java.security
クラス KeyStoreSpi

java.lang.Object
  java.security.KeyStoreSpi

public abstract class KeyStoreSpi
extends Object

このクラスは、KeyStore クラスの Service Provider Interface (SPI) を定義します。特定のキーストア型のキーストアの実装を提供する各暗号サービスプロバイダは、このクラスのすべての抽象メソッドを実装する必要があります。

導入されたバージョン:

1.2

関連項目:

KeyStore

コンストラクタの概要

KeyStoreSpi()

メソッドの概要

abstract Enumeration	engineAliases() このキーストアのすべての別名を一覧表示します。
abstract boolean	engineContainsAlias(String alias) このキーストアに、指定された別名が存在するかどうかを判定します。
abstract void	engineDeleteEntry(String alias) このキーストアから、指定された別名によって識別されるエントリを削除します。
abstract Certificate	engineGetCertificate(String alias) 指定された別名に関連付けられた証明書を返します。
abstract String	engineGetCertificateAlias(Certificate cert) 指定された証明書と一致する証明書がある最初のキーストアエントリの別名を返します。
abstract Certificate[]	engineGetCertificateChain(String alias) 指定された別名に関連付けられた証明書チェーンを返します。
abstract Date	engineGetCreationDate(String alias) 指定された別名によって識別されるエントリの作成日を返します。
abstract Key	engineGetKey(String alias, char[] password) 指定されたパスワードを使用して、指定された別名に関連付けられた鍵を復元し、その鍵を返します。
abstract boolean	engineIsCertificateEntry(String alias) 指定された別名で識別されるエントリが「信頼できる証明書エントリ」である場合は true、そうでない場合は false を返します。
abstract boolean	engineIsKeyEntry(String alias) 指定された別名で識別されるエントリが「鍵エントリ」である場合は true、そうでない場合は false を返します。
abstract void	engineLoad(InputStream stream, char[] password) 指定された入力ストリームからキーストアをロードします。
abstract void	engineSetCertificateEntry(String alias, Certificate cert) 指定された別名に、指定された証明書を割り当てます。
abstract void	engineSetKeyEntry(String alias, byte[] key, Certificate[] chain) 指定された別名に、すでに保護されている指定の鍵を割り当てます。
abstract void	engineSetKeyEntry(String alias, Key key, char[] password, Certificate[] chain) 指定された別名に指定された鍵を割り当て、指定されたパスワードでその鍵を保護します。
abstract int	engineSize() このキーストアのエントリ数を取得します。
abstract void	engineStore(OutputStream stream, char[] password) 指定された出力ストリームにこのキーストアを格納し、指定されたパスワードでその整合性を保護します。

クラス java.lang.Object から継承されたメソッド

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

コンストラクタの詳細

KeyStoreSpi

public KeyStoreSpi()

メソッドの詳細

engineGetKey

public abstract Key engineGetKey(String alias,
                                 char[] password)
                          throws NoSuchAlgorithmException,
                                 UnrecoverableKeyException

指定されたパスワードを使用して、指定された別名に関連付けられた鍵を復元し、その鍵を返します。

パラメータ:

alias - 別名

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

戻り値:

要求される鍵。指定された別名が存在しないか、「鍵エントリ」を識別しない場合は null

例外:

NoSuchAlgorithmException - 鍵を復元するためのアルゴリズムが見つからない場合

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

engineGetCertificateChain

public abstract Certificate[] engineGetCertificateChain(String alias)

指定された別名に関連付けられた証明書チェーンを返します。

パラメータ:

alias - 別名

戻り値:

証明書チェーン。順番は、ユーザーの証明書が最初でルート証明書発行局が最後。指定された別名が存在しないか、証明書チェーンを含んでいない (指定された別名によって「信頼できる証明書エントリ」または証明書チェーンを含まない「鍵エントリ」が識別される) 場合は null

engineGetCertificate

public abstract Certificate engineGetCertificate(String alias)

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

指定された別名によって「信頼できる証明書エントリ」が識別される場合は、そのエントリに関連付けられた証明書が返されます。指定された別名によって「鍵エントリ」が識別される場合は、そのエントリの証明書チェーンの最初の要素が返されます。そのエントリが証明書チェーンを含まない場合は、null が返されます。

パラメータ:

alias - 別名

戻り値:

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

engineGetCreationDate

public abstract Date engineGetCreationDate(String alias)

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

パラメータ:

