Cryptography - Encrypt and sign
Declaration
<AMCRYPTOGRAPHY SUBFOLDERS="yes/no" KEEPFOLDERSTRUCT="yes/no" OVERWRITE="yes/no" ISNEWER="yes/no" ONLYIFEXIST="yes/no" OVERWRITEREADONLY="yes/no" OVERWRITEHIDDEN="yes/no" ARCHIVETURNOFF="yes/no" MATCHCASE="yes/no" EXCLUDE="text" RE="yes/no" INPUTFILE="text" OUTPUTFILE="text" RESULTDATASET="text" PUBKEYRINGPATH="text" SECKEYRINGPATH="text" PASSPHRASE="text (encrypted)" HASHALGO="text (options)" SYMMETRICALGO="text (options)" PROTECTION="text (options)" COMPRESSIONALGO="text (options)" USEOLDPACKETS="YES/NO" INPUTTEXT="yes/no" ARMOR="YES/NO" TAR="YES/NO" SELFEXTRACT="YES/NO" APPENDEXTENSION="text" ATTRFILTER="+r" />
Description
Encrypts and digitally signs one or more files in a single automated sequence.
Practical Usage
Ideal for keeping sensitive and confidential information private.
General Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Source |
Text |
Yes |
(Empty) |
|
The path and filename of the file(s) to encrypt. Wildcard characters such as asterisk (*) and question mark (?) can be used to encrypt files matching a certain mask. |
Destination |
Text |
Yes |
(Empty) |
|
The destination folder and (optional) filename of to place the newly encrypted files. Folders that do not exist will be automatically created at runtime. |
Create and populate dataset |
Text |
Yes |
(Empty) |
RESUTDATASET="myData" |
The name of the dataset to create and populate with information about this operation. |
Public keyring file |
Text |
Yes |
(Empty) |
PUBKEYRINGPATH="c:\Folder\File.pkr" |
The path and filename 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: is equipped with the OpenPGP engine which is installed on the system during installation. |
Secret keyring file |
Text |
Yes |
(Empty) |
SECKEYRINGPATH="c:\Folder\File.skr" |
The path and filename 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: is equipped with the OpenPGP engine which is installed on the system during installation. |
Recipient/Signer Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Use conventional (passphrase) encryption |
|
|
|
|
|
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 e-mail address or name along with keyring passphrase, click the Add button and enter the e-mail 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 e-mail address or name in the keyring, then the Passphrase field can be left blank. Additionally, if no name or e-mail address is used to identify the key, make sure to empty the Email or Name field of any contents. |
Recipient(s) Email or Name |
Text |
Yes |
(Empty) |
|
Specifies the recipient name or email address used to locate the private key. Existing signatures (populated using values entered in the Public keyring file and Secret keyring file parameters) can be added by selecting the signature and clicking the Add button or simply double-clicking the signature. To manually enter an e-mail 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 e-mail 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. |
Signer(s) Email or Name |
Text |
Yes |
(Empty) |
|
Specifies the name or e-mail address used to locate the private key. Existing signatures (populated using values entered in the Public keyring file and Secret keyring file parameters) can be added by selecting the signature and clicking the Add button or simply double-clicking the signature. To manually enter an e-mail 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 e-mail 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. |
Symmetric algorithm |
Text (options) |
Yes |
CAST5 |
|
The symmetric algorithm to encrypt and sign the file. The available options are:
|
Hash algorithm |
Text (options) |
Yes |
Auto |
|
|
Protection level |
Text (options) |
Yes |
Normal |
|
|
Compression algorithm |
Text (options) |
Yes |
None |
|
|
Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.
Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)
On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)