Introduction

 

1. About

This guide provides instructions on how to:

• Set up Beyond Identity [BI} Authenticator to sign and verify with GitLab
• Beyond Identity authenticator with GPG key entitlements can be used to sign and verify code based on typical Devops events like push, pull, etc. This is a powerful tool to ensure security of SDLC process.  The event triggers the signature validation process as part of CI/CD pipeline.
• A GPG key generated on BI Authenticator can be used to sign many repositories, but a repository can be signed with only one key. 
• The email used to sign must be enrolled in the Beyond Identity tenant.

 

2. Prerequisites

Ensure that you have the following:

1. You have a tenant configured for your organization and able to enroll users.
   1. Integration with your SSO provider. The instructions are different based on your SSO provider. Please refer to the integration guides available in the below link

https://beyondidentity.atlassian.net/wiki/spaces/CS/pages/1063813121/SSO+Integration+Guides

No need to setup up BI admin console or BI user console

2. You have configured source code repository, project and entitled users to pull, commit, merge source code.
3. The users who will sign code must enroll with BI tenant and download BI authenticator.
4. You already have setup a CI/CD pipeline [optional]

3. Beyond Identity Tenant Configuration

Information to provide to the Beyond Identity Field Team to setup a tenant:

 

4. BI configuration for Gitlab Devops

• Generate Key management token
• Get authenticator entitlement to generate GPG keys
• Generate GPG Key
• Set repository path on the authenticator

1. Generate key management token

Beyond Identity Field Team: Please generate key management token through Beyond Identity Support Console for the tenant. This token will be used in the CI/CD pipeline as the value of BYNDID_KEY_MGMT_API_TOKEN in later steps.

2. Get authenticator entitlement to generate GPG keys

• Ensure “Commit-Signing” is enabled for the tenant. This can be done through the support console and BI SME can help with this. 
• After this is enabled, any members of the Super administrator group in Beyond identity admin console should create a group with the exact name of “BI_SDO_GPG_Key_Creation”
• Members of “BI_SDO_GPG_Key_Creation” group will be entitled to generate GPG keys and configure repository paths
• Using Beyond Identity admin console, add users to this group. These users will see “GPG keys” in their platform authenticator as shown below

 

 

On clicking “GPG Keys” link, you should see a screen with options to create GPG keys and configure

 

Click “Create” 

 

Ensure the email address matches the email configured to perform git operations. You can omit the expiration date

 

3. Set Repository Path on the authenticator

After creating the key, you should see the key in the Authenticator and “…” to the right. Click “…” and choose “Set repository”.

 

Browse to the local path of the repository root and click Configure. 

 

4. Gitlab configuration

• Create a GitLab account
• Sign into Gitlab with the account with the same email that will be used to code sign/verify
• Setup GitLab repository
  • Configure Gitlab CI/CD variable BYNDID_KEY_MGMT_API_TOKEN with value generated in step 4.1

• Your Repository 🡪Settings🡪CI/CD🡪Variables🡪Add variable

 

• Setup CI/CD 
  • In your repository root, setup.gitlab-ci.yml

stages:

  - test

 

commit-signature-verification:

  stage: test

  variables:

    API_TOKEN: "$BYNDID_KEY_MGMT_API_TOKEN"

  image:

    name: byndid/auth-commit-sig:0.4.1-debian

    entrypoint: [""]

  script:

    - /bin/action -ref="HEAD"

  rules:

    - if: $CI_PIPELINE_SOURCE == "push" 🡪Event triggering BI auth commit/ sign verify

 

• Clone repository
• Make changes
• Commit with sign
  • git commit -v -S -m "Modified README commit with -S"
• Push
• Verify successful pipeline run
  • Sign on to your Gitlab account, Navigate to Your Repository🡪CI/CD🡪Pipelines. You should see the pipeline with status “passed”. Click on the pipleline ID and see

 

 

5. Appendix

Gitlab Prerequisites.

• Create an account
  • Use the same email account that you will use to code sign/verify
• Create a repository
• Sign in with the same email account that you will use to code sign/verify
• You should have privileges to clone, modify, commit changes. 

1. Create an account

• Gitlab: https://gitlab.com/users/sign_in#register-pane

2. Create Repository

• Gitlab: https://docs.gitlab.com/ee/user/project/repository/#create-a-repository

3. Starting with Git

• Git Get Started: https://docs.gitlab.com/ee/tutorials/make_your_first_git_commit.html