Macros

Macros

#define ECJPAKE_STATUS_SUCCESS   (0)
 Successful status code. More...
 
#define ECJPAKE_STATUS_ERROR   (-1)
 Generic error status code. More...
 
#define ECJPAKE_STATUS_UNDEFINEDCMD   (-2)
 An error status code returned by ECJPAKE_control() for undefined command codes. More...
 
#define ECJPAKE_STATUS_RESOURCE_UNAVAILABLE   (-3)
 An error status code returned if the hardware or software resource is currently unavailable. More...
 
#define ECJPAKE_STATUS_INVALID_PUBLIC_KEY   (-4)
 The public key of the other party is not valid. More...
 
#define ECJPAKE_STATUS_PUBLIC_KEY_NOT_ON_CURVE   (-5)
 The public key of the other party does not lie upon the curve. More...
 
#define ECJPAKE_STATUS_PUBLIC_KEY_LARGER_THAN_PRIME   (-6)
 A coordinate of the public key of the other party is too large. More...
 
#define ECJPAKE_STATUS_POINT_AT_INFINITY   (-7)
 The result of the operation is the point at infinity. More...
 
#define ECJPAKE_STATUS_INVALID_PRIVATE_KEY   (-8)
 The private key passed into the the call is invalid. More...
 
#define ECJPAKE_STATUS_INVALID_PRIVATE_V   (-9)
 The private v passed into the the call is invalid. More...
 

Detailed Description

ECJPAKE_STATUS_* macros are general status codes returned by ECJPAKE functions

Macro Definition Documentation

§ ECJPAKE_STATUS_SUCCESS

#define ECJPAKE_STATUS_SUCCESS   (0)

Successful status code.

Functions return ECJPAKE_STATUS_SUCCESS if the function was executed successfully.

§ ECJPAKE_STATUS_ERROR

#define ECJPAKE_STATUS_ERROR   (-1)

Generic error status code.

Functions return ECJPAKE_STATUS_ERROR if the function was not executed successfully.

§ ECJPAKE_STATUS_UNDEFINEDCMD

#define ECJPAKE_STATUS_UNDEFINEDCMD   (-2)

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

ECJPAKE_control() returns ECJPAKE_STATUS_UNDEFINEDCMD if the control code is not recognized by the driver implementation.

§ ECJPAKE_STATUS_RESOURCE_UNAVAILABLE

#define ECJPAKE_STATUS_RESOURCE_UNAVAILABLE   (-3)

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

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

§ ECJPAKE_STATUS_INVALID_PUBLIC_KEY

#define ECJPAKE_STATUS_INVALID_PUBLIC_KEY   (-4)

The public key of the other party is not valid.

The public key received from the other party is not valid.

§ ECJPAKE_STATUS_PUBLIC_KEY_NOT_ON_CURVE

#define ECJPAKE_STATUS_PUBLIC_KEY_NOT_ON_CURVE   (-5)

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.

§ ECJPAKE_STATUS_PUBLIC_KEY_LARGER_THAN_PRIME

#define ECJPAKE_STATUS_PUBLIC_KEY_LARGER_THAN_PRIME   (-6)

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.

§ ECJPAKE_STATUS_POINT_AT_INFINITY

#define ECJPAKE_STATUS_POINT_AT_INFINITY   (-7)

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.

§ ECJPAKE_STATUS_INVALID_PRIVATE_KEY

#define ECJPAKE_STATUS_INVALID_PRIVATE_KEY   (-8)

The private key passed into the the call is invalid.

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

§ ECJPAKE_STATUS_INVALID_PRIVATE_V

#define ECJPAKE_STATUS_INVALID_PRIVATE_V   (-9)

The private v passed into the the call is invalid.

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

Copyright 2018, Texas Instruments Incorporated