KeyStore 类

定义

[Android.Runtime.Register("java/security/KeyStore", DoNotGenerateAcw=true)]
public class KeyStore : Java.Lang.Object

[<Android.Runtime.Register("java/security/KeyStore", DoNotGenerateAcw=true)>]
type KeyStore = class
    inherit Object

继承

Object

Object

KeyStore

属性

RegisterAttribute

注解

此类表示加密密钥和证书的存储设施。

管理 KeyStore 不同类型的条目。 每种类型的条目实现 KeyStore.Entry 接口。 提供了三个基本 KeyStore.Entry 实现：

<ul><li><b>KeyStore.PrivateKeyEntry</b>

这种类型的条目保存加密，该加密 PrivateKey（可选）以受保护的格式存储，以防止未经授权的访问。 它还附带相应的公钥的证书链。

私钥和证书链由给定实体用于自我身份验证。 此身份验证的应用程序包括将 JAR 文件签名为发布和/或许可软件的一部分的软件分发组织。

<li><b>KeyStore.SecretKeyEntry</b>

这种类型的条目保存加密，该加密 SecretKey（可选）以受保护的格式存储，以防止未经授权的访问。

<li><b>KeyStore.TrustedCertificateEntry</b>

这种类型的条目包含属于另一方的单一公钥 Certificate 。 它被称为 受信任的证书 ，因为密钥存储所有者信任证书中的公钥确实属于证书 的使用者 （所有者）标识的标识。

这种类型的条目可用于对其他参与方进行身份验证。 </ul>

密钥存储中的每个条目都由“alias”字符串标识。 对于私钥及其关联的证书链，这些字符串区分实体可能自行进行身份验证的不同方式。 例如，实体可以使用不同的证书颁发机构或使用不同的公钥算法对自身进行身份验证。

别名是否区分大小写取决于实现。 为了避免问题，建议不要在 KeyStore 中使用别名，但大小写不同。

密钥存储是否为持久性，如果未在此处指定密钥存储使用的机制（如果密钥存储是永久性的）。 这允许使用各种技术来保护敏感（例如私有或机密）密钥。 智能卡或其他集成加密引擎（SafeKeyper）是一个选项，并且也可以使用更简单的机制（如文件）（采用各种格式）。

请求 KeyStore 对象的典型方法包括指定现有密钥存储文件、依赖于默认类型和提供特定密钥存储类型。

<ul><li>若要指定现有的密钥存储文件：

// get keystore password
               char[] password = getPassword();

               // probe the keystore file and load the keystore entries
               KeyStore ks = KeyStore.getInstance(new File("keyStoreName"), password);

系统将探测指定的文件以确定其密钥存储类型，并返回已加载其条目的密钥存储实现。 使用此方法时，无需调用密钥存储 #load(java.io.InputStream, char[]) load 的方法。

<li>要依赖默认类型：

KeyStore ks = KeyStore.getInstance(KeyStore.getDefaultType());

系统将返回默认类型的密钥存储实现。

<li>若要提供特定的密钥存储类型：

KeyStore ks = KeyStore.getInstance("JKS");

系统将返回环境中可用的指定密钥存储类型的最首选实现。 </ul>

必须先访问密钥存储，然后才能访问密钥 #load(java.io.InputStream, char[]) loaded存储。

KeyStore ks = KeyStore.getInstance(KeyStore.getDefaultType());

               // get user password and file input stream
               char[] password = getPassword();

               try (FileInputStream fis = new FileInputStream("keyStoreName")) {
                   ks.load(fis, password);
               }

若要使用上述load方法创建空密钥存储，请作为InputStream参数传递null。

加载密钥存储后，可以从密钥存储读取现有条目，或将新条目写入密钥存储：

KeyStore.ProtectionParameter protParam =
                   new KeyStore.PasswordProtection(password);

               // get my private key
               KeyStore.PrivateKeyEntry pkEntry = (KeyStore.PrivateKeyEntry)
                   ks.getEntry("privateKeyAlias", protParam);
               PrivateKey myPrivateKey = pkEntry.getPrivateKey();

               // save my secret key
               javax.crypto.SecretKey mySecretKey;
               KeyStore.SecretKeyEntry skEntry =
                   new KeyStore.SecretKeyEntry(mySecretKey);
               ks.setEntry("secretKeyAlias", skEntry, protParam);

               // store away the keystore
               try (FileOutputStream fos = new FileOutputStream("newKeyStoreName")) {
                   ks.store(fos, password);
               }

请注意，尽管可以使用相同的密码来加载密钥存储、保护私钥条目、保护密钥条目以及存储密钥存储（如上面的示例代码所示），也可以使用不同的密码或其他保护参数。

Android 提供以下KeyStore类型：<表<>thead<>tr<>th>Algorithm</th th Supported API Levels</><>th></tr></thead><tbody>><<td>AndroidCAStore/td td>14+/td>><</<<>>tr tr td>AndroidKeyStore<<></td 18+<</td><>/tr><tr class=“deprecated”><td>BCPKCS12</td<>td>1-8</td<>/tr<>><td>BKS</td<>td>1+</td></tr<>><td>BouncyCastle</td><td td>1+</<>td/<>><tr td>PKCS12</td><td td>1+</td></tr<>tr class=“deprecated”><td>PKCS12-DEF</td><td>1-8</td></tr></tbody></table>

Java加密体系结构标准算法名称文档的 KeyStore 部分介绍了这些类型。

已在 1.2 中添加。

Java文档java.security.KeyStore。

本页的某些部分是根据 创建和共享的工作进行的修改，并根据 许可证中所述的条款使用。