MPI (Multiple Precision Integer Arithmetic) More...

#include <stdio.h>
#include "core/crypto.h"

Data Structures
struct	Mpi
	Arbitrary precision integer. More...

Macros
#define	MPI_MAX_BITS 4096

#define	MPI_BITS_PER_WORD 32

#define	MPI_MAX_WORDS ((MPI_MAX_BITS + MPI_BITS_PER_WORD - 1) / MPI_BITS_PER_WORD)

#define	MPI_BYTES_PER_WORD (MPI_BITS_PER_WORD / 8)

#define	mpi_word_t uint32_t

#define	mpi_sword_t int32_t

#define	mpi_dword_t uint64_t

#define	MPI_CHECK(f) if((error = f) != NO_ERROR) goto end

#define	mpiIsEven(a) !mpiGetBitValue(a, 0)

#define	mpiIsOdd(a) mpiGetBitValue(a, 0)

Enumerations
enum	MpiFormat { MPI_FORMAT_LITTLE_ENDIAN = 0, MPI_FORMAT_BIG_ENDIAN = 1 }
	MPI import/export format. More...

Functions
void	mpiInit (Mpi *r)
	Initialize a multiple precision integer. More...

void	mpiFree (Mpi *r)
	Release a multiple precision integer. More...

error_t	mpiGrow (Mpi *r, uint_t size)
	Adjust the size of multiple precision integer. More...

uint_t	mpiGetLength (const Mpi *a)
	Get the actual length in words. More...

uint_t	mpiGetByteLength (const Mpi *a)
	Get the actual length in bytes. More...

uint_t	mpiGetBitLength (const Mpi *a)
	Get the actual length in bits. More...

error_t	mpiSetBitValue (Mpi *r, uint_t index, uint_t value)
	Set the bit value at the specified index. More...

uint_t	mpiGetBitValue (const Mpi *a, uint_t index)
	Get the bit value at the specified index. More...

int_t	mpiComp (const Mpi a, const Mpi b)
	Compare two multiple precision integers. More...

int_t	mpiCompInt (const Mpi *a, mpi_sword_t b)
	Compare a multiple precision integer with an integer. More...

int_t	mpiCompAbs (const Mpi a, const Mpi b)
	Compare the absolute value of two multiple precision integers. More...

error_t	mpiCopy (Mpi r, const Mpi a)
	Copy a multiple precision integer. More...

error_t	mpiSetValue (Mpi *r, mpi_sword_t a)
	Set the value of a multiple precision integer. More...

error_t	mpiRand (Mpi r, uint_t length, const PrngAlgo prngAlgo, void *prngContext)
	Generate a random value. More...

error_t	mpiRandRange (Mpi r, const Mpi p, const PrngAlgo prngAlgo, void prngContext)
	Generate a random value in the range 1 to p-1. More...

error_t	mpiCheckProbablePrime (const Mpi *a)
	Test whether a number is probable prime. More...

error_t	mpiImport (Mpi r, const uint8_t input, size_t length, MpiFormat format)
	Octet string to integer conversion. More...

error_t	mpiExport (const Mpi a, uint8_t output, size_t length, MpiFormat format)
	Integer to octet string conversion. More...

error_t	mpiAdd (Mpi r, const Mpi a, const Mpi *b)
	Multiple precision addition. More...

error_t	mpiAddInt (Mpi r, const Mpi a, mpi_sword_t b)
	Add an integer to a multiple precision integer. More...

error_t	mpiSub (Mpi r, const Mpi a, const Mpi *b)
	Multiple precision subtraction. More...

error_t	mpiSubInt (Mpi r, const Mpi a, mpi_sword_t b)
	Subtract an integer from a multiple precision integer. More...

error_t	mpiAddAbs (Mpi r, const Mpi a, const Mpi *b)
	Helper routine for multiple precision addition. More...

error_t	mpiSubAbs (Mpi r, const Mpi a, const Mpi *b)
	Helper routine for multiple precision subtraction. More...

