1XMLSEC1(1) User Commands XMLSEC1(1)
2
6 xmlsec1 - sign, verify, encrypt and decrypt XML documents
7
9 xmlsec <command> [<options>] [<files>]
10
12 xmlsec is a command line tool for signing, verifying, encrypting and
13 decrypting XML documents. The allowed <command> values are:
14 --help display this help information and exit
16 --help-all
18 display help information for all commands/options and exit
19 --help-<cmd>
21 display help information for command <cmd> and exit
22 --version
24 print version information and exit
25 --keys keys XML file manipulation
27 --sign sign data and output XML document
29 --verify
31 verify signed document
32 --sign-tmpl
34 create and sign dynamicaly generated signature template
35 --encrypt
37 encrypt data and output XML document
38 --decrypt
40 decrypt data from XML document
41
43 --ignore-manifests
44 do not process <dsig:Manifest> elements
46 --store-references
48 store and print the result of <dsig:Reference/> element process‐
50 ing just before calculating digest
51 --store-signatures
53 store and print the result of <dsig:Signature> processing just
55 before calculating signature
56 --enabled-reference-uris <list>
58 comma separated list of of the following values: "empty",
60 "same-doc", "local","remote" to restrict possible URI attribute
61 values for the <dsig:Reference> element
62 --enable-visa3d-hack
64 enables Visa3D protocol specific hack for URI attributes pro‐
66 cessing when we are trying not to use XPath/XPointer engine;
67 this is a hack and I don't know what else might be broken in
68 your application when you use it (also check "--id-attr" option
69 because you might need it)
70 --binary-data <file>
72 binary <file> to encrypt
74 --xml-data <file>
76 XML <file> to encrypt
78 --enabled-cipher-reference-uris <list>
80 comma separated list of of the following values: "empty",
82 "same-doc", "local","remote" to restrict possible URI attribute
83 values for the <enc:CipherReference> element
84 --session-key <keyKlass>-<keySize>
86 generate new session <keyKlass> key of <keySize> bits size (for
88 example, "--session des-192" generates a new 192 bits DES key
89 for DES3 encryption)
90 --output <filename>
92 write result document to file <filename>
94 --print-debug
96 print debug information to stdout
98 --print-xml-debug
100 print debug information to stdout in xml format
102 --dtd-file <file>
104 load the specified file as the DTD
106 --node-id <id>
108 set the operation start point to the node with given <id>
110 --node-name [<namespace-uri>:]<name>
112 set the operation start point to the first node with given
114 <name> and <namespace> URI
115 --node-xpath <expr>
117 set the operation start point to the first node selected by the
119 specified XPath expression
120 --id-attr[:<attr-name>] [<node-namespace-uri>:]<node-name>
122 adds attributes <attr-name> (default value "id") from all nodes
124 with<node-name> and namespace <node-namespace-uri> to the list
125 of known ID attributes; this is a hack and if you can use DTD or
126 schema to declare ID attributes instead (see "--dtd-file" op‐
127 tion), I don't know what else might be broken in your applica‐
128 tion when you use this hack
129 --enabled-key-data <list>
131 comma separated list of enabled key data (list of registered key
133 data klasses is available with "--list-key-data" command); by
134 default, all registered key data are enabled
135 --enabled-retrieval-uris <list>
137 comma separated list of of the following values: "empty",
139 "same-doc", "local","remote" to restrict possible URI attribute
140 values for the <dsig:RetrievalMethod> element.
141 --gen-key[:<name>] <keyKlass>-<keySize>
143 generate new <keyKlass> key of <keySize> bits size, set the key
145 name to <name> and add the result to keys manager (for example,
146 "--gen:mykey rsa-1024" generates a new 1024 bits RSA key and
147 sets it's name to "mykey")
148 --keys-file <file>
150 load keys from XML file
152 --privkey-pem[:<name>] <file>[,<cafile>[,<cafile>[...]]]
154 load private key from PEM file and certificates that verify this
156 key
157 --privkey-der[:<name>] <file>[,<cafile>[,<cafile>[...]]]
159 load private key from DER file and certificates that verify this
161 key
162 --pkcs8-pem[:<name>] <file>[,<cafile>[,<cafile>[...]]]
164 load private key from PKCS8 PEM file and PEM certificates that
166 verify this key
167 --pkcs8-der[:<name>] <file>[,<cafile>[,<cafile>[...]]]
169 load private key from PKCS8 DER file and DER certificates that
171 verify this key
172 --pubkey-pem[:<name>] <file>
174 load public key from PEM file
176 --pubkey-der[:<name>] <file>
178 load public key from DER file
180 --aeskey[:<name>] <file>
182 load AES key from binary file <file>
184 --deskey[:<name>] <file>
186 load DES key from binary file <file>
188 --hmackey[:<name>] <file>
190 load HMAC key from binary file <file>
192 --pwd <password>
194 the password to use for reading keys and certs
196 --pkcs12[:<name>] <file>
198 load load private key from pkcs12 file <file>
200 --pkcs12-persist
202 persist loaded private key
204 --pubkey-cert-pem[:<name>] <file>
206 load public key from PEM cert file
208 --pubkey-cert-der[:<name>] <file>
210 load public key from DER cert file
212 --trusted-pem <file>
214 load trusted (root) certificate from PEM file <file>
216 --untrusted-pem <file>
218 load untrusted certificate from PEM file <file>
220 --trusted-der <file>
222 load trusted (root) certificate from DER file <file>
224 --untrusted-der <file>
226 load untrusted certificate from DER file <file>
228 --verification-time <time>
230 the local time in "YYYY-MM-DD HH:MM:SS" format used certificates
232 verification
233 --verification-gmt-time <time>
235 the GMT time in "YYYY-MM-DD HH:MM:SS" format used certificates
237 verification
238 --depth <number>
240 maximum certificates chain depth
242 --X509-skip-strict-checks
244 skip strict checking of X509 data
246 --insecure
248 do not verify certificates
250 --privkey-openssl-engine[:<name>] <openssl-en‐
252 gine>;<openssl-key-id>[,<crtfile>[,<crtfile>[...]]]
253 load private key by OpenSSL ENGINE interface; specify the name
255 of engine (like with -engine params), the key specs (like with
256 -inkey or -key params) and optionally certificates that verify
257 this key
258 --crypto <name>
260 the name of the crypto engine to use from the following list:
262 openssl, mscrypto, nss, gnutls, gcrypt (if no crypto engine is
263 specified then the default one is used)
264 --crypto-config <path>
266 path to crypto engine configuration
268 --repeat <number>
270 repeat the operation <number> times
272 --disable-error-msgs
274 do not print xmlsec error messages
276 --print-crypto-error-msgs
278 print errors stack at the end
280 --help
282 print help information about the command
284 --xxe
286 enable External Entity resolution. WARNING: this may allow the
288 reading of arbitrary files and URLs, controlled by the input XML
289 document. Use with caution!
290 --url-map:<url> <file>
292 maps a given <url> to the given <file> for loading external re‐
294 sources
295
297 Written by Aleksey Sanin <aleksey@aleksey.com>.
298
300 Report bugs to http://www.aleksey.com/xmlsec/bugs.html
301
303 Copyright © 2002-2022 Aleksey Sanin <aleksey@aleksey.com>. All Rights
304 Reserved..
305 This is free software: see the source for copying information.
306xmlsec1 1.2.37 (openssl) November 2022 XMLSEC1(1)