ptpmgmt_spp_t Struct Reference

#include <cfg.h>

Public Attributes
void(*	free )(ptpmgmt_spp spp)
bool(*	addKey )(ptpmgmt_spp spp, uint32_t id, enum PTPMGMT_HMAC_t type, const void *value, size_t size, size_t digest, bool replace)
bool(*	have )(const_ptpmgmt_spp spp, uint32_t key)
size_t(*	mac_size )(const_ptpmgmt_spp spp, uint32_t key)
const void *(*	key )(const_ptpmgmt_spp spp, uint32_t key)
size_t(*	key_size )(const_ptpmgmt_spp spp, uint32_t key)
size_t(*	keys )(const_ptpmgmt_spp spp)
enum PTPMGMT_HMAC_t(*	htype )(const_ptpmgmt_spp spp, uint32_t key)
uint8_t(*	ownID )(const_ptpmgmt_spp spp)

Detailed Description

The ptpmgmt spp structure hold a authentication security parameters object and call backs to call C++ methods

Member Data Documentation

addKey

bool(* ptpmgmt_spp_t::addKey) (ptpmgmt_spp spp, uint32_t id, enum PTPMGMT_HMAC_t type, const void *value, size_t size, size_t digest, bool replace)

Set a new key

Parameters

[in,out]	spp	authentication security parameters object
[in]	id	id the Key
[in]	type	of the key
[in]	value	of the key
[in]	size	of the key
[in]	digest	size to use with the key
[in]	replace	an existing key if exist

Returns

true, if new key is valid

free

void(* ptpmgmt_spp_t::free) (ptpmgmt_spp spp)

< Free a authentication security parameters object

Parameters

[in,out]

spp

authentication security parameters object

have

bool(* ptpmgmt_spp_t::have) (const_ptpmgmt_spp spp, uint32_t key)

Verify key exist

Parameters

[in]	spp	authentication security parameters object
[in]	key	ID

Returns

true if key exist

htype

enum PTPMGMT_HMAC_t(* ptpmgmt_spp_t::htype) (const_ptpmgmt_spp spp, uint32_t key)

Get key type

Parameters

[in]	spp	authentication security parameters object
[in]	key	ID

Returns

Key type

key

const void *(* ptpmgmt_spp_t::key) (const_ptpmgmt_spp spp, uint32_t key)

Get key

Parameters

[in]	spp	authentication security parameters object
[in]	key	ID

Returns

Key or nullptr if key does not exist

key_size

size_t(* ptpmgmt_spp_t::key_size) (const_ptpmgmt_spp spp, uint32_t key)

Get key size

Parameters

[in]	spp	authentication security parameters object
[in]	key	ID

Returns

Key size or zero if key does not exist

keys

size_t(* ptpmgmt_spp_t::keys) (const_ptpmgmt_spp spp)

Get number of keys

Parameters

[in]	spp	authentication security parameters object
[in]	key	ID

Returns

Key or empty binary if key does not exist

mac_size

size_t(* ptpmgmt_spp_t::mac_size) (const_ptpmgmt_spp spp, uint32_t key)

Get MAC digest size to use with the key

Parameters

[in]	spp	authentication security parameters object
[in]	key	ID

Returns

MAC digest size or 0 if the key does not exist

ownID

uint8_t(* ptpmgmt_spp_t::ownID) (const_ptpmgmt_spp spp)

Return own SPP ID

Parameters

[in]

spp

authentication security parameters object

Returns

own SPP ID

---

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

• pub/c/cfg.h