A descriptor of encryption method and key to be used in container. More...

#include <Recipient.h>

Public Types
enum	Type : uint8_t { NONE , SYMMETRIC_KEY , PUBLIC_KEY }
	The recipient type. More...

Public Member Functions
	Recipient ()=default
bool	isEmpty () const
	test whether the Recipient structure is initialized
bool	isSymmetric () const
	check whether Recipient is based on symmetric key
bool	isPKI () const
	check whether Recipient is based on public key
bool	isCertificate () const
	check whether Recipient is based on certificate
bool	isKeyServer () const
	check whether Recipient is keyserver
void	clear ()
	Clear all values and set type to NONE.
bool	isTheSameRecipient (const Recipient &other) const
	A convenience method to check whether two recipients are both public key based and have the same keys.
bool	isTheSameRecipient (const std::vector< uint8_t > &public_key) const
	A convenience method to check whether a recipient is public key based and has the given keys.
std::string	getLabel (std::map< std::string_view, std::string_view > extra) const
	Get the label for this recipient.
void	setLabelValue (std::string_view key, std::string_view value)
	Set a property for automatic label generation.
bool	validate () const
	Validate recipient record.
bool	operator== (const Recipient &other) const =default

Static Public Member Functions
static Recipient	makeSymmetric (std::string label, int32_t kdf_iter)
	Create a new symmetric key based Recipient.
static Recipient	makePublicKey (std::string label, std::vector< uint8_t > public_key, PKType pk_type)
	Create a new public key based Recipient.
static Recipient	makePublicKey (const Lock &lock)
	Create a new public key based Recipient.
static Recipient	makeCertificate (std::string label, std::vector< uint8_t > cert)
	Create a new certificate based Recipient.
static Recipient	makeServer (std::string label, std::vector< uint8_t > public_key, PKType pk_type, std::string server_id)
	Create a new capsule server based Recipient If the label is empty, a machine-readable label text (public key version) is automatically generated according to CDoc2 specification.
static Recipient	makeServer (std::string label, std::vector< uint8_t > cert, std::string server_id)
	Create a new capsule server based Recipient If the label is empty, a machine-readable label text (either eID or certificate version) is automatically generated according to CDoc2 specification.
static Recipient	makeServer (const Lock &lock, std::string server_id)
	Create a new capsule server based Recipient.

Public Attributes
Type	type = Type::NONE
	The recipient type.
PKType	pk_type = PKType::ECC
	The public key type.
int32_t	kdf_iter = 0
	The number of iterations for PBKDF. Value 0 means directly provided symmetric key.
std::string	label
	The recipient's label (if empty the lock label will be autogenerated).
std::vector< uint8_t >	rcpt_key
	Recipient's public key (for all PKI types).
std::vector< uint8_t >	cert
	The recipient's certificate (if present).
std::string	server_id
	The keyserver or share server list id (if present).
uint64_t	expiry_ts = 0
	The requested capsule expiry timestamp (0 - use server default).

Protected Member Functions
	Recipient (Type _type)

Detailed Description

A descriptor of encryption method and key to be used in container.

Recipient determines all the relevant properties to encrypt the FMK for a certain target.

Member Enumeration Documentation

◆ Type

enum libcdoc::Recipient::Type : uint8_t

The recipient type.

Enumerator
NONE	Uninitialized recipient
SYMMETRIC_KEY	Symmetric key (or password).
PUBLIC_KEY	Public key.

Constructor & Destructor Documentation

◆ Recipient() [1/2]

libcdoc::Recipient::Recipient ( )

default

Referenced by isTheSameRecipient(), makeCertificate(), makePublicKey(), makePublicKey(), makeServer(), makeServer(), makeServer(), makeSymmetric(), and operator==().

◆ Recipient() [2/2]

libcdoc::Recipient::Recipient ( Type _type )

inlineprotected

References type.

Member Function Documentation

◆ clear()

