Class PublicKey (3.7.0)

PublicKey(mapping=None,*,ignore_unknown_fields=False,**kwargs)

The public keys for a givenCryptoKeyVersion. ObtainedviaGetPublicKey.

Attributes

NameDescription
pemstr
The public key, encoded in PEM format. For more information, see theRFC 7468__ sections for `General Considerations
algorithmgoogle.cloud.kms_v1.types.CryptoKeyVersion.CryptoKeyVersionAlgorithm
TheAlgorithm associated with this key.
pem_crc32cgoogle.protobuf.wrappers_pb2.Int64Value
Integrity verification field. A CRC32C checksum of the returnedPublicKey.pem. An integrity check ofPublicKey.pem can be performed by computing the CRC32C checksum ofPublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta.
namestr
Thename of theCryptoKeyVersion public key. Provided here for verification. NOTE: This field is in Beta.
protection_levelgoogle.cloud.kms_v1.types.ProtectionLevel
TheProtectionLevel of theCryptoKeyVersion public key.
public_key_formatgoogle.cloud.kms_v1.types.PublicKey.PublicKeyFormat
ThePublicKey format specified by the customer through thepublic_key_format field.
public_keygoogle.cloud.kms_v1.types.ChecksummedData
This field contains the public key (with integrity verification), formatted according to thepublic_key_format field.

Classes

PublicKeyFormat

PublicKeyFormat(value)

The supportedPublicKey formats.

    - For PQC algorithms, an error will be returned.    - For non-PQC algorithms, the default format is PEM, and the      field <xref uid="google.cloud.kms.v1.PublicKey.pem">pem</xref> will be      populated.    Otherwise, the public key will be exported through the    <xref uid="google.cloud.kms.v1.PublicKey.public_key">public_key</xref> field    in the requested format.PEM (1):    The returned public key will be encoded in PEM format. See    the `RFC7468 <https://tools.ietf.org/html/rfc7468>`__    sections for `General    Considerations <https://tools.ietf.org/html/rfc7468#section-2>`__    and [Textual Encoding of Subject Public Key Info]    (https://tools.ietf.org/html/rfc7468#section-13) for more    information.DER (2):    The returned public key will be encoded in    DER format (the PrivateKeyInfo structure from    RFC 5208).NIST_PQC (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).XWING_RAW_BYTES (4):    The returned public key is in raw bytes    format defined in its standard    https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-11-13 UTC.