# Database Access with Snowflake Teleport can provide secure access to Snowflake via the [Teleport Database Service](https://goteleport.com/docs/enroll-resources/database-access.md). This allows for fine-grained access control through [Teleport's RBAC](https://goteleport.com/docs/enroll-resources/database-access/rbac.md). In this guide, you will: 1. Configure your Snowflake database with key pair authentication. 2. Add the database to your Teleport cluster. 3. Connect to the database via Teleport. ## How it works The Teleport Database Service communicates with Snowflake using HTTP messages that contain JSON web tokens signed by the Teleport certificate authority for database clients. Snowflake is configured to trust the Teleport database client CA. When a user connects to Snowflake via Teleport, the Database Service forwards the user's requests to Snowflake as Teleport-authenticated messages. **Self-Hosted** ![Enroll Snowflake with a self-hosted Teleport cluster](/docs/assets/images/snowflake_selfhosted-2a63f9f0785788b791802885c1acc75e.png) **Teleport Enterprise Cloud** ![Enroll Snowflake with a cloud-hosted Teleport cluster](/docs/assets/images/snowflake_cloud-96a16249b48f13f376e35b60d62bf346.png) ## Prerequisites - A running Teleport cluster. If you want to get started with Teleport, [sign up](https://goteleport.com/signup) for a free trial or [set up a demo environment](https://goteleport.com/docs/get-started/deploy-community.md). - The `tctl` and `tsh` clients. Installing `tctl` and `tsh` clients 1. Determine the version of your Teleport cluster. The `tctl` and `tsh` clients must be at most one major version behind your Teleport cluster version. Send a GET request to the Proxy Service at `/v1/webapi/find` and use a JSON query tool to obtain your cluster version. Replace teleport.example.com:443 with the web address of your Teleport Proxy Service: ``` $ TELEPORT_DOMAIN=teleport.example.com:443 $ TELEPORT_VERSION="$(curl -s https://$TELEPORT_DOMAIN/v1/webapi/find | jq -r '.server_version')" ``` 2. Follow the instructions for your platform to install `tctl` and `tsh` clients: **Mac** Download the signed macOS .pkg installer for Teleport, which includes the `tctl` and `tsh` clients: ``` $ curl -O https://cdn.teleport.dev/teleport-${TELEPORT_VERSION?}.pkg ``` In Finder double-click the `pkg` file to begin installation. --- DANGER Using Homebrew to install Teleport is not supported. The Teleport package in Homebrew is not maintained by Teleport and we can't guarantee its reliability or security. --- **Windows - Powershell** ``` $ curl.exe -O https://cdn.teleport.dev/teleport-v${TELEPORT_VERSION?}-windows-amd64-bin.zip Unzip the archive and move the `tctl` and `tsh` clients to your %PATH% NOTE: Do not place the `tctl` and `tsh` clients in the System32 directory, as this can cause issues when using WinSCP. Use %SystemRoot% (C:\Windows) or %USERPROFILE% (C:\Users\) instead. ``` **Linux** All of the Teleport binaries in Linux installations include the `tctl` and `tsh` clients. For more options (including RPM/DEB packages and downloads for i386/ARM/ARM64) see our [installation page](https://goteleport.com/docs/installation.md). ``` $ curl -O https://cdn.teleport.dev/teleport-v${TELEPORT_VERSION?}-linux-amd64-bin.tar.gz $ tar -xzf teleport-v${TELEPORT_VERSION?}-linux-amd64-bin.tar.gz $ cd teleport $ sudo ./install Teleport binaries have been copied to /usr/local/bin ``` * Snowflake account with `SECURITYADMIN` role or higher. * `snowsql` installed and added to your system's `PATH` environment variable. * A host where you will run the Teleport Database Service. See [Installation](https://goteleport.com/docs/installation.md) for details. * 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, run the following command, assigning teleport.example.com to the domain name of the Teleport Proxy Service in your cluster and email\@example.com to your Teleport username: ``` $ tsh login --proxy=teleport.example.com --user=email@example.com $ tctl status Cluster teleport.example.com Version 18.7.3 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/5. Set up 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 ``` Install and configure Teleport where you will run the Teleport Database Service: **Linux Server** To install a Teleport Agent on your Linux server: The recommended installation method is the cluster install script. It will select the correct version, edition, and installation mode for your cluster. 1. Assign teleport.example.com:443 to your Teleport cluster hostname and port, but not the scheme (https\://). 2. Run your cluster's install script: ``` $ curl "https://teleport.example.com:443/scripts/install.sh" | sudo bash ``` On the host where you will run the Teleport Database Service, start Teleport with the appropriate configuration. Note that a single Teleport process can run multiple different services, for example multiple Database Service agents as well as the SSH Service or Application Service. The step below will overwrite an existing configuration file, so if you're running multiple services add `--output=stdout` to print the config in your terminal, and manually adjust `/etc/teleport.yaml`. Generate a configuration file at `/etc/teleport.yaml` for the Database Service: **Teleport Enterprise/Enterprise Cloud** ``` $ sudo teleport db configure create \ -o file \ --token=/tmp/token \ --proxy=teleport.example.com:443 \ --name=example-snowflake \ --protocol=snowflake \ --uri=abc12345.snowflakecomputing.com \ --labels=env=dev ``` **Teleport Community Edition** ``` $ sudo teleport db configure create \ -o file \ --token=/tmp/token \ --proxy=mytenant.teleport.sh:443 \ --name=example-snowflake \ --protocol=snowflake \ --uri=abc12345.snowflakecomputing.com \ --labels=env=dev ``` 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. **Package Manager** On the host where you will run the Teleport Database Service, enable and start Teleport: ``` $ sudo systemctl enable teleport $ sudo systemctl start teleport ``` **TAR Archive** On the host where you will run the Teleport Database Service, create a systemd service configuration for Teleport, enable the Teleport service, and 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`. **Kubernetes Cluster** Teleport provides Helm charts for installing the Teleport Database Service in Kubernetes Clusters. Configure Helm to fetch Teleport charts from the Teleport Helm repository: ``` $ helm repo add teleport https://charts.releases.teleport.dev ``` Refresh the local Helm cache by fetching the latest charts: ``` $ helm repo update ``` **Self-Hosted** Install the Teleport Kube Agent into your Kubernetes Cluster with the Teleport Database Service configuration. ``` $ JOIN_TOKEN=$(cat /tmp/token) $ helm install teleport-kube-agent teleport/teleport-kube-agent \ --create-namespace \ --namespace teleport-agent \ --set roles=db \ --set proxyAddr=teleport.example.com:443 \ --set authToken=${JOIN_TOKEN?} \ --set "databases[0].name=example-snowflake" \ --set "databases[0].uri=abc12345.snowflakecomputing.com" \ --set "databases[0].protocol=snowflake" \ --set "databases[0].static_labels.env=dev" \ --version 18.7.3 ``` **Cloud-Hosted** Install the Teleport Kube Agent into your Kubernetes Cluster with the Teleport Database Service configuration. ``` $ JOIN_TOKEN=$(cat /tmp/token) $ helm install teleport-kube-agent teleport/teleport-kube-agent \ --create-namespace \ --namespace teleport-agent \ --set roles=db \ --set proxyAddr=mytenant.teleport.sh:443 \ --set authToken=${JOIN_TOKEN?} \ --set "databases[0].name=example-snowflake" \ --set "databases[0].uri=abc12345.snowflakecomputing.com" \ --set "databases[0].protocol=snowflake" \ --set "databases[0].static_labels.env=dev" \ --version 18.7.3 ``` Make sure that the Teleport Agent pod is running. You should see one `teleport-kube-agent` pod with a single ready container: ``` $ kubectl -n teleport-agent get pods NAME READY STATUS RESTARTS AGE teleport-kube-agent-0 1/1 Running 0 32s ``` --- TIP A single Teleport process can run multiple services, for example multiple Database Service instances as well as other services such as the SSH Service or Application Service. --- ## Step 2/5. Create a Teleport user --- TIP To modify an existing user to provide access to the Database Service, see [Database Access Controls](https://goteleport.com/docs/enroll-resources/database-access/rbac.md) --- **Teleport Community Edition** Create a local Teleport user with the built-in `access` role: ``` $ tctl users add \ --roles=access \ --db-users="*" \ --db-names="*" \ alice ``` **Teleport Enterprise/Enterprise Cloud** Create a local Teleport user with the built-in `access` and `requester` roles: ``` $ tctl users add \ --roles=access,requester \ --db-users="*" \ --db-names="*" \ alice ``` | Flag | Description | | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | | `--roles` | List of roles to assign to the user. The builtin `access` role allows them to connect to any database server registered with Teleport. | | `--db-users` | List of database usernames the user will be allowed to use when connecting to the databases. A wildcard allows any user. | | `--db-names` | List of logical databases (aka schemas) the user will be allowed to connect to within a database server. A wildcard allows any database. | --- WARNING Database names are only enforced for PostgreSQL, MongoDB, and Cloud Spanner databases. --- For more detailed information about database access controls and how to restrict access see [RBAC](https://goteleport.com/docs/enroll-resources/database-access/rbac.md) documentation. ## Step 3/5. Export a public key Use the `tctl auth sign` command below to export a public key for your Snowflake user: ``` $ tctl auth sign --format=snowflake --out=server ``` The command will create a `server.pub` file with Teleport's public key. Teleport will use the corresponding private key to generate a JWT (JSON Web Token) that will be used to authenticate to Snowflake. ## Step 4/5. Add the public key to your Snowflake user Use the public key you generated earlier to enable key pair authentication. Log in to your Snowflake instance and execute the SQL statement below: ``` alter user alice set rsa_public_key='MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAv3dHYw4LJCcZzdbhb3hV...LwIDAQAB'; ``` In this statement, `alice` is the name of the Snowflake user and the `rsa_public_key` is the key generated earlier without the PEM header/footer (first and the last line). You can use the `describe user` command to verify the user's public key: ``` desc user alice; ``` See the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/key-pair-auth.html#step-4-assign-the-public-key-to-a-snowflake-user) for more details. ## Step 5/5. Connect Log in to your Teleport cluster and see the available databases: **Self-Hosted** ``` $ tsh login --proxy=teleport.example.com --user=alice $ tsh db ls Name Description Labels ----------------- ------------------- -------- example-snowflake Example Snowflake ❄ env=dev ``` **Cloud-Hosted** ``` $ tsh login --proxy=mytenant.teleport.sh --user=alice $ tsh db ls Name Description Labels ----------------- ------------------- -------- example-snowflake Example Snowflake ❄ env=dev ``` To retrieve credentials for a database and connect to it: ``` $ tsh db connect --db-user=alice --db-name=SNOWFLAKE_SAMPLE_DATA example-snowflake ``` The `snowsql` command-line client should be available in the system `PATH` in order to be able to connect. To log out of the database and remove credentials: ``` Remove credentials for a particular database instance. $ tsh db logout example-snowflake Remove credentials for all database instances. $ tsh db logout ``` ## Access Snowsight via Teleport The Teleport Database Service provides CLI and programmatic access to Snowflake databases, but it does not provide direct access to the Snowsight web interface. To enable Snowsight access, you can configure it as a SAML application in Teleport, allowing Teleport to act as the Identity Provider (IdP) for Snowsight. --- NOTE When Teleport is configured as the IdP for Snowsight, it only handles SAML authentication. Snowsight activity is not audited or recorded through Teleport. --- Follow [Using Teleport as a SAML identity provider](https://goteleport.com/docs/identity-governance/idps/saml-guide.md) and [Configuring Snowflake to use federated authentication](https://docs.snowflake.com/en/user-guide/admin-security-fed-auth-security-integration) to setup Teleport as an IDP. Here is an example of the security integration to be created in your Snowflake database: ``` CREATE SECURITY INTEGRATION teleport_idp TYPE = saml2 ENABLED = true SAML2_ISSUER = 'https://teleport.example.com/enterprise/saml-idp/metadata' SAML2_SSO_URL = 'https://teleport.example.com/enterprise/saml-idp/sso' SAML2_PROVIDER = 'custom' SAML2_X509_CERT = 'MII...' SAML2_ENABLE_SP_INITIATED = true SAML2_SP_INITIATED_LOGIN_PAGE_LABEL = 'Teleport Login' ``` Replace the URLs and X.509 certificate with the values generated during the enrollment flow in the Teleport Web UI. After creating the integration, describe the integration to obtain the Snowflake URLs that must be configured in Teleport. By default, Teleport passes your Teleport username as the Snowsight account name. For custom mappings, see [SAML Idp Attribute Mapping](https://goteleport.com/docs/identity-governance/idps/saml-attribute-mapping.md). ## Next steps - Learn how to [restrict access](https://goteleport.com/docs/enroll-resources/database-access/rbac.md) to certain users and databases. * View the [High Availability (HA)](https://goteleport.com/docs/enroll-resources/agents/high-availability.md) guide. - Take a look at the YAML configuration [reference](https://goteleport.com/docs/enroll-resources/database-access/reference/configuration.md). * See the full CLI [reference](https://goteleport.com/docs/enroll-resources/database-access/reference/cli.md).