Functions
enum lc_bike_type	lc_bike_sk_type (const struct lc_bike_sk *sk)
	Obtain BIKE type from secret key.
enum lc_bike_type	lc_bike_pk_type (const struct lc_bike_pk *pk)
	Obtain BIKE type from public key.
enum lc_bike_type	lc_bike_ct_type (const struct lc_bike_ct *ct)
	Obtain BIKE type from BIKE ciphertext.
enum lc_bike_type	lc_bike_ss_type (const struct lc_bike_ss *ss)
	Obtain BIKE type from shared secret.
LC_PURE unsigned int	lc_bike_sk_size (enum lc_bike_type bike_type)
	Return the size of the BIKE secret key.
LC_PURE unsigned int	lc_bike_pk_size (enum lc_bike_type bike_type)
	Return the size of the BIKE public key.
LC_PURE unsigned int	lc_bike_ct_size (enum lc_bike_type bike_type)
	Return the size of the BIKE ciphertext.
LC_PURE unsigned int	lc_bike_ss_size (enum lc_bike_type bike_type)
	Return the size of the BIKE shared secret.
int	lc_bike_sk_load (struct lc_bike_sk sk, const uint8_t src_key, size_t src_key_len)
	Load a BIKE secret key provided with a buffer into the leancrypto data structure.
int	lc_bike_pk_load (struct lc_bike_pk pk, const uint8_t src_key, size_t src_key_len)
	Load a BIKE public key provided with a buffer into the leancrypto data structure.
int	lc_bike_ct_load (struct lc_bike_ct ct, const uint8_t src_key, size_t src_key_len)
	Load a BIKE ciphertext key provided with a buffer into the leancrypto data structure.
int	lc_bike_ss_load (struct lc_bike_ss ss, const uint8_t src_key, size_t src_key_len)
	Load a BIKE shared secret provided with a buffer into the leancrypto data structure.
int	lc_bike_sk_ptr (uint8_t *bike_key, size_t bike_key_len, struct lc_bike_sk *sk)
	Obtain the reference to the BIKE key and its length.
int	lc_bike_pk_ptr (uint8_t *bike_key, size_t bike_key_len, struct lc_bike_pk *pk)
	Obtain the reference to the BIKE key and its length.
int	lc_bike_ct_ptr (uint8_t *bike_ct, size_t bike_ct_len, struct lc_bike_ct *ct)
	Obtain the reference to the BIKE ciphertext and its length.
int	lc_bike_ss_ptr (uint8_t *bike_ss, size_t bike_ss_len, struct lc_bike_ss *ss)
	Obtain the reference to the BIKE shared secret and its length.
int	lc_bike_keypair (struct lc_bike_pk pk, struct lc_bike_sk sk, struct lc_rng_ctx *rng_ctx, enum lc_bike_type bike_type)
	Generates public and private key for IND-CCA2-secure BIKE key encapsulation mechanism.
int	lc_bike_keypair_from_seed (struct lc_bike_pk pk, struct lc_bike_sk sk, const uint8_t *seed, size_t seedlen, enum lc_bike_type bike_type)
	Generates BIKE public and private key from a given seed.
int	lc_bike_enc (struct lc_bike_ct ct, struct lc_bike_ss ss, const struct lc_bike_pk *pk)
	Key encapsulation.
int	lc_bike_enc_kdf (struct lc_bike_ct ct, uint8_t ss, size_t ss_len, const struct lc_bike_pk *pk)
	Key encapsulation with KDF applied to shared secret.
int	lc_bike_dec (struct lc_bike_ss ss, const struct lc_bike_ct ct, const struct lc_bike_sk *sk)
	Key decapsulation.
int	lc_bike_dec_kdf (uint8_t ss, size_t ss_len, const struct lc_bike_ct ct, const struct lc_bike_sk *sk)
	Key decapsulation with KDF applied to shared secret.

Detailed Description

BIKE API concept

The BIKE API is accessible via the following header files with the mentioned purpose.

