BA / Mbed OS BaBoRo1
Embed: (wiki syntax)

« Back to documentation index

ecdsa.h File Reference
Typedefs | Functions

ecdsa.h File Reference

The Elliptic Curve Digital Signature Algorithm (ECDSA). More...

Go to the source code of this file.

Typedefs

typedef mbedtls_ecp_keypair mbedtls_ecdsa_context
 The ECDSA context structure.

Functions

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_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.
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_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-4492: Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS).
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-4492: Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS).
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_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_from_keypair (mbedtls_ecdsa_context *ctx, const mbedtls_ecp_keypair *key)
 This function sets an ECDSA context from an EC key pair.
void mbedtls_ecdsa_init (mbedtls_ecdsa_context *ctx)
 This function initializes an ECDSA context.
void mbedtls_ecdsa_free (mbedtls_ecdsa_context *ctx)
 This function frees an ECDSA context.

Detailed Description

The Elliptic Curve Digital Signature Algorithm (ECDSA).

ECDSA is defined in Standards for Efficient Cryptography Group (SECG): SEC1 Elliptic Curve Cryptography. The use of ECDSA for TLS is defined in RFC-4492: Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS).

Definition in file ecdsa.h.

Typedef Documentation

typedef mbedtls_ecp_keypair mbedtls_ecdsa_context

The ECDSA context structure.

Definition at line 60 of file ecdsa.h.

Function Documentation

void mbedtls_ecdsa_free ( mbedtls_ecdsa_context *  ctx )

This function frees an ECDSA context.

Parameters:
ctxThe ECDSA context to free.

Definition at line 453 of file ecdsa.c.

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.

Parameters:
ctxThe ECDSA context to set.
keyThe EC key to use.
Returns:
0 on success, or an MBEDTLS_ERR_ECP_XXX code on failure.
See also:
ecp.h

Definition at line 428 of file ecdsa.c.

int mbedtls_ecdsa_genkey ( mbedtls_ecdsa_context *  ctx,
mbedtls_ecp_group_id  gid,
int(*)(void *, unsigned char *, size_t)  f_rng,
void *  p_rng 
)

This function generates an ECDSA keypair on the given curve.

Parameters:
ctxThe ECDSA context to store the keypair in.
gidThe elliptic curve to use. One of the various MBEDTLS_ECP_DP_XXX macros depending on configuration.
f_rngThe RNG function.
p_rngThe RNG parameter.
Returns:
0 on success, or an MBEDTLS_ERR_ECP_XXX code on failure.
See also:
ecp.h

Definition at line 417 of file ecdsa.c.

void mbedtls_ecdsa_init ( mbedtls_ecdsa_context *  ctx )

This function initializes an ECDSA context.

Parameters:
ctxThe ECDSA context to initialize.

Definition at line 445 of file ecdsa.c.

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.

Parameters:
ctxThe ECDSA context.
hashThe message hash.
hlenThe size of the hash.
sigThe signature to read and verify.
slenThe size of sig.
Note:
If the bitlength of the message hash is larger than the bitlength of the group order, then the hash is truncated as defined in Standards for Efficient Cryptography Group (SECG): SEC1 Elliptic Curve Cryptography, section 4.1.4, step 3.
Returns:
0 on success, MBEDTLS_ERR_ECP_BAD_INPUT_DATA if signature is invalid, MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH if the signature is valid but its actual length is less than siglen, or an MBEDTLS_ERR_ECP_XXX or MBEDTLS_ERR_MPI_XXX error code on failure for any other reason.
See also:
ecp.h

Definition at line 365 of file ecdsa.c.

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(*)(void *, unsigned char *, size_t)  f_rng,
void *  p_rng 
)

This function computes the ECDSA signature of a previously-hashed message.

Note:
The deterministic version is usually preferred.
Parameters:
grpThe ECP group.
rThe first output integer.
sThe second output integer.
dThe private signing key.
bufThe message hash.
blenThe length of buf.
f_rngThe RNG function.
p_rngThe RNG parameter.
Note:
If the bitlength of the message hash is larger than the bitlength of the group order, then the hash is truncated as defined in Standards for Efficient Cryptography Group (SECG): SEC1 Elliptic Curve Cryptography, section 4.1.3, step 5.
Returns:
0 on success, or an MBEDTLS_ERR_ECP_XXX or MBEDTLS_MPI_XXX error code on failure.
See also:
ecp.h

Definition at line 73 of file ecdsa.c.

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.

