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

tink-crypto · Mar 18, 2024 · 6736ac2 · 6736ac2
1 parent 065b8f1
commit 6736ac2
Show file tree

Hide file tree

Showing 13 changed files with 593 additions and 68 deletions.
diff --git a/javadoc/tink-gcpkms/HEAD-SNAPSHOT/allclasses-frame.html b/javadoc/tink-gcpkms/HEAD-SNAPSHOT/allclasses-frame.html
@@ -12,6 +12,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <div class="indexContainer">
 <ul>
 <li><a href="com/google/crypto/tink/integration/gcpkms/GcpKmsAead.html" title="class in com.google.crypto.tink.integration.gcpkms" target="classFrame">GcpKmsAead</a></li>
+<li><a href="com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms" target="classFrame">GcpKmsAead.Builder</a></li>
 <li><a href="com/google/crypto/tink/integration/gcpkms/GcpKmsClient.html" title="class in com.google.crypto.tink.integration.gcpkms" target="classFrame">GcpKmsClient</a></li>
 </ul>
 </div>

diff --git a/javadoc/tink-gcpkms/HEAD-SNAPSHOT/allclasses-noframe.html b/javadoc/tink-gcpkms/HEAD-SNAPSHOT/allclasses-noframe.html
@@ -12,6 +12,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <div class="indexContainer">
 <ul>
 <li><a href="com/google/crypto/tink/integration/gcpkms/GcpKmsAead.html" title="class in com.google.crypto.tink.integration.gcpkms">GcpKmsAead</a></li>
+<li><a href="com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms">GcpKmsAead.Builder</a></li>
 <li><a href="com/google/crypto/tink/integration/gcpkms/GcpKmsClient.html" title="class in com.google.crypto.tink.integration.gcpkms">GcpKmsClient</a></li>
 </ul>
 </div>

diff --git a/...nk-gcpkms/HEAD-SNAPSHOT/com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html b/...nk-gcpkms/HEAD-SNAPSHOT/com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html
diff --git a/javadoc/tink-gcpkms/HEAD-SNAPSHOT/com/google/crypto/tink/integration/gcpkms/GcpKmsAead.html b/javadoc/tink-gcpkms/HEAD-SNAPSHOT/com/google/crypto/tink/integration/gcpkms/GcpKmsAead.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":9,"i1":10,"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";
 var tableTab = "tableTab";
@@ -48,7 +48,7 @@
 <div class="subNav">
 <ul class="navList">
 <li>Prev&nbsp;Class</li>
-<li><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsClient.html" title="class in com.google.crypto.tink.integration.gcpkms"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
+<li><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?com/google/crypto/tink/integration/gcpkms/GcpKmsAead.html" target="_top">Frames</a></li>
@@ -72,7 +72,7 @@
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
-<li>Nested&nbsp;|&nbsp;</li>
+<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
@@ -114,7 +114,7 @@ <h2 title="Class GcpKmsAead" class="title">Class GcpKmsAead</h2>
 <pre>public final class <span class="typeNameLabel">GcpKmsAead</span>
 extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
 implements com.google.crypto.tink.Aead</pre>
-<div class="block">A <code>Aead</code> that forwards encryption/decryption requests to a key in <a
+<div class="block">An <code>Aead</code> that forwards encryption/decryption requests to a key in <a
  href="https://cloud.google.com/kms/">Google Cloud KMS</a>.
 
  <p>As of August 2017, Google Cloud KMS supports only AES-256-GCM keys.</div>
@@ -128,6 +128,27 @@ <h2 title="Class GcpKmsAead" class="title">Class GcpKmsAead</h2>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+<ul class="blockList">
+<li class="blockList"><a name="nested.class.summary">
+<!--   -->
+</a>
+<h3>Nested Class Summary</h3>
+<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
+<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Class and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static class&nbsp;</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms">GcpKmsAead.Builder</a></span></code>
+<div class="block">A Builder to create an Aead backed by GCP Cloud KMS.</div>
+</td>
+</tr>
+</table>
+</li>
+</ul>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor.summary">
@@ -153,17 +174,21 @@ <h3>Constructor Summary</h3>
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
-<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
+<td class="colFirst"><code>static <a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms">GcpKmsAead.Builder</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.html#builder--">builder</a></span>()</code>&nbsp;</td>
+</tr>
+<tr id="i1" class="rowColor">
 <td class="colFirst"><code>byte[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.html#decrypt-byte:A-byte:A-">decrypt</a></span>(byte[]&nbsp;ciphertext,
        byte[]&nbsp;associatedData)</code>&nbsp;</td>
 </tr>
-<tr id="i1" class="rowColor">
+<tr id="i2" class="altColor">
 <td class="colFirst"><code>byte[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.html#encrypt-byte:A-byte:A-">encrypt</a></span>(byte[]&nbsp;plaintext,
        byte[]&nbsp;associatedData)</code>&nbsp;</td>
@@ -228,7 +253,7 @@ <h4>encrypt</h4>
 <a name="decrypt-byte:A-byte:A-">
 <!--   -->
 </a>
