MySQL Connection

Configure a MySQL Role for Hanzo KMS

Hanzo KMS recommends creating a designated role in your MySQL database for your connection.

-- create user role
CREATE USER 'kms_role'@'%' IDENTIFIED BY 'my-password';

Depending on how you intend to use your MySQL connection, you'll need to grant one or more of the following permissions.

To learn more about MySQL's permission system, please visit their documentation.

For Secret Rotations, your Hanzo KMS user will require the ability to alter other users' passwords:

-- enable permissions to alter login credentials
GRANT CREATE USER ON *.* TO 'kms_role'@'%';

-- Apply changes
FLUSH PRIVILEGES;

You'll need the following information to create your MySQL connection:

• host - The hostname or IP address of your MySQL server
• port - The port number your MySQL server is listening on (default: 3306)
• database - The name of the specific database you want to connect to
• username - The role name of the login created in the steps above
• password - The role password of the login created in the steps above
• sslCertificate (optional) - The SSL certificate required for connection (if configured)

If you are self-hosting Hanzo KMS and intend to connect to an internal/private IP address, be sure to set the ALLOW_INTERNAL_IP_CONNECTIONS environment variable to true.

Create Connection in Hanzo KMS

1. Navigate to the Integrations tab in the desired project, then select App Connections.

2. Select the MySQL Connection option.

3. Select the Username & Password method option and provide the details obtained from the previous section and press Connect to MySQL.

Optionally, if you'd like Hanzo KMS to manage the credentials of this connection, you can enable the Platform Managed Credentials option. If enabled, Hanzo KMS will update the password of the connection on creation to prevent external access to this database role.

4. Your MySQL Connection is now available for use.

To create a MySQL Connection, make an API request to the Create MySQL Connection API endpoint.

Optionally, if you'd like Hanzo KMS to manage the credentials of this connection, you can set the isPlatformManagedCredentials option to true. If enabled, Hanzo KMS will update the password of the connection on creation to prevent external access to this database role.

Sample request

curl    --request POST \
--url https://app.kms.hanzo.ai/api/v1/app-connections/mysql \
--header 'Content-Type: application/json' \
--data '{
    "name": "my-mysql-connection",
    "method": "username-and-password",
    "isPlatformManagedCredentials": true,
    "projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
    "credentials": {
        "host": "123.4.5.6",
        "port": 3306,
        "database": "default",
        "username": "kms_role",
        "password": "my-password",
        "sslEnabled": true,
        "sslRejectUnauthorized": true
    },
}'

Sample response

{
    "appConnection": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "my-mysql-connection",
        "projectId": "7ffbb072-2575-495a-b5b0-127f88caef78",
        "version": 1,
        "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "app": "mysql",
        "method": "username-and-password",
        "isPlatformManagedCredentials": true,
        "credentials": {
            "host": "123.4.5.6",
            "port": 3306,
            "database": "default",
            "username": "kms_role",
            "sslEnabled": true,
            "sslRejectUnauthorized": true
        }
    }
}