クラスPKIXBuilderParameters

java.lang.Object

java.security.cert.PKIXParameters

java.security.cert.PKIXBuilderParameters

すべての実装されたインタフェース:

Cloneable, CertPathParameters

public class PKIXBuilderParameters extends PKIXParameters

PKIX CertPathBuilderアルゴリズムの入力で使用されるパラメータです。

PKIX CertPathBuilderではこれらのパラメータを使用し、PKIX証明書パス検査アルゴリズムに従って検証されたCertPathを構築(build)します。

PKIXBuilderParametersオブジェクトをインスタンス化するには、アプリケーションでPKIX証明書パス検査アルゴリズムで定義されるもっとも信頼できるCAを1つ以上指定しなければいけません。 もっとも信頼できるCAは、2つのコンストラクタのどちらかを使用して指定されます。 PKIXBuilderParameters(Set, CertSelector)を呼び出す場合は、TrustAnchorオブジェクトのSetを指定します。それぞれのTrustAnchorオブジェクトではもっとも信頼できるCAを特定します。 またアプリケーションは、信頼できる証明書エントリが含まれるKeyStoreインスタンスを指定してPKIXBuilderParameters(KeyStore, CertSelector)を呼び出すことができます。それぞれの証明書エントリがもっとも信頼できるCAになります。

さらにアプリケーションでは、CertPathBuilderがパスを構築しようとするターゲット証明書の制約を指定する必要があります。 制約は、CertSelectorオブジェクトとして指定されます。 これらの制約により、ターゲット証明書を見つけるための十分な検索基準がCertPathBuilderに与えられます。 通常、X509Certificateの最小基準には、サブジェクトの名前や1つ以上のサブジェクトの代替名が含まれています。 十分な基準が指定されない場合、CertPathBuilderはCertPathBuilderExceptionをスローします。

並行アクセス

特に断らないかぎり、このクラスで定義されているメソッドはスレッドセーフではありません。 単一のオブジェクトに並行アクセスする必要のある複数スレッドは、スレッド間で同期をとり、必要に応じてロックする必要があります。 複数のスレッドがそれぞれ個別のオブジェクトを処理する場合、それらのスレッドは同期する必要はありません。

導入されたバージョン:

1.4

関連項目:

• CertPathBuilder

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

コンストラクタ

コンストラクタ	説明
PKIXBuilderParameters(KeyStore keystore, CertSelector targetConstraints)	もっとも信頼できるCAのセットを、指定したKeyStoreに含まれる信頼できる証明書エントリから生成する、PKIXBuilderParametersのインスタンスを作成します。
PKIXBuilderParameters(Set<TrustAnchor> trustAnchors, CertSelector targetConstraints)	もっとも信頼できるCAからなる指定したSetで、PKIXBuilderParametersのインスタンスを作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
int	getMaxPathLength()	証明書パスに存在する、自己発行でない中間証明書の最大数を返します。
void	setMaxPathLength(int maxPathLength)	証明書パスに存在する、自己発行でない中間証明書の最大数を設定します。
String	toString()	パラメータを説明する書式付き文字列を返します。

クラスで宣言されたメソッド PKIXParameters

addCertPathChecker, addCertStore, clone, getCertPathCheckers, getCertStores, getDate, getInitialPolicies, getPolicyQualifiersRejected, getSigProvider, getTargetCertConstraints, getTrustAnchors, isAnyPolicyInhibited, isExplicitPolicyRequired, isPolicyMappingInhibited, isRevocationEnabled, setAnyPolicyInhibited, setCertPathCheckers, setCertStores, setDate, setExplicitPolicyRequired, setInitialPolicies, setPolicyMappingInhibited, setPolicyQualifiersRejected, setRevocationEnabled, setSigProvider, setTargetCertConstraints, setTrustAnchors

修飾子と型	メソッド	説明
void	addCertPathChecker(PKIXCertPathChecker checker)	PKIXCertPathCheckerを証明書パス・チェッカのリストに追加します。
void	addCertStore(CertStore store)	CertStoreを、証明書とCRLを見つけるために使用されるCertStoreのリストの最後に追加します。
Object	clone()	このPKIXParametersオブジェクトのコピーを作成します。
List<PKIXCertPathChecker>	getCertPathCheckers()	証明書パス・チェッカのListを返します。
List<CertStore>	getCertStores()	証明書とCRLを見つけるために使用されるCertStoreの不変なListを返します。
Date	getDate()	証明書パスの妥当性が判断される時刻を返します。
Set<String>	getInitialPolicies()	どの初期ポリシーも証明書パス処理のために証明書ユーザーにとって許容できるような初期ポリシー識別子(OID文字列)の不変なSetを返します。
boolean	getPolicyQualifiersRejected()	PolicyQualifiersRejectedフラグを取得します。
String	getSigProvider()	署名プロバイダの名前を返します。設定されていない場合はnullを返します。
CertSelector	getTargetCertConstraints()	ターゲット証明書に要求された制約を返します。
Set<TrustAnchor>	getTrustAnchors()	もっとも信頼できるCAの不変なSetを返します。
boolean	isAnyPolicyInhibited()	任意のポリシーOIDが証明書に含まれるとき、そのポリシーOIDが処理されるべきかどうかをチェックします。
boolean	isExplicitPolicyRequired()	明示的なポリシーが要求されているかどうかをチェックします。
boolean	isPolicyMappingInhibited()	ポリシー・マッピングが抑制されているかどうかをチェックします。
boolean	isRevocationEnabled()	RevocationEnabledフラグをチェックします。
void	setAnyPolicyInhibited(boolean val)	任意のポリシーOIDが証明書に含まれるときに、そのポリシーOIDが処理されなければならないかどうかを判断する状態を設定します。
void	setCertPathCheckers(List<PKIXCertPathChecker> checkers)	追加の証明書パス・チェッカのListを設定します。
void	setCertStores(List<CertStore> stores)	証明書とCRLを見つけるために使用されるCertStoreのリストを設定します。
void	setDate(Date date)	証明書パスの妥当性が判断される時刻を設定します。
void	setExplicitPolicyRequired(boolean val)	ExplicitPolicyRequiredフラグを設定します。
void	setInitialPolicies(Set<String> initialPolicies)	初期ポリシー識別子(OID文字列)のSetを設定して、証明書パス処理のためにどの初期ポリシーも証明書ユーザーが許容できることを示します。
void	setPolicyMappingInhibited(boolean val)	PolicyMappingInhibitedフラグを設定します。
void	setPolicyQualifiersRejected(boolean qualifiersRejected)	PolicyQualifiersRejectedフラグを設定します。
void	setRevocationEnabled(boolean val)	RevocationEnabledフラグを設定します。
void	setSigProvider(String sigProvider)	署名プロバイダの名前を設定します。
void	setTargetCertConstraints(CertSelector selector)	ターゲット証明書に要求された制約を設定します。
void	setTrustAnchors(Set<TrustAnchor> trustAnchors)	もっとも信頼できるCAのSetを設定します。

