From 774932e5370ba38e0a06029794790c6e25829061 Mon Sep 17 00:00:00 2001 From: Nandor Kracser Date: Fri, 15 Aug 2025 10:33:11 +0200 Subject: [PATCH 1/5] docs: update README to clarify cryptographic backend integration and build prerequisites --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 79d33ed..0f054eb 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This project provides a C implementation of AWS Signature Version 4 (SigV4) sign ## Features - AWS SigV4 signing for HTTP requests -- OpenSSL integration for cryptographic operations +- Pluggable cryptographic backend integration (not limited to OpenSSL) - Simple API for integration into C projects - Example usage included - System header configurability via `SIGV4_SYSTEM_HEADER` @@ -13,11 +13,16 @@ This project provides a C implementation of AWS Signature Version 4 (SigV4) sign ### Prerequisites - GCC or compatible C compiler -- OpenSSL development libraries - `pkg-config` utility +- OpenSSL for testing, and examples +- libcheck for testing ### Build Instructions +```sh +sudo apt install libssl-dev check +``` + To build the shared library and example application, run: ```sh @@ -51,10 +56,10 @@ Include the header in your application: #include "sigv4.h" ``` -Link against the shared library and OpenSSL: +Link against the shared library and your selected crypto backend: ``` --L. -lsigv4 $(pkg-config --libs libssl) +-L. -lsigv4 [crypto backend linkage] ``` ### Example From 3db5bdd6478e2535189b7e4b352a7f574a3cd704 Mon Sep 17 00:00:00 2001 From: Nandor Kracser Date: Fri, 15 Aug 2025 10:37:54 +0200 Subject: [PATCH 2/5] add some links --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0f054eb..578c14d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This project provides a C implementation of AWS Signature Version 4 (SigV4) sign - AWS SigV4 signing for HTTP requests - Pluggable cryptographic backend integration (not limited to OpenSSL) - Simple API for integration into C projects -- Example usage included +- Example usage and tests included - System header configurability via `SIGV4_SYSTEM_HEADER` ## Building @@ -14,8 +14,8 @@ This project provides a C implementation of AWS Signature Version 4 (SigV4) sign ### Prerequisites - GCC or compatible C compiler - `pkg-config` utility -- OpenSSL for testing, and examples -- libcheck for testing +- [OpenSSL](https://github.com/openssl/openssl) for testing, and examples +- [libcheck](https://github.com/libcheck/check) for testing ### Build Instructions From 00dd23834469e5b5b8dbd7f6cf7bd8088639f01d Mon Sep 17 00:00:00 2001 From: Nandor Kracser Date: Fri, 15 Aug 2025 10:39:27 +0200 Subject: [PATCH 3/5] docs: add acknowledgments section to README for original library creator --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 578c14d..3ffb7ca 100644 --- a/README.md +++ b/README.md @@ -70,3 +70,7 @@ See `LICENSE` for details. ## Contributing Pull requests and issues are welcome! + +## Acknowledgments + +Special thanks to Shi Bai, who created the original version of this library: https://github.com/sidbai/aws-sigv4-c From 65ad2b0580826bed65ca1b3f2f3fea6dbdee983e Mon Sep 17 00:00:00 2001 From: Nandor Kracser Date: Fri, 15 Aug 2025 10:40:54 +0200 Subject: [PATCH 4/5] docs: add note about no dynamic memory allocations in features section --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 3ffb7ca..b935c02 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ This project provides a C implementation of AWS Signature Version 4 (SigV4) sign ## Features - AWS SigV4 signing for HTTP requests +- No dynamic memory allocations - Pluggable cryptographic backend integration (not limited to OpenSSL) - Simple API for integration into C projects - Example usage and tests included From a86f17e305ccaab8c5426105164497d9f1564002 Mon Sep 17 00:00:00 2001 From: Nandor Kracser Date: Fri, 15 Aug 2025 10:43:44 +0200 Subject: [PATCH 5/5] docs: add build status badge to README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b935c02..84bc980 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # AWS SigV4 C Library +[![Build](https://github.com/riptideslabs/libsigv4/actions/workflows/build.yml/badge.svg)](https://github.com/riptideslabs/libsigv4/actions/workflows/build.yml) + This project provides a C implementation of AWS Signature Version 4 (SigV4) signing, suitable for use in embedded, kernel, or user-space applications. It includes a shared library and an example application demonstrating usage. ## Features