6b8a4ad0d8
While at it, mark parameters based on their role. Signed-off-by: Janos Follath <janos.follath@arm.com>
79 lines
3.1 KiB
C
79 lines
3.1 KiB
C
/**
|
|
* Low level modular bignum functions
|
|
*
|
|
* This interface only should be used by the higher level modular bignum
|
|
* module (bignum_mod.c) and the ECP module (ecp.c, ecp_curves.c). All other
|
|
* modules should use the high level modular bignum interface (bignum_mod.h)
|
|
* or the legacy bignum interface (bignum.h).
|
|
*
|
|
* Copyright The Mbed TLS Contributors
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
* not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef MBEDTLS_BIGNUM_MOD_RAW_H
|
|
#define MBEDTLS_BIGNUM_MOD_RAW_H
|
|
|
|
#include "common.h"
|
|
|
|
#if defined(MBEDTLS_BIGNUM_C)
|
|
#include "mbedtls/bignum.h"
|
|
#endif
|
|
|
|
#include "bignum_mod.h"
|
|
|
|
/** Import X from unsigned binary data.
|
|
*
|
|
* The MPI needs to have enough limbs to store the full value (including any
|
|
* most significant zero bytes in the input).
|
|
*
|
|
* \param[out] X The address of the MPI. The size is determined by \p m. (In
|
|
* particular, it must have at least as many limbs as the
|
|
* modulus \p m.)
|
|
* \param[in] m The address of the modulus related to \p X.
|
|
* \param[in] buf The input buffer to import from.
|
|
* \param buflen The length in bytes of \p buf.
|
|
*
|
|
* \return \c 0 if successful.
|
|
* \return #MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL if \p X isn't
|
|
* large enough to hold the value in \p buf.
|
|
* \return #MBEDTLS_ERR_MPI_BAD_INPUT_DATA if the external representation
|
|
* of \p m is invalid or \p X is not less than \p m.
|
|
*/
|
|
int mbedtls_mpi_mod_raw_read( mbedtls_mpi_uint *X,
|
|
const mbedtls_mpi_mod_modulus *m,
|
|
const unsigned char *buf,
|
|
size_t buflen );
|
|
|
|
/** Export X into unsigned binary data.
|
|
*
|
|
* \param[in] X The address of the MPI. The size is determined by \p m. (In
|
|
* particular, it must have at least as many limbs as the modulus
|
|
* \p m.)
|
|
* \param[in] m The address of the modulus related to \p X.
|
|
* \param[out] buf The output buffer to export to.
|
|
* \param buflen The length in bytes of \p buf.
|
|
*
|
|
* \return \c 0 if successful.
|
|
* \return #MBEDTLS_ERR_MPI_BUFFER_TOO_SMALL if \p buf isn't
|
|
* large enough to hold the value of \p X.
|
|
* \return #MBEDTLS_ERR_MPI_BAD_INPUT_DATA if the external representation
|
|
* of \p m is invalid.
|
|
*/
|
|
int mbedtls_mpi_mod_raw_write( const mbedtls_mpi_uint *X,
|
|
const mbedtls_mpi_mod_modulus *m,
|
|
unsigned char *buf,
|
|
size_t buflen );
|
|
|
|
#endif /* MBEDTLS_BIGNUM_MOD_RAW_H */
|