mbed TLS v2.28.3
ecdsa.h
Go to the documentation of this file.
1 
13 /*
14  * Copyright The Mbed TLS Contributors
15  * 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.
28  */
29 
30 #ifndef MBEDTLS_ECDSA_H
31 #define MBEDTLS_ECDSA_H
32 
33 #if !defined(MBEDTLS_CONFIG_FILE)
34 #include "mbedtls/config.h"
35 #else
36 #include MBEDTLS_CONFIG_FILE
37 #endif
38 
39 #include "mbedtls/ecp.h"
40 #include "mbedtls/md.h"
41 
51 /*
52  * Ecdsa-Sig-Value ::= SEQUENCE {
53  * r INTEGER,
54  * s INTEGER
55  * }
56  *
57  * For each of r and s, the value (V) may include an extra initial "0" bit.
58  */
59 #define MBEDTLS_ECDSA_MAX_SIG_LEN(bits) \
60  (/*T,L of SEQUENCE*/ ((bits) >= 61 * 8 ? 3 : 2) + \
61  /*T,L of r,s*/ 2 * (((bits) >= 127 * 8 ? 3 : 2) + \
62  /*V of r,s*/ ((bits) + 8) / 8))
63 
65 #define MBEDTLS_ECDSA_MAX_LEN MBEDTLS_ECDSA_MAX_SIG_LEN(MBEDTLS_ECP_MAX_BITS)
66 
67 #ifdef __cplusplus
68 extern "C" {
69 #endif
70 
79 
80 #if defined(MBEDTLS_ECP_RESTARTABLE)
81 
87 typedef struct mbedtls_ecdsa_restart_ver mbedtls_ecdsa_restart_ver_ctx;
88 
94 typedef struct mbedtls_ecdsa_restart_sig mbedtls_ecdsa_restart_sig_ctx;
95 
96 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
97 
102 typedef struct mbedtls_ecdsa_restart_det mbedtls_ecdsa_restart_det_ctx;
103 #endif
104 
108 typedef struct {
111  mbedtls_ecdsa_restart_ver_ctx *ver;
112  mbedtls_ecdsa_restart_sig_ctx *sig;
113 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
114  mbedtls_ecdsa_restart_det_ctx *det;
115 #endif
117 
118 #else /* MBEDTLS_ECP_RESTARTABLE */
119 
120 /* Now we can declare functions that take a pointer to that */
122 
123 #endif /* MBEDTLS_ECP_RESTARTABLE */
124 
134 
172  const mbedtls_mpi *d, const unsigned char *buf, size_t blen,
173  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
174 
175 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
176 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
177 #if defined(MBEDTLS_DEPRECATED_WARNING)
178 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
179 #else
180 #define MBEDTLS_DEPRECATED
181 #endif
182 
231  mbedtls_mpi *s, const mbedtls_mpi *d,
232  const unsigned char *buf, size_t blen,
234 #undef MBEDTLS_DEPRECATED
235 #endif /* MBEDTLS_DEPRECATED_REMOVED */
236 
277  mbedtls_mpi *s, const mbedtls_mpi *d,
278  const unsigned char *buf, size_t blen,
279  mbedtls_md_type_t md_alg,
280  int (*f_rng_blind)(void *, unsigned char *, size_t),
281  void *p_rng_blind);
282 #endif /* MBEDTLS_ECDSA_DETERMINISTIC */
283 
315  const unsigned char *buf, size_t blen,
316  const mbedtls_ecp_point *Q, const mbedtls_mpi *r,
317  const mbedtls_mpi *s);
318 
368  mbedtls_md_type_t md_alg,
369  const unsigned char *hash, size_t hlen,
370  unsigned char *sig, size_t *slen,
371  int (*f_rng)(void *, unsigned char *, size_t),
372  void *p_rng);
373 
414  mbedtls_md_type_t md_alg,
415  const unsigned char *hash, size_t hlen,
416  unsigned char *sig, size_t *slen,
417  int (*f_rng)(void *, unsigned char *, size_t),
418  void *p_rng,
419  mbedtls_ecdsa_restart_ctx *rs_ctx);
420 
421 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
422 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
423 #if defined(MBEDTLS_DEPRECATED_WARNING)
424 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
425 #else
426 #define MBEDTLS_DEPRECATED
427 #endif
428 
472  const unsigned char *hash, size_t hlen,
473  unsigned char *sig, size_t *slen,
475 #undef MBEDTLS_DEPRECATED
476 #endif /* MBEDTLS_DEPRECATED_REMOVED */
477 #endif /* MBEDTLS_ECDSA_DETERMINISTIC */
478 
507  const unsigned char *hash, size_t hlen,
508  const unsigned char *sig, size_t slen);
509 
542  const unsigned char *hash, size_t hlen,
543  const unsigned char *sig, size_t slen,
544  mbedtls_ecdsa_restart_ctx *rs_ctx);
545 
563  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
564 
581  const mbedtls_ecp_keypair *key);
582 
590 
599 
600 #if defined(MBEDTLS_ECP_RESTARTABLE)
601 
607 void mbedtls_ecdsa_restart_init(mbedtls_ecdsa_restart_ctx *ctx);
608 
616 void mbedtls_ecdsa_restart_free(mbedtls_ecdsa_restart_ctx *ctx);
617 #endif /* MBEDTLS_ECP_RESTARTABLE */
618 
619 #ifdef __cplusplus
620 }
621 #endif
622 
623 #endif /* ecdsa.h */
void mbedtls_ecdsa_free(mbedtls_ecdsa_context *ctx)
This function frees an ECDSA context.
This file provides an API for Elliptic Curves over GF(P) (ECP).
The ECP key-pair structure.
Definition: ecp.h:426
Configuration options (set of defines)
void mbedtls_ecdsa_restart_ctx
Definition: ecdsa.h:121
void mbedtls_ecdsa_init(mbedtls_ecdsa_context *ctx)
This function initializes an ECDSA context.
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.
The ECP group structure.
Definition: ecp.h:256
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, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
This function computes the ECDSA signature of a previously-hashed message.
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_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 *slen, int(*f_rng)(void *, unsigned char *, size_t), 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...
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, int(*f_rng_blind)(void *, unsigned char *, size_t), void *p_rng_blind)
This function computes the ECDSA signature of a previously-hashed message, deterministic version...
void mbedtls_ecp_restart_ctx
Definition: ecp.h:414
int mbedtls_ecdsa_can_do(mbedtls_ecp_group_id gid)
This function checks whether a given group can be used for ECDSA.
mbedtls_ecp_keypair mbedtls_ecdsa_context
The ECDSA context structure.
Definition: ecdsa.h:78
mbedtls_ecp_group_id
Definition: ecp.h:120
int mbedtls_ecdsa_genkey(mbedtls_ecdsa_context *ctx, mbedtls_ecp_group_id gid, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
This function generates an ECDSA keypair on the given curve.
int mbedtls_ecdsa_sign_det(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_DEPRECATED
This function computes the ECDSA signature of a previously-hashed message, deterministic version...
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.
This file contains the generic message-digest wrapper.
int mbedtls_ecdsa_write_signature_det(mbedtls_ecdsa_context *ctx, const unsigned char *hash, size_t hlen, unsigned char *sig, size_t *slen, mbedtls_md_type_t md_alg) MBEDTLS_DEPRECATED
This function computes an ECDSA signature and writes it to a buffer, serialized as defined in RFC-449...
MPI structure.
Definition: bignum.h:208
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.
The ECP point structure, in Jacobian coordinates.
Definition: ecp.h:174
mbedtls_md_type_t
Supported message digests.
Definition: md.h:62
#define MBEDTLS_DEPRECATED
Definition: ecdsa.h:426
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 *slen, int(*f_rng)(void *, unsigned char *, size_t), void *p_rng)
This function computes the ECDSA signature and writes it to a buffer, serialized as defined in RFC-44...