public abstract class Configuration +extends Object+
Configuration objects is to be used at
+ primitive creation time.abstract booleanequalsKey(Key other)
-other.public abstract boolean equalsKey(Key other)-
other.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
| Modifier and Type | Method and Description | ||
|---|---|---|---|
boolean |
-doesSupport(String typeUrl) |
+default boolean |
+doesSupport(String typeUrl)
+Deprecated.
+
+Use
+getKeyType() instead. |
String |
-getKeyType() |
+getKeyType()
+Returns the type URL that identifies the key type of keys managed by this KeyManager.
+ |
|
P |
@@ -152,9 +158,11 @@ |||
P |
+default P |
getPrimitive(com.google.protobuf.MessageLite key)
-Constructs an instance of P for the key given in
+key.Deprecated.
+
Use
+getPrimitive(serializedKey) instead. |
|
int |
-getVersion() |
+default int |
+getVersion()
+Deprecated.
+
+Do not use it.
+ |
com.google.protobuf.MessageLite |
+default com.google.protobuf.MessageLite |
newKey(com.google.protobuf.ByteString serializedKeyFormat)
-Generates a new key according to specification in
+serializedKeyFormat, which must be a
- serialized key format protocol buffer handled by this manager.Deprecated.
+
Use
+newKeyData(serializedKeyFormat) instead. |
|
com.google.protobuf.MessageLite |
+default com.google.protobuf.MessageLite |
newKey(com.google.protobuf.MessageLite keyFormat)
-Generates a new key according to specification in
+keyFormat.Deprecated.
+
Use
+newKeyData(serializedKeyFormat) instead. |
|
KeyData |
newKeyData(com.google.protobuf.ByteString serializedKeyFormat)
-Generates a new
+KeyData according to specification in serializedkeyFormat.Generates a new
KeyData according to specification in serializedKeyFormat. |
P getPrimitive(com.google.protobuf.MessageLite key) - throws GeneralSecurityException+
@Deprecated +default P getPrimitive(com.google.protobuf.MessageLite key) + throws GeneralSecurityException+
getPrimitive(serializedKey) instead.key.
For primitives of type Mac, Aead, PublicKeySign, PublicKeyVerify, DeterministicAead, HybridEncrypt, and HybridDecrypt
- this should be a primitive which ignores the output prefix and assumes "RAW".
This method is not used by Tink. It does not need to be implemented.
com.google.protobuf.MessageLite newKey(com.google.protobuf.ByteString serializedKeyFormat) - throws GeneralSecurityException+
@Deprecated +default com.google.protobuf.MessageLite newKey(com.google.protobuf.ByteString serializedKeyFormat) + throws GeneralSecurityException+
newKeyData(serializedKeyFormat) instead.serializedKeyFormat, which must be a
- serialized key format protocol buffer handled by this manager.This method is not used by Tink anymore. It does not need to be implemented.
com.google.protobuf.MessageLite newKey(com.google.protobuf.MessageLite keyFormat) - throws GeneralSecurityException-
keyFormat.@Deprecated +default com.google.protobuf.MessageLite newKey(com.google.protobuf.MessageLite keyFormat) + throws GeneralSecurityException+
newKeyData(serializedKeyFormat) instead.keyFormat.
+
+ This method is only used by Registry.newKey which is deprecated and not used by Tink
+ anymore. This method does not need to be implemented.
boolean doesSupport(String typeUrl)-
typeUrl.@Deprecated +default boolean doesSupport(String typeUrl)+
getKeyType() instead.typeUrl.
+
+ This method is not used by Tink anymore. It does not need to be implemented.
String getKeyType()-
int getVersion()-
@Deprecated +default int getVersion()+
This method is not used by Tink anymore. It does not need to be implemented.
KeyData newKeyData(com.google.protobuf.ByteString serializedKeyFormat) throws GeneralSecurityException-
KeyData according to specification in serializedkeyFormat.
-
- This should be used solely by KeysetManager.
KeyData according to specification in serializedKeyFormat.| Modifier and Type | Method and Description | @@ -158,16 +158,36 @@|
|---|---|---|
static KeyTemplate |
+createFrom(Parameters p) |
+|
KeyTemplate.OutputPrefixType |
getOutputPrefixType() |
|
String |
-getTypeUrl() |
+getTypeUrl()
+Deprecated.
+
+Instead, operate on the
+Parameters object obtained with toParameters(). If you really need this array, you need to first use
+ TinkProtoParametersFormat to serialize this parameters object, then parse the result with
+ the Tink-internal proto class "KeyTemplate". |
byte[] |
-getValue() |
+getValue()
+Deprecated.
+
+Instead, operate on the
+Parameters object obtained with toParameters(). If you really need this array, you need to first use
+ TinkProtoParametersFormat to serialize this parameters object, then parse the result with
+ the Tink-internal proto class "KeyTemplate". |
+
Parameters |
+toParameters() |
public static KeyTemplate createFrom(Parameters p) + throws GeneralSecurityException+
GeneralSecurityExceptionpublic String getTypeUrl()+
@Deprecated +public String getTypeUrl()+
Parameters object obtained with toParameters(). If you really need this array, you need to first use
+ TinkProtoParametersFormat to serialize this parameters object, then parse the result with
+ the Tink-internal proto class "KeyTemplate".public byte[] getValue()+
@Deprecated +public byte[] getValue()+
Parameters object obtained with toParameters(). If you really need this array, you need to first use
+ TinkProtoParametersFormat to serialize this parameters object, then parse the result with
+ the Tink-internal proto class "KeyTemplate".public KeyTemplate.OutputPrefixType getOutputPrefixType()
public Parameters toParameters() + throws GeneralSecurityException+
GeneralSecurityExceptionbooleanequalsKeyset(KeysetHandle other)
+other, ignoring monitoring annotations.static KeysetHandle.Builder.EntrygenerateEntryFromParameters(Parameters parameters)
static KeysetHandle.Builder.EntrygenerateEntryFromParametersName(String namedParameters)
static KeysetHandlegenerateNew(KeyTemplate keyTemplate)
KeysetHandle that contains a single fresh key generated according to
keyTemplate.static KeysetHandlegenerateNew(KeyTemplate keyTemplate)
KeysetHandle that contains a single fresh key generated according to
keyTemplate.static KeysetHandlegenerateNew(Parameters parameters)
KeysetHandle that contains a single fresh key generated key with the
given Parameters object.KeysetHandle.EntrygetAt(int i)
List<KeyHandle>getKeys()
-KeyHandles.KeysetInfogetKeysetInfo()
KeysetInfo that doesn't contain actual key
material.KeysetHandle.EntrygetPrimary()
<P> PgetPrimitive(Class<P> targetClassObject)
<P> PgetPrimitive(Configuration configuration,
+ Class<P> targetClassObject)
+Configuration to create
+ resources used in creating the primitive.KeysetHandlegetPublicKeysetHandle()
KeysetHandle of the public keys.static KeysetHandle.Builder.EntryimportKey(Key key)
static KeysetHandle.BuildernewBuilder()
static KeysetHandle.BuildernewBuilder(KeysetHandle handle)
handle.KeyHandleprimaryKey()
-KeysetHandle, and returns the key
- wrapped in a KeyHandle.getPrimary() instead.static KeysetHandleread(KeysetReader reader,
Aead masterKey)
KeysetHandle from an encrypted keyset obtained via reader.static KeysetHandlereadNoSecret(byte[] serialized)
KeysetHandle from a serialized keyset which contains no secret key
material.static KeysetHandlereadNoSecret(KeysetReader reader)
KeysetHandle from a keyset, obtained via reader, which
contains no secret key material.static KeysetHandlereadWithAssociatedData(KeysetReader reader,
Aead masterKey,
@@ -300,32 +317,32 @@ Method Summary
using the provided associated data.
intsize()
StringtoString()
KeysetInfo of the managed keyset.voidwrite(KeysetWriter keysetWriter,
Aead masterKey)
masterKey and writes the keyset to outputStream.voidwriteNoSecret(KeysetWriter writer)
writer this keyset which must not contain any secret key material.voidwriteWithAssociatedData(KeysetWriter keysetWriter,
Aead masterKey,
@@ -454,7 +471,12 @@ getAt
entries were inserted when the KeysetHandle was built.
Currently, this may throw "IllegalStateException" in case the status entry of the Key in the
- keyset was wrongly set. In the future, Tink will throw at parsing time in this case.
+ keyset was wrongly set. In this case, we call this KeysetHandle invalid. In the future, Tink
+ will throw at parsing time in this case, and we will not have invalid KeysetHandles.
+
+
If you want to ensure that this does not throw an IllegalStateException, please first
+ re-parse the KeysetHandle: KeysetHandle guaranteedValid =
+ KeysetHandle.newBuilder(maybeInvalidHandle).build(); (This would throw a GeneralSecurityException if the maybeInvalidHandle handle is invalid).
- Throws:
IndexOutOfBoundsException - if i < 0 or i >= size();getAt
-
getKeys
-public List<KeyHandle> getKeys()
+@Deprecated
+public List<KeyHandle> getKeys()
+Deprecated. Use "getAt" instead.
Returns the keyset data as a list of KeyHandles.
- Please do not use this function in new code. Instead, use getAt(int).
+ Please do not use this function in new code. Instead, use getAt(int).
@@ -510,7 +534,16 @@ generateNew
public static final KeysetHandle generateNew(KeyTemplate keyTemplate)
throws GeneralSecurityException
Generates a new KeysetHandle that contains a single fresh key generated according to
- keyTemplate.
+ keyTemplate.
+
+ Please do not use this function. Instead, use generateNew(Parameters).
+
+
For existing usage, try to use refaster
+ https://github.com/tink-crypto/tink-java/tree/main/tools/refaster to replace usage
+ automatically. This will replaces calls KeysetHandle.generateNew(XYZKeyTemplates.ABC);
+ with KeysetHandle.generateNew(PredefinedXYZParameters.ABC); which is a NO-OP.
+
+
If this is not possible, please inline the function in your code.
- Throws:
GeneralSecurityException - if the key template is invalid.generateNew
public static final KeysetHandle generateNew(KeyTemplate keyTemplate)
throws GeneralSecurityException
Generates a new KeysetHandle that contains a single fresh key generated according to
- keyTemplate.
+ keyTemplate.
+
+ Please do not use this function. Instead, inline it: replace calls with generateNew(t) with generateNew(t.toParameters()).
- Throws:
GeneralSecurityException - if the key template is invalid.toString
+
+
+
+
+-
+
getPrimitive
+public <P> P getPrimitive(Configuration configuration,
+ Class<P> targetClassObject)
+ throws GeneralSecurityException
+Returns a primitive from this keyset using the provided Configuration to create
+ resources used in creating the primitive.
+
+- Throws:
+GeneralSecurityException
+
+
@@ -754,21 +806,38 @@ getPrimitive
-
+
-
primaryKey
-public KeyHandle primaryKey()
- throws GeneralSecurityException
+@Deprecated
+public KeyHandle primaryKey()
+ throws GeneralSecurityException
+Deprecated. Use getPrimary() instead.
Searches the keyset to find the primary key of this KeysetHandle, and returns the key
wrapped in a KeyHandle.
- Please do not use this function in new code. Instead, use getPrimary().
+ Please do not use this function in new code. Instead, use getPrimary().
- Throws:
GeneralSecurityException
+
+
+
+
+-
+
equalsKeyset
+public boolean equalsKeyset(KeysetHandle other)
+Returns true if this keyset is equal to other, ignoring monitoring annotations.
+
+ Note: this may return false even if the keysets represent the same set of functions. For
+ example, this can happen if the keys store zero-byte padding of a BigInteger,
+ which are irrelevant to the function computed. Currently, keysets can also be invalid in which
+ case this will return false.
+
+
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/KeysetManager.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/KeysetManager.html
index 5d8b5bdf4..f0f518af9 100644
--- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/KeysetManager.html
+++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/KeysetManager.html
@@ -17,8 +17,8 @@
catch(err) {
}
//-->
-var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":9};
-var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
+var methods = {"i0":42,"i1":42,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":9};
+var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
@@ -132,7 +132,7 @@ Class KeysetManager
Method Summary
-All Methods Static Methods Instance Methods Concrete Methods
+All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type
Method and Description
@@ -140,14 +140,18 @@ Method Summary
KeysetManageradd(KeyHandle keyHandle)
-Adds the input KeyHandle to the existing keyset.
+Deprecated.
+We recommend to use the KeysetHandle.Builder API.
+
KeysetManageradd(KeyHandle keyHandle,
KeyAccess access)
-Adds the input KeyHandle to the existing keyset with OutputPrefixType.TINK.
+Deprecated.
+We recommend to use the KeysetHandle.Builder API.
+
@@ -344,8 +348,10 @@ add
-
add
@CanIgnoreReturnValue
+ @Deprecated
public KeysetManager add(KeyHandle keyHandle)
- throws GeneralSecurityException
+ throws GeneralSecurityException
+Deprecated. We recommend to use the KeysetHandle.Builder API.
Adds the input KeyHandle to the existing keyset. The KeyStatusType and key ID of the
KeyHandle are used as-is in the keyset.
@@ -364,9 +370,11 @@ add
-
add
@CanIgnoreReturnValue
+ @Deprecated
public KeysetManager add(KeyHandle keyHandle,
- KeyAccess access)
- throws GeneralSecurityException
+ KeyAccess access)
+ throws GeneralSecurityException
+Deprecated. We recommend to use the KeysetHandle.Builder API.
Adds the input KeyHandle to the existing keyset with OutputPrefixType.TINK.
- Throws:
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/Parameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/Parameters.html
index d623fec4f..4b3bbf134 100644
--- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/Parameters.html
+++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/Parameters.html
@@ -108,7 +108,7 @@ Class Parameters
-
- Direct Known Subclasses:
-- AeadParameters, DeterministicAeadParameters, HybridParameters, JwtMacParameters, LegacyProtoParameters, MacParameters, PrfParameters, SignatureParameters, StreamingAeadParameters
+- AeadParameters, DeterministicAeadParameters, HybridParameters, JwtMacParameters, JwtSignatureParameters, KeyDerivationParameters, LegacyProtoParameters, MacParameters, PrfParameters, SignatureParameters, StreamingAeadParameters
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/PrimitiveWrapper.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/PrimitiveWrapper.html
index b7d8eb64b..c90fe6a22 100644
--- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/PrimitiveWrapper.html
+++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/PrimitiveWrapper.html
@@ -100,7 +100,7 @@ Interface PrimitiveWrapper&
-
- All Known Implementing Classes:
-- AeadWrapper, ChunkedMacWrapper, DeterministicAeadWrapper, HybridDecryptWrapper, HybridEncryptWrapper, PrfSetWrapper, PublicKeySignWrapper, StreamingAeadWrapper
+- AeadWrapper, ChunkedMacWrapper, DeterministicAeadWrapper, HybridDecryptWrapper, HybridEncryptWrapper, KeysetDeriverWrapper, PrfSetWrapper, PublicKeySignWrapper, StreamingAeadWrapper
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/PrivateKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/PrivateKey.html
index 1b13083f7..b59a03bfa 100644
--- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/PrivateKey.html
+++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/PrivateKey.html
@@ -100,7 +100,7 @@ Interface PrivateKey
-
- All Known Implementing Classes:
-- EcdsaPrivateKey, Ed25519PrivateKey, HybridPrivateKey, RsaSsaPkcs1PrivateKey, SignaturePrivateKey
+- EcdsaPrivateKey, Ed25519PrivateKey, HpkePrivateKey, HybridPrivateKey, JwtEcdsaPrivateKey, JwtSignaturePrivateKey, RsaSsaPkcs1PrivateKey, RsaSsaPssPrivateKey, SignaturePrivateKey
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/PrivilegedRegistry.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/PrivilegedRegistry.html
index cec34dd24..5fa28c7a8 100644
--- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/PrivilegedRegistry.html
+++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/PrivilegedRegistry.html
@@ -17,7 +17,7 @@
catch(err) {
}
//-->
-var methods = {"i0":9,"i1":9};
+var methods = {"i0":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -136,14 +136,8 @@ Method Summary
static KeyDataderiveKey(KeyTemplate keyTemplate,
InputStream randomStream)
-Method to derive a key, using the given , with the randomness as provided
- by the second argument.
-
-
-static com.google.protobuf.MessageLiteparseKeyData(KeyData keyData)
-Returns the key proto in the keyData if a corresponding key type manager was registered.
+Method to derive a key, using the given keyTemplate, with the randomness as provided by
+ the second argument.
@@ -171,14 +165,14 @@ Method Detail
-
+
-
deriveKey
public static KeyData deriveKey(KeyTemplate keyTemplate,
InputStream randomStream)
throws GeneralSecurityException
-Method to derive a key, using the given , with the randomness as provided
- by the second argument.
+Method to derive a key, using the given keyTemplate, with the randomness as provided by
+ the second argument.
This method is on purpose not in the public interface. Calling it twice using different key
templates and the same randomness can completely destroy any security in a system, so we
@@ -191,24 +185,6 @@
deriveKey
-
-
-
-
--
-
parseKeyData
-public static com.google.protobuf.MessageLite parseKeyData(KeyData keyData)
- throws GeneralSecurityException,
- com.google.protobuf.InvalidProtocolBufferException
-Returns the key proto in the keyData if a corresponding key type manager was registered.
- Returns null if the key type was registered with a KeyManager (and not a KeyTypeManager).
-
-- Throws:
-GeneralSecurityExceptioncom.google.protobuf.InvalidProtocolBufferException
-
-
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/Registry.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/Registry.html
index c0020ec26..6c3fd9563 100644
--- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/Registry.html
+++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/Registry.html
@@ -17,7 +17,7 @@
catch(err) {
}
//-->
-var methods = {"i0":41,"i1":41,"i2":9,"i3":41,"i4":9,"i5":41,"i6":9,"i7":41,"i8":9,"i9":41,"i10":9,"i11":41,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9,"i24":41,"i25":41,"i26":9,"i27":9,"i28":9,"i29":9};
+var methods = {"i0":41,"i1":41,"i2":9,"i3":41,"i4":9,"i5":41,"i6":9,"i7":41,"i8":9,"i9":41,"i10":9,"i11":41,"i12":41,"i13":9,"i14":9,"i15":9,"i16":41,"i17":41,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9,"i24":41,"i25":41,"i26":9,"i27":9,"i28":9,"i29":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -202,7 +202,9 @@ Method Summary
static <P> KeyManager<P>getKeyManager(String typeUrl,
- Class<P> primitiveClass) KeyManager for the given typeUrl (if found).
+
static <P> PMethod Summary
getPrimitive(String typeUrl,
com.google.protobuf.MessageLite key)
Deprecated.
-Use getPrimitive(typeUrl, key, P.class) instead.
+Use getPrimitive(typeUrl, serializedKey, P.class) instead.
@@ -267,7 +269,9 @@ Method Summary
getPrimitive(String typeUrl,
com.google.protobuf.MessageLite key,
Class<P> primitiveClass)
-Convenience method for creating a new primitive for the key given in key.
+Deprecated.
+Use getPrimitive(typeUrl, serializedKey, Primitive.class instead.
+
static KeyManager<?>getUntypedKeyManager(String typeUrl) getUntypedKeyManager(String typeUrl)
+KeyManager for the given typeUrl (if found).static List<String>static com.google.protobuf.MessageLitenewKey(KeyTemplate keyTemplate)
-keyTemplate.newKeyData instead.static com.google.protobuf.MessageLitenewKey(String typeUrl,
com.google.protobuf.MessageLite format)
-format.newKeyData instead.public static <P> KeyManager<P> getKeyManager(String typeUrl, Class<P> primitiveClass) throws GeneralSecurityException+
KeyManager for the given typeUrl (if found).KeyManager for the given typeUrl (if found).GeneralSecurityExceptionpublic static KeyManager<?> getUntypedKeyManager(String typeUrl) throws GeneralSecurityException+
KeyManager for the given typeUrl (if found).KeyManager for the given typeUrl (if found).GeneralSecurityExceptionpublic static com.google.protobuf.MessageLite newKey(KeyTemplate keyTemplate) - throws GeneralSecurityException+
@Deprecated +public static com.google.protobuf.MessageLite newKey(KeyTemplate keyTemplate) + throws GeneralSecurityException+
newKeyData instead.keyTemplate.
It looks up a KeyManager identified by keyTemplate.type_url, and calls
@@ -738,9 +748,11 @@
public static com.google.protobuf.MessageLite newKey(String typeUrl, - com.google.protobuf.MessageLite format) - throws GeneralSecurityException+
@Deprecated +public static com.google.protobuf.MessageLite newKey(String typeUrl, + com.google.protobuf.MessageLite format) + throws GeneralSecurityException+
newKeyData instead.format.
It looks up a KeyManager identified by keyTemplate.type_url, and calls
@@ -783,7 +795,7 @@
getPrimitive(typeUrl, key, P.class) instead.getPrimitive(typeUrl, serializedKey, P.class) instead.proto.
It looks up a KeyManager identified by type_url, and calls KeyManager.getPrimitive(com.google.protobuf.ByteString) with key as the parameter.
public static <P> P getPrimitive(String typeUrl, - com.google.protobuf.MessageLite key, - Class<P> primitiveClass) - throws GeneralSecurityException+
@Deprecated +public static <P> P getPrimitive(String typeUrl, + com.google.protobuf.MessageLite key, + Class<P> primitiveClass) + throws GeneralSecurityException+
getPrimitive(typeUrl, serializedKey, Primitive.class instead.key.
It looks up a KeyManager identified by type_url, and calls KeyManager.getPrimitive(com.google.protobuf.ByteString) with key as the parameter.
booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
AesCtrHmacAeadParameters.BuildersetTagSizeBytes(int tagSizeBytes) setIvSizeBytes(int ivSizeBytes)
+AesCtrHmacAeadParameters.BuildersetTagSizeBytes(int tagSizeBytes) AesCtrHmacAeadParameters.BuildersetVariant(AesCtrHmacAeadParameters.Variant variant) @CanIgnoreReturnValue +public AesCtrHmacAeadParameters.Builder setIvSizeBytes(int ivSizeBytes) + throws GeneralSecurityException+
GeneralSecurityExceptionpublic final class AesCtrHmacAeadParameters extends AeadParameters-
AesCtrHmacAeadƒKey.AesCtrHmacAeadKey.intgetTagSizeBytes() getIvSizeBytes() intgetTagSizeBytes() AesCtrHmacAeadParameters.VariantgetVariant()
inthashCode() booleanhasIdRequirement()
StringtoString() public int getTagSizeBytes()
public int getIvSizeBytes()+
booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
| Modifier and Type | Method and Description | @@ -181,6 +181,10 @@
|---|---|
static boolean |
+isSupportedDekKeyType(String dekKeyTypeUrl) |
+
public static boolean isSupportedDekKeyType(String dekKeyTypeUrl)+
booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
class AesCtrHmacAeadParameters
-AesCtrHmacAeadƒKey.AesCtrHmacAeadKey.AesCtrHmacAeadParameters.BuildersetTagSizeBytes(int tagSizeBytes) setIvSizeBytes(int ivSizeBytes)
+AesCtrHmacAeadParameters.BuildersetTagSizeBytes(int tagSizeBytes) AesCtrHmacAeadParameters.BuildersetVariant(AesCtrHmacAeadParameters.Variant variant) AesCtrHmacAeadƒKey.AesCtrHmacAeadKey.AesCtrHmacAeadƒKey.AesCtrHmacAeadKey.class HpkePrivateKey
+class HpkePublicKey
+class HybridParameters
HybridPrivateKey and the corresponding HybridPublicKey excluding the randomly chosen key material.| Modifier and Type | +Class and Description | +
|---|---|
class |
+JwtSignaturePrivateKey
+Represents a key to compute JWT using asymmetric cryptography (i.e., using the
+JwtPublicKeySign interface). |
+
| Class and Description | +
|---|
| Alpha
+ Signifies that a public API (public class, method or field) is subject to incompatible changes,
+ or even removal, in a future release.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static HpkePrivateKey |
+HpkePrivateKey.create(HpkePublicKey publicKey,
+ SecretBytes privateKeyBytes)
+Creates a new HPKE private key.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static JwtEcdsaPrivateKey |
+JwtEcdsaPrivateKey.create(JwtEcdsaPublicKey publicKey,
+ SecretBigInteger privateValue) |
+
RsaSsaPssPrivateKeybuild() RsaSsaPkcs1PrivateKeybuild() EcdsaPrivateKeybuild() static Ed25519PublicKeycreate(Bytes publicKeyBytes) static Ed25519PrivateKeycreate(Ed25519PublicKey publicKey,
SecretBytes privateKeyBytes) | Modifier and Type | +Class and Description | +
|---|---|
class |
+PrfAesCmac
+An implementation of CMAC following RFC 4493.
+ |
+
class |
+PrfHmacJce
+Prf implementation using JCE. |
+
class |
+PrfMac
+Class that provides the functionality expressed by the Mac primitive using a Prf implementation.
+ |
+
| Package | +Description | +
|---|---|
| com.google.crypto.tink | ++ |
| com.google.crypto.tink.internal | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
<P> P |
+KeysetHandle.getPrimitive(Configuration configuration,
+ Class<P> targetClassObject)
+Returns a primitive from this keyset using the provided
+Configuration to create
+ resources used in creating the primitive. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+InternalConfiguration
+Abstract class representing the real configuration API, i.e.
+ |
+
class |
+RegistryConfiguration
+Represents the configuration as currently specified by the registry.
+ |
+
abstract booleanequalsKey(Key other)
-other.class EciesPublicKey
+class HpkePrivateKey
+class HpkePublicKey
+class HybridPrivateKey
class HybridPublicKey
booleanequalsKey(Key o) booleanequalsKey(Key o) booleanequalsKey(Key o) <P> PgetPrimitive(Key key,
+ Class<P> primitiveClass) abstract <P> PgetPrimitive(Key key,
+ Class<P> primitiveClass)
+class JwtEcdsaPrivateKey
+class JwtEcdsaPublicKey
+class JwtHmacKey
class JwtSignaturePrivateKey
+JwtPublicKeySign interface).class JwtSignaturePublicKey
+JwtPublicKeyVerify interface).JwtHmacKey.equalsKey(Key o) |
+|
boolean |
+JwtEcdsaPublicKey.equalsKey(Key o) |
+
boolean |
+JwtEcdsaPrivateKey.equalsKey(Key o) |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+KeyDerivationKey
+Represents a function to derive a key.
+ |
+
class |
+PrfBasedKeyDerivationKey
+Represents a Derivation key which is based on a PRF.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+PrfBasedKeyDerivationKey.equalsKey(Key other) |
+
booleanequalsKey(Key o) equalsKey(Key o) booleanequalsKey(Key o) equalsKey(Key o) booleanequalsKey(Key o) equalsKey(Key o) class RsaSsaPssPrivateKey
+class RsaSsaPssPublicKey
+class SignaturePrivateKey
SignaturePrivateKey represents a digital signature primitive, which consists of a sign
and a verify function.booleanequalsKey(Key o) booleanequalsKey(Key o) booleanequalsKey(Key o) static <P> KeyManager<P>getKeyManager(String typeUrl,
- Class<P> primitiveClass) KeyManager for the given typeUrl (if found).KeyManager<P>static KeyManager<?>getUntypedKeyManager(String typeUrl) getUntypedKeyManager(String typeUrl)
+KeyManager for the given typeUrl (if found).static KeyTemplate.OutputPrefixTypegetOutputPrefixType(KeyTemplate t) static KeyTemplate.OutputPrefixTypeprefixFromProto(OutputPrefixType outputPrefixType) static KeyTemplatecreateFrom(Parameters p) static KeyTemplateget(String name)
Registry as name.static KeyTemplate.OutputPrefixTypegetOutputPrefixType(KeyTemplate t) static byte[]toByteArray(KeyTemplate keyTemplate) static KeyTemplatetoProto(KeyTemplate keyTemplate) booleanequalsKeyset(KeysetHandle other)
+other, ignoring monitoring annotations.static KeysetgetKeyset(KeysetHandle keysetHandle) static KeysetHandle.BuildernewBuilder(KeysetHandle handle)
handle.static byte[]serializeEncryptedKeyset(KeysetHandle keysetHandle,
Aead keysetEncryptionAead,
byte[] associatedData) static StringserializeEncryptedKeyset(KeysetHandle keysetHandle,
Aead keysetEncryptionAead,
byte[] associatedData) static byte[]serializeKeyset(KeysetHandle keysetHandle,
SecretKeyAccess access) static StringserializeKeyset(KeysetHandle keysetHandle,
SecretKeyAccess access) static byte[]serializeKeysetWithoutSecret(KeysetHandle keysetHandle) static StringserializeKeysetWithoutSecret(KeysetHandle keysetHandle) static KeysetManagerwithKeysetHandle(KeysetHandle val) static voidwrite(KeysetHandle handle,
KeysetWriter keysetWriter)
@@ -492,6 +506,42 @@ | Modifier and Type | +Method and Description | +
|---|---|
KeysetHandle |
+KeysetDeriver.deriveKeyset(byte[] salt) |
+
| Modifier and Type | +Method and Description | +
|---|---|
KeysetHandle |
+PrfBasedDeriver.deriveKeyset(byte[] salt) |
+
KeysetManageradd(KeyHandle keyHandle)
-KeyHandle to the existing keyset.KeysetHandle.Builder API.KeysetManageradd(KeyHandle keyHandle,
KeyAccess access)
-KeyHandle to the existing keyset with OutputPrefixType.TINK.KeysetHandle.Builder API.class SharedPrefKeysetWriter
-KeysetWriter that can write keysets to private shared preferences on Android.static Maccreate(AesCmacKey key)
+Mac interface using an AesCmac underneath.static Maccreate(HmacKey key)
+Mac interface using an Hmac underneath.| com.google.crypto.tink.mac | +com.google.crypto.tink.keyderivation | |
| com.google.crypto.tink.prf | +com.google.crypto.tink.mac | |
| com.google.crypto.tink.signature | +com.google.crypto.tink.prf | |
| com.google.crypto.tink.signature | ++ | |
| com.google.crypto.tink.streamingaead | ||
Parameters |
+KeyTemplate.toParameters() |
+
| Modifier and Type | +Method and Description | +
|---|---|
Parameters |
+EciesParameters.getDemParameters() |
+
| Modifier and Type | +Method and Description | +
|---|---|
EciesParameters.Builder |
+EciesParameters.Builder.setDemParameters(Parameters demParameters)
+Current implementation only accepts NO_PREFIX instances of an AesGcmParameters,
+ AesCtrHmacAeadParameters, XChaCha20Poly1305Parameters or AesSivParameters.
+ |
+
class JwtEcdsaParameters
+JwtEcdsaPrivateKey or a JwtEcdsaPublicKey.class JwtHmacParameters
JwtHmacKey.class JwtMacParameters
JwtMacKey excluding the randomly chosen key material.class JwtSignatureParameters
+JwtSignatureKey excluding the randomly chosen key material.| Modifier and Type | +Class and Description | +
|---|---|
class |
+KeyDerivationParameters
+The public part of a
+KeyDerivationKey. |
+
class |
+PrfBasedKeyDerivationParameters
+Represents the parameters needed in a
+PrfBasedKeyDerivationKey. |
+
| Modifier and Type | +Method and Description | +
|---|---|
Parameters |
+PrfBasedKeyDerivationParameters.getDerivedKeyParameters()
+The parameters of the keys which are in the result keyset when the user calls
+KeysetDeriver.deriveKeyset(). |
+
abstract Parameters |
+KeyDerivationParameters.getDerivedKeyParameters() |
+
| Modifier and Type | +Method and Description | +
|---|---|
PrfBasedKeyDerivationParameters.Builder |
+PrfBasedKeyDerivationParameters.Builder.setDerivedKeyParameters(Parameters derivedKeyParameters)
+The parameters of the keys which are in the result keyset when the user calls
+KeysetDeriver.deriveKeyset(). |
+
class RsaSsaPssParameters
+RsaSsaPssPublicKey and RsaSsaPssPrivateKey.class SignatureParameters
SignaturePrivateKey and the coresponding SignaturePublicKey excluding the randomly chosen key material.getMonitoringKeysetInfo(PrimitiveSet<P> primitiveSet)
<B,P> Pwrap(PrimitiveSet<B> primitiveSet,
+ Class<P> clazz) abstract <B,P> Pwrap(PrimitiveSet<B> primitiveSet,
+ Class<P> clazz)
+<InputPrimitiveT,WrapperPrimitiveT>
WrapperPrimitiveTwrap(PrimitiveSet<InputPrimitiveT> primitives,
Class<WrapperPrimitiveT> wrapperClassObject) | Modifier and Type | +Method and Description | +
|---|---|
KeysetDeriver |
+KeysetDeriverWrapper.wrap(PrimitiveSet<KeysetDeriver> primitiveSet) |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+KeysetDeriverWrapper
+KeysetDeriverWrapper is the implementation of PrimitiveWrapper for the KeysetDeriver primitive.
+ |
+
class HpkePrivateKey
+class HybridPrivateKey
| Modifier and Type | +Class and Description | +
|---|---|
class |
+JwtEcdsaPrivateKey
+Represents a key for computing JWT ECDSA signatures (ES256, ES384, ES512).
+ |
+
class |
+JwtSignaturePrivateKey
+Represents a key to compute JWT using asymmetric cryptography (i.e., using the
+JwtPublicKeySign interface). |
+
class RsaSsaPssPrivateKey
+class SignaturePrivateKey
SignaturePrivateKey represents a digital signature primitive, which consists of a sign
and a verify function.static TinkFipsUtil.AlgorithmFipsCompatibilityFIPS FIPS static TinkFipsUtil.AlgorithmFipsCompatibilityFIPS FIPS static TinkFipsUtil.AlgorithmFipsCompatibilityFIPS FIPS static TinkFipsUtil.AlgorithmFipsCompatibilitybooleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
For more information on how to obtain and use instances of DeterministicAead, see KeysetHandle.getPrimitive(java.lang.Class<P>).
For more information on how to obtain and use instances of DeterministicAead, see KeysetHandle.getPrimitive(com.google.crypto.tink.Configuration, java.lang.Class<P>).
PredefinedDeterministicAeadParameters instead.public final class DeterministicAeadKeyTemplates +@Deprecated +public final class DeterministicAeadKeyTemplates extends ObjectPre-generatedKeyTemplateforDeterministicAeadkeys. @@ -126,9 +130,8 @@Class Deterministi
Instead, we recommend to use
KeysetHandle.generateEntryFromParametersNameorKeysetHandle.generateEntryFromParameters. - One can use these templates - to generate newKeysetwithKeysetHandle. To generate a new keyset that contains - a singleAesSivKey, one can do: +One can use these templates to generate new
KeysetwithKeysetHandle. To + generate a new keyset that contains a singleAesSivKey, one can do:Config.register(DeterministicAeadConfig.TINK_1_1_0); @@ -160,6 +163,7 @@Field Summary
@@ -173,14 +177,16 @@ static KeyTemplateAES256_SIV+Deprecated.AKeyTemplatethat generates new instances ofAesSivKeywith a 64-byte key.Field Summary
Method Summary
-
All Methods Static Methods Concrete Methods +All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method and Description - static KeyTemplate+ createAesSivKeyTemplate(int keySize)createAesSivKeyTemplate(int keySize)+Deprecated.+@@ -211,6 +217,7 @@
@@ -229,6 +236,7 @@Field Detail
AES256_SIV
public static final KeyTemplate AES256_SIV+Deprecated.AKeyTemplatethat generates new instances ofAesSivKeywith a 64-byte key.Method Detail
createAesSivKeyTemplate
public static KeyTemplate createAesSivKeyTemplate(int keySize)+Deprecated.
- Returns:
- a
KeyTemplatecontaining aAesSivKeyFormatwith some specified diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/daead/package-summary.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/daead/package-summary.html index f51d1446b..476f737d1 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/daead/package-summary.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/daead/package-summary.html @@ -141,8 +141,8 @@Package com.google.crypto.tink.daead
KeyTemplate for DeterministicAead keys.PredefinedDeterministicAeadParameters instead.public static final class EciesParameters.Builder +extends Object+
EciesParameters instance.| Modifier and Type | +Method and Description | +
|---|---|
EciesParameters |
+build() |
+
EciesParameters.Builder |
+setCurveType(EciesParameters.CurveType curveType) |
+
EciesParameters.Builder |
+setDemParameters(Parameters demParameters)
+Current implementation only accepts NO_PREFIX instances of an AesGcmParameters,
+ AesCtrHmacAeadParameters, XChaCha20Poly1305Parameters or AesSivParameters.
+ |
+
EciesParameters.Builder |
+setHashType(EciesParameters.HashType hashType) |
+
EciesParameters.Builder |
+setPointFormat(EciesParameters.PointFormat pointFormat) |
+
EciesParameters.Builder |
+setSalt(Bytes salt)
+Defaults to null if not set.
+ |
+
EciesParameters.Builder |
+setVariant(EciesParameters.Variant variant) |
+
@CanIgnoreReturnValue +public EciesParameters.Builder setCurveType(EciesParameters.CurveType curveType)+
@CanIgnoreReturnValue +public EciesParameters.Builder setHashType(EciesParameters.HashType hashType)+
@CanIgnoreReturnValue +public EciesParameters.Builder setPointFormat(EciesParameters.PointFormat pointFormat)+
@CanIgnoreReturnValue +public EciesParameters.Builder setDemParameters(Parameters demParameters) + throws InvalidAlgorithmParameterException+
InvalidAlgorithmParameterException@CanIgnoreReturnValue +public EciesParameters.Builder setVariant(EciesParameters.Variant variant)+
@CanIgnoreReturnValue +public EciesParameters.Builder setSalt(Bytes salt)+
public EciesParameters build() + throws GeneralSecurityException+
GeneralSecurityException@Immutable +public static final class EciesParameters.CurveType +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
static EciesParameters.CurveType |
+NIST_P256 |
+
static EciesParameters.CurveType |
+NIST_P384 |
+
static EciesParameters.CurveType |
+NIST_P521 |
+
static EciesParameters.CurveType |
+X25519 |
+
public static final EciesParameters.CurveType NIST_P256+
public static final EciesParameters.CurveType NIST_P384+
public static final EciesParameters.CurveType NIST_P521+
public static final EciesParameters.CurveType X25519+
@Immutable +public static final class EciesParameters.HashType +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
static EciesParameters.HashType |
+SHA1 |
+
static EciesParameters.HashType |
+SHA224 |
+
static EciesParameters.HashType |
+SHA256 |
+
static EciesParameters.HashType |
+SHA384 |
+
static EciesParameters.HashType |
+SHA512 |
+
public static final EciesParameters.HashType SHA1+
public static final EciesParameters.HashType SHA224+
public static final EciesParameters.HashType SHA256+
public static final EciesParameters.HashType SHA384+
public static final EciesParameters.HashType SHA512+
@Immutable +public static final class EciesParameters.PointFormat +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
static EciesParameters.PointFormat |
+COMPRESSED |
+
static EciesParameters.PointFormat |
+LEGACY_UNCOMPRESSED
+Like
+UNCOMPRESSED, but without the \x04 prefix. |
+
static EciesParameters.PointFormat |
+UNCOMPRESSED |
+
public static final EciesParameters.PointFormat COMPRESSED+
public static final EciesParameters.PointFormat UNCOMPRESSED+
public static final EciesParameters.PointFormat LEGACY_UNCOMPRESSED+
UNCOMPRESSED, but without the \x04 prefix. Crunchy uses this format. DO NOT USE
+ unless you are a Crunchy user moving to Tink.@Immutable +public static final class EciesParameters.Variant +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
static EciesParameters.Variant |
+CRUNCHY
+Leading 0x00-byte followed by 4-byte key id (big endian format).
+ |
+
static EciesParameters.Variant |
+NO_PREFIX
+Empty prefix.
+ |
+
static EciesParameters.Variant |
+TINK
+Leading 0x01-byte followed by 4-byte key id (big endian format).
+ |
+
public static final EciesParameters.Variant TINK+
public static final EciesParameters.Variant CRUNCHY+
public static final EciesParameters.Variant NO_PREFIX+
public final class EciesParameters +extends HybridParameters+
This API follows loosely ECIES ISO 18033-2 standard (Elliptic Curve Integrated Encryption + Scheme, see http://www.shoup.net/iso/std6.pdf), but with some differences: + +
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+EciesParameters.Builder
+Builds a new
+EciesParameters instance. |
+
static class |
+EciesParameters.CurveType
+The elliptic curve type used for the KEM.
+ |
+
static class |
+EciesParameters.HashType
+The Hash algorithm used for the KEM.
+ |
+
static class |
+EciesParameters.PointFormat
+The Elliptic Curve Point Format.
+ |
+
static class |
+EciesParameters.Variant
+Description of the output prefix prepended to the ciphertext.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static EciesParameters.Builder |
+builder() |
+
boolean |
+equals(Object o) |
+
EciesParameters.CurveType |
+getCurveType() |
+
Parameters |
+getDemParameters() |
+
EciesParameters.HashType |
+getHashType() |
+
EciesParameters.PointFormat |
+getPointFormat() |
+
Bytes |
+getSalt()
+Gets the salt value, which defaults to null if not set.
+ |
+
EciesParameters.Variant |
+getVariant() |
+
int |
+hashCode() |
+
boolean |
+hasIdRequirement()
+Returns true if a key created with the parameters in this object has to have a certain ID when
+ it is in a keyset.
+ |
+
String |
+toString() |
+
public static EciesParameters.Builder builder()+
public EciesParameters.CurveType getCurveType()+
public EciesParameters.HashType getHashType()+
public EciesParameters.PointFormat getPointFormat()+
public Parameters getDemParameters()+
public EciesParameters.Variant getVariant()+
@Nullable +public Bytes getSalt()+
This class does not store an RFC compliant default value and the converion must be done in + the implementation (meaning that a null salt must be converted to a string of zeros that is of + the length of the hash function output, as per RFC 5869).
public boolean hasIdRequirement()+
ParametersIn Tink, certain keys change their behavior depending on the key id (for example, an Aead object can prefix the ciphertext with the big endian encoding of the key id). If this is
+ the case, such a key should require a unique id in Key.getIdRequirementOrNull() and
+ return true here.
hasIdRequirement in class Parameters@Immutable +public final class EciesPublicKey +extends HybridPublicKey+
| Modifier and Type | +Method and Description | +
|---|---|
static EciesPublicKey |
+create(EciesParameters parameters,
+ Bytes publicPointBytes,
+ Integer idRequirement)
+Creates a new ECIES public key.
+ |
+
boolean |
+equalsKey(Key o)
+Returns true if the key is guaranteed to be equal to
+other. |
+
Integer |
+getIdRequirementOrNull()
+Returns null if this key has no id requirement, otherwise the required id.
+ |
+
Bytes |
+getOutputPrefix()
+Returns a
+Bytes instance, which is prefixed to every ciphertext. |
+
EciesParameters |
+getParameters()
+Returns a
+Parameters object containing all the information about the key which is not
+ randomly chosen. |
+
Bytes |
+getPublicPointBytes()
+Returns the underlying public point coordinates as
+Bytes, using the
+ Octet-String-to-Elliptic-Curve-Point conversion according to https://secg.org/sec1-v2.pdf (for
+ the NIST curves). |
+
public static EciesPublicKey create(EciesParameters parameters, + Bytes publicPointBytes, + @Nullable + Integer idRequirement) + throws GeneralSecurityException+
parameters - ECIES parameters for the public keypublicPointBytes - public point coordinates in bytes. For the NIST curves, the public
+ point is encoded using the Elliptic-Curve-Point-to-Octet-String conversion according to
+ https://secg.org/sec1-v2.pdf. For X25519, the encoding is just the identity function, since
+ these curves already use fixed-length byte strings for public keys.idRequirement - key id requirement, which must be null for NO_PREFIX variant and
+ non-null for all other variantsGeneralSecurityExceptionpublic Bytes getPublicPointBytes()+
Bytes, using the
+ Octet-String-to-Elliptic-Curve-Point conversion according to https://secg.org/sec1-v2.pdf (for
+ the NIST curves). For X25519, the decoding is just the identity function.public Bytes getOutputPrefix()+
HybridPublicKeyBytes instance, which is prefixed to every ciphertext.getOutputPrefix in class HybridPublicKeypublic EciesParameters getParameters()+
KeyParameters object containing all the information about the key which is not
+ randomly chosen.
+
+ Implementations need to ensure that getParameters().hasIdRequirement() returns true
+ if and only if getIdRequirementOrNull is non-null.
getParameters in class HybridPublicKey@Nullable +public Integer getIdRequirementOrNull()+
KeySome keys, when they are in a keyset, are required to have a certain ID to work properly.
+ This comes from the fact that Tink in some cases prefixes ciphertexts or signatures with the
+ string 0x01<id>, where the ID is encoded in big endian (see the documentation of the
+ key type for details), in which case the key requires a certain ID.
getIdRequirementOrNull in class Keypublic boolean equalsKey(Key o)+
Keyother.
+
+ Implementations are required to do this in constant time. + +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. + +
Note: Tink Key objects should typically not override hashCode (because it
+ could risk leaking key material). Hence, they typically also should not override equals.
@Immutable +public static final class HpkeParameters.AeadId +extends Object+
See https://www.rfc-editor.org/rfc/rfc9180.html#section-7.3.
| Modifier and Type | +Field and Description | +
|---|---|
static HpkeParameters.AeadId |
+AES_128_GCM |
+
static HpkeParameters.AeadId |
+AES_256_GCM |
+
static HpkeParameters.AeadId |
+CHACHA20_POLY1305 |
+
public static final HpkeParameters.AeadId AES_128_GCM+
public static final HpkeParameters.AeadId AES_256_GCM+
public static final HpkeParameters.AeadId CHACHA20_POLY1305+
public static final class HpkeParameters.Builder +extends Object+
HpkeParameters instance.| Modifier and Type | +Method and Description | +
|---|---|
HpkeParameters |
+build() |
+
HpkeParameters.Builder |
+setAeadId(HpkeParameters.AeadId aead) |
+
HpkeParameters.Builder |
+setKdfId(HpkeParameters.KdfId kdf) |
+
HpkeParameters.Builder |
+setKemId(HpkeParameters.KemId kem) |
+
HpkeParameters.Builder |
+setVariant(HpkeParameters.Variant variant) |
+
@CanIgnoreReturnValue +public HpkeParameters.Builder setKemId(HpkeParameters.KemId kem)+
@CanIgnoreReturnValue +public HpkeParameters.Builder setKdfId(HpkeParameters.KdfId kdf)+
@CanIgnoreReturnValue +public HpkeParameters.Builder setAeadId(HpkeParameters.AeadId aead)+
@CanIgnoreReturnValue +public HpkeParameters.Builder setVariant(HpkeParameters.Variant variant)+
public HpkeParameters build() + throws GeneralSecurityException+
GeneralSecurityException@Immutable +public static final class HpkeParameters.KdfId +extends Object+
See https://www.rfc-editor.org/rfc/rfc9180.html#section-7.2.
| Modifier and Type | +Field and Description | +
|---|---|
static HpkeParameters.KdfId |
+HKDF_SHA256 |
+
static HpkeParameters.KdfId |
+HKDF_SHA384 |
+
static HpkeParameters.KdfId |
+HKDF_SHA512 |
+
public static final HpkeParameters.KdfId HKDF_SHA256+
public static final HpkeParameters.KdfId HKDF_SHA384+
public static final HpkeParameters.KdfId HKDF_SHA512+
@Immutable +public static final class HpkeParameters.KemId +extends Object+
See https://www.rfc-editor.org/rfc/rfc9180.html#section-7.1.
| Modifier and Type | +Field and Description | +
|---|---|
static HpkeParameters.KemId |
+DHKEM_P256_HKDF_SHA256 |
+
static HpkeParameters.KemId |
+DHKEM_P384_HKDF_SHA384 |
+
static HpkeParameters.KemId |
+DHKEM_P521_HKDF_SHA512 |
+
static HpkeParameters.KemId |
+DHKEM_X25519_HKDF_SHA256 |
+
public static final HpkeParameters.KemId DHKEM_P256_HKDF_SHA256+
public static final HpkeParameters.KemId DHKEM_P384_HKDF_SHA384+
public static final HpkeParameters.KemId DHKEM_P521_HKDF_SHA512+
public static final HpkeParameters.KemId DHKEM_X25519_HKDF_SHA256+
@Immutable +public static final class HpkeParameters.Variant +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
static HpkeParameters.Variant |
+CRUNCHY
+CRUNCHY: Leading 0x00-byte followed by 4-byte key id (big endian format). |
+
static HpkeParameters.Variant |
+NO_PREFIX
+NO_PREFIX: Empty prefix. |
+
static HpkeParameters.Variant |
+TINK
+TINK: Leading 0x01-byte followed by 4-byte key id (big endian format). |
+
public static final HpkeParameters.Variant TINK+
TINK: Leading 0x01-byte followed by 4-byte key id (big endian format).public static final HpkeParameters.Variant CRUNCHY+
CRUNCHY: Leading 0x00-byte followed by 4-byte key id (big endian format).public static final HpkeParameters.Variant NO_PREFIX+
NO_PREFIX: Empty prefix.public final class HpkeParameters +extends HybridParameters+
HpkePublicKey or HpkePrivateKey.| Modifier and Type | +Class and Description | +
|---|---|
static class |
+HpkeParameters.AeadId
+HPKE AEAD identifiers.
+ |
+
static class |
+HpkeParameters.Builder
+Builds a new
+HpkeParameters instance. |
+
static class |
+HpkeParameters.KdfId
+HPKE KDF identifiers.
+ |
+
static class |
+HpkeParameters.KemId
+HPKE KEM identifiers.
+ |
+
static class |
+HpkeParameters.Variant
+Description of the output prefix prepended to the ciphertext.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static HpkeParameters.Builder |
+builder() |
+
boolean |
+equals(Object o) |
+
HpkeParameters.AeadId |
+getAeadId() |
+
HpkeParameters.KdfId |
+getKdfId() |
+
HpkeParameters.KemId |
+getKemId() |
+
HpkeParameters.Variant |
+getVariant() |
+
int |
+hashCode() |
+
boolean |
+hasIdRequirement()
+Returns true if a key created with the parameters in this object has to have a certain ID when
+ it is in a keyset.
+ |
+
public static HpkeParameters.Builder builder()+
public HpkeParameters.KemId getKemId()+
public HpkeParameters.KdfId getKdfId()+
public HpkeParameters.AeadId getAeadId()+
public HpkeParameters.Variant getVariant()+
public boolean hasIdRequirement()+
ParametersIn Tink, certain keys change their behavior depending on the key id (for example, an Aead object can prefix the ciphertext with the big endian encoding of the key id). If this is
+ the case, such a key should require a unique id in Key.getIdRequirementOrNull() and
+ return true here.
hasIdRequirement in class Parameters@Alpha + @Immutable +public final class HpkePrivateKey +extends HybridPrivateKey+
| Modifier and Type | +Method and Description | +
|---|---|
static HpkePrivateKey |
+create(HpkePublicKey publicKey,
+ SecretBytes privateKeyBytes)
+Creates a new HPKE private key.
+ |
+
boolean |
+equalsKey(Key o)
+Returns true if the key is guaranteed to be equal to
+other. |
+
HpkeParameters |
+getParameters()
+Returns a
+Parameters object containing all the information about the key which is not
+ randomly chosen. |
+
SecretBytes |
+getPrivateKeyBytes() |
+
HpkePublicKey |
+getPublicKey() |
+
getIdRequirementOrNull, getOutputPrefixpublic static HpkePrivateKey create(HpkePublicKey publicKey, + SecretBytes privateKeyBytes) + throws GeneralSecurityException+
publicKey - Corresponding HPKE public key for this private keyprivateKeyBytes - Private key encoded according to
+ https://www.rfc-editor.org/rfc/rfc9180.html#section-7.1.2GeneralSecurityExceptionpublic SecretBytes getPrivateKeyBytes()+
public HpkeParameters getParameters()+
KeyParameters object containing all the information about the key which is not
+ randomly chosen.
+
+ Implementations need to ensure that getParameters().hasIdRequirement() returns true
+ if and only if getIdRequirementOrNull is non-null.
getParameters in class HybridPrivateKeypublic HpkePublicKey getPublicKey()+
getPublicKey in interface PrivateKeygetPublicKey in class HybridPrivateKeypublic boolean equalsKey(Key o)+
Keyother.
+
+ Implementations are required to do this in constant time. + +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. + +
Note: Tink Key objects should typically not override hashCode (because it
+ could risk leaking key material). Hence, they typically also should not override equals.
@Alpha + @Immutable +public final class HpkePublicKey +extends HybridPublicKey+
| Modifier and Type | +Method and Description | +
|---|---|
static HpkePublicKey |
+create(HpkeParameters parameters,
+ Bytes publicKeyBytes,
+ Integer idRequirement)
+Creates a new HPKE public key.
+ |
+
boolean |
+equalsKey(Key o)
+Returns true if the key is guaranteed to be equal to
+other. |
+
Integer |
+getIdRequirementOrNull()
+Returns null if this key has no id requirement, otherwise the required id.
+ |
+
Bytes |
+getOutputPrefix()
+Returns a
+Bytes instance, which is prefixed to every ciphertext. |
+
HpkeParameters |
+getParameters()
+Returns a
+Parameters object containing all the information about the key which is not
+ randomly chosen. |
+
Bytes |
+getPublicKeyBytes() |
+
public static HpkePublicKey create(HpkeParameters parameters, + Bytes publicKeyBytes, + @Nullable + Integer idRequirement) + throws GeneralSecurityException+
parameters - HPKE parameters for the public keypublicKeyBytes - Public key encoded according to
+ https://www.rfc-editor.org/rfc/rfc9180.html#section-7.1.1idRequirement - Key id requirement, which must be null for NO_PREFIX variant and
+ non-null for all other variantsGeneralSecurityExceptionpublic Bytes getPublicKeyBytes()+
public Bytes getOutputPrefix()+
HybridPublicKeyBytes instance, which is prefixed to every ciphertext.getOutputPrefix in class HybridPublicKeypublic HpkeParameters getParameters()+
KeyParameters object containing all the information about the key which is not
+ randomly chosen.
+
+ Implementations need to ensure that getParameters().hasIdRequirement() returns true
+ if and only if getIdRequirementOrNull is non-null.
getParameters in class HybridPublicKey@Nullable +public Integer getIdRequirementOrNull()+
KeySome keys, when they are in a keyset, are required to have a certain ID to work properly.
+ This comes from the fact that Tink in some cases prefixes ciphertexts or signatures with the
+ string 0x01<id>, where the ID is encoded in big endian (see the documentation of the
+ key type for details), in which case the key requires a certain ID.
getIdRequirementOrNull in class Keypublic boolean equalsKey(Key o)+
Keyother.
+
+ Implementations are required to do this in constant time. + +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. + +
Note: Tink Key objects should typically not override hashCode (because it
+ could risk leaking key material). Hence, they typically also should not override equals.
| Modifier and Type | Method and Description | @@ -224,7 +224,11 @@
|---|---|
static EciesAeadHkdfParams |
@@ -232,7 +236,11 @@
public static KeyTemplate createEciesAeadHkdfKeyTemplate(EllipticCurveType curve, - HashType hashType, - EcPointFormat ecPointFormat, - KeyTemplate demKeyTemplate, - OutputPrefixType outputPrefixType, - byte[] salt)+
@Deprecated +public static KeyTemplate createEciesAeadHkdfKeyTemplate(EllipticCurveType curve, + HashType hashType, + EcPointFormat ecPointFormat, + KeyTemplate demKeyTemplate, + OutputPrefixType outputPrefixType, + byte[] salt)+
KeyTemplate containing a EciesAeadHkdfKeyFormat.public static EciesAeadHkdfParams createEciesAeadHkdfParams(EllipticCurveType curve, - HashType hashType, - EcPointFormat ecPointFormat, - KeyTemplate demKeyTemplate, - byte[] salt)+
@Deprecated +public static EciesAeadHkdfParams createEciesAeadHkdfParams(EllipticCurveType curve, + HashType hashType, + EcPointFormat ecPointFormat, + KeyTemplate demKeyTemplate, + byte[] salt)+
EciesAeadHkdfParams with the specified parameters.@Immutable diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/HybridPrivateKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/HybridPrivateKey.html index a2bfa83c4..664f6d1b0 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/HybridPrivateKey.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/HybridPrivateKey.html @@ -115,6 +115,10 @@Class HybridPrivateKey
@Immutable diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/HybridPublicKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/HybridPublicKey.html index 73badcb52..e8f978849 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/HybridPublicKey.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/HybridPublicKey.html @@ -111,6 +111,10 @@Class HybridPublicKey
- +
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HybridPrivateKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HybridPrivateKey.html index 63b5639aa..89fb0dfeb 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HybridPrivateKey.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HybridPrivateKey.html @@ -71,7 +71,49 @@+
- Direct Known Subclasses:
+- EciesPublicKey, HpkePublicKey
+
@Immutable diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.Builder.html new file mode 100644 index 000000000..396caa97c --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.Builder.html @@ -0,0 +1,192 @@ + + + + + +Uses of Class com.google.crypto.tink.hybrid.EciesParameters.Builder + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.EciesParameters.Builder++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.CurveType.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.CurveType.html new file mode 100644 index 000000000..fc5308207 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.CurveType.html @@ -0,0 +1,201 @@ + + + + + ++
+- +
++
+Packages that use EciesParameters.Builder ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of EciesParameters.Builder in com.google.crypto.tink.hybrid
++
+Methods in com.google.crypto.tink.hybrid that return EciesParameters.Builder ++ + +Modifier and Type +Method and Description ++ ++ static EciesParameters.BuilderEciesParameters. +builder()+ ++ EciesParameters.BuilderEciesParameters.Builder. +setCurveType(EciesParameters.CurveType curveType)+ ++ EciesParameters.BuilderEciesParameters.Builder. +setDemParameters(Parameters demParameters)+Current implementation only accepts NO_PREFIX instances of an AesGcmParameters, + AesCtrHmacAeadParameters, XChaCha20Poly1305Parameters or AesSivParameters.++ ++ EciesParameters.BuilderEciesParameters.Builder. +setHashType(EciesParameters.HashType hashType)+ ++ EciesParameters.BuilderEciesParameters.Builder. +setPointFormat(EciesParameters.PointFormat pointFormat)+ ++ EciesParameters.BuilderEciesParameters.Builder. +setSalt(Bytes salt)+Defaults to null if not set.++ + ++ EciesParameters.BuilderEciesParameters.Builder. +setVariant(EciesParameters.Variant variant)Uses of Class com.google.crypto.tink.hybrid.EciesParameters.CurveType + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.EciesParameters.CurveType++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.HashType.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.HashType.html new file mode 100644 index 000000000..a35ca829b --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.HashType.html @@ -0,0 +1,205 @@ + + + + + ++
+- +
++
+Packages that use EciesParameters.CurveType ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of EciesParameters.CurveType in com.google.crypto.tink.hybrid
++
+Fields in com.google.crypto.tink.hybrid declared as EciesParameters.CurveType ++ + +Modifier and Type +Field and Description ++ ++ static EciesParameters.CurveTypeEciesParameters.CurveType. +NIST_P256+ ++ static EciesParameters.CurveTypeEciesParameters.CurveType. +NIST_P384+ ++ static EciesParameters.CurveTypeEciesParameters.CurveType. +NIST_P521+ + ++ static EciesParameters.CurveTypeEciesParameters.CurveType. +X25519+
+Methods in com.google.crypto.tink.hybrid that return EciesParameters.CurveType ++ + +Modifier and Type +Method and Description ++ + ++ EciesParameters.CurveTypeEciesParameters. +getCurveType()+
+Methods in com.google.crypto.tink.hybrid with parameters of type EciesParameters.CurveType ++ + +Modifier and Type +Method and Description ++ + ++ EciesParameters.BuilderEciesParameters.Builder. +setCurveType(EciesParameters.CurveType curveType)Uses of Class com.google.crypto.tink.hybrid.EciesParameters.HashType + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.EciesParameters.HashType++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.PointFormat.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.PointFormat.html new file mode 100644 index 000000000..2f688c13c --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.PointFormat.html @@ -0,0 +1,199 @@ + + + + + ++
+- +
++
+Packages that use EciesParameters.HashType ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of EciesParameters.HashType in com.google.crypto.tink.hybrid
++
+Fields in com.google.crypto.tink.hybrid declared as EciesParameters.HashType ++ + +Modifier and Type +Field and Description ++ ++ static EciesParameters.HashTypeEciesParameters.HashType. +SHA1+ ++ static EciesParameters.HashTypeEciesParameters.HashType. +SHA224+ ++ static EciesParameters.HashTypeEciesParameters.HashType. +SHA256+ ++ static EciesParameters.HashTypeEciesParameters.HashType. +SHA384+ + ++ static EciesParameters.HashTypeEciesParameters.HashType. +SHA512+
+Methods in com.google.crypto.tink.hybrid that return EciesParameters.HashType ++ + +Modifier and Type +Method and Description ++ + ++ EciesParameters.HashTypeEciesParameters. +getHashType()+
+Methods in com.google.crypto.tink.hybrid with parameters of type EciesParameters.HashType ++ + +Modifier and Type +Method and Description ++ + ++ EciesParameters.BuilderEciesParameters.Builder. +setHashType(EciesParameters.HashType hashType)Uses of Class com.google.crypto.tink.hybrid.EciesParameters.PointFormat + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.EciesParameters.PointFormat++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.Variant.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.Variant.html new file mode 100644 index 000000000..06e932bb4 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.Variant.html @@ -0,0 +1,203 @@ + + + + + ++
+- +
++
+Packages that use EciesParameters.PointFormat ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of EciesParameters.PointFormat in com.google.crypto.tink.hybrid
++
+Fields in com.google.crypto.tink.hybrid declared as EciesParameters.PointFormat ++ + +Modifier and Type +Field and Description ++ ++ static EciesParameters.PointFormatEciesParameters.PointFormat. +COMPRESSED+ ++ static EciesParameters.PointFormatEciesParameters.PointFormat. +LEGACY_UNCOMPRESSED+Like+UNCOMPRESSED, but without the \x04 prefix.+ + ++ static EciesParameters.PointFormatEciesParameters.PointFormat. +UNCOMPRESSED+
+Methods in com.google.crypto.tink.hybrid that return EciesParameters.PointFormat ++ + +Modifier and Type +Method and Description ++ + ++ EciesParameters.PointFormatEciesParameters. +getPointFormat()+
+Methods in com.google.crypto.tink.hybrid with parameters of type EciesParameters.PointFormat ++ + +Modifier and Type +Method and Description ++ + ++ EciesParameters.BuilderEciesParameters.Builder. +setPointFormat(EciesParameters.PointFormat pointFormat)Uses of Class com.google.crypto.tink.hybrid.EciesParameters.Variant + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.EciesParameters.Variant++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.html new file mode 100644 index 000000000..d3cba0b97 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesParameters.html @@ -0,0 +1,184 @@ + + + + + ++
+- +
++
+Packages that use EciesParameters.Variant ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of EciesParameters.Variant in com.google.crypto.tink.hybrid
++
+Fields in com.google.crypto.tink.hybrid declared as EciesParameters.Variant ++ + +Modifier and Type +Field and Description ++ ++ static EciesParameters.VariantEciesParameters.Variant. +CRUNCHY+Leading 0x00-byte followed by 4-byte key id (big endian format).++ ++ static EciesParameters.VariantEciesParameters.Variant. +NO_PREFIX+Empty prefix.++ + ++ static EciesParameters.VariantEciesParameters.Variant. +TINK+Leading 0x01-byte followed by 4-byte key id (big endian format).++
+Methods in com.google.crypto.tink.hybrid that return EciesParameters.Variant ++ + +Modifier and Type +Method and Description ++ + ++ EciesParameters.VariantEciesParameters. +getVariant()+
+Methods in com.google.crypto.tink.hybrid with parameters of type EciesParameters.Variant ++ + +Modifier and Type +Method and Description ++ + ++ EciesParameters.BuilderEciesParameters.Builder. +setVariant(EciesParameters.Variant variant)Uses of Class com.google.crypto.tink.hybrid.EciesParameters + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.EciesParameters++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesPublicKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesPublicKey.html new file mode 100644 index 000000000..f1e4d8a80 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/EciesPublicKey.html @@ -0,0 +1,167 @@ + + + + + ++
+- +
++
+Packages that use EciesParameters ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of EciesParameters in com.google.crypto.tink.hybrid
++
+Methods in com.google.crypto.tink.hybrid that return EciesParameters ++ + +Modifier and Type +Method and Description ++ ++ EciesParametersEciesParameters.Builder. +build()+ + ++ EciesParametersEciesPublicKey. +getParameters()+
+Methods in com.google.crypto.tink.hybrid with parameters of type EciesParameters ++ + +Modifier and Type +Method and Description ++ + ++ static EciesPublicKeyEciesPublicKey. +create(EciesParameters parameters, + Bytes publicPointBytes, + Integer idRequirement)+Creates a new ECIES public key.+Uses of Class com.google.crypto.tink.hybrid.EciesPublicKey + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.EciesPublicKey++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.AeadId.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.AeadId.html new file mode 100644 index 000000000..cfacdaa0c --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.AeadId.html @@ -0,0 +1,197 @@ + + + + + ++
+- +
++
+Packages that use EciesPublicKey ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of EciesPublicKey in com.google.crypto.tink.hybrid
++
+Methods in com.google.crypto.tink.hybrid that return EciesPublicKey ++ + +Modifier and Type +Method and Description ++ + ++ static EciesPublicKeyEciesPublicKey. +create(EciesParameters parameters, + Bytes publicPointBytes, + Integer idRequirement)+Creates a new ECIES public key.+Uses of Class com.google.crypto.tink.hybrid.HpkeParameters.AeadId + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.HpkeParameters.AeadId++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.Builder.html new file mode 100644 index 000000000..e2a410f30 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.Builder.html @@ -0,0 +1,179 @@ + + + + + ++
+- +
++
+Packages that use HpkeParameters.AeadId ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of HpkeParameters.AeadId in com.google.crypto.tink.hybrid
++
+Fields in com.google.crypto.tink.hybrid declared as HpkeParameters.AeadId ++ + +Modifier and Type +Field and Description ++ ++ static HpkeParameters.AeadIdHpkeParameters.AeadId. +AES_128_GCM+ ++ static HpkeParameters.AeadIdHpkeParameters.AeadId. +AES_256_GCM+ + ++ static HpkeParameters.AeadIdHpkeParameters.AeadId. +CHACHA20_POLY1305+
+Methods in com.google.crypto.tink.hybrid that return HpkeParameters.AeadId ++ + +Modifier and Type +Method and Description ++ + ++ HpkeParameters.AeadIdHpkeParameters. +getAeadId()+
+Methods in com.google.crypto.tink.hybrid with parameters of type HpkeParameters.AeadId ++ + +Modifier and Type +Method and Description ++ + ++ HpkeParameters.BuilderHpkeParameters.Builder. +setAeadId(HpkeParameters.AeadId aead)Uses of Class com.google.crypto.tink.hybrid.HpkeParameters.Builder + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.HpkeParameters.Builder++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.KdfId.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.KdfId.html new file mode 100644 index 000000000..1085dff0a --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.KdfId.html @@ -0,0 +1,197 @@ + + + + + ++
+- +
++
+Packages that use HpkeParameters.Builder ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of HpkeParameters.Builder in com.google.crypto.tink.hybrid
++
+Methods in com.google.crypto.tink.hybrid that return HpkeParameters.Builder ++ + +Modifier and Type +Method and Description ++ ++ static HpkeParameters.BuilderHpkeParameters. +builder()+ ++ HpkeParameters.BuilderHpkeParameters.Builder. +setAeadId(HpkeParameters.AeadId aead)+ ++ HpkeParameters.BuilderHpkeParameters.Builder. +setKdfId(HpkeParameters.KdfId kdf)+ ++ HpkeParameters.BuilderHpkeParameters.Builder. +setKemId(HpkeParameters.KemId kem)+ + ++ HpkeParameters.BuilderHpkeParameters.Builder. +setVariant(HpkeParameters.Variant variant)Uses of Class com.google.crypto.tink.hybrid.HpkeParameters.KdfId + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.HpkeParameters.KdfId++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.KemId.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.KemId.html new file mode 100644 index 000000000..30756173e --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.KemId.html @@ -0,0 +1,201 @@ + + + + + ++
+- +
++
+Packages that use HpkeParameters.KdfId ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of HpkeParameters.KdfId in com.google.crypto.tink.hybrid
++
+Fields in com.google.crypto.tink.hybrid declared as HpkeParameters.KdfId ++ + +Modifier and Type +Field and Description ++ ++ static HpkeParameters.KdfIdHpkeParameters.KdfId. +HKDF_SHA256+ ++ static HpkeParameters.KdfIdHpkeParameters.KdfId. +HKDF_SHA384+ + ++ static HpkeParameters.KdfIdHpkeParameters.KdfId. +HKDF_SHA512+
+Methods in com.google.crypto.tink.hybrid that return HpkeParameters.KdfId ++ + +Modifier and Type +Method and Description ++ + ++ HpkeParameters.KdfIdHpkeParameters. +getKdfId()+
+Methods in com.google.crypto.tink.hybrid with parameters of type HpkeParameters.KdfId ++ + +Modifier and Type +Method and Description ++ + ++ HpkeParameters.BuilderHpkeParameters.Builder. +setKdfId(HpkeParameters.KdfId kdf)Uses of Class com.google.crypto.tink.hybrid.HpkeParameters.KemId + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.HpkeParameters.KemId++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.Variant.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.Variant.html new file mode 100644 index 000000000..a9215421c --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.Variant.html @@ -0,0 +1,203 @@ + + + + + ++
+- +
++
+Packages that use HpkeParameters.KemId ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of HpkeParameters.KemId in com.google.crypto.tink.hybrid
++
+Fields in com.google.crypto.tink.hybrid declared as HpkeParameters.KemId ++ + +Modifier and Type +Field and Description ++ ++ static HpkeParameters.KemIdHpkeParameters.KemId. +DHKEM_P256_HKDF_SHA256+ ++ static HpkeParameters.KemIdHpkeParameters.KemId. +DHKEM_P384_HKDF_SHA384+ ++ static HpkeParameters.KemIdHpkeParameters.KemId. +DHKEM_P521_HKDF_SHA512+ + ++ static HpkeParameters.KemIdHpkeParameters.KemId. +DHKEM_X25519_HKDF_SHA256+
+Methods in com.google.crypto.tink.hybrid that return HpkeParameters.KemId ++ + +Modifier and Type +Method and Description ++ + ++ HpkeParameters.KemIdHpkeParameters. +getKemId()+
+Methods in com.google.crypto.tink.hybrid with parameters of type HpkeParameters.KemId ++ + +Modifier and Type +Method and Description ++ + ++ HpkeParameters.BuilderHpkeParameters.Builder. +setKemId(HpkeParameters.KemId kem)Uses of Class com.google.crypto.tink.hybrid.HpkeParameters.Variant + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.HpkeParameters.Variant++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.html new file mode 100644 index 000000000..aa035d4c8 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkeParameters.html @@ -0,0 +1,188 @@ + + + + + ++
+- +
++
+Packages that use HpkeParameters.Variant ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of HpkeParameters.Variant in com.google.crypto.tink.hybrid
++
+Fields in com.google.crypto.tink.hybrid declared as HpkeParameters.Variant ++ + +Modifier and Type +Field and Description ++ ++ static HpkeParameters.VariantHpkeParameters.Variant. +CRUNCHY++CRUNCHY: Leading 0x00-byte followed by 4-byte key id (big endian format).+ ++ static HpkeParameters.VariantHpkeParameters.Variant. +NO_PREFIX++NO_PREFIX: Empty prefix.+ + ++ static HpkeParameters.VariantHpkeParameters.Variant. +TINK++TINK: Leading 0x01-byte followed by 4-byte key id (big endian format).+
+Methods in com.google.crypto.tink.hybrid that return HpkeParameters.Variant ++ + +Modifier and Type +Method and Description ++ + ++ HpkeParameters.VariantHpkeParameters. +getVariant()+
+Methods in com.google.crypto.tink.hybrid with parameters of type HpkeParameters.Variant ++ + +Modifier and Type +Method and Description ++ + ++ HpkeParameters.BuilderHpkeParameters.Builder. +setVariant(HpkeParameters.Variant variant)Uses of Class com.google.crypto.tink.hybrid.HpkeParameters + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.HpkeParameters++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkePrivateKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkePrivateKey.html new file mode 100644 index 000000000..ac29b8d86 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkePrivateKey.html @@ -0,0 +1,166 @@ + + + + + ++
+- +
++
+Packages that use HpkeParameters ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of HpkeParameters in com.google.crypto.tink.hybrid
++
+Methods in com.google.crypto.tink.hybrid that return HpkeParameters ++ + +Modifier and Type +Method and Description ++ ++ HpkeParametersHpkeParameters.Builder. +build()+ ++ HpkeParametersHpkePublicKey. +getParameters()+ + ++ HpkeParametersHpkePrivateKey. +getParameters()+
+Methods in com.google.crypto.tink.hybrid with parameters of type HpkeParameters ++ + +Modifier and Type +Method and Description ++ + ++ static HpkePublicKeyHpkePublicKey. +create(HpkeParameters parameters, + Bytes publicKeyBytes, + Integer idRequirement)+Creates a new HPKE public key.+Uses of Class com.google.crypto.tink.hybrid.HpkePrivateKey + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.HpkePrivateKey++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkePublicKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkePublicKey.html new file mode 100644 index 000000000..220095478 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HpkePublicKey.html @@ -0,0 +1,187 @@ + + + + + ++
+- +
++
+Packages that use HpkePrivateKey ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of HpkePrivateKey in com.google.crypto.tink.hybrid
++
+Methods in com.google.crypto.tink.hybrid that return HpkePrivateKey ++ + +Modifier and Type +Method and Description ++ + ++ static HpkePrivateKeyHpkePrivateKey. +create(HpkePublicKey publicKey, + SecretBytes privateKeyBytes)+Creates a new HPKE private key.+Uses of Class com.google.crypto.tink.hybrid.HpkePublicKey + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.hybrid.HpkePublicKey++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HybridParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HybridParameters.html index 0858661ae..8ce42b317 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HybridParameters.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HybridParameters.html @@ -94,6 +94,27 @@+
+- +
++
+Packages that use HpkePublicKey ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of HpkePublicKey in com.google.crypto.tink.hybrid
++
+Methods in com.google.crypto.tink.hybrid that return HpkePublicKey ++ + +Modifier and Type +Method and Description ++ ++ static HpkePublicKeyHpkePublicKey. +create(HpkeParameters parameters, + Bytes publicKeyBytes, + Integer idRequirement)+Creates a new HPKE public key.++ + ++ HpkePublicKeyHpkePrivateKey. +getPublicKey()+
+Methods in com.google.crypto.tink.hybrid with parameters of type HpkePublicKey ++ + +Modifier and Type +Method and Description ++ + ++ static HpkePrivateKeyHpkePrivateKey. +create(HpkePublicKey publicKey, + SecretBytes privateKeyBytes)+Creates a new HPKE private key.+HybridParameters in com.google.crypto.tink.hybrid +
+
Subclasses of HybridParameters in com.google.crypto.tink.hybrid ++ + +Modifier and Type +Class and Description ++ ++ class+ EciesParameters+Parameters for an ECIES primitive with HKDF and AEAD encryption.++ + ++ class+ HpkeParameters+Description of the parameters for an+HpkePublicKeyorHpkePrivateKey.
Methods in com.google.crypto.tink.hybrid that return HybridParameters @@ -102,13 +123,13 @@ -Uses of -
- abstract HybridParametersHybridPublicKey. -getParameters()+ HybridParametersHybridPrivateKey. getParameters()+ + abstract HybridParametersHybridPublicKey. +getParameters()-Uses of Class
com.google.crypto.tink.hybrid.HybridPrivateKeyNo usage of com.google.crypto.tink.hybrid.HybridPrivateKey+++
+- +
++
+Packages that use HybridPrivateKey ++ + +Package +Description ++ + +com.google.crypto.tink.hybrid ++ - +
++
+- + + +
+Uses of HybridPrivateKey in com.google.crypto.tink.hybrid
++
+Subclasses of HybridPrivateKey in com.google.crypto.tink.hybrid ++ + +Modifier and Type +Class and Description ++ + ++ class+ HpkePrivateKey+Representation of the decryption function for an HPKE hybrid encryption primitive.+diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HybridPublicKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HybridPublicKey.html index 9fb4b662c..928274ba4 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HybridPublicKey.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/class-use/HybridPublicKey.html @@ -94,6 +94,27 @@HybridPublicKey
in com.google.crypto.tink.hybrid ++
Subclasses of HybridPublicKey in com.google.crypto.tink.hybrid ++ + +Modifier and Type +Class and Description ++ ++ class+ EciesPublicKey+Represents the encryption function for an ECIES hybrid encryption primitive.++ + ++ class+ HpkePublicKey+Representation of the encryption function for an HPKE hybrid encryption primitive.+@@ -128,6 +132,26 @@
Methods in com.google.crypto.tink.hybrid that return HybridPublicKey diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/package-frame.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/package-frame.html index 74a2b29dd..f70839652 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/package-frame.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/package-frame.html @@ -13,6 +13,21 @@ Classes
- EciesAeadHkdfPrivateKeyManager
+- EciesParameters
+- EciesParameters.Builder
+- EciesParameters.CurveType
+- EciesParameters.HashType
+- EciesParameters.PointFormat
+- EciesParameters.Variant
+- EciesPublicKey
+- HpkeParameters
+- HpkeParameters.AeadId
+- HpkeParameters.Builder
+- HpkeParameters.KdfId
+- HpkeParameters.KemId
+- HpkeParameters.Variant
+- HpkePrivateKey
+- HpkePublicKey
- HybridConfig
- HybridDecryptConfig
- HybridDecryptFactory
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/package-summary.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/package-summary.html index 3b44068fd..77a855976 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/package-summary.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/package-summary.html @@ -89,69 +89,159 @@Package com.google.crypto.tink.hybrid
+ +EciesParameters ++ +Parameters for an ECIES primitive with HKDF and AEAD encryption.++ +EciesParameters.Builder ++ +Builds a new+EciesParametersinstance.+ +EciesParameters.CurveType ++ +The elliptic curve type used for the KEM.++ +EciesParameters.HashType ++ +The Hash algorithm used for the KEM.++ +EciesParameters.PointFormat ++ +The Elliptic Curve Point Format.++ +EciesParameters.Variant ++ +Description of the output prefix prepended to the ciphertext.++ +EciesPublicKey ++ +Represents the encryption function for an ECIES hybrid encryption primitive.++ +HpkeParameters ++ +Description of the parameters for an+HpkePublicKeyorHpkePrivateKey.+ +HpkeParameters.AeadId ++ +HPKE AEAD identifiers.++ +HpkeParameters.Builder ++ +Builds a new+HpkeParametersinstance.+ +HpkeParameters.KdfId ++ +HPKE KDF identifiers.++ +HpkeParameters.KemId ++ +HPKE KEM identifiers.++ +HpkeParameters.Variant ++ +Description of the output prefix prepended to the ciphertext.++ +HpkePrivateKey ++ +Representation of the decryption function for an HPKE hybrid encryption primitive.++ +HpkePublicKey ++ +Representation of the encryption function for an HPKE hybrid encryption primitive.+- HybridConfig Registryall instances ofHybridEncryptandHybridDecryptkey types supported in a particular release of Tink.+ - HybridDecryptConfig Deprecated useConfigandHybridConfig+ - HybridDecryptFactory Deprecated UsekeysetHandle.GetPrimitive(HybridDecrypt.class)after registering theHybridDecryptWrapperinstead.+ - HybridDecryptWrapper PrimitiveWrapper<HybridDecrypt>.+ - HybridEncryptConfig Deprecated useConfigandHybridConfig+ - HybridEncryptFactory Deprecated UsekeysetHandle.GetPrimitive(HybridEncrypt.class)after registering theHybridEncryptWrapperinstead.+ - HybridEncryptWrapper PrimitiveWrapper<HybridEncrypt>.+ - HybridKeyTemplates + - HybridParameters HybridPrivateKeyand the correspondingHybridPublicKeyexcluding the randomly chosen key material.+ - HybridPrivateKey + HybridPublicKey Class Hierarchy
- java.lang.Object
+
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/package-use.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/package-use.html index 4f8c066ae..cff2c9c12 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/package-use.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/hybrid/package-use.html @@ -98,10 +98,90 @@- com.google.crypto.tink.hybrid.EciesParameters.Builder
+- com.google.crypto.tink.hybrid.EciesParameters.CurveType
+- com.google.crypto.tink.hybrid.EciesParameters.HashType
+- com.google.crypto.tink.hybrid.EciesParameters.PointFormat
+- com.google.crypto.tink.hybrid.EciesParameters.Variant
+- com.google.crypto.tink.hybrid.HpkeParameters.AeadId
+- com.google.crypto.tink.hybrid.HpkeParameters.Builder
+- com.google.crypto.tink.hybrid.HpkeParameters.KdfId
+- com.google.crypto.tink.hybrid.HpkeParameters.KemId
+- com.google.crypto.tink.hybrid.HpkeParameters.Variant
- com.google.crypto.tink.hybrid.HybridConfig
- com.google.crypto.tink.hybrid.HybridDecryptConfig
- com.google.crypto.tink.hybrid.HybridDecryptFactory
@@ -90,8 +100,17 @@Class Hierarchy
- com.google.crypto.tink.hybrid.HybridKeyTemplates
- com.google.crypto.tink.Key
-
- com.google.crypto.tink.hybrid.HybridPrivateKey (implements com.google.crypto.tink.PrivateKey)
-- com.google.crypto.tink.hybrid.HybridPublicKey
+- com.google.crypto.tink.hybrid.HybridPrivateKey (implements com.google.crypto.tink.PrivateKey) +
++
+- com.google.crypto.tink.hybrid.HpkePrivateKey
+- com.google.crypto.tink.hybrid.HybridPublicKey +
+
+- com.google.crypto.tink.hybrid.EciesPublicKey
+- com.google.crypto.tink.hybrid.HpkePublicKey
+- com.google.crypto.tink.internal.KeyTypeManager<KeyProtoT> @@ -105,7 +124,12 @@
Class Hierarchy
- com.google.crypto.tink.Parameters
-
- com.google.crypto.tink.hybrid.HybridParameters
+- com.google.crypto.tink.hybrid.HybridParameters +
+
+- com.google.crypto.tink.hybrid.EciesParameters
+- com.google.crypto.tink.hybrid.HpkeParameters
+Uses of
+ +EciesParameters + +Parameters for an ECIES primitive with HKDF and AEAD encryption.++ +EciesParameters.Builder + +Builds a new+EciesParametersinstance.+ +EciesParameters.CurveType + +The elliptic curve type used for the KEM.++ +EciesParameters.HashType + +The Hash algorithm used for the KEM.++ +EciesParameters.PointFormat + +The Elliptic Curve Point Format.++ +EciesParameters.Variant + +Description of the output prefix prepended to the ciphertext.++ +EciesPublicKey + +Represents the encryption function for an ECIES hybrid encryption primitive.++ +HpkeParameters + +Description of the parameters for an+HpkePublicKeyorHpkePrivateKey.+ +HpkeParameters.AeadId + +HPKE AEAD identifiers.++ +HpkeParameters.Builder + +Builds a new+HpkeParametersinstance.+ +HpkeParameters.KdfId + +HPKE KDF identifiers.++ +HpkeParameters.KemId + +HPKE KEM identifiers.++ +HpkeParameters.Variant + +Description of the output prefix prepended to the ciphertext.++ +HpkePrivateKey + +Representation of the decryption function for an HPKE hybrid encryption primitive.++ +HpkePublicKey + +Representation of the encryption function for an HPKE hybrid encryption primitive.++ HybridParameters Represents a description of aHybridPrivateKeyand the correspondingHybridPublicKeyexcluding the randomly chosen key material.+ HybridPrivateKey + +Representation of the decryption function for a hybrid encryption primitive.++ HybridPublicKey Representation of the encryption function for a hybrid encryption primitive.diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/integration/android/SharedPrefKeysetWriter.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/integration/android/SharedPrefKeysetWriter.html index a25cab6be..06f8fdd64 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/integration/android/SharedPrefKeysetWriter.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/integration/android/SharedPrefKeysetWriter.html @@ -17,8 +17,8 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":42,"i1":42}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -111,8 +111,13 @@Class SharedPrefKeysetWri
- KeysetWriter
+Deprecated. +We do not expect anyone to use this class. Please file an issue on + github.com/tink-crypto/tink-java/ if you need to replace this.+
-public final class SharedPrefKeysetWriter +@Deprecated +public final class SharedPrefKeysetWriter extends Object implements KeysetWriterA@@ -141,6 +146,7 @@KeysetWriterthat can write keysets to private shared preferences on Android.Constructor Summary
@@ -155,7 +161,7 @@ SharedPrefKeysetWriter(Context context, String keysetName, String prefFileName)+Deprecated.Creates aKeysetReaderthat hex-encodes and writes keysets to the preference namekeysetNamein the private shared preferences fileprefFileName.Constructor Summary
Method Summary
-
@@ -128,6 +132,26 @@All Methods Instance Methods Concrete Methods +All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method and Description @@ -163,12 +169,14 @@Method Summary
voidwrite(EncryptedKeyset keyset)+Deprecated.Tries to write anEncryptedKeysetto some storage system.@@ -203,6 +211,7 @@ voidwrite(Keyset keyset)+Deprecated.Tries to write aKeysetto some storage system.SharedPrefKeysetWriter
public SharedPrefKeysetWriter(Context context, String keysetName, String prefFileName)+Deprecated.Creates aKeysetReaderthat hex-encodes and writes keysets to the preference namekeysetNamein the private shared preferences fileprefFileName. @@ -230,6 +239,7 @@Method Detail
write
public void write(Keyset keyset) throws IOException+Deprecated.Description copied from interface:KeysetWriterTries to write aKeysetto some storage system.@@ -248,6 +258,7 @@
write
write
public void write(EncryptedKeyset keyset) throws IOException+Deprecated.Description copied from interface:KeysetWriterTries to write anEncryptedKeysetto some storage system.diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/integration/android/package-summary.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/integration/android/package-summary.html index df831174d..a76bb1a51 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/integration/android/package-summary.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/integration/android/package-summary.html @@ -121,8 +121,8 @@
+ + + +Package com.google.crypto.tink.integratio
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Ed25519.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Ed25519.html index 9015ac4ce..83b89a08e 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Ed25519.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Ed25519.html @@ -17,7 +17,7 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":9,"i2":9,"i3":9}; +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -174,6 +174,12 @@ SharedPrefKeysetWriter -- A+KeysetWriterthat can write keysets to private shared preferences on Android.Deprecated + We do not expect anyone to use this class.Method Summary
getHashedScalar(byte[] privateKey)+ ++ static void+ init()+Initializes Ed25519 if not yet initialized.+- static byte[]scalarMultWithBaseToBytes(byte[] a)Computesa*B @@ -181,7 +187,7 @@Method Summary
B is the Ed25519 base point (x,4/5) with x positive.+ - static byte[]sign(byte[] message, byte[] publicKey, @@ -189,7 +195,7 @@Method Summary
Returns the EdDSA signature for themessagebased on thehashedPrivateKey.+ static booleanverify(byte[] message, byte[] signature, @@ -309,7 +315,7 @@sign
+ + + +
- Parameters:
- -
message- to sign- +
publicKey-Ed25519#scalarMultToBytes(byte[])ofhashedPrivateKeypublicKey-scalarMultWithBaseToBytes(byte[])ofhashedPrivateKeyhashedPrivateKey-getHashedScalar(byte[])of the private key- Returns:
- signature for the
@@ -321,7 +327,7 @@message.sign
-+
verify
public static boolean verify(byte[] message, @@ -335,6 +341,16 @@verify
+
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/EllipticCurvesUtil.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/EllipticCurvesUtil.html index d05385f50..8ff0d47a3 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/EllipticCurvesUtil.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/EllipticCurvesUtil.html @@ -49,7 +49,7 @@- +
+init
+public static void init()+Initializes Ed25519 if not yet initialized.+
- Frames
@@ -368,7 +368,7 @@multiplyByGenerator
- Frames
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/EnumTypeProtoConverter.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/EnumTypeProtoConverter.Builder.html new file mode 100644 index 000000000..0dfd9e1fb --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/EnumTypeProtoConverter.Builder.html @@ -0,0 +1,262 @@ + + + + + +EnumTypeProtoConverter.Builder + + + + + + + + + + + +++com.google.crypto.tink.internal+Class EnumTypeProtoConverter.Builder<E extends Enum<E>,O>
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/EnumTypeProtoConverter.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/EnumTypeProtoConverter.html new file mode 100644 index 000000000..eafd3d2c2 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/EnumTypeProtoConverter.html @@ -0,0 +1,305 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.internal.EnumTypeProtoConverter.Builder<E,O>
++++
+- +
++
+- Enclosing class:
+- EnumTypeProtoConverter<E extends Enum<E>,O>
+
+
+public static final class EnumTypeProtoConverter.Builder<E extends Enum<E>,O> +extends Object+Builds instances of+EnumTypeProtoConverter.++ ++
+- + +
++
+- + + +
+Method Summary
++
+ +All Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ EnumTypeProtoConverter.Builder<E,O>+ add(E protoEnum, + O objectEnum)+Adds bidirectional conversion mapping between+protoEnumandobjectEnum.+ ++ EnumTypeProtoConverter<E,O>+ build()EnumTypeProtoConverter + + + + + + + + + + + +++com.google.crypto.tink.internal+Class EnumTypeProtoConverter<E extends Enum<E>,O>
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Field25519.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Field25519.html index 085613a0e..f1cb7e4c2 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Field25519.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Field25519.html @@ -48,8 +48,8 @@+
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.internal.EnumTypeProtoConverter<E,O>
++ +++++
+- + +
++
+ +- + + +
+Nested Class Summary
++
+Nested Classes ++ +Modifier and Type +Class and Description ++ ++ static class+ EnumTypeProtoConverter.Builder<E extends Enum<E>,O>+Builds instances of+EnumTypeProtoConverter.+
+- + + +
+Method Summary
++
+ +All Methods Static Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ static <E extends Enum<E>,O>
EnumTypeProtoConverter.Builder<E,O>+ builder()+ ++ O+ fromProtoEnum(E protoEnum)+Converts+protoEnumto the equivalent object enum.+ ++ E+ toProtoEnum(O objectEnum)+Converts+objectEnumto the equivalent proto enum.+++
+- + +
++
+- + + +
+Method Detail
+ + + ++
+ + + + + +- +
+builder
+public static <E extends Enum<E>,O> EnumTypeProtoConverter.Builder<E,O> builder()++
+ + + + + +- +
+toProtoEnum
+public E toProtoEnum(O objectEnum) + throws GeneralSecurityException+Converts+objectEnumto the equivalent proto enum.+
+- Throws:
+- +
GeneralSecurityException+
+- +
+fromProtoEnum
+public O fromProtoEnum(E protoEnum) + throws GeneralSecurityException+Converts+protoEnumto the equivalent object enum.+
+- Throws:
+- +
GeneralSecurityException
- Frames
@@ -292,8 +292,8 @@contract
- Frames
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/InternalConfiguration.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/InternalConfiguration.html new file mode 100644 index 000000000..8788504de --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/InternalConfiguration.html @@ -0,0 +1,375 @@ + + + + + +InternalConfiguration + + + + + + + + + + + +++com.google.crypto.tink.internal+Class InternalConfiguration
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/JsonParser.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/JsonParser.html index 6a4efb491..f8b540bdb 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/JsonParser.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/JsonParser.html @@ -48,7 +48,7 @@+
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.Configuration
+- +
++
+- com.google.crypto.tink.internal.InternalConfiguration
++++
+- +
++
+- Direct Known Subclasses:
+- RegistryConfiguration
+
+
+public abstract class InternalConfiguration +extends Configuration+Abstract class representing the real configuration API, i.e. all algorithms that Tink + understands. Internal. Users should not access these methods since the operations are to be used + by internal KeysetHandle operations only.++++
+- + +
++
+ +- + + +
+Constructor Summary
++
+Constructors ++ +Constructor and Description ++ ++ InternalConfiguration()+
+- + + +
+Method Summary
++
+ +All Methods Static Methods Instance Methods Abstract Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ static InternalConfiguration+ createFromPrimitiveRegistry(PrimitiveRegistry registry)+ ++ abstract Class<?>+ getInputPrimitiveClass(Class<?> wrapperClassObject)+Given the target class, reveals primitive set of what type should be provided to the ++InternalConfiguration.wrapmethod in order to get a wrapped object of the target class.+ ++ abstract <P> P+ getLegacyPrimitive(KeyData keyData, + Class<P> primitiveClass)+Creates a primitive from a key in the old (proto) format.++ ++ abstract <P> P+ getPrimitive(Key key, + Class<P> primitiveClass)+Given a key and a desired primitive class, creates the required primitive.++ ++ abstract <B,P> P+ wrap(PrimitiveSet<B> primitiveSet, + Class<P> clazz)+Wraps the primitives in the primitive set into the provided class.++++
+- + + + +
++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+getLegacyPrimitive
+public abstract <P> P getLegacyPrimitive(KeyData keyData, + Class<P> primitiveClass) + throws GeneralSecurityException+Creates a primitive from a key in the old (proto) format.++
+- Throws:
+- +
GeneralSecurityException+
+ + + +- +
+getPrimitive
+public abstract <P> P getPrimitive(Key key, + Class<P> primitiveClass) + throws GeneralSecurityException+Given a key and a desired primitive class, creates the required primitive.++
+- Throws:
+- +
GeneralSecurityException+
+ + + +- +
+wrap
+public abstract <B,P> P wrap(PrimitiveSet<B> primitiveSet, + Class<P> clazz) + throws GeneralSecurityException+Wraps the primitives in the primitive set into the provided class.++
+- Throws:
+- +
GeneralSecurityException- if the wrapper for the provided pair + (input class, wrapped class) is not registered+
+ + + +- +
+getInputPrimitiveClass
+public abstract Class<?> getInputPrimitiveClass(Class<?> wrapperClassObject) + throws GeneralSecurityException+Given the target class, reveals primitive set of what type should be provided to the ++InternalConfiguration.wrapmethod in order to get a wrapped object of the target class.+
+- Throws:
+- +
GeneralSecurityException+
+- +
+createFromPrimitiveRegistry
+public static InternalConfiguration createFromPrimitiveRegistry(PrimitiveRegistry registry)+@@ -229,7 +229,7 @@
getParsedNumberAsLongOrThrow
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/KeyTemplateProtoConverter.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/KeyTemplateProtoConverter.html index 52180fbba..28e909bfc 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/KeyTemplateProtoConverter.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/KeyTemplateProtoConverter.html @@ -17,7 +17,7 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9}; +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -139,13 +139,17 @@
Method Summary
- static KeyTemplate.OutputPrefixType+ prefixFromProto(OutputPrefixType outputPrefixType)getOutputPrefixType(KeyTemplate t)+ ++ static KeyTemplate.OutputPrefixType+ prefixFromProto(OutputPrefixType outputPrefixType)- static byte[]toByteArray(KeyTemplate keyTemplate)+ @@ -230,7 +234,7 @@ static KeyTemplatetoProto(KeyTemplate keyTemplate)fromProto
-+
fromByteArray
public static KeyTemplate fromByteArray(byte[] bytes) @@ -241,6 +245,20 @@fromByteArray
+
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/KeyTypeManager.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/KeyTypeManager.html index d52d7d8e7..a1f7c9a8e 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/KeyTypeManager.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/KeyTypeManager.html @@ -108,7 +108,7 @@- +
+getOutputPrefixType
+public static KeyTemplate.OutputPrefixType getOutputPrefixType(KeyTemplate t) + throws GeneralSecurityException++
+- Throws:
+- +
GeneralSecurityExceptionClass KeyTypeManager<KeyProtoT
- Direct Known Subclasses:
-- AesCmacKeyManager, AesCmacPrfKeyManager, AesCtrHmacAeadKeyManager, AesCtrHmacStreamingKeyManager, AesCtrKeyManager, AesEaxKeyManager, AesGcmHkdfStreamingKeyManager, AesGcmKeyManager, AesGcmSivKeyManager, AesSivKeyManager, ChaCha20Poly1305KeyManager, HkdfPrfKeyManager, HmacKeyManager, HmacPrfKeyManager, HpkePublicKeyManager, JwtHmacKeyManager, KmsAeadKeyManager, KmsEnvelopeAeadKeyManager, PrivateKeyTypeManager, XChaCha20Poly1305KeyManager
+- AesCmacKeyManager, AesCmacPrfKeyManager, AesCtrHmacAeadKeyManager, AesCtrHmacStreamingKeyManager, AesCtrKeyManager, AesEaxKeyManager, AesGcmHkdfStreamingKeyManager, AesGcmKeyManager, AesGcmSivKeyManager, AesSivKeyManager, ChaCha20Poly1305KeyManager, HkdfPrfKeyManager, HmacKeyManager, HmacPrfKeyManager, HpkePublicKeyManager, JwtHmacKeyManager, KmsAeadKeyManager, KmsEnvelopeAeadKeyManager, PrfBasedDeriverKeyManager, PrivateKeyTypeManager, XChaCha20Poly1305KeyManager
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/MutableSerializationRegistry.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/MutableSerializationRegistry.html index df00e0f98..7882bba77 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/MutableSerializationRegistry.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/MutableSerializationRegistry.html @@ -414,18 +414,18 @@parseKey
parseKeyWithLegacyFallback
public Key parseKeyWithLegacyFallback(ProtoKeySerialization protoKeySerialization, + @Nullable SecretKeyAccess access) throws GeneralSecurityExceptionReturns a Key object from a protoKeySerialization, even if no parser has been registered.+ LegacyProtoKey.Falling back is useful because we want users to be able to call
#getAteven for key types for which we did not yet register a parser; in this case we simply fall back to return a - LegacyProtoKey. - -This always requires SecretKeyAccess.
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/PrimitiveRegistry.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/PrimitiveRegistry.Builder.html index f9cb0411d..83845afee 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/PrimitiveRegistry.Builder.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/PrimitiveRegistry.Builder.html @@ -17,7 +17,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10}; +var methods = {"i0":10,"i1":10,"i2":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -75,13 +75,13 @@
- Throws:
-- +
GeneralSecurityException- if a parser is registered but parsing fails.GeneralSecurityException- if a parser is registered but parsing fails or required + SecretKeyAccess is missing- Summary:
- Nested |
- Field |
-- Constr |
+- Constr |
- Method
@@ -121,26 +121,6 @@Class PrimitiveRegistr
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/PrimitiveRegistry.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/PrimitiveRegistry.html index b247f3d06..d57ad2823 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/PrimitiveRegistry.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/PrimitiveRegistry.html @@ -17,8 +17,8 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -146,23 +146,31 @@
- - -
-
- - - -
-Constructor Summary
--
-Constructors -- -Constructor and Description -- -- Builder()- -- Builder(PrimitiveRegistry registry)
- @@ -154,12 +134,16 @@
Method Summary
Method and Description + ++ PrimitiveRegistry+ build()- <KeyT extends Key,PrimitiveT>
PrimitiveRegistry.BuilderregisterPrimitiveConstructor(PrimitiveConstructor<KeyT,PrimitiveT> primitiveConstructor)Registers a primitive constructor for later use inPrimitiveRegistry.getPrimitive(KeyT, java.lang.Class<PrimitiveT>).+ @@ -179,32 +163,6 @@ <InputPrimitiveT,WrapperPrimitiveT>
PrimitiveRegistry.BuilderregisterPrimitiveWrapper(PrimitiveWrapper<InputPrimitiveT,WrapperPrimitiveT> wrapper)Methods inherited from class java.lang.
- - -
@@ -302,13 +269,13 @@-
- - - -
-Constructor Detail
- - - --
- - - -- -
-Builder
-public Builder()--
-- -
-Builder
-public Builder(PrimitiveRegistry registry)-
- @@ -235,7 +193,7 @@
registerPrimitiveConstructor
-+
+ + + +
registerPrimitiveWrapper
@CanIgnoreReturnValue @@ -247,6 +205,15 @@registerPrimitiveWrapper
+
- +
+build
+public PrimitiveRegistry build()+registerPrimitiveWrapper
- Summary:
- Nested |
- Field |
-- Constr |
+- Constr |
- Method
Nested Class Summary
Method Summary
-
@@ -214,7 +214,7 @@All Methods Instance Methods Concrete Methods +All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description + ++ static PrimitiveRegistry.Builder+ builder()+ ++ static PrimitiveRegistry.Builder+ builder(PrimitiveRegistry registry)- Class<?>getInputPrimitiveClass(Class<?> wrapperClassObject)+ - <KeyT extends Key,PrimitiveT>
PrimitiveTgetPrimitive(KeyT key, Class<PrimitiveT> primitiveClass)Creates a primitive from a given key.+ <InputPrimitiveT,WrapperPrimitiveT>
WrapperPrimitiveT@@ -189,6 +197,24 @@ wrap(PrimitiveSet<InputPrimitiveT> primitives, Class<WrapperPrimitiveT> wrapperClassObject)Methods inherited from class java.lang. + + +
+
+ + + +- +
+builder
+public static PrimitiveRegistry.Builder builder()++
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/ProtoParametersSerialization.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/ProtoParametersSerialization.html index 39dc1a1fc..86424209e 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/ProtoParametersSerialization.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/ProtoParametersSerialization.html @@ -17,7 +17,7 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":9,"i2":10,"i3":10}; +var methods = {"i0":9,"i1":9,"i2":9,"i3":10,"i4":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -49,7 +49,7 @@- +
+builder
+public static PrimitiveRegistry.Builder builder(PrimitiveRegistry registry)+
- Frames
@@ -140,25 +140,31 @@Method Summary
- static ProtoParametersSerializationcreate(KeyTemplate keyTemplate)+checkedCreate(KeyTemplate keyTemplate)Creates a newProtoParametersSerializationobject.+ + static ProtoParametersSerialization+ create(KeyTemplate keyTemplate)+Creates a new+ProtoParametersSerializationobject.+ -static ProtoParametersSerializationcreate(String typeUrl, OutputPrefixType outputPrefixType, com.google.protobuf.MessageLite value)Creates a newProtoParametersSerializationobject from the individual parts.+ - KeyTemplategetKeyTemplate()The contents of the field value in the message com.google.crypto.tink.proto.KeyData.+ BytesgetObjectIdentifier()The typeUrl.@@ -195,7 +201,9 @@create
public static ProtoParametersSerialization create(String typeUrl, OutputPrefixType outputPrefixType, com.google.protobuf.MessageLite value)-Creates a new+ProtoParametersSerializationobject from the individual parts.Creates a new@@ -205,7 +213,27 @@ProtoParametersSerializationobject from the individual parts. + +Note: the given typeUrl must be valid and must not contain invalid characters.
create
- + + + + +
create
public static ProtoParametersSerialization create(KeyTemplate keyTemplate)-Creates a new+ProtoParametersSerializationobject.Creates a new+ProtoParametersSerializationobject. + +Note: the given typeUrl must be valid and may not contain invalid characters.
+
@@ -261,7 +289,7 @@- +
checkedCreate
+public static ProtoParametersSerialization checkedCreate(KeyTemplate keyTemplate) + throws GeneralSecurityException+Creates a new+ProtoParametersSerializationobject. + +If the type URL contains invalid characters, such as spaces, this throws a + GeneralSecurityException
+
- Throws:
+- +
GeneralSecurityExceptiongetObjectIdentifier
- Frames
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Random.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Random.html new file mode 100644 index 000000000..d60606291 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Random.html @@ -0,0 +1,287 @@ + + + + + +Random + + + + + + + + + + + +++com.google.crypto.tink.internal+Class Random
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/RegistryConfiguration.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/RegistryConfiguration.html new file mode 100644 index 000000000..fc33ac07e --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/RegistryConfiguration.html @@ -0,0 +1,373 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.internal.Random
++++
+- +
+
+
+public final class Random +extends Object+Provides secure randomness using+SecureRandom.+++
+- + +
++
+- + + +
+Method Summary
++
+ +All Methods Static Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ static byte[]+ randBytes(int size)+Returns a random byte array of size+size.+ ++ static int+ randInt()+ ++ static int+ randInt(int max)+ ++ static void+ validateUsesConscrypt()+Throws a GeneralSecurityException if the provider is not Conscrypt.++++
+- + +
++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+randBytes
+public static byte[] randBytes(int size)+Returns a random byte array of size+size.+
+ + + +- +
+randInt
+public static final int randInt(int max)++
+ + + +- +
+randInt
+public static final int randInt()++
+- +
+validateUsesConscrypt
+public static final void validateUsesConscrypt() + throws GeneralSecurityException+Throws a GeneralSecurityException if the provider is not Conscrypt.++
+- Throws:
+- +
GeneralSecurityExceptionRegistryConfiguration + + + + + + + + + + + +++com.google.crypto.tink.internal+Class RegistryConfiguration
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Serialization.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Serialization.html index 30e8977ee..d638c4db3 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Serialization.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Serialization.html @@ -48,7 +48,7 @@+
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.Configuration
+- +
++
+- com.google.crypto.tink.internal.InternalConfiguration
+- +
++
+- com.google.crypto.tink.internal.RegistryConfiguration
++++
+- +
+
+
+public final class RegistryConfiguration +extends InternalConfiguration+ ++++
+- + +
++
+- + + +
+Method Summary
++
+ +All Methods Static Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ static InternalConfiguration+ createFromPrimitiveRegistry(PrimitiveRegistry registry)+Do not call.++ ++ static RegistryConfiguration+ get()+ ++ Class<?>+ getInputPrimitiveClass(Class<?> wrapperClassObject)+Given the target class, reveals primitive set of what type should be provided to the ++InternalConfiguration.wrapmethod in order to get a wrapped object of the target class.+ ++ <P> P+ getLegacyPrimitive(KeyData keyData, + Class<P> primitiveClass)+Creates a primitive from a key in the old (proto) format.++ ++ <P> P+ getPrimitive(Key key, + Class<P> primitiveClass)+Given a key and a desired primitive class, creates the required primitive.++ ++ <B,P> P+ wrap(PrimitiveSet<B> primitiveSet, + Class<P> clazz)+Wraps the primitives in the primitive set into the provided class.++++
+- + +
++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+get
+public static RegistryConfiguration get()++
+ + + +- +
+getLegacyPrimitive
+public <P> P getLegacyPrimitive(KeyData keyData, + Class<P> primitiveClass) + throws GeneralSecurityException+Description copied from class:+InternalConfigurationCreates a primitive from a key in the old (proto) format.++
+- Specified by:
+- +
getLegacyPrimitivein classInternalConfiguration- Throws:
+- +
GeneralSecurityException+
+ + + +- +
+getPrimitive
+public <P> P getPrimitive(Key key, + Class<P> primitiveClass) + throws GeneralSecurityException+Description copied from class:+InternalConfigurationGiven a key and a desired primitive class, creates the required primitive.++
+- Specified by:
+- +
getPrimitivein classInternalConfiguration- Throws:
+- +
GeneralSecurityException+
+ + + +- +
+wrap
+public <B,P> P wrap(PrimitiveSet<B> primitiveSet, + Class<P> clazz) + throws GeneralSecurityException+Description copied from class:+InternalConfigurationWraps the primitives in the primitive set into the provided class.++
+- Specified by:
+- +
wrapin classInternalConfiguration- Throws:
+- +
GeneralSecurityException- if the wrapper for the provided pair + (input class, wrapped class) is not registered+
+ + + +- +
+getInputPrimitiveClass
+@Nullable +public Class<?> getInputPrimitiveClass(Class<?> wrapperClassObject)+Description copied from class:+InternalConfigurationGiven the target class, reveals primitive set of what type should be provided to the ++InternalConfiguration.wrapmethod in order to get a wrapped object of the target class.+
+- Specified by:
+- +
getInputPrimitiveClassin classInternalConfiguration+
+- +
+createFromPrimitiveRegistry
+public static InternalConfiguration createFromPrimitiveRegistry(PrimitiveRegistry registry)+Do not call. + ++We shadow the function
createFromPrimitiveRegistryhere so that one cannot invoke + the static function in the superclass by writingRegistryConfiguration.createFromPrimitiveRegistry.@@ -195,7 +195,7 @@
getObjectIdentifier
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Util.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Util.html index 8725202a9..5dad0acb0 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Util.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/Util.html @@ -17,7 +17,7 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":9,"i2":9,"i3":9}; +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -151,24 +151,30 @@
Method Summary
Method and Description + ++ static Bytes+ checkedToBytesFromPrintableAscii(String s)+Converts a string+sto a correspondingBytesobject.- static IntegergetAndroidApiLevel()Returns the current Android API level as integer or null if we do not run on Android.+ - static booleanisAndroid()Best-effort checks that this is Android.+ - static intrandKeyId()Returns a positive random int which can be used as a key ID in a keyset.+ static BytestoBytesFromPrintableAscii(String s)Converts a string@@ -237,7 +243,24 @@sto a correspondingBytesobject.toBytesFromPrintableAscii
considered a bug in Tink. Spaces are not allowed.+ + + + + +
- Throws:
-- +
TinkBugException- if s contains a character which is not a printable ASCII character.- +
TinkBugException- if s contains a character which is not a printable ASCII character or + a space.+
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/EnumTypeProtoConverter.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/EnumTypeProtoConverter.Builder.html new file mode 100644 index 000000000..4f01dd477 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/EnumTypeProtoConverter.Builder.html @@ -0,0 +1,170 @@ + + + + + +- +
checkedToBytesFromPrintableAscii
+public static final Bytes checkedToBytesFromPrintableAscii(String s) + throws GeneralSecurityException+Converts a string+sto a correspondingBytesobject.+
- Throws:
+GeneralSecurityException- if s contains a character which is not a printable ASCII + character or a space.Uses of Class com.google.crypto.tink.internal.EnumTypeProtoConverter.Builder + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.internal.EnumTypeProtoConverter.Builder++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/EnumTypeProtoConverter.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/EnumTypeProtoConverter.html new file mode 100644 index 000000000..a2fc77e21 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/EnumTypeProtoConverter.html @@ -0,0 +1,163 @@ + + + + + ++
+- +
++
+Packages that use EnumTypeProtoConverter.Builder ++ + +Package +Description ++ + +com.google.crypto.tink.internal ++ - +
++
+- + + +
+Uses of EnumTypeProtoConverter.Builder in com.google.crypto.tink.internal
++
+Methods in com.google.crypto.tink.internal that return EnumTypeProtoConverter.Builder ++ + +Modifier and Type +Method and Description ++ ++ EnumTypeProtoConverter.Builder<E,O>EnumTypeProtoConverter.Builder. +add(E protoEnum, + O objectEnum)+Adds bidirectional conversion mapping between+protoEnumandobjectEnum.+ + ++ static <E extends Enum<E>,O>
EnumTypeProtoConverter.Builder<E,O>EnumTypeProtoConverter. +builder()Uses of Class com.google.crypto.tink.internal.EnumTypeProtoConverter + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.internal.EnumTypeProtoConverter++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/InternalConfiguration.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/InternalConfiguration.html new file mode 100644 index 000000000..59d094dbc --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/InternalConfiguration.html @@ -0,0 +1,184 @@ + + + + + ++
+- +
++
+Packages that use EnumTypeProtoConverter ++ + +Package +Description ++ + +com.google.crypto.tink.internal ++ - +
++
+- + + +
+Uses of EnumTypeProtoConverter in com.google.crypto.tink.internal
++
+Methods in com.google.crypto.tink.internal that return EnumTypeProtoConverter ++ + +Modifier and Type +Method and Description ++ + ++ EnumTypeProtoConverter<E,O>EnumTypeProtoConverter.Builder. +build()Uses of Class com.google.crypto.tink.internal.InternalConfiguration + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.internal.InternalConfiguration++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/KeyTypeManager.KeyFactory.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/KeyTypeManager.KeyFactory.html index 12da25760..15bf992e4 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/KeyTypeManager.KeyFactory.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/KeyTypeManager.KeyFactory.html @@ -106,18 +106,22 @@+
+- +
++
+Packages that use InternalConfiguration ++ + +Package +Description ++ + +com.google.crypto.tink.internal ++ - +
++
+- + + +
+Uses of InternalConfiguration in com.google.crypto.tink.internal
++
+Subclasses of InternalConfiguration in com.google.crypto.tink.internal ++ + +Modifier and Type +Class and Description ++ + ++ class+ RegistryConfiguration+Represents the configuration as currently specified by the registry.++
+Methods in com.google.crypto.tink.internal that return InternalConfiguration ++ + +Modifier and Type +Method and Description ++ ++ static InternalConfigurationRegistryConfiguration. +createFromPrimitiveRegistry(PrimitiveRegistry registry)+Do not call.++ + ++ static InternalConfigurationInternalConfiguration. +createFromPrimitiveRegistry(PrimitiveRegistry registry)
- com.google.crypto.tink.mac +com.google.crypto.tink.keyderivation.internal - com.google.crypto.tink.prf +com.google.crypto.tink.mac - com.google.crypto.tink.signature +com.google.crypto.tink.prf + +com.google.crypto.tink.signature ++ @@ -280,6 +284,24 @@ com.google.crypto.tink.streamingaead Uses of + + +
Uses of KeyTypeManager.KeyFactory in com.google.crypto.tink.keyderivation.internal
++
+Methods in com.google.crypto.tink.keyderivation.internal that return KeyTypeManager.KeyFactory ++ + +Modifier and Type +Method and Description ++ + ++ KeyTypeManager.KeyFactory<PrfBasedDeriverKeyFormat,PrfBasedDeriverKey>PrfBasedDeriverKeyManager. +keyFactory()- diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/KeyTypeManager.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/KeyTypeManager.html index 142eec777..5b66f7352 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/KeyTypeManager.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/KeyTypeManager.html @@ -110,18 +110,22 @@
- com.google.crypto.tink.mac +com.google.crypto.tink.keyderivation.internal - com.google.crypto.tink.prf +com.google.crypto.tink.mac - com.google.crypto.tink.signature +com.google.crypto.tink.prf + +com.google.crypto.tink.signature ++ @@ -360,6 +364,26 @@ com.google.crypto.tink.streamingaead Uses of + + +
Uses of KeyTypeManager in com.google.crypto.tink.keyderivation.internal
++
+Subclasses of KeyTypeManager in com.google.crypto.tink.keyderivation.internal ++ + +Modifier and Type +Class and Description ++ + ++ class+ PrfBasedDeriverKeyManager+ +- diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/PrimitiveRegistry.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/PrimitiveRegistry.Builder.html index d187df19b..f27193f4f 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/PrimitiveRegistry.Builder.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/PrimitiveRegistry.Builder.html @@ -102,6 +102,14 @@
Uses of +
+ static PrimitiveRegistry.BuilderPrimitiveRegistry. + +builder()+ ++ static PrimitiveRegistry.BuilderPrimitiveRegistry. +builder(PrimitiveRegistry registry)<KeyT extends Key,PrimitiveT>
PrimitiveRegistry.BuilderPrimitiveRegistry.Builder. registerPrimitiveConstructor(PrimitiveConstructor<KeyT,PrimitiveT> primitiveConstructor)Registers a primitive constructor for later use indiff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/PrimitiveRegistry.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/PrimitiveRegistry.html index 87821a5d4..2017fe65c 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/PrimitiveRegistry.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/PrimitiveRegistry.html @@ -94,14 +94,39 @@PrimitiveRegistry.getPrimitive(KeyT, java.lang.Class<PrimitiveT>).
Uses of PrimitiveRegistry in com.google.crypto.tink.internal
--
+Constructors in com.google.crypto.tink.internal with parameters of type PrimitiveRegistry ++
+Methods in com.google.crypto.tink.internal that return PrimitiveRegistry - Constructor and Description +Modifier and Type +Method and Description - + ++ Builder(PrimitiveRegistry registry)+ PrimitiveRegistryPrimitiveRegistry.Builder. +build()+
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/ProtoParametersSerialization.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/ProtoParametersSerialization.html index 4505b9241..e33b98f2c 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/ProtoParametersSerialization.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/ProtoParametersSerialization.html @@ -103,19 +103,25 @@Methods in com.google.crypto.tink.internal with parameters of type PrimitiveRegistry ++ + +Modifier and Type +Method and Description ++ ++ static PrimitiveRegistry.BuilderPrimitiveRegistry. +builder(PrimitiveRegistry registry)+ ++ static InternalConfigurationRegistryConfiguration. +createFromPrimitiveRegistry(PrimitiveRegistry registry)+Do not call.++ + static InternalConfigurationInternalConfiguration. createFromPrimitiveRegistry(PrimitiveRegistry registry)Uses of
- static ProtoParametersSerializationProtoParametersSerialization. create(KeyTemplate keyTemplate)+ProtoParametersSerialization. checkedCreate(KeyTemplate keyTemplate)Creates a newProtoParametersSerializationobject.+ + static ProtoParametersSerializationProtoParametersSerialization. +create(KeyTemplate keyTemplate)+Creates a new+ProtoParametersSerializationobject.+ -static ProtoParametersSerializationProtoParametersSerialization. create(String typeUrl, OutputPrefixType outputPrefixType, com.google.protobuf.MessageLite value)Creates a newProtoParametersSerializationobject from the individual parts.+ ProtoParametersSerializationLegacyProtoParameters. getSerialization()returns the serialization which was used to create this object.diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/Random.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/Random.html new file mode 100644 index 000000000..e577e291a --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/Random.html @@ -0,0 +1,123 @@ + + + + + +Uses of Class com.google.crypto.tink.internal.Random + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.internal.RandomNo usage of com.google.crypto.tink.internal.Random+ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/RegistryConfiguration.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/RegistryConfiguration.html new file mode 100644 index 000000000..2f5845790 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/class-use/RegistryConfiguration.html @@ -0,0 +1,163 @@ + + + + + +Uses of Class com.google.crypto.tink.internal.RegistryConfiguration + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.internal.RegistryConfiguration++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/package-frame.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/package-frame.html index 9e6fe5e12..56345be7c 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/package-frame.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/package-frame.html @@ -27,7 +27,10 @@+
+- +
++
+Packages that use RegistryConfiguration ++ + +Package +Description ++ + +com.google.crypto.tink.internal ++ - +
++
+- + + +
+Uses of RegistryConfiguration in com.google.crypto.tink.internal
++
+Methods in com.google.crypto.tink.internal that return RegistryConfiguration ++ + +Modifier and Type +Method and Description ++ + ++ static RegistryConfigurationRegistryConfiguration. +get()Classes
- Curve25519
- Ed25519
- EllipticCurvesUtil
+- EnumTypeProtoConverter
+- EnumTypeProtoConverter.Builder
- Field25519
+- InternalConfiguration
- JsonParser
- KeyParser
- KeySerializer
@@ -51,6 +54,8 @@Classes
- PrivateKeyTypeManager
- ProtoKeySerialization
- ProtoParametersSerialization
+- Random
+- RegistryConfiguration
- SerializationRegistry
- SerializationRegistry.Builder
- Util
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/package-summary.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/package-summary.html index fa1cc6e8b..16c88e83e 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/package-summary.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/package-summary.html @@ -167,6 +167,18 @@Package com.google.crypto.tink.internal
+ +EnumTypeProtoConverter<E extends Enum<E>,O> ++ +Utility class for bidirectional conversion to and from proto enum types.++ +EnumTypeProtoConverter.Builder<E extends Enum<E>,O> ++ +Builds instances of+EnumTypeProtoConverter.Field25519 + +InternalConfiguration ++ +Abstract class representing the real configuration API, i.e.+- JsonParser + - KeyParser<SerializationT extends Serialization> Serializationobjects intoKeyobjects of a certain kind.+ - KeySerializer<KeyT extends Key,SerializationT extends Serialization> Keyobjects intoSerializationobjects of a certain kind.+ - KeyStatusTypeProtoConverter KeyHandle.KeyStatusTypeenum andKeyHandle.KeyStatusTypeproto.+ - KeyTemplateProtoConverter + - KeyTypeManager<KeyProtoT extends com.google.protobuf.MessageLite> + - KeyTypeManager.KeyFactory<KeyFormatProtoT extends com.google.protobuf.MessageLite,KeyProtoT extends com.google.protobuf.MessageLite> KeyFactorycreates new keys from a given KeyFormat.+ - KeyTypeManager.KeyFactory.KeyFormat<KeyFormatProtoT> + - LegacyProtoKey + - LegacyProtoParameters + - MonitoringUtil + - MutableMonitoringRegistry + - MutablePrimitiveRegistry PrimitiveRegistry.+ - MutableSerializationRegistry SerializationRegistry.+ - ParametersParser<SerializationT extends Serialization> Serializationobjects intoParametersobjects of a certain kind.+ - ParametersSerializer<ParametersT extends Parameters,SerializationT extends Serialization> Parametersobjects intoSerializationobjects of a certain kind.+ - PrimitiveConstructor<KeyT extends Key,PrimitiveT> Keyobjects of a certain kind.+ - PrimitiveFactory<PrimitiveT,KeyProtoT extends com.google.protobuf.MessageLite> + - PrimitiveRegistry PrimitiveConstructorobjects, and creating primitives with those objects.+ - PrimitiveRegistry.Builder + - PrivateKeyTypeManager<KeyProtoT extends com.google.protobuf.MessageLite,PublicKeyProtoT extends com.google.protobuf.MessageLite> KeyTypeManager, but additionally has a method to create a public key.+ - ProtoKeySerialization Keyobject serialized with binary protobuf Serialization.+ + ProtoParametersSerialization Parametersobject serialized with binary protobuf Serialization.+ Random ++ +Provides secure randomness using+SecureRandom.+ +RegistryConfiguration ++ +Represents the configuration as currently specified by the registry.+- SerializationRegistry KeySerializer,KeyParser,ParametersSerializer, andParametersParserobjects, and parsing/serializing keys and key formats with such objects.+ - SerializationRegistry.Builder + Util Class Hierarchy
- java.lang.Object
- com.google.crypto.tink.internal.BigIntegerEncoding
+- com.google.crypto.tink.Configuration +
+
+- com.google.crypto.tink.internal.InternalConfiguration +
++
+- com.google.crypto.tink.internal.RegistryConfiguration
+- com.google.crypto.tink.internal.Curve25519
- com.google.crypto.tink.internal.Ed25519
- com.google.crypto.tink.internal.EllipticCurvesUtil
+- com.google.crypto.tink.internal.EnumTypeProtoConverter<E,O>
+- com.google.crypto.tink.internal.EnumTypeProtoConverter.Builder<E,O>
- com.google.crypto.tink.internal.Field25519
- com.google.crypto.tink.internal.JsonParser
- com.google.crypto.tink.Key @@ -119,6 +130,7 @@
Class Hierarchy
- com.google.crypto.tink.internal.PrimitiveRegistry.Builder
- com.google.crypto.tink.internal.ProtoKeySerialization (implements com.google.crypto.tink.internal.Serialization)
- com.google.crypto.tink.internal.ProtoParametersSerialization (implements com.google.crypto.tink.internal.Serialization)
+- com.google.crypto.tink.internal.Random
- com.google.crypto.tink.internal.SerializationRegistry
- com.google.crypto.tink.internal.SerializationRegistry.Builder
- java.lang.Throwable (implements java.io.Serializable) diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/package-use.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/package-use.html index 2af8371b7..a5bfe026e 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/package-use.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/internal/package-use.html @@ -110,18 +110,22 @@
Uses o
- com.google.crypto.tink.mac +com.google.crypto.tink.keyderivation.internal - com.google.crypto.tink.prf +com.google.crypto.tink.mac - com.google.crypto.tink.signature +com.google.crypto.tink.prf + +com.google.crypto.tink.signature ++ @@ -266,113 +270,133 @@ com.google.crypto.tink.streamingaead Uses o
+ +EnumTypeProtoConverter + +Utility class for bidirectional conversion to and from proto enum types.++ +EnumTypeProtoConverter.Builder + +Builds instances of+EnumTypeProtoConverter.+ +InternalConfiguration + +Abstract class representing the real configuration API, i.e.+- KeyParser ParsesSerializationobjects intoKeyobjects of a certain kind.+ - KeyParser.KeyParsingFunction A function which parses a key.+ - KeySerializer SerializesKeyobjects intoSerializationobjects of a certain kind.+ - KeySerializer.KeySerializationFunction A function which serializes a key.+ - KeyTypeManager An object which collects all the operations which one can do on for a single key type, identified by a single KeyProto.+ - KeyTypeManager.KeyFactory AKeyFactorycreates new keys from a given KeyFormat.+ - KeyTypeManager.KeyFactory.KeyFormat A container that contains key format and other information that form key templates supported by this factory.+ - MutableMonitoringRegistry A Registry for MonitoringClient.+ - MutablePrimitiveRegistry A Mutable version of thePrimitiveRegistry.+ - MutableSerializationRegistry A Mutable version of theSerializationRegistry.+ - ParametersParser ParsesSerializationobjects intoParametersobjects of a certain kind.+ - ParametersParser.ParametersParsingFunction A function which parses a Parameters object.+ - ParametersSerializer SerializesParametersobjects intoSerializationobjects of a certain kind.+ - ParametersSerializer.ParametersSerializationFunction A function which serializes a Parameters object.+ - PrimitiveConstructor Create Primitive objects fromKeyobjects of a certain kind.+ - PrimitiveConstructor.PrimitiveConstructionFunction A function which creates a Primitive object.+ - PrimitiveFactory A PrimitiveFactory knows how to create primitives from a given key.+ - PrimitiveRegistry Allows registeringPrimitiveConstructorobjects, and creating primitives with those objects.+ - PrimitiveRegistry.Builder Allows building PrimitiveRegistry objects.+ - ProtoKeySerialization * Represents aKeyobject serialized with binary protobuf Serialization.+ + ProtoParametersSerialization Represents aParametersobject serialized with binary protobuf Serialization.+ RegistryConfiguration + +Represents the configuration as currently specified by the registry.+Serialization Represents either a serialized@@ -431,6 +455,29 @@Keyor a serializedParametersobject.Uses o
- + + +
+
+Classes in com.google.crypto.tink.internal used by com.google.crypto.tink.keyderivation.internal ++ + +Class and Description ++ +KeyTypeManager + +An object which collects all the operations which one can do on for a single key type, identified + by a single KeyProto.++ + +KeyTypeManager.KeyFactory + +A+KeyFactorycreates new keys from a given KeyFormat.- diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwkSetConverter.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwkSetConverter.html index ace77d033..c9fca9e92 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwkSetConverter.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwkSetConverter.html @@ -49,7 +49,7 @@
- Prev Class
-- Next Class
+- Next Class
- Frames
@@ -296,7 +296,7 @@toKeysetHandle
- Prev Class
-- Next Class
+- Next Class
- Frames
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaParameters.Algorithm.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaParameters.Algorithm.html new file mode 100644 index 000000000..bb3258341 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaParameters.Algorithm.html @@ -0,0 +1,330 @@ + + + + + +JwtEcdsaParameters.Algorithm + + + + + + + + + + + +++com.google.crypto.tink.jwt+Class JwtEcdsaParameters.Algorithm
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaParameters.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaParameters.Builder.html new file mode 100644 index 000000000..c3ec0415b --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaParameters.Builder.html @@ -0,0 +1,274 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.jwt.JwtEcdsaParameters.Algorithm
++++
+- +
++
+- Enclosing class:
+- JwtEcdsaParameters
+
+
+@Immutable +public static final class JwtEcdsaParameters.Algorithm +extends Object+The algorithm to be used for the signature computation.++++
+- + +
++
+ +- + + +
+Field Summary
++
+Fields ++ +Modifier and Type +Field and Description ++ ++ static JwtEcdsaParameters.Algorithm+ ES256+ECDSA using P-256 and SHA-256++ ++ static JwtEcdsaParameters.Algorithm+ ES384+ECDSA using P-384 and SHA-384++ ++ static JwtEcdsaParameters.Algorithm+ ES512+ECDSA using P-521 and SHA-512++
+- + + +
+Method Summary
++
+ +All Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ String+ getStandardName()+ ++ String+ toString()+++
+- + +
++
+ + +- + + +
+Field Detail
+ + + ++
+ + + +- +
+ES256
+public static final JwtEcdsaParameters.Algorithm ES256+ECDSA using P-256 and SHA-256++
+ + + +- +
+ES384
+public static final JwtEcdsaParameters.Algorithm ES384+ECDSA using P-384 and SHA-384++
+- +
+ES512
+public static final JwtEcdsaParameters.Algorithm ES512+ECDSA using P-521 and SHA-512+JwtEcdsaParameters.Builder + + + + + + + + + + + +++com.google.crypto.tink.jwt+Class JwtEcdsaParameters.Builder
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaParameters.KidStrategy.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaParameters.KidStrategy.html new file mode 100644 index 000000000..a8e5342be --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaParameters.KidStrategy.html @@ -0,0 +1,339 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.jwt.JwtEcdsaParameters.Builder
++++
+- +
++
+- Enclosing class:
+- JwtEcdsaParameters
+
+
+public static final class JwtEcdsaParameters.Builder +extends Object+Helps creating a+JwtEcdsaParametersobject.+++
+- + +
++
+- + + +
+Method Summary
++
+ +All Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ JwtEcdsaParameters+ build()+ ++ JwtEcdsaParameters.Builder+ setAlgorithm(JwtEcdsaParameters.Algorithm algorithm)+ ++ JwtEcdsaParameters.Builder+ setKidStrategy(JwtEcdsaParameters.KidStrategy kidStrategy)+++
+- + +
++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+setKidStrategy
+@CanIgnoreReturnValue +public JwtEcdsaParameters.Builder setKidStrategy(JwtEcdsaParameters.KidStrategy kidStrategy)++
+ + + +- +
+setAlgorithm
+@CanIgnoreReturnValue +public JwtEcdsaParameters.Builder setAlgorithm(JwtEcdsaParameters.Algorithm algorithm)++
+- +
+build
+public JwtEcdsaParameters build() + throws GeneralSecurityException++
+- Throws:
+- +
GeneralSecurityExceptionJwtEcdsaParameters.KidStrategy + + + + + + + + + + + +++com.google.crypto.tink.jwt+Class JwtEcdsaParameters.KidStrategy
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaParameters.html new file mode 100644 index 000000000..1217b943f --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaParameters.html @@ -0,0 +1,405 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.jwt.JwtEcdsaParameters.KidStrategy
++++
+- +
++
+- Enclosing class:
+- JwtEcdsaParameters
+
+
+@Immutable +public static final class JwtEcdsaParameters.KidStrategy +extends Object+Specifies how the "kid" header is handled.++++
+- + +
++
+ + +- + + +
+Field Summary
++
+Fields ++ +Modifier and Type +Field and Description ++ ++ static JwtEcdsaParameters.KidStrategy+ BASE64_ENCODED_KEY_ID+The "kid" is the URL safe (RFC 4648 Section 5) base64-encoded big-endian key_id in the + keyset.++ ++ static JwtEcdsaParameters.KidStrategy+ CUSTOM+The "kid" is fixed.++ ++ static JwtEcdsaParameters.KidStrategy+ IGNORED+The "kid" header is ignored.++++
+- + +
++
+ + +- + + +
+Field Detail
+ + + ++
+ + + +- +
+BASE64_ENCODED_KEY_ID
+public static final JwtEcdsaParameters.KidStrategy BASE64_ENCODED_KEY_ID+The "kid" is the URL safe (RFC 4648 Section 5) base64-encoded big-endian key_id in the + keyset. + ++In
PublicKeySign#signAndEncodeTink always adds the KID. + +In
PublicKeyVerify#verifyAndDecodeTink checks that the kid is present and equal + to this value. + +This strategy is recommended by Tink.
+
+ + + +- +
+IGNORED
+public static final JwtEcdsaParameters.KidStrategy IGNORED+The "kid" header is ignored. + ++In
PublicKeySign#signAndEncodeTink does not write a "kid" header. + +In
PublicKeyVerify#verifyAndDecodeTink ignores the "kid" header.+
+- +
+CUSTOM
+public static final JwtEcdsaParameters.KidStrategy CUSTOM+The "kid" is fixed. It can be obtained from+parameters.getCustomKid(). + +In
PublicKeySign#signAndEncodeTink writes the "kid" header to the value given by +parameters.getCustomKid(). + +In
PublicKeyVerify#verifyAndDecode, if the kid is present, it needs to match +parameters.getCustomKid(). If the kid is absent, it will be accepted. + +Note: Tink does not allow to randomly generate new
JwtEcdsaKeyobjects from + parameters objects withKidStrategyequals toCUSTOM.JwtEcdsaParameters + + + + + + + + + + + +++com.google.crypto.tink.jwt+Class JwtEcdsaParameters
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaPrivateKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaPrivateKey.html new file mode 100644 index 000000000..1e4a37bb0 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaPrivateKey.html @@ -0,0 +1,406 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.Parameters
+- +
++
+- com.google.crypto.tink.jwt.JwtSignatureParameters
+- +
++
+- com.google.crypto.tink.jwt.JwtEcdsaParameters
++++
+- +
+
+
+public final class JwtEcdsaParameters +extends JwtSignatureParameters+Describes the parameters of a+JwtEcdsaPrivateKeyor aJwtEcdsaPublicKey.+++
+- + +
++
+ +- + + +
+Nested Class Summary
++
+Nested Classes ++ +Modifier and Type +Class and Description ++ ++ static class+ JwtEcdsaParameters.Algorithm+The algorithm to be used for the signature computation.++ ++ static class+ JwtEcdsaParameters.Builder+Helps creating a+JwtEcdsaParametersobject.+ ++ static class+ JwtEcdsaParameters.KidStrategy+Specifies how the "kid" header is handled.++
+- + + +
+Method Summary
++
+ +All Methods Static Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ boolean+ allowKidAbsent()+If true, tokens without+"kid"header are allowed when verifying a token.+ ++ static JwtEcdsaParameters.Builder+ builder()+ ++ boolean+ equals(Object o)+ ++ JwtEcdsaParameters.Algorithm+ getAlgorithm()+ ++ JwtEcdsaParameters.KidStrategy+ getKidStrategy()+ ++ int+ hashCode()+ ++ boolean+ hasIdRequirement()+Returns true if a key created with the parameters in this object has to have a certain ID when + it is in a keyset.++ ++ String+ toString()+++
+- + +
++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+builder
+public static JwtEcdsaParameters.Builder builder()++
+ + + +- +
+getKidStrategy
+public JwtEcdsaParameters.KidStrategy getKidStrategy()++
+ + + +- +
+getAlgorithm
+public JwtEcdsaParameters.Algorithm getAlgorithm()++
+ + + +- +
+hasIdRequirement
+public boolean hasIdRequirement()+Description copied from class:+ParametersReturns true if a key created with the parameters in this object has to have a certain ID when + it is in a keyset. + ++In Tink, certain keys change their behavior depending on the key id (for example, an
Aeadobject can prefix the ciphertext with the big endian encoding of the key id). If this is + the case, such a key should require a unique id inKey.getIdRequirementOrNull()and + return true here.+
+- Specified by:
+- +
hasIdRequirementin classParameters+
+ + + + + + + + + + + + +- +
+allowKidAbsent
+public boolean allowKidAbsent()+Description copied from class:+JwtSignatureParametersIf true, tokens without+"kid"header are allowed when verifying a token.+
+- Specified by:
+- +
allowKidAbsentin classJwtSignatureParametersJwtEcdsaPrivateKey + + + + + + + + + + + +++com.google.crypto.tink.jwt+Class JwtEcdsaPrivateKey
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaPublicKey.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaPublicKey.Builder.html new file mode 100644 index 000000000..c37d7bf53 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaPublicKey.Builder.html @@ -0,0 +1,302 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.Key
+- +
++
+- com.google.crypto.tink.jwt.JwtSignaturePrivateKey
+- +
++
+- com.google.crypto.tink.jwt.JwtEcdsaPrivateKey
++++
+- +
++
+- All Implemented Interfaces:
+- PrivateKey
+
+
+@Immutable +public final class JwtEcdsaPrivateKey +extends JwtSignaturePrivateKey+Represents a key for computing JWT ECDSA signatures (ES256, ES384, ES512). + ++See https://datatracker.ietf.org/doc/html/rfc7518 for more information.
+++
+- + +
++
+ +- + + +
+Field Summary
++
+Fields ++ +Modifier and Type +Field and Description ++ ++ SecretBigInteger+ privateKeyValue+ ++ JwtEcdsaPublicKey+ publicKey+
+- + + +
+Method Summary
++
+All Methods Static Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ static JwtEcdsaPrivateKey+ create(JwtEcdsaPublicKey publicKey, + SecretBigInteger privateValue)+ ++ boolean+ equalsKey(Key o)+Returns true if the key is guaranteed to be equal to+other.+ ++ JwtEcdsaParameters+ getParameters()+Returns a+Parametersobject containing all the information about the key which is not + randomly chosen.+ ++ SecretBigInteger+ getPrivateValue()+ ++ JwtEcdsaPublicKey+ getPublicKey()+
+ +- + + +
+Methods inherited from class com.google.crypto.tink.jwt.JwtSignaturePrivateKey
+getIdRequirementOrNull, getKid+++
+- + +
++
+ +- + + +
+Field Detail
+ + + ++
+ + + +- +
+publicKey
+public final JwtEcdsaPublicKey publicKey++
+- +
+privateKeyValue
+public final SecretBigInteger privateKeyValue++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+create
+public static JwtEcdsaPrivateKey create(JwtEcdsaPublicKey publicKey, + SecretBigInteger privateValue) + throws GeneralSecurityException++
+- Throws:
+- +
GeneralSecurityException+
+ + + +- +
+getPrivateValue
+public SecretBigInteger getPrivateValue()++
+ + + +- +
+getParameters
+public JwtEcdsaParameters getParameters()+Description copied from class:+KeyReturns a+Parametersobject containing all the information about the key which is not + randomly chosen. + +Implementations need to ensure that
getParameters().hasIdRequirement()returns true + if and only ifgetIdRequirementOrNullis non-null.+
+- Specified by:
+- +
getParametersin classJwtSignaturePrivateKey+
+ + + +- +
+getPublicKey
+public JwtEcdsaPublicKey getPublicKey()++
+- Specified by:
+- +
getPublicKeyin interfacePrivateKey- Specified by:
+- +
getPublicKeyin classJwtSignaturePrivateKey+
+- +
+equalsKey
+public boolean equalsKey(Key o)+Description copied from class:+KeyReturns true if the key is guaranteed to be equal to+ +other. + +Implementations are required to do this in constant time. + +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. + +
Note: Tink
Keyobjects should typically not overridehashCode(because it + could risk leaking key material). Hence, they typically also should not overrideequals.JwtEcdsaPublicKey.Builder + + + + + + + + + + + +++com.google.crypto.tink.jwt+Class JwtEcdsaPublicKey.Builder
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaPublicKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaPublicKey.html new file mode 100644 index 000000000..4ac696193 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaPublicKey.html @@ -0,0 +1,392 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.jwt.JwtEcdsaPublicKey.Builder
++++
+- +
++
+- Enclosing class:
+- JwtEcdsaPublicKey
+
+
+public static class JwtEcdsaPublicKey.Builder +extends Object+Builder for EcdsaPublicKey.++++
+- + +
++
+- + + +
+Method Summary
++
+ +All Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ JwtEcdsaPublicKey+ build()+ ++ JwtEcdsaPublicKey.Builder+ setCustomKid(String customKid)+ ++ JwtEcdsaPublicKey.Builder+ setIdRequirement(Integer idRequirement)+ ++ JwtEcdsaPublicKey.Builder+ setParameters(JwtEcdsaParameters parameters)+ ++ JwtEcdsaPublicKey.Builder+ setPublicPoint(ECPoint publicPoint)+++
+- + +
++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+setParameters
+@CanIgnoreReturnValue +public JwtEcdsaPublicKey.Builder setParameters(JwtEcdsaParameters parameters)++
+ + + +- +
+setPublicPoint
+@CanIgnoreReturnValue +public JwtEcdsaPublicKey.Builder setPublicPoint(ECPoint publicPoint)++
+ + + +- +
+setIdRequirement
+@CanIgnoreReturnValue +public JwtEcdsaPublicKey.Builder setIdRequirement(Integer idRequirement)++
+ + + +- +
+setCustomKid
+@CanIgnoreReturnValue +public JwtEcdsaPublicKey.Builder setCustomKid(String customKid)++
+- +
+build
+public JwtEcdsaPublicKey build() + throws GeneralSecurityException++
+- Throws:
+- +
GeneralSecurityExceptionJwtEcdsaPublicKey + + + + + + + + + + + +++com.google.crypto.tink.jwt+Class JwtEcdsaPublicKey
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaSignKeyManager.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaSignKeyManager.html index bfdd511c3..6721b39d6 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaSignKeyManager.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtEcdsaSignKeyManager.html @@ -48,7 +48,7 @@+
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.Key
+- +
++
+- com.google.crypto.tink.jwt.JwtSignaturePublicKey
+- +
++
+- com.google.crypto.tink.jwt.JwtEcdsaPublicKey
++++
+- +
+
+
+@Immutable +public final class JwtEcdsaPublicKey +extends JwtSignaturePublicKey+JwtEcdsaPublicKey represents the public portion of JWT ECDSA keys.++++
+- + +
++
+ +- + + +
+Nested Class Summary
++
+Nested Classes ++ +Modifier and Type +Class and Description ++ ++ static class+ JwtEcdsaPublicKey.Builder+Builder for EcdsaPublicKey.++
+- + + +
+Method Summary
++
+ +All Methods Static Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ static JwtEcdsaPublicKey.Builder+ builder()+ ++ boolean+ equalsKey(Key o)+Returns true if the key is guaranteed to be equal to+other.+ ++ Integer+ getIdRequirementOrNull()+Returns null if this key has no id requirement, otherwise the required id.++ ++ Optional<String>+ getKid()+Returns the "kid" to be used for this key (https://www.rfc-editor.org/rfc/rfc7517#section-4.5).++ ++ JwtEcdsaParameters+ getParameters()+Returns the parameters of this key.++ ++ ECPoint+ getPublicPoint()+++
+- + +
++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+builder
+public static JwtEcdsaPublicKey.Builder builder()++
+ + + +- +
+getPublicPoint
+public ECPoint getPublicPoint()++
+ + + +- +
+getKid
+public Optional<String> getKid()+Description copied from class:+JwtSignaturePublicKeyReturns the "kid" to be used for this key (https://www.rfc-editor.org/rfc/rfc7517#section-4.5). + ++Note that the "kid" is not necessarily related to Tink's "Key ID" in the keyset. + +
If present, this kid will be written into the
kidheader duringcomputeMacAndEncode. If absent, no kid will be written. + +If present, and the
kidheader is present, the contents of thekidheader + needs to match the return value of this function. + +Note that
getParameters.allowKidAbsent()specifies if omitting thekid+ header is allowed. Of course, ifgetParameters.allowKidAbsent()is true, thengetKidmust not return an emptyOptional.+
+- Specified by:
+- +
getKidin classJwtSignaturePublicKey+
+ + + +- +
+getIdRequirementOrNull
+@Nullable +public Integer getIdRequirementOrNull()+Description copied from class:+KeyReturns null if this key has no id requirement, otherwise the required id. + ++Some keys, when they are in a keyset, are required to have a certain ID to work properly. + This comes from the fact that Tink in some cases prefixes ciphertexts or signatures with the + string
0x01<id>, where the ID is encoded in big endian (see the documentation of the + key type for details), in which case the key requires a certain ID.+
+- Specified by:
+- +
getIdRequirementOrNullin classKey+
+ + + +- +
+getParameters
+public JwtEcdsaParameters getParameters()+Description copied from class:+JwtSignaturePublicKeyReturns the parameters of this key.++
+- Specified by:
+- +
getParametersin classJwtSignaturePublicKey+
+- +
+equalsKey
+public boolean equalsKey(Key o)+Description copied from class:+KeyReturns true if the key is guaranteed to be equal to+ +other. + +Implementations are required to do this in constant time. + +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. + +
Note: Tink
Keyobjects should typically not overridehashCode(because it + could risk leaking key material). Hence, they typically also should not overrideequals.@@ -399,7 +399,7 @@
registerPair
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtHmacKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtHmacKey.html index 7cb3175c1..3e2cfb14e 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtHmacKey.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtHmacKey.html @@ -167,7 +167,7 @@
Method Summary
booleanequalsKey(Key o)-Returns true if the key is equal to the passed in key.+Returns true if the key is guaranteed to be equal toother.@@ -300,10 +300,15 @@ getParameters
equalsKey
public boolean equalsKey(Key o)Description copied from class:-KeyReturns true if the key is equal to the passed in key. +Returns true if the key is guaranteed to be equal toother.Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink
Keyobjects should typically not overridehashCode(because it could risk leaking key material). Hence, they typically also should not overrideequals.diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtHmacParameters.KidStrategy.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtHmacParameters.KidStrategy.html index 98d883c90..2ad1eacdf 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtHmacParameters.KidStrategy.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtHmacParameters.KidStrategy.html @@ -234,9 +234,9 @@
CUSTOM
public static final JwtHmacParameters.KidStrategy CUSTOMThe "kid" is fixed. It can be obtained fromdiff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtHmacParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtHmacParameters.html index 23d2f6be7..27da90753 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtHmacParameters.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtHmacParameters.html @@ -175,7 +175,7 @@parameters.getCustomKid(). -In
computeMacAndEncodeIf the kid is present, it needs to matchparameters.getCustomKid(). If the kid is absent, it will be accepted. +In
computeMacAndEncodeTink writes the "kid" header to the value given byparameters.getCustomKid(). -In
verifyMacAndDecodeTink writes the "kid" header to the value given byparameters.getCustomKid(). +In
verifyMacAndDecodeIf the kid is present, it needs to matchparameters.getCustomKid(). If the kid is absent, it will be accepted.Note: Tink does not allow to randomly generate new
JwtHmacKeyobjects from parameters objects withKidStrategyequals toCUSTOM.Method Summary
booleanallowKidAbsent()-If true, no+"kid"header is allowed when verifying a token.If true, tokens without"kid"header are allowed when verifying a token.@@ -299,7 +299,7 @@ hasIdRequirement
allowKidAbsent
public boolean allowKidAbsent()Description copied from class:-JwtMacParametersIf true, no+"kid"header is allowed when verifying a token.If true, tokens without"kid"header are allowed when verifying a token.
- Specified by:
- diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtMacConfig.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtMacConfig.html index bf81424a4..075f51957 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtMacConfig.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtMacConfig.html @@ -119,7 +119,7 @@
allowKidAbsentin classJwtMacParametersClass JwtMacConfig
JwtMacConfig.register(); -For more information on how to obtain and use instances of
JwtMac, seeKeysetHandle.getPrimitive(java.lang.Class<P>). +For more information on how to obtain and use instances of
JwtMac, seeKeysetHandle.getPrimitive(com.google.crypto.tink.Configuration, java.lang.Class<P>). diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtMacParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtMacParameters.html index f3456a7a0..435c3cd3d 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtMacParameters.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtMacParameters.html @@ -158,7 +158,7 @@Method Summary
abstract booleanallowKidAbsent()-If true, no+"kid"header is allowed when verifying a token.If true, tokens without"kid"header are allowed when verifying a token.Method Detail
- diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtSignatureConfig.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtSignatureConfig.html index da039e614..4e350cc4e 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtSignatureConfig.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtSignatureConfig.html @@ -49,7 +49,7 @@
allowKidAbsent
public abstract boolean allowKidAbsent()-If true, no+"kid"header is allowed when verifying a token.If true, tokens without"kid"header are allowed when verifying a token.
- Frames
@@ -328,7 +328,7 @@register
- Frames
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtSignatureParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtSignatureParameters.html new file mode 100644 index 000000000..d5bb95075 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtSignatureParameters.html @@ -0,0 +1,290 @@ + + + + + +JwtSignatureParameters + + + + + + + + + + + +++com.google.crypto.tink.jwt+Class JwtSignatureParameters
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtSignaturePrivateKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtSignaturePrivateKey.html new file mode 100644 index 000000000..2d4427c95 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtSignaturePrivateKey.html @@ -0,0 +1,377 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.Parameters
+- +
++
+- com.google.crypto.tink.jwt.JwtSignatureParameters
++++
+- +
++
+- Direct Known Subclasses:
+- JwtEcdsaParameters
+
+
+public abstract class JwtSignatureParameters +extends Parameters+Represents a description of a+JwtSignatureKeyexcluding the randomly chosen key material.++ ++
+- + +
++
+ +- + + +
+Constructor Summary
++
+Constructors ++ +Constructor and Description ++ ++ JwtSignatureParameters()+
+- + + +
+Method Summary
++
+All Methods Instance Methods Abstract Methods ++ +Modifier and Type +Method and Description ++ ++ abstract boolean+ allowKidAbsent()+If true, tokens without+"kid"header are allowed when verifying a token.+
+ +- + + +
+Methods inherited from class com.google.crypto.tink.Parameters
+hasIdRequirementJwtSignaturePrivateKey + + + + + + + + + + + +++com.google.crypto.tink.jwt+Class JwtSignaturePrivateKey
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtSignaturePublicKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtSignaturePublicKey.html new file mode 100644 index 000000000..ad0eced08 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtSignaturePublicKey.html @@ -0,0 +1,320 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.Key
+- +
++
+- com.google.crypto.tink.jwt.JwtSignaturePrivateKey
++++
+- +
++
+- All Implemented Interfaces:
+- PrivateKey
++
+- Direct Known Subclasses:
+- JwtEcdsaPrivateKey
+
+
+@Immutable + @Alpha +public abstract class JwtSignaturePrivateKey +extends Key +implements PrivateKey+Represents a key to compute JWT using asymmetric cryptography (i.e., using the+JwtPublicKeySigninterface).+++
+- + +
++
+ +- + + +
+Constructor Summary
++
+Constructors ++ +Constructor and Description ++ ++ JwtSignaturePrivateKey()+
+- + + +
+Method Summary
++
+ + +All Methods Instance Methods Abstract Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ Integer+ getIdRequirementOrNull()+Returns null if this key has no id requirement, otherwise the required id.++ ++ Optional<String>+ getKid()+Returns the "kid" to be used for this key (https://www.rfc-editor.org/rfc/rfc7517#section-4.5).++ ++ abstract JwtSignatureParameters+ getParameters()+Returns a+Parametersobject containing all the information about the key which is not + randomly chosen.+ ++ abstract JwtSignaturePublicKey+ getPublicKey()+++
+- + +
++
+ +- + + +
+Constructor Detail
+ + + ++
+- +
+JwtSignaturePrivateKey
+public JwtSignaturePrivateKey()++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+getPublicKey
+public abstract JwtSignaturePublicKey getPublicKey()++
+- Specified by:
+- +
getPublicKeyin interfacePrivateKey+
+ + + +- +
+getKid
+public Optional<String> getKid()+Returns the "kid" to be used for this key (https://www.rfc-editor.org/rfc/rfc7517#section-4.5). + ++Note that the "kid" is not necessarily related to Tink's "Key ID" in the keyset. + +
If present, this kid will be written into the
kidheader duringcomputeMacAndEncode. If absent, no kid will be written. + +If present, and the
kidheader is present, the contents of thekidheader + needs to match the return value of this function. + +Note that
getParameters.allowKidAbsent()specifies if omitting thekid+ header is allowed. Of course, ifgetParameters.allowKidAbsent()is true, thengetKidmust not return an emptyOptional.+
+ + + +- +
+getParameters
+public abstract JwtSignatureParameters getParameters()+Description copied from class:+KeyReturns a+Parametersobject containing all the information about the key which is not + randomly chosen. + +Implementations need to ensure that
getParameters().hasIdRequirement()returns true + if and only ifgetIdRequirementOrNullis non-null.+
+- Specified by:
+- +
getParametersin classKey+
+- +
+getIdRequirementOrNull
+@Nullable +public Integer getIdRequirementOrNull()+Description copied from class:+KeyReturns null if this key has no id requirement, otherwise the required id. + ++Some keys, when they are in a keyset, are required to have a certain ID to work properly. + This comes from the fact that Tink in some cases prefixes ciphertexts or signatures with the + string
0x01<id>, where the ID is encoded in big endian (see the documentation of the + key type for details), in which case the key requires a certain ID.+
+- Specified by:
+- +
getIdRequirementOrNullin classKeyJwtSignaturePublicKey + + + + + + + + + + + +++com.google.crypto.tink.jwt+Class JwtSignaturePublicKey
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtValidator.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtValidator.html index a6fff6f43..e14f3625f 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtValidator.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/JwtValidator.html @@ -48,7 +48,7 @@+
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.Key
+- +
++
+- com.google.crypto.tink.jwt.JwtSignaturePublicKey
++++
+- +
++
+- Direct Known Subclasses:
+- JwtEcdsaPublicKey
+
+
+public abstract class JwtSignaturePublicKey +extends Key+Represents a key to verify JWT using asymmetric cryptography (i.e., using the+JwtPublicKeyVerifyinterface).+++
+- + +
++
+ +- + + +
+Constructor Summary
++
+Constructors ++ +Constructor and Description ++ ++ JwtSignaturePublicKey()+
+- + + +
+Method Summary
++
+All Methods Instance Methods Abstract Methods ++ +Modifier and Type +Method and Description ++ ++ abstract Optional<String>+ getKid()+Returns the "kid" to be used for this key (https://www.rfc-editor.org/rfc/rfc7517#section-4.5).++ ++ abstract JwtSignatureParameters+ getParameters()+Returns the parameters of this key.++
+ +- + + +
+Methods inherited from class com.google.crypto.tink.Key
+equalsKey, getIdRequirementOrNull+++
+- + + + +
++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+getKid
+public abstract Optional<String> getKid()+Returns the "kid" to be used for this key (https://www.rfc-editor.org/rfc/rfc7517#section-4.5). + ++Note that the "kid" is not necessarily related to Tink's "Key ID" in the keyset. + +
If present, this kid will be written into the
kidheader duringcomputeMacAndEncode. If absent, no kid will be written. + +If present, and the
kidheader is present, the contents of thekidheader + needs to match the return value of this function. + +Note that
getParameters.allowKidAbsent()specifies if omitting thekid+ header is allowed. Of course, ifgetParameters.allowKidAbsent()is true, thengetKidmust not return an emptyOptional.+
+- +
+getParameters
+public abstract JwtSignatureParameters getParameters()+Returns the parameters of this key.++
+- Specified by:
+- +
getParametersin classKey@@ -245,7 +245,7 @@
toString
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/RawJwt.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/RawJwt.Builder.html index d02398e6d..64b0f6ee9 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/RawJwt.Builder.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/RawJwt.Builder.html @@ -17,7 +17,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -175,72 +175,79 @@
Method Summary
+ + RawJwt.Builder+ addNumberClaim(String name, + long value)+Adds a custom claim of type+longto the JWT.+ -RawJwt.BuilderaddStringClaim(String name, String value)Adds a custom claim of typeStringto the JWT.+ - RawJwtbuild()+ - RawJwt.BuildersetAudience(String value)Sets the audience that the JWT is intended for.+ - RawJwt.BuildersetAudiences(List<String> values)Sets the audiences that the JWT is intended for.+ - RawJwt.BuildersetExpiration(Instant value)Sets theexpclaim that identifies the instant on or after which the token MUST NOT be accepted for processing.+ - RawJwt.BuildersetIssuedAt(Instant value)Sets theiatclaim that identifies the instant at which the JWT was issued.+ - RawJwt.BuildersetIssuer(String value)Sets the issuer claim that identifies the principal that issued the JWT.+ - RawJwt.BuildersetJwtId(String value)Sets the JWT ID claim that provides a unique identifier for the JWT.+ - RawJwt.BuildersetNotBefore(Instant value)Sets thenbfclaim that identifies the instant before which the token MUST NOT be accepted for processing.+ - RawJwt.BuildersetSubject(String value)Sets the subject claim identifying the principal that is the subject of the JWT.+ - RawJwt.BuildersetTypeHeader(String value)Sets the Type Header Parameter.+ RawJwt.BuilderwithoutExpiration()Allow generating tokens without an expiration.@@ -449,6 +456,18 @@addBooleanClaim
Adds a custom claim of type+ + + +booleanto the JWT.+
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/RawJwt.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/RawJwt.html index e5b807e6f..a494fbeeb 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/RawJwt.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/RawJwt.html @@ -17,7 +17,7 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":10}; +var methods = {"i0":10,"i1":9,"i2":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -157,12 +157,16 @@- +
+addNumberClaim
+@CanIgnoreReturnValue +public RawJwt.Builder addNumberClaim(String name, + long value)+Adds a custom claim of type+longto the JWT.Method Summary
Method and Description + ++ String+ getJsonPayload()- static RawJwt.BuildernewBuilder()Returns a new RawJwt.Builder.+ + StringtoString()Returns a brief description of a RawJwt object.@@ -200,6 +204,15 @@newBuilder
Returns a new RawJwt.Builder.+ + + ++
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaParameters.Algorithm.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaParameters.Algorithm.html new file mode 100644 index 000000000..23bc9a4bc --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaParameters.Algorithm.html @@ -0,0 +1,203 @@ + + + + + +- +
+getJsonPayload
+public String getJsonPayload()+Uses of Class com.google.crypto.tink.jwt.JwtEcdsaParameters.Algorithm + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.jwt.JwtEcdsaParameters.Algorithm++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaParameters.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaParameters.Builder.html new file mode 100644 index 000000000..04e667e29 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaParameters.Builder.html @@ -0,0 +1,171 @@ + + + + + ++
+- +
++
+Packages that use JwtEcdsaParameters.Algorithm ++ + +Package +Description ++ + +com.google.crypto.tink.jwt ++ - +
++
+- + + +
+Uses of JwtEcdsaParameters.Algorithm in com.google.crypto.tink.jwt
++
+Fields in com.google.crypto.tink.jwt declared as JwtEcdsaParameters.Algorithm ++ + +Modifier and Type +Field and Description ++ ++ static JwtEcdsaParameters.AlgorithmJwtEcdsaParameters.Algorithm. +ES256+ECDSA using P-256 and SHA-256++ ++ static JwtEcdsaParameters.AlgorithmJwtEcdsaParameters.Algorithm. +ES384+ECDSA using P-384 and SHA-384++ + ++ static JwtEcdsaParameters.AlgorithmJwtEcdsaParameters.Algorithm. +ES512+ECDSA using P-521 and SHA-512++
+Methods in com.google.crypto.tink.jwt that return JwtEcdsaParameters.Algorithm ++ + +Modifier and Type +Method and Description ++ + ++ JwtEcdsaParameters.AlgorithmJwtEcdsaParameters. +getAlgorithm()+
+Methods in com.google.crypto.tink.jwt with parameters of type JwtEcdsaParameters.Algorithm ++ + +Modifier and Type +Method and Description ++ + ++ JwtEcdsaParameters.BuilderJwtEcdsaParameters.Builder. +setAlgorithm(JwtEcdsaParameters.Algorithm algorithm)Uses of Class com.google.crypto.tink.jwt.JwtEcdsaParameters.Builder + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.jwt.JwtEcdsaParameters.Builder++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaParameters.KidStrategy.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaParameters.KidStrategy.html new file mode 100644 index 000000000..41264b1f7 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaParameters.KidStrategy.html @@ -0,0 +1,204 @@ + + + + + ++
+- +
++
+Packages that use JwtEcdsaParameters.Builder ++ + +Package +Description ++ + +com.google.crypto.tink.jwt ++ - +
++
+- + + +
+Uses of JwtEcdsaParameters.Builder in com.google.crypto.tink.jwt
++
+Methods in com.google.crypto.tink.jwt that return JwtEcdsaParameters.Builder ++ + +Modifier and Type +Method and Description ++ ++ static JwtEcdsaParameters.BuilderJwtEcdsaParameters. +builder()+ ++ JwtEcdsaParameters.BuilderJwtEcdsaParameters.Builder. +setAlgorithm(JwtEcdsaParameters.Algorithm algorithm)+ + ++ JwtEcdsaParameters.BuilderJwtEcdsaParameters.Builder. +setKidStrategy(JwtEcdsaParameters.KidStrategy kidStrategy)Uses of Class com.google.crypto.tink.jwt.JwtEcdsaParameters.KidStrategy + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.jwt.JwtEcdsaParameters.KidStrategy++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaParameters.html new file mode 100644 index 000000000..d9dfa8a23 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaParameters.html @@ -0,0 +1,184 @@ + + + + + ++
+- +
++
+Packages that use JwtEcdsaParameters.KidStrategy ++ + +Package +Description ++ + +com.google.crypto.tink.jwt ++ - +
++
+- + + +
+Uses of JwtEcdsaParameters.KidStrategy in com.google.crypto.tink.jwt
++
+Fields in com.google.crypto.tink.jwt declared as JwtEcdsaParameters.KidStrategy ++ + +Modifier and Type +Field and Description ++ ++ static JwtEcdsaParameters.KidStrategyJwtEcdsaParameters.KidStrategy. +BASE64_ENCODED_KEY_ID+The "kid" is the URL safe (RFC 4648 Section 5) base64-encoded big-endian key_id in the + keyset.++ ++ static JwtEcdsaParameters.KidStrategyJwtEcdsaParameters.KidStrategy. +CUSTOM+The "kid" is fixed.++ + ++ static JwtEcdsaParameters.KidStrategyJwtEcdsaParameters.KidStrategy. +IGNORED+The "kid" header is ignored.++
+Methods in com.google.crypto.tink.jwt that return JwtEcdsaParameters.KidStrategy ++ + +Modifier and Type +Method and Description ++ + ++ JwtEcdsaParameters.KidStrategyJwtEcdsaParameters. +getKidStrategy()+
+Methods in com.google.crypto.tink.jwt with parameters of type JwtEcdsaParameters.KidStrategy ++ + +Modifier and Type +Method and Description ++ + ++ JwtEcdsaParameters.BuilderJwtEcdsaParameters.Builder. +setKidStrategy(JwtEcdsaParameters.KidStrategy kidStrategy)Uses of Class com.google.crypto.tink.jwt.JwtEcdsaParameters + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.jwt.JwtEcdsaParameters++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaPrivateKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaPrivateKey.html new file mode 100644 index 000000000..80c4ef3fb --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaPrivateKey.html @@ -0,0 +1,164 @@ + + + + + ++
+- +
++
+Packages that use JwtEcdsaParameters ++ + +Package +Description ++ + +com.google.crypto.tink.jwt ++ - +
++
+- + + +
+Uses of JwtEcdsaParameters in com.google.crypto.tink.jwt
++
+Methods in com.google.crypto.tink.jwt that return JwtEcdsaParameters ++ + +Modifier and Type +Method and Description ++ ++ JwtEcdsaParametersJwtEcdsaParameters.Builder. +build()+ ++ JwtEcdsaParametersJwtEcdsaPublicKey. +getParameters()+ + ++ JwtEcdsaParametersJwtEcdsaPrivateKey. +getParameters()+
+Methods in com.google.crypto.tink.jwt with parameters of type JwtEcdsaParameters ++ + +Modifier and Type +Method and Description ++ + ++ JwtEcdsaPublicKey.BuilderJwtEcdsaPublicKey.Builder. +setParameters(JwtEcdsaParameters parameters)Uses of Class com.google.crypto.tink.jwt.JwtEcdsaPrivateKey + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.jwt.JwtEcdsaPrivateKey++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaPublicKey.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaPublicKey.Builder.html new file mode 100644 index 000000000..21f3d8d31 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaPublicKey.Builder.html @@ -0,0 +1,179 @@ + + + + + ++
+- +
++
+Packages that use JwtEcdsaPrivateKey ++ + +Package +Description ++ + +com.google.crypto.tink.jwt ++ - +
++
+- + + +
+Uses of JwtEcdsaPrivateKey in com.google.crypto.tink.jwt
++
+Methods in com.google.crypto.tink.jwt that return JwtEcdsaPrivateKey ++ + +Modifier and Type +Method and Description ++ + ++ static JwtEcdsaPrivateKeyJwtEcdsaPrivateKey. +create(JwtEcdsaPublicKey publicKey, + SecretBigInteger privateValue)Uses of Class com.google.crypto.tink.jwt.JwtEcdsaPublicKey.Builder + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.jwt.JwtEcdsaPublicKey.Builder++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaPublicKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaPublicKey.html new file mode 100644 index 000000000..90df17bc4 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtEcdsaPublicKey.html @@ -0,0 +1,194 @@ + + + + + ++
+- +
++
+Packages that use JwtEcdsaPublicKey.Builder ++ + +Package +Description ++ + +com.google.crypto.tink.jwt ++ - +
++
+- + + +
+Uses of JwtEcdsaPublicKey.Builder in com.google.crypto.tink.jwt
++
+Methods in com.google.crypto.tink.jwt that return JwtEcdsaPublicKey.Builder ++ + +Modifier and Type +Method and Description ++ ++ static JwtEcdsaPublicKey.BuilderJwtEcdsaPublicKey. +builder()+ ++ JwtEcdsaPublicKey.BuilderJwtEcdsaPublicKey.Builder. +setCustomKid(String customKid)+ ++ JwtEcdsaPublicKey.BuilderJwtEcdsaPublicKey.Builder. +setIdRequirement(Integer idRequirement)+ ++ JwtEcdsaPublicKey.BuilderJwtEcdsaPublicKey.Builder. +setParameters(JwtEcdsaParameters parameters)+ + ++ JwtEcdsaPublicKey.BuilderJwtEcdsaPublicKey.Builder. +setPublicPoint(ECPoint publicPoint)Uses of Class com.google.crypto.tink.jwt.JwtEcdsaPublicKey + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.jwt.JwtEcdsaPublicKey++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtSignatureParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtSignatureParameters.html new file mode 100644 index 000000000..5a3bed3db --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtSignatureParameters.html @@ -0,0 +1,184 @@ + + + + + ++
+- +
++
+Packages that use JwtEcdsaPublicKey ++ + +Package +Description ++ + +com.google.crypto.tink.jwt ++ - +
++
+- + + +
+Uses of JwtEcdsaPublicKey in com.google.crypto.tink.jwt
++
+Fields in com.google.crypto.tink.jwt declared as JwtEcdsaPublicKey ++ + +Modifier and Type +Field and Description ++ + ++ JwtEcdsaPublicKeyJwtEcdsaPrivateKey. +publicKey+
+Methods in com.google.crypto.tink.jwt that return JwtEcdsaPublicKey ++ + +Modifier and Type +Method and Description ++ ++ JwtEcdsaPublicKeyJwtEcdsaPublicKey.Builder. +build()+ + ++ JwtEcdsaPublicKeyJwtEcdsaPrivateKey. +getPublicKey()+
+Methods in com.google.crypto.tink.jwt with parameters of type JwtEcdsaPublicKey ++ + +Modifier and Type +Method and Description ++ + ++ static JwtEcdsaPrivateKeyJwtEcdsaPrivateKey. +create(JwtEcdsaPublicKey publicKey, + SecretBigInteger privateValue)Uses of Class com.google.crypto.tink.jwt.JwtSignatureParameters + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.jwt.JwtSignatureParameters++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtSignaturePrivateKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtSignaturePrivateKey.html new file mode 100644 index 000000000..ceb998110 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtSignaturePrivateKey.html @@ -0,0 +1,165 @@ + + + + + ++
+- +
++
+Packages that use JwtSignatureParameters ++ + +Package +Description ++ + +com.google.crypto.tink.jwt ++ - +
++
+- + + +
+Uses of JwtSignatureParameters in com.google.crypto.tink.jwt
++
+Subclasses of JwtSignatureParameters in com.google.crypto.tink.jwt ++ + +Modifier and Type +Class and Description ++ + ++ class+ JwtEcdsaParameters+Describes the parameters of a+JwtEcdsaPrivateKeyor aJwtEcdsaPublicKey.+
+Methods in com.google.crypto.tink.jwt that return JwtSignatureParameters ++ + +Modifier and Type +Method and Description ++ ++ abstract JwtSignatureParametersJwtSignaturePrivateKey. +getParameters()+ + ++ abstract JwtSignatureParametersJwtSignaturePublicKey. +getParameters()+Returns the parameters of this key.+Uses of Class com.google.crypto.tink.jwt.JwtSignaturePrivateKey + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.jwt.JwtSignaturePrivateKey++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtSignaturePublicKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtSignaturePublicKey.html new file mode 100644 index 000000000..4b59ea3bf --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/JwtSignaturePublicKey.html @@ -0,0 +1,178 @@ + + + + + ++
+- +
++
+Packages that use JwtSignaturePrivateKey ++ + +Package +Description ++ + +com.google.crypto.tink.jwt ++ - +
++
+- + + +
+Uses of JwtSignaturePrivateKey in com.google.crypto.tink.jwt
++
+Subclasses of JwtSignaturePrivateKey in com.google.crypto.tink.jwt ++ + +Modifier and Type +Class and Description ++ + ++ class+ JwtEcdsaPrivateKey+Represents a key for computing JWT ECDSA signatures (ES256, ES384, ES512).+Uses of Class com.google.crypto.tink.jwt.JwtSignaturePublicKey + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.jwt.JwtSignaturePublicKey++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/RawJwt.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/RawJwt.Builder.html index 030eb1735..76ded9548 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/RawJwt.Builder.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/class-use/RawJwt.Builder.html @@ -143,74 +143,81 @@+
+- +
++
+Packages that use JwtSignaturePublicKey ++ + +Package +Description ++ + +com.google.crypto.tink.jwt ++ - +
++
+- + + +
+Uses of JwtSignaturePublicKey in com.google.crypto.tink.jwt
++
+Subclasses of JwtSignaturePublicKey in com.google.crypto.tink.jwt ++ + +Modifier and Type +Class and Description ++ + ++ class+ JwtEcdsaPublicKey+JwtEcdsaPublicKey represents the public portion of JWT ECDSA keys.++
+Methods in com.google.crypto.tink.jwt that return JwtSignaturePublicKey ++ + +Modifier and Type +Method and Description ++ + ++ abstract JwtSignaturePublicKeyJwtSignaturePrivateKey. +getPublicKey()Uses of
+ RawJwt.BuilderRawJwt.Builder. +addNumberClaim(String name, + long value)+Adds a custom claim of type+longto the JWT.+ -RawJwt.BuilderRawJwt.Builder. addStringClaim(String name, String value)Adds a custom claim of typeStringto the JWT.+ - static RawJwt.BuilderRawJwt. newBuilder()Returns a new RawJwt.Builder.+ - RawJwt.BuilderRawJwt.Builder. setAudience(String value)Sets the audience that the JWT is intended for.+ - RawJwt.BuilderRawJwt.Builder. setAudiences(List<String> values)Sets the audiences that the JWT is intended for.+ - RawJwt.BuilderRawJwt.Builder. setExpiration(Instant value)Sets theexpclaim that identifies the instant on or after which the token MUST NOT be accepted for processing.+ - RawJwt.BuilderRawJwt.Builder. setIssuedAt(Instant value)Sets theiatclaim that identifies the instant at which the JWT was issued.+ - RawJwt.BuilderRawJwt.Builder. setIssuer(String value)Sets the issuer claim that identifies the principal that issued the JWT.+ - RawJwt.BuilderRawJwt.Builder. setJwtId(String value)Sets the JWT ID claim that provides a unique identifier for the JWT.+ - RawJwt.BuilderRawJwt.Builder. setNotBefore(Instant value)Sets thenbfclaim that identifies the instant before which the token MUST NOT be accepted for processing.+ - RawJwt.BuilderRawJwt.Builder. setSubject(String value)Sets the subject claim identifying the principal that is the subject of the JWT.+ - RawJwt.BuilderRawJwt.Builder. setTypeHeader(String value)Sets the Type Header Parameter.+ RawJwt.BuilderRawJwt.Builder. withoutExpiration()Allow generating tokens without an expiration.diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-frame.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-frame.html index 8bde0213a..9e305576b 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-frame.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-frame.html @@ -21,6 +21,13 @@Interfaces
Classes
- JwkSetConverter
+- JwtEcdsaParameters
+- JwtEcdsaParameters.Algorithm
+- JwtEcdsaParameters.Builder
+- JwtEcdsaParameters.KidStrategy
+- JwtEcdsaPrivateKey
+- JwtEcdsaPublicKey
+- JwtEcdsaPublicKey.Builder
- JwtEcdsaSignKeyManager
- JwtHmacKey
- JwtHmacKey.Builder
@@ -35,6 +42,9 @@Classes
- JwtRsaSsaPkcs1SignKeyManager
- JwtRsaSsaPssSignKeyManager
- JwtSignatureConfig
+- JwtSignatureParameters
+- JwtSignaturePrivateKey
+- JwtSignaturePublicKey
- JwtValidator
- JwtValidator.Builder
- RawJwt
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-summary.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-summary.html index 05e4c1e53..11efb0c76 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-summary.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-summary.html @@ -43,7 +43,7 @@
- Frames
@@ -132,94 +132,154 @@Package com.google.crypto.tink.jwt
+ +JwtEcdsaParameters ++ +Describes the parameters of a+JwtEcdsaPrivateKeyor aJwtEcdsaPublicKey.+ +JwtEcdsaParameters.Algorithm ++ +The algorithm to be used for the signature computation.++ +JwtEcdsaParameters.Builder ++ +Helps creating a+JwtEcdsaParametersobject.+ +JwtEcdsaParameters.KidStrategy ++ +Specifies how the "kid" header is handled.++ +JwtEcdsaPrivateKey ++ +Represents a key for computing JWT ECDSA signatures (ES256, ES384, ES512).++ +JwtEcdsaPublicKey ++ +JwtEcdsaPublicKey represents the public portion of JWT ECDSA keys.++ +JwtEcdsaPublicKey.Builder ++ +Builder for EcdsaPublicKey.+- JwtEcdsaSignKeyManager JwtEcdsaSignKeykeys and produces new instances ofJwtPublicKeySign.+ - JwtHmacKey + - JwtHmacKey.Builder JwtHmacKeyobjects.+ - JwtHmacKeyManager JwtHmacKeykeys and produces new instances ofJwtHmac.+ - JwtHmacParameters JwtHmacKey.+ - JwtHmacParameters.Algorithm + - JwtHmacParameters.Builder JwtHmacParametersobject.+ - JwtHmacParameters.KidStrategy + - JwtMacConfig + - JwtMacKey JwtMacinterface).+ - JwtMacParameters JwtMacKeyexcluding the randomly chosen key material.+ - JwtRsaSsaPkcs1SignKeyManager JwtRsaSsaPkcs1PrivateKeykeys and produces new instances ofJwtPublicKeySign.+ - JwtRsaSsaPssSignKeyManager JwtRsaSsaPssPrivateKeykeys and produces new instances ofJwtPublicKeySign.+ + JwtSignatureConfig Registryall instances ofcom.google.crypto.tink.JwtPublicKeySignandPublicKeyVerifykey types supported in a particular release of Tink.+ +JwtSignatureParameters ++ +Represents a description of a+JwtSignatureKeyexcluding the randomly chosen key material.+ +JwtSignaturePrivateKey ++ +Represents a key to compute JWT using asymmetric cryptography (i.e., using the+JwtPublicKeySigninterface).+ JwtSignaturePublicKey ++ +Represents a key to verify JWT using asymmetric cryptography (i.e., using the+JwtPublicKeyVerifyinterface).JwtValidator @@ -294,7 +354,7 @@ Package com.google.crypto.tink.jwt
- Frames
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-tree.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-tree.html index 6472d6dd7..8115329c2 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-tree.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-tree.html @@ -43,7 +43,7 @@
- Frames
@@ -81,6 +81,10 @@Class Hierarchy
- java.lang.Object
+
- com.google.crypto.tink.jwt.JwkSetConverter
+- com.google.crypto.tink.jwt.JwtEcdsaParameters.Algorithm
+- com.google.crypto.tink.jwt.JwtEcdsaParameters.Builder
+- com.google.crypto.tink.jwt.JwtEcdsaParameters.KidStrategy
+- com.google.crypto.tink.jwt.JwtEcdsaPublicKey.Builder
- com.google.crypto.tink.jwt.JwtHmacKey.Builder
- com.google.crypto.tink.jwt.JwtHmacParameters.Algorithm
- com.google.crypto.tink.jwt.JwtHmacParameters.Builder
@@ -96,6 +100,16 @@Class Hierarchy
- com.google.crypto.tink.jwt.JwtHmacKey
- com.google.crypto.tink.jwt.JwtSignaturePrivateKey (implements com.google.crypto.tink.PrivateKey) +
++
+- com.google.crypto.tink.jwt.JwtEcdsaPrivateKey
+- com.google.crypto.tink.jwt.JwtSignaturePublicKey +
+
+- com.google.crypto.tink.jwt.JwtEcdsaPublicKey
+- com.google.crypto.tink.internal.KeyTypeManager<KeyProtoT> @@ -117,6 +131,11 @@
Class Hierarchy
- com.google.crypto.tink.jwt.JwtHmacParameters
+- com.google.crypto.tink.jwt.JwtSignatureParameters +
+
+- com.google.crypto.tink.jwt.JwtEcdsaParameters
+- com.google.crypto.tink.jwt.RawJwt
@@ -169,7 +188,7 @@Interface Hierarchy
- Frames
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-use.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-use.html index 4325cde2e..a21dbc6b4 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-use.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/jwt/package-use.html @@ -98,51 +98,101 @@Uses of Pac
+ +JwtEcdsaParameters + +Describes the parameters of a+JwtEcdsaPrivateKeyor aJwtEcdsaPublicKey.+ +JwtEcdsaParameters.Algorithm + +The algorithm to be used for the signature computation.++ +JwtEcdsaParameters.Builder + +Helps creating a+JwtEcdsaParametersobject.+ +JwtEcdsaParameters.KidStrategy + +Specifies how the "kid" header is handled.++ +JwtEcdsaPrivateKey + +Represents a key for computing JWT ECDSA signatures (ES256, ES384, ES512).++ +JwtEcdsaPublicKey + +JwtEcdsaPublicKey represents the public portion of JWT ECDSA keys.++ +JwtEcdsaPublicKey.Builder + +Builder for EcdsaPublicKey.+- JwtHmacKey Represents a JWT HMAC key to create and verify JWT using HMAC.+ - JwtHmacKey.Builder Helps creating newJwtHmacKeyobjects.+ - JwtHmacParameters Describes the parameters of aJwtHmacKey.+ - JwtHmacParameters.Algorithm The algorithm to be used for the mac computation.+ - JwtHmacParameters.Builder Helps creating aJwtHmacParametersobject.+ - JwtHmacParameters.KidStrategy Specifies how the "kid" header is handled.+ - JwtInvalidException This error is thrown when one of the headers or one of the claims is invalid.+ - JwtMacKey Represents a key to compute JWT using symmetric cryptography (i.e., using theJwtMacinterface).+ + JwtMacParameters Represents a description of aJwtMacKeyexcluding the randomly chosen key material.+ +JwtSignatureParameters + +Represents a description of a+JwtSignatureKeyexcluding the randomly chosen key material.+ +JwtSignaturePrivateKey + +Represents a key to compute JWT using asymmetric cryptography (i.e., using the+JwtPublicKeySigninterface).+ JwtSignaturePublicKey + +Represents a key to verify JWT using asymmetric cryptography (i.e., using the+JwtPublicKeyVerifyinterface).JwtValidator Defines how the headers and claims of a JWT should be validated.diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeyDerivationConfig.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeyDerivationConfig.html new file mode 100644 index 000000000..8e5b1f5f0 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeyDerivationConfig.html @@ -0,0 +1,255 @@ + + + + + +KeyDerivationConfig + + + + + + + + + + + +++com.google.crypto.tink.keyderivation+Class KeyDerivationConfig
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeyDerivationKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeyDerivationKey.html new file mode 100644 index 000000000..0e3636ea1 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeyDerivationKey.html @@ -0,0 +1,305 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.keyderivation.KeyDerivationConfig
++++
+- +
+
+
+public final class KeyDerivationConfig +extends Object+Static methods and constants for registering with the+Registryall + instances ofKeysetDeriverkey types supported in a particular release of Tink. + +To register all
KeysetDeriverkey types provided in the latest Tink version one can + do: + ++ ++ KeyDerivationConfig.register(); +For more information on how to obtain and use instances of
KeysetDeriver, seeKeysetHandle.getPrimitive(com.google.crypto.tink.Configuration, java.lang.Class<P>).+++
+- + +
++
+- + + +
+Method Summary
++
+ +All Methods Static Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ static void+ register()+Tries to register with the+Registryall instances ofKeyManagerneeded to handle KeysetDeriver key types supported in Tink.+++
+- + +
++
+- + + +
+Method Detail
+ + + ++
+- +
+register
+public static void register() + throws GeneralSecurityException+Tries to register with the+Registryall instances ofKeyManagerneeded to handle KeysetDeriver key types supported in Tink.+
+- Throws:
+- +
GeneralSecurityExceptionKeyDerivationKey + + + + + + + + + + + +++com.google.crypto.tink.keyderivation+Class KeyDerivationKey
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeyDerivationParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeyDerivationParameters.html new file mode 100644 index 000000000..04a8f16fa --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeyDerivationParameters.html @@ -0,0 +1,303 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.Key
+- +
++
+- com.google.crypto.tink.keyderivation.KeyDerivationKey
++++
+- +
++
+- Direct Known Subclasses:
+- PrfBasedKeyDerivationKey
+
+
+public abstract class KeyDerivationKey +extends Key+Represents a function to derive a key. + ++Tink Key Derivation is given by the primitive which maps a
byte[] saltto a Keyset. + For each key, aKeyDerivationKeymaps abyte[] saltto a new "derived"Key. For a Keyset containing multiple derivation keys, the derived keyset is obtained by mapping + each key according to this map (for the samebyte[] salt), and inserting them into a new + keyset.+++
+- + +
++
+ +- + + +
+Constructor Summary
++
+Constructors ++ +Constructor and Description ++ ++ KeyDerivationKey()+
+- + + +
+Method Summary
++
+All Methods Instance Methods Abstract Methods ++ +Modifier and Type +Method and Description ++ ++ abstract KeyDerivationParameters+ getParameters()+Returns a+Parametersobject containing all the information about the key which is not + randomly chosen.+
+ +- + + +
+Methods inherited from class com.google.crypto.tink.Key
+equalsKey, getIdRequirementOrNull+++
+- + + + +
++
+- + + +
+Method Detail
+ + + ++
+- +
+getParameters
+public abstract KeyDerivationParameters getParameters()+Description copied from class:+KeyReturns a+Parametersobject containing all the information about the key which is not + randomly chosen. + +Implementations need to ensure that
getParameters().hasIdRequirement()returns true + if and only ifgetIdRequirementOrNullis non-null.+
+- Specified by:
+- +
getParametersin classKeyKeyDerivationParameters + + + + + + + + + + + +++com.google.crypto.tink.keyderivation+Class KeyDerivationParameters
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeysetDeriver.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeysetDeriver.html new file mode 100644 index 000000000..82727fd9c --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeysetDeriver.html @@ -0,0 +1,235 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.Parameters
+- +
++
+- com.google.crypto.tink.keyderivation.KeyDerivationParameters
++++
+- +
++
+- Direct Known Subclasses:
+- PrfBasedKeyDerivationParameters
+
+
+public abstract class KeyDerivationParameters +extends Parameters+The public part of a+KeyDerivationKey.+++
+- + +
++
+ +- + + +
+Constructor Summary
++
+Constructors ++ +Constructor and Description ++ ++ KeyDerivationParameters()+
+- + + +
+Method Summary
++
+ +All Methods Instance Methods Abstract Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ abstract Parameters+ getDerivedKeyParameters()+ ++ boolean+ hasIdRequirement()+Whether this key needs a specific ID when it is in a Keyset.++++
+- + +
++
+ +- + + +
+Constructor Detail
+ + + ++
+- +
+KeyDerivationParameters
+public KeyDerivationParameters()++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+getDerivedKeyParameters
+public abstract Parameters getDerivedKeyParameters()++
+- +
+hasIdRequirement
+public boolean hasIdRequirement()+Whether this key needs a specific ID when it is in a Keyset. + ++Tink Keyset derivation always copies the ID of a key to the derived key. Hence,a
KeyDerivationKeyneeds a specific ID if and only if the derived key needs a specific ID, and + so this is always equal togetDerivedParameters().hasIdRequirement().+
+- Specified by:
+- +
hasIdRequirementin classParametersKeysetDeriver + + + + + + + + + + + +++com.google.crypto.tink.keyderivation+Interface KeysetDeriver
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeysetDeriverWrapper.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeysetDeriverWrapper.html new file mode 100644 index 000000000..1a2601405 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/KeysetDeriverWrapper.html @@ -0,0 +1,327 @@ + + + + + ++++
+- +
++
+- All Known Implementing Classes:
+- PrfBasedDeriver
+
+
+@Immutable +public interface KeysetDeriver+KeysetDeriver is the interface used to derive new keysets based on an additional input, the salt. + ++The
saltis used to create the keyset using a pseudorandom function. Implementations + must be indistinguishable from ideal KeysetDerivers, which, for every salt, generates a new + random keyset and caches it.+++
+- + +
++
+- + + +
+Method Summary
++
+All Methods Instance Methods Abstract Methods ++ +Modifier and Type +Method and Description ++ ++ KeysetHandle+ deriveKeyset(byte[] salt)+++
+- + +
++
+- + + +
+Method Detail
+ + + ++
+- +
+deriveKeyset
+KeysetHandle deriveKeyset(byte[] salt) + throws GeneralSecurityException++
+- Throws:
+- +
GeneralSecurityExceptionKeysetDeriverWrapper + + + + + + + + + + + +++com.google.crypto.tink.keyderivation+Class KeysetDeriverWrapper
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/PrfBasedKeyDerivationKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/PrfBasedKeyDerivationKey.html new file mode 100644 index 000000000..1305b5184 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/PrfBasedKeyDerivationKey.html @@ -0,0 +1,357 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.keyderivation.KeysetDeriverWrapper
++++
+- +
++
+- All Implemented Interfaces:
+- PrimitiveWrapper<KeysetDeriver,KeysetDeriver>
+
+
+public class KeysetDeriverWrapper +extends Object +implements PrimitiveWrapper<KeysetDeriver,KeysetDeriver>+KeysetDeriverWrapper is the implementation of PrimitiveWrapper for the KeysetDeriver primitive. + ++The wrapper derives a key from each key in a keyset, and returns the resulting keys as a new + keyset. Each of the derived keys inherits key_id, status, and output_prefix_type from the key + from which it was derived.
+++
+- + +
++
+- + + +
+Method Summary
++
+ +All Methods Static Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ Class<KeysetDeriver>+ getInputPrimitiveClass()+Returns the primitive class object of the primitive used to create B.++ ++ Class<KeysetDeriver>+ getPrimitiveClass()+Returns the primitive class object of the primitive managed.++ ++ static void+ register()+Registers this wrapper with Tink, allowing to use the primitive.++ ++ KeysetDeriver+ wrap(PrimitiveSet<KeysetDeriver> primitiveSet)+Wraps a+PrimitiveSetand returns a single instance.+++
+- + +
++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+wrap
+public KeysetDeriver wrap(PrimitiveSet<KeysetDeriver> primitiveSet) + throws GeneralSecurityException+Description copied from interface:+PrimitiveWrapperWraps a+PrimitiveSetand returns a single instance. + +This method gets called when a new primitive is created.
primitiveSetis immutable. + + This has to be implemented when a new primitive type is added.+
+- Specified by:
+- +
wrapin interfacePrimitiveWrapper<KeysetDeriver,KeysetDeriver>- Throws:
+- +
GeneralSecurityException+
+ + + +- +
+getPrimitiveClass
+public Class<KeysetDeriver> getPrimitiveClass()+Description copied from interface:+PrimitiveWrapperReturns the primitive class object of the primitive managed. Used for internal management. + Should be implemented as+return P.class;when implementing a wrapper creating objects + of typeP.+
+- Specified by:
+- +
getPrimitiveClassin interfacePrimitiveWrapper<KeysetDeriver,KeysetDeriver>+
+ + + +- +
+getInputPrimitiveClass
+public Class<KeysetDeriver> getInputPrimitiveClass()+Description copied from interface:+PrimitiveWrapperReturns the primitive class object of the primitive used to create B. Used for internal + management. Should be implemented as+return B.class;.+
+- Specified by:
+- +
getInputPrimitiveClassin interfacePrimitiveWrapper<KeysetDeriver,KeysetDeriver>+
+- +
+register
+public static void register() + throws GeneralSecurityException+Registers this wrapper with Tink, allowing to use the primitive.++
+- Throws:
+- +
GeneralSecurityExceptionPrfBasedKeyDerivationKey + + + + + + + + + + + +++com.google.crypto.tink.keyderivation+Class PrfBasedKeyDerivationKey
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/PrfBasedKeyDerivationParameters.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/PrfBasedKeyDerivationParameters.Builder.html new file mode 100644 index 000000000..ce782508e --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/PrfBasedKeyDerivationParameters.Builder.html @@ -0,0 +1,312 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.Key
+- +
++
+- com.google.crypto.tink.keyderivation.KeyDerivationKey
+- +
++
+- com.google.crypto.tink.keyderivation.PrfBasedKeyDerivationKey
++++
+- +
+
+
+public final class PrfBasedKeyDerivationKey +extends KeyDerivationKey+Represents a Derivation key which is based on a PRF. + ++An object of this class represents the map which 1) uses the given PRF (as specified by
getPrfKey()) to get sufficient key material from the salt, then 2) creates a key for the + parameters as specified ingetParameters().getDerivedKeyParameters().+++
+- + +
++
+- + + +
+Method Summary
++
+ +All Methods Static Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ static PrfBasedKeyDerivationKey+ create(PrfBasedKeyDerivationParameters parameters, + PrfKey prfKey, + Integer idRequirement)+ ++ boolean+ equalsKey(Key other)+Returns true if the key is guaranteed to be equal to+other.+ ++ Integer+ getIdRequirementOrNull()+Returns null if this key has no id requirement, otherwise the required id.++ ++ PrfBasedKeyDerivationParameters+ getParameters()+Returns a+Parametersobject containing all the information about the key which is not + randomly chosen.+ ++ PrfKey+ getPrfKey()+++
+- + +
++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+create
+public static PrfBasedKeyDerivationKey create(PrfBasedKeyDerivationParameters parameters, + PrfKey prfKey, + @Nullable + Integer idRequirement) + throws GeneralSecurityException++
+- Throws:
+- +
GeneralSecurityException+
+ + + +- +
+getPrfKey
+public PrfKey getPrfKey()++
+ + + +- +
+getParameters
+public PrfBasedKeyDerivationParameters getParameters()+Description copied from class:+KeyReturns a+Parametersobject containing all the information about the key which is not + randomly chosen. + +Implementations need to ensure that
getParameters().hasIdRequirement()returns true + if and only ifgetIdRequirementOrNullis non-null.+
+- Specified by:
+- +
getParametersin classKeyDerivationKey+
+ + + +- +
+getIdRequirementOrNull
+@Nullable +public Integer getIdRequirementOrNull()+Description copied from class:+KeyReturns null if this key has no id requirement, otherwise the required id. + ++Some keys, when they are in a keyset, are required to have a certain ID to work properly. + This comes from the fact that Tink in some cases prefixes ciphertexts or signatures with the + string
0x01<id>, where the ID is encoded in big endian (see the documentation of the + key type for details), in which case the key requires a certain ID.+
+- Specified by:
+- +
getIdRequirementOrNullin classKey+
+- +
+equalsKey
+public boolean equalsKey(Key other)+Description copied from class:+KeyReturns true if the key is guaranteed to be equal to+ +other. + +Implementations are required to do this in constant time. + +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. + +
Note: Tink
Keyobjects should typically not overridehashCode(because it + could risk leaking key material). Hence, they typically also should not overrideequals.PrfBasedKeyDerivationParameters.Builder + + + + + + + + + + + +++com.google.crypto.tink.keyderivation+Class PrfBasedKeyDerivationParameters.Builder
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/PrfBasedKeyDerivationParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/PrfBasedKeyDerivationParameters.html new file mode 100644 index 000000000..9954b9509 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/PrfBasedKeyDerivationParameters.html @@ -0,0 +1,363 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.keyderivation.PrfBasedKeyDerivationParameters.Builder
++++
+- +
++
+- Enclosing class:
+- PrfBasedKeyDerivationParameters
+
+
+public static class PrfBasedKeyDerivationParameters.Builder +extends Object+Builds a new PrfBasedKeyDerivationParameters instance.++++
+- + + + +
++
+- + + +
+Method Summary
++
+ +All Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ PrfBasedKeyDerivationParameters+ build()+ ++ PrfBasedKeyDerivationParameters.Builder+ setDerivedKeyParameters(Parameters derivedKeyParameters)+The parameters of the keys which are in the result keyset when the user calls+KeysetDeriver.deriveKeyset().+ ++ PrfBasedKeyDerivationParameters.Builder+ setPrfParameters(PrfParameters prfParameters)+Sets the parameters of the PRF used to create randomness from the salt.++++
+- + + + +
++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+setPrfParameters
+public PrfBasedKeyDerivationParameters.Builder setPrfParameters(PrfParameters prfParameters)+Sets the parameters of the PRF used to create randomness from the salt.++
+ + + +- +
+setDerivedKeyParameters
+public PrfBasedKeyDerivationParameters.Builder setDerivedKeyParameters(Parameters derivedKeyParameters)+The parameters of the keys which are in the result keyset when the user calls+KeysetDeriver.deriveKeyset().+
+- +
+build
+public PrfBasedKeyDerivationParameters build() + throws GeneralSecurityException++
+- Throws:
+- +
GeneralSecurityExceptionPrfBasedKeyDerivationParameters + + + + + + + + + + + +++com.google.crypto.tink.keyderivation+Class PrfBasedKeyDerivationParameters
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeyDerivationConfig.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeyDerivationConfig.html new file mode 100644 index 000000000..ea16bf715 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeyDerivationConfig.html @@ -0,0 +1,123 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.Parameters
+- +
++
+- com.google.crypto.tink.keyderivation.KeyDerivationParameters
+- +
++
+- com.google.crypto.tink.keyderivation.PrfBasedKeyDerivationParameters
++++
+- +
+
+
+@Immutable +public final class PrfBasedKeyDerivationParameters +extends KeyDerivationParameters+Represents the parameters needed in a+PrfBasedKeyDerivationKey.+++
+- + +
++
+ +- + + +
+Nested Class Summary
++
+Nested Classes ++ +Modifier and Type +Class and Description ++ ++ static class+ PrfBasedKeyDerivationParameters.Builder+Builds a new PrfBasedKeyDerivationParameters instance.++
+- + + +
+Method Summary
++
+All Methods Static Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ static PrfBasedKeyDerivationParameters.Builder+ builder()+ ++ boolean+ equals(Object o)+ ++ Parameters+ getDerivedKeyParameters()+The parameters of the keys which are in the result keyset when the user calls+KeysetDeriver.deriveKeyset().+ ++ PrfParameters+ getPrfParameters()+The parameters of the PRF used to create randomness from the salt.++ ++ int+ hashCode()+ ++ String+ toString()+
+ +- + + +
+Methods inherited from class com.google.crypto.tink.keyderivation.KeyDerivationParameters
+hasIdRequirement+++
+- + +
++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+builder
+public static PrfBasedKeyDerivationParameters.Builder builder()++
+ + + +- +
+getPrfParameters
+public PrfParameters getPrfParameters()+The parameters of the PRF used to create randomness from the salt.++
+ + + + + + + + + + + + +- +
+getDerivedKeyParameters
+public Parameters getDerivedKeyParameters()+The parameters of the keys which are in the result keyset when the user calls+KeysetDeriver.deriveKeyset().+
+- Specified by:
+- +
getDerivedKeyParametersin classKeyDerivationParametersUses of Class com.google.crypto.tink.keyderivation.KeyDerivationConfig + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.keyderivation.KeyDerivationConfigNo usage of com.google.crypto.tink.keyderivation.KeyDerivationConfig+ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeyDerivationKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeyDerivationKey.html new file mode 100644 index 000000000..ee7e31b8b --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeyDerivationKey.html @@ -0,0 +1,165 @@ + + + + + +Uses of Class com.google.crypto.tink.keyderivation.KeyDerivationKey + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.keyderivation.KeyDerivationKey++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeyDerivationParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeyDerivationParameters.html new file mode 100644 index 000000000..55756b90b --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeyDerivationParameters.html @@ -0,0 +1,178 @@ + + + + + ++
+- +
++
+Packages that use KeyDerivationKey ++ + +Package +Description ++ + +com.google.crypto.tink.keyderivation ++ - +
++
+- + + +
+Uses of KeyDerivationKey in com.google.crypto.tink.keyderivation
++
+Subclasses of KeyDerivationKey in com.google.crypto.tink.keyderivation ++ + +Modifier and Type +Class and Description ++ + ++ class+ PrfBasedKeyDerivationKey+Represents a Derivation key which is based on a PRF.+Uses of Class com.google.crypto.tink.keyderivation.KeyDerivationParameters + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.keyderivation.KeyDerivationParameters++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeysetDeriver.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeysetDeriver.html new file mode 100644 index 000000000..5ac21596a --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeysetDeriver.html @@ -0,0 +1,218 @@ + + + + + ++
+- +
++
+Packages that use KeyDerivationParameters ++ + +Package +Description ++ + +com.google.crypto.tink.keyderivation ++ - +
++
+- + + +
+Uses of KeyDerivationParameters in com.google.crypto.tink.keyderivation
++
+Subclasses of KeyDerivationParameters in com.google.crypto.tink.keyderivation ++ + +Modifier and Type +Class and Description ++ + ++ class+ PrfBasedKeyDerivationParameters+Represents the parameters needed in a+PrfBasedKeyDerivationKey.+
+Methods in com.google.crypto.tink.keyderivation that return KeyDerivationParameters ++ + +Modifier and Type +Method and Description ++ + ++ abstract KeyDerivationParametersKeyDerivationKey. +getParameters()Uses of Interface com.google.crypto.tink.keyderivation.KeysetDeriver + + + + + + + + + + +++Uses of Interface
+
com.google.crypto.tink.keyderivation.KeysetDeriver++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeysetDeriverWrapper.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeysetDeriverWrapper.html new file mode 100644 index 000000000..fea07b4a4 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/KeysetDeriverWrapper.html @@ -0,0 +1,123 @@ + + + + + ++
+- +
++
+Packages that use KeysetDeriver ++ + +Package +Description ++ +com.google.crypto.tink.keyderivation ++ + + +com.google.crypto.tink.keyderivation.internal ++ - +
++
+- + + +
+Uses of KeysetDeriver in com.google.crypto.tink.keyderivation
++
+Methods in com.google.crypto.tink.keyderivation that return KeysetDeriver ++ + +Modifier and Type +Method and Description ++ + ++ KeysetDeriverKeysetDeriverWrapper. +wrap(PrimitiveSet<KeysetDeriver> primitiveSet)+
+Methods in com.google.crypto.tink.keyderivation that return types with arguments of type KeysetDeriver ++ + +Modifier and Type +Method and Description ++ ++ Class<KeysetDeriver>KeysetDeriverWrapper. +getInputPrimitiveClass()+ + ++ Class<KeysetDeriver>KeysetDeriverWrapper. +getPrimitiveClass()+
+Method parameters in com.google.crypto.tink.keyderivation with type arguments of type KeysetDeriver ++ + +Modifier and Type +Method and Description ++ + ++ KeysetDeriverKeysetDeriverWrapper. +wrap(PrimitiveSet<KeysetDeriver> primitiveSet)- + + +
+Uses of KeysetDeriver in com.google.crypto.tink.keyderivation.internal
++
+Classes in com.google.crypto.tink.keyderivation.internal that implement KeysetDeriver ++ + +Modifier and Type +Class and Description ++ + ++ class+ PrfBasedDeriver+An implementation of+KeysetDeriver, which uses a PRF and the Tink registry to derive a +KeysetHandle.Uses of Class com.google.crypto.tink.keyderivation.KeysetDeriverWrapper + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.keyderivation.KeysetDeriverWrapperNo usage of com.google.crypto.tink.keyderivation.KeysetDeriverWrapper+ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/PrfBasedKeyDerivationKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/PrfBasedKeyDerivationKey.html new file mode 100644 index 000000000..87a44d995 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/PrfBasedKeyDerivationKey.html @@ -0,0 +1,165 @@ + + + + + +Uses of Class com.google.crypto.tink.keyderivation.PrfBasedKeyDerivationKey + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.keyderivation.PrfBasedKeyDerivationKey++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/PrfBasedKeyDerivationParameters.Builder.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/PrfBasedKeyDerivationParameters.Builder.html new file mode 100644 index 000000000..e696e1f03 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/PrfBasedKeyDerivationParameters.Builder.html @@ -0,0 +1,175 @@ + + + + + ++
+- +
++
+Packages that use PrfBasedKeyDerivationKey ++ + +Package +Description ++ + +com.google.crypto.tink.keyderivation ++ - +
++
+- + + +
+Uses of PrfBasedKeyDerivationKey in com.google.crypto.tink.keyderivation
++
+Methods in com.google.crypto.tink.keyderivation that return PrfBasedKeyDerivationKey ++ + +Modifier and Type +Method and Description ++ + ++ static PrfBasedKeyDerivationKeyPrfBasedKeyDerivationKey. +create(PrfBasedKeyDerivationParameters parameters, + PrfKey prfKey, + Integer idRequirement)Uses of Class com.google.crypto.tink.keyderivation.PrfBasedKeyDerivationParameters.Builder + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.keyderivation.PrfBasedKeyDerivationParameters.Builder++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/PrfBasedKeyDerivationParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/PrfBasedKeyDerivationParameters.html new file mode 100644 index 000000000..55d1dfd7d --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/class-use/PrfBasedKeyDerivationParameters.html @@ -0,0 +1,182 @@ + + + + + ++
+- +
++
+Packages that use PrfBasedKeyDerivationParameters.Builder ++ + +Package +Description ++ + +com.google.crypto.tink.keyderivation ++ - +
++
+- + + +
+Uses of PrfBasedKeyDerivationParameters.Builder in com.google.crypto.tink.keyderivation
++
+Methods in com.google.crypto.tink.keyderivation that return PrfBasedKeyDerivationParameters.Builder ++ + +Modifier and Type +Method and Description ++ ++ static PrfBasedKeyDerivationParameters.BuilderPrfBasedKeyDerivationParameters. +builder()+ ++ PrfBasedKeyDerivationParameters.BuilderPrfBasedKeyDerivationParameters.Builder. +setDerivedKeyParameters(Parameters derivedKeyParameters)+The parameters of the keys which are in the result keyset when the user calls+KeysetDeriver.deriveKeyset().+ + ++ PrfBasedKeyDerivationParameters.BuilderPrfBasedKeyDerivationParameters.Builder. +setPrfParameters(PrfParameters prfParameters)+Sets the parameters of the PRF used to create randomness from the salt.+Uses of Class com.google.crypto.tink.keyderivation.PrfBasedKeyDerivationParameters + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.keyderivation.PrfBasedKeyDerivationParameters++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/PrfBasedDeriver.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/PrfBasedDeriver.html new file mode 100644 index 000000000..1aa0e461a --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/PrfBasedDeriver.html @@ -0,0 +1,271 @@ + + + + + ++
+- +
++
+Packages that use PrfBasedKeyDerivationParameters ++ + +Package +Description ++ + +com.google.crypto.tink.keyderivation ++ - +
++
+- + + +
+Uses of PrfBasedKeyDerivationParameters in com.google.crypto.tink.keyderivation
++
+Methods in com.google.crypto.tink.keyderivation that return PrfBasedKeyDerivationParameters ++ + +Modifier and Type +Method and Description ++ ++ PrfBasedKeyDerivationParametersPrfBasedKeyDerivationParameters.Builder. +build()+ + ++ PrfBasedKeyDerivationParametersPrfBasedKeyDerivationKey. +getParameters()+
+Methods in com.google.crypto.tink.keyderivation with parameters of type PrfBasedKeyDerivationParameters ++ + +Modifier and Type +Method and Description ++ + ++ static PrfBasedKeyDerivationKeyPrfBasedKeyDerivationKey. +create(PrfBasedKeyDerivationParameters parameters, + PrfKey prfKey, + Integer idRequirement)PrfBasedDeriver + + + + + + + + + + + +++com.google.crypto.tink.keyderivation.internal+Class PrfBasedDeriver
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/PrfBasedDeriverKeyManager.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/PrfBasedDeriverKeyManager.html new file mode 100644 index 000000000..23546d2b4 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/PrfBasedDeriverKeyManager.html @@ -0,0 +1,440 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.keyderivation.internal.PrfBasedDeriver
++++
+- +
++
+- All Implemented Interfaces:
+- KeysetDeriver
+
+
+@Immutable +public class PrfBasedDeriver +extends Object +implements KeysetDeriver+An implementation of+KeysetDeriver, which uses a PRF and the Tink registry to derive a +KeysetHandle.+++
+- + +
++
+- + + +
+Method Summary
++
+ +All Methods Static Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ static PrfBasedDeriver+ create(KeyData streamingPrfKey, + KeyTemplate derivedKeyTemplate)+ ++ KeysetHandle+ deriveKeyset(byte[] salt)+++
+- + +
++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+create
+public static PrfBasedDeriver create(KeyData streamingPrfKey, + KeyTemplate derivedKeyTemplate) + throws GeneralSecurityException++
+- Throws:
+- +
GeneralSecurityException+
+- +
+deriveKeyset
+public KeysetHandle deriveKeyset(byte[] salt) + throws GeneralSecurityException++
+- Specified by:
+- +
deriveKeysetin interfaceKeysetDeriver- Throws:
+- +
GeneralSecurityExceptionPrfBasedDeriverKeyManager + + + + + + + + + + + +++com.google.crypto.tink.keyderivation.internal+Class PrfBasedDeriverKeyManager
+++ + + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/class-use/PrfBasedDeriver.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/class-use/PrfBasedDeriver.html new file mode 100644 index 000000000..dce9d0496 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/class-use/PrfBasedDeriver.html @@ -0,0 +1,164 @@ + + + + + ++
+- java.lang.Object
+- +
++
+- com.google.crypto.tink.internal.KeyTypeManager<PrfBasedDeriverKey>
+- +
++
+- com.google.crypto.tink.keyderivation.internal.PrfBasedDeriverKeyManager
++++
+- +
+
+
+public final class PrfBasedDeriverKeyManager +extends KeyTypeManager<PrfBasedDeriverKey>+ ++++
+- + +
++
+ +- + + +
+Nested Class Summary
++
+- + + +
+Nested classes/interfaces inherited from class com.google.crypto.tink.internal.KeyTypeManager
+KeyTypeManager.KeyFactory<KeyFormatProtoT extends com.google.protobuf.MessageLite,KeyProtoT extends com.google.protobuf.MessageLite>+
+ +- + + +
+Constructor Summary
++
+Constructors ++ +Constructor and Description ++ ++ PrfBasedDeriverKeyManager()+
+- + + +
+Method Summary
++
+All Methods Static Methods Instance Methods Concrete Methods ++ +Modifier and Type +Method and Description ++ ++ String+ getKeyType()+Returns the type URL that identifies the key type of keys managed by this KeyManager.++ ++ int+ getVersion()+Returns the version number of this KeyManager.++ ++ KeyTypeManager.KeyFactory<PrfBasedDeriverKeyFormat,PrfBasedDeriverKey>+ keyFactory()+Returns the+KeyTypeManager.KeyFactoryfor this key type.+ ++ KeyData.KeyMaterialType+ keyMaterialType()+Returns the+KeyData.KeyMaterialTypefor this proto.+ ++ PrfBasedDeriverKey+ parseKey(com.google.protobuf.ByteString byteString)+Parses a serialized key proto.++ ++ static void+ register(boolean newKeyAllowed)+ ++ void+ validateKey(PrfBasedDeriverKey key)+Checks if the given+keyProtois a valid key.+
+ +- + + +
+Methods inherited from class com.google.crypto.tink.internal.KeyTypeManager
+fipsStatus, firstSupportedPrimitiveClass, getKeyClass, getPrimitive, supportedPrimitives+++
+- + +
++
+ +- + + +
+Constructor Detail
+ + + ++
+- +
+PrfBasedDeriverKeyManager
+public PrfBasedDeriverKeyManager()++
+- + + +
+Method Detail
+ + + ++
+ + + +- +
+getKeyType
+public String getKeyType()+Description copied from class:+KeyTypeManagerReturns the type URL that identifies the key type of keys managed by this KeyManager.++
+- Specified by:
+- +
getKeyTypein classKeyTypeManager<PrfBasedDeriverKey>+
+ + + +- +
+getVersion
+public int getVersion()+Description copied from class:+KeyTypeManagerReturns the version number of this KeyManager.++
+- Specified by:
+- +
getVersionin classKeyTypeManager<PrfBasedDeriverKey>+
+ + + +- +
+keyMaterialType
+public KeyData.KeyMaterialType keyMaterialType()+Description copied from class:+KeyTypeManagerReturns the+KeyData.KeyMaterialTypefor this proto.+
+- Specified by:
+- +
keyMaterialTypein classKeyTypeManager<PrfBasedDeriverKey>+
+ + + +- +
+validateKey
+public void validateKey(PrfBasedDeriverKey key) + throws GeneralSecurityException+Description copied from class:+KeyTypeManagerChecks if the given+keyProtois a valid key.+
+- Specified by:
+- +
validateKeyin classKeyTypeManager<PrfBasedDeriverKey>- Throws:
+- +
GeneralSecurityException- if the passedkeyProtois not valid in any way.+
+ + + +- +
+parseKey
+public PrfBasedDeriverKey parseKey(com.google.protobuf.ByteString byteString) + throws com.google.protobuf.InvalidProtocolBufferException+Description copied from class:+KeyTypeManagerParses a serialized key proto. + ++Implement as
return KeyProtoT.parseFrom(byteString);.+
+- Specified by:
+- +
parseKeyin classKeyTypeManager<PrfBasedDeriverKey>- Throws:
+- +
com.google.protobuf.InvalidProtocolBufferException+
+ + + +- +
+keyFactory
+public KeyTypeManager.KeyFactory<PrfBasedDeriverKeyFormat,PrfBasedDeriverKey> keyFactory()+Description copied from class:+KeyTypeManagerReturns the+KeyTypeManager.KeyFactoryfor this key type. + +By default, this throws an UnsupportedOperationException. Hence, if an implementation does + not support creating primitives, no implementation is required.
+
+- Overrides:
+- +
keyFactoryin classKeyTypeManager<PrfBasedDeriverKey>+
+- +
+register
+public static void register(boolean newKeyAllowed) + throws GeneralSecurityException++
+- Throws:
+- +
GeneralSecurityExceptionUses of Class com.google.crypto.tink.keyderivation.internal.PrfBasedDeriver + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.keyderivation.internal.PrfBasedDeriver++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/class-use/PrfBasedDeriverKeyManager.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/class-use/PrfBasedDeriverKeyManager.html new file mode 100644 index 000000000..4584459d8 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/class-use/PrfBasedDeriverKeyManager.html @@ -0,0 +1,123 @@ + + + + + ++
+- +
++
+Packages that use PrfBasedDeriver ++ + +Package +Description ++ + +com.google.crypto.tink.keyderivation.internal ++ - +
++
+- + + +
+Uses of PrfBasedDeriver in com.google.crypto.tink.keyderivation.internal
++
+Methods in com.google.crypto.tink.keyderivation.internal that return PrfBasedDeriver ++ + +Modifier and Type +Method and Description ++ + ++ static PrfBasedDeriverPrfBasedDeriver. +create(KeyData streamingPrfKey, + KeyTemplate derivedKeyTemplate)Uses of Class com.google.crypto.tink.keyderivation.internal.PrfBasedDeriverKeyManager + + + + + + + + + + +++Uses of Class
+
com.google.crypto.tink.keyderivation.internal.PrfBasedDeriverKeyManagerNo usage of com.google.crypto.tink.keyderivation.internal.PrfBasedDeriverKeyManager+ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/package-frame.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/package-frame.html new file mode 100644 index 000000000..5ccde2b98 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/package-frame.html @@ -0,0 +1,20 @@ + + + + + +com.google.crypto.tink.keyderivation.internal + + + + +com.google.crypto.tink.keyderivation.internal
+++ + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/package-summary.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/package-summary.html new file mode 100644 index 000000000..b8a84a527 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/package-summary.html @@ -0,0 +1,150 @@ + + + + + +Classes
+ +com.google.crypto.tink.keyderivation.internal + + + + + + + + + + +++Package com.google.crypto.tink.keyderivation.internal
+++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/package-tree.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/package-tree.html new file mode 100644 index 000000000..c7b9ae2be --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/package-tree.html @@ -0,0 +1,141 @@ + + + + + ++
+- +
++
+Class Summary ++ + +Class +Description ++ +PrfBasedDeriver ++ +An implementation of+KeysetDeriver, which uses a PRF and the Tink registry to derive a +KeysetHandle.+ + +PrfBasedDeriverKeyManager ++ + +com.google.crypto.tink.keyderivation.internal Class Hierarchy + + + + + + + + + + +++Hierarchy For Package com.google.crypto.tink.keyderivation.internal
+Package Hierarchies: ++
+- All Packages
+++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/package-use.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/package-use.html new file mode 100644 index 000000000..0f9a738b8 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/internal/package-use.html @@ -0,0 +1,159 @@ + + + + + +Class Hierarchy
++
+- java.lang.Object +
++
+- com.google.crypto.tink.internal.KeyTypeManager<KeyProtoT> +
++
+- com.google.crypto.tink.keyderivation.internal.PrfBasedDeriverKeyManager
+- com.google.crypto.tink.keyderivation.internal.PrfBasedDeriver (implements com.google.crypto.tink.keyderivation.KeysetDeriver)
+Uses of Package com.google.crypto.tink.keyderivation.internal + + + + + + + + + + +++Uses of Package
+
com.google.crypto.tink.keyderivation.internal++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/package-frame.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/package-frame.html new file mode 100644 index 000000000..6b9d3bcaf --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/package-frame.html @@ -0,0 +1,29 @@ + + + + + ++
+- +
++
+Packages that use com.google.crypto.tink.keyderivation.internal ++ + +Package +Description ++ + +com.google.crypto.tink.keyderivation.internal ++ - + + +
++
+Classes in com.google.crypto.tink.keyderivation.internal used by com.google.crypto.tink.keyderivation.internal ++ + +Class and Description ++ + +PrfBasedDeriver + +An implementation of+KeysetDeriver, which uses a PRF and the Tink registry to derive a +KeysetHandle.com.google.crypto.tink.keyderivation + + + + +com.google.crypto.tink.keyderivation
+++ + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/package-summary.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/package-summary.html new file mode 100644 index 000000000..bbe643769 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/package-summary.html @@ -0,0 +1,197 @@ + + + + + +Interfaces
+ +Classes
+ +com.google.crypto.tink.keyderivation + + + + + + + + + + +++Package com.google.crypto.tink.keyderivation
+++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/package-tree.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/package-tree.html new file mode 100644 index 000000000..4ad203b99 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/package-tree.html @@ -0,0 +1,160 @@ + + + + + ++
+- +
++
+Interface Summary ++ + +Interface +Description ++ + +KeysetDeriver ++ +KeysetDeriver is the interface used to derive new keysets based on an additional input, the salt.+- +
++
+Class Summary ++ + +Class +Description ++ +KeyDerivationConfig ++ +Static methods and constants for registering with the+Registryall + instances ofKeysetDeriverkey types supported in a particular release of Tink.+ +KeyDerivationKey ++ +Represents a function to derive a key.++ +KeyDerivationParameters ++ +The public part of a+KeyDerivationKey.+ +KeysetDeriverWrapper ++ +KeysetDeriverWrapper is the implementation of PrimitiveWrapper for the KeysetDeriver primitive.++ +PrfBasedKeyDerivationKey ++ +Represents a Derivation key which is based on a PRF.++ +PrfBasedKeyDerivationParameters ++ +Represents the parameters needed in a+PrfBasedKeyDerivationKey.+ + +PrfBasedKeyDerivationParameters.Builder ++ +Builds a new PrfBasedKeyDerivationParameters instance.+com.google.crypto.tink.keyderivation Class Hierarchy + + + + + + + + + + +++Hierarchy For Package com.google.crypto.tink.keyderivation
+Package Hierarchies: ++
+- All Packages
+++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/package-use.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/package-use.html new file mode 100644 index 000000000..9abe937d7 --- /dev/null +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/keyderivation/package-use.html @@ -0,0 +1,204 @@ + + + + + +Class Hierarchy
++
+- java.lang.Object +
++
+- com.google.crypto.tink.Key +
++
+- com.google.crypto.tink.keyderivation.KeyDerivationKey +
++
+- com.google.crypto.tink.keyderivation.PrfBasedKeyDerivationKey
+- com.google.crypto.tink.keyderivation.KeyDerivationConfig
+- com.google.crypto.tink.keyderivation.KeysetDeriverWrapper (implements com.google.crypto.tink.PrimitiveWrapper<B,P>)
+- com.google.crypto.tink.Parameters +
++
+- com.google.crypto.tink.keyderivation.KeyDerivationParameters +
++
+- com.google.crypto.tink.keyderivation.PrfBasedKeyDerivationParameters
+- com.google.crypto.tink.keyderivation.PrfBasedKeyDerivationParameters.Builder
+Interface Hierarchy
++
+- com.google.crypto.tink.keyderivation.KeysetDeriver
+Uses of Package com.google.crypto.tink.keyderivation + + + + + + + + + + +++Uses of Package
+
com.google.crypto.tink.keyderivation++ + + + + + diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/AesCmacKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/AesCmacKey.html index 9fad2318e..a746d7385 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/AesCmacKey.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/AesCmacKey.html @@ -171,7 +171,7 @@+
+- +
++
+Packages that use com.google.crypto.tink.keyderivation ++ + +Package +Description ++ +com.google.crypto.tink.keyderivation ++ + + +com.google.crypto.tink.keyderivation.internal ++ - + + +
++
+Classes in com.google.crypto.tink.keyderivation used by com.google.crypto.tink.keyderivation ++ + +Class and Description ++ +KeyDerivationKey + +Represents a function to derive a key.++ +KeyDerivationParameters + +The public part of a+KeyDerivationKey.+ +KeysetDeriver + +KeysetDeriver is the interface used to derive new keysets based on an additional input, the salt.++ +PrfBasedKeyDerivationKey + +Represents a Derivation key which is based on a PRF.++ +PrfBasedKeyDerivationParameters + +Represents the parameters needed in a+PrfBasedKeyDerivationKey.+ + +PrfBasedKeyDerivationParameters.Builder + +Builds a new PrfBasedKeyDerivationParameters instance.+- + + +
++
+Classes in com.google.crypto.tink.keyderivation used by com.google.crypto.tink.keyderivation.internal ++ + +Class and Description ++ + +KeysetDeriver + +KeysetDeriver is the interface used to derive new keysets based on an additional input, the salt.+Method Summary
booleanequalsKey(Key o)-Returns true if the key is equal to the passed in key.+Returns true if the key is guaranteed to be equal toother.@@ -306,10 +306,15 @@ getIdRequirementOrNull
equalsKey
public boolean equalsKey(Key o)Description copied from class:-KeyReturns true if the key is equal to the passed in key. +Returns true if the key is guaranteed to be equal toother.Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink
Keyobjects should typically not overridehashCode(because it could risk leaking key material). Hence, they typically also should not overrideequals.diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/HmacKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/HmacKey.html index 0a95494a5..5a7938eb4 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/HmacKey.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/HmacKey.html @@ -172,7 +172,7 @@
Method Summary
booleanequalsKey(Key o)-Returns true if the key is equal to the passed in key.+Returns true if the key is guaranteed to be equal toother.@@ -307,10 +307,15 @@ getIdRequirementOrNull
equalsKey
public boolean equalsKey(Key o)Description copied from class:-KeyReturns true if the key is equal to the passed in key. ++Returns true if the key is guaranteed to be equal toother.Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink
Keyobjects should typically not overridehashCode(because it could risk leaking key material). Hence, they typically also should not overrideequals.diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/MacConfig.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/MacConfig.html index 775709305..ee34414fd 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/MacConfig.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/MacConfig.html @@ -120,7 +120,7 @@
Class MacConfig
MacConfig.register(); -For more information on how to obtain and use instances of Mac, see
KeysetHandle.getPrimitive(java.lang.Class<P>).For more information on how to obtain and use instances of Mac, see
KeysetHandle.getPrimitive(com.google.crypto.tink.Configuration, java.lang.Class<P>).
- Since:
- 1.0.0
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/MacKeyTemplates.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/MacKeyTemplates.html index e06d61d1d..93286ad97 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/MacKeyTemplates.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/MacKeyTemplates.html @@ -17,8 +17,8 @@ catch(err) { } //--> -var methods = {"i0":9}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var methods = {"i0":41}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -107,8 +107,12 @@Class MacKeyTemplates
+Deprecated. +Use PredefinedMacParameters instead.+
-public final class MacKeyTemplates +@Deprecated +public final class MacKeyTemplates extends ObjectPre-generatedKeyTemplateforMac. @@ -160,6 +164,7 @@Field Summary
static KeyTemplateAES_CMAC+Deprecated.AKeyTemplatethat generates new instances ofcom.google.crypto.tink.proto.CmacKeywith the following parameters: @@ -172,6 +177,7 @@Field Summary
static KeyTemplateHMAC_SHA256_128BITTAG+Deprecated.AKeyTemplatethat generates new instances ofHmacKeywith the following parameters: @@ -185,6 +191,7 @@Field Summary
static KeyTemplateHMAC_SHA256_256BITTAG+Deprecated.AKeyTemplatethat generates new instances ofHmacKeywith the following parameters: @@ -198,6 +205,7 @@Field Summary
static KeyTemplateHMAC_SHA512_256BITTAG+Deprecated.AKeyTemplatethat generates new instances ofHmacKeywith the following parameters: @@ -211,6 +219,7 @@Field Summary
+ static KeyTemplateHMAC_SHA512_512BITTAG+Deprecated.AKeyTemplatethat generates new instances ofHmacKeywith the following parameters: @@ -231,7 +240,7 @@Field Summary
Method Summary
-
All Methods Static Methods Concrete Methods +All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method and Description @@ -240,7 +249,9 @@Method Summary
static KeyTemplate+ HashType hashType) + createHmacKeyTemplate(int keySize, int tagSize, - HashType hashType)Deprecated.+@@ -271,6 +282,7 @@
Field Detail
HMAC_SHA256_128BITTAG
public static final KeyTemplate HMAC_SHA256_128BITTAG+Deprecated.AKeyTemplatethat generates new instances ofHmacKeywith the following parameters:@@ -288,6 +300,7 @@
HMAC_SHA256_128BITTAG
HMAC_SHA256_256BITTAG
public static final KeyTemplate HMAC_SHA256_256BITTAG+Deprecated.AKeyTemplatethat generates new instances ofHmacKeywith the following parameters:@@ -305,6 +318,7 @@
HMAC_SHA256_256BITTAG
HMAC_SHA512_256BITTAG
public static final KeyTemplate HMAC_SHA512_256BITTAG+Deprecated.AKeyTemplatethat generates new instances ofHmacKeywith the following parameters:@@ -322,6 +336,7 @@
HMAC_SHA512_256BITTAG
HMAC_SHA512_512BITTAG
public static final KeyTemplate HMAC_SHA512_512BITTAG+Deprecated.AKeyTemplatethat generates new instances ofHmacKeywith the following parameters:@@ -339,6 +354,7 @@
HMAC_SHA512_512BITTAG
AES_CMAC
public static final KeyTemplate AES_CMAC+Deprecated.AKeyTemplatethat generates new instances ofcom.google.crypto.tink.proto.CmacKeywith the following parameters:@@ -365,6 +381,7 @@
createHmacKeyTemplate
public static KeyTemplate createHmacKeyTemplate(int keySize, int tagSize, HashType hashType)+Deprecated.
- Returns:
- a
KeyTemplatecontaining aHmacKeyFormatwith some specified diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/class-use/AesCmacKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/class-use/AesCmacKey.html index 29d120c89..211fffdfc 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/class-use/AesCmacKey.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/class-use/AesCmacKey.html @@ -89,6 +89,10 @@Us
com.google.crypto.tink.mac.internal + com.google.crypto.tink.subtle ++ Uses of + + +
Uses of AesCmacKey in com.google.crypto.tink.subtle
++
+ diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/class-use/HmacKey.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/class-use/HmacKey.html index 41e48afe1..da5d92998 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/class-use/HmacKey.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/class-use/HmacKey.html @@ -89,6 +89,10 @@Methods in com.google.crypto.tink.subtle with parameters of type AesCmacKey ++ + +Modifier and Type +Method and Description ++ + ++ static MacPrfMac. +create(AesCmacKey key)+Creates an object implementing the+Macinterface using an AesCmac underneath.Uses
com.google.crypto.tink.mac.internal + com.google.crypto.tink.subtle ++ Uses of +
- + + +
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/package-summary.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/package-summary.html index f36ab574e..ffbc9c39b 100644 --- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/package-summary.html +++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/mac/package-summary.html @@ -42,7 +42,7 @@Uses of HmacKey in com.google.crypto.tink.subtle
++
+Methods in com.google.crypto.tink.subtle with parameters of type HmacKey ++ + +Modifier and Type +Method and Description ++ + ++ static MacPrfMac. +create(HmacKey key)+Creates an object implementing the+Macinterface using an Hmac underneath.@@ -216,8 +216,8 @@
Package com.google.crypto.tink.mac
KeyTemplate for Mac.| Class and Description | +
|---|
| AesCmacKey
+ Represents a key computing AES-CMAC.
+ |
+
| HmacKey
+ Represents a key computing HMAC.
+ |
+
SecretKeyAccess tokens.KeysetReader that can read from source source cleartext or encrypted keysets in Package com.google.crypto.tink
JSON format.KeysetWriter that can write to some source cleartext or encrypted keysets in Package com.google.crypto.tink
JSON format.Keyset, to limit the exposure of actual
protocol buffers that hold sensitive key material.KeysetHandle objects.Keyset proto, with convenience methods that rotate, disable, enable or destroy
keys.KeyTemplate objects.KmsClient-objects that are needed by KeyManager-objects for
primitives that use KMS-managed keys.KeysetReader that can read from source source cleartext or encrypted keysets in proto
JSON format.Keyset, to limit the exposure of actual
protocol buffers that hold sensitive key material.KeysetHandle objects.Keyset proto, with convenience methods that rotate, disable, enable or destroy
keys.Keyset or an EncryptedKeyset from some source.Keyset or an EncryptedKeyset to some storage
system.Keyset, to limit the exposure of actual
protocol buffers that hold sensitive key material.Keyset, to limit the exposure of actual
protocol buffers that hold sensitive key material.| Class and Description | +
|---|
| Key
+ Represents a cryptographic object.
+ |
+
| KeysetHandle
+ A KeysetHandle provides abstracted access to
+Keyset, to limit the exposure of actual
+ protocol buffers that hold sensitive key material. |
+
| Parameters
+ Represents a cryptographic function without the actual key material.
+ |
+
| PrimitiveSet
+ A container class for a set of primitives -- implementations of cryptographic primitives offered
+ by Tink.
+ |
+
| PrimitiveWrapper
+ Basic interface for wrapping a primitive.
+ |
+
| Class and Description | +
|---|
| KeysetHandle
+ A KeysetHandle provides abstracted access to
+Keyset, to limit the exposure of actual
+ protocol buffers that hold sensitive key material. |
+
booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
public final class PredefinedPrfParameters +extends Object+
Parameters for PRF-Keys.
+
+ Note: if you want to keep dependencies small, consider inlining the constants here.
| Modifier and Type | +Field and Description | +
|---|---|
static AesCmacPrfParameters |
+AES_CMAC_PRF
+A
+Parameters object for generating new instances of AesCmacKey with the
+ following parameters:
+
+
+ HMAC key size: 32 bytes
+ |
+
static HkdfPrfParameters |
+HKDF_SHA256
+A
+Parameters object for generating new instances of HkdfPrfKey with the
+ following parameters:
+
+
+ Hash function: SHA256
+ HMAC key size: 32 bytes
+ Salt: empty
+ |
+
static HmacPrfParameters |
+HMAC_SHA256_PRF
+A
+Parameters object for generating new instances of HmacPrfKey with the
+ following parameters:
+
+
+ Hash function: SHA256
+ HMAC key size: 32 bytes
+ |
+
static HmacPrfParameters |
+HMAC_SHA512_PRF
+A
+Parameters object for generating new instances of HmacPrfKey with the
+ following parameters:
+
+
+ Hash function: SHA512
+ HMAC key size: 64 bytes
+ |
+
public static final HkdfPrfParameters HKDF_SHA256+
Parameters object for generating new instances of HkdfPrfKey with the
+ following parameters:
+
+ public static final HmacPrfParameters HMAC_SHA256_PRF+
Parameters object for generating new instances of HmacPrfKey with the
+ following parameters:
+
+ public static final HmacPrfParameters HMAC_SHA512_PRF+
Parameters object for generating new instances of HmacPrfKey with the
+ following parameters:
+
+ public static final AesCmacPrfParameters AES_CMAC_PRF+
Parameters object for generating new instances of AesCmacKey with the
+ following parameters:
+
+ public final class PrfKeyTemplates +@Deprecated +public final class PrfKeyTemplates extends ObjectKey templates for PRF-Keys. @@ -139,22 +143,29 @@Field Summary
static KeyTemplateAES_CMAC_PRF AES_CMAC_PRF
+static KeyTemplateHKDF_SHA256
+KeyTemplate for a HkdfPrfKey key with
the following parameters.static KeyTemplateHMAC_SHA256_PRF HMAC_SHA256_PRF
+static KeyTemplateHMAC_SHA512_PRF HMAC_SHA512_PRF
+public static final KeyTemplate HKDF_SHA256+
KeyTemplate for a HkdfPrfKey key with
the following parameters.
@@ -210,6 +222,7 @@ public static final KeyTemplate HMAC_SHA256_PRF+
public static final KeyTemplate HMAC_SHA512_PRF+
public static final KeyTemplate AES_CMAC_PRF+
| Modifier and Type | +Method and Description | +
|---|---|
static Prf |
+PrfAesCmac.create(AesCmacPrfKey key) |
+
| Modifier and Type | +Field and Description | +
|---|---|
static AesCmacPrfParameters |
+PredefinedPrfParameters.AES_CMAC_PRF
+A
+Parameters object for generating new instances of AesCmacKey with the
+ following parameters:
+
+
+ HMAC key size: 32 bytes
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
static HkdfPrfParameters |
+PredefinedPrfParameters.HKDF_SHA256
+A
+Parameters object for generating new instances of HkdfPrfKey with the
+ following parameters:
+
+
+ Hash function: SHA256
+ HMAC key size: 32 bytes
+ Salt: empty
+ |
+
| com.google.crypto.tink.prf | |
| com.google.crypto.tink.subtle | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static Prf |
+PrfHmacJce.create(HmacPrfKey key)
+Given an HmacPrfKey, returns an instance of the Prf interface.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
static HmacPrfParameters |
+PredefinedPrfParameters.HMAC_SHA256_PRF
+A
+Parameters object for generating new instances of HmacPrfKey with the
+ following parameters:
+
+
+ Hash function: SHA256
+ HMAC key size: 32 bytes
+ |
+
static HmacPrfParameters |
+PredefinedPrfParameters.HMAC_SHA512_PRF
+A
+Parameters object for generating new instances of HmacPrfKey with the
+ following parameters:
+
+
+ Hash function: SHA512
+ HMAC key size: 64 bytes
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Prf |
+PrfAesCmac.create(AesCmacPrfKey key) |
+
static Prf |
+PrfHmacJce.create(HmacPrfKey key)
+Given an HmacPrfKey, returns an instance of the Prf interface.
+ |
+
| com.google.crypto.tink.keyderivation | ++ | |
| com.google.crypto.tink.prf |
| Modifier and Type | +Method and Description | +
|---|---|
PrfKey |
+PrfBasedKeyDerivationKey.getPrfKey() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static PrfBasedKeyDerivationKey |
+PrfBasedKeyDerivationKey.create(PrfBasedKeyDerivationParameters parameters,
+ PrfKey prfKey,
+ Integer idRequirement) |
+
| Modifier and Type | +Method and Description | +
|---|---|
PrfParameters |
+PrfBasedKeyDerivationParameters.getPrfParameters()
+The parameters of the PRF used to create randomness from the salt.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
PrfBasedKeyDerivationParameters.Builder |
+PrfBasedKeyDerivationParameters.Builder.setPrfParameters(PrfParameters prfParameters)
+Sets the parameters of the PRF used to create randomness from the salt.
+ |
+
Parameters for PRF-Keys.Registry all instances of StreamingPrf key types supported in a particular release of
Tink.PrfKey excluding the randomly chosen key material.| Class and Description | +
|---|
| PrfKey
+ Represents functions to compute a PRF.
+ |
+
| PrfParameters
+ Represents a description of a
+PrfKey excluding the randomly chosen key material. |
+
public final class PrfBasedDeriver +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry) |
+
public static final class PrfBasedDeriverKey.Builder +extends com.google.protobuf.GeneratedMessageLite.Builder<PrfBasedDeriverKey,PrfBasedDeriverKey.Builder> +implements PrfBasedDeriverKeyOrBuilder+
+ key_type: type.googleapis.com/google.crypto.tink.PrfBasedDeriverKey ++ + Protobuf type
google.crypto.tink.PrfBasedDeriverKeyinstance| Modifier and Type | +Method and Description | +
|---|---|
PrfBasedDeriverKey.Builder |
+clearParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
PrfBasedDeriverKey.Builder |
+clearPrfKey()
+.google.crypto.tink.KeyData prf_key = 2; |
+
PrfBasedDeriverKey.Builder |
+clearVersion()
+uint32 version = 1; |
+
PrfBasedDeriverParams |
+getParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
KeyData |
+getPrfKey()
+.google.crypto.tink.KeyData prf_key = 2; |
+
int |
+getVersion()
+uint32 version = 1; |
+
boolean |
+hasParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
boolean |
+hasPrfKey()
+.google.crypto.tink.KeyData prf_key = 2; |
+
PrfBasedDeriverKey.Builder |
+mergeParams(PrfBasedDeriverParams value)
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
PrfBasedDeriverKey.Builder |
+mergePrfKey(KeyData value)
+.google.crypto.tink.KeyData prf_key = 2; |
+
PrfBasedDeriverKey.Builder |
+setParams(PrfBasedDeriverParams.Builder builderForValue)
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
PrfBasedDeriverKey.Builder |
+setParams(PrfBasedDeriverParams value)
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
PrfBasedDeriverKey.Builder |
+setPrfKey(KeyData.Builder builderForValue)
+.google.crypto.tink.KeyData prf_key = 2; |
+
PrfBasedDeriverKey.Builder |
+setPrfKey(KeyData value)
+.google.crypto.tink.KeyData prf_key = 2; |
+
PrfBasedDeriverKey.Builder |
+setVersion(int value)
+uint32 version = 1; |
+
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFromaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetDefaultInstanceForType, isInitializedpublic int getVersion()+
uint32 version = 1;getVersion in interface PrfBasedDeriverKeyOrBuilderpublic PrfBasedDeriverKey.Builder setVersion(int value)+
uint32 version = 1;value - The version to set.public PrfBasedDeriverKey.Builder clearVersion()+
uint32 version = 1;public boolean hasPrfKey()+
.google.crypto.tink.KeyData prf_key = 2;hasPrfKey in interface PrfBasedDeriverKeyOrBuilderpublic KeyData getPrfKey()+
.google.crypto.tink.KeyData prf_key = 2;getPrfKey in interface PrfBasedDeriverKeyOrBuilderpublic PrfBasedDeriverKey.Builder setPrfKey(KeyData value)+
.google.crypto.tink.KeyData prf_key = 2;public PrfBasedDeriverKey.Builder setPrfKey(KeyData.Builder builderForValue)+
.google.crypto.tink.KeyData prf_key = 2;public PrfBasedDeriverKey.Builder mergePrfKey(KeyData value)+
.google.crypto.tink.KeyData prf_key = 2;public PrfBasedDeriverKey.Builder clearPrfKey()+
.google.crypto.tink.KeyData prf_key = 2;public boolean hasParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 3;hasParams in interface PrfBasedDeriverKeyOrBuilderpublic PrfBasedDeriverParams getParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 3;getParams in interface PrfBasedDeriverKeyOrBuilderpublic PrfBasedDeriverKey.Builder setParams(PrfBasedDeriverParams value)+
.google.crypto.tink.PrfBasedDeriverParams params = 3;public PrfBasedDeriverKey.Builder setParams(PrfBasedDeriverParams.Builder builderForValue)+
.google.crypto.tink.PrfBasedDeriverParams params = 3;public PrfBasedDeriverKey.Builder mergeParams(PrfBasedDeriverParams value)+
.google.crypto.tink.PrfBasedDeriverParams params = 3;public PrfBasedDeriverKey.Builder clearParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 3;public final class PrfBasedDeriverKey +extends com.google.protobuf.GeneratedMessageLite<PrfBasedDeriverKey,PrfBasedDeriverKey.Builder> +implements PrfBasedDeriverKeyOrBuilder+
+ key_type: type.googleapis.com/google.crypto.tink.PrfBasedDeriverKey ++ + Protobuf type
google.crypto.tink.PrfBasedDeriverKey| Modifier and Type | +Class and Description | +
|---|---|
static class |
+PrfBasedDeriverKey.Builder
+
+ key_type: type.googleapis.com/google.crypto.tink.PrfBasedDeriverKey
+ |
+
com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedFormcom.google.protobuf.AbstractMessageLite.InternalOneOfEnum| Modifier and Type | +Field and Description | +
|---|---|
static int |
+PARAMS_FIELD_NUMBER |
+
static int |
+PRF_KEY_FIELD_NUMBER |
+
static int |
+VERSION_FIELD_NUMBER |
+
unknownFieldsmemoizedHashCode| Modifier and Type | +Method and Description | +
|---|---|
protected Object |
+dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method,
+ Object arg0,
+ Object arg1) |
+
static PrfBasedDeriverKey |
+getDefaultInstance() |
+
PrfBasedDeriverParams |
+getParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
KeyData |
+getPrfKey()
+.google.crypto.tink.KeyData prf_key = 2; |
+
int |
+getVersion()
+uint32 version = 1; |
+
boolean |
+hasParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
boolean |
+hasPrfKey()
+.google.crypto.tink.KeyData prf_key = 2; |
+
static PrfBasedDeriverKey.Builder |
+newBuilder() |
+
static PrfBasedDeriverKey.Builder |
+newBuilder(PrfBasedDeriverKey prototype) |
+
static PrfBasedDeriverKey |
+parseDelimitedFrom(InputStream input) |
+
static PrfBasedDeriverKey |
+parseDelimitedFrom(InputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKey |
+parseFrom(byte[] data) |
+
static PrfBasedDeriverKey |
+parseFrom(byte[] data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKey |
+parseFrom(ByteBuffer data) |
+
static PrfBasedDeriverKey |
+parseFrom(ByteBuffer data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKey |
+parseFrom(com.google.protobuf.ByteString data) |
+
static PrfBasedDeriverKey |
+parseFrom(com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKey |
+parseFrom(com.google.protobuf.CodedInputStream input) |
+
static PrfBasedDeriverKey |
+parseFrom(com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKey |
+parseFrom(InputStream input) |
+
static PrfBasedDeriverKey |
+parseFrom(InputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static com.google.protobuf.Parser<PrfBasedDeriverKey> |
+parser() |
+
createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeToaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetDefaultInstanceForType, isInitializedpublic static final int VERSION_FIELD_NUMBER+
public static final int PRF_KEY_FIELD_NUMBER+
public static final int PARAMS_FIELD_NUMBER+
public int getVersion()+
uint32 version = 1;getVersion in interface PrfBasedDeriverKeyOrBuilderpublic boolean hasPrfKey()+
.google.crypto.tink.KeyData prf_key = 2;hasPrfKey in interface PrfBasedDeriverKeyOrBuilderpublic KeyData getPrfKey()+
.google.crypto.tink.KeyData prf_key = 2;getPrfKey in interface PrfBasedDeriverKeyOrBuilderpublic boolean hasParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 3;hasParams in interface PrfBasedDeriverKeyOrBuilderpublic PrfBasedDeriverParams getParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 3;getParams in interface PrfBasedDeriverKeyOrBuilderpublic static PrfBasedDeriverKey parseFrom(ByteBuffer data) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverKey parseFrom(ByteBuffer data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverKey parseFrom(com.google.protobuf.ByteString data) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverKey parseFrom(com.google.protobuf.ByteString data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverKey parseFrom(byte[] data) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverKey parseFrom(byte[] data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverKey parseFrom(InputStream input) + throws IOException+
IOExceptionpublic static PrfBasedDeriverKey parseFrom(InputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws IOException+
IOExceptionpublic static PrfBasedDeriverKey parseDelimitedFrom(InputStream input) + throws IOException+
IOExceptionpublic static PrfBasedDeriverKey parseDelimitedFrom(InputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws IOException+
IOExceptionpublic static PrfBasedDeriverKey parseFrom(com.google.protobuf.CodedInputStream input) + throws IOException+
IOExceptionpublic static PrfBasedDeriverKey parseFrom(com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws IOException+
IOExceptionpublic static PrfBasedDeriverKey.Builder newBuilder()+
public static PrfBasedDeriverKey.Builder newBuilder(PrfBasedDeriverKey prototype)+
protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, + Object arg0, + Object arg1)+
dynamicMethod in class com.google.protobuf.GeneratedMessageLite<PrfBasedDeriverKey,PrfBasedDeriverKey.Builder>public static PrfBasedDeriverKey getDefaultInstance()+
public static com.google.protobuf.Parser<PrfBasedDeriverKey> parser()+
public static final class PrfBasedDeriverKeyFormat.Builder +extends com.google.protobuf.GeneratedMessageLite.Builder<PrfBasedDeriverKeyFormat,PrfBasedDeriverKeyFormat.Builder> +implements PrfBasedDeriverKeyFormatOrBuilder+
google.crypto.tink.PrfBasedDeriverKeyFormatinstance| Modifier and Type | +Method and Description | +
|---|---|
PrfBasedDeriverKeyFormat.Builder |
+clearParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverKeyFormat.Builder |
+clearPrfKeyTemplate()
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
PrfBasedDeriverParams |
+getParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
KeyTemplate |
+getPrfKeyTemplate()
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
boolean |
+hasParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
boolean |
+hasPrfKeyTemplate()
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
PrfBasedDeriverKeyFormat.Builder |
+mergeParams(PrfBasedDeriverParams value)
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverKeyFormat.Builder |
+mergePrfKeyTemplate(KeyTemplate value)
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
PrfBasedDeriverKeyFormat.Builder |
+setParams(PrfBasedDeriverParams.Builder builderForValue)
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverKeyFormat.Builder |
+setParams(PrfBasedDeriverParams value)
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverKeyFormat.Builder |
+setPrfKeyTemplate(KeyTemplate.Builder builderForValue)
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
PrfBasedDeriverKeyFormat.Builder |
+setPrfKeyTemplate(KeyTemplate value)
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFromaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetDefaultInstanceForType, isInitializedpublic boolean hasPrfKeyTemplate()+
.google.crypto.tink.KeyTemplate prf_key_template = 1;hasPrfKeyTemplate in interface PrfBasedDeriverKeyFormatOrBuilderpublic KeyTemplate getPrfKeyTemplate()+
.google.crypto.tink.KeyTemplate prf_key_template = 1;getPrfKeyTemplate in interface PrfBasedDeriverKeyFormatOrBuilderpublic PrfBasedDeriverKeyFormat.Builder setPrfKeyTemplate(KeyTemplate value)+
.google.crypto.tink.KeyTemplate prf_key_template = 1;public PrfBasedDeriverKeyFormat.Builder setPrfKeyTemplate(KeyTemplate.Builder builderForValue)+
.google.crypto.tink.KeyTemplate prf_key_template = 1;public PrfBasedDeriverKeyFormat.Builder mergePrfKeyTemplate(KeyTemplate value)+
.google.crypto.tink.KeyTemplate prf_key_template = 1;public PrfBasedDeriverKeyFormat.Builder clearPrfKeyTemplate()+
.google.crypto.tink.KeyTemplate prf_key_template = 1;public boolean hasParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 2;hasParams in interface PrfBasedDeriverKeyFormatOrBuilderpublic PrfBasedDeriverParams getParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 2;getParams in interface PrfBasedDeriverKeyFormatOrBuilderpublic PrfBasedDeriverKeyFormat.Builder setParams(PrfBasedDeriverParams value)+
.google.crypto.tink.PrfBasedDeriverParams params = 2;public PrfBasedDeriverKeyFormat.Builder setParams(PrfBasedDeriverParams.Builder builderForValue)+
.google.crypto.tink.PrfBasedDeriverParams params = 2;public PrfBasedDeriverKeyFormat.Builder mergeParams(PrfBasedDeriverParams value)+
.google.crypto.tink.PrfBasedDeriverParams params = 2;public PrfBasedDeriverKeyFormat.Builder clearParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 2;public final class PrfBasedDeriverKeyFormat +extends com.google.protobuf.GeneratedMessageLite<PrfBasedDeriverKeyFormat,PrfBasedDeriverKeyFormat.Builder> +implements PrfBasedDeriverKeyFormatOrBuilder+
google.crypto.tink.PrfBasedDeriverKeyFormat| Modifier and Type | +Class and Description | +
|---|---|
static class |
+PrfBasedDeriverKeyFormat.Builder
+Protobuf type
+google.crypto.tink.PrfBasedDeriverKeyFormat |
+
com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedFormcom.google.protobuf.AbstractMessageLite.InternalOneOfEnum| Modifier and Type | +Field and Description | +
|---|---|
static int |
+PARAMS_FIELD_NUMBER |
+
static int |
+PRF_KEY_TEMPLATE_FIELD_NUMBER |
+
unknownFieldsmemoizedHashCode| Modifier and Type | +Method and Description | +
|---|---|
protected Object |
+dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method,
+ Object arg0,
+ Object arg1) |
+
static PrfBasedDeriverKeyFormat |
+getDefaultInstance() |
+
PrfBasedDeriverParams |
+getParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
KeyTemplate |
+getPrfKeyTemplate()
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
boolean |
+hasParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
boolean |
+hasPrfKeyTemplate()
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
static PrfBasedDeriverKeyFormat.Builder |
+newBuilder() |
+
static PrfBasedDeriverKeyFormat.Builder |
+newBuilder(PrfBasedDeriverKeyFormat prototype) |
+
static PrfBasedDeriverKeyFormat |
+parseDelimitedFrom(InputStream input) |
+
static PrfBasedDeriverKeyFormat |
+parseDelimitedFrom(InputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKeyFormat |
+parseFrom(byte[] data) |
+
static PrfBasedDeriverKeyFormat |
+parseFrom(byte[] data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKeyFormat |
+parseFrom(ByteBuffer data) |
+
static PrfBasedDeriverKeyFormat |
+parseFrom(ByteBuffer data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKeyFormat |
+parseFrom(com.google.protobuf.ByteString data) |
+
static PrfBasedDeriverKeyFormat |
+parseFrom(com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKeyFormat |
+parseFrom(com.google.protobuf.CodedInputStream input) |
+
static PrfBasedDeriverKeyFormat |
+parseFrom(com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKeyFormat |
+parseFrom(InputStream input) |
+
static PrfBasedDeriverKeyFormat |
+parseFrom(InputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static com.google.protobuf.Parser<PrfBasedDeriverKeyFormat> |
+parser() |
+
createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeToaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetDefaultInstanceForType, isInitializedpublic static final int PRF_KEY_TEMPLATE_FIELD_NUMBER+
public static final int PARAMS_FIELD_NUMBER+
public boolean hasPrfKeyTemplate()+
.google.crypto.tink.KeyTemplate prf_key_template = 1;hasPrfKeyTemplate in interface PrfBasedDeriverKeyFormatOrBuilderpublic KeyTemplate getPrfKeyTemplate()+
.google.crypto.tink.KeyTemplate prf_key_template = 1;getPrfKeyTemplate in interface PrfBasedDeriverKeyFormatOrBuilderpublic boolean hasParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 2;hasParams in interface PrfBasedDeriverKeyFormatOrBuilderpublic PrfBasedDeriverParams getParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 2;getParams in interface PrfBasedDeriverKeyFormatOrBuilderpublic static PrfBasedDeriverKeyFormat parseFrom(ByteBuffer data) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverKeyFormat parseFrom(ByteBuffer data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverKeyFormat parseFrom(com.google.protobuf.ByteString data) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverKeyFormat parseFrom(com.google.protobuf.ByteString data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverKeyFormat parseFrom(byte[] data) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverKeyFormat parseFrom(byte[] data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverKeyFormat parseFrom(InputStream input) + throws IOException+
IOExceptionpublic static PrfBasedDeriverKeyFormat parseFrom(InputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws IOException+
IOExceptionpublic static PrfBasedDeriverKeyFormat parseDelimitedFrom(InputStream input) + throws IOException+
IOExceptionpublic static PrfBasedDeriverKeyFormat parseDelimitedFrom(InputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws IOException+
IOExceptionpublic static PrfBasedDeriverKeyFormat parseFrom(com.google.protobuf.CodedInputStream input) + throws IOException+
IOExceptionpublic static PrfBasedDeriverKeyFormat parseFrom(com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws IOException+
IOExceptionpublic static PrfBasedDeriverKeyFormat.Builder newBuilder()+
public static PrfBasedDeriverKeyFormat.Builder newBuilder(PrfBasedDeriverKeyFormat prototype)+
protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, + Object arg0, + Object arg1)+
dynamicMethod in class com.google.protobuf.GeneratedMessageLite<PrfBasedDeriverKeyFormat,PrfBasedDeriverKeyFormat.Builder>public static PrfBasedDeriverKeyFormat getDefaultInstance()+
public static com.google.protobuf.Parser<PrfBasedDeriverKeyFormat> parser()+
public interface PrfBasedDeriverKeyFormatOrBuilder
+extends com.google.protobuf.MessageLiteOrBuilder
+| Modifier and Type | +Method and Description | +
|---|---|
PrfBasedDeriverParams |
+getParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
KeyTemplate |
+getPrfKeyTemplate()
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
boolean |
+hasParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
boolean |
+hasPrfKeyTemplate()
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
getDefaultInstanceForType, isInitializedboolean hasPrfKeyTemplate()+
.google.crypto.tink.KeyTemplate prf_key_template = 1;KeyTemplate getPrfKeyTemplate()+
.google.crypto.tink.KeyTemplate prf_key_template = 1;boolean hasParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 2;PrfBasedDeriverParams getParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 2;public interface PrfBasedDeriverKeyOrBuilder
+extends com.google.protobuf.MessageLiteOrBuilder
+| Modifier and Type | +Method and Description | +
|---|---|
PrfBasedDeriverParams |
+getParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
KeyData |
+getPrfKey()
+.google.crypto.tink.KeyData prf_key = 2; |
+
int |
+getVersion()
+uint32 version = 1; |
+
boolean |
+hasParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
boolean |
+hasPrfKey()
+.google.crypto.tink.KeyData prf_key = 2; |
+
getDefaultInstanceForType, isInitializedint getVersion()+
uint32 version = 1;boolean hasPrfKey()+
.google.crypto.tink.KeyData prf_key = 2;KeyData getPrfKey()+
.google.crypto.tink.KeyData prf_key = 2;boolean hasParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 3;PrfBasedDeriverParams getParams()+
.google.crypto.tink.PrfBasedDeriverParams params = 3;public static final class PrfBasedDeriverParams.Builder +extends com.google.protobuf.GeneratedMessageLite.Builder<PrfBasedDeriverParams,PrfBasedDeriverParams.Builder> +implements PrfBasedDeriverParamsOrBuilder+
google.crypto.tink.PrfBasedDeriverParamsinstance| Modifier and Type | +Method and Description | +
|---|---|
PrfBasedDeriverParams.Builder |
+clearDerivedKeyTemplate()
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
KeyTemplate |
+getDerivedKeyTemplate()
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
boolean |
+hasDerivedKeyTemplate()
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
PrfBasedDeriverParams.Builder |
+mergeDerivedKeyTemplate(KeyTemplate value)
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
PrfBasedDeriverParams.Builder |
+setDerivedKeyTemplate(KeyTemplate.Builder builderForValue)
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
PrfBasedDeriverParams.Builder |
+setDerivedKeyTemplate(KeyTemplate value)
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFromaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetDefaultInstanceForType, isInitializedpublic boolean hasDerivedKeyTemplate()+
.google.crypto.tink.KeyTemplate derived_key_template = 1;hasDerivedKeyTemplate in interface PrfBasedDeriverParamsOrBuilderpublic KeyTemplate getDerivedKeyTemplate()+
.google.crypto.tink.KeyTemplate derived_key_template = 1;getDerivedKeyTemplate in interface PrfBasedDeriverParamsOrBuilderpublic PrfBasedDeriverParams.Builder setDerivedKeyTemplate(KeyTemplate value)+
.google.crypto.tink.KeyTemplate derived_key_template = 1;public PrfBasedDeriverParams.Builder setDerivedKeyTemplate(KeyTemplate.Builder builderForValue)+
.google.crypto.tink.KeyTemplate derived_key_template = 1;public PrfBasedDeriverParams.Builder mergeDerivedKeyTemplate(KeyTemplate value)+
.google.crypto.tink.KeyTemplate derived_key_template = 1;public PrfBasedDeriverParams.Builder clearDerivedKeyTemplate()+
.google.crypto.tink.KeyTemplate derived_key_template = 1;public final class PrfBasedDeriverParams +extends com.google.protobuf.GeneratedMessageLite<PrfBasedDeriverParams,PrfBasedDeriverParams.Builder> +implements PrfBasedDeriverParamsOrBuilder+
google.crypto.tink.PrfBasedDeriverParams| Modifier and Type | +Class and Description | +
|---|---|
static class |
+PrfBasedDeriverParams.Builder
+Protobuf type
+google.crypto.tink.PrfBasedDeriverParams |
+
com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedFormcom.google.protobuf.AbstractMessageLite.InternalOneOfEnum| Modifier and Type | +Field and Description | +
|---|---|
static int |
+DERIVED_KEY_TEMPLATE_FIELD_NUMBER |
+
unknownFieldsmemoizedHashCode| Modifier and Type | +Method and Description | +
|---|---|
protected Object |
+dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method,
+ Object arg0,
+ Object arg1) |
+
static PrfBasedDeriverParams |
+getDefaultInstance() |
+
KeyTemplate |
+getDerivedKeyTemplate()
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
boolean |
+hasDerivedKeyTemplate()
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
static PrfBasedDeriverParams.Builder |
+newBuilder() |
+
static PrfBasedDeriverParams.Builder |
+newBuilder(PrfBasedDeriverParams prototype) |
+
static PrfBasedDeriverParams |
+parseDelimitedFrom(InputStream input) |
+
static PrfBasedDeriverParams |
+parseDelimitedFrom(InputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverParams |
+parseFrom(byte[] data) |
+
static PrfBasedDeriverParams |
+parseFrom(byte[] data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverParams |
+parseFrom(ByteBuffer data) |
+
static PrfBasedDeriverParams |
+parseFrom(ByteBuffer data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverParams |
+parseFrom(com.google.protobuf.ByteString data) |
+
static PrfBasedDeriverParams |
+parseFrom(com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverParams |
+parseFrom(com.google.protobuf.CodedInputStream input) |
+
static PrfBasedDeriverParams |
+parseFrom(com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverParams |
+parseFrom(InputStream input) |
+
static PrfBasedDeriverParams |
+parseFrom(InputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static com.google.protobuf.Parser<PrfBasedDeriverParams> |
+parser() |
+
createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeToaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitgetDefaultInstanceForType, isInitializedpublic static final int DERIVED_KEY_TEMPLATE_FIELD_NUMBER+
public boolean hasDerivedKeyTemplate()+
.google.crypto.tink.KeyTemplate derived_key_template = 1;hasDerivedKeyTemplate in interface PrfBasedDeriverParamsOrBuilderpublic KeyTemplate getDerivedKeyTemplate()+
.google.crypto.tink.KeyTemplate derived_key_template = 1;getDerivedKeyTemplate in interface PrfBasedDeriverParamsOrBuilderpublic static PrfBasedDeriverParams parseFrom(ByteBuffer data) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverParams parseFrom(ByteBuffer data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverParams parseFrom(com.google.protobuf.ByteString data) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverParams parseFrom(com.google.protobuf.ByteString data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverParams parseFrom(byte[] data) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverParams parseFrom(byte[] data, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws com.google.protobuf.InvalidProtocolBufferException+
com.google.protobuf.InvalidProtocolBufferExceptionpublic static PrfBasedDeriverParams parseFrom(InputStream input) + throws IOException+
IOExceptionpublic static PrfBasedDeriverParams parseFrom(InputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws IOException+
IOExceptionpublic static PrfBasedDeriverParams parseDelimitedFrom(InputStream input) + throws IOException+
IOExceptionpublic static PrfBasedDeriverParams parseDelimitedFrom(InputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws IOException+
IOExceptionpublic static PrfBasedDeriverParams parseFrom(com.google.protobuf.CodedInputStream input) + throws IOException+
IOExceptionpublic static PrfBasedDeriverParams parseFrom(com.google.protobuf.CodedInputStream input, + com.google.protobuf.ExtensionRegistryLite extensionRegistry) + throws IOException+
IOExceptionpublic static PrfBasedDeriverParams.Builder newBuilder()+
public static PrfBasedDeriverParams.Builder newBuilder(PrfBasedDeriverParams prototype)+
protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, + Object arg0, + Object arg1)+
dynamicMethod in class com.google.protobuf.GeneratedMessageLite<PrfBasedDeriverParams,PrfBasedDeriverParams.Builder>public static PrfBasedDeriverParams getDefaultInstance()+
public static com.google.protobuf.Parser<PrfBasedDeriverParams> parser()+
public interface PrfBasedDeriverParamsOrBuilder
+extends com.google.protobuf.MessageLiteOrBuilder
+| Modifier and Type | +Method and Description | +
|---|---|
KeyTemplate |
+getDerivedKeyTemplate()
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
boolean |
+hasDerivedKeyTemplate()
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
getDefaultInstanceForType, isInitializedboolean hasDerivedKeyTemplate()+
.google.crypto.tink.KeyTemplate derived_key_template = 1;KeyTemplate getDerivedKeyTemplate()+
.google.crypto.tink.KeyTemplate derived_key_template = 1;static EciesAeadHkdfParamscreateEcdsaKeyTemplate(HashType hashType,
EllipticCurveType curve,
EcdsaSignatureEncoding encoding,
- OutputPrefixType prefixType)
+ OutputPrefixType prefixType)
+EcdsaParameters object instead.static KeyTemplatestatic EciesAeadHkdfParamscreateEcdsaKeyTemplate(HashType hashType,
EllipticCurveType curve,
EcdsaSignatureEncoding encoding,
- OutputPrefixType prefixType)
+ OutputPrefixType prefixType)
+EcdsaParameters object instead.static KeyTemplatevoidwrite(EncryptedKeyset keyset) write(EncryptedKeyset keyset)
+static EciesAeadHkdfParamsstatic KeyTemplate
createHmacKeyTemplate(int keySize,
int tagSize,
- HashType hashType) createEcdsaKeyTemplate(HashType hashType,
EllipticCurveType curve,
EcdsaSignatureEncoding encoding,
- OutputPrefixType prefixType)
+ OutputPrefixType prefixType)
+EcdsaParameters object instead.static KeyTemplatecreateRsaSsaPkcs1KeyTemplate(HashType hashType,
int modulusSize,
BigInteger publicExponent,
- OutputPrefixType prefixType)
+ OutputPrefixType prefixType)
+RsaSsaPkcs1Parameters object insteadstatic KeyTemplateRsaSsaPssParameters object instead.static KeyTemplatecreateAesGcmHkdfStreamingKeyTemplate(int mainKeySize,
HashType hkdfHashType,
int derivedKeySize,
- int ciphertextSegmentSize) PrfBasedDeriverKey.BuildersetPrfKey(KeyData.Builder builderForValue)
+.google.crypto.tink.KeyData prf_key = 2;| Modifier and Type | +Method and Description | +
|---|---|
KeyData.KeyMaterialType |
+PrfBasedDeriverKeyManager.keyMaterialType() |
+
static KeyData
deriveKey(KeyTemplate keyTemplate,
InputStream randomStream)
-keyTemplate, with the randomness as provided by
+ the second argument.KeyDatanewKeyData(com.google.protobuf.ByteString serializedKeyFormat)
-KeyData according to specification in serializedkeyFormat.KeyData according to specification in serializedKeyFormat.keyData.
| Modifier and Type | +Method and Description | +||
|---|---|---|---|
static com.google.protobuf.MessageLite |
-PrivilegedRegistry.parseKeyData(KeyData keyData)
-Returns the key proto in the keyData if a corresponding key type manager was registered.
+ | <P> P |
+RegistryConfiguration.getLegacyPrimitive(KeyData keyData,
+ Class<P> primitiveClass) |
+
abstract <P> P |
+InternalConfiguration.getLegacyPrimitive(KeyData keyData,
+ Class<P> primitiveClass)
+Creates a primitive from a key in the old (proto) format.
|
| Modifier and Type | +Method and Description | +
|---|---|
static PrfBasedDeriver |
+PrfBasedDeriver.create(KeyData streamingPrfKey,
+ KeyTemplate derivedKeyTemplate) |
+
KeyDatagetPrfKey()
+.google.crypto.tink.KeyData prf_key = 2;KeyDatagetPrfKey()
+.google.crypto.tink.KeyData prf_key = 2;KeyDatagetPrfKey()
+.google.crypto.tink.KeyData prf_key = 2;static KeyDataparseDelimitedFrom(InputStream input) static KeyDataparseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) static KeyDataparseFrom(byte[] data) static KeyDataparseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) static KeyDataparseFrom(ByteBuffer data) static KeyDataparseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) static KeyDataparseFrom(com.google.protobuf.ByteString data) static KeyDataparseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) static KeyDataparseFrom(com.google.protobuf.CodedInputStream input) static KeyDataparseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) static KeyDataparseFrom(InputStream input) static KeyDataparseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) PrfBasedDeriverKey.BuildermergePrfKey(KeyData value)
+.google.crypto.tink.KeyData prf_key = 2;static KeyData.BuildernewBuilder(KeyData prototype) Keyset.Key.BuildersetKeyData(KeyData value)
PrfBasedDeriverKey.BuildersetPrfKey(KeyData value)
+.google.crypto.tink.KeyData prf_key = 2;PrfBasedDeriverParams.BuildersetDerivedKeyTemplate(KeyTemplate.Builder builderForValue)
+.google.crypto.tink.KeyTemplate derived_key_template = 1;PrfBasedDeriverKeyFormat.BuildersetPrfKeyTemplate(KeyTemplate.Builder builderForValue)
+.google.crypto.tink.KeyTemplate prf_key_template = 1;static KeyData
deriveKey(KeyTemplate keyTemplate,
InputStream randomStream)
-keyTemplate, with the randomness as provided by
+ the second argument.static com.google.protobuf.MessageLitenewKey(KeyTemplate keyTemplate)
-keyTemplate.newKeyData instead.static KeyTemplateAES256_SIV
+KeyTemplate that generates new instances of AesSivKey with a 64-byte key.static KeyTemplatecreateAesSivKeyTemplate(int keySize) createAesSivKeyTemplate(int keySize)
+static EciesAeadHkdfParamsstatic ProtoParametersSerializationcreate(KeyTemplate keyTemplate)
+checkedCreate(KeyTemplate keyTemplate)
ProtoParametersSerialization object.static ProtoParametersSerializationcreate(KeyTemplate keyTemplate)
+ProtoParametersSerialization object.static KeyTemplatefromProto(KeyTemplate proto) | Modifier and Type | +Method and Description | +
|---|---|
static PrfBasedDeriver |
+PrfBasedDeriver.create(KeyData streamingPrfKey,
+ KeyTemplate derivedKeyTemplate) |
+
static KeyTemplateAES_CMAC
+KeyTemplate that generates new instances of com.google.crypto.tink.proto.CmacKey with the following parameters:
@@ -588,6 +635,7 @@ static KeyTemplateHMAC_SHA256_128BITTAG
+KeyTemplate that generates new instances of HmacKey with the following parameters:
@@ -601,6 +649,7 @@ static KeyTemplateHMAC_SHA256_256BITTAG
+KeyTemplate that generates new instances of HmacKey with the following parameters:
@@ -614,6 +663,7 @@ static KeyTemplateHMAC_SHA512_256BITTAG
+KeyTemplate that generates new instances of HmacKey with the following parameters:
@@ -627,6 +677,7 @@ static KeyTemplateHMAC_SHA512_512BITTAG
+KeyTemplate that generates new instances of HmacKey with the following parameters:
@@ -650,7 +701,9 @@ static KeyTemplatecreateHmacKeyTemplate(int keySize,
int tagSize,
- HashType hashType) static KeyTemplateAES_CMAC_PRF AES_CMAC_PRF
+static KeyTemplateHKDF_SHA256
+KeyTemplate for a HkdfPrfKey key with
the following parameters.static KeyTemplateHMAC_SHA256_PRF HMAC_SHA256_PRF
+static KeyTemplateHMAC_SHA512_PRF HMAC_SHA512_PRF
+KeyTemplategetDerivedKeyTemplate()
+.google.crypto.tink.KeyTemplate derived_key_template = 1;KeyTemplategetDerivedKeyTemplate()
+.google.crypto.tink.KeyTemplate derived_key_template = 1;KeyTemplategetDerivedKeyTemplate()
+.google.crypto.tink.KeyTemplate derived_key_template = 1;KeyTemplategetPrfKeyTemplate()
+.google.crypto.tink.KeyTemplate prf_key_template = 1;KeyTemplategetPrfKeyTemplate()
+.google.crypto.tink.KeyTemplate prf_key_template = 1;KeyTemplategetPrfKeyTemplate()
+.google.crypto.tink.KeyTemplate prf_key_template = 1;static KeyTemplateparseDelimitedFrom(InputStream input) PrfBasedDeriverParams.BuildermergeDerivedKeyTemplate(KeyTemplate value)
+.google.crypto.tink.KeyTemplate derived_key_template = 1;PrfBasedDeriverKeyFormat.BuildermergePrfKeyTemplate(KeyTemplate value)
+.google.crypto.tink.KeyTemplate prf_key_template = 1;static KeyTemplate.BuildernewBuilder(KeyTemplate prototype) PrfBasedDeriverParams.BuildersetDerivedKeyTemplate(KeyTemplate value)
+.google.crypto.tink.KeyTemplate derived_key_template = 1;PrfBasedDeriverKeyFormat.BuildersetPrfKeyTemplate(KeyTemplate value)
+.google.crypto.tink.KeyTemplate prf_key_template = 1;createEcdsaKeyTemplate(HashType hashType,
EllipticCurveType curve,
EcdsaSignatureEncoding encoding,
- OutputPrefixType prefixType) EcdsaParameters object instead.static KeyTemplatecreateRsaSsaPkcs1KeyTemplate(HashType hashType,
int modulusSize,
BigInteger publicExponent,
- OutputPrefixType prefixType) RsaSsaPkcs1Parameters object insteadstatic KeyTemplateRsaSsaPssParameters object instead.static KeyTemplateAES128_CTR_HMAC_SHA256_1MB
+KeyTemplate that generates new instances of AesCtrHmacStreamingKey with the following parameters:
@@ -1064,6 +1197,7 @@ static KeyTemplateAES128_CTR_HMAC_SHA256_4KB
+KeyTemplate that generates new instances of AesCtrHmacStreamingKey with the following parameters:
@@ -1079,6 +1213,7 @@ static KeyTemplateAES128_GCM_HKDF_1MB
+KeyTemplate that generates new instances of AesGcmHkdfStreamingKey with the following parameters:
@@ -1092,6 +1227,7 @@ static KeyTemplateAES128_GCM_HKDF_4KB
+KeyTemplate that generates new instances of AesGcmHkdfStreamingKey with the following parameters:
@@ -1105,6 +1241,7 @@ static KeyTemplateAES256_CTR_HMAC_SHA256_1MB
+KeyTemplate that generates new instances of AesCtrHmacStreamingKey with the following parameters:
@@ -1120,6 +1257,7 @@ static KeyTemplateAES256_CTR_HMAC_SHA256_4KB
+KeyTemplate that generates new instances of AesCtrHmacStreamingKey with the following parameters:
@@ -1135,6 +1273,7 @@ static KeyTemplateAES256_GCM_HKDF_1MB
+KeyTemplate that generates new instances of AesGcmHkdfStreamingKey with the following parameters:
@@ -1148,6 +1287,7 @@ static KeyTemplateAES256_GCM_HKDF_4KB
+KeyTemplate that generates new instances of AesGcmHkdfStreamingKey with the following parameters:
@@ -1174,14 +1314,18 @@ static KeyTemplatecreateAesGcmHkdfStreamingKeyTemplate(int mainKeySize,
HashType hkdfHashType,
int derivedKeySize,
- int ciphertextSegmentSize) voidwrite(Keyset keyset) write(Keyset keyset)
+createEcdsaKeyTemplate(HashType hashType,
EllipticCurveType curve,
EcdsaSignatureEncoding encoding,
- OutputPrefixType prefixType) EcdsaParameters object instead.static KeyTemplatecreateRsaSsaPkcs1KeyTemplate(HashType hashType,
int modulusSize,
BigInteger publicExponent,
- OutputPrefixType prefixType) RsaSsaPkcs1Parameters object instead| Package | +Description | +
|---|---|
| com.google.crypto.tink.proto | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.Builder.clearParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.Builder.clearPrfKey()
+.google.crypto.tink.KeyData prf_key = 2; |
+
PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.Builder.clearVersion()
+uint32 version = 1; |
+
PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.Builder.mergeParams(PrfBasedDeriverParams value)
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.Builder.mergePrfKey(KeyData value)
+.google.crypto.tink.KeyData prf_key = 2; |
+
static PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.newBuilder() |
+
static PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.newBuilder(PrfBasedDeriverKey prototype) |
+
PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.Builder.setParams(PrfBasedDeriverParams.Builder builderForValue)
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.Builder.setParams(PrfBasedDeriverParams value)
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.Builder.setPrfKey(KeyData.Builder builderForValue)
+.google.crypto.tink.KeyData prf_key = 2; |
+
PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.Builder.setPrfKey(KeyData value)
+.google.crypto.tink.KeyData prf_key = 2; |
+
PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.Builder.setVersion(int value)
+uint32 version = 1; |
+
| Package | +Description | +
|---|---|
| com.google.crypto.tink.keyderivation.internal | ++ |
| com.google.crypto.tink.proto | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
PrfBasedDeriverKey |
+PrfBasedDeriverKeyManager.parseKey(com.google.protobuf.ByteString byteString) |
+
| Modifier and Type | +Method and Description | +
|---|---|
KeyTypeManager.KeyFactory<PrfBasedDeriverKeyFormat,PrfBasedDeriverKey> |
+PrfBasedDeriverKeyManager.keyFactory() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+PrfBasedDeriverKeyManager.validateKey(PrfBasedDeriverKey key) |
+
| Modifier and Type | +Method and Description | +
|---|---|
static PrfBasedDeriverKey |
+PrfBasedDeriverKey.getDefaultInstance() |
+
static PrfBasedDeriverKey |
+PrfBasedDeriverKey.parseDelimitedFrom(InputStream input) |
+
static PrfBasedDeriverKey |
+PrfBasedDeriverKey.parseDelimitedFrom(InputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKey |
+PrfBasedDeriverKey.parseFrom(byte[] data) |
+
static PrfBasedDeriverKey |
+PrfBasedDeriverKey.parseFrom(byte[] data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKey |
+PrfBasedDeriverKey.parseFrom(ByteBuffer data) |
+
static PrfBasedDeriverKey |
+PrfBasedDeriverKey.parseFrom(ByteBuffer data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKey |
+PrfBasedDeriverKey.parseFrom(com.google.protobuf.ByteString data) |
+
static PrfBasedDeriverKey |
+PrfBasedDeriverKey.parseFrom(com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKey |
+PrfBasedDeriverKey.parseFrom(com.google.protobuf.CodedInputStream input) |
+
static PrfBasedDeriverKey |
+PrfBasedDeriverKey.parseFrom(com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKey |
+PrfBasedDeriverKey.parseFrom(InputStream input) |
+
static PrfBasedDeriverKey |
+PrfBasedDeriverKey.parseFrom(InputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
| Modifier and Type | +Method and Description | +
|---|---|
static com.google.protobuf.Parser<PrfBasedDeriverKey> |
+PrfBasedDeriverKey.parser() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.newBuilder(PrfBasedDeriverKey prototype) |
+
| Package | +Description | +
|---|---|
| com.google.crypto.tink.proto | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.Builder.clearParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.Builder.clearPrfKeyTemplate()
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.Builder.mergeParams(PrfBasedDeriverParams value)
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.Builder.mergePrfKeyTemplate(KeyTemplate value)
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
static PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.newBuilder() |
+
static PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.newBuilder(PrfBasedDeriverKeyFormat prototype) |
+
PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.Builder.setParams(PrfBasedDeriverParams.Builder builderForValue)
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.Builder.setParams(PrfBasedDeriverParams value)
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.Builder.setPrfKeyTemplate(KeyTemplate.Builder builderForValue)
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.Builder.setPrfKeyTemplate(KeyTemplate value)
+.google.crypto.tink.KeyTemplate prf_key_template = 1; |
+
| Package | +Description | +
|---|---|
| com.google.crypto.tink.keyderivation.internal | ++ |
| com.google.crypto.tink.proto | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
KeyTypeManager.KeyFactory<PrfBasedDeriverKeyFormat,PrfBasedDeriverKey> |
+PrfBasedDeriverKeyManager.keyFactory() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static PrfBasedDeriverKeyFormat |
+PrfBasedDeriverKeyFormat.getDefaultInstance() |
+
static PrfBasedDeriverKeyFormat |
+PrfBasedDeriverKeyFormat.parseDelimitedFrom(InputStream input) |
+
static PrfBasedDeriverKeyFormat |
+PrfBasedDeriverKeyFormat.parseDelimitedFrom(InputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKeyFormat |
+PrfBasedDeriverKeyFormat.parseFrom(byte[] data) |
+
static PrfBasedDeriverKeyFormat |
+PrfBasedDeriverKeyFormat.parseFrom(byte[] data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKeyFormat |
+PrfBasedDeriverKeyFormat.parseFrom(ByteBuffer data) |
+
static PrfBasedDeriverKeyFormat |
+PrfBasedDeriverKeyFormat.parseFrom(ByteBuffer data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKeyFormat |
+PrfBasedDeriverKeyFormat.parseFrom(com.google.protobuf.ByteString data) |
+
static PrfBasedDeriverKeyFormat |
+PrfBasedDeriverKeyFormat.parseFrom(com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKeyFormat |
+PrfBasedDeriverKeyFormat.parseFrom(com.google.protobuf.CodedInputStream input) |
+
static PrfBasedDeriverKeyFormat |
+PrfBasedDeriverKeyFormat.parseFrom(com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverKeyFormat |
+PrfBasedDeriverKeyFormat.parseFrom(InputStream input) |
+
static PrfBasedDeriverKeyFormat |
+PrfBasedDeriverKeyFormat.parseFrom(InputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
| Modifier and Type | +Method and Description | +
|---|---|
static com.google.protobuf.Parser<PrfBasedDeriverKeyFormat> |
+PrfBasedDeriverKeyFormat.parser() |
+
| Modifier and Type | +Method and Description | +
|---|---|
static PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.newBuilder(PrfBasedDeriverKeyFormat prototype) |
+
| Package | +Description | +
|---|---|
| com.google.crypto.tink.proto | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PrfBasedDeriverKeyFormat
+Protobuf type
+google.crypto.tink.PrfBasedDeriverKeyFormat |
+
static class |
+PrfBasedDeriverKeyFormat.Builder
+Protobuf type
+google.crypto.tink.PrfBasedDeriverKeyFormat |
+
| Package | +Description | +
|---|---|
| com.google.crypto.tink.proto | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PrfBasedDeriverKey
+
+ key_type: type.googleapis.com/google.crypto.tink.PrfBasedDeriverKey
+ |
+
static class |
+PrfBasedDeriverKey.Builder
+
+ key_type: type.googleapis.com/google.crypto.tink.PrfBasedDeriverKey
+ |
+
| Package | +Description | +
|---|---|
| com.google.crypto.tink.proto | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
PrfBasedDeriverParams.Builder |
+PrfBasedDeriverParams.Builder.clearDerivedKeyTemplate()
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
PrfBasedDeriverParams.Builder |
+PrfBasedDeriverParams.Builder.mergeDerivedKeyTemplate(KeyTemplate value)
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
static PrfBasedDeriverParams.Builder |
+PrfBasedDeriverParams.newBuilder() |
+
static PrfBasedDeriverParams.Builder |
+PrfBasedDeriverParams.newBuilder(PrfBasedDeriverParams prototype) |
+
PrfBasedDeriverParams.Builder |
+PrfBasedDeriverParams.Builder.setDerivedKeyTemplate(KeyTemplate.Builder builderForValue)
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
PrfBasedDeriverParams.Builder |
+PrfBasedDeriverParams.Builder.setDerivedKeyTemplate(KeyTemplate value)
+.google.crypto.tink.KeyTemplate derived_key_template = 1; |
+
| Modifier and Type | +Method and Description | +
|---|---|
PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.Builder.setParams(PrfBasedDeriverParams.Builder builderForValue)
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.Builder.setParams(PrfBasedDeriverParams.Builder builderForValue)
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
| Package | +Description | +
|---|---|
| com.google.crypto.tink.proto | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static PrfBasedDeriverParams |
+PrfBasedDeriverParams.getDefaultInstance() |
+
PrfBasedDeriverParams |
+PrfBasedDeriverKeyOrBuilder.getParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
PrfBasedDeriverParams |
+PrfBasedDeriverKeyFormatOrBuilder.getParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverParams |
+PrfBasedDeriverKeyFormat.getParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverParams |
+PrfBasedDeriverKeyFormat.Builder.getParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverParams |
+PrfBasedDeriverKey.getParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
PrfBasedDeriverParams |
+PrfBasedDeriverKey.Builder.getParams()
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
static PrfBasedDeriverParams |
+PrfBasedDeriverParams.parseDelimitedFrom(InputStream input) |
+
static PrfBasedDeriverParams |
+PrfBasedDeriverParams.parseDelimitedFrom(InputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverParams |
+PrfBasedDeriverParams.parseFrom(byte[] data) |
+
static PrfBasedDeriverParams |
+PrfBasedDeriverParams.parseFrom(byte[] data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverParams |
+PrfBasedDeriverParams.parseFrom(ByteBuffer data) |
+
static PrfBasedDeriverParams |
+PrfBasedDeriverParams.parseFrom(ByteBuffer data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverParams |
+PrfBasedDeriverParams.parseFrom(com.google.protobuf.ByteString data) |
+
static PrfBasedDeriverParams |
+PrfBasedDeriverParams.parseFrom(com.google.protobuf.ByteString data,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverParams |
+PrfBasedDeriverParams.parseFrom(com.google.protobuf.CodedInputStream input) |
+
static PrfBasedDeriverParams |
+PrfBasedDeriverParams.parseFrom(com.google.protobuf.CodedInputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
static PrfBasedDeriverParams |
+PrfBasedDeriverParams.parseFrom(InputStream input) |
+
static PrfBasedDeriverParams |
+PrfBasedDeriverParams.parseFrom(InputStream input,
+ com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
+
| Modifier and Type | +Method and Description | +
|---|---|
static com.google.protobuf.Parser<PrfBasedDeriverParams> |
+PrfBasedDeriverParams.parser() |
+
| Modifier and Type | +Method and Description | +
|---|---|
PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.Builder.mergeParams(PrfBasedDeriverParams value)
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.Builder.mergeParams(PrfBasedDeriverParams value)
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
static PrfBasedDeriverParams.Builder |
+PrfBasedDeriverParams.newBuilder(PrfBasedDeriverParams prototype) |
+
PrfBasedDeriverKeyFormat.Builder |
+PrfBasedDeriverKeyFormat.Builder.setParams(PrfBasedDeriverParams value)
+.google.crypto.tink.PrfBasedDeriverParams params = 2; |
+
PrfBasedDeriverKey.Builder |
+PrfBasedDeriverKey.Builder.setParams(PrfBasedDeriverParams value)
+.google.crypto.tink.PrfBasedDeriverParams params = 3; |
+
| Package | +Description | +
|---|---|
| com.google.crypto.tink.proto | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+PrfBasedDeriverParams
+Protobuf type
+google.crypto.tink.PrfBasedDeriverParams |
+
static class |
+PrfBasedDeriverParams.Builder
+Protobuf type
+google.crypto.tink.PrfBasedDeriverParams |
+
google.crypto.tink.PrfBasedDeriverKeyFormatgoogle.crypto.tink.PrfBasedDeriverKeyFormatgoogle.crypto.tink.PrfBasedDeriverParamsgoogle.crypto.tink.PrfBasedDeriverParamsgoogle.crypto.tink.RsaSsaPkcs1KeyFormatgoogle.crypto.tink.RsaSsaPkcs1KeyFormatgoogle.crypto.tink.RsaSsaPkcs1Paramsgoogle.crypto.tink.RsaSsaPkcs1Paramsgoogle.crypto.tink.RsaSsaPssKeyFormatgoogle.crypto.tink.RsaSsaPssKeyFormatgoogle.crypto.tink.RsaSsaPssParamsgoogle.crypto.tink.RsaSsaPssParamsgoogle.crypto.tink.XChaCha20Poly1305KeyFormatgoogle.crypto.tink.XChaCha20Poly1305KeyFormatgoogle.crypto.tink.KeyData.KeyMaterialTypegoogle.crypto.tink.KeyStatusTypegoogle.crypto.tink.KeyTemplate| Class and Description | +
|---|
| KeyData
+
+ The actual *Key-proto is wrapped in a KeyData message, which in addition
+ to this serialized proto contains also type_url identifying the
+ definition of *Key-proto (as in KeyFormat-message), and some extra metadata
+ about the type key material.
+ |
+
| KeyData.KeyMaterialType
+ Protobuf enum
+google.crypto.tink.KeyData.KeyMaterialType |
+
| KeyTemplate
+ Protobuf type
+google.crypto.tink.KeyTemplate |
+
| PrfBasedDeriverKey
+
+ key_type: type.googleapis.com/google.crypto.tink.PrfBasedDeriverKey
+ |
+
| PrfBasedDeriverKeyFormat
+ Protobuf type
+google.crypto.tink.PrfBasedDeriverKeyFormat |
+
google.crypto.tink.PrfBasedDeriverKeyFormatgoogle.crypto.tink.PrfBasedDeriverKeyFormatgoogle.crypto.tink.PrfBasedDeriverParamsgoogle.crypto.tink.PrfBasedDeriverParamsgoogle.crypto.tink.RsaSsaPkcs1KeyFormatgoogle.crypto.tink.RsaSsaPkcs1KeyFormatgoogle.crypto.tink.RsaSsaPkcs1Paramsgoogle.crypto.tink.RsaSsaPkcs1Paramsgoogle.crypto.tink.RsaSsaPssKeyFormatgoogle.crypto.tink.RsaSsaPssKeyFormatgoogle.crypto.tink.RsaSsaPssParamsgoogle.crypto.tink.RsaSsaPssParamsgoogle.crypto.tink.XChaCha20Poly1305KeyFormatgoogle.crypto.tink.XChaCha20Poly1305KeyFormatbooleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
public final class PredefinedSignatureParameters +extends Object+
Parameter objects for PublicKeySign and
+ PublicKeyVerify. keys.
+
+ Note: if you want to keep dependencies small, consider inlining the constants here.
| Modifier and Type | +Field and Description | +
|---|---|
static EcdsaParameters |
+ECDSA_P256
+A
+Parameters object that generates new instances of EcdsaPrivateKey objects
+ with the following parameters:
+
+
+ Hash function: SHA256
+ Curve: NIST P-256
+ Signature encoding: DER (this is the encoding that Java uses). |
+
static EcdsaParameters |
+ECDSA_P256_IEEE_P1363
+A
+Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+
+ Hash function: SHA256
+ Curve: NIST P-256
+ Signature encoding: IEEE_P1363 (this is the encoding that JWS and WebCrypto use). |
+
static EcdsaParameters |
+ECDSA_P256_IEEE_P1363_WITHOUT_PREFIX
+A
+Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+
+ Hash function: SHA256
+ Curve: NIST P-256
+ Signature encoding: DER (this is the encoding that Java uses). |
+
static EcdsaParameters |
+ECDSA_P384
+A
+Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+
+ Hash function: SHA512
+ Curve: NIST P-384
+ Signature encoding: DER (this is the encoding that Java uses). |
+
static EcdsaParameters |
+ECDSA_P384_IEEE_P1363
+A
+Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+
+ Hash function: SHA512
+ Curve: NIST P-384
+ Signature encoding: IEEE_P1363 (this is the encoding that JWS and WebCrypto use). |
+
static EcdsaParameters |
+ECDSA_P521
+A
+Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+
+ Hash function: SHA512
+ Curve: NIST P-521
+ Signature encoding: DER (this is the encoding that Java uses). |
+
static EcdsaParameters |
+ECDSA_P521_IEEE_P1363
+A
+Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+
+ Hash function: SHA512
+ Curve: NIST P-521
+ Signature encoding: IEEE_P1363 (this is the encoding that JWS and WebCrypto use). |
+
static Ed25519Parameters |
+ED25519
+A
+Parameters that generates new instances of Ed25519PrivateKey objects. |
+
static Ed25519Parameters |
+ED25519WithRawOutput
+A
+Parameters that generates new instances of ED25519PrivateKey. |
+
static RsaSsaPkcs1Parameters |
+RSA_SSA_PKCS1_3072_SHA256_F4
+A
+Parameters that generates new instances of RsaSsaPkcs1PrivateKey objects with
+ the following parameters:
+
+
+ Hash function: SHA256. |
+
static RsaSsaPkcs1Parameters |
+RSA_SSA_PKCS1_3072_SHA256_F4_WITHOUT_PREFIX
+A
+Parameters that generates new instances of RsaSsaPkcs1PrivateKey objects with
+ the following parameters:
+
+
+ Hash function: SHA256. |
+
static RsaSsaPkcs1Parameters |
+RSA_SSA_PKCS1_4096_SHA512_F4
+A
+Parameters that generates new instances of RsaSsaPkcs1PrivateKey objects with
+ the following parameters:
+
+
+ Hash function: SHA512. |
+
static RsaSsaPssParameters |
+RSA_SSA_PSS_3072_SHA256_SHA256_32_F4
+A
+Parameters that generates new instances of RsaSsaPssPrivateKey objects with
+ the following parameters:
+
+
+ Signature hash: SHA256. |
+
static RsaSsaPssParameters |
+RSA_SSA_PSS_4096_SHA512_SHA512_64_F4
+A
+Parameters that generates new instances of RsaSsaPssPrivateKey objects with
+ the following parameters:
+
+
+ Signature hash: SHA512. |
+
public static final EcdsaParameters ECDSA_P256+
Parameters object that generates new instances of EcdsaPrivateKey objects
+ with the following parameters:
+
+ OutputPrefixType.TINK
+ public static final EcdsaParameters ECDSA_P384+
Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+ OutputPrefixType.TINK
+ public static final EcdsaParameters ECDSA_P521+
Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+ OutputPrefixType.TINK
+ public static final EcdsaParameters ECDSA_P256_IEEE_P1363+
Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+ OutputPrefixType.TINK
+ public static final EcdsaParameters ECDSA_P384_IEEE_P1363+
Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+ OutputPrefixType.TINK
+ public static final EcdsaParameters ECDSA_P256_IEEE_P1363_WITHOUT_PREFIX+
Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+ public static final EcdsaParameters ECDSA_P521_IEEE_P1363+
Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+ OutputPrefixType.TINK
+ public static final Ed25519Parameters ED25519+
Parameters that generates new instances of Ed25519PrivateKey objects.public static final Ed25519Parameters ED25519WithRawOutput+
Parameters that generates new instances of ED25519PrivateKey.
+
+ The difference between ED25519WithRawOutput and ED25519 is the format of
+ signatures generated. ED25519WithRawOutput generates signatures of OutputPrefixType.RAW format, which is 64 bytes long.
public static final RsaSsaPkcs1Parameters RSA_SSA_PKCS1_3072_SHA256_F4+
Parameters that generates new instances of RsaSsaPkcs1PrivateKey objects with
+ the following parameters:
+
+ OutputPrefixType.TINK
+ public static final RsaSsaPkcs1Parameters RSA_SSA_PKCS1_3072_SHA256_F4_WITHOUT_PREFIX+
Parameters that generates new instances of RsaSsaPkcs1PrivateKey objects with
+ the following parameters:
+
+ public static final RsaSsaPkcs1Parameters RSA_SSA_PKCS1_4096_SHA512_F4+
Parameters that generates new instances of RsaSsaPkcs1PrivateKey objects with
+ the following parameters:
+
+ OutputPrefixType.TINK
+ public static final RsaSsaPssParameters RSA_SSA_PSS_3072_SHA256_SHA256_32_F4+
Parameters that generates new instances of RsaSsaPssPrivateKey objects with
+ the following parameters:
+
+ public static final RsaSsaPssParameters RSA_SSA_PSS_4096_SHA512_SHA512_64_F4+
Parameters that generates new instances of RsaSsaPssPrivateKey objects with
+ the following parameters:
+
+ booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
booleanequalsKey(Key o)
-other.public boolean equalsKey(Key o)
Keyother.
Implementations are required to do this in constant time. +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. +
Note: Tink Key objects should typically not override hashCode (because it
could risk leaking key material). Hence, they typically also should not override equals.
public static final class RsaSsaPssParameters.Builder +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
RsaSsaPssParameters |
+build() |
+
RsaSsaPssParameters.Builder |
+setMgf1HashType(RsaSsaPssParameters.HashType mgf1HashType) |
+
RsaSsaPssParameters.Builder |
+setModulusSizeBits(int modulusSizeBits) |
+
RsaSsaPssParameters.Builder |
+setPublicExponent(BigInteger e) |
+
RsaSsaPssParameters.Builder |
+setSaltLengthBytes(int saltLengthBytes) |
+
RsaSsaPssParameters.Builder |
+setSigHashType(RsaSsaPssParameters.HashType sigHashType) |
+
RsaSsaPssParameters.Builder |
+setVariant(RsaSsaPssParameters.Variant variant) |
+
@CanIgnoreReturnValue +public RsaSsaPssParameters.Builder setModulusSizeBits(int modulusSizeBits)+
@CanIgnoreReturnValue +public RsaSsaPssParameters.Builder setPublicExponent(BigInteger e)+
@CanIgnoreReturnValue +public RsaSsaPssParameters.Builder setVariant(RsaSsaPssParameters.Variant variant)+
@CanIgnoreReturnValue +public RsaSsaPssParameters.Builder setSigHashType(RsaSsaPssParameters.HashType sigHashType)+
@CanIgnoreReturnValue +public RsaSsaPssParameters.Builder setMgf1HashType(RsaSsaPssParameters.HashType mgf1HashType)+
@CanIgnoreReturnValue +public RsaSsaPssParameters.Builder setSaltLengthBytes(int saltLengthBytes) + throws GeneralSecurityException+
GeneralSecurityExceptionpublic RsaSsaPssParameters build() + throws GeneralSecurityException+
GeneralSecurityException@Immutable +public static final class RsaSsaPssParameters.HashType +extends Object+
| Modifier and Type | +Field and Description | +
|---|---|
static RsaSsaPssParameters.HashType |
+SHA256 |
+
static RsaSsaPssParameters.HashType |
+SHA384 |
+
static RsaSsaPssParameters.HashType |
+SHA512 |
+
public static final RsaSsaPssParameters.HashType SHA256+
public static final RsaSsaPssParameters.HashType SHA384+
public static final RsaSsaPssParameters.HashType SHA512+
@Immutable +public static final class RsaSsaPssParameters.Variant +extends Object+
The usual key is used for variant "NO_PREFIX". Other variants slightly change how the + signature is computed, or add a prefix to every computation depending on the key id.
| Modifier and Type | +Field and Description | +
|---|---|
static RsaSsaPssParameters.Variant |
+CRUNCHY |
+
static RsaSsaPssParameters.Variant |
+LEGACY |
+
static RsaSsaPssParameters.Variant |
+NO_PREFIX |
+
static RsaSsaPssParameters.Variant |
+TINK |
+
public static final RsaSsaPssParameters.Variant TINK+
public static final RsaSsaPssParameters.Variant CRUNCHY+
public static final RsaSsaPssParameters.Variant LEGACY+
public static final RsaSsaPssParameters.Variant NO_PREFIX+
public final class RsaSsaPssParameters +extends SignatureParameters+
RsaSsaPssPublicKey and RsaSsaPssPrivateKey.
+
+ Standard: https://datatracker.ietf.org/doc/html/rfc8017#section-8.1
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+RsaSsaPssParameters.Builder
+Builds a new RsaSsaPssParameters instance.
+ |
+
static class |
+RsaSsaPssParameters.HashType
+The Hash algorithm used.
+ |
+
static class |
+RsaSsaPssParameters.Variant
+Describes details of the signature.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
static BigInteger |
+F4 |
+
| Modifier and Type | +Method and Description | +
|---|---|
static RsaSsaPssParameters.Builder |
+builder() |
+
boolean |
+equals(Object o) |
+
RsaSsaPssParameters.HashType |
+getMgf1HashType() |
+
int |
+getModulusSizeBits() |
+
BigInteger |
+getPublicExponent() |
+
int |
+getSaltLengthBytes() |
+
RsaSsaPssParameters.HashType |
+getSigHashType() |
+
RsaSsaPssParameters.Variant |
+getVariant() |
+
int |
+hashCode() |
+
boolean |
+hasIdRequirement()
+Returns true if a key created with the parameters in this object has to have a certain ID when
+ it is in a keyset.
+ |
+
String |
+toString() |
+
public static final BigInteger F4+
public static RsaSsaPssParameters.Builder builder()+
public int getModulusSizeBits()+
public BigInteger getPublicExponent()+
public RsaSsaPssParameters.Variant getVariant()+
public RsaSsaPssParameters.HashType getSigHashType()+
public RsaSsaPssParameters.HashType getMgf1HashType()+
public int getSaltLengthBytes()+
public boolean hasIdRequirement()+
ParametersIn Tink, certain keys change their behavior depending on the key id (for example, an Aead object can prefix the ciphertext with the big endian encoding of the key id). If this is
+ the case, such a key should require a unique id in Key.getIdRequirementOrNull() and
+ return true here.
hasIdRequirement in class Parameterspublic static class RsaSsaPssPrivateKey.Builder +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
RsaSsaPssPrivateKey |
+build() |
+
RsaSsaPssPrivateKey.Builder |
+setCrtCoefficient(SecretBigInteger qInv)
+Sets the CRT coefficient qInv.
+ |
+
RsaSsaPssPrivateKey.Builder |
+setPrimeExponents(SecretBigInteger dP,
+ SecretBigInteger dQ)
+Sets the prime exponents dP and dQ.
+ |
+
RsaSsaPssPrivateKey.Builder |
+setPrimes(SecretBigInteger p,
+ SecretBigInteger q)
+Sets the prime factors p and q.
+ |
+
RsaSsaPssPrivateKey.Builder |
+setPrivateExponent(SecretBigInteger d)
+Sets the private exponent d.
+ |
+
RsaSsaPssPrivateKey.Builder |
+setPublicKey(RsaSsaPssPublicKey publicKey)
+Sets the public key, which includes the parameters.
+ |
+
@CanIgnoreReturnValue +public RsaSsaPssPrivateKey.Builder setPublicKey(RsaSsaPssPublicKey publicKey)+
This is required.
@CanIgnoreReturnValue +public RsaSsaPssPrivateKey.Builder setPrimes(SecretBigInteger p, + SecretBigInteger q)+
This is required.
@CanIgnoreReturnValue +public RsaSsaPssPrivateKey.Builder setPrivateExponent(SecretBigInteger d)+
This is required.
@CanIgnoreReturnValue +public RsaSsaPssPrivateKey.Builder setPrimeExponents(SecretBigInteger dP, + SecretBigInteger dQ)+
See https://www.rfc-editor.org/rfc/rfc8017#section-3.2. + +
This is required.
@CanIgnoreReturnValue +public RsaSsaPssPrivateKey.Builder setCrtCoefficient(SecretBigInteger qInv)+
See https://www.rfc-editor.org/rfc/rfc8017#section-3.2. + +
This is required.
public RsaSsaPssPrivateKey build() + throws GeneralSecurityException+
GeneralSecurityExceptionpublic final class RsaSsaPssPrivateKey +extends SignaturePrivateKey+
Standard: https://www.rfc-editor.org/rfc/rfc8017#section-3.2.
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+RsaSsaPssPrivateKey.Builder
+Builder for RsaSsaPssPrivateKey.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static RsaSsaPssPrivateKey.Builder |
+builder() |
+
boolean |
+equalsKey(Key o)
+Returns true if the key is guaranteed to be equal to
+other. |
+
SecretBigInteger |
+getCrtCoefficient()
+Returns the CRT coefficient qInv.
+ |
+
RsaSsaPssParameters |
+getParameters()
+Returns the key parameters.
+ |
+
SecretBigInteger |
+getPrimeExponentP()
+Returns the prime exponent dP.
+ |
+
SecretBigInteger |
+getPrimeExponentQ()
+Returns the prime exponent dQ.
+ |
+
SecretBigInteger |
+getPrimeP()
+Returns the prime factor p.
+ |
+
SecretBigInteger |
+getPrimeQ()
+Returns the prime factor q.
+ |
+
SecretBigInteger |
+getPrivateExponent()
+Returns the private exponent d.
+ |
+
RsaSsaPssPublicKey |
+getPublicKey()
+Returns the public key.
+ |
+
getIdRequirementOrNull, getOutputPrefixpublic static RsaSsaPssPrivateKey.Builder builder()+
public RsaSsaPssParameters getParameters()+
getParameters in class SignaturePrivateKeypublic RsaSsaPssPublicKey getPublicKey()+
getPublicKey in interface PrivateKeygetPublicKey in class SignaturePrivateKeypublic SecretBigInteger getPrimeP()+
public SecretBigInteger getPrimeQ()+
public SecretBigInteger getPrivateExponent()+
public SecretBigInteger getPrimeExponentP()+
public SecretBigInteger getPrimeExponentQ()+
public SecretBigInteger getCrtCoefficient()+
public boolean equalsKey(Key o)+
Keyother.
+
+ Implementations are required to do this in constant time. + +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. + +
Note: Tink Key objects should typically not override hashCode (because it
+ could risk leaking key material). Hence, they typically also should not override equals.
public static class RsaSsaPssPublicKey.Builder +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
RsaSsaPssPublicKey |
+build() |
+
RsaSsaPssPublicKey.Builder |
+setIdRequirement(Integer idRequirement) |
+
RsaSsaPssPublicKey.Builder |
+setModulus(BigInteger modulus) |
+
RsaSsaPssPublicKey.Builder |
+setParameters(RsaSsaPssParameters parameters) |
+
@CanIgnoreReturnValue +public RsaSsaPssPublicKey.Builder setParameters(RsaSsaPssParameters parameters)+
@CanIgnoreReturnValue +public RsaSsaPssPublicKey.Builder setModulus(BigInteger modulus)+
@CanIgnoreReturnValue +public RsaSsaPssPublicKey.Builder setIdRequirement(@Nullable + Integer idRequirement)+
public RsaSsaPssPublicKey build() + throws GeneralSecurityException+
GeneralSecurityExceptionpublic final class RsaSsaPssPublicKey +extends SignaturePublicKey+
Standard: https://www.rfc-editor.org/rfc/rfc8017.txt
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+RsaSsaPssPublicKey.Builder
+Builder for RsaSsaPssPublicKey.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static RsaSsaPssPublicKey.Builder |
+builder() |
+
boolean |
+equalsKey(Key o)
+Returns true if the key is guaranteed to be equal to
+other. |
+
Integer |
+getIdRequirementOrNull()
+Returns null if this key has no id requirement, otherwise the required id.
+ |
+
BigInteger |
+getModulus()
+Returns the underlying key bytes.
+ |
+
Bytes |
+getOutputPrefix()
+Returns a
+Bytes instance which is prefixed to every signature. |
+
RsaSsaPssParameters |
+getParameters()
+Returns the parameters of this key.
+ |
+
public static RsaSsaPssPublicKey.Builder builder()+
public BigInteger getModulus()+
public Bytes getOutputPrefix()+
SignaturePublicKeyBytes instance which is prefixed to every signature.getOutputPrefix in class SignaturePublicKeypublic RsaSsaPssParameters getParameters()+
SignaturePublicKeygetParameters in class SignaturePublicKey@Nullable +public Integer getIdRequirementOrNull()+
KeySome keys, when they are in a keyset, are required to have a certain ID to work properly.
+ This comes from the fact that Tink in some cases prefixes ciphertexts or signatures with the
+ string 0x01<id>, where the ID is encoded in big endian (see the documentation of the
+ key type for details), in which case the key requires a certain ID.
getIdRequirementOrNull in class Keypublic boolean equalsKey(Key o)+
Keyother.
+
+ Implementations are required to do this in constant time. + +
Note: this is allowed to return false even if two keys are guaranteed to represent the same + function, but are represented differently. For example, a key is allowed to internally store + the number of zero-bytes used as padding when a large number is represented as a byte array, + and use this in the comparison. + +
Note: Tink Key objects should typically not override hashCode (because it
+ could risk leaking key material). Hence, they typically also should not override equals.
| Modifier and Type | Method and Description | @@ -312,14 +312,22 @@createEcdsaKeyTemplate(HashType hashType,
EllipticCurveType curve,
EcdsaSignatureEncoding encoding,
- OutputPrefixType prefixType) |
+ OutputPrefixType prefixType)
+
|---|---|---|
static KeyTemplate |
createRsaSsaPkcs1KeyTemplate(HashType hashType,
int modulusSize,
BigInteger publicExponent,
- OutputPrefixType prefixType) |
+ OutputPrefixType prefixType)
+|
static KeyTemplate |
@@ -327,7 +335,11 @@
public static KeyTemplate createEcdsaKeyTemplate(HashType hashType, - EllipticCurveType curve, - EcdsaSignatureEncoding encoding, - OutputPrefixType prefixType)+
@Deprecated +public static KeyTemplate createEcdsaKeyTemplate(HashType hashType, + EllipticCurveType curve, + EcdsaSignatureEncoding encoding, + OutputPrefixType prefixType)+
EcdsaParameters object instead.KeyTemplate containing a EcdsaKeyFormat with some specified
@@ -622,10 +636,12 @@ public static KeyTemplate createRsaSsaPkcs1KeyTemplate(HashType hashType, - int modulusSize, - BigInteger publicExponent, - OutputPrefixType prefixType)+
@Deprecated +public static KeyTemplate createRsaSsaPkcs1KeyTemplate(HashType hashType, + int modulusSize, + BigInteger publicExponent, + OutputPrefixType prefixType)+
RsaSsaPkcs1Parameters object insteadKeyTemplate containing a RsaSsaPkcs1KeyFormat with some specified
@@ -639,11 +655,13 @@ public static KeyTemplate createRsaSsaPssKeyTemplate(HashType sigHash, - HashType mgf1Hash, - int saltLength, - int modulusSize, - BigInteger publicExponent)+
@Deprecated +public static KeyTemplate createRsaSsaPssKeyTemplate(HashType sigHash, + HashType mgf1Hash, + int saltLength, + int modulusSize, + BigInteger publicExponent)+
RsaSsaPssParameters object instead.KeyTemplate containing a RsaSsaPssKeyFormat with some specified
diff --git a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/signature/SignatureParameters.html b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/signature/SignatureParameters.html
index 7cfb8d93e..d923524fb 100644
--- a/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/signature/SignatureParameters.html
+++ b/javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/signature/SignatureParameters.html
@@ -107,7 +107,7 @@ | Modifier and Type | +Field and Description | +
|---|---|
static EcdsaParameters |
+PredefinedSignatureParameters.ECDSA_P256
+A
+Parameters object that generates new instances of EcdsaPrivateKey objects
+ with the following parameters:
+
+
+ Hash function: SHA256
+ Curve: NIST P-256
+ Signature encoding: DER (this is the encoding that Java uses). |
+
static EcdsaParameters |
+PredefinedSignatureParameters.ECDSA_P256_IEEE_P1363
+A
+Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+
+ Hash function: SHA256
+ Curve: NIST P-256
+ Signature encoding: IEEE_P1363 (this is the encoding that JWS and WebCrypto use). |
+
static EcdsaParameters |
+PredefinedSignatureParameters.ECDSA_P256_IEEE_P1363_WITHOUT_PREFIX
+A
+Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+
+ Hash function: SHA256
+ Curve: NIST P-256
+ Signature encoding: DER (this is the encoding that Java uses). |
+
static EcdsaParameters |
+PredefinedSignatureParameters.ECDSA_P384
+A
+Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+
+ Hash function: SHA512
+ Curve: NIST P-384
+ Signature encoding: DER (this is the encoding that Java uses). |
+
static EcdsaParameters |
+PredefinedSignatureParameters.ECDSA_P384_IEEE_P1363
+A
+Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+
+ Hash function: SHA512
+ Curve: NIST P-384
+ Signature encoding: IEEE_P1363 (this is the encoding that JWS and WebCrypto use). |
+
static EcdsaParameters |
+PredefinedSignatureParameters.ECDSA_P521
+A
+Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+
+ Hash function: SHA512
+ Curve: NIST P-521
+ Signature encoding: DER (this is the encoding that Java uses). |
+
static EcdsaParameters |
+PredefinedSignatureParameters.ECDSA_P521_IEEE_P1363
+A
+Parameters that generates new instances of EcdsaPrivateKey objects with the
+ following parameters:
+
+
+ Hash function: SHA512
+ Curve: NIST P-521
+ Signature encoding: IEEE_P1363 (this is the encoding that JWS and WebCrypto use). |
+