Skip to content

Commit

Permalink
tink-HEAD-SNAPSHOT Javadoc auto-pushed to gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Tink Team committed Nov 25, 2024
1 parent c8db3e7 commit 6fe1c6c
Show file tree
Hide file tree
Showing 3 changed files with 102 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -204,11 +204,27 @@ <h3>Field Summary</h3>
</tr>
<tr class="rowColor">
<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/PredefinedAeadParameters.html#X_AES_GCM_8_BYTE_SALT_NO_PREFIX">X_AES_GCM_8_BYTE_SALT_NO_PREFIX</a></span></code>
<td class="colLast"><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>&nbsp;</td>
</tr>
<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"><code><span class="memberNameLink"><a href="../../../../../com/google/crypto/tink/aead/PredefinedAeadParameters.html#XAES_256_GCM_160_BIT_NONCE_NO_PREFIX">XAES_256_GCM_160_BIT_NONCE_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>.</div>
</td>
</tr>
<tr class="rowColor">
<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/PredefinedAeadParameters.html#XAES_256_GCM_192_BIT_NONCE">XAES_256_GCM_192_BIT_NONCE</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>.</div>
</td>
</tr>
<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"><code><span class="memberNameLink"><a href="../../../../../com/google/crypto/tink/aead/PredefinedAeadParameters.html#XAES_256_GCM_192_BIT_NONCE_NO_PREFIX">XAES_256_GCM_192_BIT_NONCE_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>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../com/google/crypto/tink/aead/XChaCha20Poly1305Parameters.html" title="class in com.google.crypto.tink.aead">XChaCha20Poly1305Parameters</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/google/crypto/tink/aead/PredefinedAeadParameters.html#XCHACHA20_POLY1305">XCHACHA20_POLY1305</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 that generates new instances of <a href="../../../../../com/google/crypto/tink/aead/XChaCha20Poly1305Key.html" title="class in com.google.crypto.tink.aead"><code>XChaCha20Poly1305Key</code></a>.</div>
Expand Down Expand Up @@ -366,26 +382,74 @@ <h4>XCHACHA20_POLY1305</h4>
<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/XChaCha20Poly1305Key.html" title="class in com.google.crypto.tink.aead"><code>XChaCha20Poly1305Key</code></a>.</div>
</li>
</ul>
<a name="X_AES_GCM_8_BYTE_SALT_NO_PREFIX">
<a name="XAES_256_GCM_192_BIT_NONCE">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>X_AES_GCM_8_BYTE_SALT_NO_PREFIX</h4>
<pre>public static final&nbsp;<a href="../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters</a> X_AES_GCM_8_BYTE_SALT_NO_PREFIX</pre>
<h4>XAES_256_GCM_192_BIT_NONCE</h4>
<pre>public static final&nbsp;<a href="../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters</a> XAES_256_GCM_192_BIT_NONCE</pre>
<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>. This follows the algorithm defined in the <a
href="https://github.com/C2SP/C2SP/blob/main/XAES-256-GCM.md">XAES-256-GCM specification</a>

<ul>
<li>Key size: 32 bytes
<li>Nonce size: 24 bytes (12 bytes of salt, 12 bytes of AES-GCM IV)
<li>Salt size: 12 bytes
<li>Tag size: 16 bytes
<li>Output prefix: TINK
</ul></div>
</li>
</ul>
<a name="XAES_256_GCM_192_BIT_NONCE_NO_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XAES_256_GCM_192_BIT_NONCE_NO_PREFIX</h4>
<pre>public static final&nbsp;<a href="../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters</a> XAES_256_GCM_192_BIT_NONCE_NO_PREFIX</pre>
<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>. This follows the algorithm defined in the <a
href="https://github.com/C2SP/C2SP/blob/main/XAES-256-GCM.md">XAES-256-GCM specification</a>

<ul>
<li>Key size: 32 bytes
<li>Nonce size: 24 bytes (12 bytes of salt, 12 bytes of AES-GCM IV)
<li>Salt size: 12 bytes
<li>Tag size: 16 bytes
<li>Output prefix: NO_PREFIX
</ul></div>
</li>
</ul>
<a name="XAES_256_GCM_160_BIT_NONCE_NO_PREFIX">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>XAES_256_GCM_160_BIT_NONCE_NO_PREFIX</h4>
<pre>public static final&nbsp;<a href="../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters</a> XAES_256_GCM_160_BIT_NONCE_NO_PREFIX</pre>
<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>. This follows the algorithm defined in the <a
href="https://github.com/C2SP/C2SP/blob/main/XAES-256-GCM.md">XAES-256-GCM specification</a>,
except that the salt is 8 bytes instead of 12 bytes.
except that the nonce size is 160 bits instead of 192 bits. The remaining 4 bytes are padded
with zeros.

