Austin Blackstone / Mbed 2 deprecated client-lwip-lightswitch-demo-expanded

mbed client lightswitch demo

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Fork of mbed-client-classic-example-lwip by Austin Blackstone

mbedtls/mbedtls/ecdsa.h@11:cada08fc8a70, 2016-06-09 (annotated)

Committer:
mbedAustin
Date:
Thu Jun 09 17:08:36 2016 +0000
Revision:
11:cada08fc8a70
Commit for public Consumption

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbedAustin 11:cada08fc8a70 1 /**
mbedAustin 11:cada08fc8a70 2 * \file ecdsa.h
mbedAustin 11:cada08fc8a70 3 *
mbedAustin 11:cada08fc8a70 4 * \brief Elliptic curve DSA
mbedAustin 11:cada08fc8a70 5 *
mbedAustin 11:cada08fc8a70 6 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
mbedAustin 11:cada08fc8a70 7 * SPDX-License-Identifier: Apache-2.0
mbedAustin 11:cada08fc8a70 8 *
mbedAustin 11:cada08fc8a70 9 * Licensed under the Apache License, Version 2.0 (the "License"); you may
mbedAustin 11:cada08fc8a70 10 * not use this file except in compliance with the License.
mbedAustin 11:cada08fc8a70 11 * You may obtain a copy of the License at
mbedAustin 11:cada08fc8a70 12 *
mbedAustin 11:cada08fc8a70 13 * http://www.apache.org/licenses/LICENSE-2.0
mbedAustin 11:cada08fc8a70 14 *
mbedAustin 11:cada08fc8a70 15 * Unless required by applicable law or agreed to in writing, software
mbedAustin 11:cada08fc8a70 16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
mbedAustin 11:cada08fc8a70 17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mbedAustin 11:cada08fc8a70 18 * See the License for the specific language governing permissions and
mbedAustin 11:cada08fc8a70 19 * limitations under the License.
mbedAustin 11:cada08fc8a70 20 *
mbedAustin 11:cada08fc8a70 21 * This file is part of mbed TLS (https://tls.mbed.org)
mbedAustin 11:cada08fc8a70 22 */
mbedAustin 11:cada08fc8a70 23 #ifndef MBEDTLS_ECDSA_H
mbedAustin 11:cada08fc8a70 24 #define MBEDTLS_ECDSA_H
mbedAustin 11:cada08fc8a70 25
mbedAustin 11:cada08fc8a70 26 #include "ecp.h"
mbedAustin 11:cada08fc8a70 27 #include "md.h"
mbedAustin 11:cada08fc8a70 28
mbedAustin 11:cada08fc8a70 29 /*
mbedAustin 11:cada08fc8a70 30 * RFC 4492 page 20:
mbedAustin 11:cada08fc8a70 31 *
mbedAustin 11:cada08fc8a70 32 * Ecdsa-Sig-Value ::= SEQUENCE {
mbedAustin 11:cada08fc8a70 33 * r INTEGER,
mbedAustin 11:cada08fc8a70 34 * s INTEGER
mbedAustin 11:cada08fc8a70 35 * }
mbedAustin 11:cada08fc8a70 36 *
mbedAustin 11:cada08fc8a70 37 * Size is at most
mbedAustin 11:cada08fc8a70 38 * 1 (tag) + 1 (len) + 1 (initial 0) + ECP_MAX_BYTES for each of r and s,
mbedAustin 11:cada08fc8a70 39 * twice that + 1 (tag) + 2 (len) for the sequence
mbedAustin 11:cada08fc8a70 40 * (assuming ECP_MAX_BYTES is less than 126 for r and s,
mbedAustin 11:cada08fc8a70 41 * and less than 124 (total len <= 255) for the sequence)
mbedAustin 11:cada08fc8a70 42 */
mbedAustin 11:cada08fc8a70 43 #if MBEDTLS_ECP_MAX_BYTES > 124
mbedAustin 11:cada08fc8a70 44 #error "MBEDTLS_ECP_MAX_BYTES bigger than expected, please fix MBEDTLS_ECDSA_MAX_LEN"
mbedAustin 11:cada08fc8a70 45 #endif
mbedAustin 11:cada08fc8a70 46 /** Maximum size of an ECDSA signature in bytes */
mbedAustin 11:cada08fc8a70 47 #define MBEDTLS_ECDSA_MAX_LEN ( 3 + 2 * ( 3 + MBEDTLS_ECP_MAX_BYTES ) )
mbedAustin 11:cada08fc8a70 48
mbedAustin 11:cada08fc8a70 49 /**
mbedAustin 11:cada08fc8a70 50 * \brief ECDSA context structure
mbedAustin 11:cada08fc8a70 51 */
mbedAustin 11:cada08fc8a70 52 typedef mbedtls_ecp_keypair mbedtls_ecdsa_context;
mbedAustin 11:cada08fc8a70 53
mbedAustin 11:cada08fc8a70 54 #ifdef __cplusplus
mbedAustin 11:cada08fc8a70 55 extern "C" {
mbedAustin 11:cada08fc8a70 56 #endif
mbedAustin 11:cada08fc8a70 57
mbedAustin 11:cada08fc8a70 58 /**
mbedAustin 11:cada08fc8a70 59 * \brief Compute ECDSA signature of a previously hashed message
mbedAustin 11:cada08fc8a70 60 *
mbedAustin 11:cada08fc8a70 61 * \note The deterministic version is usually prefered.
mbedAustin 11:cada08fc8a70 62 *
mbedAustin 11:cada08fc8a70 63 * \param grp ECP group
mbedAustin 11:cada08fc8a70 64 * \param r First output integer
mbedAustin 11:cada08fc8a70 65 * \param s Second output integer
mbedAustin 11:cada08fc8a70 66 * \param d Private signing key
mbedAustin 11:cada08fc8a70 67 * \param buf Message hash
mbedAustin 11:cada08fc8a70 68 * \param blen Length of buf
mbedAustin 11:cada08fc8a70 69 * \param f_rng RNG function
mbedAustin 11:cada08fc8a70 70 * \param p_rng RNG parameter
mbedAustin 11:cada08fc8a70 71 *
mbedAustin 11:cada08fc8a70 72 * \return 0 if successful,
mbedAustin 11:cada08fc8a70 73 * or a MBEDTLS_ERR_ECP_XXX or MBEDTLS_MPI_XXX error code
mbedAustin 11:cada08fc8a70 74 */
mbedAustin 11:cada08fc8a70 75 int mbedtls_ecdsa_sign( mbedtls_ecp_group *grp, mbedtls_mpi *r, mbedtls_mpi *s,
mbedAustin 11:cada08fc8a70 76 const mbedtls_mpi *d, const unsigned char *buf, size_t blen,
mbedAustin 11:cada08fc8a70 77 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
mbedAustin 11:cada08fc8a70 78
mbedAustin 11:cada08fc8a70 79 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
mbedAustin 11:cada08fc8a70 80 /**
mbedAustin 11:cada08fc8a70 81 * \brief Compute ECDSA signature of a previously hashed message,
mbedAustin 11:cada08fc8a70 82 * deterministic version (RFC 6979).
mbedAustin 11:cada08fc8a70 83 *
mbedAustin 11:cada08fc8a70 84 * \param grp ECP group
mbedAustin 11:cada08fc8a70 85 * \param r First output integer
mbedAustin 11:cada08fc8a70 86 * \param s Second output integer
mbedAustin 11:cada08fc8a70 87 * \param d Private signing key
mbedAustin 11:cada08fc8a70 88 * \param buf Message hash
mbedAustin 11:cada08fc8a70 89 * \param blen Length of buf
mbedAustin 11:cada08fc8a70 90 * \param md_alg MD algorithm used to hash the message
mbedAustin 11:cada08fc8a70 91 *
mbedAustin 11:cada08fc8a70 92 * \return 0 if successful,
mbedAustin 11:cada08fc8a70 93 * or a MBEDTLS_ERR_ECP_XXX or MBEDTLS_MPI_XXX error code
mbedAustin 11:cada08fc8a70 94 */
mbedAustin 11:cada08fc8a70 95 int mbedtls_ecdsa_sign_det( mbedtls_ecp_group *grp, mbedtls_mpi *r, mbedtls_mpi *s,
mbedAustin 11:cada08fc8a70 96 const mbedtls_mpi *d, const unsigned char *buf, size_t blen,
mbedAustin 11:cada08fc8a70 97 mbedtls_md_type_t md_alg );
mbedAustin 11:cada08fc8a70 98 #endif /* MBEDTLS_ECDSA_DETERMINISTIC */
mbedAustin 11:cada08fc8a70 99
mbedAustin 11:cada08fc8a70 100 /**
mbedAustin 11:cada08fc8a70 101 * \brief Verify ECDSA signature of a previously hashed message
mbedAustin 11:cada08fc8a70 102 *
mbedAustin 11:cada08fc8a70 103 * \param grp ECP group
mbedAustin 11:cada08fc8a70 104 * \param buf Message hash
mbedAustin 11:cada08fc8a70 105 * \param blen Length of buf
mbedAustin 11:cada08fc8a70 106 * \param Q Public key to use for verification
mbedAustin 11:cada08fc8a70 107 * \param r First integer of the signature
mbedAustin 11:cada08fc8a70 108 * \param s Second integer of the signature
mbedAustin 11:cada08fc8a70 109 *
mbedAustin 11:cada08fc8a70 110 * \return 0 if successful,
mbedAustin 11:cada08fc8a70 111 * MBEDTLS_ERR_ECP_BAD_INPUT_DATA if signature is invalid
mbedAustin 11:cada08fc8a70 112 * or a MBEDTLS_ERR_ECP_XXX or MBEDTLS_MPI_XXX error code
mbedAustin 11:cada08fc8a70 113 */
mbedAustin 11:cada08fc8a70 114 int mbedtls_ecdsa_verify( mbedtls_ecp_group *grp,
mbedAustin 11:cada08fc8a70 115 const unsigned char *buf, size_t blen,
mbedAustin 11:cada08fc8a70 116 const mbedtls_ecp_point *Q, const mbedtls_mpi *r, const mbedtls_mpi *s);
mbedAustin 11:cada08fc8a70 117
mbedAustin 11:cada08fc8a70 118 /**
mbedAustin 11:cada08fc8a70 119 * \brief Compute ECDSA signature and write it to buffer,
mbedAustin 11:cada08fc8a70 120 * serialized as defined in RFC 4492 page 20.
mbedAustin 11:cada08fc8a70 121 * (Not thread-safe to use same context in multiple threads)
mbedAustin 11:cada08fc8a70 122 *
mbedAustin 11:cada08fc8a70 123 * \note The deterministice version (RFC 6979) is used if
mbedAustin 11:cada08fc8a70 124 * MBEDTLS_ECDSA_DETERMINISTIC is defined.
mbedAustin 11:cada08fc8a70 125 *
mbedAustin 11:cada08fc8a70 126 * \param ctx ECDSA context
mbedAustin 11:cada08fc8a70 127 * \param md_alg Algorithm that was used to hash the message
mbedAustin 11:cada08fc8a70 128 * \param hash Message hash
mbedAustin 11:cada08fc8a70 129 * \param hlen Length of hash
mbedAustin 11:cada08fc8a70 130 * \param sig Buffer that will hold the signature
mbedAustin 11:cada08fc8a70 131 * \param slen Length of the signature written
mbedAustin 11:cada08fc8a70 132 * \param f_rng RNG function
mbedAustin 11:cada08fc8a70 133 * \param p_rng RNG parameter
mbedAustin 11:cada08fc8a70 134 *
mbedAustin 11:cada08fc8a70 135 * \note The "sig" buffer must be at least as large as twice the
mbedAustin 11:cada08fc8a70 136 * size of the curve used, plus 9 (eg. 73 bytes if a 256-bit
mbedAustin 11:cada08fc8a70 137 * curve is used). MBEDTLS_ECDSA_MAX_LEN is always safe.
mbedAustin 11:cada08fc8a70 138 *
mbedAustin 11:cada08fc8a70 139 * \return 0 if successful,
mbedAustin 11:cada08fc8a70 140 * or a MBEDTLS_ERR_ECP_XXX, MBEDTLS_ERR_MPI_XXX or
mbedAustin 11:cada08fc8a70 141 * MBEDTLS_ERR_ASN1_XXX error code
mbedAustin 11:cada08fc8a70 142 */
mbedAustin 11:cada08fc8a70 143 int mbedtls_ecdsa_write_signature( mbedtls_ecdsa_context *ctx, mbedtls_md_type_t md_alg,
mbedAustin 11:cada08fc8a70 144 const unsigned char *hash, size_t hlen,
mbedAustin 11:cada08fc8a70 145 unsigned char *sig, size_t *slen,
mbedAustin 11:cada08fc8a70 146 int (*f_rng)(void *, unsigned char *, size_t),
mbedAustin 11:cada08fc8a70 147 void *p_rng );
mbedAustin 11:cada08fc8a70 148
mbedAustin 11:cada08fc8a70 149 #if defined(MBEDTLS_ECDSA_DETERMINISTIC)
mbedAustin 11:cada08fc8a70 150 #if ! defined(MBEDTLS_DEPRECATED_REMOVED)
mbedAustin 11:cada08fc8a70 151 #if defined(MBEDTLS_DEPRECATED_WARNING)
mbedAustin 11:cada08fc8a70 152 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
mbedAustin 11:cada08fc8a70 153 #else
mbedAustin 11:cada08fc8a70 154 #define MBEDTLS_DEPRECATED
mbedAustin 11:cada08fc8a70 155 #endif
mbedAustin 11:cada08fc8a70 156 /**
mbedAustin 11:cada08fc8a70 157 * \brief Compute ECDSA signature and write it to buffer,
mbedAustin 11:cada08fc8a70 158 * serialized as defined in RFC 4492 page 20.
mbedAustin 11:cada08fc8a70 159 * Deterministic version, RFC 6979.
mbedAustin 11:cada08fc8a70 160 * (Not thread-safe to use same context in multiple threads)
mbedAustin 11:cada08fc8a70 161 *
mbedAustin 11:cada08fc8a70 162 * \deprecated Superseded by mbedtls_ecdsa_write_signature() in 2.0.0
mbedAustin 11:cada08fc8a70 163 *
mbedAustin 11:cada08fc8a70 164 * \param ctx ECDSA context
mbedAustin 11:cada08fc8a70 165 * \param hash Message hash
mbedAustin 11:cada08fc8a70 166 * \param hlen Length of hash
mbedAustin 11:cada08fc8a70 167 * \param sig Buffer that will hold the signature
mbedAustin 11:cada08fc8a70 168 * \param slen Length of the signature written
mbedAustin 11:cada08fc8a70 169 * \param md_alg MD algorithm used to hash the message
mbedAustin 11:cada08fc8a70 170 *
mbedAustin 11:cada08fc8a70 171 * \note The "sig" buffer must be at least as large as twice the
mbedAustin 11:cada08fc8a70 172 * size of the curve used, plus 9 (eg. 73 bytes if a 256-bit
mbedAustin 11:cada08fc8a70 173 * curve is used). MBEDTLS_ECDSA_MAX_LEN is always safe.
mbedAustin 11:cada08fc8a70 174 *
mbedAustin 11:cada08fc8a70 175 * \return 0 if successful,
mbedAustin 11:cada08fc8a70 176 * or a MBEDTLS_ERR_ECP_XXX, MBEDTLS_ERR_MPI_XXX or
mbedAustin 11:cada08fc8a70 177 * MBEDTLS_ERR_ASN1_XXX error code
mbedAustin 11:cada08fc8a70 178 */
mbedAustin 11:cada08fc8a70 179 int mbedtls_ecdsa_write_signature_det( mbedtls_ecdsa_context *ctx,
mbedAustin 11:cada08fc8a70 180 const unsigned char *hash, size_t hlen,
mbedAustin 11:cada08fc8a70 181 unsigned char *sig, size_t *slen,
mbedAustin 11:cada08fc8a70 182 mbedtls_md_type_t md_alg ) MBEDTLS_DEPRECATED;
mbedAustin 11:cada08fc8a70 183 #undef MBEDTLS_DEPRECATED
mbedAustin 11:cada08fc8a70 184 #endif /* MBEDTLS_DEPRECATED_REMOVED */
mbedAustin 11:cada08fc8a70 185 #endif /* MBEDTLS_ECDSA_DETERMINISTIC */
mbedAustin 11:cada08fc8a70 186
mbedAustin 11:cada08fc8a70 187 /**
mbedAustin 11:cada08fc8a70 188 * \brief Read and verify an ECDSA signature
mbedAustin 11:cada08fc8a70 189 *
mbedAustin 11:cada08fc8a70 190 * \param ctx ECDSA context
mbedAustin 11:cada08fc8a70 191 * \param hash Message hash
mbedAustin 11:cada08fc8a70 192 * \param hlen Size of hash
mbedAustin 11:cada08fc8a70 193 * \param sig Signature to read and verify
mbedAustin 11:cada08fc8a70 194 * \param slen Size of sig
mbedAustin 11:cada08fc8a70 195 *
mbedAustin 11:cada08fc8a70 196 * \return 0 if successful,
mbedAustin 11:cada08fc8a70 197 * MBEDTLS_ERR_ECP_BAD_INPUT_DATA if signature is invalid,
mbedAustin 11:cada08fc8a70 198 * MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH if the signature is
mbedAustin 11:cada08fc8a70 199 * valid but its actual length is less than siglen,
mbedAustin 11:cada08fc8a70 200 * or a MBEDTLS_ERR_ECP_XXX or MBEDTLS_ERR_MPI_XXX error code
mbedAustin 11:cada08fc8a70 201 */
mbedAustin 11:cada08fc8a70 202 int mbedtls_ecdsa_read_signature( mbedtls_ecdsa_context *ctx,
mbedAustin 11:cada08fc8a70 203 const unsigned char *hash, size_t hlen,
mbedAustin 11:cada08fc8a70 204 const unsigned char *sig, size_t slen );
mbedAustin 11:cada08fc8a70 205
mbedAustin 11:cada08fc8a70 206 /**
mbedAustin 11:cada08fc8a70 207 * \brief Generate an ECDSA keypair on the given curve
mbedAustin 11:cada08fc8a70 208 *
mbedAustin 11:cada08fc8a70 209 * \param ctx ECDSA context in which the keypair should be stored
mbedAustin 11:cada08fc8a70 210 * \param gid Group (elliptic curve) to use. One of the various
mbedAustin 11:cada08fc8a70 211 * MBEDTLS_ECP_DP_XXX macros depending on configuration.
mbedAustin 11:cada08fc8a70 212 * \param f_rng RNG function
mbedAustin 11:cada08fc8a70 213 * \param p_rng RNG parameter
mbedAustin 11:cada08fc8a70 214 *
mbedAustin 11:cada08fc8a70 215 * \return 0 on success, or a MBEDTLS_ERR_ECP_XXX code.
mbedAustin 11:cada08fc8a70 216 */
mbedAustin 11:cada08fc8a70 217 int mbedtls_ecdsa_genkey( mbedtls_ecdsa_context *ctx, mbedtls_ecp_group_id gid,
mbedAustin 11:cada08fc8a70 218 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng );
mbedAustin 11:cada08fc8a70 219
mbedAustin 11:cada08fc8a70 220 /**
mbedAustin 11:cada08fc8a70 221 * \brief Set an ECDSA context from an EC key pair
mbedAustin 11:cada08fc8a70 222 *
mbedAustin 11:cada08fc8a70 223 * \param ctx ECDSA context to set
mbedAustin 11:cada08fc8a70 224 * \param key EC key to use
mbedAustin 11:cada08fc8a70 225 *
mbedAustin 11:cada08fc8a70 226 * \return 0 on success, or a MBEDTLS_ERR_ECP_XXX code.
mbedAustin 11:cada08fc8a70 227 */
mbedAustin 11:cada08fc8a70 228 int mbedtls_ecdsa_from_keypair( mbedtls_ecdsa_context *ctx, const mbedtls_ecp_keypair *key );
mbedAustin 11:cada08fc8a70 229
mbedAustin 11:cada08fc8a70 230 /**
mbedAustin 11:cada08fc8a70 231 * \brief Initialize context
mbedAustin 11:cada08fc8a70 232 *
mbedAustin 11:cada08fc8a70 233 * \param ctx Context to initialize
mbedAustin 11:cada08fc8a70 234 */
mbedAustin 11:cada08fc8a70 235 void mbedtls_ecdsa_init( mbedtls_ecdsa_context *ctx );
mbedAustin 11:cada08fc8a70 236
mbedAustin 11:cada08fc8a70 237 /**
mbedAustin 11:cada08fc8a70 238 * \brief Free context
mbedAustin 11:cada08fc8a70 239 *
mbedAustin 11:cada08fc8a70 240 * \param ctx Context to free
mbedAustin 11:cada08fc8a70 241 */
mbedAustin 11:cada08fc8a70 242 void mbedtls_ecdsa_free( mbedtls_ecdsa_context *ctx );
mbedAustin 11:cada08fc8a70 243
mbedAustin 11:cada08fc8a70 244 #ifdef __cplusplus
mbedAustin 11:cada08fc8a70 245 }
mbedAustin 11:cada08fc8a70 246 #endif
mbedAustin 11:cada08fc8a70 247
mbedAustin 11:cada08fc8a70 248 #endif /* ecdsa.h */