Spec-Zone.ru › OpenJDK 25

Класс PKIXParameters

java.lang.Object
java.security.cert.PKIXParameters
Все реализуемые интерфейсы:
Cloneable, CertPathParameters
Прямые известные подклассы:
PKIXBuilderParameters
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, что означает текущее время на момент проверки цепочки. Для остальных параметров по умолчанию используются наименее ограничительные значения.

Параллельный доступ

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

Начиная с:
1.4
См. также:
  • CertPathValidator

Краткое описание конструкторов

Конструктор Описание
PKIXParameters(KeyStore keystore)
Создаёт экземпляр PKIXParameters, заполняя набор наиболее доверенных центров сертификации доверенными записями сертификатов, содержащимися в указанном KeyStore.
PKIXParameters(Set<TrustAnchor> trustAnchors)
Создаёт экземпляр PKIXParameters с указанным Set наиболее доверенных центров сертификации.

Краткое описание методов

Модификатор и тип Метод Описание
void addCertPathChecker(PKIXCertPathChecker checker)
Добавляет PKIXCertPathChecker в список средств проверки цепочки сертификации.
void addCertStore(CertStore store)
Добавляет CertStore в конец списка CertStore, используемых для поиска сертификатов и списков отзыва сертификатов.
Object clone()
Создаёт копию этого объекта PKIXParameters.
List<PKIXCertPathChecker> getCertPathCheckers()
Возвращает List средств проверки цепочки сертификации.
List<CertStore> getCertStores()
Возвращает неизменяемый List объектов CertStore, используемых для поиска сертификатов и списков отзыва сертификатов.
Date getDate()
Возвращает время, на которое следует определить срок действия цепочки сертификации.
Set<String> getInitialPolicies()
Возвращает неизменяемый Set исходных идентификаторов политик (строк OID), указывающий, что любая из этих политик будет приемлема для пользователя сертификата при обработке цепочки сертификации.
boolean getPolicyQualifiersRejected()
Возвращает значение флага PolicyQualifiersRejected.
String getSigProvider()
Возвращает имя поставщика подписи или null, если оно не задано.
CertSelector getTargetCertConstraints()
Возвращает обязательные ограничения для целевого сертификата.
Set<TrustAnchor> getTrustAnchors()
Возвращает неизменяемый Set наиболее доверенных центров сертификации.
boolean isAnyPolicyInhibited()
Проверяет, следует ли обрабатывать OID любой политики, если он включён в сертификат.
boolean isExplicitPolicyRequired()
Проверяет, требуется ли явная политика.
boolean isPolicyMappingInhibited()
Проверяет, запрещено ли сопоставление политик.
boolean isRevocationEnabled()
Проверяет значение флага RevocationEnabled.
void setAnyPolicyInhibited(boolean val)
Устанавливает состояние, определяющее, следует ли обрабатывать OID любой политики, если он включён в сертификат.
void setCertPathCheckers(List<PKIXCertPathChecker> checkers)
Задаёт List дополнительных средств проверки цепочки сертификации.
void setCertStores(List<CertStore> stores)
Задаёт список CertStore, используемых для поиска сертификатов и списков отзыва сертификатов.
void setDate(Date date)
Задаёт время, на которое следует определить срок действия цепочки сертификации.
void setExplicitPolicyRequired(boolean val)
Устанавливает флаг ExplicitPolicyRequired.
void setInitialPolicies(Set<String> initialPolicies)
Задаёт Set исходных идентификаторов политик (строк OID), указывающий, что любая из этих политик будет приемлема для пользователя сертификата при обработке цепочки сертификации.
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)
Задаёт Set наиболее доверенных центров сертификации.
String toString()
Возвращает отформатированную строку с описанием параметров.

Методы, объявленные в классе Object

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

Подробное описание конструкторов

PKIXParameters

public PKIXParameters(Set<TrustAnchor> trustAnchors) throws InvalidAlgorithmParameterException
Создает экземпляр PKIXParameters с указанным Set наиболее доверенных центров сертификации. Каждый элемент набора является объектом TrustAnchor.

