Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.futurex.com/llms.txt

Use this file to discover all available pages before exploring further.

Perform the following steps to install and set up CertAgent. Internet Explorer and Firefox support its web-based interface.
1
Double-click the Certagent.7.0.5.x64.exe and follow the on-screen instructions.
2
When prompted, choose the listening port to be created for the HyperSQL database. If port 9001 is already in use, you can use 9002 or 9003.
3
CertAgent prompts you to create TLS ports and credentials for Admin and Public web interfaces.
4
After installing, configure the following details:
InformationDescription
PKCS11 Library PathSelect [ Browse ] and select the location of FXPKCS11.dll on the hard drive. (The default PKCS11 install location is C:/Program Files/Futurex.)
HSM PartitionPrompt to select one of the partitions found in the HSM.
HSM PINThis is the password for the identity created previously.
Common Name (CN) Common Name for the CA Root certificate that the CertAgent creates.
Organization NameOrganization Name for the CA Root certificate that CertAgent creates.
PKCS #12 PasswordPassword to be used for PKCS #12 files the CertAgent and the Vectera Plus generate.
Be sure to note the PKCS #12 password, admin TLS port (<admin port>), and public TLS port (<public port>) you enter during installation. You need this information to import the certificates for the web browsers to access the CertAgent sites (Administrator site, Public site, CA site)
5
Next, set the SA password along with a user account and password for the CertAgent database. Be sure to note these for future use.
The installer creates the credentials and finalizes the installation process.
6
During the installation process, you can check the following logs:
  • C:\Temp\fxpkcs11.log - for status related to all actions through the PKCS11 library.
  • C:\Program Files\CertAgent7\install.log - for CertAgent installation status.
  • C:\Program Files\CertAgent7\install-hsql.log - for HyperSQL installation status.
At the end of the installation, CertAgent creates a Readme.txt file. We recommend you read and follow the instructions for POST-installation steps.

​
Installation verification

Perform the following steps to ensure CertAgent communicates correctly with the Vectera Plus:
The following procedure requires you to add the certificates installed by CertAgent to the trusted list of your web browser.
1
After the installation completes, you can log in to the HSM through Excrypt Manager to verify the keys are generated and stored on the HSM.
2
You can use FXCLI to validate this installation. After you connect by using the connect usb command, you must run the following commands to verify the keys exist in the Vectera Plus:
FXCLI
  login user
FXCLI
  login user
FXCLI
  keytable list
If all six keys are present, the installation was successful.
3
Open a command terminal and go to the installation location of CertAgent. Then run the certagent setpin command.
4
To set a pin in the terminal, go to the System PIN Entry page shown in the Readme.txt and follow the instructions provided in the file.
5
After you set the System PIN Entry, review the Readme.txt file to find the links for the System Administrative site, the CA Account site, and the Public site.
SiteDescription
System Administrative Site
  • Admin controls over the system and server.
  • Configuration settings can be done here as well.
  • Must connect with the Admin certificate.
CA Account Site
  • When connected with the Admin certificate, it allows you to set the certificate enrollment, management, CRL, and other settings.
  • When connected with the Operations certificate, it allows you to approve, sign, and revoke CSRs and complete other certificate enrollment tasks.
Public Site
  • When connected with the Client certificate, it allows you to enroll, upload, and retrieve certificates to and from the HSM.
6
Using the Public site, send a certificate signing request by using the Enroll function. Using Internet Explorer, you can generate a key for a certificate to be signed by the HSM. Firefox cannot generate a key for you.
7
After sending in a CSR, log in to the CA Account site using the Operations certificate, find the certificate in the pending section, and issue it. Proper application configuration with the HSM enables you to use the web to issue and retrieve the certificate.