1 | /* ed25519.h
|
---|
2 | *
|
---|
3 | * Copyright (C) 2006-2020 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/ed25519.h
|
---|
24 | */
|
---|
25 |
|
---|
26 |
|
---|
27 | #ifndef WOLF_CRYPT_ED25519_H
|
---|
28 | #define WOLF_CRYPT_ED25519_H
|
---|
29 |
|
---|
30 | #include <wolfssl/wolfcrypt/types.h>
|
---|
31 |
|
---|
32 | #ifdef HAVE_ED25519
|
---|
33 |
|
---|
34 | #include <wolfssl/wolfcrypt/fe_operations.h>
|
---|
35 | #include <wolfssl/wolfcrypt/ge_operations.h>
|
---|
36 | #include <wolfssl/wolfcrypt/random.h>
|
---|
37 | #include <wolfssl/wolfcrypt/sha512.h>
|
---|
38 |
|
---|
39 | #ifdef WOLFSSL_ASYNC_CRYPT
|
---|
40 | #include <wolfssl/wolfcrypt/async.h>
|
---|
41 | #endif
|
---|
42 |
|
---|
43 | #ifdef __cplusplus
|
---|
44 | extern "C" {
|
---|
45 | #endif
|
---|
46 |
|
---|
47 |
|
---|
48 | /* info about EdDSA curve specifically ed25519, defined as an elliptic curve
|
---|
49 | over GF(p) */
|
---|
50 | /*
|
---|
51 | 32, key size
|
---|
52 | "ED25519", curve name
|
---|
53 | "2^255-19", prime number
|
---|
54 | "SHA512", hash function
|
---|
55 | "-121665/121666", value of d
|
---|
56 | */
|
---|
57 |
|
---|
58 | #define ED25519_KEY_SIZE 32 /* private key only */
|
---|
59 | #define ED25519_SIG_SIZE 64
|
---|
60 |
|
---|
61 | #define ED25519_PUB_KEY_SIZE 32 /* compressed */
|
---|
62 | /* both private and public key */
|
---|
63 | #define ED25519_PRV_KEY_SIZE (ED25519_PUB_KEY_SIZE+ED25519_KEY_SIZE)
|
---|
64 |
|
---|
65 |
|
---|
66 | enum {
|
---|
67 | Ed25519 = -1,
|
---|
68 | Ed25519ctx = 0,
|
---|
69 | Ed25519ph = 1,
|
---|
70 | };
|
---|
71 |
|
---|
72 | #ifndef WC_ED25519KEY_TYPE_DEFINED
|
---|
73 | typedef struct ed25519_key ed25519_key;
|
---|
74 | #define WC_ED25519KEY_TYPE_DEFINED
|
---|
75 | #endif
|
---|
76 |
|
---|
77 | /* An ED25519 Key */
|
---|
78 | struct ed25519_key {
|
---|
79 | byte p[ED25519_PUB_KEY_SIZE]; /* compressed public key */
|
---|
80 | byte k[ED25519_PRV_KEY_SIZE]; /* private key : 32 secret -- 32 public */
|
---|
81 | #ifdef FREESCALE_LTC_ECC
|
---|
82 | /* uncompressed point coordinates */
|
---|
83 | byte pointX[ED25519_KEY_SIZE]; /* recovered X coordinate */
|
---|
84 | byte pointY[ED25519_KEY_SIZE]; /* Y coordinate is the public key with The most significant bit of the final octet always zero. */
|
---|
85 | #endif
|
---|
86 | word16 pubKeySet:1;
|
---|
87 | #ifdef WOLFSSL_ASYNC_CRYPT
|
---|
88 | WC_ASYNC_DEV asyncDev;
|
---|
89 | #endif
|
---|
90 | };
|
---|
91 |
|
---|
92 |
|
---|
93 | WOLFSSL_API
|
---|
94 | int wc_ed25519_make_public(ed25519_key* key, unsigned char* pubKey,
|
---|
95 | word32 pubKeySz);
|
---|
96 | WOLFSSL_API
|
---|
97 | int wc_ed25519_make_key(WC_RNG* rng, int keysize, ed25519_key* key);
|
---|
98 | WOLFSSL_API
|
---|
99 | int wc_ed25519_sign_msg(const byte* in, word32 inLen, byte* out,
|
---|
100 | word32 *outLen, ed25519_key* key);
|
---|
101 | WOLFSSL_API
|
---|
102 | int wc_ed25519ctx_sign_msg(const byte* in, word32 inLen, byte* out,
|
---|
103 | word32 *outLen, ed25519_key* key,
|
---|
104 | const byte* context, byte contextLen);
|
---|
105 | WOLFSSL_API
|
---|
106 | int wc_ed25519ph_sign_hash(const byte* hash, word32 hashLen, byte* out,
|
---|
107 | word32 *outLen, ed25519_key* key,
|
---|
108 | const byte* context, byte contextLen);
|
---|
109 | WOLFSSL_API
|
---|
110 | int wc_ed25519ph_sign_msg(const byte* in, word32 inLen, byte* out,
|
---|
111 | word32 *outLen, ed25519_key* key, const byte* context,
|
---|
112 | byte contextLen);
|
---|
113 | WOLFSSL_API
|
---|
114 | int wc_ed25519_verify_msg(const byte* sig, word32 sigLen, const byte* msg,
|
---|
115 | word32 msgLen, int* stat, ed25519_key* key);
|
---|
116 | WOLFSSL_API
|
---|
117 | int wc_ed25519ctx_verify_msg(const byte* sig, word32 sigLen, const byte* msg,
|
---|
118 | word32 msgLen, int* stat, ed25519_key* key,
|
---|
119 | const byte* context, byte contextLen);
|
---|
120 | WOLFSSL_API
|
---|
121 | int wc_ed25519ph_verify_hash(const byte* sig, word32 sigLen, const byte* hash,
|
---|
122 | word32 hashLen, int* stat, ed25519_key* key,
|
---|
123 | const byte* context, byte contextLen);
|
---|
124 | WOLFSSL_API
|
---|
125 | int wc_ed25519ph_verify_msg(const byte* sig, word32 sigLen, const byte* msg,
|
---|
126 | word32 msgLen, int* stat, ed25519_key* key,
|
---|
127 | const byte* context, byte contextLen);
|
---|
128 | WOLFSSL_API
|
---|
129 | int wc_ed25519_init(ed25519_key* key);
|
---|
130 | WOLFSSL_API
|
---|
131 | void wc_ed25519_free(ed25519_key* key);
|
---|
132 | WOLFSSL_API
|
---|
133 | int wc_ed25519_import_public(const byte* in, word32 inLen, ed25519_key* key);
|
---|
134 | WOLFSSL_API
|
---|
135 | int wc_ed25519_import_private_only(const byte* priv, word32 privSz,
|
---|
136 | ed25519_key* key);
|
---|
137 | WOLFSSL_API
|
---|
138 | int wc_ed25519_import_private_key(const byte* priv, word32 privSz,
|
---|
139 | const byte* pub, word32 pubSz, ed25519_key* key);
|
---|
140 | WOLFSSL_API
|
---|
141 | int wc_ed25519_export_public(ed25519_key*, byte* out, word32* outLen);
|
---|
142 | WOLFSSL_API
|
---|
143 | int wc_ed25519_export_private_only(ed25519_key* key, byte* out, word32* outLen);
|
---|
144 | WOLFSSL_API
|
---|
145 | int wc_ed25519_export_private(ed25519_key* key, byte* out, word32* outLen);
|
---|
146 | WOLFSSL_API
|
---|
147 | int wc_ed25519_export_key(ed25519_key* key,
|
---|
148 | byte* priv, word32 *privSz,
|
---|
149 | byte* pub, word32 *pubSz);
|
---|
150 |
|
---|
151 | WOLFSSL_API
|
---|
152 | int wc_ed25519_check_key(ed25519_key* key);
|
---|
153 |
|
---|
154 | /* size helper */
|
---|
155 | WOLFSSL_API
|
---|
156 | int wc_ed25519_size(ed25519_key* key);
|
---|
157 | WOLFSSL_API
|
---|
158 | int wc_ed25519_priv_size(ed25519_key* key);
|
---|
159 | WOLFSSL_API
|
---|
160 | int wc_ed25519_pub_size(ed25519_key* key);
|
---|
161 | WOLFSSL_API
|
---|
162 | int wc_ed25519_sig_size(ed25519_key* key);
|
---|
163 |
|
---|
164 | #ifdef __cplusplus
|
---|
165 | } /* extern "C" */
|
---|
166 | #endif
|
---|
167 |
|
---|
168 | #endif /* HAVE_ED25519 */
|
---|
169 | #endif /* WOLF_CRYPT_ED25519_H */
|
---|