Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Amazon.S3.Encryption.AmazonS3EncryptionClient Class Reference
Inheritance diagram for Amazon.S3.Encryption.AmazonS3EncryptionClient:
Amazon.S3.AmazonS3Client Amazon.S3.IAmazonS3 Amazon.S3.IAmazonS3

Public Member Functions

 AmazonS3EncryptionClient (EncryptionMaterials materials)
 Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. More...
 
 AmazonS3EncryptionClient (RegionEndpoint region, EncryptionMaterials materials)
 Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. More...
 
 AmazonS3EncryptionClient (AmazonS3CryptoConfiguration config, EncryptionMaterials materials)
 Constructs AmazonS3EncryptionClient with the Encryption materials, AmazonS3 CryptoConfiguration object and credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. More...
 
 AmazonS3EncryptionClient (AWSCredentials credentials, EncryptionMaterials materials)
 Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials. More...
 
 AmazonS3EncryptionClient (AWSCredentials credentials, RegionEndpoint region, EncryptionMaterials materials)
 Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials More...
 
 AmazonS3EncryptionClient (AWSCredentials credentials, AmazonS3CryptoConfiguration config, EncryptionMaterials materials)
 Constructs AmazonS3EncryptionClient with AWS Credentials, AmazonS3CryptoConfiguration Configuration object and Encryption materials More...
 
 AmazonS3EncryptionClient (string awsAccessKeyId, string awsSecretAccessKey, EncryptionMaterials materials)
 Constructs AmazonS3EncryptionClient with AWS Access Key ID, AWS Secret Key and Encryption materials More...
 
 AmazonS3EncryptionClient (string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region, EncryptionMaterials materials)
 Constructs AmazonS3EncryptionClient with AWS Access Key ID, AWS Secret Key, Region and Encryption materials More...
 
 AmazonS3EncryptionClient (string awsAccessKeyId, string awsSecretAccessKey, AmazonS3CryptoConfiguration config, EncryptionMaterials materials)
 Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, AmazonS3 CryptoConfiguration object and Encryption materials. More...
 
 AmazonS3EncryptionClient (string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, EncryptionMaterials materials)
 Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken and Encryption materials. More...
 
 AmazonS3EncryptionClient (string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region, EncryptionMaterials materials)
 Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken, Region and Encryption materials. More...
 
 AmazonS3EncryptionClient (string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonS3CryptoConfiguration config, EncryptionMaterials materials)
 Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken AmazonS3EncryptionClient CryptoConfiguration object and Encryption materials. More...
 
- Public Member Functions inherited from Amazon.S3.AmazonS3Client
 AmazonS3Client ()
 Constructs AmazonS3Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. More...
 
 AmazonS3Client (RegionEndpoint region)
 Constructs AmazonS3Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. More...
 
 AmazonS3Client (AmazonS3Config config)
 Constructs AmazonS3Client with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. More...
 
 AmazonS3Client (AWSCredentials credentials)
 Constructs AmazonS3Client with AWS Credentials More...
 
 AmazonS3Client (AWSCredentials credentials, RegionEndpoint region)
 Constructs AmazonS3Client with AWS Credentials More...
 
 AmazonS3Client (AWSCredentials credentials, AmazonS3Config clientConfig)
 Constructs AmazonS3Client with AWS Credentials and an AmazonS3Client Configuration object. More...
 
 AmazonS3Client (string awsAccessKeyId, string awsSecretAccessKey)
 Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key More...
 
 AmazonS3Client (string awsAccessKeyId, string awsSecretAccessKey, RegionEndpoint region)
 Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key More...
 
 AmazonS3Client (string awsAccessKeyId, string awsSecretAccessKey, AmazonS3Config clientConfig)
 Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an AmazonS3Client Configuration object. More...
 
 AmazonS3Client (string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken)
 Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key More...
 
 AmazonS3Client (string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, RegionEndpoint region)
 Constructs AmazonS3Client with AWS Access Key ID and AWS Secret Key More...
 
 AmazonS3Client (string awsAccessKeyId, string awsSecretAccessKey, string awsSessionToken, AmazonS3Config clientConfig)
 Constructs AmazonS3Client with AWS Access Key ID, AWS Secret Key and an AmazonS3Client Configuration object. More...
 