For more information, see RFC-6979: Deterministic Usage of the Digital Signature Algorithm (DSA) and Elliptic Curve Digital Signature Algorithm (ECDSA).

Parameters:
grpThe ECP group.
rThe first output integer.
sThe second output integer.
dThe private signing key.
bufThe message hash.
blenThe length of buf.
md_algThe MD algorithm used to hash the message.
Note:
If the bitlength of the message hash is larger than the bitlength of the group order, then the hash is truncated as defined in Standards for Efficient Cryptography Group (SECG): SEC1 Elliptic Curve Cryptography, section 4.1.3, step 5.
Returns:
0 on success, or an MBEDTLS_ERR_ECP_XXX or MBEDTLS_MPI_XXX error code on failure.
See also:
ecp.h

Definition at line 167 of file ecdsa.c.

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.

Parameters:
grpThe ECP group.
bufThe message hash.
blenThe length of buf.
QThe public key to use for verification.
rThe first integer of the signature.
sThe second integer of the signature.
Note:
If the bitlength of the message hash is larger than the bitlength of the group order, then the hash is truncated as defined in Standards for Efficient Cryptography Group (SECG): SEC1 Elliptic Curve Cryptography, section 4.1.4, step 3.
Returns:
0 on success, MBEDTLS_ERR_ECP_BAD_INPUT_DATA if signature is invalid, or an MBEDTLS_ERR_ECP_XXX or MBEDTLS_MPI_XXX error code on failure for any other reason.
See also:
ecp.h

Definition at line 206 of file ecdsa.c.

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(*)(void *, unsigned char *, size_t)  f_rng,
void *  p_rng 
)

This function computes the ECDSA signature and writes it to a buffer, serialized as defined in RFC-4492: Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS).

Warning:
It is not thread-safe to use the same context in multiple threads.
Note:
The deterministic version is used if MBEDTLS_ECDSA_DETERMINISTIC is defined. For more information, see RFC-6979: Deterministic Usage of the Digital Signature Algorithm (DSA) and Elliptic Curve Digital Signature Algorithm (ECDSA).
Parameters:
ctxThe ECDSA context.
md_algThe message digest that was used to hash the message.
hashThe message hash.
hlenThe length of the hash.
sigThe buffer that holds the signature.
slenThe length of the signature written.
f_rngThe RNG function.
p_rngThe RNG parameter.
Note:
The sig buffer must be at least twice as large as the size of the curve used, plus 9. For example, 73 Bytes if a 256-bit curve is used. A buffer length of MBEDTLS_ECDSA_MAX_LEN is always safe.
If the bitlength of the message hash is larger than the bitlength of the group order, then the hash is truncated as defined in Standards for Efficient Cryptography Group (SECG): SEC1 Elliptic Curve Cryptography, section 4.1.3, step 5.
Returns:
0 on success, or an MBEDTLS_ERR_ECP_XXX, MBEDTLS_ERR_MPI_XXX or MBEDTLS_ERR_ASN1_XXX error code on failure.
See also:
ecp.h

Definition at line 316 of file ecdsa.c.

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 
)

This function computes an ECDSA signature and writes it to a buffer, serialized as defined in RFC-4492: Elliptic Curve Cryptography (ECC) Cipher Suites for Transport Layer Security (TLS).

The deterministic version is defined in RFC-6979: Deterministic Usage of the Digital Signature Algorithm (DSA) and Elliptic Curve Digital Signature Algorithm (ECDSA).

Warning:
It is not thread-safe to use the same context in multiple threads.
Parameters:
ctxThe ECDSA context.
hashThe Message hash.
hlenThe length of the hash.
sigThe buffer that holds the signature.
slenThe length of the signature written.
md_algThe MD algorithm used to hash the message.
Note:
The sig buffer must be at least twice as large as the size of the curve used, plus 9. For example, 73 Bytes if a 256-bit curve is used. A buffer length of MBEDTLS_ECDSA_MAX_LEN is always safe.
If the bitlength of the message hash is larger than the bitlength of the group order, then the hash is truncated as defined in Standards for Efficient Cryptography Group (SECG): SEC1 Elliptic Curve Cryptography, section 4.1.3, step 5.
Returns:
0 on success, or an MBEDTLS_ERR_ECP_XXX, MBEDTLS_ERR_MPI_XXX or MBEDTLS_ERR_ASN1_XXX error code on failure.
See also:
ecp.h

Definition at line 352 of file ecdsa.c.

Generated on Tue Jul 12 2022 12:22:30 by  doxygen 1.7.2