クラスKeyStore

java.lang.Object

java.security.KeyStore

public class KeyStore extends Object

このクラスは、暗号化のキーと証明書の� �納� �所を表現したものです。

KeyStoreは異なるタイプのエントリを管理します。 個々のエントリ・タイプはKeyStore.Entryインタフェースを実装します。 次の3つの基本KeyStore.Entry実装が提供されています。

• KeyStore.PrivateKeyEntry

  このタイプのエントリには暗号化PrivateKeyが� �納されます。許可されないアクセスを防ぐために保護形式で� �納できるようになっています。 また、対応する公開キーの証明書チェーンもいっしょに� �納されます。

  秘密キーおよび証明書チェーンは、自動認証のための指定されたエンティティによって使用されます。 この認証が利用されるのは、ソフトウェア配布組織がソフトウェアのリリースやライセンス供与の一貫としてJARファイルに署名する� �合などです。

• KeyStore.SecretKeyEntry

  このタイプのエントリには暗号化SecretKeyが� �納されます。許可されないアクセスを防ぐために保護形式で� �納できるようになっています。

• KeyStore.TrustedCertificateEntry

  このタイプのエントリには別の組織に属する単一の公開キーCertificateが� �納されます。 これは信� �できる証明書と呼ばれますが、それは、キーストアの所有者が、証明書内の公開キーが実際に証明書のサブジェクト (所有者)によって識別されたアイデンティティに属することを信� �するためです。

  このタイプのエントリは、他の相手を認証するのに使用できます。

キーストア内の各エントリは、「別名」文字列によって識別されます。 秘密キーとそれに関連付けられた証明書チェーンの� �合は、これらの文字列はエンティティ自体が認証するというように、方法別に区別されます。 たとえば、エンティティが異なる証明書発行局を使ったり、異なる公開キー・アルゴリズ� を使ったりして、エンティティ自体を認証することも可能です。

別名で大文字と小文字が区別されるかどうかは、実装に依存します。 問題の発生を防ぐため、KeyStore内では、大文字と小文字の区別が異なる� けの別名を使用しないようにしてく� さい。

キーストアが持続性があるかどうか、および持続性がある� �合に使われるメカニズ� は、ここでは指定されません。 これにより、重要な(秘密または非公開)キーを保護するためのさまざまな技術を使うことができます。 スマート・カードまたはその他の統合暗号化エンジン(SafeKeyper)を使うことも1つの方法です。また、ファイルなどのより単純なメカニズ� を様々な形式で使うこともできます。

KeyStoreオブジェクトをリクエストする一般的な方法は、既存のキーストア・ファイルの指定、デフォルト・タイプに依存し、特定のキーストア・タイプの指定です。

• 既存のキーストア・ファイルを指定するには:

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

  システ� は、指定されたファイルを検証して、そのキーストア・タイプを確認し、エントリがすでにロードされているキーストア実装を返します。 この方法を使用する� �合、キーストアのloadメソッドをコールする必要はありません。
• デフォルトのタイプを利用するには:

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

  システ� は、デフォルト・タイプのキーストア実装を返します。
• 特定のキーストア・タイプを指定するには:

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

  システ� は、環境内で利用可能な実装のうち、指定されたキーストア・タイプにもっとも適したものを返します。

キーストアにアクセスするには、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.PasswordProtection protParam =
        new KeyStore.PasswordProtection(password);
    try (FileOutputStream fos = new FileOutputStream("newKeyStoreName")) {
        // 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
        ks.store(fos, password);
    } finally {
        protParam.destroy();
    }
 

なお、上記サンプル・コードで示したように、キーストアのロード、非公開キーエントリの保護、秘密キーエントリの保護、およびキーストアの� �納には同じパスワードを使用できますが、異なるパスワードやその他の保護パラメータも使用できます。

Javaプラットフォー� の実装は、すべて次の標準のKeyStoreタイプをサポートする必要があります。

• PKCS12

