libqtaws  0.1.0
UnofficialAWSlibraryforQt
Public Member Functions | List of all members
AwsSignatureV3 Class Reference

Implements AWS Signature Version 3. More...

Inheritance diagram for AwsSignatureV3:
Inheritance graph
[legend]
Collaboration diagram for AwsSignatureV3:
Collaboration graph
[legend]

Public Member Functions

 AwsSignatureV3 (const QCryptographicHash::Algorithm hashAlgorithm=QCryptographicHash::Sha256)
 Constructs a new AwsSignatureV3 object. More...
 
virtual void sign (const AwsAbstractCredentials &credentials, const QNetworkAccessManager::Operation operation, QNetworkRequest &request, const QByteArray &data=QByteArray()) const
 Sign an AWS request. More...
 
virtual int version () const
 AWS Signature version implemented by this class. More...
 
- Public Member Functions inherited from AwsAbstractSignature
virtual ~AwsAbstractSignature ()
 AwsAbstractSignature destructor.
 

Detailed Description

Implements AWS Signature Version 3.

This class implements both AWS3 and AWS3-HTTPS varieties.

See also
http://docs.aws.amazon.com/amazonswf/latest/developerguide/HMACAuth-swf.html (AWS3)
http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/RESTAuthentication.html (AWS3-HTTPS)

Constructor & Destructor Documentation

AwsSignatureV3::AwsSignatureV3 ( const QCryptographicHash::Algorithm  hashAlgorithm = QCryptographicHash::Sha256)

Constructs a new AwsSignatureV3 object.

Use instances of this object to provide Version 3 signatures for AWS services.

Parameters
hashAlgorithmHash algorithm for signatures. Must be either QCryptographicHash::Sha1 or QCryptographicHash::Sha256 (default, recommended).

Member Function Documentation

void AwsSignatureV3::sign ( const AwsAbstractCredentials credentials,
const QNetworkAccessManager::Operation  operation,
QNetworkRequest &  request,
const QByteArray &  data = QByteArray() 
) const
virtual

Sign an AWS request.

Note, credentials must be valid before calling this function. So, for example, if credentials has expired, and is refreshable, it is the caller's responsibility to refresh the credentials before calling this function.

Parameters
operationThe network operation to sign request for.
requestThe network request to be signed.
credentialsThe credentials to use for signing.
dataOptional POST / PUT data to sign request for.

Implements AwsAbstractSignature.

int AwsSignatureV3::version ( ) const
virtual

AWS Signature version implemented by this class.

Derived classes must implement this function to report the version of the AWS Signature implemented by the class.

Returns
The AWS Signature version implemented by this class.

Implements AwsAbstractSignature.


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