mbed TLS v2.16.7
ecdsa.h
Go to the documentation of this file.
1 
13 /*
14  * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
15  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
16  *
17  * This file is provided under the Apache License 2.0, or the
18  * GNU General Public License v2.0 or later.
19  *
20  * **********
21  * Apache License 2.0:
22  *
23  * Licensed under the Apache License, Version 2.0 (the "License"); you may
24  * not use this file except in compliance with the License.
25  * You may obtain a copy of the License at
26  *
27  * http://www.apache.org/licenses/LICENSE-2.0
28  *
29  * Unless required by applicable law or agreed to in writing, software
30  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
31  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
32  * See the License for the specific language governing permissions and
33  * limitations under the License.
34  *
35  * **********
36  *
37  * **********
38  * GNU General Public License v2.0 or later:
39  *
40  * This program is free software; you can redistribute it and/or modify
41  * it under the terms of the GNU General Public License as published by
42  * the Free Software Foundation; either version 2 of the License, or
43  * (at your option) any later version.
44  *
45  * This program is distributed in the hope that it will be useful,
46  * but WITHOUT ANY WARRANTY; without even the implied warranty of
47  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
48  * GNU General Public License for more details.
49  *
50  * You should have received a copy of the GNU General Public License along
51  * with this program; if not, write to the Free Software Foundation, Inc.,
52  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
53  *
54  * **********
55  *
56  * This file is part of Mbed TLS (https://tls.mbed.org)
57  */
58 
59 #ifndef MBEDTLS_ECDSA_H
60 #define MBEDTLS_ECDSA_H
61 
62 #if !defined(MBEDTLS_CONFIG_FILE)
63 #include "config.h"
64 #else
65 #include MBEDTLS_CONFIG_FILE
66 #endif
67 
68 #include "ecp.h"
69 #include "md.h"
70 
71 /*
72  * RFC-4492 page 20:
73  *
74  * Ecdsa-Sig-Value ::= SEQUENCE {
75  * r INTEGER,
76  * s INTEGER
77  * }
78  *
79  * Size is at most
80  * 1 (tag) + 1 (len) + 1 (initial 0) + ECP_MAX_BYTES for each of r and s,
81  * twice that + 1 (tag) + 2 (len) for the sequence
82  * (assuming ECP_MAX_BYTES is less than 126 for r and s,
83  * and less than 124 (total len <= 255) for the sequence)
84  */
85 #if MBEDTLS_ECP_MAX_BYTES > 124
86 #error "MBEDTLS_ECP_MAX_BYTES bigger than expected, please fix MBEDTLS_ECDSA_MAX_LEN"
87 #endif
88 
89 #define MBEDTLS_ECDSA_MAX_LEN ( 3 + 2 * ( 3 + MBEDTLS_ECP_MAX_BYTES ) )
90 
91 #ifdef __cplusplus
92 extern "C" {
93 #endif
94 
103 
104 #if defined(MBEDTLS_ECP_RESTARTABLE)
105 
111 typedef struct mbedtls_ecdsa_restart_ver mbedtls_ecdsa_restart_ver_ctx;
112 
118 typedef struct mbedtls_ecdsa_restart_sig mbedtls_ecdsa_restart_sig_ctx;
119 
120 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
121 
126 typedef struct mbedtls_ecdsa_restart_det mbedtls_ecdsa_restart_det_ctx;
127 #endif
128 
132 typedef struct
133 {
136  mbedtls_ecdsa_restart_ver_ctx *ver;
137  mbedtls_ecdsa_restart_sig_ctx *sig;
138 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
139  mbedtls_ecdsa_restart_det_ctx *det;
140 #endif
142 
143 #else /* MBEDTLS_ECP_RESTARTABLE */
144 
145 /* Now we can declare functions that take a pointer to that */
147 
148 #endif /* MBEDTLS_ECP_RESTARTABLE */
149 
187  const mbedtls_mpi *d, const unsigned char *buf, size_t blen,
188  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
189 
190 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
191 
240  mbedtls_mpi *s, const mbedtls_mpi *d,
241  const unsigned char *buf, size_t blen,
242  mbedtls_md_type_t md_alg );
283  mbedtls_mpi *s, const mbedtls_mpi *d,
284  const unsigned char *buf, size_t blen,
285  mbedtls_md_type_t md_alg,
286  int (*f_rng_blind)(void *, unsigned char *,
287  size_t),
288  void *p_rng_blind );
289 #endif /* MBEDTLS_ECDSA_DETERMINISTIC */
290 
324  const unsigned char *buf, size_t blen,
325  const mbedtls_ecp_point *Q, const mbedtls_mpi *r,
326  const mbedtls_mpi *s);
327 
376  mbedtls_md_type_t md_alg,
377  const unsigned char *hash, size_t hlen,
378  unsigned char *sig, size_t *slen,
379  int (*f_rng)(void *, unsigned char *, size_t),
380  void *p_rng );
381 
422  mbedtls_md_type_t md_alg,
423  const unsigned char *hash, size_t hlen,
424  unsigned char *sig, size_t *slen,
425  int (*f_rng)(void *, unsigned char *, size_t),
426  void *p_rng,
427  mbedtls_ecdsa_restart_ctx *rs_ctx );
428 
429 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
430 #if ! defined(MBEDTLS_DEPRECATED_REMOVED)
431 #if defined(MBEDTLS_DEPRECATED_WARNING)
432 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
433 #else
434 #define MBEDTLS_DEPRECATED
435 #endif
436 
480  const unsigned char *hash, size_t hlen,
481  unsigned char *sig, size_t *slen,
483 #undef MBEDTLS_DEPRECATED
484 #endif /* MBEDTLS_DEPRECATED_REMOVED */
485 #endif /* MBEDTLS_ECDSA_DETERMINISTIC */
486 
515  const unsigned char *hash, size_t hlen,
516  const unsigned char *sig, size_t slen );
517 
550  const unsigned char *hash, size_t hlen,
551  const unsigned char *sig, size_t slen,
552  mbedtls_ecdsa_restart_ctx *rs_ctx );
553 
571  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
572 
589  const mbedtls_ecp_keypair *key );
590 
598 
607 
608 #if defined(MBEDTLS_ECP_RESTARTABLE)
609 
615 void mbedtls_ecdsa_restart_init( mbedtls_ecdsa_restart_ctx *ctx );
616 
624 void mbedtls_ecdsa_restart_free( mbedtls_ecdsa_restart_ctx *ctx );
625 #endif /* MBEDTLS_ECP_RESTARTABLE */
626 
627 #ifdef __cplusplus
628 }
629 #endif
630 
631 #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:359
Configuration options (set of defines)
void mbedtls_ecdsa_restart_ctx
Definition: ecdsa.h:146
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:200
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:347
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)
This function computes the ECDSA signature of a previously-hashed message, deterministic version...
mbedtls_ecp_keypair mbedtls_ecdsa_context
The ECDSA context structure.
Definition: ecdsa.h:102
mbedtls_ecp_group_id
Definition: ecp.h:104
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 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:212
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:151
mbedtls_md_type_t
Supported message digests.
Definition: md.h:85
#define MBEDTLS_DEPRECATED
Definition: ecdsa.h:434
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...