語言

KeyGenParameterSpec 類別

定義

AlgorithmParameterSpec 用於初始化 Android Keystore 系統的 a KeyPairGenerator 或 a KeyGenerator 。

[Android.Runtime.Register("android/security/keystore/KeyGenParameterSpec", ApiSince=23, DoNotGenerateAcw=true)]
public sealed class KeyGenParameterSpec : Java.Lang.Object, IDisposable, Java.Security.Spec.IAlgorithmParameterSpec
[<Android.Runtime.Register("android/security/keystore/KeyGenParameterSpec", ApiSince=23, DoNotGenerateAcw=true)>]
type KeyGenParameterSpec = class
    inherit Object
    interface IAlgorithmParameterSpec
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable
繼承
KeyGenParameterSpec
屬性
實作

備註

AlgorithmParameterSpec用於初始化 Android Keystore 系統的 a KeyPairGenerator 或 aKeyGenerator。 規範決定金鑰的授權用途,例如使用金鑰是否需要使用者驗證、授權哪些操作(例如簽名但不需解密)、參數(例如僅限特定填充方案或摘要),以及金鑰的有效開始與結束日期。 規範中所描述的金鑰使用授權僅適用於秘密金鑰與私鑰——公鑰可用於任何支援的操作。

要產生非對稱金鑰對或對稱金鑰,請使用Builder該類別的實例,從提供KeyPairGenerator者初始KeyGeneratorEC化所需金鑰類型(例如,AESKeyProperties或 -- 見 KEY_ALGORITHM. 常AndroidKeyStore數),KeyGenParameterSpec然後使用 KeyGenerator#generateKey() 或 KeyPairGenerator#generateKeyPair()產生金鑰或金鑰對。

產生的金鑰對或金鑰將由產生器回傳,並以本規範指定的別名儲存在 Android 金鑰庫中。若要從 Android Keystore 取得秘密或私密金鑰,請使用 java.security.KeyStore#getKey(String, char[]) KeyStore.getKey(String, null) 或 java.security.KeyStore#getEntry(String, java.security.KeyStore.ProtectionParameter) KeyStore.getEntry(String, null)。 要從 Android Keystore 取得公鑰,請使用 java.security.KeyStore#getCertificate(String) ,然後 Certificate#getPublicKey()。

為了幫助取得儲存在 Android Keystore 中的密鑰對的演算法專屬公開參數,產生私鑰的 Implement java.security.interfaces.ECKey 或 java.security.interfaces.RSAKey 介面,而公鑰則是 Implement java.security.interfaces.ECPublicKey 或 java.security.interfaces.RSAPublicKey interface。

對於非對稱金鑰對,也會產生並儲存在 Android 金鑰庫中的 X.509 憑證。 這是因為抽象 java.security.KeyStore 化不支援在沒有憑證的情況下儲存金鑰對。 證書的主題、序號及有效日期可在此規範中自訂。該證書可在日後由憑證授權機構(CA)簽署的證書取代。

注意:若未使用 Builder#setAttestationChallenge(byte[])請求認證,產生的證書可自行簽署。 若私鑰未被授權簽署該憑證,則憑證將以無效的簽章建立,無法進行驗證。 這類憑證仍然有用,因為它提供公開金鑰的存取權限。 要產生有效的憑證簽章,金鑰必須獲得以下所有授權<:ul><li>KeyProperties#PURPOSE_SIGN、</li><li>操作且不需使用者認證(參見Builder#setUserAuthenticationRequired(boolean))、</li><li 此>刻簽署/發起(參見 Builder#setKeyValidityStart(Date) 及Builder#setKeyValidityForOriginationEnd(Date))、</li><li>適合摘要,</li><li>(僅限 RSA 金鑰)填充方案。KeyProperties#SIGNATURE_PADDING_RSA_PKCS1</li></ul>

注意:產生的對稱與私鑰的金鑰材料無法存取。 公鑰的鑰匙資料是可存取的。

此類別的實例是不可變的。

<h3>已知問題</h3> Android 6.0(API 等級 23)中的一個已知錯誤導致即使是公開金鑰,使用者驗證相關的授權也會被強制執行。 為了解決這個問題,請將公開金鑰資料擷取到用於 Android Keystore 以外的資料。 例如:

{@code
            PublicKey unrestrictedPublicKey =
                    KeyFactory.getInstance(publicKey.getAlgorithm()).generatePublic(
                            new X509EncodedKeySpec(publicKey.getEncoded()));
            }