-<ul class="blockListLast">
+<ul class="blockList">
 <li class="blockList">
 <h4>decrypt</h4>
 <pre>public&nbsp;byte[]&nbsp;decrypt(byte[]&nbsp;ciphertext,
@@ -242,6 +267,15 @@ <h4>decrypt</h4>
 </dl>
 </li>
 </ul>
+<a name="builder--">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>builder</h4>
+<pre>public static&nbsp;<a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms">GcpKmsAead.Builder</a>&nbsp;builder()</pre>
+</li>
+</ul>
 </li>
 </ul>
 </li>
@@ -270,7 +304,7 @@ <h4>decrypt</h4>
 <div class="subNav">
 <ul class="navList">
 <li>Prev&nbsp;Class</li>
-<li><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsClient.html" title="class in com.google.crypto.tink.integration.gcpkms"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
+<li><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../../index.html?com/google/crypto/tink/integration/gcpkms/GcpKmsAead.html" target="_top">Frames</a></li>
@@ -294,7 +328,7 @@ <h4>decrypt</h4>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
-<li>Nested&nbsp;|&nbsp;</li>
+<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>

diff --git a/...doc/tink-gcpkms/HEAD-SNAPSHOT/com/google/crypto/tink/integration/gcpkms/GcpKmsClient.html b/...doc/tink-gcpkms/HEAD-SNAPSHOT/com/google/crypto/tink/integration/gcpkms/GcpKmsClient.html
@@ -17,8 +17,8 @@
     catch(err) {
     }
 //-->
-var methods = {"i0":10,"i1":10,"i2":41,"i3":10,"i4":10,"i5":10,"i6":10};
-var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
+var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":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";
@@ -47,7 +47,7 @@
 </div>
 <div class="subNav">
 <ul class="navList">
-<li><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.html" title="class in com.google.crypto.tink.integration.gcpkms"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
+<li><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li>Next&nbsp;Class</li>
 </ul>
 <ul class="navList">
@@ -179,7 +179,7 @@ <h3>Constructor Summary</h3>
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
-<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
+<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
@@ -199,12 +199,7 @@ <h3>Method Summary</h3>
 <td class="colFirst"><code>static void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsClient.html#register-java.util.Optional-java.util.Optional-">register</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;keyUri,
         <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;credentialPath)</code>
-<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
-<div class="block"><span class="deprecationComment">It is preferable to not register KMS clients. Instead, create the GcpKmsClient
-     yourself and call <code>getAead</code> to get a remote <code>Aead</code>. Use this <code>Aead</code> to
-     encrypt a keyset with <code>TinkProtoKeysetFormat.serializeEncryptedKeyset</code>, or to create
-     an envelope <code>Aead</code> using <code>KmsEnvelopeAead.create</code>.</span></div>
-</div>
+<div class="block">Creates and registers a <a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsClient.html#GcpKmsClient-java.lang.String-"><code>GcpKmsClient(java.lang.String)</code></a> with the Tink runtime.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
@@ -413,21 +408,21 @@ <h4>getAead</h4>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>register</h4>
-<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>
-public static&nbsp;void&nbsp;register(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;keyUri,
-                                        <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;credentialPath)
-                                 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">It is preferable to not register KMS clients. Instead, create the GcpKmsClient
-     yourself and call <code>getAead</code> to get a remote <code>Aead</code>. Use this <code>Aead</code> to
-     encrypt a keyset with <code>TinkProtoKeysetFormat.serializeEncryptedKeyset</code>, or to create
-     an envelope <code>Aead</code> using <code>KmsEnvelopeAead.create</code>.</span></div>
+<pre>public static&nbsp;void&nbsp;register(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;keyUri,
+                            <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;credentialPath)
+                     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 and registers a <a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsClient.html#GcpKmsClient-java.lang.String-"><code>GcpKmsClient(java.lang.String)</code></a> with the Tink runtime.
 
  <p>If <code>keyUri</code> is present, it is the only key that the new client will support. Otherwise
  the new client supports all GCP KMS keys.
 
  <p>If <code>credentialPath</code> is present, load the credentials from that. Otherwise use the
- default credentials.</div>
+ default credentials.
+
+ <p>In many cases, it is not necessary to register the client. For example, you can create the
+ GcpKmsClient yourself and call <a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsClient.html#getAead-java.lang.String-"><code>getAead(java.lang.String)</code></a> to get a remote <code>Aead</code>. Use
+ this <code>Aead</code> to encrypt a keyset for with <code>TinkProtoKeysetFormat.serializeEncryptedKeyset</code>, or to create an envelope <code>Aead</code> using
+ <code>KmsEnvelopeAead.create</code>.</div>
 <dl>
 <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>
@@ -461,7 +456,7 @@ <h4>register</h4>
 </div>
 <div class="subNav">
 <ul class="navList">
-<li><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.html" title="class in com.google.crypto.tink.integration.gcpkms"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
+<li><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li>Next&nbsp;Class</li>
 </ul>
 <ul class="navList">