com.google.crypto.tink

Interface KmsClient

All Known Implementing Classes:

AndroidKeystoreKmsClient

public interface KmsClient

A KmsClient knows how to produce primitives backed by keys stored in remote KMS services.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
boolean	doesSupport(String keyUri)
Aead	getAead(String keyUri) Gets an Aead backed by keyUri.
KmsClient	withCredentials(String credentialPath) Loads the credentials in credentialPath.
KmsClient	withDefaultCredentials() Loads the default credentials.

Method Detail

doesSupport

boolean doesSupport(String keyUri)

Returns:

true if this client does support keyUri

withCredentials

KmsClient withCredentials(String credentialPath)
                   throws GeneralSecurityException

Loads the credentials in credentialPath. If credentialPath is null, loads the default credentials.

Throws:

GeneralSecurityException

withDefaultCredentials

KmsClient withDefaultCredentials()
                          throws GeneralSecurityException

Loads the default credentials.

Throws:

GeneralSecurityException

getAead

Aead getAead(String keyUri)
      throws GeneralSecurityException

Gets an Aead backed by keyUri.

Throws:

GeneralSecurityException - if the URI is not supported or invalid