compact1, compact2, compact3

java.security

Class KeyStore

java.lang.Object

java.security.KeyStore

public class KeyStore
extends Object

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

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

• keystore.privatekeyentry

  这种类型的入口保存密码PrivateKey，这是可选的存储在受保护的格式，以防止未经授权的访问。它也伴随着相应的公共密钥的证书链。

  私有密钥和证书链被一个给定的实体用于自我认证。此身份验证的应用程序包括作为释放和/或授权软件的一部分签署的文件的软件分发组织。

• keystore.secretkeyentry

  这种类型的入口保存密码SecretKey，这是可选的存储在受保护的格式，以防止未经授权的访问。

• keystore.trustedcertificateentry

  这种类型的条目包含一个公钥Certificate属于另一方。它被称为可信证书因为密钥所有者信托证书中的公钥确实属于身份识别的主题（业主）的证书。

  这种类型的条目可以用来对其他方进行身份验证。

在密钥库中每个条目是确定一个“别名”字符串。在私钥和它们的关联的证书链的情况下，这些字符串区别于实体可以对其进行身份验证的不同方法中的区别。例如，实体可以使用不同的证书颁发机构进行身份验证，也可以使用不同的公钥算法来进行身份验证。

无论是别名是区分大小写的是依赖于实现的。为了避免这些问题，建议不要在密钥库，只有在不同情况下使用别名。

无论密钥是持久的，而机构使用的密钥库如果是持续的，不是在这里指定。这允许使用各种技术保护敏感的（例如，私人或秘密）密钥。智能卡或其他集成加密引擎（safekeyper）是一个选择，和简单的机制，如文件也可以使用（多种格式）。

典型的方式要求密钥库对象包括依赖于默认的类型和提供特定的密钥类型。

• 依靠默认类型：

  密钥Ks＝keystore。getInstance（密钥库。getdefaulttype()）；

  系统会返回一个默认的类型库的实现。
• 提供一个特定的密钥类型：

  密钥Ks＝keystore getInstance（“硕”）；

  系统将返回指定密钥类型环境中可用的最优选的实施。

在密钥库可以被访问，它必须loaded。

密钥Ks＝keystore。getInstance（密钥库。getdefaulttype()）；获取用户密码和文件输入流字符[ ]密码= getpassword()；尝试（FileInputStream FIS =新的输入（“keystorename”））{KS。负荷（FIS，密码）；}

使用上述 load方法创建一个空的密钥库，通过 null为 InputStream论点。

一旦密钥被加载，可以从密钥库中读取现有的条目，或写新的条目到密钥库：

KeyStore.ProtectionParameter protParam =新的密码保护密钥（密码）；/得到我的私人钥匙keystore.privatekeyentry pkentry =（密钥库。privatekeyentry）KS。getentry（“privatekeyalias”，ProtParam）；myprivatekey = pkentry getprivatekey()私钥；/保存我的秘密钥匙javax.crypto.secretkey mysecretkey；keystore.secretkeyentry skentry =新的密钥。secretkeyentry（mysecretkey）；KS。setentry（“secretkeyalias”，skentry，ProtParam）；/ /储存密钥库尝试（FileOutputStream FOS =新FileOutputStream（“newkeystorename”））{KS店（FOS、密码）；}

注意，虽然相同的密码可以用来加载密钥库，来保护私钥的进入，保护密钥输入，并存储密钥库（如图所示的示例代码段），不同的密码或其他保护参数也可以使用。

java平台的每种实现都要求支持以下标准KeyStore型：

• PKCS12

这类型的java加密体系标准算法的名字 KeyStore section描述文件。向您的实现咨询发布文档，以查看是否支持任何其他类型的实现。

从以下版本开始：

一点二

另请参见：

