386 lines
14 KiB
HTML
386 lines
14 KiB
HTML
<!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_262) on Tue May 23 15:15:09 BST 2023 -->
|
|
<title>ICipherFactory</title>
|
|
<meta name="date" content="2023-05-23">
|
|
<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="ICipherFactory";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/CipherException.html" title="class in com.captainalm.lib.stdcrypt.encryption"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li>Next Class</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html" target="_top">Frames</a></li>
|
|
<li><a href="ICipherFactory.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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">com.captainalm.lib.stdcrypt.encryption</div>
|
|
<h2 title="Interface ICipherFactory" class="title">Interface ICipherFactory</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html" title="class in com.captainalm.lib.stdcrypt.encryption">AESPasswordRfc2898CipherFactory</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public interface <span class="typeNameLabel">ICipherFactory</span></pre>
|
|
<div class="block">This interface provides the ability to obtain a <code>Cipher</code> and get and set its settings.</div>
|
|
<dl>
|
|
<dt><span class="simpleTagLabel">Author:</span></dt>
|
|
<dd>Captain ALM</dd>
|
|
</dl>
|
|
</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>boolean</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#cipherAttributesModified--">cipherAttributesModified</a></span>()</code>
|
|
<div class="block">Gets if the cipher settings attributes have been modified.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>javax.crypto.Cipher</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#getCipher-int-">getCipher</a></span>(int opmode)</code>
|
|
<div class="block">Gets a new cipher instance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#getName--">getName</a></span>()</code>
|
|
<div class="block">Gets the name of the cipher factory.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>byte[]</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#getSettings--">getSettings</a></span>()</code>
|
|
<div class="block">Gets the cipher settings as a byte array.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#getSettingsLength--">getSettingsLength</a></span>()</code>
|
|
<div class="block">Gets the length of the settings byte array.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>byte[]</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#getSettingsNoSecrets--">getSettingsNoSecrets</a></span>()</code>
|
|
<div class="block">Gets the cipher settings as a byte array without secrets.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#getSettingsNoSecretsLength--">getSettingsNoSecretsLength</a></span>()</code>
|
|
<div class="block">Gets the length of the settings byte array without secrets.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#setSettings-byte:A-">setSettings</a></span>(byte[] settingsIn)</code>
|
|
<div class="block">Sets the cipher settings using a byte array.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</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="getCipher-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCipher</h4>
|
|
<pre>javax.crypto.Cipher getCipher(int opmode)
|
|
throws <a href="../../../../../com/captainalm/lib/stdcrypt/encryption/CipherException.html" title="class in com.captainalm.lib.stdcrypt.encryption">CipherException</a></pre>
|
|
<div class="block">Gets a new cipher instance.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>opmode</code> - The Cipher Operation Mode (<code>Cipher.ENCRYPT_MODE</code>, <code>Cipher.DECRYPT_MODE</code>, <code>Cipher.WRAP_MODE</code> and <code>Cipher.UNWRAP_MODE</code>).</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The new cipher instance or null.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/CipherException.html" title="class in com.captainalm.lib.stdcrypt.encryption">CipherException</a></code> - An Exception has occurred.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getName--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getName</h4>
|
|
<pre>java.lang.String getName()</pre>
|
|
<div class="block">Gets the name of the cipher factory.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The name of the cipher factory.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="cipherAttributesModified--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>cipherAttributesModified</h4>
|
|
<pre>boolean cipherAttributesModified()</pre>
|
|
<div class="block">Gets if the cipher settings attributes have been modified.
|
|
Resets the flag once checked.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>If the attributes have been modified.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSettings--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSettings</h4>
|
|
<pre>byte[] getSettings()</pre>
|
|
<div class="block">Gets the cipher settings as a byte array.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The byte array of the settings.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSettingsLength--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSettingsLength</h4>
|
|
<pre>int getSettingsLength()</pre>
|
|
<div class="block">Gets the length of the settings byte array.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The length of the settings byte array.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSettingsNoSecrets--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSettingsNoSecrets</h4>
|
|
<pre>byte[] getSettingsNoSecrets()</pre>
|
|
<div class="block">Gets the cipher settings as a byte array without secrets.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The byte array of the settings without secrets.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSettingsNoSecretsLength--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSettingsNoSecretsLength</h4>
|
|
<pre>int getSettingsNoSecretsLength()</pre>
|
|
<div class="block">Gets the length of the settings byte array without secrets.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The length of the settings byte array without secrets.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setSettings-byte:A-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>setSettings</h4>
|
|
<pre>void setSettings(byte[] settingsIn)
|
|
throws <a href="../../../../../com/captainalm/lib/stdcrypt/encryption/CipherException.html" title="class in com.captainalm.lib.stdcrypt.encryption">CipherException</a></pre>
|
|
<div class="block">Sets the cipher settings using a byte array.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>settingsIn</code> - The byte array to load the settings from.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - settingsIn is null.</dd>
|
|
<dd><code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/CipherException.html" title="class in com.captainalm.lib.stdcrypt.encryption">CipherException</a></code> - An Exception has occurred.</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="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/CipherException.html" title="class in com.captainalm.lib.stdcrypt.encryption"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li>Next Class</li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html" target="_top">Frames</a></li>
|
|
<li><a href="ICipherFactory.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|