org.apache.shindig.common.crypto

Class BasicBlobCrypter

java.lang.Object

org.apache.shindig.common.crypto.BasicBlobCrypter

All Implemented Interfaces:

BlobCrypter

public class BasicBlobCrypter
extends Object
implements BlobCrypter

Simple implementation of BlobCrypter.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MASTER_KEY_MIN_LEN minimum length of master key
TimeSource	timeSource

Constructor Summary

Constructors

Constructor and Description
BasicBlobCrypter(byte[] masterKey) Builds a BlobCrypter from the specified master key
BasicBlobCrypter(byte[] masterKey, HMACType hmacType)
BasicBlobCrypter(File keyfile) Creates a crypter based on a key in a file.
BasicBlobCrypter(File keyfile, HMACType hmacType)
BasicBlobCrypter(String masterKey) Builds a BlobCrypter from the specified master key
BasicBlobCrypter(String masterKey, HMACType hmacType)

Method Summary

Methods

Modifier and Type	Method and Description
HMACType	getHmacType()
void	setHmacType(HMACType hmacType)
static void	setpreferredHMACAlgorithm(String preferredHMACAlgorithm)
Map<String,String>	unwrap(String in) Unwraps a blob.
String	wrap(Map<String,String> in) Encrypts and signs a blob.

Methods inherited from class java.lang.Object

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

Field Detail

MASTER_KEY_MIN_LEN

public static final int MASTER_KEY_MIN_LEN

minimum length of master key

See Also:

Constant Field Values

timeSource

public TimeSource timeSource

Constructor Detail

BasicBlobCrypter

public BasicBlobCrypter(File keyfile)
                 throws IOException

Creates a crypter based on a key in a file. The key is the first line in the file, whitespace trimmed from either end, as UTF-8 bytes. The following *nix command line will create an excellent key:

 dd if=/dev/random bs=32 count=1  | openssl base64 > /tmp/key.txt
 

Throws:

IOException - if the file can't be read.

BasicBlobCrypter

public BasicBlobCrypter(File keyfile,
                HMACType hmacType)
                 throws IOException

Throws:

IOException

BasicBlobCrypter

public BasicBlobCrypter(byte[] masterKey)

Builds a BlobCrypter from the specified master key

Parameters:

masterKey -

BasicBlobCrypter

public BasicBlobCrypter(byte[] masterKey,
                HMACType hmacType)

BasicBlobCrypter

public BasicBlobCrypter(String masterKey)

Builds a BlobCrypter from the specified master key

Parameters:

masterKey -

BasicBlobCrypter

public BasicBlobCrypter(String masterKey,
                HMACType hmacType)

Method Detail

setpreferredHMACAlgorithm

@Inject(optional=true)
public static void setpreferredHMACAlgorithm(String preferredHMACAlgorithm)

getHmacType

public HMACType getHmacType()

setHmacType

public void setHmacType(HMACType hmacType)

wrap

public String wrap(Map<String,String> in)
            throws BlobCrypterException

Description copied from interface: BlobCrypter

Encrypts and signs a blob.

Specified by:

wrap in interface BlobCrypter

Parameters:

in - name/value pairs to encrypt

Returns:

a base64 encoded blob

Throws:

BlobCrypterException - when crypto errors occur

unwrap

public Map<String,String> unwrap(String in)
                          throws BlobCrypterException

Description copied from interface: BlobCrypter

Unwraps a blob.

Specified by:

unwrap in interface BlobCrypter

Parameters:

in - blob

Returns:

the name/value pairs.

Throws:

BlobCrypterException - if the blob can't be decoded.