lc_bike.h: This API is the generic API allowing the caller to select which BIKE type (BIKE 5, 3 or 1) are to be used. The selection is made either with the flag specified during key generation or by matching the size of the imported data with the different lc_bike_*_load API calls. All remaining APIs take the information about the BIKE type from the provided input data.

This header file only provides inline functions which selectively call the API provided with the header files below.
lc_bike_5.h: Direct access to BIKE 5.
lc_bike_3.h: Direct access to BIKE 3.
lc_bike_1.h: Direct access to BIKE 1.

Function Documentation

◆ lc_bike_ct_load()

int lc_bike_ct_load	(	struct lc_bike_ct *	ct,
		const uint8_t *	src_key,
		size_t	src_key_len )

Load a BIKE ciphertext key provided with a buffer into the leancrypto data structure.

Parameters

[out]	ct	BIKE ciphertext to be filled (the caller must have it allocated)
[in]	src_key	Buffer that holds the ciphertext to be imported
[in]	src_key_len	Buffer length that holds the ciphertext to be imported

Returns: 0 on success or < 0 on error

◆ lc_bike_ct_ptr()

int lc_bike_ct_ptr	(	uint8_t **	bike_ct,
		size_t *	bike_ct_len,
		struct lc_bike_ct *	ct )

Obtain the reference to the BIKE ciphertext and its length.

Note: Only pointer references into the leancrypto data structure are returned which implies that any modification will modify the leancrypto ciphertext, too.

Parameters

[out]	bike_ct	BIKE ciphertext pointer
[out]	bike_ct_len	Length of the ciphertext buffer
[in]	ct	BIKE ciphertext from which the references are obtained

Returns: 0 on success, != 0 on error

◆ lc_bike_ct_size()

LC_PURE unsigned int lc_bike_ct_size ( enum lc_bike_type bike_type )

Return the size of the BIKE ciphertext.

Parameters

[in] bike_type BIKE type for which the size is requested

Returns: requested size

◆ lc_bike_ct_type()

enum lc_bike_type lc_bike_ct_type ( const struct lc_bike_ct * ct )

Obtain BIKE type from BIKE ciphertext.

Parameters

[in] ct Ciphertext from which the type is to be obtained

Returns: key type

◆ lc_bike_dec()

int lc_bike_dec	(	struct lc_bike_ss *	ss,
		const struct lc_bike_ct *	ct,
		const struct lc_bike_sk *	sk )

Key decapsulation.

Generates shared secret for given cipher text and private key

Parameters

[out]	ss	pointer to output shared secret that is the same as produced during encapsulation
[in]	ct	pointer to input cipher text generated during encapsulation
[in]	sk	pointer to input private key

Returns: 0

On failure, ss will contain a pseudo-random value.

◆ lc_bike_dec_kdf()

int lc_bike_dec_kdf	(	uint8_t *	ss,
		size_t	ss_len,
		const struct lc_bike_ct *	ct,
		const struct lc_bike_sk *	sk )

Key decapsulation with KDF applied to shared secret.

Generates cipher text and shared secret for given private key. The shared secret is derived from the BIKE SS using the KDF derived from the round 3 definition of BIKE:

SS <- KMAC256(K = BIKE-SS, X = BIKE-CT, L = requested SS length,

S = "BIKE KEM SS")

Parameters

[out]	ss	pointer to output shared secret that is the same as produced during encapsulation
[in]	ss_len	length of shared secret to be generated
[in]	ct	pointer to input cipher text generated during encapsulation
[in]	sk	pointer to input private key

Returns: 0

On failure, ss will contain a pseudo-random value.

◆ lc_bike_enc()

int lc_bike_enc	(	struct lc_bike_ct *	ct,
		struct lc_bike_ss *	ss,
		const struct lc_bike_pk *	pk )

Key encapsulation.

Generates cipher text and shared secret for given public key.

Parameters

[out]	ct	pointer to output cipher text to used for decapsulation
[out]	ss	pointer to output shared secret that will be also produced during decapsulation
[in]	pk	pointer to input public key

Returns 0 (success) or < 0 on error

