ECC (Elliptic Curve Cryptography) More...

#include "core/crypto.h"
#include "ecc/ec_curves.h"

Data Structures
struct	EcPoint
	EC point. More...

struct	EcDomainParameters
	EC domain parameters. More...

struct	EcPublicKey
	EC public key. More...

struct	EcPrivateKey
	EC private key. More...

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

Enumerations
enum	EcPointFormat { EC_POINT_FORMAT_COMPRESSED_EVEN = 0x02, EC_POINT_FORMAT_COMPRESSED_ODD = 0x03, EC_POINT_FORMAT_UNCOMPRESSED = 0x04 }
	EC point format. More...

Functions
void	ecInitDomainParameters (EcDomainParameters *params)
	Initialize EC domain parameters. More...

void	ecFreeDomainParameters (EcDomainParameters *params)
	Release EC domain parameters. More...

error_t	ecLoadDomainParameters (EcDomainParameters params, const EcCurveInfo curveInfo)
	Load EC domain parameters. More...

void	ecInitPublicKey (EcPublicKey *key)
	Initialize an EC public key. More...

void	ecFreePublicKey (EcPublicKey *key)
	Release an EC public key. More...

void	ecInitPrivateKey (EcPrivateKey *key)
	Initialize an EC private key. More...

void	ecFreePrivateKey (EcPrivateKey *key)
	Release an EdDSA private key. More...

error_t	ecGenerateKeyPair (const PrngAlgo prngAlgo, void prngContext, const EcDomainParameters params, EcPrivateKey privateKey, EcPublicKey *publicKey)
	EC key pair generation. More...

error_t	ecGeneratePrivateKey (const PrngAlgo prngAlgo, void prngContext, const EcDomainParameters params, EcPrivateKey privateKey)
	EC private key generation. More...

error_t	ecGeneratePublicKey (const EcDomainParameters params, const EcPrivateKey privateKey, EcPublicKey *publicKey)
	Derive the public key from an EC private key. More...

void	ecInit (EcPoint *r)
	Initialize elliptic curve point. More...

void	ecFree (EcPoint *r)
	Release an elliptic curve point. More...

error_t	ecCopy (EcPoint r, const EcPoint s)
	Copy EC point. More...

error_t	ecImport (const EcDomainParameters params, EcPoint r, const uint8_t *data, size_t length)
	Convert an octet string to an EC point. More...

error_t	ecExport (const EcDomainParameters params, const EcPoint a, uint8_t data, size_t length)
	Convert an EC point to an octet string. More...

error_t	ecProjectify (const EcDomainParameters params, EcPoint r, const EcPoint *s)
	Compute projective representation. More...

error_t	ecAffinify (const EcDomainParameters params, EcPoint r, const EcPoint *s)
	Recover affine representation. More...

bool_t	ecIsPointAffine (const EcDomainParameters params, const EcPoint s)
	Check whether the affine point S is on the curve. More...

error_t	ecDouble (const EcDomainParameters params, EcPoint r, const EcPoint *s)
	Point doubling. More...

error_t	ecAdd (const EcDomainParameters params, EcPoint r, const EcPoint s, const EcPoint t)
	Point addition (helper routine) More...

error_t	ecFullAdd (const EcDomainParameters params, EcPoint r, const EcPoint s, const EcPoint t)
	Point addition. More...

error_t	ecFullSub (const EcDomainParameters params, EcPoint r, const EcPoint s, const EcPoint t)
	Point subtraction. More...

error_t	ecMult (const EcDomainParameters params, EcPoint r, const Mpi d, const EcPoint s)
	Scalar multiplication. More...

error_t	ecTwinMult (const EcDomainParameters params, EcPoint r, const Mpi d0, const EcPoint s, const Mpi d1, const EcPoint t)
	Twin multiplication. More...

error_t	ecAddMod (const EcDomainParameters params, Mpi r, const Mpi a, const Mpi b)
	Fast modular addition. More...

error_t	ecSubMod (const EcDomainParameters params, Mpi r, const Mpi a, const Mpi b)
	Fast modular subtraction. More...

error_t	ecMulMod (const EcDomainParameters params, Mpi r, const Mpi a, const Mpi b)
	Fast modular multiplication. More...

error_t	ecSqrMod (const EcDomainParameters params, Mpi r, const Mpi *a)
	Fast modular squaring. More...

Variables
const uint8_t	EC_PUBLIC_KEY_OID [7]

Detailed Description

ECC (Elliptic Curve Cryptography)

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.4.4

Definition in file ec.h.

Macro Definition Documentation

◆ EC_CHECK

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

Definition at line 39 of file ec.h.

Enumeration Type Documentation

◆ EcPointFormat

enum EcPointFormat

EC point format.

Enumerator
EC_POINT_FORMAT_COMPRESSED_EVEN
EC_POINT_FORMAT_COMPRESSED_ODD
EC_POINT_FORMAT_UNCOMPRESSED

Definition at line 51 of file ec.h.

Function Documentation

◆ ecAdd()

error_t ecAdd	(	const EcDomainParameters *	params,
		EcPoint *	r,
		const EcPoint *	s,
		const EcPoint *	t
	)

Point addition (helper routine)

Parameters

[in]	params	EC domain parameters
[out]	r	Resulting point R = S + T
[in]	s	First operand
[in]	t	Second operand

Returns: Error code

Definition at line 739 of file ec.c.

◆ ecAddMod()

error_t ecAddMod	(	const EcDomainParameters *	params,
		Mpi *	r,
		const Mpi *	a,
		const Mpi *	b
	)

Fast modular addition.

Parameters

[in]	params	EC domain parameters
[out]	r	Resulting integer R = (A + B) mod p
[in]	a	An integer such as 0 <= A < p
[in]	b	An integer such as 0 <= B < p

Returns: Error code

Definition at line 1317 of file ec.c.

◆ ecAffinify()

error_t ecAffinify	(	const EcDomainParameters *	ecParams,
		EcPoint *	r,
		const EcPoint *	s
	)

Recover affine representation.

Parameters

[in]	params	EC domain parameters
[out]	r	Affine representation of the point
[in]	s	Projective representation of the point

Returns: Error code

Parameters

[in]	ecParams	EC domain parameters
[out]	r	Affine representation of the point
[in]	s	Projective representation of the point

Returns: Error code

Definition at line 519 of file ec.c.

◆ ecCopy()

error_t ecCopy	(	EcPoint *	r,
		const EcPoint *	s
	)

Copy EC point.

Parameters

[out]	r	Destination EC point
[in]	s	Source EC point

Returns: Error code

Definition at line 337 of file ec.c.

◆ ecDouble()

error_t ecDouble	(	const EcDomainParameters *	params,
		EcPoint *	r,
		const EcPoint *	s
	)

Point doubling.

Parameters

[in]	params	EC domain parameters
[out]	r	Resulting point R = 2S
[in]	s	Point S

Returns: Error code

Definition at line 607 of file ec.c.

◆ ecExport()

error_t ecExport	(	const EcDomainParameters *	params,
		const EcPoint *	a,
		uint8_t *	data,
		size_t *	length
	)

Convert an EC point to an octet string.

Parameters

[in]	params	EC domain parameters
[in]	a	EC point to be converted
[out]	data	Pointer to the octet string
[out]	length	Length of the resulting octet string

Returns: Error code

Definition at line 438 of file ec.c.

◆ ecFree()

void ecFree ( EcPoint * r )

Release an elliptic curve point.

Parameters

[in,out] r Pointer to the EC point to initialize to free

Definition at line 321 of file ec.c.

◆ ecFreeDomainParameters()

void ecFreeDomainParameters ( EcDomainParameters * params )

Release EC domain parameters.

Parameters

[in] params Pointer to the EC domain parameters to free

Definition at line 72 of file ec.c.

◆ ecFreePrivateKey()

void ecFreePrivateKey ( EcPrivateKey * key )

Release an EdDSA private key.

Parameters

[in] key Pointer to the EC public key to free

Definition at line 192 of file ec.c.

◆ ecFreePublicKey()

void ecFreePublicKey ( EcPublicKey * key )

Release an EC public key.

Parameters

[in] key Pointer to the EC public key to free

Definition at line 165 of file ec.c.

◆ ecFullAdd()

error_t ecFullAdd	(	const EcDomainParameters *	params,
		EcPoint *	r,
		const EcPoint *	s,
		const EcPoint *	t
	)

Point addition.

Parameters

[in]	params	EC domain parameters
[out]	r	Resulting point R = S + T
[in]	s	First operand
[in]	t	Second operand

Returns: Error code

Definition at line 899 of file ec.c.

