Spec-Zone.ru › OpenJDK 21

Класс CertPathBuilder

java.lang.Object
java.security.cert.CertPathBuilder
public class CertPathBuilder extends Object
Класс для построения цепочек сертификатов (также известных как цепочки сертификатов).

Этот класс использует архитектуру, основанную на поставщиках. Для создания CertPathBuilder, вызовите один из статических getInstance методов, передав имя алгоритма желаемого CertPathBuilder и, необязательно, имя желаемого поставщика.

После создания объекта CertPathBuilder, цепочки сертификатов можно построить, вызвав метод build и передав ему набор параметров, специфичных для алгоритма. В случае успеха результат (включая построенную CertPath), возвращается в объекте, реализующем интерфейс CertPathBuilderResult.

Метод getRevocationChecker() позволяет приложению указать дополнительные параметры и варианты алгоритма, используемые CertPathBuilder при проверке статуса отзыва сертификатов. Вот пример, демонстрирующий, как это используется с алгоритмом PKIX:

 CertPathBuilder cpb = CertPathBuilder.getInstance("PKIX");
 PKIXRevocationChecker rc = (PKIXRevocationChecker)cpb.getRevocationChecker();
 rc.setOptions(EnumSet.of(Option.PREFER_CRLS));
 params.addCertPathChecker(rc);
 CertPathBuilderResult cpbr = cpb.build(params);
 

Каждая реализация платформы Java обязана поддерживать следующие стандартные CertPathBuilder алгоритмы:

  • PKIX
Этот алгоритм описан в разделе CertPathBuilder спецификации стандартных имён алгоритмов Java Security. Обратитесь к документации выпуска вашей реализации, чтобы узнать, поддерживаются ли какие-либо другие алгоритмы.

Доступность нескольких потоков

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

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

Since:
1.4
See Also:
  • CertPath

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

CertPathBuilder(CertPathBuilderSpi builderSpi, Provider provider, String algorithm)
Модификатор Конструктор Описание
protected
Создаёт объект CertPathBuilder заданного алгоритма и инкапсулирует реализацию данного поставщика (объект SPI) в нём.

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

Модификатор и тип Метод Описание
final CertPathBuilderResult build(CertPathParameters params)
Попытка построить цепочку сертификатов с использованием заданного набора параметров алгоритма.
final String getAlgorithm()
Возвращает имя алгоритма этого CertPathBuilder.
static final String getDefaultType()
Возвращает тип по умолчанию CertPathBuilder как задано certpathbuilder.type свойством безопасности, или строку "PKIX", если такое свойство не существует.
static CertPathBuilder getInstance(String algorithm)
Возвращает объект CertPathBuilder, который реализует указанный алгоритм.
static CertPathBuilder getInstance(String algorithm, String provider)
Возвращает объект CertPathBuilder, который реализует указанный алгоритм.
static CertPathBuilder getInstance(String algorithm, Provider provider)
Возвращает объект CertPathBuilder, который реализует указанный алгоритм.
final Provider getProvider()
Возвращает поставщика этого CertPathBuilder.
final CertPathChecker getRevocationChecker()
Возвращает CertPathChecker, который использует инкапсулированная реализация CertPathBuilderSpi для проверки статуса отзыва сертификатов.

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

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

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

CertPathBuilder

protected CertPathBuilder(CertPathBuilderSpi builderSpi, Provider provider, String algorithm)
Создаёт объект CertPathBuilder заданного алгоритма и инкапсулирует в него заданную реализацию поставщика (объект SPI).
Параметры:
builderSpi - реализация поставщика
provider - поставщик
algorithm - имя алгоритма

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

getInstance

public static CertPathBuilder getInstance(String algorithm) throws NoSuchAlgorithmException
Возвращает объект CertPathBuilder, реализующий указанный алгоритм.

Этот метод перебирает список зарегистрированных поставщиков безопасности, начиная с наиболее предпочтительного. Возвращается новый объект CertPathBuilder, инкапсулирующий реализацию CertPathBuilderSpi из первого поставщика, поддерживающего указанный алгоритм.

Обратите внимание, что список зарегистрированных поставщиков можно получить с помощью метода Security.getProviders().

Описание реализации:
Реализация JDK дополнительно использует свойство jdk.security.provider.preferred Security для определения предпочтительного порядка поставщиков для указанного алгоритма. Этот порядок может отличаться от порядка поставщиков, возвращаемого методом Security.getProviders().
Параметры:
algorithm - имя запрашиваемого алгоритма CertPathBuilder. См. раздел CertPathBuilder в Спецификации стандартных имён алгоритмов Java Security для получения информации о стандартных именах алгоритмов.
Возвращает:
объект CertPathBuilder, реализующий указанный алгоритм
Исключения:
NoSuchAlgorithmException - если ни один поставщик Provider не поддерживает реализацию CertPathBuilderSpi для указанного алгоритма
NullPointerException - если algorithm является null
См. также:
  • Provider