◆ lc_bike_enc_kdf()

int lc_bike_enc_kdf	(	struct lc_bike_ct *	ct,
		uint8_t *	ss,
		size_t	ss_len,
		const struct lc_bike_pk *	pk )

Key encapsulation with KDF applied to shared secret.

Generates cipher text and shared secret for given public key. The shared secret is derived from the BIKE SS using the KDF derived from the round 3 definition of BIKE:

SS <- KMAC256(K = BIKE-SS, X = BIKE-CT, L = requested SS length,

S = "BIKE KEM SS")

Parameters

[out]	ct	pointer to output cipher text to used for decapsulation
[out]	ss	pointer to output shared secret that will be also produced during decapsulation
[in]	ss_len	length of shared secret to be generated
[in]	pk	pointer to input public key

Returns 0 (success) or < 0 on error

◆ lc_bike_keypair()

int lc_bike_keypair	(	struct lc_bike_pk *	pk,
		struct lc_bike_sk *	sk,
		struct lc_rng_ctx *	rng_ctx,
		enum lc_bike_type	bike_type )

Generates public and private key for IND-CCA2-secure BIKE key encapsulation mechanism.

Parameters

[out]	pk	pointer to already allocated output public key
[out]	sk	pointer to already allocated output private key
[in]	rng_ctx	pointer to seeded random number generator context
[in]	bike_type	type of the BIKE key to generate

Returns: 0 (success) or < 0 on error

◆ lc_bike_keypair_from_seed()

int lc_bike_keypair_from_seed	(	struct lc_bike_pk *	pk,
		struct lc_bike_sk *	sk,
		const uint8_t *	seed,
		size_t	seedlen,
		enum lc_bike_type	bike_type )

Generates BIKE public and private key from a given seed.

The idea of the function is the allowance of FIPS 203 to maintain the seed used to generate a key pair in lieu of maintaining a private key or the key pair (which used much more memory). The seed must be treated equally sensitive as a private key.

The seed is generated by simply obtaining 64 bytes from a properly seeded DRNG, i.e. the same way as a symmetric key would be generated.

Parameters

[out]	pk	pointer to allocated output public key
[out]	sk	pointer to allocated output private key
[in]	seed	buffer with the seed data which must be exactly 64 bytes in size
[in]	seedlen	length of the seed buffer
[in]	bike_type	type of the BIKE key to generate

Returns: 0 (success) or < 0 on error

◆ lc_bike_pk_load()

int lc_bike_pk_load	(	struct lc_bike_pk *	pk,
		const uint8_t *	src_key,
		size_t	src_key_len )

Load a BIKE public key provided with a buffer into the leancrypto data structure.

Parameters

[out]	pk	Public key to be filled (the caller must have it allocated)
[in]	src_key	Buffer that holds the key to be imported
[in]	src_key_len	Buffer length that holds the key to be imported

Returns: 0 on success or < 0 on error

◆ lc_bike_pk_ptr()

int lc_bike_pk_ptr	(	uint8_t **	bike_key,
		size_t *	bike_key_len,
		struct lc_bike_pk *	pk )

Obtain the reference to the BIKE key and its length.

Note: Only pointer references into the leancrypto data structure are returned which implies that any modification will modify the leancrypto key, too.

Parameters

[out]	bike_key	BIKE key pointer
[out]	bike_key_len	Length of the key buffer
[in]	pk	BIKE public key from which the references are obtained

Returns: 0 on success, != 0 on error

◆ lc_bike_pk_size()

LC_PURE unsigned int lc_bike_pk_size ( enum lc_bike_type bike_type )

Return the size of the BIKE public key.

Parameters

[in] bike_type BIKE type for which the size is requested

Returns: requested size

◆ lc_bike_pk_type()

enum lc_bike_type lc_bike_pk_type ( const struct lc_bike_pk * pk )

Obtain BIKE type from public key.

Parameters

[in] pk Public key from which the type is to be obtained

Returns: key type

◆ lc_bike_sk_load()

