The Auth API uses mTLS to authenticate a client-server connection. Therefore, the client must provide TLS certificates signed by the Auth server to access the API. These are easy to create and provide using Credential loaders.
The client certificates signed by the Auth server will be associated with a specific user. This user will be used to authorize API requests made by the client.
It is recommended to make a new user and role for each client. This makes it easier to track client actions, as well as carefully control client permissions.
For example, if your client needs to use
client.GetRole(), the user must have permission to perform the
action on the
role resource. You should create a user and role with the minimum permissions required.
The examples below may include the use of the
sudo keyword, token UUIDs, and users with
admin privileges to make following each step easier when creating resources from scratch.
- We discourage using
sudoin production environments unless it's needed.
- We encourage creating new, non-root, users or new test instances for experimenting with Teleport.
- We encourage adherence to the Principle of Least Privilege (PoLP) and Zero Admin best practices. Don't give users the
adminrole when giving them the more restrictive
access,editorroles will do instead.
- Saving tokens into a file rather than sharing tokens directly as strings.
Learn more about Teleport Role-Based Access Control best practices.
# Copy and Paste the below and run on the Teleport Auth server. cat > api-role.yaml <<EOF kind: role metadata: name: api-role spec: allow: rules: - resources: ['role'] verbs: ['read'] deny: node_labels: '*': '*' version: v4 EOF # Create role tctl create -f api-role.yaml # Add user and login via web proxy tctl users add api-user --roles=api-role
See our roles documentation for more details on role based access control.
The Teleport Go client uses Credentials to gather and hold TLS certificates, connect to proxy servers over SSH, and perform some other actions.
Credentials are created by using Credential loaders, which gather certificates and data generated by Teleport CLIs.
Since there are several Credential loaders to choose from with distinct benefits, here's a quick breakdown:
- Profile Credentials are the easiest to get started with. All you have to do is log in to your device with
tsh login. Your Teleport proxy address and credentials will automatically be located and used.
- IdentityFile Credentials are the most well-rounded in terms of usability, functionality,
and customizability. Identity files can be generated through
tctl auth sign, making them ideal for both long-lived proxy and auth server connections.
- Key Pair Credentials have a much simpler implementation than the first two Credentials listed and may feel more familiar. These are good for authenticating clients hosted directly on the auth server.
- TLS Credentials leave everything up to the client user. This is mostly used internally, but some advanced users may find it useful.
Here are some more specific details to differentiate them by:
|Type||Profile Credentials||Identity Credentials||Key Pair Credentials||TLS Credentials|
|Ease of use||Easy||Easy||Medium||Hard|
|Supports long-lived certificates||Yes, but must be configured on server side||Yes||Yes||Yes|
|Supports SSH connections||Yes||Yes (6.1+)||No||No|
|Automatic Proxy Address discovery||Yes||No||No||No|
See the Credentials type on pkg.go.dev for more information and examples for Credentials and Credential Loaders.
The API client makes requests through an open connection to the Teleport Auth server.
If the Auth server is isolated behind a Proxy Server, a reverse tunnel connection can be made using SSH certificates signed by the auth server. You can either provide the server's reverse tunnel address directly or provide the web proxy address and have the client automatically retrieve the reverse tunnel address.
Take a look at this client constructor example to see what these connection options look like.