Класс PKIXParameters

public class PKIXParameters
extends Object
implements CertPathParameters

Параметры, используемые в качестве входных данных для алгоритма PKIX CertPathValidator.

Объект PKIX CertPathValidator использует эти параметры для проверки CertPath в соответствии с алгоритмом проверки цепочки сертификации PKIX.

Для создания объекта PKIXParameters, приложение должно указать один или несколько самых надёжных ЦС, как определено алгоритмом проверки цепочки сертификации PKIX. Самые надёжные ЦС можно указать, используя один из двух конструкторов. Приложение может вызвать PKIXParameters(Set), указав Set объектов TrustAnchor, каждый из которых идентифицирует самую надёжную ЦС. В качестве альтернативы, приложение может вызвать PKIXParameters(KeyStore), указав экземпляр KeyStore, содержащий записи доверенных сертификатов, каждый из которых будет рассматриваться как самая надёжная ЦС.

После создания объекта PKIXParameters, можно указать другие параметры (например, вызвав setInitialPolicies или setDate), а затем передать объект PKIXParameters вместе с проверяемым CertPath в метод CertPathValidator.validate.

Любой параметр, который не задан (или установлен в null), будет установлен по умолчанию. Значение по умолчанию для параметра date — null, что соответствует текущему времени при проверке пути. Значение по умолчанию для остальных параметров — наименее ограниченное.

Одновременный доступ

Если не указано иное, методы, определённые в этом классе, не являются потокобезопасными. Несколько потоков, которым необходимо одновременное обращение к одному объекту, должны синхронизироваться между собой и обеспечить необходимое блокирование. Несколько потоков, работающих с различными объектами, синхронизироваться не должны.

Конструкторы

PKIXParameters

public PKIXParameters(Set<TrustAnchor> trustAnchors)
               throws InvalidAlgorithmParameterException

Параметры:

trustAnchors - набор Set TrustAnchor

Исключения:

InvalidAlgorithmParameterException - если указанный Set пустой (trustAnchors.isEmpty() == true)

NullPointerException - если указанный Set null

ClassCastException - если любой из элементов в наборе не является объектом типа java.security.cert.TrustAnchor

PKIXParameters

public PKIXParameters(KeyStore keystore)
               throws KeyStoreException,
                      InvalidAlgorithmParameterException

Создаёт экземпляр PKIXParameters, который заполняет набор наиболее надёжных ЦС из надёжных сертификатных записей, содержащихся в указанном KeyStore. В рассмотрение принимаются только записи хранилища ключей, содержащие надёжные X509Certificates все остальные типы сертификатов игнорируются.

Параметры:

keystore - хранилище ключей, из которого будет заполнен набор наиболее надёжных ЦС

Исключения:

KeyStoreException - если хранилище ключей не инициализировано

InvalidAlgorithmParameterException - если хранилище ключей не содержит ни одной надёжной сертификатной записи

NullPointerException - если хранилище ключей null

Методы

getTrustAnchors

public Set<TrustAnchor> getTrustAnchors()

Возвращает неизменяемый набор наиболее надёжных ЦС.

Возвращает:

неизменяемый набор TrustAnchor (никогда null)

См. также:

setTrustAnchors(java.util.Set<java.security.cert.TrustAnchor>)

setTrustAnchors

public void setTrustAnchors(Set<TrustAnchor> trustAnchors)
                     throws InvalidAlgorithmParameterException

Параметры:

trustAnchors - набор TrustAnchor

Исключения:

InvalidAlgorithmParameterException - если указанный Set пустой (trustAnchors.isEmpty() == true)

NullPointerException - если указанный Set null

ClassCastException - если любой из элементов в наборе не является объектом типа java.security.cert.TrustAnchor

См. также:

getTrustAnchors()

getInitialPolicies

public Set<String> getInitialPolicies()

Возвращает неизменяемый набор идентификаторов начальных политик (строки OID), указывающих, что любой из этих политик будет приемлем для пользователя сертификата в целях обработки пути сертификации. Значение по умолчанию — пустой набор, что означает, что любая политика будет приемлема.

Возвращает:

неизменяемый набор начальных OID политик в формате String, или пустой набор (что подразумевает приемлемость любой политики). Никогда не возвращает null.

См. также:

setInitialPolicies(java.util.Set<java.lang.String>)

setInitialPolicies

public void setInitialPolicies(Set<String> initialPolicies)

Параметры:

initialPolicies - набор начальных OID политик в формате String (или null)

Исключения:

ClassCastException - если любой из элементов в наборе не является объектом типа String

См. также:

getInitialPolicies()

setCertStores

public void setCertStores(List<CertStore> stores)

Параметры:

stores - список CertStore (или null)

Исключения:

ClassCastException - если любой из элементов в списке не является объектом типа java.security.cert.CertStore

См. также:

getCertStores()

addCertStore

public void addCertStore(CertStore store)

Добавляет CertStore в конец списка CertStore для поиска сертификатов и CRL.

Параметры:

store - добавляемое CertStore. Если null, хранилище игнорируется (не добавляется в список).

getCertStores

public List<CertStore> getCertStores()

Возвращает неизменяемый список CertStore для поиска сертификатов и CRL.

Возвращает:

неизменяемый список CertStore (может быть пустым, но никогда null)

См. также:

setCertStores(java.util.List<java.security.cert.CertStore>)

setRevocationEnabled

public void setRevocationEnabled(boolean val)

Параметры:

val - новое значение флага RevocationEnabled

isRevocationEnabled

public boolean isRevocationEnabled()