getInstance

public static CertPathBuilder getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException
Возвращает объект CertPathBuilder, реализующий указанный алгоритм.

Возвращается новый объект CertPathBuilder, инкапсулирующий реализацию CertPathBuilderSpi от указанного поставщика. Указанный поставщик должен быть зарегистрирован в списке поставщиков безопасности.

Обратите внимание, что список зарегистрированных поставщиков можно получить с помощью метода Security.getProviders().

Параметры:
algorithm - имя запрашиваемого алгоритма CertPathBuilder. См. раздел CertPathBuilder в Спецификации стандартных имён алгоритмов Java Security для получения информации о стандартных именах алгоритмов.
provider - имя поставщика.
Возвращает:
объект CertPathBuilder, реализующий указанный алгоритм
Исключения:
IllegalArgumentException - если provider является null или пустым
NoSuchAlgorithmException - если реализация CertPathBuilderSpi для указанного алгоритма недоступна от указанного поставщика
NoSuchProviderException - если указанный поставщик не зарегистрирован в списке поставщиков безопасности
NullPointerException - если algorithm является null
См. также:
  • Provider

getInstance

public static CertPathBuilder getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException
Возвращает объект CertPathBuilder, реализующий указанный алгоритм.

Возвращается новый объект CertPathBuilder, инкапсулирующий реализацию CertPathBuilderSpi от указанного объекта Provider. Обратите внимание, что указанный объект Provider не обязательно должен быть зарегистрирован в списке поставщиков.

Параметры:
algorithm - имя запрашиваемого алгоритма CertPathBuilder. См. раздел CertPathBuilder в Спецификации стандартных имён алгоритмов Java Security для получения информации о стандартных именах алгоритмов.
provider - поставщик.
Возвращает:
объект CertPathBuilder, реализующий указанный алгоритм
Исключения:
IllegalArgumentException - если provider является null
NoSuchAlgorithmException - если реализация CertPathBuilderSpi для указанного алгоритма недоступна от указанного объекта Provider
NullPointerException - если algorithm является null
См. также:
  • Provider

getProvider

public final Provider getProvider()
Возвращает поставщика этого CertPathBuilder.
Возвращает:
поставщик этого CertPathBuilder

getAlgorithm

public final String getAlgorithm()
Возвращает имя алгоритма этого CertPathBuilder.
Возвращает:
имя алгоритма этого CertPathBuilder

build

public final CertPathBuilderResult build(CertPathParameters params) throws CertPathBuilderException, InvalidAlgorithmParameterException
Попытка построить сертификационный путь, используя заданный набор параметров алгоритма.
Параметры:
params - параметры алгоритма
Возвращает:
результат алгоритма построения
Исключения:
CertPathBuilderException - если создатель не может построить сертификационный путь, удовлетворяющий заданным параметрам
InvalidAlgorithmParameterException - если заданные параметры неподходят для этого CertPathBuilder

getDefaultType

public static final String getDefaultType()
Возвращает тип по умолчанию CertPathBuilder как задано свойством безопасности certpathbuilder.type, или строку "PKIX", если такое свойство не существует.

Тип по умолчанию CertPathBuilder может использоваться приложениями, которые не хотят использовать жёстко заданный тип при вызове одного из методов getInstance, и хотят предоставить тип по умолчанию в случае, если пользователь не укажет свой собственный.

Тип по умолчанию CertPathBuilder можно изменить, задав значение свойства безопасности certpathbuilder.type желаемому типу.

Возвращает:
тип по умолчанию CertPathBuilder как задано свойством безопасности certpathbuilder.type, или строку "PKIX", если такое свойство не существует.
См. также:
  • security properties

getRevocationChecker

public final CertPathChecker getRevocationChecker()
Возвращает CertPathChecker, который использует реализация CertPathBuilderSpi для проверки статуса отзыва сертификатов. Реализация PKIX возвращает объекты типа PKIXRevocationChecker. Каждый вызов этого метода возвращает новый экземпляр CertPathChecker.

Основная цель этого метода — позволить вызывающим сторонам указывать дополнительные входные параметры и опции, специфичные для проверки отзыва. См. описание класса для примера.

Возвращает:
CertPathChecker
Исключения:
UnsupportedOperationException - если поставщик услуг не поддерживает этот метод
С тех пор:
1.8

© 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/CertPathBuilder.html

Spec-Zone.ru

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