Enabling the debugging mode

As explained in Installing the Signing Automation Client, the out-of-the-box distribution includes the pkcs11-logger third-party library for debugging purposes. In debugging mode, this library logs PKCS #11 operations by sitting between the Signing Application Client and the P11SigningClient64 library.

  1. The Signing Application Client sends the PKCS #11 operation calls to the pkcs11-logger library.

  2. The pkcs11-logger library redirects the calls to the P11SigningClient64 library.

  3. The pkcs11-logger library returns the call results to the Signing Application Client.

To enable the debugging mode of the Signing Automation Client

  1. Rrun the signingclient config set command and use the pkcs11-logger library path as value of the --library option. For example:

    signingclient config set --library "C:\Program Files\Entrust\SigningClient\pkcs11-logger64.dll"

  2. Set the following environment variables.

PKCS11_LOGGER_LIBRARY_PATH

The path of the P11SigningClient64.dll library. As explained in Installing the Signing Automation Client, the default path of this library is the following.

C:\Program Files\Entrust\SigningClient\P11SigningClient64.dll

Do not enclose the path with quotes.

PKCS11_LOGGER_LOG_FILE_PATH

Set the value of this environment variable to the path of the file where logs will be recorded.

Do not enclose the path with quotes.

PKCS11_LOGGER_FLAGS

The sum of requested logging flags.

Hex

Dec

Flag

0x01

1

Disables logging into the log file

0x02

2

Disables logging process identifiers.

0x04

4

Disables logging thread identifiers.

0x08

8

Enables logging personal identification numbers (PINs).

0x10

16

Enables logging to the standard output (stdout).

0x20

32

Enables logging to the standard error destination (stderr).

0x40

64

Enables reopening of the log file. This feature decreases performance but allows deleting the log file when needed.

For example, a value of 6 disables logging:

  • The process identifier.

  • The thread identifier.

When not set, this variable defaults to 0.