mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2025-01-18 12:52:44 +01:00
104 lines
2.5 KiB
C
104 lines
2.5 KiB
C
/*
|
|
* Copyright (C) 2021 HAW Hamburg
|
|
*
|
|
* This file is subject to the terms and conditions of the GNU Lesser
|
|
* General Public License v2.1. See the file LICENSE in the top level
|
|
* directory for more details.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup net_sock_dtls_creds DTLS sock credentials API
|
|
* @ingroup net_sock_dtls
|
|
* @brief Credential handling for DTLS sock
|
|
* @{
|
|
*
|
|
* @file
|
|
* @brief DTLS sock definitions
|
|
*
|
|
* @author Leandro Lanzieri <leandro.lanzieri@haw-hamburg.de>
|
|
*/
|
|
|
|
#ifndef NET_SOCK_DTLS_CREDS_H
|
|
#define NET_SOCK_DTLS_CREDS_H
|
|
|
|
#include "net/sock/udp.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @ingroup net_sock_dtls_conf
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Default maximum size for the PSK Identity hint string
|
|
*/
|
|
#ifndef CONFIG_DTLS_PSK_ID_HINT_MAX_SIZE
|
|
#define CONFIG_DTLS_PSK_ID_HINT_MAX_SIZE 32
|
|
#endif
|
|
|
|
/**
|
|
* @brief Default buffer size for TLS credential tags
|
|
*/
|
|
#ifndef CONFIG_DTLS_CREDENTIALS_MAX
|
|
#define CONFIG_DTLS_CREDENTIALS_MAX 4
|
|
#endif
|
|
/** @} */
|
|
|
|
/**
|
|
* @brief 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.
|
|
*
|
|
* @param[in, out] sock The DTLS sock object to set the hint to.
|
|
* @param[in] hint PSK Identity hint as NULL-terminated string.
|
|
*
|
|
* @retval 0 on success
|
|
* @retval -1 on error
|
|
*/
|
|
int sock_dtls_set_server_psk_id_hint(sock_dtls_t *sock, const char *hint);
|
|
|
|
/**
|
|
* @brief Adds a credential tag to list of available credentials for @p sock.
|
|
*
|
|
* @pre sock != NULL
|
|
*
|
|
* @param[in] sock DTLS sock object
|
|
* @param[in] tag Tag of the credential to add
|
|
*
|
|
* @retval 0 on success
|
|
* @retval -1 otherwise
|
|
*/
|
|
int sock_dtls_add_credential(sock_dtls_t *sock, credman_tag_t tag);
|
|
|
|
/**
|
|
* @brief Removes a credential tag of the list of available credentials for @p sock.
|
|
*
|
|
* @pre sock != NULL
|
|
*
|
|
* @param[in] sock DTLS sock object
|
|
* @param[in] tag Tag of the credential to remove
|
|
*
|
|
* @retval 0 on success
|
|
* @retval -1 otherwise
|
|
*/
|
|
int sock_dtls_remove_credential(sock_dtls_t *sock, credman_tag_t tag);
|
|
|
|
/**
|
|
* @brief Returns an array of tags of the registered credentials in @p sock.
|
|
*
|
|
* @param[in] sock DTLS sock object
|
|
* @param[out] out Pointer to place the reference to a read-only array of @ref credman_tag_t
|
|
*
|
|
* @return Number of registered credentials
|
|
*/
|
|
size_t sock_dtls_get_credentials(sock_dtls_t *sock, const credman_tag_t **out);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* NET_SOCK_DTLS_CREDS_H */
|
|
/** @} */
|