Authenticate the use of Encrypted Variables

$authenticate digest

This command is used to authenticate the use of encrypted variables in an infobox or infobox collection file.  When the generated digest is valid, any variables named SECRETx may be expanded in the associated infobox(es).

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 or COLLECT), never entered manually.

When an individual infobox is to be authenticated, you should enter this command, without parameters, as the first line of 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 is correct (and that a password is present in the configuration 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.

To authenticate a whole infobox collection, name the collection with an extension .IBCA instead of .IBC, on the COLLECT command line and on the corresponding $load_ibc command.  This will cause a password to be requested in the same way as COLLECT creates the file.

When COPIAFACTS processes the script in the infobox, any expansions of a SECRETx variable expand to an empty string if they are used in the absence of authentication.  If the authentication is present but invalid (indicating that the contents of the file have been changed since the digest was generated) a run-time error occurs.

Tracing of variable assignments is suppressed inside an authenticated infobox.  If you use temporary variables to substring the expansion of a secret variable, you should set them to @EMPTY before passing control to an infobox which is not authenticated.

This command is accepted (and ignored) by CopiaFacts version 7 in engine release 7.399 and later.


$authenticate E0CA61A65F5CC162182207CF3E5BF18BAF4FC95A