error_t	mpiShiftLeft (Mpi *r, uint_t n)
	Left shift operation. More...

error_t	mpiShiftRight (Mpi *r, uint_t n)
	Right shift operation. More...

error_t	mpiMul (Mpi r, const Mpi a, const Mpi *b)
	Multiple precision multiplication. More...

error_t	mpiMulInt (Mpi r, const Mpi a, mpi_sword_t b)
	Multiply a multiple precision integer by an integer. More...

error_t	mpiDiv (Mpi q, Mpi r, const Mpi a, const Mpi b)
	Multiple precision division. More...

error_t	mpiDivInt (Mpi q, Mpi r, const Mpi *a, mpi_sword_t b)
	Divide a multiple precision integer by an integer. More...

error_t	mpiMod (Mpi r, const Mpi a, const Mpi *p)
	Modulo operation. More...

error_t	mpiAddMod (Mpi r, const Mpi a, const Mpi b, const Mpi p)
	Modular addition. More...

error_t	mpiSubMod (Mpi r, const Mpi a, const Mpi b, const Mpi p)
	Modular subtraction. More...

error_t	mpiMulMod (Mpi r, const Mpi a, const Mpi b, const Mpi p)
	Modular multiplication. More...

error_t	mpiInvMod (Mpi r, const Mpi a, const Mpi *p)
	Modular inverse. More...

error_t	mpiExpMod (Mpi r, const Mpi a, const Mpi e, const Mpi p)
	Modular exponentiation. More...

error_t	mpiExpModFast (Mpi r, const Mpi a, const Mpi e, const Mpi p)
	Modular exponentiation (fast calculation) More...

error_t	mpiExpModRegular (Mpi r, const Mpi a, const Mpi e, const Mpi p)
	Modular exponentiation (regular calculation) More...

void	mpiDump (FILE stream, const char_t prepend, const Mpi *a)
	Display the contents of a multiple precision integer. More...

Detailed Description

MPI (Multiple Precision Integer Arithmetic)

License

SPDX-License-Identifier: GPL-2.0-or-later

This file is part of CycloneCRYPTO Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.5.4

Definition in file mpi.h.

Macro Definition Documentation

◆ MPI_BITS_PER_WORD

#define MPI_BITS_PER_WORD 32

Definition at line 47 of file mpi.h.

◆ MPI_BYTES_PER_WORD

#define MPI_BYTES_PER_WORD (MPI_BITS_PER_WORD / 8)

Definition at line 56 of file mpi.h.

◆ MPI_CHECK

#define MPI_CHECK ( f ) if((error = f) != NO_ERROR) goto end

Definition at line 74 of file mpi.h.

◆ mpi_dword_t

#define mpi_dword_t uint64_t

Definition at line 70 of file mpi.h.

◆ MPI_MAX_BITS

#define MPI_MAX_BITS 4096

Definition at line 40 of file mpi.h.

◆ MPI_MAX_WORDS

#define MPI_MAX_WORDS ((MPI_MAX_BITS + MPI_BITS_PER_WORD - 1) / MPI_BITS_PER_WORD)

Definition at line 53 of file mpi.h.

◆ mpi_sword_t

#define mpi_sword_t int32_t

Definition at line 69 of file mpi.h.

◆ mpi_word_t

#define mpi_word_t uint32_t

Definition at line 68 of file mpi.h.

◆ mpiIsEven

#define mpiIsEven ( a ) !mpiGetBitValue(a, 0)

Definition at line 77 of file mpi.h.

◆ mpiIsOdd

#define mpiIsOdd ( a ) mpiGetBitValue(a, 0)

Definition at line 78 of file mpi.h.

Enumeration Type Documentation

◆ MpiFormat

enum MpiFormat

MPI import/export format.

Enumerator
MPI_FORMAT_LITTLE_ENDIAN
MPI_FORMAT_BIG_ENDIAN

Definition at line 90 of file mpi.h.

Function Documentation

◆ mpiAdd()

error_t mpiAdd	(	Mpi *	r,
		const Mpi *	a,
		const Mpi *	b
	)

