mbed TLS v2.16.3
ecjpake.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
8  * SPDX-License-Identifier: Apache-2.0
9  *
10  * Licensed under the Apache License, Version 2.0 (the "License"); you may
11  * not use this file except in compliance with the License.
12  * You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  *
22  * This file is part of mbed TLS (https://tls.mbed.org)
23  */
24 #ifndef MBEDTLS_ECJPAKE_H
25 #define MBEDTLS_ECJPAKE_H
26 
27 /*
28  * J-PAKE is a password-authenticated key exchange that allows deriving a
29  * strong shared secret from a (potentially low entropy) pre-shared
30  * passphrase, with forward secrecy and mutual authentication.
31  * https://en.wikipedia.org/wiki/Password_Authenticated_Key_Exchange_by_Juggling
32  *
33  * This file implements the Elliptic Curve variant of J-PAKE,
34  * as defined in Chapter 7.4 of the Thread v1.0 Specification,
35  * available to members of the Thread Group http://threadgroup.org/
36  *
37  * As the J-PAKE algorithm is inherently symmetric, so is our API.
38  * Each party needs to send its first round message, in any order, to the
39  * other party, then each sends its second round message, in any order.
40  * The payloads are serialized in a way suitable for use in TLS, but could
41  * also be use outside TLS.
42  */
43 #if !defined(MBEDTLS_CONFIG_FILE)
44 #include "config.h"
45 #else
46 #include MBEDTLS_CONFIG_FILE
47 #endif
48 
49 #include "ecp.h"
50 #include "md.h"
51 
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55 
59 typedef enum {
63 
64 #if !defined(MBEDTLS_ECJPAKE_ALT)
65 
77 {
94 
95 #else /* MBEDTLS_ECJPAKE_ALT */
96 #include "ecjpake_alt.h"
97 #endif /* MBEDTLS_ECJPAKE_ALT */
98 
106 
130  mbedtls_md_type_t hash,
131  mbedtls_ecp_group_id curve,
132  const unsigned char *secret,
133  size_t len );
134 
145 
166  unsigned char *buf, size_t len, size_t *olen,
167  int (*f_rng)(void *, unsigned char *, size_t),
168  void *p_rng );
169 
185  const unsigned char *buf,
186  size_t len );
187 
207  unsigned char *buf, size_t len, size_t *olen,
208  int (*f_rng)(void *, unsigned char *, size_t),
209  void *p_rng );
210 
225  const unsigned char *buf,
226  size_t len );
227 
247  unsigned char *buf, size_t len, size_t *olen,
248  int (*f_rng)(void *, unsigned char *, size_t),
249  void *p_rng );
250 
260 
261 #if defined(MBEDTLS_SELF_TEST)
262 
268 int mbedtls_ecjpake_self_test( int verbose );
269 
270 #endif /* MBEDTLS_SELF_TEST */
271 
272 #ifdef __cplusplus
273 }
274 #endif
275 
276 
277 #endif /* ecjpake.h */
mbedtls_ecjpake_context::xm2
mbedtls_mpi xm2
Definition: ecjpake.h:90
mbedtls_md_type_t
mbedtls_md_type_t
Supported message digests.
Definition: md.h:58
mbedtls_ecp_group
The ECP group structure.
Definition: ecp.h:173
ecp.h
This file provides an API for Elliptic Curves over GF(P) (ECP).
mbedtls_mpi
MPI structure.
Definition: bignum.h:185
md.h
This file contains the generic message-digest wrapper.
mbedtls_ecjpake_free
void mbedtls_ecjpake_free(mbedtls_ecjpake_context *ctx)
This clears an ECJPAKE context and frees any embedded data structure.
mbedtls_ecjpake_context::s
mbedtls_mpi s
Definition: ecjpake.h:92
mbedtls_ecjpake_self_test
int mbedtls_ecjpake_self_test(int verbose)
Checkup routine.
mbedtls_ecjpake_context::Xp2
mbedtls_ecp_point Xp2
Definition: ecjpake.h:86
MBEDTLS_ECJPAKE_CLIENT
@ MBEDTLS_ECJPAKE_CLIENT
Definition: ecjpake.h:60
mbedtls_ecjpake_context
struct mbedtls_ecjpake_context mbedtls_ecjpake_context
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_context::xm1
mbedtls_mpi xm1
Definition: ecjpake.h:89
mbedtls_ecjpake_context::Xm2
mbedtls_ecp_point Xm2
Definition: ecjpake.h:84
mbedtls_ecjpake_context::Xm1
mbedtls_ecp_point Xm1
Definition: ecjpake.h:83
mbedtls_ecjpake_context::grp
mbedtls_ecp_group grp
Definition: ecjpake.h:79
mbedtls_ecjpake_context::md_info
const mbedtls_md_info_t * md_info
Definition: ecjpake.h:78
mbedtls_ecjpake_init
void mbedtls_ecjpake_init(mbedtls_ecjpake_context *ctx)
Initialize an ECJPAKE context.
mbedtls_ecjpake_context::Xp1
mbedtls_ecp_point Xp1
Definition: ecjpake.h:85
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_ecp_group_id
mbedtls_ecp_group_id
Definition: ecp.h:77
mbedtls_ecjpake_role
mbedtls_ecjpake_role
Definition: ecjpake.h:59
mbedtls_ecjpake_context::point_format
int point_format
Definition: ecjpake.h:81
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_context::Xp
mbedtls_ecp_point Xp
Definition: ecjpake.h:87
mbedtls_ecjpake_context
Definition: ecjpake.h:76
mbedtls_md_info_t
struct mbedtls_md_info_t mbedtls_md_info_t
Definition: md.h:80
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_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_context::role
mbedtls_ecjpake_role role
Definition: ecjpake.h:80
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).
config.h
Configuration options (set of defines)
mbedtls_ecjpake_check
int mbedtls_ecjpake_check(const mbedtls_ecjpake_context *ctx)
Check if an ECJPAKE context is ready for use.
mbedtls_ecp_point
The ECP point structure, in Jacobian coordinates.
Definition: ecp.h:124
MBEDTLS_ECJPAKE_SERVER
@ MBEDTLS_ECJPAKE_SERVER
Definition: ecjpake.h:61