Обратите внимание, что Set копируется для защиты от последующих изменений.

Параметры:
trustAnchors — Set TrustAnchorов
Исключения:
InvalidAlgorithmParameterException — если указанный Set пуст (trustAnchors.isEmpty() == true)
NullPointerException — если указанный Set равен null
ClassCastException — если элементы Set не имеют тип java.security.cert.TrustAnchor

PKIXParameters

public PKIXParameters(KeyStore keystore) throws KeyStoreException, InvalidAlgorithmParameterException
Создает экземпляр PKIXParameters, заполняющий набор наиболее доверенных центров сертификации на основе записей доверенных сертификатов, содержащихся в указанном KeyStore. Учитываются только записи хранилища ключей, содержащие доверенные X509Certificates; все остальные типы сертификатов игнорируются.
Параметры:
keystore — KeyStore, из которого будет заполнен набор наиболее доверенных центров сертификации
Исключения:
KeyStoreException — если хранилище ключей не было инициализировано
InvalidAlgorithmParameterException — если хранилище ключей не содержит ни одной записи доверенного сертификата
NullPointerException — если хранилище ключей равно null

Подробное описание методов

getTrustAnchors

public Set<TrustAnchor> getTrustAnchors()
Возвращает неизменяемый Set наиболее доверенных центров сертификации.
Возвращает:
неизменяемый Set TrustAnchorов (никогда не null)
См. также:
  • setTrustAnchors(Set)

setTrustAnchors

public void setTrustAnchors(Set<TrustAnchor> trustAnchors) throws InvalidAlgorithmParameterException
Задает Set наиболее доверенных центров сертификации.

Обратите внимание, что Set копируется для защиты от последующих изменений.

Параметры:
trustAnchors — Set TrustAnchorов
Исключения:
InvalidAlgorithmParameterException — если указанный Set пуст (trustAnchors.isEmpty() == true)
NullPointerException — если указанный Set равен null
ClassCastException — если элементы набора не имеют тип java.security.cert.TrustAnchor
См. также:
  • getTrustAnchors()

getInitialPolicies

public Set<String> getInitialPolicies()
Возвращает неизменяемый Set идентификаторов начальных политик (строк OID), указывающий, что любая из этих политик будет приемлема для пользователя сертификата при обработке пути сертификации. По умолчанию возвращается пустой Set, что означает, что приемлема любая политика.
Возвращает:
неизменяемый Set OID начальных политик в формате String или пустой Set (означающий, что приемлема любая политика). Никогда не возвращает null.
См. также:
  • setInitialPolicies(Set)

setInitialPolicies

public void setInitialPolicies(Set<String> initialPolicies)
Задает Set идентификаторов начальных политик (строк OID), указывающий, что любая из этих политик будет приемлема для пользователя сертификата при обработке пути сертификации. По умолчанию приемлема любая политика (то есть все политики), поэтому пользователю, который хочет считать приемлемой любую политику, не нужно вызывать этот метод; также его можно вызвать с пустым Set (или null).

Обратите внимание, что Set копируется для защиты от последующих изменений.

Параметры:
initialPolicies — Set OID начальных политик в формате String (или null)
Исключения:
ClassCastException — если элементы набора не имеют тип String
См. также:
  • getInitialPolicies()

setCertStores

public void setCertStores(List<CertStore> stores)
Задает список CertStoreов, используемых для поиска сертификатов и списков отзыва сертификатов (CRL). Может быть null; в этом случае CertStoreы использоваться не будут. Предпочтение может отдаваться CertStoreам, находящимся в начале списка.

Обратите внимание, что List копируется для защиты от последующих изменений.

Параметры:
stores — List 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()
Возвращает неизменяемый List CertStoreов, используемых для поиска сертификатов и списков отзыва сертификатов (CRL).
Возвращает:
неизменяемый List CertStoreов (может быть пустым, но никогда не null)
См. также:
  • setCertStores(List)

setRevocationEnabled

