MCUX CLNS
MCUX Crypto Library Normal Secure
mcuxCsslFlowProtection_SecureCounter_Common.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------*/
2 /* Copyright 2020-2023 NXP */
3 /* */
4 /* NXP Confidential. This software is owned or controlled by NXP and may */
5 /* only be used strictly in accordance with the applicable license terms. */
6 /* By expressly accepting such terms or by downloading, installing, */
7 /* activating and/or otherwise using the software, you are agreeing that */
8 /* you have read, and that you agree to comply with and are bound by, such */
9 /* license terms. If you do not agree to be bound by the applicable license */
10 /* terms, then you may not retain, install, activate or otherwise use the */
11 /* software. */
12 /*--------------------------------------------------------------------------*/
13 
19 #ifndef MCUX_CSSL_FLOW_PROTECTION_SECURE_COUNTER_COMMON_H_
20 #define MCUX_CSSL_FLOW_PROTECTION_SECURE_COUNTER_COMMON_H_
21 
22 /* Include the CSSL C pre-processor support functionality. */
23 #include <mcuxCsslCPreProcessor.h>
24 #include <mcuxCsslAnalysis.h>
25 
26 /* Include the CSSL secure counter mechanism as basic building block. */
27 #include <mcuxCsslSecureCounter.h>
28 
29 /* Include the C99 standard integer types. */
30 #include <stdint.h>
31 
63 #define MCUX_CSSL_FP_DECL_NAME(type, id) \
64  MCUX_CSSL_CPP_CAT4(mcuxCsslFlowProtection_, type, _, id)
65 
75 #define MCUX_CSSL_FP_DECL_IMPL(type, id) \
76  MCUX_CSSL_SC_VALUE_TYPE MCUX_CSSL_FP_DECL_NAME(type, id) = \
77  MCUX_CSSL_CPP_CAT3(MCUX_CSSL_FP_, type, _ID)(id)
78 
86 #define MCUX_CSSL_FP_ID_IMPL() \
87  MCUX_CSSL_CPP_CAT(__LINE__, u)
88 
89 
90 
106 #define MCUX_CSSL_FP_EXPECTATIONS(...) \
107  (MCUX_CSSL_CPP_MAP(MCUX_CSSL_CPP_ADD, __VA_ARGS__))
108 
121 #define MCUX_CSSL_FP_COUNTER_STMT_IMPL(statement) \
122  statement
123 
135 #define MCUX_CSSL_FP_CONDITIONAL_IMPL(condition, ...) \
136  (MCUX_CSSL_FP_EXPECTATIONS(__VA_ARGS__) & ((condition) ? ((uint32_t) UINT32_MAX) : ((uint32_t) 0)))
137 
148 #define MCUX_CSSL_FP_VOID_EXPECTATION_IMPL() \
149  (0u)
150 
164 #define MCUX_CSSL_FP_EXPECT_IMPL(...) \
165  MCUX_CSSL_SC_SUB( \
166  MCUX_CSSL_FP_EXPECTATIONS(__VA_ARGS__) \
167  )
168 
169 
170 
188 #define MCUX_CSSL_FP_FUNCTION_ID(id) \
189  MCUX_CSSL_CPP_CAT(MCUX_CSSL_FP_FUNCID_, id)
190 
196 #define MCUX_CSSL_FP_FUNCTION_ID_ENTRY_MASK \
197  (0x5A5A5A5Au)
198 
206 #define MCUX_CSSL_FP_FUNCTION_ID_ENTRY_PART(id) \
207  (MCUX_CSSL_FP_FUNCTION_VALUE(id) & MCUX_CSSL_FP_FUNCTION_ID_ENTRY_MASK)
208 
216 #define MCUX_CSSL_FP_FUNCTION_ID_EXIT_PART(id) \
217  (MCUX_CSSL_FP_FUNCTION_VALUE(id) - MCUX_CSSL_FP_FUNCTION_ID_ENTRY_PART(id))
218 
230 #define MCUX_CSSL_FP_FUNCTION_DECL_IMPL(...) \
231  /* Intentionally empty */
232 
241 #define MCUX_CSSL_FP_FUNCTION_VALUE(id) \
242  MCUX_CSSL_FP_FUNCTION_ID(id)
243 
254 #define MCUX_CSSL_FP_FUNCTION_DEF_IMPL(...) \
255  /* Intentionally empty. */
256 
265 #define MCUX_CSSL_FP_FUNCTION_POINTER_IMPL(type, definition) \
266  definition
267 
273 #define MCUX_CSSL_FP_RESULT_OFFSET \
274  (0u)
275 
281 #define MCUX_CSSL_FP_RESULT_MASK \
282  (0xFFFFFFFFuLL)
283 
291 #define MCUX_CSSL_FP_RESULT_VALUE(result) \
292  (((uint64_t)(result) & MCUX_CSSL_FP_RESULT_MASK) << MCUX_CSSL_FP_RESULT_OFFSET)
293 
301 #define MCUX_CSSL_FP_RESULT_IMPL(return) \
302  (uint32_t)(((return) >> MCUX_CSSL_FP_RESULT_OFFSET) & MCUX_CSSL_FP_RESULT_MASK)
303 
309 #define MCUX_CSSL_FP_PROTECTION_OFFSET \
310  (32u)
311 
317 #define MCUX_CSSL_FP_PROTECTION_MASK \
318  (0xFFFFFFFFuLL)
319 
330 #define MCUX_CSSL_FP_PROTECTION_TOKEN_VALUE(token) \
331  ((((uint64_t)(token) & MCUX_CSSL_FP_PROTECTION_MASK)) << MCUX_CSSL_FP_PROTECTION_OFFSET)
332 
343 #define MCUX_CSSL_FP_PROTECTION_TOKEN_IMPL(return) \
344  (uint32_t)(((return) >> MCUX_CSSL_FP_PROTECTION_OFFSET) & MCUX_CSSL_FP_PROTECTION_MASK)
345 
352 #define MCUX_CSSL_FP_COUNTER_COMPRESSED() \
353  MCUX_CSSL_SC_VALUE()
354 
355 
369 #define MCUX_CSSL_FP_FUNCTION_CALLED_IMPL(id) \
370  MCUX_CSSL_FP_FUNCTION_VALUE(id)
371 
372 
386 #define MCUX_CSSL_FP_FUNCTION_ENTERED_IMPL(id) \
387  MCUX_CSSL_FP_FUNCTION_ID_ENTRY_PART(id)
388 
389 
408 #define MCUX_CSSL_FP_LOOP_ID(id) \
409  MCUX_CSSL_FP_ID_IMPL()
410 
418 #define MCUX_CSSL_FP_LOOP_DECL_IMPL(id) \
419  MCUX_CSSL_FP_DECL_IMPL(LOOP, id)
420 
429 #define MCUX_CSSL_FP_LOOP_VALUE(id) \
430  MCUX_CSSL_FP_DECL_NAME(LOOP, id)
431 
443 #define MCUX_CSSL_FP_LOOP_ITERATION_IMPLn(id, ...) \
444  MCUX_CSSL_SC_ADD( \
445  MCUX_CSSL_FP_LOOP_VALUE(id) \
446  - MCUX_CSSL_FP_EXPECTATIONS(__VA_ARGS__) \
447  )
448 
459 #define MCUX_CSSL_FP_LOOP_ITERATION_IMPL1(id) \
460  MCUX_CSSL_FP_LOOP_ITERATION_IMPLn(id, 0u)
461 
476 #define MCUX_CSSL_FP_LOOP_ITERATION_IMPL(...) \
477  MCUX_CSSL_CPP_OVERLOADED1(MCUX_CSSL_FP_LOOP_ITERATION_IMPL, __VA_ARGS__)
478 
487 #define MCUX_CSSL_FP_LOOP_ITERATIONS_IMPL(id, count) \
488  ((count) * MCUX_CSSL_FP_LOOP_VALUE(id))
489 
490 
491 
510 #define MCUX_CSSL_FP_BRANCH_ID(id) \
511  MCUX_CSSL_FP_ID_IMPL()
512 
520 #define MCUX_CSSL_FP_BRANCH_DECL_IMPL(id) \
521  MCUX_CSSL_FP_DECL_IMPL(BRANCH, id)
522 
531 #define MCUX_CSSL_FP_BRANCH_VALUE(id) \
532  MCUX_CSSL_FP_DECL_NAME(BRANCH, id)
533 
539 #define MCUX_CSSL_FP_BRANCH_POSITIVE_VALUE 0x5u
540 
546 #define MCUX_CSSL_FP_BRANCH_NEGATIVE_VALUE 0xAu
547 
562 #define MCUX_CSSL_FP_BRANCH_SCENARIO_IMPL(id, scenario, ...) \
563  MCUX_CSSL_SC_ADD( \
564  (MCUX_CSSL_FP_BRANCH_VALUE(id) * (scenario)) \
565  - MCUX_CSSL_FP_EXPECTATIONS(__VA_ARGS__) \
566  )
567 
582 #define MCUX_CSSL_FP_BRANCH_POSITIVE_IMPLn(id, ...) \
583  MCUX_CSSL_FP_BRANCH_SCENARIO_IMPL(id, MCUX_CSSL_FP_BRANCH_POSITIVE_VALUE, \
584  __VA_ARGS__)
585 
598 #define MCUX_CSSL_FP_BRANCH_POSITIVE_IMPL1(id) \
599  MCUX_CSSL_FP_BRANCH_SCENARIO_IMPL(id, MCUX_CSSL_FP_BRANCH_POSITIVE_VALUE, 0u)
600 
616 #define MCUX_CSSL_FP_BRANCH_POSITIVE_IMPL(...) \
617  MCUX_CSSL_CPP_OVERLOADED1(MCUX_CSSL_FP_BRANCH_POSITIVE_IMPL, __VA_ARGS__)
618 
633 #define MCUX_CSSL_FP_BRANCH_NEGATIVE_IMPLn(id, ...) \
634  MCUX_CSSL_FP_BRANCH_SCENARIO_IMPL(id, MCUX_CSSL_FP_BRANCH_NEGATIVE_VALUE, \
635  __VA_ARGS__)
636 
649 #define MCUX_CSSL_FP_BRANCH_NEGATIVE_IMPL1(id) \
650  MCUX_CSSL_FP_BRANCH_SCENARIO_IMPL(id, MCUX_CSSL_FP_BRANCH_NEGATIVE_VALUE, 0u)
651 
667 #define MCUX_CSSL_FP_BRANCH_NEGATIVE_IMPL(...) \
668  MCUX_CSSL_CPP_OVERLOADED1(MCUX_CSSL_FP_BRANCH_NEGATIVE_IMPL, __VA_ARGS__)
669 
682 #define MCUX_CSSL_FP_BRANCH_TAKEN_IMPL(id, scenario, condition) \
683  MCUX_CSSL_FP_CONDITIONAL_IMPL(condition, \
684  MCUX_CSSL_FP_BRANCH_VALUE(id) * (scenario))
685 
698 #define MCUX_CSSL_FP_BRANCH_TAKEN_POSITIVE_IMPL2(id, condition) \
699  MCUX_CSSL_FP_BRANCH_TAKEN_IMPL(id, MCUX_CSSL_FP_BRANCH_POSITIVE_VALUE, condition)
700 
712 #define MCUX_CSSL_FP_BRANCH_TAKEN_POSITIVE_IMPL1(id) \
713  MCUX_CSSL_FP_BRANCH_TAKEN_IMPL(id, MCUX_CSSL_FP_BRANCH_POSITIVE_VALUE, true)
714 
728 #define MCUX_CSSL_FP_BRANCH_TAKEN_POSITIVE_IMPL(...) \
729  MCUX_CSSL_CPP_OVERLOADED2(MCUX_CSSL_FP_BRANCH_TAKEN_POSITIVE_IMPL, __VA_ARGS__)
730 
743 #define MCUX_CSSL_FP_BRANCH_TAKEN_NEGATIVE_IMPL2(id, condition) \
744  MCUX_CSSL_FP_BRANCH_TAKEN_IMPL(id, MCUX_CSSL_FP_BRANCH_NEGATIVE_VALUE, condition)
745 
757 #define MCUX_CSSL_FP_BRANCH_TAKEN_NEGATIVE_IMPL1(id) \
758  MCUX_CSSL_FP_BRANCH_TAKEN_IMPL(id, MCUX_CSSL_FP_BRANCH_NEGATIVE_VALUE, true)
759 
773 #define MCUX_CSSL_FP_BRANCH_TAKEN_NEGATIVE_IMPL(...) \
774  MCUX_CSSL_CPP_OVERLOADED2(MCUX_CSSL_FP_BRANCH_TAKEN_NEGATIVE_IMPL, __VA_ARGS__)
775 
776 
777 
796 #define MCUX_CSSL_FP_SWITCH_ID(id) \
797  MCUX_CSSL_FP_ID_IMPL()
798 
806 #define MCUX_CSSL_FP_SWITCH_DECL_IMPL(id) \
807  MCUX_CSSL_FP_DECL_IMPL(SWITCH, id)
808 
817 #define MCUX_CSSL_FP_SWITCH_VALUE(id) \
818  MCUX_CSSL_FP_DECL_NAME(SWITCH, id)
819 
833 #define MCUX_CSSL_FP_SWITCH_CASE_IMPLn(id, case, ...) \
834  MCUX_CSSL_SC_ADD( \
835  (MCUX_CSSL_FP_SWITCH_VALUE(id) * (case)) \
836  - MCUX_CSSL_FP_EXPECTATIONS(__VA_ARGS__) \
837  )
838 
850 #define MCUX_CSSL_FP_SWITCH_CASE_IMPL2(id, case) \
851  MCUX_CSSL_FP_SWITCH_CASE_IMPLn(id, case, 0u)
852 
868 #define MCUX_CSSL_FP_SWITCH_CASE_IMPL(...) \
869  MCUX_CSSL_CPP_OVERLOADED2(MCUX_CSSL_FP_SWITCH_CASE_IMPL, __VA_ARGS__)
870 
876 #define MCUX_CSSL_FP_SWITCH_DEFAULT_VALUE \
877  (0xDEFAu)
878 
891 #define MCUX_CSSL_FP_SWITCH_DEFAULT_IMPLn(id, ...) \
892  MCUX_CSSL_FP_SWITCH_CASE_IMPLn( \
893  id, MCUX_CSSL_FP_SWITCH_DEFAULT_VALUE, __VA_ARGS__)
894 
905 #define MCUX_CSSL_FP_SWITCH_DEFAULT_IMPL1(id) \
906  MCUX_CSSL_FP_SWITCH_DEFAULT_IMPLn(id, 0u) \
907 
908 
922 #define MCUX_CSSL_FP_SWITCH_DEFAULT_IMPL(...) \
923  MCUX_CSSL_CPP_OVERLOADED1(MCUX_CSSL_FP_SWITCH_DEFAULT_IMPL, __VA_ARGS__)
924 
938 #define MCUX_CSSL_FP_SWITCH_TAKEN_IMPL3(id, case, condition) \
939  MCUX_CSSL_FP_CONDITIONAL_IMPL(condition, \
940  MCUX_CSSL_FP_SWITCH_VALUE(id) * (case))
941 
953 #define MCUX_CSSL_FP_SWITCH_TAKEN_IMPL2(id, case) \
954  MCUX_CSSL_FP_SWITCH_TAKEN_IMPL3(id, case, true)
955 
971 #define MCUX_CSSL_FP_SWITCH_TAKEN_IMPL(...) \
972  MCUX_CSSL_CPP_OVERLOADED3(MCUX_CSSL_FP_SWITCH_TAKEN_IMPL, __VA_ARGS__)
973 
985 #define MCUX_CSSL_FP_SWITCH_TAKEN_DEFAULT_IMPL2(id, condition) \
986  MCUX_CSSL_FP_SWITCH_TAKEN_IMPL3(id, MCUX_CSSL_FP_SWITCH_DEFAULT_VALUE, condition)
987 
998 #define MCUX_CSSL_FP_SWITCH_TAKEN_DEFAULT_IMPL1(id) \
999  MCUX_CSSL_FP_SWITCH_TAKEN_DEFAULT_IMPL2(id, true)
1000 
1014 #define MCUX_CSSL_FP_SWITCH_TAKEN_DEFAULT_IMPL(...) \
1015  MCUX_CSSL_CPP_OVERLOADED2(MCUX_CSSL_FP_SWITCH_TAKEN_DEFAULT_IMPL, __VA_ARGS__)
1016 
1034 #ifndef MCUX_CSSL_FP_ASSERT_CALLBACK
1035  #define MCUX_CSSL_FP_ASSERT_CALLBACK() \
1036  return 1/0 /* Fallback ASSERT callback is used, please provide your own. */
1037 #endif
1038 
1039 #endif /* MCUX_CSSL_FLOW_PROTECTION_SECURE_COUNTER_COMMON_H_ */
The default implementation is based on standard C preprocessor functionality.
Provides the API for the CSSL secure counter mechanism.