Using Machine ID with CircleCI
- Version 15.x
- Version 14.x
- Version 13.x
- Version 12.x
- Older Versions
- Available for:
Machine ID for CircleCI is available starting from Teleport
In this guide, you will use Teleport Machine ID to allow a CircleCI job to securely connect to a Teleport SSH node without the need for long-lived secrets.
This mitigates the risk of long-lived secrets such as passwords or SSH private keys being exfiltrated from your CircleCI organization and provides many of the other benefits of Teleport such as auditing and finely-grained access control.
To check version information, run the
tctl version and
tsh version commands.
Teleport Enterprise v13.3.9 git:api/14.0.0-gd1e081e go1.21tsh version
Teleport v13.3.9 go1.21Proxy version: 13.3.9Proxy: teleport.example.com
- To check that you can connect to your Teleport cluster, sign in with
tsh login, then verify that you can run
tctlcommands on your administrative workstation using your current credentials. For example:If you can connect to the cluster and run thetsh login --proxy=teleport.example.com --user=[email protected]tctl status
CA pin sha256:abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678
tctl statuscommand, you can use your current credentials to run subsequent
tctlcommands from your workstation. If you host your own Teleport cluster, you can also run
tctlcommands on the computer that hosts the Teleport Auth Service for full permissions.
- A running instance of the Teleport SSH Service that you have registered with
your Teleport cluster. For instructions on setting this up, see the
Getting Started Guide. The SSH node must
include a user you want to grant access to. In this guide, we will call the SSH
my-nodeand the user
ci-user. Replace these with values appropriate to your setup.
- A CircleCI project connected to a Git repository you can push to.
In order to configure the rules for which CircleCI workflows will be allowed to connect to your Teleport cluster, you must determine the ID of your CircleCI organization and create a CircleCI context.
Open CircleCI and navigate to "Organization settings" from the navbar.
You should be presented with an interface titled "Overview" with a section
called "Organization ID". Note this value down and substitute
in configuration examples with this.
CircleCI has an organization-level concept called contexts, which allow you to configure a series of secrets that should be exposed to a workflow job. You can configure CircleCI to control which actors are allowed to trigger jobs associated with a context.
The contexts that a workflow job has been assigned are also encoded in the identity token that CircleCI creates for the job. This makes them an ideal way for Teleport to determine which CircleCI jobs should be granted access to the Teleport cluster.
In this example, you will create a CircleCI context named
You will then grant this context access to your Teleport cluster.
To create the CircleCI context, open up "Organization settings" in CircleCI
and navigate to "Contexts". Click "Create Context" and provide
as the name of the context you wish to create. You may substitute this value
for a string that makes more sense to your organization, but ensure in future
steps of this guide that you replace
teleport-access with your value.
Select the context you have just created. You will now be on a page that allows you to configure the context. To determine the ID of the context to use when configuring Teleport, locate the URL of the context settings page, which should have a format similar to the following:
In this case, the context ID is:
Note this value down and substitute
$CONTEXT_ID in configuration examples
In order to allow your CircleCI workflow to authenticate with your Teleport cluster, you'll first need to create a join token. These tokens set out criteria by which the Auth Server decides whether or not to allow a bot or node to join.
Create a file named
tokenconfig.yaml, ensuring that you replace
$CONTEXT_ID with the values from Step 1.
kind: token version: v2 metadata: name: circleci-demo spec: roles: [Bot] join_method: circleci bot_name: circleci-demo circleci: organization_id: $ORGANIZATION_ID allow: - context_id: $CONTEXT_ID
Let's go over the token resource's fields in more detail:
metadata.namedefines the name of the token. Note that this value will need to be used in other parts of the configuration later.
metadata.expiresdefines the date that the join token will expire. This example is set to the year
spec.bot_nameis the name of the Machine ID bot that this token will grant access to. Note that this value will need to be used in other parts of the configuration later.
spec.rolesdefines which roles that this token will grant access to. The value of
[Bot]states that this token grants access to a Machine ID bot.
spec.join_methoddefines the join method the token is applicable for. Since this guide only focuses on CircleCI, you will set this to to
spec.circleci.allowis used to set rules for what CircleCI runs will be able to authenticate by using the token.
Apply this to your Teleport cluster using
tctl create -f tokenconfig.yaml
With the join token for the CircleCI project created, you now need to create a Machine ID bot that the token will grant access to. A Machine ID bot is a special type of Teleport user designed for access by machines, and can authenticate using a join token rather than forms of authentication more suitable to users (such as a Single Sign-On solution).
For this guide, we are using the default
access role and explicitly stating
that the bot should have access to the
ci-user login on hosts. In production
environments, we recommend creating a custom role for your CI/CD workflow and
ensuring that this role has no more permissions than is needed for the workflow
to complete its tasks.
tctl to create the bot:
tctl bots add circleci-demo --roles=access --logins=ci-user --token=circleci-demo
With the token and bot now configured, you can now create a CircleCI workflow that can connect to your Teleport cluster.
Our example workflow will connect to an SSH node named
my-node and write a
line to a file that links back to the CI/CD run. This is a trivial example and
could be replaced with pushing new configuration or binaries over SSH.
Open your Git repository and create a directory called
.circleci. Then open
a file called
config.yml and insert the following configuration:
# See: https://circleci.com/docs/2.0/configuration-reference version: 2.1 jobs: write-run-log: docker: - image: cimg/base:stable steps: - checkout - run: name: "Install Teleport" command: | cd /tmp curl -O https://cdn.teleport.dev/teleport-v14.0.1-linux-amd64-bin.tar.gz tar -xvf teleport-v14.0.1-linux-amd64-bin.tar.gz sudo ./teleport/install - run: name: "Use Machine ID to access Teleport Node" command: | export TELEPORT_ANONYMOUS_TELEMETRY=1 tbot start \ --auth-server=tele.example.com:443 \ --join-method=circleci --token=circleci-demo \ --oneshot \ --destination-dir=./certs \ --data-dir=/tmp/tbot-data tsh \ -i ./certs/identity \ --proxy tele.example.com:443 \ ssh ci-user@my-node \ "echo $CIRCLE_BUILD_URL >> ~/circle_run_log_demo" workflows: write-run-log: jobs: - write-run-log: context: - teleport-access
TELEPORT_ANONYMOUS_TELEMETRY enables the submission of anonymous usage
telemetry. This helps us shape the future development of
tbot. You can disable
this by omitting this.
tele.example.com:443 with the public-facing address of your Teleport
Proxy Service or cloud tenant (e.g.
with the name of the Teleport node that you wish to connect to and replace
ci-user with the login you configured in Step 3.
Add, commit, and push this new configuration file to your repository.
Open CircleCI and check the status of the job, wait for it to complete and ensure that no errors are emitted.
my-node and confirm that a file has been created in
circle_run_log with a link to the build in CircleCI.
tbot start has been used in a job, all successive steps in that job will
have access to the credentials that have been produced by
tbot. Break your
workflow down into multiple jobs to reduce the amount of steps that have access
to these credentials.
Ensure that the role you assign to your CircleCI bot has access to only the resources in your Teleport cluster that your CI/CD needs to interact with.
For more information about CircleCI itself, read their documentation.