Multiple precision addition.

Parameters

[out]	r	Resulting integer R = A + B
[in]	a	First operand A
[in]	b	Second operand B

Returns: Error code

Definition at line 893 of file mpi.c.

◆ mpiAddAbs()

error_t mpiAddAbs	(	Mpi *	r,
		const Mpi *	a,
		const Mpi *	b
	)

Helper routine for multiple precision addition.

Parameters

[out]	r	Resulting integer R = \|A + B\|
[in]	a	First operand A
[in]	b	Second operand B

Returns: Error code

Definition at line 1049 of file mpi.c.

◆ mpiAddInt()

error_t mpiAddInt	(	Mpi *	r,
		const Mpi *	a,
		mpi_sword_t	b
	)

Add an integer to a multiple precision integer.

Parameters

[out]	r	Resulting integer R = A + B
[in]	a	First operand A
[in]	b	Second operand B

Returns: Error code

Definition at line 942 of file mpi.c.

◆ mpiAddMod()

error_t mpiAddMod	(	Mpi *	r,
		const Mpi *	a,
		const Mpi *	b,
		const Mpi *	p
	)

Modular addition.

Parameters

[out]	r	Resulting integer R = A + B mod P
[in]	a	The first operand A
[in]	b	The second operand B
[in]	p	The modulus P

Returns: Error code

Definition at line 1653 of file mpi.c.

◆ mpiCheckProbablePrime()

error_t mpiCheckProbablePrime ( const Mpi * a )

Test whether a number is probable prime.

Parameters

[in] a Pointer to a multiple precision integer

Returns: Error code

Definition at line 610 of file pic32cx_bz_crypto_pkc.c.

◆ mpiComp()

int_t mpiComp	(	const Mpi *	a,
		const Mpi *	b
	)

Compare two multiple precision integers.

Parameters

[in]	a	The first multiple precision integer to be compared
[in]	b	The second multiple precision integer to be compared

Returns: Comparison result

Definition at line 359 of file mpi.c.

◆ mpiCompAbs()

int_t mpiCompAbs	(	const Mpi *	a,
		const Mpi *	b
	)

Compare the absolute value of two multiple precision integers.

Parameters

[in]	a	The first multiple precision integer to be compared
[in]	b	The second multiple precision integer to be compared

Returns: Comparison result

Definition at line 458 of file mpi.c.

◆ mpiCompInt()

int_t mpiCompInt	(	const Mpi *	a,
		mpi_sword_t	b
	)

Compare a multiple precision integer with an integer.

Parameters

[in]	a	Multiple precision integer to be compared
[in]	b	Integer to be compared

Returns: Comparison result

Definition at line 430 of file mpi.c.

◆ mpiCopy()

error_t mpiCopy	(	Mpi *	r,
		const Mpi *	a
	)

Copy a multiple precision integer.

Parameters

[out]	r	Pointer to a multiple precision integer (destination)
[in]	a	Pointer to a multiple precision integer (source)

Returns: Error code

Definition at line 517 of file mpi.c.

◆ mpiDiv()

error_t mpiDiv	(	Mpi *	q,
		Mpi *	r,
		const Mpi *	a,
		const Mpi *	b
	)

Multiple precision division.

Parameters

[out]	q	The quotient Q = A / B
[out]	r	The remainder R = A mod B
[in]	a	The dividend A
[in]	b	The divisor B

Returns: Error code

Definition at line 1487 of file mpi.c.

◆ mpiDivInt()

error_t mpiDivInt	(	Mpi *	q,
		Mpi *	r,
		const Mpi *	a,
		mpi_sword_t	b
	)

Divide a multiple precision integer by an integer.

Parameters

[out]	q	The quotient Q = A / B
[out]	r	The remainder R = A mod B
[in]	a	The dividend A
[in]	b	The divisor B

Returns: Error code

Definition at line 1560 of file mpi.c.

◆ mpiDump()

void mpiDump	(	FILE *	stream,
		const char_t *	prepend,
		const Mpi *	a
	)

