arrow-left

All pages
gitbookPowered by GitBook
1 of 4

Loading...

Loading...

Loading...

Loading...

Example: MySQL Database

Configuring MySQL DB as a PAM Database Record

hashtag
Overview

In this example, you'll learn how to configure a MySQL DB in your Keeper Vault as a PAM Database record.

hashtag
Prerequisites

Prior to proceeding with this guide, make sure you have

hashtag
PAM Database Record

Databases such as a MySQL DB can be configured on the PAM Database record type.

hashtag
Creating a PAM Database

To create a PAM Database:

  • Click on Create New

  • Depending on your use case, click on "Rotation", "Tunnel", or "Connection"

  • On the prompted window:

hashtag
Configure a MySQL Database on the PAM Database Record

Suppose I have a database with the hostname "db-mysql-1", the following table lists all the configurable fields and their respective values:

Field
Description
Value

hashtag
Configuring PAM Settings on the PAM Database

On the "PAM Settings" section of the vault record, you can configure the KeeperPAM Connection and Tunnel settings and link a PAM User credential for performing rotations and connections. Tunnels do not require a linked credential. The following table lists all the configurable fields and their respective values for the MySQL Database:

Field
Description
Required

hashtag
Administrative Credential Record

The Admin Credential Record in the PAM Database links a user to the PAM Database record in your Keeper Vault. This linked user is used for authenticating the connection when clicking "Launch".

User Accounts are configured on the PAM User record. Visit this for more information.

hashtag
Setting a Non Admin User as the Administrative Credential Record

If you prefer not to authenticate a connection using the admin credential, you can optionally designate a regular user of the resource as the admin credential.

hashtag
Sharing PAM Database Records

PAM Database records can be shared with other Keeper users within your organization. However, the recipient must be assigned to a role with the appropriate PAM enforcement policies in place to utilize KeeperPAM features.

When sharing a PAM Database record, the linked admin credentials will not be shared. For example, if the PAM Database is configured with a MySQL Database, the recipient can connect to the database without having direct access to the linked credentials.

  • Learn more about

hashtag
Setup Complete

The MySQL Database record is set up. The user with the ability to launch connections can now launch an interactive MySQL connection or tunnel to the target database.

