Skip to content

googlePrivatecaCertificateTemplate

Certificate Authority Service provides reusable and parameterized templates that you can use for common certificate issuance scenarios. A certificate template represents a relatively static and well-defined certificate issuance schema within an organization. A certificate template can essentially become a full-fledged vertical certificate issuance framework.

For more information, see:

Example Usage - basic_certificate_template

An example of a basic privateca certificate template

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.privatecaCertificateTemplate.PrivatecaCertificateTemplate(
  this,
  "primary",
  {
    description: "An updated sample certificate template",
    identity_constraints: [
      {
        allow_subject_alt_names_passthrough: true,
        allow_subject_passthrough: true,
        cel_expression: [
          {
            description: "Always true",
            expression: "true",
            location: "any.file.anywhere",
            title: "Sample expression",
          },
        ],
      },
    ],
    labels: [
      {
        "label-two": "value-two",
      },
    ],
    location: "us-west1",
    name: "template",
    passthrough_extensions: [
      {
        additional_extensions: [
          {
            object_id_path: [1, 6],
          },
        ],
        known_extensions: ["EXTENDED_KEY_USAGE"],
      },
    ],
    predefined_values: [
      {
        additional_extensions: [
          {
            critical: true,
            object_id: [
              {
                object_id_path: [1, 6],
              },
            ],
            value: "c3RyaW5nCg==",
          },
        ],
        aia_ocsp_servers: ["string"],
        ca_options: [
          {
            is_ca: false,
            max_issuer_path_length: 6,
          },
        ],
        key_usage: [
          {
            base_key_usage: [
              {
                cert_sign: false,
                content_commitment: true,
                crl_sign: false,
                data_encipherment: true,
                decipher_only: true,
                digital_signature: true,
                encipher_only: true,
                key_agreement: true,
                key_encipherment: true,
              },
            ],
            extended_key_usage: [
              {
                client_auth: true,
                code_signing: true,
                email_protection: true,
                ocsp_signing: true,
                server_auth: true,
                time_stamping: true,
              },
            ],
            unknown_extended_key_usages: [
              {
                object_id_path: [1, 6],
              },
            ],
          },
        ],
        policy_ids: [
          {
            object_id_path: [1, 6],
          },
        ],
      },
    ],
    project: "my-project-name",
  }
);

Argument Reference

