Self-signed certificates or custom Certification Authorities
Introduced in GitLab Runner 0.7.0
GitLab Runner allows you to configure certificates that are used to verify TLS peers when connecting to the GitLab server.
This solves the
x509: certificate signed by unknown authority problem when registering a runner.
For existing Runners, the same error can be shown in Runner logs when trying to check the jobs:
Couldn't execute POST against https://hostname.tld/api/v4/jobs/request: Post https://hostname.tld/api/v4/jobs/request: x509: certificate signed by unknown authority
Supported options for self-signed certificates
GitLab Runner supports the following options:
Default: GitLab Runner reads the system certificate store and verifies the GitLab server against the certificate authorities (CA) stored in the system.
GitLab Runner reads the PEM certificate (DER format is not supported) from a predefined file:
/etc/gitlab-runner/certs/hostname.crton *nix systems when GitLab Runner is executed as root.
~/.gitlab-runner/certs/hostname.crton *nix systems when GitLab Runner is executed as non-root.
./certs/hostname.crton other systems. If running Runner as a Windows service, this will not work. Use the last option instead.
If your server address is:
https://my.gitlab.server.com:8443/, create the certificate file at:
/etc/gitlab-runner/certs/my.gitlab.server.com.crt. To verify that the file looks correct, you can use a tool like
openssl. For example:
echo | openssl s_client -CAfile /etc/gitlab-runner/certs/gitlab-hostname.tld.crt -connect gitlab-hostname.tld:443Note: You may need to concatenate the intermediate and server certificate for the chain to be properly identified. For example, if you have a primary, intermediate, and root certificate, you can put all of them into one file:
-----BEGIN CERTIFICATE----- (Your primary SSL certificate: your_domain_name.crt) -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- (Your intermediate certificate) -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- (Your root certificate) -----END CERTIFICATE-----
- If you are updating the certificate for an existing Runner, restart it.
GitLab Runner exposes the
tls-ca-fileoption during registration (
gitlab-runner register --tls-ca-file=/path), and in
[[runners]]section. This allows you to specify a custom certificate file. This file will be read every time the runner tries to access the GitLab server.
If you are using GitLab Runner Helm chart, configure custom certificates.
- As a temporary and unsecure workaround, to skip the verification of certificates,
variables:section of your
.gitlab-ci.ymlfile, set the CI variable
The runner injects missing certificates to build the CA chain in build containers.
git clone and
artifacts to work with servers that do not use publicly
This approach is secure, but makes the runner a single point of trust.
Using TLS in build scripts
The scenario described in the previous section applies to built-in Runner operations such as fetching a repository or uploading artifacts. These operations are performed by a separate Runner helper image, which installs the custom certificate with a script.
If your build script needs to communicate with peers through TLS and needs to rely on
a self-signed certificate or custom Certificate Authority, you will need to perform the
certificate installation in the build job, as the user scripts are run in a Docker container
that doesn’t have the certificate files installed by default. This might be required to perform
git clone, or fetch a file through a tool like
wget, for example.
To install the certificate:
Map the necessary files as a Docker volume so that the Docker container that will run the scripts can see them. Do this by adding a volume inside the respective key inside the
config.tomlfile, for example:
[[runners]] name = "docker" url = "https://CI/" token = "TOKEN" executor = "docker" [runners.docker] image = "ubuntu:latest" # Add path to your ca.crt file in the volumes list volumes = ["/cache", "/path/to-ca-cert-dir/ca.crt:/etc/gitlab-runner/certs/ca.crt:ro"]
Use the mapped file (e.g
ca.crt) in a
- Copies it to
/usr/local/share/ca-certificates/ca.crtinside the Docker container.
Install it by running
update-ca-certificates --fresh. For example (commands vary based on the distribution you’re using):
[[runners]] name = "docker" url = "https://CI/" token = "TOKEN" executor = "docker" # Copy and install CA certificate before each job pre_build_script = """ apt-get update -y > /dev/null apt-get install -y ca-certificates > /dev/null cp /etc/gitlab-runner/certs/ca.crt /usr/local/share/ca-certificates/ca.crt update-ca-certificates --fresh > /dev/null """
[[runners]] name = "docker" url = "https://CI/" token = "TOKEN" executor = "docker" # Copy and install CA certificate before each job pre_build_script = """ apk update >/dev/null apk add ca-certificates >/dev/null rm -rf /var/cache/apk/* cp /etc/gitlab-runner/certs/ca.crt /usr/local/share/ca-certificates/ca.crt update-ca-certificates --fresh > /dev/null """
- Copies it to