Select "New Record"
  • Select the Shared Folder you want the record to be created in

  • Specify the Title

  • Select "Database" for the Target

  • Click "Next" and complete all of the required information.

  • Database ID

    Azure or AWS Resource ID (if applicable)

    Required if a managed AWS or Azure Database

    Database Type

    Appropriate database type from supported databases.

    mysql

    Provider Group

    Azure or AWS Provider Group

    Required if a managed AWS or Azure Database

    Provider Region

    Azure or AWS Provider Region

    Required if a managed AWS or Azure Database

    Connection Parameters

    Connection-specific protocol settings which can vary based on the protocol type

    See this for MySQL protocol settings We recommend specifying the Connection Port at a minimum. E.g. "3306" for MySQL.

    Title (Required)

    Title of the PAM Database Record

    Local MySQL Database

    Hostname or IP Address (Required)

    Address or RDP endpoint or Server name of the Database Resource

    db-mysql-1

    Port (Required)

    Port to connect to the Database Resource

    3306

    Use SSL (Required)

    Check to perform SSL verification before connecting, if your database has SSL configured

    Enabled

    PAM Configuration

    Associated PAM Configuration record which defines the environment

    Required - This is the PAM configuration you created in the prerequisites

    Administrative Credential Record

    Linked PAM User credential used for connection and administrative operations

    Required Visit this section for more details

    Protocol

    Native database protocol used for connecting from the Gateway to the target

    Required - for this example: "MySQL"

    Session Recording

    Options for recording sessions and typescripts

    See session recordingarrow-up-right

    Installed and configured the Keeper Gateway
    Set up a PAM Configuration for your target Environment
    page
    Sharing and Access Control
    PAM Database
    Administrative Credential Record
    Sharing PAM Database Records
    MySQL Database Record
    Connection to MySQL Database
    MySQL Interactive Session
    sectionarrow-up-right

    Example: Microsoft SQL Server Database

    Configuring Microsoft SQL Server DB as a PAM Database Record

    hashtag
    Overview

    In this example, you'll learn how to configure a Microsoft SQL Server DB in your Keeper Vault as a PAM Database record.

    hashtag
    Prerequisites

    Prior to proceeding with this guide, make sure you have

    hashtag
    PAM Database Record

    Databases such as a Microsoft SQL Server DB can be configured on the PAM Database record type.

    hashtag
    Creating a PAM Database

    To create a PAM Database:

    • Click on Create New

    • Depending on your use case, click on "Rotation", "Tunnel", or "Connection"

    • On the prompted window:

    hashtag
    Configure a Microsoft SQL Server Database on the PAM Database Record

    Suppose I have a database with the hostname "db-mssql-1", the following table lists all the configurable fields and their respective values:

    Field
    Description
    Value

    hashtag
    Configuring PAM Settings on the PAM Database

    On the "PAM Settings" section of the vault record, you can configure the KeeperPAM Connection and Tunnel settings and link a PAM User credential for performing rotations and connections. Tunnels do not require a linked credential. The following table lists all the configurable fields and their respective values for the Microsoft SQL Database:

    Field
    Description
    Required

    hashtag
    Administrative Credential Record

    The Admin Credential Record in the PAM Database links a user to the PAM Database record in your Keeper Vault. This linked user is used for authenticating the connection when clicking "Launch".

    User Accounts are configured on the PAM User record. Visit this for more information.

    hashtag
    Setting a Non Admin User as the Administrative Credential Record

    If you prefer not to authenticate a connection using the admin credential, you can optionally designate a regular user of the resource as the admin credential.

    hashtag
    Sharing PAM Database Records

    PAM Database records can be shared with other Keeper users within your organization. However, the recipient must be assigned to a role with the appropriate PAM enforcement policies in place to utilize KeeperPAM features.

    When sharing a PAM Database record, the linked admin credentials will not be shared. For example, if the PAM Database is configured with a Microsoft SQL Database, the recipient can connect to the database without having direct access to the linked credentials.

    • Learn more about

    hashtag
    Setup Complete

    The Microsoft SQL Database record is set up. The user with the ability to launch connections can now launch an interactive SQL connection or tunnel to the target database.

    Select "New Record"
  • Select the Shared Folder you want the record to be created in

  • Specify the Title

  • Select "Database" for the Target

  • Click "Next" and complete all of the required information.

  • Database ID

    Azure or AWS Resource ID (if applicable)

    Required if a managed AWS or Azure Database

    Database Type

    Appropriate database type from supported databases.

    mssql

    Provider Group

    Azure or AWS Provider Group

    Required if a managed AWS or Azure Database

    Provider Region

    Azure or AWS Provider Region

    Required if a managed AWS or Azure Database

    Connection Parameters

    Connection-specific protocol settings which can vary based on the protocol type

    See this for SQL Server protocol settings We recommend specifying the Connection Port at a minimum. E.g. "1433" for SQL Server.

    Title (Required)

    Title of the PAM Database Record

    Local SQL Database

    Hostname or IP Address (Required)

    Address or RDP endpoint or Server name of the Database Resource

    db-mssql-1

    Port (Required)

    Port to connect to the Database Resource

    1433

    Use SSL (Required)

    Check to perform SSL verification before connecting, if your database has SSL configured

    Enabled

    PAM Configuration

    Associated PAM Configuration record which defines the environment

    Required - This is the PAM configuration you created in the prerequisites

    Administrative Credential Record

    Linked PAM User credential used for connection and administrative operations

    Required Visit this section for more details

    Protocol

    Native database protocol used for connecting from the Gateway to the target

    Required - for this example: "SQL Server"

    Session Recording

    Options for recording sessions and typescripts

    See session recordingarrow-up-right

    Installed and configured the Keeper Gateway
    Set up a PAM Configuration for your target Environment
    page
    Sharing and Access Control
    SQL Server PAM Database Record
    Administrative Credential Record
    Sharing PAM Database Records
    Microsoft SQL Server Database
    Connection to a Microsoft SQL Database
    Interactive Session with Microsoft SQL Database
    sectionarrow-up-right

    PAM Database

    KeeperPAM resource for managing databases either on-prem or in the cloud

    hashtag
    Overview

    In your Keeper Vault, the following assets can be configured on the PAM Database record type:

    PAM Record Type
    Supported Assets

    This guide will cover the PAM Database Record type in more details.

    hashtag
    Features Available

    The PAM Database resource supports the following features:

    • Password rotation

    • Zero-trust Connections

    • TCP Tunnels

    • Graphical session recording

    circle-info

    Connecting to the PAM database requires only that the Keeper Gateway has access to the database either through native protocols or AWS/Azure APIs. The Keeper Vault operates independently and does not require direct connectivity to the database, leveraging Keeper's zero-trust network access model to securely manage access through the Gateway. See the for more details.

    hashtag
    Creating a PAM Database

    Prior to creating a PAM Database, make sure you have already created a PAM Configuration. The PAM Configuration contains information of your target infrastructure while the PAM Database contains information about the target database, such as the hostname, type (MySQL, PostgreSQL, etc) and port number.

    To create a PAM Database:

    • Click on Create New

    • Depending on your use case, click on "Rotation", "Tunnel", or "Connection"

    • On the prompted window:

    hashtag
    PAM Database Record Type Fields

    The following table lists all the configurable fields on the PAM Database Record Type:

    Field
    Description
    Notes

    hashtag
    PAM Settings and Administrative Credentials

    On the "PAM Settings" section of the vault record, you can configure the KeeperPAM Connection and Tunnel settings and link a PAM User credential for performing rotations and connections. Tunnels do not require a linked credential.

    hashtag
    PAM Settings

    Field
    Description
    Required

    Below is an example of a PAM Database record with Connections and Tunnels activated.

    hashtag
    Examples

    Visit the following pages to set up:

    Text session recording (Typescript)

  • Sharing access without sharing credentials

  • Select "New Record"
  • Select the Shared Folder you want the record to be created in

  • Specify the Title

  • Select "Database" for the Target

  • Click "Next" and complete all of the required information.

  • Database name to connect to

    Required for connecting to PostgreSQL, MongoDB, and MS SQL Server

    Database Id

    Azure or AWS Resource ID

    Required if a managed AWS or Azure Database

    Database Type

    Appropriate database type from supported databases.

    If a non-standard port is provided, the Database Type will be used to determine connection method.

    Provider Group

    Azure or AWS Provider Group

    Required if a managed AWS or Azure Database

    Provider Region

    Azure or AWS Provider Region

    Required if a managed AWS or Azure Database

    Connection Parameters (multiple)

    Connection-specific protocol settings which can vary based on the protocol type

    Depends on protocol

    PAM Database

    MySQL, PostgreSQL, SQL Server, MongoDB, MariaDB, Oracle

    Hostname or IP Address

    Address of the Database Resource

    Required

    Port

    Port to connect to the Database Resource

    Required Standard ports are: PostgreSQL: 5432 MySQL: 3306 Maria DB: 3306 Microsoft SQL: 1433 Oracle: 1521 Mongo DB: 27017

    Use SSL

    Use SSL when connecting

    PAM Configuration

    Associated PAM Configuration record which defines the environment

    Required

    Administrative Credential Record

    Linked PAM User credential used for connection and administrative operations

    Required Visit this section for more details

    Protocol

    Native database protocol used for connecting from the Gateway to the target

    Required

    Session Recording

    Options for recording sessions and typescripts

    See session recording

    network architecture diagram
    MySQL Database
    PostgreSQL Database
    Microsoft SQL Server Database
    Create a PAM Database
    PAM Settings and Administrative Credentials
    PAM Settings on Database resource
    PAM Database with Connections and Tunnels activated

    Connect Database

    Example: PostgreSQL Database

    Configuring PostgreSQL DB as a PAM Database Record

    hashtag
    Overview

    In this example, you'll learn how to configure a PostgreSQL DB in your Keeper Vault as a PAM Database record.

    hashtag
    Prerequisites

    Prior to proceeding with this guide, make sure you have

    hashtag
    PAM Database Record

    Databases such as a PostgreSQL DB can be configured on the PAM Database record type.

    hashtag
    Creating a PAM Database

    To create a PAM Database:

    • Click on Create New

    • Depending on your use case, click on "Rotation", "Tunnel", or "Connection"

    • On the prompted window:

    hashtag
    Configure a PostgreSQL Database on the PAM Database Record

    Suppose I have a database with the hostname "db-postgres-1", the following table lists all the configurable fields and their respective values:

    Field
    Description
    Value

    hashtag
    Configuring PAM Settings on the PAM Database

    On the "PAM Settings" section of the vault record, you can configure the KeeperPAM Connection and Tunnel settings and link a PAM User credential for performing rotations and connections. Tunnels do not require a linked credential. The following table lists all the configurable fields and their respective values for the PostgreSQL Database:

    Field
    Description
    Required

    hashtag
    Administrative Credential Record

    The Admin Credential Record in the PAM Database links a user to the PAM Database record in your Keeper Vault. This linked user is used for authenticating the connection when clicking "Launch".

    User Accounts are configured on the PAM User record. Visit this for more information.

    hashtag
    Setting a Non Admin User as the Administrative Credential Record

    If you prefer not to authenticate a connection using the admin credential, you can optionally designate a regular user of the resource as the admin credential.

    hashtag
    Sharing PAM Database Records

    PAM Database records can be shared with other Keeper users within your organization. However, the recipient must be assigned to a role with the appropriate PAM enforcement policies in place to utilize KeeperPAM features.

    When sharing a PAM Database record, the linked admin credentials will not be shared. For example, if the PAM Database is configured with a PostgreSQL Database, the recipient can connect to the database without having direct access to the linked credentials.

    • Learn more about

    hashtag
    Setup Complete

    The PostgreSQL Database record is set up. The user with the ability to launch connections can now launch an interactive PostgreSQL connection or tunnel to the target database.

    Select "New Record"
  • Select the Shared Folder you want the record to be created in

  • Specify the Title

  • Select "Database" for the Target

  • Click "Next" and complete all of the required information.

  • Database ID

    Azure or AWS Resource ID (if applicable)

    Required if a managed AWS or Azure Database

    Database Type

    Appropriate database type from supported databases.

    postgresql

    Provider Group

    Azure or AWS Provider Group

    Required if a managed AWS or Azure Database

    Provider Region

    Azure or AWS Provider Region

    Required if a managed AWS or Azure Database

    Connection Parameters

    Connection-specific protocol settings which can vary based on the protocol type

    See this for PostgreSQL protocol settings We recommend specifying the Connection Port at a minimum. E.g. "5432" for PostgreSQL.

    Title (Required)

    Title of the PAM Database Record

    PostgreSQL Database - postgresuser

    Hostname or IP Address (Required)

    Address or RDP endpoint or Server name of the Database Resource

    db-postgres-1

    Port (Required)

    Port to connect to the PostgreSQL DB Resource

    5432

    Use SSL (Required)

    Check to perform SSL verification before connecting, if your database has SSL configured

    Enabled

    PAM Configuration

    Associated PAM Configuration record which defines the environment

    Required - This is the PAM configuration you created in the prerequisites

    Administrative Credential Record

    Linked PAM User credential used for connection and administrative operations

    Required Visit this section for more details

    Protocol

    Native database protocol used for connecting from the Gateway to the target

    Required - for this example: "PostgreSQL"

    Session Recording

    Options for recording sessions and typescripts

    See session recordingarrow-up-right

    Installed and configured the Keeper Gateway
    Set up a PAM Configuration for your target Environment
    page
    Sharing and Access Control
    PostgreSQL PAM Database Record
    Administrative Credential Record
    Sharing a PostgreSQL Database Record
    Launching interactive CLI session to PostgreSQL
    Interactive Connection to PostgreSQL Database
    sectionarrow-up-right