Cryptography - Verify

Declaration

<AMVERIFY INPUTFILE="text" OUTPUTFILE="text" SUBFOLDERS="Yes/No" OVERWRITE="Yes/No" ISNEWER="Yes/No" PUBKEYRINGPATH="text" SECKEYRINGPATH="text" OUTPUTDATASET="text"><AUTOVERIFY /></AMVERIFY>

Related Topics    

Overview

Verifies the signature attached to a file to validate authenticity of the sender.

Practical usage

Used to verify a file for a valid signature and decrypts the file upon proper authentication.

Parameters

General

Property Type Required Default Markup Description
Source Text Yes (Empty)
  • INPUTFILE="c:\source\file.txt"
  • INPUTFILE="c:\source\*.txt"
 The path and file name of the files to encrypt. This can be a fully qualified path and file name (preferred) or a single file (requires use of the File System - Change folder activity). You can use wildcard characters (for example, * or ?) to specify all files matching a certain mask. You can specify multiple files and file masks by separating each entry with a pipe (|). For example, c:\temp\*.txt|c:\backup\*.bak. See File Masks & Wildcards for more information.
NOTE: Files with invalid paths are ignored at runtime.
Destination Text Yes User
  • OUTPUTFILE="c:\destfile.txt"
  • OUTPUTFILE="c:\dest\
 The destination folder and (optional) file name to place the newly encrypted files. Folders that do not exist are automatically created at runtime.
Create and populate verify dataset Text No (Empty) RESULTDATASET="theResult" The name of the dataset to create and populate with results of this activity. See Datasets for more information.
Keyring file(s) - Public Text Yes (Empty) PUBKEYRINGPATH="c:\foldername\file.pkr" Specifies the path and file name of the OpenPGP or PGP public keyring file (.pkr). Entering a valid public keyring file along with a matching secret keyring file populates the Recipient(s) section with the appropriate signature information when you click Select recipients. This parameter is available only if the Encryption type parameter is set to OpenPGP public key or PGP public key.
NOTE: Automate Desktop includes the OpenPGP engine which is installed on the system during Automate Desktop installation.  
Keyring file(s) - Secret Text Yes (Empty) SECKEYRINGPATH="c:\foldername\file.skr" Specifies the path and file name of the PGP secret keyring file (.skr). Entering a valid public keyring file along with a matching secret keyring file populates the Recipient(s) section with the appropriate signature information when you click Select recipients. This parameter is available only if the Encryption type parameter is set to PGP public key.
NOTE: Automate Desktop includes the OpenPGP engine which is installed on the system during Automate Desktop installation.  

Signature

Property Type Required Default Markup Description
Sign type Text (options) Yes Non-detached SIGNTYPE="clear_text" Specifies the digital signature to use. The available options are:

  • Clear text

  • Detached

  • Non-detached
Hash algorithm Text (options) Yes Auto

  • HASHALGO="sha256"

  • HASHALGO="md5"

  • HASHALGO="sha1"

  • HASHALGO="ripemd160"

  • HASHALGO="sha256"

  • HASHALGO="sha384"

  • HASHALGO="sha512"

  • HASHALGO="sha224"

Specifies the hash algorithm to use. The available options are:

  • Auto

  • MD5

  • SHA1

  • RIPEMD160

  • SHA256

  • SHA384

  • SHA512

  • SHA224
Signer(s) - Email or Name Text Yes (Empty)
  • SIGNER KEYID="ron@fortra.com"
  • SIGNER KEYID="ron"
 Specifies the signer's name or email address used to locate the private key. You can select existing signatures (populated using values entered in the Public keyring file and Secret keyring file parameters) by selecting Select signer(s).

To manually enter an email address or name, select an empty box and enter the email address or unique name.

To remove a recipient, click X.

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, you can leave the Password parameter empty. Additionally, if no name or email address is used to identify the key, make sure to clear the Email or Name field.  
Signer(s) - Password Text Yes (Empty) PASSWORD="encrypted" Specifies the password to add to the private key. You can select existing signatures (populated using the Public Keyring File and Secret Keyring File parameters) by selecting Select signer(s).

To manually enter a password, select an empty box and enter it.

To remove a signer, select X.

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, you can leave the Password parameter empty. Additionally, if no name or email address is used to identify the key, make sure to clear the Email or Name field of any contents.    

Advanced

Property Type Required Default Markup Description
Use new features (PGP > 6.5.x) Yes/No No Yes USENEWFEATURES="NO" If selected (default), newer PGP features introduced in 6.5.x are supported.
Use old packets (PGP 2.3.x, 6.5.x) Yes/No No Yes USEOLDPACKETS="YES" If selected, older PGP encryption algorithm is supported. Disabled by default.
Remove extension (for example, enc) Text No (Empty) REMOVEEXTENSION=".enc" The extension to remove (if any).

File Options