<ul>
<li>Key size: 32 bytes
<li>IV size: 20 bytes (8 bytes of salt, 12 bytes of AES-GCM IV)
<li>Nonce size: 20 bytes (8 bytes of salt, 12 bytes of AES-GCM IV)
<li>Salt size: 8 bytes
<li>Tag size: 16 bytes
<li>Output prefix: None
<li>Output prefix: NO_PREFIX
</ul></div>
</li>
</ul>
<a name="X_AES_GCM_8_BYTE_SALT_NO_PREFIX">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>X_AES_GCM_8_BYTE_SALT_NO_PREFIX</h4>
<pre>public static final&nbsp;<a href="../../../../../com/google/crypto/tink/aead/XAesGcmParameters.html" title="class in com.google.crypto.tink.aead">XAesGcmParameters</a> X_AES_GCM_8_BYTE_SALT_NO_PREFIX</pre>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,23 @@ <h3>Uses of <a href="../../../../../../com/google/crypto/tink/aead/XAesGcmParame
<tbody>
<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>
<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>&nbsp;</td>
</tr>
<tr class="rowColor">
<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#XAES_256_GCM_160_BIT_NONCE_NO_PREFIX">XAES_256_GCM_160_BIT_NONCE_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>.</div>
</td>
</tr>
<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#XAES_256_GCM_192_BIT_NONCE">XAES_256_GCM_192_BIT_NONCE</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>.</div>
</td>
</tr>
<tr class="rowColor">
<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#XAES_256_GCM_192_BIT_NONCE_NO_PREFIX">XAES_256_GCM_192_BIT_NONCE_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>.</div>
</td>
</tr>
Expand Down
16 changes: 13 additions & 3 deletions javadoc/tink/HEAD-SNAPSHOT/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -30053,15 +30053,25 @@ <h2 class="title">X</h2>
<div class="block">X25519 implementation using Conscrypt.</div>
</dd>
<dt><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> - Static variable in class com.google.crypto.tink.aead.<a href="com/google/crypto/tink/aead/PredefinedAeadParameters.html" title="class in com.google.crypto.tink.aead">PredefinedAeadParameters</a></dt>
<dd>
<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>
</dd>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="com/google/crypto/tink/proto/EcdsaPublicKey.html#X_FIELD_NUMBER">X_FIELD_NUMBER</a></span> - Static variable in class com.google.crypto.tink.proto.<a href="com/google/crypto/tink/proto/EcdsaPublicKey.html" title="class in com.google.crypto.tink.proto">EcdsaPublicKey</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="com/google/crypto/tink/proto/EciesAeadHkdfPublicKey.html#X_FIELD_NUMBER">X_FIELD_NUMBER</a></span> - Static variable in class com.google.crypto.tink.proto.<a href="com/google/crypto/tink/proto/EciesAeadHkdfPublicKey.html" title="class in com.google.crypto.tink.proto">EciesAeadHkdfPublicKey</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="com/google/crypto/tink/proto/JwtEcdsaPublicKey.html#X_FIELD_NUMBER">X_FIELD_NUMBER</a></span> - Static variable in class com.google.crypto.tink.proto.<a href="com/google/crypto/tink/proto/JwtEcdsaPublicKey.html" title="class in com.google.crypto.tink.proto">JwtEcdsaPublicKey</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="com/google/crypto/tink/aead/PredefinedAeadParameters.html#XAES_256_GCM_160_BIT_NONCE_NO_PREFIX">XAES_256_GCM_160_BIT_NONCE_NO_PREFIX</a></span> - Static variable in class com.google.crypto.tink.aead.<a href="com/google/crypto/tink/aead/PredefinedAeadParameters.html" title="class in com.google.crypto.tink.aead">PredefinedAeadParameters</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="com/google/crypto/tink/aead/PredefinedAeadParameters.html#XAES_256_GCM_192_BIT_NONCE">XAES_256_GCM_192_BIT_NONCE</a></span> - Static variable in class com.google.crypto.tink.aead.<a href="com/google/crypto/tink/aead/PredefinedAeadParameters.html" title="class in com.google.crypto.tink.aead">PredefinedAeadParameters</a></dt>
<dd>
<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>
</dd>
<dt><span class="memberNameLink"><a href="com/google/crypto/tink/aead/PredefinedAeadParameters.html#XAES_256_GCM_192_BIT_NONCE_NO_PREFIX">XAES_256_GCM_192_BIT_NONCE_NO_PREFIX</a></span> - Static variable in class com.google.crypto.tink.aead.<a href="com/google/crypto/tink/aead/PredefinedAeadParameters.html" title="class in com.google.crypto.tink.aead">PredefinedAeadParameters</a></dt>
<dd>
<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>
</dd>
<dt><a href="com/google/crypto/tink/aead/internal/XAesGcm.html" title="class in com.google.crypto.tink.aead.internal"><span class="typeNameLink">XAesGcm</span></a> - Class in <a href="com/google/crypto/tink/aead/internal/package-summary.html">com.google.crypto.tink.aead.internal</a></dt>
<dd>
<div class="block">This primitive implements XAesGcm.</div>
Expand Down

0 comments on commit 6fe1c6c

Please sign in to comment.