mbed TLS v3.1.0
platform.h
Go to the documentation of this file.
1 
15 /*
16  * Copyright The Mbed TLS Contributors
17  * SPDX-License-Identifier: Apache-2.0
18  *
19  * Licensed under the Apache License, Version 2.0 (the "License"); you may
20  * not use this file except in compliance with the License.
21  * You may obtain a copy of the License at
22  *
23  * http://www.apache.org/licenses/LICENSE-2.0
24  *
25  * Unless required by applicable law or agreed to in writing, software
26  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
27  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
28  * See the License for the specific language governing permissions and
29  * limitations under the License.
30  */
31 #ifndef MBEDTLS_PLATFORM_H
32 #define MBEDTLS_PLATFORM_H
33 #include "mbedtls/private_access.h"
34 
35 #include "mbedtls/build_info.h"
36 
37 #if defined(MBEDTLS_HAVE_TIME)
38 #include "mbedtls/platform_time.h"
39 #endif
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
53 /* The older Microsoft Windows common runtime provides non-conforming
54  * implementations of some standard library functions, including snprintf
55  * and vsnprintf. This affects MSVC and MinGW builds.
56  */
57 #if defined(__MINGW32__) || (defined(_MSC_VER) && _MSC_VER <= 1900)
58 #define MBEDTLS_PLATFORM_HAS_NON_CONFORMING_SNPRINTF
59 #define MBEDTLS_PLATFORM_HAS_NON_CONFORMING_VSNPRINTF
60 #endif
61 
62 #if !defined(MBEDTLS_PLATFORM_NO_STD_FUNCTIONS)
63 #include <stdio.h>
64 #include <stdlib.h>
65 #include <time.h>
66 #if !defined(MBEDTLS_PLATFORM_STD_SNPRINTF)
67 #if defined(MBEDTLS_PLATFORM_HAS_NON_CONFORMING_SNPRINTF)
68 #define MBEDTLS_PLATFORM_STD_SNPRINTF mbedtls_platform_win32_snprintf
69 #else
70 #define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf
71 #endif
72 #endif
73 #if !defined(MBEDTLS_PLATFORM_STD_VSNPRINTF)
74 #if defined(MBEDTLS_PLATFORM_HAS_NON_CONFORMING_VSNPRINTF)
75 #define MBEDTLS_PLATFORM_STD_VSNPRINTF mbedtls_platform_win32_vsnprintf
76 #else
77 #define MBEDTLS_PLATFORM_STD_VSNPRINTF vsnprintf
78 #endif
79 #endif
80 #if !defined(MBEDTLS_PLATFORM_STD_PRINTF)
81 #define MBEDTLS_PLATFORM_STD_PRINTF printf
82 #endif
83 #if !defined(MBEDTLS_PLATFORM_STD_FPRINTF)
84 #define MBEDTLS_PLATFORM_STD_FPRINTF fprintf
85 #endif
86 #if !defined(MBEDTLS_PLATFORM_STD_CALLOC)
87 #define MBEDTLS_PLATFORM_STD_CALLOC calloc
88 #endif
89 #if !defined(MBEDTLS_PLATFORM_STD_FREE)
90 #define MBEDTLS_PLATFORM_STD_FREE free
91 #endif
92 #if !defined(MBEDTLS_PLATFORM_STD_EXIT)
93 #define MBEDTLS_PLATFORM_STD_EXIT exit
94 #endif
95 #if !defined(MBEDTLS_PLATFORM_STD_TIME)
96 #define MBEDTLS_PLATFORM_STD_TIME time
97 #endif
98 #if !defined(MBEDTLS_PLATFORM_STD_EXIT_SUCCESS)
99 #define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS EXIT_SUCCESS
100 #endif
101 #if !defined(MBEDTLS_PLATFORM_STD_EXIT_FAILURE)
102 #define MBEDTLS_PLATFORM_STD_EXIT_FAILURE EXIT_FAILURE
103 #endif
104 #if defined(MBEDTLS_FS_IO)
105 #if !defined(MBEDTLS_PLATFORM_STD_NV_SEED_READ)
106 #define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read
107 #endif
108 #if !defined(MBEDTLS_PLATFORM_STD_NV_SEED_WRITE)
109 #define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write
110 #endif
111 #if !defined(MBEDTLS_PLATFORM_STD_NV_SEED_FILE)
112 #define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile"
113 #endif
114 #endif /* MBEDTLS_FS_IO */
115 #else /* MBEDTLS_PLATFORM_NO_STD_FUNCTIONS */
116 #if defined(MBEDTLS_PLATFORM_STD_MEM_HDR)
117 #include MBEDTLS_PLATFORM_STD_MEM_HDR
118 #endif
119 #endif /* MBEDTLS_PLATFORM_NO_STD_FUNCTIONS */
120 
121 
122 /* \} name SECTION: Module settings */
123 
124 /*
125  * The function pointers for calloc and free.
126  */
127 #if defined(MBEDTLS_PLATFORM_MEMORY)
128 #if defined(MBEDTLS_PLATFORM_FREE_MACRO) && \
129  defined(MBEDTLS_PLATFORM_CALLOC_MACRO)
130 #define mbedtls_free MBEDTLS_PLATFORM_FREE_MACRO
131 #define mbedtls_calloc MBEDTLS_PLATFORM_CALLOC_MACRO
132 #else
133 /* For size_t */
134 #include <stddef.h>
135 extern void *mbedtls_calloc( size_t n, size_t size );
136 extern void mbedtls_free( void *ptr );
137 
147 int mbedtls_platform_set_calloc_free( void * (*calloc_func)( size_t, size_t ),
148  void (*free_func)( void * ) );
149 #endif /* MBEDTLS_PLATFORM_FREE_MACRO && MBEDTLS_PLATFORM_CALLOC_MACRO */
150 #else /* !MBEDTLS_PLATFORM_MEMORY */
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>
161 extern int (*mbedtls_fprintf)( FILE *stream, const char *format, ... );
162 
172 int mbedtls_platform_set_fprintf( int (*fprintf_func)( FILE *stream, const char *,
173  ... ) );
174 #else
175 #if defined(MBEDTLS_PLATFORM_FPRINTF_MACRO)
176 #define mbedtls_fprintf MBEDTLS_PLATFORM_FPRINTF_MACRO
177 #else
178 #define mbedtls_fprintf fprintf
179 #endif /* MBEDTLS_PLATFORM_FPRINTF_MACRO */
180 #endif /* MBEDTLS_PLATFORM_FPRINTF_ALT */
181 
182 /*
183  * The function pointers for printf
184  */
185 #if defined(MBEDTLS_PLATFORM_PRINTF_ALT)
186 extern int (*mbedtls_printf)( const char *format, ... );
187 
197 int mbedtls_platform_set_printf( int (*printf_func)( const char *, ... ) );
198 #else /* !MBEDTLS_PLATFORM_PRINTF_ALT */
199 #if defined(MBEDTLS_PLATFORM_PRINTF_MACRO)
200 #define mbedtls_printf MBEDTLS_PLATFORM_PRINTF_MACRO
201 #else
202 #define mbedtls_printf printf
203 #endif /* MBEDTLS_PLATFORM_PRINTF_MACRO */
204 #endif /* MBEDTLS_PLATFORM_PRINTF_ALT */
205 
206 /*
207  * The function pointers for snprintf
208  *
209  * The snprintf implementation should conform to C99:
210  * - it *must* always correctly zero-terminate the buffer
211  * (except when n == 0, then it must leave the buffer untouched)
212  * - however it is acceptable to return -1 instead of the required length when
213  * the destination buffer is too short.
214  */
215 #if defined(MBEDTLS_PLATFORM_HAS_NON_CONFORMING_SNPRINTF)
216 /* For Windows (inc. MSYS2), we provide our own fixed implementation */
217 int mbedtls_platform_win32_snprintf( char *s, size_t n, const char *fmt, ... );
218 #endif
219 
220 #if defined(MBEDTLS_PLATFORM_SNPRINTF_ALT)
221 extern int (*mbedtls_snprintf)( char * s, size_t n, const char * format, ... );
222 
231 int mbedtls_platform_set_snprintf( int (*snprintf_func)( char * s, size_t n,
232  const char * format, ... ) );
233 #else /* MBEDTLS_PLATFORM_SNPRINTF_ALT */
234 #if defined(MBEDTLS_PLATFORM_SNPRINTF_MACRO)
235 #define mbedtls_snprintf MBEDTLS_PLATFORM_SNPRINTF_MACRO
236 #else
237 #define mbedtls_snprintf MBEDTLS_PLATFORM_STD_SNPRINTF
238 #endif /* MBEDTLS_PLATFORM_SNPRINTF_MACRO */
239 #endif /* MBEDTLS_PLATFORM_SNPRINTF_ALT */
240 
241 /*
242  * The function pointers for vsnprintf
243  *
244  * The vsnprintf implementation should conform to C99:
245  * - it *must* always correctly zero-terminate the buffer
246  * (except when n == 0, then it must leave the buffer untouched)
247  * - however it is acceptable to return -1 instead of the required length when
248  * the destination buffer is too short.
249  */
250 #if defined(MBEDTLS_PLATFORM_HAS_NON_CONFORMING_VSNPRINTF)
251 #include <stdarg.h>
252 /* For Older Windows (inc. MSYS2), we provide our own fixed implementation */
253 int mbedtls_platform_win32_vsnprintf( char *s, size_t n, const char *fmt, va_list arg );
254 #endif
255 
256 #if defined(MBEDTLS_PLATFORM_VSNPRINTF_ALT)
257 #include <stdarg.h>
258 extern int (*mbedtls_vsnprintf)( char * s, size_t n, const char * format, va_list arg );
259 
267 int mbedtls_platform_set_vsnprintf( int (*vsnprintf_func)( char * s, size_t n,
268  const char * format, va_list arg ) );
269 #else /* MBEDTLS_PLATFORM_VSNPRINTF_ALT */
270 #if defined(MBEDTLS_PLATFORM_VSNPRINTF_MACRO)
271 #define mbedtls_vsnprintf MBEDTLS_PLATFORM_VSNPRINTF_MACRO
272 #else
273 #define mbedtls_vsnprintf vsnprintf
274 #endif /* MBEDTLS_PLATFORM_VSNPRINTF_MACRO */
275 #endif /* MBEDTLS_PLATFORM_VSNPRINTF_ALT */
276 
277 /*
278  * The function pointers for exit
279  */
280 #if defined(MBEDTLS_PLATFORM_EXIT_ALT)
281 extern void (*mbedtls_exit)( int status );
282 
292 int mbedtls_platform_set_exit( void (*exit_func)( int status ) );
293 #else
294 #if defined(MBEDTLS_PLATFORM_EXIT_MACRO)
295 #define mbedtls_exit MBEDTLS_PLATFORM_EXIT_MACRO
296 #else
297 #define mbedtls_exit exit
298 #endif /* MBEDTLS_PLATFORM_EXIT_MACRO */
299 #endif /* MBEDTLS_PLATFORM_EXIT_ALT */
300 
301 /*
302  * The default exit values
303  */
304 #if defined(MBEDTLS_PLATFORM_STD_EXIT_SUCCESS)
305 #define MBEDTLS_EXIT_SUCCESS MBEDTLS_PLATFORM_STD_EXIT_SUCCESS
306 #else
307 #define MBEDTLS_EXIT_SUCCESS 0
308 #endif
309 #if defined(MBEDTLS_PLATFORM_STD_EXIT_FAILURE)
310 #define MBEDTLS_EXIT_FAILURE MBEDTLS_PLATFORM_STD_EXIT_FAILURE
311 #else
312 #define MBEDTLS_EXIT_FAILURE 1
313 #endif
314 
315 /*
316  * The function pointers for reading from and writing a seed file to
317  * Non-Volatile storage (NV) in a platform-independent way
318  *
319  * Only enabled when the NV seed entropy source is enabled
320  */
321 #if defined(MBEDTLS_ENTROPY_NV_SEED)
322 #if !defined(MBEDTLS_PLATFORM_NO_STD_FUNCTIONS) && defined(MBEDTLS_FS_IO)
323 /* Internal standard platform definitions */
324 int mbedtls_platform_std_nv_seed_read( unsigned char *buf, size_t buf_len );
325 int mbedtls_platform_std_nv_seed_write( unsigned char *buf, size_t buf_len );
326 #endif
327 
328 #if defined(MBEDTLS_PLATFORM_NV_SEED_ALT)
329 extern int (*mbedtls_nv_seed_read)( unsigned char *buf, size_t buf_len );
330 extern int (*mbedtls_nv_seed_write)( unsigned char *buf, size_t buf_len );
331 
341 int mbedtls_platform_set_nv_seed(
342  int (*nv_seed_read_func)( unsigned char *buf, size_t buf_len ),
343  int (*nv_seed_write_func)( unsigned char *buf, size_t buf_len )
344  );
345 #else
346 #if defined(MBEDTLS_PLATFORM_NV_SEED_READ_MACRO) && \
347  defined(MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO)
348 #define mbedtls_nv_seed_read MBEDTLS_PLATFORM_NV_SEED_READ_MACRO
349 #define mbedtls_nv_seed_write MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO
350 #else
351 #define mbedtls_nv_seed_read mbedtls_platform_std_nv_seed_read
352 #define mbedtls_nv_seed_write mbedtls_platform_std_nv_seed_write
353 #endif
354 #endif /* MBEDTLS_PLATFORM_NV_SEED_ALT */
355 #endif /* MBEDTLS_ENTROPY_NV_SEED */
356 
357 #if !defined(MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT)
358 
365 typedef struct mbedtls_platform_context
366 {
367  char MBEDTLS_PRIVATE(dummy);
368 }
369 mbedtls_platform_context;
370 
371 #else
372 #include "platform_alt.h"
373 #endif /* !MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT */
374 
390 int mbedtls_platform_setup( mbedtls_platform_context *ctx );
405 void mbedtls_platform_teardown( mbedtls_platform_context *ctx );
406 
407 #ifdef __cplusplus
408 }
409 #endif
410 
411 #endif /* platform.h */
mbedtls_platform_set_calloc_free
int mbedtls_platform_set_calloc_free(void *(*calloc_func)(size_t, size_t), void(*free_func)(void *))
This function dynamically sets the memory-management functions used by the library, during runtime.
mbedtls_platform_teardown
void mbedtls_platform_teardown(mbedtls_platform_context *ctx)
This function performs any platform teardown operations.
MBEDTLS_PRIVATE
#define MBEDTLS_PRIVATE(member)
Definition: private_access.h:27
mbedtls_platform_set_exit
int mbedtls_platform_set_exit(void(*exit_func)(int status))
This function dynamically configures the exit function that is called when the mbedtls_exit() functio...
mbedtls_platform_set_printf
int mbedtls_platform_set_printf(int(*printf_func)(const char *,...))
This function dynamically configures the snprintf function that is called when the mbedtls_snprintf()...
mbedtls_platform_set_vsnprintf
int mbedtls_platform_set_vsnprintf(int(*vsnprintf_func)(char *s, size_t n, const char *format, va_list arg))
Set your own snprintf function pointer.
mbedtls_platform_set_fprintf
int mbedtls_platform_set_fprintf(int(*fprintf_func)(FILE *stream, const char *,...))
This function dynamically configures the fprintf function that is called when the mbedtls_fprintf() f...
mbedtls_calloc
void * mbedtls_calloc(size_t n, size_t size)
mbedtls_printf
int(* mbedtls_printf)(const char *format,...)
mbedtls_vsnprintf
int(* mbedtls_vsnprintf)(char *s, size_t n, const char *format, va_list arg)
mbedtls_free
void mbedtls_free(void *ptr)
mbedtls_nv_seed_write
int(* mbedtls_nv_seed_write)(unsigned char *buf, size_t buf_len)
private_access.h
Macro wrapper for struct's memebrs.
mbedtls_platform_set_snprintf
int mbedtls_platform_set_snprintf(int(*snprintf_func)(char *s, size_t n, const char *format,...))
This function allows configuring a custom snprintf function pointer.
mbedtls_fprintf
int(* mbedtls_fprintf)(FILE *stream, const char *format,...)
build_info.h
Build-time configuration info.
mbedtls_exit
void(* mbedtls_exit)(int status)
mbedtls_platform_set_nv_seed
int mbedtls_platform_set_nv_seed(int(*nv_seed_read_func)(unsigned char *buf, size_t buf_len), int(*nv_seed_write_func)(unsigned char *buf, size_t buf_len))
This function allows configuring custom seed file writing and reading functions.
mbedtls_platform_setup
int mbedtls_platform_setup(mbedtls_platform_context *ctx)
This function performs any platform-specific initialization operations.
mbedtls_snprintf
int(* mbedtls_snprintf)(char *s, size_t n, const char *format,...)
platform_time.h
mbed TLS Platform time abstraction
mbedtls_nv_seed_read
int(* mbedtls_nv_seed_read)(unsigned char *buf, size_t buf_len)
Generated on Tue Aug 30 2022 09:50:16 for mbed TLS v3.1.0 by   doxygen 1.8.6