Database Access with Cloud Spanner

Teleport can provide secure access to Cloud Spanner via the Teleport Database Service. This allows for fine-grained access control through Teleport's RBAC.

In this guide, you will:

1. Configure your Cloud Spanner database with a service account.
2. Add the database to your Teleport cluster.
3. Connect to the database via Teleport.

How it works

The Teleport Database Service uses IAM authentication to communicate with Spanner. When a user connects to the database via Teleport, the Teleport Database Service obtains Google Cloud credentials and authenticates to Google Cloud as an IAM principal with permissions to access the database.

• Self-Hosted
• Cloud-Hosted

Prerequisites

• A running Teleport cluster version 16.4.8 or above. If you want to get started with Teleport, sign up for a free trial or set up a demo environment.

• The tctl admin tool and tsh client tool.

  Visit Installation for instructions on downloading tctl and tsh.

• Google Cloud account
• Google Cloud Spanner database.
• A host where you will run the Teleport Database Service, e.g. a Compute Engine instance.
• To check that you can connect to your Teleport cluster, sign in with tsh login, then verify that you can run tctl commands using your current credentials. For example:

  tsh login --proxy=teleport.example.com --user=[email protected]
  tctl status
  Cluster  teleport.example.com
  Version  16.4.8
  CA pin   sha256:abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678abdc1245efgh5678

  If you can connect to the cluster and run the tctl status command, you can use your current credentials to run subsequent tctl commands from your workstation. If you host your own Teleport cluster, you can also run tctl commands on the computer that hosts the Teleport Auth Service for full permissions.

Step 1/8. Create a service account for the Teleport Database Service

A GCP service account will be used by the Teleport Database Service to create ephemeral access tokens for other GCP service accounts when it's acting on the behalf of authorized Teleport users.

Create a service account

Go to the Service Accounts page and create a service account:

Ignore the optional steps - click "Done". We will grant permissions to this service account later in this guide.

Step 2/8. Create a service account for a database user

When a user connects to Spanner via Teleport, they will specify a service account name as the database user and the Teleport Database service will impersonate that service account to authenticate to GCP.

You can create multiple service accounts to provide different access levels to Teleport users, but for this guide we will just create one.

Create a service account

Go to the IAM & Admin Service Accounts page and create a new service account named "spanner-user":

Ignore the optional steps - just click "Done". Rather than granting access at the project level, we will grant this service account permissions to just the databases it will be used to access.

Grant permissions

Navigate to the Spanner instance overview page and check the box of your Spanner instance, then click "Permissions".

In the permissions blade, click "Add Principal" then add the "spanner-user" service account as a principal and assign it the "Cloud Spanner Database User" role:

Click "Save".

Grant access to the service account

The Teleport Database Service must be able to impersonate this service account. Navigate to the "spanner-user" service account overview page and select the "permissions" tab:

Click "Grant Access" and add the "teleport-db-service" principal ID. Select the "Service Account Token Creator" role and save the change:

# Used to generate IAM auth tokens when connecting to a database instance.
iam.serviceAccounts.getAccessToken

Step 3/8. Install Teleport

Install Teleport on your Linux server:

1. Assign edition to one of the following, depending on your Teleport edition:

   Edition	Value
   Teleport Enterprise Cloud	cloud
   Teleport Enterprise (Self-Hosted)	enterprise
   Teleport Community Edition	oss

2. Get the version of Teleport to install. If you have automatic agent updates enabled in your cluster, query the latest Teleport version that is compatible with the updater:

   TELEPORT_DOMAIN=example.teleport.com
   TELEPORT_VERSION="$(curl https://$TELEPORT_DOMAIN/v1/webapi/automaticupgrades/channel/default/version | sed 's/v//')"

   Otherwise, get the version of your Teleport cluster:

   TELEPORT_DOMAIN=example.teleport.com
   TELEPORT_VERSION="$(curl https://$TELEPORT_DOMAIN/v1/webapi/ping | jq -r '.server_version')"

3. Install Teleport on your Linux server:

   curl https://cdn.teleport.dev/install-v16.4.8.sh | bash -s ${TELEPORT_VERSION} edition

   The installation script detects the package manager on your Linux server and uses it to install Teleport binaries. To customize your installation, learn about the Teleport package repositories in the installation guide.

Step 4/8. Configure the Teleport Database Service

