模块 java.base

软件包 java.security

Interface Key

All Superinterfaces:

Serializable

All Known Subinterfaces:

DHPrivateKey ， DHPublicKey ， DSAPrivateKey ， DSAPublicKey ， ECPrivateKey ， ECPublicKey ， PBEKey ， PrivateKey ， PublicKey ， RSAMultiPrimePrivateCrtKey ， RSAPrivateCrtKey ， RSAPrivateKey ， RSAPublicKey ， SecretKey ， XECPrivateKey ， XECPublicKey

所有已知实现类：

EncryptionKey ， KerberosKey ， SecretKeySpec

public interface Keyextends Serializable

Key接口是所有键的顶级接口。 它定义了所有关键对象共享的功能。 所有按键都有三个特征：

• 算法

  这是该密钥的关键算法。 关键算法通常是加密或非对称操作算法（例如DSA或RSA），它将与那些算法和相关算法（例如带有RSA的MD5，带有RSA的SHA-1，原始DSA等）一起工作。使用getAlgorithm方法获得密钥算法。

• 编码表格

  这是在Java虚拟机外部需要密钥的标准表示时使用的密钥的外部编码形式，如将密钥传输给其他方时。 密钥根据标准格式（例如X.509 SubjectPublicKeyInfo或PKCS＃8）进行编码，并使用getEncoded方法返回。 注意：ASN.1类型SubjectPublicKeyInfo的语法定义如下：

    SubjectPublicKeyInfo ::= SEQUENCE {   algorithm AlgorithmIdentifier,   subjectPublicKey BIT STRING } AlgorithmIdentifier ::= SEQUENCE {   algorithm OBJECT IDENTIFIER,   parameters ANY DEFINED BY algorithm OPTIONAL } 

  有关更多信息，请参阅RFC 5280: Internet X.509 Public Key Infrastructure Certificate and CRL Profile 。
• 格式

  这是编码密钥格式的名称。 它由getFormat方法返回。

密钥通常通过密钥生成器，证书或用于管理密钥的各种Identity类获得。 也可以通过使用密钥工厂从关键规范（基础密钥材料的透明表示）获得密钥（参见KeyFactory ）。

密钥应使用KeyRep作为其序列化表示。 请注意，序列化密钥可能包含不应在不受信任的环境中公开的敏感信息。 有关更多信息，请参阅序列化规范的Security Appendix 。

从以下版本开始：

1.1

另请参见：

PublicKey ， PrivateKey ， KeyPair ， KeyPairGenerator ， KeyFactory ， KeyRep ， KeySpec ， Identity ， Signer

字段汇总

字段

变量和类型	字段	描述
static long	serialVersionUID	设置的类指纹，用于指示与该类的先前版本的序列化兼容性。

方法摘要

变量和类型	方法	描述
String	getAlgorithm()	返回此键的标准算法名称。
byte[]	getEncoded()	以主编码格式返回密钥，如果此密钥不支持编码，则返回null。
String	getFormat()	返回此键的主要编码格式的名称，如果此键不支持编码，则返回null。

字段详细信息

serialVersionUID

static final long serialVersionUID

设置的类指纹，用于指示与该类的先前版本的序列化兼容性。

另请参见：

常数字段值

方法详细信息

getAlgorithm

String getAlgorithm()

返回此键的标准算法名称。 例如，“DSA”表示此密钥是DSA密钥。 有关更多信息，请参见Java Security Standard Algorithm Names文档。

结果

与此键关联的算法的名称。

getFormat

String getFormat()

返回此键的主要编码格式的名称，如果此键不支持编码，则返回null。 如果存在此密钥的ASN.1规范，则主要编码格式根据适当的ASN.1数据格式命名。 例如，公钥的ASN.1数据格式的名称是SubjectPublicKeyInfo ，由X.509标准定义; 在这种情况下，返回的格式为"X.509" 。 类似地，私钥的ASN.1数据格式的名称是PrivateKeyInfo ，由PKCS＃8标准定义; 在这种情况下，返回的格式是"PKCS#8" 。

结果

密钥的主要编码格式。

getEncoded

byte[] getEncoded()

以主编码格式返回密钥，如果此密钥不支持编码，则返回null。

结果

编码密钥，如果密钥不支持编码，则返回null。