Mbed TLS v3.6.4
ecdsa.h
Go to the documentation of this file.
1 
13 /*
14  * Copyright The Mbed TLS Contributors
15  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
16  */
17 
18 #ifndef MBEDTLS_ECDSA_H
19 #define MBEDTLS_ECDSA_H
20 #include "mbedtls/private_access.h"
21 
22 #include "mbedtls/build_info.h"
23 
24 #include "mbedtls/ecp.h"
25 #include "mbedtls/md.h"
26 
36 /*
37  * Ecdsa-Sig-Value ::= SEQUENCE {
38  * r INTEGER,
39  * s INTEGER
40  * }
41  *
42  * For each of r and s, the value (V) may include an extra initial "0" bit.
43  */
44 #define MBEDTLS_ECDSA_MAX_SIG_LEN(bits) \
45  (/*T,L of SEQUENCE*/ ((bits) >= 61 * 8 ? 3 : 2) + \
46  /*T,L of r,s*/ 2 * (((bits) >= 127 * 8 ? 3 : 2) + \
47  /*V of r,s*/ ((bits) + 8) / 8))
48 
50 #define MBEDTLS_ECDSA_MAX_LEN MBEDTLS_ECDSA_MAX_SIG_LEN(MBEDTLS_ECP_MAX_BITS)
51 
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55 
69 
70 #if defined(MBEDTLS_ECP_RESTARTABLE)
71 
77 typedef struct mbedtls_ecdsa_restart_ver mbedtls_ecdsa_restart_ver_ctx;
78 
84 typedef struct mbedtls_ecdsa_restart_sig mbedtls_ecdsa_restart_sig_ctx;
85 
86 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
92 typedef struct mbedtls_ecdsa_restart_det mbedtls_ecdsa_restart_det_ctx;
93 #endif
94 
98 typedef struct {
101  mbedtls_ecdsa_restart_ver_ctx *MBEDTLS_PRIVATE(ver);
102  mbedtls_ecdsa_restart_sig_ctx *MBEDTLS_PRIVATE(sig);
103 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
104  mbedtls_ecdsa_restart_det_ctx *MBEDTLS_PRIVATE(det);
105 #endif
107 
108 #else /* MBEDTLS_ECP_RESTARTABLE */
109 
110 /* Now we can declare functions that take a pointer to that */
112 
113 #endif /* MBEDTLS_ECP_RESTARTABLE */
114 
124 
163  const mbedtls_mpi *d, const unsigned char *buf, size_t blen,
164  mbedtls_f_rng_t *f_rng, void *p_rng);
165 
166 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
208  mbedtls_mpi *s, const mbedtls_mpi *d,
209  const unsigned char *buf, size_t blen,
210  mbedtls_md_type_t md_alg,
211  mbedtls_f_rng_t *f_rng_blind,
212  void *p_rng_blind);
213 #endif /* MBEDTLS_ECDSA_DETERMINISTIC */
214 
215 #if !defined(MBEDTLS_ECDSA_SIGN_ALT)
272  mbedtls_ecp_group *grp,
273  mbedtls_mpi *r, mbedtls_mpi *s,
274  const mbedtls_mpi *d,
275  const unsigned char *buf, size_t blen,
276  mbedtls_f_rng_t *f_rng,
277  void *p_rng,
278  mbedtls_f_rng_t *f_rng_blind,
279  void *p_rng_blind,
280  mbedtls_ecdsa_restart_ctx *rs_ctx);
281 
282 #endif /* !MBEDTLS_ECDSA_SIGN_ALT */
283 
284 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
285 
335  mbedtls_ecp_group *grp,
336  mbedtls_mpi *r, mbedtls_mpi *s,
337  const mbedtls_mpi *d, const unsigned char *buf, size_t blen,
338  mbedtls_md_type_t md_alg,
339  mbedtls_f_rng_t *f_rng_blind,
340  void *p_rng_blind,
341  mbedtls_ecdsa_restart_ctx *rs_ctx);
342 
343 #endif /* MBEDTLS_ECDSA_DETERMINISTIC */
344 
376  const unsigned char *buf, size_t blen,
377  const mbedtls_ecp_point *Q, const mbedtls_mpi *r,
378  const mbedtls_mpi *s);
379 
380 #if !defined(MBEDTLS_ECDSA_VERIFY_ALT)
417  const unsigned char *buf, size_t blen,
418  const mbedtls_ecp_point *Q,
419  const mbedtls_mpi *r,
420  const mbedtls_mpi *s,
421  mbedtls_ecdsa_restart_ctx *rs_ctx);
422 
423 #endif /* !MBEDTLS_ECDSA_VERIFY_ALT */
424 
475  mbedtls_md_type_t md_alg,
476  const unsigned char *hash, size_t hlen,
477  unsigned char *sig, size_t sig_size, size_t *slen,
478  mbedtls_f_rng_t *f_rng,
479  void *p_rng);
480 
523  mbedtls_md_type_t md_alg,
524  const unsigned char *hash, size_t hlen,
525  unsigned char *sig, size_t sig_size, size_t *slen,
526  mbedtls_f_rng_t *f_rng,
527  void *p_rng,
528  mbedtls_ecdsa_restart_ctx *rs_ctx);
529 
558  const unsigned char *hash, size_t hlen,
559  const unsigned char *sig, size_t slen);
560 
593  const unsigned char *hash, size_t hlen,
594  const unsigned char *sig, size_t slen,
595  mbedtls_ecdsa_restart_ctx *rs_ctx);
596 
614  mbedtls_f_rng_t *f_rng, void *p_rng);
615 
632  const mbedtls_ecp_keypair *key);
633 
641 
650 
651 #if defined(MBEDTLS_ECP_RESTARTABLE)
658 void mbedtls_ecdsa_restart_init(mbedtls_ecdsa_restart_ctx *ctx);
659 
667 void mbedtls_ecdsa_restart_free(mbedtls_ecdsa_restart_ctx *ctx);
668 #endif /* MBEDTLS_ECP_RESTARTABLE */
669 
670 #ifdef __cplusplus
671 }
672 #endif
673 
674 #endif /* ecdsa.h */
int mbedtls_ecdsa_sign_det_restartable(mbedtls_ecp_group *grp, mbedtls_mpi *r, mbedtls_mpi *s, const mbedtls_mpi *d, const unsigned char *buf, size_t blen, mbedtls_md_type_t md_alg, mbedtls_f_rng_t *f_rng_blind, void *p_rng_blind, mbedtls_ecdsa_restart_ctx *rs_ctx)
This function computes the ECDSA signature of a previously-hashed message, in a restartable way.
int mbedtls_ecdsa_verify(mbedtls_ecp_group *grp, const unsigned char *buf, size_t blen, const mbedtls_ecp_point *Q, const mbedtls_mpi *r, const mbedtls_mpi *s)
This function verifies the ECDSA signature of a previously-hashed message.
void mbedtls_ecdsa_free(mbedtls_ecdsa_context *ctx)
This function frees an ECDSA context.
int mbedtls_ecdsa_genkey(mbedtls_ecdsa_context *ctx, mbedtls_ecp_group_id gid, mbedtls_f_rng_t *f_rng, void *p_rng)
This function generates an ECDSA keypair on the given curve.
int mbedtls_ecdsa_sign(mbedtls_ecp_group *grp, mbedtls_mpi *r, mbedtls_mpi *s, const mbedtls_mpi *d, const unsigned char *buf, size_t blen, mbedtls_f_rng_t *f_rng, void *p_rng)
This function computes the ECDSA signature of a previously-hashed message.
int mbedtls_ecdsa_sign_restartable(mbedtls_ecp_group *grp, mbedtls_mpi *r, mbedtls_mpi *s, const mbedtls_mpi *d, const unsigned char *buf, size_t blen, mbedtls_f_rng_t *f_rng, void *p_rng, mbedtls_f_rng_t *f_rng_blind, void *p_rng_blind, mbedtls_ecdsa_restart_ctx *rs_ctx)
This function computes the ECDSA signature of a previously-hashed message, in a restartable way.
int mbedtls_ecdsa_sign_det_ext(mbedtls_ecp_group *grp, mbedtls_mpi *r, mbedtls_mpi *s, const mbedtls_mpi *d, const unsigned char *buf, size_t blen, mbedtls_md_type_t md_alg, mbedtls_f_rng_t *f_rng_blind, void *p_rng_blind)
This function computes the ECDSA signature of a previously-hashed message, deterministic version.
int mbedtls_ecdsa_verify_restartable(mbedtls_ecp_group *grp, const unsigned char *buf, size_t blen, const mbedtls_ecp_point *Q, const mbedtls_mpi *r, const mbedtls_mpi *s, mbedtls_ecdsa_restart_ctx *rs_ctx)
This function verifies the ECDSA signature of a previously-hashed message, in a restartable manner.
int mbedtls_ecdsa_from_keypair(mbedtls_ecdsa_context *ctx, const mbedtls_ecp_keypair *key)
This function sets up an ECDSA context from an EC key pair.
int mbedtls_ecdsa_read_signature_restartable(mbedtls_ecdsa_context *ctx, const unsigned char *hash, size_t hlen, const unsigned char *sig, size_t slen, mbedtls_ecdsa_restart_ctx *rs_ctx)
This function reads and verifies an ECDSA signature, in a restartable way.
int mbedtls_ecdsa_read_signature(mbedtls_ecdsa_context *ctx, const unsigned char *hash, size_t hlen, const unsigned char *sig, size_t slen)
This function reads and verifies an ECDSA signature.
mbedtls_ecp_keypair mbedtls_ecdsa_context
The ECDSA context structure.
Definition: ecdsa.h:68
int mbedtls_ecdsa_can_do(mbedtls_ecp_group_id gid)
This function checks whether a given group can be used for ECDSA.
void mbedtls_ecdsa_restart_ctx
Definition: ecdsa.h:111
void mbedtls_ecdsa_init(mbedtls_ecdsa_context *ctx)
This function initializes an ECDSA context.
int mbedtls_ecdsa_write_signature(mbedtls_ecdsa_context *ctx, mbedtls_md_type_t md_alg, const unsigned char *hash, size_t hlen, unsigned char *sig, size_t sig_size, size_t *slen, mbedtls_f_rng_t *f_rng, void *p_rng)
This function computes the ECDSA signature and writes it to a buffer, serialized as defined in RFC-44...
int mbedtls_ecdsa_write_signature_restartable(mbedtls_ecdsa_context *ctx, mbedtls_md_type_t md_alg, const unsigned char *hash, size_t hlen, unsigned char *sig, size_t sig_size, size_t *slen, mbedtls_f_rng_t *f_rng, void *p_rng, mbedtls_ecdsa_restart_ctx *rs_ctx)
This function computes the ECDSA signature and writes it to a buffer, in a restartable way.
This file provides an API for Elliptic Curves over GF(P) (ECP).
void mbedtls_ecp_restart_ctx
Definition: ecp.h:416
mbedtls_ecp_group_id
Definition: ecp.h:102
Build-time configuration info.
This file contains the generic functions for message-digest (hashing) and HMAC.
mbedtls_md_type_t
Supported message digests.
Definition: md.h:47
int mbedtls_f_rng_t(void *p_rng, unsigned char *output, size_t output_size)
The type of custom random generator (RNG) callbacks.
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
The ECP group structure.
Definition: ecp.h:233
The ECP key-pair structure.
Definition: ecp.h:428
The ECP point structure, in Jacobian coordinates.
Definition: ecp.h:158
MPI structure.
Definition: bignum.h:208