Документация Aureole

Хранилище ключей

Данный плагин используется для работы с различными хранилищами ключей. Позволяет получать, сохранять и изменять ключи.

  • Тип: object. Обязательны: name. Наличие дополнительных свойств: Недопустимо.
    • name: Тип: string. Дополнительно: Имя экземпляра плагина. Имя хранилища ключей. Имя используется для того, чтобы в дальнейшем ссылаться на данное хранилище ключей. Минимальная длина: 1.

    Допустим один из вариантов конфига

    Конфигурация file хранилища ключе.

    • Тип: object. Конфигурация file хранилища ключе. Позволяет использовать файловую систему для хранения ключей. Обязательны: type, config. Наличие дополнительных свойств: Недопустимо.
      • type: Константа: file. Тип хранилища ключей. Необходим, чтобы дать Aureole понять, какое из хранилищ ключей использовать.
      • config: Тип: object. Конфигурация хранилища ключей. Описывает все свойства данного хранилища ключей. Обязательны: path.
        • path: Тип: string. Дополнительно: Путь к файлу, Расширение файла: json. Путь к файлу. Указывает путь к файлу, с которым будут производитсья операции чтения/записи.

      Пример конфига

      crypto_storages:
  - type: "file"
    name: jwk_keys_store
    config:
      path: lab/keys/keys.json
      1
      2
      3
      4
      5

    Конфигурация url хранилища ключей.

    • Тип: object. Конфигурация url хранилища ключей. Позволяет получать ключи, хранящиеся по определенному адресу в сети. Обязательны: type, config. Наличие дополнительных свойств: Недопустимо.
      • type: Константа: url. Тип хранилища ключей. Необходим, чтобы дать Aureole понять, какое из хранилищ ключей использовать.
      • config: Тип: object. Конфигурация хранилища ключей. Описывает все свойства данного хранилища ключей. Обязательны: path.
        • path: Тип: string. Дополнительно: Абсолютный URL-адрес. Путь к ресурсу. Маршрут в сети, по которому Aureole будет читать данные.

      Пример конфига

      crypto_storages:
  - type: "url"
    name: google_keys_store
    config:
      path: https://www.googleapis.com/oauth2/v3/certs
      1
      2
      3
      4
      5

    Конфигурация Vault хранилища ключей.

    • Тип: object. Конфигурация Vault хранилища ключей. Позволяет использовать Vault в качестве хранилища ключей. Обязательны: type, config. Наличие дополнительных свойств: Недопустимо.
      • type: Константа: vault. Тип хранилища. Необходим, чтобы дать Aureole понять, какое из хранилищ ключей использовать.
      • config: Тип: object. Конфигурация хранилища ключей. Описывает все свойства данного хранилища ключей. Обязательны: token, address, path.
        • token: Тип: string. Аутентификационный токен. Токен, по которому Aureole будет аутентифицироваться в Vault.
        • address: Тип: string. Дополнительно: Абсолютный URL-адрес. Адрес сервера Vault. Адрес, на котором запущен сервер Vault.
        • path: Тип: string. Дополнительно: Относительный URL-адрес. Путь к хранилищу Vault. Путь к хранилищу Vault, с которым Aureole может производить операции чтения/записи.

      Пример конфига

      crypto_storages:
  - type: "vault"
    name: vault_keys_store
    config:
      token: ${VAULT_AUTH_TOKEN}
      address: http://127.0.0.1:8200
      path: /secret/keys
      1
      2
      3
      4
      5
      6
      7
Contributors: asaevich