From 9481a75e9d77216f19875149309c488a2004753a Mon Sep 17 00:00:00 2001 From: Erik Boasson Date: Mon, 20 Jan 2020 15:28:46 +0100 Subject: [PATCH] Config file doc generator parsing of RELOFF construct Signed-off-by: Erik Boasson --- docs/makernc.pl | 2 +- docs/manual/options.md | 98 +++++++-------- etc/cyclonedds.rnc | 191 ++++++++++++++--------------- etc/cyclonedds.xsd | 268 ++++++++++++++++++----------------------- 4 files changed, 259 insertions(+), 300 deletions(-) diff --git a/docs/makernc.pl b/docs/makernc.pl index 1fad42f..0de6a8e 100644 --- a/docs/makernc.pl +++ b/docs/makernc.pl @@ -626,7 +626,7 @@ sub read_config { # skip reference to internal name (either ABSOFF(field), # RELOFF(field,field) or , (the latter being used by # "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 $rest =~ s/([A-Za-z_0-9]+|0) *, *//; # type hint from conversion function diff --git a/docs/manual/options.md b/docs/manual/options.md index 98c0166..f875c77 100644 --- a/docs/manual/options.md +++ b/docs/manual/options.md @@ -117,8 +117,7 @@ specification. ##### //CycloneDDS/Domain/DDSSecurity/AccessControl/Governance - -RELOFF (cfg.access_control_properties.governance), pf_string, BLURB(" +Text URI to the shared Governance Document signed by the Permissions CA in S/MIME format @@ -168,38 +167,39 @@ MIIDuAYJKoZIhv ...al5s= ------F9A8A198D6F08E1285A292ADF14DD04F-]] +The default value is: "". + ##### //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 Access Control plugin. -###### //CycloneDDS/Domain/DDSSecurity/AccessControl/Library/finalizeFunction - -RELOFF (cfg.access_control_plugin.library_finalize), pf_string, BLURB(" +##### //CycloneDDS/Domain/DDSSecurity/AccessControl/Library[@finalizeFunction] +Text This element names the finalization function of Access Control plugin. 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 function is called after loading the plugin library for instantiation purposes. Init function must return an object that 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. @@ -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 Windows systems. +The default value is: "dds_security_ac". + ##### //CycloneDDS/Domain/DDSSecurity/AccessControl/Permissions - -RELOFF (cfg.access_control_properties.permissions), pf_string, BLURB(" +Text URI to the DomainParticipant permissions document signed by the Permissions CA in S/MIME format @@ -232,10 +233,11 @@ Example data URI: +The default value is: "". + ##### //CycloneDDS/Domain/DDSSecurity/AccessControl/PermissionsCA - -RELOFF (cfg.access_control_properties.permissions_ca), pf_string, BLURB(" +Text URI to a X509 certificate for the PermissionsCA in PEM format. @@ -256,6 +258,8 @@ MIIC3DCCAcQCCQCWE5x+Z ... PhovK0mp2ohhRLYI0ZiyYQ== -----END CERTIFICATE----- +The default value is: "". + #### //CycloneDDS/Domain/DDSSecurity/Authentication Children: [IdentityCA](#cycloneddsdomainddssecurityauthenticationidentityca), [IdentityCertificate](#cycloneddsdomainddssecurityauthenticationidentitycertificate), [Library](#cycloneddsdomainddssecurityauthenticationlibrary), [Password](#cycloneddsdomainddssecurityauthenticationpassword), [PrivateKey](#cycloneddsdomainddssecurityauthenticationprivatekey), [TrustedCADirectory](#cycloneddsdomainddssecurityauthenticationtrustedcadirectory) @@ -266,8 +270,7 @@ specification. ##### //CycloneDDS/Domain/DDSSecurity/Authentication/IdentityCA - -RELOFF (cfg.authentication_properties.identity_ca), pf_string, BLURB(" +Text URI to the X509 certificate [39] of the Identity CA that is the signer of Identity Certificate. @@ -289,9 +292,7 @@ MIIC3DCCAcQCCQCWE5x+Z...PhovK0mp2ohhRLYI0ZiyYQ==
##### //CycloneDDS/Domain/DDSSecurity/Authentication/IdentityCertificate - -RELOFF (cfg.authentication_properties.identity_certificate), pf_string, -BLURB(" +Text Identity certificate that will be used for identifying all participants in the OSPL instance.
The content is URI to a X509 certificate signed @@ -311,36 +312,35 @@ MIIDjjCCAnYCCQDCEu9...6rmT87dhTo=
##### //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 Access Control plugin. -###### //CycloneDDS/Domain/DDSSecurity/Authentication/Library/finalizeFunction - -RELOFF (cfg.authentication_plugin.library_finalize), pf_string, BLURB(" +##### //CycloneDDS/Domain/DDSSecurity/Authentication/Library[@finalizeFunction] +Text This element names the finalization function of Authentication plugin. 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 function is called after loading the plugin library for instantiation purposes. Init function must return an object that 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. @@ -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 Windows systems. +The default value is: "dds_security_auth". + ##### //CycloneDDS/Domain/DDSSecurity/Authentication/Password - -RELOFF (cfg.authentication_properties.password), pf_string, BLURB(" +Text 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 private_key property must contain the unencrypted private key. +The default value is: "". + ##### //CycloneDDS/Domain/DDSSecurity/Authentication/PrivateKey - -RELOFF (cfg.authentication_properties.private_key), pf_string, BLURB(" +Text URI to access the private Private Key for all of the participants in the OSPL federation. @@ -388,12 +390,13 @@ MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg==
##### //CycloneDDS/Domain/DDSSecurity/Authentication/TrustedCADirectory - -RELOFF (cfg.authentication_properties.trusted_ca_dir), pf_string, BLURB(" +Text Trusted CA Directory which contains trusted CA certificates as separated files. +The default value is: "". + #### //CycloneDDS/Domain/DDSSecurity/Cryptographic Children: [Library](#cycloneddsdomainddssecuritycryptographiclibrary) @@ -404,36 +407,35 @@ specification. ##### //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 Cryptographic plugin. -###### //CycloneDDS/Domain/DDSSecurity/Cryptographic/Library/finalizeFunction - -RELOFF (cfg.cryptography_plugin.library_finalize), pf_string, BLURB(" +##### //CycloneDDS/Domain/DDSSecurity/Cryptographic/Library[@finalizeFunction] +Text This element names the finalization function of Cryptographic plugin. 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 function is called after loading the plugin library for instantiation purposes. Init function must return an object that 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. @@ -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 Windows systems. +The default value is: "dds_security_crypto". + ### //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) diff --git a/etc/cyclonedds.rnc b/etc/cyclonedds.rnc index 3a73819..eac2679 100644 --- a/etc/cyclonedds.rnc +++ b/etc/cyclonedds.rnc @@ -90,9 +90,8 @@ specification plugins and settings.

""" ] ] specification.

""" ] ] element AccessControl { [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.access_control_properties.governance), pf_string, -BLURB("

URI to the shared Governance Document signed by the Permissions -CA in S/MIME format

+

URI to the shared Governance Document signed by the Permissions CA in +S/MIME format

URI schemes: file, data


@@ -138,36 +137,34 @@ boundary="----F9A8A198D6F08E1285A292ADF14DD04F"

MIIDuAYJKoZIhv ...al5s=

-

------F9A8A198D6F08E1285A292ADF14DD04F-]]