<h3>範例:用於 ECDSA/<h3> 簽署/驗證的 NIST P-256 EC 金鑰對 此範例說明如何在 Android KeyStore 系統中以別名 key1 方式產生 NIST P-256(又稱 secp256r1,或 prime256v1)EC 金鑰對,且私鑰僅被授權用於使用 SHA-256、SHA-384 或 SHA-512 摘要簽署,且僅限於使用者在過去五分鐘內完成驗證。 公開金鑰的使用不受限制(參見已知問題)。

{@code
            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();
            }

<h3>範例:使用 RSA-PSS</h3> 進行簽署/驗證的 RSA 金鑰對 此範例說明如何在 Android KeyStore 系統中產生 RSA 金鑰對,並以別名 key1 授權僅用於簽署,使用 SHA-256 或 SHA-512 摘要的 RSA-PSS 簽章填充方案。 公鑰的使用不受限制。

{@code
            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();
            }

<h3>範例:使用 RSA OAEP</h3> 進行加密/解密的 RSA 金鑰對 本範例示範如何在 Android KeyStore 系統中以別名 key1 方式產生 RSA 金鑰對,且私鑰僅被授權使用 RSA OAEP 加密填充方案與 SHA-256 或 SHA-512 摘要進行解密。 公鑰的使用不受限制。

{@code
            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();
            }

<h3>範例:用於 GCM 模式下<加密/解密的 AES 金鑰/h3> 以下範例說明如何在 Android KeyStore 系統中產生 AES 金鑰,且別名 key2 授權僅用於 GCM 模式下的加密/解密,且不需填充。

{@code
            KeyGenerator keyGenerator = KeyGenerator.getInstance(
                    KeyProperties.KEY_ALGORITHM_AES, "AndroidKeyStore");
            keyGenerator.init(
                    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);
            }

<h3>範例:使用 SHA-256</h3> 產生 MAC 的 HMAC 金鑰 此範例說明如何在 Android KeyStore 系統中以僅授權用於使用 SHA-256 產生 HMAC 的別名 key2 產生 HMAC 金鑰。

{@code
            KeyGenerator keyGenerator = KeyGenerator.getInstance(
                    KeyProperties.KEY_ALGORITHM_HMAC_SHA256, "AndroidKeyStore");
            keyGenerator.init(
                    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);
            }

<h3 id=“example:ecdh”>範例:EC 金鑰用於 ECDH 金鑰協議</h3> 此範例說明如何產生橢圓曲線金鑰對,用於利用 ECDH 金鑰協議與另一方建立共享祕密。

{@code
            KeyPairGenerator keyPairGenerator = KeyPairGenerator.getInstance(
                    KeyProperties.KEY_ALGORITHM_EC, "AndroidKeyStore");
            keyPairGenerator.initialize(
                    new KeyGenParameterSpec.Builder(
                        "eckeypair",
                        KeyProperties.PURPOSE_AGREE_KEY)
                        .setAlgorithmParameterSpec(new ECGenParameterSpec("secp256r1"))
                        .build());
            KeyPair myKeyPair = keyPairGenerator.generateKeyPair();

            // Exchange public keys with server. A new ephemeral key MUST be used for every message.
            PublicKey serverEphemeralPublicKey; // Ephemeral key received from server.

            // Create a shared secret based on our private key and the other party's public key.
            KeyAgreement keyAgreement = KeyAgreement.getInstance("ECDH", "AndroidKeyStore");
            keyAgreement.init(myKeyPair.getPrivate());
            keyAgreement.doPhase(serverEphemeralPublicKey, true);
            byte[] sharedSecret = keyAgreement.generateSecret();

            // sharedSecret cannot safely be used as a key yet. We must run it through a key derivation
            // function with some other data: "salt" and "info". Salt is an optional random value,
            // omitted in this example. It's good practice to include both public keys and any other
            // key negotiation data in info. Here we use the public keys and a label that indicates
            // messages encrypted with this key are coming from the server.
            byte[] salt = {};
            ByteArrayOutputStream info = new ByteArrayOutputStream();
            info.write("ECDH secp256r1 AES-256-GCM-SIV\0".getBytes(StandardCharsets.UTF_8));
            info.write(myKeyPair.getPublic().getEncoded());
            info.write(serverEphemeralPublicKey.getEncoded());

            // This example uses the Tink library and the HKDF key derivation function.
            AesGcmSiv key = new AesGcmSiv(Hkdf.computeHkdf(
                    "HMACSHA256", sharedSecret, salt, info.toByteArray(), 32));
            byte[] associatedData = {};
            return key.decrypt(ciphertext, associatedData);
            }