このタイプについては、Javaセキュリティ標準アルゴリズ� 名仕様の「KeyStoreセクション」を参照してく� さい。 サポートされているその他のタイプについては、実装のリリース・ノートを参照してく� さい。

導入されたバージョン:

1.2

関連� �目:

• PrivateKey
• SecretKey
• Certificate

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	クラス	説明
static class	KeyStore.Builder	インスタンス化予定のKeyStoreオブジェクトの説明。
static class	KeyStore.CallbackHandlerProtection	CallbackHandlerをカプセル化するProtectionParameter。
static interface	KeyStore.Entry	KeyStoreエントリの種類に対するマーカー・インタフェースです。
static interface	KeyStore.LoadStoreParameter	KeyStoreのloadパラメータとstoreパラメータに対するマーカー・インタフェースです。
static class	KeyStore.PasswordProtection	ProtectionParameterのパスワードベースの実装です。
static final class	KeyStore.PrivateKeyEntry	特定のPrivateKeyと対応する証明書チェーンが� �納されたKeyStoreエントリです。
static interface	KeyStore.ProtectionParameter	キーストアの保護パラメータに対するマーカー・インタフェースです。
static final class	KeyStore.SecretKeyEntry	特定のSecretKeyが� �納されたKeyStoreエントリです。
static final class	KeyStore.TrustedCertificateEntry	信� �できるCertificateが� �納されたKeyStoreエントリです。

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタ	説明
protected	KeyStore(KeyStoreSpi keyStoreSpi, Provider provider, String type)	指定されたタイプのKeyStoreオブジェクトを作成し、指定されたプロバイダ実装(SPIオブジェクト)をカプセル化します。

メソッドのサマリー

修飾子と型	メソッド	説明
final Enumeration<String>	aliases()	このキーストアのすべての別名を一覧表示します。
final boolean	containsAlias(String alias)	このキーストアに、指定された別名が存在するかどうかを判定します。
final void	deleteEntry(String alias)	このキーストアから、指定された別名によって識別されるエントリを削除します。
final boolean	entryInstanceOf(String alias, Class<? extends KeyStore.Entry> entryClass)	指定されたaliasのキーストアEntryが、指定されたentryClassのインスタンスまたはサブクラスであるかどうかを判定します。
final Set<KeyStore.Entry.Attribute>	getAttributes(String alias)	指定された別名に関連付けられた属性を取得します。
final Certificate	getCertificate(String alias)	指定された別名に関連した証明書を返します。
final String	getCertificateAlias(Certificate cert)	指定された証明書と一致する証明書がある最初のキーストア・エントリの別名を返します。
final Certificate[]	getCertificateChain(String alias)	指定された別名に関連付けられている証明書チェーンを返します。
final Date	getCreationDate(String alias)	指定された別名によって識別されるエントリの作成日を返します。
static final String	getDefaultType()	keystore.typeセキュリティ・プロパティで指定されたデフォルトのキーストア・タイプ、またはそのようなプロパティが存在しない� �合は文字列"pkcs12"を返します。
final KeyStore.Entry	getEntry(String alias, KeyStore.ProtectionParameter protParam)	指定された保護パラメータを使用して、指定された別名に対するキーストアEntryを取得します。
static final KeyStore	getInstance(File file, char[] password)	適切なキーストア・タイプのロードされたキーストア・オブジェクトを返します。
static final KeyStore	getInstance(File file, KeyStore.LoadStoreParameter param)	適切なキーストア・タイプのロードされたキーストア・オブジェクトを返します。
static KeyStore	getInstance(String type)	指定されたタイプのKeyStoreオブジェクトを返します。
static KeyStore	getInstance(String type, String provider)	指定されたタイプのKeyStoreオブジェクトを返します。
static KeyStore	getInstance(String type, Provider provider)	指定されたタイプのKeyStoreオブジェクトを返します。
final Key	getKey(String alias, char[] password)	指定されたパスワードを使って、指定された別名に関連したキーを復元し、そのキーを返します。
final Provider	getProvider()	このキーストアのプロバイダを返します。
final String	getType()	このキーストア・タイプを返します。
final boolean	isCertificateEntry(String alias)	指定された別名で識別されるエントリがsetCertificateEntryへのコールによって作成されたか、TrustedCertificateEntryを使用してsetEntryへのコールによって作成された� �合は、trueを返します。
final boolean	isKeyEntry(String alias)	指定された別名で識別されるエントリがsetKeyEntryへのコールによって作成されたか、PrivateKeyEntryまたはSecretKeyEntryを使用してsetEntryへのコールによって作成された� �合は、trueを返します。
final void	load(InputStream stream, char[] password)	指定された入力ストリー� からこのキーストアをロードします。
final void	load(KeyStore.LoadStoreParameter param)	指定されたLoadStoreParameterを使用してこのキーストアをロードします。
final void	setCertificateEntry(String alias, Certificate cert)	指定された別名に、指定された信� �できる証明書を割り当てます。
final void	setEntry(String alias, KeyStore.Entry entry, KeyStore.ProtectionParameter protParam)	キーストアEntryを指定された別名で保存します。
final void	setKeyEntry(String alias, byte[] key, Certificate[] chain)	指定された別名に、すでに保護されている指定のキーを割り当てます。
final void	setKeyEntry(String alias, Key key, char[] password, Certificate[] chain)	指定された別名に指定されたキーを割り当て、指定されたパスワードでそのキーを保護します。
final int	size()	このキーストアのエントリ数を取得します。
final void	store(OutputStream stream, char[] password)	指定された出力ストリー� にこのキーストアを� �納し、指定されたパスワードでその整合性を保護します。
final void	store(KeyStore.LoadStoreParameter param)	指定されたLoadStoreParameterを使用してこのキーストアを� �納します。

