GitHubの統合 –KSP

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​​®​​ Software Trust Manager 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​​®​​ Software Trust Manager.

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 One Signing Manager Tools>

set PATH=%path%;C:\Program Files\DigiCert\DigiCert One Signing Manager 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:

クライアントツールがDigiCert​​®​​ Software Trust Managerと接続するためには、これらの環境変数が必要です。

環境変数を GitHub シークレットとして統合するには、次を行います。

これらの環境変数に設定する値は、以下のようになります。

環境変数を設定するコマンド:

- name: Set variables
  id: variables
  run: |
    echo "::set-output name=version::${GITHUB_REF#refs/tags/v}"
    echo "SM_HOST=${{ secrets.SM_HOST }}" >> "$GITHUB_ENV"
    echo "SM_API_KEY=${{ secrets.SM_API_KEY }}" >> "$GITHUB_ENV"
    echo "SM_CLIENT_CERT_FILE=D:\\Certificate_pkcs12.p12" >> "$GITHUB_ENV"
    echo "SM_CLIENT_CERT_PASSWORD=${{ secrets.SM_CLIENT_CERT_PASSWORD }}" >> "$GITHUB_ENV"
    echo "C:\Program Files (x86)\Windows Kits\10\App Certification Kit" >> $GITHUB_PATH
    echo "C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.8 Tools" >> $GITHUB_PATH
    echo "C:\Program Files\DigiCert\DigiCert One Signing Manager Tools" >> $GITHUB_PATH
  shell: bash

GitHub の操作からクライアントコントロールを呼び出すには、以下を実行します。

以下の curl コマンドで smtools-Windows-x64.msI をダウンロードしてインストールします。

- name: Setup SSM KSP on windows latest
  run: |
    curl -X GET  https://one.digicert.com/signingmanager/api-ui/v1/releases/smtools-windows-x64.msi/download -H "x-api-key:%SM_API_KEY%" -o smtools-windows-x64.msi
    msiexec /i smtools-windows-x64.msi /quiet /qn
  shell: cmd

KSPが登録されていることを確認するには、以下を実行します。

- name: Register KSP
  run: |
    smksp_registrar.exe list
  shell: cmd

証明書付きの RSA テスト鍵ペアを生成する GitHub 操作の例：

- name: Generate Test Keypair
  run: |
      smctl keypair generate rsa <Keypair Name> --cert-alias=<Certificate Name> --cert-profile-id=<Certificate Profile ID> --generate-cert=true --key-type=TEST
  shell: cmd

鍵ペア名と証明書名は、一意でなければなりません。つまりポータル上に既に存在することはできません。

証明書プロファイルIDを取得するには：

証明書付きの RSA プロダクション鍵ペアを生成する GitHub 操作のステップの例：

- name: Generate Production Keypair
  run: |
    smctl keypair generate rsa <Keypair Name> --cert-alias=<Certificate Name> --cert-profile-id=<Certificate Profile ID> --generate-cert=true --key-type=PRODUCTION
  shell: cmd

パラメータは前の場合と同じですが、プロファイルカテゴリが「プロダクション」である証明書プロファイルを選択していることを確認してください。

既存の鍵ペアの証明書を生成する GitHub 操作ステップの例：

- name: Generate Certificate for Existing Keypair
  run: |
    smctl keypair generate-cert <Keypair ID> --cert-alias=<Certificate Name> --cert-profile-id=<Certificate Profile ID>
  shell: cmd

このステップで必要な入力は、鍵ペアID、証明書名（一意でなければなりません）、および証明書プロファイルIDです。鍵ペアIDを取得するには、次の2つの方法があります。

前述の使用ケースと同様に、使用する証明書プロファイルIDは正しいプロファイルカテゴリに属していなければなりません。

To sign with Mage:

- name: Signing using mage
  run: |
    mage.exe -sign <file_name> -CertHash <hash_or_cert_fingerprint> -a sha256RSA
 shell: cmd

To sign with NuGet:

- name: Signing using nuget
  run: |
    nuget sign <package folder> -Timestamper http://timestamp.digicert.com -outputdirectory <output folder> -Certificate Fingerprint <SHA1 Thumbprint> -HashAlgorithm SHA256 -Verbosity detailed -Overwrite
  shell: cmd

To sign with SignTool:

- name: Signing using signtool
  run: |
    signtool.exe sign /sha1 <certificate thumbprint> /tr http://timestamp.digicert.com /td SHA256 /fd SHA256 <file to be signed>
 shell: cmd

To verify a signature with Mage:

- name: Mage verify
  run: |
    mage -Verify <Path to signed .application file>
  shell: cmd- name: Mage verify
run: |
mage -Verify <path to signed .application file>
shell: cmd

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

To verify a signature with NuGet:

- name: Nuget verify
  run: |
    nuget verify -All <output folder>\*
  shell: cmd- name: Nuget verify
run: |
nuget verify -All <output folder>\*
shell: cmd

