AWS IoT Device SDK C++ v2
1.34.0
AWS IoT Device SDK C++ v2
|
#include <Sigv4Signing.h>
Public Member Functions | |
AwsSigningConfig (Allocator *allocator=ApiAllocator()) | |
virtual | ~AwsSigningConfig () |
virtual SigningConfigType | GetType () const noexcept override |
SigningAlgorithm | GetSigningAlgorithm () const noexcept |
void | SetSigningAlgorithm (SigningAlgorithm algorithm) noexcept |
SignatureType | GetSignatureType () const noexcept |
void | SetSignatureType (SignatureType signatureType) noexcept |
const Crt::String & | GetRegion () const noexcept |
void | SetRegion (const Crt::String ®ion) noexcept |
const Crt::String & | GetService () const noexcept |
void | SetService (const Crt::String &service) noexcept |
DateTime | GetSigningTimepoint () const noexcept |
void | SetSigningTimepoint (const DateTime &date) noexcept |
bool | GetUseDoubleUriEncode () const noexcept |
void | SetUseDoubleUriEncode (bool useDoubleUriEncode) noexcept |
bool | GetShouldNormalizeUriPath () const noexcept |
void | SetShouldNormalizeUriPath (bool shouldNormalizeUriPath) noexcept |
bool | GetOmitSessionToken () const noexcept |
void | SetOmitSessionToken (bool omitSessionToken) noexcept |
ShouldSignHeaderCb | GetShouldSignHeaderCallback () const noexcept |
void | SetShouldSignHeaderCallback (ShouldSignHeaderCb shouldSignHeaderCb) noexcept |
void * | GetShouldSignHeaderUserData () const noexcept |
void | SetShouldSignHeaderUserData (void *userData) noexcept |
const Crt::String & | GetSignedBodyValue () const noexcept |
void | SetSignedBodyValue (const Crt::String &signedBodyValue) noexcept |
SignedBodyHeaderType | GetSignedBodyHeader () const noexcept |
void | SetSignedBodyHeader (SignedBodyHeaderType signedBodyHeader) noexcept |
uint64_t | GetExpirationInSeconds () const noexcept |
void | SetExpirationInSeconds (uint64_t expirationInSeconds) noexcept |
const std::shared_ptr< ICredentialsProvider > & | GetCredentialsProvider () const noexcept |
void | SetCredentialsProvider (const std::shared_ptr< ICredentialsProvider > &credsProvider) noexcept |
const std::shared_ptr< Credentials > & | GetCredentials () const noexcept |
void | SetCredentials (const std::shared_ptr< Credentials > &credentials) noexcept |
Public Member Functions inherited from Aws::Crt::Auth::ISigningConfig | |
ISigningConfig ()=default | |
ISigningConfig (const ISigningConfig &)=delete | |
ISigningConfig (ISigningConfig &&)=delete | |
ISigningConfig & | operator= (const ISigningConfig &)=delete |
ISigningConfig & | operator= (ISigningConfig &&)=delete |
virtual | ~ISigningConfig ()=default |
Wrapper around the configuration structure specific to the AWS Sigv4 signing process
Aws::Crt::Auth::AwsSigningConfig::AwsSigningConfig | ( | Allocator * | allocator = ApiAllocator() | ) |
|
virtual |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
noexcept |
|
inlineoverridevirtualnoexcept |
RTTI query for the SigningConfig hierarchy
Implements Aws::Crt::Auth::ISigningConfig.
|
noexcept |
|
noexcept |
Set the credentials to use for signing.
|
noexcept |
Set the credentials provider to use for signing.
|
noexcept |
(Query param signing only) Sets the amount of time, in seconds, the (pre)signed URI will be good for
|
noexcept |
Sets whether or not to omit the session token during signing. Only set to true when performing a websocket handshake with IoT Core.
|
noexcept |
Sets the AWS region to sign against
|
noexcept |
Sets the (signing) name of the AWS service to sign a request for
|
noexcept |
Sets whether or not the uri paths should be normalized when building the canonical request
|
noexcept |
Sets a callback invoked during the signing process for white-listing headers that can be signed. If you do not set this, all headers will be signed.
|
noexcept |
Sets the userData you could get from the ShouldSignHeaderCb callback function.
|
noexcept |
Sets the type of signature we want to calculate
|
noexcept |
Sets the name of the header to add that stores the signed body value
|
noexcept |
Sets the string to use as the canonical request's body value. If an empty string is set (the default), a value will be calculated from the payload during signing. Typically, this is the SHA-256 of the (request/chunk/event) payload, written as lowercase hex. If this has been precalculated, it can be set here. Special values used by certain services can also be set (see Aws::Crt::Auth::SignedBodyValue).
|
noexcept |
Sets the signing process we want to invoke
|
noexcept |
Sets the timestamp to use during the signing process.
|
noexcept |
Sets whether or not the signing process should perform a uri encode step before creating the canonical request.