◆ ecFullSub()

error_t ecFullSub	(	const EcDomainParameters *	params,
		EcPoint *	r,
		const EcPoint *	s,
		const EcPoint *	t
	)

Point subtraction.

Parameters

[in]	params	EC domain parameters
[out]	r	Resulting point R = S - T
[in]	s	First operand
[in]	t	Second operand

Returns: Error code

Definition at line 962 of file ec.c.

◆ ecGenerateKeyPair()

error_t ecGenerateKeyPair	(	const PrngAlgo *	prngAlgo,
		void *	prngContext,
		const EcDomainParameters *	params,
		EcPrivateKey *	privateKey,
		EcPublicKey *	publicKey
	)

EC key pair generation.

Parameters

[in]	prngAlgo	PRNG algorithm
[in]	prngContext	Pointer to the PRNG context
[in]	params	EC domain parameters
[out]	privateKey	EC private key
[out]	publicKey	EC public key

Returns: Error code

Definition at line 209 of file ec.c.

◆ ecGeneratePrivateKey()

error_t ecGeneratePrivateKey	(	const PrngAlgo *	prngAlgo,
		void *	prngContext,
		const EcDomainParameters *	params,
		EcPrivateKey *	privateKey
	)

EC private key generation.

Parameters

[in]	prngAlgo	PRNG algorithm
[in]	prngContext	Pointer to the PRNG context
[in]	params	EC domain parameters
[out]	privateKey	EC private key

Returns: Error code

Definition at line 239 of file ec.c.

◆ ecGeneratePublicKey()

error_t ecGeneratePublicKey	(	const EcDomainParameters *	params,
		const EcPrivateKey *	privateKey,
		EcPublicKey *	publicKey
	)

Derive the public key from an EC private key.

Parameters

[in]	params	EC domain parameters
[in]	privateKey	EC private key
[out]	publicKey	EC public key

Returns: Error code

Definition at line 275 of file ec.c.

◆ ecImport()

error_t ecImport	(	const EcDomainParameters *	params,
		EcPoint *	r,
		const uint8_t *	data,
		size_t	length
	)

Convert an octet string to an EC point.

Parameters

[in]	params	EC domain parameters
[out]	r	EC point resulting from the conversion
[in]	data	Pointer to the octet string
[in]	length	Length of the octet string

Returns: Error code

Definition at line 365 of file ec.c.

◆ ecInit()

void ecInit ( EcPoint * r )

Initialize elliptic curve point.

Parameters

[in,out] r Pointer to the EC point to be initialized

Definition at line 307 of file ec.c.

◆ ecInitDomainParameters()

void ecInitDomainParameters ( EcDomainParameters * params )

Initialize EC domain parameters.

Parameters

[in] params Pointer to the EC domain parameters to initialize

Definition at line 51 of file ec.c.

◆ ecInitPrivateKey()

void ecInitPrivateKey ( EcPrivateKey * key )

Initialize an EC private key.

Parameters

[in] key Pointer to the EC private key to initialize

Definition at line 177 of file ec.c.

◆ ecInitPublicKey()

void ecInitPublicKey ( EcPublicKey * key )

Initialize an EC public key.

Parameters

[in] key Pointer to the EC public key to initialize

Definition at line 153 of file ec.c.

◆ ecIsPointAffine()

bool_t ecIsPointAffine	(	const EcDomainParameters *	ecParams,
		const EcPoint *	s
	)

Check whether the affine point S is on the curve.

Parameters

[in]	params	EC domain parameters
[in]	s	Affine representation of the point

Returns: TRUE if the affine point S is on the curve, else FALSE

Parameters

[in]	ecParams	EC domain parameters
[in]	s	Affine representation of the point

Returns: TRUE if the affine point S is on the curve, else FALSE

Definition at line 565 of file ec.c.

◆ ecLoadDomainParameters()

error_t ecLoadDomainParameters	(	EcDomainParameters *	params,
		const EcCurveInfo *	curveInfo
	)

Load EC domain parameters.

Parameters

[out]	params	Pointer to the structure to be initialized
[in]	curveInfo	Elliptic curve parameters

Returns: Error code

Definition at line 90 of file ec.c.

◆ ecMulMod()

error_t ecMulMod	(	const EcDomainParameters *	params,
		Mpi *	r,
		const Mpi *	a,
		const Mpi *	b
	)

