Scripts for signing using PKCS11 library on Maven

Prerequisites

Maven installed on the agent
JDK installed on the agent
DigiCert® Software Trust Manager access setup
DigiCert® Software Trust Manager client for the specific OS (client tools)
DigiCert® Software Trust Manager PKSC11 library (client tools)

Note

Client tools can be downloaded from DigiCert ONE® portal at DigiCert® Software Trust Manager > Resources > Client tool repository.

Client tools

DigiCert® Software Trust Manager clients can be downloaded in a package.

Download client tools

Sign in to DigiCert ONE.
Navigate to DigiCert® Software Trust Manager > Resources > Client tool repository.
Select your operating system.
Click the download icon next to DigiCert® Software Trust Manager 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:

Example 1. Windows

name=signingmanager 
library="<path to smpkcs11.dll>"
slotListIndex=0

Sample

name=signingmanager 
library="C:\\Program Files\\DigiCert\\DigiCert One Signing Manager Tools\\smpkcs11.dll"
slotListIndex=0

Example 2. Linux

name=signingmanager 
library="<path to smpkcs11.so>"
slotListIndex=0

Sample:

name=signingmanager 
library="/home/<user>/smtools-linux-x64/smpkcs11.so" 
slotListIndex=0

Example 3. macOS

name=signingmanager 
library=<path to smpkcs11.dylib> 
slotListIndex=0

Sample:

name=signingmanager 
library=/Users/<user>/digicert/smtools-mac/smpkcs11.dylib" 
slotListIndex=0

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.

Example 4. Windows

You can set the PATH environment variable using command line or via the environment variables.

To set the path to your signing tools via command line:

set PATH=%path%;<path to DigiCert One Signing Manager Tools>

Command sample:

set PATH=%path%;C:\Program Files\DigiCert\DigiCert One Signing Manager Tools

To set the path to your signing tools for your system or account:

Search for environment variables in the Windows start menu.
Select Edit environment variables for your account or Edit system environment variables.
Double click on the Path variable.
Click New.
Select Browse.
Select the path to the signing tool.
Click OK to save the path.
Click on OK to close the dialog.

Example 5. Linux

To set the path to your signing tools via command line:

Launch the Terminal application.
Open the file in an editor:
```
nano ~/.profile
```

Add any exports definitions you need:

export PATH=<Path to DigiCert One Signing Manager Tools>

Click CTRL+X to exit.
Click Y to save.
Click Enter to keep the same file name.
Execute the new .profile by restarting Terminal or using:
```
 source ~/.profile
```

Example 6. macOS

To set the path to your signing tools via command line:

Launch the Terminal application.
Create a profile file:
```
touch ~/.zprofile
```
Open the file in an editor:
```
open ~/.zprofile
```

Add any exports definitions you need, such as:

export PATH=<Path to DigiCert One Signing Manager Tools>

To save the new .zprofile, click File > Save (CMD + S).
Close the terminal window and reopen to use new saved variables.

User authentication

Software Trust Manager 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.
Note
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.
Note
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® Software Trust Manager 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.
SM_TLS_SKIP_VERIFY	Enter true to disable or false to enable TLS verification on client side.

Create keypair and certificate

As an example, to generate an RSA test keypair with certificate, create a .bat file which contains the command to generate the test keypair. The contents of smtcl_gen_testcert.bat are:

keypair generate rsa <keypair alias> --cert-alias=<certificate alias> --cert-profile-id=<certificate profile ID> --generate-cert=true --key-type=TEST

Then, add in the pom.xml:

<plugins>
<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-antrun-plugin</artifactId>
        <version>3.0.0</version>
        <executions>
            <execution>
              <phase>generate-sources</phase>
                <configuration>
                    <target>
                        <exec dir="C:\smtools" executable="smctl_gen_testcert.bat"  failonerror="true">
                        </exec>
                    </target>
                </configuration>
                <goals>
                    <goal>run</goal>
                </goals>
       </execution>
   </executions>      
</plugin>
</plugins>

The keypair name and certificate name are must be unique inputs, meaning that they cannot exist on the portal already.

The certificate profile ID to be used can be retrieved from the DigiCert One portal at DigiCert® Software Trust Manager > Certificates > Certificate profiles. Select a profile (Profile Category should be Test) that you want to generate the certificate with, and you should see the profile ID.

Create production keypair with certificate

As an example, to generate an RSA production keypair with certificate, create a .bat file which contains the command to generate the production keypair. The contents of smtcl_gen_prodcert.bat are:

keypair generate rsa <keypair alias> --cert-alias=<certificate alias> --cert-profile-id=<certificate profile ID> --generate-cert=true --key-type=PRODUCTION

