Documentation Home
MySQL 9.3 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 40.8Mb
PDF (A4) - 40.9Mb
Man Pages (TGZ) - 261.1Kb
Man Pages (Zip) - 368.3Kb
Info (Gzip) - 4.1Mb
Info (Zip) - 4.1Mb


8.4.5.18 Keyring System Variables

MySQL Keyring plugins support the following system variables. Use them to configure keyring plugin operation. These variables are unavailable unless the appropriate keyring plugin is installed (seeSection 8.4.5.3, “Keyring Plugin Installation”).

  • keyring_aws_cmk_id

    Command-Line Format--keyring-aws-cmk-id=value
    System Variablekeyring_aws_cmk_id
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    TypeString

    The KMS key ID obtained from the AWS KMS server and used by thekeyring_aws plugin. This variable is unavailable unless that plugin is installed.

    This variable is mandatory. If not specified,keyring_aws initialization fails.

  • keyring_aws_conf_file

    Command-Line Format--keyring-aws-conf-file=file_name
    System Variablekeyring_aws_conf_file
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    TypeFile name
    Default Valueplatform specific

    The location of the configuration file for thekeyring_aws plugin. This variable is unavailable unless that plugin is installed.

    At plugin startup,keyring_aws reads the AWS secret access key ID and key from the configuration file. For thekeyring_aws plugin to start successfully, the configuration file must exist and contain valid secret access key information, initialized as described inSection 8.4.5.7, “Using the keyring_aws Amazon Web Services Keyring Plugin”.

    The default file name iskeyring_aws_conf, located in the default keyring file directory.

  • keyring_aws_data_file

    Command-Line Format--keyring-aws-data-file
    System Variablekeyring_aws_data_file
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    TypeFile name
    Default Valueplatform specific

    The location of the storage file for thekeyring_aws plugin. This variable is unavailable unless that plugin is installed.

    At plugin startup, if the value assigned tokeyring_aws_data_file specifies a file that does not exist, thekeyring_aws plugin attempts to create it (as well as its parent directory, if necessary). If the file does exist,keyring_aws reads any encrypted keys contained in the file into its in-memory cache.keyring_aws does not cache unencrypted keys in memory.

    The default file name iskeyring_aws_data, located in the default keyring file directory.

  • keyring_aws_region

    Command-Line Format--keyring-aws-region=value
    System Variablekeyring_aws_region
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    TypeEnumeration
    Default Valueus-east-1
    Valid Values

    af-south-1

    ap-east-1

    ap-northeast-1

    ap-northeast-2

    ap-northeast-3

    ap-south-1

    ap-southeast-1

    ap-southeast-2

    ca-central-1

    cn-north-1

    cn-northwest-1

    eu-central-1

    eu-north-1

    eu-south-1

    eu-west-1

    eu-west-2

    eu-west-3

    me-south-1

    sa-east-1

    us-east-1

    us-east-2

    us-gov-east-1

    us-iso-east-1

    us-iso-west-1

    us-isob-east-1

    us-west-1

    us-west-2

    The AWS region for thekeyring_aws plugin. This variable is unavailable unless that plugin is installed.

    If not set, the AWS region defaults tous-east-1. Thus, for any other region, this variable must be set explicitly.

  • keyring_hashicorp_auth_path

    Command-Line Format--keyring-hashicorp-auth-path=value
    DeprecatedYes
    System Variablekeyring_hashicorp_auth_path
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    TypeString
    Default Value/v1/auth/approle/login

    The authentication path where AppRole authentication is enabled within the HashiCorp Vault server, for use by thekeyring_hashicorp plugin. This variable is unavailable unless that plugin is installed.

  • keyring_hashicorp_ca_path

    Command-Line Format--keyring-hashicorp-ca-path=file_name
    DeprecatedYes
    System Variablekeyring_hashicorp_ca_path
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    TypeFile name
    Default Valueempty string

    The absolute path name of a local file accessible to the MySQL server that contains a properly formatted TLS certificate authority for use by thekeyring_hashicorp plugin. This variable is unavailable unless that plugin is installed.

    If this variable is not set, thekeyring_hashicorp plugin opens an HTTPS connection without using server certificate verification, and trusts any certificate delivered by the HashiCorp Vault server. For this to be safe, it must be assumed that the Vault server is not malicious and that no man-in-the-middle attack is possible. If those assumptions are invalid, setkeyring_hashicorp_ca_path to the path of a trusted CA certificate. (For example, for the instructions inCertificate and Key Preparation, this is thecompany.crt file.)

  • keyring_hashicorp_caching

    Command-Line Format--keyring-hashicorp-caching[={OFF|ON}]
    DeprecatedYes
    System Variablekeyring_hashicorp_caching
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    TypeBoolean
    Default ValueOFF

    Whether to enable the optional in-memory key cache used by thekeyring_hashicorp plugin to cache keys from the HashiCorp Vault server. This variable is unavailable unless that plugin is installed. If the cache is enabled, the plugin populates it during initialization. Otherwise, the plugin populates only the key list during initialization.

    Enabling the cache is a compromise: It improves performance, but maintains a copy of sensitive key information in memory, which may be undesirable for security purposes.

  • keyring_hashicorp_commit_auth_path

    DeprecatedYes
    System Variablekeyring_hashicorp_commit_auth_path
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    TypeString

    This variable is associated withkeyring_hashicorp_auth_path, from which it takes its value duringkeyring_hashicorp plugin initialization. This variable is unavailable unless that plugin is installed. It reflects thecommitted value actually used for plugin operation if initialization succeeds. For additional information, seekeyring_hashicorp Configuration.

  • keyring_hashicorp_commit_ca_path

    DeprecatedYes
    System Variablekeyring_hashicorp_commit_ca_path
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    TypeString

    This variable is associated withkeyring_hashicorp_ca_path, from which it takes its value duringkeyring_hashicorp plugin initialization. This variable is unavailable unless that plugin is installed. It reflects thecommitted value actually used for plugin operation if initialization succeeds. For additional information, seekeyring_hashicorp Configuration.

  • keyring_hashicorp_commit_caching

    DeprecatedYes
    System Variablekeyring_hashicorp_commit_caching
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    TypeString

    This variable is associated withkeyring_hashicorp_caching, from which it takes its value duringkeyring_hashicorp plugin initialization. This variable is unavailable unless that plugin is installed. It reflects thecommitted value actually used for plugin operation if initialization succeeds. For additional information, seekeyring_hashicorp Configuration.

  • keyring_hashicorp_commit_role_id

    DeprecatedYes
    System Variablekeyring_hashicorp_commit_role_id
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    TypeString

    This variable is associated withkeyring_hashicorp_role_id, from which it takes its value duringkeyring_hashicorp plugin initialization. This variable is unavailable unless that plugin is installed. It reflects thecommitted value actually used for plugin operation if initialization succeeds. For additional information, seekeyring_hashicorp Configuration.

  • keyring_hashicorp_commit_server_url

    DeprecatedYes
    System Variablekeyring_hashicorp_commit_server_url
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    TypeString

    This variable is associated withkeyring_hashicorp_server_url, from which it takes its value duringkeyring_hashicorp plugin initialization. This variable is unavailable unless that plugin is installed. It reflects thecommitted value actually used for plugin operation if initialization succeeds. For additional information, seekeyring_hashicorp Configuration.

  • keyring_hashicorp_commit_store_path

    DeprecatedYes
    System Variablekeyring_hashicorp_commit_store_path
    ScopeGlobal
    DynamicNo
    SET_VAR Hint AppliesNo
    TypeString

    This variable is associated withkeyring_hashicorp_store_path, from which it takes its value duringkeyring_hashicorp plugin initialization. This variable is unavailable unless that plugin is installed. It reflects thecommitted value actually used for plugin operation if initialization succeeds. For additional information, seekeyring_hashicorp Configuration.

  • keyring_hashicorp_role_id

    Command-Line Format--keyring-hashicorp-role-id=value
    DeprecatedYes
    System Variablekeyring_hashicorp_role_id
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    TypeString
    Default Valueempty string

    The HashiCorp Vault AppRole authentication role ID, for use by thekeyring_hashicorp plugin. This variable is unavailable unless that plugin is installed. The value must be in UUID format.

    This variable is mandatory. If not specified,keyring_hashicorp initialization fails.

  • keyring_hashicorp_secret_id

    Command-Line Format--keyring-hashicorp-secret-id=value
    DeprecatedYes
    System Variablekeyring_hashicorp_secret_id
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    TypeString
    Default Valueempty string

    The HashiCorp Vault AppRole authentication secret ID, for use by thekeyring_hashicorp plugin. This variable is unavailable unless that plugin is installed. The value must be in UUID format.

    This variable is mandatory. If not specified,keyring_hashicorp initialization fails.

    The value of this variable is sensitive, so its value is masked by* characters when displayed.

  • keyring_hashicorp_server_url

    Command-Line Format--keyring-hashicorp-server-url=value
    DeprecatedYes
    System Variablekeyring_hashicorp_server_url
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    TypeString
    Default Valuehttps://127.0.0.1:8200

    The HashiCorp Vault server URL, for use by thekeyring_hashicorp plugin. This variable is unavailable unless that plugin is installed. The value must begin withhttps://.

  • keyring_hashicorp_store_path

    Command-Line Format--keyring-hashicorp-store-path=value
    DeprecatedYes
    System Variablekeyring_hashicorp_store_path
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    TypeString
    Default Valueempty string

    A store path within the HashiCorp Vault server that is writeable when appropriate AppRole credentials are provided by thekeyring_hashicorp plugin. This variable is unavailable unless that plugin is installed. To specify the credentials, set thekeyring_hashicorp_role_id andkeyring_hashicorp_secret_id system variables (for example, as shown inkeyring_hashicorp Configuration).

    This variable is mandatory. If not specified,keyring_hashicorp initialization fails.

  • keyring_okv_conf_dir

    Command-Line Format--keyring-okv-conf-dir=dir_name
    System Variablekeyring_okv_conf_dir
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    TypeDirectory name
    Default Valueempty string

    The path name of the directory that stores configuration information used by thekeyring_okv plugin. This variable is unavailable unless that plugin is installed. The location should be a directory considered for use only by thekeyring_okv plugin. For example, do not locate the directory under the data directory.

    The defaultkeyring_okv_conf_dir value is empty. For thekeyring_okv plugin to be able to access Oracle Key Vault, the value must be set to a directory that contains Oracle Key Vault configuration and SSL materials. For instructions on setting up this directory, seeSection 8.4.5.6, “Using the keyring_okv KMIP Plugin”.

    The directory should have a restrictive mode and be accessible only to the account used to run the MySQL server. For example, on Unix and Unix-like systems, to use the/usr/local/mysql/mysql-keyring-okv directory, the following commands (executed asroot) create the directory and set its mode and ownership:

    cd /usr/local/mysqlmkdir mysql-keyring-okvchmod 750 mysql-keyring-okvchown mysql mysql-keyring-okvchgrp mysql mysql-keyring-okv

    If the value assigned tokeyring_okv_conf_dir specifies a directory that does not exist, or that does not contain configuration information that enables a connection to Oracle Key Vault to be established,keyring_okv writes an error message to the error log. If an attempted runtime assignment tokeyring_okv_conf_dir results in an error, the variable value and keyring operation remain unchanged.

  • keyring_operations

    System Variablekeyring_operations
    ScopeGlobal
    DynamicYes
    SET_VAR Hint AppliesNo
    TypeBoolean
    Default ValueON

    Whether keyring operations are enabled. This variable is used during key migration operations. SeeSection 8.4.5.13, “Migrating Keys Between Keyring Keystores”. The privileges required to modify this variable areENCRYPTION_KEY_ADMIN in addition to eitherSYSTEM_VARIABLES_ADMIN or the deprecatedSUPER privilege.