tink-android-HEAD-SNAPSHOT Javadoc auto-pushed to gh-pages

javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/KeysetHandle.html

@@ -17,7 +17,7 @@
     catch(err) {
     }
 //-->
-var methods = {"i0":41,"i1":10,"i2":9,"i3":9,"i4":41,"i5":9,"i6":9,"i7":10,"i8":42,"i9":42,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":9,"i16":9,"i17":42,"i18":41,"i19":41,"i20":41,"i21":41,"i22":10,"i23":10,"i24":42,"i25":42,"i26":42};
+var methods = {"i0":41,"i1":10,"i2":9,"i3":9,"i4":41,"i5":9,"i6":9,"i7":10,"i8":42,"i9":42,"i10":10,"i11":42,"i12":10,"i13":10,"i14":9,"i15":9,"i16":9,"i17":42,"i18":41,"i19":41,"i20":41,"i21":41,"i22":10,"i23":10,"i24":42,"i25":42,"i26":42};
 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";
@@ -247,8 +247,12 @@ <h3>Method Summary</h3>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code>&lt;P&gt;&nbsp;P</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/google/crypto/tink/KeysetHandle.html#getPrimitive-java.lang.Class-">getPrimitive</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;P&gt;&nbsp;targetClassObject)</code>
-<div class="block">Returns a primitive from this keyset, using the global registry to create resources creating
- the primitive.</div>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
+<div class="block"><span class="deprecationComment">New users should use <code>KeysetHandle.getPrimitive</code> with a suitable
+     <code>Configuration</code>. Existing users can use
+     <code>KeysetHandle.getPrimitive(RegistryConfiguration.get(), targetClassObject)</code> for
+     exactly the same behavior.</span></div>
+</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
@@ -839,10 +843,15 @@ <h4>getPrimitive</h4>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPrimitive</h4>
-<pre>@InlineMe(replacement="this.getPrimitive(RegistryConfiguration.get(), targetClassObject)",
+<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
+ @InlineMe(replacement="this.getPrimitive(RegistryConfiguration.get(), targetClassObject)",
           imports="com.google.crypto.tink.RegistryConfiguration")
 public&nbsp;&lt;P&gt;&nbsp;P&nbsp;getPrimitive(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;P&gt;&nbsp;targetClassObject)
-                                                                                                                                                                                throws <a href="https://docs.oracle.com/javase/8/docs/api/java/security/GeneralSecurityException.html?is-external=true" title="class or interface in java.security">GeneralSecurityException</a></pre>
+                                                                                                                                                                                             throws <a href="https://docs.oracle.com/javase/8/docs/api/java/security/GeneralSecurityException.html?is-external=true" title="class or interface in java.security">GeneralSecurityException</a></pre>
+<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">New users should use <code>KeysetHandle.getPrimitive</code> with a suitable
+     <code>Configuration</code>. Existing users can use
+     <code>KeysetHandle.getPrimitive(RegistryConfiguration.get(), targetClassObject)</code> for
+     exactly the same behavior.</span></div>
 <div class="block">Returns a primitive from this keyset, using the global registry to create resources creating
  the primitive.</div>
 <dl>

javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/StreamingAead.html

@@ -115,7 +115,7 @@ <h2 title="Interface StreamingAead" class="title">Interface StreamingAead</h2>
 
  <h3>Security guarantees</h3>
 
- <p>Instances of StreamingAead must follow the OAE2 definition as proposed in the paper "Online
+ <p>Instances of StreamingAead must follow the nOAE definition as proposed in the paper "Online
  Authenticated-Encryption and its Nonce-Reuse Misuse-Resistance" by Hoang, Reyhanitabar, Rogaway
  and Vizár https://eprint.iacr.org/2015/189.pdf
 

javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/aead/XAesGcmParameters.html

@@ -163,7 +163,9 @@ <h3>Method Summary</h3>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html#create-com.google.crypto.tink.aead.XAesGcmParameters.Variant-int-">create</a></span>(<a href="../../../../../com/google/crypto/tink/aead/XAesGcmParameters.Variant.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters.Variant</a>&nbsp;variant,
-      int&nbsp;saltSizeBytes)</code>&nbsp;</td>
+      int&nbsp;saltSizeBytes)</code>
+<div class="block">Creates a new <a href="../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead"><code>XAesGcmParameters</code></a> object for generating new instances of <a href="../../../../../com/google/crypto/tink/aead/XAesGcmKey.html" title="class in com.google.crypto.tink.aead"><code>XAesGcmKey</code></a>.</div>
+</td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
@@ -225,7 +227,15 @@ <h4>create</h4>
 <pre>public static&nbsp;<a href="../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters</a>&nbsp;create(<a href="../../../../../com/google/crypto/tink/aead/XAesGcmParameters.Variant.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters.Variant</a>&nbsp;variant,
                                        int&nbsp;saltSizeBytes)
                                 throws <a href="https://docs.oracle.com/javase/8/docs/api/java/security/GeneralSecurityException.html?is-external=true" title="class or interface in java.security">GeneralSecurityException</a></pre>