Then, add in the pom.xml:

<plugins>
<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-antrun-plugin</artifactId>
        <version>3.0.0</version>
        <executions>
            <execution>
              <phase>generate-sources</phase>
                <configuration>
                    <target>
                        <exec dir="C:\smtools" executable="smctl_gen_prodcert.bat"  failonerror="true">
                        </exec>
                    </target>
                </configuration>
                <goals>
                    <goal>run</goal>
                </goals>
       </execution>
   </executions>      
</plugin>
</plugins>

The parameters are the same as the previous case, but be sure to select a certificate profile that has the profile category as Production.

Create certificate from an existing keypair

As an example, to generate a certificate for an existing keypair, create a .bat file which contains the command to generate a certificate for an existing keypair. Here, the contents of smctl_gen_cert_for_keypair.bat are:

smctl keypair generate-cert <keypair ID> --cert-alias=<certificate alias> --cert-profile-id=<certificate profile ID> --set-as-default-cert=true

Then, add in the pom.xml:

<plugins>
<plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-antrun-plugin</artifactId>
        <version>3.0.0</version>
        <executions>
            <execution>
              <phase>generate-sources</phase>
                <configuration>
                    <target>
                        <exec dir="C:\smtools" executable="smctl_gen_cert_for_keypair.bat"  failonerror="true">
                        </exec>
                    </target>
                </configuration>
                <goals>
                    <goal>run</goal>
                </goals>
       </execution>
   </executions>      
</plugin>
</plugins>

For this step, the inputs required are a keypair ID, certificate name (which should be unique), and certificate profile ID. The keypair ID can be retrieved in two ways:

Run a smctl keypair ls command on the command line with all environment variables set up.
Refer to DigiCert® Software Trust Manager on the DigiCert One portal and go to DigiCert® Software Trust Manager > Keypairs and select a keypair.

Also, as in the previous use cases, the certificate profile ID used should belong to the correct profile category.

Sign

Apache Maven provides a plugin for integration with jarsigner. To integrate the DigiCert® Software Trust Manager PKCS11 with your Maven implementation, you need to update the Build properties in your POM.xml file to use this plugin.

Plugins

groupId = org.apache.maven.plugins
artifactId = maven-jarsigner-plugin
version = 3.0.0

Executions

id = sign
goal = sign

Configurations

keystore = NONE
alias = <certificate alias>
storepass = none
keypass = none
providerClass = sun.security.pkcs11.SunPKCS11
storetype = PKCS11
providerArg = <path to pkcs11 config file>

For example:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<artifact.classifier />
</properties>
<groupId>com.digicert</groupId>
<artifactId>signing</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>pkcs11</name>
<description>pkcs11 signing</description>
<url>https://github.com/company/project</url>
<prerequisites>
<maven>3.3.9</maven>
</prerequisites>
<dependencies/>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jarsigner-plugin</artifactId>
<version>3.0.0</version>
<executions>
<execution>
<id>sign</id>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
<configuration>
<keystore>NONE</keystore>
<alias>KPRose</alias>
<storepass>none</storepass>
<providerClass>sun.security.pkcs11.SunPKCS11</providerClass>
<storetype>PKCS11</storetype>
<providerArg>C:\smtools\pkcs11properties.cfg</providerArg>
<tsa>http://timestamp.digicert.com</tsa>
</configuration>
</plugin>
</plugins>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<extensions>true</extensions>
<configuration>
<source>1.8</source>
<target>1.8</target>
<compilerArgs>-Xlint</compilerArgs>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<version>${maven.release.version}</version>
<configuration>
<autoVersionSubmodules>true</autoVersionSubmodules>
<tagNameFormat>ProjectName-@{project.version}</tagNameFormat>
</configuration>
</plugin>
</plugins>
</pluginManagement>
</build>
</project>

Verify signature

To verify a signature:

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jarsigner-plugin</artifactId>
<version>3.0.0</version>
<executions>
<execution>
<id>verify</id>
<goals>
<goal>verify</goal>
</goals>
</execution>
</executions>
<configuration>
<verbose>true</verbose>
<certs>true</certs>
</configuration>
</plugin>

In this section:

Scripts for signing using PKCS11 library on Maven

Prerequisites

Note

Client tools

Download client tools

Create PKCS11 configuration file

Set PATH environment variables

User authentication

Create an API token

Note

Create an authentication certificate

Note

DigiCert​​®​​ Software Trust Manager environment variables

Create keypair and certificate

Sign

Verify signature

Related articles

Search results

DigiCert® Software Trust Manager environment variables