Refactor C headers into nat20/types.h (#79)

werwurm · web-flow · commit ba32e51e9651 · 2026-02-27T09:56:20.000-08:00
Move common C headers into nat20/types.h so that necessary target
platform customizations can be made in one place.
Also add nat20/endian.h and nat20/limits.h and replace the posix type
ssize_t with the C type ptrdiff_t.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -89,8 +89,10 @@ set(LIBNAT20_PUB_HEADERS
     include/nat20/cbor.h
     include/nat20/constants.h
     include/nat20/crypto.h
+    include/nat20/endian.h
     include/nat20/error.h
     include/nat20/functionality.h
+    include/nat20/limits.h
     include/nat20/oid.h
     include/nat20/open_dice.h
     include/nat20/stream.h
diff --git a/include/nat20/asn1.h b/include/nat20/asn1.h
@@ -19,9 +19,6 @@
 #include <nat20/oid.h>
 #include <nat20/stream.h>
 #include <nat20/types.h>
-#include <stdbool.h>
-#include <stdint.h>
-#include <unistd.h>
 
 /** @file */
 
diff --git a/include/nat20/cbor.h b/include/nat20/cbor.h
@@ -18,8 +18,6 @@
 
 #include <nat20/stream.h>
 #include <nat20/types.h>
-#include <stdint.h>
-#include <unistd.h>
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/include/nat20/crypto.h b/include/nat20/crypto.h
@@ -20,8 +20,6 @@
 
 #include <nat20/error.h>
 #include <nat20/types.h>
-#include <stdint.h>
-#include <unistd.h>
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/include/nat20/crypto/nat20/sha.h b/include/nat20/crypto/nat20/sha.h
@@ -27,8 +27,6 @@
 #pragma once
 
 #include <nat20/types.h>
-#include <stddef.h>
-#include <stdint.h>
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/include/nat20/endian.h b/include/nat20/endian.h
@@ -0,0 +1,34 @@
+/*
+ * Copyright 2026 Aurora Operations, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** @file Homogeneous Endian definitions for various environments. */
+
+#pragma once
+
+#ifdef __KERNEL__
+#include <asm/byteorder.h>
+#ifdef __LITTLE_ENDIAN
+#define LITTLE_ENDIAN __LITTLE_ENDIAN
+#define BIG_ENDIAN (~(__LITTLE_ENDIAN))
+#define BYTE_ORDER __LITTLE_ENDIAN
+#else
+#define LITTLE_ENDIAN (~(__BIG_ENDIAN))
+#define BIG_ENDIAN __BIG_ENDIAN
+#define BYTE_ORDER __BIG_ENDIAN
+#endif
+#else
+#include <endian.h>
+#endif
diff --git a/include/nat20/functionality.h b/include/nat20/functionality.h
@@ -26,8 +26,6 @@
 #include <nat20/types.h>
 #include <nat20/x509.h>
 #include <nat20/x509_ext_open_dice_input.h>
-#include <stddef.h>
-#include <stdint.h>
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/include/nat20/limits.h b/include/nat20/limits.h
@@ -0,0 +1,25 @@
+/*
+ * Copyright 2026 Aurora Operations, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** @file Homogeneous Limits definitions for various environments. */
+
+#pragma once
+
+#ifdef __KERNEL__
+#include <linux/limits.h>
+#else
+#include <limits.h>
+#endif
diff --git a/include/nat20/oid.h b/include/nat20/oid.h
@@ -16,9 +16,7 @@
 
 #pragma once
 
-#include <stdbool.h>
-#include <stdint.h>
-#include <unistd.h>
+#include <nat20/types.h>
 
 /** @file
  *
diff --git a/include/nat20/service/messages.h b/include/nat20/service/messages.h
@@ -20,7 +20,6 @@
 #include <nat20/crypto.h>
 #include <nat20/open_dice.h>
 #include <nat20/types.h>
-#include <stddef.h>
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/include/nat20/stream.h b/include/nat20/stream.h
@@ -19,9 +19,6 @@
 /** @file */
 
 #include <nat20/types.h>
-#include <stdbool.h>
-#include <stddef.h>
-#include <stdint.h>
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/include/nat20/types.h b/include/nat20/types.h
@@ -18,8 +18,27 @@
 
 #pragma once
 
+#ifdef __KERNEL__
+#include <linux/string.h>
+#include <linux/types.h>
+#else
+#include <stdbool.h>
+#include <stddef.h>
 #include <stdint.h>
-#include <unistd.h>
+#include <string.h>
+#endif
+
+#ifndef fallthrough
+#if __cplusplus >= 201703L
+#define fallthrough [[fallthrough]]
+#elif defined(__GNUC__) && __GNUC__ >= 7
+#define fallthrough __attribute__((fallthrough))
+#else
+#define fallthrough \
+    do {            \
+    } while (0)
+#endif
+#endif  // fallthrough
 
 #ifdef __cplusplus
 extern "C" {
@@ -53,7 +72,7 @@ struct n20_slice_s {
      *
      * A buffer with a capacity of at least @ref size bytes or NULL.
      */
-    uint8_t const *buffer;
+    uint8_t const* buffer;
 };
 
 /**
@@ -103,7 +122,7 @@ struct n20_string_slice_s {
      *
      * A buffer with a capacity of at least @ref size bytes or NULL.
      */
-    char const *buffer;
+    char const* buffer;
 };
 
 /**
diff --git a/include/nat20/x509_ext_tcg_dice_tcb_freshness.h b/include/nat20/x509_ext_tcg_dice_tcb_freshness.h
@@ -20,8 +20,7 @@
 
 #include <nat20/asn1.h>
 #include <nat20/oid.h>
-#include <stddef.h>
-#include <stdint.h>
+#include <nat20/types.h>
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/include/nat20/x509_ext_tcg_dice_tcb_info.h b/include/nat20/x509_ext_tcg_dice_tcb_info.h
@@ -20,8 +20,7 @@
 
 #include <nat20/asn1.h>
 #include <nat20/oid.h>
-#include <stddef.h>
-#include <stdint.h>
+#include <nat20/types.h>
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/include/nat20/x509_ext_tcg_dice_ueid.h b/include/nat20/x509_ext_tcg_dice_ueid.h
@@ -20,8 +20,7 @@
 
 #include <nat20/asn1.h>
 #include <nat20/oid.h>
-#include <stddef.h>
-#include <stdint.h>
+#include <nat20/types.h>
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/src/core/asn1.c b/src/core/asn1.c
@@ -14,13 +14,11 @@
  * limitations under the License.
  */
 
-#include <endian.h>
 #include <nat20/asn1.h>
+#include <nat20/endian.h>
 #include <nat20/oid.h>
 #include <nat20/stream.h>
 #include <nat20/types.h>
-#include <stdbool.h>
-#include <string.h>
 
 void n20_asn1_base128_int(n20_stream_t *const s, uint64_t n) {
     // The integer n is written 7 bits at a time starting with the least
@@ -186,7 +184,7 @@ static void n20_asn1_integer_internal_content(n20_stream_t *const s, void *ctx)
     // compilation unit and assure that it is never NULL.
     uint8_t const *msb = number->n.buffer;
     uint8_t const *end = number->n.buffer + number->n.size;
-    ssize_t inc = 1;
+    ptrdiff_t inc = 1;
     int add_extra = 0;
     uint8_t extra = 0;
 
diff --git a/src/core/cbor.c b/src/core/cbor.c
@@ -15,10 +15,9 @@
  */
 
 #include <nat20/cbor.h>
+#include <nat20/limits.h>
 #include <nat20/stream.h>
 #include <nat20/types.h>
-#include <stddef.h>
-#include <stdint.h>
 
 void n20_cbor_write_header(n20_stream_t *const s, n20_cbor_type_t cbor_type, uint64_t n) {
     if ((unsigned int)cbor_type > 7) {
diff --git a/src/core/functionality.c b/src/core/functionality.c
@@ -24,9 +24,6 @@
 #include <nat20/x509.h>
 #include <nat20/x509_ext_open_dice_input.h>
 #include <nat20/x509_ext_tcg_dice_tcb_freshness.h>
-#include <stddef.h>
-#include <stdint.h>
-#include <string.h>
 
 /*
  * Buffer holding the utf-8 encoded string "CDI_Attest".
@@ -573,7 +570,7 @@ n20_error_t n20_eca_ee_sign_message(n20_crypto_context_t *crypto_ctx,
     switch (key_usage.size) {
         default:
             cert_info.key_usage[1] = key_usage.buffer[1];
-            /* fallthrough */
+            fallthrough;
         case 1:
             cert_info.key_usage[0] = key_usage.buffer[0];
             break;
diff --git a/src/core/oid.c b/src/core/oid.c
@@ -15,7 +15,7 @@
  */
 
 #include <nat20/oid.h>
-#include <stdbool.h>
+#include <nat20/types.h>
 
 N20_ASN1_DEFINE_OID(OID_RSA_ENCRYPTION, 1, 2, 840, 113549, 1, 1, 1);
 N20_ASN1_DEFINE_OID(OID_SHA256_WITH_RSA_ENC, 1, 2, 840, 113549, 1, 1, 11);
diff --git a/src/core/stream.c b/src/core/stream.c
@@ -16,7 +16,6 @@
 
 #include <nat20/stream.h>
 #include <nat20/types.h>
-#include <string.h>
 
 void n20_stream_init(n20_stream_t *s, uint8_t *const buffer, size_t buffer_size) {
     if (s == NULL) return;
diff --git a/src/crypto/nat20/crypto.c b/src/crypto/nat20/crypto.c
@@ -17,13 +17,8 @@
 #include <nat20/crypto.h>
 #include <nat20/crypto/nat20/crypto.h>
 #include <nat20/crypto/nat20/sha.h>
-#include <stddef.h>
-#include <stdint.h>
-#include <string.h>
-#include <sys/types.h>
-
-#include "nat20/error.h"
-#include "nat20/types.h"
+#include <nat20/error.h>
+#include <nat20/types.h>
 
 union n20_digest_state_u {
     n20_sha384_sha512_state_t sha_512;
diff --git a/src/crypto/nat20/sha256.c b/src/crypto/nat20/sha256.c
@@ -15,7 +15,7 @@
  */
 
 #include <nat20/crypto/nat20/sha.h>
-#include <stdint.h>
+#include <nat20/types.h>
 
 n20_sha224_sha256_state_t n20_sha256_init(void) {
     n20_sha224_sha256_state_t state = {0};
diff --git a/src/crypto/nat20/sha512.c b/src/crypto/nat20/sha512.c
@@ -15,7 +15,7 @@
  */
 
 #include <nat20/crypto/nat20/sha.h>
-#include <stdint.h>
+#include <nat20/types.h>
 
 n20_sha384_sha512_state_t n20_sha512_init(void) {
     n20_sha384_sha512_state_t state = {0};
diff --git a/src/service/messages.c b/src/service/messages.c
@@ -19,7 +19,6 @@
 #include <nat20/service/messages.h>
 #include <nat20/stream.h>
 #include <nat20/types.h>
-#include <sys/types.h>
 
 #define N20_MSG_LABEL_ISSUER_KEY_TYPE 1
 #define N20_MSG_LABEL_SUBJECT_KEY_TYPE 2

Original file line number	Diff line number	Diff line change
`@@ -16,9 +16,7 @@`
`16`	`16`
`17`	`17`	`#pragma once`
`18`	`18`
`19`		`-#include <stdbool.h>`
`20`		`-#include <stdint.h>`
`21`		`-#include <unistd.h>`
	`19`	`+#include <nat20/types.h>`
`22`	`20`
`23`	`21`	`/** @file`
`24`	`22`	`*`