""" ] ] +

------F9A8A198D6F08E1285A292ADF14DD04F-]]

The +default value is: "".

""" ] ] element Governance { - empty + text }? & [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.access_control_plugin), pf_string, BLURB("

This element -specifies the library to be loaded as the DDS Security Access Control -plugin.

""" ] ] +

This element specifies the library to be loaded as the DDS Security +Access Control plugin.

""" ] ] element Library { [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.access_control_plugin.library_finalize), pf_string, -BLURB("

This element names the finalization function of Access Control -plugin. This function is called to let the plugin release its -resources.

""" ] ] - element finalizeFunction { - empty +

This element names the finalization function of Access Control plugin. +This function is called to let the plugin release its +resources.

The default value is: +"finalize_access_control".

""" ] ] + attribute finalizeFunction { + text }? & [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.access_control_plugin.library_init), pf_string, -BLURB("

This element names the initialization function of Access -Control plugin. This function is called after loading the plugin library -for instantiation purposes. Init function must return an object that -implements DDS Security Access Control interface.

""" ] ] - element initFunction { - empty +

This element names the initialization function of Access Control +plugin. This function is called after loading the plugin library for +instantiation purposes. Init function must return an object that +implements DDS Security Access Control interface.

The default value +is: "init_access_control".

""" ] ] + attribute initFunction { + text }? & [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.access_control_plugin.library_path), pf_string, -BLURB("

This element points to the path of Access Control plugin -library.

+

This element points to the path of Access Control plugin library.

It can be either absolute path excluding file extension ( /usr/lib/dds_security_ac ) or single file without extension ( @@ -175,14 +172,14 @@ dds_security_ac ).

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 -Windows systems.

""" ] ] - element path { - empty +Windows systems.

The default value is: +"dds_security_ac".

""" ] ] + attribute path { + text }? }? & [ a:documentation [ xml:lang="en" """ -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

The permissions document specifies the permissions to be applied to a @@ -196,14 +193,13 @@ domain.


Example data URI:

-

""" ] ] +

