Registro de auditoria e plataforma do Model Armor

Este documento descreve a geração de registros de auditoria para o Model Armor.Os serviços do Google Cloud geram registros de auditoria que registram atividades administrativas e de acesso nos recursos do Google Cloud . Para mais informações sobre os Registros de auditoria do Cloud, consulte:

Nome do serviço

Os registros de auditoria do Model Armor usam o nome de serviço modelarmor.googleapis.com. Filtrar por este serviço: 

    protoPayload.serviceName="modelarmor.googleapis.com"

Métodos por tipo de permissão

Cada permissão do IAM tem uma propriedade type, que tem o valor de um tipo enumerado que pode ser um dos quatro valores: ADMIN_READ, ADMIN_WRITE, DATA_READ ou DATA_WRITE. Quando você chama um método, o Model Armor gera um registro de auditoria com categoria dependente da propriedade type da permissão necessária para executar o método. Métodos que exigem uma permissão do IAM com o valor da propriedade type de DATA_READ, DATA_WRITE ou ADMIN_READ geram registros de auditoria de acesso aos dados. Métodos que exigem uma permissão do IAM com o valor da propriedade type de ADMIN_WRITE geram registros de auditoria de Atividade do administrador.

Tipo de permissão Métodos
ADMIN_READ google.cloud.modelarmor.v1.ModelArmor.GetFloorSetting
google.cloud.modelarmor.v1.ModelArmor.GetTemplate
google.cloud.modelarmor.v1.ModelArmor.ListTemplates
google.cloud.modelarmor.v1alpha.ModelArmor.GetFloorSetting
google.cloud.modelarmor.v1alpha.ModelArmor.GetTemplate
google.cloud.modelarmor.v1alpha.ModelArmor.ListTemplates
ADMIN_WRITE google.cloud.modelarmor.v1.ModelArmor.CreateTemplate
google.cloud.modelarmor.v1.ModelArmor.DeleteTemplate
google.cloud.modelarmor.v1.ModelArmor.UpdateFloorSetting
google.cloud.modelarmor.v1.ModelArmor.UpdateTemplate
google.cloud.modelarmor.v1alpha.ModelArmor.CreateTemplate
google.cloud.modelarmor.v1alpha.ModelArmor.DeleteTemplate
google.cloud.modelarmor.v1alpha.ModelArmor.UpdateFloorSetting
google.cloud.modelarmor.v1alpha.ModelArmor.UpdateTemplate
DATA_READ google.cloud.modelarmor.v1.ModelArmor.SanitizeModelResponse
google.cloud.modelarmor.v1.ModelArmor.SanitizeUserPrompt
google.cloud.modelarmor.v1alpha.ModelArmor.SanitizeModelResponse
google.cloud.modelarmor.v1alpha.ModelArmor.SanitizeUserPrompt

Registros de auditoria da interface da API

Para informações sobre como e quais permissões são avaliadas para cada método, consulte a documentação do Identity and Access Management para o Model Armor.

google.cloud.modelarmor.v1.ModelArmor

Os registros de auditoria a seguir estão associados a métodos que pertencem a google.cloud.modelarmor.v1.ModelArmor.

CreateTemplate

  • Método: google.cloud.modelarmor.v1.ModelArmor.CreateTemplate
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • modelarmor.templates.create - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1.ModelArmor.CreateTemplate"

DeleteTemplate

  • Método: google.cloud.modelarmor.v1.ModelArmor.DeleteTemplate
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • modelarmor.templates.delete - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1.ModelArmor.DeleteTemplate"

GetFloorSetting

  • Método: google.cloud.modelarmor.v1.ModelArmor.GetFloorSetting
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • modelarmor.floorSettings.get - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1.ModelArmor.GetFloorSetting"

GetTemplate

  • Método: google.cloud.modelarmor.v1.ModelArmor.GetTemplate
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • modelarmor.templates.get - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1.ModelArmor.GetTemplate"

ListTemplates

  • Método: google.cloud.modelarmor.v1.ModelArmor.ListTemplates
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • modelarmor.templates.list - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1.ModelArmor.ListTemplates"

SanitizeModelResponse

  • Método: google.cloud.modelarmor.v1.ModelArmor.SanitizeModelResponse
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • modelarmor.templates.useToSanitizeModelResponse - DATA_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1.ModelArmor.SanitizeModelResponse"