クラスjava.lang.Objectで宣言されたメソッド

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

コンストラクタの詳細

KeyStore

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

指定されたタイプのKeyStoreオブジェクトを作成し、指定されたプロバイダ実装(SPIオブジェクト)をカプセル化します。

パラメータ:

keyStoreSpi - プロバイダの実装。

provider - プロバイダ

type - キーストア・タイプ。

メソッドの詳細

getInstance

public static KeyStore getInstance(String type) throws KeyStoreException

指定されたタイプのKeyStoreオブジェクトを返します。

このメソッドは、最も優先されるプロバイダから始まる登録済セキュリティ・プロバイダのリストを横断します。 指定されたタイプをサポートする最初のプロバイダからKeyStoreSpi実装をカプセル化する新しいKeyStoreオブジェクトが返されます。

登録済みプロバイダのリストは、Security.getProviders()メソッド経由で取得できます。

実装上のノート:

JDKリファレンス実装では、さらにjdk.security.provider.preferred Securityプロパティを使用して、指定したアルゴリズ� の優先プロバイダ� �序を決定します。 これは、Security.getProviders()によって返されるプロバイダの� �序とは異なる� �合があります。

パラメータ:

type - キーストアのタイプ。 標準キーストア・タイプの詳細は、「Javaセキュリティ標準アルゴリズ� 名仕様」のKeyStoreの� �を参照してく� さい。

戻り値:

指定されたタイプのキーストア・オブジェクト

スロー:

KeyStoreException - 指定したタイプのKeyStoreSpi実装をサポートするプロバイダがない� �合

NullPointerException - typeがnullである� �合

関連� �目:

• Provider

getInstance

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

指定されたタイプのKeyStoreオブジェクトを返します。

指定したプロバイダからKeyStoreSpi実装をカプセル化する新しいKeyStoreオブジェクトが返されます。 指定したプロバイダは、セキュリティ・プロバイダ・リストに登録する必要があります。

登録済みプロバイダのリストは、Security.getProviders()メソッド経由で取得できます。

パラメータ:

type - キーストアのタイプ。 標準キーストア・タイプの詳細は、「Javaセキュリティ標準アルゴリズ� 名仕様」のKeyStoreの� �を参照してく� さい。

