Класс 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

См. также:

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

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

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

Модификатор и тип	Метод	Описание
`void`	`addCertPathChecker(PKIXCertPathChecker checker)`	Добавляет `PKIXCertPathChecker` в список проверяющих пути сертификации.
`void`	`addCertStore(CertStore store)`	Добавляет `CertStore` в конец списка `CertStore` для поиска сертификатов и CRL.
`Object`	`clone()`	Создаёт копию этого объекта `PKIXParameters`.
`List<PKIXCertPathChecker>`	`getCertPathCheckers()`	Возвращает `List` проверяющих пути сертификации.
`List<CertStore>`	`getCertStores()`	Возвращает неизменяемый `List` `CertStore` для поиска сертификатов и CRL.
`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` для поиска сертификатов и CRL.
`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()`	Возвращает отформатированную строку, описывающую параметры.

Методы, унаследованные от класса java.lang.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 - если любой из элементов в наборе не является типом 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()

Возвращает неизменяемый Set наиболее надёжных центров сертификации.

Возвращает:

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

См. также:

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

См. также:

getInitialPolicies

public Set<String> getInitialPolicies()

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

Возвращает:

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

См. также:

setInitialPolicies

public void setInitialPolicies(Set<String> initialPolicies)

Устанавливает Set идентификаторов начальных политик (строки OID), указывающих, что любой из этих политик будет приемлем для пользователя сертификата для обработки пути сертификации. По умолчанию любая политика приемлема (т. е. все политики), поэтому пользователь, который хочет разрешить приемлемость любой политики, не должен вызывать этот метод, или может вызвать его с пустым Set (или null).

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

Параметры:

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

Исключения:

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

См. также:

setCertStores

public void setCertStores(List<CertStore> stores)

Устанавливает список CertStore для поиска сертификатов и CRL. Может быть null, в этом случае CertStore не будут использоваться. Первые CertStore в списке могут иметь приоритет над последующими.

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

Параметры:

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

Исключения:

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

См. также:

addCertStore

public void addCertStore(CertStore store)

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

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

getCertStores

public List<CertStore> getCertStores()

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

Возвращает:

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

См. также:

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 в противном случае

END_OF_DOCUMENT_MARKER

isPolicyMappingInhibited

public boolean isPolicyMappingInhibited()

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

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

setAnyPolicyInhibited

public void setAnyPolicyInhibited(boolean val)

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

Параметры:: val - true если любой ОИД политики должен быть запрещён, false в противном случае

isAnyPolicyInhibited

public boolean isAnyPolicyInhibited()

Проверяет, должен ли обрабатываться любой ОИД политики, если он включён в сертификат.

Возвращает:: true если любой ОИД политики запрещён, false в противном случае

setPolicyQualifiersRejected

public void setPolicyQualifiersRejected(boolean qualifiersRejected)

Устанавливает флаг PolicyQualifiersRejected. Если этот флаг true, сертификаты, включающие квалификаторы политики в расширении политики сертификата, помеченном как критический, отклоняются. Если флаг false, сертификаты не отклоняются по этому основанию.

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

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

Параметры:

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

См. также:

getPolicyQualifiersRejected

public boolean getPolicyQualifiersRejected()

Возвращает флаг PolicyQualifiersRejected. Если этот флаг true, сертификаты, включающие квалификаторы политики в расширении политики сертификата, помеченном как критический, отклоняются. Если флаг false, сертификаты не отклоняются по этому основанию.

Возвращает:

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

См. также:

getDate

public Date getDate()

Возвращает время, для которого должна быть определена валидность пути сертификации. Если null, используется текущее время.

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

Возвращает:

указанное Date, или null если не задано

См. также:

setDate

public void setDate(Date date)

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

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

Параметры:

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

См. также:

setCertPathCheckers

public void setCertPathCheckers(List<PKIXCertPathChecker> checkers)

Устанавливает список дополнительных проверяющих пути сертификации. Если указанный список List содержит объект, который не является PKIXCertPathChecker, он игнорируется.

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

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

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

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

Параметры:

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

Исключения:

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

См. также:

getCertPathCheckers

public List<PKIXCertPathChecker> getCertPathCheckers()

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

Возвращает:

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

См. также:

addCertPathChecker

public void addCertPathChecker(PKIXCertPathChecker checker)

Добавляет PKIXCertPathChecker в список проверяющих пути сертификации. См. метод setCertPathCheckers для получения более подробной информации.

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

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

getSigProvider

public String getSigProvider()

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

Возвращает:

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

См. также:

setSigProvider

public void setSigProvider(String sigProvider)

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

Параметры:

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

См. также:

getTargetCertConstraints

public CertSelector getTargetCertConstraints()

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

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

Возвращает:

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

См. также:

setTargetCertConstraints

public void setTargetCertConstraints(CertSelector selector)

Устанавливает необходимые ограничения на целевой сертификат. Ограничения задаются как экземпляр CertSelector. Если null, ограничения не определены.

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

Параметры:

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

См. также:

клонировать

public Object clone()

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

Определено:

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

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

clone в классе Object

Возвращает:

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

См. также:

toString

public String toString()

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

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

© 1993, 2023, 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/21/docs/api/java.base/java/security/cert/PKIXParameters.html