# Database Access with Oracle Teleport can provide secure access to Oracle via the [Teleport Database Service](https://goteleport.com/docs/ver/17.x/enroll-resources/database-access.md). This allows for fine-grained access control through the [Teleport RBAC system](https://goteleport.com/docs/ver/17.x/enroll-resources/database-access/rbac.md). 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: 1. Configure your Oracle database for Teleport access. 2. Add the database to your Teleport cluster. 3. Connect to the database via Teleport. ## How it works The Teleport Database Service authenticates to your self-hosted Oracle database using mutual TLS. Oracle 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. **Teleport Enterprise** ![Enroll Oracle with a Self-Hosted Teleport Cluster](/docs/assets/images/oracle_selfhosted-b86a597fc5b6d731beff75a9bd8b71b3.png) **Teleport Enterprise Cloud** ![Enroll Oracle with a Cloud-Hosted Teleport Cluster](/docs/assets/images/oracle_selfhosted_cloud-83cd919797f36b5e688024a1125e0585.png) ## Prerequisites - A running Teleport Enterprise 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/ver/17.x/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/ver/17.x/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 ``` * Self-hosted Oracle server instance 18c or later. * The `sqlcl` [Oracle client](https://www.oracle.com/pl/database/sqldeveloper/technologies/sqlcl/) installed and added to your system's `PATH` environment variable or any GUI client that supports JDBC Oracle thin client. * Optional: a certificate authority that issues certificates for your self-hosted database. ## Step 1/6. Create a Teleport token and user 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 ``` --- TIP To modify an existing user to provide access to the Database Service, see [Database Access Controls](https://goteleport.com/docs/ver/17.x/enroll-resources/database-access/rbac.md) --- 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 and MongoDB databases. --- For more detailed information about database access controls and how to restrict access see [RBAC](https://goteleport.com/docs/ver/17.x/enroll-resources/database-access/rbac.md) documentation. ## Step 2/6. Create a certificate/key pair and Teleport Oracle Wallet 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"] ``` Follow the instructions below to generate TLS credentials for your database. ``` Export Teleport's certificate authority and a generated certificate/key pair for host db.example.com with a 3-month validity period. $ tctl auth sign --format=oracle --host=db.example.com --out=server --ttl=2190h ``` In this example, `db.example.com` is the hostname where the Teleport Database Service can reach the Oracle server. --- TTL We recommend using a shorter TTL, but keep mind that you'll need to update the database server certificate before it expires to not lose the ability to connect. Pick the TTL value that best fits your use-case. --- If `tctl` finds the Orapki tool in your local environment, the `tctl auth sign --format=oracle --host=db.example.com --out=server --ttl=2190h` command will produce an Oracle Wallet and instructions how to configure the Oracle TCPS listener with Teleport Oracle Wallet. Otherwise the `tctl auth sign --format=oracle` command will produce a `p12` certificate and instructions on how to create an Oracle Wallet on your Oracle Database instance. If your Oracle database presents TLS credentials signed by an existing certificate authority, take the following steps instead: 1. Export a Teleport CA certificate for Oracle to authenticate traffic from the Teleport Database Service. Run the following command on your workstation: ``` $ tctl auth export --type=db-client --auth-server=example.teleport.sh:443 > server.ca-client.crt ``` 2. Move `server.ca-client.crt` to a directory in your Oracle server you will use for your Oracle wallet. 3. Issue a key and certificate in PKCS12 format for the Oracle server and move the resulting P12 file to `server.p12` in your Oracle wallet directory. 4. Use the `orapki` tool on your Oracle server to set up an Oracle wallet: ``` Assign this to your password $ PKCS12_PASS="" $ WALLET_DIR="/path/to/oracleWalletDir" $ orapki wallet create -wallet "$WALLET_DIR" -auto_login_only $ orapki wallet import_pkcs12 -wallet "$WALLET_DIR" -auto_login_only -pkcs12file server.p12 -pkcs12pwd ${PKCS12_PASS?} $ orapki wallet add -wallet "$WALLET_DIR" -trusted_cert -auto_login_only -cert server.ca-client.crt ``` --- WARNING If copying these files to your Oracle server, ensure the cert file permissions are readable by the `oracle` user. --- ## Step 3/6. Configure Oracle Database In order to enable the Teleport Oracle integration you will need to configure the TCPS Oracle listener and use the Teleport Oracle Wallet created in the previous step. Align your `listener.ora` Oracle configuration file and add the following entries: ``` LISTENER = (DESCRIPTION_LIST = (DESCRIPTION = (ADDRESS = (PROTOCOL = TCPS)(HOST = 0.0.0.0)(PORT = 2484)) ) ) WALLET_LOCATION = (SOURCE = (METHOD = FILE)(METHOD_DATA = (DIRECTORY = /path/to/oracleWalletDir))) SSL_CLIENT_AUTHENTICATION = TRUE ``` Additionally, you will need to extend your `sqlnet.ora` Oracle configuration: ``` WALLET_LOCATION = (SOURCE = (METHOD = FILE)(METHOD_DATA = (DIRECTORY = /path/to/oracleWalletDir))) SSL_CLIENT_AUTHENTICATION = TRUE SQLNET.AUTHENTICATION_SERVICES = (TCPS) ``` --- TIP You will need to reload Oracle Listener `lsnrctl reload` after updating the `listener.ora` configuration file. --- Additionally, your Oracle Database user accounts must be configured to require a valid client certificate. If you're creating a new user: ``` CREATE USER alice IDENTIFIED EXTERNALLY AS 'CN=alice'; GRANT CREATE SESSION TO alice; ``` ## Step 4/6. Configure and Start the Database Service Install and configure Teleport where you will run the Teleport Database Service: **Linux Server** 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` | 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=teleport.example.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=teleport.example.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.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](https://goteleport.com/docs/ver/17.x/installation/linux.md). 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 example.teleport.sh to use the host and port of the Teleport Proxy Service: ``` $ sudo teleport db configure create \ -o file \ --token=/tmp/token \ --proxy=example.teleport.sh:443 \ --name=oracle \ --protocol=oracle \ --uri=oracle.example.com:2484 \ --labels=env=dev ``` To configure the Teleport Database Service to trust a custom CA: 1. Export a CA certificate for the custom CA and make it available at `/var/lib/teleport/db.ca` on the Teleport Database Service host. 2. 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=example.teleport.sh:443 \ --name=oracle \ --protocol=oracle \ --uri=oracle.example.com:2484 \ --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=example.teleport.sh:443 \ --name=oracle \ --protocol=oracle \ --uri=oracle.example.com:2484 \ --trust-system-cert-pool \ --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. Set up the Teleport Helm repository. Allow Helm to install charts that are hosted in the Teleport Helm repository: ``` $ helm repo add teleport https://charts.releases.teleport.dev ``` Update the cache of charts from the remote repository so you can upgrade to all available releases: ``` $ 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 example.teleport.sh to use the host and port of the Teleport Proxy Service and JOIN\_TOKEN to the join token you created earlier: ``` roles: db proxyAddr: example.teleport.sh # Set to false if using Teleport Community Edition enterprise: true authToken: "JOIN_TOKEN" databases: - name: oracle uri: oracle.example.com:2484 protocol: oracle static_labels: env: dev ``` To configure the Teleport Database Service to trust a custom CA: 1. Export a CA certificate for the custom CA and make it available at `db.ca` on your workstation. 2. Create a secret containing the database CA certificate in the same namespace as Teleport using the following command: ``` $ kubectl create secret generic db-ca --from-file=ca.pem=/path/to/db.ca ``` 3. Add the following to `values.yaml`: ``` roles: db proxyAddr: example.teleport.sh # Set to false if using Teleport Community Edition enterprise: true authToken: JOIN_TOKEN databases: - name: oracle uri: oracle.example.com:2484 protocol: oracle + tls: + ca_cert_file: "/etc/teleport-tls-db/db-ca/ca.pem" static_labels: env: dev + extraVolumes: + - name: db-ca + secret: + secretName: db-ca + extraVolumeMounts: + - name: db-ca + mountPath: /etc/teleport-tls-db/db-ca + readOnly: true ``` 4. Install the chart: ``` $ helm install teleport-kube-agent teleport/teleport-kube-agent \ --create-namespace \ --namespace teleport-agent \ --version 17.7.20 \ -f values.yaml ``` 5. 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 the SSH Service or Application Service. --- ## Step 5/6. (Optional) Configure Teleport to pull audit logs from Oracle Audit Trail Teleport can pull audit logs from Oracle Audit Trail. In order to enable this feature, you will need to configure Oracle Audit Trail and create a dedicated Teleport user that will be used to fetch audit events from Oracle Audit Trail. Create an internal Oracle `teleport` user that will fetch audit events from Oracle Audit Trail: ``` CREATE USER teleport IDENTIFIED EXTERNALLY AS 'CN=teleport'; GRANT CREATE SESSION TO teleport; GRANT SELECT ON SYS.DBA_AUDIT_TRAIL TO teleport; GRANT SELECT ON SYS.V_$SESSION TO teleport; ``` Enable the table in Oracle Audit Trail: ``` ALTER system SET audit_trail=db,extended scope=spfile; ``` Restart your Oracle instance to propagate audit trail changes. Enable Oracle auditing for the `alice` user: ``` AUDIT ALL STATEMENTS by alice BY access; ``` You must enable auditing for each Teleport user that will be used to connect to Oracle. Additionally you can create a different audit policy for each user. Edit the Database Service configuration you created earlier to pull audit logs from the Oracle Audit Trail: ``` db_service: enabled: true databases: - name: "oracle" protocol: "oracle" uri: "oracle.example.com:2484" oracle: audit_user: "teleport" ``` Teleport doesn't clean up audit trail events from Oracle Audit Trail. Make sure to configure an Oracle Audit Trail cleanup policy to avoid running out of disk space. ## Step 6/6. Connect Once the Database Service has joined the cluster, log in to see the available databases: ``` $ tsh login --proxy=example.teleport.sh --user=alice $ tsh db ls Name Description Allowed Users Labels Connect ------ -------------- ------------- ------- ------- oracle Oracle Example [*] env=dev ``` Connect to the database: ``` $ tsh db connect --db-user=alice --db-name=XE oracle SQLcl: Release 22.4 Production on Fri Mar 31 20:48:02 2023 Copyright (c) 1982, 2023, Oracle. All rights reserved. Connected to: Oracle Database 21c Express Edition Release 21.0.0.0.0 - Production Version 21.3.0.0.0 SQL> ``` To log out of the database and remove credentials: ``` Remove credentials for a particular database instance. $ tsh db logout oracle Remove credentials for all database instances. $ tsh db logout ``` ## Next steps - Learn how to [restrict access](https://goteleport.com/docs/ver/17.x/enroll-resources/database-access/rbac.md) to certain users and databases. * View the [High Availability (HA)](https://goteleport.com/docs/ver/17.x/enroll-resources/database-access/guides/ha.md) guide. - Take a look at the YAML configuration [reference](https://goteleport.com/docs/ver/17.x/reference/agent-services/database-access-reference/configuration.md). * See the full CLI [reference](https://goteleport.com/docs/ver/17.x/reference/agent-services/database-access-reference/cli.md). - Learn more about `sqlnet.ora` and `listener.ora` configuration from the [Parameters for the sqlnet.ora File](https://docs.oracle.com/en/database/oracle/oracle-database/18/netrf/parameters-for-the-sqlnet-ora-file.html#guid-28040885-6832-4ffc-9258-0ef19fe9a3ac) and [Oracle Net Listener Parameters in the listener.ora File](https://docs.oracle.com/en/database/oracle/oracle-database/18/netrf/oracle-net-listener-parameters-in-listener-ora-file.html#guid-f9fa0df5-2faf-45ca-b6a1-f0166c7bfe54) Oracle documentation. - [Oracle Audit Trail](https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/audit-traditional-auditing.html#guid-adf45b07-547a-4096-8144-50241fa2d8dd)