diff options
author | vnugent <public@vaughnnugent.com> | 2024-08-12 13:57:11 -0400 |
---|---|---|
committer | vnugent <public@vaughnnugent.com> | 2024-08-12 13:57:11 -0400 |
commit | fa5e809f465fc25d2872fe85983632b77f290062 (patch) | |
tree | e2ffc7daee461ae0946763e3227dfd801f087359 | |
parent | fb3608b9455b3e0956e401e6254da13cebd71558 (diff) |
Squashed commit of the following:v0.1.3
commit a6392806eae7f302031afbcf22664ba33cbc4ad1
Author: vnugent <public@vaughnnugent.com>
Date: Mon Aug 12 13:56:03 2024 -0400
simple cleanup & some api notes
commit a97012676cc836ec50ef5ff6d8e97134aa7a1d22
Merge: ec7461d fb3608b
Author: vnugent <public@vaughnnugent.com>
Date: Wed Aug 7 21:39:28 2024 -0400
Merge branch 'master' into develop
-rw-r--r-- | CMakeLists.txt | 15 | ||||
-rw-r--r-- | include/noscrypt.h | 21 | ||||
-rw-r--r-- | src/nc-util.h | 19 |
3 files changed, 46 insertions, 9 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index 89b2026..4a10738 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -421,9 +421,20 @@ install(TARGETS ${_NC_PROJ_NAME}_static INCLUDES DESTINATION include ) -install(FILES - include/noscrypt.h +SET(NC_INSTALL_HEADERS + include/noscrypt.h #static install headers include/platform.h +) + +if(NC_ENABLE_UTILS) + LIST(APPEND + NC_INSTALL_HEADERS + include/noscryptutil.h + ) +endif() + +install(FILES + ${NC_INSTALL_HEADERS} DESTINATION noscrypt ) diff --git a/include/noscrypt.h b/include/noscrypt.h index 574cef9..3702555 100644 --- a/include/noscrypt.h +++ b/include/noscrypt.h @@ -125,6 +125,27 @@ extern "C" { #define NC_ENC_SET_NIP44_MAC_KEY 0x03 #define NC_ENC_SET_NIP04_KEY 0x04 +/* +* API NOTES: +* +* - Decisions on integer width +* Since noscrypt will target general purpose processors and embedded +* systems (future) I didn't want to risk word size issues causing under/overflow +* for the time being, so a fixed integer width was used and internal code +* supports and guards against the platform default integer width (size_t) +* +* I'd like to support 64bit stuff, but really the underlying systems don't +* need to support that size buffer, nor do I expect platforms to have more than +* 4GB sized buffers (int32_t), it's just not practial and most work is on +* digests anyway. +* +* - Decisions on unsigned vs signed +* Yeah, I know this is a popular squabble in C land, but implementation details +* should not trouble the user. If I expect an unsigned int, then it should be +* explicit, negative number guards are cumbersom to handle return codes with +* that IMO most engineers don't bother doing anyway or doing well at the very +* least, so I'm using unsgined integers. Sorry, not sorry. +*/ /* A compressed resul/return value, negative values are failure, 0 is success and positive values are diff --git a/src/nc-util.h b/src/nc-util.h index a248578..36d26de 100644 --- a/src/nc-util.h +++ b/src/nc-util.h @@ -193,13 +193,10 @@ static _nc_fn_inline void ncSpanWrite(span_t span, uint32_t offset, const uint8_ static _nc_fn_inline void ncSpanAppend(span_t span, uint32_t* offset, const uint8_t* data, uint32_t size) { - DEBUG_ASSERT2(ncSpanIsValid(span), "Expected span to be non-null") DEBUG_ASSERT2(offset != NULL, "Expected offset to be non-null") - DEBUG_ASSERT2(data != NULL, "Expected data to be non-null") - DEBUG_ASSERT2(*offset + size <= span.size, "Expected offset + size to be less than span size") - /* Copy data to span */ - MEMMOV(span.data + *offset, data, size); + /* Copy data to span (also performs argument assertions) */ + ncSpanWrite(span, *offset, data, size); /* Increment offset */ *offset += size; @@ -213,7 +210,11 @@ static _nc_fn_inline span_t ncSpanSlice(span_t span, uint32_t offset, uint32_t s DEBUG_ASSERT2(offset + size <= span.size, "Expected offset + size to be less than span size") /* Initialize slice, offset input data by the specified offset */ - ncSpanInit(&slice, span.data + offset, size); + ncSpanInit( + &slice, + ncSpanGetOffset(span, offset), + size + ); return slice; } @@ -226,7 +227,11 @@ static _nc_fn_inline cspan_t ncSpanSliceC(cspan_t span, uint32_t offset, uint32_ DEBUG_ASSERT2(offset + size <= span.size, "Expected offset + size to be less than span size") /* Initialize slice, offset input data by the specified offset */ - ncSpanInitC(&slice, span.data + offset, size); + ncSpanInitC( + &slice, + ncSpanGetOffsetC(span, offset), + size + ); return slice; } |