blob: 6e4bc6c04fdf7c634d617c36c89e20222bde7653 [file] [log] [blame]
Manuel Pégourié-Gonnard2aea1412013-01-26 16:33:44 +01001/**
2 * \file ecdsa.h
3 *
Rose Zadik817297f2018-03-27 11:30:14 +01004 * \brief This file contains ECDSA definitions and functions.
Manuel Pégourié-Gonnard2aea1412013-01-26 16:33:44 +01005 *
Rose Zadik817297f2018-03-27 11:30:14 +01006 * The Elliptic Curve Digital Signature Algorithm (ECDSA) is defined in
7 * <em>Standards for Efficient Cryptography Group (SECG):
Rose Zadikbff87d92018-01-25 21:58:53 +00008 * SEC1 Elliptic Curve Cryptography</em>.
9 * The use of ECDSA for TLS is defined in <em>RFC-4492: Elliptic Curve
10 * Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS)</em>.
11 *
Darryl Greena40a1012018-01-05 15:33:17 +000012 */
13/*
Rose Zadikbff87d92018-01-25 21:58:53 +000014 * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020015 * SPDX-License-Identifier: Apache-2.0
16 *
17 * Licensed under the Apache License, Version 2.0 (the "License"); you may
18 * not use this file except in compliance with the License.
19 * You may obtain a copy of the License at
20 *
21 * http://www.apache.org/licenses/LICENSE-2.0
22 *
23 * Unless required by applicable law or agreed to in writing, software
24 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
25 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
26 * See the License for the specific language governing permissions and
27 * limitations under the License.
Manuel Pégourié-Gonnard2aea1412013-01-26 16:33:44 +010028 *
Rose Zadikbff87d92018-01-25 21:58:53 +000029 * This file is part of Mbed TLS (https://tls.mbed.org)
Manuel Pégourié-Gonnard2aea1412013-01-26 16:33:44 +010030 */
Rose Zadikbff87d92018-01-25 21:58:53 +000031
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032#ifndef MBEDTLS_ECDSA_H
33#define MBEDTLS_ECDSA_H
Manuel Pégourié-Gonnard2aea1412013-01-26 16:33:44 +010034
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050035#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010036#include "mbedtls/config.h"
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050037#else
38#include MBEDTLS_CONFIG_FILE
39#endif
40
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010041#include "mbedtls/ecp.h"
42#include "mbedtls/md.h"
Manuel Pégourié-Gonnard4daaef72014-01-06 14:25:56 +010043
Manuel Pégourié-Gonnard2f2b3962018-11-12 15:06:57 +010044/**
45 * \brief Maximum ECDSA signature size for a given curve bit size
Manuel Pégourié-Gonnard63e93192015-03-31 11:15:48 +020046 *
Manuel Pégourié-Gonnard2f2b3962018-11-12 15:06:57 +010047 * \param bits Curve size in bits
48 * \return Maximum signature size in bytes
49 *
50 * \note This macro returns a compile-time constant if its argument
51 * is one. It may evaluate its argument multiple times.
52 */
53/*
Manuel Pégourié-Gonnard63e93192015-03-31 11:15:48 +020054 * Ecdsa-Sig-Value ::= SEQUENCE {
55 * r INTEGER,
56 * s INTEGER
57 * }
58 *
Manuel Pégourié-Gonnard2f2b3962018-11-12 15:06:57 +010059 * For each of r and s, the value (V) may include an extra initial "0" bit.
Manuel Pégourié-Gonnard63e93192015-03-31 11:15:48 +020060 */
Manuel Pégourié-Gonnard2f2b3962018-11-12 15:06:57 +010061#define MBEDTLS_ECDSA_MAX_SIG_LEN( bits ) \
62 ( /*T,L of SEQUENCE*/ ( ( bits ) >= 61 * 8 ? 3 : 2 ) + \
63 /*T,L of r,s*/ 2 * ( ( ( bits ) >= 127 * 8 ? 3 : 2 ) + \
64 /*V of r,s*/ ( ( bits ) + 8 ) / 8 ) )
65
Rose Zadikbff87d92018-01-25 21:58:53 +000066/** The maximal size of an ECDSA signature in Bytes. */
Manuel Pégourié-Gonnard2f2b3962018-11-12 15:06:57 +010067#define MBEDTLS_ECDSA_MAX_LEN MBEDTLS_ECDSA_MAX_SIG_LEN( MBEDTLS_ECP_MAX_BITS )
Manuel Pégourié-Gonnard63e93192015-03-31 11:15:48 +020068
Manuel Pégourié-Gonnard32aa4372017-04-21 10:29:13 +020069#ifdef __cplusplus
70extern "C" {
71#endif
72
Manuel Pégourié-Gonnardbec2f452013-06-27 10:17:07 +020073/**
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +020074 * \brief The ECDSA context structure.
Manuel Pégourié-Gonnardeaf55be2017-08-23 14:40:21 +020075 *
76 * \warning Performing multiple operations concurrently on the same
77 * ECDSA context is not supported; objects of this type
78 * should not be shared between multiple threads.
Manuel Pégourié-Gonnardbec2f452013-06-27 10:17:07 +020079 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020080typedef mbedtls_ecp_keypair mbedtls_ecdsa_context;
Manuel Pégourié-Gonnardbec2f452013-06-27 10:17:07 +020081
Manuel Pégourié-Gonnard32aa4372017-04-21 10:29:13 +020082#if defined(MBEDTLS_ECP_RESTARTABLE)
83
84/**
Manuel Pégourié-Gonnarda0c5bcc2017-04-21 11:33:57 +020085 * \brief Internal restart context for ecdsa_verify()
86 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +020087 * \note Opaque struct, defined in ecdsa.c
Manuel Pégourié-Gonnarda0c5bcc2017-04-21 11:33:57 +020088 */
89typedef struct mbedtls_ecdsa_restart_ver mbedtls_ecdsa_restart_ver_ctx;
90
91/**
Manuel Pégourié-Gonnardb90883d2017-04-25 11:33:10 +020092 * \brief Internal restart context for ecdsa_sign()
93 *
94 * \note Opaque struct, defined in ecdsa.c
95 */
96typedef struct mbedtls_ecdsa_restart_sig mbedtls_ecdsa_restart_sig_ctx;
97
98#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
99/**
100 * \brief Internal restart context for ecdsa_sign_det()
101 *
102 * \note Opaque struct, defined in ecdsa.c
103 */
104typedef struct mbedtls_ecdsa_restart_det mbedtls_ecdsa_restart_det_ctx;
105#endif
106
107/**
Manuel Pégourié-Gonnard32aa4372017-04-21 10:29:13 +0200108 * \brief General context for resuming ECDSA operations
109 */
110typedef struct
111{
Manuel Pégourié-Gonnard12e4a8b2018-09-12 10:55:15 +0200112 mbedtls_ecp_restart_ctx ecp; /*!< base context for ECP restart and
113 shared administrative info */
Manuel Pégourié-Gonnarda0c5bcc2017-04-21 11:33:57 +0200114 mbedtls_ecdsa_restart_ver_ctx *ver; /*!< ecdsa_verify() sub-context */
Manuel Pégourié-Gonnardb90883d2017-04-25 11:33:10 +0200115 mbedtls_ecdsa_restart_sig_ctx *sig; /*!< ecdsa_sign() sub-context */
116#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
117 mbedtls_ecdsa_restart_det_ctx *det; /*!< ecdsa_sign_det() sub-context */
118#endif
Manuel Pégourié-Gonnard32aa4372017-04-21 10:29:13 +0200119} mbedtls_ecdsa_restart_ctx;
120
121#else /* MBEDTLS_ECP_RESTARTABLE */
122
123/* Now we can declare functions that take a pointer to that */
124typedef void mbedtls_ecdsa_restart_ctx;
125
126#endif /* MBEDTLS_ECP_RESTARTABLE */
Manuel Pégourié-Gonnard2aea1412013-01-26 16:33:44 +0100127
128/**
Christoph M. Wintersteiger0082f9d2019-01-07 13:47:30 +0000129 * \brief This function checks whether a given group can be used
130 * for ECDSA.
131 *
132 * \param gid The ECP group ID to check.
133 *
134 * \return \c 1 if the group can be used, \c 0 otherwise
135 */
136int mbedtls_ecdsa_can_do( mbedtls_ecp_group_id gid );
137
138/**
Rose Zadikbff87d92018-01-25 21:58:53 +0000139 * \brief This function computes the ECDSA signature of a
140 * previously-hashed message.
Manuel Pégourié-Gonnardb309ab22013-01-26 17:24:59 +0100141 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500142 * \note The deterministic version implemented in
143 * mbedtls_ecdsa_sign_det() is usually preferred.
Manuel Pégourié-Gonnardb309ab22013-01-26 17:24:59 +0100144 *
Janos Follath0a5154b2017-03-10 11:31:41 +0000145 * \note If the bitlength of the message hash is larger than the
Rose Zadik817297f2018-03-27 11:30:14 +0100146 * bitlength of the group order, then the hash is truncated
147 * as defined in <em>Standards for Efficient Cryptography Group
148 * (SECG): SEC1 Elliptic Curve Cryptography</em>, section
149 * 4.1.3, step 5.
Janos Follath0a5154b2017-03-10 11:31:41 +0000150 *
Rose Zadik817297f2018-03-27 11:30:14 +0100151 * \see ecp.h
152 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500153 * \param grp The context for the elliptic curve to use.
154 * This must be initialized and have group parameters
155 * set, for example through mbedtls_ecp_group_load().
156 * \param r The MPI context in which to store the first part
157 * the signature. This must be initialized.
158 * \param s The MPI context in which to store the second part
159 * the signature. This must be initialized.
160 * \param d The private signing key. This must be initialized.
161 * \param buf The content to be signed. This is usually the hash of
162 * the original data to be signed. This must be a readable
163 * buffer of length \p blen Bytes. It may be \c NULL if
164 * \p blen is zero.
165 * \param blen The length of \p buf in Bytes.
166 * \param f_rng The RNG function. This must not be \c NULL.
167 * \param p_rng The RNG context to be passed to \p f_rng. This may be
168 * \c NULL if \p f_rng doesn't need a context parameter.
Manuel Pégourié-Gonnardb309ab22013-01-26 17:24:59 +0100169 *
Rose Zadik817297f2018-03-27 11:30:14 +0100170 * \return \c 0 on success.
171 * \return An \c MBEDTLS_ERR_ECP_XXX
Rose Zadikbff87d92018-01-25 21:58:53 +0000172 * or \c MBEDTLS_MPI_XXX error code on failure.
Manuel Pégourié-Gonnardb309ab22013-01-26 17:24:59 +0100173 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200174int mbedtls_ecdsa_sign( mbedtls_ecp_group *grp, mbedtls_mpi *r, mbedtls_mpi *s,
175 const mbedtls_mpi *d, const unsigned char *buf, size_t blen,
Manuel Pégourié-Gonnardb309ab22013-01-26 17:24:59 +0100176 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200178#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
Manuel Pégourié-Gonnard4daaef72014-01-06 14:25:56 +0100179/**
Rose Zadikbff87d92018-01-25 21:58:53 +0000180 * \brief This function computes the ECDSA signature of a
181 * previously-hashed message, deterministic version.
Manuel Pégourié-Gonnard4daaef72014-01-06 14:25:56 +0100182 *
Rose Zadikbff87d92018-01-25 21:58:53 +0000183 * For more information, see <em>RFC-6979: Deterministic
184 * Usage of the Digital Signature Algorithm (DSA) and Elliptic
185 * Curve Digital Signature Algorithm (ECDSA)</em>.
Manuel Pégourié-Gonnard4daaef72014-01-06 14:25:56 +0100186 *
Janos Follath0a5154b2017-03-10 11:31:41 +0000187 * \note If the bitlength of the message hash is larger than the
188 * bitlength of the group order, then the hash is truncated as
Rose Zadik817297f2018-03-27 11:30:14 +0100189 * defined in <em>Standards for Efficient Cryptography Group
190 * (SECG): SEC1 Elliptic Curve Cryptography</em>, section
191 * 4.1.3, step 5.
Janos Follath0a5154b2017-03-10 11:31:41 +0000192 *
Rose Zadik817297f2018-03-27 11:30:14 +0100193 * \see ecp.h
194 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500195 * \param grp The context for the elliptic curve to use.
196 * This must be initialized and have group parameters
197 * set, for example through mbedtls_ecp_group_load().
198 * \param r The MPI context in which to store the first part
199 * the signature. This must be initialized.
200 * \param s The MPI context in which to store the second part
201 * the signature. This must be initialized.
202 * \param d The private signing key. This must be initialized
203 * and setup, for example through mbedtls_ecp_gen_privkey().
204 * \param buf The hashed content to be signed. This must be a readable
205 * buffer of length \p blen Bytes. It may be \c NULL if
206 * \p blen is zero.
207 * \param blen The length of \p buf in Bytes.
208 * \param md_alg The hash algorithm used to hash the original data.
Manuel Pégourié-Gonnard4daaef72014-01-06 14:25:56 +0100209 *
Rose Zadik817297f2018-03-27 11:30:14 +0100210 * \return \c 0 on success.
Rose Zadik14d0d572018-04-16 16:09:30 +0100211 * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX
Rose Zadikbff87d92018-01-25 21:58:53 +0000212 * error code on failure.
Manuel Pégourié-Gonnard4daaef72014-01-06 14:25:56 +0100213 */
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500214int mbedtls_ecdsa_sign_det( mbedtls_ecp_group *grp, mbedtls_mpi *r,
215 mbedtls_mpi *s, const mbedtls_mpi *d,
216 const unsigned char *buf, size_t blen,
217 mbedtls_md_type_t md_alg );
Janos Follathdca667a2019-01-04 14:32:30 +0000218/**
219 * \brief This function computes the ECDSA signature of a
220 * previously-hashed message, deterministic version.
221 *
222 * For more information, see <em>RFC-6979: Deterministic
223 * Usage of the Digital Signature Algorithm (DSA) and Elliptic
224 * Curve Digital Signature Algorithm (ECDSA)</em>.
225 *
226 * \note If the bitlength of the message hash is larger than the
227 * bitlength of the group order, then the hash is truncated as
228 * defined in <em>Standards for Efficient Cryptography Group
229 * (SECG): SEC1 Elliptic Curve Cryptography</em>, section
230 * 4.1.3, step 5.
231 *
232 * \see ecp.h
233 *
234 * \param grp The context for the elliptic curve to use.
235 * This must be initialized and have group parameters
236 * set, for example through mbedtls_ecp_group_load().
237 * \param r The MPI context in which to store the first part
238 * the signature. This must be initialized.
239 * \param s The MPI context in which to store the second part
240 * the signature. This must be initialized.
241 * \param d The private signing key. This must be initialized
242 * and setup, for example through mbedtls_ecp_gen_privkey().
243 * \param buf The hashed content to be signed. This must be a readable
244 * buffer of length \p blen Bytes. It may be \c NULL if
245 * \p blen is zero.
246 * \param blen The length of \p buf in Bytes.
247 * \param md_alg The hash algorithm used to hash the original data.
248 * \param f_rng_blind The RNG function used for blinding. This must not be
249 * \c NULL.
250 * \param p_rng_blind The RNG context to be passed to \p f_rng. This may be
251 * \c NULL if \p f_rng doesn't need a context parameter.
252 *
253 * \return \c 0 on success.
254 * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX
255 * error code on failure.
256 */
257int mbedtls_ecdsa_sign_det_ext( mbedtls_ecp_group *grp, mbedtls_mpi *r,
258 mbedtls_mpi *s, const mbedtls_mpi *d,
259 const unsigned char *buf, size_t blen,
260 mbedtls_md_type_t md_alg,
261 int (*f_rng_blind)(void *, unsigned char *, size_t),
262 void *p_rng_blind );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200263#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Manuel Pégourié-Gonnard4daaef72014-01-06 14:25:56 +0100264
Manuel Pégourié-Gonnardb309ab22013-01-26 17:24:59 +0100265/**
Rose Zadikbff87d92018-01-25 21:58:53 +0000266 * \brief This function verifies the ECDSA signature of a
267 * previously-hashed message.
Manuel Pégourié-Gonnard3aeb5a72013-01-26 18:05:50 +0100268 *
Janos Follath0a5154b2017-03-10 11:31:41 +0000269 * \note If the bitlength of the message hash is larger than the
270 * bitlength of the group order, then the hash is truncated as
Rose Zadik817297f2018-03-27 11:30:14 +0100271 * defined in <em>Standards for Efficient Cryptography Group
272 * (SECG): SEC1 Elliptic Curve Cryptography</em>, section
273 * 4.1.4, step 3.
Janos Follath0a5154b2017-03-10 11:31:41 +0000274 *
Rose Zadik817297f2018-03-27 11:30:14 +0100275 * \see ecp.h
276 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500277 * \param grp The ECP group to use.
278 * This must be initialized and have group parameters
279 * set, for example through mbedtls_ecp_group_load().
280 * \param buf The hashed content that was signed. This must be a readable
281 * buffer of length \p blen Bytes. It may be \c NULL if
282 * \p blen is zero.
283 * \param blen The length of \p buf in Bytes.
284 * \param Q The public key to use for verification. This must be
285 * initialized and setup.
Rose Zadikbff87d92018-01-25 21:58:53 +0000286 * \param r The first integer of the signature.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500287 * This must be initialized.
Rose Zadikbff87d92018-01-25 21:58:53 +0000288 * \param s The second integer of the signature.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500289 * This must be initialized.
Manuel Pégourié-Gonnard3aeb5a72013-01-26 18:05:50 +0100290 *
Rose Zadik817297f2018-03-27 11:30:14 +0100291 * \return \c 0 on success.
Rose Zadik14d0d572018-04-16 16:09:30 +0100292 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if the signature
293 * is invalid.
Rose Zadik817297f2018-03-27 11:30:14 +0100294 * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX
Rose Zadikbff87d92018-01-25 21:58:53 +0000295 * error code on failure for any other reason.
Manuel Pégourié-Gonnard3aeb5a72013-01-26 18:05:50 +0100296 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200297int mbedtls_ecdsa_verify( mbedtls_ecp_group *grp,
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500298 const unsigned char *buf, size_t blen,
299 const mbedtls_ecp_point *Q, const mbedtls_mpi *r,
300 const mbedtls_mpi *s);
Manuel Pégourié-Gonnard3aeb5a72013-01-26 18:05:50 +0100301
302/**
Rose Zadikbff87d92018-01-25 21:58:53 +0000303 * \brief This function computes the ECDSA signature and writes it
304 * to a buffer, serialized as defined in <em>RFC-4492:
305 * Elliptic Curve Cryptography (ECC) Cipher Suites for
306 * Transport Layer Security (TLS)</em>.
Manuel Pégourié-Gonnardb694b482013-08-08 13:30:57 +0200307 *
Rose Zadikbff87d92018-01-25 21:58:53 +0000308 * \warning It is not thread-safe to use the same context in
309 * multiple threads.
Manuel Pégourié-Gonnarddfdcac92015-03-31 11:41:42 +0200310 *
Rose Zadikbff87d92018-01-25 21:58:53 +0000311 * \note The deterministic version is used if
312 * #MBEDTLS_ECDSA_DETERMINISTIC is defined. For more
313 * information, see <em>RFC-6979: Deterministic Usage
314 * of the Digital Signature Algorithm (DSA) and Elliptic
315 * Curve Digital Signature Algorithm (ECDSA)</em>.
Manuel Pégourié-Gonnardb694b482013-08-08 13:30:57 +0200316 *
Janos Follath0a5154b2017-03-10 11:31:41 +0000317 * \note If the bitlength of the message hash is larger than the
318 * bitlength of the group order, then the hash is truncated as
Rose Zadikbff87d92018-01-25 21:58:53 +0000319 * defined in <em>Standards for Efficient Cryptography Group
320 * (SECG): SEC1 Elliptic Curve Cryptography</em>, section
321 * 4.1.3, step 5.
Janos Follath0a5154b2017-03-10 11:31:41 +0000322 *
Rose Zadikbff87d92018-01-25 21:58:53 +0000323 * \see ecp.h
Rose Zadik817297f2018-03-27 11:30:14 +0100324 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500325 * \param ctx The ECDSA context to use. This must be initialized
326 * and have a group and private key bound to it, for example
327 * via mbedtls_ecdsa_genkey() or mbedtls_ecdsa_from_keypair().
Rose Zadik817297f2018-03-27 11:30:14 +0100328 * \param md_alg The message digest that was used to hash the message.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500329 * \param hash The message hash to be signed. This must be a readable
330 * buffer of length \p blen Bytes.
331 * \param hlen The length of the hash \p hash in Bytes.
332 * \param sig The buffer to which to write the signature. This must be a
333 * writable buffer of length at least twice as large as the
334 * size of the curve used, plus 9. For example, 73 Bytes if
335 * a 256-bit curve is used. A buffer length of
336 * #MBEDTLS_ECDSA_MAX_LEN is always safe.
337 * \param slen The address at which to store the actual length of
338 * the signature written. Must not be \c NULL.
339 * \param f_rng The RNG function. This must not be \c NULL if
340 * #MBEDTLS_ECDSA_DETERMINISTIC is unset. Otherwise,
341 * it is unused and may be set to \c NULL.
342 * \param p_rng The RNG context to be passed to \p f_rng. This may be
343 * \c NULL if \p f_rng is \c NULL or doesn't use a context.
Rose Zadik817297f2018-03-27 11:30:14 +0100344 *
345 * \return \c 0 on success.
346 * \return An \c MBEDTLS_ERR_ECP_XXX, \c MBEDTLS_ERR_MPI_XXX or
347 * \c MBEDTLS_ERR_ASN1_XXX error code on failure.
Manuel Pégourié-Gonnardb694b482013-08-08 13:30:57 +0200348 */
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500349int mbedtls_ecdsa_write_signature( mbedtls_ecdsa_context *ctx,
350 mbedtls_md_type_t md_alg,
Manuel Pégourié-Gonnardb694b482013-08-08 13:30:57 +0200351 const unsigned char *hash, size_t hlen,
352 unsigned char *sig, size_t *slen,
353 int (*f_rng)(void *, unsigned char *, size_t),
354 void *p_rng );
355
Manuel Pégourié-Gonnardaddb10e2017-04-21 12:54:46 +0200356/**
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200357 * \brief This function computes the ECDSA signature and writes it
358 * to a buffer, in a restartable way.
Manuel Pégourié-Gonnardaddb10e2017-04-21 12:54:46 +0200359 *
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200360 * \see \c mbedtls_ecdsa_write_signature()
361 *
362 * \note This function is like \c mbedtls_ecdsa_write_signature()
363 * but it can return early and restart according to the limit
Manuel Pégourié-Gonnardaddb10e2017-04-21 12:54:46 +0200364 * set with \c mbedtls_ecp_set_max_ops() to reduce blocking.
365 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500366 * \param ctx The ECDSA context to use. This must be initialized
367 * and have a group and private key bound to it, for example
368 * via mbedtls_ecdsa_genkey() or mbedtls_ecdsa_from_keypair().
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200369 * \param md_alg The message digest that was used to hash the message.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500370 * \param hash The message hash to be signed. This must be a readable
371 * buffer of length \p blen Bytes.
372 * \param hlen The length of the hash \p hash in Bytes.
373 * \param sig The buffer to which to write the signature. This must be a
374 * writable buffer of length at least twice as large as the
375 * size of the curve used, plus 9. For example, 73 Bytes if
376 * a 256-bit curve is used. A buffer length of
377 * #MBEDTLS_ECDSA_MAX_LEN is always safe.
378 * \param slen The address at which to store the actual length of
379 * the signature written. Must not be \c NULL.
380 * \param f_rng The RNG function. This must not be \c NULL if
381 * #MBEDTLS_ECDSA_DETERMINISTIC is unset. Otherwise,
382 * it is unused and may be set to \c NULL.
383 * \param p_rng The RNG context to be passed to \p f_rng. This may be
384 * \c NULL if \p f_rng is \c NULL or doesn't use a context.
385 * \param rs_ctx The restart context to use. This may be \c NULL to disable
386 * restarting. If it is not \c NULL, it must point to an
387 * initialized restart context.
Manuel Pégourié-Gonnardaddb10e2017-04-21 12:54:46 +0200388 *
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200389 * \return \c 0 on success.
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200390 * \return #MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of
Manuel Pégourié-Gonnardaddb10e2017-04-21 12:54:46 +0200391 * operations was reached: see \c mbedtls_ecp_set_max_ops().
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200392 * \return Another \c MBEDTLS_ERR_ECP_XXX, \c MBEDTLS_ERR_MPI_XXX or
393 * \c MBEDTLS_ERR_ASN1_XXX error code on failure.
Manuel Pégourié-Gonnardaddb10e2017-04-21 12:54:46 +0200394 */
395int mbedtls_ecdsa_write_signature_restartable( mbedtls_ecdsa_context *ctx,
396 mbedtls_md_type_t md_alg,
397 const unsigned char *hash, size_t hlen,
398 unsigned char *sig, size_t *slen,
399 int (*f_rng)(void *, unsigned char *, size_t),
400 void *p_rng,
401 mbedtls_ecdsa_restart_ctx *rs_ctx );
402
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200403#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
404#if ! defined(MBEDTLS_DEPRECATED_REMOVED)
405#if defined(MBEDTLS_DEPRECATED_WARNING)
406#define MBEDTLS_DEPRECATED __attribute__((deprecated))
Manuel Pégourié-Gonnarddfdcac92015-03-31 11:41:42 +0200407#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200408#define MBEDTLS_DEPRECATED
Manuel Pégourié-Gonnarddfdcac92015-03-31 11:41:42 +0200409#endif
Manuel Pégourié-Gonnard937340b2014-01-06 10:27:16 +0100410/**
Rose Zadik817297f2018-03-27 11:30:14 +0100411 * \brief This function computes an ECDSA signature and writes
412 * it to a buffer, serialized as defined in <em>RFC-4492:
413 * Elliptic Curve Cryptography (ECC) Cipher Suites for
414 * Transport Layer Security (TLS)</em>.
Manuel Pégourié-Gonnard937340b2014-01-06 10:27:16 +0100415 *
Rose Zadik817297f2018-03-27 11:30:14 +0100416 * The deterministic version is defined in <em>RFC-6979:
417 * Deterministic Usage of the Digital Signature Algorithm (DSA)
418 * and Elliptic Curve Digital Signature Algorithm (ECDSA)</em>.
Manuel Pégourié-Gonnarddfdcac92015-03-31 11:41:42 +0200419 *
Rose Zadikbff87d92018-01-25 21:58:53 +0000420 * \warning It is not thread-safe to use the same context in
421 * multiple threads.
Manuel Pégourié-Gonnard937340b2014-01-06 10:27:16 +0100422 *
Janos Follath0a5154b2017-03-10 11:31:41 +0000423 * \note If the bitlength of the message hash is larger than the
424 * bitlength of the group order, then the hash is truncated as
Rose Zadikbff87d92018-01-25 21:58:53 +0000425 * defined in <em>Standards for Efficient Cryptography Group
426 * (SECG): SEC1 Elliptic Curve Cryptography</em>, section
427 * 4.1.3, step 5.
Janos Follath0a5154b2017-03-10 11:31:41 +0000428 *
Rose Zadikbff87d92018-01-25 21:58:53 +0000429 * \see ecp.h
Rose Zadik817297f2018-03-27 11:30:14 +0100430 *
Rose Zadikec5d4162018-04-17 15:55:28 +0100431 * \deprecated Superseded by mbedtls_ecdsa_write_signature() in
432 * Mbed TLS version 2.0 and later.
Rose Zadik817297f2018-03-27 11:30:14 +0100433 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500434 * \param ctx The ECDSA context to use. This must be initialized
435 * and have a group and private key bound to it, for example
436 * via mbedtls_ecdsa_genkey() or mbedtls_ecdsa_from_keypair().
437 * \param hash The message hash to be signed. This must be a readable
438 * buffer of length \p blen Bytes.
439 * \param hlen The length of the hash \p hash in Bytes.
440 * \param sig The buffer to which to write the signature. This must be a
441 * writable buffer of length at least twice as large as the
442 * size of the curve used, plus 9. For example, 73 Bytes if
443 * a 256-bit curve is used. A buffer length of
444 * #MBEDTLS_ECDSA_MAX_LEN is always safe.
445 * \param slen The address at which to store the actual length of
446 * the signature written. Must not be \c NULL.
447 * \param md_alg The message digest that was used to hash the message.
Rose Zadik817297f2018-03-27 11:30:14 +0100448 *
449 * \return \c 0 on success.
450 * \return An \c MBEDTLS_ERR_ECP_XXX, \c MBEDTLS_ERR_MPI_XXX or
451 * \c MBEDTLS_ERR_ASN1_XXX error code on failure.
Manuel Pégourié-Gonnard937340b2014-01-06 10:27:16 +0100452 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200453int mbedtls_ecdsa_write_signature_det( mbedtls_ecdsa_context *ctx,
Manuel Pégourié-Gonnard937340b2014-01-06 10:27:16 +0100454 const unsigned char *hash, size_t hlen,
455 unsigned char *sig, size_t *slen,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200456 mbedtls_md_type_t md_alg ) MBEDTLS_DEPRECATED;
457#undef MBEDTLS_DEPRECATED
458#endif /* MBEDTLS_DEPRECATED_REMOVED */
459#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
Manuel Pégourié-Gonnard937340b2014-01-06 10:27:16 +0100460
Manuel Pégourié-Gonnardb694b482013-08-08 13:30:57 +0200461/**
Rose Zadikbff87d92018-01-25 21:58:53 +0000462 * \brief This function reads and verifies an ECDSA signature.
Manuel Pégourié-Gonnardb694b482013-08-08 13:30:57 +0200463 *
Janos Follath0a5154b2017-03-10 11:31:41 +0000464 * \note If the bitlength of the message hash is larger than the
465 * bitlength of the group order, then the hash is truncated as
Rose Zadikbff87d92018-01-25 21:58:53 +0000466 * defined in <em>Standards for Efficient Cryptography Group
467 * (SECG): SEC1 Elliptic Curve Cryptography</em>, section
468 * 4.1.4, step 3.
Janos Follath0a5154b2017-03-10 11:31:41 +0000469 *
Rose Zadikbff87d92018-01-25 21:58:53 +0000470 * \see ecp.h
Rose Zadik817297f2018-03-27 11:30:14 +0100471 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500472 * \param ctx The ECDSA context to use. This must be initialized
473 * and have a group and public key bound to it.
474 * \param hash The message hash that was signed. This must be a readable
475 * buffer of length \p size Bytes.
476 * \param hlen The size of the hash \p hash.
477 * \param sig The signature to read and verify. This must be a readable
478 * buffer of length \p slen Bytes.
479 * \param slen The size of \p sig in Bytes.
Rose Zadik817297f2018-03-27 11:30:14 +0100480 *
481 * \return \c 0 on success.
482 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if signature is invalid.
Rose Zadikabc9ec72018-04-23 06:16:40 +0100483 * \return #MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH if there is a valid
484 * signature in \p sig, but its length is less than \p siglen.
Rose Zadik817297f2018-03-27 11:30:14 +0100485 * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_ERR_MPI_XXX
486 * error code on failure for any other reason.
Manuel Pégourié-Gonnardb694b482013-08-08 13:30:57 +0200487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200488int mbedtls_ecdsa_read_signature( mbedtls_ecdsa_context *ctx,
Manuel Pégourié-Gonnardb694b482013-08-08 13:30:57 +0200489 const unsigned char *hash, size_t hlen,
490 const unsigned char *sig, size_t slen );
491
492/**
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200493 * \brief This function reads and verifies an ECDSA signature,
494 * in a restartable way.
Manuel Pégourié-Gonnard32aa4372017-04-21 10:29:13 +0200495 *
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200496 * \see \c mbedtls_ecdsa_read_signature()
497 *
498 * \note This function is like \c mbedtls_ecdsa_read_signature()
499 * but it can return early and restart according to the limit
Manuel Pégourié-Gonnard32aa4372017-04-21 10:29:13 +0200500 * set with \c mbedtls_ecp_set_max_ops() to reduce blocking.
501 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500502 * \param ctx The ECDSA context to use. This must be initialized
503 * and have a group and public key bound to it.
504 * \param hash The message hash that was signed. This must be a readable
505 * buffer of length \p size Bytes.
506 * \param hlen The size of the hash \p hash.
507 * \param sig The signature to read and verify. This must be a readable
508 * buffer of length \p slen Bytes.
509 * \param slen The size of \p sig in Bytes.
510 * \param rs_ctx The restart context to use. This may be \c NULL to disable
511 * restarting. If it is not \c NULL, it must point to an
512 * initialized restart context.
Manuel Pégourié-Gonnard32aa4372017-04-21 10:29:13 +0200513 *
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200514 * \return \c 0 on success.
515 * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if signature is invalid.
516 * \return #MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH if there is a valid
517 * signature in \p sig, but its length is less than \p siglen.
Manuel Pégourié-Gonnardda19f4c2018-06-12 12:40:54 +0200518 * \return #MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of
Manuel Pégourié-Gonnard32aa4372017-04-21 10:29:13 +0200519 * operations was reached: see \c mbedtls_ecp_set_max_ops().
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200520 * \return Another \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_ERR_MPI_XXX
521 * error code on failure for any other reason.
Manuel Pégourié-Gonnard32aa4372017-04-21 10:29:13 +0200522 */
523int mbedtls_ecdsa_read_signature_restartable( mbedtls_ecdsa_context *ctx,
524 const unsigned char *hash, size_t hlen,
525 const unsigned char *sig, size_t slen,
526 mbedtls_ecdsa_restart_ctx *rs_ctx );
Christoph M. Wintersteigeref17e3b2019-02-15 12:52:09 +0000527
Manuel Pégourié-Gonnard32aa4372017-04-21 10:29:13 +0200528/**
Rose Zadikbff87d92018-01-25 21:58:53 +0000529 * \brief This function generates an ECDSA keypair on the given curve.
Manuel Pégourié-Gonnard8eebd012013-08-09 16:21:34 +0200530 *
Rose Zadik817297f2018-03-27 11:30:14 +0100531 * \see ecp.h
Manuel Pégourié-Gonnard8eebd012013-08-09 16:21:34 +0200532 *
Rose Zadikbff87d92018-01-25 21:58:53 +0000533 * \param ctx The ECDSA context to store the keypair in.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500534 * This must be initialized.
Rose Zadikbff87d92018-01-25 21:58:53 +0000535 * \param gid The elliptic curve to use. One of the various
536 * \c MBEDTLS_ECP_DP_XXX macros depending on configuration.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500537 * \param f_rng The RNG function to use. This must not be \c NULL.
538 * \param p_rng The RNG context to be passed to \p f_rng. This may be
539 * \c NULL if \p f_rng doesn't need a context argument.
Manuel Pégourié-Gonnard8eebd012013-08-09 16:21:34 +0200540 *
Rose Zadik817297f2018-03-27 11:30:14 +0100541 * \return \c 0 on success.
542 * \return An \c MBEDTLS_ERR_ECP_XXX code on failure.
Manuel Pégourié-Gonnard8eebd012013-08-09 16:21:34 +0200543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200544int mbedtls_ecdsa_genkey( mbedtls_ecdsa_context *ctx, mbedtls_ecp_group_id gid,
Manuel Pégourié-Gonnard8eebd012013-08-09 16:21:34 +0200545 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
546
547/**
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500548 * \brief This function sets up an ECDSA context from an EC key pair.
Manuel Pégourié-Gonnardf4999932013-08-12 17:02:59 +0200549 *
Rose Zadik817297f2018-03-27 11:30:14 +0100550 * \see ecp.h
Manuel Pégourié-Gonnardf4999932013-08-12 17:02:59 +0200551 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500552 * \param ctx The ECDSA context to setup. This must be initialized.
553 * \param key The EC key to use. This must be initialized and hold
554 * a private-public key pair or a public key. In the former
555 * case, the ECDSA context may be used for signature creation
556 * and verification after this call. In the latter case, it
557 * may be used for signature verification.
Manuel Pégourié-Gonnardf4999932013-08-12 17:02:59 +0200558 *
Rose Zadik817297f2018-03-27 11:30:14 +0100559 * \return \c 0 on success.
560 * \return An \c MBEDTLS_ERR_ECP_XXX code on failure.
Manuel Pégourié-Gonnardf4999932013-08-12 17:02:59 +0200561 */
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500562int mbedtls_ecdsa_from_keypair( mbedtls_ecdsa_context *ctx,
563 const mbedtls_ecp_keypair *key );
Manuel Pégourié-Gonnardf4999932013-08-12 17:02:59 +0200564
565/**
Rose Zadikbff87d92018-01-25 21:58:53 +0000566 * \brief This function initializes an ECDSA context.
Manuel Pégourié-Gonnard7c8934e2013-06-27 12:54:02 +0200567 *
Rose Zadikbff87d92018-01-25 21:58:53 +0000568 * \param ctx The ECDSA context to initialize.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500569 * This must not be \c NULL.
Manuel Pégourié-Gonnard7c8934e2013-06-27 12:54:02 +0200570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571void mbedtls_ecdsa_init( mbedtls_ecdsa_context *ctx );
Manuel Pégourié-Gonnard7c8934e2013-06-27 12:54:02 +0200572
573/**
Rose Zadikbff87d92018-01-25 21:58:53 +0000574 * \brief This function frees an ECDSA context.
Manuel Pégourié-Gonnard7c8934e2013-06-27 12:54:02 +0200575 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500576 * \param ctx The ECDSA context to free. This may be \c NULL,
577 * in which case this function does nothing. If it
578 * is not \c NULL, it must be initialized.
Manuel Pégourié-Gonnard7c8934e2013-06-27 12:54:02 +0200579 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200580void mbedtls_ecdsa_free( mbedtls_ecdsa_context *ctx );
Manuel Pégourié-Gonnard7c8934e2013-06-27 12:54:02 +0200581
Manuel Pégourié-Gonnard32aa4372017-04-21 10:29:13 +0200582#if defined(MBEDTLS_ECP_RESTARTABLE)
583/**
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500584 * \brief Initialize a restart context.
585 *
586 * \param ctx The restart context to initialize.
587 * This must not be \c NULL.
Manuel Pégourié-Gonnard32aa4372017-04-21 10:29:13 +0200588 */
589void mbedtls_ecdsa_restart_init( mbedtls_ecdsa_restart_ctx *ctx );
590
591/**
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500592 * \brief Free the components of a restart context.
593 *
594 * \param ctx The restart context to free. This may be \c NULL,
595 * in which case this function does nothing. If it
596 * is not \c NULL, it must be initialized.
Manuel Pégourié-Gonnard32aa4372017-04-21 10:29:13 +0200597 */
598void mbedtls_ecdsa_restart_free( mbedtls_ecdsa_restart_ctx *ctx );
599#endif /* MBEDTLS_ECP_RESTARTABLE */
600
Manuel Pégourié-Gonnard2aea1412013-01-26 16:33:44 +0100601#ifdef __cplusplus
602}
603#endif
604
Paul Bakker9af723c2014-05-01 13:03:14 +0200605#endif /* ecdsa.h */