PrivateKey， SecretKey， Certificate

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyStore.Builder 描述一个对象被实例化的密钥库。
static class	KeyStore.CallbackHandlerProtection 一个protectionparameter封装callbackhandler。
static interface	KeyStore.Entry 一个 KeyStore输入类型标记接口。
static interface	KeyStore.LoadStoreParameter 一个标记接口， KeyStore load和 store参数。
static class	KeyStore.PasswordProtection 一种基于口令的 ProtectionParameter实施。
static class	KeyStore.PrivateKeyEntry 一个 KeyStore条目，持有 PrivateKey和相应的证书链。
static interface	KeyStore.ProtectionParameter 一个私钥保护参数标记接口。
static class	KeyStore.SecretKeyEntry 一个 KeyStore条目，持有 SecretKey。
static class	KeyStore.TrustedCertificateEntry 一个 KeyStore进入认为可信的 Certificate。

构造方法摘要

构造方法

Modifier	Constructor and Description
protected	KeyStore(KeyStoreSpi keyStoreSpi, Provider provider, String type) 创建一个密钥存储给定类型的对象，并封装了提供程序实现（SPI对象）在这。

方法摘要

Modifier and Type	Method and Description
Enumeration<String>	aliases() 列出所有这个密钥库的别名。
boolean	containsAlias(String alias) 检查给出的别名存在这个密钥库。
void	deleteEntry(String alias) 删除条目由给定的别名从密钥库确定。
boolean	entryInstanceOf(String alias, 类<? extends KeyStore.Entry> entryClass) 确定是否为指定的 alias keystore Entry是指定 entryClass实例或类。
Certificate	getCertificate(String alias) 返回与给定别名关联的证书。
String	getCertificateAlias(Certificate cert) 返回（化名）名称的第一个条目匹配给定的密钥证书证书。
Certificate[]	getCertificateChain(String alias) 返回与给定别名关联的证书链。
Date	getCreationDate(String alias) 返回给定别名标识的条目的创建日期。
static String	getDefaultType() 返回默认的密钥库类型的 keystore.type安全属性中指定，或字符串“硕”（“java库”的缩写）如果没有这种属性的存在。
KeyStore.Entry	getEntry(String alias, KeyStore.ProtectionParameter protParam) 获取指定别名与指定参数保护密钥库 Entry。
static KeyStore	getInstance(String type) 返回一个指定类型的对象库。
static KeyStore	getInstance(String type, Provider provider) 返回一个指定类型的对象库。
static KeyStore	getInstance(String type, String provider) 返回一个指定类型的对象库。
Key	getKey(String alias, char[] password) 返回与给定别名关联的密钥，使用给定的密码来恢复它。
Provider	getProvider() 返回此密钥库提供者。
String	getType() 返回此密钥库的类型。
boolean	isCertificateEntry(String alias) 返回true如果条目被给定的别名是由一个叫 setCertificateEntry创建，或通过调用创建一 TrustedCertificateEntry setEntry。
boolean	isKeyEntry(String alias) 返回true如果条目被给定的别名是由一个叫 setKeyEntry创建，或通过调用创建一 PrivateKeyEntry或 SecretKeyEntry setEntry。
void	load(InputStream stream, char[] password) 加载这个密钥库从给定的输入流。
void	load(KeyStore.LoadStoreParameter param) 加载这个密钥使用给定的 LoadStoreParameter。
void	setCertificateEntry(String alias, Certificate cert) 将给定的可信证书分配给给定的别名。
void	setEntry(String alias, KeyStore.Entry entry, KeyStore.ProtectionParameter protParam) 节省下的密钥库 Entry指定别名。
void	setKeyEntry(String alias, byte[] key, Certificate[] chain) 指定给定的键（已被保护）给给定的别名。
void	setKeyEntry(String alias, Key key, char[] password, Certificate[] chain) 将给定的密钥分配给给定的别名，用给定的密码保护它。
int	size() 这个密钥库检索条目数量。
void	store(KeyStore.LoadStoreParameter param) 商店这个密钥使用给定的 LoadStoreParameter。
void	store(OutputStream stream, char[] password) 商店这个密钥库到给定的输出流，其完整性与给定的密码保护。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyStore

