nRF Connect SDK API 3.3.99
Loading...
Searching...
No Matches
modem_key_mgmt.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2019 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
5 */
6
7#ifndef MODEM_KEY_MGMT_H__
8#define MODEM_KEY_MGMT_H__
9
10#include <stdbool.h>
11#include <stdint.h>
12
13#include <nrf_socket.h>
14
15#ifdef __cplusplus
16extern "C" {
17#endif
18
27#define MODEM_KEY_MGMT_DIGEST_SIZE (32)
28
37
45 nrf_sec_tag_t sec_tag, enum modem_key_mgmt_cred_type cred_type);
46
70int modem_key_mgmt_write(nrf_sec_tag_t sec_tag,
71 enum modem_key_mgmt_cred_type cred_type,
72 const void *buf, size_t len);
73
91int modem_key_mgmt_delete(nrf_sec_tag_t sec_tag,
92 enum modem_key_mgmt_cred_type cred_type);
93
108int modem_key_mgmt_clear(nrf_sec_tag_t sec_tag);
109
128int modem_key_mgmt_read(nrf_sec_tag_t sec_tag,
129 enum modem_key_mgmt_cred_type cred_type,
130 void *buf, size_t *len);
131
147int modem_key_mgmt_cmp(nrf_sec_tag_t sec_tag,
148 enum modem_key_mgmt_cred_type cred_type,
149 const void *buf, size_t len);
150
164int modem_key_mgmt_digest(nrf_sec_tag_t sec_tag,
165 enum modem_key_mgmt_cred_type cred_type,
166 void *buf, size_t len);
167
180int modem_key_mgmt_exists(nrf_sec_tag_t sec_tag,
181 enum modem_key_mgmt_cred_type cred_type,
182 bool *exists);
183
194
197#ifdef __cplusplus
198}
199#endif
200
201#endif /* MODEM_KEY_MGMT_H__ */
int modem_key_mgmt_write(nrf_sec_tag_t sec_tag, enum modem_key_mgmt_cred_type cred_type, const void *buf, size_t len)
Write or update a credential in persistent storage.
int modem_key_mgmt_read(nrf_sec_tag_t sec_tag, enum modem_key_mgmt_cred_type cred_type, void *buf, size_t *len)
Read a credential from persistent storage.
void(* modem_key_mgmt_list_cb_t)(nrf_sec_tag_t sec_tag, enum modem_key_mgmt_cred_type cred_type)
Credential list entry handler function prototype.
Definition modem_key_mgmt.h:44
int modem_key_mgmt_clear(nrf_sec_tag_t sec_tag)
Delete all credentials for a given sectag from persistent storage.
int modem_key_mgmt_delete(nrf_sec_tag_t sec_tag, enum modem_key_mgmt_cred_type cred_type)
Delete a credential from persistent storage.
int modem_key_mgmt_digest(nrf_sec_tag_t sec_tag, enum modem_key_mgmt_cred_type cred_type, void *buf, size_t len)
Read the SHA-256 digest of a credential from persistent storage.
int modem_key_mgmt_cmp(nrf_sec_tag_t sec_tag, enum modem_key_mgmt_cred_type cred_type, const void *buf, size_t len)
Compare a credential with a credential in persistent storage.
int modem_key_mgmt_exists(nrf_sec_tag_t sec_tag, enum modem_key_mgmt_cred_type cred_type, bool *exists)
Check if a credential exists in persistent storage.
int modem_key_mgmt_list(modem_key_mgmt_list_cb_t list_cb)
List all the available credentials in persistent storage.
modem_key_mgmt_cred_type
Credential types.
Definition modem_key_mgmt.h:30
@ MODEM_KEY_MGMT_CRED_TYPE_PRIVATE_CERT
Definition modem_key_mgmt.h:33
@ MODEM_KEY_MGMT_CRED_TYPE_IDENTITY
Definition modem_key_mgmt.h:35
@ MODEM_KEY_MGMT_CRED_TYPE_CA_CHAIN
Definition modem_key_mgmt.h:31
@ MODEM_KEY_MGMT_CRED_TYPE_PSK
Definition modem_key_mgmt.h:34
@ MODEM_KEY_MGMT_CRED_TYPE_PUBLIC_CERT
Definition modem_key_mgmt.h:32