Google Certificate Authority Service V1 Client - Class NameConstraints (1.7.2)

Reference documentation and code samples for the Google Certificate Authority Service V1 Client class NameConstraints.

Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10

Generated from protobuf message google.cloud.security.privateca.v1.X509Parameters.NameConstraints

Namespace

Google \ Cloud \ Security \ PrivateCA \ V1 \ X509Parameters

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ critical bool

Indicates whether or not the name constraints are marked critical.
↳ permitted_dns_names array

Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, example.com, www.example.com, www.sub.example.com would satisfy example.com while example1.com does not.
↳ excluded_dns_names array

Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint. For example, example.com, www.example.com, www.sub.example.com would satisfy example.com while example1.com does not.
↳ permitted_ip_ranges array

Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
↳ excluded_ip_ranges array

Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.
↳ permitted_email_addresses array

Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. .example.com) to indicate all email addresses in that domain.
↳ excluded_email_addresses array

Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. .example.com) to indicate all email addresses in that domain.
↳ permitted_uris array

Contains the permitted URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like .example.com)
↳ excluded_uris array

Contains the excluded URIs that apply to the host part of the name. The value can be a hostname or a domain with a leading period (like .example.com)

getCritical

Indicates whether or not the name constraints are marked critical.

Returns
Type Description
bool

setCritical

Indicates whether or not the name constraints are marked critical.

Parameter
Name Description
var bool
Returns
Type Description
$this

getPermittedDnsNames

Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint.

For example, example.com, www.example.com, www.sub.example.com would satisfy example.com while example1.com does not.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPermittedDnsNames

Contains permitted DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint.

For example, example.com, www.example.com, www.sub.example.com would satisfy example.com while example1.com does not.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getExcludedDnsNames

Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint.

For example, example.com, www.example.com, www.sub.example.com would satisfy example.com while example1.com does not.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setExcludedDnsNames

Contains excluded DNS names. Any DNS name that can be constructed by simply adding zero or more labels to the left-hand side of the name satisfies the name constraint.

For example, example.com, www.example.com, www.sub.example.com would satisfy example.com while example1.com does not.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getPermittedIpRanges

Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632.

For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPermittedIpRanges

Contains the permitted IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632.

For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getExcludedIpRanges

Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632.

For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setExcludedIpRanges

Contains the excluded IP ranges. For IPv4 addresses, the ranges are expressed using CIDR notation as specified in RFC 4632.

For IPv6 addresses, the ranges are expressed in similar encoding as IPv4 addresses.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getPermittedEmailAddresses

Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. .example.com) to indicate all email addresses in that domain.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPermittedEmailAddresses

Contains the permitted email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. .example.com) to indicate all email addresses in that domain.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getExcludedEmailAddresses

Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. .example.com) to indicate all email addresses in that domain.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setExcludedEmailAddresses

Contains the excluded email addresses. The value can be a particular email address, a hostname to indicate all email addresses on that host or a domain with a leading period (e.g. .example.com) to indicate all email addresses in that domain.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getPermittedUris

Contains the permitted URIs that apply to the host part of the name.

The value can be a hostname or a domain with a leading period (like .example.com)

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPermittedUris

Contains the permitted URIs that apply to the host part of the name.

The value can be a hostname or a domain with a leading period (like .example.com)

Parameter
Name Description
var string[]
Returns
Type Description
$this

getExcludedUris

Contains the excluded URIs that apply to the host part of the name.

The value can be a hostname or a domain with a leading period (like .example.com)

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setExcludedUris

Contains the excluded URIs that apply to the host part of the name.

The value can be a hostname or a domain with a leading period (like .example.com)

Parameter
Name Description
var string[]
Returns
Type Description
$this