aws-crt-cpp
Public Member Functions | List of all members
Aws::Crt::Auth::AwsSigningConfig Class Reference

#include <Sigv4Signing.h>

Inheritance diagram for Aws::Crt::Auth::AwsSigningConfig:
Aws::Crt::Auth::ISigningConfig

Public Member Functions

 AwsSigningConfig (Allocator *allocator=g_allocator)
 
virtual ~AwsSigningConfig ()
 
virtual SigningConfigType GetType () const noexcept override
 
SigningAlgorithm GetSigningAlgorithm () const noexcept
 
void SetSigningAlgorithm (SigningAlgorithm algorithm) noexcept
 
const Crt::StringGetRegion () const noexcept
 
void SetRegion (const Crt::String &region) noexcept
 
const Crt::StringGetService () 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
 
ShouldSignParameterCb GetShouldSignParameterCallback () const noexcept
 
void SetShouldSignHeadersCallback (ShouldSignParameterCb shouldSignParameterCb) noexcept
 
BodySigningType GetBodySigningType () const noexcept
 
void SetBodySigningType (BodySigningType bodysigningType) noexcept
 
const std::shared_ptr< ICredentialsProvider > & GetCredentialsProvider () const noexcept
 
void SetCredentialsProvider (const std::shared_ptr< ICredentialsProvider > &credsProvider) noexcept
 
- Public Member Functions inherited from Aws::Crt::Auth::ISigningConfig
 ISigningConfig ()=default
 
 ISigningConfig (const ISigningConfig &)=delete
 
 ISigningConfig (ISigningConfig &&)=delete
 
ISigningConfigoperator= (const ISigningConfig &)=delete
 
ISigningConfigoperator= (ISigningConfig &&)=delete
 
virtual ~ISigningConfig ()=default
 

Detailed Description

Wrapper around the configuration structure specific to the AWS Sigv4 signing process

Constructor & Destructor Documentation

◆ AwsSigningConfig()

Aws::Crt::Auth::AwsSigningConfig::AwsSigningConfig ( Allocator allocator = g_allocator)

◆ ~AwsSigningConfig()

Aws::Crt::Auth::AwsSigningConfig::~AwsSigningConfig ( )
virtual

Member Function Documentation

◆ GetBodySigningType()

BodySigningType Aws::Crt::Auth::AwsSigningConfig::GetBodySigningType ( ) const
noexcept

Gets whether or not the signer should add the x-amz-content-sha256 header (with appropriate value) to the canonical request.

◆ GetCredentialsProvider()

const std::shared_ptr< ICredentialsProvider > & Aws::Crt::Auth::AwsSigningConfig::GetCredentialsProvider ( ) const
noexcept

Get the credentials provider to use for signing.

◆ GetRegion()

const Crt::String & Aws::Crt::Auth::AwsSigningConfig::GetRegion ( ) const
noexcept

Gets the AWS region to sign against

◆ GetService()

const Crt::String & Aws::Crt::Auth::AwsSigningConfig::GetService ( ) const
noexcept

Gets the (signing) name of the AWS service to sign a request for

◆ GetShouldNormalizeUriPath()

bool Aws::Crt::Auth::AwsSigningConfig::GetShouldNormalizeUriPath ( ) const
noexcept

Gets whether or not the uri paths should be normalized when building the canonical request

◆ GetShouldSignParameterCallback()

ShouldSignParameterCb Aws::Crt::Auth::AwsSigningConfig::GetShouldSignParameterCallback ( ) const
noexcept

Gets the ShouldSignHeadersCb from the underlying config.

◆ GetSigningAlgorithm()

SigningAlgorithm Aws::Crt::Auth::AwsSigningConfig::GetSigningAlgorithm ( ) const
noexcept

Gets the signing process we want to invoke

◆ GetSigningTimepoint()

DateTime Aws::Crt::Auth::AwsSigningConfig::GetSigningTimepoint ( ) const
noexcept

Gets the timestamp to use during the signing process.

◆ GetType()

virtual SigningConfigType Aws::Crt::Auth::AwsSigningConfig::GetType ( ) const
inlineoverridevirtualnoexcept

RTTI query for the SigningConfig hierarchy

Implements Aws::Crt::Auth::ISigningConfig.

◆ GetUseDoubleUriEncode()

bool Aws::Crt::Auth::AwsSigningConfig::GetUseDoubleUriEncode ( ) const
noexcept

Gets whether or not the signing process should perform a uri encode step before creating the canonical request.

◆ SetBodySigningType()

void Aws::Crt::Auth::AwsSigningConfig::SetBodySigningType ( BodySigningType  bodysigningType)
noexcept

Sets whether or not the signer should add the x-amz-content-sha256 header (with appropriate value) to the canonical request.

◆ SetCredentialsProvider()

void Aws::Crt::Auth::AwsSigningConfig::SetCredentialsProvider ( const std::shared_ptr< ICredentialsProvider > &  credsProvider)
noexcept

Set the credentials provider to use for signing, this is mandatory for sigv4.

◆ SetRegion()

void Aws::Crt::Auth::AwsSigningConfig::SetRegion ( const Crt::String region)
noexcept

Sets the AWS region to sign against

◆ SetService()

void Aws::Crt::Auth::AwsSigningConfig::SetService ( const Crt::String service)
noexcept

Sets the (signing) name of the AWS service to sign a request for

◆ SetShouldNormalizeUriPath()

void Aws::Crt::Auth::AwsSigningConfig::SetShouldNormalizeUriPath ( bool  shouldNormalizeUriPath)
noexcept

Sets whether or not the uri paths should be normalized when building the canonical request

◆ SetShouldSignHeadersCallback()

void Aws::Crt::Auth::AwsSigningConfig::SetShouldSignHeadersCallback ( ShouldSignParameterCb  shouldSignParameterCb)
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.

◆ SetSigningAlgorithm()

void Aws::Crt::Auth::AwsSigningConfig::SetSigningAlgorithm ( SigningAlgorithm  algorithm)
noexcept

Sets the signing process we want to invoke

◆ SetSigningTimepoint()

void Aws::Crt::Auth::AwsSigningConfig::SetSigningTimepoint ( const DateTime date)
noexcept

Sets the timestamp to use during the signing process.

◆ SetUseDoubleUriEncode()

void Aws::Crt::Auth::AwsSigningConfig::SetUseDoubleUriEncode ( bool  useDoubleUriEncode)
noexcept

Sets whether or not the signing process should perform a uri encode step before creating the canonical request.


The documentation for this class was generated from the following files: