Cassandra 및 ScyllaDB로 데이터베이스 액세스

요약

Teleport can provide secure access to Cassandra or ScyllaDB via the Teleport Database Service. The Teleport Database Service proxies traffic from database clients to self-hosted databases in your infrastructure.

Teleport can provide secure access to Cassandra or ScyllaDB via the Teleport Database Service. This allows for fine-grained access control through the Teleport RBAC system.

The Teleport Database Service proxies traffic from database clients to self-hosted databases in your infrastructure. Teleport maintains a certificate authority (CA) for database clients. You configure your database to trust the Teleport database client CA, and the Teleport Database Service presents certificates signed by this CA when proxying user traffic. With this setup, there is no need to store long-lived credentials for self-hosted databases.

Meanwhile, the Teleport Database Service verifies self-hosted databases by checking their TLS certificates against either the Teleport database CA or a custom CA used with the database.

In this guide, you will:

Configure your Cassandra or ScyllaDB database for Teleport access.
Add the database to your Teleport cluster.
Connect to the database via Teleport.

작동 방식#

The Teleport Database Service authenticates to your self-hosted Cassandra or ScyllaDB database using mutual TLS. Cassandra or ScyllaDB trusts the Teleport certificate authority for database clients, and presents a certificate signed by either the Teleport database CA or a custom CA. When a user initiates a database session, the Teleport Database Service presents a certificate signed by Teleport. The authenticated connection then proxies client traffic from the user.

Self-Hosted Teleport 클러스터로 Cassandra 등록

Cloud-Hosted Teleport 클러스터로 Cassandra 등록

사전 조건#

A running Teleport cluster. If you want to get started with Teleport, sign up for a free trial or set up a demo environment.
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 with the web address of your Teleport Proxy Service:
```
$ TELEPORT_DOMAIN=
$ 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:

자체 호스팅 Cassandra 또는 ScyllaDB 인스턴스.
cqlsh Cassandra 클라이언트가 설치되어 시스템 PATH 환경 변수에 추가되어 있어야 합니다.
선택 사항: 자체 호스팅 데이터베이스용 인증서를 발급하는 인증 기관.

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 to the domain name of the Teleport Proxy Service in your cluster and to your Teleport username:

$ tsh login --proxy= --user=
$ tctl status
# Cluster  (=teleport.url=)
# Version  (=teleport.version=)
# CA pin   (=presets.ca_pin=)

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.

1/5단계. 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
(=presets.tokens.first=)

Teleport Database Service를 실행할 곳에 Teleport를 설치하고 구성합니다:

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.

Assign to your Teleport cluster hostname and port, but not the scheme (https://).

Run your cluster's install script:

$ curl "https:///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.

Run the following command to generate a configuration file at /etc/teleport.yaml for the Database Service. Update to use the host and port of the Teleport Proxy Service:

$ sudo teleport db configure create \
   -o file \
   --token=/tmp/token \
   --proxy=:443 \
   --name=cassandra \
   --protocol=cassandra \
   --uri=cassandra.example.com:9042 \
   --labels=env=dev

To configure the Teleport Database Service to trust a custom CA:

Export a CA certificate for the custom CA and make it available at /var/lib/teleport/db.ca on the Teleport Database Service host.

Run a variation of the command above that uses the --ca-cert-file flag. This configures the Teleport Database Service to use the CA certificate at db.ca to verify traffic from the database:

$ sudo teleport db configure create \
   -o file \
   --token=/tmp/token \
   --proxy=:443 \
   --name=cassandra \
   --protocol=cassandra \
   --uri=cassandra.example.com:9042 \
   --ca-cert-file="/var/lib/teleport/db.ca" \
   --labels=env=dev

If your database servers use certificates that are signed by a public CA such as ComodoCA or DigiCert, you can use the trust-system-cert-pool option without exporting the CA:

$ sudo teleport db configure create \
   -o file \
   --token=/tmp/token \
   --proxy=:443 \
   --name=cassandra \
   --protocol=cassandra \
   --uri=cassandra.example.com:9042 \
   --trust-system-cert-pool \
   --labels=env=dev

(!docs/pages/includes/start-teleport.mdx service="the Teleport Database Service"!)

Teleport는 Kubernetes 클러스터에 Teleport Database Service를 설치하기 위한 Helm 차트를 제공합니다.

Configure Helm to fetch Teleport charts from the Teleport Helm repository:

$ helm repo add teleport (=teleport.helm_repo_url=)

Refresh the local Helm cache by fetching the latest charts:

$ helm repo update

Install a Teleport Agent into your Kubernetes Cluster with the Teleport Database Service configuration.

Create a file called values.yaml with the following content. Update

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.

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

3/5단계. 상호 TLS 설정#

Teleport uses mutual TLS authentication with self-hosted databases. These databases must be configured with Teleport's certificate authority to be able to verify client certificates. They also need a certificate/key pair that Teleport can verify.

To use issue certificates from your workstation with tctl, your Teleport user must be allowed to impersonate the system role Db.

Include the following allow rule in in your Teleport user's role:

allow:
  impersonate:
    users: ["Db"]
    roles: ["Db"]

아래 지침에 따라 데이터베이스용 TLS 자격 증명을 생성합니다.

Cassandra#

Cassandra에 연결할 때 Teleport가 연결할 호스트 이름에 대한 인증서에 서명합니다:

$ tctl auth sign --format=cassandra --host=cassandra.example.com --out=server --ttl=2190h

이 명령은 두 개의 파일을 생성합니다:

JKS 형식의 생성된 개인 키 및 사용자 인증서가 포함된 server.keystore.
JKS 형식의 Teleport 인증 기관이 포함된 server.truststore.

Teleport 데이터베이스 클라이언트 CA 대신 기존 인증 기관을 사용하여 Cassandra용 인증서에 서명하려면 server.keystore를 삭제하고 기존 CA로 생성된 keystore를 대신 사용하세요.

Scylla#

Teleport uses mutual TLS authentication with self-hosted databases. These databases must be able to verify certificates presented by the Teleport Database Service. Self-hosted databases also need a certificate/key pair that Teleport can verify.

By default, the Teleport Database Service trusts certificates issued by a certificate authority managed by the Teleport Auth Service. You can either:

Configure your self-hosted database to trust this CA, and instruct Teleport to issue a certificate for the database to present to the Teleport Database Service.
Configure the Database Service to trust a custom CA.

4/5단계. Cassandra/Scylla 구성#

데이터베이스에 대한 지침에 따라 Teleport 클러스터와의 TLS 통신을 활성화합니다:

Cassandra가 TLS 연결을 수락하도록 구성하려면 Cassandra 구성 파일 cassandra.yaml에 다음을 추가합니다:

client_encryption_options:
  enabled: true
  optional: false
  keystore: /path/to/server.keystore
  keystore_password: "password"
  require_client_auth: true
  truststore: /path/to/server.truststore
  truststore_password: "password"
  protocol: TLS
  algorithm: SunX509
  store_type: JKS
  cipher_suites: [TLS_RSA_WITH_AES_256_CBC_SHA]

위 구성에서 "password"를 이전 단계의 tctl auth sign 명령으로 생성된 값으로 교체합니다. Cassandra 인스턴스를 재시작하여 이 구성을 활성화합니다.

Scylla가 TLS 연결을 수락하도록 구성하려면 Scylla 구성 파일 scylla.yaml에 다음을 추가합니다:

client_encryption_options:
  enabled: true
  certificate: /path/to/server.crt
  keyfile: /path/to/server.key
  truststore:  /path/to/server.cas
  require_client_auth: True

Scylla 인스턴스를 재시작하여 이 구성을 활성화합니다.

5/5단계. 연결#

Database Service가 클러스터에 참여하면 로그인하여 사용 가능한 데이터베이스를 확인합니다:

$ tsh login --proxy=teleport.example.com --user=alice
$ tsh db ls
# Name      Description       Allowed Users Labels  Connect
# --------- ----------------- ------------- ------- -------
# cassandra Cassandra Example [*]           env=dev

$ tsh login --proxy=mytenant.teleport.sh --user=alice
$ tsh db ls
# Name      Description       Allowed Users Labels  Connect
# --------- ----------------- ------------- ------- -------
# cassandra Cassandra Example [*]           env=dev

특정 데이터베이스 인스턴스에 연결하려면:

$ tsh db connect --db-user=cassandra cassandra
# Password:
# Connected to Test Cluster at localhost:49594
# [cqlsh 6.0.0 | Cassandra 4.0.5 | CQL spec 3.4.5 | Native protocol v5]
# Use HELP for help.
# cassandra@cqlsh>

데이터베이스에서 로그아웃하고 자격 증명을 제거하려면:

# 특정 데이터베이스 인스턴스의 자격 증명 제거.
$ tsh db logout example
# 모든 데이터베이스 인스턴스의 자격 증명 제거.
$ tsh db logout

다음 단계#

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.