Cryptography - Sign |
Declaration
|
<AMSIGN INPUTFILE="text" OUTPUTFILE="text" SUBFOLDERS="Yes/No" OVERWRITE="Yes/No" ISNEWER="Yes/No" PUBKEYRINGPATH="text" SECKEYRINGPATH="text"><SIGNATURE KEYID="text" PASSWORD="text" /></AMSIGN> |
Description
Digitally signs a file using the specified private keys. The files can be signed by multiple keys.
Practical Usage
Protects files from being tampered with by digitally signing them. Digital signing uses a key pair and encrypts the message to be signed with the private key to produce a signature file. The Verify action can later be used to validate and decrypt the signature.
Parameters
General
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Source |
Text |
Yes |
(Empty) |
|
The
path and file name of the files to be digitally signed. This can be a fully
qualified path and file name (preferred) or a single file (requires
use of the File System - Change
folder activity). Wildcard characters (for example, * or ?) may be
used to specify all files matching a certain mask. Multiple files
and/or file masks can be specified by separating each entry with
a pipe character (|) (for example, c:\temp\*.txt|c:\backup\*.bak).
See File
Masks & Wildcards for more details. NOTE: Files with invalid paths are ignored at runtime. |
|
Destination |
Text |
Yes |
(Empty) |
|
The destination folder and (optional) file name of the files to be digitally signed. Folders that do not exist will be automatically created at runtime. |
|
Public Keyring File |
Text |
Yes |
(Empty) |
PUBKEYRINGPATH="c:\Folder\File.pkr" |
The path and file name of the PGP, OpenPGP or GnuPG Public Keyring file. Entering a valid Public Keyring file along with a matching Secret Keyring file will populate the Signatures tab with the appropriate signature information. NOTE: Automate is equipped with the OpenPGP engine which is installed on the system during Automate installation. |
|
Secret Keyring File |
Text |
Yes |
(Empty) |
SECKEYRINGPATH="c:\Folder\File.skr" |
The path and file name of the PGP, OpenPGP or GnuPG secret keyring file. Entering a valid Public Keyring file along with a matching Secret Keyring file will populate the Signatures tab with the appropriate signature information. NOTE: Automate is equipped with the OpenPGP engine which is installed on the system during Automate installation. |
Options
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Include Subfolders |
Yes/No |
No |
No |
SUBFOLDERS="YES" |
If selected, specifies that, if present, subfolders should be searched for files matching the mask specified in the Source parameter. The default value is disabled. |
|
Preserve Folder Structure |
Yes/No |
No |
Yes |
KEEPFOLDERSTRUCT="NO" |
If selected, specifies that subfolders found in the source folder should be created in the destination folder, and source files should be decrypted into their respective folders rather than directly into the root of the folder specified in the Destination parameter. Valid only if the Include subfolders parameter is selected. |
|
Overwrite if Exists |
Yes/No |
No |
No |
OVERWRITE="YES" |
If selected, specifies that, if destination files already exist, they should be overwritten. The default value is disabled. |
|
Only if Newer |
Yes/No |
No |
No |
ISNEWERTHAN="YES" |
If selected, indicates that only files that are newer than those in the destination folder will overwrite existing files. Valid only if the Overwrite if Exists parameter is selected. |
|
Only if Exists in Destination |
Yes/No |
No |
No |
ONLYIFEXIST="YES" |
If selected, specifies that only files that already exist in the destination will be decrypted from the source. All other files, regardless of whether they match the mask or other parameter settings will be bypassed. Valid only if the Overwrite if Exists parameter is selected. |
|
Overwrite Read-Only Files |
Yes/No |
No |
No |
OVERWRITEREADONLY="YES" |
If selected, indicates that already existing files should be overwritten even if the file in the destination is marked with the "read-only" attribute. By default, read only files are not overwritten. Valid only if the Overwrite if Exists parameter is selected. |
|
Overwrite Hidden Files |
Yes/No |
No |
No |
OVERWRITEHIDDEN="YES" |
If selected, specifies that already existing files should be overwritten even if the file in the destination is marked with the "hidden" attribute. By default, hidden files are not overwritten. Valid only if the Overwrite if Exists parameter is selected. |
|
Turn Archive Attribute Off |
Yes/No |
No |
No |
ARCHIVETURNOFF="YES" |
If selected, denotes that the "archive" attribute of the source file should be switched OFF. The Windows "archive" attribute is generally used to track whether a file has been backed-up. By turning the source file's archive attribute off—this indicates to many backup programs that the file has already been backed-up. |
|
Exclude Mask |
Text |
No |
(Empty) |
EXCLUDE="*.txt" |
Causes this action to omit decrypting files matching the masks specified. Filenames or wildcard masks may be used. Multiple entries may be specified by separating them with a pipe symbol (|). For example: *.txt|*.bak. |
|
Regular Expression |
Yes/No |
No |
No |
RE="YES" |
If selected, specifies that a regular expression is used in the Exclude Mask field. |
|
Only if Newer Than |
Date |
No |
(Empty) |
ISNEWERTHAN= "%DateSerial(2007,10,12) + TimeSerial(00,00,00)%" |
Causes this action to only decrypt files if the source is newer than the date/time specified. If this parameter is left blank or not included, the date of the files will be ignored (excluding Only if newer parameter). |
|
Only if Older Than |
Date |
No |
(Empty) |
ISOLDERTHAN= "%DateSerial(2007,10,12) + TimeSerial(00,00,00)%" |
Causes this action to only decrypt files if the source is older than the date/time specified. If this parameter is left blank or not included, the date of the files will be ignored (excluding Only if newer parameter). |
Attributes
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Attributes |
Text Options |
No |
(Empty) |
ATTRFILTER="+R+A-H" (decrypt read-only & archive files but not hidden files) |
This group of settings causes the action to filter which files are decrypted based on the attribute settings of the source files. In visual mode, a group of controls are provided to assist in the selection of this parameter. In markup mode, a single text item must be specified that contains the attributes of the files you wish to decrypt. The available options are:
|
Signatures
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Email or Name |
Text |
Yes |
(Empty) |
KEYID="Jay@netauto.com" |
Specifies the name or email address used to locate the private key. Existing signatures (populated using the Public Keyring File and Secret Keyring File parameters located in the General tab) can be added by selecting the signature and clicking the Add button or simply double-clicking the signature. To manually enter an email address or name along with keyring passphrase, click the Create button and enter the email address or unique name and associated passphrase in the appropriate fields. To remove a signature, select it from the list and click the Remove button. NOTE: At least one signature is required. Therefore, one email address or name from the keyring along with its keyring passphrase needs to be entered. If there is no password associated with the email address or name in the keyring, then the Passphrase field can be left blank. Additionally, if no name or email address is used to identify the key, make sure to empty the Email or Name field of any contents. |
|
Passphrase |
Text |
Yes |
(Empty) |
PASSWORD="encrypted" |
Specifies the passphrase to be added to the private key. Existing signatures (populated using the Public Keyring File and Secret Keyring File parameters located in the General tab) can be added by selecting the signature and clicking the Move Up button or simply double-clicking the signature. To manually enter an email address or name along with keyring passphrase, click the Add button and enter the email or name and passphrase in the appropriate fields. To remove a signature, select it from the list and click the Remove button. NOTE: At least one signature is required. Therefore, one email address or name from the keyring along with its keyring passphrase needs to be entered. If there is no password associated with the email address or name in the keyring, then the Passphrase field can be left blank. Additionally, if no name or email address is used to identify the key, make sure to empty the Email or Name field of any contents. |
Example
- The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
Description: Sign files "C:\Temp\File.txt".Save signed files at "C:\Destination\". Use accounts "joe@mycompany.com" for the key.
<AMCRYPTOGRAPHY ACTIVITY="sign" INPUTFILE="C:\Temp\File.txt" OUTPUTFILE="C:\Destination\" PUBKEYRINGPATH="C:\Temp\pubring.pkr" SECKEYRINGPATH="C:\Temp\secring.skr" SIGNTYPE="detached"><SIGNER KEYID="Joe@mycompany.com" PASSWORD="AM5+Wp0q1SpFQxxAeQ3Twj7SHOXbt1ZMkLoE1oYJQB7JQ8=aME" /></AMCRYPTOGRAPHY>