info.pppc.base.security.key

Class HMACSymmetricKey

java.lang.Object

info.pppc.base.security.key.HMACSymmetricKey

All Implemented Interfaces:

IPrivateKey, IPublicKey, ISymmetricKey, ISymSigningKey

public class HMACSymmetricKey
extends java.lang.Object
implements ISymSigningKey

This class is used to create a symmetric key that can be used for signing (using a HMAC)

Author:

WA

Field Summary

Fields inherited from interface info.pppc.base.security.ISymmetricKey

TIMESTAMP_MANUAL, TIMESTAMP_MISSING

Constructor Summary

Constructors

Constructor and Description
HMACSymmetricKey(byte[] key, long timestamp) Creates a new symmetric signing key out of a byte array
HMACSymmetricKey(byte[] key, long timestamp, SystemID systemID) Creates a new symmetric signing key out of a byte array

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	createSignature(byte[] message) Creates a HMAC signature
byte[]	decryptMessage(byte[] message) Since this key is not for encryption, a runtime exception will be thrown.
byte[]	encryptMessage(byte[] input) Since this key is not for encryption, a runtime exception will be thrown.
boolean	forEncryption() This key cannot be used for encryption or decryption, so this method will return false.
boolean	forSigning() This key can be used for signing, so this method will return true.
SystemID	getCorrespondingSystemID()
byte[]	getKey() Get the key as a byte array.
long	getTimestamp() Returns the time stamp of a symmetric key or TIMESTAMP_MISSING, if there is no entry for the key.
boolean	verifySignature(byte[] message, byte[] signature) Use this public key to verify a signature.

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.pppc.base.security.IPublicKey

equals

Methods inherited from interface info.pppc.base.security.IPrivateKey

equals

Constructor Detail

HMACSymmetricKey

public HMACSymmetricKey(byte[] key,
                long timestamp,
                SystemID systemID)

Creates a new symmetric signing key out of a byte array

Parameters:

key - A secret key as a byte array

HMACSymmetricKey

public HMACSymmetricKey(byte[] key,
                long timestamp)

Creates a new symmetric signing key out of a byte array

Parameters:

key - A secret key as a byte array

Method Detail

encryptMessage

public byte[] encryptMessage(byte[] input)

Since this key is not for encryption, a runtime exception will be thrown.

Specified by:

encryptMessage in interface IPublicKey

Parameters:

input - A runtime exception will be thrown.

Returns:

A runtime exception will be thrown.

verifySignature

public boolean verifySignature(byte[] message,
                      byte[] signature)

Use this public key to verify a signature.

Specified by:

verifySignature in interface IPublicKey

Parameters:

message - The message which was signed

signature - The signature of this message

Returns:

True, if the signature is valid, false otherwise

createSignature

public byte[] createSignature(byte[] message)

Creates a HMAC signature

Specified by:

createSignature in interface IPrivateKey

Parameters:

message - The message that should be signed as byte array

Returns:

The HMAC signature.

decryptMessage

public byte[] decryptMessage(byte[] message)

Since this key is not for encryption, a runtime exception will be thrown.

Specified by:

decryptMessage in interface IPrivateKey

Parameters:

message - A runtime exception will be thrown.

Returns:

A runtime exception will be thrown.

forEncryption

public boolean forEncryption()

This key cannot be used for encryption or decryption, so this method will return false.

If this symmetric key can be used for encryption, this method will return true.

Specified by:

forEncryption in interface ISymmetricKey

Returns:

True, if this key can be used for encryption

forSigning

public boolean forSigning()

This key can be used for signing, so this method will return true.

If this symmetric key can be used to create signatures, this method will return true.

Specified by:

forSigning in interface ISymmetricKey

Returns:

True, if this key can be used to create signatures

getTimestamp

public long getTimestamp()

Description copied from interface: ISymmetricKey

Returns the time stamp of a symmetric key or TIMESTAMP_MISSING, if there is no entry for the key.

Specified by:

getTimestamp in interface ISymmetricKey

Returns:

The time stamp of the key.

getKey

public byte[] getKey()

Description copied from interface: ISymmetricKey

Get the key as a byte array.

Specified by:

getKey in interface ISymmetricKey

Returns:

The key of this implementation of ISymmetricKey.

getCorrespondingSystemID

public SystemID getCorrespondingSystemID()

Specified by:

getCorrespondingSystemID in interface ISymmetricKey