public void setRevocationEnabled(boolean val)
Задает флаг RevocationEnabled. Если этот флаг имеет значение true, будет использоваться механизм проверки отзыва сертификатов по умолчанию, предоставляемый базовым поставщиком службы PKIX, если только объект PKIXRevocationChecker не передан в качестве CertPathChecker (дополнительные пояснения см. ниже). Если этот флаг имеет значение false, механизм проверки отзыва сертификатов по умолчанию будет отключен (не будет использоваться).

При создании объекта PKIXParameters этот флаг устанавливается в true. Такая настройка отражает наиболее распространенную стратегию проверки отзыва сертификатов, поскольку каждый поставщик службы должен поддерживать такую проверку, чтобы соответствовать требованиям PKIX. В сложных приложениях следует задавать этому флагу значение false, если использовать механизм проверки отзыва сертификатов по умолчанию поставщика службы PKIX нецелесообразно или требуется заменить его альтернативным механизмом проверки отзыва (вызвав также методы addCertPathChecker или setCertPathCheckers).

Обратите внимание: если объект PKIXRevocationChecker передан в качестве параметра методам addCertPathChecker или setCertPathCheckers, он будет использоваться для проверки отзыва независимо от значения флага RevocationEnabled.

Параметры:
val — новое значение флага RevocationEnabled

isRevocationEnabled

public boolean isRevocationEnabled()
Проверяет флаг RevocationEnabled. Если этот флаг имеет значение true, будет использоваться механизм проверки отзыва сертификатов по умолчанию, предоставляемый базовым поставщиком службы PKIX, если только объект PKIXRevocationChecker не передан в качестве CertPathChecker. Если этот флаг имеет значение 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)
Задает флаг PolicyQualifiersRejected. Если этот флаг имеет значение true, сертификаты, содержащие квалификаторы политики в расширении политик сертификата, помеченном как критическое, отклоняются. Если флаг имеет значение false, сертификаты не отклоняются по этой причине.

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

Обратите внимание: алгоритм проверки пути сертификации PKIX требует обрабатывать и проверять любые квалификаторы политики в расширении политик сертификата, помеченном как критическое. В противном случае путь сертификации должен быть отклонен. Если флаг policyQualifiersRejected имеет значение false, приложение должно самостоятельно проверить все квалификаторы политики таким образом, чтобы соответствовать требованиям PKIX.

Параметры:
qualifiersRejected — новое значение флага PolicyQualifiersRejected
См. также:
  • getPolicyQualifiersRejected()
  • PolicyQualifierInfo

getPolicyQualifiersRejected

public boolean getPolicyQualifiersRejected()
Возвращает значение флага PolicyQualifiersRejected. Если этот флаг имеет значение true, сертификаты, содержащие квалификаторы политики в расширении политик сертификата, помеченном как критическое, отклоняются. Если флаг имеет значение false, сертификаты не отклоняются по этой причине.

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

Возвращает:
текущее значение флага PolicyQualifiersRejected
См. также:
  • setPolicyQualifiersRejected(boolean)

getDate

public Date getDate()
Возвращает время, на которое следует определить срок действия пути сертификации. Если null, используется текущее время.

Обратите внимание, что возвращаемое значение Date копируется для защиты от последующих изменений.

Возвращает:
Date или null, если значение не задано
См. также:
  • setDate(Date)

setDate

public void setDate(Date date)
Задает время, на которое следует определить срок действия пути сертификации. Если null, используется текущее время.

Обратите внимание, что указанное здесь значение Date копируется для защиты от последующих изменений.

Параметры:
date — Date или null для текущего времени
См. также:
  • getDate()

setCertPathCheckers

public void setCertPathCheckers(List<PKIXCertPathChecker> checkers)
Задает List дополнительных средств проверки пути сертификации. Если указанный List содержит объект, не являющийся PKIXCertPathChecker, он игнорируется.

