Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 1 | /** |
| 2 | * \file ecp.h |
| 3 | * |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 4 | * \brief This file provides an API for Elliptic Curves over GF(P) (ECP). |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 5 | * |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 6 | * The use of ECP in cryptography and TLS is defined in |
| 7 | * <em>Standards for Efficient Cryptography Group (SECG): SEC1 |
| 8 | * Elliptic Curve Cryptography</em> and |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 9 | * <em>RFC-4492: Elliptic Curve Cryptography (ECC) Cipher Suites |
| 10 | * for Transport Layer Security (TLS)</em>. |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 11 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 12 | * <em>RFC-2409: The Internet Key Exchange (IKE)</em> defines ECP |
| 13 | * group types. |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 14 | * |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 15 | */ |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 16 | |
Darryl Green | a40a101 | 2018-01-05 15:33:17 +0000 | [diff] [blame] | 17 | /* |
Bence Szépkúti | a2947ac | 2020-08-19 16:37:36 +0200 | [diff] [blame] | 18 | * Copyright The Mbed TLS Contributors |
Bence Szépkúti | f744bd7 | 2020-06-05 13:02:18 +0200 | [diff] [blame] | 19 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
| 20 | * |
| 21 | * This file is provided under the Apache License 2.0, or the |
| 22 | * GNU General Public License v2.0 or later. |
| 23 | * |
| 24 | * ********** |
| 25 | * Apache License 2.0: |
Manuel Pégourié-Gonnard | 37ff140 | 2015-09-04 14:21:07 +0200 | [diff] [blame] | 26 | * |
| 27 | * Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 28 | * not use this file except in compliance with the License. |
| 29 | * You may obtain a copy of the License at |
| 30 | * |
| 31 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 32 | * |
| 33 | * Unless required by applicable law or agreed to in writing, software |
| 34 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 35 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 36 | * See the License for the specific language governing permissions and |
| 37 | * limitations under the License. |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 38 | * |
Bence Szépkúti | f744bd7 | 2020-06-05 13:02:18 +0200 | [diff] [blame] | 39 | * ********** |
| 40 | * |
| 41 | * ********** |
| 42 | * GNU General Public License v2.0 or later: |
| 43 | * |
| 44 | * This program is free software; you can redistribute it and/or modify |
| 45 | * it under the terms of the GNU General Public License as published by |
| 46 | * the Free Software Foundation; either version 2 of the License, or |
| 47 | * (at your option) any later version. |
| 48 | * |
| 49 | * This program is distributed in the hope that it will be useful, |
| 50 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 51 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 52 | * GNU General Public License for more details. |
| 53 | * |
| 54 | * You should have received a copy of the GNU General Public License along |
| 55 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 56 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 57 | * |
| 58 | * ********** |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 59 | */ |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 60 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 61 | #ifndef MBEDTLS_ECP_H |
| 62 | #define MBEDTLS_ECP_H |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 63 | |
Ron Eldor | 8b0cf2e | 2018-02-14 16:02:41 +0200 | [diff] [blame] | 64 | #if !defined(MBEDTLS_CONFIG_FILE) |
| 65 | #include "config.h" |
| 66 | #else |
| 67 | #include MBEDTLS_CONFIG_FILE |
| 68 | #endif |
| 69 | |
Manuel Pégourié-Gonnard | bdc9676 | 2013-10-03 11:50:39 +0200 | [diff] [blame] | 70 | #include "bignum.h" |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 71 | |
| 72 | /* |
Manuel Pégourié-Gonnard | 7cfcea3 | 2012-11-05 10:06:12 +0100 | [diff] [blame] | 73 | * ECP error codes |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 74 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 75 | #define MBEDTLS_ERR_ECP_BAD_INPUT_DATA -0x4F80 /**< Bad input parameters to function. */ |
| 76 | #define MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL -0x4F00 /**< The buffer is too small to write to. */ |
Rose Zadik | d353405 | 2018-04-23 16:12:42 +0100 | [diff] [blame] | 77 | #define MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE -0x4E80 /**< The requested feature is not available, for example, the requested curve is not supported. */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 78 | #define MBEDTLS_ERR_ECP_VERIFY_FAILED -0x4E00 /**< The signature is not valid. */ |
Manuel Pégourié-Gonnard | 6a8ca33 | 2015-05-28 09:33:39 +0200 | [diff] [blame] | 79 | #define MBEDTLS_ERR_ECP_ALLOC_FAILED -0x4D80 /**< Memory allocation failed. */ |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 80 | #define MBEDTLS_ERR_ECP_RANDOM_FAILED -0x4D00 /**< Generation of random value, such as ephemeral key, failed. */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 81 | #define MBEDTLS_ERR_ECP_INVALID_KEY -0x4C80 /**< Invalid private or public key. */ |
Gilles Peskine | 5114d3e | 2018-03-30 07:12:15 +0200 | [diff] [blame] | 82 | #define MBEDTLS_ERR_ECP_SIG_LEN_MISMATCH -0x4C00 /**< The buffer contains a valid signature followed by more data. */ |
Ron Eldor | 9924bdc | 2018-10-04 10:59:13 +0300 | [diff] [blame] | 83 | |
| 84 | /* MBEDTLS_ERR_ECP_HW_ACCEL_FAILED is deprecated and should not be used. */ |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 85 | #define MBEDTLS_ERR_ECP_HW_ACCEL_FAILED -0x4B80 /**< The ECP hardware accelerator failed. */ |
Ron Eldor | 9924bdc | 2018-10-04 10:59:13 +0300 | [diff] [blame] | 86 | |
Manuel Pégourié-Gonnard | f0bbd7e | 2018-10-15 13:22:41 +0200 | [diff] [blame] | 87 | #define MBEDTLS_ERR_ECP_IN_PROGRESS -0x4B00 /**< Operation in progress, call again with the same parameters to continue. */ |
Manuel Pégourié-Gonnard | 883f313 | 2012-11-02 09:40:25 +0100 | [diff] [blame] | 88 | |
Paul Bakker | 407a0da | 2013-06-27 14:29:21 +0200 | [diff] [blame] | 89 | #ifdef __cplusplus |
| 90 | extern "C" { |
| 91 | #endif |
| 92 | |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 93 | /** |
Rose Zadik | d76ac58 | 2018-04-23 06:29:34 +0100 | [diff] [blame] | 94 | * Domain-parameter identifiers: curve, subgroup, and generator. |
Manuel Pégourié-Gonnard | 7038039 | 2013-09-16 16:19:53 +0200 | [diff] [blame] | 95 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 96 | * \note Only curves over prime fields are supported. |
Manuel Pégourié-Gonnard | 7038039 | 2013-09-16 16:19:53 +0200 | [diff] [blame] | 97 | * |
| 98 | * \warning This library does not support validation of arbitrary domain |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 99 | * parameters. Therefore, only standardized domain parameters from trusted |
Manuel Pégourié-Gonnard | e3a062b | 2015-05-11 18:46:47 +0200 | [diff] [blame] | 100 | * sources should be used. See mbedtls_ecp_group_load(). |
Manuel Pégourié-Gonnard | 7038039 | 2013-09-16 16:19:53 +0200 | [diff] [blame] | 101 | */ |
| 102 | typedef enum |
| 103 | { |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 104 | MBEDTLS_ECP_DP_NONE = 0, /*!< Curve not defined. */ |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 105 | MBEDTLS_ECP_DP_SECP192R1, /*!< Domain parameters for the 192-bit curve defined by FIPS 186-4 and SEC1. */ |
| 106 | MBEDTLS_ECP_DP_SECP224R1, /*!< Domain parameters for the 224-bit curve defined by FIPS 186-4 and SEC1. */ |
| 107 | MBEDTLS_ECP_DP_SECP256R1, /*!< Domain parameters for the 256-bit curve defined by FIPS 186-4 and SEC1. */ |
| 108 | MBEDTLS_ECP_DP_SECP384R1, /*!< Domain parameters for the 384-bit curve defined by FIPS 186-4 and SEC1. */ |
| 109 | MBEDTLS_ECP_DP_SECP521R1, /*!< Domain parameters for the 521-bit curve defined by FIPS 186-4 and SEC1. */ |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 110 | MBEDTLS_ECP_DP_BP256R1, /*!< Domain parameters for 256-bit Brainpool curve. */ |
| 111 | MBEDTLS_ECP_DP_BP384R1, /*!< Domain parameters for 384-bit Brainpool curve. */ |
| 112 | MBEDTLS_ECP_DP_BP512R1, /*!< Domain parameters for 512-bit Brainpool curve. */ |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 113 | MBEDTLS_ECP_DP_CURVE25519, /*!< Domain parameters for Curve25519. */ |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 114 | MBEDTLS_ECP_DP_SECP192K1, /*!< Domain parameters for 192-bit "Koblitz" curve. */ |
| 115 | MBEDTLS_ECP_DP_SECP224K1, /*!< Domain parameters for 224-bit "Koblitz" curve. */ |
| 116 | MBEDTLS_ECP_DP_SECP256K1, /*!< Domain parameters for 256-bit "Koblitz" curve. */ |
Jaeden Amero | fe0669f | 2018-04-27 17:43:32 +0100 | [diff] [blame] | 117 | MBEDTLS_ECP_DP_CURVE448, /*!< Domain parameters for Curve448. */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 118 | } mbedtls_ecp_group_id; |
Manuel Pégourié-Gonnard | 7038039 | 2013-09-16 16:19:53 +0200 | [diff] [blame] | 119 | |
| 120 | /** |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 121 | * The number of supported curves, plus one for #MBEDTLS_ECP_DP_NONE. |
Manuel Pégourié-Gonnard | 6615366 | 2013-12-03 14:12:26 +0100 | [diff] [blame] | 122 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 123 | * \note Montgomery curves are currently excluded. |
Manuel Pégourié-Gonnard | f24b4a7 | 2013-09-23 18:14:50 +0200 | [diff] [blame] | 124 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 125 | #define MBEDTLS_ECP_DP_MAX 12 |
Manuel Pégourié-Gonnard | f24b4a7 | 2013-09-23 18:14:50 +0200 | [diff] [blame] | 126 | |
| 127 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 128 | * Curve information, for use by other modules. |
Manuel Pégourié-Gonnard | 568c9cf | 2013-09-16 17:30:04 +0200 | [diff] [blame] | 129 | */ |
Dawid Drozd | 428cc52 | 2018-07-24 10:02:47 +0200 | [diff] [blame] | 130 | typedef struct mbedtls_ecp_curve_info |
Manuel Pégourié-Gonnard | 568c9cf | 2013-09-16 17:30:04 +0200 | [diff] [blame] | 131 | { |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 132 | mbedtls_ecp_group_id grp_id; /*!< An internal identifier. */ |
| 133 | uint16_t tls_id; /*!< The TLS NamedCurve identifier. */ |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 134 | uint16_t bit_size; /*!< The curve size in bits. */ |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 135 | const char *name; /*!< A human-friendly name. */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 136 | } mbedtls_ecp_curve_info; |
Manuel Pégourié-Gonnard | 568c9cf | 2013-09-16 17:30:04 +0200 | [diff] [blame] | 137 | |
| 138 | /** |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 139 | * \brief The ECP point structure, in Jacobian coordinates. |
Manuel Pégourié-Gonnard | ae180d0 | 2012-11-02 18:14:40 +0100 | [diff] [blame] | 140 | * |
Manuel Pégourié-Gonnard | 1c2782c | 2012-11-19 20:16:28 +0100 | [diff] [blame] | 141 | * \note All functions expect and return points satisfying |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 142 | * the following condition: <code>Z == 0</code> or |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 143 | * <code>Z == 1</code>. Other values of \p Z are |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 144 | * used only by internal functions. |
| 145 | * The point is zero, or "at infinity", if <code>Z == 0</code>. |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 146 | * Otherwise, \p X and \p Y are its standard (affine) |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 147 | * coordinates. |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 148 | */ |
Dawid Drozd | 428cc52 | 2018-07-24 10:02:47 +0200 | [diff] [blame] | 149 | typedef struct mbedtls_ecp_point |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 150 | { |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 151 | mbedtls_mpi X; /*!< The X coordinate of the ECP point. */ |
| 152 | mbedtls_mpi Y; /*!< The Y coordinate of the ECP point. */ |
| 153 | mbedtls_mpi Z; /*!< The Z coordinate of the ECP point. */ |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 154 | } |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 155 | mbedtls_ecp_point; |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 156 | |
| 157 | #if !defined(MBEDTLS_ECP_ALT) |
| 158 | /* |
| 159 | * default mbed TLS elliptic curve arithmetic implementation |
| 160 | * |
| 161 | * (in case MBEDTLS_ECP_ALT is defined then the developer has to provide an |
| 162 | * alternative implementation for the whole module and it will replace this |
| 163 | * one.) |
| 164 | */ |
| 165 | |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 166 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 167 | * \brief The ECP group structure. |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 168 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 169 | * We consider two types of curve equations: |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 170 | * <ul><li>Short Weierstrass: <code>y^2 = x^3 + A x + B mod P</code> |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 171 | * (SEC1 + RFC-4492)</li> |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 172 | * <li>Montgomery: <code>y^2 = x^3 + A x^2 + x mod P</code> (Curve25519, |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 173 | * Curve448)</li></ul> |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 174 | * In both cases, the generator (\p G) for a prime-order subgroup is fixed. |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 175 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 176 | * For Short Weierstrass, this subgroup is the whole curve, and its |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 177 | * cardinality is denoted by \p N. Our code requires that \p N is an |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 178 | * odd prime as mbedtls_ecp_mul() requires an odd number, and |
| 179 | * mbedtls_ecdsa_sign() requires that it is prime for blinding purposes. |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 180 | * |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 181 | * For Montgomery curves, we do not store \p A, but <code>(A + 2) / 4</code>, |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 182 | * which is the quantity used in the formulas. Additionally, \p nbits is |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 183 | * not the size of \p N but the required size for private keys. |
Manuel Pégourié-Gonnard | 4712325 | 2012-11-10 14:44:24 +0100 | [diff] [blame] | 184 | * |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 185 | * If \p modp is NULL, reduction modulo \p P is done using a generic algorithm. |
| 186 | * Otherwise, \p modp must point to a function that takes an \p mbedtls_mpi in the |
| 187 | * range of <code>0..2^(2*pbits)-1</code>, and transforms it in-place to an integer |
| 188 | * which is congruent mod \p P to the given MPI, and is close enough to \p pbits |
| 189 | * in size, so that it may be efficiently brought in the 0..P-1 range by a few |
| 190 | * additions or subtractions. Therefore, it is only an approximative modular |
| 191 | * reduction. It must return 0 on success and non-zero on failure. |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 192 | * |
Janos Follath | c3b680b | 2018-12-05 16:01:13 +0000 | [diff] [blame] | 193 | * \note Alternative implementations must keep the group IDs distinct. If |
| 194 | * two group structures have the same ID, then they must be |
| 195 | * identical. |
| 196 | * |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 197 | */ |
Dawid Drozd | 428cc52 | 2018-07-24 10:02:47 +0200 | [diff] [blame] | 198 | typedef struct mbedtls_ecp_group |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 199 | { |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 200 | mbedtls_ecp_group_id id; /*!< An internal group identifier. */ |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 201 | mbedtls_mpi P; /*!< The prime modulus of the base field. */ |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 202 | mbedtls_mpi A; /*!< For Short Weierstrass: \p A in the equation. For |
| 203 | Montgomery curves: <code>(A + 2) / 4</code>. */ |
| 204 | mbedtls_mpi B; /*!< For Short Weierstrass: \p B in the equation. |
| 205 | For Montgomery curves: unused. */ |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 206 | mbedtls_ecp_point G; /*!< The generator of the subgroup used. */ |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 207 | mbedtls_mpi N; /*!< The order of \p G. */ |
| 208 | size_t pbits; /*!< The number of bits in \p P.*/ |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 209 | size_t nbits; /*!< For Short Weierstrass: The number of bits in \p P. |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 210 | For Montgomery curves: the number of bits in the |
Rose Zadik | d76ac58 | 2018-04-23 06:29:34 +0100 | [diff] [blame] | 211 | private keys. */ |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 212 | unsigned int h; /*!< \internal 1 if the constants are static. */ |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 213 | int (*modp)(mbedtls_mpi *); /*!< The function for fast pseudo-reduction |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 214 | mod \p P (see above).*/ |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 215 | int (*t_pre)(mbedtls_ecp_point *, void *); /*!< Unused. */ |
| 216 | int (*t_post)(mbedtls_ecp_point *, void *); /*!< Unused. */ |
| 217 | void *t_data; /*!< Unused. */ |
| 218 | mbedtls_ecp_point *T; /*!< Pre-computed points for ecp_mul_comb(). */ |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 219 | size_t T_size; /*!< The number of pre-computed points. */ |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 220 | } |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 221 | mbedtls_ecp_group; |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 222 | |
Darryl Green | b779759 | 2019-01-04 16:18:06 +0000 | [diff] [blame] | 223 | /** |
| 224 | * \name SECTION: Module settings |
| 225 | * |
| 226 | * The configuration options you can set for this module are in this section. |
| 227 | * Either change them in config.h, or define them using the compiler command line. |
| 228 | * \{ |
| 229 | */ |
| 230 | |
| 231 | #if !defined(MBEDTLS_ECP_MAX_BITS) |
| 232 | /** |
| 233 | * The maximum size of the groups, that is, of \c N and \c P. |
| 234 | */ |
| 235 | #define MBEDTLS_ECP_MAX_BITS 521 /**< The maximum size of groups, in bits. */ |
| 236 | #endif |
| 237 | |
| 238 | #define MBEDTLS_ECP_MAX_BYTES ( ( MBEDTLS_ECP_MAX_BITS + 7 ) / 8 ) |
| 239 | #define MBEDTLS_ECP_MAX_PT_LEN ( 2 * MBEDTLS_ECP_MAX_BYTES + 1 ) |
| 240 | |
| 241 | #if !defined(MBEDTLS_ECP_WINDOW_SIZE) |
| 242 | /* |
| 243 | * Maximum "window" size used for point multiplication. |
| 244 | * Default: 6. |
| 245 | * Minimum value: 2. Maximum value: 7. |
| 246 | * |
| 247 | * Result is an array of at most ( 1 << ( MBEDTLS_ECP_WINDOW_SIZE - 1 ) ) |
| 248 | * points used for point multiplication. This value is directly tied to EC |
| 249 | * peak memory usage, so decreasing it by one should roughly cut memory usage |
| 250 | * by two (if large curves are in use). |
| 251 | * |
| 252 | * Reduction in size may reduce speed, but larger curves are impacted first. |
| 253 | * Sample performances (in ECDHE handshakes/s, with FIXED_POINT_OPTIM = 1): |
| 254 | * w-size: 6 5 4 3 2 |
| 255 | * 521 145 141 135 120 97 |
| 256 | * 384 214 209 198 177 146 |
| 257 | * 256 320 320 303 262 226 |
| 258 | * 224 475 475 453 398 342 |
| 259 | * 192 640 640 633 587 476 |
| 260 | */ |
| 261 | #define MBEDTLS_ECP_WINDOW_SIZE 6 /**< The maximum window size used. */ |
| 262 | #endif /* MBEDTLS_ECP_WINDOW_SIZE */ |
| 263 | |
| 264 | #if !defined(MBEDTLS_ECP_FIXED_POINT_OPTIM) |
| 265 | /* |
| 266 | * Trade memory for speed on fixed-point multiplication. |
| 267 | * |
| 268 | * This speeds up repeated multiplication of the generator (that is, the |
| 269 | * multiplication in ECDSA signatures, and half of the multiplications in |
| 270 | * ECDSA verification and ECDHE) by a factor roughly 3 to 4. |
| 271 | * |
| 272 | * The cost is increasing EC peak memory usage by a factor roughly 2. |
| 273 | * |
| 274 | * Change this value to 0 to reduce peak memory usage. |
| 275 | */ |
| 276 | #define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up. */ |
| 277 | #endif /* MBEDTLS_ECP_FIXED_POINT_OPTIM */ |
| 278 | |
| 279 | /* \} name SECTION: Module settings */ |
| 280 | |
| 281 | #else /* MBEDTLS_ECP_ALT */ |
| 282 | #include "ecp_alt.h" |
| 283 | #endif /* MBEDTLS_ECP_ALT */ |
| 284 | |
Manuel Pégourié-Gonnard | 4b9c51e | 2017-04-20 15:50:26 +0200 | [diff] [blame] | 285 | #if defined(MBEDTLS_ECP_RESTARTABLE) |
Manuel Pégourié-Gonnard | b5a50e7 | 2017-04-20 16:06:13 +0200 | [diff] [blame] | 286 | |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 287 | /** |
Manuel Pégourié-Gonnard | 3cade22 | 2017-04-20 09:31:00 +0200 | [diff] [blame] | 288 | * \brief Internal restart context for multiplication |
| 289 | * |
| 290 | * \note Opaque struct |
| 291 | */ |
| 292 | typedef struct mbedtls_ecp_restart_mul mbedtls_ecp_restart_mul_ctx; |
| 293 | |
| 294 | /** |
Manuel Pégourié-Gonnard | 54dd652 | 2017-04-20 13:36:18 +0200 | [diff] [blame] | 295 | * \brief Internal restart context for ecp_muladd() |
| 296 | * |
| 297 | * \note Opaque struct |
| 298 | */ |
| 299 | typedef struct mbedtls_ecp_restart_muladd mbedtls_ecp_restart_muladd_ctx; |
| 300 | |
| 301 | /** |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 302 | * \brief General context for resuming ECC operations |
| 303 | */ |
| 304 | typedef struct |
| 305 | { |
Manuel Pégourié-Gonnard | 646393b | 2017-04-20 10:03:45 +0200 | [diff] [blame] | 306 | unsigned ops_done; /*!< current ops count */ |
Manuel Pégourié-Gonnard | 3a25612 | 2017-04-20 11:20:26 +0200 | [diff] [blame] | 307 | unsigned depth; /*!< call depth (0 = top-level) */ |
Manuel Pégourié-Gonnard | 646393b | 2017-04-20 10:03:45 +0200 | [diff] [blame] | 308 | mbedtls_ecp_restart_mul_ctx *rsm; /*!< ecp_mul_comb() sub-context */ |
Manuel Pégourié-Gonnard | 54dd652 | 2017-04-20 13:36:18 +0200 | [diff] [blame] | 309 | mbedtls_ecp_restart_muladd_ctx *ma; /*!< ecp_muladd() sub-context */ |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 310 | } mbedtls_ecp_restart_ctx; |
Manuel Pégourié-Gonnard | b5a50e7 | 2017-04-20 16:06:13 +0200 | [diff] [blame] | 311 | |
Manuel Pégourié-Gonnard | c751148 | 2017-04-20 16:31:00 +0200 | [diff] [blame] | 312 | /* |
| 313 | * Operation counts for restartable functions |
| 314 | */ |
Manuel Pégourié-Gonnard | 5314f23 | 2017-04-21 12:36:59 +0200 | [diff] [blame] | 315 | #define MBEDTLS_ECP_OPS_CHK 3 /*!< basic ops count for ecp_check_pubkey() */ |
Manuel Pégourié-Gonnard | c751148 | 2017-04-20 16:31:00 +0200 | [diff] [blame] | 316 | #define MBEDTLS_ECP_OPS_DBL 8 /*!< basic ops count for ecp_double_jac() */ |
| 317 | #define MBEDTLS_ECP_OPS_ADD 11 /*!< basic ops count for see ecp_add_mixed() */ |
| 318 | #define MBEDTLS_ECP_OPS_INV 120 /*!< empirical equivalent for mpi_mod_inv() */ |
| 319 | |
| 320 | /** |
| 321 | * \brief Internal; for restartable functions in other modules. |
| 322 | * Check and update basic ops budget. |
| 323 | * |
| 324 | * \param grp Group structure |
| 325 | * \param rs_ctx Restart context |
| 326 | * \param ops Number of basic ops to do |
| 327 | * |
Manuel Pégourié-Gonnard | 12e4a8b | 2018-09-12 10:55:15 +0200 | [diff] [blame] | 328 | * \return \c 0 if doing \p ops basic ops is still allowed, |
| 329 | * \return #MBEDTLS_ERR_ECP_IN_PROGRESS otherwise. |
Manuel Pégourié-Gonnard | c751148 | 2017-04-20 16:31:00 +0200 | [diff] [blame] | 330 | */ |
| 331 | int mbedtls_ecp_check_budget( const mbedtls_ecp_group *grp, |
| 332 | mbedtls_ecp_restart_ctx *rs_ctx, |
| 333 | unsigned ops ); |
| 334 | |
| 335 | /* Utility macro for checking and updating ops budget */ |
Hanno Becker | abdf67e | 2018-10-26 13:28:32 +0100 | [diff] [blame] | 336 | #define MBEDTLS_ECP_BUDGET( ops ) \ |
| 337 | MBEDTLS_MPI_CHK( mbedtls_ecp_check_budget( grp, rs_ctx, \ |
| 338 | (unsigned) (ops) ) ); |
Manuel Pégourié-Gonnard | c751148 | 2017-04-20 16:31:00 +0200 | [diff] [blame] | 339 | |
Manuel Pégourié-Gonnard | b5a50e7 | 2017-04-20 16:06:13 +0200 | [diff] [blame] | 340 | #else /* MBEDTLS_ECP_RESTARTABLE */ |
| 341 | |
Manuel Pégourié-Gonnard | c751148 | 2017-04-20 16:31:00 +0200 | [diff] [blame] | 342 | #define MBEDTLS_ECP_BUDGET( ops ) /* no-op; for compatibility */ |
| 343 | |
Manuel Pégourié-Gonnard | b5a50e7 | 2017-04-20 16:06:13 +0200 | [diff] [blame] | 344 | /* We want to declare restartable versions of existing functions anyway */ |
| 345 | typedef void mbedtls_ecp_restart_ctx; |
| 346 | |
Manuel Pégourié-Gonnard | 4b9c51e | 2017-04-20 15:50:26 +0200 | [diff] [blame] | 347 | #endif /* MBEDTLS_ECP_RESTARTABLE */ |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 348 | |
Paul Bakker | 088c5c5 | 2014-04-25 11:11:10 +0200 | [diff] [blame] | 349 | /** |
Jaeden Amero | 8945343 | 2018-04-24 17:15:38 +0100 | [diff] [blame] | 350 | * \brief The ECP key-pair structure. |
Ron Eldor | 05d0e51 | 2018-04-16 17:40:04 +0300 | [diff] [blame] | 351 | * |
Jaeden Amero | 8945343 | 2018-04-24 17:15:38 +0100 | [diff] [blame] | 352 | * A generic key-pair that may be used for ECDSA and fixed ECDH, for example. |
Ron Eldor | 05d0e51 | 2018-04-16 17:40:04 +0300 | [diff] [blame] | 353 | * |
Jaeden Amero | 8945343 | 2018-04-24 17:15:38 +0100 | [diff] [blame] | 354 | * \note Members are deliberately in the same order as in the |
| 355 | * ::mbedtls_ecdsa_context structure. |
Ron Eldor | 05d0e51 | 2018-04-16 17:40:04 +0300 | [diff] [blame] | 356 | */ |
Dawid Drozd | 428cc52 | 2018-07-24 10:02:47 +0200 | [diff] [blame] | 357 | typedef struct mbedtls_ecp_keypair |
Ron Eldor | 05d0e51 | 2018-04-16 17:40:04 +0300 | [diff] [blame] | 358 | { |
| 359 | mbedtls_ecp_group grp; /*!< Elliptic curve and base point */ |
| 360 | mbedtls_mpi d; /*!< our secret value */ |
| 361 | mbedtls_ecp_point Q; /*!< our public value */ |
| 362 | } |
| 363 | mbedtls_ecp_keypair; |
| 364 | |
Manuel Pégourié-Gonnard | 37d218a | 2012-11-24 15:19:55 +0100 | [diff] [blame] | 365 | /* |
Manuel Pégourié-Gonnard | 0079405 | 2013-02-09 19:00:07 +0100 | [diff] [blame] | 366 | * Point formats, from RFC 4492's enum ECPointFormat |
Manuel Pégourié-Gonnard | 37d218a | 2012-11-24 15:19:55 +0100 | [diff] [blame] | 367 | */ |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 368 | #define MBEDTLS_ECP_PF_UNCOMPRESSED 0 /**< Uncompressed point format. */ |
| 369 | #define MBEDTLS_ECP_PF_COMPRESSED 1 /**< Compressed point format. */ |
Manuel Pégourié-Gonnard | 37d218a | 2012-11-24 15:19:55 +0100 | [diff] [blame] | 370 | |
Manuel Pégourié-Gonnard | 1a96728 | 2013-02-09 17:03:58 +0100 | [diff] [blame] | 371 | /* |
Manuel Pégourié-Gonnard | 0079405 | 2013-02-09 19:00:07 +0100 | [diff] [blame] | 372 | * Some other constants from RFC 4492 |
Manuel Pégourié-Gonnard | 1a96728 | 2013-02-09 17:03:58 +0100 | [diff] [blame] | 373 | */ |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 374 | #define MBEDTLS_ECP_TLS_NAMED_CURVE 3 /**< The named_curve of ECCurveType. */ |
Manuel Pégourié-Gonnard | 1a96728 | 2013-02-09 17:03:58 +0100 | [diff] [blame] | 375 | |
Manuel Pégourié-Gonnard | 4b9c51e | 2017-04-20 15:50:26 +0200 | [diff] [blame] | 376 | #if defined(MBEDTLS_ECP_RESTARTABLE) |
Manuel Pégourié-Gonnard | 054433c | 2017-03-22 11:18:33 +0100 | [diff] [blame] | 377 | /** |
| 378 | * \brief Set the maximum number of basic operations done in a row. |
| 379 | * |
| 380 | * If more operations are needed to complete a computation, |
Manuel Pégourié-Gonnard | 12e4a8b | 2018-09-12 10:55:15 +0200 | [diff] [blame] | 381 | * #MBEDTLS_ERR_ECP_IN_PROGRESS will be returned by the |
Manuel Pégourié-Gonnard | 8467e68 | 2017-04-20 09:47:06 +0200 | [diff] [blame] | 382 | * function performing the computation. It is then the |
| 383 | * caller's responsibility to either call again with the same |
Manuel Pégourié-Gonnard | 7037e22 | 2017-08-23 14:30:36 +0200 | [diff] [blame] | 384 | * parameters until it returns 0 or an error code; or to free |
Manuel Pégourié-Gonnard | 8467e68 | 2017-04-20 09:47:06 +0200 | [diff] [blame] | 385 | * the restart context if the operation is to be aborted. |
Manuel Pégourié-Gonnard | 054433c | 2017-03-22 11:18:33 +0100 | [diff] [blame] | 386 | * |
Manuel Pégourié-Gonnard | 7037e22 | 2017-08-23 14:30:36 +0200 | [diff] [blame] | 387 | * It is strictly required that all input parameters and the |
| 388 | * restart context be the same on successive calls for the |
| 389 | * same operation, but output parameters need not be the |
| 390 | * same; they must not be used until the function finally |
| 391 | * returns 0. |
| 392 | * |
Manuel Pégourié-Gonnard | 32df911 | 2018-10-15 13:29:21 +0200 | [diff] [blame] | 393 | * This only applies to functions whose documentation |
| 394 | * mentions they may return #MBEDTLS_ERR_ECP_IN_PROGRESS (or |
| 395 | * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS for functions in the |
| 396 | * SSL module). For functions that accept a "restart context" |
| 397 | * argument, passing NULL disables restart and makes the |
| 398 | * function equivalent to the function with the same name |
| 399 | * with \c _restartable removed. For functions in the ECDH |
| 400 | * module, restart is disabled unless the function accepts |
| 401 | * an "ECDH context" argument and |
| 402 | * mbedtls_ecdh_enable_restart() was previously called on |
| 403 | * that context. For function in the SSL module, restart is |
| 404 | * only enabled for specific sides and key exchanges |
| 405 | * (currently only for clients and ECDHE-ECDSA). |
Manuel Pégourié-Gonnard | 8f28add | 2017-04-19 10:20:49 +0200 | [diff] [blame] | 406 | * |
Manuel Pégourié-Gonnard | 054433c | 2017-03-22 11:18:33 +0100 | [diff] [blame] | 407 | * \param max_ops Maximum number of basic operations done in a row. |
| 408 | * Default: 0 (unlimited). |
| 409 | * Lower (non-zero) values mean ECC functions will block for |
| 410 | * a lesser maximum amount of time. |
| 411 | * |
Manuel Pégourié-Gonnard | e685449 | 2017-03-20 14:35:19 +0100 | [diff] [blame] | 412 | * \note A "basic operation" is defined as a rough equivalent of a |
| 413 | * multiplication in GF(p) for the NIST P-256 curve. |
| 414 | * As an indication, with default settings, a scalar |
| 415 | * multiplication (full run of \c mbedtls_ecp_mul()) is: |
| 416 | * - about 3300 basic operations for P-256 |
| 417 | * - about 9400 basic operations for P-384 |
Manuel Pégourié-Gonnard | 054433c | 2017-03-22 11:18:33 +0100 | [diff] [blame] | 418 | * |
Manuel Pégourié-Gonnard | e58f65a | 2017-03-20 14:59:54 +0100 | [diff] [blame] | 419 | * \note Very low values are not always respected: sometimes |
Manuel Pégourié-Gonnard | 1c678e0 | 2017-03-20 13:39:39 +0100 | [diff] [blame] | 420 | * functions need to block for a minimum number of |
| 421 | * operations, and will do so even if max_ops is set to a |
| 422 | * lower value. That minimum depends on the curve size, and |
| 423 | * can be made lower by decreasing the value of |
Manuel Pégourié-Gonnard | 7037e22 | 2017-08-23 14:30:36 +0200 | [diff] [blame] | 424 | * \c MBEDTLS_ECP_WINDOW_SIZE. As an indication, here is the |
| 425 | * lowest effective value for various curves and values of |
| 426 | * that parameter (w for short): |
| 427 | * w=6 w=5 w=4 w=3 w=2 |
| 428 | * P-256 208 208 160 136 124 |
| 429 | * P-384 682 416 320 272 248 |
| 430 | * P-521 1364 832 640 544 496 |
Manuel Pégourié-Gonnard | e58f65a | 2017-03-20 14:59:54 +0100 | [diff] [blame] | 431 | * |
Manuel Pégourié-Gonnard | 12e4a8b | 2018-09-12 10:55:15 +0200 | [diff] [blame] | 432 | * \note This setting is currently ignored by Curve25519. |
Manuel Pégourié-Gonnard | 054433c | 2017-03-22 11:18:33 +0100 | [diff] [blame] | 433 | */ |
| 434 | void mbedtls_ecp_set_max_ops( unsigned max_ops ); |
Manuel Pégourié-Gonnard | a0c5bcc | 2017-04-21 11:33:57 +0200 | [diff] [blame] | 435 | |
| 436 | /** |
| 437 | * \brief Check if restart is enabled (max_ops != 0) |
| 438 | * |
Manuel Pégourié-Gonnard | 12e4a8b | 2018-09-12 10:55:15 +0200 | [diff] [blame] | 439 | * \return \c 0 if \c max_ops == 0 (restart disabled) |
| 440 | * \return \c 1 otherwise (restart enabled) |
Manuel Pégourié-Gonnard | a0c5bcc | 2017-04-21 11:33:57 +0200 | [diff] [blame] | 441 | */ |
Manuel Pégourié-Gonnard | b843b15 | 2018-10-16 10:41:31 +0200 | [diff] [blame] | 442 | int mbedtls_ecp_restart_is_enabled( void ); |
Manuel Pégourié-Gonnard | 4b9c51e | 2017-04-20 15:50:26 +0200 | [diff] [blame] | 443 | #endif /* MBEDTLS_ECP_RESTARTABLE */ |
Manuel Pégourié-Gonnard | 054433c | 2017-03-22 11:18:33 +0100 | [diff] [blame] | 444 | |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 445 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 446 | * \brief This function retrieves the information defined in |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 447 | * mbedtls_ecp_curve_info() for all supported curves in order |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 448 | * of preference. |
Manuel Pégourié-Gonnard | da179e4 | 2013-09-18 15:31:24 +0200 | [diff] [blame] | 449 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 450 | * \return A statically allocated array. The last entry is 0. |
Manuel Pégourié-Gonnard | da179e4 | 2013-09-18 15:31:24 +0200 | [diff] [blame] | 451 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 452 | const mbedtls_ecp_curve_info *mbedtls_ecp_curve_list( void ); |
Manuel Pégourié-Gonnard | da179e4 | 2013-09-18 15:31:24 +0200 | [diff] [blame] | 453 | |
| 454 | /** |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 455 | * \brief This function retrieves the list of internal group |
| 456 | * identifiers of all supported curves in the order of |
| 457 | * preference. |
Manuel Pégourié-Gonnard | ac71941 | 2014-02-04 14:48:50 +0100 | [diff] [blame] | 458 | * |
| 459 | * \return A statically allocated array, |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 460 | * terminated with MBEDTLS_ECP_DP_NONE. |
Manuel Pégourié-Gonnard | ac71941 | 2014-02-04 14:48:50 +0100 | [diff] [blame] | 461 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 462 | const mbedtls_ecp_group_id *mbedtls_ecp_grp_id_list( void ); |
Manuel Pégourié-Gonnard | ac71941 | 2014-02-04 14:48:50 +0100 | [diff] [blame] | 463 | |
| 464 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 465 | * \brief This function retrieves curve information from an internal |
| 466 | * group identifier. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 467 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 468 | * \param grp_id An \c MBEDTLS_ECP_DP_XXX value. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 469 | * |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 470 | * \return The associated curve information on success. |
| 471 | * \return NULL on failure. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 472 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 473 | const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_grp_id( mbedtls_ecp_group_id grp_id ); |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 474 | |
| 475 | /** |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 476 | * \brief This function retrieves curve information from a TLS |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 477 | * NamedCurve value. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 478 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 479 | * \param tls_id An \c MBEDTLS_ECP_DP_XXX value. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 480 | * |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 481 | * \return The associated curve information on success. |
| 482 | * \return NULL on failure. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 483 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 484 | const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_tls_id( uint16_t tls_id ); |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 485 | |
| 486 | /** |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 487 | * \brief This function retrieves curve information from a |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 488 | * human-readable name. |
Manuel Pégourié-Gonnard | 0267e3d | 2013-11-30 15:10:14 +0100 | [diff] [blame] | 489 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 490 | * \param name The human-readable name. |
Manuel Pégourié-Gonnard | 0267e3d | 2013-11-30 15:10:14 +0100 | [diff] [blame] | 491 | * |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 492 | * \return The associated curve information on success. |
| 493 | * \return NULL on failure. |
Manuel Pégourié-Gonnard | 0267e3d | 2013-11-30 15:10:14 +0100 | [diff] [blame] | 494 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 495 | const mbedtls_ecp_curve_info *mbedtls_ecp_curve_info_from_name( const char *name ); |
Manuel Pégourié-Gonnard | 0267e3d | 2013-11-30 15:10:14 +0100 | [diff] [blame] | 496 | |
| 497 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 498 | * \brief This function initializes a point as zero. |
| 499 | * |
| 500 | * \param pt The point to initialize. |
Manuel Pégourié-Gonnard | ae180d0 | 2012-11-02 18:14:40 +0100 | [diff] [blame] | 501 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 502 | void mbedtls_ecp_point_init( mbedtls_ecp_point *pt ); |
Manuel Pégourié-Gonnard | ae180d0 | 2012-11-02 18:14:40 +0100 | [diff] [blame] | 503 | |
| 504 | /** |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 505 | * \brief This function initializes an ECP group context |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 506 | * without loading any domain parameters. |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 507 | * |
| 508 | * \note After this function is called, domain parameters |
| 509 | * for various ECP groups can be loaded through the |
Gilles Peskine | 4dc50bc | 2018-11-07 22:06:48 +0100 | [diff] [blame] | 510 | * mbedtls_ecp_group_load() or mbedtls_ecp_tls_read_group() |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 511 | * functions. |
Manuel Pégourié-Gonnard | b505c27 | 2012-11-05 17:27:54 +0100 | [diff] [blame] | 512 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 513 | void mbedtls_ecp_group_init( mbedtls_ecp_group *grp ); |
Manuel Pégourié-Gonnard | b505c27 | 2012-11-05 17:27:54 +0100 | [diff] [blame] | 514 | |
| 515 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 516 | * \brief This function initializes a key pair as an invalid one. |
| 517 | * |
| 518 | * \param key The key pair to initialize. |
Manuel Pégourié-Gonnard | b8c6e0e | 2013-07-01 13:40:52 +0200 | [diff] [blame] | 519 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 520 | void mbedtls_ecp_keypair_init( mbedtls_ecp_keypair *key ); |
Manuel Pégourié-Gonnard | b8c6e0e | 2013-07-01 13:40:52 +0200 | [diff] [blame] | 521 | |
| 522 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 523 | * \brief This function frees the components of a point. |
| 524 | * |
| 525 | * \param pt The point to free. |
Manuel Pégourié-Gonnard | 883f313 | 2012-11-02 09:40:25 +0100 | [diff] [blame] | 526 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 527 | void mbedtls_ecp_point_free( mbedtls_ecp_point *pt ); |
Manuel Pégourié-Gonnard | 883f313 | 2012-11-02 09:40:25 +0100 | [diff] [blame] | 528 | |
| 529 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 530 | * \brief This function frees the components of an ECP group. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 531 | * |
| 532 | * \param grp The group to free. This may be \c NULL, in which |
Hanno Becker | 486f1b3 | 2018-12-18 13:00:34 +0000 | [diff] [blame] | 533 | * case this function returns immediately. If it is not |
| 534 | * \c NULL, it must point to an initialized ECP group. |
Manuel Pégourié-Gonnard | 883f313 | 2012-11-02 09:40:25 +0100 | [diff] [blame] | 535 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 536 | void mbedtls_ecp_group_free( mbedtls_ecp_group *grp ); |
Manuel Pégourié-Gonnard | 883f313 | 2012-11-02 09:40:25 +0100 | [diff] [blame] | 537 | |
| 538 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 539 | * \brief This function frees the components of a key pair. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 540 | * |
| 541 | * \param key The key pair to free. This may be \c NULL, in which |
Hanno Becker | 486f1b3 | 2018-12-18 13:00:34 +0000 | [diff] [blame] | 542 | * case this function returns immediately. If it is not |
| 543 | * \c NULL, it must point to an initialized ECP key pair. |
Manuel Pégourié-Gonnard | b8c6e0e | 2013-07-01 13:40:52 +0200 | [diff] [blame] | 544 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 545 | void mbedtls_ecp_keypair_free( mbedtls_ecp_keypair *key ); |
Manuel Pégourié-Gonnard | b8c6e0e | 2013-07-01 13:40:52 +0200 | [diff] [blame] | 546 | |
Manuel Pégourié-Gonnard | 4b9c51e | 2017-04-20 15:50:26 +0200 | [diff] [blame] | 547 | #if defined(MBEDTLS_ECP_RESTARTABLE) |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 548 | /** |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 549 | * \brief Initialize a restart context. |
| 550 | * |
| 551 | * \param ctx The restart context to initialize. This must |
| 552 | * not be \c NULL. |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 553 | */ |
| 554 | void mbedtls_ecp_restart_init( mbedtls_ecp_restart_ctx *ctx ); |
| 555 | |
| 556 | /** |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 557 | * \brief Free the components of a restart context. |
| 558 | * |
| 559 | * \param ctx The restart context to free. This may be \c NULL, in which |
Hanno Becker | 486f1b3 | 2018-12-18 13:00:34 +0000 | [diff] [blame] | 560 | * case this function returns immediately. If it is not |
| 561 | * \c NULL, it must point to an initialized restart context. |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 562 | */ |
| 563 | void mbedtls_ecp_restart_free( mbedtls_ecp_restart_ctx *ctx ); |
Manuel Pégourié-Gonnard | 4b9c51e | 2017-04-20 15:50:26 +0200 | [diff] [blame] | 564 | #endif /* MBEDTLS_ECP_RESTARTABLE */ |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 565 | |
Manuel Pégourié-Gonnard | b8c6e0e | 2013-07-01 13:40:52 +0200 | [diff] [blame] | 566 | /** |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 567 | * \brief This function copies the contents of point \p Q into |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 568 | * point \p P. |
Manuel Pégourié-Gonnard | 883f313 | 2012-11-02 09:40:25 +0100 | [diff] [blame] | 569 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 570 | * \param P The destination point. This must be initialized. |
| 571 | * \param Q The source point. This must be initialized. |
Manuel Pégourié-Gonnard | 883f313 | 2012-11-02 09:40:25 +0100 | [diff] [blame] | 572 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 573 | * \return \c 0 on success. |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 574 | * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 575 | * \return Another negative error code for other kinds of failure. |
Manuel Pégourié-Gonnard | 883f313 | 2012-11-02 09:40:25 +0100 | [diff] [blame] | 576 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 577 | int mbedtls_ecp_copy( mbedtls_ecp_point *P, const mbedtls_ecp_point *Q ); |
Manuel Pégourié-Gonnard | 883f313 | 2012-11-02 09:40:25 +0100 | [diff] [blame] | 578 | |
| 579 | /** |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 580 | * \brief This function copies the contents of group \p src into |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 581 | * group \p dst. |
Manuel Pégourié-Gonnard | e09631b | 2013-08-12 15:44:31 +0200 | [diff] [blame] | 582 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 583 | * \param dst The destination group. This must be initialized. |
| 584 | * \param src The source group. This must be initialized. |
Manuel Pégourié-Gonnard | e09631b | 2013-08-12 15:44:31 +0200 | [diff] [blame] | 585 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 586 | * \return \c 0 on success. |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 587 | * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 588 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | e09631b | 2013-08-12 15:44:31 +0200 | [diff] [blame] | 589 | */ |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 590 | int mbedtls_ecp_group_copy( mbedtls_ecp_group *dst, |
| 591 | const mbedtls_ecp_group *src ); |
Manuel Pégourié-Gonnard | e09631b | 2013-08-12 15:44:31 +0200 | [diff] [blame] | 592 | |
| 593 | /** |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 594 | * \brief This function sets a point to the point at infinity. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 595 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 596 | * \param pt The point to set. This must be initialized. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 597 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 598 | * \return \c 0 on success. |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 599 | * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 600 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 601 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 602 | int mbedtls_ecp_set_zero( mbedtls_ecp_point *pt ); |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 603 | |
| 604 | /** |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 605 | * \brief This function checks if a point is the point at infinity. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 606 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 607 | * \param pt The point to test. This must be initialized. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 608 | * |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 609 | * \return \c 1 if the point is zero. |
| 610 | * \return \c 0 if the point is non-zero. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 611 | * \return A negative error code on failure. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 612 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 613 | int mbedtls_ecp_is_zero( mbedtls_ecp_point *pt ); |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 614 | |
| 615 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 616 | * \brief This function compares two points. |
Manuel Pégourié-Gonnard | 6029a85 | 2015-08-11 15:44:41 +0200 | [diff] [blame] | 617 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 618 | * \note This assumes that the points are normalized. Otherwise, |
Manuel Pégourié-Gonnard | 6029a85 | 2015-08-11 15:44:41 +0200 | [diff] [blame] | 619 | * they may compare as "not equal" even if they are. |
| 620 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 621 | * \param P The first point to compare. This must be initialized. |
| 622 | * \param Q The second point to compare. This must be initialized. |
Manuel Pégourié-Gonnard | 6029a85 | 2015-08-11 15:44:41 +0200 | [diff] [blame] | 623 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 624 | * \return \c 0 if the points are equal. |
| 625 | * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if the points are not equal. |
Manuel Pégourié-Gonnard | 6029a85 | 2015-08-11 15:44:41 +0200 | [diff] [blame] | 626 | */ |
| 627 | int mbedtls_ecp_point_cmp( const mbedtls_ecp_point *P, |
| 628 | const mbedtls_ecp_point *Q ); |
| 629 | |
| 630 | /** |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 631 | * \brief This function imports a non-zero point from two ASCII |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 632 | * strings. |
Manuel Pégourié-Gonnard | 847395a | 2012-11-05 13:13:44 +0100 | [diff] [blame] | 633 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 634 | * \param P The destination point. This must be initialized. |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 635 | * \param radix The numeric base of the input. |
| 636 | * \param x The first affine coordinate, as a null-terminated string. |
| 637 | * \param y The second affine coordinate, as a null-terminated string. |
Manuel Pégourié-Gonnard | 847395a | 2012-11-05 13:13:44 +0100 | [diff] [blame] | 638 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 639 | * \return \c 0 on success. |
| 640 | * \return An \c MBEDTLS_ERR_MPI_XXX error code on failure. |
Manuel Pégourié-Gonnard | 847395a | 2012-11-05 13:13:44 +0100 | [diff] [blame] | 641 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 642 | int mbedtls_ecp_point_read_string( mbedtls_ecp_point *P, int radix, |
Manuel Pégourié-Gonnard | 847395a | 2012-11-05 13:13:44 +0100 | [diff] [blame] | 643 | const char *x, const char *y ); |
| 644 | |
| 645 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 646 | * \brief This function exports a point into unsigned binary data. |
Manuel Pégourié-Gonnard | e19feb5 | 2012-11-24 14:10:14 +0100 | [diff] [blame] | 647 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 648 | * \param grp The group to which the point should belong. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 649 | * This must be initialized and have group parameters |
| 650 | * set, for example through mbedtls_ecp_group_load(). |
| 651 | * \param P The point to export. This must be initialized. |
| 652 | * \param format The point format. This must be either |
| 653 | * #MBEDTLS_ECP_PF_COMPRESSED or #MBEDTLS_ECP_PF_UNCOMPRESSED. |
| 654 | * \param olen The address at which to store the length of |
Hanno Becker | 5edcfa5 | 2018-12-18 12:49:55 +0000 | [diff] [blame] | 655 | * the output in Bytes. This must not be \c NULL. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 656 | * \param buf The output buffer. This must be a writable buffer |
| 657 | * of length \p buflen Bytes. |
| 658 | * \param buflen The length of the output buffer \p buf in Bytes. |
Manuel Pégourié-Gonnard | e19feb5 | 2012-11-24 14:10:14 +0100 | [diff] [blame] | 659 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 660 | * \return \c 0 on success. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 661 | * \return #MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL if the output buffer |
| 662 | * is too small to hold the point. |
| 663 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | e19feb5 | 2012-11-24 14:10:14 +0100 | [diff] [blame] | 664 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 665 | int mbedtls_ecp_point_write_binary( const mbedtls_ecp_group *grp, const mbedtls_ecp_point *P, |
Manuel Pégourié-Gonnard | 420f1eb | 2013-02-10 12:22:46 +0100 | [diff] [blame] | 666 | int format, size_t *olen, |
Manuel Pégourié-Gonnard | 7e86025 | 2013-02-10 10:58:48 +0100 | [diff] [blame] | 667 | unsigned char *buf, size_t buflen ); |
Manuel Pégourié-Gonnard | e19feb5 | 2012-11-24 14:10:14 +0100 | [diff] [blame] | 668 | |
| 669 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 670 | * \brief This function imports a point from unsigned binary data. |
Manuel Pégourié-Gonnard | 5e402d8 | 2012-11-24 16:19:42 +0100 | [diff] [blame] | 671 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 672 | * \note This function does not check that the point actually |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 673 | * belongs to the given group, see mbedtls_ecp_check_pubkey() |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 674 | * for that. |
Manuel Pégourié-Gonnard | 5e402d8 | 2012-11-24 16:19:42 +0100 | [diff] [blame] | 675 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 676 | * \param grp The group to which the point should belong. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 677 | * This must be initialized and have group parameters |
| 678 | * set, for example through mbedtls_ecp_group_load(). |
| 679 | * \param P The destination context to import the point to. |
| 680 | * This must be initialized. |
| 681 | * \param buf The input buffer. This must be a readable buffer |
| 682 | * of length \p ilen Bytes. |
| 683 | * \param ilen The length of the input buffer \p buf in Bytes. |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 684 | * |
| 685 | * \return \c 0 on success. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 686 | * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if the input is invalid. |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 687 | * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure. |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 688 | * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if the point format |
Manuel Pégourié-Gonnard | 5246ee5 | 2014-03-19 16:18:38 +0100 | [diff] [blame] | 689 | * is not implemented. |
Manuel Pégourié-Gonnard | 5e402d8 | 2012-11-24 16:19:42 +0100 | [diff] [blame] | 690 | */ |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 691 | int mbedtls_ecp_point_read_binary( const mbedtls_ecp_group *grp, |
| 692 | mbedtls_ecp_point *P, |
| 693 | const unsigned char *buf, size_t ilen ); |
Manuel Pégourié-Gonnard | 1a96728 | 2013-02-09 17:03:58 +0100 | [diff] [blame] | 694 | |
Manuel Pégourié-Gonnard | 5e402d8 | 2012-11-24 16:19:42 +0100 | [diff] [blame] | 695 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 696 | * \brief This function imports a point from a TLS ECPoint record. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 697 | * |
Janos Follath | 89ac8c9 | 2018-10-30 11:24:05 +0000 | [diff] [blame] | 698 | * \note On function return, \p *buf is updated to point immediately |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 699 | * after the ECPoint record. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 700 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 701 | * \param grp The ECP group to use. |
| 702 | * This must be initialized and have group parameters |
| 703 | * set, for example through mbedtls_ecp_group_load(). |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 704 | * \param pt The destination point. |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 705 | * \param buf The address of the pointer to the start of the input buffer. |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 706 | * \param len The length of the buffer. |
Manuel Pégourié-Gonnard | 150c4f6 | 2014-11-21 09:14:52 +0100 | [diff] [blame] | 707 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 708 | * \return \c 0 on success. |
Janos Follath | 89ac8c9 | 2018-10-30 11:24:05 +0000 | [diff] [blame] | 709 | * \return An \c MBEDTLS_ERR_MPI_XXX error code on initialization |
| 710 | * failure. |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 711 | * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if input is invalid. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 712 | */ |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 713 | int mbedtls_ecp_tls_read_point( const mbedtls_ecp_group *grp, |
| 714 | mbedtls_ecp_point *pt, |
| 715 | const unsigned char **buf, size_t len ); |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 716 | |
| 717 | /** |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 718 | * \brief This function exports a point as a TLS ECPoint record |
| 719 | * defined in RFC 4492, Section 5.4. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 720 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 721 | * \param grp The ECP group to use. |
| 722 | * This must be initialized and have group parameters |
| 723 | * set, for example through mbedtls_ecp_group_load(). |
| 724 | * \param pt The point to be exported. This must be initialized. |
| 725 | * \param format The point format to use. This must be either |
| 726 | * #MBEDTLS_ECP_PF_COMPRESSED or #MBEDTLS_ECP_PF_UNCOMPRESSED. |
| 727 | * \param olen The address at which to store the length in Bytes |
| 728 | * of the data written. |
| 729 | * \param buf The target buffer. This must be a writable buffer of |
| 730 | * length \p blen Bytes. |
| 731 | * \param blen The length of the target buffer \p buf in Bytes. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 732 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 733 | * \return \c 0 on success. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 734 | * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if the input is invalid. |
| 735 | * \return #MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL if the target buffer |
| 736 | * is too small to hold the exported point. |
| 737 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 738 | */ |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 739 | int mbedtls_ecp_tls_write_point( const mbedtls_ecp_group *grp, |
| 740 | const mbedtls_ecp_point *pt, |
| 741 | int format, size_t *olen, |
| 742 | unsigned char *buf, size_t blen ); |
Manuel Pégourié-Gonnard | cae6f3e | 2013-10-23 20:19:57 +0200 | [diff] [blame] | 743 | |
| 744 | /** |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 745 | * \brief This function sets up an ECP group context |
| 746 | * from a standardized set of domain parameters. |
Manuel Pégourié-Gonnard | a5402fe | 2012-11-07 20:24:05 +0100 | [diff] [blame] | 747 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 748 | * \note The index should be a value of the NamedCurve enum, |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 749 | * as defined in <em>RFC-4492: Elliptic Curve Cryptography |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 750 | * (ECC) Cipher Suites for Transport Layer Security (TLS)</em>, |
| 751 | * usually in the form of an \c MBEDTLS_ECP_DP_XXX macro. |
Manuel Pégourié-Gonnard | a5402fe | 2012-11-07 20:24:05 +0100 | [diff] [blame] | 752 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 753 | * \param grp The group context to setup. This must be initialized. |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 754 | * \param id The identifier of the domain parameter set to load. |
Manuel Pégourié-Gonnard | a5402fe | 2012-11-07 20:24:05 +0100 | [diff] [blame] | 755 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 756 | * \return \c 0 on success. |
| 757 | * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if \p id doesn't |
| 758 | * correspond to a known group. |
| 759 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | a5402fe | 2012-11-07 20:24:05 +0100 | [diff] [blame] | 760 | */ |
Hanno Becker | 61937d4 | 2017-04-26 15:01:23 +0100 | [diff] [blame] | 761 | int mbedtls_ecp_group_load( mbedtls_ecp_group *grp, mbedtls_ecp_group_id id ); |
Manuel Pégourié-Gonnard | 1a96728 | 2013-02-09 17:03:58 +0100 | [diff] [blame] | 762 | |
| 763 | /** |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 764 | * \brief This function sets up an ECP group context from a TLS |
| 765 | * ECParameters record as defined in RFC 4492, Section 5.4. |
Manuel Pégourié-Gonnard | 1a96728 | 2013-02-09 17:03:58 +0100 | [diff] [blame] | 766 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 767 | * \note The read pointer \p buf is updated to point right after |
| 768 | * the ECParameters record on exit. |
Manuel Pégourié-Gonnard | 1a96728 | 2013-02-09 17:03:58 +0100 | [diff] [blame] | 769 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 770 | * \param grp The group context to setup. This must be initialized. |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 771 | * \param buf The address of the pointer to the start of the input buffer. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 772 | * \param len The length of the input buffer \c *buf in Bytes. |
Manuel Pégourié-Gonnard | 150c4f6 | 2014-11-21 09:14:52 +0100 | [diff] [blame] | 773 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 774 | * \return \c 0 on success. |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 775 | * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if input is invalid. |
Janos Follath | 89ac8c9 | 2018-10-30 11:24:05 +0000 | [diff] [blame] | 776 | * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if the group is not |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 777 | * recognized. |
| 778 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | 1a96728 | 2013-02-09 17:03:58 +0100 | [diff] [blame] | 779 | */ |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 780 | int mbedtls_ecp_tls_read_group( mbedtls_ecp_group *grp, |
| 781 | const unsigned char **buf, size_t len ); |
Manuel Pégourié-Gonnard | a5402fe | 2012-11-07 20:24:05 +0100 | [diff] [blame] | 782 | |
| 783 | /** |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 784 | * \brief This function extracts an elliptic curve group ID from a |
| 785 | * TLS ECParameters record as defined in RFC 4492, Section 5.4. |
Janos Follath | 89ac8c9 | 2018-10-30 11:24:05 +0000 | [diff] [blame] | 786 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 787 | * \note The read pointer \p buf is updated to point right after |
| 788 | * the ECParameters record on exit. |
Janos Follath | 89ac8c9 | 2018-10-30 11:24:05 +0000 | [diff] [blame] | 789 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 790 | * \param grp The address at which to store the group id. |
| 791 | * This must not be \c NULL. |
Janos Follath | 89ac8c9 | 2018-10-30 11:24:05 +0000 | [diff] [blame] | 792 | * \param buf The address of the pointer to the start of the input buffer. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 793 | * \param len The length of the input buffer \c *buf in Bytes. |
Janos Follath | 89ac8c9 | 2018-10-30 11:24:05 +0000 | [diff] [blame] | 794 | * |
| 795 | * \return \c 0 on success. |
| 796 | * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if input is invalid. |
| 797 | * \return #MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE if the group is not |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 798 | * recognized. |
| 799 | * \return Another negative error code on other kinds of failure. |
Janos Follath | 89ac8c9 | 2018-10-30 11:24:05 +0000 | [diff] [blame] | 800 | */ |
| 801 | int mbedtls_ecp_tls_read_group_id( mbedtls_ecp_group_id *grp, |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 802 | const unsigned char **buf, |
| 803 | size_t len ); |
Janos Follath | 89ac8c9 | 2018-10-30 11:24:05 +0000 | [diff] [blame] | 804 | /** |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 805 | * \brief This function exports an elliptic curve as a TLS |
| 806 | * ECParameters record as defined in RFC 4492, Section 5.4. |
Manuel Pégourié-Gonnard | b325887 | 2013-02-10 12:06:19 +0100 | [diff] [blame] | 807 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 808 | * \param grp The ECP group to be exported. |
| 809 | * This must be initialized and have group parameters |
| 810 | * set, for example through mbedtls_ecp_group_load(). |
| 811 | * \param olen The address at which to store the number of Bytes written. |
| 812 | * This must not be \c NULL. |
| 813 | * \param buf The buffer to write to. This must be a writable buffer |
| 814 | * of length \p blen Bytes. |
| 815 | * \param blen The length of the output buffer \p buf in Bytes. |
Manuel Pégourié-Gonnard | b325887 | 2013-02-10 12:06:19 +0100 | [diff] [blame] | 816 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 817 | * \return \c 0 on success. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 818 | * \return #MBEDTLS_ERR_ECP_BUFFER_TOO_SMALL if the output |
| 819 | * buffer is too small to hold the exported group. |
| 820 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | b325887 | 2013-02-10 12:06:19 +0100 | [diff] [blame] | 821 | */ |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 822 | int mbedtls_ecp_tls_write_group( const mbedtls_ecp_group *grp, |
| 823 | size_t *olen, |
| 824 | unsigned char *buf, size_t blen ); |
Manuel Pégourié-Gonnard | b325887 | 2013-02-10 12:06:19 +0100 | [diff] [blame] | 825 | |
| 826 | /** |
Hanno Becker | 5edcfa5 | 2018-12-18 12:49:55 +0000 | [diff] [blame] | 827 | * \brief This function performs a scalar multiplication of a point |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 828 | * by an integer: \p R = \p m * \p P. |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 829 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 830 | * It is not thread-safe to use same group in multiple threads. |
Manuel Pégourié-Gonnard | 56cc88a | 2015-05-11 18:40:45 +0200 | [diff] [blame] | 831 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 832 | * \note To prevent timing attacks, this function |
| 833 | * executes the exact same sequence of base-field |
| 834 | * operations for any valid \p m. It avoids any if-branch or |
| 835 | * array index depending on the value of \p m. |
Manuel Pégourié-Gonnard | 56cc88a | 2015-05-11 18:40:45 +0200 | [diff] [blame] | 836 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 837 | * \note If \p f_rng is not NULL, it is used to randomize |
| 838 | * intermediate results to prevent potential timing attacks |
| 839 | * targeting these results. We recommend always providing |
| 840 | * a non-NULL \p f_rng. The overhead is negligible. |
Manuel Pégourié-Gonnard | b34aeeb | 2020-06-04 10:20:12 +0200 | [diff] [blame] | 841 | * Note: unless #MBEDTLS_ECP_NO_INTERNAL_RNG is defined, when |
| 842 | * \p f_rng is NULL, an internal RNG (seeded from the value |
| 843 | * of \p m) will be used instead. |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 844 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 845 | * \param grp The ECP group to use. |
| 846 | * This must be initialized and have group parameters |
| 847 | * set, for example through mbedtls_ecp_group_load(). |
| 848 | * \param R The point in which to store the result of the calculation. |
| 849 | * This must be initialized. |
| 850 | * \param m The integer by which to multiply. This must be initialized. |
| 851 | * \param P The point to multiply. This must be initialized. |
| 852 | * \param f_rng The RNG function. This may be \c NULL if randomization |
| 853 | * of intermediate results isn't desired (discouraged). |
| 854 | * \param p_rng The RNG context to be passed to \p p_rng. |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 855 | * |
| 856 | * \return \c 0 on success. |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 857 | * \return #MBEDTLS_ERR_ECP_INVALID_KEY if \p m is not a valid private |
| 858 | * key, or \p P is not a valid public key. |
| 859 | * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 860 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 861 | */ |
| 862 | int mbedtls_ecp_mul( mbedtls_ecp_group *grp, mbedtls_ecp_point *R, |
| 863 | const mbedtls_mpi *m, const mbedtls_ecp_point *P, |
| 864 | int (*f_rng)(void *, unsigned char *, size_t), void *p_rng ); |
| 865 | |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 866 | /** |
Manuel Pégourié-Gonnard | da19f4c | 2018-06-12 12:40:54 +0200 | [diff] [blame] | 867 | * \brief This function performs multiplication of a point by |
| 868 | * an integer: \p R = \p m * \p P in a restartable way. |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 869 | * |
Manuel Pégourié-Gonnard | 12e4a8b | 2018-09-12 10:55:15 +0200 | [diff] [blame] | 870 | * \see mbedtls_ecp_mul() |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 871 | * |
Manuel Pégourié-Gonnard | da19f4c | 2018-06-12 12:40:54 +0200 | [diff] [blame] | 872 | * \note This function does the same as \c mbedtls_ecp_mul(), but |
| 873 | * it can return early and restart according to the limit set |
| 874 | * with \c mbedtls_ecp_set_max_ops() to reduce blocking. |
| 875 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 876 | * \param grp The ECP group to use. |
| 877 | * This must be initialized and have group parameters |
| 878 | * set, for example through mbedtls_ecp_group_load(). |
| 879 | * \param R The point in which to store the result of the calculation. |
| 880 | * This must be initialized. |
| 881 | * \param m The integer by which to multiply. This must be initialized. |
| 882 | * \param P The point to multiply. This must be initialized. |
| 883 | * \param f_rng The RNG function. This may be \c NULL if randomization |
| 884 | * of intermediate results isn't desired (discouraged). |
| 885 | * \param p_rng The RNG context to be passed to \p p_rng. |
Manuel Pégourié-Gonnard | f0bbd7e | 2018-10-15 13:22:41 +0200 | [diff] [blame] | 886 | * \param rs_ctx The restart context (NULL disables restart). |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 887 | * |
Manuel Pégourié-Gonnard | 12e4a8b | 2018-09-12 10:55:15 +0200 | [diff] [blame] | 888 | * \return \c 0 on success. |
| 889 | * \return #MBEDTLS_ERR_ECP_INVALID_KEY if \p m is not a valid private |
| 890 | * key, or \p P is not a valid public key. |
| 891 | * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure. |
| 892 | * \return #MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of |
Manuel Pégourié-Gonnard | 8467e68 | 2017-04-20 09:47:06 +0200 | [diff] [blame] | 893 | * operations was reached: see \c mbedtls_ecp_set_max_ops(). |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 894 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 895 | */ |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 896 | int mbedtls_ecp_mul_restartable( mbedtls_ecp_group *grp, mbedtls_ecp_point *R, |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 897 | const mbedtls_mpi *m, const mbedtls_ecp_point *P, |
Manuel Pégourié-Gonnard | b739a71 | 2017-04-19 10:11:56 +0200 | [diff] [blame] | 898 | int (*f_rng)(void *, unsigned char *, size_t), void *p_rng, |
| 899 | mbedtls_ecp_restart_ctx *rs_ctx ); |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 900 | |
| 901 | /** |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 902 | * \brief This function performs multiplication and addition of two |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 903 | * points by integers: \p R = \p m * \p P + \p n * \p Q |
Manuel Pégourié-Gonnard | 56cc88a | 2015-05-11 18:40:45 +0200 | [diff] [blame] | 904 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 905 | * It is not thread-safe to use same group in multiple threads. |
Manuel Pégourié-Gonnard | 56cc88a | 2015-05-11 18:40:45 +0200 | [diff] [blame] | 906 | * |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 907 | * \note In contrast to mbedtls_ecp_mul(), this function does not |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 908 | * guarantee a constant execution flow and timing. |
Manuel Pégourié-Gonnard | 56cc88a | 2015-05-11 18:40:45 +0200 | [diff] [blame] | 909 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 910 | * \param grp The ECP group to use. |
| 911 | * This must be initialized and have group parameters |
| 912 | * set, for example through mbedtls_ecp_group_load(). |
| 913 | * \param R The point in which to store the result of the calculation. |
| 914 | * This must be initialized. |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 915 | * \param m The integer by which to multiply \p P. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 916 | * This must be initialized. |
| 917 | * \param P The point to multiply by \p m. This must be initialized. |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 918 | * \param n The integer by which to multiply \p Q. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 919 | * This must be initialized. |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 920 | * \param Q The point to be multiplied by \p n. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 921 | * This must be initialized. |
Manuel Pégourié-Gonnard | 56cc88a | 2015-05-11 18:40:45 +0200 | [diff] [blame] | 922 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 923 | * \return \c 0 on success. |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 924 | * \return #MBEDTLS_ERR_ECP_INVALID_KEY if \p m or \p n are not |
| 925 | * valid private keys, or \p P or \p Q are not valid public |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 926 | * keys. |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 927 | * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 928 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | 56cc88a | 2015-05-11 18:40:45 +0200 | [diff] [blame] | 929 | */ |
| 930 | int mbedtls_ecp_muladd( mbedtls_ecp_group *grp, mbedtls_ecp_point *R, |
| 931 | const mbedtls_mpi *m, const mbedtls_ecp_point *P, |
| 932 | const mbedtls_mpi *n, const mbedtls_ecp_point *Q ); |
| 933 | |
Manuel Pégourié-Gonnard | 54dd652 | 2017-04-20 13:36:18 +0200 | [diff] [blame] | 934 | /** |
Manuel Pégourié-Gonnard | da19f4c | 2018-06-12 12:40:54 +0200 | [diff] [blame] | 935 | * \brief This function performs multiplication and addition of two |
| 936 | * points by integers: \p R = \p m * \p P + \p n * \p Q in a |
Manuel Pégourié-Gonnard | 12e4a8b | 2018-09-12 10:55:15 +0200 | [diff] [blame] | 937 | * restartable way. |
Manuel Pégourié-Gonnard | 54dd652 | 2017-04-20 13:36:18 +0200 | [diff] [blame] | 938 | * |
Manuel Pégourié-Gonnard | da19f4c | 2018-06-12 12:40:54 +0200 | [diff] [blame] | 939 | * \see \c mbedtls_ecp_muladd() |
Manuel Pégourié-Gonnard | 54dd652 | 2017-04-20 13:36:18 +0200 | [diff] [blame] | 940 | * |
Manuel Pégourié-Gonnard | da19f4c | 2018-06-12 12:40:54 +0200 | [diff] [blame] | 941 | * \note This function works the same as \c mbedtls_ecp_muladd(), |
| 942 | * but it can return early and restart according to the limit |
| 943 | * set with \c mbedtls_ecp_set_max_ops() to reduce blocking. |
Manuel Pégourié-Gonnard | 54dd652 | 2017-04-20 13:36:18 +0200 | [diff] [blame] | 944 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 945 | * \param grp The ECP group to use. |
| 946 | * This must be initialized and have group parameters |
| 947 | * set, for example through mbedtls_ecp_group_load(). |
| 948 | * \param R The point in which to store the result of the calculation. |
| 949 | * This must be initialized. |
Manuel Pégourié-Gonnard | da19f4c | 2018-06-12 12:40:54 +0200 | [diff] [blame] | 950 | * \param m The integer by which to multiply \p P. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 951 | * This must be initialized. |
| 952 | * \param P The point to multiply by \p m. This must be initialized. |
Manuel Pégourié-Gonnard | da19f4c | 2018-06-12 12:40:54 +0200 | [diff] [blame] | 953 | * \param n The integer by which to multiply \p Q. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 954 | * This must be initialized. |
Manuel Pégourié-Gonnard | da19f4c | 2018-06-12 12:40:54 +0200 | [diff] [blame] | 955 | * \param Q The point to be multiplied by \p n. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 956 | * This must be initialized. |
Manuel Pégourié-Gonnard | f0bbd7e | 2018-10-15 13:22:41 +0200 | [diff] [blame] | 957 | * \param rs_ctx The restart context (NULL disables restart). |
Manuel Pégourié-Gonnard | da19f4c | 2018-06-12 12:40:54 +0200 | [diff] [blame] | 958 | * |
| 959 | * \return \c 0 on success. |
| 960 | * \return #MBEDTLS_ERR_ECP_INVALID_KEY if \p m or \p n are not |
| 961 | * valid private keys, or \p P or \p Q are not valid public |
| 962 | * keys. |
| 963 | * \return #MBEDTLS_ERR_MPI_ALLOC_FAILED on memory-allocation failure. |
| 964 | * \return #MBEDTLS_ERR_ECP_IN_PROGRESS if maximum number of |
Manuel Pégourié-Gonnard | 54dd652 | 2017-04-20 13:36:18 +0200 | [diff] [blame] | 965 | * operations was reached: see \c mbedtls_ecp_set_max_ops(). |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 966 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | 54dd652 | 2017-04-20 13:36:18 +0200 | [diff] [blame] | 967 | */ |
| 968 | int mbedtls_ecp_muladd_restartable( |
| 969 | mbedtls_ecp_group *grp, mbedtls_ecp_point *R, |
| 970 | const mbedtls_mpi *m, const mbedtls_ecp_point *P, |
| 971 | const mbedtls_mpi *n, const mbedtls_ecp_point *Q, |
| 972 | mbedtls_ecp_restart_ctx *rs_ctx ); |
Manuel Pégourié-Gonnard | 54dd652 | 2017-04-20 13:36:18 +0200 | [diff] [blame] | 973 | |
Manuel Pégourié-Gonnard | 56cc88a | 2015-05-11 18:40:45 +0200 | [diff] [blame] | 974 | /** |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 975 | * \brief This function checks that a point is a valid public key |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 976 | * on this curve. |
Manuel Pégourié-Gonnard | c8dc295 | 2013-07-01 14:06:13 +0200 | [diff] [blame] | 977 | * |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 978 | * It only checks that the point is non-zero, has |
| 979 | * valid coordinates and lies on the curve. It does not verify |
| 980 | * that it is indeed a multiple of \p G. This additional |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 981 | * check is computationally more expensive, is not required |
| 982 | * by standards, and should not be necessary if the group |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 983 | * used has a small cofactor. In particular, it is useless for |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 984 | * the NIST groups which all have a cofactor of 1. |
Manuel Pégourié-Gonnard | c8dc295 | 2013-07-01 14:06:13 +0200 | [diff] [blame] | 985 | * |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 986 | * \note This function uses bare components rather than an |
| 987 | * ::mbedtls_ecp_keypair structure, to ease use with other |
| 988 | * structures, such as ::mbedtls_ecdh_context or |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 989 | * ::mbedtls_ecdsa_context. |
Manuel Pégourié-Gonnard | c8dc295 | 2013-07-01 14:06:13 +0200 | [diff] [blame] | 990 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 991 | * \param grp The ECP group the point should belong to. |
| 992 | * This must be initialized and have group parameters |
| 993 | * set, for example through mbedtls_ecp_group_load(). |
| 994 | * \param pt The point to check. This must be initialized. |
Manuel Pégourié-Gonnard | c8dc295 | 2013-07-01 14:06:13 +0200 | [diff] [blame] | 995 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 996 | * \return \c 0 if the point is a valid public key. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 997 | * \return #MBEDTLS_ERR_ECP_INVALID_KEY if the point is not |
| 998 | * a valid public key for the given curve. |
| 999 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | c8dc295 | 2013-07-01 14:06:13 +0200 | [diff] [blame] | 1000 | */ |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1001 | int mbedtls_ecp_check_pubkey( const mbedtls_ecp_group *grp, |
| 1002 | const mbedtls_ecp_point *pt ); |
Manuel Pégourié-Gonnard | c8dc295 | 2013-07-01 14:06:13 +0200 | [diff] [blame] | 1003 | |
| 1004 | /** |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1005 | * \brief This function checks that an \p mbedtls_mpi is a |
| 1006 | * valid private key for this curve. |
Manuel Pégourié-Gonnard | c8dc295 | 2013-07-01 14:06:13 +0200 | [diff] [blame] | 1007 | * |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 1008 | * \note This function uses bare components rather than an |
| 1009 | * ::mbedtls_ecp_keypair structure to ease use with other |
| 1010 | * structures, such as ::mbedtls_ecdh_context or |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 1011 | * ::mbedtls_ecdsa_context. |
Manuel Pégourié-Gonnard | c8dc295 | 2013-07-01 14:06:13 +0200 | [diff] [blame] | 1012 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1013 | * \param grp The ECP group the private key should belong to. |
| 1014 | * This must be initialized and have group parameters |
| 1015 | * set, for example through mbedtls_ecp_group_load(). |
| 1016 | * \param d The integer to check. This must be initialized. |
Manuel Pégourié-Gonnard | c8dc295 | 2013-07-01 14:06:13 +0200 | [diff] [blame] | 1017 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 1018 | * \return \c 0 if the point is a valid private key. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1019 | * \return #MBEDTLS_ERR_ECP_INVALID_KEY if the point is not a valid |
| 1020 | * private key for the given curve. |
| 1021 | * \return Another negative error code on other kinds of failure. |
Manuel Pégourié-Gonnard | c8dc295 | 2013-07-01 14:06:13 +0200 | [diff] [blame] | 1022 | */ |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1023 | int mbedtls_ecp_check_privkey( const mbedtls_ecp_group *grp, |
| 1024 | const mbedtls_mpi *d ); |
Manuel Pégourié-Gonnard | c8dc295 | 2013-07-01 14:06:13 +0200 | [diff] [blame] | 1025 | |
| 1026 | /** |
Manuel Pégourié-Gonnard | da19f4c | 2018-06-12 12:40:54 +0200 | [diff] [blame] | 1027 | * \brief This function generates a private key. |
Manuel Pégourié-Gonnard | a7937f9 | 2017-04-20 15:37:46 +0200 | [diff] [blame] | 1028 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1029 | * \param grp The ECP group to generate a private key for. |
| 1030 | * This must be initialized and have group parameters |
| 1031 | * set, for example through mbedtls_ecp_group_load(). |
| 1032 | * \param d The destination MPI (secret part). This must be initialized. |
| 1033 | * \param f_rng The RNG function. This must not be \c NULL. |
| 1034 | * \param p_rng The RNG parameter to be passed to \p f_rng. This may be |
| 1035 | * \c NULL if \p f_rng doesn't need a context argument. |
Manuel Pégourié-Gonnard | a7937f9 | 2017-04-20 15:37:46 +0200 | [diff] [blame] | 1036 | * |
Manuel Pégourié-Gonnard | da19f4c | 2018-06-12 12:40:54 +0200 | [diff] [blame] | 1037 | * \return \c 0 on success. |
| 1038 | * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX error code |
| 1039 | * on failure. |
Manuel Pégourié-Gonnard | a7937f9 | 2017-04-20 15:37:46 +0200 | [diff] [blame] | 1040 | */ |
| 1041 | int mbedtls_ecp_gen_privkey( const mbedtls_ecp_group *grp, |
| 1042 | mbedtls_mpi *d, |
| 1043 | int (*f_rng)(void *, unsigned char *, size_t), |
| 1044 | void *p_rng ); |
| 1045 | |
| 1046 | /** |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 1047 | * \brief This function generates a keypair with a configurable base |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 1048 | * point. |
Manuel Pégourié-Gonnard | d9a3f47 | 2015-08-11 14:31:03 +0200 | [diff] [blame] | 1049 | * |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 1050 | * \note This function uses bare components rather than an |
| 1051 | * ::mbedtls_ecp_keypair structure to ease use with other |
| 1052 | * structures, such as ::mbedtls_ecdh_context or |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 1053 | * ::mbedtls_ecdsa_context. |
Manuel Pégourié-Gonnard | d9a3f47 | 2015-08-11 14:31:03 +0200 | [diff] [blame] | 1054 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1055 | * \param grp The ECP group to generate a key pair for. |
| 1056 | * This must be initialized and have group parameters |
| 1057 | * set, for example through mbedtls_ecp_group_load(). |
| 1058 | * \param G The base point to use. This must be initialized |
| 1059 | * and belong to \p grp. It replaces the default base |
| 1060 | * point \c grp->G used by mbedtls_ecp_gen_keypair(). |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 1061 | * \param d The destination MPI (secret part). |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1062 | * This must be initialized. |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 1063 | * \param Q The destination point (public part). |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1064 | * This must be initialized. |
| 1065 | * \param f_rng The RNG function. This must not be \c NULL. |
| 1066 | * \param p_rng The RNG context to be passed to \p f_rng. This may |
| 1067 | * be \c NULL if \p f_rng doesn't need a context argument. |
Manuel Pégourié-Gonnard | d9a3f47 | 2015-08-11 14:31:03 +0200 | [diff] [blame] | 1068 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 1069 | * \return \c 0 on success. |
| 1070 | * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX error code |
| 1071 | * on failure. |
Manuel Pégourié-Gonnard | d9a3f47 | 2015-08-11 14:31:03 +0200 | [diff] [blame] | 1072 | */ |
| 1073 | int mbedtls_ecp_gen_keypair_base( mbedtls_ecp_group *grp, |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1074 | const mbedtls_ecp_point *G, |
| 1075 | mbedtls_mpi *d, mbedtls_ecp_point *Q, |
| 1076 | int (*f_rng)(void *, unsigned char *, size_t), |
| 1077 | void *p_rng ); |
Manuel Pégourié-Gonnard | d9a3f47 | 2015-08-11 14:31:03 +0200 | [diff] [blame] | 1078 | |
| 1079 | /** |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 1080 | * \brief This function generates an ECP keypair. |
Manuel Pégourié-Gonnard | 45a035a | 2013-01-26 14:42:45 +0100 | [diff] [blame] | 1081 | * |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 1082 | * \note This function uses bare components rather than an |
| 1083 | * ::mbedtls_ecp_keypair structure to ease use with other |
| 1084 | * structures, such as ::mbedtls_ecdh_context or |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 1085 | * ::mbedtls_ecdsa_context. |
Manuel Pégourié-Gonnard | 45a035a | 2013-01-26 14:42:45 +0100 | [diff] [blame] | 1086 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1087 | * \param grp The ECP group to generate a key pair for. |
| 1088 | * This must be initialized and have group parameters |
| 1089 | * set, for example through mbedtls_ecp_group_load(). |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 1090 | * \param d The destination MPI (secret part). |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1091 | * This must be initialized. |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 1092 | * \param Q The destination point (public part). |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1093 | * This must be initialized. |
| 1094 | * \param f_rng The RNG function. This must not be \c NULL. |
| 1095 | * \param p_rng The RNG context to be passed to \p f_rng. This may |
| 1096 | * be \c NULL if \p f_rng doesn't need a context argument. |
Manuel Pégourié-Gonnard | c8dc295 | 2013-07-01 14:06:13 +0200 | [diff] [blame] | 1097 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 1098 | * \return \c 0 on success. |
| 1099 | * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX error code |
| 1100 | * on failure. |
Manuel Pégourié-Gonnard | 45a035a | 2013-01-26 14:42:45 +0100 | [diff] [blame] | 1101 | */ |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1102 | int mbedtls_ecp_gen_keypair( mbedtls_ecp_group *grp, mbedtls_mpi *d, |
| 1103 | mbedtls_ecp_point *Q, |
| 1104 | int (*f_rng)(void *, unsigned char *, size_t), |
| 1105 | void *p_rng ); |
Manuel Pégourié-Gonnard | 45a035a | 2013-01-26 14:42:45 +0100 | [diff] [blame] | 1106 | |
| 1107 | /** |
Rose Zadik | f56cb34 | 2018-04-19 12:49:10 +0100 | [diff] [blame] | 1108 | * \brief This function generates an ECP key. |
Manuel Pégourié-Gonnard | 104ee1d | 2013-11-30 14:13:16 +0100 | [diff] [blame] | 1109 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 1110 | * \param grp_id The ECP group identifier. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1111 | * \param key The destination key. This must be initialized. |
| 1112 | * \param f_rng The RNG function to use. This must not be \c NULL. |
| 1113 | * \param p_rng The RNG context to be passed to \p f_rng. This may |
| 1114 | * be \c NULL if \p f_rng doesn't need a context argument. |
Manuel Pégourié-Gonnard | 104ee1d | 2013-11-30 14:13:16 +0100 | [diff] [blame] | 1115 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 1116 | * \return \c 0 on success. |
| 1117 | * \return An \c MBEDTLS_ERR_ECP_XXX or \c MBEDTLS_MPI_XXX error code |
| 1118 | * on failure. |
Manuel Pégourié-Gonnard | 104ee1d | 2013-11-30 14:13:16 +0100 | [diff] [blame] | 1119 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1120 | int mbedtls_ecp_gen_key( mbedtls_ecp_group_id grp_id, mbedtls_ecp_keypair *key, |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1121 | int (*f_rng)(void *, unsigned char *, size_t), |
| 1122 | void *p_rng ); |
Manuel Pégourié-Gonnard | 104ee1d | 2013-11-30 14:13:16 +0100 | [diff] [blame] | 1123 | |
Manuel Pégourié-Gonnard | 30668d6 | 2014-11-06 15:25:32 +0100 | [diff] [blame] | 1124 | /** |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 1125 | * \brief This function checks that the keypair objects |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 1126 | * \p pub and \p prv have the same group and the |
| 1127 | * same public point, and that the private key in |
| 1128 | * \p prv is consistent with the public key. |
Manuel Pégourié-Gonnard | 30668d6 | 2014-11-06 15:25:32 +0100 | [diff] [blame] | 1129 | * |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1130 | * \param pub The keypair structure holding the public key. This |
| 1131 | * must be initialized. If it contains a private key, that |
| 1132 | * part is ignored. |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 1133 | * \param prv The keypair structure holding the full keypair. |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1134 | * This must be initialized. |
Manuel Pégourié-Gonnard | 30668d6 | 2014-11-06 15:25:32 +0100 | [diff] [blame] | 1135 | * |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 1136 | * \return \c 0 on success, meaning that the keys are valid and match. |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 1137 | * \return #MBEDTLS_ERR_ECP_BAD_INPUT_DATA if the keys are invalid or do not match. |
Rose Zadik | a7a6155 | 2018-04-24 13:14:01 +0100 | [diff] [blame] | 1138 | * \return An \c MBEDTLS_ERR_ECP_XXX or an \c MBEDTLS_ERR_MPI_XXX |
Rose Zadik | b2e111a | 2018-04-20 10:13:48 +0100 | [diff] [blame] | 1139 | * error code on calculation failure. |
Manuel Pégourié-Gonnard | 30668d6 | 2014-11-06 15:25:32 +0100 | [diff] [blame] | 1140 | */ |
Hanno Becker | ebffa79 | 2018-12-14 15:07:50 +0000 | [diff] [blame] | 1141 | int mbedtls_ecp_check_pub_priv( const mbedtls_ecp_keypair *pub, |
| 1142 | const mbedtls_ecp_keypair *prv ); |
Manuel Pégourié-Gonnard | 30668d6 | 2014-11-06 15:25:32 +0100 | [diff] [blame] | 1143 | |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1144 | #if defined(MBEDTLS_SELF_TEST) |
Janos Follath | b069753 | 2016-08-18 12:38:46 +0100 | [diff] [blame] | 1145 | |
Manuel Pégourié-Gonnard | 104ee1d | 2013-11-30 14:13:16 +0100 | [diff] [blame] | 1146 | /** |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 1147 | * \brief The ECP checkup routine. |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 1148 | * |
Rose Zadik | d3c9bfc | 2018-04-17 10:56:55 +0100 | [diff] [blame] | 1149 | * \return \c 0 on success. |
| 1150 | * \return \c 1 on failure. |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 1151 | */ |
Manuel Pégourié-Gonnard | 2cf5a7c | 2015-04-08 12:49:31 +0200 | [diff] [blame] | 1152 | int mbedtls_ecp_self_test( int verbose ); |
Janos Follath | b069753 | 2016-08-18 12:38:46 +0100 | [diff] [blame] | 1153 | |
Janos Follath | 372697b | 2016-10-28 16:53:11 +0100 | [diff] [blame] | 1154 | #endif /* MBEDTLS_SELF_TEST */ |
Manuel Pégourié-Gonnard | 39d2adb | 2012-10-31 09:26:55 +0100 | [diff] [blame] | 1155 | |
| 1156 | #ifdef __cplusplus |
| 1157 | } |
| 1158 | #endif |
| 1159 | |
Paul Bakker | 9af723c | 2014-05-01 13:03:14 +0200 | [diff] [blame] | 1160 | #endif /* ecp.h */ |