smithy::AwsSigV4Signer Class Reference

#include <SigV4Signer.h>

Inheritance diagram for smithy::AwsSigV4Signer:

Public Types

using SigV4AuthSchemeParameters = DefaultAuthSchemeResolverParameters

 

Public Types inherited from smithy::AwsSignerBase< AwsCredentialIdentityBase >

using IdentityT = AwsCredentialIdentityBase

 

using SigningProperties = Aws::UnorderedMap< Aws::String, Aws::Crt::Variant< Aws::String, bool > >

 

using AdditionalParameters = Aws::UnorderedMap< Aws::String, Aws::Crt::Variant< Aws::String, bool > >

 

using HttpRequest = Aws::Http::HttpRequest

 

using SigningError = Aws::Client::AWSError< Aws::Client::CoreErrors >

 

using SigningFutureOutcome = Aws::Utils::FutureOutcome< std::shared_ptr< HttpRequest >, SigningError >

 

using SigningEventOutcome = Aws::Utils::Outcome< Aws::Utils::Event::Message, SigningError >

 

Public Member Functions

 AwsSigV4Signer (const Aws::String &serviceName, const Aws::String &region)

 

 AwsSigV4Signer (const Aws::String &serviceName, const Aws::String &region, Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy policy, bool urlEscapePath)

 

SigningFutureOutcome sign (std::shared_ptr< HttpRequest > httpRequest, const AwsCredentialIdentityBase &identity, SigningProperties properties) override

 

SigningFutureOutcome presign (std::shared_ptr< HttpRequest > httpRequest, const AwsCredentialIdentityBase &identity, SigningProperties properties, const Aws::String &region, const Aws::String &serviceName, long long expirationTimeInSeconds) override

 

SigningEventOutcome signMessage (Aws::Utils::Event::Message &msg, Aws::String &seed, const AwsCredentialIdentityBase &identity, SigningProperties properties) override

 

virtual ~AwsSigV4Signer ()

 

Public Member Functions inherited from smithy::AwsSignerBase< AwsCredentialIdentityBase >

virtual ~AwsSignerBase ()

 

Public Member Functions inherited from smithy::AwsSignerCommon

virtual ~AwsSignerCommon ()=default

 

virtual void SetClockSkew (const std::chrono::milliseconds &clockSkew)

 

virtual Aws::Utils::DateTime GetSigningTimestamp () const

 

Protected Member Functions

 AwsSigV4Signer (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::String &serviceName, const Aws::String &region, Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy policy, bool urlEscapePath, Aws::Auth::AWSSigningAlgorithm signingAlgorithm)

 

const Aws::Client::AWSAuthV4Signer & getLegacySigner () const

 

Protected Member Functions inherited from smithy::AwsSignerCommon

virtual std::chrono::milliseconds GetClockSkewOffset () const

 

Protected Attributes

Aws::String m_serviceName

 

Aws::String m_region

 

Aws::Client::AWSAuthV4Signer legacySigner

 

Aws::Client::AWSAuthEventStreamV4Signer legacyEventStreamingSigner

 

Protected Attributes inherited from smithy::AwsSignerCommon

std::atomic< std::chrono::milliseconds > m_clockSkew = {}

 

Detailed Description

A smithy SigV4 signer wrapper on top of legacy SDK SigV4 signer TODO: refactor into own signer using smithy design

Definition at line 22 of file SigV4Signer.h.

Member Typedef Documentation

SigV4AuthSchemeParameters

using smithy::AwsSigV4Signer::SigV4AuthSchemeParameters = DefaultAuthSchemeResolverParameters

Definition at line 25 of file SigV4Signer.h.

Constructor & Destructor Documentation

AwsSigV4Signer() [1/3]

smithy::AwsSigV4Signer::AwsSigV4Signer ( const Aws::String &  serviceName,

const Aws::String &  region 

)

inlineexplicit

Definition at line 26 of file SigV4Signer.h.

AwsSigV4Signer() [2/3]

smithy::AwsSigV4Signer::AwsSigV4Signer ( const Aws::String &  serviceName,

const Aws::String &  region,

Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy  policy,

bool  urlEscapePath 

)

inlineexplicit

Definition at line 36 of file SigV4Signer.h.

~AwsSigV4Signer()

virtual smithy::AwsSigV4Signer::~AwsSigV4Signer ( )

inlinevirtual

Definition at line 118 of file SigV4Signer.h.

AwsSigV4Signer() [3/3]

smithy::AwsSigV4Signer::AwsSigV4Signer ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,

const Aws::String &  serviceName,

const Aws::String &  region,

Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy  policy,

bool  urlEscapePath,

Aws::Auth::AWSSigningAlgorithm  signingAlgorithm 

)

inlineexplicitprotected

Definition at line 122 of file SigV4Signer.h.

Member Function Documentation

getLegacySigner()

const Aws::Client::AWSAuthV4Signer & smithy::AwsSigV4Signer::getLegacySigner ( ) const

inlineprotected

Definition at line 131 of file SigV4Signer.h.

presign()

SigningFutureOutcome smithy::AwsSigV4Signer::presign ( std::shared_ptr< HttpRequest >  httpRequest,

const AwsCredentialIdentityBase &  identity,

SigningProperties  properties,

const Aws::String &  region,

const Aws::String &  serviceName,

long long  expirationTimeInSeconds 

)

inlineoverridevirtual

Implements smithy::AwsSignerBase< AwsCredentialIdentityBase >.

Definition at line 77 of file SigV4Signer.h.

sign()

SigningFutureOutcome smithy::AwsSigV4Signer::sign ( std::shared_ptr< HttpRequest >  httpRequest,

const AwsCredentialIdentityBase &  identity,

SigningProperties  properties 

)

inlineoverridevirtual

Implements smithy::AwsSignerBase< AwsCredentialIdentityBase >.

Definition at line 44 of file SigV4Signer.h.

signMessage()

SigningEventOutcome smithy::AwsSigV4Signer::signMessage ( Aws::Utils::Event::Message &  msg,

Aws::String &  seed,

const AwsCredentialIdentityBase &  identity,

SigningProperties  properties 

)

inlineoverridevirtual

Reimplemented from smithy::AwsSignerBase< AwsCredentialIdentityBase >.

Definition at line 98 of file SigV4Signer.h.

Member Data Documentation

legacyEventStreamingSigner

Aws::Client::AWSAuthEventStreamV4Signer smithy::AwsSigV4Signer::legacyEventStreamingSigner

protected

Definition at line 137 of file SigV4Signer.h.

legacySigner

Aws::Client::AWSAuthV4Signer smithy::AwsSigV4Signer::legacySigner

protected

Definition at line 136 of file SigV4Signer.h.

m_region

Aws::String smithy::AwsSigV4Signer::m_region

protected

Definition at line 135 of file SigV4Signer.h.

m_serviceName

Aws::String smithy::AwsSigV4Signer::m_serviceName

protected

Definition at line 134 of file SigV4Signer.h.

---

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

• src/aws-cpp-sdk-core/include/smithy/identity/signer/built-in/SigV4Signer.h