blob: 4031668a43733abe268680423c990fbac804ddde [file] [log] [blame]
<!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 (1.8.0_261) on Mon Dec 20 14:15:51 MSK 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EncryptionSpi (Ignite 2.11.1)</title>
<meta name="date" content="2021-12-20">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<link rel='shortcut icon' href='https://ignite.apache.org/favicon.ico'/>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="EncryptionSpi (Ignite 2.11.1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/EncryptionSpi.html">Use</a></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&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/ignite/spi/encryption/EncryptionSpi.html" target="_top">Frames</a></li>
<li><a href="EncryptionSpi.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.ignite.spi.encryption</div>
<h2 title="Interface EncryptionSpi" class="title">Interface EncryptionSpi</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../org/apache/ignite/spi/IgniteSpi.html" title="interface in org.apache.ignite.spi">IgniteSpi</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/ignite/spi/encryption/keystore/KeystoreEncryptionSpi.html" title="class in org.apache.ignite.spi.encryption.keystore">KeystoreEncryptionSpi</a>, <a href="../../../../../org/apache/ignite/spi/encryption/noop/NoopEncryptionSpi.html" title="class in org.apache.ignite.spi.encryption.noop">NoopEncryptionSpi</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">EncryptionSpi</span>
extends <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html" title="interface in org.apache.ignite.spi">IgniteSpi</a></pre>
<div class="block">SPI provides encryption features for an Ignite.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#blockSize--">blockSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#create--">create</a></span>()</code>
<div class="block">Creates new key for an encryption/decryption of cache persistent data: pages, WAL records.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#decrypt-byte:A-java.io.Serializable-">decrypt</a></span>(byte[]&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;key)</code>
<div class="block">Decrypts data encrypted with <a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#encrypt-java.nio.ByteBuffer-java.io.Serializable-java.nio.ByteBuffer-"><code>encrypt(ByteBuffer, Serializable, ByteBuffer)</code></a></div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#decryptKey-byte:A-">decryptKey</a></span>(byte[]&nbsp;key)</code>
<div class="block">Decrypts key and checks it integrity.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#decryptKey-byte:A-java.lang.String-">decryptKey</a></span>(byte[]&nbsp;key,
<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;masterKeyName)</code>
<div class="block">Decrypts key and checks its integrity using the master key specified by name.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#decryptNoPadding-java.nio.ByteBuffer-java.io.Serializable-java.nio.ByteBuffer-">decryptNoPadding</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;res)</code>
<div class="block">Decrypts data encrypted with <a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#encryptNoPadding-java.nio.ByteBuffer-java.io.Serializable-java.nio.ByteBuffer-"><code>encryptNoPadding(ByteBuffer, Serializable, ByteBuffer)</code></a></div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#encrypt-java.nio.ByteBuffer-java.io.Serializable-java.nio.ByteBuffer-">encrypt</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;res)</code>
<div class="block">Encrypts data.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#encryptedSize-int-">encryptedSize</a></span>(int&nbsp;dataSize)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#encryptedSizeNoPadding-int-">encryptedSizeNoPadding</a></span>(int&nbsp;dataSize)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#encryptKey-java.io.Serializable-">encryptKey</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;key)</code>
<div class="block">Encrypts key.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#encryptKey-java.io.Serializable-java.lang.String-">encryptKey</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;key,
<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;masterKeyName)</code>
<div class="block">Encrypts a key with the master key specified by name.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#encryptNoPadding-java.nio.ByteBuffer-java.io.Serializable-java.nio.ByteBuffer-">encryptNoPadding</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;res)</code>
<div class="block">Encrypts data without padding info.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#getMasterKeyName--">getMasterKeyName</a></span>()</code>
<div class="block">Gets the current master key name.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#masterKeyDigest--">masterKeyDigest</a></span>()</code>
<div class="block">Returns master key digest.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#masterKeyDigest-java.lang.String-">masterKeyDigest</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;masterKeyName)</code>
<div class="block">Returns master key digest by name.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#setMasterKeyName-java.lang.String-">setMasterKeyName</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;masterKeyName)</code>
<div class="block">Sets master key Name that will be used for keys encryption in <a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#encryptKey-java.io.Serializable-"><code>encryptKey(Serializable)</code></a> and <a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#decryptKey-byte:A-"><code>decryptKey(byte[])</code></a> methods and in the <a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#masterKeyDigest--"><code>masterKeyDigest()</code></a> method.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.ignite.spi.IgniteSpi">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.ignite.spi.<a href="../../../../../org/apache/ignite/spi/IgniteSpi.html" title="interface in org.apache.ignite.spi">IgniteSpi</a></h3>
<code><a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#getName--">getName</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#getNodeAttributes--">getNodeAttributes</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#onClientDisconnected-org.apache.ignite.lang.IgniteFuture-">onClientDisconnected</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#onClientReconnected-boolean-">onClientReconnected</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#onContextDestroyed--">onContextDestroyed</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#onContextInitialized-org.apache.ignite.spi.IgniteSpiContext-">onContextInitialized</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#spiStart-java.lang.String-">spiStart</a>, <a href="../../../../../org/apache/ignite/spi/IgniteSpi.html#spiStop--">spiStop</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="masterKeyDigest--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>masterKeyDigest</h4>
<pre>byte[]&nbsp;masterKeyDigest()</pre>
<div class="block">Returns master key digest.
Should always return same digest for a same key.
Digest used for a configuration consistency check.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Master key digest.</dd>
</dl>
</li>
</ul>
<a name="masterKeyDigest-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>masterKeyDigest</h4>
<pre>byte[]&nbsp;masterKeyDigest(<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;masterKeyName)</pre>
<div class="block">Returns master key digest by name.
Should always return same digest for a same key.
Digest used for a configuration consistency check.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>masterKeyName</code> - Master key name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Master key digest.</dd>
</dl>
</li>
</ul>
<a name="create--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;create()
throws <a href="../../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></pre>
<div class="block">Creates new key for an encryption/decryption of cache persistent data: pages, WAL records.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Newly created encryption key.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/ignite/IgniteException.html" title="class in org.apache.ignite">IgniteException</a></code> - If key creation failed.</dd>
</dl>
</li>
</ul>
<a name="encrypt-java.nio.ByteBuffer-java.io.Serializable-java.nio.ByteBuffer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encrypt</h4>
<pre>void&nbsp;encrypt(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;res)</pre>
<div class="block">Encrypts data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - Data to encrypt.</dd>
<dd><code>key</code> - Encryption key.</dd>
<dd><code>res</code> - Destination buffer.</dd>
</dl>
</li>
</ul>
<a name="encryptNoPadding-java.nio.ByteBuffer-java.io.Serializable-java.nio.ByteBuffer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encryptNoPadding</h4>
<pre>void&nbsp;encryptNoPadding(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;res)</pre>
<div class="block">Encrypts data without padding info.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - Data to encrypt.</dd>
<dd><code>key</code> - Encryption key.</dd>
<dd><code>res</code> - Destination buffer.</dd>
</dl>
</li>
</ul>
<a name="decrypt-byte:A-java.io.Serializable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decrypt</h4>
<pre>byte[]&nbsp;decrypt(byte[]&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;key)</pre>
<div class="block">Decrypts data encrypted with <a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#encrypt-java.nio.ByteBuffer-java.io.Serializable-java.nio.ByteBuffer-"><code>encrypt(ByteBuffer, Serializable, ByteBuffer)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - Data to decrypt.</dd>
<dd><code>key</code> - Encryption key.</dd>
</dl>
</li>
</ul>
<a name="decryptNoPadding-java.nio.ByteBuffer-java.io.Serializable-java.nio.ByteBuffer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decryptNoPadding</h4>
<pre>void&nbsp;decryptNoPadding(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;data,
<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;key,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;res)</pre>
<div class="block">Decrypts data encrypted with <a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#encryptNoPadding-java.nio.ByteBuffer-java.io.Serializable-java.nio.ByteBuffer-"><code>encryptNoPadding(ByteBuffer, Serializable, ByteBuffer)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - Data to decrypt.</dd>
<dd><code>key</code> - Encryption key.</dd>
</dl>
</li>
</ul>
<a name="encryptKey-java.io.Serializable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encryptKey</h4>
<pre>byte[]&nbsp;encryptKey(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;key)</pre>
<div class="block">Encrypts key.
Adds some info to check key integrity on decryption.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key to encrypt.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Encrypted key.</dd>
</dl>
</li>
</ul>
<a name="encryptKey-java.io.Serializable-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encryptKey</h4>
<pre>byte[]&nbsp;encryptKey(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;key,
<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;masterKeyName)</pre>
<div class="block">Encrypts a key with the master key specified by name.
Adds some info to check key integrity on decryption.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key to encrypt.</dd>
<dd><code>masterKeyName</code> - Master key name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Encrypted key.</dd>
</dl>
</li>
</ul>
<a name="decryptKey-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decryptKey</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;decryptKey(byte[]&nbsp;key)</pre>
<div class="block">Decrypts key and checks it integrity.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key to decrypt.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Encrypted key.</dd>
</dl>
</li>
</ul>
<a name="decryptKey-byte:A-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decryptKey</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>&nbsp;decryptKey(byte[]&nbsp;key,
<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;masterKeyName)</pre>
<div class="block">Decrypts key and checks its integrity using the master key specified by name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - Key to decrypt.</dd>
<dd><code>masterKeyName</code> - Master key name.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Encrypted key.</dd>
</dl>
</li>
</ul>
<a name="encryptedSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encryptedSize</h4>
<pre>int&nbsp;encryptedSize(int&nbsp;dataSize)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dataSize</code> - Size of plain data in bytes.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Size of encrypted data in bytes for padding encryption mode.</dd>
</dl>
</li>
</ul>
<a name="encryptedSizeNoPadding-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encryptedSizeNoPadding</h4>
<pre>int&nbsp;encryptedSizeNoPadding(int&nbsp;dataSize)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dataSize</code> - Size of plain data in bytes.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Size of encrypted data in bytes for nopadding encryption mode.</dd>
</dl>
</li>
</ul>
<a name="blockSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>blockSize</h4>
<pre>int&nbsp;blockSize()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Encrypted data block size.</dd>
</dl>
</li>
</ul>
<a name="getMasterKeyName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMasterKeyName</h4>
<pre><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;getMasterKeyName()</pre>
<div class="block">Gets the current master key name.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Master key name.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#setMasterKeyName-java.lang.String-"><code>setMasterKeyName(String)</code></a></dd>
</dl>
</li>
</ul>
<a name="setMasterKeyName-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setMasterKeyName</h4>
<pre>void&nbsp;setMasterKeyName(<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;masterKeyName)
throws <a href="../../../../../org/apache/ignite/spi/IgniteSpiException.html" title="class in org.apache.ignite.spi">IgniteSpiException</a></pre>
<div class="block">Sets master key Name that will be used for keys encryption in <a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#encryptKey-java.io.Serializable-"><code>encryptKey(Serializable)</code></a> and <a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#decryptKey-byte:A-"><code>decryptKey(byte[])</code></a> methods and in the <a href="../../../../../org/apache/ignite/spi/encryption/EncryptionSpi.html#masterKeyDigest--"><code>masterKeyDigest()</code></a> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>masterKeyName</code> - Master key name.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/ignite/spi/IgniteSpiException.html" title="class in org.apache.ignite.spi">IgniteSpiException</a></code> - In case of error.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/EncryptionSpi.html">Use</a></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&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/ignite/spi/encryption/EncryptionSpi.html" target="_top">Frames</a></li>
<li><a href="EncryptionSpi.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2021 Copyright &#169; Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Database and Caching Platform</b> </td> <td>:&nbsp;&nbsp; ver. <strong>2.11.1</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; December 20 2021 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>