The +default value is: "".

""" ] ] element Permissions { - empty + text }? & [ a:documentation [ xml:lang="en" """ -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.

Supported URI schemes: file, data

@@ -220,9 +216,10 @@ X.509 v3 ITU-T Recommendation X.509 (2005) [39]) in PEM format.


MIIC3DCCAcQCCQCWE5x+Z ... PhovK0mp2ohhRLYI0ZiyYQ==

-

-----END CERTIFICATE-----

""" ] ] +

-----END CERTIFICATE-----

The default value is: +"".

""" ] ] element PermissionsCA { - empty + text }? }? & [ a:documentation [ xml:lang="en" """ @@ -230,9 +227,8 @@ X.509 v3 ITU-T Recommendation X.509 (2005) [39]) in PEM format.


specification.

""" ] ] element Authentication { [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.authentication_properties.identity_ca), pf_string, -BLURB("

URI to the X509 certificate [39] of the Identity CA that is the -signer of Identity Certificate.

+

URI to the X509 certificate [39] of the Identity CA that is the signer +of Identity Certificate.

Supported URI schemes: file, data

@@ -249,11 +245,10 @@ MIIC3DCCAcQCCQCWE5x+Z...PhovK0mp2ohhRLYI0ZiyYQ==
-----END CERTIFICATE-----

""" ] ] element IdentityCA { - empty - }? + text + } & [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.authentication_properties.identity_certificate), pf_string, -BLURB("

Identity certificate that will be used for identifying all +

Identity certificate that will be used for identifying all participants in the OSPL instance.
The content is URI to a X509 certificate signed by the IdentityCA in PEM format containing the signed public key.

@@ -270,34 +265,31 @@ MIIDjjCCAnYCCQDCEu9...6rmT87dhTo=
-----END CERTIFICATE-----

""" ] ] element IdentityCertificate { - empty - }? + text + } & [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.authentication_plugin), pf_string, BLURB("

This element -specifies the library to be loaded as the DDS Security Access Control -plugin.

""" ] ] +

This element specifies the library to be loaded as the DDS Security +Access Control plugin.

""" ] ] element Library { [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.authentication_plugin.library_finalize), pf_string, -BLURB("

This element names the finalization function of Authentication -plugin. This function is called to let the plugin release its -resources.

""" ] ] - element finalizeFunction { - empty +

This element names the finalization function of Authentication plugin. +This function is called to let the plugin release its +resources.

The default value is: +"finalize_authentication".

""" ] ] + attribute finalizeFunction { + text }? & [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.authentication_plugin.library_init), pf_string, -BLURB("

This element names the initialization function of -Authentication plugin. This function is called after loading the plugin -library for instantiation purposes. Init function must return an object -that implements DDS Security Authentication interface.

""" ] ] - element initFunction { - empty +

This element names the initialization function of Authentication +plugin. This function is called after loading the plugin library for +instantiation purposes. Init function must return an object that +implements DDS Security Authentication interface.

The default value +is: "init_authentication".

""" ] ] + attribute initFunction { + text }? & [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.authentication_plugin.library_path), pf_string, -BLURB("

This element points to the path of Authentication plugin -library.

+

This element points to the path of Authentication plugin library.

It can be either absolute path excluding file extension ( /usr/lib/dds_security_auth ) or single file without extension ( @@ -305,28 +297,28 @@ dds_security_auth ).

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 -Windows systems.

""" ] ] - element path { - empty +Windows systems.

The default value is: +"dds_security_auth".

""" ] ] + attribute path { + text }? }? & [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.authentication_properties.password), pf_string, BLURB("

A -password used to decrypt the private_key.

+

A password used to decrypt the private_key.

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 using AES128-CBC.

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: "".

""" ] ] element Password { - empty + text }? & [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.authentication_properties.private_key), pf_string, -BLURB("

URI to access the private Private Key for all of the -participants in the OSPL federation.

+

URI to access the private Private Key for all of the participants in +the OSPL federation.

Supported URI schemes: file, data

@@ -340,14 +332,13 @@ MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg==
-----END RSA PRIVATE KEY-----

""" ] ] element PrivateKey { - empty - }? + text + } & [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.authentication_properties.trusted_ca_dir), pf_string, -BLURB("

Trusted CA Directory which contains trusted CA certificates as -separated files.

""" ] ] +

Trusted CA Directory which contains trusted CA certificates as +separated files.

The default value is: "".

""" ] ] element TrustedCADirectory { - empty + text }? }? & [ a:documentation [ xml:lang="en" """ @@ -355,30 +346,27 @@ separated files.

""" ] ] specification.

