Macros

Macros

#define ECDH_STATUS_SUCCESS   (0)
 Successful status code. More...
 
#define ECDH_STATUS_ERROR   (-1)
 Generic error status code. More...
 
#define ECDH_STATUS_UNDEFINEDCMD   (-2)
 An error status code returned by ECDH_control() for undefined command codes. More...
 
#define ECDH_STATUS_RESOURCE_UNAVAILABLE   (-3)
 An error status code returned if the hardware or software resource is currently unavailable. More...
 
#define ECDH_STATUS_POINT_AT_INFINITY   (-4)
 The result of the operation is the point at infinity. More...
 
#define ECDH_STATUS_PRIVATE_KEY_LARGER_EQUAL_ORDER   (-5)
 The private key passed in is larger than the order of the curve. More...
 
#define ECDH_STATUS_PRIVATE_KEY_ZERO   (-6)
 The private key passed in is zero. More...
 
#define ECDH_STATUS_PUBLIC_KEY_NOT_ON_CURVE   (-7)
 The public key of the other party does not lie upon the curve. More...
 
#define ECDH_STATUS_PUBLIC_KEY_LARGER_THAN_PRIME   (-8)
 A coordinate of the public key of the other party is too large. More...
 

Detailed Description

ECDH_STATUS_* macros are general status codes returned by ECC functions

Macro Definition Documentation

§ ECDH_STATUS_SUCCESS

#define ECDH_STATUS_SUCCESS   (0)

Successful status code.

Functions return ECDH_STATUS_SUCCESS if the function was executed successfully.

§ ECDH_STATUS_ERROR

#define ECDH_STATUS_ERROR   (-1)

Generic error status code.

Functions return ECDH_STATUS_ERROR if the function was not executed successfully.

§ ECDH_STATUS_UNDEFINEDCMD

#define ECDH_STATUS_UNDEFINEDCMD   (-2)

An error status code returned by ECDH_control() for undefined command codes.

ECDH_control() returns ECDH_STATUS_UNDEFINEDCMD if the control code is not recognized by the driver implementation.

§ ECDH_STATUS_RESOURCE_UNAVAILABLE

#define ECDH_STATUS_RESOURCE_UNAVAILABLE   (-3)

An error status code returned if the hardware or software resource is currently unavailable.

ECC driver implementations may have hardware or software limitations on how many clients can simultaneously perform operations. This status code is returned if the mutual exclusion mechanism signals that an operation cannot currently be performed.

§ ECDH_STATUS_POINT_AT_INFINITY

#define ECDH_STATUS_POINT_AT_INFINITY   (-4)

The result of the operation is the point at infinity.

The operation yielded the point at infinity on this curve. This point is not permitted for further use in ECC operations.

§ ECDH_STATUS_PRIVATE_KEY_LARGER_EQUAL_ORDER

#define ECDH_STATUS_PRIVATE_KEY_LARGER_EQUAL_ORDER   (-5)

The private key passed in is larger than the order of the curve.

Private keys must be integers in the interval [1, n - 1], where n is the order of the curve.

§ ECDH_STATUS_PRIVATE_KEY_ZERO

#define ECDH_STATUS_PRIVATE_KEY_ZERO   (-6)

The private key passed in is zero.

Private keys must be integers in the interval [1, n - 1], where n is the order of the curve.

§ ECDH_STATUS_PUBLIC_KEY_NOT_ON_CURVE

#define ECDH_STATUS_PUBLIC_KEY_NOT_ON_CURVE   (-7)

The public key of the other party does not lie upon the curve.

The public key received from the other party does not lie upon the agreed upon curve.

§ ECDH_STATUS_PUBLIC_KEY_LARGER_THAN_PRIME

#define ECDH_STATUS_PUBLIC_KEY_LARGER_THAN_PRIME   (-8)

A coordinate of the public key of the other party is too large.

A coordinate of the public key received from the other party is larger than the prime of the curve. This implies that the point was not correctly generated on that curve.

Copyright 2018, Texas Instruments Incorporated