protected KeyStore(KeyStoreSpi keyStoreSpi,
                   Provider provider,
                   String type)

创建一个密钥存储给定类型的对象，并封装了提供程序实现（SPI对象）在这。

参数

keyStoreSpi -提供程序实现。

provider -供应商。

type -密钥类型。

方法详细信息

getInstance

public static KeyStore getInstance(String type)
                            throws KeyStoreException

返回一个指定类型的对象库。

该方法通过注册安全提供商列表，从最开始的首选供应商。一个新的密钥库对象封装keystorespi实施支持指定类型的第一个提供程序返回。

注意，注册商的列表可以通过Security.getProviders()检索方法。

参数

type -密钥库的类型。看到关于标准库类型信息在 Java Cryptography Architecture Standard Algorithm Name Documentation密钥库段。

结果

一个指定类型的对象库。

异常

KeyStoreException -如果没有供应商的支持为指定的类型keystorespi实施。

另请参见：

Provider

getInstance

public static KeyStore getInstance(String type,
                                   String provider)
                            throws KeyStoreException,
                                   NoSuchProviderException

返回一个指定类型的对象库。

一个新的密钥库对象封装keystorespi实现从指定的提供程序返回。指定的提供程序必须在安全提供程序列表中注册。

注意，注册商的列表可以通过Security.getProviders()检索方法。

参数

type -密钥库的类型。看到关于标准库类型信息在 Java Cryptography Architecture Standard Algorithm Name Documentation密钥库段。

provider -提供者的名称。

结果

一个指定类型的对象库。

异常

KeyStoreException -如果一个指定类型的keystorespi执行不可从指定的供应商。

NoSuchProviderException -如果指定的供应商不在安全提供商注册名单。

IllegalArgumentException如果提供者名称为空或空。

另请参见：

Provider

getInstance

public static KeyStore getInstance(String type,
                                   Provider provider)
                            throws KeyStoreException

返回一个指定类型的对象库。

一个新的密钥库对象封装keystorespi实现从指定的提供程序对象返回。请注意，指定的提供程序对象不必在提供者列表中注册。

参数

type -密钥库的类型。看到关于标准库类型信息在 Java Cryptography Architecture Standard Algorithm Name Documentation密钥库段。

provider -供应商。

结果

一个指定类型的对象库。

异常

KeyStoreException -如果指定类型的keystorespi执行不可从指定的提供程序对象。

IllegalArgumentException -如果指定的提供程序是无效的。

从以下版本开始：

一点四

另请参见：

Provider

getDefaultType

public static final String getDefaultType()

返回默认的密钥库类型的 keystore.type安全属性中指定，或字符串“硕”（“java库”的缩写）如果没有这种属性的存在。

默认的密钥类型可以用，不想用一个硬编码的密钥类型时调用的方法之一getInstance应用使用，并要提供一个默认的密钥库类型在用户不指定自己的。

默认的密钥类型，可以通过设置的keystore.type安全属性的值所需的密钥类型的改变。

结果

默认的密钥类型的 keystore.type安全属性中指定，或字符串“硕”如果没有这种属性的存在。

另请参见：

security properties

getProvider

public final Provider getProvider()

返回此密钥库提供者。

结果

这个密钥库提供者。

getType

public final String getType()

返回此密钥库的类型。

结果

这个密钥库的类型。

getKey

public final Key getKey(String alias,
                        char[] password)
                 throws KeyStoreException,
                        NoSuchAlgorithmException,
                        UnrecoverableKeyException

返回与给定别名关联的密钥，使用给定的密码来恢复它。关键要一直用电话 setKeyEntry别名关联，或通过调用一个 PrivateKeyEntry或 SecretKeyEntry setEntry。

参数

alias -别名

password -恢复密钥的密码

结果