Display the contents of a multiple precision integer.

Parameters

[in]	stream	Pointer to a FILE object that identifies an output stream
[in]	prepend	String to prepend to the left of each line
[in]	a	Pointer to a multiple precision integer

Definition at line 2023 of file mpi.c.

◆ mpiExpMod()

error_t mpiExpMod	(	Mpi *	r,
		const Mpi *	a,
		const Mpi *	e,
		const Mpi *	p
	)

Modular exponentiation.

Parameters

[out]	r	Resulting integer R = A ^ E mod P
[in]	a	Pointer to a multiple precision integer
[in]	e	Exponent
[in]	p	Modulus

Returns: Error code

Definition at line 205 of file esp32_crypto_pkc.c.

◆ mpiExpModFast()

error_t mpiExpModFast	(	Mpi *	r,
		const Mpi *	a,
		const Mpi *	e,
		const Mpi *	p
	)

Modular exponentiation (fast calculation)

Parameters

[out]	r	Resulting integer R = A ^ E mod P
[in]	a	Pointer to a multiple precision integer
[in]	e	Exponent
[in]	p	Modulus

Returns: Error code

Definition at line 142 of file m2354_crypto_pkc.c.

◆ mpiExpModRegular()

error_t mpiExpModRegular	(	Mpi *	r,
		const Mpi *	a,
		const Mpi *	e,
		const Mpi *	p
	)

Modular exponentiation (regular calculation)

Parameters

[out]	r	Resulting integer R = A ^ E mod P
[in]	a	Pointer to a multiple precision integer
[in]	e	Exponent
[in]	p	Modulus

Returns: Error code

Definition at line 224 of file m2354_crypto_pkc.c.

◆ mpiExport()

error_t mpiExport	(	const Mpi *	a,
		uint8_t *	output,
		size_t	length,
		MpiFormat	format
	)

Integer to octet string conversion.

Converts an integer to an octet string of a specified length

Parameters

[in]	a	Non-negative integer to be converted
[out]	output	Octet string resulting from the conversion
[in]	length	Intended length of the resulting octet string
[in]	format	Output format

Returns: Error code

Definition at line 811 of file mpi.c.

◆ mpiFree()

void mpiFree ( Mpi * r )

Release a multiple precision integer.

Parameters

[in,out] r Pointer to the multiple precision integer to be freed

Definition at line 65 of file mpi.c.

◆ mpiGetBitLength()

uint_t mpiGetBitLength ( const Mpi * a )

Get the actual length in bits.

Parameters

[in] a Pointer to a multiple precision integer

Returns: The actual bit count

Definition at line 255 of file mpi.c.

◆ mpiGetBitValue()

uint_t mpiGetBitValue	(	const Mpi *	a,
		uint_t	index
	)

Get the bit value at the specified index.

Parameters

[in]	a	Pointer to a multiple precision integer
[in]	index	Position where to read the bit

Returns: The actual bit value

Definition at line 334 of file mpi.c.

◆ mpiGetByteLength()

uint_t mpiGetByteLength ( const Mpi * a )

Get the actual length in bytes.

Parameters

[in] a Pointer to a multiple precision integer

Returns: The actual byte count

Definition at line 216 of file mpi.c.

◆ mpiGetLength()

uint_t mpiGetLength ( const Mpi * a )

Get the actual length in words.

Parameters

[in] a Pointer to a multiple precision integer

Returns: The actual length in words

Definition at line 189 of file mpi.c.

◆ mpiGrow()

error_t mpiGrow	(	Mpi *	r,
		uint_t	size
	)

Adjust the size of multiple precision integer.

Parameters

[in,out]	r	A multiple precision integer whose size is to be increased
[in]	size	Desired size in words

Returns: Error code

Definition at line 103 of file mpi.c.

◆ mpiImport()

error_t mpiImport	(	Mpi *	r,
		const uint8_t *	input,
		size_t	length,
		MpiFormat	format
	)

Octet string to integer conversion.

