| Package | Description |
|---|---|
| com.prosysopc.ua |
Common classes for client and server side.
|
| com.prosysopc.ua.server |
Main server side classes of the SDK.
|
| com.prosysopc.ua.stack.application |
The code in this package is for application developer.
|
| com.prosysopc.ua.stack.transport |
This package contains SecureChannel and related interfaces
|
| com.prosysopc.ua.stack.transport.https |
Code for creating a HTTPS based secure channel
|
| com.prosysopc.ua.stack.transport.security |
This folder contains common security related classes
|
| com.prosysopc.ua.stack.transport.tcp.nio | |
| com.prosysopc.ua.stack.utils |
Utility classes
|
| Modifier and Type | Method and Description |
|---|---|
static KeyPair |
ApplicationIdentity.createHttpsCertificate(ApplicationDescription applicationDecription,
String hostName,
KeyPair issuerKeys)
Deprecated.
this method depends on static state. Call
ApplicationIdentity.createHttpsCertificate(ApplicationDescription, String, KeyPair, int)
instead. |
static KeyPair |
ApplicationIdentity.createHttpsCertificate(ApplicationDescription applicationDecription,
String hostName,
KeyPair issuerKeys,
int keySize)
/** Create certificate and private key to be used for HTTPS
|
static KeyPair |
ApplicationIdentity.createKeyPair(String commonName,
String organisation,
int certificateDays,
KeyPair issuerKeys,
String applicationUri,
int keySize,
String... hostNames)
Create a new Certificate.
|
static KeyPair |
ApplicationIdentity.createKeyPair(String commonName,
String organisation,
int certificateDays,
KeyPair issuerKeys,
String applicationUri,
String... hostNames)
Deprecated.
this method depends on static state. Call
ApplicationIdentity.createKeyPair(String, String, int, KeyPair, String, int, String...)
instead. |
KeyPair[] |
ApplicationIdentity.getCertificates()
The OPC UA Application Instance Certificates of the application.
|
KeyPair |
ApplicationIdentity.getHttpsCertificate()
The HTTPS Certificate (and private key).
|
KeyPair |
SecureIdentity.getKeys() |
protected static KeyPair |
ApplicationIdentity.loadCertificate(String certType,
String privateKeyPassword,
boolean enableRenew,
File certFile,
File privFile,
boolean usePfx) |
static KeyPair |
ApplicationIdentity.loadOrCreateHttpsCertificate(ApplicationDescription applicationDecription,
String hostName,
String privateKeyPassword,
KeyPair issuerKeys,
File path,
boolean enableRenew)
Deprecated.
this method depends on static state. Call
ApplicationIdentity.loadOrCreateHttpsCertificate(ApplicationDescription, String, String, KeyPair, File, boolean, int)
instead. |
static KeyPair |
ApplicationIdentity.loadOrCreateHttpsCertificate(ApplicationDescription applicationDecription,
String hostName,
String privateKeyPassword,
KeyPair issuerKeys,
File path,
boolean enableRenew,
int keySize)
Load certificate and private key from applicationName_https.der & .pem - or create ones if they
do not exist
|
static KeyPair |
ApplicationIdentity.loadOrCreateIssuerCertificate(String issuerName,
File path,
String privateKeyPassword,
int days,
boolean enableRenew)
Load CA certificate and private key from
|
static KeyPair |
ApplicationIdentity.loadOrCreateIssuerCertificate(String issuerName,
File path,
String privateKeyPassword,
int days,
boolean enableRenew,
int keySize)
Load CA certificate and private key from
|
static KeyPair |
ApplicationIdentity.loadOrCreateKeyPair(String applicationName,
String organisation,
File certFile,
File privFile,
String privateKeyPassword,
KeyPair caKeys,
boolean enableRenew,
String applicationUri,
int keySize,
String... hostNames) |
static KeyPair |
ApplicationIdentity.loadOrCreateKeyPair(String applicationName,
String organisation,
File certFile,
File privFile,
String privateKeyPassword,
KeyPair caKeys,
boolean enableRenew,
String applicationUri,
String... hostNames)
Deprecated.
this method depends on static state. Call
ApplicationIdentity.loadOrCreateKeyPair(String, String, File, File, String, KeyPair, boolean, String, int, String...).
instead. |
| Modifier and Type | Method and Description |
|---|---|
static ApplicationIdentity |
ApplicationIdentity.createCertificate(ApplicationDescription applicationDescription,
String organisation,
KeyPair issuerKeys,
int keySize,
String... hostNames)
Create a new Application Identity certificate.
|
static ApplicationIdentity |
ApplicationIdentity.createCertificate(ApplicationDescription applicationDescription,
String organisation,
KeyPair issuerKeys,
String... hostNames)
Deprecated.
this method depend on static state. Call
ApplicationIdentity.createCertificate(ApplicationDescription, String, KeyPair, int, String...)
instead. |
static ApplicationIdentity |
ApplicationIdentity.createCertificate(String applicationName,
String organisation,
KeyPair issuerKeys,
String applicationUri,
int keySize,
String... hostNames)
Create the Application Identity certificate.
|
static ApplicationIdentity |
ApplicationIdentity.createCertificate(String applicationName,
String organisation,
KeyPair issuerKeys,
String applicationUri,
String... hostNames)
Deprecated.
this method depends on static state. Call
ApplicationIdentity.createCertificate(String, String, KeyPair, String, int, String...)
instead. |
static KeyPair |
ApplicationIdentity.createHttpsCertificate(ApplicationDescription applicationDecription,
String hostName,
KeyPair issuerKeys)
Deprecated.
this method depends on static state. Call
ApplicationIdentity.createHttpsCertificate(ApplicationDescription, String, KeyPair, int)
instead. |
static KeyPair |
ApplicationIdentity.createHttpsCertificate(ApplicationDescription applicationDecription,
String hostName,
KeyPair issuerKeys,
int keySize)
/** Create certificate and private key to be used for HTTPS
|
static KeyPair |
ApplicationIdentity.createKeyPair(String commonName,
String organisation,
int certificateDays,
KeyPair issuerKeys,
String applicationUri,
int keySize,
String... hostNames)
Create a new Certificate.
|
static KeyPair |
ApplicationIdentity.createKeyPair(String commonName,
String organisation,
int certificateDays,
KeyPair issuerKeys,
String applicationUri,
String... hostNames)
Deprecated.
this method depends on static state. Call
ApplicationIdentity.createKeyPair(String, String, int, KeyPair, String, int, String...)
instead. |
protected void |
UserIdentity.decryptPassword(UserIdentityToken userIdentityToken,
KeyPair[] serverKeys,
ByteString serverNonce,
Map<String,UserTokenPolicy> policyMap) |
static ApplicationIdentity |
ApplicationIdentity.loadOrCreateCertificate(ApplicationDescription applicationDescription,
String organisation,
String privateKeyPassword,
File path,
KeyPair issuerKeys,
int[] keySizes,
boolean enableRenew,
String... hostNames)
Load the Application Identity certificate, or create a new one and save it.
|
static ApplicationIdentity |
ApplicationIdentity.loadOrCreateCertificate(String applicationName,
String organisation,
File certFile,
File privFile,
String privateKeyPassword,
KeyPair issuerKeys,
boolean enableRenew,
String applicationUri,
int keySize,
String... hostNames)
Load the Application Identity certificate, or create a new one and save it.
|
static ApplicationIdentity |
ApplicationIdentity.loadOrCreateCertificate(String applicationName,
String organisation,
File certFile,
File privFile,
String privateKeyPassword,
KeyPair issuerKeys,
boolean enableRenew,
String applicationUri,
String... hostNames)
Deprecated.
this method depends on static state. Call
ApplicationIdentity.loadOrCreateCertificate(String, String, File, File, String, KeyPair, boolean, String, int, String...)
instead. |
static ApplicationIdentity |
ApplicationIdentity.loadOrCreateCertificate(String applicationName,
String organisation,
String privateKeyPassword,
File path,
KeyPair issuerKeys,
int[] keySizes,
boolean enableRenew,
String applicationUri,
String... hostNames)
Load the Application Identity certificate, or create a new one and save it.
|
protected static ApplicationIdentity |
ApplicationIdentity.loadOrCreateFromProtectedStore(ApplicationDescription applicationDescription,
String organisation,
String privateKeyPassword,
String keystoreLocation,
String keyStorePassword,
KeyPair issuerKeys,
int keySize,
String... hostNames)
Load the Application Identity certificate from a protected key store, or create a new one and
save it to the store.
|
protected static ApplicationIdentity |
ApplicationIdentity.loadOrCreateFromProtectedStore(ApplicationDescription applicationDescription,
String organisation,
String privateKeyPassword,
String keystoreLocation,
String keyStorePassword,
KeyPair issuerKeys,
String... hostNames)
Load the Application Identity certificate from a protected key store, or create a new one and
save it to the store.
|
static KeyPair |
ApplicationIdentity.loadOrCreateHttpsCertificate(ApplicationDescription applicationDecription,
String hostName,
String privateKeyPassword,
KeyPair issuerKeys,
File path,
boolean enableRenew)
Deprecated.
this method depends on static state. Call
ApplicationIdentity.loadOrCreateHttpsCertificate(ApplicationDescription, String, String, KeyPair, File, boolean, int)
instead. |
static KeyPair |
ApplicationIdentity.loadOrCreateHttpsCertificate(ApplicationDescription applicationDecription,
String hostName,
String privateKeyPassword,
KeyPair issuerKeys,
File path,
boolean enableRenew,
int keySize)
Load certificate and private key from applicationName_https.der & .pem - or create ones if they
do not exist
|
static KeyPair |
ApplicationIdentity.loadOrCreateKeyPair(String applicationName,
String organisation,
File certFile,
File privFile,
String privateKeyPassword,
KeyPair caKeys,
boolean enableRenew,
String applicationUri,
int keySize,
String... hostNames) |
static KeyPair |
ApplicationIdentity.loadOrCreateKeyPair(String applicationName,
String organisation,
File certFile,
File privFile,
String privateKeyPassword,
KeyPair caKeys,
boolean enableRenew,
String applicationUri,
String... hostNames)
Deprecated.
this method depends on static state. Call
ApplicationIdentity.loadOrCreateKeyPair(String, String, File, File, String, KeyPair, boolean, String, int, String...).
instead. |
protected static void |
ApplicationIdentity.saveCertificate(String certType,
KeyPair keys,
File certFile,
File privFile,
String privateKeyPassword,
boolean usePfx) |
void |
ApplicationIdentity.setHttpsCertificate(KeyPair httpsCertificate)
The HTTPS Certificate (and private key).
|
| Constructor and Description |
|---|
ApplicationIdentity(KeyPair... keyPairs)
Create an identity with one or more application certificate.
|
| Constructor and Description |
|---|
ServerUserIdentity(SessionManager sessionManager,
UserIdentityToken userIdentityToken,
SignatureData userTokenSignature,
KeyPair[] serverKeys,
ByteString serverNonce,
SecurityPolicy securityPolicy)
Create a new identity from the user token and server keys.
|
ServerUserIdentity(SessionManager sessionManager,
UserIdentityToken userIdentityToken,
SignatureData userTokenSignature,
KeyPair serverKeys,
ByteString serverNonce,
SecurityPolicy securityPolicy)
Create a new identity from the user token and server key.
|
| Modifier and Type | Method and Description |
|---|---|
KeyPair |
Application.getApplicationInstanceCertificate()
getApplicationInstanceCertificate.
|
KeyPair |
Application.getApplicationInstanceCertificate(byte[] thumb)
getApplicationInstanceCertificate.
|
KeyPair[] |
Application.getApplicationInstanceCertificates()
Getter for the field
applicationInstanceCertificates. |
| Modifier and Type | Method and Description |
|---|---|
void |
Application.addApplicationInstanceCertificate(KeyPair cert)
addApplicationInstanceCertificate.
|
static Client |
Client.createClientApplication(KeyPair cert)
createClientApplication.
|
void |
Application.removeApplicationInstanceCertificate(KeyPair applicationInstanceCertificate)
removeApplicationInstanceCertificate.
|
| Modifier and Type | Method and Description |
|---|---|
KeyPair |
ServerSecureChannel.getLocalCertificate()
Get Local Application Instance Certificate
|
| Constructor and Description |
|---|
TransportChannelSettings(EndpointDescription description,
EndpointConfiguration configuration,
KeyPair keypair,
CertificateValidator certValidator,
org.apache.http.conn.ssl.X509HostnameVerifier hostnameVerifier)
Create Transport channel settings for a https connection
|
| Modifier and Type | Method and Description |
|---|---|
KeyPair |
HttpsServerSecureChannel.getLocalCertificate()
getLocalCertificate.
|
| Modifier and Type | Method and Description |
|---|---|
void |
HttpsSettings.setKeyPair(KeyPair keypair,
Cert... caCerts)
Set keypair of a https application.
|
void |
HttpsSettings.setKeyPairs(KeyPair[] keypairs,
Cert... caCerts)
Set keypairs to a https application.
|
| Constructor and Description |
|---|
HttpsSettings(KeyPair keypair,
CertificateValidator certValidator,
org.apache.http.conn.ssl.X509HostnameVerifier hostnameVerifier) |
| Modifier and Type | Method and Description |
|---|---|
KeyPair |
SecurityConfiguration.getLocalKeyPair()
Returns
KeyPair of the local side of the communication (note that for remote side only
the Certificate is available, via #getRemoteCertificate2()). |
static KeyPair |
KeyPair.load(File certificateFile,
File privateKeyFile,
String privateKeyPassword)
Load Certificate and Private key pair from X.509 and keystore file
|
static KeyPair |
KeyPair.load(URL certificateFile,
URL privateKeyFile,
String privateKeyPassword)
Load Certificate and Private key pair from X.509 and keystore file
|
| Modifier and Type | Method and Description |
|---|---|
X509Certificate |
CertificateProvider.generateCertificate(String domainName,
PublicKey publicKey,
PrivateKey privateKey,
KeyPair issuerKeys,
Instant from,
Instant to,
BigInteger serialNumber,
String applicationUri,
String... hostNames) |
X509Certificate |
BcCertificateProvider.generateCertificate(String domainName,
PublicKey publicKey,
PrivateKey privateKey,
KeyPair issuerKeys,
Instant from,
Instant to,
BigInteger serial,
String applicationUri,
String... hostNames)
Generates a new certificate using the Bouncy Castle implementation.
|
X509Certificate |
CertificateProvider.generateIssuerCert(PublicKey publicKey,
PrivateKey privateKey,
KeyPair issuerKeys,
String domainName,
BigInteger serialNumber,
Instant startDate,
Instant expiryDate) |
X509Certificate |
BcCertificateProvider.generateIssuerCert(PublicKey publicKey,
PrivateKey privateKey,
KeyPair issuerKeys,
String commonName,
BigInteger serialNr,
Instant startDate,
Instant expiryDate)
Build a X509 V3 certificate to use as an issuer (CA) certificate.
|
| Constructor and Description |
|---|
SecurityConfiguration(SecurityMode mode,
KeyPair localApplicationInstanceCertificate,
Cert remoteCertificate)
Constructor for SecurityConfiguration.
|
| Modifier and Type | Method and Description |
|---|---|
KeyPair |
OpcTcpServerSecureChannel.getLocalCertificate()
getLocalCertificate.
|
| Modifier and Type | Method and Description |
|---|---|
static KeyPair |
CertificateUtils.createApplicationInstanceCertificate(String commonName,
String organisation,
String applicationUri,
int validityTime,
int keySize,
String... hostNames)
createApplicationInstanceCertificate.
|
static KeyPair |
CertificateUtils.createApplicationInstanceCertificate(String commonName,
String organisation,
String applicationUri,
int validityTime,
KeyPair issuerKeys,
int keySize,
String... hostNames)
createApplicationInstanceCertificate.
|
static KeyPair |
CertificateUtils.createApplicationInstanceCertificate(String commonName,
String organisation,
String applicationUri,
int validityTime,
KeyPair issuerKeys,
String... hostNames)
Deprecated.
this method depends on static state; instead call
CertificateUtils.createApplicationInstanceCertificate(String, String, String, int, com.prosysopc.ua.stack.transport.security.KeyPair, int, String...). |
static KeyPair |
CertificateUtils.createApplicationInstanceCertificate(String commonName,
String organisation,
String applicationUri,
int validityTime,
String... hostNames)
Deprecated.
this method depends on static state, call
CertificateUtils.createApplicationInstanceCertificate(String, String, String, int, int, String...)
instead. |
static KeyPair |
CertificateUtils.createHttpsCertificate(String hostName,
String applicationUri,
int days,
KeyPair issuerCert)
Deprecated.
this method depends on static state. Call
CertificateUtils.createHttpsCertificate(String, String, int, com.prosysopc.ua.stack.transport.security.KeyPair, int)
instead. |
static KeyPair |
CertificateUtils.createHttpsCertificate(String hostName,
String applicationUri,
int days,
KeyPair issuerCert,
int keySize)
Create a new certificate that can be used with the HTTPS protocol.
|
static KeyPair |
CertificateUtils.createIssuerCertificate(String commonName,
int days,
KeyPair issuerCert)
Deprecated.
this method depends on static state. Call
CertificateUtils.createIssuerCertificate(String, int, com.prosysopc.ua.stack.transport.security.KeyPair, int)
instead. |
static KeyPair |
CertificateUtils.createIssuerCertificate(String commonName,
int days,
KeyPair issuerCert,
int keySize)
Create a new issuer certificate that can be used to issue certificates built with
CertificateUtils.createApplicationInstanceCertificate(String, String, String, int, String...) or
CertificateUtils.createHttpsCertificate(String, String, int, com.prosysopc.ua.stack.transport.security.KeyPair). |
static KeyPair |
CertificateUtils.loadKeyPairFromProtectedStore(String storeLocation,
String alias,
String storePW,
String privatePW)
Load a KeyPair from a Java Key Store.
|
static KeyPair |
CertificateUtils.renewApplicationInstanceCertificate(String commonName,
String organisation,
String applicationUri,
int validityTime,
KeyPair oldKeys,
KeyPair issuerKeys,
String... hostNames)
Renew a certificate KeyPair using the old keys.
|
static KeyPair |
CertificateUtils.renewApplicationInstanceCertificate(String commonName,
String organisation,
String applicationUri,
int validityTime,
KeyPair oldKeys,
String... hostNames)
Renew a certificate KeyPair.
|
static KeyPair |
CertificateUtils.toKeyPair(X509Certificate cert,
PrivateKey privateKey)
toKeyPair.
|
| Modifier and Type | Method and Description |
|---|---|
static KeyPair |
CertificateUtils.createApplicationInstanceCertificate(String commonName,
String organisation,
String applicationUri,
int validityTime,
KeyPair issuerKeys,
int keySize,
String... hostNames)
createApplicationInstanceCertificate.
|
static KeyPair |
CertificateUtils.createApplicationInstanceCertificate(String commonName,
String organisation,
String applicationUri,
int validityTime,
KeyPair issuerKeys,
String... hostNames)
Deprecated.
this method depends on static state; instead call
CertificateUtils.createApplicationInstanceCertificate(String, String, String, int, com.prosysopc.ua.stack.transport.security.KeyPair, int, String...). |
static KeyPair |
CertificateUtils.createHttpsCertificate(String hostName,
String applicationUri,
int days,
KeyPair issuerCert)
Deprecated.
this method depends on static state. Call
CertificateUtils.createHttpsCertificate(String, String, int, com.prosysopc.ua.stack.transport.security.KeyPair, int)
instead. |
static KeyPair |
CertificateUtils.createHttpsCertificate(String hostName,
String applicationUri,
int days,
KeyPair issuerCert,
int keySize)
Create a new certificate that can be used with the HTTPS protocol.
|
static KeyPair |
CertificateUtils.createIssuerCertificate(String commonName,
int days,
KeyPair issuerCert)
Deprecated.
this method depends on static state. Call
CertificateUtils.createIssuerCertificate(String, int, com.prosysopc.ua.stack.transport.security.KeyPair, int)
instead. |
static KeyPair |
CertificateUtils.createIssuerCertificate(String commonName,
int days,
KeyPair issuerCert,
int keySize)
Create a new issuer certificate that can be used to issue certificates built with
CertificateUtils.createApplicationInstanceCertificate(String, String, String, int, String...) or
CertificateUtils.createHttpsCertificate(String, String, int, com.prosysopc.ua.stack.transport.security.KeyPair). |
static X509Certificate |
BouncyCastleUtils.generateCertificate(String domainName,
PublicKey publicKey,
PrivateKey privateKey,
KeyPair issuerKeys,
Date from,
Date to,
BigInteger serial,
String applicationUri,
String... hostNames)
Deprecated.
Generates a new certificate using the Bouncy Castle implementation.
|
static X509Certificate |
BouncyCastleUtils.generateIssuerCert(PublicKey publicKey,
PrivateKey privateKey,
KeyPair issuerKeys,
String commonName,
BigInteger serialNr,
Date startDate,
Date expiryDate)
Deprecated.
Build a X509 V3 certificate to use as an issuer (CA) certificate.
|
static KeyPair |
CertificateUtils.renewApplicationInstanceCertificate(String commonName,
String organisation,
String applicationUri,
int validityTime,
KeyPair oldKeys,
KeyPair issuerKeys,
String... hostNames)
Renew a certificate KeyPair using the old keys.
|
static KeyPair |
CertificateUtils.renewApplicationInstanceCertificate(String commonName,
String organisation,
String applicationUri,
int validityTime,
KeyPair oldKeys,
String... hostNames)
Renew a certificate KeyPair.
|
static boolean |
CertificateUtils.saveKeyPairToProtectedStore(KeyPair keyPairToSave,
String storeLocation,
String alias,
String storePW,
String privatePW)
Save the KeyPair to a Java Key Store.
|
Copyright © 2026. All rights reserved.