Package com.icodici.crypto

Class AbstractPrivateKey

java.lang.Object

com.icodici.crypto.AbstractKey

com.icodici.crypto.AbstractAsymmetricKey

com.icodici.crypto.AbstractPrivateKey

All Implemented Interfaces:

KeyMatcher, net.sergeych.tools.Bindable, net.sergeych.tools.Hashable

Direct Known Subclasses:

RSAOAEPPrivateKey

public abstract class AbstractPrivateKey
extends AbstractAsymmetricKey
implements net.sergeych.tools.Hashable

Generic private key interface.

Important: The Key can be in not-initialized state after creation, in which case the depending methods must throw IllegalStateException. Non-initialized state is a transient state between creation and construction from the hash or generation new key.

Created by sergeych on 15/04/16.

Nested Class Summary

Nested classes/interfaces inherited from interface net.sergeych.tools.Hashable

net.sergeych.tools.Hashable.Error

Field Summary

Fields inherited from class com.icodici.crypto.AbstractAsymmetricKey

MAX_SALT_LENGTH

Fields inherited from class com.icodici.crypto.AbstractKey

FINGERPRINT_SHA256, FINGERPRINT_SHA384, keyInfo, TYPE_PRIVATE, TYPE_PRIVATE_PASSWORD, TYPE_PRIVATE_PASSWORD_V2, TYPE_PUBLIC

Constructor Summary

Constructors

Constructor	Description
AbstractPrivateKey()

Method Summary

Modifier and Type	Method	Description
abstract boolean	canDecrypt()	Check that this key instance is suitable for decryption too (some keys can provide sign only functionality).
abstract byte[]	decrypt(byte[] ciphertext)	Decrypt the ciphertext.
abstract void	generate(int bitStrength, HashType mgf1HashType)	Generate a new key pair of the specified bit strength.
abstract int	getBitStrength()
abstract AbstractPublicKey	getPublicKey()	Return valid public key, for example self, or raise the exception.
abstract boolean	isInitialized()	True if the key is properly initialized.
byte[]	sign(byte[] data, HashType hashType)	Digitally sign data in array.
byte[]	sign(byte[] data, HashType hashType, @org.checkerframework.checker.nullness.qual.Nullable byte[] salt)	Digitally sign data in array.
byte[]	sign(java.io.InputStream input, HashType hashType)	Sign the source document represented by the input stream.
abstract byte[]	sign(java.io.InputStream input, HashType hashType, @org.checkerframework.checker.nullness.qual.Nullable byte[] salt)	Sign the source document represented by the input stream.
byte[]	sign(java.lang.String data, HashType hashType)	Digitally sign a string encoded in UTF-8.
byte[]	sign(java.lang.String data, HashType hashType, @org.checkerframework.checker.nullness.qual.Nullable byte[] salt)	Digitally sign a string encoded in UTF-8.

Methods inherited from class com.icodici.crypto.AbstractAsymmetricKey

getMaxSaltLength

Methods inherited from class com.icodici.crypto.AbstractKey

address, asKeySource, canSign, createAnonymousId, encrypt, fingerprint, fromBinder, getLongAddress, getShortAddress, info, isMatchingKey, isMatchingKeyAddress, isPrivate, isPublic, matchAnonymousId, matchTag, matchType, pack, packedInfo, packToBase64String, setTag, setTag, toBinder, toString, unpack, updateDigestWithKeyComponents, updateFrom, verify, verify, verify

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sergeych.tools.Hashable

toHash, updateFromHash

Constructor Detail

AbstractPrivateKey

public AbstractPrivateKey()

Method Detail

generate

public abstract void generate(int bitStrength,
                              HashType mgf1HashType)

Generate a new key pair of the specified bit strength.

The private key instance should have empty constructor (non initialized instance).

Parameters:

bitStrength - bit strength of the key, e.g. 2048 ro RSA.

mgf1HashType - hash function used for MGF1 (normally this is SHA1).

isInitialized

public abstract boolean isInitialized()

True if the key is properly initialized. The key is initialized after generate is called or loaded from the hash (see Hashable

getBitStrength

public abstract int getBitStrength()

Returns:

bit strength of the key, e.g. 2048 for RSA.

getPublicKey

public abstract AbstractPublicKey getPublicKey()
                                        throws java.lang.IllegalStateException

Description copied from class: AbstractKey

Return valid public key, for example self, or raise the exception. This implementation returns self if AbstractKey.isPublic() or throws an exception.

Overrides:

getPublicKey in class AbstractKey

Returns:

corresponding public key

Throws:

java.lang.IllegalStateException

canDecrypt

public abstract boolean canDecrypt()

Check that this key instance is suitable for decryption too (some keys can provide sign only functionality).

Returns:

true if this key can be used for decryption.

decrypt

public abstract byte[] decrypt(byte[] ciphertext)
                        throws EncryptionError

Decrypt the ciphertext.

Overrides:

decrypt in class AbstractKey

Parameters:

ciphertext - to decrypt

Returns:

decrypted plaintext

Throws:

EncryptionError - if any error prevents decryption (incorrect block data, block too short and like)

sign

public abstract byte[] sign(java.io.InputStream input,
                            HashType hashType,
                            @org.checkerframework.checker.nullness.qual.Nullable byte[] salt)
                     throws java.io.IOException

Sign the source document represented by the input stream. The document can be way too large to load the whole into memory, so implementations should calculate the signature by reading portions of it from the stream.

Parameters:

input - document to sign

salt - salt to use; may be null, then it is generated automatically with the maximum possible size.

Returns:

digital signature of the document

Throws:

java.io.IOException - if the document can't be read, is empty and like.

sign

public byte[] sign(java.io.InputStream input,
                   HashType hashType)
            throws java.io.IOException

Sign the source document represented by the input stream. The document can be way too large to load the whole into memory, so implementations should calculate the signature by reading portions of it from the stream.

Overrides:

sign in class AbstractKey

Parameters:

input - document to sign

Returns:

digital signature of the document

Throws:

java.io.IOException - if the document can't be read, is empty and like.

sign

public byte[] sign(byte[] data,
                   HashType hashType,
                   @org.checkerframework.checker.nullness.qual.Nullable byte[] salt)

Digitally sign data in array.

Parameters:

data - to sign

salt - salt to use; may be null, then it is generated automatically with the maximum possible size.

Returns:

digital signature

sign

public byte[] sign(byte[] data,
                   HashType hashType)

Digitally sign data in array.

Overrides:

sign in class AbstractKey

Parameters:

data - to sign

Returns:

digital signature

sign

public byte[] sign(java.lang.String data,
                   HashType hashType,
                   @org.checkerframework.checker.nullness.qual.Nullable byte[] salt)

Digitally sign a string encoded in UTF-8.

Parameters:

data - to sign

salt - salt to use; may be null, then it is generated automatically with the maximum possible size.

Returns:

digital signature

sign

public byte[] sign(java.lang.String data,
                   HashType hashType)

Digitally sign a string encoded in UTF-8.

Parameters:

data - to sign

Returns:

digital signature