Каждый указанный PKIXCertPathChecker выполняет дополнительные проверки сертификата. Как правило, это проверки для обработки и проверки закрытых расширений, содержащихся в сертификатах. Каждый PKIXCertPathChecker следует создавать с параметрами инициализации, необходимыми для выполнения проверки.

Этот метод позволяет сложным приложениям расширять CertPathValidator или CertPathBuilder PKIX. Каждый указанный PKIXCertPathChecker будет поочередно вызываться объектом CertPathValidator или CertPathBuilder PKIX для каждого обрабатываемого или проверяемого сертификата.

Независимо от того, заданы ли эти дополнительные PKIXCertPathCheckerы, объект CertPathValidator или CertPathBuilder PKIX должен выполнять все обязательные проверки PKIX для каждого сертификата. Единственное исключение — если флаг RevocationEnabled имеет значение false (см. метод setRevocationEnabled).

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

Параметры:
checkers — List PKIXCertPathCheckerов. Может быть null; в этом случае дополнительные средства проверки использоваться не будут.
Исключения:
ClassCastException — если элементы списка не имеют тип java.security.cert.PKIXCertPathChecker
См. также:
  • getCertPathCheckers()

getCertPathCheckers

public List<PKIXCertPathChecker> getCertPathCheckers()
Возвращает List средств проверки пути сертификации. Возвращаемый List является неизменяемым, а каждый PKIXCertPathChecker в List клонируется для защиты от последующих изменений.
Возвращает:
неизменяемый List PKIXCertPathCheckerов (может быть пустым, но не null)
См. также:
  • setCertPathCheckers(List)

addCertPathChecker

public void addCertPathChecker(PKIXCertPathChecker checker)
Добавляет PKIXCertPathChecker в список средств проверки пути сертификации. Дополнительные сведения см. в методе setCertPathCheckers.

Обратите внимание, что PKIXCertPathChecker клонируется для защиты от последующих изменений.

Параметры:
checker — PKIXCertPathChecker для добавления в список проверок. Если null, средство проверки игнорируется (не добавляется в список).

getSigProvider

public String getSigProvider()
Возвращает имя поставщика службы подписей или null, если оно не задано.
Возвращает:
имя поставщика службы подписей (или null)
См. также:
  • setSigProvider(String)

setSigProvider

public void setSigProvider(String sigProvider)
Задает имя поставщика службы подписей. Указанный поставщик будет иметь приоритет при создании объектов Signature. Если задано значение null или поставщик не указан, будет использоваться первый найденный поставщик, поддерживающий алгоритм.
Параметры:
sigProvider — имя поставщика службы подписей (или null)
См. также:
  • getSigProvider()

getTargetCertConstraints

public CertSelector getTargetCertConstraints()
Возвращает обязательные ограничения для целевого сертификата. Ограничения возвращаются в виде экземпляра CertSelector. Если null, ограничения не заданы.

Обратите внимание, что возвращаемое значение CertSelector клонируется для защиты от последующих изменений.

Возвращает:
CertSelector, задающий ограничения для целевого сертификата (или null)
См. также:
  • setTargetCertConstraints(CertSelector)

setTargetCertConstraints

public void setTargetCertConstraints(CertSelector selector)
Задает обязательные ограничения для целевого сертификата. Ограничения указываются в виде экземпляра CertSelector. Если null, ограничения не заданы.

Обратите внимание, что указанный объект CertSelector клонируется для защиты от последующих изменений.

Параметры:
selector — CertSelector, задающий ограничения для целевого сертификата (или null)
См. также:
  • getTargetCertConstraints()

clone

public Object clone()
Создает копию этого объекта PKIXParameters. Изменения копии не влияют на оригинал, и наоборот.
Указано в:
clone в интерфейсе CertPathParameters
Переопределяет:
clone в классе Object
Возвращает:
копию этого объекта PKIXParameters
См. также:
  • Cloneable

toString

public String toString()
Возвращает отформатированную строку с описанием параметров.
Переопределяет:
toString в классе Object
Возвращает:
отформатированную строку с описанием параметров.

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065, США.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/security/cert/PKIXParameters.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API