REST Resource: projects.locations.serverTlsPolicies

Resource: ServerTlsPolicy

ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource.

ServerTlsPolicy in the form accepted by external HTTPS load balancers can be attached only to TargetHttpsProxy with an EXTERNAL or EXTERNAL_MANAGED load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director INTERNAL_SELF_MANAGED load balancing scheme.

JSON representation 
{
  "name": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "allowOpen": boolean,
  "serverCertificate": {
    object (CertificateProvider)
  },
  "mtlsPolicy": {
    object (MTLSPolicy)
  }
}
Fields
name

string

Required. Name of the ServerTlsPolicy resource. It matches the pattern projects/*/locations/{location}/serverTlsPolicies/{serverTlsPolicy}
description

string

Free-text description of the resource.
createTime

string (Timestamp format)

Output only. The timestamp when the resource was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The timestamp when the resource was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Set of label tags associated with the resource.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
allowOpen

boolean

This field applies only for Traffic Director policies. It is must be set to false for external HTTPS load balancer policies.

Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if allowOpen and mtlsPolicy are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility.

Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.
serverCertificate

object (CertificateProvider)

Optional if policy is to be used with Traffic Director. For external HTTPS load balancer must be empty.

Defines a mechanism to provision server identity (public and private keys). Cannot be combined with allowOpen as a permissive mode that allows both plain text and TLS is not supported.
mtlsPolicy

object (MTLSPolicy)

This field is required if the policy is used with external HTTPS load balancers. This field can be empty for Traffic Director.

Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If allowOpen and mtlsPolicy are set, server allows both plain text and mTLS connections.

MTLSPolicy

Specification of the MTLSPolicy.

JSON representation 
{
  "clientValidationMode": enum (ClientValidationMode),
  "clientValidationCa": [
    {
      object (ValidationCA)
    }
  ],
  "clientValidationTrustConfig": string
}
Fields
clientValidationMode

enum (ClientValidationMode)

When the client presents an invalid certificate or no certificate to the load balancer, the clientValidationMode specifies how the client connection is handled.

Required if the policy is to be used with the external HTTPS load balancing. For Traffic Director it must be empty.
clientValidationCa[]

object (ValidationCA)

Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty.

Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate.
clientValidationTrustConfig

string

Reference to the TrustConfig from certificatemanager.googleapis.com namespace.

If specified, the chain validation will be performed against certificates configured in the given TrustConfig.

Allowed only if the policy is to be used with external HTTPS load balancers.

ClientValidationMode

Mutual TLS certificate validation mode.

Enums
CLIENT_VALIDATION_MODE_UNSPECIFIED Not allowed.
ALLOW_INVALID_OR_MISSING_CLIENT_CERT Allow connection even if certificate chain validation of the client certificate failed or no client certificate was presented. The proof of possession of the private key is always checked if client certificate was presented. This mode requires the backend to implement processing of data extracted from a client certificate to authenticate the peer, or to reject connections if the client certificate fingerprint is missing.
REJECT_INVALID

Require a client certificate and allow connection to the backend only if validation of the client certificate passed.

If set, requires a reference to non-empty TrustConfig specified in clientValidationTrustConfig.

Methods

create

 Creates a new ServerTlsPolicy in a given project and location.

delete

 Deletes a single ServerTlsPolicy.

get

 Gets details of a single ServerTlsPolicy.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists ServerTlsPolicies in a given project and location.

patch

 Updates the parameters of a single ServerTlsPolicy.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.