Skip to content

Commit c8b1f50

Browse files
jeronstonejeronstone
authored
Consistent naming of Sec Param Int/Uint (#163)
* Trivial int->uint name change, small fix to sha var * apply format ubuntu
1 parent f1eb7ac commit c8b1f50

12 files changed

Lines changed: 115 additions & 115 deletions

‎src/BPSecLib_Private.h‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -626,7 +626,7 @@ size_t BSL_SecResult_Sizeof(void);
626626
enum BSL_SecParam_Types_e
627627
{
628628
BSL_SECPARAM_TYPE_UNKNOWN = 0, ///< Indicates parsed value not of expected type.
629-
BSL_SECPARAM_TYPE_INT64, ///< Indicates value type is an unsigned integer.
629+
BSL_SECPARAM_TYPE_UINT64, ///< Indicates value type is an unsigned integer.
630630
BSL_SECPARAM_TYPE_BYTESTR, ///< Indicates the value type is a byte string.
631631
BSL_SECPARAM_TYPE_TEXTSTR, ///< Indicates the value is a text string.
632632
};
@@ -723,7 +723,7 @@ int BSL_SecParam_InitBytestr(BSL_SecParam_t *self, uint64_t param_id, BSL_Data_t
723723
* @param[in] value View of bytes, which get copied into this Security Parameter.
724724
* @return Negative on an error.
725725
*/
726-
int BSL_SecParam_InitInt64(BSL_SecParam_t *self, uint64_t param_id, uint64_t value);
726+
int BSL_SecParam_InitUint64(BSL_SecParam_t *self, uint64_t param_id, uint64_t value);
727727

728728
/** Initialize as a parameter containing a byte string with a null-terminated
729729
* text value.
@@ -740,15 +740,15 @@ int BSL_SecParam_InitTextstr(BSL_SecParam_t *self, uint64_t param_id, const char
740740
* @param[in] self This Security Parameter
741741
* @return True when value type is integer.
742742
*/
743-
bool BSL_SecParam_IsInt64(const BSL_SecParam_t *self);
743+
bool BSL_SecParam_IsUint64(const BSL_SecParam_t *self);
744744

745745
/** Retrieve integer value of result when this result type is integer.
746-
* @warning Always check using BSL_SecParam_IsInt64() first.
746+
* @warning Always check using BSL_SecParam_IsUint64() first.
747747
*
748748
* @param[in] self This Security Parameter
749749
* @return Integer value of parameter if present, panics/aborts otherwise.
750750
*/
751-
uint64_t BSL_SecParam_GetAsUInt64(const BSL_SecParam_t *self);
751+
uint64_t BSL_SecParam_GetAsUint64(const BSL_SecParam_t *self);
752752

753753
/** Returns true when the value type is a byte string.
754754
*

‎src/backend/AbsSecBlock.c‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ void BSL_AbsSecBlock_Print(const BSL_AbsSecBlock_t *self)
5757
for (size_t index = 0; index < BSLB_SecParamList_size(self->params); index++)
5858
{
5959
BSL_SecParam_t *param = BSLB_SecParamList_get(self->params, index);
60-
if (BSL_SecParam_IsInt64(param))
60+
if (BSL_SecParam_IsUint64(param))
6161
{
6262
BSL_LOG_INFO("ASB Param[%zu]: id=%" PRIu64 " val=%" PRIu64, index, param->param_id, param->_uint_value);
6363
}
@@ -340,9 +340,9 @@ ssize_t BSL_AbsSecBlock_EncodeToCBOR(const BSL_AbsSecBlock_t *self, BSL_Data_t *
340340
const BSL_SecParam_t *param = BSLB_SecParamList_cref(pit);
341341
QCBOREncode_OpenArray(&encoder);
342342
QCBOREncode_AddUInt64(&encoder, param->param_id);
343-
if (BSL_SecParam_IsInt64(param))
343+
if (BSL_SecParam_IsUint64(param))
344344
{
345-
QCBOREncode_AddUInt64(&encoder, BSL_SecParam_GetAsUInt64(param));
345+
QCBOREncode_AddUInt64(&encoder, BSL_SecParam_GetAsUint64(param));
346346
}
347347
else if (BSL_SecParam_IsBytestr(param))
348348
{
@@ -529,7 +529,7 @@ int BSL_AbsSecBlock_DecodeFromCBOR(BSL_AbsSecBlock_t *self, const BSL_Data_t *bu
529529
}
530530
BSL_LOG_DEBUG("ASB: Parsed Param[%" PRIu64 "] = %" PRIu64, item_id, dec_value);
531531
BSL_SecParam_t param;
532-
BSL_SecParam_InitInt64(&param, item_id, dec_value);
532+
BSL_SecParam_InitUint64(&param, item_id, dec_value);
533533
BSLB_SecParamList_push_back(self->params, param);
534534
BSL_SecParam_Deinit(&param);
535535
break;

‎src/backend/SecParam.c‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -100,29 +100,29 @@ int BSL_SecParam_InitBytestr(BSL_SecParam_t *self, uint64_t param_id, BSL_Data_t
100100
return BSL_SUCCESS;
101101
}
102102

103-
int BSL_SecParam_InitInt64(BSL_SecParam_t *self, uint64_t param_id, uint64_t value)
103+
int BSL_SecParam_InitUint64(BSL_SecParam_t *self, uint64_t param_id, uint64_t value)
104104
{
105105
CHK_ARG_NONNULL(self);
106106

107107
memset(self, 0, sizeof(*self));
108108
self->param_id = param_id;
109-
self->_type = BSL_SECPARAM_TYPE_INT64;
109+
self->_type = BSL_SECPARAM_TYPE_UINT64;
110110
self->_uint_value = value;
111111
m_bstring_init(self->_bytes);
112112

113113
return BSL_SUCCESS;
114114
}
115115

116-
bool BSL_SecParam_IsInt64(const BSL_SecParam_t *self)
116+
bool BSL_SecParam_IsUint64(const BSL_SecParam_t *self)
117117
{
118118
CHK_AS_BOOL(self);
119-
return (self->_type == BSL_SECPARAM_TYPE_INT64);
119+
return (self->_type == BSL_SECPARAM_TYPE_UINT64);
120120
}
121121

122-
uint64_t BSL_SecParam_GetAsUInt64(const BSL_SecParam_t *self)
122+
uint64_t BSL_SecParam_GetAsUint64(const BSL_SecParam_t *self)
123123
{
124124
ASSERT_ARG_NONNULL(self);
125-
ASSERT_PRECONDITION(self->_type == BSL_SECPARAM_TYPE_INT64);
125+
ASSERT_PRECONDITION(self->_type == BSL_SECPARAM_TYPE_UINT64);
126126

127127
return self->_uint_value;
128128
}
@@ -169,7 +169,7 @@ bool BSL_SecParam_IsConsistent(const BSL_SecParam_t *self)
169169
CHK_AS_BOOL(self->param_id > 0);
170170
CHK_AS_BOOL(self->_type > BSL_SECPARAM_TYPE_UNKNOWN && self->_type <= BSL_SECPARAM_TYPE_TEXTSTR);
171171

172-
if (self->_type == BSL_SECPARAM_TYPE_INT64)
172+
if (self->_type == BSL_SECPARAM_TYPE_UINT64)
173173
{
174174
CHK_AS_BOOL(m_bstring_empty_p(self->_bytes));
175175
}

‎src/mock_bpa/policy_config.c‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -351,15 +351,15 @@ int mock_bpa_register_policy_from_json(const char *pp_cfg_file_path, BSLP_Policy
351351
sha_var = RFC9173_BIB_SHA_HMAC512;
352352
}
353353

354-
BSL_SecParam_InitInt64(params->param_sha_variant, RFC9173_BIB_PARAMID_SHA_VARIANT,
355-
sha_var);
354+
BSL_SecParam_InitUint64(params->param_sha_variant, RFC9173_BIB_PARAMID_SHA_VARIANT,
355+
sha_var);
356356
params_got |= 0x2;
357357
}
358358
else if (0 == strcmp(id_str, "scope_flags"))
359359
{
360360
uint64_t flag = strtol(value_str, NULL, 10); // FIXME
361-
BSL_SecParam_InitInt64(params->param_integ_scope_flag,
362-
RFC9173_BIB_PARAMID_INTEG_SCOPE_FLAG, flag);
361+
BSL_SecParam_InitUint64(params->param_integ_scope_flag,
362+
RFC9173_BIB_PARAMID_INTEG_SCOPE_FLAG, flag);
363363
params_got |= 0x4;
364364
}
365365
else if (0 == strcmp(id_str, "key_wrap"))
@@ -374,8 +374,8 @@ int mock_bpa_register_policy_from_json(const char *pp_cfg_file_path, BSLP_Policy
374374
keywrap = 1;
375375
}
376376

377-
BSL_SecParam_InitInt64(params->param_use_wrapped_key, BSL_SECPARAM_USE_KEY_WRAP,
378-
keywrap);
377+
BSL_SecParam_InitUint64(params->param_use_wrapped_key, BSL_SECPARAM_USE_KEY_WRAP,
378+
keywrap);
379379
params_got |= 0x8;
380380
}
381381
else
@@ -410,15 +410,15 @@ int mock_bpa_register_policy_from_json(const char *pp_cfg_file_path, BSLP_Policy
410410
aes_var = RFC9173_BCB_AES_VARIANT_A256GCM;
411411
}
412412

413-
BSL_SecParam_InitInt64(params->param_aes_variant, RFC9173_BCB_SECPARAM_AESVARIANT,
414-
aes_var);
413+
BSL_SecParam_InitUint64(params->param_aes_variant, RFC9173_BCB_SECPARAM_AESVARIANT,
414+
aes_var);
415415
params_got |= 0x4;
416416
}
417417
else if (0 == strcmp(id_str, "aad_scope"))
418418
{
419419
uint64_t flag = strtol(value_str, NULL, 10); // FIXME
420-
BSL_SecParam_InitInt64(params->param_aad_scope_flag, RFC9173_BCB_SECPARAM_AADSCOPE,
421-
flag);
420+
BSL_SecParam_InitUint64(params->param_aad_scope_flag, RFC9173_BCB_SECPARAM_AADSCOPE,
421+
flag);
422422
params_got |= 0x8;
423423
}
424424
else if (0 == strcmp(id_str, "key_wrap"))
@@ -433,8 +433,8 @@ int mock_bpa_register_policy_from_json(const char *pp_cfg_file_path, BSLP_Policy
433433
keywrap = 1;
434434
}
435435

436-
BSL_SecParam_InitInt64(params->param_use_wrapped_key, BSL_SECPARAM_USE_KEY_WRAP,
437-
keywrap);
436+
BSL_SecParam_InitUint64(params->param_use_wrapped_key, BSL_SECPARAM_USE_KEY_WRAP,
437+
keywrap);
438438
params_got |= 0x10;
439439
}
440440
else
@@ -562,27 +562,27 @@ static void mock_bpa_register_policy(const bsl_mock_policy_configuration_t polic
562562
// Init params for BCB if equal to 1, otherwise BIB
563563
if (sec_block_type == 1)
564564
{
565-
BSL_SecParam_InitInt64(params->param_aad_scope_flag, RFC9173_BCB_SECPARAM_AADSCOPE,
566-
RFC9173_BCB_AADSCOPEFLAGID_INC_NONE);
567-
BSL_SecParam_InitInt64(params->param_aes_variant, RFC9173_BCB_SECPARAM_AESVARIANT,
568-
RFC9173_BCB_AES_VARIANT_A128GCM);
565+
BSL_SecParam_InitUint64(params->param_aad_scope_flag, RFC9173_BCB_SECPARAM_AADSCOPE,
566+
RFC9173_BCB_AADSCOPEFLAGID_INC_NONE);
567+
BSL_SecParam_InitUint64(params->param_aes_variant, RFC9173_BCB_SECPARAM_AESVARIANT,
568+
RFC9173_BCB_AES_VARIANT_A128GCM);
569569
if (use_wrapped_key)
570570
{
571571
BSL_SecParam_InitTextstr(params->param_test_key, BSL_SECPARAM_TYPE_KEY_ID, "9103");
572-
BSL_SecParam_InitInt64(params->param_use_wrapped_key, BSL_SECPARAM_USE_KEY_WRAP, 1);
572+
BSL_SecParam_InitUint64(params->param_use_wrapped_key, BSL_SECPARAM_USE_KEY_WRAP, 1);
573573
}
574574
else
575575
{
576576
BSL_SecParam_InitTextstr(params->param_test_key, BSL_SECPARAM_TYPE_KEY_ID, "9102");
577-
BSL_SecParam_InitInt64(params->param_use_wrapped_key, BSL_SECPARAM_USE_KEY_WRAP, 0);
577+
BSL_SecParam_InitUint64(params->param_use_wrapped_key, BSL_SECPARAM_USE_KEY_WRAP, 0);
578578
}
579579
}
580580
else
581581
{
582-
BSL_SecParam_InitInt64(params->param_integ_scope_flag, RFC9173_BIB_PARAMID_INTEG_SCOPE_FLAG, 0);
583-
BSL_SecParam_InitInt64(params->param_sha_variant, RFC9173_BIB_PARAMID_SHA_VARIANT, RFC9173_BIB_SHA_HMAC512);
582+
BSL_SecParam_InitUint64(params->param_integ_scope_flag, RFC9173_BIB_PARAMID_INTEG_SCOPE_FLAG, 0);
583+
BSL_SecParam_InitUint64(params->param_sha_variant, RFC9173_BIB_PARAMID_SHA_VARIANT, RFC9173_BIB_SHA_HMAC512);
584584
BSL_SecParam_InitTextstr(params->param_test_key, BSL_SECPARAM_TYPE_KEY_ID, "9100");
585-
BSL_SecParam_InitInt64(params->param_use_wrapped_key, BSL_SECPARAM_USE_KEY_WRAP, 0);
585+
BSL_SecParam_InitUint64(params->param_use_wrapped_key, BSL_SECPARAM_USE_KEY_WRAP, 0);
586586
}
587587

588588
BSL_SecBlockType_e sec_block_emum;

‎src/security_context/BCB_AES_GCM.c‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -414,7 +414,7 @@ int BSLX_BCB_GetParams(const BSL_BundleRef_t *bundle, BSLX_BCB_t *bcb_context, c
414414
for (size_t param_index = 0; param_index < BSL_SecOper_CountParams(sec_oper); param_index++)
415415
{
416416
const BSL_SecParam_t *param = BSL_SecOper_GetParamAt(sec_oper, param_index);
417-
bool is_int = BSL_SecParam_IsInt64(param);
417+
bool is_int = BSL_SecParam_IsUint64(param);
418418

419419
uint64_t param_id = BSL_SecParam_GetId(param);
420420
BSL_LOG_DEBUG("BCB parsing param id %" PRIu64, param_id);
@@ -440,7 +440,7 @@ int BSLX_BCB_GetParams(const BSL_BundleRef_t *bundle, BSLX_BCB_t *bcb_context, c
440440
{
441441
BSL_LOG_DEBUG("BCB parsing AES variant (optid=%" PRIu64 ")", param_id);
442442
ASSERT_PRECONDITION(is_int);
443-
bcb_context->aes_variant = BSL_SecParam_GetAsUInt64(param);
443+
bcb_context->aes_variant = BSL_SecParam_GetAsUint64(param);
444444
if (bcb_context->aes_variant < RFC9173_BCB_AES_VARIANT_A128GCM
445445
|| bcb_context->aes_variant > RFC9173_BCB_AES_VARIANT_A256GCM)
446446
{
@@ -470,7 +470,7 @@ int BSLX_BCB_GetParams(const BSL_BundleRef_t *bundle, BSLX_BCB_t *bcb_context, c
470470
case RFC9173_BCB_SECPARAM_AADSCOPE:
471471
{
472472
ASSERT_PRECONDITION(is_int);
473-
uint64_t aad_scope = BSL_SecParam_GetAsUInt64(param);
473+
uint64_t aad_scope = BSL_SecParam_GetAsUint64(param);
474474
BSL_LOG_DEBUG("Param[%" PRIu64 "]: AAD_SCOPE value = %" PRIu64, param_id, aad_scope);
475475
bcb_context->aad_scope = aad_scope;
476476
if ((aad_scope & RFC9173_BCB_AADSCOPEFLAGID_INC_PRIM_BLOCK) == 0)
@@ -505,7 +505,7 @@ int BSLX_BCB_GetParams(const BSL_BundleRef_t *bundle, BSLX_BCB_t *bcb_context, c
505505
}
506506
case BSL_SECPARAM_USE_KEY_WRAP:
507507
{
508-
const uint64_t arg_val = BSL_SecParam_GetAsUInt64(param);
508+
const uint64_t arg_val = BSL_SecParam_GetAsUint64(param);
509509
BSL_LOG_DEBUG("Param[%" PRIu64 "]: USE_WRAPPED_KEY value = %" PRIu64, param_id, arg_val);
510510
bcb_context->keywrap = arg_val;
511511
break;
@@ -692,7 +692,7 @@ int BSLX_BCB_Execute(BSL_LibCtx_t *lib _U_, BSL_BundleRef_t *bundle, const BSL_S
692692
}
693693

694694
BSL_SecParam_t *aes_param = BSL_calloc(1, BSL_SecParam_Sizeof());
695-
if (BSL_SUCCESS != BSL_SecParam_InitInt64(aes_param, RFC9173_BCB_SECPARAM_AESVARIANT, bcb_context.aes_variant))
695+
if (BSL_SUCCESS != BSL_SecParam_InitUint64(aes_param, RFC9173_BCB_SECPARAM_AESVARIANT, bcb_context.aes_variant))
696696
{
697697
BSL_LOG_ERR("Failed to append BCB AES param");
698698
BSL_SecParam_Deinit(aes_param);
@@ -731,7 +731,7 @@ int BSLX_BCB_Execute(BSL_LibCtx_t *lib _U_, BSL_BundleRef_t *bundle, const BSL_S
731731
}
732732

733733
BSL_SecParam_t *scope_flag_param = BSL_calloc(1, BSL_SecParam_Sizeof());
734-
if (BSL_SUCCESS != BSL_SecParam_InitInt64(scope_flag_param, RFC9173_BCB_SECPARAM_AADSCOPE, bcb_context.aad_scope))
734+
if (BSL_SUCCESS != BSL_SecParam_InitUint64(scope_flag_param, RFC9173_BCB_SECPARAM_AADSCOPE, bcb_context.aad_scope))
735735
{
736736
BSL_LOG_ERR("Failed to append BCB scope flag param");
737737
BSL_SecParam_Deinit(scope_flag_param);

‎src/security_context/BIB_HMAC_SHA2.c‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ bool BSLX_BCB_Validate(BSL_LibCtx_t *lib, const BSL_BundleRef_t *bundle, const B
6262
* Provides the mapping from the security-context-specific ID defined in RFC9173
6363
* to the local ID of the SHA variant used by the crypto engine (OpenSSL).
6464
*/
65-
static int64_t map_rfc9173_sha_variant_to_crypto(int64_t rfc9173_sha_variant)
65+
static int64_t map_rfc9173_sha_variant_to_crypto(uint64_t rfc9173_sha_variant)
6666
{
6767
int64_t crypto_sha_variant = -1;
6868
if (rfc9173_sha_variant == RFC9173_BIB_SHA_HMAC512)
@@ -108,11 +108,11 @@ int BSLX_BIB_InitFromSecOper(BSLX_BIB_t *self, const BSL_BundleRef_t *bundle, co
108108
{
109109
const BSL_SecParam_t *param = BSL_SecOper_GetParamAt(sec_oper, param_index);
110110
uint64_t param_id = BSL_SecParam_GetId(param);
111-
bool is_int = BSL_SecParam_IsInt64(param);
112-
int64_t int_val = -1;
111+
bool is_int = BSL_SecParam_IsUint64(param);
112+
uint64_t int_val = 0;
113113
if (is_int)
114114
{
115-
int_val = BSL_SecParam_GetAsUInt64(param);
115+
int_val = BSL_SecParam_GetAsUint64(param);
116116
}
117117

118118
if (param_id == BSL_SECPARAM_TYPE_KEY_ID)
@@ -149,7 +149,7 @@ int BSLX_BIB_InitFromSecOper(BSLX_BIB_t *self, const BSL_BundleRef_t *bundle, co
149149
}
150150
else if (param_id == BSL_SECPARAM_USE_KEY_WRAP)
151151
{
152-
const uint64_t arg_val = BSL_SecParam_GetAsUInt64(param);
152+
const uint64_t arg_val = BSL_SecParam_GetAsUint64(param);
153153
BSL_LOG_DEBUG("Param[%" PRIu64 "]: USE_WRAPPED_KEY value = %" PRIu64, param_id, arg_val);
154154
self->keywrap = arg_val;
155155
}

‎src/security_context/DefaultSecContext_Private.h‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@ typedef struct BSLX_BIB_s
6464
int64_t integrity_scope_flags;
6565
int64_t sha_variant;
6666
uint64_t hash_size;
67-
uint64_t sha_variant_uint;
68-
int64_t _crypto_sha_variant;
6967
BSL_Data_t wrapped_key;
7068
int64_t keywrap;
7169
uint64_t hmac_result_id;

0 commit comments

Comments
 (0)