所请求的键，或如果给定的别名不存在或不确定密钥相关的条目，或为空。

异常

KeyStoreException如果keystore尚未初始化（加载）。

NoSuchAlgorithmException如果恢复键不能发现算法

UnrecoverableKeyException -如果钥匙无法恢复（例如，给定的密码是错误的）。

getCertificateChain

public final Certificate[] getCertificateChain(String alias)
                                        throws KeyStoreException

返回与给定别名关联的证书链。证书链必须已经通过调用 setKeyEntry别名关联，或通过调用一个 PrivateKeyEntry setEntry。

参数

alias -别名

结果

证书链（如果给定的别名不存在或不包含证书链，由用户的证书的第一次由零或更多证书颁发机构）订购

异常

KeyStoreException如果keystore尚未初始化（加载）。

getCertificate

public final Certificate getCertificate(String alias)
                                 throws KeyStoreException

返回与给定别名关联的证书。

如果给定的别名标识被调用的setCertificateEntry创建了一个条目，或通过调用创建setEntry与TrustedCertificateEntry，那么可信证书包含在输入返回。

如果给定的别名标识被调用的setKeyEntry创建了一个条目，或通过调用创建一PrivateKeyEntry setEntry，然后返回，进入证书链的第一个元素。

参数

alias -别名

结果

该证书，或无效，如果给定的别名不存在或不包含证书。

异常

KeyStoreException如果keystore尚未初始化（加载）。

getCreationDate

public final Date getCreationDate(String alias)
                           throws KeyStoreException

返回给定别名标识的条目的创建日期。

参数

alias -别名

结果

此条目的创建日期，如果给定的别名不存在，或为空

异常

KeyStoreException如果keystore尚未初始化（加载）。

setKeyEntry

public final void setKeyEntry(String alias,
                              Key key,
                              char[] password,
                              Certificate[] chain)
                       throws KeyStoreException

将给定的密钥分配给给定的别名，用给定的密码保护它。

如果给定的键的类型是java.security.PrivateKey，它必须伴随着相应的公共密钥证书链认证。

如果给定的别名已经存在，与它相关的密钥信息是由给定的键重写（可能是证书链）。

参数

alias -别名

key -与别名关联的关键

password -保护密钥的密码

chain -相应的公钥证书链（如果给定的关键是型 java.security.PrivateKey只需要）。

异常

KeyStoreException如果keystore尚未初始化（加载），给定的键不能保护，或操作失败的其他原因

setKeyEntry

public final void setKeyEntry(String alias,
                              byte[] key,
                              Certificate[] chain)
                       throws KeyStoreException

指定给定的键（已被保护）给给定的别名。

如果受保护的关键是java.security.PrivateKey型，它必须伴随着相应的公共密钥证书链认证。如果底层的库实现的类型是jks，key必须被编码为一个EncryptedPrivateKeyInfo在PKCS 8标准定义的#。

如果给定的别名已经存在，与它相关的密钥信息是由给定的键重写（可能是证书链）。

参数

alias -别名

key的关键（在保护格式）是与别名关联

chain -相应的公钥证书链（唯一有用的如果受保护的关键是型 java.security.PrivateKey）。

异常

KeyStoreException如果keystore尚未初始化（加载），或如果操作其他原因失败。

setCertificateEntry

public final void setCertificateEntry(String alias,
                                      Certificate cert)
                               throws KeyStoreException

将给定的可信证书分配给给定的别名。

如果给定的别名识别现有项目通过调用setCertificateEntry创建，或通过调用创建一TrustedCertificateEntry setEntry，可信证书在现有的条目是由给定的证书中重写。

参数

alias -别名

cert -证书

异常

KeyStoreException如果keystore尚未初始化，或给定的别名已经存在不确定项包含一个可信的证书，或操作失败的其他原因。

deleteEntry

public final void deleteEntry(String alias)
                       throws KeyStoreException

删除条目由给定的别名从密钥库确定。

