xmlsignature-update

www.altova.com Expand/Collapse All Print this Topic Previous Page Up One Level Next page

Home >  Command Line Interface (CLI) > XML Signature Commands >

xmlsignature-update

The xmlsignature-update | xupdate command updates the XML signature in the signed input file. If the document has been modified, the updated XML signature will be different; otherwise, the updated signature will be the same as the previous signature.

 

Windows

RaptorXML xmlsignature-update [options] --output=File SignedFile

Linux

raptorxml xmlsignature-update [options] --output=File SignedFile

Mac

raptorxml xmlsignature-update [options] --output=File SignedFile

 

The SignedFile argument is the signed XML document to update. Either (i) the hmac-secret-key option or (ii) the certificate-name and certificate-store options must be specified. If the the certificate-name and certificate-store options are specified, then they must match those that were used to sign the XML document previously. (Note that the certificate-store option is currently not supported on Linux and macOS.)

 

Examples

 

raptorxml xupdate --output=c:\UpdatedSignedFile.xml --certname=certificate1 --certstore=MyCertStore c:\SomeSignedFile.xml
raptorxml xupdate --output=c:\UpdatedSignedFile.xml --hmackey=SecretPassword c:\SomeSignedFile.xml

 

Click to expand/collapseCasing and slashes on the command line

RaptorXML on Windows

raptorxml on Unix (Linux, Mac)

 

* Note that lowercase (raptorxml) works on all platforms (Windows, Linux, and Mac), while upper-lower (RaptorXML) works only on Windows and Mac.

* Use forward slashes on Linux and Mac, backslashes on Windows.

 

Options

The command's options are listed below, organized into groups. Values can be specified without quotes except in two cases: (i) when the value string contains spaces, or (ii) when explicitly stated in the description of the option that quotes are required.

 

Click to expand/collapseCommon options

output = FILE

The URL of the output document that is created with the new XML signature.

 

--verbose = true|false

A value of true enables output of additional information during validation. Default value is false.

Note:   Boolean option values are set to true if the option is specified without a value.

 

 

Click to expand/collapseXML Signature options

--certname, --certificate-name = VALUE

The name of the certificate used for signing.

 

Windows

This is the Subject name of a certificate from the selected --certificate-store.

 

Example to list the certificates (under PowerShell)

% ls cert://CurrentUser/My

PSParentPath: Microsoft.PowerShell.Security\Certificate::CurrentUser\My

Thumbprint Subject

---------- -------

C9DF64BB0AAF5FA73474D78B7CCFFC37C95BFC6C CN=certificate1

... CN=...

 

Example: --certificate-name==certificate1

 

 

Linux/MacOS

--certname specifies the file name of a PEM encoded X.509v3 certificate with the private key. Such files usually have the extension .pem.

 

Example: --certificate-name==/path/to/certificate1.pem

 

--certstore, --certificate-store = VALUE

The location where the the certificate specified with --certificate-name is stored.

 

Windows

The name of a certificate store under cert://CurrentUser. The available certificate stores can be listed (under PowerShell) by using % ls cert://CurrentUser/. Certificates would then be listed as follows:

 

Name : TrustedPublisher

Name : ClientAuthIssuer

Name : Root

Name : UserDS

Name : CA

Name : ACRS

Name : REQUEST

Name : AuthRoot

Name : MSIEHistoryJournal

Name : TrustedPeople

Name : MyCertStore

Name : Local NonRemovable Certificates

Name : SmartCardRoot

Name : Trust

Name : Disallowed

 

Example: --certificate-store==MyCertStore

 

 

Linux/MacOS

The --certstore option is currently not supported.

--hmackey, --hmac-secret-key = VALUE

The HMAC shared secret key; must have a minimum length of six characters.

 

Example: --hmackey=secretpassword

 

Click to expand/collapseHelp and version options

--help

Displays help text for the command. For example, valany --h. (Alternatively the help command can be used with an argument. For example: help valany.)

 

--version

Displays the version of RaptorXML Server. If used with a command, place --version before the command.

 

 

 

 


© 2019 Altova GmbH