KeyProtection クラス

定義

[Android.Runtime.Register("android/security/keystore/KeyProtection", ApiSince=23, DoNotGenerateAcw=true)]
public sealed class KeyProtection : Java.Lang.Object, IDisposable, Java.Interop.IJavaPeerable, Java.Security.KeyStore.IProtectionParameter

[<Android.Runtime.Register("android/security/keystore/KeyProtection", ApiSince=23, DoNotGenerateAcw=true)>]
type KeyProtection = class
    inherit Object
    interface KeyStore.IProtectionParameter
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

継承

Object

Object

KeyProtection

属性

RegisterAttribute

実装

IJavaObject IJavaPeerable KeyStore.IProtectionParameter IDisposable

注釈

Android キーストア システムにインポートするときにキーまたはキー ペアをセキュリティで保護する方法の指定。 このクラスは、キーの使用にユーザー認証が必要かどうか、キーが承認される操作 (暗号化解除、署名なしなど) と、キーの有効期間の開始日と終了日など、インポートされたキーの承認された使用方法を指定します。 このクラスで表されるキー使用承認は、秘密鍵と秘密キーにのみ適用されます。公開キーは、サポートされている任意の操作に使用できます。

キーまたはキーペアを Android キーストアにインポートするには、このクラスのインスタンスを作成し、インポートするキーまたはキーペアを使用して Builder インスタンス java.security.KeyStore#setEntry(String, java.security.KeyStore.Entry, ProtectionParameter) KeyStore.setEntry を渡します。

Android キーストアからシークレット/対称キーまたは秘密キーを取得するには、次を使用 java.security.KeyStore#getKey(String, char[]) KeyStore.getKey(String, null) します java.security.KeyStore#getEntry(String, java.security.KeyStore.ProtectionParameter) KeyStore.getEntry(String, null)。 Android キーストアから公開キーを取得するには、次を使用 java.security.KeyStore#getCertificate(String) します Certificate#getPublicKey()。

Android キーストアに格納されているキー ペアのアルゴリズム固有の公開パラメーターを取得するために、その秘密キーは、公開キーが実装またはインターフェイスを実装するのに対して、またはインターフェイスを実装java.security.interfaces.ECKeyjava.security.interfaces.ECPublicKeyしますjava.security.interfaces.RSAPublicKey。java.security.interfaces.RSAKey

注: Android キーストアに格納されているキーのキー マテリアルにはアクセスできません。

このクラスのインスタンスは不変です。

<h3>既知の問題</h3> Android 6.0 (API レベル 23) の既知のバグにより、公開キーに対してもユーザー認証関連の承認が適用されます。 この問題を回避するには、Android キーストアの外部で使用する公開キーマテリアルを抽出します。 次に例を示します。

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

<h3>例: GCM モードでの暗号化/復号化のための AES キー/h3> この例では、埋め込みなしで GCM モード<での暗号化/復号化にのみ使用することが承認されたエイリアスkey1で、Android KeyStore に AES キーをインポートする方法を示します。 キーは、そのキー マテリアルを形式でRAWエクスポートするKey#getEncoded()必要があります。

{@code
            SecretKey key = ...; // AES key

            KeyStore keyStore = KeyStore.getInstance("AndroidKeyStore");
            keyStore.load(null);
            keyStore.setEntry(
                    "key1",
                    new KeyStore.SecretKeyEntry(key),
                    new KeyProtection.Builder(KeyProperties.PURPOSE_ENCRYPT | KeyProperties.PURPOSE_DECRYPT)
                            .setBlockMode(KeyProperties.BLOCK_MODE_GCM)
                            .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_NONE)
                            .build());
            // Key imported, obtain a reference to it.
            SecretKey keyStoreKey = (SecretKey) keyStore.getKey("key1", null);
            // The original key can now be discarded.

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

<h3>例: SHA-512/h3> を使用して MAC を生成するための HMAC キー この例では、SHA-512< ダイジェストを使用して MAC を生成する場合にのみ使用することが許可されているエイリアスkey1で、Android KeyStore に HMAC キーをインポートする方法を示します。 キーは、そのキー マテリアルを形式でRAWエクスポートするKey#getEncoded()必要があります。

{@code
            SecretKey key = ...; // HMAC key of algorithm "HmacSHA512".

            KeyStore keyStore = KeyStore.getInstance("AndroidKeyStore");
            keyStore.load(null);
            keyStore.setEntry(
                    "key1",
                    new KeyStore.SecretKeyEntry(key),
                    new KeyProtection.Builder(KeyProperties.PURPOSE_SIGN).build());
            // Key imported, obtain a reference to it.
            SecretKey keyStoreKey = (SecretKey) keyStore.getKey("key1", null);
            // The original key can now be discarded.

            Mac mac = Mac.getInstance("HmacSHA512");
            mac.init(keyStoreKey);
            ...
            }

<h3>例: ECDSA</h3> を使用した署名/検証のための EC キー ペア この例では、SHA-256 ダイジェストまたは SHA-512 ダイジェストでの署名にのみ使用する秘密キーを使用して、エイリアス key2 の下で ANDROID KeyStore に EC キー ペアをインポートする方法を示します。 公開キーの使用は無制限です。 秘密キーと公開キーの両方で、それぞれキー マテリアルをエクスポートし、X.509形式をPKCS#8指定Key#getEncoded()する必要があります。