Property Type Required Default Markup Description
Exclude mask Text No (Empty) EXCLUDE="*.txt" Omits decrypting files matching the specified masks. Filenames or wildcard masks may be used. Multiple entries may be specified by separating them with a pipe (|). 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)%" Only decrypts files if the source is newer than the specified date/time. If this parameter is left blank or not included, the date of the files is ignored (excluding Only if newer parameter).
Only if older than Date No (Empty) ISOLDERTHAN="%DateSerial(2007,10,12) + TimeSerial(00,00,00)%" Only decrypts files if the source is older than the specified date/time. If this parameter is left blank or not included, the date of the files is ignored (excluding Only if newer parameter).
Overwrite if exists Yes/No No No OVERWRITE="YES" If selected, specifies that, if destination files already exist, they are 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 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 are decrypted from the source. All other files, regardless of whether they match the mask or other parameter settings are 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 are 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 are 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.
Include subfolders Yes/No No No SUBFOLDERS="YES" If selected, specifies that, if present, subfolders are 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 are created in the destination folder, and source files are 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.
Turn archive attribute off Yes/No No No ARCHIVETURNOFF="YES" If selected, the archive attribute of the source file is OFF. The Windows archive attribute is used to track whether a file is backed up. By disabling the source file archive, this indicates to many backup programs that the file is already backed up. This parameter is disabled by default.
Match case Yes/No No No MATCHCASE="YES" If selected, the properties set within this activity are case sensitive in relation to the file. This parameter is disabled by deafult.

File 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) Causes the action to filter files that 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 want to decrypt. Available options are:
  • R—Read-only - Specifying +R causes files with this attribute turned on to be included, -R causes files with this attribute turned off to be included, not specifying the letter (default) causes this attribute to be ignored.
  • A—Archive - Specifying +A causes files with this attribute turned on to be included, -A causes files with this attribute turned off to be included, not specifying the letter (default) causes this attribute to be ignored.
  • S—System - Specifying +S causes files with this attribute turned on to be included, -S causes files with this attribute turned off to be included, not specifying the letter (default) causes this attribute to be ignored.
  • H—Hidden - Specifying +H causes files with this attribute turned on to be included, -H causes files with this attribute turned off to be included, not specifying the letter (default) causes this attribute to be ignored.
  • C—Compression - Specifying +C causes files with this attribute turned on to be included, -C causes files with this attribute turned off to be included, not specifying the letter (default) causes this attribute to be ignored.

Description

Error Causes

On Error

Additional notes

Datasets

A dataset is a multiple column, multiple row container object. This activity creates and populates a dataset containing a specific set of fields in addition to the standard dataset fields. The following table describes these fields (assuming the dataset name assigned is theDataset).

Name Type Return value
theDataset.Cached True/False Returns TRUE if files are cached; otherwise, returns FALSE.
theDataset.ColumnNames Text A comma-delimited list of the column names in the dataset.
theDataset.CurrentRow Number The current row accessed in the dataset by an expression that does not contain a specific row index.
theDataset.Datasource Text The datasource used for the SQL Query, if applicable.
theDataset.Destination Text The path and file name of the destination file.
theDataset.Error Text A textual description of the error that occurred (if any). If no errors occurred during the decryption step, this dataset will remain empty.
theDataset.ExecutionDate Date The date and time the dataset is created and populated
theDataset.Result True/False Returns TRUE if result of activity is a success; otherwise, returns FALSE.
theDataset.RowsAffected Number The number of rows affected by an update.
theDataset.Signature Text Contains the signature user information. The returned dataset signature may contain the following values:
  • The name and email associated with the key.
  • No Name - The dataset returns No Name if there are empty identifiers for the key (for example, name, email) in the specified keyring.
  • Unknown Key -The dataset returns Unknown Key if the key has no identifier in the available keyring.
theDataset.SignatureFile Text The path and file name of the signature folder and file.
theDataset.SignType Text The digital signature type that was used to sign the file.
theDataset.Source Text The path and file name of the source folder and file.
theDataset.SQLQuery Text The SQL Query that was used to generate this dataset. If a SQL Query is not used, this value is empty.
theDataset.TotalColumns Number The total number of rows in the dataset.
theDataset.TotalRows Number The total number of rows in the dataset.
theDataset.Validity Text Contains the signature verification results. The returned verification results can contain the following values:

  • Valid - Specifies that the key is valid.

  • Invalid - Specifies that the key is invalid.

  • Corrupted - Specifies that the key is corrupt.

  • KeyNotFound - Specifies that there were no valid keys found. This result can occur when a Key/Passphrase combination set does not match the one contained in the keyring.

  • UnknownAlgorithm - Specifies an unknown or unsupported algorithm type.

Example

NOTE:
  • Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
  • To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.

The following sample task verifies a signature file, and then creates and populates a dataset with the results:

Copy 
<AMCRYPTOGRAPHY ACTIVITY="verify" INPUTFILE="C:\test\signed.txt" SIGNATUREFILE="C:\test\signed.txt" RESULTDATASET="Verify" PUBKEYRINGPATH="C:\test\PGPKeyManager\BobKeyring.pkr" SECKEYRINGPATH="C:\test\PGPKeyManager\BobKeyring.skr" SIGNTYPE="detached" />