blob: 953c14450390a113f71e6f4791bdc4d6892ea2a8 [file] [log] [blame]
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +02001/*
2 * Example ECDSA program
3 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02004 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02005 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020018 */
19
Bence Szépkútic662b362021-05-27 11:25:03 +020020#include "mbedtls/build_info.h"
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020021
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000022#include "mbedtls/platform.h"
Rich Evansf90016a2015-01-19 14:26:37 +000023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020024#if defined(MBEDTLS_ECDSA_C) && \
25 defined(MBEDTLS_ENTROPY_C) && defined(MBEDTLS_CTR_DRBG_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000026#include "mbedtls/entropy.h"
27#include "mbedtls/ctr_drbg.h"
28#include "mbedtls/ecdsa.h"
Janos Follath0a5154b2017-03-10 11:31:41 +000029#include "mbedtls/sha256.h"
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020030
31#include <string.h>
Rich Evans18b78c72015-02-11 14:06:19 +000032#endif
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020033
34/*
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020035 * Uncomment to show key and signature details
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020036 */
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020037#define VERBOSE
38
39/*
40 * Uncomment to force use of a specific curve
41 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020042#define ECPARAMS MBEDTLS_ECP_DP_SECP192R1
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020043
44#if !defined(ECPARAMS)
Gilles Peskine5b8618b2021-09-28 12:34:53 +020045#define ECPARAMS mbedtls_ecp_curve_list()->grp_id
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020046#endif
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020047
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020048#if !defined(MBEDTLS_ECDSA_C) || !defined(MBEDTLS_SHA256_C) || \
49 !defined(MBEDTLS_ENTROPY_C) || !defined(MBEDTLS_CTR_DRBG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +010050int main(void)
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020051{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020052 mbedtls_printf("MBEDTLS_ECDSA_C and/or MBEDTLS_SHA256_C and/or "
Gilles Peskine449bd832023-01-11 14:50:10 +010053 "MBEDTLS_ENTROPY_C and/or MBEDTLS_CTR_DRBG_C not defined\n");
54 mbedtls_exit(0);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020055}
56#else
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020057#if defined(VERBOSE)
Gilles Peskine449bd832023-01-11 14:50:10 +010058static void dump_buf(const char *title, unsigned char *buf, size_t len)
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020059{
60 size_t i;
61
Gilles Peskine449bd832023-01-11 14:50:10 +010062 mbedtls_printf("%s", title);
63 for (i = 0; i < len; i++) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064 mbedtls_printf("%c%c", "0123456789ABCDEF" [buf[i] / 16],
Gilles Peskine449bd832023-01-11 14:50:10 +010065 "0123456789ABCDEF" [buf[i] % 16]);
66 }
67 mbedtls_printf("\n");
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020068}
69
Gilles Peskine449bd832023-01-11 14:50:10 +010070static void dump_pubkey(const char *title, mbedtls_ecdsa_context *key)
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020071{
72 unsigned char buf[300];
73 size_t len;
74
Gilles Peskine449bd832023-01-11 14:50:10 +010075 if (mbedtls_ecp_point_write_binary(&key->MBEDTLS_PRIVATE(grp), &key->MBEDTLS_PRIVATE(Q),
Dave Rodgman6dd757a2023-02-02 12:40:50 +000076 MBEDTLS_ECP_PF_UNCOMPRESSED, &len, buf, sizeof(buf)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020077 mbedtls_printf("internal error\n");
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020078 return;
79 }
80
Gilles Peskine449bd832023-01-11 14:50:10 +010081 dump_buf(title, buf, len);
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020082}
83#else
Gilles Peskine449bd832023-01-11 14:50:10 +010084#define dump_buf(a, b, c)
85#define dump_pubkey(a, b)
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020086#endif
87
Simon Butcher63cb97e2018-12-06 17:43:31 +000088
Gilles Peskine449bd832023-01-11 14:50:10 +010089int main(int argc, char *argv[])
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020090{
Andres Amaya Garcia2602a1f2018-04-29 19:45:25 +010091 int ret = 1;
92 int exit_code = MBEDTLS_EXIT_FAILURE;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020093 mbedtls_ecdsa_context ctx_sign, ctx_verify;
94 mbedtls_entropy_context entropy;
95 mbedtls_ctr_drbg_context ctr_drbg;
Janos Follath0a5154b2017-03-10 11:31:41 +000096 unsigned char message[100];
97 unsigned char hash[32];
98 unsigned char sig[MBEDTLS_ECDSA_MAX_LEN];
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020099 size_t sig_len;
100 const char *pers = "ecdsa";
101 ((void) argv);
102
Gilles Peskine449bd832023-01-11 14:50:10 +0100103 mbedtls_ecdsa_init(&ctx_sign);
104 mbedtls_ecdsa_init(&ctx_verify);
105 mbedtls_ctr_drbg_init(&ctr_drbg);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200106
Gilles Peskine449bd832023-01-11 14:50:10 +0100107 memset(sig, 0, sizeof(sig));
108 memset(message, 0x25, sizeof(message));
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200109
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 if (argc != 1) {
111 mbedtls_printf("usage: ecdsa\n");
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200112
113#if defined(_WIN32)
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 mbedtls_printf("\n");
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200115#endif
116
117 goto exit;
118 }
119
120 /*
121 * Generate a key pair for signing
122 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100123 mbedtls_printf("\n . Seeding the random number generator...");
124 fflush(stdout);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 mbedtls_entropy_init(&entropy);
127 if ((ret = mbedtls_ctr_drbg_seed(&ctr_drbg, mbedtls_entropy_func, &entropy,
128 (const unsigned char *) pers,
129 strlen(pers))) != 0) {
130 mbedtls_printf(" failed\n ! mbedtls_ctr_drbg_seed returned %d\n", ret);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200131 goto exit;
132 }
133
Gilles Peskine449bd832023-01-11 14:50:10 +0100134 mbedtls_printf(" ok\n . Generating key pair...");
135 fflush(stdout);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200136
Gilles Peskine449bd832023-01-11 14:50:10 +0100137 if ((ret = mbedtls_ecdsa_genkey(&ctx_sign, ECPARAMS,
138 mbedtls_ctr_drbg_random, &ctr_drbg)) != 0) {
139 mbedtls_printf(" failed\n ! mbedtls_ecdsa_genkey returned %d\n", ret);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200140 goto exit;
141 }
142
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 mbedtls_printf(" ok (key size: %d bits)\n", (int) ctx_sign.MBEDTLS_PRIVATE(grp).pbits);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200144
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 dump_pubkey(" + Public key: ", &ctx_sign);
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +0200146
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200147 /*
Janos Follath0a5154b2017-03-10 11:31:41 +0000148 * Compute message hash
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200149 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100150 mbedtls_printf(" . Computing message hash...");
151 fflush(stdout);
Janos Follath0a5154b2017-03-10 11:31:41 +0000152
Gilles Peskine449bd832023-01-11 14:50:10 +0100153 if ((ret = mbedtls_sha256(message, sizeof(message), hash, 0)) != 0) {
154 mbedtls_printf(" failed\n ! mbedtls_sha256 returned %d\n", ret);
Andres Amaya Garcia1ff60f42017-06-28 13:26:36 +0100155 goto exit;
156 }
Janos Follath0a5154b2017-03-10 11:31:41 +0000157
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 mbedtls_printf(" ok\n");
Janos Follath0a5154b2017-03-10 11:31:41 +0000159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 dump_buf(" + Hash: ", hash, sizeof(hash));
Janos Follath0a5154b2017-03-10 11:31:41 +0000161
162 /*
163 * Sign message hash
164 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100165 mbedtls_printf(" . Signing message hash...");
166 fflush(stdout);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200167
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 if ((ret = mbedtls_ecdsa_write_signature(&ctx_sign, MBEDTLS_MD_SHA256,
169 hash, sizeof(hash),
170 sig, sizeof(sig), &sig_len,
171 mbedtls_ctr_drbg_random, &ctr_drbg)) != 0) {
172 mbedtls_printf(" failed\n ! mbedtls_ecdsa_write_signature returned %d\n", ret);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200173 goto exit;
174 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 mbedtls_printf(" ok (signature length = %u)\n", (unsigned int) sig_len);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200176
Gilles Peskine449bd832023-01-11 14:50:10 +0100177 dump_buf(" + Signature: ", sig, sig_len);
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +0200178
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200179 /*
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200180 * Transfer public information to verifying context
Manuel Pégourié-Gonnard4e3e7c22014-07-08 13:05:49 +0200181 *
182 * We could use the same context for verification and signatures, but we
183 * chose to use a new one in order to make it clear that the verifying
184 * context only needs the public key (Q), and not the private key (d).
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200185 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 mbedtls_printf(" . Preparing verification context...");
187 fflush(stdout);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200188
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 if ((ret =
190 mbedtls_ecp_group_copy(&ctx_verify.MBEDTLS_PRIVATE(grp),
191 &ctx_sign.MBEDTLS_PRIVATE(grp))) != 0) {
192 mbedtls_printf(" failed\n ! mbedtls_ecp_group_copy returned %d\n", ret);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200193 goto exit;
194 }
195
Gilles Peskine449bd832023-01-11 14:50:10 +0100196 if ((ret =
197 mbedtls_ecp_copy(&ctx_verify.MBEDTLS_PRIVATE(Q), &ctx_sign.MBEDTLS_PRIVATE(Q))) != 0) {
198 mbedtls_printf(" failed\n ! mbedtls_ecp_copy returned %d\n", ret);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200199 goto exit;
200 }
201
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200202 /*
203 * Verify signature
204 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 mbedtls_printf(" ok\n . Verifying signature...");
206 fflush(stdout);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200207
Gilles Peskine449bd832023-01-11 14:50:10 +0100208 if ((ret = mbedtls_ecdsa_read_signature(&ctx_verify,
209 hash, sizeof(hash),
210 sig, sig_len)) != 0) {
211 mbedtls_printf(" failed\n ! mbedtls_ecdsa_read_signature returned %d\n", ret);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200212 goto exit;
213 }
214
Gilles Peskine449bd832023-01-11 14:50:10 +0100215 mbedtls_printf(" ok\n");
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200216
Andres Amaya Garcia2602a1f2018-04-29 19:45:25 +0100217 exit_code = MBEDTLS_EXIT_SUCCESS;
218
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200219exit:
220
Gilles Peskine449bd832023-01-11 14:50:10 +0100221 mbedtls_ecdsa_free(&ctx_verify);
222 mbedtls_ecdsa_free(&ctx_sign);
223 mbedtls_ctr_drbg_free(&ctr_drbg);
224 mbedtls_entropy_free(&entropy);
Manuel Pégourié-Gonnardbf3109f2013-08-14 21:36:01 +0200225
Gilles Peskine449bd832023-01-11 14:50:10 +0100226 mbedtls_exit(exit_code);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200227}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200228#endif /* MBEDTLS_ECDSA_C && MBEDTLS_ENTROPY_C && MBEDTLS_CTR_DRBG_C &&
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200229 ECPARAMS */