Gradle script integration with PKCS11
Prerequisites
Gradle installed on the agent
JDK installed on the agent
access setup
client for the specific OS (client tools)
PKSC11 library (client tools)
Nota
Client tools can be downloaded from DigiCert One portal at > Resources >Client tool repository.
Client tools
DigiCert® KeyLocker clients can be downloaded in a package.
Download Client tools
Sign in to DigiCert ONE.
Navigate to DigiCert® KeyLocker > Resources > Client tool repository.
Select your operating system.
Click the download icon next to DigiCert® KeyLocker clients.
Create PKCS11 configuration file
To create a configuration file with the path to this shared library:
Open an integrated development environment (IDE) or plain text editor.
Copy and paste the following text into the editor:
Save the file as pkcs11properties.cfg.
Move the pkcs11properties.cfg file to the same location as the PKCS11 library.
Set PATH environment variables
Operating systems use the environment variable called PATH to determine where executable files are stored on your system. Use the PATH environment variable to store the file path to your signing tools to ensure that the CLI can reference these signing tools.
User authentication
DigiCert® KeyLocker enforces multifactor authentication for security. To access keypairs, certificates, and sign code, you need to set up two types of credentials: an API token and an authentication certificate.
Create an API token
The API token is an authentication method used to verify you as a user and your permissions assigned in DigiCert ONE. The API token provides the first factor authentication.
Follow these steps to generate an API token:
Sign in to DigiCert ONE.
Select the profile icon (top-right).
Select Admin Profile.
Scroll down to API Tokens.
Select Create API token.
Nota
The API token is only shown once, securely store the API key to use it later.
Create an authentication certificate
The client authentication certificate is an authentication method used to verify you as a user and your permissions assigned in DigiCert ONE. The client authentication certificate provides the second factor authentication.
Follow these steps to create a client authentication certificate:
Sign in to DigiCert ONE.
Select the profile icon (top-right).
Select Admin Profile.
Scroll down to Authentication certificates.
Select Create authentication certificate.
Nota
The client authentication certificate password shown after creating an client authentication certificate cannot be accessed again, download the certificate and securely store the password to use it later.
DigiCert® KeyLocker environment variables
Set the following environment variables:
Variable | Description |
|---|---|
SM_API_KEY | Provide your API token. |
SM_CLIENT_CERT_FILE | Provide your client authentication certificate. |
SM_CLIENT_CERT_PASSWORD | Provide your client certificate password. |
SM_HOST | Provide your host environment. |
PKCS11_CONFIG | Provide the path to the PKCS11 configuration file. |
Secure your credentials
Your DigiCert ONE host environment, API key, client authentication certificate and password makes up your environment variables and are required to access DigiCert® KeyLocker client tools. Use one of the methods provided below to securely store your credentials based on your operating system.
Sign
To integrate PKCS11 with Gradle implementation, add the code snippet to the build.gradle file:
plugins {
// Apply the java-library plugin for API and implementation separation.
id 'java'
}
task sign(type: Exec, dependsOn: 'jar', description: 'jar signing using DigiCert Signing Manager pkcs11', group: 'Build') {
def storePassword = "NONE"
def keyStore = "NONE"
def storeType = "PKCS11"
def providerClass = "sun.security.pkcs11.SunPKCS11"
def providerArg = "<Path to smpkcs11.config>"
def alias = "<keypair alias>"
def signedjarfile = "<Path of signed file>"
def unsignedjarfile=""<Path of unsigned file>""
commandLine "${System.env.JAVA_HOME}/bin/jarsigner.exe", "-keystore", keyStore, "-storepass", storePassword, "-storetype", storeType, "-providerClass", providerClass, "-providerArg", providerArg, "-signedjar", signedjarfile, "-unsignedjarfile", unsignedjarfile, alias
}The input parameters for the example are the path to the alias of the keypair, the configuration file, the path where the signed jar needs to be output, the path to the jar that needs to be signed, and the name of the certificate that needs to be used for signing.
Verify signature
An example of a Gradle setup that verifies a signed jar:
plugins {
// Apply the java-library plugin for API and implementation separation.
id 'java'
}
task verify(type: Exec, dependsOn: 'jar', description: 'jar verification using DigiCert Signing Manager pkcs11', group: 'Build') {
def signedjarfile = ""<Path of signed file>""
commandLine "${System.env.JAVA_HOME}/bin/jarsigner.exe", "-verify", signedjarfile
}The only input for this stage is the path to the signed jar that needs to be verified.