ReactOS 0.4.16-dev-297-gc569aee
ecjpake.h
Go to the documentation of this file.
1
6/*
7 * Copyright The Mbed TLS Contributors
8 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9 *
10 * This file is provided under the Apache License 2.0, or the
11 * GNU General Public License v2.0 or later.
12 *
13 * **********
14 * Apache License 2.0:
15 *
16 * Licensed under the Apache License, Version 2.0 (the "License"); you may
17 * not use this file except in compliance with the License.
18 * You may obtain a copy of the License at
19 *
20 * http://www.apache.org/licenses/LICENSE-2.0
21 *
22 * Unless required by applicable law or agreed to in writing, software
23 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25 * See the License for the specific language governing permissions and
26 * limitations under the License.
27 *
28 * **********
29 *
30 * **********
31 * GNU General Public License v2.0 or later:
32 *
33 * This program is free software; you can redistribute it and/or modify
34 * it under the terms of the GNU General Public License as published by
35 * the Free Software Foundation; either version 2 of the License, or
36 * (at your option) any later version.
37 *
38 * This program is distributed in the hope that it will be useful,
39 * but WITHOUT ANY WARRANTY; without even the implied warranty of
40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41 * GNU General Public License for more details.
42 *
43 * You should have received a copy of the GNU General Public License along
44 * with this program; if not, write to the Free Software Foundation, Inc.,
45 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46 *
47 * **********
48 */
49#ifndef MBEDTLS_ECJPAKE_H
50#define MBEDTLS_ECJPAKE_H
51
52/*
53 * J-PAKE is a password-authenticated key exchange that allows deriving a
54 * strong shared secret from a (potentially low entropy) pre-shared
55 * passphrase, with forward secrecy and mutual authentication.
56 * https://en.wikipedia.org/wiki/Password_Authenticated_Key_Exchange_by_Juggling
57 *
58 * This file implements the Elliptic Curve variant of J-PAKE,
59 * as defined in Chapter 7.4 of the Thread v1.0 Specification,
60 * available to members of the Thread Group http://threadgroup.org/
61 *
62 * As the J-PAKE algorithm is inherently symmetric, so is our API.
63 * Each party needs to send its first round message, in any order, to the
64 * other party, then each sends its second round message, in any order.
65 * The payloads are serialized in a way suitable for use in TLS, but could
66 * also be use outside TLS.
67 */
68#if !defined(MBEDTLS_CONFIG_FILE)
69#include "config.h"
70#else
71#include MBEDTLS_CONFIG_FILE
72#endif
73
74#include "ecp.h"
75#include "md.h"
76
77#ifdef __cplusplus
78extern "C" {
79#endif
80
84typedef enum {
88
89#if !defined(MBEDTLS_ECJPAKE_ALT)
102{
119
120#else /* MBEDTLS_ECJPAKE_ALT */
121#include "ecjpake_alt.h"
122#endif /* MBEDTLS_ECJPAKE_ALT */
123
131
157 const unsigned char *secret,
158 size_t len );
159
170
191 unsigned char *buf, size_t len, size_t *olen,
192 int (*f_rng)(void *, unsigned char *, size_t),
193 void *p_rng );
194
210 const unsigned char *buf,
211 size_t len );
212
232 unsigned char *buf, size_t len, size_t *olen,
233 int (*f_rng)(void *, unsigned char *, size_t),
234 void *p_rng );
235
250 const unsigned char *buf,
251 size_t len );
252
272 unsigned char *buf, size_t len, size_t *olen,
273 int (*f_rng)(void *, unsigned char *, size_t),
274 void *p_rng );
275
285
286#if defined(MBEDTLS_SELF_TEST)
287
293int mbedtls_ecjpake_self_test( int verbose );
294
295#endif /* MBEDTLS_SELF_TEST */
296
297#ifdef __cplusplus
298}
299#endif
300
301
302#endif /* ecjpake.h */
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).
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
Definition: ecjpake.h:84
@ MBEDTLS_ECJPAKE_CLIENT
Definition: ecjpake.h:85
@ MBEDTLS_ECJPAKE_SERVER
Definition: ecjpake.h:86
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.
void mbedtls_ecjpake_init(mbedtls_ecjpake_context *ctx)
Initialize an ECJPAKE context.
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).
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).
int mbedtls_ecjpake_check(const mbedtls_ecjpake_context *ctx)
Check if an ECJPAKE context is ready for use.
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,...
void mbedtls_ecjpake_free(mbedtls_ecjpake_context *ctx)
This clears an ECJPAKE context and frees any embedded data structure.
GLenum GLuint GLenum GLsizei const GLchar * buf
Definition: glext.h:7751
GLenum GLsizei len
Definition: glext.h:6722
This file contains the generic message-digest wrapper.
mbedtls_md_type_t
Supported message digests.
Definition: md.h:83
static DATA_BLOB CRYPTPROTECT_PROMPTSTRUCT DATA_BLOB *static LPWSTR DATA_BLOB CRYPTPROTECT_PROMPTSTRUCT DATA_BLOB *static char secret[]
Definition: protectdata.c:33
#define verbose
Definition: rosglue.h:36
This file provides an API for Elliptic Curves over GF(P) (ECP).
mbedtls_ecp_group_id
Definition: ecp.h:103
Definition: _hash_fun.h:40
const mbedtls_md_info_t * md_info
Definition: ecjpake.h:103
mbedtls_ecp_point Xp1
Definition: ecjpake.h:110
mbedtls_ecjpake_role role
Definition: ecjpake.h:105
mbedtls_ecp_point Xm2
Definition: ecjpake.h:109
mbedtls_ecp_point Xp2
Definition: ecjpake.h:111
mbedtls_ecp_point Xp
Definition: ecjpake.h:112
mbedtls_ecp_group grp
Definition: ecjpake.h:104
mbedtls_ecp_point Xm1
Definition: ecjpake.h:108
The ECP group structure.
Definition: ecp.h:233
The ECP point structure, in Jacobian coordinates.
Definition: ecp.h:150
MPI structure.
Definition: bignum.h:211