alfred/calmstdcrypt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity
master
calmstdcrypt/JavaDoc/com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html

696 lines
30 KiB
HTML
Raw Permalink Normal View History

Add JavaDoc.
2023-05-23 15:16:28 +01:00
<!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>AESPasswordRfc2898CipherFactory</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="AESPasswordRfc2898CipherFactory";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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>Prev&nbsp;Class</li>
<li><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/CipherException.html" title="class in com.captainalm.lib.stdcrypt.encryption"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html" target="_top">Frames</a></li>
<li><a href="AESPasswordRfc2898CipherFactory.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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">com.captainalm.lib.stdcrypt.encryption</div>
<h2 title="Class AESPasswordRfc2898CipherFactory" class="title">Class AESPasswordRfc2898CipherFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.captainalm.lib.stdcrypt.encryption.AESPasswordRfc2898CipherFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html" title="interface in com.captainalm.lib.stdcrypt.encryption">ICipherFactory</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">AESPasswordRfc2898CipherFactory</span>
extends java.lang.Object
implements <a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html" title="interface in com.captainalm.lib.stdcrypt.encryption">ICipherFactory</a></pre>
<div class="block">This class provides an AES cipher that uses Rfc2898 for key generation and a string password.</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">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#AESPasswordRfc2898CipherFactory-java.lang.String-">AESPasswordRfc2898CipherFactory</a></span>(java.lang.String&nbsp;password)</code>
<div class="block">Constructs a new instance of AESPasswordRfc2898CipherFactory with the specified password.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#AESPasswordRfc2898CipherFactory-java.lang.String-byte:A-byte:A-">AESPasswordRfc2898CipherFactory</a></span>(java.lang.String&nbsp;password,
byte[]&nbsp;salt,
byte[]&nbsp;initializationVector)</code>
<div class="block">Constructs a new instance of AESPasswordRfc2898CipherFactory with the specified password, salt and initialization vector.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.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/AESPasswordRfc2898CipherFactory.html#getCipher-int-">getCipher</a></span>(int&nbsp;opmode)</code>
<div class="block">Gets a new cipher instance.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#getInitializationVector--">getInitializationVector</a></span>()</code>
<div class="block">Gets the initialization vector.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#getName--">getName</a></span>()</code>
<div class="block">Gets the name of the cipher factory.</div>
</td>
</tr>
<tr id="i4" 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/AESPasswordRfc2898CipherFactory.html#getPassword--">getPassword</a></span>()</code>
<div class="block">Gets the password.</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/AESPasswordRfc2898CipherFactory.html#getSalt--">getSalt</a></span>()</code>
<div class="block">Gets the salt in use.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#getSettings--">getSettings</a></span>()</code>
<div class="block">Gets the cipher settings as a byte array.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#getSettingsLength--">getSettingsLength</a></span>()</code>
<div class="block">Gets the length of the settings byte array.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#getSettingsNoSecrets--">getSettingsNoSecrets</a></span>()</code>
<div class="block">Gets the cipher settings as a byte array without secrets.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#getSettingsNoSecretsLength--">getSettingsNoSecretsLength</a></span>()</code>
<div class="block">Gets the length of the settings byte array without secrets.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#isOutputtingInitializationVector--">isOutputtingInitializationVector</a></span>()</code>
<div class="block">Gets whether the InitializationVector is output.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#isOutputtingSalt--">isOutputtingSalt</a></span>()</code>
<div class="block">Gets whether the salt is output.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#setInitializationVector-byte:A-">setInitializationVector</a></span>(byte[]&nbsp;initializationVector)</code>
<div class="block">Sets the initialization vector in use, set to null to generate a random initialization vector.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#setOutputInitializationVector-boolean-">setOutputInitializationVector</a></span>(boolean&nbsp;outputInitializationVector)</code>
<div class="block">Sets if the InitializationVector is output.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#setOutputSalt-boolean-">setOutputSalt</a></span>(boolean&nbsp;outputSalt)</code>
<div class="block">Sets if the salt is output.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#setPassword-java.lang.String-">setPassword</a></span>(java.lang.String&nbsp;password)</code>
<div class="block">Sets the password.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#setSalt-byte:A-">setSalt</a></span>(byte[]&nbsp;salt)</code>
<div class="block">Sets the salt in use, set to null to generate a random salt.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html#setSettings-byte:A-">setSettings</a></span>(byte[]&nbsp;settingsIn)</code>
<div class="block">Sets the cipher settings using a byte array.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="AESPasswordRfc2898CipherFactory-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>AESPasswordRfc2898CipherFactory</h4>
<pre>public&nbsp;AESPasswordRfc2898CipherFactory(java.lang.String&nbsp;password)</pre>
<div class="block">Constructs a new instance of AESPasswordRfc2898CipherFactory with the specified password.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>password</code> - The password to use.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - password is null.</dd>
</dl>
</li>
</ul>
<a name="AESPasswordRfc2898CipherFactory-java.lang.String-byte:A-byte:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AESPasswordRfc2898CipherFactory</h4>
<pre>public&nbsp;AESPasswordRfc2898CipherFactory(java.lang.String&nbsp;password,
byte[]&nbsp;salt,
byte[]&nbsp;initializationVector)</pre>
<div class="block">Constructs a new instance of AESPasswordRfc2898CipherFactory with the specified password, salt and initialization vector.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>password</code> - The password to use.</dd>
<dd><code>salt</code> - The salt to use or null.</dd>
<dd><code>initializationVector</code> - The initialization vector to use or null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - password is null.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - salt or initializationVector is larger than 255.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ 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>public&nbsp;javax.crypto.Cipher&nbsp;getCipher(int&nbsp;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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#getCipher-int-">getCipher</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html" title="interface in com.captainalm.lib.stdcrypt.encryption">ICipherFactory</a></code></dd>
<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>public&nbsp;java.lang.String&nbsp;getName()</pre>
<div class="block">Gets the name of the cipher factory.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#getName--">getName</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html" title="interface in com.captainalm.lib.stdcrypt.encryption">ICipherFactory</a></code></dd>
<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>public&nbsp;boolean&nbsp;cipherAttributesModified()</pre>
<div class="block">Gets if the cipher settings attributes have been modified.
Resets the flag once checked.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#cipherAttributesModified--">cipherAttributesModified</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html" title="interface in com.captainalm.lib.stdcrypt.encryption">ICipherFactory</a></code></dd>
<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>public&nbsp;byte[]&nbsp;getSettings()</pre>
<div class="block">Gets the cipher settings as a byte array.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#getSettings--">getSettings</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html" title="interface in com.captainalm.lib.stdcrypt.encryption">ICipherFactory</a></code></dd>
<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>public&nbsp;int&nbsp;getSettingsLength()</pre>
<div class="block">Gets the length of the settings byte array.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#getSettingsLength--">getSettingsLength</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html" title="interface in com.captainalm.lib.stdcrypt.encryption">ICipherFactory</a></code></dd>
<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>public&nbsp;byte[]&nbsp;getSettingsNoSecrets()</pre>
<div class="block">Gets the cipher settings as a byte array without secrets.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#getSettingsNoSecrets--">getSettingsNoSecrets</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html" title="interface in com.captainalm.lib.stdcrypt.encryption">ICipherFactory</a></code></dd>
<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>public&nbsp;int&nbsp;getSettingsNoSecretsLength()</pre>
<div class="block">Gets the length of the settings byte array without secrets.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#getSettingsNoSecretsLength--">getSettingsNoSecretsLength</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html" title="interface in com.captainalm.lib.stdcrypt.encryption">ICipherFactory</a></code></dd>
<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="blockList">
<li class="blockList">
<h4>setSettings</h4>
<pre>public&nbsp;void&nbsp;setSettings(byte[]&nbsp;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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html#setSettings-byte:A-">setSettings</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/ICipherFactory.html" title="interface in com.captainalm.lib.stdcrypt.encryption">ICipherFactory</a></code></dd>
<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>
<a name="getPassword--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPassword</h4>
<pre>public&nbsp;java.lang.String&nbsp;getPassword()</pre>
<div class="block">Gets the password.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The password.</dd>
</dl>
</li>
</ul>
<a name="setPassword-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPassword</h4>
<pre>public&nbsp;void&nbsp;setPassword(java.lang.String&nbsp;password)</pre>
<div class="block">Sets the password.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>password</code> - The new password.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - password is null.</dd>
</dl>
</li>
</ul>
<a name="getSalt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSalt</h4>
<pre>public&nbsp;byte[]&nbsp;getSalt()</pre>
<div class="block">Gets the salt in use.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The salt.</dd>
</dl>
</li>
</ul>
<a name="setSalt-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSalt</h4>
<pre>public&nbsp;void&nbsp;setSalt(byte[]&nbsp;salt)</pre>
<div class="block">Sets the salt in use, set to null to generate a random salt.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>salt</code> - The new salt or null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - salt is larger than 255.</dd>
</dl>
</li>
</ul>
<a name="getInitializationVector--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitializationVector</h4>
<pre>public&nbsp;byte[]&nbsp;getInitializationVector()</pre>
<div class="block">Gets the initialization vector.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The initialization vector.</dd>
</dl>
</li>
</ul>
<a name="setInitializationVector-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInitializationVector</h4>
<pre>public&nbsp;void&nbsp;setInitializationVector(byte[]&nbsp;initializationVector)</pre>
<div class="block">Sets the initialization vector in use, set to null to generate a random initialization vector.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>initializationVector</code> - The new initialization vector or null.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - initializationVector is larger than 255.</dd>
</dl>
</li>
</ul>
<a name="isOutputtingSalt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOutputtingSalt</h4>
<pre>public&nbsp;boolean&nbsp;isOutputtingSalt()</pre>
<div class="block">Gets whether the salt is output.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Is the salt output.</dd>
</dl>
</li>
</ul>
<a name="setOutputSalt-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutputSalt</h4>
<pre>public&nbsp;void&nbsp;setOutputSalt(boolean&nbsp;outputSalt)</pre>
<div class="block">Sets if the salt is output.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outputSalt</code> - Should the salt be output.</dd>
</dl>
</li>
</ul>
<a name="isOutputtingInitializationVector--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isOutputtingInitializationVector</h4>
<pre>public&nbsp;boolean&nbsp;isOutputtingInitializationVector()</pre>
<div class="block">Gets whether the InitializationVector is output.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Is the InitializationVector output.</dd>
</dl>
</li>
</ul>
<a name="setOutputInitializationVector-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setOutputInitializationVector</h4>
<pre>public&nbsp;void&nbsp;setOutputInitializationVector(boolean&nbsp;outputInitializationVector)</pre>
<div class="block">Sets if the InitializationVector is output.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outputInitializationVector</code> - Should the InitializationVector be output.</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>Prev&nbsp;Class</li>
<li><a href="../../../../../com/captainalm/lib/stdcrypt/encryption/CipherException.html" title="class in com.captainalm.lib.stdcrypt.encryption"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/captainalm/lib/stdcrypt/encryption/AESPasswordRfc2898CipherFactory.html" target="_top">Frames</a></li>
<li><a href="AESPasswordRfc2898CipherFactory.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><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
Reference in New Issue Copy Permalink