ecjpake.h
Go to the documentation of this file.
/*
* Copyright The Mbed TLS Contributors
* SPDX-License-Identifier: Apache-2.0
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MBEDTLS_ECJPAKE_H
#define MBEDTLS_ECJPAKE_H
/*
* J-PAKE is a password-authenticated key exchange that allows deriving a
* strong shared secret from a (potentially low entropy) pre-shared
* passphrase, with forward secrecy and mutual authentication.
* https://en.wikipedia.org/wiki/Password_Authenticated_Key_Exchange_by_Juggling
*
* This file implements the Elliptic Curve variant of J-PAKE,
* as defined in Chapter 7.4 of the Thread v1.0 Specification,
* available to members of the Thread Group http://threadgroup.org/
*
* As the J-PAKE algorithm is inherently symmetric, so is our API.
* Each party needs to send its first round message, in any order, to the
* other party, then each sends its second round message, in any order.
* The payloads are serialized in a way suitable for use in TLS, but could
* also be use outside TLS.
*/
#if !defined(MBEDTLS_CONFIG_FILE)
#include "mbedtls/config.h"
#else
#include MBEDTLS_CONFIG_FILE
#endif
#include "mbedtls/ecp.h"
#include "mbedtls/md.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef enum {
MBEDTLS_ECJPAKE_CLIENT = 0,
MBEDTLS_ECJPAKE_SERVER,
} mbedtls_ecjpake_role;
#if !defined(MBEDTLS_ECJPAKE_ALT)
typedef struct mbedtls_ecjpake_context
{
const mbedtls_md_info_t *md_info;
mbedtls_ecp_group grp;
mbedtls_ecjpake_role role;
int point_format;
mbedtls_ecp_point Xm1;
mbedtls_ecp_point Xm2;
mbedtls_ecp_point Xp1;
mbedtls_ecp_point Xp2;
mbedtls_ecp_point Xp;
mbedtls_mpi xm1;
mbedtls_mpi xm2;
mbedtls_mpi s;
} mbedtls_ecjpake_context;
#else /* MBEDTLS_ECJPAKE_ALT */
#include "ecjpake_alt.h"
#endif /* MBEDTLS_ECJPAKE_ALT */
void mbedtls_ecjpake_init( mbedtls_ecjpake_context *ctx );
int mbedtls_ecjpake_setup( mbedtls_ecjpake_context *ctx,
mbedtls_ecjpake_role role,
mbedtls_md_type_t hash,
mbedtls_ecp_group_id curve,
const unsigned char *secret,
size_t len );
int mbedtls_ecjpake_check( const mbedtls_ecjpake_context *ctx );
int mbedtls_ecjpake_write_round_one( mbedtls_ecjpake_context *ctx,
unsigned char *buf, size_t len, size_t *olen,
int (*f_rng)(void *, unsigned char *, size_t),
void *p_rng );
int mbedtls_ecjpake_read_round_one( mbedtls_ecjpake_context *ctx,
const unsigned char *buf,
size_t len );
int mbedtls_ecjpake_write_round_two( mbedtls_ecjpake_context *ctx,
unsigned char *buf, size_t len, size_t *olen,
int (*f_rng)(void *, unsigned char *, size_t),
void *p_rng );
int mbedtls_ecjpake_read_round_two( mbedtls_ecjpake_context *ctx,
const unsigned char *buf,
size_t len );
int mbedtls_ecjpake_derive_secret( mbedtls_ecjpake_context *ctx,
unsigned char *buf, size_t len, size_t *olen,
int (*f_rng)(void *, unsigned char *, size_t),
void *p_rng );
void mbedtls_ecjpake_free( mbedtls_ecjpake_context *ctx );
#if defined(MBEDTLS_SELF_TEST)
int mbedtls_ecjpake_self_test( int verbose );
#endif /* MBEDTLS_SELF_TEST */
#ifdef __cplusplus
}
#endif
#endif /* ecjpake.h */
config.h
Configuration options (set of defines)
mbedtls_ecjpake_read_round_two
int mbedtls_ecjpake_read_round_two(mbedtls_ecjpake_context *ctx, const unsigned char *buf, size_t len)
Read and process the second round message (TLS: contents of the Client/ServerKeyExchange).
mbedtls_ecjpake_write_round_one
int mbedtls_ecjpake_write_round_one(mbedtls_ecjpake_context *ctx, unsigned char *buf, size_t len, size_t *olen, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Generate and write the first round message (TLS: contents of the Client/ServerHello extension,...
mbedtls_ecjpake_role
mbedtls_ecjpake_role
Definition: ecjpake.h:57
MBEDTLS_ECJPAKE_CLIENT
@ MBEDTLS_ECJPAKE_CLIENT
Definition: ecjpake.h:58
MBEDTLS_ECJPAKE_SERVER
@ MBEDTLS_ECJPAKE_SERVER
Definition: ecjpake.h:59
mbedtls_ecjpake_setup
int mbedtls_ecjpake_setup(mbedtls_ecjpake_context *ctx, mbedtls_ecjpake_role role, mbedtls_md_type_t hash, mbedtls_ecp_group_id curve, const unsigned char *secret, size_t len)
Set up an ECJPAKE context for use.
mbedtls_ecjpake_context
struct mbedtls_ecjpake_context mbedtls_ecjpake_context
mbedtls_ecjpake_init
void mbedtls_ecjpake_init(mbedtls_ecjpake_context *ctx)
Initialize an ECJPAKE context.
mbedtls_ecjpake_write_round_two
int mbedtls_ecjpake_write_round_two(mbedtls_ecjpake_context *ctx, unsigned char *buf, size_t len, size_t *olen, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Generate and write the second round message (TLS: contents of the Client/ServerKeyExchange).
mbedtls_ecjpake_derive_secret
int mbedtls_ecjpake_derive_secret(mbedtls_ecjpake_context *ctx, unsigned char *buf, size_t len, size_t *olen, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
Derive the shared secret (TLS: Pre-Master Secret).
mbedtls_ecjpake_self_test
int mbedtls_ecjpake_self_test(int verbose)
Checkup routine.
mbedtls_ecjpake_check
int mbedtls_ecjpake_check(const mbedtls_ecjpake_context *ctx)
Check if an ECJPAKE context is ready for use.
mbedtls_ecjpake_read_round_one
int mbedtls_ecjpake_read_round_one(mbedtls_ecjpake_context *ctx, const unsigned char *buf, size_t len)
Read and process the first round message (TLS: contents of the Client/ServerHello extension,...
mbedtls_ecjpake_free
void mbedtls_ecjpake_free(mbedtls_ecjpake_context *ctx)
This clears an ECJPAKE context and frees any embedded data structure.
ecp.h
This file provides an API for Elliptic Curves over GF(P) (ECP).
mbedtls_ecp_group_id
mbedtls_ecp_group_id
Definition: ecp.h:121
md.h
This file contains the generic message-digest wrapper.
mbedtls_md_type_t
mbedtls_md_type_t
Supported message digests.
Definition: md.h:62
mbedtls_md_info_t
struct mbedtls_md_info_t mbedtls_md_info_t
Definition: md.h:90
mbedtls_ecjpake_context
Definition: ecjpake.h:75
mbedtls_ecjpake_context::md_info
const mbedtls_md_info_t * md_info
Definition: ecjpake.h:76
mbedtls_ecjpake_context::Xp1
mbedtls_ecp_point Xp1
Definition: ecjpake.h:83
mbedtls_ecjpake_context::role
mbedtls_ecjpake_role role
Definition: ecjpake.h:78
mbedtls_ecjpake_context::s
mbedtls_mpi s
Definition: ecjpake.h:90
mbedtls_ecjpake_context::Xm2
mbedtls_ecp_point Xm2
Definition: ecjpake.h:82
mbedtls_ecjpake_context::Xp2
mbedtls_ecp_point Xp2
Definition: ecjpake.h:84
mbedtls_ecjpake_context::Xp
mbedtls_ecp_point Xp
Definition: ecjpake.h:85
mbedtls_ecjpake_context::grp
mbedtls_ecp_group grp
Definition: ecjpake.h:77
mbedtls_ecjpake_context::point_format
int point_format
Definition: ecjpake.h:79
mbedtls_ecjpake_context::xm1
mbedtls_mpi xm1
Definition: ecjpake.h:87
mbedtls_ecjpake_context::xm2
mbedtls_mpi xm2
Definition: ecjpake.h:88
mbedtls_ecjpake_context::Xm1
mbedtls_ecp_point Xm1
Definition: ecjpake.h:81
mbedtls_ecp_group
The ECP group structure.
Definition: ecp.h:261
mbedtls_ecp_point
The ECP point structure, in Jacobian coordinates.
Definition: ecp.h:178
mbedtls_mpi
MPI structure.
Definition: bignum.h:193