Module org.eclipse.milo.opcua.stack.core

Package org.eclipse.milo.opcua.stack.core.security

Interface CertificateManager

All Known Implementing Classes:

DefaultCertificateManager

public interface CertificateManager

Method Summary

Modifier and Type	Method	Description
Optional<X509Certificate>	getCertificate(ByteString thumbprint)	Get the X509Certificate identified by thumbprint.
Optional<X509Certificate[]>	getCertificateChain(ByteString thumbprint)	Get the X509Certificate identified by thumbprint as well as any certificates in its chain.
Optional<CertificateGroup>	getCertificateGroup(ByteString thumbprint)	Get the CertificateGroup containing the X509Certificate identified by thumbprint.
Optional<CertificateGroup>	getCertificateGroup(NodeId certificateGroupId)	Get the CertificateGroup identified by certificateGroupId.
List<CertificateGroup>	getCertificateGroups()	Get the CertificateGroups managed by this CertificateManager.
CertificateQuarantine	getCertificateQuarantine()	Get the Server's CertificateQuarantine.
default Optional<CertificateGroup>	getDefaultApplicationGroup()	Get the DefaultApplicationGroup CertificateGroup, if it's configured.
default Optional<CertificateGroup>	getDefaultHttpsGroup()	Get the DefaultHttpsGroup CertificateGroup, if it's configured.
default Optional<CertificateGroup>	getDefaultUserTokenGroup()	Get the DefaultUserTokenGroup CertificateGroup, if it's configured.
Optional<KeyPair>	getKeyPair(ByteString thumbprint)	Get the KeyPair belonging to the certificate identified by thumbprint.

Method Details

getKeyPair

Optional<KeyPair> getKeyPair(ByteString thumbprint)

Get the KeyPair belonging to the certificate identified by thumbprint.

thumbprint is a SHA1 hash of the encoded certificate.

Parameters:

thumbprint - the thumbprint of the certificate.

Returns:

the KeyPair belonging to the certificate identified by thumbprint.

getCertificate

Optional<X509Certificate> getCertificate(ByteString thumbprint)

Get the X509Certificate identified by thumbprint.

thumbprint is a SHA1 hash of the encoded certificate.

Parameters:

thumbprint - the thumbprint of the certificate.

Returns:

the X509Certificate identified by thumbprint.

getCertificateChain

Optional<X509Certificate[]> getCertificateChain(ByteString thumbprint)

Get the X509Certificate identified by thumbprint as well as any certificates in its chain.

Parameters:

thumbprint - the thumbprint of the certificate.

Returns:

the X509Certificate identified by thumbprint as well as any certificates in its chain.

getCertificateGroup

Optional<CertificateGroup> getCertificateGroup(ByteString thumbprint)

Get the CertificateGroup containing the X509Certificate identified by thumbprint.

Parameters:

thumbprint - the thumbprint of the certificate.

Returns:

the CertificateGroup containing the X509Certificate identified by thumbprint.

getCertificateGroup

Optional<CertificateGroup> getCertificateGroup(NodeId certificateGroupId)

Get the CertificateGroup identified by certificateGroupId.

Parameters:

certificateGroupId - the NodeId identifying the CertificateGroup.

Returns:

the CertificateGroup identified by certificateGroupId.

getCertificateGroups

List<CertificateGroup> getCertificateGroups()

Get the CertificateGroups managed by this CertificateManager.

Returns:

the CertificateGroups managed by this CertificateManager.

getCertificateQuarantine

CertificateQuarantine getCertificateQuarantine()

Get the Server's CertificateQuarantine.

Returns:

the Server's CertificateQuarantine.

getDefaultApplicationGroup

default Optional<CertificateGroup> getDefaultApplicationGroup()

Get the DefaultApplicationGroup CertificateGroup, if it's configured.

Servers are required to support the DefaultApplicationGroup CertificateGroup.

Returns:

the DefaultApplicationGroup CertificateGroup, if it's configured.

getDefaultUserTokenGroup

default Optional<CertificateGroup> getDefaultUserTokenGroup()

Get the DefaultUserTokenGroup CertificateGroup, if it's configured.

Support for the DefaultUserTokenGroup CertificateGroup is optional.

Returns:

the DefaultUserTokenGroup CertificateGroup, if it's configured.

getDefaultHttpsGroup

default Optional<CertificateGroup> getDefaultHttpsGroup()

Get the DefaultHttpsGroup CertificateGroup, if it's configured.

Support for the DefaultHttpsGroup CertificateGroup is optional.

Returns:

the DefaultHttpsGroup CertificateGroup, if it's configured.