blob: 3646667e0cad61708c0fde0d0ff59f03ab9aa712 [file] [log] [blame]
yuezonghe824eb0c2024-06-27 02:32:26 -07001/* curve25519.h
2 *
3 * Copyright (C) 2006-2021 wolfSSL Inc.
4 *
5 * This file is part of wolfSSL.
6 *
7 * wolfSSL is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * wolfSSL is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
20 */
21
22/*!
23 \file wolfssl/wolfcrypt/curve25519.h
24*/
25
26
27#ifndef WOLF_CRYPT_CURVE25519_H
28#define WOLF_CRYPT_CURVE25519_H
29
30#include <wolfssl/wolfcrypt/types.h>
31
32#ifdef HAVE_CURVE25519
33
34#include <wolfssl/wolfcrypt/fe_operations.h>
35#include <wolfssl/wolfcrypt/random.h>
36
37#ifdef WOLFSSL_ASYNC_CRYPT
38 #include <wolfssl/wolfcrypt/async.h>
39#endif
40
41#ifdef __cplusplus
42 extern "C" {
43#endif
44
45#define CURVE25519_KEYSIZE 32
46
47#ifdef WOLFSSL_NAMES_STATIC
48typedef char curve25519_str[12];
49#else
50typedef const char* curve25519_str;
51#endif
52
53/* curve25519 set type */
54typedef struct {
55 int size; /* The size of the curve in octets */
56 curve25519_str name; /* name of this curve */
57} curve25519_set_type;
58
59
60/* ECC point, the internal structure is Little endian
61 * the mathematical functions used the endianness */
62typedef struct {
63 byte point[CURVE25519_KEYSIZE];
64 #ifdef FREESCALE_LTC_ECC
65 byte pointY[CURVE25519_KEYSIZE];
66 #endif
67} ECPoint;
68
69/* A CURVE25519 Key */
70typedef struct curve25519_key {
71 int idx; /* Index into the ecc_sets[] for the parameters of
72 this curve if -1, this key is using user supplied
73 curve in dp */
74 const curve25519_set_type* dp; /* domain parameters, either points to
75 curves (idx >= 0) or user supplied */
76 ECPoint p; /* public key */
77 ECPoint k; /* private key */
78
79#ifdef WOLFSSL_ASYNC_CRYPT
80 WC_ASYNC_DEV asyncDev;
81#endif
82#if defined(WOLF_CRYPTO_CB)
83 int devId;
84#endif
85} curve25519_key;
86
87enum {
88 EC25519_LITTLE_ENDIAN=0,
89 EC25519_BIG_ENDIAN=1
90};
91
92WOLFSSL_API
93int wc_curve25519_make_pub(int public_size, byte* pub, int private_size,
94 const byte* priv);
95
96WOLFSSL_API
97int wc_curve25519_generic(int public_size, byte* pub,
98 int private_size, const byte* priv,
99 int basepoint_size, const byte* basepoint);
100
101WOLFSSL_API
102int wc_curve25519_make_priv(WC_RNG* rng, int keysize, byte* priv);
103
104WOLFSSL_API
105int wc_curve25519_make_key(WC_RNG* rng, int keysize, curve25519_key* key);
106
107WOLFSSL_API
108int wc_curve25519_shared_secret(curve25519_key* private_key,
109 curve25519_key* public_key,
110 byte* out, word32* outlen);
111
112WOLFSSL_API
113int wc_curve25519_shared_secret_ex(curve25519_key* private_key,
114 curve25519_key* public_key,
115 byte* out, word32* outlen, int endian);
116
117WOLFSSL_API
118int wc_curve25519_init(curve25519_key* key);
119WOLFSSL_API
120int wc_curve25519_init_ex(curve25519_key* key, void* heap, int devId);
121
122WOLFSSL_API
123void wc_curve25519_free(curve25519_key* key);
124
125
126/* raw key helpers */
127WOLFSSL_API
128int wc_curve25519_import_private(const byte* priv, word32 privSz,
129 curve25519_key* key);
130WOLFSSL_API
131int wc_curve25519_import_private_ex(const byte* priv, word32 privSz,
132 curve25519_key* key, int endian);
133
134WOLFSSL_API
135int wc_curve25519_import_private_raw(const byte* priv, word32 privSz,
136 const byte* pub, word32 pubSz, curve25519_key* key);
137WOLFSSL_API
138int wc_curve25519_import_private_raw_ex(const byte* priv, word32 privSz,
139 const byte* pub, word32 pubSz,
140 curve25519_key* key, int endian);
141WOLFSSL_API
142int wc_curve25519_export_private_raw(curve25519_key* key, byte* out,
143 word32* outLen);
144WOLFSSL_API
145int wc_curve25519_export_private_raw_ex(curve25519_key* key, byte* out,
146 word32* outLen, int endian);
147
148WOLFSSL_API
149int wc_curve25519_import_public(const byte* in, word32 inLen,
150 curve25519_key* key);
151WOLFSSL_API
152int wc_curve25519_import_public_ex(const byte* in, word32 inLen,
153 curve25519_key* key, int endian);
154WOLFSSL_API
155int wc_curve25519_check_public(const byte* pub, word32 pubSz, int endian);
156
157WOLFSSL_API
158int wc_curve25519_export_public(curve25519_key* key, byte* out, word32* outLen);
159WOLFSSL_API
160int wc_curve25519_export_public_ex(curve25519_key* key, byte* out,
161 word32* outLen, int endian);
162
163WOLFSSL_API
164int wc_curve25519_export_key_raw(curve25519_key* key,
165 byte* priv, word32 *privSz,
166 byte* pub, word32 *pubSz);
167WOLFSSL_API
168int wc_curve25519_export_key_raw_ex(curve25519_key* key,
169 byte* priv, word32 *privSz,
170 byte* pub, word32 *pubSz,
171 int endian);
172/* size helper */
173WOLFSSL_API
174int wc_curve25519_size(curve25519_key* key);
175
176#ifdef __cplusplus
177 } /* extern "C" */
178#endif
179
180#endif /* HAVE_CURVE25519 */
181#endif /* WOLF_CRYPT_CURVE25519_H */
182