KeyGenParameterSpec

public final class KeyGenParameterSpec
extends Object implements AlgorithmParameterSpec

AlgorithmParameterSpec用于初始化KeyPairGenerator或KeyGenerator的KeyGenerator 。 该规范确定了密钥的授权使用，例如是否需要使用密钥的用户身份验证，授权哪些操作（例如签名，但不解密），使用哪些参数（例如，只使用特定的填充方案或摘要） ，以及密钥的有效开始和结束日期。 规范中表达的密钥使用授权仅适用于密钥和私钥 - 公钥可用于任何支持的操作。

为了产生非对称密钥对或对称密钥，创建使用此类的实例 KeyGenParameterSpec.Builder ，初始化 KeyPairGenerator或 KeyGenerator （例如，所期望的密钥类型的 EC或 AES -见 KeyProperties 。 KEY_ALGORITHM从常量） AndroidKeyStore提供商使用 KeyGenParameterSpec实例，然后使用 generateKey()或 generateKeyPair()生成密钥或密钥对。

生成的密钥对或密钥将由生成器返回，并存储在Android规范中指定的别名下的Android密钥库中。 要从Android密钥库中获取密钥或私钥，请使用KeyStore.getKey(String, null)或KeyStore.getEntry(String, null) 。 要从Android密钥库获取公钥，请使用getCertificate(String) ，然后使用getPublicKey() 。

为了帮助获取存储在Android Keystore中的密钥对的算法特定公共参数，生成的私钥实现了 ECKey或 RSAKey接口，而公钥实现了 ECPublicKey或 RSAPublicKey接口。

对于非对称密钥对，还会生成自签名X.509证书并存储在Android密钥库中。 这是因为KeyStore抽象不支持存储没有证书的密钥对。 本规范中可定制证书的主题，序列号和有效日期。 自签名证书可能会在稍后由证书颁发机构（CA）签署的证书替换。

注意：如果私钥没有被授权对自签名证书进行签名，则证书将被创建为具有无法验证的无效签名。 这样的证书仍然有用，因为它提供了对公钥的访问。 为了生成证书的有效签名，密钥需要被授权以下所有内容：

• PURPOSE_SIGN,
• operation without requiring the user to be authenticated (see setUserAuthenticationRequired(boolean)),
• signing/origination at this moment in time (see setKeyValidityStart(Date) and setKeyValidityForOriginationEnd(Date)),
• suitable digest,
• (RSA keys only) padding scheme SIGNATURE_PADDING_RSA_PKCS1.

注意：生成的对称密钥和专用密钥的密钥材料不可访问。 公钥的关键材料是可访问的。

这个类的实例是不可变的。

Known issues

 PublicKey unrestrictedPublicKey =
         KeyFactory.getInstance(publicKey.getAlgorithm()).generatePublic(
                 new X509EncodedKeySpec(publicKey.getEncoded()));
 

Example: NIST P-256 EC key pair for signing/verification using ECDSA

 KeyPairGenerator keyPairGenerator = KeyPairGenerator.getInstance(
         KeyProperties.KEY_ALGORITHM_EC, "AndroidKeyStore");
 keyPairGenerator.initialize(
         new KeyGenParameterSpec.Builder(
                 "key1",
                 KeyProperties.PURPOSE_SIGN)
                 .setAlgorithmParameterSpec(new ECGenParameterSpec("secp256r1"))
                 .setDigests(KeyProperties.DIGEST_SHA256,
                         KeyProperties.DIGEST_SHA384,
                         KeyProperties.DIGEST_SHA512)
                 // Only permit the private key to be used if the user authenticated
                 // within the last five minutes.
                 .setUserAuthenticationRequired(true)
                 .setUserAuthenticationValidityDurationSeconds(5 * 60)
                 .build());
 KeyPair keyPair = keyPairGenerator.generateKeyPair();
 Signature signature = Signature.getInstance("SHA256withECDSA");
 signature.initSign(keyPair.getPrivate());
 ...

 // The key pair can also be obtained from the Android Keystore any time as follows:
 KeyStore keyStore = KeyStore.getInstance("AndroidKeyStore");
 keyStore.load(null);
 PrivateKey privateKey = (PrivateKey) keyStore.getKey("key1", null);
 PublicKey publicKey = keyStore.getCertificate("key1").getPublicKey();
 

Example: RSA key pair for signing/verification using RSA-PSS

 KeyPairGenerator keyPairGenerator = KeyPairGenerator.getInstance(
         KeyProperties.KEY_ALGORITHM_RSA, "AndroidKeyStore");
 keyPairGenerator.initialize(
         new KeyGenParameterSpec.Builder(
                 "key1",
                 KeyProperties.PURPOSE_SIGN)
                 .setDigests(KeyProperties.DIGEST_SHA256, KeyProperties.DIGEST_SHA512)
                 .setSignaturePaddings(KeyProperties.SIGNATURE_PADDING_RSA_PSS)
                 .build());
 KeyPair keyPair = keyPairGenerator.generateKeyPair();
 Signature signature = Signature.getInstance("SHA256withRSA/PSS");
 signature.initSign(keyPair.getPrivate());
 ...

 // The key pair can also be obtained from the Android Keystore any time as follows:
 KeyStore keyStore = KeyStore.getInstance("AndroidKeyStore");
 keyStore.load(null);
 PrivateKey privateKey = (PrivateKey) keyStore.getKey("key1", null);
 PublicKey publicKey = keyStore.getCertificate("key1").getPublicKey();
 