Проверяет флаг RevocationEnabled. Если флаг true, используется стандартный механизм проверки отзыва, встроенный в поставщик PKIX. Если флаг false, стандартный механизм проверки отзыва отключается. Подробная информация об установке значения флага приведена в методе setRevocationEnabled.

Возвращает:

текущее значение флага RevocationEnabled

setExplicitPolicyRequired

public void setExplicitPolicyRequired(boolean val)

Устанавливает флаг ExplicitPolicyRequired. Если флаг true, приемлемая политика должна быть явно указана в каждом сертификате. По умолчанию флаг ExplicitPolicyRequired равен false.

Параметры:

val - true если требуется явная политика, false в противном случае

isExplicitPolicyRequired

public boolean isExplicitPolicyRequired()

Проверяет, требуется ли явная политика. Если флаг true, приемлемая политика должна быть явно указана в каждом сертификате. По умолчанию флаг ExplicitPolicyRequired равен false.

Возвращает:

true если требуется явная политика, false в противном случае

setPolicyMappingInhibited

public void setPolicyMappingInhibited(boolean val)

Устанавливает флаг PolicyMappingInhibited. Если этот флаг true, отображение политики запрещено. По умолчанию отображение политики не запрещено (флаг false).

Параметры:

val - true если отображение политики должно быть запрещено, false в противном случае

isPolicyMappingInhibited

public boolean isPolicyMappingInhibited()

Проверяет, запрещено ли отображение политики. Если этот флаг true, отображение политики запрещено. По умолчанию отображение политики не запрещено (флаг false).

Возвращает:

true, если отображение политики запрещено, иначе false

setAnyPolicyInhibited

public void setAnyPolicyInhibited(boolean val)

Устанавливает состояние, определяющее, должен ли обрабатываться OID «любая политика», если он включён в сертификат. По умолчанию OID «любая политика» не запрещён (isAnyPolicyInhibited() возвращает false).

Параметры:

val - true если OID «любая политика» должен быть запрещён, false в противном случае

isAnyPolicyInhibited

public boolean isAnyPolicyInhibited()

Проверяет, должен ли обрабатываться OID «любая политика», если он включён в сертификат.

Возвращает:

true если OID «любая политика» запрещён, false в противном случае

setPolicyQualifiersRejected

public void setPolicyQualifiersRejected(boolean qualifiersRejected)

Параметры:

qualifiersRejected - новое значение флага PolicyQualifiersRejected

См. также:

getPolicyQualifiersRejected(), PolicyQualifierInfo

getPolicyQualifiersRejected

public boolean getPolicyQualifiersRejected()

Возвращает:

текущее значение флага PolicyQualifiersRejected

См. также:

setPolicyQualifiersRejected(boolean)

getDate

public Date getDate()

Возвращает:

значение Date, или null если не установлено

См. также:

setDate(java.util.Date)

setDate

public void setDate(Date date)

Параметры:

date - значение Date, или null для текущего времени

См. также:

getDate()

setCertPathCheckers

public void setCertPathCheckers(List<PKIXCertPathChecker> checkers)

Параметры:

checkers - список List PKIXCertPathCheckers. Может быть null, в этом случае дополнительные проверки не будут использоваться.

Исключения:

ClassCastException - если любой из элементов в списке не является типом java.security.cert.PKIXCertPathChecker

См. также:

getCertPathCheckers()

getCertPathCheckers

public List<PKIXCertPathChecker> getCertPathCheckers()

Возвращает список проверяющих цепочку сертификатов. Возвращаемый список неизменяем, и каждый PKIXCertPathChecker в списке List клонируется для защиты от последующих изменений.

Возвращает:

неизменяемый список List PKIXCertPathCheckers (может быть пустым, но не null)

См. также:

setCertPathCheckers(java.util.List<java.security.cert.PKIXCertPathChecker>)

addCertPathChecker

public void addCertPathChecker(PKIXCertPathChecker checker)

Параметры:

checker - проверяющий для добавления в список. Если null, проверяющий игнорируется (не добавляется в список).

getSigProvider

public String getSigProvider()

Возвращает имя поставщика подписей или null если не установлено.

Возвращает:

имя поставщика подписей (или null)

См. также:

setSigProvider(java.lang.String)

setSigProvider

public void setSigProvider(String sigProvider)

Устанавливает имя поставщика подписей. Указанный поставщик будет предпочтительным при создании объектов Signature. Если null или не установлен, будет использован первый найденный поставщик, поддерживающий алгоритм.

Параметры:

sigProvider - имя поставщика подписей (или null)

См. также:

getSigProvider()

getTargetCertConstraints

public CertSelector getTargetCertConstraints()

Возвращает:

объект CertSelector, задающий ограничения на целевой сертификат (или null)

См. также:

setTargetCertConstraints(java.security.cert.CertSelector)

setTargetCertConstraints

public void setTargetCertConstraints(CertSelector selector)

Параметры:

selector - объект CertSelector, задающий ограничения на целевой сертификат (или null)

См. также:

getTargetCertConstraints()

clone

public Object clone()

Создаёт копию объекта PKIXParameters. Изменения в копии не повлияют на оригинал и наоборот.

Определено в:

clone в интерфейсе CertPathParameters

Переопределяет:

clone в классе Object

Возвращает:

копию объекта PKIXParameters

См. также:

Cloneable

toString

public String toString()

Возвращает отформатированную строку, описывающую параметры.

Переопределяет:

toString в классе Object

Возвращает:

отформатированную строку, описывающую параметры.