Класс 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 Standard Algorithm Names. Обратитесь к документации релиза вашей реализации, чтобы узнать, поддерживаются ли другие алгоритмы.

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

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

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

Since:
1.4
См. также:
CertPath

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

Модификатор Конструктор Описание
protected CertPathBuilder​(CertPathBuilderSpi builderSpi, Provider provider, String algorithm)

Создаёт объект CertPathBuilder заданного алгоритма и инкапсулирует в нём реализацию заданного поставщика (объект SPI).

Методы

Модификатор и тип Метод Описание
CertPathBuilderResult build​(CertPathParameters params)

Попытка построить цепочку сертификатов с использованием заданного набора параметров алгоритма.

String getAlgorithm()

Возвращает имя алгоритма этого CertPathBuilder.

static 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, реализующий заданный алгоритм.

Provider getProvider()

Возвращает поставщика этого CertPathBuilder.

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 Standard Algorithm Names для получения информации об именах стандартных алгоритмов.
Возвращает:
объект 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 Standard Algorithm Names для получения информации об именах стандартных алгоритмов.
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 Standard Algorithm Names для получения информации об именах стандартных алгоритмов.
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, 2020, 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/11/docs/api/java.base/java/security/cert/CertPathBuilder.html

Spec-Zone .ru
спецификации, руководства, описания, API