Skip to main content
AppViewX authenticates to CryptoHub as the identity a service endpoint provisions, and the keys it generates land in a key group you designate. Deploy the AppViewX service and create those objects before you configure AppViewX.

Deploy the AppViewX service and create an endpoint

Deploy the AppViewX service and create an endpoint for it. Creating the endpoint provisions the scoped partition, the identity AppViewX authenticates as, and that identity’s access, and authorizes the Host API commands it sends. The endpoint is a REST API endpoint, so the identity can authenticate over the CryptoHub REST API with no further identity configuration. You do not create the partition, configure its access, enable the commands in Host API Options, or enable REST API login by hand. AppViewX can authenticate with either of two methods, which you choose when you deploy the service:
  • User name and password (UserPass, the default): AppViewX logs in to the CryptoHub REST API and carries the returned token on each request.
  • Client certificate (TlsBundle): AppViewX presents a client certificate that CryptoHub issues for the endpoint identity on every request. It makes no login call and handles no token.
1
Log in to the CryptoHub under dual control with your administrator identities.
2
On the Services page, select the AppViewX service and select [ Deploy ]. Accept the default Service Name and Service Category, and step through Access Control.
3
On the Service Info step, under Authentication Mechanisms, choose how the AppViewX endpoint authenticates. The list shows the method names as follows:
  • UserPass for user name and password. This is the default.
  • TlsBundle for client certificate.
Select [ Deploy ].
The authentication method is fixed when you deploy the service. To change the method later, deploy a new AppViewX service with the other method and create an endpoint for it.
4
Open the Endpoints menu for the AppViewX service and select [ Add New ]. Enter an identifier or leave it blank for auto-generation, leave the CryptoHub Hostname as is, and select [ Add Endpoint ]. The browser downloads a bundle for the endpoint.The endpoint authorizes the Host API commands the integration sends, RKPK and RKOP:request.
5
Record the endpoint credentials from the downloaded bundle for the method you chose. You store them in the AppViewX vault in Configure AppViewX to authenticate to CryptoHub.
  • User name and password (UserPass): record the endpoint’s username and password from credential.txt.
  • Client certificate (TlsBundle): keep the following files from the bundle:
    • pki.p12: the client certificate and its private key, in encrypted PKCS #12 format.
    • pki-password.txt: the password for pki.p12.
    • client-cert.pem: the client certificate.
    • ca-chain.pem: the CA certificate bundle.
Treat the endpoint password, pki.p12, and pki-password.txt as secrets. Store them only in the AppViewX vault, and do not place them in workflow definitions, scripts, or logs.
For the standard service deployment and endpoint flow this integration follows, see Service guides.

Create the key group and give AppViewX access

The generated key pairs are stored in a key group. AppViewX passes the group name when it generates each key pair. For details on key groups, see About key database.
1
Go to Key Management > Key Database.
2
Under KEY GROUPS, select [ Create ]. Set Key Type to Asymmetric and Storage Location to HSM Trusted, and select [ OK ].
3
On the Group tab, enter a Name, select an Algorithm (RSA or ECC) and its key length or curve, and leave Key Usage as Sign + Verify. Select [ OK ]. Record the group name.
4
Right-click the new group and select Permission….
5
In the resource list, select the role of the AppViewX service, named after the service, for example AppViewX-AppViewX-<number>. Select [ Add ].
6
In the new row, set Permission to Add, then select [ Save ].
Key generation into the group requires the Add access level. With no access, key generation returns UNKNOWN KEY GROUP. With Use or Modify, it returns KEY GROUP PERMISSIONS LACKING. Deploying the AppViewX service does not give its role access to an existing key group.
A key pair keeps the algorithm and size requested in each key generation request, regardless of the algorithm set on the group. One group can hold both RSA and ECC key pairs. Create separate groups only if you want to organize keys by algorithm or purpose.

Next steps

Configure AppViewX to authenticate with the endpoint credentials or client certificate. See Configure AppViewX to authenticate to CryptoHub.