PrivateCACAPool
| Property | Value |
|---|---|
| Google Cloud Service Name | Private CA |
| Google Cloud Service Documentation | /certificate-authority-service/docs/ |
| Google Cloud REST Resource Name | v1.projects.locations.caPools |
| Google Cloud REST Resource Documentation | /certificate-authority-service/docs/reference/rest/v1/projects.locations.caPools |
| Config Connector Resource Short Names | gcpprivatecacapool gcpprivatecacapools privatecacapool |
| Config Connector Service Name | privateca.googleapis.com |
| Config Connector Resource Fully Qualified Name | privatecacapools.privateca.cnrm.cloud.google.com |
| Can Be Referenced by IAMPolicy/IAMPolicyMember | No |
| Config Connector Default Average Reconcile Interval In Seconds | 600 |
Custom Resource Definition Properties
Spec
Schema
issuancePolicy
:
allowedIssuanceModes
:
allowConfigBasedIssuance
:
boolean
allowCsrBasedIssuance
:
boolean
allowedKeyTypes
:
-
ellipticCurve
:
signatureAlgorithm
:
string
rsa
:
maxModulusSize
:
integer
minModulusSize
:
integer
baselineValues
:
additionalExtensions
:
-
critical
:
boolean
objectId
:
objectIdPath
:
-
integer
value
:
string
aiaOcspServers
:
-
string
caOptions
:
isCa
:
boolean
maxIssuerPathLength
:
integer
zeroMaxIssuerPathLength
:
boolean
keyUsage
:
baseKeyUsage
:
certSign
:
boolean
contentCommitment
:
boolean
crlSign
:
boolean
dataEncipherment
:
boolean
decipherOnly
:
boolean
digitalSignature
:
boolean
encipherOnly
:
boolean
keyAgreement
:
boolean
keyEncipherment
:
boolean
extendedKeyUsage
:
clientAuth
:
boolean
codeSigning
:
boolean
emailProtection
:
boolean
ocspSigning
:
boolean
serverAuth
:
boolean
timeStamping
:
boolean
unknownExtendedKeyUsages
:
-
objectIdPath
:
-
integer
policyIds
:
-
objectIdPath
:
-
integer
identityConstraints
:
allowSubjectAltNamesPassthrough
:
boolean
allowSubjectPassthrough
:
boolean
celExpression
:
description
:
string
expression
:
string
location
:
string
title
:
string
maximumLifetime
:
string
passthroughExtensions
:
additionalExtensions
:
-
objectIdPath
:
-
integer
knownExtensions
:
-
string
location
:
string
projectRef
:
external
:
string
kind
:
string
name
:
string
namespace
:
string
publishingOptions
:
publishCaCert
:
boolean
publishCrl
:
boolean
resourceID
:
string
tier
:
string
| Fields | |
|---|---|
| Optional |
Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool. |
| Optional |
Optional. If specified, then only methods allowed in the [IssuanceModes][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.IssuanceModes] may be used to issue [Certificates][google.cloud.security.privateca.v1.Certificate]. |
| Optional |
Optional. When true, allows callers to create [Certificates][google.cloud.security.privateca.v1.Certificate] by specifying a [CertificateConfig][google.cloud.security.privateca.v1.CertificateConfig]. |
| Optional |
Optional. When true, allows callers to create [Certificates][google.cloud.security.privateca.v1.Certificate] by specifying a CSR. |
| Optional |
Optional. If any [AllowedKeyType][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.AllowedKeyType] is specified, then the certificate request's public key must match one of the key types listed here. Otherwise, any key may be used. |
| Optional |
|
| Optional |
Represents an allowed Elliptic Curve key type. |
| Optional |
Optional. A signature algorithm that must be used. If this is omitted, any EC-based signature algorithm will be allowed. |
| Optional |
Represents an allowed RSA key type. |
| Optional |
Optional. The maximum allowed RSA modulus size (inclusive), in bits. If this is not set, or if set to zero, the service will not enforce an explicit upper bound on RSA modulus sizes. |
| Optional |
Optional. The minimum allowed RSA modulus size (inclusive), in bits. If this is not set, or if set to zero, the service-level min RSA modulus size will continue to apply. |
| Optional |
Optional. A set of X.509 values that will be applied to all certificates issued through this [CaPool][google.cloud.security.privateca.v1.CaPool]. If a certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If a certificate request uses a [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate] that defines conflicting [predefined_values][google.cloud.security.privateca.v1.CertificateTemplate.predefined_values] for the same properties, the certificate issuance request will fail. |
| Optional |
Optional. Describes custom X.509 extensions. |
| Optional |
X509Extension |
| Optional |
Optional. Indicates whether or not this extension is critical (i.e., if the client does not know how to handle this extension, the client should consider this to be an error). |
| Optional |
Required. The OID for this X.509 extension. |
| Optional |
Required. The parts of an OID path. The most significant parts of the path come first. |
| Optional |
|
| Optional |
Required. The value of this X.509 extension. |
| Optional |
Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate. |
| Optional |
|
| Optional |
Optional. Describes options in this [X509Parameters][google.cloud.security.privateca.v1.X509Parameters] that are relevant in a CA certificate. If not specified, a default basic constraints extension with `is_ca=false` will be added for leaf certificates. |
| Optional |
Optional. Refers to the "CA" boolean field in the X.509 extension. When this value is missing, the basic constraints extension will be omitted from the certificate. |
| Optional |
Optional. Refers to the path length constraint field in the X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the certificate. |
| Optional |
Optional. When true, the "path length constraint" in Basic Constraints extension will be set to 0. if both max_issuer_path_length and zero_max_issuer_path_length are unset, the max path length will be omitted from the CA certificate. |
| Optional |
Optional. Indicates the intended use for keys that correspond to a certificate. |
| Optional |
Describes high-level ways in which a key may be used. |
| Optional |
The key may be used to sign certificates. |
| Optional |
The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation". |
| Optional |
The key may be used sign certificate revocation lists. |
| Optional |
The key may be used to encipher data. |
| Optional |
The key may be used to decipher only. |
| Optional |
The key may be used for digital signatures. |
| Optional |
The key may be used to encipher only. |
| Optional |
The key may be used in a key agreement protocol. |
| Optional |
The key may be used to encipher other keys. |
| Optional |
Detailed scenarios in which a key may be used. |
| Optional |
Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as "TLS WWW client authentication", though regularly used for non-WWW TLS. |
| Optional |
Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication". |
| Optional |
Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection". |
| Optional |
Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses". |
| Optional |
Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as "TLS WWW server authentication", though regularly used for non-WWW TLS. |
| Optional |
Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as "Binding the hash of an object to a time". |
| Optional |
Used to describe extended key usages that are not listed in the [KeyUsage.ExtendedKeyUsageOptions][google.cloud.security.privateca.v1.KeyUsage.ExtendedKeyUsageOptions] message. |
| Optional |
|
| Optional |
Required. The parts of an OID path. The most significant parts of the path come first. |
| Optional |
|
| Optional |
Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4. |
| Optional |
|
| Optional |
Required. The parts of an OID path. The most significant parts of the path come first. |
| Optional |
|
| Optional |
Optional. Describes constraints on identities that may appear in [Certificates][google.cloud.security.privateca.v1.Certificate] issued through this [CaPool][google.cloud.security.privateca.v1.CaPool]. If this is omitted, then this [CaPool][google.cloud.security.privateca.v1.CaPool] will not add restrictions on a certificate's identity. |
| Optional |
Required. If this is true, the [SubjectAltNames][google.cloud.security.privateca.v1.SubjectAltNames] extension may be copied from a certificate request into the signed certificate. Otherwise, the requested [SubjectAltNames][google.cloud.security.privateca.v1.SubjectAltNames] will be discarded. |
| Optional |
Required. If this is true, the [Subject][google.cloud.security.privateca.v1.Subject] field may be copied from a certificate request into the signed certificate. Otherwise, the requested [Subject][google.cloud.security.privateca.v1.Subject] will be discarded. |
| Optional |
Optional. A CEL expression that may be used to validate the resolved X.509 Subject and/or Subject Alternative Name before a certificate is signed. To see the full allowed syntax and some examples, see https://cloud.google.com/certificate-authority-service/docs/using-cel |
| Optional |
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. |
| Optional |
Textual representation of an expression in Common Expression Language syntax. |
| Optional |
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. |
| Optional |
Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. |
| Optional |
Optional. The maximum lifetime allowed for issued [Certificates][google.cloud.security.privateca.v1.Certificate]. Note that if the issuing [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority] expires before a [Certificate][google.cloud.security.privateca.v1.Certificate] resource's requested maximum_lifetime, the effective lifetime will be explicitly truncated to match it. |
| Optional |
Optional. Describes the set of X.509 extensions that may appear in a [Certificate][google.cloud.security.privateca.v1.Certificate] issued through this [CaPool][google.cloud.security.privateca.v1.CaPool]. If a certificate request sets extensions that don't appear in the [passthrough_extensions][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.passthrough_extensions], those extensions will be dropped. If a certificate request uses a [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate] with [predefined_values][google.cloud.security.privateca.v1.CertificateTemplate.predefined_values] that don't appear here, the certificate issuance request will fail. If this is omitted, then this [CaPool][google.cloud.security.privateca.v1.CaPool] will not add restrictions on a certificate's X.509 extensions. These constraints do not apply to X.509 extensions set in this [CaPool][google.cloud.security.privateca.v1.CaPool]'s [baseline_values][google.cloud.security.privateca.v1.CaPool.IssuancePolicy.baseline_values]. |
| Optional |
Optional. A set of [ObjectIds][google.cloud.security.privateca.v1.ObjectId] identifying custom X.509 extensions. Will be combined with [known_extensions][google.cloud.security.privateca.v1.CertificateExtensionConstraints.known_extensions] to determine the full set of X.509 extensions. |
| Optional |
|
| Optional |
Required. The parts of an OID path. The most significant parts of the path come first. |
| Optional |
|
| Optional |
Optional. A set of named X.509 extensions. Will be combined with [additional_extensions][google.cloud.security.privateca.v1.CertificateExtensionConstraints.additional_extensions] to determine the full set of X.509 extensions. |
| Optional |
|
| Required |
The location of this resource. |
| Required |
The project that this resource belongs to. |
| Optional |
The `projectID` field of a project, when not managed by Config Connector. |
| Optional |
The kind of the Project resource; optional but must be `Project` if provided. |
| Optional |
The `name` field of a `Project` resource. |
| Optional |
The `namespace` field of a `Project` resource. |
| Optional |
Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool. |
| Optional |
Optional. When true, publishes each [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s CA certificate and includes its URL in the "Authority Information Access" X.509 extension in all issued [Certificates][google.cloud.security.privateca.v1.Certificate]. If this is false, the CA certificate will not be published and the corresponding X.509 extension will not be written in issued certificates. |
| Optional |
Optional. When true, publishes each [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]'s CRL and includes its URL in the "CRL Distribution Points" X.509 extension in all issued [Certificates][google.cloud.security.privateca.v1.Certificate]. If this is false, CRLs will not be published and the corresponding X.509 extension will not be written in issued certificates. CRLs will expire 7 days from their creation. However, we will rebuild daily. CRLs are also rebuilt shortly after a certificate is revoked. |
| Optional |
The PrivateCACAPool name. If not given, the metadata.name is used. |
| Optional |
Required. Immutable. The Tier of this CaPool. Possible values: TIER_UNSPECIFIED, ENTERPRISE, DEVOPS |
Status
Schema
conditions
:
-
lastTransitionTime
:
string
message
:
string
reason
:
string
status
:
string
type
:
string
observedGeneration
:
integer
| Fields | |
|---|---|
conditions
|
Conditions represent the latest available observations of the object's current state. |
conditions[]
|
|
conditions[].lastTransitionTime
|
Last time the condition transitioned from one status to another. |
conditions[].message
|
Human-readable message indicating details about last transition. |
conditions[].reason
|
Unique, one-word, CamelCase reason for the condition's last transition. |
conditions[].status
|
Status is the status of the condition. Can be True, False, Unknown. |
conditions[].type
|
Type is the type of the condition. |
observedGeneration
|
ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. |
Sample YAML(s)
Typical Use Case
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
apiVersion
:
privateca.cnrm.cloud.google.com/v1beta1
kind
:
PrivateCACAPool
metadata
:
labels
:
label-two
:
"value-two"
name
:
privatecacapool-sample
spec
:
projectRef
:
external
:
projects/${PROJECT_ID?}
location
:
"us-central1"
tier
:
ENTERPRISE
issuancePolicy
:
allowedKeyTypes
:
-
rsa
:
minModulusSize
:
64
maxModulusSize
:
128
-
ellipticCurve
:
signatureAlgorithm
:
ECDSA_P384
maximumLifetime
:
43200s
allowedIssuanceModes
:
allowCsrBasedIssuance
:
true
allowConfigBasedIssuance
:
false
baselineValues
:
keyUsage
:
baseKeyUsage
:
digitalSignature
:
false
contentCommitment
:
false
keyEncipherment
:
false
dataEncipherment
:
false
keyAgreement
:
false
certSign
:
false
crlSign
:
false
encipherOnly
:
false
decipherOnly
:
false
extendedKeyUsage
:
serverAuth
:
false
clientAuth
:
false
codeSigning
:
false
emailProtection
:
false
timeStamping
:
false
ocspSigning
:
false
unknownExtendedKeyUsages
:
-
objectIdPath
:
-
1
-
7
caOptions
:
isCa
:
false
maxIssuerPathLength
:
7
policyIds
:
-
objectIdPath
:
-
1
-
7
aiaOcspServers
:
-
string
additionalExtensions
:
-
objectId
:
objectIdPath
:
-
1
-
7
critical
:
false
value
:
c3RyaW5nCg==
identityConstraints
:
celExpression
:
title
:
Sample expression
description
:
Always false
expression
:
'false'
location
:
devops.ca_pool.json
allowSubjectPassthrough
:
false
allowSubjectAltNamesPassthrough
:
false
passthroughExtensions
:
knownExtensions
:
-
BASE_KEY_USAGE
additionalExtensions
:
-
objectIdPath
:
-
1
-
7
