DTLS sock credentials API

Credential handling for DTLS sock. More...

Detailed Description

Credential handling for DTLS sock.

Files
file	creds.h
	DTLS sock definitions.

Typedefs
typedef credman_tag_t(*	sock_dtls_client_psk_cb_t) (sock_dtls_t *sock, sock_udp_ep_t *ep, credman_tag_t tags[], unsigned tags_len, const char *hint, size_t hint_len)
	Pre-Shared Key client callback. More...
typedef credman_tag_t(*	sock_dtls_rpk_cb_t) (sock_dtls_t *sock, sock_udp_ep_t *ep, credman_tag_t tags[], unsigned tags_len)
	Raw Public Key callback. More...

Functions
int	sock_dtls_set_server_psk_id_hint (sock_dtls_t *sock, const char *hint)
	Sets the PSK Identity hint to be sent to clients during handshake. More...
int	sock_dtls_add_credential (sock_dtls_t *sock, credman_tag_t tag)
	Adds a credential tag to list of available credentials for sock. More...
int	sock_dtls_remove_credential (sock_dtls_t *sock, credman_tag_t tag)
	Removes a credential tag of the list of available credentials for sock. More...
size_t	sock_dtls_get_credentials (sock_dtls_t *sock, const credman_tag_t **out)
	Returns an array of tags of the registered credentials in sock. More...
void	sock_dtls_set_client_psk_cb (sock_dtls_t *sock, sock_dtls_client_psk_cb_t cb)
	Sets the callback function for clients to specify a credential to use for a given connection. More...
void	sock_dtls_set_rpk_cb (sock_dtls_t *sock, sock_dtls_rpk_cb_t cb)
	Sets the callback function to specify a credential to use for a given connection, when using Raw Public Keys. More...
#define	CONFIG_DTLS_CREDENTIALS_MAX   4
	Default buffer size for TLS credential tags.

Typedef Documentation

sock_dtls_client_psk_cb_t

typedef credman_tag_t(* sock_dtls_client_psk_cb_t) (sock_dtls_t *sock, sock_udp_ep_t *ep, credman_tag_t tags[], unsigned tags_len, const char *hint, size_t hint_len)

Pre-Shared Key client callback.

Called during handshake to determine session credential.

Parameters

[in]	sock	DTLS sock object
[in]	ep	Remove UDP endpoint representing the session
[in]	tags	List of credential tags available for sock
[in]	tags_len	Number of credentials in tags
[in]	hint	Hint sent by the server. May be NULL
[in]	hint_len	Length of hint

Returns

Tag of the credential to use when a suitable one is found

Return values

CREDMAN_TAG_EMPTY

otherwise

Definition at line 61 of file creds.h.

sock_dtls_rpk_cb_t

typedef credman_tag_t(* sock_dtls_rpk_cb_t) (sock_dtls_t *sock, sock_udp_ep_t *ep, credman_tag_t tags[], unsigned tags_len)

Raw Public Key callback.

Called during handshake to determine the session credential.

Parameters

[in]	sock	DTLS sock object
[in]	ep	Remote UDP endpoint representing the session
[in]	tags	List of credential tags available for sock
[in]	tags_len	Number of credentials in tags

Returns

Tag of the credential to use when a suitable one is found

Return values

CREDMAN_TAG_EMPTY

otherwise

Definition at line 76 of file creds.h.

Function Documentation

sock_dtls_add_credential()

int sock_dtls_add_credential	(	sock_dtls_t *	sock,
		credman_tag_t	tag
	)

Adds a credential tag to list of available credentials for sock.

Precondition

sock != NULL

Parameters

[in]	sock	DTLS sock object
[in]	tag	Tag of the credential to add

Return values

0	on success
-1	otherwise

sock_dtls_get_credentials()

size_t sock_dtls_get_credentials	(	sock_dtls_t *	sock,
		const credman_tag_t **	out
	)

Returns an array of tags of the registered credentials in sock.

Parameters

[in]	sock	DTLS sock object
[out]	out	Pointer to place the reference to a read-only array of credman_tag_t

Returns

Number of registered credentials

sock_dtls_remove_credential()

int sock_dtls_remove_credential	(	sock_dtls_t *	sock,
		credman_tag_t	tag
	)

Removes a credential tag of the list of available credentials for sock.

Precondition

sock != NULL

Parameters

[in]	sock	DTLS sock object
[in]	tag	Tag of the credential to remove

Return values

0	on success
-1	otherwise

sock_dtls_set_client_psk_cb()

void sock_dtls_set_client_psk_cb	(	sock_dtls_t *	sock,
		sock_dtls_client_psk_cb_t	cb
	)

Sets the callback function for clients to specify a credential to use for a given connection.

Parameters

[in]	sock	The DTLS sock object to set the callback to.
[in]	cb	Callback to set.

sock_dtls_set_rpk_cb()

void sock_dtls_set_rpk_cb	(	sock_dtls_t *	sock,
		sock_dtls_rpk_cb_t	cb
	)

Sets the callback function to specify a credential to use for a given connection, when using Raw Public Keys.

Parameters

[in]	sock	The DTLS sock object to set the callback to.
[in]	cb	Callback to set.

sock_dtls_set_server_psk_id_hint()

int sock_dtls_set_server_psk_id_hint	(	sock_dtls_t *	sock,
		const char *	hint
	)

Sets the PSK Identity hint to be sent to clients during handshake.

This hint is optional. It helps clients to decide which PSK Identity to use.

Parameters

[in,out]	sock	The DTLS sock object to set the hint to.
[in]	hint	PSK Identity hint as NULL-terminated string.

Return values

0	on success
-1	on error