Struct KeyManagementService 

pub struct KeyManagementService { /* private fields */ }

Implements a client for the Cloud Key Management Service (KMS) API.

Example

let client = KeyManagementService::builder().build().await?;
// use `client` to make requests to the Cloud Key Management Service (KMS) API.

Service Description

Google Cloud Key Management Service

Manages cryptographic keys and operations using those keys. Implements a REST model with the following objects:

• KeyRing
• CryptoKey
• CryptoKeyVersion
• ImportJob

If you are using manual gRPC libraries, see Using gRPC with Cloud KMS.

Configuration

To configure KeyManagementService use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://cloudkms.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

KeyManagementService holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap KeyManagementService in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl KeyManagementService

pub fn builder() -> ClientBuilder

Returns a builder for KeyManagementService.

let client = KeyManagementService::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: KeyManagementService + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn list_key_rings(&self) -> ListKeyRings

Lists KeyRings.

pub fn list_crypto_keys(&self) -> ListCryptoKeys

Lists CryptoKeys.

pub fn list_crypto_key_versions(&self) -> ListCryptoKeyVersions

Lists CryptoKeyVersions.

pub fn list_import_jobs(&self) -> ListImportJobs

Lists ImportJobs.

pub fn get_key_ring(&self) -> GetKeyRing

Returns metadata for a given KeyRing.

pub fn get_crypto_key(&self) -> GetCryptoKey

Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion.

pub fn get_crypto_key_version(&self) -> GetCryptoKeyVersion

Returns metadata for a given CryptoKeyVersion.

pub fn get_public_key(&self) -> GetPublicKey

Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.

pub fn get_import_job(&self) -> GetImportJob

Returns metadata for a given ImportJob.

pub fn create_key_ring(&self) -> CreateKeyRing

Create a new KeyRing in a given Project and Location.

pub fn create_crypto_key(&self) -> CreateCryptoKey

Create a new CryptoKey within a KeyRing.

CryptoKey.purpose and CryptoKey.version_template.algorithm are required.

pub fn create_crypto_key_version(&self) -> CreateCryptoKeyVersion

Create a new CryptoKeyVersion in a CryptoKey.

The server will assign the next sequential id. If unset, state will be set to ENABLED.

pub fn import_crypto_key_version(&self) -> ImportCryptoKeyVersion

Import wrapped key material into a CryptoKeyVersion.

All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey.

pub fn create_import_job(&self) -> CreateImportJob

Create a new ImportJob within a KeyRing.

ImportJob.import_method is required.

pub fn update_crypto_key(&self) -> UpdateCryptoKey

Update a CryptoKey.

pub fn update_crypto_key_version(&self) -> UpdateCryptoKeyVersion

Update a CryptoKeyVersion’s metadata.

state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states.

pub fn update_crypto_key_primary_version(&self) -> UpdateCryptoKeyPrimaryVersion

Update the version of a CryptoKey that will be used in Encrypt.

Returns an error if called on a key whose purpose is not ENCRYPT_DECRYPT.

pub fn destroy_crypto_key_version(&self) -> DestroyCryptoKeyVersion

Schedule a CryptoKeyVersion for destruction.

Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed.

Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.

pub fn restore_crypto_key_version(&self) -> RestoreCryptoKeyVersion

Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state.

Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared.

pub fn encrypt(&self) -> Encrypt

Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.

pub fn decrypt(&self) -> Decrypt

Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.

pub fn raw_encrypt(&self) -> RawEncrypt

Encrypts data using portable cryptographic primitives. Most users should choose Encrypt and Decrypt rather than their raw counterparts. The CryptoKey.purpose must be RAW_ENCRYPT_DECRYPT.

pub fn raw_decrypt(&self) -> RawDecrypt

Decrypts data that was originally encrypted using a raw cryptographic mechanism. The CryptoKey.purpose must be RAW_ENCRYPT_DECRYPT.

pub fn asymmetric_sign(&self) -> AsymmetricSign

Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.

pub fn asymmetric_decrypt(&self) -> AsymmetricDecrypt

Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.

pub fn mac_sign(&self) -> MacSign

Signs data using a CryptoKeyVersion with CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key.

pub fn mac_verify(&self) -> MacVerify

Verifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful.

pub fn decapsulate(&self) -> Decapsulate

Decapsulates data that was encapsulated with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose KEY_ENCAPSULATION.

pub fn generate_random_bytes(&self) -> GenerateRandomBytes

Generate random bytes using the Cloud KMS randomness source in the provided location.

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

pub fn set_iam_policy(&self) -> SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

pub fn get_iam_policy(&self) -> GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

pub fn test_iam_permissions(&self) -> TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for KeyManagementService

fn clone(&self) -> KeyManagementService

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KeyManagementService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.