void libcdoc::Recipient::clear ( )

inline

Clear all values and set type to NONE.

References cert, libcdoc::ECC, kdf_iter, label, NONE, pk_type, rcpt_key, and type.

◆ getLabel()

std::string libcdoc::Recipient::getLabel ( std::map< std::string_view, std::string_view > extra ) const

Get the label for this recipient.

Either returns user-specified label or generate machine-readable if empty

Parameters

extra additional parameter values to use

Returns: a label value

◆ isCertificate()

bool libcdoc::Recipient::isCertificate ( ) const

inline

check whether Recipient is based on certificate

Returns: true if type is CERTIFICATE

References cert, PUBLIC_KEY, and type.

◆ isEmpty()

bool libcdoc::Recipient::isEmpty ( ) const

inline

test whether the Recipient structure is initialized

Returns: true if not initialized

References NONE, and type.

◆ isKeyServer()

bool libcdoc::Recipient::isKeyServer ( ) const

inline

check whether Recipient is keyserver

Returns: true if type is SERVER

References PUBLIC_KEY, server_id, and type.

◆ isPKI()

bool libcdoc::Recipient::isPKI ( ) const

inline

check whether Recipient is based on public key

Returns: true if type is CERTIFICATE, PUBLIC_KEY or SERVER

References PUBLIC_KEY, and type.

◆ isSymmetric()

bool libcdoc::Recipient::isSymmetric ( ) const

inline

check whether Recipient is based on symmetric key

Returns: true if type is SYMMETRIC_KEY

References SYMMETRIC_KEY, and type.

◆ isTheSameRecipient() [1/2]

bool libcdoc::Recipient::isTheSameRecipient ( const Recipient & other ) const

A convenience method to check whether two recipients are both public key based and have the same keys.

Parameters

other another Recipient

Returns: true if the public keys are identical

References Recipient().

◆ isTheSameRecipient() [2/2]

bool libcdoc::Recipient::isTheSameRecipient ( const std::vector< uint8_t > & public_key ) const

A convenience method to check whether a recipient is public key based and has the given keys.

Parameters

public_key a public key to test

Returns: true if the public keys are identical

◆ makeCertificate()

Recipient libcdoc::Recipient::makeCertificate	(	std::string	label,
		std::vector< uint8_t >	cert )

static

Create a new certificate based Recipient.

Parameters

label	the label text
cert	the certificate value (der-encoded)

Returns: a new Recipient structure

References cert, label, and Recipient().

◆ makePublicKey() [1/2]

Recipient libcdoc::Recipient::makePublicKey ( const Lock & lock )

static

Create a new public key based Recipient.

Parameters

lock	Lock to derive parameters from

Returns: a new Recipient structure

References Recipient().

◆ makePublicKey() [2/2]

Recipient libcdoc::Recipient::makePublicKey	(	std::string	label,
		std::vector< uint8_t >	public_key,
		PKType	pk_type )

static

Create a new public key based Recipient.

Parameters

label	the label text
public_key	the public key value
pk_type	the algorithm type (either ECC or RSA)

Returns: a new Recipient structure

References label, pk_type, and Recipient().

◆ makeServer() [1/3]

Recipient libcdoc::Recipient::makeServer	(	const Lock &	lock,
		std::string	server_id )

static

Create a new capsule server based Recipient.

Parameters

lock	Lock to derive parameters from
server_id	the keyserver id

Returns: a new Recipient structure

References label, Recipient(), and server_id.

◆ makeServer() [2/3]

Recipient libcdoc::Recipient::makeServer	(	std::string	label,
		std::vector< uint8_t >	cert,
		std::string	server_id )

static

Create a new capsule server based Recipient If the label is empty, a machine-readable label text (either eID or certificate version) is automatically generated according to CDoc2 specification.

Parameters

label	the label text
cert	the recipient's certificate (der-encoded)
server_id	the keyserver id

