Please enable JavaScript to view this site.

CopiaFacts™ Reference Manual

Navigation: Commands > Fax to Send File [FS]

$authenticate [FST]

Scroll Prev Top Next More

Authenticate the use of Encrypted Variables

$authenticate digest

This command is used to authenticate the use of encrypted variables in a template file for use with the Copia SMTP Gateway.  When the generated digest is valid,  a variable named  may be expanded as the passphrase of an $email_decrypt_keyfile command.

The parameter on this command is used as follows:

digesta digest computed automatically from the contents of the file.  This parameter is always generated (by COPIAEDIT), never entered manually.

The command is needed for the following types of templates and usages:

•A Special Recipient template file, to authenticate the use of SECRETx in the passphrase parameter of an $email_decrypt_keyfile command. This command is used in the decryption of incoming encrypted messages.

•A Sender template file, to authenticate the definition of a system variable named SIGN_SECRET.  This variable can then be used in a post-processing script, to send a signed notification, on an $email_sign_keyfile command, even if the command appears inside a block of conditional ($if, etc.) commands. The  where  a

When an template is to be authenticated, you should enter this command, without parameters, as the first line of the file.  If COPIAEDIT finds a 'SECRET or @SECRET parameter in the commands in the file, it will also prompt for a password and add this command to the file.

On saving the file, you will be prompted for the password assigned by the administrator in the CFHWL configurator.  Provided that the password matches the one set for secret variables in the FAXCOUNT.HWL file the digest will automatically be added (and displayed) as the file is saved.  If you edit an authenticated file, a new digest will be computed in the same way when you save it.

When the SMTP Gateway processes the template, any expansions of a SECRETx variable in the absence of authentication will cause the operation to fail.

Because FS files are dynamic, and can change several times while being processed, authentication is only used in FST files, not FS files.

Example:

$authenticate E0CA61A65F5CC162182207CF3E5BF18BAF4FC95A