Skip to content

Commit

Permalink
tink-gcpkms-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 Dec 7, 2023
1 parent ae73438 commit bcca0e9
Show file tree
Hide file tree
Showing 12 changed files with 579 additions and 17 deletions.
1 change: 1 addition & 0 deletions javadoc/tink-gcpkms/HEAD-SNAPSHOT/allclasses-frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
1 change: 1 addition & 0 deletions javadoc/tink-gcpkms/HEAD-SNAPSHOT/allclasses-noframe.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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">
Expand All @@ -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>
Expand Down Expand Up @@ -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,
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down Expand Up @@ -461,7 +461,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">
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Uses of Class com.google.crypto.tink.integration.gcpkms.GcpKmsAead.Builder</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Uses of Class com.google.crypto.tink.integration.gcpkms.GcpKmsAead.Builder";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../com/google/crypto/tink/integration/gcpkms/package-summary.html">Package</a></li>
<li><a href="../../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?com/google/crypto/tink/integration/gcpkms/class-use/GcpKmsAead.Builder.html" target="_top">Frames</a></li>
<li><a href="GcpKmsAead.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h2 title="Uses of Class com.google.crypto.tink.integration.gcpkms.GcpKmsAead.Builder" class="title">Uses of Class<br>com.google.crypto.tink.integration.gcpkms.GcpKmsAead.Builder</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="com.google.crypto.tink.integration.gcpkms">
<!-- -->
</a>
<h3>Uses of <a href="../../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms">GcpKmsAead.Builder</a> in <a href="../../../../../../../com/google/crypto/tink/integration/gcpkms/package-summary.html">com.google.crypto.tink.integration.gcpkms</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../../../../com/google/crypto/tink/integration/gcpkms/package-summary.html">com.google.crypto.tink.integration.gcpkms</a> that return <a href="../../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms">GcpKmsAead.Builder</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr 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"><span class="typeNameLabel">GcpKmsAead.</span><code><span class="memberNameLink"><a href="../../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.html#builder--">builder</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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"><span class="typeNameLabel">GcpKmsAead.Builder.</span><code><span class="memberNameLink"><a href="../../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html#setCloudKms-com.google.api.services.cloudkms.v1.CloudKMS-">setCloudKms</a></span>(com.google.api.services.cloudkms.v1.CloudKMS&nbsp;cloudKms)</code>
<div class="block">Set the CloudKms object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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"><span class="typeNameLabel">GcpKmsAead.Builder.</span><code><span class="memberNameLink"><a href="../../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html#setKeyManagementServiceClient-com.google.cloud.kms.v1.KeyManagementServiceClient-">setKeyManagementServiceClient</a></span>(com.google.cloud.kms.v1.KeyManagementServiceClient&nbsp;kmsClient)</code>
<div class="block">Set the KeyManagementServiceClient object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><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"><span class="typeNameLabel">GcpKmsAead.Builder.</span><code><span class="memberNameLink"><a href="../../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html#setKeyName-java.lang.String-">setKeyName</a></span>(<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>&nbsp;keyName)</code>
<div class="block">Set the ResourceName of the KMS key.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../com/google/crypto/tink/integration/gcpkms/package-summary.html">Package</a></li>
<li><a href="../../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?com/google/crypto/tink/integration/gcpkms/class-use/GcpKmsAead.Builder.html" target="_top">Frames</a></li>
<li><a href="GcpKmsAead.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ <h1 class="bar"><a href="../../../../../../com/google/crypto/tink/integration/gc
<h2 title="Classes">Classes</h2>
<ul title="Classes">
<li><a href="GcpKmsAead.html" title="class in com.google.crypto.tink.integration.gcpkms" target="classFrame">GcpKmsAead</a></li>
<li><a href="GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms" target="classFrame">GcpKmsAead.Builder</a></li>
<li><a href="GcpKmsClient.html" title="class in com.google.crypto.tink.integration.gcpkms" target="classFrame">GcpKmsClient</a></li>
</ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,17 @@ <h1 title="Package" class="title">Package&nbsp;com.google.crypto.tink.integratio
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.html" title="class in com.google.crypto.tink.integration.gcpkms">GcpKmsAead</a></td>
<td class="colLast">
<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>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsAead.Builder.html" title="class in com.google.crypto.tink.integration.gcpkms">GcpKmsAead.Builder</a></td>
<td class="colLast">
<div class="block">A Builder to create an Aead backed by GCP Cloud KMS.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../../com/google/crypto/tink/integration/gcpkms/GcpKmsClient.html" title="class in com.google.crypto.tink.integration.gcpkms">GcpKmsClient</a></td>
<td class="colLast">
<div class="block">An implementation of <code>KmsClient</code> for <a href="https://cloud.google.com/kms/">Google Cloud
Expand Down
Loading

0 comments on commit bcca0e9

Please sign in to comment.