Spec-Zone.ru › MySQL 8.4

8.4.4.16 Системные переменные Keyring

Плагины MySQL Keyring поддерживают следующие системные переменные. Используйте их для настройки работы плагина keyring. Эти переменные недоступны, если соответствующий плагин keyring не установлен (см. Раздел 8.4.4.3, «Установка плагина Keyring»).

  • keyring_aws_cmk_id

    Формат командной строки --keyring-aws-cmk-id=value
    Системная переменная keyring_aws_cmk_id
    Область видимости Глобальная
    Динамическая Да
    SET_VAR Подсказка применяется Нет
    Тип Строка

    Идентификатор ключа KMS, полученный от сервера AWS KMS и используемый плагином keyring_aws. Эта переменная недоступна, если этот плагин не установлен.

    Эта переменная является обязательной. Если она не указана, инициализация keyring_aws завершается с ошибкой.

  • keyring_aws_conf_file

    Формат командной строки --keyring-aws-conf-file=file_name
    Системная переменная keyring_aws_conf_file
    Область видимости Глобальная
    Динамическая Нет
    SET_VAR Подсказка применяется Нет
    Тип Имя файла
    Значение по умолчанию platform specific

    Расположение файла конфигурации для плагина keyring_aws. Эта переменная недоступна, если этот плагин не установлен.

    При запуске плагина keyring_aws считывает идентификатор секретного ключа доступа AWS и ключ из файла конфигурации. Для успешного запуска плагина keyring_aws файл конфигурации должен существовать и содержать действительную информацию о секретном ключе доступа, инициализированную, как описано в Разделе 8.4.4.7, «Использование плагина keyring_aws Amazon Web Services Keyring».

    Имя файла по умолчанию — keyring_aws_conf, расположенное в каталоге файлов keyring по умолчанию.

  • keyring_aws_data_file

    Формат командной строки --keyring-aws-data-file
    Системная переменная keyring_aws_data_file
    Область видимости Глобальная
    Динамическая Нет
    SET_VAR Подсказка применяется Нет
    Тип Имя файла
    Значение по умолчанию platform specific

    Расположение файла хранения для плагина keyring_aws. Эта переменная недоступна, если этот плагин не установлен.

    При запуске плагина, если значение, присвоенное keyring_aws_data_file, указывает на файл, который не существует, плагин keyring_aws пытается создать его (а также его родительский каталог, если необходимо). Если файл существует, keyring_aws считывает любые зашифрованные ключи, содержащиеся в файле, в свой кэш в памяти. keyring_aws не кэширует незашифрованные ключи в памяти.

    Имя файла по умолчанию — keyring_aws_data, расположенное в каталоге файлов keyring по умолчанию.

  • keyring_aws_region

    Формат командной строки --keyring-aws-region=value
    Системная переменная keyring_aws_region
    Область видимости Глобальная
    Динамическая Да
    SET_VAR Подсказка применяется Нет
    Тип Перечисление
    Значение по умолчанию us-east-1
    Допустимые значения

    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

    Регион AWS для плагина keyring_aws. Эта переменная недоступна, если этот плагин не установлен.

  • keyring_hashicorp_auth_path

    Формат командной строки --keyring-hashicorp-auth-path=value
    Системная переменная keyring_hashicorp_auth_path
    Область видимости Глобальная
    Динамическая Да
    SET_VAR Подсказка применяется Нет
    Тип Строка
    Значение по умолчанию /v1/auth/approle/login

    Путь аутентификации, где включена аутентификация AppRole на сервере HashiCorp Vault, для использования плагином keyring_hashicorp. Эта переменная недоступна, если этот плагин не установлен.

  • keyring_hashicorp_ca_path

    Формат командной строки --keyring-hashicorp-ca-path=file_name
    Системная переменная keyring_hashicorp_ca_path
    Область видимости Глобальная
    Динамическая Да
    SET_VAR Подсказка применяется Нет
    Тип Имя файла
    Значение по умолчанию empty string

    Абсолютное имя локального файла, доступного серверу MySQL, который содержит правильно отформатированный центр сертификации TLS для использования плагином keyring_hashicorp. Эта переменная недоступна, если этот плагин не установлен.

    Если эта переменная не установлена, плагин keyring_hashicorp открывает HTTPS-соединение без проверки сертификата сервера и доверяет любому сертификату, предоставленному сервером HashiCorp Vault. Для безопасности необходимо предположить, что сервер Vault не является вредоносным и что атака «человек посередине» невозможна. Если эти предположения неверны, установите keyring_hashicorp_ca_path в путь к доверенному сертификату CA. (Например, для инструкций в Подготовка сертификата и ключа, это файл company.crt.)

  • keyring_hashicorp_caching

    Формат командной строки --keyring-hashicorp-caching[={OFF|ON}]
    Системная переменная keyring_hashicorp_caching
    Область видимости Глобальная
    Динамическая Да
    SET_VAR Подсказка применяется Нет
    Тип Булево
    Значение по умолчанию OFF

    Следует ли включать необязательный кэш ключей в памяти, используемый плагином keyring_hashicorp для кэширования ключей с сервера HashiCorp Vault. Эта переменная недоступна, если этот плагин не установлен. Если кэш включен, плагин заполняет его во время инициализации. В противном случае плагин заполняет только список ключей во время инициализации.

    Включение кэша — это компромисс: он повышает производительность, но сохраняет копию конфиденциальной информации о ключах в памяти, что может быть нежелательно с точки зрения безопасности.

  • keyring_hashicorp_commit_auth_path

    Системная переменная keyring_hashicorp_commit_auth_path
    Область видимости Глобальная
    Динамическая Нет
    SET_VAR Подсказка применяется Нет
    Тип Строка

    Эта переменная связана с keyring_hashicorp_auth_path, из которой она принимает своё значение во время инициализации плагина keyring_hashicorp. Эта переменная недоступна, если плагин не установлен. Она отражает значение “committed”, фактически используемое для работы плагина, если инициализация прошла успешно. Для получения дополнительной информации см. keyring_hashicorp Configuration.

  • keyring_hashicorp_commit_ca_path

    Системная переменная keyring_hashicorp_commit_ca_path
    Область видимости Глобальная
    Динамическая Нет
    SET_VAR Подсказка применяется Нет
    Тип Строка

    Эта переменная связана с keyring_hashicorp_ca_path, из которой она принимает своё значение во время инициализации плагина keyring_hashicorp. Эта переменная недоступна, если плагин не установлен. Она отражает значение “committed”, фактически используемое для работы плагина, если инициализация прошла успешно. Для получения дополнительной информации см. keyring_hashicorp Configuration.

  • keyring_hashicorp_commit_caching

    Системная переменная keyring_hashicorp_commit_caching
    Область видимости Глобальная
    Динамическая Нет
    SET_VAR Подсказка применяется Нет
    Тип Строка

    Эта переменная связана с keyring_hashicorp_caching, из которой она принимает своё значение во время инициализации плагина keyring_hashicorp. Эта переменная недоступна, если плагин не установлен. Она отражает значение “committed”, фактически используемое для работы плагина, если инициализация прошла успешно. Для получения дополнительной информации см. keyring_hashicorp Configuration.

  • keyring_hashicorp_commit_role_id

    Системная переменная keyring_hashicorp_commit_role_id
    Область видимости Глобальная
    Динамическая Нет
    SET_VAR Подсказка применяется Нет
    Тип Строка

    Эта переменная связана с keyring_hashicorp_role_id, из которой она принимает своё значение во время инициализации плагина keyring_hashicorp. Эта переменная недоступна, если плагин не установлен. Она отражает значение “committed”, фактически используемое для работы плагина, если инициализация прошла успешно. Для получения дополнительной информации см. keyring_hashicorp Configuration.

  • keyring_hashicorp_commit_server_url

    Системная переменная keyring_hashicorp_commit_server_url
    Область видимости Глобальная
    Динамическая Нет
    SET_VAR Подсказка применяется Нет
    Тип Строка

    Эта переменная связана с keyring_hashicorp_server_url, из которой она принимает своё значение во время инициализации плагина keyring_hashicorp. Эта переменная недоступна, если плагин не установлен. Она отражает значение “committed”, фактически используемое для работы плагина, если инициализация прошла успешно. Для получения дополнительной информации см. keyring_hashicorp Configuration.

  • keyring_hashicorp_commit_store_path

    Системная переменная keyring_hashicorp_commit_store_path
    Область видимости Глобальная
    Динамическая Нет
    SET_VAR Подсказка применяется Нет
    Тип Строка

    Эта переменная связана с keyring_hashicorp_store_path, из которой она принимает своё значение во время инициализации плагина keyring_hashicorp. Эта переменная недоступна, если плагин не установлен. Она отражает значение “committed”, фактически используемое для работы плагина, если инициализация прошла успешно. Для получения дополнительной информации см. keyring_hashicorp Configuration.

  • keyring_hashicorp_role_id

    Формат командной строки --keyring-hashicorp-role-id=value
    Системная переменная keyring_hashicorp_role_id
    Область видимости Глобальная
    Динамическая Да
    SET_VAR Подсказка применяется Нет
    Тип Строка
    Значение по умолчанию empty string

    ID роли аутентификации HashiCorp Vault AppRole, для использования плагином keyring_hashicorp. Эта переменная недоступна, если плагин не установлен. Значение должно быть в формате UUID.

    Эта переменная обязательна. Если она не указана, инициализация keyring_hashicorp завершается неудачей.

  • keyring_hashicorp_secret_id

    Формат командной строки --keyring-hashicorp-secret-id=value
    Системная переменная keyring_hashicorp_secret_id
    Область видимости Глобальная
    Динамическая Да
    SET_VAR Подсказка применяется Нет
    Тип Строка
    Значение по умолчанию empty string

    Секретный ID аутентификации HashiCorp Vault AppRole, для использования плагином keyring_hashicorp. Эта переменная недоступна, если плагин не установлен. Значение должно быть в формате UUID.

    Эта переменная обязательна. Если она не указана, инициализация keyring_hashicorp завершается неудачей.

    Значение этой переменной является конфиденциальным, поэтому при отображении оно маскируется символами *.

  • keyring_hashicorp_server_url

    Формат командной строки --keyring-hashicorp-server-url=value
    Системная переменная keyring_hashicorp_server_url
    Область видимости Глобальная
    Динамическая Да
    SET_VAR Подсказка применяется Нет
    Тип Строка
    Значение по умолчанию https://127.0.0.1:8200

    URL-адрес сервера HashiCorp Vault, для использования плагином keyring_hashicorp. Эта переменная недоступна, если плагин не установлен. Значение должно начинаться с https://.

  • keyring_hashicorp_store_path

    Формат командной строки --keyring-hashicorp-store-path=value
    Системная переменная keyring_hashicorp_store_path
    Область действия Глобальная
    Динамическая Да
    SET_VAR Применяется подсказка Нет
    Тип Строка
    Значение по умолчанию empty string

    Путь к хранилищу на сервере HashiCorp Vault, доступному для записи, когда соответствующие учетные данные AppRole предоставляются плагином keyring_hashicorp. Эта переменная недоступна, если этот плагин не установлен. Для указания учетных данных задайте системные переменные keyring_hashicorp_role_id и keyring_hashicorp_secret_id (например, как показано в Настройке keyring_hashicorp).

    Эта переменная является обязательной. Если она не указана, инициализация keyring_hashicorp завершается ошибкой.

  • keyring_okv_conf_dir

    Формат командной строки --keyring-okv-conf-dir=dir_name
    Системная переменная keyring_okv_conf_dir
    Область действия Глобальная
    Динамическая Да
    SET_VAR Применяется подсказка Нет
    Тип Имя каталога
    Значение по умолчанию empty string

    Путь к каталогу, в котором хранятся конфигурационные данные, используемые плагином keyring_okv. Эта переменная недоступна, если этот плагин не установлен. Путь должен указывать на каталог, предназначенный только для использования плагином keyring_okv. Например, не размещайте каталог в каталоге данных.

    Значение по умолчанию для keyring_okv_conf_dir пустое. Для того, чтобы плагин keyring_okv смог получить доступ к Oracle Key Vault, значение должно быть установлено на каталог, содержащий конфигурацию Oracle Key Vault и SSL-материалы. Инструкции по настройке этого каталога см. в Разделе 8.4.4.6, «Использование плагина keyring_okv KMIP».

    Каталог должен иметь ограниченный доступ и быть доступным только учетной записи, используемой для запуска сервера MySQL. Например, в Unix-подобных системах, чтобы использовать каталог /usr/local/mysql/mysql-keyring-okv, следующие команды (выполняемые от имени root) создают каталог и устанавливают его права и владельца:

    cd /usr/local/mysql
    mkdir mysql-keyring-okv
    chmod 750 mysql-keyring-okv
    chown mysql mysql-keyring-okv
    chgrp mysql mysql-keyring-okv
    

    Если значение, присвоенное keyring_okv_conf_dir, указывает на каталог, который не существует или не содержит конфигурационной информации, позволяющей установить подключение к Oracle Key Vault, keyring_okv записывает сообщение об ошибке в журнал ошибок. Если при попытке динамического присвоения значения keyring_okv_conf_dir возникнет ошибка, значение переменной и операция keyring останутся неизменными.

  • keyring_operations

    Системная переменная keyring_operations
    Область действия Глобальная
    Динамическая Да
    SET_VAR Применяется подсказка Нет
    Тип Булево
    Значение по умолчанию ON

    Включены ли операции keyring. Эта переменная используется во время миграции ключей. См. Раздел 8.4.4.11, «Миграция ключей между хранилищами keyring». Требуемые привилегии для изменения этой переменной — ENCRYPTION_KEY_ADMIN в дополнение к SYSTEM_VARIABLES_ADMIN или устаревшей привилегии SUPER.

© 2025 Oracle
Licensed under the GPLv2 License.
https://docs.oracle.com/cd/E17952_01/mysql-8.4-en/keyring-system-variables.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API