Package com.icodici.crypto.rsaoaep

Class RSAOAEPPrivateKey

java.lang.Object

com.icodici.crypto.AbstractKey

com.icodici.crypto.AbstractAsymmetricKey

com.icodici.crypto.AbstractPrivateKey

com.icodici.crypto.rsaoaep.RSAOAEPPrivateKey

All Implemented Interfaces:

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

public class RSAOAEPPrivateKey
extends AbstractPrivateKey

The Private Key for RSA asymmetric algorithm used together with OAEP padding. All key information is private, until increasing its visibility is really needed. Default hash and MGF1 hash are SHA-256.

Created by amyodov on 16.04.16.

Nested Class Summary

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

net.sergeych.tools.Hashable.Error

Field Summary

Fields

Modifier and Type	Field	Description
static HashType	DEFAULT_MGF1_HASH	The default MGF1 hash algorithm.
static HashType	DEFAULT_OAEP_HASH	The default hash algorithm for OAEP.

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
RSAOAEPPrivateKey()	Empty constructor.

Method Summary

Modifier and Type	Method	Description
boolean	canDecrypt()	Check that this key instance is suitable for decryption too (some keys can provide sign only functionality).
byte[]	decrypt(byte[] ciphertext)	Decrypt the ciphertext.
void	generate(int bitStrength, byte[] e, int certainty, HashType oaepHashType, HashType mgf1HashType)	Generate a new key pair, with all options specified.
void	generate(int bitStrength, HashType mgf1HashType)	Generate a new key pair of the specified bit strength.
int	getBitStrength()
AbstractPublicKey	getPublicKey()	Return valid public key, for example self, or raise the exception.
boolean	isInitialized()	True if the key is properly initialized.
byte[]	pack()
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.
@NonNull java.util.Map<java.lang.String,java.lang.Object>	toHash()
java.lang.String	toString()
void	updateFromHash(java.util.Map<java.lang.String,java.lang.Object> hash)

Methods inherited from class com.icodici.crypto.AbstractPrivateKey

sign, sign, sign, sign, sign

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, packedInfo, packToBase64String, setTag, setTag, toBinder, unpack, updateDigestWithKeyComponents, updateFrom, verify, verify, verify

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OAEP_HASH

public static final HashType DEFAULT_OAEP_HASH

The default hash algorithm for OAEP.

DEFAULT_MGF1_HASH

public static final HashType DEFAULT_MGF1_HASH

The default MGF1 hash algorithm.

Constructor Detail

RSAOAEPPrivateKey

public RSAOAEPPrivateKey()

Empty constructor.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class AbstractKey

generate

public 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).

Specified by:

generate in class AbstractPrivateKey

Parameters:

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

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

generate

public void generate(int bitStrength,
                     byte[] e,
                     int certainty,
                     HashType oaepHashType,
                     HashType mgf1HashType)

Generate a new key pair, with all options specified.

Parameters:

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

e - RSA public exponent

certainty - RSA key generation certainty

mgf1HashType - The type of the hash(digest) function used for OAEP MGF1 hash generation.

isInitialized

public boolean isInitialized()

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

Specified by:

isInitialized in class AbstractPrivateKey

getBitStrength

public int getBitStrength()
                   throws java.lang.IllegalStateException

Specified by:

getBitStrength in class AbstractPrivateKey

Returns:

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

Throws:

java.lang.IllegalStateException

getPublicKey

public AbstractPublicKey getPublicKey()
                               throws java.lang.IllegalStateException

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

Specified by:

getPublicKey in class AbstractPrivateKey

Returns:

corresponding public key

Throws:

java.lang.IllegalStateException

canDecrypt

public boolean canDecrypt()

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

Specified by:

canDecrypt in class AbstractPrivateKey

Returns:

true if this key can be used for decryption.

decrypt

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

Decrypt the ciphertext.

Specified by:

decrypt in class AbstractPrivateKey

Parameters:

ciphertext - to decrypt

Returns:

decrypted plaintext

Throws:

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

sign

public byte[] sign(java.io.InputStream input,
                   HashType hashType,
                   @org.checkerframework.checker.nullness.qual.Nullable byte[] salt)
            throws java.lang.IllegalStateException,
                   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.

Signature is created using RSA-PSS as described in PKCS# 1 v 2.1.

Specified by:

sign in class AbstractPrivateKey

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.

java.lang.IllegalStateException

toHash

public @NonNull java.util.Map<java.lang.String,java.lang.Object> toHash()
                                                                       throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

updateFromHash

public void updateFromHash(java.util.Map<java.lang.String,java.lang.Object> hash)
                    throws net.sergeych.tools.Hashable.Error

Throws:

net.sergeych.tools.Hashable.Error

pack

public byte[] pack()

Overrides:

pack in class AbstractKey