alias - 別名

戻り値:

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

engineSetKeyEntry

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

指定された別名に指定された鍵を割り当て、指定されたパスワードでその鍵を保護します。

指定された鍵が java.security.PrivateKey 型である場合、その鍵には対応する公開鍵を証明する証明書チェーンが含まれていなければなりません。

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

パラメータ:

alias - 別名

key - 別名に関連付ける鍵

password - 鍵を保護するためのパスワード

chain - 対応する公開鍵の証明書チェーン。指定された鍵が java.security.PrivateKey 型である場合にのみ必要

例外:

KeyStoreException - 指定された鍵を保護できない場合、またはこの処理がなんらかの原因で失敗した場合

engineSetKeyEntry

public abstract void engineSetKeyEntry(String alias,
                                       byte[] key,
                                       Certificate[] chain)
                                throws KeyStoreException

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

保護された鍵が java.security.PrivateKey 型である場合、その鍵には対応する公開鍵を証明する証明書チェーンが含まれていなければなりません。

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

パラメータ:

alias - 別名

key - 別名に関連付ける保護形式の鍵

chain - 対応する公開鍵の証明書チェーン。保護された鍵が java.security.PrivateKey 型である場合にのみ有効

例外:

KeyStoreException - この処理が失敗した場合

engineSetCertificateEntry

public abstract void engineSetCertificateEntry(String alias,
                                               Certificate cert)
                                        throws KeyStoreException

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

指定された別名がこのキーストアに存在し、それによって「信頼できる証明書エントリ」が識別される場合は、それに関連付けられた証明書が、指定された証明書でオーバーライドされます。

パラメータ:

alias - 別名

cert - 証明書

例外:

KeyStoreException - 指定された別名がすでに存在しており、それによって「信頼できる証明書エントリ」が識別されない場合、またはこの処理がなんらかの原因で失敗した場合

engineDeleteEntry

public abstract void engineDeleteEntry(String alias)
                                throws KeyStoreException

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

パラメータ:

alias - 別名

例外:

KeyStoreException - エントリを削除できない場合

engineAliases

public abstract Enumeration engineAliases()

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

戻り値:

別名の列挙

engineContainsAlias

public abstract boolean engineContainsAlias(String alias)

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

パラメータ:

alias - 別名

戻り値:

別名が存在する場合は true、そうでない場合は false

engineSize

public abstract int engineSize()

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

戻り値:

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

engineIsKeyEntry

public abstract boolean engineIsKeyEntry(String alias)

指定された別名で識別されるエントリが「鍵エントリ」である場合は true、そうでない場合は false を返します。

パラメータ:

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

戻り値:

指定された別名で識別されるエントリが「鍵エントリ」である場合は true、そうでない場合は false

engineIsCertificateEntry

public abstract boolean engineIsCertificateEntry(String alias)

指定された別名で識別されるエントリが「信頼できる証明書エントリ」である場合は true、そうでない場合は false を返します。

パラメータ:

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

戻り値:

指定された別名で識別されるエントリが「信頼できる証明書エントリ」である場合は true、そうでない場合は false

engineGetCertificateAlias

public abstract String engineGetCertificateAlias(Certificate cert)

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

このメソッドは、指定された証明書を各キーストアエントリと照合します。処理対象のエントリが「信頼できる証明書エントリ」である場合は、指定された証明書がそのエントリの証明書と比較されます。処理対象のエントリが「鍵エントリ」である場合は、指定された証明書がそのエントリの証明書チェーン (存在する場合) の最初の要素と比較されます。

パラメータ:

cert - 照合する証明書

戻り値:

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

engineStore

public abstract void engineStore(OutputStream stream,
                                 char[] password)
                          throws IOException,
                                 NoSuchAlgorithmException,
                                 CertificateException

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

パラメータ:

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

password - キーストアの整合性を検査するためのパスワード

例外:

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

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

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

engineLoad

public abstract void engineLoad(InputStream stream,
                                char[] password)
                         throws IOException,
                                NoSuchAlgorithmException,
                                CertificateException

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

パスワードを指定すると、それを使ってキーストアデータの整合性が検査されます。パスワードを指定しないと、キーストアの整合性検査は行われません。

パラメータ:

stream - キーストアのロード元の入力ストリーム

password - キーストアの整合性検査用のパスワード (省略可能)

例外:

IOException - キーストアデータに入出力または形式の問題があった場合

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

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