SOPC_ClientHelper_Security Struct Reference

Connection configuration to a remote OPC server. More...

#include <libs2opc_client_cmds.h>

Data Fields
const char *	security_policy
OpcUa_MessageSecurityMode	security_mode
const char *	path_cert_auth
const char *	path_crl
const char *	path_cert_srv
const char *	path_cert_cli
const char *	path_key_cli
const char *	policyId
const char *	username
const char *	password
const char *	path_cert_x509_token
const char *	path_key_x509_token
bool	key_x509_token_encrypted

Detailed Description

Connection configuration to a remote OPC server.

Deprecated:

This type is deprecated since version 1.5.0 and will be removed in version 1.6.0.

Field Documentation

security_policy

SOPC_ClientHelper_Security::security_policy

The chosen OPC-UA security policy for the connection, one of the SOPC_SecurityPolicy_*_URI string from "sopc_crypto_profiles.h". zero-terminated string

security_mode

SOPC_ClientHelper_Security::security_mode

The chosen OPC-UA security mode for the connection. The list of accepted values is one of the following OpcUa_MessageSecurityMode values:

• OpcUa_MessageSecurityMode_None: no security mode,
• OpcUa_MessageSecurityMode_Sign: only signature,
• OpcUa_MessageSecurityMode_SignAndEncrypt: signature and encryption.

path_cert_auth

SOPC_ClientHelper_Security::path_cert_auth

Zero-terminated path to the root certificate authority in the DER format

path_crl

SOPC_ClientHelper_Security::path_crl

Zero-terminated path to the Certificate Revocation List (CRL) of the certificate authority in the DER format

path_cert_srv

SOPC_ClientHelper_Security::path_cert_srv

Zero-terminated path to the server certificate in the DER format, signed by the root certificate authority

path_cert_cli

SOPC_ClientHelper_Security::path_cert_cli

Zero-terminated path to the client certificate in the DER format, signed by the root certificate authority

path_key_cli

SOPC_ClientHelper_Security::path_key_cli

Zero-terminated path to the client private key which is paired to the public key signed client certificate, in the DER format. Note: if the key is encrypted SOPC_ClientConfigHelper_SetClientKeyPasswordCallback shall be called.

policyId

SOPC_ClientHelper_Security::policyId

Zero-terminated policy id. To know which policy id to use, please read a GetEndpointsResponse or a CreateSessionResponse. AnonymousIdentityToken is used when:

• username, path_cert_x509_token and path_key_x509_token is NULL
• the policy id must correspond to an anonymous UserIdentityPolicy UserNameIdentityToken is used when:
• username is not NULL
• the policy id must correspond to an username UserIdentityPolicy X509IdentityToken is used when:
• username is NULL, path_cert_x509_token and path_key_x509_token is not NULL
• the policy id must correspond to a certificate UserIdentityPolicy

username

SOPC_ClientHelper_Security::username

Zero-terminated username, NULL for anonymous access, see policyId The password will be encrypted, or not, depending on the user token security policy associated to the policyId or if it is empty depending on the SecureChannel security policy.

password

SOPC_ClientHelper_Security::password

Zero-terminated password, ignored when username is NULL. Password is kept in memory for future reconnections.

path_cert_x509_token

SOPC_ClientHelper_Security::path_cert_x509_token

Zero-terminated path to the user x509 certificate, NULL for anonymous access, see policyId

path_key_x509_token

SOPC_ClientHelper_Security::path_key_x509_token

Zero-terminated path to the user private key, NULL for anonymous access, see policyId. Note: if the key is encrypted SOPC_ClientConfigHelper_SetUserKeyPasswordCallback shall be called.

key_x509_token_encrypted

bool SOPC_ClientHelper_Security::key_x509_token_encrypted

---

The documentation for this struct was generated from the following file:

• /builds/systerel/S2OPC/src/ClientServer/frontend/client_wrapper/deprecated/libs2opc_client_cmds.h