void PutObject (PutObjectRequest putObjectRequest, Action< PutObjectResponse > responseCallback)
 
PutObjectResponse EndPutObject (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the PutObject operation.

See Also
Amazon.S3.IAmazonS3.PutObject
More...
 
void PutBucket (PutBucketRequest putBucketRequest, Action< PutBucketResponse > responseCallback)
 
PutBucketResponse EndPutBucket (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the PutBucket operation.

See Also
Amazon.S3.IAmazonS3.PutBucket
More...
 
void DeleteObjects (DeleteObjectsRequest deleteObjectsRequest, Action< DeleteObjectsResponse > responseCallback)
 
DeleteObjectsResponse EndDeleteObjects (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the DeleteObjects operation.

See Also
Amazon.S3.IAmazonS3.DeleteObjects
More...
 
void DeleteBucket (DeleteBucketRequest deleteBucketRequest, Action< DeleteBucketResponse > responseCallback)
 
DeleteBucketResponse EndDeleteBucket (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the DeleteBucket operation.

See Also
Amazon.S3.IAmazonS3.DeleteBucket
More...
 
void ListMultipartUploads (ListMultipartUploadsRequest listMultipartUploadsRequest, Action< ListMultipartUploadsResponse > responseCallback)
 
ListMultipartUploadsResponse EndListMultipartUploads (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the ListMultipartUploads operation.

See Also
Amazon.S3.IAmazonS3.ListMultipartUploads
More...
 
void CompleteMultipartUpload (CompleteMultipartUploadRequest completeMultipartUploadRequest, Action< CompleteMultipartUploadResponse > responseCallback)
 
CompleteMultipartUploadResponse EndCompleteMultipartUpload (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the CompleteMultipartUpload operation.

See Also
Amazon.S3.IAmazonS3.CompleteMultipartUpload
More...
 
void GetObject (GetObjectRequest getObjectRequest, Action< GetObjectResponse > responseCallback)
 
GetObjectResponse EndGetObject (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the GetObject operation.

See Also
Amazon.S3.IAmazonS3.GetObject
More...
 
void AbortMultipartUpload (AbortMultipartUploadRequest abortMultipartUploadRequest, Action< AbortMultipartUploadResponse > responseCallback)
 
AbortMultipartUploadResponse EndAbortMultipartUpload (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the AbortMultipartUpload operation.

See Also
Amazon.S3.IAmazonS3.AbortMultipartUpload
More...
 
void UploadPart (UploadPartRequest uploadPartRequest, Action< UploadPartResponse > responseCallback)
 
UploadPartResponse EndUploadPart (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the UploadPart operation.

See Also
Amazon.S3.IAmazonS3.UploadPart
More...
 
void DeleteObject (DeleteObjectRequest deleteObjectRequest, Action< DeleteObjectResponse > responseCallback)
 
DeleteObjectResponse EndDeleteObject (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the DeleteObject operation.

See Also
Amazon.S3.IAmazonS3.DeleteObject
More...
 
void InitiateMultipartUpload (InitiateMultipartUploadRequest initiateMultipartUploadRequest, Action< InitiateMultipartUploadResponse > responseCallback)
 
InitiateMultipartUploadResponse EndInitiateMultipartUpload (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the InitiateMultipartUpload operation.

See Also
Amazon.S3.IAmazonS3.InitiateMultipartUpload
More...
 
void ListObjects (ListObjectsRequest listObjectsRequest, Action< ListObjectsResponse > responseCallback)
 
ListObjectsResponse EndListObjects (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the ListObjects operation.

See Also
Amazon.S3.IAmazonS3.ListObjects
More...
 
void ListBuckets (ListBucketsRequest listBucketsRequest, Action< ListBucketsResponse > responseCallback)
 
ListBucketsResponse EndListBuckets (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the ListBuckets operation.

See Also
Amazon.S3.IAmazonS3.ListBuckets
More...
 
string GetPreSignedURL (GetPreSignedUrlRequest request)
 Create a signed URL allowing access to a resource that would usually require authentication. More...
 

Protected Member Functions

override void ProcessPreRequestHandlers (AmazonWebServiceRequest request)
 Performs encryption for PutObject and MultiPartUpload, also adding encryption information to object metadata or instruction file More...
 
override void ProcessResponseHandlers (AmazonWebServiceResponse response, IRequest request, IWebResponseData webResponseData)
 Performs decryption of data by getting encryption information from object metadata or instruction file. More...
 
override void ProcessRequestHandlers (IRequest request)
 Adds user agent to headers More...
 
- Protected Member Functions inherited from Amazon.S3.AmazonS3Client
override void Dispose (bool disposing)
 
override void ProcessResponseHandlers (AmazonWebServiceResponse response, IRequest request, IWebResponseData webResponseData)
 
override void ProcessExceptionHandlers (Exception exception, IRequest request)
 
override void ProcessPreRequestHandlers (AmazonWebServiceRequest request)
 
override void ProcessRequestHandlers (IRequest request)
 

Properties

override bool SupportResponseLogging [get]
 Turn off response logging because it will interfere with decrypt of the data coming back from S3. More...
 

Constructor & Destructor Documentation

Amazon.S3.Encryption.AmazonS3EncryptionClient.AmazonS3EncryptionClient ( EncryptionMaterials  materials)

Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.

Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration>

Parameters
materialsThe encryption materials to be used to encrypt and decrypt envelope key.
Amazon.S3.Encryption.AmazonS3EncryptionClient.AmazonS3EncryptionClient ( RegionEndpoint  region,
EncryptionMaterials  materials 
)

Constructs AmazonS3EncryptionClient with the Encryption materials and credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.

Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration>

Parameters
regionThe region to connect.
materialsThe encryption materials to be used to encrypt and decrypt envelope key.
Amazon.S3.Encryption.AmazonS3EncryptionClient.AmazonS3EncryptionClient ( AmazonS3CryptoConfiguration  config,
EncryptionMaterials  materials 
)

Constructs AmazonS3EncryptionClient with the Encryption materials, AmazonS3 CryptoConfiguration object and credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.

Example App.config with credentials set. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration>

Parameters
configThe AmazonS3EncryptionClient CryptoConfiguration Object
materialsThe encryption materials to be used to encrypt and decrypt envelope key.
Amazon.S3.Encryption.AmazonS3EncryptionClient.AmazonS3EncryptionClient ( AWSCredentials  credentials,
EncryptionMaterials  materials 
)

Constructs AmazonS3EncryptionClient with AWS Credentials and Encryption materials.

Parameters
materialsThe encryption materials to be used to encrypt and decrypt envelope key.
credentialsAWS Credentials
Amazon.S3.Encryption.AmazonS3EncryptionClient.AmazonS3EncryptionClient ( AWSCredentials  credentials,
RegionEndpoint  region,
EncryptionMaterials  materials 
)

Constructs AmazonS3EncryptionClient with AWS Credentials, Region and Encryption materials

Parameters
credentialsAWS Credentials
regionThe region to connect.
materialsThe encryption materials to be used to encrypt and decrypt envelope key.
Amazon.S3.Encryption.AmazonS3EncryptionClient.AmazonS3EncryptionClient ( AWSCredentials  credentials,
AmazonS3CryptoConfiguration  config,
EncryptionMaterials  materials 
)

Constructs AmazonS3EncryptionClient with AWS Credentials, AmazonS3CryptoConfiguration Configuration object and Encryption materials

Parameters
credentialsAWS Credentials
configThe AmazonS3EncryptionClient CryptoConfiguration Object
materialsThe encryption materials to be used to encrypt and decrypt envelope key.
Amazon.S3.Encryption.AmazonS3EncryptionClient.AmazonS3EncryptionClient ( string  awsAccessKeyId,
string  awsSecretAccessKey,
EncryptionMaterials  materials 
)

Constructs AmazonS3EncryptionClient with AWS Access Key ID, AWS Secret Key and Encryption materials

Parameters
awsAccessKeyIdAWS Access Key ID
awsSecretAccessKeyAWS Secret Access Key
materialsThe encryption materials to be used to encrypt and decrypt envelope key.
Amazon.S3.Encryption.AmazonS3EncryptionClient.AmazonS3EncryptionClient ( string  awsAccessKeyId,
string  awsSecretAccessKey,
RegionEndpoint  region,
EncryptionMaterials  materials 
)

Constructs AmazonS3EncryptionClient with AWS Access Key ID, AWS Secret Key, Region and Encryption materials

Parameters
awsAccessKeyIdAWS Access Key ID
awsSecretAccessKeyAWS Secret Access Key
regionThe region to connect.
materialsThe encryption materials to be used to encrypt and decrypt envelope key.
Amazon.S3.Encryption.AmazonS3EncryptionClient.AmazonS3EncryptionClient ( string  awsAccessKeyId,
string  awsSecretAccessKey,
AmazonS3CryptoConfiguration  config,
EncryptionMaterials  materials 
)

Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, AmazonS3 CryptoConfiguration object and Encryption materials.

Parameters
awsAccessKeyIdAWS Access Key ID
awsSecretAccessKeyAWS Secret Access Key
configThe AmazonS3EncryptionClient CryptoConfiguration Object
materialsThe encryption materials to be used to encrypt and decrypt envelope key.
Amazon.S3.Encryption.AmazonS3EncryptionClient.AmazonS3EncryptionClient ( string  awsAccessKeyId,
string  awsSecretAccessKey,
string  awsSessionToken,
EncryptionMaterials  materials 
)

Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken and Encryption materials.

Parameters
awsAccessKeyIdAWS Access Key ID
awsSecretAccessKeyAWS Secret Access Key
awsSessionTokenAWS Session Token
materialsThe encryption materials to be used to encrypt and decrypt envelope key.
Amazon.S3.Encryption.AmazonS3EncryptionClient.AmazonS3EncryptionClient ( string  awsAccessKeyId,
string  awsSecretAccessKey,
string  awsSessionToken,
RegionEndpoint  region,
EncryptionMaterials  materials 
)

Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken, Region and Encryption materials.

Parameters
awsAccessKeyIdAWS Access Key ID
awsSecretAccessKeyAWS Secret Access Key
awsSessionTokenAWS Session Token
regionThe region to connect.
materialsThe encryption materials to be used to encrypt and decrypt envelope key.
Amazon.S3.Encryption.AmazonS3EncryptionClient.AmazonS3EncryptionClient ( string  awsAccessKeyId,
string  awsSecretAccessKey,
string  awsSessionToken,
AmazonS3CryptoConfiguration  config,
EncryptionMaterials  materials 
)

Constructs AmazonS3EncryptionClient with AWS Access Key ID, Secret Key, SessionToken AmazonS3EncryptionClient CryptoConfiguration object and Encryption materials.

Parameters
awsAccessKeyIdAWS Access Key ID
awsSecretAccessKeyAWS Secret Access Key
awsSessionTokenAWS Session Token
configThe AmazonS3EncryptionClient CryptoConfiguration Object
materialsThe encryption materials to be used to encrypt and decrypt envelope key.

Member Function Documentation

override void Amazon.S3.Encryption.AmazonS3EncryptionClient.ProcessPreRequestHandlers ( AmazonWebServiceRequest  request)
protected

Performs encryption for PutObject and MultiPartUpload, also adding encryption information to object metadata or instruction file

Parameters
requestAmazonWebServiceRequest on which encryption is performed
override void Amazon.S3.Encryption.AmazonS3EncryptionClient.ProcessRequestHandlers ( IRequest  request)
protected

Adds user agent to headers

Parameters
request
override void Amazon.S3.Encryption.AmazonS3EncryptionClient.ProcessResponseHandlers ( AmazonWebServiceResponse  response,
IRequest  request,
IWebResponseData  webResponseData 
)
protected

Performs decryption of data by getting encryption information from object metadata or instruction file.

Parameters
responseAmazonWebServiceResponse on which decryption is performed
requestIRequest
webResponseDataIWebResponseData

Property Documentation

override bool Amazon.S3.Encryption.AmazonS3EncryptionClient.SupportResponseLogging
getprotected

Turn off response logging because it will interfere with decrypt of the data coming back from S3.


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