REST Resource: projects.locations.serverTlsPolicies

Recurso: ServerTlsPolicy

ServerTlsPolicy é um recurso que especifica como um servidor deve autenticar as solicitações recebidas. Esse recurso em si não afeta a configuração, a menos que esteja anexado a um proxy HTTPS de destino ou recurso de seletor de configuração de endpoint.

ServerTlsPolicy no formato aceito pelos balanceadores de carga de aplicativo só pode ser anexado a TargetHttpsProxy com um esquema de balanceamento de carga EXTERNAL, EXTERNAL_MANAGED ou INTERNAL_MANAGED. As ServerTlsPolicies compatíveis com o Traffic Director podem ser anexadas a EndpointPolicy e TargetHttpsProxy com o esquema de balanceamento de carga do Traffic Director INTERNAL_SELF_MANAGED.

Representação JSON
{
  "name": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "allowOpen": boolean,
  "serverCertificate": {
    object (CertificateProvider)
  },
  "mtlsPolicy": {
    object (MTLSPolicy)
  }
}
Campos
name

string

Obrigatório. Nome do recurso ServerTlsPolicy. Ele corresponde ao padrão projects/*/locations/{location}/serverTlsPolicies/{serverTlsPolicy}

description

string

Descrição de texto livre do recurso.

createTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que o recurso foi criado.

Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30";

updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que o recurso foi atualizado.

Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30";

labels

map (key: string, value: string)

Conjunto de tags de rótulo associadas ao recurso.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

allowOpen

boolean

Esse campo se aplica apenas às políticas do Traffic Director. Ele precisa ser definido como "false" para políticas do balanceador de carga de aplicativo.

Determina se o servidor permite conexões de texto simples Se definido como "true", o servidor permite conexões de texto simples. Por padrão, ela é definida como "false". Essa configuração não é exclusiva de outros modos de criptografia. Por exemplo, se allowOpen e mtlsPolicy estiverem definidos, o servidor permitirá conexões de texto simples e mTLS. Consulte a documentação de outros modos de criptografia para confirmar a compatibilidade.

Considere usar esse comando se quiser atualizar sua implantação para TLS enquanto tiver tráfego misto de TLS e não TLS chegando à porta :80.

serverCertificate

object (CertificateProvider)

Opcional se a política for usada com o Traffic Director. Para balanceadores de carga de aplicativo, precisa estar vazio.

Define um mecanismo para provisionar a identidade do servidor (chaves pública e privada). Não pode ser combinado com allowOpen porque não há suporte para um modo permissivo que permita texto simples e TLS.

mtlsPolicy

object (MTLSPolicy)

Esse campo é obrigatório se a política for usada com balanceadores de carga de aplicativo. Esse campo pode ficar vazio para o Traffic Director.

Define um mecanismo para provisionar certificados de validação de pares para autenticação de pares (TLS mútuo – mTLS). Se não for especificado, o certificado do cliente não será solicitado. A conexão é tratada como TLS, não mTLS. Se allowOpen e mtlsPolicy estiverem definidos, o servidor vai permitir conexões de texto simples e mTLS.

MTLSPolicy

Especificação da MTLSPolicy.

Representação JSON
{
  "clientValidationMode": enum (ClientValidationMode),
  "clientValidationCa": [
    {
      object (ValidationCA)
    }
  ],
  "clientValidationTrustConfig": string,
  "tier": enum (Tier)
}
Campos
clientValidationMode

enum (ClientValidationMode)

Quando o cliente apresenta um certificado inválido ou nenhum certificado para o balanceador de carga, o clientValidationMode especifica como a conexão do cliente é processada.

Obrigatório se a política for usada com os balanceadores de carga de aplicativo. Para o Traffic Director, ele precisa estar vazio.

clientValidationCa[]

object (ValidationCA)

Obrigatório se a política for usada com o Traffic Director. Para balanceadores de carga de aplicativo, ele precisa estar vazio.

Define o mecanismo para obter o certificado da autoridade de certificação e validar o certificado do cliente.

clientValidationTrustConfig

string

Referência ao TrustConfig do namespace certificatemanager.googleapis.com.

Se especificado, a validação da cadeia será realizada em relação aos certificados configurados na TrustConfig especificada.

Permitido apenas se a política for usada com balanceadores de carga de aplicativo.

tier

enum (Tier)

Nível do TLS mútuo.

Permitido apenas se a política for usada com balanceadores de carga de aplicativo.

ClientValidationMode

Modo de validação de certificado TLS mútuo.

Enums
CLIENT_VALIDATION_MODE_UNSPECIFIED Não permitido.
ALLOW_INVALID_OR_MISSING_CLIENT_CERT Permite a conexão mesmo que a validação da cadeia de certificados do certificado do cliente tenha falhado ou nenhum certificado do cliente tenha sido apresentado. O comprovante de posse da chave privada é sempre verificado se o certificado do cliente foi apresentado. Esse modo exige que o back-end implemente o processamento de dados extraídos de um certificado do cliente para autenticar o peer ou rejeite conexões se a impressão digital do certificado do cliente estiver faltando.
REJECT_INVALID

Exigir um certificado de cliente e permitir a conexão com o back-end somente se a validação do certificado de cliente for aprovada.

Se definido, exige uma referência a TrustConfig não vazio especificado em clientValidationTrustConfig.

Nível

Nível de TLS mútuo para XLB.

Enums
TIER_UNSPECIFIED Se o nível não for especificado na solicitação, o sistema vai escolher um valor padrão, que atualmente é o nível STANDARD.
STANDARD Nível padrão. Principalmente para provedores de software (comunicação de serviço para serviço/API).
ADVANCED Nível avançado. Para clientes em ambientes altamente regulamentados, especifique chaves mais longas e cadeias de certificados complexas.

Métodos

create

Cria uma ServerTlsPolicy em um determinado projeto e local.

delete

Exclui uma única ServerTlsPolicy.

get

Recebe detalhes de uma única ServerTlsPolicy.

list

Lista ServerTlsPolicies em um determinado projeto e local.

patch

Atualiza os parâmetros de uma única ServerTlsPolicy.