Package com.google.crypto.tink

Class ProtoKeySerialization

java.lang.Object

com.google.crypto.tink.ProtoKeySerialization

@Immutable
public final class ProtoKeySerialization
extends java.lang.Object

A representation of a Key object, prepared for the Tink proto keyset format.

ProtoKeySerialization objects fully describe a Key object, but they are such that the TinkProtoKeysetFormat can be easily obtained from it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProtoKeySerialization.KeyMaterialType	An enum describing the key material type.
static class	ProtoKeySerialization.OutputPrefixType	An enum describing the how to prefix signatures and ciphertexts.

Method Summary

Modifier and Type	Method	Description
static ProtoKeySerialization	create(java.lang.String typeUrl, com.google.protobuf.ByteString value, ProtoKeySerialization.KeyMaterialType keyMaterialType, ProtoKeySerialization.OutputPrefixType outputPrefixType, java.lang.Integer idRequirement)	Creates new ProtoKeySerialization objects.
java.lang.Integer	getIdRequirementOrNull()
ProtoKeySerialization.KeyMaterialType	getKeyMaterialType()
ProtoKeySerialization.OutputPrefixType	getOutputPrefixType()
java.lang.String	getTypeUrl()
com.google.protobuf.ByteString	getValue()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ProtoKeySerialization create(java.lang.String typeUrl,
                                           com.google.protobuf.ByteString value,
                                           ProtoKeySerialization.KeyMaterialType keyMaterialType,
                                           ProtoKeySerialization.OutputPrefixType outputPrefixType,
                                           @Nullable
                                           java.lang.Integer idRequirement)
                                    throws java.security.GeneralSecurityException

Creates new ProtoKeySerialization objects.

Throws an exception if (idRequirement == null) != (outputPrefixType == RAW) or if typeUrl does not consist entirely of ASCII characters.

Throws:

java.security.GeneralSecurityException

getTypeUrl

public java.lang.String getTypeUrl()

getValue

public com.google.protobuf.ByteString getValue()

getKeyMaterialType

public ProtoKeySerialization.KeyMaterialType getKeyMaterialType()

getOutputPrefixType

public ProtoKeySerialization.OutputPrefixType getOutputPrefixType()

getIdRequirementOrNull

@Nullable
public java.lang.Integer getIdRequirementOrNull()