Merge pull request #15 from kosmas-valianos/healthcheckHelper

Add helper function to quickly and easy create a v2 healthcheck header

Author: kosmas-valianos

src/proxy_protocol.c

@@ -721,6 +721,16 @@ uint8_t *pp2_create_hdr(const pp_info_t *pp_info, uint16_t *pp2_hdr_len, int32_t
     return pp2_hdr;
 }
 
+uint8_t *pp2_create_healthcheck_hdr(uint16_t *pp2_hdr_len, int32_t *error)
+{
+    pp_info_t pp_info = {
+        .address_family = ADDR_FAMILY_UNSPEC,
+        .transport_protocol = TRANSPORT_PROTOCOL_UNSPEC,
+        .pp2_info.local = 1
+    };
+    return pp2_create_hdr(&pp_info, pp2_hdr_len, error);
+}
+
 static uint8_t *pp1_create_hdr(const pp_info_t *pp_info, uint16_t *pp1_hdr_len, int32_t *error)
 {
     if (pp_info->transport_protocol != TRANSPORT_PROTOCOL_UNSPEC && pp_info->transport_protocol != TRANSPORT_PROTOCOL_STREAM)

src/proxy_protocol.h

@@ -176,13 +176,26 @@ const uint8_t *pp_info_get_azure_linkid(const pp_info_t *pp_info, uint16_t *leng
  */
 void pp_info_clear(pp_info_t *pp_info);
 
+/* Helper to easily create a v2 healthcheck PROXY protocol header.
+ *
+ * Note: There is not an equivalent v1 function because specification 2.6 suggests that senders
+ *       SHOULD build a valid PROXY line i.e. usage of "UNKNOWN" style is discouraged 
+ * 
+ * pp_hdr_len   Pointer to a uint16_t where the length of the create PROXY protocol header will be set
+ * error        Pointer to a int32_t where the error value will be set
+ *                  ERR_NULL No error occurred
+ *                  < 0      Error occurred. Optionally, pp_strerror() with that value can be used to get a descriptive message
+ * return       Pointer to a heap allocated buffer containing the PROXY protocol header. Must be freed with free()
+ */
+uint8_t *pp2_create_healthcheck_hdr(uint16_t *pp2_hdr_len, int32_t *error);
+
 /* Creates a PROXY protocol header considering the information inside the pp_info.
  *
  * version:     0 Create a v1 PROXY protocol header
  *              1 Create a v2 PROXY protocol header
  * pp_info      Pointer to a filled pp_info_t structure whose information will be used for the creation of the PROXY protocol header
  * pp_hdr_len   Pointer to a uint16_t where the length of the create PROXY protocol header will be set
- * error        Pointer to a uint32_t where the error value will be set
+ * error        Pointer to a int32_t where the error value will be set
  *                  ERR_NULL No error occurred
  *                  < 0      Error occurred. Optionally, pp_strerror() with that value can be used to get a descriptive message
  * return       Pointer to a heap allocated buffer containing the PROXY protocol header. Must be freed with free()

tests/test.c

@@ -66,6 +66,7 @@ typedef struct
 {
     const char *name;
     uint8_t     version;
+    uint8_t     create_healthcheck;
     pp_info_t   pp_info_in;
     uint8_t    *raw_bytes_in;
     uint32_t    raw_bytes_in_length;
@@ -447,40 +448,40 @@ int main()
             },
             .add_tlvs = {
                 {
-                    .type = PP2_SUBTYPE_SSL_VERSION,
+                .type = PP2_SUBTYPE_SSL_VERSION,
                     .value_len = 8,
-                    .value = (uint8_t*) "TLSv1.2"
+                    .value = (uint8_t*)"TLSv1.2"
                 },
                 {
                     .type = PP2_SUBTYPE_SSL_CN,
                     .value_len = 18,
-                    .value = (uint8_t*) "proxy-protocol.com"
+                    .value = (uint8_t*)"proxy-protocol.com"
                 },
                 {
                     .type = PP2_SUBTYPE_SSL_CIPHER,
                     .value_len = 28,
-                    .value = (uint8_t*) "ECDHE-RSA-AES128-GCM-SHA256"
+                    .value = (uint8_t*)"ECDHE-RSA-AES128-GCM-SHA256"
                 },
                 {
                     .type = PP2_SUBTYPE_SSL_SIG_ALG,
                     .value_len = 7,
-                    .value = (uint8_t*) "SHA256"
+                    .value = (uint8_t*)"SHA256"
                 },
                 {
                     .type = PP2_SUBTYPE_SSL_KEY_ALG,
                     .value_len = 8,
-                    .value = (uint8_t*) "RSA2048"
+                    .value = (uint8_t*)"RSA2048"
                 },
                 {
                     .type = PP2_TYPE_AWS,
                     .subtype = PP2_SUBTYPE_AWS_VPCE_ID,
                     .value_len = 24,
-                    .value = (uint8_t*) "vpce-24d8ezjk38bchilm4m"
+                    .value = (uint8_t*)"vpce-24d8ezjk38bchilm4m"
                 },
                 {
                     .type = PP2_TYPE_CRC32C,
                     .value_len = 4,
-                    .value = (uint8_t*) "\x43\x84\x86\x4e"
+                    .value = (uint8_t*)"\x43\x84\x86\x4e"
                 },
             },
             .pp_info_out_expected = tests[9].pp_info_in,
@@ -511,27 +512,27 @@ int main()
                 {
                     .type = PP2_SUBTYPE_SSL_VERSION,
                     .value_len = 8,
-                    .value = (uint8_t*) "TLSv1.2"
+                    .value = (uint8_t*)"TLSv1.2"
                 },
                 {
                     .type = PP2_SUBTYPE_SSL_CN,
                     .value_len = 11,
-                    .value = (uint8_t*) "example.com"
+                    .value = (uint8_t*)"example.com"
                 },
                 {
                     .type = PP2_SUBTYPE_SSL_CIPHER,
                     .value_len = 28,
-                    .value = (uint8_t*) "ECDHE-RSA-AES128-GCM-SHA256"
+                    .value = (uint8_t*)"ECDHE-RSA-AES128-GCM-SHA256"
                 },
                 {
                     .type = PP2_SUBTYPE_SSL_SIG_ALG,
                     .value_len = 7,
-                    .value = (uint8_t*) "SHA256"
+                    .value = (uint8_t*)"SHA256"
                 },
                 {
                     .type = PP2_SUBTYPE_SSL_KEY_ALG,
                     .value_len = 8,
-                    .value = (uint8_t*) "RSA2048"
+                    .value = (uint8_t*)"RSA2048"
                 },
             },
         },
@@ -544,6 +545,15 @@ int main()
             },
             .pp_info_out_expected = tests[11].pp_info_in,
         },
+        {
+            .name = "v2 PROXY protocol header: pp2_create_healthcheck_hdr() and parse - LOCAL, AF_UNSPEC",
+            .create_healthcheck = 1,
+            .pp_info_out_expected = {
+                .address_family = ADDR_FAMILY_UNSPEC,
+                .transport_protocol = TRANSPORT_PROTOCOL_UNSPEC,
+                .pp2_info.local = 1
+            },
+        },
     };
 
     /* Run tests */
@@ -574,8 +584,16 @@ int main()
                 }
             }
 
-            uint8_t *pp_hdr = pp_create_hdr(tests[i].version, &tests[i].pp_info_in, &pp_hdr_len, &error);
-            pp_info_clear(&tests[i].pp_info_in);
+            uint8_t *pp_hdr = NULL;
+            if (tests[i].create_healthcheck)
+            {
+                pp_hdr = pp2_create_healthcheck_hdr(&pp_hdr_len, &error);
+            }
+            else
+            {
+                pp_hdr = pp_create_hdr(tests[i].version, &tests[i].pp_info_in, &pp_hdr_len, &error);
+                pp_info_clear(&tests[i].pp_info_in);
+            }
             if (!pp_hdr
                 || error != ERR_NULL
                 || (alignment > 1 && pp_hdr_len % alignment))