PKCS11との Gradle統合
前提条件
エージェントにインストールされた Gradle
エージェントにインストールされたJDK
DigiCert® Software Trust Managerのアクセス権セットアップ
特定の OS 用の DigiCert® Software Trust Manager クライアント（クライアントツール）
DigiCert® Software Trust Manager PKSC11ライブラリ (クライアントツール)
注記
クライアントツールは、DigiCert Oneポータルの DigiCert® Software Trust Manager -> リソース -> クライアントツールからダウンロードすることができます。
Client tools
DigiCert® KeyLocker clients can be downloaded as a package.
Download client tools
In the KeyLocker menu, go to Resources > Client tool repository.
Select your operating system, and then select the corresponding download (
) icon next to the desired client.
Create PKCS11 configuration file
To create a configuration file with the path to the 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
KeyLocker enforces multi-factor authentication for security purposes. To access keypairs, certificates, and sign code, you need to set up two types of credentials: An API key and an authentication certificate.
Create an API key
The API key is an authentication method used to verify you as a user and your permissions assigned in DigiCert ONE. The API key provides the first factor authentication.
In DigiCert ONE, select the profile (
) icon, and then select Admin Profile.Under API keys, select Create API key.
For Name, enter a descriptive name for the key.
For End date (optional), enter the date when the key should expire.
Select Create. The API key appears this one time and can't be accessed again. Securely store the API key for future use.
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.
In DigiCert ONE, select the profile (
) icon, and then select Admin Profile.Under Client authentication certificates, select Create client authentication certificate.
For Nickname, enter a descriptive name for the key.
For End date, enter the date when the certificate should expire.
Select the desired Encryption and Signature hash algorithm.
Select Generate certificate. The password appears this one time and can't be accessed again. Download the certificate and securely store the password for future use.
DigiCert® Software Trust Managerのセットアップ
システム変数として設定することで、環境変数が永続的に残るようにしてください。
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 PKCS#11 configuration file. |
SM_TLS_SKIP_VERIFY | Enter true to disable or false to enable TLS verification on the client side. |
Secure your credentials
Your DigiCert ONE host environment, API key, client authentication certificate, and password make up your environment variables and are required to access KeyLocker client tools. Use one of the following methods 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
}上記の例の入力パラメータは、鍵ペアのエイリアスのパス、設定ファイル、署名済みJarを出力する必要があるパス、署名する必要がある jarのパス、および署名に使用する証明書名です。
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
}この段階での入力は、検証が必要な署名付き jarのパスのみです。