com.google.crypto.tink

Class CleartextKeysetHandle

java.lang.Object

com.google.crypto.tink.CleartextKeysetHandle

public final class CleartextKeysetHandle
extends Object

Static methods for reading or writing cleartext keysets.

WARNING

Reading or writing cleartext keysets is a bad practice, usage of this API should be restricted. Users can read encrypted keysets using KeysetHandle.read(com.google.crypto.tink.KeysetReader, com.google.crypto.tink.Aead).

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
static KeysetHandle	fromKeyset(Keyset keyset) Returns a KeysetHandle for keyset.
static Keyset	getKeyset(KeysetHandle keysetHandle)
static KeysetHandle	parseFrom(byte[] serialized) Deprecated. use read(com.google.crypto.tink.KeysetReader) instead
static KeysetHandle	read(KeysetReader reader)
static KeysetHandle	read(KeysetReader reader, Map<String,String> monitoringAnnotations) Creates a KeysetHandle from a KeysetReader.
static void	write(KeysetHandle handle, KeysetWriter keysetWriter) Serializes and writes the Keyset managed by handle to keysetWriter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

parseFrom

@Deprecated
public static final KeysetHandle parseFrom(byte[] serialized)
                                                throws GeneralSecurityException

Deprecated. use read(com.google.crypto.tink.KeysetReader) instead

Returns:

a new KeysetHandle from serialized that is a serialized Keyset

Throws:

GeneralSecurityException

read

public static KeysetHandle read(KeysetReader reader)
                         throws GeneralSecurityException,
                                IOException

Returns:

a new KeysetHandle from a Keyset read with reader.

Throws:

GeneralSecurityException - when the keyset is invalid or can't be read.

IOException

read

@Alpha
public static KeysetHandle read(KeysetReader reader,
                                       Map<String,String> monitoringAnnotations)
                                throws GeneralSecurityException,
                                       IOException

Creates a KeysetHandle from a KeysetReader.

The additional monitoringAnnotations are used for monitoring, and will be passed to the MonitoringClient.

Throws:

GeneralSecurityException - when the keyset is invalid or cannot be read.

IOException

getKeyset

public static Keyset getKeyset(KeysetHandle keysetHandle)

Returns:

the keyset underlying this keysetHandle.

fromKeyset

public static KeysetHandle fromKeyset(Keyset keyset)
                               throws GeneralSecurityException

Returns a KeysetHandle for keyset.

Throws:

GeneralSecurityException

write

public static void write(KeysetHandle handle,
                         KeysetWriter keysetWriter)
                  throws IOException

Serializes and writes the Keyset managed by handle to keysetWriter.

Throws:

IOException