- java.lang.Object
-
- org.apache.xml.security.utils.KeyUtils
-
public class KeyUtils extends java.lang.ObjectA set of utility methods to handle keys.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classKeyUtils.KeyAlgorithmTypeEnumeration of Supported key algorithm types.static classKeyUtils.KeyTypeEnumeration of specific key types.
-
Constructor Summary
Constructors Constructor Description KeyUtils()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static javax.crypto.SecretKeyaesWrapKeyWithDHGeneratedKey(KeyAgreementParameters parameterSpec)Method generates a secret key for given KeyAgreementParameterSpec.static java.security.KeyPairGeneratorcreateKeyPairGenerator(java.lang.String algorithm, java.security.Provider provider)Create a KeyPairGenerator for the given algorithm and provider.static byte[]deriveKeyEncryptionKey(byte[] sharedSecret, KeyDerivationParameters keyDerivationParameter)Derive a key encryption key from a shared secret and keyDerivationParameter.static byte[]deriveKeyWithConcatKDF(byte[] sharedSecret, ConcatKDFParams ckdfParameter)Derive a key using the Concatenation Key Derivation Function (ConcatKDF) with implementation instanceConcatKDFParams.static byte[]deriveKeyWithHKDF(byte[] sharedSecret, HKDFParams hkdfParameter)Derive a key using the HMAC-based Extract-and-Expand Key Derivation Function (HKDF) with implementation instanceHKDFParams.static java.security.KeyPairgenerateEphemeralDHKeyPair(java.security.PublicKey recipientPublicKey, java.security.Provider provider)Method generates DH keypair which match the type of given public key type.static intgetAESKeyBitSizeForWrapAlgorithm(java.lang.String keyWrapAlg)Defines the key size for the encrypting algorithm.
-
-
-
Method Detail
-
generateEphemeralDHKeyPair
public static java.security.KeyPair generateEphemeralDHKeyPair(java.security.PublicKey recipientPublicKey, java.security.Provider provider) throws XMLEncryptionExceptionMethod generates DH keypair which match the type of given public key type.- Parameters:
recipientPublicKey- public key of recipientprovider- provider to use for key generation- Returns:
- generated keypair
- Throws:
XMLEncryptionException- if the keys cannot be generated
-
createKeyPairGenerator
public static java.security.KeyPairGenerator createKeyPairGenerator(java.lang.String algorithm, java.security.Provider provider) throws java.security.NoSuchAlgorithmExceptionCreate a KeyPairGenerator for the given algorithm and provider.- Parameters:
algorithm- the key JCE algorithm nameprovider- the provider to use or null if default JCE provider should be used- Returns:
- the KeyPairGenerator
- Throws:
java.security.NoSuchAlgorithmException- if the algorithm is not supported
-
aesWrapKeyWithDHGeneratedKey
public static javax.crypto.SecretKey aesWrapKeyWithDHGeneratedKey(KeyAgreementParameters parameterSpec) throws XMLEncryptionException
Method generates a secret key for given KeyAgreementParameterSpec.- Parameters:
parameterSpec- KeyAgreementParameterSpec which defines algorithm to derive key- Returns:
- generated secret key
- Throws:
XMLEncryptionException- if the secret key cannot be generated as: Key agreement is not supported, wrong key types, etc.
-
getAESKeyBitSizeForWrapAlgorithm
public static int getAESKeyBitSizeForWrapAlgorithm(java.lang.String keyWrapAlg) throws XMLEncryptionExceptionDefines the key size for the encrypting algorithm.- Parameters:
keyWrapAlg- the key wrap algorithm URI- Returns:
- the key size in bits
- Throws:
XMLEncryptionException- if the key wrap algorithm is not supported
-
deriveKeyEncryptionKey
public static byte[] deriveKeyEncryptionKey(byte[] sharedSecret, KeyDerivationParameters keyDerivationParameter) throws XMLSecurityExceptionDerive a key encryption key from a shared secret and keyDerivationParameter. Currently only the ConcatKDF and HMAC-base Extract-and-Expand Key Derivation Function (HKDF) are supported.- Parameters:
sharedSecret- the shared secretkeyDerivationParameter- the key derivation parameters- Returns:
- the derived key encryption key
- Throws:
java.lang.IllegalArgumentException- if the keyDerivationParameter is nullXMLSecurityException- if the key derivation algorithm is not supported
-
deriveKeyWithHKDF
public static byte[] deriveKeyWithHKDF(byte[] sharedSecret, HKDFParams hkdfParameter) throws XMLSecurityExceptionDerive a key using the HMAC-based Extract-and-Expand Key Derivation Function (HKDF) with implementation instanceHKDFParams.- Parameters:
sharedSecret- the shared secrethkdfParameter- the HKDF parameters- Returns:
- the derived key encryption key.
- Throws:
XMLSecurityException- if the key derivation parameters are invalid or the hmac algorithm is not supported.
-
deriveKeyWithConcatKDF
public static byte[] deriveKeyWithConcatKDF(byte[] sharedSecret, ConcatKDFParams ckdfParameter) throws XMLSecurityExceptionDerive a key using the Concatenation Key Derivation Function (ConcatKDF) with implementation instanceConcatKDFParams.- Parameters:
sharedSecret- the shared secret/ input keying materialckdfParameter- the ConcatKDF parameters- Returns:
- the derived key
- Throws:
XMLSecurityException- if the key derivation parameters are invalid or the hash algorithm is not supported.
-
-