The only input required here is the path to the signed folder.

To verify a signature with SignTool:

- name: Signtool verify
  run: |
    signtool verify /v /pa <Path to the signed exe/DLL>
  shell: cmd- name: Signtool verify
run: |
signtool verify /v /pa <path to the signed .exe or .dll>
shell: cmd

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

name: 'build and release electron installer'
on:
  push:
    tags:
      - 'v*'
      
jobs:
  release:
    runs-on: ${{ matrix.os }}
    
    strategy:
      matrix:
        os: [windows-latest]
        
    steps:
      - name: Check out Git repository
        uses: actions/checkout@v2

      - name: Install Node.js, NPM and Yarn
        uses: actions/setup-node@v2
        with: 
          node-version: 14
        
      - name: Build/release Electron app
        uses: samuelmeuli/action-electron-builder@v1
        with: 
          github_token: ${{ secrets.github_token }}
          release: ${{ startsWith(github.ref, 'refs/tags/v') }}
          build_script_name: dist

      - name: NuGet Install
        uses: NuGet/setup-nuget@v1.0.5
        with:
          nuget-version: latest

      - name: Setup Certificate
        run: |
          echo "${{ secrets.SM_CLIENT_CERT_FILE_B64 }}" | base64 --decode > /d/Certificate_pkcs12.p12
          cat /d/Certificate_pkcs12.p12
        shell: bash

          
      - name: Set variables
        id: variables
        run: |
          echo "::set-output name=version::${GITHUB_REF#refs/tags/v}"
          echo "SM_HOST=${{ secrets.SM_HOST }}" >> "$GITHUB_ENV"
          echo "SM_API_KEY=${{ secrets.SM_API_KEY }}" >> "$GITHUB_ENV"
          echo "SM_CLIENT_CERT_FILE=D:\\Certificate_pkcs12.p12" >> "$GITHUB_ENV"
          echo "SM_CLIENT_CERT_PASSWORD=${{ secrets.SM_CLIENT_CERT_PASSWORD }}" >> "$GITHUB_ENV"
          echo "C:\Program Files (x86)\Windows Kits\10\App Certification Kit" >> $GITHUB_PATH
          echo "C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.8 Tools" >> $GITHUB_PATH
          echo "C:\Program Files\DigiCert\ DigiCert One Signing Manager Tools" >> $GITHUB_PATH
        shell: bash

      - name: Setup SSM KSP on windows latest
        run: |
          curl -X GET  https://one.digicert.com/signingmanager/api-ui/v1/releases/smtools-windows-x64.msi/download -H "x-api-key:%SM_API_KEY%" -o smtools-windows-x64.msi
          msiexec /i smtools-windows-x64.msi /quiet /qn
          smksp_registrar.exe list
          smctl.exe keypair ls
          C:\Windows\System32\certutil.exe -csp "DigiCert Signing Manager KSP" -key -user
          smksp_cert_sync.exe
        shell: cmd

      - name: Signing using Signtool
        run: |
          signtool.exe sign /sha1 ${{ secrets.SM_CODE_SIGNING_CERT_SHA1_HASH }} /tr http://timestamp.digicert.com /td SHA256 /fd SHA256 "D:\a\github-action-electron\github-action-electron\dist\my-electron-app Setup ${{ steps.variables.outputs.version }}.exe"
          signtool.exe verify /v /pa "D:\a\github-action-electron\github-action-electron\dist\my-electron-app Setup ${{ steps.variables.outputs.version }}.exe"

      - name: Signing using Nuget
        run: |
          copy D:\a\github-action-electron\github-action-electron\UNSIGNED.nupkg D:\a\github-action-electron\github-action-electron\dist\UNSIGNED.nupkg
          nuget sign "D:\a\github-action-electron\github-action-electron\dist\UNSIGNED.nupkg" -Timestamper http://timestamp.digicert.com -outputdirectory "D:\a\github-action-electron\github-action-electron\dist\Signed" -CertificateFingerprint ${{ secrets.SM_CODE_SIGNING_CERT_SHA1_HASH }} -HashAlgorithm SHA256 -Verbosity detailed -Overwrite
          nuget verify -All "D:\a\github-action-electron\github-action-electron\dist\Signed\*"

      - name: Signing using Mage
        run: |
          copy D:\a\github-action-electron\github-action-electron\UNSIGNED2.manifest D:\a\github-action-electron\github-action-electron\dist\UNSIGNED2.manifest
          mage.exe -sign "D:\a\github-action-electron\github-action-electron\dist\UNSIGNED2.manifest" -CertHash ${{ secrets.SM_CODE_SIGNING_CERT_SHA1_HASH }} -a sha256RSA
          mage -Verify "D:\a\github-action-electron\github-action-electron\dist\UNSIGNED2.manifest"

      - name: Upload artifacts
        uses: actions/upload-artifact@v2
        with:
          name: ${{ matrix.os }}
          path: |
            dist