Top Description Inners Fields Constructors Methods

org.bouncycastle.crypto.asymmetric

public abstract Class AsymmetricRSAKey

Class Inheritance

extends Object
implements AsymmetricKey

java.lang.Object
org.bouncycastle.crypto.asymmetric.AsymmetricRSAKey

All Implemented Interfaces

org.bouncycastle.crypto.AsymmetricKey, org.bouncycastle.crypto.Key

Known Direct Subclasses

org.bouncycastle.crypto.asymmetric.AsymmetricRSAPrivateKey, org.bouncycastle.crypto.asymmetric.AsymmetricRSAPublicKey

Imports

java.lang.ref.WeakReference, java.math.BigInteger, java.util.HashSet, .Set, .WeakHashMap, java.util.concurrent.atomic.AtomicReference, org.bouncycastle.asn1.ASN1ObjectIdentifier, .DERNull, org.bouncycastle.asn1.pkcs.PKCSObjectIdentifiers, org.bouncycastle.asn1.x509.AlgorithmIdentifier, .X509ObjectIdentifiers, org.bouncycastle.crypto.Algorithm, .AsymmetricKey, .CryptoServicesRegistrar, org.bouncycastle.crypto.fips.FipsUnapprovedOperationError, org.bouncycastle.util.Properties

Base class for RSA keys.

Note

the module attempts to prevent accidental recent use of RSA keys for signing and encryption purposes by associating a specific usage with a modulus. If the module is not running in approved mode this behavior can be overridden by setting the system property "org.bouncycastle.rsa.allow_multi_use" to "true".

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	AsymmetricRSAKey.KeyMarker
public static enum	AsymmetricRSAKey.Usage Specific RSA key usages.

Field Summary

Modifier and Type	Field and Description
private Algorithm	algorithm
private final boolean	approvedModeOnly
protected static final AlgorithmIdentifier	DEF_ALG_ID
private final AsymmetricRSAKey.KeyMarker	keyMarker
private static WeakHashMap<BigInteger, WeakReference<AsymmetricRSAKey.KeyMarker>>	markers
protected BigInteger	modulus
protected final AlgorithmIdentifier	rsaAlgIdentifier
private static final Set<ASN1ObjectIdentifier>	rsaOids

Constructor Summary

Access	Constructor and Description
pack-priv	AsymmetricRSAKey(Algorithm algorithm, BigInteger modulus)
pack-priv	AsymmetricRSAKey(Algorithm algorithm, AlgorithmIdentifier rsaAlgIdentifier, BigInteger modulus)

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if the modulus is already associated with the usage, or has not being used already. canBeUsed(AsymmetricRSAKey.Usage usage for the RSA key. usage) Check to see if a key can be used for a specific usage.
protected final void	checkApprovedOnlyModeStatus()
public Algorithm	Returns: the key's algorithm. getAlgorithm() Implements org.bouncycastle.crypto.Key.getAlgorithm. Return the algorithm this RSA key is for.
pack-priv static synchronized AsymmetricRSAKey.KeyMarker	getKeyMarker(BigInteger modulus)
public BigInteger	Returns: the key's modulus. getModulus() Return the modulus for this RSA key.
pack-priv static synchronized boolean	isAlreadySeen(BigInteger modulus)
protected void	zeroize()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

algorithm	back to summary
private Algorithm algorithm

approvedModeOnly	back to summary
private final boolean approvedModeOnly

DEF_ALG_ID	back to summary
protected static final AlgorithmIdentifier DEF_ALG_ID

keyMarker	back to summary
private final AsymmetricRSAKey.KeyMarker keyMarker

markers	back to summary
private static WeakHashMap<BigInteger, WeakReference<AsymmetricRSAKey.KeyMarker>> markers

modulus	back to summary
protected BigInteger modulus

rsaAlgIdentifier	back to summary
protected final AlgorithmIdentifier rsaAlgIdentifier

rsaOids	back to summary
private static final Set<ASN1ObjectIdentifier> rsaOids

Constructor Detail

AsymmetricRSAKey	back to summary
pack-priv AsymmetricRSAKey(Algorithm algorithm, BigInteger modulus)

AsymmetricRSAKey	back to summary
pack-priv AsymmetricRSAKey(Algorithm algorithm, AlgorithmIdentifier rsaAlgIdentifier, BigInteger modulus)

Method Detail

