libcoap 4.3.5rc1
Loading...
Searching...
No Matches
coap_notls.c
Go to the documentation of this file.
1/*
2 * coap_notls.c -- Stub Datagram Transport Layer Support for libcoap
3 *
4 * Copyright (C) 2016 Olaf Bergmann <bergmann@tzi.org>
5 * Copyright (C) 2021-2024 Jon Shallow <supjps-libcoap@jpshallow.com>
6 *
7 * SPDX-License-Identifier: BSD-2-Clause
8 *
9 * This file is part of the CoAP library libcoap. Please see README for terms
10 * of use.
11 */
12
19
20#if !defined(COAP_WITH_LIBOPENSSL)
21int
23 (void)conf_mem;
24 return 0;
25}
26
27int
29 return 0;
30}
31#endif /* ! COAP_WITH_LIBOPENSSL */
32
33#if !defined(COAP_WITH_LIBTINYDTLS) && !defined(COAP_WITH_LIBOPENSSL) && !defined(COAP_WITH_LIBWOLFSSL) && !defined(COAP_WITH_LIBGNUTLS) && !defined(COAP_WITH_LIBMBEDTLS)
34
35int
37 return 0;
38}
39
40int
42 return 0;
43}
44
45/*
46 * return 0 failed
47 * 1 passed
48 */
49int
51 return 0;
52}
53
54/*
55 * return 0 failed
56 * 1 passed
57 */
58int
60 return 0;
61}
62
63/*
64 * return 0 failed
65 * 1 passed
66 */
67int
69 return 0;
70}
71
72/*
73 * return 0 failed
74 * 1 passed
75 */
76int
78 return 0;
79}
80
83 static coap_tls_version_t version;
84 version.version = 0;
86 return &version;
87}
88
89int
91 const coap_dtls_pki_t *setup_data COAP_UNUSED,
93 ) {
94 return 0;
95}
96
97int
99 const char *ca_file COAP_UNUSED,
100 const char *ca_path COAP_UNUSED
101 ) {
102 return 0;
103}
104
105#if COAP_CLIENT_SUPPORT
106int
108 coap_dtls_cpsk_t *setup_data COAP_UNUSED
109 ) {
110 return 0;
111}
112#endif /* COAP_CLIENT_SUPPORT */
113
114#if COAP_SERVER_SUPPORT
115int
117 coap_dtls_spsk_t *setup_data COAP_UNUSED
118 ) {
119 return 0;
120}
121#endif /* COAP_SERVER_SUPPORT */
122
123int
127
129
130void
132}
133
134void *
136 coap_tls_library_t *tls_lib) {
137 if (tls_lib)
138 *tls_lib = COAP_TLS_LIBRARY_NOTLS;
139 return NULL;
140}
141
142void
146
147void
151
156
157void *
159 return NULL;
160}
161
162void
165
166#if COAP_SERVER_SUPPORT
167void *
169 return NULL;
170}
171#endif /* COAP_SERVER_SUPPORT */
172
173#if COAP_CLIENT_SUPPORT
174void *
176 return NULL;
177}
178#endif /* COAP_CLIENT_SUPPORT */
179
180void
183
184void
187
188ssize_t
190 const uint8_t *data COAP_UNUSED,
191 size_t data_len COAP_UNUSED) {
192 return -1;
193}
194
195int
197 return 1;
198}
199
202 return 0;
203}
204
209
210/*
211 * return 1 timed out
212 * 0 still timing out
213 */
214int
218
219int
221 const uint8_t *data COAP_UNUSED,
222 size_t data_len COAP_UNUSED
223 ) {
224 return -1;
225}
226
227#if COAP_SERVER_SUPPORT
228int
230 const uint8_t *data COAP_UNUSED,
231 size_t data_len COAP_UNUSED
232 ) {
233 return 0;
234}
235#endif /* COAP_SERVER_SUPPORT */
236
237unsigned int
239 return 0;
240}
241
242#if COAP_CLIENT_SUPPORT
243void *
245 return NULL;
246}
247#endif /* COAP_CLIENT_SUPPORT */
248
249#if COAP_SERVER_SUPPORT
250void *
252 return NULL;
253}
254#endif /* COAP_SERVER_SUPPORT */
255
256void
259
260/*
261 * strm
262 * return +ve Number of bytes written.
263 * -1 Error (error in errno).
264 */
265ssize_t
267 const uint8_t *data COAP_UNUSED,
268 size_t data_len COAP_UNUSED) {
269 return -1;
270}
271
272/*
273 * strm
274 * return >=0 Number of bytes read.
275 * -1 Error (error in errno).
276 */
277ssize_t
279 uint8_t *data COAP_UNUSED,
280 size_t data_len COAP_UNUSED) {
281 return -1;
282}
283
284#if COAP_SERVER_SUPPORT
285typedef struct coap_local_hash_t {
286 size_t ofs;
287 coap_key_t key[8]; /* 32 bytes in total */
288} coap_local_hash_t;
289
291coap_digest_setup(void) {
292 coap_key_t *digest_ctx = coap_malloc_type(COAP_DIGEST_CTX, sizeof(coap_local_hash_t));
293
294 if (digest_ctx) {
295 memset(digest_ctx, 0, sizeof(coap_local_hash_t));
296 }
297
298 return digest_ctx;
299}
300
301void
303 coap_free_type(COAP_DIGEST_CTX, digest_ctx);
304}
305
306int
308 const uint8_t *data,
309 size_t data_len) {
310 coap_local_hash_t *local = (coap_local_hash_t *)digest_ctx;
311
312 coap_hash(data, data_len, local->key[local->ofs]);
313
314 local->ofs = (local->ofs + 1) % 7;
315 return 1;
316}
317
318int
320 coap_digest_t *digest_buffer) {
321 coap_local_hash_t *local = (coap_local_hash_t *)digest_ctx;
322
323 memcpy(digest_buffer, local->key, sizeof(coap_digest_t));
324
325 coap_digest_free(digest_ctx);
326 return 1;
327}
328#endif /* COAP_SERVER_SUPPORT */
329
330#if COAP_WS_SUPPORT
331int
333 const coap_bin_const_t *data,
334 coap_bin_const_t **hash) {
335 SHA1Context sha1_context;
336 coap_binary_t *dummy = NULL;
337
338 (void)alg;
339
340 SHA1Reset(&sha1_context);
341 if (SHA1Input(&sha1_context, data->s, data->length) != shaSuccess)
342 return 0;
344 if (!dummy)
345 return 0;
346 if (SHA1Result(&sha1_context, dummy->s) != shaSuccess) {
348 return 0;
349 }
350 *hash = (coap_bin_const_t *)(dummy);
351 return 1;
352}
353#endif /* COAP_WS_SUPPORT */
354
355#if COAP_OSCORE_SUPPORT
356
357int
359 return 0;
360}
361
362int
364 (void)alg;
365 return 0;
366}
367
368int
370 (void)hkdf_alg;
371 return 0;
372}
373
374int
376 coap_bin_const_t *data,
377 coap_bin_const_t *aad,
378 uint8_t *result,
379 size_t *max_result_len) {
380 (void)params;
381 (void)data;
382 (void)aad;
383 (void)result;
384 *max_result_len = 0;
385 return 0;
386}
387
388int
390 coap_bin_const_t *data,
391 coap_bin_const_t *aad,
392 uint8_t *result,
393 size_t *max_result_len) {
394 (void)params;
395 (void)data;
396 (void)aad;
397 (void)result;
398 *max_result_len = 0;
399 return 0;
400}
401
402int
404 coap_bin_const_t *key,
405 coap_bin_const_t *data,
406 coap_bin_const_t **hmac) {
407 (void)hmac_alg;
408 (void)key;
409 (void)data;
410 (void)hmac;
411 return 0;
412}
413
414#endif /* COAP_OSCORE_SUPPORT */
415
416#else /* !COAP_WITH_LIBTINYDTLS && !COAP_WITH_LIBOPENSSL && !COAP_WITH_LIBWOLFSSL && !COAP_WITH_LIBGNUTLS */
417
418#ifdef __clang__
419/* Make compilers happy that do not like empty modules. As this function is
420 * never used, we ignore -Wunused-function at the end of compiling this file
421 */
422#pragma GCC diagnostic ignored "-Wunused-function"
423#endif
424static inline void
425dummy(void) {
426}
427
428#endif /* !COAP_WITH_LIBTINYDTLS && !COAP_WITH_LIBOPENSSL && !COAP_WITH_LIBWOLFSSL && !COAP_WITH_LIBGNUTLS && !COAP_WITH_LIBMBEDTLS */
static void dummy(void)
unsigned char coap_key_t[4]
#define coap_hash(String, Length, Result)
Library specific build wrapper for coap_internal.h.
@ COAP_DIGEST_CTX
Definition coap_mem.h:57
void * coap_malloc_type(coap_memory_tag_t type, size_t size)
Allocates a chunk of size bytes and returns a pointer to the newly allocated memory.
void coap_free_type(coap_memory_tag_t type, void *p)
Releases the memory that was allocated by coap_malloc_type().
int coap_dtls_context_set_pki(coap_context_t *ctx COAP_UNUSED, const coap_dtls_pki_t *setup_data COAP_UNUSED, const coap_dtls_role_t role COAP_UNUSED)
Definition coap_notls.c:90
coap_tick_t coap_dtls_get_timeout(coap_session_t *session COAP_UNUSED, coap_tick_t now COAP_UNUSED)
Definition coap_notls.c:206
ssize_t coap_tls_read(coap_session_t *session COAP_UNUSED, uint8_t *data COAP_UNUSED, size_t data_len COAP_UNUSED)
Definition coap_notls.c:278
coap_tick_t coap_dtls_get_context_timeout(void *dtls_context COAP_UNUSED)
Definition coap_notls.c:201
int coap_dtls_receive(coap_session_t *session COAP_UNUSED, const uint8_t *data COAP_UNUSED, size_t data_len COAP_UNUSED)
Definition coap_notls.c:220
void * coap_dtls_get_tls(const coap_session_t *c_session COAP_UNUSED, coap_tls_library_t *tls_lib)
Definition coap_notls.c:135
unsigned int coap_dtls_get_overhead(coap_session_t *session COAP_UNUSED)
Definition coap_notls.c:238
static coap_log_t dtls_log_level
Definition coap_notls.c:128
int coap_dtls_context_check_keys_enabled(coap_context_t *ctx COAP_UNUSED)
Definition coap_notls.c:124
ssize_t coap_dtls_send(coap_session_t *session COAP_UNUSED, const uint8_t *data COAP_UNUSED, size_t data_len COAP_UNUSED)
Definition coap_notls.c:189
ssize_t coap_tls_write(coap_session_t *session COAP_UNUSED, const uint8_t *data COAP_UNUSED, size_t data_len COAP_UNUSED)
Definition coap_notls.c:266
void coap_dtls_session_update_mtu(coap_session_t *session COAP_UNUSED)
Definition coap_notls.c:185
int coap_dtls_context_set_pki_root_cas(coap_context_t *ctx COAP_UNUSED, const char *ca_file COAP_UNUSED, const char *ca_path COAP_UNUSED)
Definition coap_notls.c:98
int coap_dtls_handle_timeout(coap_session_t *session COAP_UNUSED)
Definition coap_notls.c:215
void coap_dtls_free_context(void *handle COAP_UNUSED)
Definition coap_notls.c:163
void coap_dtls_free_session(coap_session_t *coap_session COAP_UNUSED)
Definition coap_notls.c:181
void * coap_dtls_new_context(coap_context_t *coap_context COAP_UNUSED)
Definition coap_notls.c:158
void coap_tls_free_session(coap_session_t *coap_session COAP_UNUSED)
Definition coap_notls.c:257
int SHA1Result(SHA1Context *, uint8_t Message_Digest[SHA1HashSize])
int SHA1Reset(SHA1Context *)
int SHA1Input(SHA1Context *, const uint8_t *, unsigned int)
@ shaSuccess
#define SHA1HashSize
void coap_digest_free(coap_digest_ctx_t *digest_ctx)
Free off coap_digest_ctx_t.
int coap_digest_final(coap_digest_ctx_t *digest_ctx, coap_digest_t *digest_buffer)
Finalize the coap_digest information into the provided digest_buffer.
int coap_digest_update(coap_digest_ctx_t *digest_ctx, const uint8_t *data, size_t data_len)
Update the coap_digest information with the next chunk of data.
void coap_digest_ctx_t
coap_digest_ctx_t * coap_digest_setup(void)
Initialize a coap_digest.
uint64_t coap_tick_t
This data type represents internal timer ticks with COAP_TICKS_PER_SECOND resolution.
Definition coap_time.h:143
int coap_crypto_hmac(cose_hmac_alg_t hmac_alg, coap_bin_const_t *key, coap_bin_const_t *data, coap_bin_const_t **hmac)
Create a HMAC hash of the provided data.
int coap_crypto_aead_decrypt(const coap_crypto_param_t *params, coap_bin_const_t *data, coap_bin_const_t *aad, uint8_t *result, size_t *max_result_len)
Decrypt the provided encrypted data into plaintext.
int coap_crypto_aead_encrypt(const coap_crypto_param_t *params, coap_bin_const_t *data, coap_bin_const_t *aad, uint8_t *result, size_t *max_result_len)
Encrypt the provided plaintext data.
int coap_crypto_hash(cose_alg_t alg, const coap_bin_const_t *data, coap_bin_const_t **hash)
Create a hash of the provided data.
int coap_crypto_check_hkdf_alg(cose_hkdf_alg_t hkdf_alg)
Check whether the defined hkdf algorithm is supported by the underlying crypto library.
int coap_crypto_check_cipher_alg(cose_alg_t alg)
Check whether the defined cipher algorithm is supported by the underlying crypto library.
void * coap_tls_new_server_session(coap_session_t *coap_session)
Create a TLS new server-side session.
void coap_dtls_startup(void)
Initialize the underlying (D)TLS Library layer.
Definition coap_notls.c:131
void * coap_dtls_new_client_session(coap_session_t *coap_session)
Create a new client-side session.
void * coap_dtls_new_server_session(coap_session_t *coap_session)
Create a new DTLS server-side session.
int coap_dtls_hello(coap_session_t *coap_session, const uint8_t *data, size_t data_len)
Handling client HELLO messages from a new candiate peer.
int coap_dtls_is_context_timeout(void)
Check if timeout is handled per CoAP session or per CoAP context.
Definition coap_notls.c:196
int coap_dtls_context_set_cpsk(coap_context_t *coap_context, coap_dtls_cpsk_t *setup_data)
Set the DTLS context's default client PSK information.
int coap_dtls_context_set_spsk(coap_context_t *coap_context, coap_dtls_spsk_t *setup_data)
Set the DTLS context's default server PSK information.
void coap_dtls_shutdown(void)
Close down the underlying (D)TLS Library layer.
Definition coap_notls.c:143
void * coap_tls_new_client_session(coap_session_t *coap_session)
Create a new TLS client-side session.
int coap_tls_engine_configure(coap_str_const_t *conf_mem)
Configure an ENGINE for a TLS library.
Definition coap_notls.c:22
coap_tls_version_t * coap_get_tls_library_version(void)
Determine the type and version of the underlying (D)TLS library.
Definition coap_notls.c:82
int coap_dtls_psk_is_supported(void)
Check whether (D)TLS PSK is available.
Definition coap_notls.c:50
coap_dtls_role_t
Definition coap_dtls.h:44
int coap_tls_is_supported(void)
Check whether TLS is available.
Definition coap_notls.c:41
int coap_tls_engine_remove(void)
Remove a previously configured ENGINE from a TLS library.
Definition coap_notls.c:28
int coap_dtls_is_supported(void)
Check whether DTLS is available.
Definition coap_notls.c:36
int coap_dtls_pki_is_supported(void)
Check whether (D)TLS PKI is available.
Definition coap_notls.c:59
int coap_dtls_rpk_is_supported(void)
Check whether (D)TLS RPK is available.
Definition coap_notls.c:77
coap_tls_library_t
Definition coap_dtls.h:112
int coap_dtls_pkcs11_is_supported(void)
Check whether (D)TLS PKCS11 is available.
Definition coap_notls.c:68
@ COAP_TLS_LIBRARY_NOTLS
No DTLS library.
Definition coap_dtls.h:113
coap_log_t
Logging type.
Definition coap_debug.h:50
coap_log_t coap_dtls_get_log_level(void)
Get the current (D)TLS logging.
Definition coap_notls.c:153
void coap_dtls_set_log_level(coap_log_t level)
Sets the (D)TLS logging level to the specified level.
Definition coap_notls.c:148
@ COAP_LOG_EMERG
Definition coap_debug.h:51
cose_hkdf_alg_t
cose_hmac_alg_t
cose_alg_t
int coap_oscore_is_supported(void)
Check whether OSCORE is available.
coap_binary_t * coap_new_binary(size_t size)
Returns a new binary object with at least size bytes storage allocated.
Definition coap_str.c:77
void coap_delete_binary(coap_binary_t *s)
Deletes the given coap_binary_t object and releases any memory allocated.
Definition coap_str.c:105
#define COAP_UNUSED
Definition libcoap.h:70
CoAP binary data definition with const data.
Definition coap_str.h:64
size_t length
length of binary data
Definition coap_str.h:65
const uint8_t * s
read-only binary data
Definition coap_str.h:66
CoAP binary data definition.
Definition coap_str.h:56
The CoAP stack's global state is stored in a coap_context_t object.
The common structure that holds the Crypto information.
The structure used for defining the Client PSK setup data to be used.
Definition coap_dtls.h:448
The structure used for defining the PKI setup data to be used.
Definition coap_dtls.h:354
The structure used for defining the Server PSK setup data to be used.
Definition coap_dtls.h:535
Abstraction of virtual session that can be attached to coap_context_t (client) or coap_endpoint_t (se...
CoAP string data definition with const data.
Definition coap_str.h:46
The structure used for returning the underlying (D)TLS library information.
Definition coap_dtls.h:125
coap_tls_library_t type
Library type.
Definition coap_dtls.h:127
uint64_t version
(D)TLS runtime Library Version
Definition coap_dtls.h:126