The Database Service requires a valid join token to join your Teleport cluster. Run the following tctl command and save the token output in /tmp/token on the server that will run the Database Service:

tctl tokens add --type=db --format=text
abcd123-insecure-do-not-use-this

Provide the following information and then generate a configuration file for the Teleport Database Service:

• example.teleport.sh:443 The host and port of your Teleport Proxy Service or cloud-hosted Teleport Enterprise site
• project-id The GCP project ID. You can normally see it in the organization view at the top of the GCP dashboard.
• instance-id The name of your Cloud SQL instance.

sudo teleport db configure create \   -o file \   --name=spanner-example \   --protocol=spanner \   --labels=env=dev \   --token=/tmp/token \   --uri=spanner.googleapis.com:443 \   --proxy=example.teleport.sh:443  \   --gcp-project-id=project-id \   --gcp-instance-id=instance-id 

Step 5/8. Configure GCP credentials

The Teleport Database Service must have credentials for the "teleport-db-service" GCP service account.

If the Teleport Database Service is hosted on a GCE instance, you can change the attached service account. For non-GCE deployments of Teleport, we recommend using workload identity.

Alternatively, go to that service account's Keys tab and create a new key:

Make sure to choose JSON format:

Save the file. Set the GOOGLE_APPLICATION_CREDENTIALS environment variable to point to the JSON credentials file you downloaded earlier. For example, if you use systemd to start teleport, then you should edit the service's EnvironmentFile to include the env var:

echo 'GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json' | sudo tee -a /etc/default/teleport

Step 6/8. Start the Teleport Database Service

Configure the Teleport Database Service to start automatically when the host boots up by creating a systemd service for it. The instructions depend on how you installed the Teleport Database Service.

sudo systemctl enable teleport
sudo systemctl start teleport

sudo teleport install systemd -o /etc/systemd/system/teleport.service
sudo systemctl enable teleport
sudo systemctl start teleport

You can check the status of the Teleport Database Service with systemctl status teleport and view its logs with journalctl -fu teleport.

Step 7/8. Create a Teleport user

tctl users add \  --roles=access \  --db-users="*" \  --db-names="*" \  alice

tctl users add \  --roles=access,requester \  --db-users="*" \  --db-names="*" \  alice

For more detailed information about database access controls and how to restrict access see RBAC documentation.

Step 8/8. Connect

Once the Teleport Database Service has joined the cluster, log in to see the available databases:

tsh login --proxy=teleport.example.com --user=example-user
tsh db ls
Name            Description       Allowed Users Labels  Connect --------------- ----------------- ------------- ------- ------- spanner-example GCP Cloud Spanner [*]           env=dev

tsh login --proxy=mytenant.teleport.sh --user=example-user
tsh db ls
Name            Description       Allowed Users Labels  Connect --------------- ----------------- ------------- ------- ------- spanner-example GCP Cloud Spanner [*]           env=dev

When connecting to the database, use the name of the service account that you created for a database user above, (minus the "@project-id.iam.gserviceaccount.com" suffix). Retrieve credentials for a database in the Cloud Spanner instance and connect to it:

tsh db connect --db-user=spanner-user --db-name=example-db spanner-example

To log out of the database and remove credentials:

Remove credentials for a particular database instance:
tsh db logout spanner-example
Or remove credentials for all databases:
tsh db logout

Troubleshooting

Could not find default credentials

This error can come from either your client application or Teleport.

For a client application, ensure that you disable GCP credential loading. Your client should not attempt to load credentials because GCP credentials will be provided by the Teleport Database Service.

If you see the credentials error message in the Teleport Database Service logs (at DEBUG log level), then the Teleport Database Service does not have GCP credentials configured correctly.

If you are using a service account key, then ensure that the environment variable GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json is set and restart your Teleport Database Service to ensure that the env var is available to teleport. For example, if your Teleport Database Service runs as a systemd service:

echo 'GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json' | sudo tee -a /etc/default/teleport
sudo systemctl restart teleport

See authentication in the Google Cloud documentation for more information about service account authentication methods.

Next steps

• Learn how to restrict access to certain users and databases.

• View the High Availability (HA) guide.

• Take a look at the YAML configuration reference.

• See the full CLI reference.

• Learn how to connect with a GUI client.
• Learn more about authenticating as a service account in Google Cloud.