1/**
2 * \file ecp_invasive.h
3 *
4 * \brief ECP module: interfaces for invasive testing only.
5 *
6 * The interfaces in this file are intended for testing purposes only.
7 * They SHOULD NOT be made available in library integrations except when
8 * building the library for testing.
9 */
10/*
11 * Copyright The Mbed TLS Contributors
12 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
25 */
26#ifndef MBEDTLS_ECP_INVASIVE_H
27#define MBEDTLS_ECP_INVASIVE_H
28
29#include "common.h"
30#include "mbedtls/bignum.h"
31#include "mbedtls/ecp.h"
32
33#if defined(MBEDTLS_TEST_HOOKS) && defined(MBEDTLS_ECP_C)
34
35#if defined(MBEDTLS_ECP_DP_SECP224R1_ENABLED) || \
36 defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED) || \
37 defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
38/* Preconditions:
39 * - bits is a multiple of 64 or is 224
40 * - c is -1 or -2
41 * - 0 <= N < 2^bits
42 * - N has room for bits plus one limb
43 *
44 * Behavior:
45 * Set N to c * 2^bits + old_value_of_N.
46 */
47void mbedtls_ecp_fix_negative(mbedtls_mpi *N, signed char c, size_t bits);
48#endif
49
50#if defined(MBEDTLS_ECP_MONTGOMERY_ENABLED)
51/** Generate a private key on a Montgomery curve (Curve25519 or Curve448).
52 *
53 * This function implements key generation for the set of secret keys
54 * specified in [Curve25519] p. 5 and in [Curve448]. The resulting value
55 * has the lower bits masked but is not necessarily canonical.
56 *
57 * \note - [Curve25519] http://cr.yp.to/ecdh/curve25519-20060209.pdf
58 * - [RFC7748] https://tools.ietf.org/html/rfc7748
59 *
60 * \p high_bit The position of the high-order bit of the key to generate.
61 * This is the bit-size of the key minus 1:
62 * 254 for Curve25519 or 447 for Curve448.
63 * \param d The randomly generated key. This is a number of size
64 * exactly \p high_bit + 1 bits, with the least significant bits
65 * masked as specified in [Curve25519] and in [RFC7748] ยง5.
66 * \param f_rng The RNG function.
67 * \param p_rng The RNG context to be passed to \p f_rng.
68 *
69 * \return \c 0 on success.
70 * \return \c MBEDTLS_ERR_ECP_xxx or MBEDTLS_ERR_MPI_xxx on failure.
71 */
72int mbedtls_ecp_gen_privkey_mx(size_t high_bit,
73 mbedtls_mpi *d,
74 int (*f_rng)(void *, unsigned char *, size_t),
75 void *p_rng);
76
77#endif /* MBEDTLS_ECP_MONTGOMERY_ENABLED */
78
79#endif /* MBEDTLS_TEST_HOOKS && MBEDTLS_ECP_C */
80
81#endif /* MBEDTLS_ECP_INVASIVE_H */
82