Sign XML File Action

Declaration

<AMXMLSIGN SIGNUSING="text [options]" KEYCONTAINERNAME="text" KEYCONTAINERLEVEL="text" KEYPAIRFILE="text" PASSWORD="text"/>

See Also

Merge XML Files Action, Output XML File Action

Description

Signs an XML file with specified key. Signing an XML file provides a means of verification that the file has not been modified. Use the Verify XML action to verify a previously signed XML file.

Signature can be added using Key Container or Public/Private Key file generated using Generate Public/Private Key Files action in Cryptography Plug-in.

Practical Usage

The user can tell if anyone has changed the original XML file.

Parameters

General Tab

Sign Using

Text [options], Optional - Default "KeyContainer"
MARKUP: SIGNUSING="KEYFILE"

Tells the system how you want add the signature for the in-memory xml file.

The available options are:

Key Container

Specifies that the Windows key container which stores the private and public key requires a key container name.

Key File

Specifies the .pri or .pfx file. The .pri file is the file generated using Generate Key Files action in Automate.

Note: These options are only available if Sign Using combo box has value Key Container.

Key Container Name

Text, Required
MARKUP: KEYCONTAINERNAME="Automate"

Allows you to enter the name of the key container to identify which private or public key to use. You must select the key container by clicking on Select Key Container Button.

Key Container Level

Text [options], Optional - Default "User"
MARKUP: KEYCONTAINERLEVEL="MACHINE"

Specifies where the keys are stored in computer--either at the user or machine level.

The available options are:

Comparing Machine-Level and User-Level RSA Key Containers

Comparing Machine-Level and User-Level RSA Key Containers

User-level RSA key containers are stored with the Windows user profile for a particular user and can be used to encrypt and decrypt information for applications that run under that specific user identity. User-level RSA key containers can be useful if you want to ensure that the RSA key information is removed when the Windows user profile is removed. However, because you must be logged in with the specific user account that makes use of the user-level RSA key container in order to encrypt or decrypt protected configuration sections, they are inconvenient to use.

Machine-level RSA key containers are available to all users that can log in to a computer, by default, and are the most useful as you can use them to encrypt or decrypt protected configuration sections while logged in with an administrator account. A machine-level RSA key container can be used to protect information for a single application, all the applications on a server, or a group of applications on a server that run under the same user identity. Although machine-level RSA key containers are available to all users, they can be secured with NTFS Access Control Lists (ACLs) so that only required users can access them.

Link: http://msdn2.microsoft.com/en-us/library/f5cs0acs.aspx

NOTE: The following parameters are only available if you select the Key File option from the Sign using dropdown.

Keypair File

Text, Required
MARKUP: KEYPAIRFILE="c:\secret.pri"

Allows you to enter the path of the .pfx or .pri file on your system.

Password

Text, Optional
MARKUP:  PASSWORD="password"

Allows you to enter the password used to during creation of private key (Usually used for .pfx file).

Session Name

Text, Optional - Default "XMLSession1"
MARKUP: SESSIONNAME="FirstXMLSession"

Specifies the session name to run the XML file in subsequent XML steps. This allows several connections to be active simultaneously.

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<AMXMLSIGN SIGNUSING="KEYFILE" KEYPAIRFILE="c:\secret.pri"/>

<AMXMLSIGN SIGNUSING="KEYFILE" KEYPAIRFILE="C:\Sing.pfx" PASSWORD="AM1JWpIQm4vanY=aME" />