Mbed TLS v3.5.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
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
65extern "C" {
66#endif
67
81
82#if defined(MBEDTLS_ECP_RESTARTABLE)
83
89typedef struct mbedtls_ecdsa_restart_ver mbedtls_ecdsa_restart_ver_ctx;
90
96typedef struct mbedtls_ecdsa_restart_sig mbedtls_ecdsa_restart_sig_ctx;
97
98#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
104typedef struct mbedtls_ecdsa_restart_det mbedtls_ecdsa_restart_det_ctx;
105#endif
106
110typedef 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)
219 mbedtls_mpi *s, const mbedtls_mpi *d,
220 const unsigned char *buf, size_t blen,
221 mbedtls_md_type_t md_alg,
222 int (*f_rng_blind)(void *, unsigned char *, size_t),
223 void *p_rng_blind);
224#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
225
226#if !defined(MBEDTLS_ECDSA_SIGN_ALT)
284 const mbedtls_mpi *d,
285 const unsigned char *buf, size_t blen,
286 int (*f_rng)(void *, unsigned char *, size_t),
287 void *p_rng,
288 int (*f_rng_blind)(void *, unsigned char *, size_t),
289 void *p_rng_blind,
291
292#endif /* !MBEDTLS_ECDSA_SIGN_ALT */
293
294#if defined(MBEDTLS_ECDSA_DETERMINISTIC)
295
347 const mbedtls_mpi *d, const unsigned char *buf, size_t blen,
348 mbedtls_md_type_t md_alg,
349 int (*f_rng_blind)(void *, unsigned char *, size_t),
350 void *p_rng_blind,
352
353#endif /* MBEDTLS_ECDSA_DETERMINISTIC */
354
386 const unsigned char *buf, size_t blen,
387 const mbedtls_ecp_point *Q, const mbedtls_mpi *r,
388 const mbedtls_mpi *s);
389
390#if !defined(MBEDTLS_ECDSA_VERIFY_ALT)
427 const unsigned char *buf, size_t blen,
428 const mbedtls_ecp_point *Q,
429 const mbedtls_mpi *r,
430 const mbedtls_mpi *s,
432
433#endif /* !MBEDTLS_ECDSA_VERIFY_ALT */
434
485 mbedtls_md_type_t md_alg,
486 const unsigned char *hash, size_t hlen,
487 unsigned char *sig, size_t sig_size, size_t *slen,
488 int (*f_rng)(void *, unsigned char *, size_t),
489 void *p_rng);
490
532 mbedtls_md_type_t md_alg,
533 const unsigned char *hash, size_t hlen,
534 unsigned char *sig, size_t sig_size, size_t *slen,
535 int (*f_rng)(void *, unsigned char *, size_t),
536 void *p_rng,
538
567 const unsigned char *hash, size_t hlen,
568 const unsigned char *sig, size_t slen);
569
602 const unsigned char *hash, size_t hlen,
603 const unsigned char *sig, size_t slen,
605
623 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng);
624
641 const mbedtls_ecp_keypair *key);
642
650
659
660#if defined(MBEDTLS_ECP_RESTARTABLE)
667void mbedtls_ecdsa_restart_init(mbedtls_ecdsa_restart_ctx *ctx);
668
676void mbedtls_ecdsa_restart_free(mbedtls_ecdsa_restart_ctx *ctx);
677#endif /* MBEDTLS_ECP_RESTARTABLE */
678
679#ifdef __cplusplus
680}
681#endif
682
683#endif /* ecdsa.h */
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.
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_ecdsa_free(mbedtls_ecdsa_context *ctx)
This function frees an ECDSA context.
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.
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_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.
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:80
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_can_do(mbedtls_ecp_group_id gid)
This function checks whether a given group can be used for ECDSA.
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...
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_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.
This file provides an API for Elliptic Curves over GF(P) (ECP).
void mbedtls_ecp_restart_ctx
Definition: ecp.h:427
mbedtls_ecp_group_id
Definition: ecp.h:113
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:173
Macro wrapper for struct's members.
#define MBEDTLS_PRIVATE(member)
The ECP group structure.
Definition: ecp.h:244
The ECP key-pair structure.
Definition: ecp.h:439
The ECP point structure, in Jacobian coordinates.
Definition: ecp.h:169
MPI structure.
Definition: bignum.h:219