クラスオブジェクトで宣言されたメソッド

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

修飾子と型	メソッド	説明
boolean	equals(Object obj)	このオブジェクトと他のオブジェクトが等しいかどうかを示します。
protected void	finalize()	削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。 最終決定は非推奨であり、将来のリリースで削除される可能性があります。
final Class<?>	getClass()	このObjectの実行時クラスを返します。
int	hashCode()	このオブジェクトに対するハッシュ・コード値を返します。
final void	notify()	このオブジェクトのモニターで待機中のスレッドを1つ再開します。
final void	notifyAll()	このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
final void	wait()	現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
final void	wait(long timeoutMillis)	現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
final void	wait(long timeoutMillis, int nanos)	現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

コンストラクタの詳細

PKIXBuilderParameters

public PKIXBuilderParameters(Set<TrustAnchor> trustAnchors, CertSelector targetConstraints) throws InvalidAlgorithmParameterException

もっとも信頼できるCAからなる指定したSetで、PKIXBuilderParametersのインスタンスを作成します。 セットの各要素はTrustAnchorです。

以後の変更から保護するために、Setは複製されています。

パラメータ:

trustAnchors - TrustAnchorのSet

targetConstraints - ターゲット証明書の制約を指定するCertSelector

スロー:

InvalidAlgorithmParameterException - trustAnchorsが空である場合(trustAnchors.isEmpty()== true)

NullPointerException - trustAnchorsがnullである場合

ClassCastException - trustAnchorsの要素のいずれかがjava.security.cert.TrustAnchor型ではない場合

PKIXBuilderParameters

public PKIXBuilderParameters(KeyStore keystore, CertSelector targetConstraints) throws KeyStoreException, InvalidAlgorithmParameterException

もっとも信頼できるCAのセットを、指定したKeyStoreに含まれる信頼できる証明書エントリから生成する、PKIXBuilderParametersのインスタンスを作成します。 信頼できるX509Certificateを含むキーストア・エントリだけが対象となり、それ以外の証明書タイプはすべて無視されます。

パラメータ:

keystore - もっとも信頼できるCAのセットが生成されるKeyStore

targetConstraints - ターゲット証明書の制約を指定するCertSelector

スロー:

KeyStoreException - keystoreが初期化されていない場合

InvalidAlgorithmParameterException - keystoreに信頼できる証明書エントリが1つも含まれない場合

NullPointerException - keystoreがnullである場合

メソッドの詳細

setMaxPathLength

public void setMaxPathLength(int maxPathLength)

証明書パスに存在する、自己発行でない中間証明書の最大数を設定します。 サブジェクト・フィールドと発行者フィールドのDNがそれぞれ特定でき、空ではない場合、証明書は自己発行されています。 証明書パスの最後の証明書は中間証明書ではないため、この上限値には含まれません。 通常、最後の証明書はエンド・エンティティ証明書ですが、CA証明書となる場合もあります。 PKIX CertPathBuilderインスタンスによって構築されるパスは、ここで指定した長さよりも長くなってはいけません。

値が0の場合、パスには証明書が1つだけ含まれていることを表します。 -1の場合は、パス長に制約がありません(つまり最大値がない)。 最大パス長を指定しなかった場合、デフォルトの5になります。 -1よりも小さい値を設定すると、例外がスローされます。

あらゆるCA証明書にBasicConstraintsExtensionが含まれている場合、機能拡張のpathLenConstraintフィールドの値は、結果の証明書パス長が短いときは常に、最大パス長のパラメータでオーバーライドされます。

パラメータ:

maxPathLength - 証明書パスに存在する、自己発行でない中間証明書の最大数

スロー:

InvalidParameterException - maxPathLengthの値が -1より小さい場合

関連項目:

• getMaxPathLength()

getMaxPathLength

public int getMaxPathLength()

証明書パスに存在する、自己発行でない中間証明書の最大数を返します。 詳細は、setMaxPathLength(int)メソッドを参照してください。

戻り値:

証明書パスに存在する、自己発行でない中間証明書の最大数。上限がない場合は -1

関連項目:

• setMaxPathLength(int)

toString

public String toString()

パラメータを説明する書式付き文字列を返します。

オーバーライド:

toString、クラスPKIXParameters

戻り値:

パラメータを説明する書式付き文字列