Java 文件 android.security.keystore.KeyGenParameterSpec。

本頁部分內容為基於 Open Source Project 所創建與分享的作品,並依授權條款所描述的使用進行修改。

屬性

名稱 Description
AlgorithmParameterSpec

回傳用於建立金鑰的演算法專屬 AlgorithmParameterSpec 金鑰,或 null 是否應使用演算法特定的預設值。

AttestKeyAlias

回傳用於簽署所產生金鑰證明證書的別名。

CertificateNotAfter

回傳用於 X.509 憑證的結束日期,該憑證會放在 java.security.KeyStore.

CertificateNotBefore

回傳開始日期,用於 X.509 憑證,該憑證將被 java.security.KeyStore放入 .

CertificateSerialNumber

回傳用於 X.509 憑證的序號,該憑證將被 java.security.KeyStore放入 .

CertificateSubject

回傳用於 X.509 證書的主題區分名稱,該證書將被 java.security.KeyStore放入 .

Class

回傳此 Object的執行時類別。

(繼承來源 Object)
Handle

底層 Android 實例的帳號。

(繼承來源 Object)
IsDevicePropertiesAttestationIncluded

若被要求在產生的金鑰的認證憑證中加入基礎裝置屬性(true, Build#BRAND, Build#DEVICE, Build#MANUFACTURERBuild#MODEL, ) 的認證,則回傳Build#PRODUCT該資料。

IsDigestsSpecified

若指定可用於該金鑰的摘要演算法集合,則回傳 true 。

IsInvalidatedByBiometricEnrollment

若在新生物識別註冊或所有註冊生物識別資料被移除後,該金鑰不可逆轉地失效,則會退還 true 。

IsMgf1DigestsSpecified

true若指定可用於 MGF1 遮罩產生函數的消化集,則返回。

IsRandomizedEncryptionRequired

如果使用此金鑰加密,則返回 true 必須足夠隨機化,以每次產生相同明文的不同密文。

IsStrongBoxBacked

如果鑰匙有 Strongbox 安全晶片保護,則會回傳 true 。

IsUnlockedDeviceRequired

若鑰匙被授權只能在裝置解鎖時使用,則會退貨 true 。

IsUserAuthenticationRequired

若金鑰被授權僅在使用者已認證時使用,則會回傳 true 。

IsUserAuthenticationValidWhileOnBody

若金鑰僅在裝置從使用者體內移除為止,且有效期限內仍被授權,則會回傳 true 。

IsUserConfirmationRequired

若金鑰被授權僅用於使用者確認的訊息,則會回傳 true 。

IsUserPresenceRequired

若金鑰被授權僅在 與 true 通話間Signature.initSign()測試使用者存在狀態時使用,則回傳Signature.sign()。

JniIdentityHashCode

取得由互通執行時指派給此 Java 對等端的身份雜湊碼。

(繼承來源 Object)
JniManagedPeerState

取得執行時最後指派的狀態旗標。

(繼承來源 JavaObject)
JniPeerMembers

取得用於存取此 Java 綁定成員的 JNI 元資料。

KeySize

回傳請求的金鑰大小。

KeystoreAlias

回傳將java.security.KeyStoreAndroidKeyStore與 搭配使用的別名。

KeyValidityForConsumptionEnd

回傳金鑰在解密與驗證時不再有效的時間點,若 null 未受限則為該時間點。

KeyValidityForOriginationEnd

回傳金鑰不再用於加密與簽署的時間點,若 null 未受限制則無法使用。

KeyValidityStart

回傳金鑰尚未有效或 null 未被限制的時間點。

MaxUsageCount

回傳有限使用金鑰允許使用的最大次數,或 KeyProperties#UNRESTRICTED_USAGE_COUNT 若金鑰使用次數無限制。

Mgf1Digests

回傳 MGF1 遮罩產生函數可用來 的消化集合(例如 SHA-256, ) SHA-384與鍵。

PeerReference

取得這個 Java 節點的 JNI 物件參考。

(繼承來源 Object)
Purposes

回傳可用於該金鑰的目的集合(例如加密、解密、簽名)。

ThresholdClass

此 API 支援 Mono for Android 基礎架構,並非直接從你的程式碼中使用。

(繼承來源 Object)
ThresholdType

此 API 支援 Mono for Android 基礎架構,並非直接從你的程式碼中使用。

(繼承來源 Object)
UserAuthenticationType

取得可授權使用此金鑰的認證模式。

UserAuthenticationValidityDurationSeconds

取得使用者成功認證後,該金鑰被授權使用的時間(秒數)。

方法

名稱 Description
Clone()

建立並回傳此物件的副本。

(繼承來源 Object)
Construct(JniObjectReference, JniObjectReferenceOptions)

將此對等節點的建置委派給執行時的值管理器。

(繼承來源 JavaObject)
Dispose()

釋放該 Java 節點所持有的資源。

(繼承來源 Object)
Dispose(Boolean)

釋放該 Java 節點所持有的資源。

(繼承來源 Object)
DisposeUnlessReferenced()

請求值管理器處置此對等節點,除非其映射保留該受管理實例。

(繼承來源 JavaObject)
Equals(Object)

測試另一個受管理節點是否參考相同的 Java 物件。

(繼承來源 JavaObject)
Equals(Object)

表示是否有其他物體「等同」於此物。

(繼承來源 Object)
GetAttestationChallenge()

回傳將放置於此金鑰組合的證明證書中的認證挑戰值。

GetBlockModes()

取得一組區塊模式(例如, GCM, CBC),可用於加密/解密時使用金鑰的模式。

GetDigests()

回傳一組消化演算法(例如:

GetEncryptionPaddings()

回傳可用於加密/解密金鑰的填充方案集合(例如 PKCS7Padding, OEAPPaddingPKCS1PaddingNoPadding)。

GetHashCode()

回傳物件的雜湊碼值。

(繼承來源 Object)
GetSignaturePaddings()

取得一組填充方案(例如, PSS,), PKCS#1可用於簽署/驗證時使用金鑰。

JavaFinalize()
已淘汰.

當垃圾回收判定該物件不再有相關參考時,由垃圾回收器呼叫。

(繼承來源 Object)
Notify()

喚醒一個正在該物件監視器上等待的執行緒。

(繼承來源 Object)
NotifyAll()

喚醒所有等待該物件監視器的執行緒。

(繼承來源 Object)
SetHandle(IntPtr, JniHandleOwnership)

設定 Handle 屬性。

(繼承來源 Object)
SetPeerReference(JniObjectReference, JniObjectReferenceOptions)

在控制區塊中儲存參考值,但不建立 JNI 參考副本。

(繼承來源 JavaObject)
ToArray<T>()

從這個 Java 陣列包裝器建立一個受管理陣列。

(繼承來源 Object)
ToString()

回傳物件的字串表示。

(繼承來源 Object)
UnregisterFromRuntime()

將此 Java 節點從互通執行時中取消註冊。

(繼承來源 Object)
Wait()

導致目前執行緒等待被喚醒,通常是透過 <em>通知</><em 或 em>中斷</em> 來喚醒。

(繼承來源 Object)
Wait(Int64, Int32)

會讓目前執行緒等待喚醒,通常是透過 <em>通知</><em 或 em>中斷</em>,或是經過一定的真實時間。

(繼承來源 Object)
Wait(Int64)

會讓目前執行緒等待喚醒,通常是透過 <em>通知</><em 或 em>中斷</em>,或是經過一定的真實時間。

(繼承來源 Object)

明確介面實作

名稱 Description
IJavaPeerable.Disposed()

標記此節點為處置,並以disposing設定為 true的呼叫Dispose。

(繼承來源 JavaObject)
IJavaPeerable.Finalized()

標記此節點為處置,並以disposing設定為 false的呼叫Dispose。

(繼承來源 JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock

取得此對等端使用的原生控制區塊指標。

(繼承來源 JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)

儲存執行時提供的身份雜湊碼。

(繼承來源 JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)

取代儲存的受管理對等狀態旗標。

(繼承來源 JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)

當引用無效時,更新對等節點並釋放已拋棄節點的控制區塊。

(繼承來源 JavaObject)
IJavaPeerable.UnregisterFromRuntime()

將此實例從執行時的 Java 物件查詢中移除。

擴充方法

名稱 Description
GetJniTypeName(IJavaPeerable)

取得實例 self類型的 JNI 名稱。

JavaAs<TResult>(IJavaPeerable)

試著強制self輸入 TResult,檢查 強制在 Java 端是否有效。

JavaCast<TResult>(IJavaObject)

執行 Android 執行時檢查型別轉換。

JavaCast<TResult>(IJavaObject)

重用相容的受管理對等端或取得請求型態的包裝器。

TryJavaCast<TResult>(IJavaPeerable, TResult)

試著強制self輸入 TResult,檢查 強制在 Java 端是否有效。

適用於