Ресурс windows_audit_policy

Редактировать эту страницу в репозитории Chef

Страница справки по ресурсам

Используйте ресурс windows_audit_policy для настройки системных и пользовательских параметров расширенной политики аудита Windows.

Новое в Chef Infra Client 16.2.

Синтаксис

Полный синтаксис всех свойств, доступных для ресурса windows_audit_policy:

windows_audit_policy 'name' do
  audit_base_directories       true, false
  audit_base_objects           true, false
  crash_on_audit_fail          true, false
  exclude_user                 String
  failure                      true, false
  full_privilege_auditing      true, false
  include_user                 String
  subcategory                  String, Array
  success                      true, false
  action                       Symbol # defaults to :set if not specified
end

где:

• windows_audit_policy — это ресурс.
• name — имя блока ресурса.
• action определяет действия, которые Chef Infra Client выполнит для приведения узла к желаемому состоянию.
• audit_base_directories, audit_base_objects, crash_on_audit_fail, exclude_user, failure, full_privilege_auditing, include_user, subcategory, и success — доступные свойства этого ресурса.

Действия

Ресурс windows_audit_policy имеет следующие действия:

:nothing

Этот блок ресурса не выполняет действий, пока не получит уведомление от другого ресурса. После уведомления этот блок ресурса либо выполняется немедленно, либо помещается в очередь для выполнения в конце выполнения Chef Infra Client.

:set

Настройка политики аудита.

Свойства

Ресурс windows_audit_policy имеет следующие свойства:

audit_base_directories

Тип в Ruby: true, false

Указание этого параметра политики аудита в значение true заставит систему назначить системный список управления доступом именованным объектам для включения аудита контейнерных объектов, таких как каталоги.

audit_base_objects

Тип в Ruby: true, false

Указание этого параметра политики аудита в значение true заставит систему назначить системный список управления доступом именованным объектам для включения аудита базовых объектов, таких как мьютексы.

crash_on_audit_fail

Тип в Ruby: true, false

Указание этого параметра политики аудита в значение true заставит систему аварийно завершить работу, если система аудита не может записывать события.

exclude_user

Тип в Ruby: Строка

Политика аудита, указанная категорией или подкатегорией, применяется к пользователю, если указан пользователь. Если указан пользователь, исключаем пользователя. Включить и исключить нельзя использовать одновременно.

failure

Тип в Ruby: true, false

Укажите аудит ошибок. Установив это свойство в значение true, ресурс включит аудит ошибок для категории или подкатегории. Успех — значение по умолчанию и применяется, если не указано ни успех, ни ошибка.

full_privilege_auditing

Тип в Ruby: true, false

Указание этого параметра политики аудита в значение true заставит систему аудировать все изменения привилегий, кроме SeAuditPrivilege. Установка этого свойства может привести к более быстрому заполнению журналов.

include_user

Тип в Ruby: Строка

Политика аудита, указанная категорией или подкатегорией, применяется к пользователю, если указан пользователь. Если указан пользователь, включаем пользователя. Включить и исключить нельзя использовать одновременно.

subcategory

Тип в Ruby: Строка, Массив

Подкатегория политики аудита, указанная GUID или именем. Применяется ко всей системе, если не указан пользователь.

success

Тип в Ruby: true, false

Укажите аудит успехов. Установив это свойство в значение true, ресурс включит аудит успехов для категории или подкатегории. Успех — значение по умолчанию и применяется, если не указано ни успех, ни ошибка.

Общие функциональные возможности ресурсов

Ресурсы Chef включают общие свойства, уведомления и блокировки ресурсов.

Общие свойства

Следующие свойства общие для всех ресурсов:

compile_time

Тип в Ruby: true, false | Значение по умолчанию: false

Управление фазой, в которой ресурс запускается на узле. Установите в значение true, чтобы запустить его во время сборки коллекции ресурсов (compile phase). Установите в значение false, чтобы запустить его во время настройки узла Chef Infra Client (converge phase).

ignore_failure

Тип в Ruby: true, false, :quiet | Значение по умолчанию: false

Продолжить выполнение рецепта, если ресурс потерпит неудачу по какой-либо причине. :quiet не отобразит полный стек вызовов, и рецепт продолжит выполнение, если ресурс потерпит неудачу.

retries

Тип в Ruby: Целое число | Значение по умолчанию: 0

Количество попыток перехватить исключения и повторить ресурс.

retry_delay

Тип в Ruby: Целое число | Значение по умолчанию: 2

Задержка повтора (в секундах).

sensitive

Тип в Ruby: true, false | Значение по умолчанию: false

Обеспечить, чтобы конфиденциальные данные ресурсов не регистрировались Chef InfraClient.

Уведомления

notifies

Тип в Ruby: Символ, 'Chef::Resource[String]'

