docs/xmlsec-man.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   4 <title>Man page of XMLSEC1</title>
   5 </head>
   6 <body><table witdh="100%" valign="top"><tr valign="top">
   7 <td valign="top" align="left" width="210">
   8 <img src="images/logo.gif" alt="XML Security Library" border="0"><p></p>
   9 <ul>
  10 <li><a href="index.html">Home</a></li>
  11 <li><a href="download.html">Download</a></li>
  12 <li><a href="news.html">News</a></li>
  13 <li><a href="documentation.html">Documentation</a></li>
  14 <ul>
  15 <li><a href="faq.html">FAQ</a></li>
  16 <li><a href="api/xmlsec-notes.html">Tutorial</a></li>
  17 <li><a href="api/xmlsec-reference.html">API reference</a></li>
  18 <li><a href="api/xmlsec-examples.html">Examples</a></li>
  19 </ul>
  20 <li><a href="xmldsig.html">XML Digital Signature</a></li>
  21 <ul><li><a href="http://www.aleksey.com/xmlsec/xmldsig-verifier.html">Online Verifier</a></li></ul>
  22 <li><a href="xmlenc.html">XML Encryption</a></li>
  23 <li><a href="c14n.html">XML Canonicalization</a></li>
  24 <li><a href="bugs.html">Reporting Bugs</a></li>
  25 <li><a href="http://www.aleksey.com/pipermail/xmlsec">Mailing list</a></li>
  26 <li><a href="related.html">Related</a></li>
  27 <li><a href="authors.html">Authors</a></li>
  28 </ul>
  29 <table width="100%">
  30 <tr>
  31 <td width="15"></td>
  32 <td><a href="http://xmlsoft.org/"><img src="images/libxml2-logo.png" alt="LibXML2" border="0"></a></td>
  33 </tr>
  34 <tr>
  35 <td width="15"></td>
  36 <td><a href="http://xmlsoft.org/XSLT"><img src="images/libxslt-logo.png" alt="LibXSLT" border="0"></a></td>
  37 </tr>
  38 <tr>
  39 <td width="15"></td>
  40 <td><a href="http://www.openssl.org/"><img src="images/openssl-logo.png" alt="OpenSSL" border="0"></a></td>
  41 </tr>
  42 <!--Links - start--><!--Links - end-->
  43 </table>
  44 </td>
  45 <td valign="top"><table width="100%" valign="top"><tr><td valign="top" align="left" id="xmlsecContent">
  46 <h1>XMLSEC1</h1>
  47 <br><br><a href="#index">Index</a><a href="/cgi-bin/man/man2html">Return to Main Contents</a><hr>
  48 <a name="lbAB"> </a><h2>NAME</h2>
  49 <a name="lbAC"> </a><h2>SYNOPSIS</h2>
  50 <b>xmlsec</b><i>&lt;command&gt; </i><i>&lt;options&gt;</i><i>&lt;files&gt;</i><a name="lbAD"> </a><h2>DESCRIPTION</h2>
  51 <dl compact>
  52 <dt><b>--help</b></dt>
  53 <dd> display this help information and exit </dd>
  54 <dt><b>--help-all</b></dt>
  55 <dd> display help information for all commands/options and exit </dd>
  56 <dt>
  57 <b>--help-</b>&lt;cmd&gt;</dt>
  58 <dd> display help information for command &lt;cmd&gt; and exit </dd>
  59 <dt><b>--version</b></dt>
  60 <dd> print version information and exit </dd>
  61 <dt><b>--keys</b></dt>
  62 <dd> keys XML file manipulation </dd>
  63 <dt><b>--sign</b></dt>
  64 <dd> sign data and output XML document </dd>
  65 <dt><b>--verify</b></dt>
  66 <dd> verify signed document </dd>
  67 <dt><b>--sign-tmpl</b></dt>
  68 <dd> create and sign dynamicaly generated signature template </dd>
  69 <dt><b>--encrypt</b></dt>
  70 <dd> encrypt data and output XML document </dd>
  71 <dt><b>--decrypt</b></dt>
  72 <dd> decrypt data from XML document </dd>
  73 </dl>
  74 <a name="lbAE"> </a><h2>OPTIONS</h2>
  75 <dl compact>
  76 <dt> <b>--ignore-manifests</b> <dt></dt>
  77 </dt>
  78 <dd> <dd>do not process &lt;dsig:Manifest&gt; elements </dd>
  79 </dd>
  80 <dt> <b>--store-references</b> <dt></dt>
  81 </dt>
  82 <dd> <dd>store and print the result of &lt;dsig:Reference/&gt; element processing just before calculating digest </dd>
  83 </dd>
  84 <dt> <b>--store-signatures</b> <dt></dt>
  85 </dt>
  86 <dd> <dd>store and print the result of &lt;dsig:Signature&gt; processing just before calculating signature </dd>
  87 </dd>
  88 <dt> <b>--enabled-reference-uris</b> &lt;list&gt; <dt></dt>
  89 </dt>
  90 <dd> <dd>comma separated list of of the following values: "empty", "same-doc", "local","remote" to restrict possible URI attribute values for the &lt;dsig:Reference&gt; element </dd>
  91 </dd>
  92 <dt> <b>--enable-visa3d-hack</b> <dt></dt>
  93 </dt>
  94 <dd> <dd>enables Visa3D protocol specific hack for URI attributes processing when we are trying not to use XPath/XPointer engine; this is a hack and I don't know what else might be broken in your application when you use it (also check "--id-attr" option because you might need it) </dd>
  95 </dd>
  96 <dt> <b>--binary-data</b> &lt;file&gt; <dt></dt>
  97 </dt>
  98 <dd> <dd>binary &lt;file&gt; to encrypt </dd>
  99 </dd>
 100 <dt> <b>--xml-data</b> &lt;file&gt; <dt></dt>
 101 </dt>
 102 <dd> <dd>XML &lt;file&gt; to encrypt </dd>
 103 </dd>
 104 <dt> <b>--enabled-cipher-reference-uris</b> &lt;list&gt; <dt></dt>
 105 </dt>
 106 <dd> <dd>comma separated list of of the following values: "empty", "same-doc", "local","remote" to restrict possible URI attribute values for the &lt;enc:CipherReference&gt; element </dd>
 107 </dd>
 108 <dt> <b>--session-key</b> &lt;keyKlass&gt;-&lt;keySize&gt; <dt></dt>
 109 </dt>
 110 <dd> <dd>generate new session &lt;keyKlass&gt; key of &lt;keySize&gt; bits size (for example, "--session des-192" generates a new 192 bits DES key for DES3 encryption) </dd>
 111 </dd>
 112 <dt> <b>--output</b> &lt;filename&gt; <dt></dt>
 113 </dt>
 114 <dd> <dd>write result document to file &lt;filename&gt; </dd>
 115 </dd>
 116 <dt> <b>--print-debug</b> <dt></dt>
 117 </dt>
 118 <dd> <dd>print debug information to stdout </dd>
 119 </dd>
 120 <dt> <b>--print-xml-debug</b> <dt></dt>
 121 </dt>
 122 <dd> <dd>print debug information to stdout in xml format </dd>
 123 </dd>
 124 <dt> <b>--dtd-file</b> &lt;file&gt; <dt></dt>
 125 </dt>
 126 <dd> <dd>load the specified file as the DTD </dd>
 127 </dd>
 128 <dt> <b>--node-id</b> &lt;id&gt; <dt></dt>
 129 </dt>
 130 <dd> <dd>set the operation start point to the node with given &lt;id&gt; </dd>
 131 </dd>
 132 <dt> <b>--node-name</b> [&lt;namespace-uri&gt;:]&lt;name&gt; <dt></dt>
 133 </dt>
 134 <dd> <dd>set the operation start point to the first node with given &lt;name&gt; and &lt;namespace&gt; URI </dd>
 135 </dd>
 136 <dt> <b>--node-xpath</b> &lt;expr&gt; <dt></dt>
 137 </dt>
 138 <dd> <dd>set the operation start point to the first node selected by the specified XPath expression </dd>
 139 </dd>
 140 <dt> <b>--id-attr[</b>:&lt;attr-name&gt;] [&lt;node-namespace-uri&gt;:]&lt;node-name&gt; <dt></dt>
 141 </dt>
 142 <dd> <dd>adds attributes &lt;attr-name&gt; (default value "id") from all nodes with&lt;node-name&gt; and namespace &lt;node-namespace-uri&gt; to the list of known ID attributes; this is a hack and if you can use DTD or schema to declare ID attributes instead (see "--dtd-file" option), I don't know what else might be broken in your application when you use this hack </dd>
 143 </dd>
 144 <dt> <b>--enabled-key-data</b> &lt;list&gt; <dt></dt>
 145 </dt>
 146 <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>
 147 </dd>
 148 <dt> <b>--enabled-retrieval-uris</b> &lt;list&gt; <dt></dt>
 149 </dt>
 150 <dd> <dd>comma separated list of of the following values: "empty", "same-doc", "local","remote" to restrict possible URI attribute values for the &lt;dsig:RetrievalMethod&gt; element. </dd>
 151 </dd>
 152 <dt> <b>--gen-key[</b>:&lt;name&gt;] &lt;keyKlass&gt;-&lt;keySize&gt; <dt></dt>
 153 </dt>
 154 <dd> <dd>generate new &lt;keyKlass&gt; key of &lt;keySize&gt; bits size, set the key name to &lt;name&gt; and add the result to keys manager (for example, "--gen:mykey rsa-1024" generates a new 1024 bits RSA key and sets it's name to "mykey") </dd>
 155 </dd>
 156 <dt> <b>--keys-file</b> &lt;file&gt; <dt></dt>
 157 </dt>
 158 <dd> <dd>load keys from XML file </dd>
 159 </dd>
 160 <dt> <b>--privkey-pem[</b>:&lt;name&gt;] &lt;file&gt;[,&lt;cafile&gt;[,&lt;cafile&gt;[...]]] <dt></dt>
 161 </dt>
 162 <dd> <dd>load private key from PEM file and certificates that verify this key </dd>
 163 </dd>
 164 <dt> <b>--privkey-der[</b>:&lt;name&gt;] &lt;file&gt;[,&lt;cafile&gt;[,&lt;cafile&gt;[...]]] <dt></dt>
 165 </dt>
 166 <dd> <dd>load private key from DER file and certificates that verify this key </dd>
 167 </dd>
 168 <dt> <b>--pkcs8-pem[</b>:&lt;name&gt;] &lt;file&gt;[,&lt;cafile&gt;[,&lt;cafile&gt;[...]]] <dt></dt>
 169 </dt>
 170 <dd> <dd>load private key from PKCS8 PEM file and PEM certificates that verify this key </dd>
 171 </dd>
 172 <dt> <b>--pkcs8-der[</b>:&lt;name&gt;] &lt;file&gt;[,&lt;cafile&gt;[,&lt;cafile&gt;[...]]] <dt></dt>
 173 </dt>
 174 <dd> <dd>load private key from PKCS8 DER file and DER certificates that verify this key </dd>
 175 </dd>
 176 <dt> <b>--pubkey-pem[</b>:&lt;name&gt;] &lt;file&gt; <dt></dt>
 177 </dt>
 178 <dd> <dd>load public key from PEM file </dd>
 179 </dd>
 180 <dt> <b>--pubkey-der[</b>:&lt;name&gt;] &lt;file&gt; <dt></dt>
 181 </dt>
 182 <dd> <dd>load public key from DER file </dd>
 183 </dd>
 184 <dt> <b>--aeskey[</b>:&lt;name&gt;] &lt;file&gt; <dt></dt>
 185 </dt>
 186 <dd> <dd>load AES key from binary file &lt;file&gt; </dd>
 187 </dd>
 188 <dt> <b>--deskey[</b>:&lt;name&gt;] &lt;file&gt; <dt></dt>
 189 </dt>
 190 <dd> <dd>load DES key from binary file &lt;file&gt; </dd>
 191 </dd>
 192 <dt> <b>--hmackey[</b>:&lt;name&gt;] &lt;file&gt; <dt></dt>
 193 </dt>
 194 <dd> <dd>load HMAC key from binary file &lt;file&gt; </dd>
 195 </dd>
 196 <dt> <b>--pwd</b> &lt;password&gt; <dt></dt>
 197 </dt>
 198 <dd> <dd>the password to use for reading keys and certs </dd>
 199 </dd>
 200 <dt> <b>--pkcs12[</b>:&lt;name&gt;] &lt;file&gt; <dt></dt>
 201 </dt>
 202 <dd> <dd>load load private key from pkcs12 file &lt;file&gt; </dd>
 203 </dd>
 204 <dt> <b>--pubkey-cert-pem[</b>:&lt;name&gt;] &lt;file&gt; <dt></dt>
 205 </dt>
 206 <dd> <dd>load public key from PEM cert file </dd>
 207 </dd>
 208 <dt> <b>--pubkey-cert-der[</b>:&lt;name&gt;] &lt;file&gt; <dt></dt>
 209 </dt>
 210 <dd> <dd>load public key from DER cert file </dd>
 211 </dd>
 212 <dt> <b>--trusted-pem</b> &lt;file&gt; <dt></dt>
 213 </dt>
 214 <dd> <dd>load trusted (root) certificate from PEM file &lt;file&gt; </dd>
 215 </dd>
 216 <dt> <b>--untrusted-pem</b> &lt;file&gt; <dt></dt>
 217 </dt>
 218 <dd> <dd>load untrusted certificate from PEM file &lt;file&gt; </dd>
 219 </dd>
 220 <dt> <b>--trusted-der</b> &lt;file&gt; <dt></dt>
 221 </dt>
 222 <dd> <dd>load trusted (root) certificate from DER file &lt;file&gt; </dd>
 223 </dd>
 224 <dt> <b>--untrusted-der</b> &lt;file&gt; <dt></dt>
 225 </dt>
 226 <dd> <dd>load untrusted certificate from DER file &lt;file&gt; </dd>
 227 </dd>
 228 <dt> <b>--verification-time</b> &lt;time&gt; <dt></dt>
 229 </dt>
 230 <dd> <dd>the local time in "YYYY-MM-DD HH:MM:SS" format used certificates verification </dd>
 231 </dd>
 232 <dt> <b>--depth</b> &lt;number&gt; <dt></dt>
 233 </dt>
 234 <dd> <dd>maximum certificates chain depth </dd>
 235 </dd>
 236 <dt> <b>--X509-skip-strict-checks</b> <dt></dt>
 237 </dt>
 238 <dd> <dd>skip strict checking of X509 data </dd>
 239 </dd>
 240 <dt> <b>--crypto</b> &lt;name&gt; <dt></dt>
 241 </dt>
 242 <dd> <dd>the name of the crypto engine to use from the following list: openssl, gnutls, nss, mscrypto (if no crypto engine is specified then the default one is used) </dd>
 243 </dd>
 244 <dt> <b>--crypto-config</b> &lt;path&gt; <dt></dt>
 245 </dt>
 246 <dd> <dd>path to crypto engine configuration </dd>
 247 </dd>
 248 <dt> <b>--repeat</b> &lt;number&gt; <dt></dt>
 249 </dt>
 250 <dd> <dd>repeat the operation &lt;number&gt; times </dd>
 251 </dd>
 252 <dt> <b>--disable-error-msgs</b> <dt></dt>
 253 </dt>
 254 <dd> <dd>do not print xmlsec error messages </dd>
 255 </dd>
 256 <dt> <b>--print-crypto-error-msgs</b> <dt></dt>
 257 </dt>
 258 <dd> <dd>print errors stack at the end </dd>
 259 </dd>
 260 <dt> <b>--help</b> <dt></dt>
 261 </dt>
 262 <dd> <dd>print help information about the command </dd>
 263 </dd>
 264 </dl>
 265 <a name="lbAF"> </a><h2>AUTHOR</h2>
 266 <a href="mailto:aleksey@aleksey.com">aleksey@aleksey.com</a><a name="lbAG"> </a><h2>REPORTING BUGS</h2>
 267 <a href="http://www.aleksey.com/xmlsec/bugs.html">http://www.aleksey.com/xmlsec/bugs.html</a><a name="lbAH"> </a><h2>COPYRIGHT</h2>
 268 <br><p>  </p>
 269 <hr>
 270 <a name="index"> </a><h2>Index</h2>
 271 <dl>
 272 <dt><a href="#lbAB">NAME</a></dt>
 273 <dd> </dd>
 274 <dt><a href="#lbAC">SYNOPSIS</a></dt>
 275 <dd> </dd>
 276 <dt><a href="#lbAD">DESCRIPTION</a></dt>
 277 <dd> </dd>
 278 <dt><a href="#lbAE">OPTIONS</a></dt>
 279 <dd> </dd>
 280 <dt><a href="#lbAF">AUTHOR</a></dt>
 281 <dd> </dd>
 282 <dt><a href="#lbAG">REPORTING BUGS</a></dt>
 283 <dd> </dd>
 284 <dt><a href="#lbAH">COPYRIGHT</a></dt>
 285 <dd> </dd>
 286 </dl>
 287 <hr>
 288 <a href="/cgi-bin/man/man2html">man2html</a><br>
 289 </td></tr></table></td>
 290 </tr></table></body>
 291 </html>