Returns: a new Recipient structure

References cert, label, Recipient(), and server_id.

◆ makeServer() [3/3]

Recipient libcdoc::Recipient::makeServer	(	std::string	label,
		std::vector< uint8_t >	public_key,
		PKType	pk_type,
		std::string	server_id )

static

Create a new capsule server based Recipient If the label is empty, a machine-readable label text (public key version) is automatically generated according to CDoc2 specification.

Parameters

label	the label text
public_key	the public key value
pk_type	the algorithm type (either ECC or RSA)
server_id	the keyserver id

Returns: a new Recipient structure

References label, pk_type, Recipient(), and server_id.

◆ makeSymmetric()

Recipient libcdoc::Recipient::makeSymmetric	(	std::string	label,
		int32_t	kdf_iter )

static

Create a new symmetric key based Recipient.

Parameters

label	the label text
kdf_iter	the number of PBKDF iterations (0 if full key is provided)

Returns: a new Recipient structure

References kdf_iter, label, and Recipient().

◆ operator==()

bool libcdoc::Recipient::operator== ( const Recipient & other ) const

default

References Recipient().

◆ setLabelValue()

void libcdoc::Recipient::setLabelValue	(	std::string_view	key,
		std::string_view	value )

inline

Set a property for automatic label generation.

Parameters

key	the property name
value	the property value

◆ validate()

bool libcdoc::Recipient::validate ( ) const

Validate recipient record.

Returns: true if Recipient is valid

Member Data Documentation

◆ cert

std::vector<uint8_t> libcdoc::Recipient::cert

The recipient's certificate (if present).

Referenced by clear(), isCertificate(), makeCertificate(), and makeServer().

◆ expiry_ts

uint64_t libcdoc::Recipient::expiry_ts = 0

The requested capsule expiry timestamp (0 - use server default).

◆ kdf_iter

int32_t libcdoc::Recipient::kdf_iter = 0

The number of iterations for PBKDF. Value 0 means directly provided symmetric key.

Referenced by clear(), and makeSymmetric().

◆ label

std::string libcdoc::Recipient::label

The recipient's label (if empty the lock label will be autogenerated).

Referenced by clear(), makeCertificate(), makePublicKey(), makeServer(), makeServer(), makeServer(), and makeSymmetric().

◆ pk_type

PKType libcdoc::Recipient::pk_type = PKType::ECC

The public key type.

Referenced by clear(), makePublicKey(), and makeServer().

◆ rcpt_key

std::vector<uint8_t> libcdoc::Recipient::rcpt_key

Recipient's public key (for all PKI types).

Referenced by clear().

◆ server_id

std::string libcdoc::Recipient::server_id

The keyserver or share server list id (if present).

Referenced by isKeyServer(), makeServer(), makeServer(), and makeServer().

◆ type

Type libcdoc::Recipient::type = Type::NONE

The recipient type.

Referenced by clear(), isCertificate(), isEmpty(), isKeyServer(), isPKI(), isSymmetric(), and Recipient().

The documentation for this struct was generated from the following file:

Recipient.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ Recipient() [1/2]

◆ Recipient() [2/2]

Member Function Documentation

◆ clear()

◆ getLabel()

◆ isCertificate()

◆ isEmpty()

◆ isKeyServer()

◆ isPKI()

◆ isSymmetric()

◆ isTheSameRecipient() [1/2]

◆ isTheSameRecipient() [2/2]

◆ makeCertificate()

◆ makePublicKey() [1/2]

◆ makePublicKey() [2/2]

◆ makeServer() [1/3]

◆ makeServer() [2/3]

◆ makeServer() [3/3]

◆ makeSymmetric()

◆ operator==()

◆ setLabelValue()

◆ validate()

Member Data Documentation

◆ cert

◆ expiry_ts

◆ kdf_iter

◆ label

◆ pk_type

◆ rcpt_key

◆ server_id

◆ type