int lc_bike_sk_load	(	struct lc_bike_sk *	sk,
		const uint8_t *	src_key,
		size_t	src_key_len )

Load a BIKE secret key provided with a buffer into the leancrypto data structure.

Parameters

[out]	sk	Secret key to be filled (the caller must have it allocated)
[in]	src_key	Buffer that holds the key to be imported
[in]	src_key_len	Buffer length that holds the key to be imported

Returns: 0 on success or < 0 on error

◆ lc_bike_sk_ptr()

int lc_bike_sk_ptr	(	uint8_t **	bike_key,
		size_t *	bike_key_len,
		struct lc_bike_sk *	sk )

Obtain the reference to the BIKE key and its length.

Note: Only pointer references into the leancrypto data structure are returned which implies that any modification will modify the leancrypto key, too.

Parameters

[out]	bike_key	BIKE key pointer
[out]	bike_key_len	Length of the key buffer
[in]	sk	BIKE secret key from which the references are obtained

Returns: 0 on success, != 0 on error

◆ lc_bike_sk_size()

LC_PURE unsigned int lc_bike_sk_size ( enum lc_bike_type bike_type )

Return the size of the BIKE secret key.

Parameters

[in] bike_type BIKE type for which the size is requested

Returns: requested size

◆ lc_bike_sk_type()

enum lc_bike_type lc_bike_sk_type ( const struct lc_bike_sk * sk )

Obtain BIKE type from secret key.

Parameters

[in] sk Secret key from which the type is to be obtained

Returns: key type

◆ lc_bike_ss_load()

int lc_bike_ss_load	(	struct lc_bike_ss *	ss,
		const uint8_t *	src_key,
		size_t	src_key_len )

Load a BIKE shared secret provided with a buffer into the leancrypto data structure.

Parameters

[out]	ss	BIKE shared secret to be filled (the caller must have it allocated)
[in]	src_key	Buffer that holds the shared secret to be imported
[in]	src_key_len	Buffer length that holds the shared secret to be imported

Returns: 0 on success or < 0 on error

◆ lc_bike_ss_ptr()

int lc_bike_ss_ptr	(	uint8_t **	bike_ss,
		size_t *	bike_ss_len,
		struct lc_bike_ss *	ss )

Obtain the reference to the BIKE shared secret and its length.

Note: Only pointer references into the leancrypto data structure are returned which implies that any modification will modify the leancrypto shared secret, too.

Parameters

[out]	bike_ss	BIKE shared secret pointer
[out]	bike_ss_len	Length of the shared secret buffer
[in]	ss	BIKE shared secret from which the references are obtained

Returns: 0 on success, != 0 on error

◆ lc_bike_ss_size()

LC_PURE unsigned int lc_bike_ss_size ( enum lc_bike_type bike_type )

Return the size of the BIKE shared secret.

Parameters

[in] bike_type BIKE type for which the size is requested

Returns: requested size

◆ lc_bike_ss_type()

enum lc_bike_type lc_bike_ss_type ( const struct lc_bike_ss * ss )

Obtain BIKE type from shared secret.

Parameters

[in] ss Shared secret key from which the type is to be obtained

Returns: key type

Functions

Detailed Description

Function Documentation

◆ lc_bike_ct_load()

◆ lc_bike_ct_ptr()

◆ lc_bike_ct_size()

◆ lc_bike_ct_type()

◆ lc_bike_dec()

◆ lc_bike_dec_kdf()

◆ lc_bike_enc()

◆ lc_bike_enc_kdf()

◆ lc_bike_keypair()

◆ lc_bike_keypair_from_seed()

◆ lc_bike_pk_load()

◆ lc_bike_pk_ptr()

◆ lc_bike_pk_size()

◆ lc_bike_pk_type()

◆ lc_bike_sk_load()

◆ lc_bike_sk_ptr()

◆ lc_bike_sk_size()

◆ lc_bike_sk_type()

◆ lc_bike_ss_load()

◆ lc_bike_ss_ptr()

◆ lc_bike_ss_size()

◆ lc_bike_ss_type()