参数

alias -别名

异常

KeyStoreException如果keystore尚未初始化，如果项目不能删除。

aliases

public final Enumeration<String> aliases()
                                  throws KeyStoreException

列出所有这个密钥库的别名。

结果

别名的枚举

异常

KeyStoreException如果keystore尚未初始化（加载）。

containsAlias

public final boolean containsAlias(String alias)
                            throws KeyStoreException

检查给出的别名存在这个密钥库。

参数

alias -别名

结果

如果别名存在，否则为假

异常

KeyStoreException如果keystore尚未初始化（加载）。

size

public final int size()
               throws KeyStoreException

这个密钥库检索条目数量。

结果

这个密钥库条目数量

异常

KeyStoreException如果keystore尚未初始化（加载）。

isKeyEntry

public final boolean isKeyEntry(String alias)
                         throws KeyStoreException

返回true如果条目被给定的别名是由一个叫 setKeyEntry创建，或通过调用创建一 PrivateKeyEntry或 SecretKeyEntry setEntry。

参数

alias -密钥库进入被检查的别名

结果

如果给定的别名所标识的条目是一个关键相关条目，则为。

异常

KeyStoreException如果keystore尚未初始化（加载）。

isCertificateEntry

public final boolean isCertificateEntry(String alias)
                                 throws KeyStoreException

返回true如果条目被给定的别名是由一个叫 setCertificateEntry创建，或通过调用创建一个 TrustedCertificateEntry setEntry。

参数

alias -密钥库进入被检查的别名

结果

如果给定的别名所标识的条目包含一个可信证书，则为。

异常

KeyStoreException如果keystore尚未初始化（加载）。

getCertificateAlias

public final String getCertificateAlias(Certificate cert)
                                 throws KeyStoreException

返回（化名）名称的第一个条目匹配给定的密钥证书证书。

匹配给定的每个密钥入境证此方法的尝试。如果条目被认为是由一个叫setCertificateEntry创建，或通过调用创建一个TrustedCertificateEntry setEntry，然后给定的证书相比，入门的证书。

如果条目被认为是由一个叫setKeyEntry创建，或通过调用创建一个PrivateKeyEntry setEntry，然后给定的证书相比，入门的证书链的第一个元素。

参数

cert -证书匹配。

结果

与匹配的第一项的别名，或空如果没有这样的条目存在这个密钥库。

异常

KeyStoreException如果keystore尚未初始化（加载）。

store

public final void store(OutputStream stream,
                        char[] password)
                 throws KeyStoreException,
                        IOException,
                        NoSuchAlgorithmException,
                        CertificateException

商店这个密钥库到给定的输出流，其完整性与给定的密码保护。

参数

stream -输出流，这个密钥写入。

password -生成密钥完整性检查密码

异常

KeyStoreException如果keystore尚未初始化（加载）。

IOException -如果有一个I/O问题的数据

NoSuchAlgorithmException如果适当的数据完整性算法无法发现

CertificateException -如果证书包含在密钥库的数据无法保存

store

public final void store(KeyStore.LoadStoreParameter param)
                 throws KeyStoreException,
                        IOException,
                        NoSuchAlgorithmException,
                        CertificateException

商店这个密钥使用给定的 LoadStoreParameter。

参数

param - LoadStoreParameter指定如何存储密钥库，这可能是 null

异常

IllegalArgumentException -如果给定的 LoadStoreParameter输入不认可

KeyStoreException如果keystore尚未初始化（加载）

IOException -如果有一个I/O问题的数据

NoSuchAlgorithmException如果适当的数据完整性算法无法发现

CertificateException -如果证书包含在密钥库的数据无法保存

从以下版本开始：

一点五

load

public final void load(InputStream stream,
                       char[] password)
                throws IOException,
                       NoSuchAlgorithmException,
                       CertificateException

加载这个密钥库从给定的输入流。

