Utility word removal from Sigv4 Library (#58)

aws · Aug 26, 2021 · 6348f66 · 6348f66
1 parent 898a4ac
commit 6348f66
Show file tree

Hide file tree

Showing 19 changed files with 50 additions and 53 deletions.
diff --git a/source/include/sigv4.h b/source/include/sigv4.h
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * 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
@@ -22,7 +22,7 @@
 
 /**
  * @file sigv4.h
- * @brief Interface for the SigV4 Client Utility Library.
+ * @brief Interface for the SigV4 Library.
  */
 
 #ifndef SIGV4_H_
@@ -131,12 +131,12 @@
 
 /**
  * @ingroup sigv4_enum_types
- * @brief Return status of the SigV4 Utility Library.
+ * @brief Return status of the SigV4 Library.
  */
 typedef enum SigV4Status
 {
     /**
-     * @brief The SigV4 Utility library function completed successfully.
+     * @brief The SigV4 library function completed successfully.
      *
      * Functions that may return this value:
      * - #SigV4_GenerateHTTPAuthorization
@@ -145,7 +145,7 @@ typedef enum SigV4Status
     SigV4Success,
 
     /**
-     * @brief The SigV4 Utility library function received an invalid input
+     * @brief The SigV4 library function received an invalid input
      * parameter.
      *
      * Functions that may return this value:

diff --git a/source/include/sigv4_config_defaults.h b/source/include/sigv4_config_defaults.h
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * 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
@@ -22,13 +22,12 @@
 
 /**
  * @file sigv4_config_defaults.h
- * @brief The default values for configuration macros used by the SigV4 Utility
- * Library.
+ * @brief The default values for configuration macros used by the SigV4 Library.
  *
  * @note This file should NOT be modified. If custom values are needed for any
  * configuration macros, a sigv4_config.h file should be provided to the SigV4
- * Utility Library to override the default values defined in this file. To use
- * the custom config file, the preprocessor macro SIGV4_DO_NOT_USE_CUSTOM_CONFIG
+ * Library to override the default values defined in this file. To use the custom
+ * config file, the preprocessor macro SIGV4_DO_NOT_USE_CUSTOM_CONFIG
  * must NOT be set.
  */
 
@@ -147,7 +146,7 @@
 
 /**
  * @brief Macro to statically enable support for canonicalizing the URI,
- * headers, and query in this utility.
+ * headers, and query in this library.
  *
  * Set this to one to enable the encoding functions used to create the canonical
  * request.
@@ -160,88 +159,88 @@
 #endif
 
 /**
- * @brief Macro called by the SigV4 Utility library for logging "Error" level
+ * @brief Macro called by the SigV4 library for logging "Error" level
  * messages.
  *
- * To enable error level logging in the SigV4 Utility library, this macro should
+ * To enable error level logging in the SigV4 library, this macro should
  * be mapped to the application-specific logging implementation that supports
  * error logging.
  *
- * @note This logging macro is called in the SigV4 Utility library with
+ * @note This logging macro is called in the SigV4 library with
  * parameters wrapped in double parentheses to be ISO C89/C90 standard
  * compliant. For a reference POSIX implementation of the logging macros, refer
  * to sigv4_config.h files, and the logging-stack in demos folder of the [AWS
  * IoT Embedded C SDK
  * repository](https://github.com/aws/aws-iot-device-sdk-embedded-C).
  *
  * <b>Default value</b>: Error logging is turned off, and no code is generated
- * for calls to the macro in the SigV4 Utility library on compilation.
+ * for calls to the macro in the SigV4 library on compilation.
  */
 #ifndef LogError
     #define LogError( message )
 #endif
 
 /**
- * @brief Macro called by the the SigV4 Utility library for logging "Warning"
+ * @brief Macro called by the the SigV4 library for logging "Warning"
  * level messages.
  *
- * To enable warning level logging in the SigV4 Utility library, this macro
+ * To enable warning level logging in the SigV4 library, this macro
  * should be mapped to the application-specific logging implementation that
  * supports warning logging.
  *
- * @note This logging macro is called in the SigV4 Utility library with
+ * @note This logging macro is called in the SigV4 library with
  * parameters wrapped in double parentheses to be ISO C89/C90 standard
  * compliant. For a reference POSIX implementation of the logging macros, refer
  * to sigv4_config.h files, and the logging-stack in demos folder of the [AWS
  * IoT Embedded C SDK
  * repository](https://github.com/aws/aws-iot-device-sdk-embedded-C).
  *
  * <b>Default value</b>: Warning logs are turned off, and no code is generated
- * for calls to the macro in the SigV4 Utility library on compilation.
+ * for calls to the macro in the SigV4 library on compilation.
  */
 #ifndef LogWarn
     #define LogWarn( message )
 #endif
 
 /**
- * @brief Macro called by the the SigV4 Utility library for logging "Info" level
+ * @brief Macro called by the the SigV4 library for logging "Info" level
  * messages.
  *
- * To enable info level logging in the SigV4 Utility library, this macro should
+ * To enable info level logging in the SigV4 library, this macro should
  * be mapped to the application-specific logging implementation that supports
  * info logging.
  *
- * @note This logging macro is called in the SigV4 Utility library with
+ * @note This logging macro is called in the SigV4 library with
  * parameters wrapped in double parentheses to be ISO C89/C90 standard
  * compliant. For a reference POSIX implementation of the logging macros, refer
  * to sigv4_config.h files, and the logging-stack in demos folder of the [AWS
  * IoT Embedded C SDK
  * repository](https://github.com/aws/aws-iot-device-sdk-embedded-C).
  *
  * <b>Default value</b>: Info logging is turned off, and no code is generated
- * for calls to the macro in the SigV4 Utility library on compilation.
+ * for calls to the macro in the SigV4 library on compilation.
  */
 #ifndef LogInfo
     #define LogInfo( message )
 #endif
 
 /**
- * @brief Macro called by the the SigV4 Utility library for logging "Debug"
+ * @brief Macro called by the the SigV4 library for logging "Debug"
  * level messages.
  *
- * To enable debug level logging from SigV4 Utility library, this macro should
+ * To enable debug level logging from SigV4 library, this macro should
  * be mapped to the application-specific logging implementation that supports
  * debug logging.
  *
- * @note This logging macro is called in the SigV4 Utility library with
+ * @note This logging macro is called in the SigV4 library with
  * parameters wrapped in double parentheses to be ISO C89/C90 standard
  * compliant. For a reference POSIX implementation of the logging macros, refer
  * to sigv4_config.h files, and the logging-stack in demos folder of the [AWS
  * IoT Embedded C SDK
  * repository](https://github.com/aws/aws-iot-device-sdk-embedded-C).
  *
  * <b>Default value</b>: Debug logging is turned off, and no code is generated
- * for calls to the macro in the SigV4 Utility library on compilation.
+ * for calls to the macro in the SigV4 library on compilation.
  */
 #ifndef LogDebug
     #define LogDebug( message )

diff --git a/source/include/sigv4_internal.h b/source/include/sigv4_internal.h
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -22,7 +22,7 @@
 
 /**
  * @file sigv4_internal.h
- * @brief Internal definitions for the SigV4 Client Utility Library.
+ * @brief Internal definitions for the SigV4 Library.
  */
 
 #ifndef SIGV4_INTERNAL_H_

diff --git a/source/include/sigv4_quicksort.h b/source/include/sigv4_quicksort.h
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -22,7 +22,7 @@
 
 /**
  * @file sigv4_quicksort.h
- * @brief Declaration of Quicksort function for the SigV4 Client Utility Library.
+ * @brief Declaration of Quicksort function for the SigV4 Library.
  */
 
 #ifndef SIGV4_QUICKSORT_H_

diff --git a/source/sigv4.c b/source/sigv4.c
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * Copyright (C) 2021 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/sigv4_quicksort.c b/source/sigv4_quicksort.c
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -22,7 +22,7 @@
 
 /**
  * @file sigv4_quicksort.c
- * @brief Implements an Iterative Quicksort Algorithm for the SigV4 Client Utility Library.
+ * @brief Implements an Iterative Quicksort Algorithm for the SigV4 Library.
  */
 
 #include "sigv4_quicksort.h"

diff --git a/test/cbmc/include/hash_stubs.h b/test/cbmc/include/hash_stubs.h
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * Copyright (C) 2021 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/sigv4_annex.h b/test/cbmc/include/sigv4_annex.h
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * Copyright (C) 2021 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/sigv4_config.h b/test/cbmc/include/sigv4_config.h
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * 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
@@ -22,12 +22,11 @@
 
 /**
  * @file sigv4_config.h
- * @brief The default values for configuration macros used by the SigV4 Utility
- * Library.
+ * @brief The default values for configuration macros used by the SigV4 Library.
  *
  * @note This file should NOT be modified. If custom values are needed for any
  * configuration macros, a sigv4_config.h file should be provided to the SigV4
- * Utility Library to override the default values defined in this file. To use
+ * Library to override the default values defined in this file. To use
  * the custom config file, the preprocessor macro SIGV4_DO_NOT_USE_CUSTOM_CONFIG
  * must NOT be set.
  */

diff --git a/test/cbmc/include/sigv4_stubs.h b/test/cbmc/include/sigv4_stubs.h
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * Copyright (C) 2021 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/SigV4_AwsIotDateToIso8601/SigV4_AwsIotDateToIso8601_harness.c b/test/cbmc/proofs/SigV4_AwsIotDateToIso8601/SigV4_AwsIotDateToIso8601_harness.c
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * Copyright (C) 2021 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/SigV4_GenerateHTTPAuthorization/SigV4_GenerateHTTPAuthorization_harness.c b/test/cbmc/proofs/SigV4_GenerateHTTPAuthorization/SigV4_GenerateHTTPAuthorization_harness.c
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * Copyright (C) 2021 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/...cbmc/proofs/copyHeaderStringToCanonicalBuffer/copyHeaderStringToCanonicalBuffer_harness.c b/...cbmc/proofs/copyHeaderStringToCanonicalBuffer/copyHeaderStringToCanonicalBuffer_harness.c
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * Copyright (C) 2021 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/hash_stubs.c b/test/cbmc/stubs/hash_stubs.c
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * Copyright (C) 2021 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/memcpy.c b/test/cbmc/stubs/memcpy.c
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * 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/memmove.c b/test/cbmc/stubs/memmove.c
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * 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/sigv4_stubs.c b/test/cbmc/stubs/sigv4_stubs.c
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * Copyright (C) 2021 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/unit-test/sigv4_config.h b/test/unit-test/sigv4_config.h
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * 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
@@ -22,12 +22,11 @@
 
 /**
  * @file sigv4_config.h
- * @brief The default values for configuration macros used by the SigV4 Utility
- * Library.
+ * @brief The default values for configuration macros used by the SigV4 Library.
  *
  * @note This file should NOT be modified. If custom values are needed for any
  * configuration macros, a sigv4_config.h file should be provided to the SigV4
- * Utility Library to override the default values defined in this file. To use
+ * Library to override the default values defined in this file. To use
  * the custom config file, the preprocessor macro SIGV4_DO_NOT_USE_CUSTOM_CONFIG
  * must NOT be set.
  */

diff --git a/test/unit-test/sigv4_utest.c b/test/unit-test/sigv4_utest.c
@@ -1,5 +1,5 @@
 /*
- * SigV4 Utility Library v1.0.0
+ * SigV4 Library v1.0.0
  * Copyright (C) 2021 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy of