Update CHANGELOG, version numbers, and add C++ header guards (#109)

* Update CHANGELOG, version numbers, and add C++ header guards * Attach PRs to updates * Update memory stats * Add md to lexicon.txt
FreeRTOS · Jul 23, 2021 · 9f511d5 · 9f511d5
1 parent 4c896b9
commit 9f511d5
Show file tree

Hide file tree

Showing 47 changed files with 113 additions and 45 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -123,4 +123,4 @@ jobs:
         uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main
         with:
             config: .github/memory_statistics_config.json
-            check_against: docs/doxygen/include/size_table.html
+            check_against: docs/doxygen/include/size_table.md
diff --git a/.github/workflows/memory_statistics.yml b/.github/workflows/memory_statistics.yml
@@ -19,4 +19,4 @@ jobs:
         uses: actions/upload-artifact@v2
         with:
           name: size_table
-          path: size_table.html
+          path: size_table.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog for coreHTTP Client Library
 
+## v2.0.2 (July 2021)
+
+### Updates
+
+- [#109](https://github.com/FreeRTOS/coreHTTP/pull/109) Add C++ header guards
+- [#106](https://github.com/FreeRTOS/coreHTTP/pull/106) Update case-insensitive compare function for header-field parser
+- [#104](https://github.com/FreeRTOS/coreHTTP/pull/104) Update CBMC proofs to work with the latest version of CBMC
+
 ## v2.0.1 (February 2021)
 
 ### Other

diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ score over 8. This library has also undergone both static code analysis from
 safety and data structure invariance through the
 [CBMC automated reasoning tool](https://www.cprover.org/cbmc/).
 
-See memory requirements for this library [here](https://docs.aws.amazon.com/embedded-csdk/202103.00/lib-ref/libraries/standard/coreHTTP/docs/doxygen/output/html/index.html#http_memory_requirements).
+See memory requirements for this library [here](./docs/doxygen/include/size_table.md).
 
 **coreHTTP v2.0.0 [source code](https://github.com/FreeRTOS/coreHTTP/tree/v2.0.0/source) is part of the [FreeRTOS 202012.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.00-LTS) release.**
 
@@ -82,8 +82,19 @@ The AWS IoT Device SDK for Embedded C repository contains demos of using the HTT
 library [here](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/http)
 on a POSIX platform. These can be used as reference examples for the library API.
 
-## Generating documentation
+## Documentation
 
+### Existing Documentation
+For pre-generated documentation, please see the documentation linked in the locations below:
+
+| Location |
+| :-: |
+| [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) |
+| [FreeRTOS.org](https://freertos.org/Documentation/api-ref/coreHTTP/docs/doxygen/output/html/index.html) |
+
+Note that the latest included version of coreHTTP may differ across repositories.
+
+### Generating Documentation
 The Doxygen references were created using Doxygen version 1.8.20. To generate the
 Doxygen pages, please run the following command from the root of this repository:
 

diff --git a/docs/doxygen/config.doxyfile b/docs/doxygen/config.doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME           = "coreHTTP"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "v2.0.1"
+PROJECT_NUMBER         = "v2.0.2"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

diff --git a/docs/doxygen/include/size_table.html → docs/doxygen/include/size_table.md b/docs/doxygen/include/size_table.html → docs/doxygen/include/size_table.md
diff --git a/docs/doxygen/pages.dox b/docs/doxygen/pages.dox
@@ -17,7 +17,7 @@ Feature of HTTP/1.1 not supported in this library:
 @section http_memory_requirements Memory Requirements
 @brief Memory requirements of the HTTP Client library.
 
-@include{doc} size_table.html
+@include{doc} size_table.md
  */
 
 /**

diff --git a/lexicon.txt b/lexicon.txt
@@ -128,6 +128,7 @@ loginfo
 logwarn
 mainpage
 malloc
+md
 memcpy
 memmove
 methodlen

diff --git a/manifest.yml b/manifest.yml
@@ -1,5 +1,5 @@
 name : "coreHTTP"
-version: "v2.0.1"
+version: "v2.0.2"
 description: |
   "Client implementation of the HTTP/1.1 specification for embedded devices.\n"
 dependencies:

diff --git a/source/core_http_client.c b/source/core_http_client.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/source/include/core_http_client.h b/source/include/core_http_client.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -31,6 +31,12 @@
 #include <stdint.h>
 #include <stddef.h>
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    extern "C" {
+#endif
+/* *INDENT-ON* */
+
 /* HTTP_DO_NOT_USE_CUSTOM_CONFIG allows building the HTTP Client library
  * without a config file. If a config file is provided, the
  * HTTP_DO_NOT_USE_CUSTOM_CONFIG macro must not be defined.
@@ -893,4 +899,10 @@ HTTPStatus_t HTTPClient_ReadHeader( const HTTPResponse_t * pResponse,
 const char * HTTPClient_strerror( HTTPStatus_t status );
 /* @[declare_httpclient_strerror] */
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    }
+#endif
+/* *INDENT-ON* */
+
 #endif /* ifndef CORE_HTTP_CLIENT_H_ */
diff --git a/source/include/core_http_client_private.h b/source/include/core_http_client_private.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -31,6 +31,12 @@
 /* Third-party http-parser include. */
 #include "http_parser.h"
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    extern "C" {
+#endif
+/* *INDENT-ON* */
+
 /**
  * @brief The HTTP protocol version of this library is HTTP/1.1.
  */
@@ -267,4 +273,10 @@ typedef struct HTTPParsingContext
     size_t lastHeaderValueLen;     /**< The length of the last value field parsed. */
 } HTTPParsingContext_t;
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    }
+#endif
+/* *INDENT-ON* */
+
 #endif /* ifndef CORE_HTTP_CLIENT_PRIVATE_H_ */
diff --git a/source/include/core_http_config_defaults.h b/source/include/core_http_config_defaults.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -35,6 +35,12 @@
 #ifndef CORE_HTTP_CONFIG_DEFAULTS_
 #define CORE_HTTP_CONFIG_DEFAULTS_
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    extern "C" {
+#endif
+/* *INDENT-ON* */
+
 /**
  * @brief Maximum size, in bytes, of headers allowed from the server.
  *
@@ -191,4 +197,10 @@
     #define LogDebug( message )
 #endif
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    }
+#endif
+/* *INDENT-ON* */
+
 #endif /* ifndef CORE_HTTP_CONFIG_DEFAULTS_ */
diff --git a/source/interface/transport_interface.h b/source/interface/transport_interface.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -31,6 +31,12 @@
 #include <stdint.h>
 #include <stddef.h>
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    extern "C" {
+#endif
+/* *INDENT-ON* */
+
 /**
  * @transportpage
  * @brief The transport interface definition.
@@ -250,4 +256,10 @@ typedef struct TransportInterface
 } TransportInterface_t;
 /* @[define_transportinterface] */
 
+/* *INDENT-OFF* */
+#ifdef __cplusplus
+    }
+#endif
+/* *INDENT-ON* */
+
 #endif /* ifndef TRANSPORT_INTERFACE_H_ */
diff --git a/test/cbmc/include/callback_stubs.h b/test/cbmc/include/callback_stubs.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/include/core_http_config.h b/test/cbmc/include/core_http_config.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/include/get_time_stub.h b/test/cbmc/include/get_time_stub.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/include/http_cbmc_state.h b/test/cbmc/include/http_cbmc_state.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/include/transport_interface_stubs.h b/test/cbmc/include/transport_interface_stubs.h
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/HTTPClient_AddHeader/HTTPClient_AddHeader_harness.c b/test/cbmc/proofs/HTTPClient_AddHeader/HTTPClient_AddHeader_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/HTTPClient_AddRangeHeader/HTTPClient_AddRangeHeader_harness.c b/test/cbmc/proofs/HTTPClient_AddRangeHeader/HTTPClient_AddRangeHeader_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/.../proofs/HTTPClient_InitializeRequestHeaders/HTTPClient_InitializeRequestHeaders_harness.c b/.../proofs/HTTPClient_InitializeRequestHeaders/HTTPClient_InitializeRequestHeaders_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/HTTPClient_ReadHeader/HTTPClient_ReadHeader_harness.c b/test/cbmc/proofs/HTTPClient_ReadHeader/HTTPClient_ReadHeader_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/HTTPClient_Send/HTTPClient_Send_harness.c b/test/cbmc/proofs/HTTPClient_Send/HTTPClient_Send_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/HTTPClient_strerror/HTTPClient_strerror_harness.c b/test/cbmc/proofs/HTTPClient_strerror/HTTPClient_strerror_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/findHeaderFieldParserCallback/findHeaderFieldParserCallback_harness.c b/test/cbmc/proofs/findHeaderFieldParserCallback/findHeaderFieldParserCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/...mc/proofs/findHeaderOnHeaderCompleteCallback/findHeaderOnHeaderCompleteCallback_harness.c b/...mc/proofs/findHeaderOnHeaderCompleteCallback/findHeaderOnHeaderCompleteCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/findHeaderValueParserCallback/findHeaderValueParserCallback_harness.c b/test/cbmc/proofs/findHeaderValueParserCallback/findHeaderValueParserCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/httpParserOnBodyCallback/httpParserOnBodyCallback_harness.c b/test/cbmc/proofs/httpParserOnBodyCallback/httpParserOnBodyCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/httpParserOnHeaderFieldCallback/httpParserOnHeaderFieldCallback_harness.c b/test/cbmc/proofs/httpParserOnHeaderFieldCallback/httpParserOnHeaderFieldCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/httpParserOnHeaderValueCallback/httpParserOnHeaderValueCallback_harness.c b/test/cbmc/proofs/httpParserOnHeaderValueCallback/httpParserOnHeaderValueCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/.../proofs/httpParserOnHeadersCompleteCallback/httpParserOnHeadersCompleteCallback_harness.c b/.../proofs/httpParserOnHeadersCompleteCallback/httpParserOnHeadersCompleteCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/httpParserOnMessageBeginCallback/httpParserOnMessageBeginCallback_harness.c b/test/cbmc/proofs/httpParserOnMessageBeginCallback/httpParserOnMessageBeginCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/.../proofs/httpParserOnMessageCompleteCallback/httpParserOnMessageCompleteCallback_harness.c b/.../proofs/httpParserOnMessageCompleteCallback/httpParserOnMessageCompleteCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/proofs/httpParserOnStatusCallback/httpParserOnStatusCallback_harness.c b/test/cbmc/proofs/httpParserOnStatusCallback/httpParserOnStatusCallback_harness.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/sources/http_cbmc_state.c b/test/cbmc/sources/http_cbmc_state.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/HTTPClient_ReadHeader_http_parser_execute.c b/test/cbmc/stubs/HTTPClient_ReadHeader_http_parser_execute.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/HTTPClient_Send_http_parser_execute.c b/test/cbmc/stubs/HTTPClient_Send_http_parser_execute.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of

diff --git a/test/cbmc/stubs/callback_stubs.c b/test/cbmc/stubs/callback_stubs.c
@@ -1,5 +1,5 @@
 /*
- * coreHTTP v2.0.1
+ * coreHTTP v2.0.2
  * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of