Converts an octet string to a non-negative integer

Parameters

[out]	r	Non-negative integer resulting from the conversion
[in]	input	Octet string to be converted
[in]	length	Length of the octet string
[in]	format	Input format

Returns: Error code

Definition at line 714 of file mpi.c.

◆ mpiInit()

void mpiInit ( Mpi * r )

Initialize a multiple precision integer.

Parameters

[in,out] r Pointer to the multiple precision integer to be initialized

Definition at line 49 of file mpi.c.

◆ mpiInvMod()

error_t mpiInvMod	(	Mpi *	r,
		const Mpi *	a,
		const Mpi *	p
	)

Modular inverse.

Parameters

[out]	r	Resulting integer R = A^-1 mod P
[in]	a	The multiple precision integer A
[in]	p	The modulus P

Returns: Error code

Definition at line 385 of file pic32cx_bz_crypto_pkc.c.

◆ mpiMod()

error_t mpiMod	(	Mpi *	r,
		const Mpi *	a,
		const Mpi *	p
	)

Modulo operation.

Parameters

[out]	r	Resulting integer R = A mod P
[in]	a	The multiple precision integer to be reduced
[in]	p	The modulus P

Returns: Error code

Definition at line 1589 of file mpi.c.

◆ mpiMul()

error_t mpiMul	(	Mpi *	r,
		const Mpi *	a,
		const Mpi *	b
	)

Multiple precision multiplication.

Parameters

[out]	r	Resulting integer R = A * B
[in]	a	First operand A
[in]	b	Second operand B

Returns: Error code

Definition at line 78 of file esp32_crypto_pkc.c.

◆ mpiMulInt()

error_t mpiMulInt	(	Mpi *	r,
		const Mpi *	a,
		mpi_sword_t	b
	)

Multiply a multiple precision integer by an integer.

Parameters

[out]	r	Resulting integer R = A * B
[in]	a	First operand A
[in]	b	Second operand B

Returns: Error code

Definition at line 1457 of file mpi.c.

◆ mpiMulMod()

error_t mpiMulMod	(	Mpi *	r,
		const Mpi *	a,
		const Mpi *	b,
		const Mpi *	p
	)

Modular multiplication.

Parameters

[out]	r	Resulting integer R = A * B mod P
[in]	a	The first operand A
[in]	b	The second operand B
[in]	p	The modulus P

Returns: Error code

Definition at line 63 of file mimxrt1160_crypto_pkc.c.

◆ mpiRand()

error_t mpiRand	(	Mpi *	r,
		uint_t	length,
		const PrngAlgo *	prngAlgo,
		void *	prngContext
	)

Generate a random value.

Parameters

[out]	r	Pointer to a multiple precision integer
[in]	length	Desired length in bits
[in]	prngAlgo	PRNG algorithm
[in]	prngContext	Pointer to the PRNG context

Returns: Error code

Definition at line 599 of file mpi.c.

◆ mpiRandRange()

error_t mpiRandRange	(	Mpi *	r,
		const Mpi *	p,
		const PrngAlgo *	prngAlgo,
		void *	prngContext
	)

Generate a random value in the range 1 to p-1.

Parameters

[out]	r	Pointer to a multiple precision integer
[in]	p	The upper bound of the range
[in]	prngAlgo	PRNG algorithm
[in]	prngContext	Pointer to the PRNG context

Returns: Error code

Definition at line 654 of file mpi.c.

◆ mpiSetBitValue()

error_t mpiSetBitValue	(	Mpi *	r,
		uint_t	index,
		uint_t	value
	)

Set the bit value at the specified index.

Parameters

[in]	r	Pointer to a multiple precision integer
[in]	index	Position of the bit to be written
[in]	value	Bit value

Returns: Error code

Definition at line 296 of file mpi.c.

◆ mpiSetValue()

error_t mpiSetValue	(	Mpi *	r,
		mpi_sword_t	a
	)

Set the value of a multiple precision integer.

Parameters