The following arguments are supported:

  • location - (Required) The location for the resource

  • name - (Required) The resource name for this CertificateTemplate in the format projects/*/locations/*/certificateTemplates/*.

The objectId block supports:

  • objectIdPath - (Required) Required. The parts of an OID path. The most significant parts of the path come first.

  • description - (Optional) Optional. A human-readable description of scenarios this template is intended for.

  • identityConstraints - (Optional) Optional. Describes constraints on identities that may be appear in Certificates issued using this template. If this is omitted, then this template will not add restrictions on a certificate's identity.

  • labels - (Optional) Optional. Labels with user-defined metadata.

  • passthroughExtensions - (Optional) Optional. Describes the set of X.509 extensions that may appear in a Certificate issued using this CertificateTemplate. If a certificate request sets extensions that don't appear in the passthrough_extensions, those extensions will be dropped. If the issuing CaPool's IssuancePolicy defines baseline_values that don't appear here, the certificate issuance request will fail. If this is omitted, then this template will not add restrictions on a certificate's X.509 extensions. These constraints do not apply to X.509 extensions set in this CertificateTemplate's predefined_values.

  • predefinedValues - (Optional) Optional. A set of X.509 values that will be applied to all issued certificates that use this template. If the certificate request includes conflicting values for the same properties, they will be overwritten by the values defined here. If the issuing CaPool's IssuancePolicy defines conflicting baseline_values for the same properties, the certificate issuance request will fail.

  • project - (Optional) The project for the resource

The identityConstraints block supports:

  • allowSubjectAltNamesPassthrough - (Required) Required. If this is true, the SubjectAltNames extension may be copied from a certificate request into the signed certificate. Otherwise, the requested SubjectAltNames will be discarded.

  • allowSubjectPassthrough - (Required) Required. If this is true, the Subject field may be copied from a certificate request into the signed certificate. Otherwise, the requested Subject will be discarded.

  • celExpression - (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

The celExpression block supports:

  • description - (Optional) Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

  • expression - (Optional) Textual representation of an expression in Common Expression Language syntax.

  • location - (Optional) Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

  • title - (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.

The passthroughExtensions block supports:

  • additionalExtensions - (Optional) Optional. A set of ObjectIds identifying custom X.509 extensions. Will be combined with known_extensions to determine the full set of X.509 extensions.

  • knownExtensions - (Optional) Optional. A set of named X.509 extensions. Will be combined with additional_extensions to determine the full set of X.509 extensions.

The additionalExtensions block supports:

  • objectIdPath - (Required) Required. The parts of an OID path. The most significant parts of the path come first.

The predefinedValues block supports:

  • additionalExtensions - (Optional) Optional. Describes custom X.509 extensions.

  • aiaOcspServers - (Optional) Optional. Describes Online Certificate Status Protocol (OCSP) endpoint addresses that appear in the "Authority Information Access" extension in the certificate.

  • caOptions - (Optional) Optional. Describes options in this X509Parameters that are relevant in a CA certificate.

  • keyUsage - (Optional) Optional. Indicates the intended use for keys that correspond to a certificate.

  • policyIds - (Optional) Optional. Describes the X.509 certificate policy object identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.

The additionalExtensions block supports:

  • critical - (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).

  • objectId - (Required) Required. The OID for this X.509 extension.

  • value - (Required) Required. The value of this X.509 extension.

The caOptions block supports:

  • isCa - (Optional) Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.

  • maxIssuerPathLength - (Optional) Optional. Refers to the path length restriction 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 CA certificate.

The keyUsage block supports:

  • baseKeyUsage - (Optional) Describes high-level ways in which a key may be used.

  • extendedKeyUsage - (Optional) Detailed scenarios in which a key may be used.

  • unknownExtendedKeyUsages - (Optional) Used to describe extended key usages that are not listed in the KeyUsage.ExtendedKeyUsageOptions message.

The baseKeyUsage block supports:

  • certSign - (Optional) The key may be used to sign certificates.

  • contentCommitment - (Optional) The key may be used for cryptographic commitments. Note that this may also be referred to as "non-repudiation".

  • crlSign - (Optional) The key may be used sign certificate revocation lists.

  • dataEncipherment - (Optional) The key may be used to encipher data.

  • decipherOnly - (Optional) The key may be used to decipher only.

  • digitalSignature - (Optional) The key may be used for digital signatures.

  • encipherOnly - (Optional) The key may be used to encipher only.

  • keyAgreement - (Optional) The key may be used in a key agreement protocol.

  • keyEncipherment - (Optional) The key may be used to encipher other keys.

The extendedKeyUsage block supports:

  • clientAuth - (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.

  • codeSigning - (Optional) Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as "Signing of downloadable executable code client authentication".

  • emailProtection - (Optional) Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described as "Email protection".

  • ocspSigning - (Optional) Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as "Signing OCSP responses".

  • serverAuth - (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.

  • timeStamping - (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".

The unknownExtendedKeyUsages block supports:

  • objectIdPath - (Required) Required. The parts of an OID path. The most significant parts of the path come first.

The policyIds block supports:

  • objectIdPath - (Required) Required. The parts of an OID path. The most significant parts of the path come first.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • id - an identifier for the resource with format projects/{{project}}/locations/{{location}}/certificateTemplates/{{name}}

  • createTime - Output only. The time at which this CertificateTemplate was created.

  • updateTime - Output only. The time at which this CertificateTemplate was updated.

Timeouts

This resource provides the following Timeouts configuration options:

  • create - Default is 20 minutes.
  • update - Default is 20 minutes.
  • delete - Default is 20 minutes.

Import

CertificateTemplate can be imported using any of these accepted formats:

$ terraform import google_privateca_certificate_template.default projects/{{project}}/locations/{{location}}/certificateTemplates/{{name}}
$ terraform import google_privateca_certificate_template.default {{project}}/{{location}}/{{name}}
$ terraform import google_privateca_certificate_template.default {{location}}/{{name}}