provider - プロバイダ名。

戻り値:

指定されたタイプのキーストア・オブジェクト

スロー:

IllegalArgumentException - プロバイダ名がnullまたは空の� �合

KeyStoreException - 指定された型のKeyStoreSpi実装が、指定されたプロバイダから利用可能でない� �合

NoSuchProviderException - 指定されたプロバイダがセキュリティ・プロバイダ・リストに登録されていない� �合

NullPointerException - typeがnullである� �合

関連� �目:

• Provider

getInstance

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

指定されたタイプのKeyStoreオブジェクトを返します。

指定されたプロバイダ・オブジェクトからKeyStoreSpi実装をカプセル化する新しいKeyStoreオブジェクトが返されます。 指定したプロバイダ・オブジェクトは、プロバイダ・リストに登録する必要はありません。

パラメータ:

type - キーストアのタイプ。 標準キーストア・タイプの詳細は、「Javaセキュリティ標準アルゴリズ� 名仕様」のKeyStoreの� �を参照してく� さい。

provider - プロバイダ

戻り値:

指定されたタイプのキーストア・オブジェクト

スロー:

IllegalArgumentException - 指定されたプロバイダがnullの� �合

KeyStoreException - 指定された型のKeyStoreSpi実装が、指定されたProviderオブジェクトから使用できない� �合

NullPointerException - typeがnullである� �合

導入されたバージョン:

1.4

関連� �目:

• Provider

getDefaultType

public static final String getDefaultType()

keystore.typeセキュリティ・プロパティで指定されたデフォルトのキーストア・タイプ、またはそのようなプロパティが存在しない� �合は文字列"pkcs12"を返します。

デフォルトのキーストア・タイプを使用するのは、アプリケーションでgetInstanceメソッドを呼び出すときに、ハードコードされたキーストア・タイプを使用しない� �合、およびユーザーが独自のキーストア・タイプを指定しないときに、デフォルトのキーストア・タイプを提供する� �合です。

デフォルトのキーストア・タイプは、keystore.typeセキュリティ・プロパティの値を目的のキーストア・タイプに設定することで変更できます。

戻り値:

keystore.typeセキュリティ・プロパティで指定されたデフォルトのキーストア・タイプ、またはそのようなプロパティが存在しない� �合は文字列"pkcs12"。

関連� �目:

• セキュリティ・プロパティ

getProvider

public final Provider getProvider()

このキーストアのプロバイダを返します。

戻り値:

このキーストアのプロバイダ。

getType

public final String getType()

このキーストア・タイプを返します。

戻り値:

このキーストア・タイプ。

getAttributes

public final Set<KeyStore.Entry.Attribute> getAttributes(String alias) throws KeyStoreException

指定された別名に関連付けられた属性を取得します。

パラメータ:

alias - 別名

戻り値:

変更できない属性のSet。 このセットは、KeyStoreSpi実装がKeyStoreSpi.engineGetAttributes(String)をオーバーライドしていない� �合、または指定された別名が存在しない� �合、または別名に関連付けられた属性がない� �合、空になります。 このセットは、保護された属性を含むPrivateKeyEntryまたはSecretKeyEntryエントリに対しても空であり、エントリが抽出された後にKeyStore.Entry.getAttributes()メソッドを介してのみ使用できます。

スロー:

KeyStoreException - キーストアが初期化(ロード)されていない� �合。

NullPointerException - aliasがnullである� �合

導入されたバージョン:

18

getKey

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

指定されたパスワードを使って、指定された別名に関連したキーを復元し、そのキーを返します。 このキーは、setKeyEntryを呼び出すか、あるいはPrivateKeyEntryまたはSecretKeyEntryを指定してsetEntryを呼び出すことでその別名に関連付けられている必要があります。

パラメータ:

alias - 別名

password - キーを復元するためのパスワード

戻り値:

リクエストされたキー、または指定された別名が存在しないかキー関連のエントリを識別しない� �合はnull。

スロー:

KeyStoreException - キーストアが初期化(ロード)されていない� �合。

