Using an SSO Client to Log In to a Database Resource for Operations
You can use single sign-on (SSO) tools to call the database client for database resource operations and operation audits. Before you start, install the SSO and database client tools and then configure the path of the database client tool.
This topic describes how to configure the SSO client and how to use the SSO tool to log in to database resources.
Supported Protocols and Clients
Table 1 describes the database protocols that support SSO-based operations as well as supported clients and versions.
| Database Type | Version | Supported Client |
|---|---|---|
| MySQL | 5.5, 5.6, 5.7, and 8.0 | Navicat 11, 12, 15, 16 MySQL Administrator 1.2.17 MySQL CMD DBeaver 22 and 23 (supported by bastion host V3.3.48.0 and later) |
| Microsoft SQL Server | 2014, 2016, 2017, 2019, and 2022 | Navicat 11, 12, 15, 16 SSMS 17.6, 18, and 19 |
| Oracle | 10g, 11g, 12c, 19c, and 21c | Toad for Oracle 11.0, 12.1, 12.8, and 13.2 Navicat 11, 12, 15, 16 PL/SQL Developer 11.0.5.1790 DBeaver 22 and 23 (supported by bastion host V3.3.48.0 and later) |
| DB2 | DB2 Express-C | DB2 CMD command line 11.1.0 |
| PostgreSQL | 11, 12, 13, 14, and 15 | DBeaver 22 and 23 |
| GaussDB | 2 and 3 | DBeaver 22 and 23 |
| DM | DM8 | DM management tool V8 (supported in Build 2023.12.14) |
| Redis | 5.0 and 6.0 | redis-cli x64 5.0.9 (git:9414ab9b) |
| MongoDB | 4.4, 5.0, and 8.2.0 | Navicat 15, 16, and 17 |
Notes and Constraints
- The database operation audit is available only in professional editions.
- Multiple Navicat clients can be opened to maintain databases.
- The client timeout period (Idle timeout in Configuring Client Login) configured in the system does not apply to MongoDB databases.
- If you upgrade a bastion host of a version earlier than V3.3.56.0 to V3.3.56.0 or later, you need to download and install SsoDBSettings again. For details, see Step 1: Download the SSO Tool (Required for the First Login).
- The bastion host cannot verify SSL-enabled databases. To log in to such a database, you are advised to use the DBeaver client and disable SSL on the client. (Under , add the sslmode property to the connection properties and set its value to disable.)
- The SsoTool.msi remote tool can be installed only in the default path C:\sso\SsoTool. If you install it in other paths, the tool may fail to be started.
Prerequisites
- Your role has the management permission for the Host Operations module. For details about how to check the permissions of each role, see Role.
- You have obtained the access permissions for the resources.
- You have installed the supported client tool on your local PC. For details, see Supported Protocols and Clients.
- The network connection between the managed host and the system is normal, and the account username and password for logging in to the managed host are correct.
Step 1: Download the SSO Tool (Required for the First Login)
- Log in to your bastion host system.
- Click
in the upper right corner to go to the download center. - On the Common Tools tab, click
on the right of SSOTool Windows to download the tool to your local PC. - Double-click SsoTool.msi and install the tool on the local PC as prompted.
Step 2: Configure the Client Path of the SSO Tool (Required for the First Login)
The following uses Navicat as an example. The procedure for configuring the path of other clients is similar.
- Start local SSO tool SsoDBSettings.
- Click the path configuration icon next to Navicat Path.
- Find the absolute path where the Navicat client is installed, select the .exe file, and click Open.
- Go to the SsoDBSettings SSO tool configuration page and view the selected Navicat client path.
- Click Save.
Step 3: Log In to a Database for O&M
- Log in to your bastion host system.
- Choose Operation > Host Operations to go to the Host Operations page.
- Quickly search for the target database.
- Expand Resource Group on the left to check the resource group view.
In the Personal Resource Group or Public Resource Group area on the left of the content pane, click a resource group name. Then only the host or database resources in the selected resource group will be displayed in the list. If no resource group is selected, all host or database resources are displayed by default.
- Above the host list, enter a keyword in the search box to quickly search for resources by host name or host address.
- Expand Resource Group on the left to check the resource group view.
- Locate a server with a database protocol and click Login in the Operation column.
The client tool selection window is displayed.
- Select the client tool (for example, Navicat) installed on the local PC and click OK.
The system automatically calls the local database client tool to log in to the database.