AWS SDK for C++  1.9.125
AWS SDK for C++
Public Member Functions | List of all members
Aws::Client::AWSAuthEventStreamV4Signer Class Reference

#include <AWSAuthSigner.h>

+ Inheritance diagram for Aws::Client::AWSAuthEventStreamV4Signer:

Public Member Functions

 AWSAuthEventStreamV4Signer (const std::shared_ptr< Auth::AWSCredentialsProvider > &credentialsProvider, const char *serviceName, const Aws::String &region)
 
const char * GetName () const override
 
bool SignEventMessage (Aws::Utils::Event::Message &, Aws::String &priorSignature) const override
 
bool SignRequest (Aws::Http::HttpRequest &request) const override
 
bool SignRequest (Aws::Http::HttpRequest &request, bool signBody) const override
 
bool SignRequest (Aws::Http::HttpRequest &request, const char *region, bool signBody) const override
 
bool SignRequest (Aws::Http::HttpRequest &request, const char *region, const char *serviceName, bool signBody) const override
 
bool PresignRequest (Aws::Http::HttpRequest &, long long) const override
 
bool PresignRequest (Aws::Http::HttpRequest &, const char *, long long) const override
 
bool PresignRequest (Aws::Http::HttpRequest &, const char *, const char *, long long) const override
 
bool ShouldSignHeader (const Aws::String &header) const
 
- Public Member Functions inherited from Aws::Client::AWSAuthSigner
 AWSAuthSigner ()
 
virtual ~AWSAuthSigner ()=default
 
virtual void SetClockSkew (const std::chrono::milliseconds &clockSkew)
 
virtual Aws::Utils::DateTime GetSigningTimestamp () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSAuthSigner
virtual std::chrono::milliseconds GetClockSkewOffset () const
 
- Protected Attributes inherited from Aws::Client::AWSAuthSigner
std::atomic< std::chrono::milliseconds > m_clockSkew
 

Detailed Description

Definition at line 340 of file AWSAuthSigner.h.

Constructor & Destructor Documentation

◆ AWSAuthEventStreamV4Signer()

Aws::Client::AWSAuthEventStreamV4Signer::AWSAuthEventStreamV4Signer ( const std::shared_ptr< Auth::AWSCredentialsProvider > &  credentialsProvider,
const char *  serviceName,
const Aws::String region 
)

Member Function Documentation

◆ GetName()

const char* Aws::Client::AWSAuthEventStreamV4Signer::GetName ( ) const
inlineoverridevirtual

Return the signer's name

Implements Aws::Client::AWSAuthSigner.

Definition at line 346 of file AWSAuthSigner.h.

◆ PresignRequest() [1/3]

bool Aws::Client::AWSAuthEventStreamV4Signer::PresignRequest ( Aws::Http::HttpRequest ,
const char *  ,
const char *  ,
long long   
) const
inlineoverridevirtual

Do nothing

Implements Aws::Client::AWSAuthSigner.

Definition at line 380 of file AWSAuthSigner.h.

◆ PresignRequest() [2/3]

bool Aws::Client::AWSAuthEventStreamV4Signer::PresignRequest ( Aws::Http::HttpRequest ,
const char *  ,
long long   
) const
inlineoverridevirtual

Do nothing

Implements Aws::Client::AWSAuthSigner.

Definition at line 375 of file AWSAuthSigner.h.

◆ PresignRequest() [3/3]

bool Aws::Client::AWSAuthEventStreamV4Signer::PresignRequest ( Aws::Http::HttpRequest ,
long long   
) const
inlineoverridevirtual

Do nothing

Implements Aws::Client::AWSAuthSigner.

Definition at line 370 of file AWSAuthSigner.h.

◆ ShouldSignHeader()

bool Aws::Client::AWSAuthEventStreamV4Signer::ShouldSignHeader ( const Aws::String header) const

◆ SignEventMessage()

bool Aws::Client::AWSAuthEventStreamV4Signer::SignEventMessage ( Aws::Utils::Event::Message ,
Aws::String  
) const
overridevirtual

Signs a single event message in an event stream. The input message buffer is copied and signed. The message's input buffer will be deallocated and a new buffer will be assigned. The new buffer encodes the original message with its headers as the payload of the new message. The signature of the original message will be added as a header to the new message.

A Hex encoded signature of the previous event (or of the HTTP request headers in case of the first event) is provided as the 'priorSignature' parameter. 'priorSignature' will contain the value of the new signature after this call returns successfully.

The function returns true if the message is successfully signed.

Reimplemented from Aws::Client::AWSAuthSigner.

◆ SignRequest() [1/4]

bool Aws::Client::AWSAuthEventStreamV4Signer::SignRequest ( Aws::Http::HttpRequest request) const
inlineoverridevirtual

Signs the request itself (usually by adding a signature header) based on info in the request and uri.

Implements Aws::Client::AWSAuthSigner.

Definition at line 350 of file AWSAuthSigner.h.

◆ SignRequest() [2/4]

bool Aws::Client::AWSAuthEventStreamV4Signer::SignRequest ( Aws::Http::HttpRequest request,
bool  signBody 
) const
inlineoverridevirtual

Signs the request itself (usually by adding a signature header) based on info in the request and uri. If signBody is false and https is being used then the body of the payload will not be signed. The default virtual function, just calls SignRequest.

Reimplemented from Aws::Client::AWSAuthSigner.

Definition at line 355 of file AWSAuthSigner.h.

◆ SignRequest() [3/4]

bool Aws::Client::AWSAuthEventStreamV4Signer::SignRequest ( Aws::Http::HttpRequest request,
const char *  region,
bool  signBody 
) const
inlineoverridevirtual

Signs the request itself (usually by adding a signature header) based on info in the request and uri. If signBody is false and https is being used then the body of the payload will not be signed. The default virtual function, just calls SignRequest. Using m_region by default if parameter region is nullptr.

Reimplemented from Aws::Client::AWSAuthSigner.

Definition at line 360 of file AWSAuthSigner.h.

◆ SignRequest() [4/4]

bool Aws::Client::AWSAuthEventStreamV4Signer::SignRequest ( Aws::Http::HttpRequest request,
const char *  region,
const char *  serviceName,
bool  signBody 
) const
overridevirtual

Signs the request itself (usually by adding a signature header) based on info in the request and uri. If signBody is false and https is being used then the body of the payload will not be signed. The default virtual function, just calls SignRequest. Using m_region by default if parameter region is nullptr. Using m_serviceName by default if parameter serviceName is nullptr.

Reimplemented from Aws::Client::AWSAuthSigner.


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