Cloud KMS V1 Client - Class PublicKeyFormat (2.4.0)

Reference documentation and code samples for the Cloud KMS V1 Client class PublicKeyFormat.

The supported PublicKey formats.

Protobuf type google.cloud.kms.v1.PublicKey.PublicKeyFormat

Namespace

Google \ Cloud \ Kms \ V1 \ PublicKey

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

PUBLIC_KEY_FORMAT_UNSPECIFIED

Value: 0

If the public_key_format field is not specified:

  • For PQC algorithms, an error will be returned.

  • For non-PQC algorithms, the default format is PEM, and the field pem will be populated. Otherwise, the public key will be exported through the public_key field in the requested format.

Generated from protobuf enum PUBLIC_KEY_FORMAT_UNSPECIFIED = 0;

PEM

Value: 1

The returned public key will be encoded in PEM format.

See the RFC7468 sections for General Considerations and Textual Encoding of Subject Public Key Info for more information.

Generated from protobuf enum PEM = 1;

DER

Value: 2

The returned public key will be encoded in DER format (the PrivateKeyInfo structure from RFC 5208).

Generated from protobuf enum DER = 2;

NIST_PQC

Value: 3

This is supported only for PQC algorithms.

The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205).

Generated from protobuf enum NIST_PQC = 3;

XWING_RAW_BYTES

Value: 4

The returned public key is in raw bytes format defined in its standard https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem.

Generated from protobuf enum XWING_RAW_BYTES = 4;