blob: 5664b8c4e5db900e96694343f8b70dc35d333d16 [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
Dave Rodgman16799db2023-11-02 19:47:20 +00005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +02006 */
7
Bence Szépkútic662b362021-05-27 11:25:03 +02008#include "mbedtls/build_info.h"
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +02009
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000010#include "mbedtls/platform.h"
Rich Evansf90016a2015-01-19 14:26:37 +000011
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020012#if defined(MBEDTLS_ECDSA_C) && \
13 defined(MBEDTLS_ENTROPY_C) && defined(MBEDTLS_CTR_DRBG_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000014#include "mbedtls/entropy.h"
15#include "mbedtls/ctr_drbg.h"
16#include "mbedtls/ecdsa.h"
Janos Follath0a5154b2017-03-10 11:31:41 +000017#include "mbedtls/sha256.h"
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020018
19#include <string.h>
Rich Evans18b78c72015-02-11 14:06:19 +000020#endif
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020021
22/*
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020023 * Uncomment to show key and signature details
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020024 */
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020025#define VERBOSE
26
27/*
28 * Uncomment to force use of a specific curve
29 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020030#define ECPARAMS MBEDTLS_ECP_DP_SECP192R1
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020031
32#if !defined(ECPARAMS)
Gilles Peskine5b8618b2021-09-28 12:34:53 +020033#define ECPARAMS mbedtls_ecp_curve_list()->grp_id
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020034#endif
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020036#if !defined(MBEDTLS_ECDSA_C) || !defined(MBEDTLS_SHA256_C) || \
37 !defined(MBEDTLS_ENTROPY_C) || !defined(MBEDTLS_CTR_DRBG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +010038int main(void)
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020039{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020040 mbedtls_printf("MBEDTLS_ECDSA_C and/or MBEDTLS_SHA256_C and/or "
Gilles Peskine449bd832023-01-11 14:50:10 +010041 "MBEDTLS_ENTROPY_C and/or MBEDTLS_CTR_DRBG_C not defined\n");
42 mbedtls_exit(0);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020043}
44#else
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020045#if defined(VERBOSE)
Gilles Peskine449bd832023-01-11 14:50:10 +010046static void dump_buf(const char *title, unsigned char *buf, size_t len)
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020047{
48 size_t i;
49
Gilles Peskine449bd832023-01-11 14:50:10 +010050 mbedtls_printf("%s", title);
51 for (i = 0; i < len; i++) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020052 mbedtls_printf("%c%c", "0123456789ABCDEF" [buf[i] / 16],
Gilles Peskine449bd832023-01-11 14:50:10 +010053 "0123456789ABCDEF" [buf[i] % 16]);
54 }
55 mbedtls_printf("\n");
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020056}
57
Gilles Peskine449bd832023-01-11 14:50:10 +010058static void dump_pubkey(const char *title, mbedtls_ecdsa_context *key)
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020059{
60 unsigned char buf[300];
61 size_t len;
62
Gilles Peskine52cc2a62023-06-22 22:32:05 +020063 if (mbedtls_ecp_write_public_key(key, MBEDTLS_ECP_PF_UNCOMPRESSED,
64 &len, buf, sizeof(buf)) != 0) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020065 mbedtls_printf("internal error\n");
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020066 return;
67 }
68
Gilles Peskine449bd832023-01-11 14:50:10 +010069 dump_buf(title, buf, len);
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020070}
71#else
Gilles Peskine449bd832023-01-11 14:50:10 +010072#define dump_buf(a, b, c)
73#define dump_pubkey(a, b)
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +020074#endif
75
Simon Butcher63cb97e2018-12-06 17:43:31 +000076
Gilles Peskine449bd832023-01-11 14:50:10 +010077int main(int argc, char *argv[])
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020078{
Andres Amaya Garcia2602a1f2018-04-29 19:45:25 +010079 int ret = 1;
80 int exit_code = MBEDTLS_EXIT_FAILURE;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020081 mbedtls_ecdsa_context ctx_sign, ctx_verify;
Gilles Peskine52cc2a62023-06-22 22:32:05 +020082 mbedtls_ecp_point Q;
83 mbedtls_ecp_point_init(&Q);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020084 mbedtls_entropy_context entropy;
85 mbedtls_ctr_drbg_context ctr_drbg;
Janos Follath0a5154b2017-03-10 11:31:41 +000086 unsigned char message[100];
87 unsigned char hash[32];
88 unsigned char sig[MBEDTLS_ECDSA_MAX_LEN];
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020089 size_t sig_len;
90 const char *pers = "ecdsa";
91 ((void) argv);
92
Gilles Peskine449bd832023-01-11 14:50:10 +010093 mbedtls_ecdsa_init(&ctx_sign);
94 mbedtls_ecdsa_init(&ctx_verify);
95 mbedtls_ctr_drbg_init(&ctr_drbg);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020096
Gilles Peskine449bd832023-01-11 14:50:10 +010097 memset(sig, 0, sizeof(sig));
98 memset(message, 0x25, sizeof(message));
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +020099
Gilles Peskine449bd832023-01-11 14:50:10 +0100100 if (argc != 1) {
101 mbedtls_printf("usage: ecdsa\n");
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200102
103#if defined(_WIN32)
Gilles Peskine449bd832023-01-11 14:50:10 +0100104 mbedtls_printf("\n");
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200105#endif
106
107 goto exit;
108 }
109
110 /*
111 * Generate a key pair for signing
112 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100113 mbedtls_printf("\n . Seeding the random number generator...");
114 fflush(stdout);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200115
Gilles Peskine449bd832023-01-11 14:50:10 +0100116 mbedtls_entropy_init(&entropy);
117 if ((ret = mbedtls_ctr_drbg_seed(&ctr_drbg, mbedtls_entropy_func, &entropy,
118 (const unsigned char *) pers,
119 strlen(pers))) != 0) {
120 mbedtls_printf(" failed\n ! mbedtls_ctr_drbg_seed returned %d\n", ret);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200121 goto exit;
122 }
123
Gilles Peskine449bd832023-01-11 14:50:10 +0100124 mbedtls_printf(" ok\n . Generating key pair...");
125 fflush(stdout);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200126
Gilles Peskine449bd832023-01-11 14:50:10 +0100127 if ((ret = mbedtls_ecdsa_genkey(&ctx_sign, ECPARAMS,
128 mbedtls_ctr_drbg_random, &ctr_drbg)) != 0) {
129 mbedtls_printf(" failed\n ! mbedtls_ecdsa_genkey returned %d\n", ret);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200130 goto exit;
131 }
132
Gilles Peskine52cc2a62023-06-22 22:32:05 +0200133 mbedtls_ecp_group_id grp_id = mbedtls_ecp_keypair_get_group_id(&ctx_sign);
134 const mbedtls_ecp_curve_info *curve_info =
135 mbedtls_ecp_curve_info_from_grp_id(grp_id);
136 mbedtls_printf(" ok (key size: %d bits)\n", (int) curve_info->bit_size);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200137
Gilles Peskine449bd832023-01-11 14:50:10 +0100138 dump_pubkey(" + Public key: ", &ctx_sign);
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +0200139
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200140 /*
Janos Follath0a5154b2017-03-10 11:31:41 +0000141 * Compute message hash
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200142 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 mbedtls_printf(" . Computing message hash...");
144 fflush(stdout);
Janos Follath0a5154b2017-03-10 11:31:41 +0000145
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if ((ret = mbedtls_sha256(message, sizeof(message), hash, 0)) != 0) {
147 mbedtls_printf(" failed\n ! mbedtls_sha256 returned %d\n", ret);
Andres Amaya Garcia1ff60f42017-06-28 13:26:36 +0100148 goto exit;
149 }
Janos Follath0a5154b2017-03-10 11:31:41 +0000150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 mbedtls_printf(" ok\n");
Janos Follath0a5154b2017-03-10 11:31:41 +0000152
Gilles Peskine449bd832023-01-11 14:50:10 +0100153 dump_buf(" + Hash: ", hash, sizeof(hash));
Janos Follath0a5154b2017-03-10 11:31:41 +0000154
155 /*
156 * Sign message hash
157 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 mbedtls_printf(" . Signing message hash...");
159 fflush(stdout);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200160
Gilles Peskine449bd832023-01-11 14:50:10 +0100161 if ((ret = mbedtls_ecdsa_write_signature(&ctx_sign, MBEDTLS_MD_SHA256,
162 hash, sizeof(hash),
163 sig, sizeof(sig), &sig_len,
164 mbedtls_ctr_drbg_random, &ctr_drbg)) != 0) {
165 mbedtls_printf(" failed\n ! mbedtls_ecdsa_write_signature returned %d\n", ret);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200166 goto exit;
167 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 mbedtls_printf(" ok (signature length = %u)\n", (unsigned int) sig_len);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200169
Gilles Peskine449bd832023-01-11 14:50:10 +0100170 dump_buf(" + Signature: ", sig, sig_len);
Manuel Pégourié-Gonnardb0a467f2013-09-21 12:31:05 +0200171
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200172 /*
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200173 * Transfer public information to verifying context
Manuel Pégourié-Gonnard4e3e7c22014-07-08 13:05:49 +0200174 *
175 * We could use the same context for verification and signatures, but we
176 * chose to use a new one in order to make it clear that the verifying
177 * context only needs the public key (Q), and not the private key (d).
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200178 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100179 mbedtls_printf(" . Preparing verification context...");
180 fflush(stdout);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200181
Gilles Peskine52cc2a62023-06-22 22:32:05 +0200182 if ((ret = mbedtls_ecp_export(&ctx_sign, NULL, NULL, &Q)) != 0) {
183 mbedtls_printf(" failed\n ! mbedtls_ecp_export returned %d\n", ret);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200184 goto exit;
185 }
186
Gilles Peskine52cc2a62023-06-22 22:32:05 +0200187 if ((ret = mbedtls_ecp_set_public_key(grp_id, &ctx_verify, &Q)) != 0) {
188 mbedtls_printf(" failed\n ! mbedtls_ecp_set_public_key returned %d\n", ret);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200189 goto exit;
190 }
191
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200192 /*
193 * Verify signature
194 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100195 mbedtls_printf(" ok\n . Verifying signature...");
196 fflush(stdout);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200197
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 if ((ret = mbedtls_ecdsa_read_signature(&ctx_verify,
199 hash, sizeof(hash),
200 sig, sig_len)) != 0) {
201 mbedtls_printf(" failed\n ! mbedtls_ecdsa_read_signature returned %d\n", ret);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200202 goto exit;
203 }
204
Gilles Peskine449bd832023-01-11 14:50:10 +0100205 mbedtls_printf(" ok\n");
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200206
Andres Amaya Garcia2602a1f2018-04-29 19:45:25 +0100207 exit_code = MBEDTLS_EXIT_SUCCESS;
208
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200209exit:
210
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 mbedtls_ecdsa_free(&ctx_verify);
212 mbedtls_ecdsa_free(&ctx_sign);
Gilles Peskine52cc2a62023-06-22 22:32:05 +0200213 mbedtls_ecp_point_free(&Q);
Gilles Peskine449bd832023-01-11 14:50:10 +0100214 mbedtls_ctr_drbg_free(&ctr_drbg);
215 mbedtls_entropy_free(&entropy);
Manuel Pégourié-Gonnardbf3109f2013-08-14 21:36:01 +0200216
Gilles Peskine449bd832023-01-11 14:50:10 +0100217 mbedtls_exit(exit_code);
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200218}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200219#endif /* MBEDTLS_ECDSA_C && MBEDTLS_ENTROPY_C && MBEDTLS_CTR_DRBG_C &&
Manuel Pégourié-Gonnardaa431612013-08-09 17:10:27 +0200220 ECPARAMS */