Fast modular multiplication.

Parameters

[in]	params	EC domain parameters
[out]	r	Resulting integer R = (A * B) mod p
[in]	a	An integer such as 0 <= A < p
[in]	b	An integer such as 0 <= B < p

Returns: Error code

Fast modular multiplication.

Parameters

[in]	params	EC domain parameters
[out]	r	Resulting integer R = (A * B) mod p
[in]	a	An integer such as 0 <= A < p
[in]	b	An integer such as 0 <= B < p

Returns: Error code

Definition at line 1375 of file ec.c.

◆ ecMult()

error_t ecMult	(	const EcDomainParameters *	params,
		EcPoint *	r,
		const Mpi *	d,
		const EcPoint *	s
	)

Scalar multiplication.

Parameters

[in]	params	EC domain parameters
[out]	r	Resulting point R = d.S
[in]	d	An integer d such as 0 <= d < p
[in]	s	EC point

Returns: Error code

Parameters

[in]	ecParams	EC domain parameters
[out]	r	Resulting point R = d.S
[in]	d	An integer d such as 0 <= d < p
[in]	s	EC point

Returns: Error code

Definition at line 998 of file ec.c.

◆ ecProjectify()

error_t ecProjectify	(	const EcDomainParameters *	params,
		EcPoint *	r,
		const EcPoint *	s
	)

Compute projective representation.

Parameters

[in]	params	EC domain parameters
[out]	r	Projective representation of the point
[in]	s	Affine representation of the point

Returns: Error code

Definition at line 495 of file ec.c.

◆ ecSqrMod()

error_t ecSqrMod	(	const EcDomainParameters *	params,
		Mpi *	r,
		const Mpi *	a
	)

Fast modular squaring.

Parameters

[in]	params	EC domain parameters
[out]	r	Resulting integer R = (A ^ 2) mod p
[in]	a	An integer such as 0 <= A < p

Returns: Error code

Definition at line 1407 of file ec.c.

◆ ecSubMod()

error_t ecSubMod	(	const EcDomainParameters *	params,
		Mpi *	r,
		const Mpi *	a,
		const Mpi *	b
	)

Fast modular subtraction.

Parameters

[in]	params	EC domain parameters
[out]	r	Resulting integer R = (A - B) mod p
[in]	a	An integer such as 0 <= A < p
[in]	b	An integer such as 0 <= B < p

Returns: Error code

Definition at line 1346 of file ec.c.

◆ ecTwinMult()

error_t ecTwinMult	(	const EcDomainParameters *	params,
		EcPoint *	r,
		const Mpi *	d0,
		const EcPoint *	s,
		const Mpi *	d1,
		const EcPoint *	t
	)

Twin multiplication.

Parameters

[in]	params	EC domain parameters
[out]	r	Resulting point R = d0.S + d1.T
[in]	d0	An integer d such as 0 <= d0 < p
[in]	s	EC point
[in]	d1	An integer d such as 0 <= d1 < p
[in]	t	EC point

Returns: Error code

Definition at line 1147 of file ec.c.

Variable Documentation

◆ EC_PUBLIC_KEY_OID

const uint8_t EC_PUBLIC_KEY_OID[7]

extern

Definition at line 43 of file ec.c.

Data Structures

Macros

Enumerations

Functions

Variables

Detailed Description

License

Macro Definition Documentation

◆ EC_CHECK

Enumeration Type Documentation

◆ EcPointFormat

Function Documentation

◆ ecAdd()

◆ ecAddMod()

◆ ecAffinify()

◆ ecCopy()

◆ ecDouble()

◆ ecExport()

◆ ecFree()

◆ ecFreeDomainParameters()

◆ ecFreePrivateKey()

◆ ecFreePublicKey()

◆ ecFullAdd()

◆ ecFullSub()

◆ ecGenerateKeyPair()

◆ ecGeneratePrivateKey()

◆ ecGeneratePublicKey()

◆ ecImport()

◆ ecInit()

◆ ecInitDomainParameters()

◆ ecInitPrivateKey()

◆ ecInitPublicKey()

◆ ecIsPointAffine()

◆ ecLoadDomainParameters()

◆ ecMulMod()

◆ ecMult()

◆ ecProjectify()

◆ ecSqrMod()

◆ ecSubMod()

◆ ecTwinMult()

Variable Documentation

◆ EC_PUBLIC_KEY_OID