Scripts for signing using KSP library on CircleCI

To register the KSP, open a command prompt and run:

smksp_registrar.exe register

To verify that your KSP is configured properly, and that your client can properly authenticate to the DigiCert​​®​​ KeyLocker service, run:

certutil.exe -csp "DigiCert Software Trust Manager KSP" -key -user

For the client tools to access the private keys in the service through the Key Storage Provider (KSP), your certificates must be synchronized to the local certificate store. Only if the certificate is synchronized, the private key remains stored securely in DigiCert​​®​​ KeyLocker.

To synchronize your certificates to the local certificate store, open a command prompt and run:

smksp_cert_sync.exe

To view the certificates, open Certificate Manager for the user account used to run the certificate sync utility:

certmgr.msc

If you do not see your certificates in the Certificate Manager, verify that you have opened the correct certificate store. There is a different certificate store for each Windows user account.

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.

set PATH=%path%;<path to DigiCert Keylocker Tools>

set PATH=%path%;C:\Program Files\DigiCert\DigiCert Keylocker Tools

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:

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:

To sign with SignTool:

steps:
  - checkout
  - run:
      name: "Signtool-Signing"
      command: |
        & $env:Signtool sign /sha1 <certificate thumbprint> /tr http://timestamp.digicert.com /td SHA256 /fd SHA256 <file to be signed>
environment:
  Signtool: 'C:\Program Files (x86)\Windows Kits\10\App Certification Kit\signtool.exe'

The input parameters are the thumbprint of the certificate to be used for signing and the path to the .exe or .dll to be signed.

To sign with Mage:

steps:
  - checkout
  - run:
      name: "Mage-Signing"
      command: |
        & $env:Mage -sign <file_name> -CertHash <hash_or_cert_fingerprint> -a sha256RSA
environment:
  Mage: 'C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.8 Tools\mage.exe'

The input parameters are the path to the .application file to be signed and the thumbprint of the certificate. You can find the thumbprint on the Certificate details page in DigiCert ONE.

To sign with NuGet:

steps:
  - checkout
  - run:
      name: "Nuget-Signing"
      command: |
        nuget sign <package folder> -Timestamper http://timestamp.digicert.com -outputdirectory <output folder> -Certificate Fingerprint <SHA1 Thumbprint> -HashAlgorithm SHA256 -Verbosity detailed -Overwrite

The inputs to this task are the path to the package and the thumbprint of the certificate. You can find the certificate thumbprint on Certificate details page in DigiCert ONE.

To verify a signature with Mage:

steps:
  - checkout
  - run:
      name: "Mage-Verification"
      command: |
        & $env:Mage -Verify <Path to signed .application file>
environment:
  Mage: 'C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.8 Tools\mage.exe'

The only input required here is the path to the signed .application file.

To verify a signature with NuGet:

steps:
  - checkout
  - run:
      name: "Nuget-Verification"
      command: |
        nuget verify -All <output folder>\*

To verify a signature with SignTool:

steps:
  - checkout
  - run:
      name: "Signtool-Verification"
      command: |
        & $env:Signtool verify /v /pa <Path to the signed exe/DLL>
environment:
  Signtool: 'C:\Program Files (x86)\Windows Kits\10\App Certification Kit\signtool.exe'

The only input for this step is the path to the signed .exe or .dll that needs to be verified.