SanitizeUserPrompt

  • Método: google.cloud.modelarmor.v1.ModelArmor.SanitizeUserPrompt
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • modelarmor.templates.useToSanitizeUserPrompt - DATA_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1.ModelArmor.SanitizeUserPrompt"

UpdateFloorSetting

  • Método: google.cloud.modelarmor.v1.ModelArmor.UpdateFloorSetting
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • modelarmor.floorSettings.update - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1.ModelArmor.UpdateFloorSetting"

UpdateTemplate

  • Método: google.cloud.modelarmor.v1.ModelArmor.UpdateTemplate
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • modelarmor.templates.update - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1.ModelArmor.UpdateTemplate"

google.cloud.modelarmor.v1alpha.ModelArmor

Os registros de auditoria a seguir estão associados a métodos que pertencem a google.cloud.modelarmor.v1alpha.ModelArmor.

CreateTemplate

  • Método: google.cloud.modelarmor.v1alpha.ModelArmor.CreateTemplate
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • modelarmor.templates.create - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1alpha.ModelArmor.CreateTemplate"

DeleteTemplate

  • Método: google.cloud.modelarmor.v1alpha.ModelArmor.DeleteTemplate
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • modelarmor.templates.delete - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1alpha.ModelArmor.DeleteTemplate"

GetFloorSetting

  • Método: google.cloud.modelarmor.v1alpha.ModelArmor.GetFloorSetting
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • modelarmor.floorSettings.get - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1alpha.ModelArmor.GetFloorSetting"

GetTemplate

  • Método: google.cloud.modelarmor.v1alpha.ModelArmor.GetTemplate
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • modelarmor.templates.get - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1alpha.ModelArmor.GetTemplate"

ListTemplates

  • Método: google.cloud.modelarmor.v1alpha.ModelArmor.ListTemplates
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • modelarmor.templates.list - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1alpha.ModelArmor.ListTemplates"

SanitizeModelResponse

  • Método: google.cloud.modelarmor.v1alpha.ModelArmor.SanitizeModelResponse
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • modelarmor.templates.useToSanitizeModelResponse - DATA_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1alpha.ModelArmor.SanitizeModelResponse"

SanitizeUserPrompt

  • Método: google.cloud.modelarmor.v1alpha.ModelArmor.SanitizeUserPrompt
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • modelarmor.templates.useToSanitizeUserPrompt - DATA_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1alpha.ModelArmor.SanitizeUserPrompt"

UpdateFloorSetting

  • Método: google.cloud.modelarmor.v1alpha.ModelArmor.UpdateFloorSetting
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • modelarmor.floorSettings.update - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1alpha.ModelArmor.UpdateFloorSetting"

UpdateTemplate

  • Método: google.cloud.modelarmor.v1alpha.ModelArmor.UpdateTemplate
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • modelarmor.templates.update - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.cloud.modelarmor.v1alpha.ModelArmor.UpdateTemplate"

Métodos que não produzem registros de auditoria

Um método pode não produzir registros de auditoria para um ou mais dos seguintes itens motivos:

  • É um método de alto volume que envolve geração de registros significativos e custos de armazenamento.
  • Tem baixo valor de auditoria.
  • Outro registro de auditoria ou plataforma já oferece cobertura de método.

Os métodos a seguir não produzem registros de auditoria:

  • envoy.service.ext_proc.v3.ExternalProcessor.Process
  • google.cloud.location.Locations.GetLocation
  • google.cloud.location.Locations.ListLocations

Configuração do Logging

É possível configurar o Model Armor para registrar as seguintes operações:

  • Criar, atualizar, ler e excluir modelos
  • Limpar o comando do usuário e a resposta do modelo
curl -X POST \
  -d "{filter_config: {}, 'template_metadata': { 'log_template_operations': 'true', 'log_sanitize_operations': 'true'} }" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    "https://modelarmor.LOCATION.rep.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/templates?template_id=TEMPLATE_ID"
  • log_template_operations : valor booleano que determina se as operações de criação, atualização, leitura e exclusão de modelos precisam ser registradas nos registros da plataforma.

  • log_sanitize_operations : valor booleano que determina se as operações de higienização precisam ser registradas nos registros da plataforma. Os registros incluem o comando e a resposta, os resultados de avaliação do Model Armor e outros campos de metadados.

    Substitua:

    • PROJECT_ID: o ID do projeto ao qual o modelo pertence.
    • LOCATION: o local do modelo.
    • TEMPLATE_ID: o ID do modelo.