+<div class="block">Creates a new <a href="../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead"><code>XAesGcmParameters</code></a> object for generating new instances of <a href="../../../../../com/google/crypto/tink/aead/XAesGcmKey.html" title="class in com.google.crypto.tink.aead"><code>XAesGcmKey</code></a>. The key size is 32 bytes and the tag size is 16 bytes. The IV size in bytes is
+ <code>saltSizeBytes + 12</code>.
+
+ <p><code>create(Variant.NO_PREFIX, 12)</code> returns <a href="../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead"><code>XAesGcmParameters</code></a> that follow the <a
+ href="https://github.com/C2SP/C2SP/blob/main/XAES-256-GCM.md">XAES-256-GCM specification</a>.</div>
 <dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>variant</code> - the variant of the X-AES-GCM key.</dd>
+<dd><code>saltSizeBytes</code> - the size of the salt in bytes. Must be between 8 and 12 bytes.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/security/GeneralSecurityException.html?is-external=true" title="class or interface in java.security">GeneralSecurityException</a></code></dd>
 </dl>

javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/aead/class-use/AesCtrHmacAeadParameters.html

@@ -104,8 +104,7 @@ <h3>Uses of <a href="../../../../../../com/google/crypto/tink/aead/AesCtrHmacAea
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/google/crypto/tink/aead/AesCtrHmacAeadParameters.html" title="class in com.google.crypto.tink.aead">AesCtrHmacAeadParameters</a></code></td>
 <td class="colLast"><span class="typeNameLabel">PredefinedAeadParameters.</span><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/aead/PredefinedAeadParameters.html#AES128_CTR_HMAC_SHA256">AES128_CTR_HMAC_SHA256</a></span></code>
-<div class="block">A <code>Parameters</code> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/AesCtrHmacAeadKey.html" title="class in com.google.crypto.tink.aead"><code>AesCtrHmacAeadKey</code></a> with the
- following parameters:
+<div class="block">A <a href="../../../../../../com/google/crypto/tink/Parameters.html" title="class in com.google.crypto.tink"><code>Parameters</code></a> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/AesCtrHmacAeadKey.html" title="class in com.google.crypto.tink.aead"><code>AesCtrHmacAeadKey</code></a> with the following parameters:
 
 
    AES key size: 16 bytes
@@ -119,8 +118,7 @@ <h3>Uses of <a href="../../../../../../com/google/crypto/tink/aead/AesCtrHmacAea
 <tr class="rowColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/google/crypto/tink/aead/AesCtrHmacAeadParameters.html" title="class in com.google.crypto.tink.aead">AesCtrHmacAeadParameters</a></code></td>
 <td class="colLast"><span class="typeNameLabel">PredefinedAeadParameters.</span><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/aead/PredefinedAeadParameters.html#AES256_CTR_HMAC_SHA256">AES256_CTR_HMAC_SHA256</a></span></code>
-<div class="block">A <code>Parameters</code> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/AesCtrHmacAeadKey.html" title="class in com.google.crypto.tink.aead"><code>AesCtrHmacAeadKey</code></a> with the
- following parameters:
+<div class="block">A <a href="../../../../../../com/google/crypto/tink/Parameters.html" title="class in com.google.crypto.tink"><code>Parameters</code></a> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/AesCtrHmacAeadKey.html" title="class in com.google.crypto.tink.aead"><code>AesCtrHmacAeadKey</code></a> with the following parameters:
 
 
    AES key size: 32 bytes

javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/aead/class-use/AesEaxParameters.html

@@ -104,8 +104,7 @@ <h3>Uses of <a href="../../../../../../com/google/crypto/tink/aead/AesEaxParamet
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/google/crypto/tink/aead/AesEaxParameters.html" title="class in com.google.crypto.tink.aead">AesEaxParameters</a></code></td>
 <td class="colLast"><span class="typeNameLabel">PredefinedAeadParameters.</span><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/aead/PredefinedAeadParameters.html#AES128_EAX">AES128_EAX</a></span></code>
-<div class="block">A <code>Parameters</code> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/AesEaxKey.html" title="class in com.google.crypto.tink.aead"><code>AesEaxKey</code></a> with the
- following parameters:
+<div class="block">A <a href="../../../../../../com/google/crypto/tink/Parameters.html" title="class in com.google.crypto.tink"><code>Parameters</code></a> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/AesEaxKey.html" title="class in com.google.crypto.tink.aead"><code>AesEaxKey</code></a> with the following parameters:
 
 
    Key size: 16 bytes
@@ -116,8 +115,7 @@ <h3>Uses of <a href="../../../../../../com/google/crypto/tink/aead/AesEaxParamet
 <tr class="rowColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/google/crypto/tink/aead/AesEaxParameters.html" title="class in com.google.crypto.tink.aead">AesEaxParameters</a></code></td>
 <td class="colLast"><span class="typeNameLabel">PredefinedAeadParameters.</span><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/aead/PredefinedAeadParameters.html#AES256_EAX">AES256_EAX</a></span></code>
-<div class="block">A <code>Parameters</code> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/AesEaxKey.html" title="class in com.google.crypto.tink.aead"><code>AesEaxKey</code></a> with the
- following parameters:
+<div class="block">A <a href="../../../../../../com/google/crypto/tink/Parameters.html" title="class in com.google.crypto.tink"><code>Parameters</code></a> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/AesEaxKey.html" title="class in com.google.crypto.tink.aead"><code>AesEaxKey</code></a> with the following parameters:
 
 
    Key size: 32 bytes

javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/aead/class-use/AesGcmParameters.html

@@ -104,8 +104,7 @@ <h3>Uses of <a href="../../../../../../com/google/crypto/tink/aead/AesGcmParamet
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/google/crypto/tink/aead/AesGcmParameters.html" title="class in com.google.crypto.tink.aead">AesGcmParameters</a></code></td>
 <td class="colLast"><span class="typeNameLabel">PredefinedAeadParameters.</span><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/aead/PredefinedAeadParameters.html#AES128_GCM">AES128_GCM</a></span></code>
-<div class="block">A <code>Parameters</code> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/AesGcmKey.html" title="class in com.google.crypto.tink.aead"><code>AesGcmKey</code></a> with the
- following parameters:
+<div class="block">A <a href="../../../../../../com/google/crypto/tink/Parameters.html" title="class in com.google.crypto.tink"><code>Parameters</code></a> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/AesGcmKey.html" title="class in com.google.crypto.tink.aead"><code>AesGcmKey</code></a> with the following parameters:
 
 
    Key size: 16 bytes
@@ -115,8 +114,7 @@ <h3>Uses of <a href="../../../../../../com/google/crypto/tink/aead/AesGcmParamet
 <tr class="rowColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/google/crypto/tink/aead/AesGcmParameters.html" title="class in com.google.crypto.tink.aead">AesGcmParameters</a></code></td>
 <td class="colLast"><span class="typeNameLabel">PredefinedAeadParameters.</span><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/aead/PredefinedAeadParameters.html#AES256_GCM">AES256_GCM</a></span></code>
-<div class="block">A <code>Parameters</code> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/AesGcmKey.html" title="class in com.google.crypto.tink.aead"><code>AesGcmKey</code></a> with the
- following parameters:
+<div class="block">A <a href="../../../../../../com/google/crypto/tink/Parameters.html" title="class in com.google.crypto.tink"><code>Parameters</code></a> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/AesGcmKey.html" title="class in com.google.crypto.tink.aead"><code>AesGcmKey</code></a> with the following parameters:
 
 
    Key size: 32 bytes

javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/aead/class-use/ChaCha20Poly1305Parameters.html