密码可以解锁密钥库（如密钥库驻留在硬件令牌设备），或检查密钥库数据的完整性。如果没有给出完整性检查的密码，则不执行完整性检查。

为了创建一个空的密钥，如果密钥无法初始化流，通过null为stream论点。

注意，如果该密钥已经被加载，它是重新初始化并重新加载，从给定的输入流。

参数

stream -从密钥库中加载输入流，或 null

password用于检查密钥库完整的密码，该密码用于解锁密钥库，或 null

异常

IOException -如果有一个I / O或密钥库的数据格式的问题，如果需要密码但没有给出，如果给定的密码是不正确的。如果错误是由于一个错误的密码，该 IOException的 cause应该是一个 UnrecoverableKeyException

NoSuchAlgorithmException如果用来检查密钥不能完整的被发现的算法

CertificateException -如果在密钥的证书无法加载

load

public final void load(KeyStore.LoadStoreParameter param)
                throws IOException,
                       NoSuchAlgorithmException,
                       CertificateException

加载这个密钥使用给定的 LoadStoreParameter。

注意，如果KeyStore已经被加载，它是重新初始化并重新加载，从给定的参数。

参数

param - LoadStoreParameter指定如何加载密钥库，这可能是 null

异常

IllegalArgumentException -如果给定的 LoadStoreParameter输入不认可

IOException -如果有一个I / O或密钥库的数据格式问题。如果错误是由于不正确的 ProtectionParameter（如密码错误）的 IOException的 cause应该是一个 UnrecoverableKeyException

NoSuchAlgorithmException如果用来检查密钥不能完整的被发现的算法

CertificateException -如果在密钥的证书无法加载

从以下版本开始：

一点五

getEntry

public final KeyStore.Entry getEntry(String alias,
                                     KeyStore.ProtectionParameter protParam)
                              throws NoSuchAlgorithmException,
                                     UnrecoverableEntryException,
                                     KeyStoreException

获取指定别名与指定参数保护密钥库 Entry。

参数

alias获取密钥库 Entry此别名

protParam -用于保护 Entry的 ProtectionParameter，可 null

结果

为指定的别名 Entry密钥，或 null如果没有这样的入口

异常

如果是 null alias NullPointerException

NoSuchAlgorithmException如果回收项目不能发现算法

UnrecoverableEntryException -如果指定 protParam不足或无效

UnrecoverableKeyException如果条目是一个 PrivateKeyEntry或 SecretKeyEntry和指定的 protParam不包含恢复所需的关键信息（如密码错误）

KeyStoreException如果keystore尚未初始化（加载）。

从以下版本开始：

一点五

另请参见：

setEntry(String, KeyStore.Entry, KeyStore.ProtectionParameter)

setEntry

public final void setEntry(String alias,
                           KeyStore.Entry entry,
                           KeyStore.ProtectionParameter protParam)
                    throws KeyStoreException

节省下的密钥库 Entry指定别名。保护参数是用来保护 Entry。

如果指定的别名的条目已经存在，它是重写。

参数

alias保存密钥库 Entry下这个别名

entry - Entry拯救

protParam -用于保护 Entry的 ProtectionParameter，可 null

异常

NullPointerException -如果 alias或 entry是 null

KeyStoreException如果keystore尚未初始化（加载），或如果操作其他原因失败

从以下版本开始：

一点五

另请参见：

getEntry(String, KeyStore.ProtectionParameter)

entryInstanceOf

public final boolean entryInstanceOf(String alias,
                                     类<? extends KeyStore.Entry> entryClass)
                              throws KeyStoreException

确定是否为指定的 alias keystore Entry是指定 entryClass实例或类。

参数

alias -别名

entryClass -入门级

结果

如果指定的 alias keystore Entry是指定 entryClass实例或类真，否则为假

异常

NullPointerException -如果 alias或 entryClass是 null

KeyStoreException如果keystore尚未初始化（加载）

从以下版本开始：

一点五