niklas/cyclonedds
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Config file doc generator parsing of RELOFF construct

Browse source 
Signed-off-by: Erik Boasson <eb@ilities.com>
This commit is contained in:
Erik Boasson 2020-01-20 15:28:46 +01:00 • committed by eboasson
parent 03b8c51332
commit 9481a75e9d
4 changed files with 259 additions and 300 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/makernc.pl
View file

@ -626,7 +626,7 @@ sub read_config {
# skip reference to internal name (either ABSOFF(field), # skip reference to internal name (either ABSOFF(field),
# RELOFF(field,field) or <int>,<int> (the latter being used by # RELOFF(field,field) or <int>,<int> (the latter being used by
# "verbosity") # "verbosity")
$rest =~ s/(ABSOFF *\( *[A-Za-z_0-9.]+ *\)|RELOFF *\( *[A-Za-z_0-9.]+ *, *[A-Za-z_0-9]+ *\)|[0-9]+ *, *[0-9]+) *, *//; $rest =~ s/(ABSOFF *\( *[A-Za-z_0-9.]+ *\)|RELOFF *\( *[A-Za-z_0-9.]+ *, *[A-Za-z_0-9. ]+\)|[0-9]+ *, *[0-9]+) *, *//;
# skip init function # skip init function
$rest =~ s/([A-Za-z_0-9]+|0) *, *//; $rest =~ s/([A-Za-z_0-9]+|0) *, *//;
# type hint from conversion function # type hint from conversion function

98
docs/manual/options.md
View file

@ -117,8 +117,7 @@ specification.
##### //CycloneDDS/Domain/DDSSecurity/AccessControl/Governance ##### //CycloneDDS/Domain/DDSSecurity/AccessControl/Governance
Text
RELOFF (cfg.access_control_properties.governance), pf_string, BLURB("
URI to the shared Governance Document signed by the Permissions CA in URI to the shared Governance Document signed by the Permissions CA in
S/MIME format S/MIME format
@ -168,38 +167,39 @@ MIIDuAYJKoZIhv ...al5s=
------F9A8A198D6F08E1285A292ADF14DD04F-]]</Governance> ------F9A8A198D6F08E1285A292ADF14DD04F-]]</Governance>
The default value is: "".
##### //CycloneDDS/Domain/DDSSecurity/AccessControl/Library ##### //CycloneDDS/Domain/DDSSecurity/AccessControl/Library
Children: [finalizeFunction](#cycloneddsdomainddssecurityaccesscontrollibraryfinalizefunction), [initFunction](#cycloneddsdomainddssecurityaccesscontrollibraryinitfunction), [path](#cycloneddsdomainddssecurityaccesscontrollibrarypath) Attributes: [finalizeFunction](#cycloneddsdomainddssecurityaccesscontrollibraryfinalizefunction), [initFunction](#cycloneddsdomainddssecurityaccesscontrollibraryinitfunction), [path](#cycloneddsdomainddssecurityaccesscontrollibrarypath)
RELOFF (cfg.access_control_plugin), pf_string, BLURB("
This element specifies the library to be loaded as the DDS Security This element specifies the library to be loaded as the DDS Security
Access Control plugin. Access Control plugin.
###### //CycloneDDS/Domain/DDSSecurity/AccessControl/Library/finalizeFunction ##### //CycloneDDS/Domain/DDSSecurity/AccessControl/Library[@finalizeFunction]
Text
RELOFF (cfg.access_control_plugin.library_finalize), pf_string, BLURB("
This element names the finalization function of Access Control plugin. This element names the finalization function of Access Control plugin.
This function is called to let the plugin release its resources. This function is called to let the plugin release its resources.
The default value is: "finalize_access_control".
###### //CycloneDDS/Domain/DDSSecurity/AccessControl/Library/initFunction
RELOFF (cfg.access_control_plugin.library_init), pf_string, BLURB(" ##### //CycloneDDS/Domain/DDSSecurity/AccessControl/Library[@initFunction]
Text
This element names the initialization function of Access Control plugin. This element names the initialization function of Access Control plugin.
This function is called after loading the plugin library for This function is called after loading the plugin library for
instantiation purposes. Init function must return an object that instantiation purposes. Init function must return an object that
implements DDS Security Access Control interface. implements DDS Security Access Control interface.
The default value is: "init_access_control".
###### //CycloneDDS/Domain/DDSSecurity/AccessControl/Library/path
RELOFF (cfg.access_control_plugin.library_path), pf_string, BLURB(" ##### //CycloneDDS/Domain/DDSSecurity/AccessControl/Library[@path]
Text
This element points to the path of Access Control plugin library. This element points to the path of Access Control plugin library.
@ -211,10 +211,11 @@ If single file is supplied, the library located by way of the current
working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for
Windows systems. Windows systems.
The default value is: "dds_security_ac".
##### //CycloneDDS/Domain/DDSSecurity/AccessControl/Permissions ##### //CycloneDDS/Domain/DDSSecurity/AccessControl/Permissions
Text
RELOFF (cfg.access_control_properties.permissions), pf_string, BLURB("
URI to the DomainParticipant permissions document signed by the URI to the DomainParticipant permissions document signed by the
Permissions CA in S/MIME format Permissions CA in S/MIME format
@ -232,10 +233,11 @@ Example data URI:
<Permissions><![CDATA[data:,.........]]</Permissions> <Permissions><![CDATA[data:,.........]]</Permissions>
The default value is: "".
##### //CycloneDDS/Domain/DDSSecurity/AccessControl/PermissionsCA ##### //CycloneDDS/Domain/DDSSecurity/AccessControl/PermissionsCA
Text
RELOFF (cfg.access_control_properties.permissions_ca), pf_string, BLURB("
URI to a X509 certificate for the PermissionsCA in PEM format. URI to a X509 certificate for the PermissionsCA in PEM format.
@ -256,6 +258,8 @@ MIIC3DCCAcQCCQCWE5x+Z ... PhovK0mp2ohhRLYI0ZiyYQ==
-----END CERTIFICATE-----</PermissionsCA> -----END CERTIFICATE-----</PermissionsCA>
The default value is: "".
#### //CycloneDDS/Domain/DDSSecurity/Authentication #### //CycloneDDS/Domain/DDSSecurity/Authentication
Children: [IdentityCA](#cycloneddsdomainddssecurityauthenticationidentityca), [IdentityCertificate](#cycloneddsdomainddssecurityauthenticationidentitycertificate), [Library](#cycloneddsdomainddssecurityauthenticationlibrary), [Password](#cycloneddsdomainddssecurityauthenticationpassword), [PrivateKey](#cycloneddsdomainddssecurityauthenticationprivatekey), [TrustedCADirectory](#cycloneddsdomainddssecurityauthenticationtrustedcadirectory) Children: [IdentityCA](#cycloneddsdomainddssecurityauthenticationidentityca), [IdentityCertificate](#cycloneddsdomainddssecurityauthenticationidentitycertificate), [Library](#cycloneddsdomainddssecurityauthenticationlibrary), [Password](#cycloneddsdomainddssecurityauthenticationpassword), [PrivateKey](#cycloneddsdomainddssecurityauthenticationprivatekey), [TrustedCADirectory](#cycloneddsdomainddssecurityauthenticationtrustedcadirectory)
@ -266,8 +270,7 @@ specification.
##### //CycloneDDS/Domain/DDSSecurity/Authentication/IdentityCA ##### //CycloneDDS/Domain/DDSSecurity/Authentication/IdentityCA
Text
RELOFF (cfg.authentication_properties.identity_ca), pf_string, BLURB("
URI to the X509 certificate [39] of the Identity CA that is the signer of URI to the X509 certificate [39] of the Identity CA that is the signer of
Identity Certificate. Identity Certificate.
@ -289,9 +292,7 @@ MIIC3DCCAcQCCQCWE5x+Z...PhovK0mp2ohhRLYI0ZiyYQ==<br>
##### //CycloneDDS/Domain/DDSSecurity/Authentication/IdentityCertificate ##### //CycloneDDS/Domain/DDSSecurity/Authentication/IdentityCertificate
Text
RELOFF (cfg.authentication_properties.identity_certificate), pf_string,
BLURB("
Identity certificate that will be used for identifying all participants Identity certificate that will be used for identifying all participants
in the OSPL instance.<br>The content is URI to a X509 certificate signed in the OSPL instance.<br>The content is URI to a X509 certificate signed
@ -311,36 +312,35 @@ MIIDjjCCAnYCCQDCEu9...6rmT87dhTo=<br>
##### //CycloneDDS/Domain/DDSSecurity/Authentication/Library ##### //CycloneDDS/Domain/DDSSecurity/Authentication/Library
Children: [finalizeFunction](#cycloneddsdomainddssecurityauthenticationlibraryfinalizefunction), [initFunction](#cycloneddsdomainddssecurityauthenticationlibraryinitfunction), [path](#cycloneddsdomainddssecurityauthenticationlibrarypath) Attributes: [finalizeFunction](#cycloneddsdomainddssecurityauthenticationlibraryfinalizefunction), [initFunction](#cycloneddsdomainddssecurityauthenticationlibraryinitfunction), [path](#cycloneddsdomainddssecurityauthenticationlibrarypath)
RELOFF (cfg.authentication_plugin), pf_string, BLURB("
This element specifies the library to be loaded as the DDS Security This element specifies the library to be loaded as the DDS Security
Access Control plugin. Access Control plugin.
###### //CycloneDDS/Domain/DDSSecurity/Authentication/Library/finalizeFunction ##### //CycloneDDS/Domain/DDSSecurity/Authentication/Library[@finalizeFunction]
Text
RELOFF (cfg.authentication_plugin.library_finalize), pf_string, BLURB("
This element names the finalization function of Authentication plugin. This element names the finalization function of Authentication plugin.
This function is called to let the plugin release its resources. This function is called to let the plugin release its resources.
The default value is: "finalize_authentication".
###### //CycloneDDS/Domain/DDSSecurity/Authentication/Library/initFunction
RELOFF (cfg.authentication_plugin.library_init), pf_string, BLURB(" ##### //CycloneDDS/Domain/DDSSecurity/Authentication/Library[@initFunction]
Text
This element names the initialization function of Authentication plugin. This element names the initialization function of Authentication plugin.
This function is called after loading the plugin library for This function is called after loading the plugin library for
instantiation purposes. Init function must return an object that instantiation purposes. Init function must return an object that
implements DDS Security Authentication interface. implements DDS Security Authentication interface.
The default value is: "init_authentication".
###### //CycloneDDS/Domain/DDSSecurity/Authentication/Library/path
RELOFF (cfg.authentication_plugin.library_path), pf_string, BLURB(" ##### //CycloneDDS/Domain/DDSSecurity/Authentication/Library[@path]
Text
This element points to the path of Authentication plugin library. This element points to the path of Authentication plugin library.
@ -352,10 +352,11 @@ If single file is supplied, the library located by way of the current
working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for
Windows systems. Windows systems.
The default value is: "dds_security_auth".
##### //CycloneDDS/Domain/DDSSecurity/Authentication/Password ##### //CycloneDDS/Domain/DDSSecurity/Authentication/Password
Text
RELOFF (cfg.authentication_properties.password), pf_string, BLURB("
A password used to decrypt the private_key. A password used to decrypt the private_key.
@ -366,10 +367,11 @@ using AES128-CBC.
If the password property is not present, then the value supplied in the If the password property is not present, then the value supplied in the
private_key property must contain the unencrypted private key. private_key property must contain the unencrypted private key.
The default value is: "".
##### //CycloneDDS/Domain/DDSSecurity/Authentication/PrivateKey ##### //CycloneDDS/Domain/DDSSecurity/Authentication/PrivateKey
Text
RELOFF (cfg.authentication_properties.private_key), pf_string, BLURB("
URI to access the private Private Key for all of the participants in the URI to access the private Private Key for all of the participants in the
OSPL federation. OSPL federation.
@ -388,12 +390,13 @@ MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg==<br>
##### //CycloneDDS/Domain/DDSSecurity/Authentication/TrustedCADirectory ##### //CycloneDDS/Domain/DDSSecurity/Authentication/TrustedCADirectory
Text
RELOFF (cfg.authentication_properties.trusted_ca_dir), pf_string, BLURB("
Trusted CA Directory which contains trusted CA certificates as separated Trusted CA Directory which contains trusted CA certificates as separated
files. files.
The default value is: "".
#### //CycloneDDS/Domain/DDSSecurity/Cryptographic #### //CycloneDDS/Domain/DDSSecurity/Cryptographic
Children: [Library](#cycloneddsdomainddssecuritycryptographiclibrary) Children: [Library](#cycloneddsdomainddssecuritycryptographiclibrary)
@ -404,36 +407,35 @@ specification.
##### //CycloneDDS/Domain/DDSSecurity/Cryptographic/Library ##### //CycloneDDS/Domain/DDSSecurity/Cryptographic/Library
Children: [finalizeFunction](#cycloneddsdomainddssecuritycryptographiclibraryfinalizefunction), [initFunction](#cycloneddsdomainddssecuritycryptographiclibraryinitfunction), [path](#cycloneddsdomainddssecuritycryptographiclibrarypath) Attributes: [finalizeFunction](#cycloneddsdomainddssecuritycryptographiclibraryfinalizefunction), [initFunction](#cycloneddsdomainddssecuritycryptographiclibraryinitfunction), [path](#cycloneddsdomainddssecuritycryptographiclibrarypath)
RELOFF (cfg.cryptography_plugin), pf_string, BLURB("
This element specifies the library to be loaded as the DDS Security This element specifies the library to be loaded as the DDS Security
Cryptographic plugin. Cryptographic plugin.
###### //CycloneDDS/Domain/DDSSecurity/Cryptographic/Library/finalizeFunction ##### //CycloneDDS/Domain/DDSSecurity/Cryptographic/Library[@finalizeFunction]
Text
RELOFF (cfg.cryptography_plugin.library_finalize), pf_string, BLURB("
This element names the finalization function of Cryptographic plugin. This element names the finalization function of Cryptographic plugin.
This function is called to let the plugin release its resources. This function is called to let the plugin release its resources.
The default value is: "finalize_crypto".
###### //CycloneDDS/Domain/DDSSecurity/Cryptographic/Library/initFunction
RELOFF (cfg.cryptography_plugin.library_init), pf_string, BLURB(" ##### //CycloneDDS/Domain/DDSSecurity/Cryptographic/Library[@initFunction]
Text
This element names the initialization function of Cryptographic plugin. This element names the initialization function of Cryptographic plugin.
This function is called after loading the plugin library for This function is called after loading the plugin library for
instantiation purposes. Init function must return an object that instantiation purposes. Init function must return an object that
implements DDS Security Cryptographic interface. implements DDS Security Cryptographic interface.
The default value is: "init_crypto".
###### //CycloneDDS/Domain/DDSSecurity/Cryptographic/Library/path
RELOFF (cfg.cryptography_plugin.library_path), pf_string, BLURB(" ##### //CycloneDDS/Domain/DDSSecurity/Cryptographic/Library[@path]
Text
This element points to the path of Cryptographic plugin library. This element points to the path of Cryptographic plugin library.
@ -445,6 +447,8 @@ If single file is supplied, the library located by way of the current
working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for
Windows systems. Windows systems.
The default value is: "dds_security_crypto".
### //CycloneDDS/Domain/Discovery ### //CycloneDDS/Domain/Discovery
Children: [DSGracePeriod](#cycloneddsdomaindiscoverydsgraceperiod), [DefaultMulticastAddress](#cycloneddsdomaindiscoverydefaultmulticastaddress), [EnableTopicDiscovery](#cycloneddsdomaindiscoveryenabletopicdiscovery), [ExternalDomainId](#cycloneddsdomaindiscoveryexternaldomainid), [MaxAutoParticipantIndex](#cycloneddsdomaindiscoverymaxautoparticipantindex), [ParticipantIndex](#cycloneddsdomaindiscoveryparticipantindex), [Peers](#cycloneddsdomaindiscoverypeers), [Ports](#cycloneddsdomaindiscoveryports), [SPDPInterval](#cycloneddsdomaindiscoveryspdpinterval), [SPDPMulticastAddress](#cycloneddsdomaindiscoveryspdpmulticastaddress), [Tag](#cycloneddsdomaindiscoverytag) Children: [DSGracePeriod](#cycloneddsdomaindiscoverydsgraceperiod), [DefaultMulticastAddress](#cycloneddsdomaindiscoverydefaultmulticastaddress), [EnableTopicDiscovery](#cycloneddsdomaindiscoveryenabletopicdiscovery), [ExternalDomainId](#cycloneddsdomaindiscoveryexternaldomainid), [MaxAutoParticipantIndex](#cycloneddsdomaindiscoverymaxautoparticipantindex), [ParticipantIndex](#cycloneddsdomaindiscoveryparticipantindex), [Peers](#cycloneddsdomaindiscoverypeers), [Ports](#cycloneddsdomaindiscoveryports), [SPDPInterval](#cycloneddsdomaindiscoveryspdpinterval), [SPDPMulticastAddress](#cycloneddsdomaindiscoveryspdpmulticastaddress), [Tag](#cycloneddsdomaindiscoverytag)

191
etc/cyclonedds.rnc
View file

@ -90,9 +90,8 @@ specification plugins and settings.</p>""" ] ]
specification.</p>""" ] ] specification.</p>""" ] ]
element AccessControl { element AccessControl {
[ a:documentation [ xml:lang="en" """ [ a:documentation [ xml:lang="en" """
RELOFF (cfg.access_control_properties.governance), pf_string, <p>URI to the shared Governance Document signed by the Permissions CA in
BLURB("<p>URI to the shared Governance Document signed by the Permissions S/MIME format</p>
CA in S/MIME format</p>
<p>URI schemes: file, data</p><br> <p>URI schemes: file, data</p><br>
@ -138,36 +137,34 @@ boundary="----F9A8A198D6F08E1285A292ADF14DD04F"</p>
<p>MIIDuAYJKoZIhv ...al5s=</p> <p>MIIDuAYJKoZIhv ...al5s=</p>
<p>------F9A8A198D6F08E1285A292ADF14DD04F-]]</Governance></p>""" ] ] <p>------F9A8A198D6F08E1285A292ADF14DD04F-]]</Governance></p><p>The
default value is: &quot;&quot;.</p>""" ] ]
element Governance { element Governance {
empty text
}? }?
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.access_control_plugin), pf_string, BLURB("<p>This element <p>This element specifies the library to be loaded as the DDS Security
specifies the library to be loaded as the DDS Security Access Control Access Control plugin.</p>""" ] ]
plugin.</p>""" ] ]
element Library { element Library {
[ a:documentation [ xml:lang="en" """ [ a:documentation [ xml:lang="en" """
RELOFF (cfg.access_control_plugin.library_finalize), pf_string, <p>This element names the finalization function of Access Control plugin.
BLURB("<p>This element names the finalization function of Access Control This function is called to let the plugin release its
plugin. This function is called to let the plugin release its resources.</p><p>The default value is:
resources.</p>""" ] ] &quot;finalize_access_control&quot;.</p>""" ] ]
element finalizeFunction { attribute finalizeFunction {
empty text
}? }?
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.access_control_plugin.library_init), pf_string, <p>This element names the initialization function of Access Control
BLURB("<p>This element names the initialization function of Access plugin. This function is called after loading the plugin library for
Control plugin. This function is called after loading the plugin library instantiation purposes. Init function must return an object that
for instantiation purposes. Init function must return an object that implements DDS Security Access Control interface.</p><p>The default value
implements DDS Security Access Control interface.</p>""" ] ] is: &quot;init_access_control&quot;.</p>""" ] ]
element initFunction { attribute initFunction {
empty text
}? }?
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.access_control_plugin.library_path), pf_string, <p>This element points to the path of Access Control plugin library.</p>
BLURB("<p>This element points to the path of Access Control plugin
library.</p>
<p>It can be either absolute path excluding file extension ( <p>It can be either absolute path excluding file extension (
/usr/lib/dds_security_ac ) or single file without extension ( /usr/lib/dds_security_ac ) or single file without extension (
@ -175,14 +172,14 @@ dds_security_ac ).</p>
<p>If single file is supplied, the library located by way of the current <p>If single file is supplied, the library located by way of the current
working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for
Windows systems.</p>""" ] ] Windows systems.</p><p>The default value is:
element path { &quot;dds_security_ac&quot;.</p>""" ] ]
empty attribute path {
text
}? }?
}? }?
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.access_control_properties.permissions), pf_string, <p>URI to the DomainParticipant permissions document signed by the
BLURB("<p>URI to the DomainParticipant permissions document signed by the
Permissions CA in S/MIME format</p> Permissions CA in S/MIME format</p>
<p>The permissions document specifies the permissions to be applied to a <p>The permissions document specifies the permissions to be applied to a
@ -196,14 +193,13 @@ domain.</p><br>
<p>Example data URI:</p> <p>Example data URI:</p>
<p><Permissions><![CDATA[data:,.........]]</Permissions></p>""" ] ] <p><Permissions><![CDATA[data:,.........]]</Permissions></p><p>The
default value is: &quot;&quot;.</p>""" ] ]
element Permissions { element Permissions {
empty text
}? }?
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.access_control_properties.permissions_ca), pf_string, <p>URI to a X509 certificate for the PermissionsCA in PEM format.</p>
BLURB("<p>URI to a X509 certificate for the PermissionsCA in PEM
format.</p>
<p>Supported URI schemes: file, data</p> <p>Supported URI schemes: file, data</p>
@ -220,9 +216,10 @@ X.509 v3 ITU-T Recommendation X.509 (2005) [39]) in PEM format.</p><br>
<p>MIIC3DCCAcQCCQCWE5x+Z ... PhovK0mp2ohhRLYI0ZiyYQ==</p> <p>MIIC3DCCAcQCCQCWE5x+Z ... PhovK0mp2ohhRLYI0ZiyYQ==</p>
<p>-----END CERTIFICATE-----</PermissionsCA></p>""" ] ] <p>-----END CERTIFICATE-----</PermissionsCA></p><p>The default value is:
&quot;&quot;.</p>""" ] ]
element PermissionsCA { element PermissionsCA {
empty text
}? }?
}? }?
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
@ -230,9 +227,8 @@ X.509 v3 ITU-T Recommendation X.509 (2005) [39]) in PEM format.</p><br>
specification.</p>""" ] ] specification.</p>""" ] ]
element Authentication { element Authentication {
[ a:documentation [ xml:lang="en" """ [ a:documentation [ xml:lang="en" """
RELOFF (cfg.authentication_properties.identity_ca), pf_string, <p>URI to the X509 certificate [39] of the Identity CA that is the signer
BLURB("<p>URI to the X509 certificate [39] of the Identity CA that is the of Identity Certificate.</p>
signer of Identity Certificate.</p>
<p>Supported URI schemes: file, data</p> <p>Supported URI schemes: file, data</p>
@ -249,11 +245,10 @@ MIIC3DCCAcQCCQCWE5x+Z...PhovK0mp2ohhRLYI0ZiyYQ==<br>
-----END CERTIFICATE-----</IdentityCA></p>""" ] ] -----END CERTIFICATE-----</IdentityCA></p>""" ] ]
element IdentityCA { element IdentityCA {
empty text
}? }
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.authentication_properties.identity_certificate), pf_string, <p>Identity certificate that will be used for identifying all
BLURB("<p>Identity certificate that will be used for identifying all
participants in the OSPL instance.<br>The content is URI to a X509 participants in the OSPL instance.<br>The content is URI to a X509
certificate signed by the IdentityCA in PEM format containing the signed certificate signed by the IdentityCA in PEM format containing the signed
public key.</p> public key.</p>
@ -270,34 +265,31 @@ MIIDjjCCAnYCCQDCEu9...6rmT87dhTo=<br>
-----END CERTIFICATE-----</IdentityCertificate></p>""" ] ] -----END CERTIFICATE-----</IdentityCertificate></p>""" ] ]
element IdentityCertificate { element IdentityCertificate {
empty text
}? }
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.authentication_plugin), pf_string, BLURB("<p>This element <p>This element specifies the library to be loaded as the DDS Security
specifies the library to be loaded as the DDS Security Access Control Access Control plugin.</p>""" ] ]
plugin.</p>""" ] ]
element Library { element Library {
[ a:documentation [ xml:lang="en" """ [ a:documentation [ xml:lang="en" """
RELOFF (cfg.authentication_plugin.library_finalize), pf_string, <p>This element names the finalization function of Authentication plugin.
BLURB("<p>This element names the finalization function of Authentication This function is called to let the plugin release its
plugin. This function is called to let the plugin release its resources.</p><p>The default value is:
resources.</p>""" ] ] &quot;finalize_authentication&quot;.</p>""" ] ]
element finalizeFunction { attribute finalizeFunction {
empty text
}? }?
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.authentication_plugin.library_init), pf_string, <p>This element names the initialization function of Authentication
BLURB("<p>This element names the initialization function of plugin. This function is called after loading the plugin library for
Authentication plugin. This function is called after loading the plugin instantiation purposes. Init function must return an object that
library for instantiation purposes. Init function must return an object implements DDS Security Authentication interface.</p><p>The default value
that implements DDS Security Authentication interface.</p>""" ] ] is: &quot;init_authentication&quot;.</p>""" ] ]
element initFunction { attribute initFunction {
empty text
}? }?
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.authentication_plugin.library_path), pf_string, <p>This element points to the path of Authentication plugin library.</p>
BLURB("<p>This element points to the path of Authentication plugin
library.</p>
<p>It can be either absolute path excluding file extension ( <p>It can be either absolute path excluding file extension (
/usr/lib/dds_security_auth ) or single file without extension ( /usr/lib/dds_security_auth ) or single file without extension (
@ -305,28 +297,28 @@ dds_security_auth ).</p>
<p>If single file is supplied, the library located by way of the current <p>If single file is supplied, the library located by way of the current
working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for
Windows systems.</p>""" ] ] Windows systems.</p><p>The default value is:
element path { &quot;dds_security_auth&quot;.</p>""" ] ]
empty attribute path {
text
}? }?
}? }?
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.authentication_properties.password), pf_string, BLURB("<p>A <p>A password used to decrypt the private_key.</p>
password used to decrypt the private_key.</p>
The value of the password property shall be interpreted as the Base64 The value of the password property shall be interpreted as the Base64
encoding of the AES-128 key that shall be used to decrypt the private_key encoding of the AES-128 key that shall be used to decrypt the private_key
using AES128-CBC.</p> using AES128-CBC.</p>
If the password property is not present, then the value supplied in the If the password property is not present, then the value supplied in the
private_key property must contain the unencrypted private key. </p>""" ] ] private_key property must contain the unencrypted private key. </p><p>The
default value is: &quot;&quot;.</p>""" ] ]
element Password { element Password {
empty text
}? }?
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.authentication_properties.private_key), pf_string, <p>URI to access the private Private Key for all of the participants in
BLURB("<p>URI to access the private Private Key for all of the the OSPL federation.</p>
participants in the OSPL federation.</p>
<p>Supported URI schemes: file, data</p> <p>Supported URI schemes: file, data</p>
@ -340,14 +332,13 @@ MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg==<br>
-----END RSA PRIVATE KEY-----</PrivateKey></p>""" ] ] -----END RSA PRIVATE KEY-----</PrivateKey></p>""" ] ]
element PrivateKey { element PrivateKey {
empty text
}? }
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.authentication_properties.trusted_ca_dir), pf_string, <p>Trusted CA Directory which contains trusted CA certificates as
BLURB("<p>Trusted CA Directory which contains trusted CA certificates as separated files.</p><p>The default value is: &quot;&quot;.</p>""" ] ]
separated files.</p>""" ] ]
element TrustedCADirectory { element TrustedCADirectory {
empty text
}? }?
}? }?
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
@ -355,30 +346,27 @@ separated files.</p>""" ] ]
specification.</p>""" ] ] specification.</p>""" ] ]
element Cryptographic { element Cryptographic {
[ a:documentation [ xml:lang="en" """ [ a:documentation [ xml:lang="en" """
RELOFF (cfg.cryptography_plugin), pf_string, BLURB("<p>This element <p>This element specifies the library to be loaded as the DDS Security
specifies the library to be loaded as the DDS Security Cryptographic Cryptographic plugin.</p>""" ] ]
plugin.</p>""" ] ]
element Library { element Library {
[ a:documentation [ xml:lang="en" """ [ a:documentation [ xml:lang="en" """
RELOFF (cfg.cryptography_plugin.library_finalize), pf_string, <p>This element names the finalization function of Cryptographic plugin.
BLURB("<p>This element names the finalization function of Cryptographic This function is called to let the plugin release its
plugin. This function is called to let the plugin release its resources.</p><p>The default value is: &quot;finalize_crypto&quot;.</p>""" ] ]
resources.</p>""" ] ] attribute finalizeFunction {
element finalizeFunction { text
empty
}? }?
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.cryptography_plugin.library_init), pf_string, BLURB("<p>This <p>This element names the initialization function of Cryptographic
element names the initialization function of Cryptographic plugin. This plugin. This function is called after loading the plugin library for
function is called after loading the plugin library for instantiation instantiation purposes. Init function must return an object that
purposes. Init function must return an object that implements DDS implements DDS Security Cryptographic interface.</p><p>The default value
Security Cryptographic interface.</p>""" ] ] is: &quot;init_crypto&quot;.</p>""" ] ]
element initFunction { attribute initFunction {
empty text
}? }?
& [ a:documentation [ xml:lang="en" """ & [ a:documentation [ xml:lang="en" """
RELOFF (cfg.cryptography_plugin.library_path), pf_string, BLURB("<p>This <p>This element points to the path of Cryptographic plugin library.</p>
element points to the path of Cryptographic plugin library.</p>
<p>It can be either absolute path excluding file extension ( <p>It can be either absolute path excluding file extension (
/usr/lib/dds_security_crypto ) or single file without extension ( /usr/lib/dds_security_crypto ) or single file without extension (
@ -386,9 +374,10 @@ dds_security_crypto ).</p>
<p>If single file is supplied, the library located by way of the current <p>If single file is supplied, the library located by way of the current
working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for
Windows systems.</p>""" ] ] Windows systems.</p><p>The default value is:
element path { &quot;dds_security_crypto&quot;.</p>""" ] ]
empty attribute path {
text
}? }?
}? }?
}? }?

214
etc/cyclonedds.xsd
View file

@ -173,39 +173,33 @@ specification.&lt;/p&gt;</xs:documentation>
<xs:element minOccurs="0" name="Library"> <xs:element minOccurs="0" name="Library">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.access_control_plugin), pf_string, BLURB("&lt;p&gt;This element &lt;p&gt;This element specifies the library to be loaded as the DDS Security
specifies the library to be loaded as the DDS Security Access Control Access Control plugin.&lt;/p&gt;</xs:documentation>
plugin.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType> <xs:complexType>
<xs:all> <xs:attribute name="finalizeFunction">
<xs:element minOccurs="0" name="finalizeFunction">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.access_control_plugin.library_finalize), pf_string, &lt;p&gt;This element names the finalization function of Access Control plugin.
BLURB("&lt;p&gt;This element names the finalization function of Access Control This function is called to let the plugin release its
plugin. This function is called to let the plugin release its resources.&lt;/p&gt;&lt;p&gt;The default value is:
resources.&lt;/p&gt;</xs:documentation> &amp;quot;finalize_access_control&amp;quot;.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/> </xs:attribute>
</xs:element> <xs:attribute name="initFunction">
<xs:element minOccurs="0" name="initFunction">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.access_control_plugin.library_init), pf_string, &lt;p&gt;This element names the initialization function of Access Control
BLURB("&lt;p&gt;This element names the initialization function of Access plugin. This function is called after loading the plugin library for
Control plugin. This function is called after loading the plugin library instantiation purposes. Init function must return an object that
for instantiation purposes. Init function must return an object that implements DDS Security Access Control interface.&lt;/p&gt;&lt;p&gt;The default value
implements DDS Security Access Control interface.&lt;/p&gt;</xs:documentation> is: &amp;quot;init_access_control&amp;quot;.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/> </xs:attribute>
</xs:element> <xs:attribute name="path">
<xs:element minOccurs="0" name="path">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.access_control_plugin.library_path), pf_string, &lt;p&gt;This element points to the path of Access Control plugin library.&lt;/p&gt;
BLURB("&lt;p&gt;This element points to the path of Access Control plugin
library.&lt;/p&gt;
&lt;p&gt;It can be either absolute path excluding file extension ( &lt;p&gt;It can be either absolute path excluding file extension (
/usr/lib/dds_security_ac ) or single file without extension ( /usr/lib/dds_security_ac ) or single file without extension (
@ -213,11 +207,10 @@ dds_security_ac ).&lt;/p&gt;
&lt;p&gt;If single file is supplied, the library located by way of the current &lt;p&gt;If single file is supplied, the library located by way of the current
working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for
Windows systems.&lt;/p&gt;</xs:documentation> Windows systems.&lt;/p&gt;&lt;p&gt;The default value is:
&amp;quot;dds_security_ac&amp;quot;.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/> </xs:attribute>
</xs:element>
</xs:all>
</xs:complexType> </xs:complexType>
</xs:element> </xs:element>
<xs:element minOccurs="0" ref="config:Permissions"/> <xs:element minOccurs="0" ref="config:Permissions"/>
@ -225,12 +218,11 @@ Windows systems.&lt;/p&gt;</xs:documentation>
</xs:all> </xs:all>
</xs:complexType> </xs:complexType>
</xs:element> </xs:element>
<xs:element name="Governance"> <xs:element name="Governance" type="xs:string">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.access_control_properties.governance), pf_string, &lt;p&gt;URI to the shared Governance Document signed by the Permissions CA in
BLURB("&lt;p&gt;URI to the shared Governance Document signed by the Permissions S/MIME format&lt;/p&gt;
CA in S/MIME format&lt;/p&gt;
&lt;p&gt;URI schemes: file, data&lt;/p&gt;&lt;br&gt; &lt;p&gt;URI schemes: file, data&lt;/p&gt;&lt;br&gt;
@ -276,15 +268,14 @@ boundary="----F9A8A198D6F08E1285A292ADF14DD04F"&lt;/p&gt;
&lt;p&gt;MIIDuAYJKoZIhv ...al5s=&lt;/p&gt; &lt;p&gt;MIIDuAYJKoZIhv ...al5s=&lt;/p&gt;
&lt;p&gt;------F9A8A198D6F08E1285A292ADF14DD04F-]]&lt;/Governance&gt;&lt;/p&gt;</xs:documentation> &lt;p&gt;------F9A8A198D6F08E1285A292ADF14DD04F-]]&lt;/Governance&gt;&lt;/p&gt;&lt;p&gt;The
default value is: &amp;quot;&amp;quot;.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/>
</xs:element> </xs:element>
<xs:element name="Permissions"> <xs:element name="Permissions" type="xs:string">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.access_control_properties.permissions), pf_string, &lt;p&gt;URI to the DomainParticipant permissions document signed by the
BLURB("&lt;p&gt;URI to the DomainParticipant permissions document signed by the
Permissions CA in S/MIME format&lt;/p&gt; Permissions CA in S/MIME format&lt;/p&gt;
&lt;p&gt;The permissions document specifies the permissions to be applied to a &lt;p&gt;The permissions document specifies the permissions to be applied to a
@ -298,16 +289,14 @@ domain.&lt;/p&gt;&lt;br&gt;
&lt;p&gt;Example data URI:&lt;/p&gt; &lt;p&gt;Example data URI:&lt;/p&gt;
&lt;p&gt;&lt;Permissions&gt;&lt;![CDATA[data:,.........]]&lt;/Permissions&gt;&lt;/p&gt;</xs:documentation> &lt;p&gt;&lt;Permissions&gt;&lt;![CDATA[data:,.........]]&lt;/Permissions&gt;&lt;/p&gt;&lt;p&gt;The
default value is: &amp;quot;&amp;quot;.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/>
</xs:element> </xs:element>
<xs:element name="PermissionsCA"> <xs:element name="PermissionsCA" type="xs:string">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.access_control_properties.permissions_ca), pf_string, &lt;p&gt;URI to a X509 certificate for the PermissionsCA in PEM format.&lt;/p&gt;
BLURB("&lt;p&gt;URI to a X509 certificate for the PermissionsCA in PEM
format.&lt;/p&gt;
&lt;p&gt;Supported URI schemes: file, data&lt;/p&gt; &lt;p&gt;Supported URI schemes: file, data&lt;/p&gt;
@ -324,9 +313,9 @@ X.509 v3 ITU-T Recommendation X.509 (2005) [39]) in PEM format.&lt;/p&gt;&lt;br&
&lt;p&gt;MIIC3DCCAcQCCQCWE5x+Z ... PhovK0mp2ohhRLYI0ZiyYQ==&lt;/p&gt; &lt;p&gt;MIIC3DCCAcQCCQCWE5x+Z ... PhovK0mp2ohhRLYI0ZiyYQ==&lt;/p&gt;
&lt;p&gt;-----END CERTIFICATE-----&lt;/PermissionsCA&gt;&lt;/p&gt;</xs:documentation> &lt;p&gt;-----END CERTIFICATE-----&lt;/PermissionsCA&gt;&lt;/p&gt;&lt;p&gt;The default value is:
&amp;quot;&amp;quot;.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/>
</xs:element> </xs:element>
<xs:element name="Authentication"> <xs:element name="Authentication">
<xs:annotation> <xs:annotation>
@ -336,44 +325,38 @@ specification.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType> <xs:complexType>
<xs:all> <xs:all>
<xs:element minOccurs="0" ref="config:IdentityCA"/> <xs:element ref="config:IdentityCA"/>
<xs:element minOccurs="0" ref="config:IdentityCertificate"/> <xs:element ref="config:IdentityCertificate"/>
<xs:element minOccurs="0" name="Library"> <xs:element minOccurs="0" name="Library">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.authentication_plugin), pf_string, BLURB("&lt;p&gt;This element &lt;p&gt;This element specifies the library to be loaded as the DDS Security
specifies the library to be loaded as the DDS Security Access Control Access Control plugin.&lt;/p&gt;</xs:documentation>
plugin.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType> <xs:complexType>
<xs:all> <xs:attribute name="finalizeFunction">
<xs:element minOccurs="0" name="finalizeFunction">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.authentication_plugin.library_finalize), pf_string, &lt;p&gt;This element names the finalization function of Authentication plugin.
BLURB("&lt;p&gt;This element names the finalization function of Authentication This function is called to let the plugin release its
plugin. This function is called to let the plugin release its resources.&lt;/p&gt;&lt;p&gt;The default value is:
resources.&lt;/p&gt;</xs:documentation> &amp;quot;finalize_authentication&amp;quot;.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/> </xs:attribute>
</xs:element> <xs:attribute name="initFunction">
<xs:element minOccurs="0" name="initFunction">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.authentication_plugin.library_init), pf_string, &lt;p&gt;This element names the initialization function of Authentication
BLURB("&lt;p&gt;This element names the initialization function of plugin. This function is called after loading the plugin library for
Authentication plugin. This function is called after loading the plugin instantiation purposes. Init function must return an object that
library for instantiation purposes. Init function must return an object implements DDS Security Authentication interface.&lt;/p&gt;&lt;p&gt;The default value
that implements DDS Security Authentication interface.&lt;/p&gt;</xs:documentation> is: &amp;quot;init_authentication&amp;quot;.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/> </xs:attribute>
</xs:element> <xs:attribute name="path">
<xs:element minOccurs="0" name="path">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.authentication_plugin.library_path), pf_string, &lt;p&gt;This element points to the path of Authentication plugin library.&lt;/p&gt;
BLURB("&lt;p&gt;This element points to the path of Authentication plugin
library.&lt;/p&gt;
&lt;p&gt;It can be either absolute path excluding file extension ( &lt;p&gt;It can be either absolute path excluding file extension (
/usr/lib/dds_security_auth ) or single file without extension ( /usr/lib/dds_security_auth ) or single file without extension (
@ -381,25 +364,23 @@ dds_security_auth ).&lt;/p&gt;
&lt;p&gt;If single file is supplied, the library located by way of the current &lt;p&gt;If single file is supplied, the library located by way of the current
working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for
Windows systems.&lt;/p&gt;</xs:documentation> Windows systems.&lt;/p&gt;&lt;p&gt;The default value is:
&amp;quot;dds_security_auth&amp;quot;.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/> </xs:attribute>
</xs:element>
</xs:all>
</xs:complexType> </xs:complexType>
</xs:element> </xs:element>
<xs:element minOccurs="0" ref="config:Password"/> <xs:element minOccurs="0" ref="config:Password"/>
<xs:element minOccurs="0" ref="config:PrivateKey"/> <xs:element ref="config:PrivateKey"/>
<xs:element minOccurs="0" ref="config:TrustedCADirectory"/> <xs:element minOccurs="0" ref="config:TrustedCADirectory"/>
</xs:all> </xs:all>
</xs:complexType> </xs:complexType>
</xs:element> </xs:element>
<xs:element name="IdentityCA"> <xs:element name="IdentityCA" type="xs:string">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.authentication_properties.identity_ca), pf_string, &lt;p&gt;URI to the X509 certificate [39] of the Identity CA that is the signer
BLURB("&lt;p&gt;URI to the X509 certificate [39] of the Identity CA that is the of Identity Certificate.&lt;/p&gt;
signer of Identity Certificate.&lt;/p&gt;
&lt;p&gt;Supported URI schemes: file, data&lt;/p&gt; &lt;p&gt;Supported URI schemes: file, data&lt;/p&gt;
@ -416,13 +397,11 @@ MIIC3DCCAcQCCQCWE5x+Z...PhovK0mp2ohhRLYI0ZiyYQ==&lt;br&gt;
-----END CERTIFICATE-----&lt;/IdentityCA&gt;&lt;/p&gt;</xs:documentation> -----END CERTIFICATE-----&lt;/IdentityCA&gt;&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/>
</xs:element> </xs:element>
<xs:element name="IdentityCertificate"> <xs:element name="IdentityCertificate" type="xs:string">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.authentication_properties.identity_certificate), pf_string, &lt;p&gt;Identity certificate that will be used for identifying all
BLURB("&lt;p&gt;Identity certificate that will be used for identifying all
participants in the OSPL instance.&lt;br&gt;The content is URI to a X509 participants in the OSPL instance.&lt;br&gt;The content is URI to a X509
certificate signed by the IdentityCA in PEM format containing the signed certificate signed by the IdentityCA in PEM format containing the signed
public key.&lt;/p&gt; public key.&lt;/p&gt;
@ -439,29 +418,26 @@ MIIDjjCCAnYCCQDCEu9...6rmT87dhTo=&lt;br&gt;
-----END CERTIFICATE-----&lt;/IdentityCertificate&gt;&lt;/p&gt;</xs:documentation> -----END CERTIFICATE-----&lt;/IdentityCertificate&gt;&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/>
</xs:element> </xs:element>
<xs:element name="Password"> <xs:element name="Password" type="xs:string">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.authentication_properties.password), pf_string, BLURB("&lt;p&gt;A &lt;p&gt;A password used to decrypt the private_key.&lt;/p&gt;
password used to decrypt the private_key.&lt;/p&gt;
The value of the password property shall be interpreted as the Base64 The value of the password property shall be interpreted as the Base64
encoding of the AES-128 key that shall be used to decrypt the private_key encoding of the AES-128 key that shall be used to decrypt the private_key
using AES128-CBC.&lt;/p&gt; using AES128-CBC.&lt;/p&gt;
If the password property is not present, then the value supplied in the If the password property is not present, then the value supplied in the
private_key property must contain the unencrypted private key. &lt;/p&gt;</xs:documentation> private_key property must contain the unencrypted private key. &lt;/p&gt;&lt;p&gt;The
default value is: &amp;quot;&amp;quot;.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/>
</xs:element> </xs:element>
<xs:element name="PrivateKey"> <xs:element name="PrivateKey" type="xs:string">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.authentication_properties.private_key), pf_string, &lt;p&gt;URI to access the private Private Key for all of the participants in
BLURB("&lt;p&gt;URI to access the private Private Key for all of the the OSPL federation.&lt;/p&gt;
participants in the OSPL federation.&lt;/p&gt;
&lt;p&gt;Supported URI schemes: file, data&lt;/p&gt; &lt;p&gt;Supported URI schemes: file, data&lt;/p&gt;
@ -475,16 +451,13 @@ MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg==&lt;br&gt;
-----END RSA PRIVATE KEY-----&lt;/PrivateKey&gt;&lt;/p&gt;</xs:documentation> -----END RSA PRIVATE KEY-----&lt;/PrivateKey&gt;&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/>
</xs:element> </xs:element>
<xs:element name="TrustedCADirectory"> <xs:element name="TrustedCADirectory" type="xs:string">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.authentication_properties.trusted_ca_dir), pf_string, &lt;p&gt;Trusted CA Directory which contains trusted CA certificates as
BLURB("&lt;p&gt;Trusted CA Directory which contains trusted CA certificates as separated files.&lt;/p&gt;&lt;p&gt;The default value is: &amp;quot;&amp;quot;.&lt;/p&gt;</xs:documentation>
separated files.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/>
</xs:element> </xs:element>
<xs:element name="Cryptographic"> <xs:element name="Cryptographic">
<xs:annotation> <xs:annotation>
@ -497,38 +470,32 @@ specification.&lt;/p&gt;</xs:documentation>
<xs:element minOccurs="0" name="Library"> <xs:element minOccurs="0" name="Library">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.cryptography_plugin), pf_string, BLURB("&lt;p&gt;This element &lt;p&gt;This element specifies the library to be loaded as the DDS Security
specifies the library to be loaded as the DDS Security Cryptographic Cryptographic plugin.&lt;/p&gt;</xs:documentation>
plugin.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType> <xs:complexType>
<xs:all> <xs:attribute name="finalizeFunction">
<xs:element minOccurs="0" name="finalizeFunction">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.cryptography_plugin.library_finalize), pf_string, &lt;p&gt;This element names the finalization function of Cryptographic plugin.
BLURB("&lt;p&gt;This element names the finalization function of Cryptographic This function is called to let the plugin release its
plugin. This function is called to let the plugin release its resources.&lt;/p&gt;&lt;p&gt;The default value is: &amp;quot;finalize_crypto&amp;quot;.&lt;/p&gt;</xs:documentation>
resources.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/> </xs:attribute>
</xs:element> <xs:attribute name="initFunction">
<xs:element minOccurs="0" name="initFunction">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.cryptography_plugin.library_init), pf_string, BLURB("&lt;p&gt;This &lt;p&gt;This element names the initialization function of Cryptographic
element names the initialization function of Cryptographic plugin. This plugin. This function is called after loading the plugin library for
function is called after loading the plugin library for instantiation instantiation purposes. Init function must return an object that
purposes. Init function must return an object that implements DDS implements DDS Security Cryptographic interface.&lt;/p&gt;&lt;p&gt;The default value
Security Cryptographic interface.&lt;/p&gt;</xs:documentation> is: &amp;quot;init_crypto&amp;quot;.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/> </xs:attribute>
</xs:element> <xs:attribute name="path">
<xs:element minOccurs="0" name="path">
<xs:annotation> <xs:annotation>
<xs:documentation> <xs:documentation>
RELOFF (cfg.cryptography_plugin.library_path), pf_string, BLURB("&lt;p&gt;This &lt;p&gt;This element points to the path of Cryptographic plugin library.&lt;/p&gt;
element points to the path of Cryptographic plugin library.&lt;/p&gt;
&lt;p&gt;It can be either absolute path excluding file extension ( &lt;p&gt;It can be either absolute path excluding file extension (
/usr/lib/dds_security_crypto ) or single file without extension ( /usr/lib/dds_security_crypto ) or single file without extension (
@ -536,11 +503,10 @@ dds_security_crypto ).&lt;/p&gt;
&lt;p&gt;If single file is supplied, the library located by way of the current &lt;p&gt;If single file is supplied, the library located by way of the current
working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for working directory, or LD_LIBRARY_PATH for Unix systems, and PATH for
Windows systems.&lt;/p&gt;</xs:documentation> Windows systems.&lt;/p&gt;&lt;p&gt;The default value is:
&amp;quot;dds_security_crypto&amp;quot;.&lt;/p&gt;</xs:documentation>
</xs:annotation> </xs:annotation>
<xs:complexType/> </xs:attribute>
</xs:element>
</xs:all>
</xs:complexType> </xs:complexType>
</xs:element> </xs:element>
</xs:sequence> </xs:sequence>