""" ] ] element Cryptographic { [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.cryptography_plugin), pf_string, BLURB("

This element -specifies the library to be loaded as the DDS Security Cryptographic -plugin.

""" ] ] +

This element specifies the library to be loaded as the DDS Security +Cryptographic plugin.

""" ] ] element Library { [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.cryptography_plugin.library_finalize), pf_string, -BLURB("

This element names the finalization function of Cryptographic -plugin. This function is called to let the plugin release its -resources.

""" ] ] - element finalizeFunction { - empty +

This element names the finalization function of Cryptographic plugin. +This function is called to let the plugin release its +resources.

The default value is: "finalize_crypto".

""" ] ] + attribute finalizeFunction { + text }? & [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.cryptography_plugin.library_init), pf_string, BLURB("

This -element names the initialization function of Cryptographic plugin. This -function is called after loading the plugin library for instantiation -purposes. Init function must return an object that implements DDS -Security Cryptographic interface.

""" ] ] - element initFunction { - empty +

This element names the initialization function of Cryptographic +plugin. This function is called after loading the plugin library for +instantiation purposes. Init function must return an object that +implements DDS Security Cryptographic interface.

The default value +is: "init_crypto".

""" ] ] + attribute initFunction { + text }? & [ a:documentation [ xml:lang="en" """ -RELOFF (cfg.cryptography_plugin.library_path), pf_string, BLURB("

This -element points to the path of Cryptographic plugin library.

+

This element points to the path of Cryptographic plugin library.

It can be either absolute path excluding file extension ( /usr/lib/dds_security_crypto ) or single file without extension ( @@ -386,9 +374,10 @@ dds_security_crypto ).

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 -Windows systems.

""" ] ] - element path { - empty +Windows systems.

The default value is: +"dds_security_crypto".

""" ] ] + attribute path { + text }? }? }? diff --git a/etc/cyclonedds.xsd b/etc/cyclonedds.xsd index 3bd9a64..8821495 100644 --- a/etc/cyclonedds.xsd +++ b/etc/cyclonedds.xsd @@ -173,39 +173,33 @@ specification.</p> -RELOFF (cfg.access_control_plugin), pf_string, BLURB("<p>This element -specifies the library to be loaded as the DDS Security Access Control -plugin.</p> +<p>This element specifies the library to be loaded as the DDS Security +Access Control plugin.</p> - - - - -RELOFF (cfg.access_control_plugin.library_finalize), pf_string, -BLURB("<p>This element names the finalization function of Access Control -plugin. This function is called to let the plugin release its -resources.</p> - - - - - - -RELOFF (cfg.access_control_plugin.library_init), pf_string, -BLURB("<p>This element names the initialization function of Access -Control plugin. This function is called after loading the plugin library -for instantiation purposes. Init function must return an object that -implements DDS Security Access Control interface.</p> - - - - - - -RELOFF (cfg.access_control_plugin.library_path), pf_string, -BLURB("<p>This element points to the path of Access Control plugin -library.</p> + + + +<p>This element names the finalization function of Access Control plugin. +This function is called to let the plugin release its +resources.</p><p>The default value is: +&quot;finalize_access_control&quot;.</p> + + + + + +<p>This element names the initialization function of Access Control +plugin. This function is called after loading the plugin library for +instantiation purposes. Init function must return an object that +implements DDS Security Access Control interface.</p><p>The default value +is: &quot;init_access_control&quot;.</p> + + + + + +<p>This element points to the path of Access Control plugin library.</p> <p>It can be either absolute path excluding file extension ( /usr/lib/dds_security_ac ) or single file without extension ( @@ -213,11 +207,10 @@ dds_security_ac ).</p> <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 -Windows systems.</p> - - - - +Windows systems.</p><p>The default value is: +&quot;dds_security_ac&quot;.</p> + + @@ -225,12 +218,11 @@ Windows systems.</p> - + -RELOFF (cfg.access_control_properties.governance), pf_string, -BLURB("<p>URI to the shared Governance Document signed by the Permissions -CA in S/MIME format</p> +<p>URI to the shared Governance Document signed by the Permissions CA in +S/MIME format</p> <p>URI schemes: file, data</p><br> @@ -276,15 +268,14 @@ boundary="----F9A8A198D6F08E1285A292ADF14DD04F"</p> <p>MIIDuAYJKoZIhv ...al5s=</p> -<p>------F9A8A198D6F08E1285A292ADF14DD04F-]]</Governance></p> +<p>------F9A8A198D6F08E1285A292ADF14DD04F-]]</Governance></p><p>The +default value is: &quot;&quot;.</p> - - + -RELOFF (cfg.access_control_properties.permissions), pf_string, -BLURB("<p>URI to the DomainParticipant permissions document signed by the +<p>URI to the DomainParticipant permissions document signed by the Permissions CA in S/MIME format</p> <p>The permissions document specifies the permissions to be applied to a @@ -298,16 +289,14 @@ domain.</p><br> <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> - - + -RELOFF (cfg.access_control_properties.permissions_ca), pf_string, -BLURB("<p>URI to a X509 certificate for the PermissionsCA in PEM -format.</p> +<p>URI to a X509 certificate for the PermissionsCA in PEM format.</p> <p>Supported URI schemes: file, data</p> @@ -324,9 +313,9 @@ X.509 v3 ITU-T Recommendation X.509 (2005) [39]) in PEM format.</p><br& <p>MIIC3DCCAcQCCQCWE5x+Z ... PhovK0mp2ohhRLYI0ZiyYQ==</p> -<p>-----END CERTIFICATE-----</PermissionsCA></p> +<p>-----END CERTIFICATE-----</PermissionsCA></p><p>The default value is: +&quot;&quot;.</p> - @@ -336,44 +325,38 @@ specification.</p> - - + + -RELOFF (cfg.authentication_plugin), pf_string, BLURB("<p>This element -specifies the library to be loaded as the DDS Security Access Control -plugin.</p> +<p>This element specifies the library to be loaded as the DDS Security +Access Control plugin.</p> - - - - -RELOFF (cfg.authentication_plugin.library_finalize), pf_string, -BLURB("<p>This element names the finalization function of Authentication -plugin. This function is called to let the plugin release its -resources.</p> - - - - - - -RELOFF (cfg.authentication_plugin.library_init), pf_string, -BLURB("<p>This element names the initialization function of -Authentication plugin. This function is called after loading the plugin -library for instantiation purposes. Init function must return an object -that implements DDS Security Authentication interface.</p> - - - - - - -RELOFF (cfg.authentication_plugin.library_path), pf_string, -BLURB("<p>This element points to the path of Authentication plugin -library.</p> + + + +<p>This element names the finalization function of Authentication plugin. +This function is called to let the plugin release its +resources.</p><p>The default value is: +&quot;finalize_authentication&quot;.</p> + + + + + +<p>This element names the initialization function of Authentication +plugin. This function is called after loading the plugin library for +instantiation purposes. Init function must return an object that +implements DDS Security Authentication interface.</p><p>The default value +is: &quot;init_authentication&quot;.</p> + + + + + +<p>This element points to the path of Authentication plugin library.</p> <p>It can be either absolute path excluding file extension ( /usr/lib/dds_security_auth ) or single file without extension ( @@ -381,25 +364,23 @@ dds_security_auth ).</p> <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 -Windows systems.</p> - - - - +Windows systems.</p><p>The default value is: +&quot;dds_security_auth&quot;.</p> + + - + - + -RELOFF (cfg.authentication_properties.identity_ca), pf_string, -BLURB("<p>URI to the X509 certificate [39] of the Identity CA that is the -signer of Identity Certificate.</p> +<p>URI to the X509 certificate [39] of the Identity CA that is the signer +of Identity Certificate.</p> <p>Supported URI schemes: file, data</p> @@ -416,13 +397,11 @@ MIIC3DCCAcQCCQCWE5x+Z...PhovK0mp2ohhRLYI0ZiyYQ==<br> -----END CERTIFICATE-----</IdentityCA></p> - - + -RELOFF (cfg.authentication_properties.identity_certificate), pf_string, -BLURB("<p>Identity certificate that will be used for identifying all +<p>Identity certificate that will be used for identifying all participants in the OSPL instance.<br>The content is URI to a X509 certificate signed by the IdentityCA in PEM format containing the signed public key.</p> @@ -439,29 +418,26 @@ MIIDjjCCAnYCCQDCEu9...6rmT87dhTo=<br> -----END CERTIFICATE-----</IdentityCertificate></p> - - + -RELOFF (cfg.authentication_properties.password), pf_string, BLURB("<p>A -password used to decrypt the private_key.</p> +<p>A password used to decrypt the private_key.</p> 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 using AES128-CBC.</p> 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> - - + -RELOFF (cfg.authentication_properties.private_key), pf_string, -BLURB("<p>URI to access the private Private Key for all of the -participants in the OSPL federation.</p> +<p>URI to access the private Private Key for all of the participants in +the OSPL federation.</p> <p>Supported URI schemes: file, data</p> @@ -475,16 +451,13 @@ MIIEpAIBAAKCAQEA3HIh...AOBaaqSV37XBUJg==<br> -----END RSA PRIVATE KEY-----</PrivateKey></p> - - + -RELOFF (cfg.authentication_properties.trusted_ca_dir), pf_string, -BLURB("<p>Trusted CA Directory which contains trusted CA certificates as -separated files.</p> +<p>Trusted CA Directory which contains trusted CA certificates as +separated files.</p><p>The default value is: &quot;&quot;.</p> - @@ -497,38 +470,32 @@ specification.</p> -RELOFF (cfg.cryptography_plugin), pf_string, BLURB("<p>This element -specifies the library to be loaded as the DDS Security Cryptographic -plugin.</p> +<p>This element specifies the library to be loaded as the DDS Security +Cryptographic plugin.</p> - - - - -RELOFF (cfg.cryptography_plugin.library_finalize), pf_string, -BLURB("<p>This element names the finalization function of Cryptographic -plugin. This function is called to let the plugin release its -resources.</p> - - - - - - -RELOFF (cfg.cryptography_plugin.library_init), pf_string, BLURB("<p>This -element names the initialization function of Cryptographic plugin. This -function is called after loading the plugin library for instantiation -purposes. Init function must return an object that implements DDS -Security Cryptographic interface.</p> - - - - - - -RELOFF (cfg.cryptography_plugin.library_path), pf_string, BLURB("<p>This -element points to the path of Cryptographic plugin library.</p> + + + +<p>This element names the finalization function of Cryptographic plugin. +This function is called to let the plugin release its +resources.</p><p>The default value is: &quot;finalize_crypto&quot;.</p> + + + + + +<p>This element names the initialization function of Cryptographic +plugin. This function is called after loading the plugin library for +instantiation purposes. Init function must return an object that +implements DDS Security Cryptographic interface.</p><p>The default value +is: &quot;init_crypto&quot;.</p> + + + + + +<p>This element points to the path of Cryptographic plugin library.</p> <p>It can be either absolute path excluding file extension ( /usr/lib/dds_security_crypto ) or single file without extension ( @@ -536,11 +503,10 @@ dds_security_crypto ).</p> <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 -Windows systems.</p> - - - - +Windows systems.</p><p>The default value is: +&quot;dds_security_crypto&quot;.</p> + +