API Security Actions

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Prévia: ações de segurança avançadas da API

Este recurso é coberto pelos Termos de ofertas pré-GA dos Termos de Serviço do Google Cloud. Os recursos pré-GA podem ter suporte limitado, e as mudanças realizadas podem não ser compatíveis com outras versões pré-GA. Para mais informações, consulte as descrições da fase de lançamento.

O suporte à versão de pré-lançamento da API Security Actions avançada está disponível no fórum Apigee: Comunidade do Google Cloud.

Além de usar ações de segurança na interface da Apigee, também é possível acessar todos os recursos desses relatórios pela API Apigee.

Observação: ações de segurança estão disponíveis para a Apigee e as versões 1.11 e mais recentes da Apigee híbrida.

Limitações das ações de segurança

As ações de segurança são aplicadas no nível do ambiente da Apigee. Para cada ambiente, as ações de segurança têm as seguintes limitações:

• No máximo 1.000 ações ativadas para um ambiente são permitidas a qualquer momento.
• É possível adicionar no máximo cinco cabeçalhos de flag para cada ação.

Latências

As ações de segurança têm as seguintes latências:

• Quando você cria uma ação de segurança, pode levar até 10 minutos para que ela entre em vigor. Quando uma ação entrar em vigor e for aplicada a parte do tráfego da API, você poderá ver os efeitos dela na página Detalhes da ação de segurança. Observação: mesmo que a ação tenha entrado em vigor, não será possível determinar isso na página de detalhes da ação de segurança, a menos que ela tenha sido aplicada a algum tráfego da API.
• As ações de segurança ativadas geram um pequeno aumento (menos de 2%) no tempo de resposta do proxy de API.

Criar ações de segurança

Os exemplos a seguir mostram como criar ações de segurança usando chamadas de API. Em todos os exemplos:

• ORG é a organização.
• ENV é o ambiente da ação de segurança.
• ACTION_NAME é o nome da ação de segurança.

Criar uma ação de negação

Para criar uma ação de negação, digite um comando semelhante ao seguinte:

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
       -H "Content-Type: application/json" \
       -d '{"state": "ENABLED", "deny": {"response_code": 404}, "condition_config": {"ip_address_ranges": ["100.0.225.0"]}}'

Observação: no momento, só é possível criar uma ação de negação para uma lista de endereços IP individuais (IPv4 ou IPv6) separados por vírgulas, mas não para um intervalo CIDR de endereços.

Isso cria uma ação de segurança que nega acesso a solicitações para os endereços IP listados após ip_address_ranges e retorna um código de resposta 404.

Criar uma ação de sinalização

Para criar uma ação de sinalização, insira um comando semelhante ao seguinte:

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME" \
        -H "Content-Type: application/json" \
        -d '{"state": "ENABLED", "flag": {"headers": [{"name": "senseflag", "value": "flagvalue"}]}, "condition_config": {"ip_address_ranges": ["100.0.230.0"]}}'

Observação: no momento, só é possível criar uma ação de sinalização para uma lista de endereços IP individuais (IPv4 ou IPv6) separados por vírgulas, mas não para um intervalo CIDR de endereços IP.

Isso cria uma ação de segurança que sinaliza as solicitações dos endereços IP listados após ip_address_ranges e adiciona um cabeçalho senseflag com o valor flagvalue.

Criar uma ação de permissão

Para criar uma ação de permissão, insira um comando semelhante ao seguinte:

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
        -H "Content-Type: application/json" \
        -d '{"state": "ENABLED", "allow": {}, "condition_config": {"ip_address_ranges": ["100.0.220.0", "200.0.0.0"]}}'

Observação: no momento, só é possível criar uma ação de permissão para uma lista de endereços IP individuais (IPv4 ou IPv6) separados por vírgulas, mas não para um intervalo CIDR de endereços IP.

Isso cria uma ação de segurança que permite solicitações dos endereços IP listados após ip_address_ranges.

Ativar ou desativar uma ação de segurança

Os exemplos a seguir mostram chamadas de API para ativar ou desativar ações de segurança.

Ativar uma ação de segurança

Para ativar uma ação de segurança, digite um comando semelhante ao seguinte:

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:enable"

Isso retorna uma resposta como a seguinte:

{
      "name": "ACTION_ALLOW",
      "state": "ENABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:19:26.650965481Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
   }

Desativar uma ação de segurança

Para desativar uma ação de segurança, insira um comando semelhante ao seguinte:

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:disable"

Isso retorna uma resposta como a seguinte:

{
      "name": "actionallow",
      "state": "DISABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:13:04.874540001Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
   }

Receber ou listar ações de segurança

Os exemplos a seguir mostram como acessar ou listar ações de segurança

Realizar uma ação de segurança

Para receber uma ação de segurança, digite um comando semelhante ao seguinte:

curl -XGET  "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME"

Isso retorna uma resposta como a seguinte:

{
      "name": "ACTION_NAME",
      "state": "DISABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:13:04Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
    }

Listar ações de segurança

Para listar todas as ações de segurança, digite um comando semelhante ao seguinte:

curl -XGET  "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions"

Pausar ou retomar ações de segurança

Os exemplos a seguir mostram como pausar ou retomar ações de segurança

Pausar todas as ações de segurança

Para pausar todas as ações de segurança, digite um comando semelhante ao seguinte:

curl -XPATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
                -H "Content-Type: application/json" \
                -d '{"enabled": "false", "name": "organizations/ORG/environments/ENV/securityActionsConfig"}'

Isso retorna uma resposta como a seguinte:

{
      "name": "organizations//environments/ENV/securityActionsConfig",
      "enabled": false,
      "updateTime": "2023-01-23T21:44:58.063807Z"
    }
}

Retomar ações de segurança pausadas

Para retomar as ações de segurança pausadas, digite um comando semelhante ao seguinte:

curl  -XPATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
                -H "Content-Type: application/json" \
                -d '{"enabled": "true", "name": "organizations/ORG/environments/ENV/securityActionsConfig"}'

Isso retorna uma resposta como a seguinte:

{
      "name": "organizations/ORG/environments/ENV/securityActionsConfig",
      "enabled": true,
      "updateTime": "2023-01-23T21:44:58.063807Z"
    }
}