NoSuchAlgorithmException - キーを復元するためのアルゴリズ� が見つからない� �合。

UnrecoverableKeyException - 指定されたパスワードが間違っている� �合など、キーを復元できない� �合。

getCertificateChain

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

指定された別名に関連付けられている証明書チェーンを返します。 この証明書チェーンは、setKeyEntryを呼び出すか、あるいはPrivateKeyEntryを指定してsetEntryを呼び出すことで別名に関連付けられている必要があります。

パラメータ:

alias - 別名

戻り値:

証明書チェーン(ユーザーの証明書が最初に� �序付けられ、その後にゼロ以上の認証局が続きます)、または指定した別名が存在しないか、証明書チェーンが含まれていない� �合はnull

スロー:

KeyStoreException - キーストアが初期化(ロード)されていない� �合。

getCertificate

public final Certificate getCertificate(String alias) throws KeyStoreException

指定された別名に関連した証明書を返します。

指定された別名によって識別されるエントリが、setCertificateEntryを呼び出して作成されたエントリ、あるいはTrustedCertificateEntryを指定してsetEntryを呼び出して作成されたエントリのいずれかである� �合、そのエントリ内に� �納されている信� �できる証明書が返されます。

指定された別名によって識別されるエントリが、setKeyEntryを呼び出して作成されたエントリ、あるいはPrivateKeyEntryを指定してsetEntryを呼び出して作成されたエントリのいずれかである� �合、そのエントリ内の証明書チェーンの最初の要� が返されます。

パラメータ:

alias - 別名

戻り値:

証明書、または指定された別名が存在しないか、証明書が含まれていない� �合はnull。

スロー:

KeyStoreException - キーストアが初期化(ロード)されていない� �合。

getCreationDate

public final Date getCreationDate(String alias) throws KeyStoreException

指定された別名によって識別されるエントリの作成日を返します。

パラメータ:

alias - 別名

戻り値:

このエントリの作成日、または指定された別名が存在しない� �合はnull

スロー:

KeyStoreException - キーストアが初期化(ロード)されていない� �合。

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 - キーストアが初期化(ロード)されていない� �合、指定されたキーを保護できない� �合、またはこの処理がなんらかの原� で失敗した� �合

setKeyEntry

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

指定された別名に、すでに保護されている指定のキーを割り当てます。

保護されたキーがjava.security.PrivateKeyタイプである� �合、そのキーには対応する公開キーを証明する証明書チェーンが含まれていなければいけません。 基本となるキーストアの実装のタイプがjksの� �合、keyはPKCS#8標準の定義に従ってEncryptedPrivateKeyInfoとして符号化されている必要があります。

指定された別名がすでに存在する� �合は、それに関連したキーストア情� �は、指定されたキーと証明書チェーンによってオーバーライドされます。

パラメータ:

alias - 別名

key - 別名に関連した保護形式のキー

chain - 保護されたキーがjava.security.PrivateKeyタイプである� �合に� け有効な、対応する公開キーの証明書チェーン。

スロー:

KeyStoreException - キーストアが初期化(ロード)されていない� �合、またはこの処理がなんらかの原� で失敗した� �合。

setCertificateEntry

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

指定された別名に、指定された信� �できる証明書を割り当てます。

指定された別名によって識別されるエントリが、setCertificateEntryを呼び出して作成された既存エントリ、あるいはTrustedCertificateEntryを指定してsetEntryを呼び出して作成された既存エントリのいずれかである� �合、その既存エントリ内に� �納されている信� �できる証明書が、指定された証明書でオーバーライドされます。

パラメータ:

alias - 別名

cert - 証明書

スロー:

KeyStoreException - キーストアが初期化されていない� �合、指定された別名がすでに存在していてもそれによって識別されるエントリが信� �できる証明書を含んでいない� �合、またはこの処理がなんらかの原� で失敗した� �合。

deleteEntry

public final void deleteEntry(String alias) throws KeyStoreException

このキーストアから、指定された別名によって識別されるエントリを削除します。