Example: RSA key pair for encryption/decryption using RSA OAEP

 KeyPairGenerator keyPairGenerator = KeyPairGenerator.getInstance(
         KeyProperties.KEY_ALGORITHM_RSA, "AndroidKeyStore");
 keyPairGenerator.initialize(
         new KeyGenParameterSpec.Builder(
                 "key1",
                 KeyProperties.PURPOSE_DECRYPT)
                 .setDigests(KeyProperties.DIGEST_SHA256, KeyProperties.DIGEST_SHA512)
                 .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_RSA_OAEP)
                 .build());
 KeyPair keyPair = keyPairGenerator.generateKeyPair();
 Cipher cipher = Cipher.getInstance("RSA/ECB/OAEPWithSHA-256AndMGF1Padding");
 cipher.init(Cipher.DECRYPT_MODE, keyPair.getPrivate());
 ...

 // The key pair can also be obtained from the Android Keystore any time as follows:
 KeyStore keyStore = KeyStore.getInstance("AndroidKeyStore");
 keyStore.load(null);
 PrivateKey privateKey = (PrivateKey) keyStore.getKey("key1", null);
 PublicKey publicKey = keyStore.getCertificate("key1").getPublicKey();
 

Example: AES key for encryption/decryption in GCM mode

 KeyGenerator keyGenerator = KeyGenerator.getInstance(
         KeyProperties.KEY_ALGORITHM_AES, "AndroidKeyStore");
 keyGenerator.initialize(
         new KeyGenParameterSpec.Builder("key2",
                 KeyProperties.PURPOSE_ENCRYPT | KeyProperties.PURPOSE_DECRYPT)
                 .setBlockModes(KeyProperties.BLOCK_MODE_GCM)
                 .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_NONE)
                 .build());
 SecretKey key = keyGenerator.generateKey();

 Cipher cipher = Cipher.getInstance("AES/GCM/NoPadding");
 cipher.init(Cipher.ENCRYPT_MODE, key);
 ...

 // The key can also be obtained from the Android Keystore any time as follows:
 KeyStore keyStore = KeyStore.getInstance("AndroidKeyStore");
 keyStore.load(null);
 key = (SecretKey) keyStore.getKey("key2", null);
 

Example: HMAC key for generating a MAC using SHA-256

 KeyGenerator keyGenerator = KeyGenerator.getInstance(
         KeyProperties.KEY_ALGORITHM_HMAC_SHA256, "AndroidKeyStore");
 keyGenerator.initialize(
         new KeyGenParameterSpec.Builder("key2", KeyProperties.PURPOSE_SIGN).build());
 SecretKey key = keyGenerator.generateKey();
 Mac mac = Mac.getInstance("HmacSHA256");
 mac.init(key);
 ...

 // The key can also be obtained from the Android Keystore any time as follows:
 KeyStore keyStore = KeyStore.getInstance("AndroidKeyStore");
 keyStore.load(null);
 key = (SecretKey) keyStore.getKey("key2", null);
 

Summary

Inherited methods

From class java.lang.Object Object clone() 创建并返回此对象的副本。 boolean equals(Object obj) 指示其他某个对象是否“等于”这一个。 void finalize() 当垃圾收集确定没有更多对该对象的引用时，由对象上的垃圾回收器调用。 final Class<?> getClass() 返回此 Object的运行时类。 int hashCode() 返回对象的哈希码值。 final void notify() 唤醒正在等待该对象监视器的单个线程。 final void notifyAll() 唤醒在该对象监视器上等待的所有线程。 String toString() 返回对象的字符串表示形式。 final void wait(long millis, int nanos) 导致当前线程等待，直到另一个线程为该对象调用方法 notify()或 notifyAll()方法，或者某个其他线程中断当前线程，或者经过一定的实时时间。 final void wait(long millis) 导致当前线程等待，直到另一个线程调用此对象的 notify()方法或 notifyAll()方法或经过了指定的时间量。 final void wait() 导致当前线程等待，直到另一个线程调用此对象的 notify()方法或 notifyAll()方法。

Public methods

AlgorithmParameterSpec getAlgorithmParameterSpec ()

byte[] getAttestationChallenge ()

String[] getBlockModes ()

Date getCertificateNotAfter ()

Date getCertificateNotBefore ()

BigInteger getCertificateSerialNumber ()

X500Principal getCertificateSubject ()

String[] getDigests ()

String[] getEncryptionPaddings ()

int getKeySize ()

Date getKeyValidityForConsumptionEnd ()

Date getKeyValidityForOriginationEnd ()

Date getKeyValidityStart ()

String getKeystoreAlias ()

int getPurposes ()

String[] getSignaturePaddings ()

int getUserAuthenticationValidityDurationSeconds ()

boolean isDigestsSpecified ()

boolean isInvalidatedByBiometricEnrollment ()

boolean isRandomizedEncryptionRequired ()

boolean isUserAuthenticationRequired ()

boolean isUserAuthenticationValidWhileOnBody ()