@@ -104,7 +104,7 @@ <h3>Uses of <a href="../../../../../../com/google/crypto/tink/aead/ChaCha20Poly1
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/google/crypto/tink/aead/ChaCha20Poly1305Parameters.html" title="class in com.google.crypto.tink.aead">ChaCha20Poly1305Parameters</a></code></td>
 <td class="colLast"><span class="typeNameLabel">PredefinedAeadParameters.</span><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/aead/PredefinedAeadParameters.html#CHACHA20_POLY1305">CHACHA20_POLY1305</a></span></code>
-<div class="block">A <code>KeyTemplate</code> that generates new instances of <a href="../../../../../../com/google/crypto/tink/proto/ChaCha20Poly1305Key.html" title="class in com.google.crypto.tink.proto"><code>ChaCha20Poly1305Key</code></a>.</div>
+<div class="block">A <a href="../../../../../../com/google/crypto/tink/Parameters.html" title="class in com.google.crypto.tink"><code>Parameters</code></a> object that generates new instances of <a href="../../../../../../com/google/crypto/tink/aead/ChaCha20Poly1305Key.html" title="class in com.google.crypto.tink.aead"><code>ChaCha20Poly1305Key</code></a>.</div>
 </td>
 </tr>
 </tbody>

javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/aead/class-use/XAesGcmParameters.Variant.html

@@ -136,7 +136,9 @@ <h3>Uses of <a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParame
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters</a></code></td>
 <td class="colLast"><span class="typeNameLabel">XAesGcmParameters.</span><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html#create-com.google.crypto.tink.aead.XAesGcmParameters.Variant-int-">create</a></span>(<a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParameters.Variant.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters.Variant</a>&nbsp;variant,
-      int&nbsp;saltSizeBytes)</code>&nbsp;</td>
+      int&nbsp;saltSizeBytes)</code>
+<div class="block">Creates a new <a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead"><code>XAesGcmParameters</code></a> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/XAesGcmKey.html" title="class in com.google.crypto.tink.aead"><code>XAesGcmKey</code></a>.</div>
+</td>
 </tr>
 </tbody>
 </table>

javadoc/tink-android/HEAD-SNAPSHOT/com/google/crypto/tink/aead/class-use/XAesGcmParameters.html

@@ -104,13 +104,7 @@ <h3>Uses of <a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParame
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters</a></code></td>
 <td class="colLast"><span class="typeNameLabel">PredefinedAeadParameters.</span><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/aead/PredefinedAeadParameters.html#X_AES_GCM_8_BYTE_SALT_NO_PREFIX">X_AES_GCM_8_BYTE_SALT_NO_PREFIX</a></span></code>
-<div class="block">A <a href="../../../../../../com/google/crypto/tink/Parameters.html" title="class in com.google.crypto.tink"><code>Parameters</code></a> object for generating new instances of
- <a href="../../../../../../com/google/crypto/tink/aead/XAesGcmKey.html" title="class in com.google.crypto.tink.aead"><code>XAesGcmKey</code></a> with the following parameters:
-
-
-   Salt size: 8 bytes
-   Output prefix type: NO_PREFIX
- </div>
+<div class="block">A <a href="../../../../../../com/google/crypto/tink/Parameters.html" title="class in com.google.crypto.tink"><code>Parameters</code></a> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/XAesGcmKey.html" title="class in com.google.crypto.tink.aead"><code>XAesGcmKey</code></a>.</div>
 </td>
 </tr>
 </tbody>
@@ -125,7 +119,9 @@ <h3>Uses of <a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParame
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters</a></code></td>
 <td class="colLast"><span class="typeNameLabel">XAesGcmParameters.</span><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html#create-com.google.crypto.tink.aead.XAesGcmParameters.Variant-int-">create</a></span>(<a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParameters.Variant.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters.Variant</a>&nbsp;variant,
-      int&nbsp;saltSizeBytes)</code>&nbsp;</td>
+      int&nbsp;saltSizeBytes)</code>
+<div class="block">Creates a new <a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead"><code>XAesGcmParameters</code></a> object for generating new instances of <a href="../../../../../../com/google/crypto/tink/aead/XAesGcmKey.html" title="class in com.google.crypto.tink.aead"><code>XAesGcmKey</code></a>.</div>
+</td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters</a></code></td>