パラメータ:

alias - 別名

スロー:

KeyStoreException - キーストアが初期化されていない� �合、またはエントリを削除できない� �合。

aliases

public final Enumeration<String> aliases() throws KeyStoreException

このキーストアのすべての別名を一覧表示します。

戻り値:

別名の列挙

スロー:

KeyStoreException - キーストアが初期化(ロード)されていない� �合。

containsAlias

public final boolean containsAlias(String alias) throws KeyStoreException

このキーストアに、指定された別名が存在するかどうかを判定します。

パラメータ:

alias - 別名

戻り値:

別名が存在する� �合はtrue、それ以外の� �合はfalse

スロー:

KeyStoreException - キーストアが初期化(ロード)されていない� �合。

size

public final int size() throws KeyStoreException

このキーストアのエントリ数を取得します。

戻り値:

このキーストアのエントリ数

スロー:

KeyStoreException - キーストアが初期化(ロード)されていない� �合。

isKeyEntry

public final boolean isKeyEntry(String alias) throws KeyStoreException

指定された別名で識別されるエントリがsetKeyEntryへのコールによって作成されたか、PrivateKeyEntryまたはSecretKeyEntryを使用してsetEntryへのコールによって作成された� �合は、trueを返します。

パラメータ:

alias - 判定対象となるキーストア・エントリの別名

戻り値:

指定された別名で識別されるエントリがキー関連のエントリの� �合はtrue、それ以外の� �合はfalse。

スロー:

KeyStoreException - キーストアが初期化(ロード)されていない� �合。

isCertificateEntry

public final boolean isCertificateEntry(String alias) throws KeyStoreException

指定された別名で識別されるエントリがsetCertificateEntryへのコールによって作成されたか、TrustedCertificateEntryを使用してsetEntryへのコールによって作成された� �合は、trueを返します。

パラメータ:

alias - 判定対象となるキーストア・エントリの別名

戻り値:

指定された別名で識別されるエントリに信� �できる証明書が含まれている� �合はtrue、それ以外の� �合はfalse。

スロー:

KeyStoreException - キーストアが初期化(ロード)されていない� �合。

getCertificateAlias

public final String getCertificateAlias(Certificate cert) throws KeyStoreException

指定された証明書と一致する証明書がある最初のキーストア・エントリの別名を返します。

このメソッドは、指定された証明書を各キーストア・エントリと照合します。 処理対象のエントリが、setCertificateEntryを呼び出して作成されたエントリ、あるいはTrustedCertificateEntryを指定してsetEntryを呼び出して作成されたエントリである� �合、指定された証明書はそのエントリの証明書と比較されます。

処理対象のエントリが、setKeyEntryを呼び出して作成されたエントリ、あるいはPrivateKeyEntryを指定してsetEntryを呼び出して作成されたエントリである� �合、指定された証明書はそのエントリの証明書チェーンの最初の要� と比較されます。

パラメータ:

cert - 照合する証明書。

戻り値:

証明書が一致する最初のエントリの別名、またはこのキーストアにそのようなエントリが存在しない� �合はnull。

スロー:

KeyStoreException - キーストアが初期化(ロード)されていない� �合。

store

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

指定された出力ストリー� にこのキーストアを� �納し、指定されたパスワードでその整合性を保護します。

パラメータ:

stream - このキーストアを書き込む出力ストリー� 。

password - キーストアの整合性を検査するためのパスワード キーストアが整合性チェックをサポートしていない� �合、または整合性チェックを必要とする� �合、nullである可能性があります。

スロー:

KeyStoreException - キーストアが初期化(ロード)されていない� �合。

IOException - データに入出力の問題があった� �合

NoSuchAlgorithmException - 適切なデータ整合性アルゴリズ� が見つからなかった� �合

CertificateException - キーストア・データに含まれるどの証明書も� �納できなかった� �合

store

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

指定されたLoadStoreParameterを使用してこのキーストアを� �納します。

パラメータ:

param - キーストアの� �納方法を指定したLoadStoreParameter。nullも指定可能

スロー:

IllegalArgumentException - 指定されたLoadStoreParameter入力が認識されない� �合

KeyStoreException - キーストアが初期化(ロード)されていない� �合

IOException - データに入出力の問題があった� �合

NoSuchAlgorithmException - 適切なデータ整合性アルゴリズ� が見つからなかった� �合

CertificateException - キーストア・データに含まれるどの証明書も� �納できなかった� �合

UnsupportedOperationException - この操作がサポートされていない� �合

導入されたバージョン:

1.5

load

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

指定された入力ストリー� からこのキーストアをロードします。

パスワードを指定すると、キーストアがハードウェア・トークン・デバイス上に存在する� �合などに、キーストアのロック解除やキーストア・データの整合性検査ができます。 整合性検査用のパスワードが指定されなかった� �合、整合性検査は実行されません。

空のキーストアを作成する� �合、あるいはキーストアをストリー� から初期化できない� �合は、stream引数としてnullを渡します。

このキーストアがすでにロードされている� �合、このキーストアは再び初期化され、指定されたストリー� からロードし直されます。

パラメータ:

stream - キーストアのロード元の入力ストリー� またはnull

password - キーストアの整合性検査用パスワード、キーストアのロック解除用パスワード、またはnull

スロー:

IOException - キーストア・データで入出力または形式に関する問題が発生した� �合、パスワードが必要であるのに指定されなかった� �合、または指定されたパスワードが間違っている� �合。 パスワードが正しくなかったためにエラーが発生した� �合、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 - キーストア・データに入出力または形式の問題があった� �合。 ProtectionParameterが正しくなかった(たとえばパスワードが正しくなかった)ためにエラーが発生した� �合、IOExceptionのcauseはUnrecoverableKeyException

NoSuchAlgorithmException - キーストアの整合性を検査するアルゴリズ� が見つからなかった� �合

CertificateException - キーストアのどの証明書もロードできなかった� �合

導入されたバージョン:

1.5

getEntry

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

指定された保護パラメータを使用して、指定された別名に対するキーストアEntryを取得します。

パラメータ:

alias - この別名に対するキーストアEntryを取得

protParam - Entryの保護に使用されるProtectionParameter。nullも指定可能

戻り値:

指定された別名に対するキーストアEntry。そのようなエントリが存在しない� �合はnull

スロー:

NullPointerException - aliasがnullである� �合

NoSuchAlgorithmException - エントリを復元するためのアルゴリズ� が見つからない� �合

UnrecoverableEntryException - 指定されたprotParamが不十分または無効である� �合

UnrecoverableKeyException - エントリがPrivateKeyEntryまたはSecretKeyEntryで、指定されたprotParamにキーの復元に必要な情� �が含まれていない� �合(たとえばパスワードが誤っている� �合)

KeyStoreException - キーストアが初期化(ロード)されていない� �合。

導入されたバージョン:

1.5

関連� �目:

• 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 - キーストアが初期化(ロード)されていない� �合、またはこの処理がなんらかの原� で失敗した� �合

導入されたバージョン:

1.5

関連� �目:

• getEntry(String, KeyStore.ProtectionParameter)

entryInstanceOf

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

指定されたaliasのキーストアEntryが、指定されたentryClassのインスタンスまたはサブクラスであるかどうかを判定します。

パラメータ:

alias - 別名

entryClass - エントリ・クラス

戻り値:

指定されたaliasのキーストアEntryが、指定されたentryClassのインスタンスまたはサブクラスである� �合はtrue、そうでない� �合はfalse

スロー:

NullPointerException - aliasまたはentryClassがnullの� �合

KeyStoreException - キーストアが初期化(ロード)されていない� �合

導入されたバージョン:

1.5

getInstance

public static final KeyStore getInstance(File file, char[] password) throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException

