Mbed TLS v4.1.1
Loading...
Searching...
No Matches
platform.h
Go to the documentation of this file.
1
22/*
23 * Copyright The Mbed TLS Contributors
24 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
25 */
26#ifndef MBEDTLS_PLATFORM_H
27#define MBEDTLS_PLATFORM_H
28#include "mbedtls/private_access.h"
29
31
32#if defined(MBEDTLS_HAVE_TIME)
34#endif
35
37
38#ifdef __cplusplus
39extern "C" {
40#endif
41
49
50#if !defined(MBEDTLS_PLATFORM_NO_STD_FUNCTIONS)
51#include <stdio.h>
52#include <stdlib.h>
53#if defined(MBEDTLS_HAVE_TIME)
54#include <time.h>
55#endif
56#if !defined(MBEDTLS_PLATFORM_STD_SNPRINTF)
57#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf
58#endif
59#if !defined(MBEDTLS_PLATFORM_STD_VSNPRINTF)
60#define MBEDTLS_PLATFORM_STD_VSNPRINTF vsnprintf
61#endif
62#if !defined(MBEDTLS_PLATFORM_STD_PRINTF)
63#define MBEDTLS_PLATFORM_STD_PRINTF printf
64#endif
65#if !defined(MBEDTLS_PLATFORM_STD_FPRINTF)
66#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf
67#endif
68#if !defined(MBEDTLS_PLATFORM_STD_CALLOC)
69#define MBEDTLS_PLATFORM_STD_CALLOC calloc
70#endif
71#if !defined(MBEDTLS_PLATFORM_STD_FREE)
72#define MBEDTLS_PLATFORM_STD_FREE free
73#endif
74#if !defined(MBEDTLS_PLATFORM_STD_SETBUF)
75#define MBEDTLS_PLATFORM_STD_SETBUF setbuf
76#endif
77#if !defined(MBEDTLS_PLATFORM_STD_EXIT)
78#define MBEDTLS_PLATFORM_STD_EXIT exit
79#endif
80#if !defined(MBEDTLS_PLATFORM_STD_TIME)
81#define MBEDTLS_PLATFORM_STD_TIME time
82#endif
83#if !defined(MBEDTLS_PLATFORM_STD_EXIT_SUCCESS)
84#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS EXIT_SUCCESS
85#endif
86#if !defined(MBEDTLS_PLATFORM_STD_EXIT_FAILURE)
87#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE EXIT_FAILURE
88#endif
89#if defined(MBEDTLS_FS_IO)
90#if !defined(MBEDTLS_PLATFORM_STD_NV_SEED_READ)
91#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read
92#endif
93#if !defined(MBEDTLS_PLATFORM_STD_NV_SEED_WRITE)
94#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write
95#endif
96#if !defined(MBEDTLS_PLATFORM_STD_NV_SEED_FILE)
97#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile"
98#endif
99#endif /* MBEDTLS_FS_IO */
100#else /* MBEDTLS_PLATFORM_NO_STD_FUNCTIONS */
101#if defined(MBEDTLS_PLATFORM_STD_MEM_HDR)
102#include MBEDTLS_PLATFORM_STD_MEM_HDR
103#endif
104#endif /* MBEDTLS_PLATFORM_NO_STD_FUNCTIONS */
105
106/* Enable certain documented defines only when generating doxygen to avoid
107 * an "unrecognized define" error. */
108#if defined(__DOXYGEN__) && !defined(MBEDTLS_PLATFORM_STD_CALLOC)
109#define MBEDTLS_PLATFORM_STD_CALLOC
110#endif
111
112#if defined(__DOXYGEN__) && !defined(MBEDTLS_PLATFORM_STD_FREE)
113#define MBEDTLS_PLATFORM_STD_FREE
114#endif
115
117
118/*
119 * The function pointers for calloc and free.
120 * Please see MBEDTLS_PLATFORM_STD_CALLOC and MBEDTLS_PLATFORM_STD_FREE
121 * in mbedtls_config.h for more information about behaviour and requirements.
122 */
123#if defined(MBEDTLS_PLATFORM_MEMORY)
124#if defined(MBEDTLS_PLATFORM_FREE_MACRO) && \
125 defined(MBEDTLS_PLATFORM_CALLOC_MACRO)
126#undef mbedtls_free
127#undef mbedtls_calloc
128#define mbedtls_free MBEDTLS_PLATFORM_FREE_MACRO
129#define mbedtls_calloc MBEDTLS_PLATFORM_CALLOC_MACRO
130#else
131/* For size_t */
132#include <stddef.h>
133extern void *mbedtls_calloc(size_t n, size_t size);
134extern void mbedtls_free(void *ptr);
135
145int mbedtls_platform_set_calloc_free(void *(*calloc_func)(size_t, size_t),
146 void (*free_func)(void *));
147#endif /* MBEDTLS_PLATFORM_FREE_MACRO && MBEDTLS_PLATFORM_CALLOC_MACRO */
148#else /* !MBEDTLS_PLATFORM_MEMORY */
149#undef mbedtls_free
150#undef mbedtls_calloc
151#define mbedtls_free free
152#define mbedtls_calloc calloc
153#endif /* MBEDTLS_PLATFORM_MEMORY && !MBEDTLS_PLATFORM_{FREE,CALLOC}_MACRO */
154
155/*
156 * The function pointers for fprintf
157 */
158#if defined(MBEDTLS_PLATFORM_FPRINTF_ALT)
159/* We need FILE * */
160#include <stdio.h>
161extern int (*mbedtls_fprintf)(FILE *stream, const char *format, ...);
162
172int mbedtls_platform_set_fprintf(int (*fprintf_func)(FILE *stream, const char *,
173 ...));
174#else
175#undef mbedtls_fprintf
176#if defined(MBEDTLS_PLATFORM_FPRINTF_MACRO)
177#define mbedtls_fprintf MBEDTLS_PLATFORM_FPRINTF_MACRO
178#else
179#define mbedtls_fprintf fprintf
180#endif /* MBEDTLS_PLATFORM_FPRINTF_MACRO */
181#endif /* MBEDTLS_PLATFORM_FPRINTF_ALT */
182
183/*
184 * The function pointers for printf
185 */
186#if defined(MBEDTLS_PLATFORM_PRINTF_ALT)
187extern int (*mbedtls_printf)(const char *format, ...);
188
208int mbedtls_platform_set_printf(int (*printf_func)(const char *, ...));
209#else /* !MBEDTLS_PLATFORM_PRINTF_ALT */
210#undef mbedtls_printf
211#if defined(MBEDTLS_PLATFORM_PRINTF_MACRO)
212#define mbedtls_printf MBEDTLS_PLATFORM_PRINTF_MACRO
213#else
214#define mbedtls_printf printf
215#endif /* MBEDTLS_PLATFORM_PRINTF_MACRO */
216#endif /* MBEDTLS_PLATFORM_PRINTF_ALT */
217
218#if defined(MBEDTLS_PLATFORM_SNPRINTF_ALT)
219extern int (*mbedtls_snprintf)(char *s, size_t n, const char *format, ...);
220
229int mbedtls_platform_set_snprintf(int (*snprintf_func)(char *s, size_t n,
230 const char *format, ...));
231#else /* MBEDTLS_PLATFORM_SNPRINTF_ALT */
232#undef mbedtls_snprintf
233#if defined(MBEDTLS_PLATFORM_SNPRINTF_MACRO)
234#define mbedtls_snprintf MBEDTLS_PLATFORM_SNPRINTF_MACRO
235#else
236#define mbedtls_snprintf MBEDTLS_PLATFORM_STD_SNPRINTF
237#endif /* MBEDTLS_PLATFORM_SNPRINTF_MACRO */
238#endif /* MBEDTLS_PLATFORM_SNPRINTF_ALT */
239
240#if defined(MBEDTLS_PLATFORM_VSNPRINTF_ALT)
241#include <stdarg.h>
242extern int (*mbedtls_vsnprintf)(char *s, size_t n, const char *format, va_list arg);
243
251int mbedtls_platform_set_vsnprintf(int (*vsnprintf_func)(char *s, size_t n,
252 const char *format, va_list arg));
253#else /* MBEDTLS_PLATFORM_VSNPRINTF_ALT */
254#undef mbedtls_vsnprintf
255#if defined(MBEDTLS_PLATFORM_VSNPRINTF_MACRO)
256#define mbedtls_vsnprintf MBEDTLS_PLATFORM_VSNPRINTF_MACRO
257#else
258#define mbedtls_vsnprintf vsnprintf
259#endif /* MBEDTLS_PLATFORM_VSNPRINTF_MACRO */
260#endif /* MBEDTLS_PLATFORM_VSNPRINTF_ALT */
261
262/*
263 * The function pointers for setbuf
264 */
265#if defined(MBEDTLS_PLATFORM_SETBUF_ALT)
266#include <stdio.h>
283extern void (*mbedtls_setbuf)(FILE *stream, char *buf);
284
294int mbedtls_platform_set_setbuf(void (*setbuf_func)(
295 FILE *stream, char *buf));
296#else
297#undef mbedtls_setbuf
298#if defined(MBEDTLS_PLATFORM_SETBUF_MACRO)
309#define mbedtls_setbuf MBEDTLS_PLATFORM_SETBUF_MACRO
310#else
311#define mbedtls_setbuf setbuf
312#endif /* MBEDTLS_PLATFORM_SETBUF_MACRO */
313#endif /* MBEDTLS_PLATFORM_SETBUF_ALT */
314
315/*
316 * The function pointers for exit
317 */
318#if defined(MBEDTLS_PLATFORM_EXIT_ALT)
319extern void (*mbedtls_exit)(int status);
320
330int mbedtls_platform_set_exit(void (*exit_func)(int status));
331#else
332#undef mbedtls_exit
333#if defined(MBEDTLS_PLATFORM_EXIT_MACRO)
334#define mbedtls_exit MBEDTLS_PLATFORM_EXIT_MACRO
335#else
336#define mbedtls_exit exit
337#endif /* MBEDTLS_PLATFORM_EXIT_MACRO */
338#endif /* MBEDTLS_PLATFORM_EXIT_ALT */
339
340/*
341 * The default exit values
342 */
343#if defined(MBEDTLS_PLATFORM_STD_EXIT_SUCCESS)
344#define MBEDTLS_EXIT_SUCCESS MBEDTLS_PLATFORM_STD_EXIT_SUCCESS
345#else
346#define MBEDTLS_EXIT_SUCCESS 0
347#endif
348#if defined(MBEDTLS_PLATFORM_STD_EXIT_FAILURE)
349#define MBEDTLS_EXIT_FAILURE MBEDTLS_PLATFORM_STD_EXIT_FAILURE
350#else
351#define MBEDTLS_EXIT_FAILURE 1
352#endif
353
354#if defined(MBEDTLS_PSA_BUILTIN_GET_ENTROPY) && \
355 !(defined(_WIN32) && !defined(EFIX64) && !defined(EFI32))
356/* Platforms where MBEDTLS_PLATFORM_DEV_RANDOM is used
357 * unless a dedicated system call is available both at
358 * compile time and at run time. */
359#define MBEDTLS_PLATFORM_HAVE_DEV_RANDOM
360#endif
361
362#if !defined(MBEDTLS_PLATFORM_DEV_RANDOM)
363#define MBEDTLS_PLATFORM_DEV_RANDOM "/dev/random"
364#endif
365
366#if defined(MBEDTLS_PLATFORM_HAVE_DEV_RANDOM)
374extern const char *mbedtls_platform_dev_random;
375#endif
376
377/*
378 * The function pointers for reading from and writing a seed file to
379 * Non-Volatile storage (NV) in a platform-independent way
380 *
381 * Only enabled when the NV seed entropy source is enabled
382 */
383#if defined(MBEDTLS_ENTROPY_NV_SEED)
384#if !defined(MBEDTLS_PLATFORM_NO_STD_FUNCTIONS) && defined(MBEDTLS_FS_IO)
385/* Internal standard platform definitions */
386int mbedtls_platform_std_nv_seed_read(unsigned char *buf, size_t buf_len);
387int mbedtls_platform_std_nv_seed_write(unsigned char *buf, size_t buf_len);
388#endif
389
390#if defined(MBEDTLS_PLATFORM_NV_SEED_ALT)
391extern int (*mbedtls_nv_seed_read)(unsigned char *buf, size_t buf_len);
392extern int (*mbedtls_nv_seed_write)(unsigned char *buf, size_t buf_len);
393
403int mbedtls_platform_set_nv_seed(
404 int (*nv_seed_read_func)(unsigned char *buf, size_t buf_len),
405 int (*nv_seed_write_func)(unsigned char *buf, size_t buf_len)
406 );
407#else
408#undef mbedtls_nv_seed_read
409#undef mbedtls_nv_seed_write
410#if defined(MBEDTLS_PLATFORM_NV_SEED_READ_MACRO) && \
411 defined(MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO)
412#define mbedtls_nv_seed_read MBEDTLS_PLATFORM_NV_SEED_READ_MACRO
413#define mbedtls_nv_seed_write MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO
414#else
415#define mbedtls_nv_seed_read mbedtls_platform_std_nv_seed_read
416#define mbedtls_nv_seed_write mbedtls_platform_std_nv_seed_write
417#endif
418#endif /* MBEDTLS_PLATFORM_NV_SEED_ALT */
419#endif /* MBEDTLS_ENTROPY_NV_SEED */
420
421#if !defined(MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT)
422
430 char MBEDTLS_PRIVATE(dummy);
431}
433
434#else
435#include "platform_alt.h"
436#endif /* !MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT */
437
474 size_t *estimate_bits,
475 unsigned char *output, size_t output_size);
476
508
509#ifdef __cplusplus
510}
511#endif
512
513#endif /* MBEDTLS_PLATFORM_H */
Definitions for PSA random and entropy drivers.
uint32_t psa_driver_get_entropy_flags_t
void mbedtls_platform_teardown(mbedtls_platform_context *ctx)
This function performs any platform teardown operations.
#define mbedtls_free
Definition platform.h:151
const char * mbedtls_platform_dev_random
#define mbedtls_snprintf
Definition platform.h:236
int mbedtls_platform_get_entropy(psa_driver_get_entropy_flags_t flags, size_t *estimate_bits, unsigned char *output, size_t output_size)
User defined callback function that is used from the entropy module to gather entropy data from some ...
#define mbedtls_fprintf
Definition platform.h:179
#define mbedtls_calloc
Definition platform.h:152
#define mbedtls_exit
Definition platform.h:336
#define mbedtls_vsnprintf
Definition platform.h:258
int mbedtls_platform_setup(mbedtls_platform_context *ctx)
This function performs any platform-specific initialization operations.
#define mbedtls_printf
Definition platform.h:214
#define mbedtls_setbuf
Definition platform.h:311
Mbed TLS Platform time abstraction.
The platform context structure.
Definition platform.h:429
Build-time configuration info.