(xmlsec-docs) clarify --enabled-key-data usage (example: rsa,key-value,x509) and add FAQ note (#917)

Author: ignat980

.gitignore

@@ -68,4 +68,4 @@ docs/api/*.bak
 docs/api/*.types
 docs/api/sgml.stamp
 docs/html.stamp
-
+.vscode/

apps/xmlsec.c

@@ -58,7 +58,7 @@
 
 static const char copyright[] =
     "Written by Aleksey Sanin <[email protected]>.\n\n"
-    "Copyright (C) 2002-2024 Aleksey Sanin <[email protected]>. All Rights Reserved..\n"
+    "Copyright (C) 2002-2024 Aleksey Sanin <[email protected]>. All Rights Reserved.\n"
     "This is free software: see the source for copying information.\n";
 
 static const char bugs[] =
@@ -484,9 +484,13 @@ static xmlSecAppCmdLineParam enabledKeyDataParam = {
     "--enabled-key-data",
     NULL,
     "--enabled-key-data <list>"
-    "\n\tcomma separated list of enabled key data (list of "
-    "\n\tregistered key data klasses is available with \"--list-key-data\""
-    "\n\tcommand); by default, all registered key data are enabled",
+    "\n\tcomma-separated list of key-data types to enable."
+    "\n\tExample:"
+    "\n\t  rsa,key-value,x509  -> populates <RSAKeyValue> and keeps <X509Data>"
+    "\n\t                         when <KeyValue/> and <X509Data/> placeholders"
+    "\n\t                         are present in the template."
+    "\n\tUse \"--list-key-data\" to view full list of registered key data klasses."
+    "\n\tBy default, all registered key data are enabled.",
     xmlSecAppCmdLineParamTypeStringList,
     xmlSecAppCmdLineParamFlagParamNameValue | xmlSecAppCmdLineParamFlagMultipleValues,
     NULL

docs/faq.html

@@ -302,6 +302,9 @@ <h4>
         re-enable <code>KeyValue</code> and <code>DEREncodedKeyValue</code> nodes using the <code>--enabled-key-data</code> option
         for the <a href="xmlsec-man.html">xmlsec command line utility</a>, or by setting the <code>keyInfoCtx-&gt;enabledKeyData</code>
         parameter in your application.
+        For example, <code>--enabled-key-data rsa,key-value,x509</code> will populate an <code>&lt;RSAKeyValue&gt;</code> element (and keep
+        <code>&lt;X509Data&gt;</code> enabled) when the template contains matching <code>&lt;KeyValue/&gt;</code> and 
+        <code>&lt;X509Data/&gt;</code> placeholders.
         <b>THIS IS NOT SECURE AND NOT RECOMMENDED.</b>
       </li>
 <li>

docs/xmlsec-man.html

@@ -145,7 +145,10 @@ <h1>XMLSEC1</h1>
 </dd>
 <dt> <b>--enabled-key-data</b> &lt;list&gt; <dt></dt>
 </dt>
-<dd> <dd>comma separated list of enabled key data (list of registered key data klasses is available with "--list-key-data" command); by default, all registered key data are enabled </dd>
+<dd>comma-separated list of key-data types to enable.  
+  Use <code>--list-key-data</code> to see all registered key-data klasses.
+  By default, all registered key data are enabled.<br>
+  <b>Example:</b> <code>--enabled-key-data rsa,key-value,x509</code> populates an <code>&lt;RSAKeyValue&gt;</code> element (and keeps <code>&lt;X509Data&gt;</code> enabled) when the template contains the matching <code>&lt;KeyValue/&gt;</code> and <code>&lt;X509Data/&gt;</code> placeholders.</dd>
 </dd>
 <dt> <b>--enabled-retrieval-method-uris</b> &lt;list&gt; <dt></dt>
 </dt>

man/xmlsec1.1

@@ -355,6 +355,6 @@ Written by Aleksey Sanin <[email protected]>.
 .SH "REPORTING BUGS"
 Report bugs to http://www.aleksey.com/xmlsec/bugs.html
 .SH COPYRIGHT
-Copyright \(co 2002\-2024 Aleksey Sanin <[email protected]>. All Rights Reserved..
+Copyright \(co 2002\-2024 Aleksey Sanin <[email protected]>. All Rights Reserved.
 .br
 This is free software: see the source for copying information.

tests/testrun.sh

@@ -1,6 +1,6 @@
 #!/bin/sh -x
 
-OS_ARCH=`uname -o`
+OS_ARCH=`uname -o 2>/dev/null || echo ""`
 OS_KERNEL=`uname -s`
 
 #