適切なキーストア・タイプのロードされたキーストア・オブジェクトを返します。 最初に、キーストア・タイプは、指定されたファイルをプローブして決定されます。 次に、キーストア・オブジェクトは、そのファイルのデータを使用してインスタンス化およびロードされます。

パスワードを指定すると、キーストアがハードウェア・トークン・デバイス上に存在する� �合などに、キーストアのロック解除やキーストア・データの整合性検査ができます。 整合性検査用のパスワードが指定されなかった� �合、整合性検査は実行されません。

このメソッドは、最も優先されるプロバイダから開始して、登録されているセキュリティprovidersのリストを横断します。 プロバイダでサポートされているKeyStoreSpi実装ごとに、engineProbeメソッドを起動して、指定したキーストアがサポートされているかどうかを確認します。 指定されたファイルをサポートする最初のプロバイダからKeyStoreSpi実装をカプセル化する新しいKeyStoreオブジェクトが返されます。

登録済みプロバイダのリストは、Security.getProviders()メソッド経由で取得できます。

パラメータ:

file - キーストア・ファイル

password - キーストア・パスワード(null)

戻り値:

キーストア・データがロードされたキーストア・オブジェクト

スロー:

KeyStoreException - 指定したキーストア・ファイルのKeyStoreSpi実装をサポートするプロバイダがない� �合。

IOException - キーストア・データで入出力または形式に関する問題が発生した� �合、パスワードが必要であるのに指定されなかった� �合、または指定されたパスワードが間違っている� �合。 エラーが間違ったパスワードによるものである� �合、IOExceptionのcauseはUnrecoverableKeyExceptionである必要があります。

NoSuchAlgorithmException - キーストアの整合性を検査するアルゴリズ� が見つからなかった� �合

CertificateException - キーストアのどの証明書もロードできなかった� �合

IllegalArgumentException - ファイルが存在しないか、通常のファイルを参照していない� �合。

NullPointerException - ファイルがnullの� �合。

導入されたバージョン:

9

関連� �目:

• Provider

getInstance

public static final KeyStore getInstance(File file, KeyStore.LoadStoreParameter param) throws KeyStoreException, IOException, NoSuchAlgorithmException, CertificateException

適切なキーストア・タイプのロードされたキーストア・オブジェクトを返します。 最初に、キーストア・タイプは、指定されたファイルをプローブして決定されます。 次に、キーストア・オブジェクトは、そのファイルのデータを使用してインスタンス化およびロードされます。 キーストア・データのロックを解除する方法、または整合性チェックを実行する方法を指定するLoadStoreParameterを指定できます。

このメソッドは、最も優先されるプロバイダから開始して、登録されているセキュリティprovidersのリストを横断します。 プロバイダでサポートされているKeyStoreSpi実装ごとに、engineProbeメソッドを起動して、指定したキーストアがサポートされているかどうかを確認します。 指定されたファイルをサポートする最初のプロバイダからKeyStoreSpi実装をカプセル化する新しいKeyStoreオブジェクトが返されます。

登録済みプロバイダのリストは、Security.getProviders()メソッド経由で取得できます。

パラメータ:

file - キーストア・ファイル

param - キーストアのロード方法を指定したLoadStoreParameter。nullも指定可能

戻り値:

キーストア・データがロードされたキーストア・オブジェクト

スロー:

KeyStoreException - 指定したキーストア・ファイルのKeyStoreSpi実装をサポートするプロバイダがない� �合。

IOException - キーストア・データに入出力または形式の問題があった� �合。 ProtectionParameter (例:間違ったパスワード)が正しくないためにエラーが発生した� �合は、IOExceptionのcauseをUnrecoverableKeyExceptionにする必要があります。

NoSuchAlgorithmException - キーストアの整合性を検査するアルゴリズ� が見つからなかった� �合

CertificateException - キーストアのどの証明書もロードできなかった� �合

IllegalArgumentException - ファイルが存在しない� �合、または通常のファイルを参照しない� �合、またはパラメータが認識されない� �合。

NullPointerException - ファイルがnullの� �合。

導入されたバージョン:

9

関連� �目:

• Provider