[out]	r	Pointer to a multiple precision integer
[in]	a	Value to be assigned to the multiple precision integer

Returns: Error code

Definition at line 563 of file mpi.c.

◆ mpiShiftLeft()

error_t mpiShiftLeft	(	Mpi *	r,
		uint_t	n
	)

Left shift operation.

Parameters

[in,out]	r	The multiple precision integer to be shifted to the left
[in]	n	The number of bits to shift

Returns: Error code

Definition at line 1245 of file mpi.c.

◆ mpiShiftRight()

error_t mpiShiftRight	(	Mpi *	r,
		uint_t	n
	)

Right shift operation.

Parameters

[in,out]	r	The multiple precision integer to be shifted to the right
[in]	n	The number of bits to shift

Returns: Error code

Definition at line 1312 of file mpi.c.

◆ mpiSub()

error_t mpiSub	(	Mpi *	r,
		const Mpi *	a,
		const Mpi *	b
	)

Multiple precision subtraction.

Parameters

[out]	r	Resulting integer R = A - B
[in]	a	First operand A
[in]	b	Second operand B

Returns: Error code

Definition at line 971 of file mpi.c.

◆ mpiSubAbs()

error_t mpiSubAbs	(	Mpi *	r,
		const Mpi *	a,
		const Mpi *	b
	)

Helper routine for multiple precision subtraction.

Parameters

[out]	r	Resulting integer R = \|A - B\|
[in]	a	First operand A
[in]	b	Second operand B

Returns: Error code

Definition at line 1143 of file mpi.c.

◆ mpiSubInt()

error_t mpiSubInt	(	Mpi *	r,
		const Mpi *	a,
		mpi_sword_t	b
	)

Subtract an integer from a multiple precision integer.

Parameters

[out]	r	Resulting integer R = A - B
[in]	a	First operand A
[in]	b	Second operand B

Returns: Error code

Definition at line 1020 of file mpi.c.

◆ mpiSubMod()

error_t mpiSubMod	(	Mpi *	r,
		const Mpi *	a,
		const Mpi *	b,
		const Mpi *	p
	)

Modular subtraction.

Parameters

[out]	r	Resulting integer R = A - B mod P
[in]	a	The first operand A
[in]	b	The second operand B
[in]	p	The modulus P

Returns: Error code

Definition at line 1676 of file mpi.c.

Data Structures

Macros

Enumerations

Functions

Detailed Description

License

Macro Definition Documentation

◆ MPI_BITS_PER_WORD

◆ MPI_BYTES_PER_WORD

◆ MPI_CHECK

◆ mpi_dword_t

◆ MPI_MAX_BITS

◆ MPI_MAX_WORDS

◆ mpi_sword_t

◆ mpi_word_t

◆ mpiIsEven

◆ mpiIsOdd

Enumeration Type Documentation

◆ MpiFormat

Function Documentation

◆ mpiAdd()

◆ mpiAddAbs()

◆ mpiAddInt()

◆ mpiAddMod()

◆ mpiCheckProbablePrime()

◆ mpiComp()

◆ mpiCompAbs()

◆ mpiCompInt()

◆ mpiCopy()

◆ mpiDiv()

◆ mpiDivInt()

◆ mpiDump()

◆ mpiExpMod()

◆ mpiExpModFast()

◆ mpiExpModRegular()

◆ mpiExport()

◆ mpiFree()

◆ mpiGetBitLength()

◆ mpiGetBitValue()

◆ mpiGetByteLength()

◆ mpiGetLength()

◆ mpiGrow()

◆ mpiImport()

◆ mpiInit()

◆ mpiInvMod()

◆ mpiMod()

◆ mpiMul()

◆ mpiMulInt()

◆ mpiMulMod()

◆ mpiRand()

◆ mpiRandRange()

◆ mpiSetBitValue()

◆ mpiSetValue()

◆ mpiShiftLeft()

◆ mpiShiftRight()

◆ mpiSub()

◆ mpiSubAbs()

◆ mpiSubInt()

◆ mpiSubMod()