mbed TLS v3.4.0
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 #include "mbedtls/private_access.h"
33 
34 #include "mbedtls/build_info.h"
35 
36 #include "mbedtls/ecp.h"
37 #include "mbedtls/md.h"
38 
48 /*
49  * Ecdsa-Sig-Value ::= SEQUENCE {
50  * r INTEGER,
51  * s INTEGER
52  * }
53  *
54  * For each of r and s, the value (V) may include an extra initial "0" bit.
55  */
56 #define MBEDTLS_ECDSA_MAX_SIG_LEN(bits) \
57  (/*T,L of SEQUENCE*/ ((bits) >= 61 * 8 ? 3 : 2) + \
58  /*T,L of r,s*/ 2 * (((bits) >= 127 * 8 ? 3 : 2) + \
59  /*V of r,s*/ ((bits) + 8) / 8))
60 
62 #define MBEDTLS_ECDSA_MAX_LEN MBEDTLS_ECDSA_MAX_SIG_LEN(MBEDTLS_ECP_MAX_BITS)
63 
64 #ifdef __cplusplus
65 extern "C" {
66 #endif
67 
81 
82 #if defined(MBEDTLS_ECP_RESTARTABLE)
83 
89 typedef struct mbedtls_ecdsa_restart_ver mbedtls_ecdsa_restart_ver_ctx;
90 
96 typedef struct mbedtls_ecdsa_restart_sig mbedtls_ecdsa_restart_sig_ctx;
97 
98 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
99 
104 typedef struct mbedtls_ecdsa_restart_det mbedtls_ecdsa_restart_det_ctx;
105 #endif
106 
110 typedef struct {
113  mbedtls_ecdsa_restart_ver_ctx *MBEDTLS_PRIVATE(ver);
114  mbedtls_ecdsa_restart_sig_ctx *MBEDTLS_PRIVATE(sig);
115 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
116  mbedtls_ecdsa_restart_det_ctx *MBEDTLS_PRIVATE(det);
117 #endif
119 
120 #else /* MBEDTLS_ECP_RESTARTABLE */
121 
122 /* Now we can declare functions that take a pointer to that */
124 
125 #endif /* MBEDTLS_ECP_RESTARTABLE */
126 
136 
174  const mbedtls_mpi *d, const unsigned char *buf, size_t blen,
175  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
176 
177 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
178 
218  mbedtls_mpi *s, const mbedtls_mpi *d,
219  const unsigned char *buf, size_t blen,
220  mbedtls_md_type_t md_alg,
221  int (*f_rng_blind)(void *, unsigned char *, size_t),
222  void *p_rng_blind);
223 #endif /* MBEDTLS_ECDSA_DETERMINISTIC */
224 
225 #if !defined(MBEDTLS_ECDSA_SIGN_ALT)
226 
281  mbedtls_ecp_group *grp,
282  mbedtls_mpi *r, mbedtls_mpi *s,
283  const mbedtls_mpi *d,
284  const unsigned char *buf, size_t blen,
285  int (*f_rng)(void *, unsigned char *, size_t),
286  void *p_rng,
287  int (*f_rng_blind)(void *, unsigned char *, size_t),
288  void *p_rng_blind,
289  mbedtls_ecdsa_restart_ctx *rs_ctx);
290 
291 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
292 
341  mbedtls_ecp_group *grp,
342  mbedtls_mpi *r, mbedtls_mpi *s,
343  const mbedtls_mpi *d, const unsigned char *buf, size_t blen,
344  mbedtls_md_type_t md_alg,
345  int (*f_rng_blind)(void *, unsigned char *, size_t),
346  void *p_rng_blind,
347  mbedtls_ecdsa_restart_ctx *rs_ctx);
348 
349 #endif /* MBEDTLS_ECDSA_DETERMINISTIC */
350 
351 #endif /* !MBEDTLS_ECDSA_SIGN_ALT */
352 
384  const unsigned char *buf, size_t blen,
385  const mbedtls_ecp_point *Q, const mbedtls_mpi *r,
386  const mbedtls_mpi *s);
387 
388 #if !defined(MBEDTLS_ECDSA_VERIFY_ALT)
389 
425  const unsigned char *buf, size_t blen,
426  const mbedtls_ecp_point *Q,
427  const mbedtls_mpi *r,
428  const mbedtls_mpi *s,
429  mbedtls_ecdsa_restart_ctx *rs_ctx);
430 
431 #endif /* !MBEDTLS_ECDSA_VERIFY_ALT */
432 
482 int mbedtls_ecdsa_write_signature(mbedtls_ecdsa_context *ctx,
483  mbedtls_md_type_t md_alg,
484  const unsigned char *hash, size_t hlen,
485  unsigned char *sig, size_t sig_size, size_t *slen,
486  int (*f_rng)(void *, unsigned char *, size_t),
487  void *p_rng);
488 
529 int mbedtls_ecdsa_write_signature_restartable(mbedtls_ecdsa_context *ctx,
530  mbedtls_md_type_t md_alg,
531  const unsigned char *hash, size_t hlen,
532  unsigned char *sig, size_t sig_size, size_t *slen,
533  int (*f_rng)(void *, unsigned char *, size_t),
534  void *p_rng,
535  mbedtls_ecdsa_restart_ctx *rs_ctx);
536 
564 int mbedtls_ecdsa_read_signature(mbedtls_ecdsa_context *ctx,
565  const unsigned char *hash, size_t hlen,
566  const unsigned char *sig, size_t slen);
567 
599 int mbedtls_ecdsa_read_signature_restartable(mbedtls_ecdsa_context *ctx,
600  const unsigned char *hash, size_t hlen,
601  const unsigned char *sig, size_t slen,
602  mbedtls_ecdsa_restart_ctx *rs_ctx);
603 
620 int mbedtls_ecdsa_genkey(mbedtls_ecdsa_context *ctx, mbedtls_ecp_group_id gid,
621  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
622 
638 int mbedtls_ecdsa_from_keypair(mbedtls_ecdsa_context *ctx,
639  const mbedtls_ecp_keypair *key);
640 
647 void mbedtls_ecdsa_init(mbedtls_ecdsa_context *ctx);
648 
656 void mbedtls_ecdsa_free(mbedtls_ecdsa_context *ctx);
657 
658 #if defined(MBEDTLS_ECP_RESTARTABLE)
659 
665 void mbedtls_ecdsa_restart_init(mbedtls_ecdsa_restart_ctx *ctx);
666 
674 void mbedtls_ecdsa_restart_free(mbedtls_ecdsa_restart_ctx *ctx);
675 #endif /* MBEDTLS_ECP_RESTARTABLE */
676 
677 #ifdef __cplusplus
678 }
679 #endif
680 
681 #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, int(*f_rng_blind)(void *, unsigned char *, size_t), 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...
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:424
#define MBEDTLS_PRIVATE(member)
void mbedtls_ecdsa_restart_ctx
Definition: ecdsa.h:123
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:232
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_sign_restartable(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, int(*f_rng_blind)(void *, unsigned char *, size_t), 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_from_keypair(mbedtls_ecdsa_context *ctx, const mbedtls_ecp_keypair *key)
This function sets up an ECDSA context from an EC key pair.
Macro wrapper for struct's members.
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:412
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:80
mbedtls_ecp_group_id
Definition: ecp.h:113
Build-time configuration info.
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_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 functions for message-digest (hashing) and HMAC.
MPI structure.
Definition: bignum.h:205
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.
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, 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...
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, 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...
The ECP point structure, in Jacobian coordinates.
Definition: ecp.h:178
mbedtls_md_type_t
Supported message digests.
Definition: md.h:143
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...