org.jets3t.service.security
Class AWSCredentials

java.lang.Object
  org.jets3t.service.security.AWSCredentials

All Implemented Interfaces:

java.io.Serializable

public class AWSCredentials

extends java.lang.Object

implements java.io.Serializable

Class to contain the Amazon Web Services (AWS) credentials of a user. This class also includes utility methods to store credentials to password-encrypted files, and retrieve credentials from these files.

See Also:

Serialized Form

Field Summary

protected static java.lang.String	KEYS_DELIMITER
protected static java.lang.String	VERSION_PREFIX

Constructor Summary

AWSCredentials(java.lang.String awsAccessKey, java.lang.String awsSecretAccessKey)
Construct credentials.

AWSCredentials(java.lang.String awsAccessKey, java.lang.String awsSecretAccessKey, java.lang.String friendlyName)
Construct credentials, and associate them with a human-friendly name.

Method Summary

java.lang.String	getAccessKey()
java.lang.String	getFriendlyName()
java.lang.String	getSecretKey()
static AWSCredentials	load(java.lang.String password, java.io.BufferedInputStream inputStream) Loads encrypted credentials from a data input stream.
static AWSCredentials	load(java.lang.String password, java.io.File file) Loads encrypted credentials from a file.
static void	main(java.lang.String[] args) Console utility to store AWS credentials information in an encrypted file in the toolkit's default preferences directory.
void	save(java.lang.String password, java.io.File file) Encrypts AWS Credentials with the given password and saves the encrypted data to a file.
void	save(java.lang.String password, java.io.OutputStream outputStream) Encrypts AWS Credentials with the given password and writes the encrypted data to an output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEYS_DELIMITER

protected static final java.lang.String KEYS_DELIMITER

See Also:

Constant Field Values

VERSION_PREFIX

protected static final java.lang.String VERSION_PREFIX

See Also:

Constant Field Values

Constructor Detail

AWSCredentials

public AWSCredentials(java.lang.String awsAccessKey,
                      java.lang.String awsSecretAccessKey)

Construct credentials.

Parameters:

awsAccessKey - AWS access key for an Amazon S3 account.

awsSecretAccessKey - AWS secret key for an Amazon S3 acount.

AWSCredentials

public AWSCredentials(java.lang.String awsAccessKey,
                      java.lang.String awsSecretAccessKey,
                      java.lang.String friendlyName)

Construct credentials, and associate them with a human-friendly name.

Parameters:

awsAccessKey - AWS access key for an Amazon S3 account.

awsSecretAccessKey - AWS secret key for an Amazon S3 acount.

friendlyName - a name identifying the owner of the credentials, such as 'James'.

Method Detail

getAccessKey

public java.lang.String getAccessKey()

Returns:

the AWS Access Key.

getSecretKey

public java.lang.String getSecretKey()

Returns:

the AWS Secret Key.

getFriendlyName

public java.lang.String getFriendlyName()

Returns:

the friendly name associated with an AWS account, if available.

save

public void save(java.lang.String password,
                 java.io.File file)
          throws java.security.InvalidKeyException,
                 java.security.NoSuchAlgorithmException,
                 javax.crypto.NoSuchPaddingException,
                 java.security.spec.InvalidKeySpecException,
                 java.lang.IllegalStateException,
                 javax.crypto.IllegalBlockSizeException,
                 javax.crypto.BadPaddingException,
                 java.security.InvalidAlgorithmParameterException,
                 java.io.IOException

Encrypts AWS Credentials with the given password and saves the encrypted data to a file.

Parameters:

password - the password used to encrypt the credentials.

file - the file to write the encrypted credentials data to.

Throws:

java.security.InvalidKeyException

java.security.NoSuchAlgorithmException

javax.crypto.NoSuchPaddingException

java.security.spec.InvalidKeySpecException

java.lang.IllegalStateException

javax.crypto.IllegalBlockSizeException

javax.crypto.BadPaddingException

java.security.InvalidAlgorithmParameterException

java.io.IOException

save

public void save(java.lang.String password,
                 java.io.OutputStream outputStream)
          throws java.security.InvalidKeyException,
                 java.security.NoSuchAlgorithmException,
                 javax.crypto.NoSuchPaddingException,
                 java.security.spec.InvalidKeySpecException,
                 java.lang.IllegalStateException,
                 javax.crypto.IllegalBlockSizeException,
                 javax.crypto.BadPaddingException,
                 java.security.InvalidAlgorithmParameterException,
                 java.io.IOException

Encrypts AWS Credentials with the given password and writes the encrypted data to an output stream.

Parameters:

password - the password used to encrypt the credentials.

outputStream - the output stream to write the encrypted credentials data to, this stream must be closed by the caller.

Throws:

java.security.InvalidKeyException

java.security.NoSuchAlgorithmException

javax.crypto.NoSuchPaddingException

java.security.spec.InvalidKeySpecException

java.lang.IllegalStateException

javax.crypto.IllegalBlockSizeException

javax.crypto.BadPaddingException

java.security.InvalidAlgorithmParameterException

java.io.IOException

load

public static AWSCredentials load(java.lang.String password,
                                  java.io.File file)
                           throws S3ServiceException

Loads encrypted credentials from a file.

Parameters:

password - the password used to decrypt the credentials. If null, the AWS Credentials are not decrypted and only the version and friendly-name information is loaded.

file - a file containing an encrypted data encoding of an AWSCredentials object.

Returns:

the decrypted credentials in an object.

Throws:

S3ServiceException

load

public static AWSCredentials load(java.lang.String password,
                                  java.io.BufferedInputStream inputStream)
                           throws S3ServiceException

Loads encrypted credentials from a data input stream.

Parameters:

password - the password used to decrypt the credentials. If null, the AWS Credentials are not decrypted and only the version and friendly-name information is loaded.

inputStream - an input stream containing an encrypted data encoding of an AWSCredentials object.

Returns:

the decrypted credentials in an object.

Throws:

S3ServiceException

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Console utility to store AWS credentials information in an encrypted file in the toolkit's default preferences directory.

This class can be run from the command line as:

 java org.jets3t.service.security.AWSCredentials <friendlyName> <credentialsFilename>
 

When run it will prompt for the user's AWS access key,secret key and encryption password. It will then encode into the specified credentials file.

Parameters:

args -

Throws:

java.lang.Exception