{@code
            PrivateKey privateKey = ...;   // EC private key
            Certificate[] certChain = ...; // Certificate chain with the first certificate
                                           // containing the corresponding EC public key.

            KeyStore keyStore = KeyStore.getInstance("AndroidKeyStore");
            keyStore.load(null);
            keyStore.setEntry(
                    "key2",
                    new KeyStore.PrivateKeyEntry(privateKey, certChain),
                    new KeyProtection.Builder(KeyProperties.PURPOSE_SIGN)
                            .setDigests(KeyProperties.DIGEST_SHA256, KeyProperties.DIGEST_SHA512)
                            .build());
            // Key pair imported, obtain a reference to it.
            PrivateKey keyStorePrivateKey = (PrivateKey) keyStore.getKey("key2", null);
            PublicKey publicKey = keyStore.getCertificate("key2").getPublicKey();
            // The original private key can now be discarded.

            Signature signature = Signature.getInstance("SHA256withECDSA");
            signature.initSign(keyStorePrivateKey);
            ...
            }

<h3>例: PKCS#1 padding</h3> を使用した署名/検証のための RSA キー ペア。この例では、SHA-256 ダイジェストを使用して PKCS#1 署名パディング スキームを使用して署名するためにのみ使用され、ユーザーが過去 10 分以内に認証された場合にのみ使用することが承認された秘密キーを使用して、エイリアス key2 の下で Android KeyStore に RSA キー ペアをインポートする方法を示します。 公開キーの使用は無制限です (既知の問題を参照)。 秘密キーと公開キーの両方で、それぞれキー マテリアルをエクスポートし、X.509形式をPKCS#8指定Key#getEncoded()する必要があります。

{@code
            PrivateKey privateKey = ...;   // RSA private key
            Certificate[] certChain = ...; // Certificate chain with the first certificate
                                           // containing the corresponding RSA public key.

            KeyStore keyStore = KeyStore.getInstance("AndroidKeyStore");
            keyStore.load(null);
            keyStore.setEntry(
                    "key2",
                    new KeyStore.PrivateKeyEntry(privateKey, certChain),
                    new KeyProtection.Builder(KeyProperties.PURPOSE_SIGN)
                            .setDigests(KeyProperties.DIGEST_SHA256)
                            .setSignaturePaddings(KeyProperties.SIGNATURE_PADDING_RSA_PKCS1)
                            // Only permit this key to be used if the user
                            // authenticated within the last ten minutes.
                            .setUserAuthenticationRequired(true)
                            .setUserAuthenticationValidityDurationSeconds(10 * 60)
                            .build());
            // Key pair imported, obtain a reference to it.
            PrivateKey keyStorePrivateKey = (PrivateKey) keyStore.getKey("key2", null);
            PublicKey publicKey = keyStore.getCertificate("key2").getPublicKey();
            // The original private key can now be discarded.

            Signature signature = Signature.getInstance("SHA256withRSA");
            signature.initSign(keyStorePrivateKey);
            ...
            }

<h3>例: PKCS#1 padding/h3> を使用した暗号化/暗号化解除のための RSA キー ペア。この例では、PKCS#1 暗号化パディング< スキームを使用した暗号化解除にのみ使用する秘密キーを使用して、エイリアスkey2の下で RSA キー ペアを Android KeyStore にインポートする方法を示します。 公開キーの使用は無制限であるため、埋め込みスキームとダイジェストを使用した暗号化が許可されます。 秘密キーと公開キーの両方で、それぞれキー マテリアルをエクスポートし、X.509形式をPKCS#8指定Key#getEncoded()する必要があります。

{@code
            PrivateKey privateKey = ...;   // RSA private key
            Certificate[] certChain = ...; // Certificate chain with the first certificate
                                           // containing the corresponding RSA public key.

            KeyStore keyStore = KeyStore.getInstance("AndroidKeyStore");
            keyStore.load(null);
            keyStore.setEntry(
                    "key2",
                    new KeyStore.PrivateKeyEntry(privateKey, certChain),
                    new KeyProtection.Builder(KeyProperties.PURPOSE_DECRYPT)
                            .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_RSA_PKCS1)
                            .build());
            // Key pair imported, obtain a reference to it.
            PrivateKey keyStorePrivateKey = (PrivateKey) keyStore.getKey("key2", null);
            PublicKey publicKey = keyStore.getCertificate("key2").getPublicKey();
            // The original private key can now be discarded.

            Cipher cipher = Cipher.getInstance("RSA/ECB/PKCS1Padding");
            cipher.init(Cipher.DECRYPT_MODE, keyStorePrivateKey);
            ...
            }

の Java ドキュメントandroid.security.keystore.KeyProtection

このページの一部は、Android オープンソース プロジェクトによって作成および共有され、クリエイティブ コモンズ 2.5 属性ライセンスに記載されている条件に従って使用される作業に基づく変更です。

プロパティ

メソッド

明示的なインターフェイスの実装

拡張メソッド

適用対象