canBeUsed	back to summary
public boolean canBeUsed(AsymmetricRSAKey.Usage usage) Check to see if a key can be used for a specific usage. Essentially this will return false if the modulus is associated with a different usage already. The system property "org.bouncycastle.rsa.allow_multi_use" can be set to "true" to override this check. Parameters usage:AsymmetricRSAKey.Usage usage for the RSA key. Returns:boolean true if the modulus is already associated with the usage, or has not being used already.

canBeUsed

back to summary

public boolean canBeUsed(AsymmetricRSAKey.Usage usage)

Check to see if a key can be used for a specific usage. Essentially this will return false if the modulus is associated with a different usage already. The system property "org.bouncycastle.rsa.allow_multi_use" can be set to "true" to override this check.

Parameters

usage:AsymmetricRSAKey.Usage: usage for the RSA key.

Returns:boolean

true if the modulus is already associated with the usage, or has not being used already.

checkApprovedOnlyModeStatus	back to summary
protected final void checkApprovedOnlyModeStatus()

getAlgorithm	back to summary
public Algorithm getAlgorithm() Implements org.bouncycastle.crypto.Key.getAlgorithm. Return the algorithm this RSA key is for. Returns:Algorithm the key's algorithm.

getAlgorithm

back to summary

public Algorithm getAlgorithm()

Implements org.bouncycastle.crypto.Key.getAlgorithm.

Return the algorithm this RSA key is for.

Returns:Algorithm: the key's algorithm.

getKeyMarker	back to summary
pack-priv static synchronized AsymmetricRSAKey.KeyMarker getKeyMarker(BigInteger modulus)

getModulus	back to summary
public BigInteger getModulus() Return the modulus for this RSA key. Returns:BigInteger the key's modulus.

getModulus

back to summary

public BigInteger getModulus()

Return the modulus for this RSA key.

Returns:BigInteger: the key's modulus.

isAlreadySeen	back to summary
pack-priv static synchronized boolean isAlreadySeen(BigInteger modulus)

zeroize	back to summary
protected void zeroize()

org.bouncycastle.crypto.asymmetric back to summary

private Class AsymmetricRSAKey.KeyMarker

Class Inheritance

extends Object

java.lang.Object
org.bouncycastle.crypto.asymmetric.AsymmetricRSAKey.KeyMarker

Field Summary

Modifier and Type	Field and Description
private final AtomicReference<AsymmetricRSAKey.Usage>	keyUsage
private final BigInteger	modulus

Constructor Summary

Access	Constructor and Description
pack-priv	KeyMarker(BigInteger modulus)

Method Summary

Modifier and Type	Method and Description
public boolean	canBeUsed(AsymmetricRSAKey.Usage usage)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

keyUsage	back to summary
private final AtomicReference<AsymmetricRSAKey.Usage> keyUsage

modulus	back to summary
private final BigInteger modulus

Constructor Detail

KeyMarker	back to summary
pack-priv KeyMarker(BigInteger modulus)

Method Detail

canBeUsed	back to summary
public boolean canBeUsed(AsymmetricRSAKey.Usage usage)

org.bouncycastle.crypto.asymmetric back to summary

public final Enum AsymmetricRSAKey.Usage

Class Inheritance

extends Enum<AsymmetricRSAKey.Usage>

java.lang.Object
java.lang.Enum
org.bouncycastle.crypto.asymmetric.AsymmetricRSAKey.Usage

Specific RSA key usages.

Field Summary

Modifier and Type	Field and Description
public static final AsymmetricRSAKey.Usage	ENCRYPT_OR_DECRYPT Key usage encryption or decryption.
public static final AsymmetricRSAKey.Usage	SIGN_OR_VERIFY Key usage signing or verification.

Constructor Summary

Access	Constructor and Description
private	Usage()

Method Summary

Modifier and Type	Method and Description
public static AsymmetricRSAKey.Usage	valueOf(String name)
public static AsymmetricRSAKey.Usage[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ENCRYPT_OR_DECRYPT	back to summary
public static final AsymmetricRSAKey.Usage ENCRYPT_OR_DECRYPT Key usage encryption or decryption.

SIGN_OR_VERIFY	back to summary
public static final AsymmetricRSAKey.Usage SIGN_OR_VERIFY Key usage signing or verification.

Constructor Detail

Usage	back to summary
private Usage()

Method Detail

valueOf	back to summary
public static AsymmetricRSAKey.Usage valueOf(String name)

values	back to summary
public static AsymmetricRSAKey.Usage[] values()