Ресурс может уведомить другой ресурс о выполнении действия при изменении его состояния. Укажите 'resource[name]', :action, который должен выполнить этот ресурс, и :timer для этого действия. Один ресурс может уведомить несколько ресурсов; для каждого уведомляемого ресурса используйте оператор notifies. Если указанный ресурс не существует, генерируется ошибка. В отличие от subscribes, которое не завершается ошибкой, если исходный ресурс не найден.

Таймер указывает момент во время выполнения Chef Infra Client, когда выполняется уведомление. Доступны следующие таймеры:

:before

Указывает, что действие по уведомленному ресурсу должно выполняться перед обработкой блока ресурса, в котором находится уведомление.

:delayed

По умолчанию. Указывает, что уведомление должно помещаться в очередь и затем выполняться в конце выполнения Chef Infra Client.

:immediate, :immediately

Указывает, что уведомление должно выполняться немедленно, для каждого уведомленного ресурса.

Синтаксис для notifies:

notifies :action, 'resource[name]', :timer

subscribes

Тип в Ruby: Символ, 'Chef::Resource[String]'

Ресурс может прослушивать другой ресурс и выполнять действие, если состояние прослушиваемого ресурса изменится. Укажите 'resource[name]', :action действия и :timer для этого действия.

Обратите внимание, что subscribes не применяет указанное действие к ресурсу, который он прослушивает - например:

file '/etc/nginx/ssl/example.crt' do
  mode '0600'
  owner 'root'
end

service 'nginx' do
  subscribes :reload, 'file[/etc/nginx/ssl/example.crt]', :immediately
end

В этом случае свойство subscribes перезагружает службу nginx всякий раз, когда файл сертификата, расположенный в /etc/nginx/ssl/example.crt, обновляется. subscribes не вносит никаких изменений в сам файл сертификата, а просто прослушивает изменения в файле и выполняет действие :reload для своего ресурса (в данном примере nginx) при обнаружении изменений.

Если другой ресурс не существует, подписка не генерирует ошибку. В отличие от более строгих семантик notifies, которые генерируют ошибку, если другой ресурс не существует.

Таймер указывает момент во время выполнения Chef Infra Client, когда выполняется уведомление. Доступны следующие таймеры:

:before

Указывает, что действие по уведомленному ресурсу должно выполняться перед обработкой блока ресурса, в котором находится уведомление.

:delayed

По умолчанию. Указывает, что уведомление должно помещаться в очередь и затем выполняться в конце выполнения Chef Infra Client.

:immediate, :immediately

Указывает, что уведомление должно выполняться немедленно, для каждого уведомленного ресурса.

Синтаксис для subscribes:

subscribes :action, 'resource[name]', :timer

Блокировки

Свойство блокировки может использоваться для оценки состояния узла во время фазы выполнения Chef Infra Client. Основываясь на результатах этой оценки, свойство блокировки затем сообщает Chef Infra Client, следует ли продолжить выполнение ресурса. Свойство блокировки принимает либо строковое значение, либо значение Ruby-блока:

• Строка выполняется как командная оболочка. Если команда возвращает 0, блокировка применяется. Если команда возвращает любое другое значение, то свойство блокировки не применяется. Строковые блокировки в powershell_script выполняют команды Windows PowerShell и могут возвращать true в дополнение к 0.
• Блок выполняется как код Ruby, который должен возвращать либо true или false. Если блок возвращает true, свойство блокировки применяется. Если блок возвращает false, свойство блокировки не применяется.

Свойство блокировки полезно для обеспечения идемпотентности ресурса, позволяя этому ресурсу проверять желаемое состояние по мере его выполнения, а затем, если желаемое состояние присутствует, Chef Infra Client ничего не делает.

Следующие свойства могут быть использованы для определения блокировки, которая оценивается во время фазы выполнения Chef Infra Client:

not_if

Запретить выполнение ресурса, когда условие возвращает true.

only_if

Разрешить выполнение ресурса только если условие возвращает true.

Примеры

Следующие примеры демонстрируют различные подходы к использованию ресурса windows_audit_policy в рецептах:

Установить политику входа и выхода в систему в «Успех и Ошибка»:

windows_audit_policy "Set Audit Policy for 'Logon and Logoff' actions to 'Success and Failure'" do
  subcategory %w(Logon Logoff)
  success true
  failure true
  action :set
end

Установить политику проверки подлинности учетных данных в «Успех»:

windows_audit_policy "Set Audit Policy for 'Credential Validation' actions to 'Success'" do
  subcategory 'Credential Validation'
  success true
  failure false
  action :set
end

Включить опцию CrashOnAuditFail:

windows_audit_policy 'Enable CrashOnAuditFail option' do
  crash_on_audit_fail true
  action :set
end