mbed TLS v2.7.14
ecdsa.h
Go to the documentation of this file.
1 
12 /*
13  * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
14  * SPDX-License-Identifier: Apache-2.0
15  *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may
17  * not use this file except in compliance with the License.
18  * You may obtain a copy of the License at
19  *
20  * http://www.apache.org/licenses/LICENSE-2.0
21  *
22  * Unless required by applicable law or agreed to in writing, software
23  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25  * See the License for the specific language governing permissions and
26  * limitations under the License.
27  *
28  * This file is part of Mbed TLS (https://tls.mbed.org)
29  */
30 
31 #ifndef MBEDTLS_ECDSA_H
32 #define MBEDTLS_ECDSA_H
33 
34 #if !defined(MBEDTLS_CONFIG_FILE)
35 #include "config.h"
36 #else
37 #include MBEDTLS_CONFIG_FILE
38 #endif
39 
40 #include "ecp.h"
41 #include "md.h"
42 
43 /*
44  * RFC-4492 page 20:
45  *
46  * Ecdsa-Sig-Value ::= SEQUENCE {
47  * r INTEGER,
48  * s INTEGER
49  * }
50  *
51  * Size is at most
52  * 1 (tag) + 1 (len) + 1 (initial 0) + ECP_MAX_BYTES for each of r and s,
53  * twice that + 1 (tag) + 2 (len) for the sequence
54  * (assuming ECP_MAX_BYTES is less than 126 for r and s,
55  * and less than 124 (total len <= 255) for the sequence)
56  */
57 #if MBEDTLS_ECP_MAX_BYTES > 124
58 #error "MBEDTLS_ECP_MAX_BYTES bigger than expected, please fix MBEDTLS_ECDSA_MAX_LEN"
59 #endif
60 
61 #define MBEDTLS_ECDSA_MAX_LEN ( 3 + 2 * ( 3 + MBEDTLS_ECP_MAX_BYTES ) )
62 
67 
68 #ifdef __cplusplus
69 extern "C" {
70 #endif
71 
99  const mbedtls_mpi *d, const unsigned char *buf, size_t blen,
100  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
101 
102 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
103 
145  mbedtls_mpi *s, const mbedtls_mpi *d,
146  const unsigned char *buf, size_t blen,
147  mbedtls_md_type_t md_alg );
188  mbedtls_mpi *s, const mbedtls_mpi *d,
189  const unsigned char *buf, size_t blen,
190  mbedtls_md_type_t md_alg,
191  int (*f_rng_blind)(void *, unsigned char *,
192  size_t),
193  void *p_rng_blind );
194 #endif /* MBEDTLS_ECDSA_DETERMINISTIC */
195 
221  const unsigned char *buf, size_t blen,
222  const mbedtls_ecp_point *Q, const mbedtls_mpi *r, const mbedtls_mpi *s);
223 
266  const unsigned char *hash, size_t hlen,
267  unsigned char *sig, size_t *slen,
268  int (*f_rng)(void *, unsigned char *, size_t),
269  void *p_rng );
270 
271 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
272 #if ! defined(MBEDTLS_DEPRECATED_REMOVED)
273 #if defined(MBEDTLS_DEPRECATED_WARNING)
274 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
275 #else
276 #define MBEDTLS_DEPRECATED
277 #endif
278 
318  const unsigned char *hash, size_t hlen,
319  unsigned char *sig, size_t *slen,
321 #undef MBEDTLS_DEPRECATED
322 #endif /* MBEDTLS_DEPRECATED_REMOVED */
323 #endif /* MBEDTLS_ECDSA_DETERMINISTIC */
324 
350  const unsigned char *hash, size_t hlen,
351  const unsigned char *sig, size_t slen );
352 
368  int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
369 
382 
389 
396 
397 #ifdef __cplusplus
398 }
399 #endif
400 
401 #endif /* ecdsa.h */
void mbedtls_ecdsa_free(mbedtls_ecdsa_context *ctx)
This function frees an ECDSA context.
Elliptic curves over GF(p)
ECP key pair structure.
Definition: ecp.h:173
Configuration options (set of defines)
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.
ECP group structure.
Definition: ecp.h:146
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 an ECDSA context from an EC key pair.
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...
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:66
mbedtls_ecp_group_id
Definition: ecp.h:70
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.
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:180
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.
ECP point structure (jacobian coordinates)
Definition: ecp.h:114
mbedtls_md_type_t
Enumeration of supported message digests.
Definition: md.h:56
#define MBEDTLS_DEPRECATED
Definition: ecdsa.h:276
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...