|
Server : Apache/2.2.2 (Fedora) System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686 User : apache ( 48) PHP Version : 5.2.9 Disable Function : NONE Directory : /usr/share/javadoc/cryptix-3.2.0/xjava/security/ |
Upload File : |
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE html PUBLIC "-//gnu.org///DTD XHTML 1.1 plus Target 1.0//EN" "../../resources/xhtml11-target10.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><title>ExtendedKeyGenerator (cryptix JavaDoc)</title><script src="../../resources/gjdoc.js" type="text/javascript"><!-- this comment required for konqueror 3.2.2 --></script><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><meta name="generator" content="GNU Gjdoc Standard Doclet"/><meta name="keywords" content="xjava.security.ExtendedKeyGenerator class"/><meta name="keywords" content="initialize()"/><meta name="keywords" content="generateKey()"/><meta name="keywords" content="isWeakAllowed()"/><meta name="keywords" content="setWeakAllowed()"/><meta name="keywords" content="getMinimumKeyLength()"/><meta name="keywords" content="getDefaultKeyLength()"/><meta name="keywords" content="getMaximumKeyLength()"/><meta name="keywords" content="isValidKeyLength()"/><link rel="stylesheet" type="text/css" href="../../resources/gjdochtml-clean-layout.css" title="GNU Clean"/><link rel="stylesheet" type="text/css" href="../../resources/gjdochtml-clean-color1.css" title="GNU Clean"/></head><body class="content class" onload="if(parent.contentPageLoaded)parent.contentPageLoaded(document.title)"><table class="navbar div top"><tr><td class="navbar div top"><div class="navbar div top"><span class="navbar item enabled"><a href="../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../about.html">About</a></span></div></td></tr><tr><td class="navi"><a href="../../xjava/security/CipherOutputStream.html">Prev Class</a> | <a href="../../xjava/security/FeedbackCipher.html">Next Class</a></td><td class="navi"><a href="../../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="ExtendedKeyGenerator.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | Field | <a href="#summary-methods">Method</a> | Constr</td><td class="navi">Detail: Nested | Field | <a href="#detail-methods">Method</a> | Constr</td></tr></table><div class="class title outer"><h3 class="class title-package">xjava.security</h3><h1 class="class title-class">Interface ExtendedKeyGenerator</h1></div><dl class="class knownimplementing"><dt class="header"><b>Known Implementing Classes:</b></dt><dd class="item"><a href="../../cryptix/provider/key/BlowfishKeyGenerator.html" title="Class in cryptix.provider.key">BlowfishKeyGenerator</a>, <a href="../../cryptix/provider/key/CAST5KeyGenerator.html" title="Class in cryptix.provider.key">CAST5KeyGenerator</a>, <a href="../../cryptix/provider/key/DES2XKeyGenerator.html" title="Class in cryptix.provider.key">DES2XKeyGenerator</a>, <a href="../../cryptix/provider/key/DESKeyGenerator.html" title="Class in cryptix.provider.key">DESKeyGenerator</a>, <a href="../../cryptix/provider/key/DESXKeyGenerator.html" title="Class in cryptix.provider.key">DESXKeyGenerator</a>, <a href="../../cryptix/provider/key/DES_EDE3KeyGenerator.html" title="Class in cryptix.provider.key">DES_EDE3KeyGenerator</a>, <a href="../../cryptix/provider/key/IDEAKeyGenerator.html" title="Class in cryptix.provider.key">IDEAKeyGenerator</a>, <a href="../../cryptix/provider/key/LOKI91KeyGenerator.html" title="Class in cryptix.provider.key">LOKI91KeyGenerator</a>, <a href="../../cryptix/provider/key/RawKeyGenerator.html" title="Class in cryptix.provider.key">RawKeyGenerator</a>, <a href="../../cryptix/provider/key/RC2KeyGenerator.html" title="Class in cryptix.provider.key">RC2KeyGenerator</a>, <a href="../../cryptix/provider/key/RC4KeyGenerator.html" title="Class in cryptix.provider.key">RC4KeyGenerator</a>, <a href="../../cryptix/provider/key/RijndaelKeyGenerator.html" title="Class in cryptix.provider.key">RijndaelKeyGenerator</a>, <a href="../../cryptix/provider/key/SAFERKeyGenerator.html" title="Class in cryptix.provider.key">SAFERKeyGenerator</a>, <a href="../../cryptix/provider/key/SPEEDKeyGenerator.html" title="Class in cryptix.provider.key">SPEEDKeyGenerator</a>, <a href="../../cryptix/provider/key/SquareKeyGenerator.html" title="Class in cryptix.provider.key">SquareKeyGenerator</a></dd></dl><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>public interface <b class="class synopsis name">ExtendedKeyGenerator</b></code></div></div><hr/><div class="class description"> The KeyGenerator class in JavaSoft's original version of JCE
does not provide these essential features:
<ul><li> ability to set key lengths, for algorithms that support
more than one length.
</li><li> ability to query which key lengths are supported.
</li><li> creation of a key from an encoded byte array.
</li><li> checking for weak keys.
</li></ul>
<p/>
This interface provides a standard API for KeyGenerators that
implement the above features.
<p/>
<b>Copyright</b> © 1997
<a href="http://www.systemics.com/">Systemics Ltd</a> on behalf of the
<a href="http://www.systemics.com/docs/cryptix/">Cryptix Development Team</a>.
<br/>All rights reserved.
<p/><b>$Revision: 1.2 $</b>
</div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Authors:</b></dt><dd class="tag item">David Hopwood</dd><dd class="tag item">Raif S. Naffah</dd></dl></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Since:</b></dt><dd>IJCE 1.0.1</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><a name="summary-methods" id="summary-methods"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Method Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../../xjava/security/SecretKey.html" title="Interface in xjava.security">SecretKey</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#generateKey()">generateKey</a>()</code></dt><dd class="description"> Generates a key.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../../xjava/security/SecretKey.html" title="Interface in xjava.security">SecretKey</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#generateKey(byte[])">generateKey</a>(byte[] data)</code></dt><dd class="description"> Generates a key from an encoded byte array.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getDefaultKeyLength()">getDefaultKeyLength</a>()</code></dt><dd class="description"> Returns the key length that will be used by
<code>generateKey()</code> to create new random keys.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getMaximumKeyLength()">getMaximumKeyLength</a>()</code></dt><dd class="description"> Returns the maximum useful key length for this algorithm.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getMinimumKeyLength()">getMinimumKeyLength</a>()</code></dt><dd class="description"> Returns the minimum key length for this algorithm.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#initialize(SecureRandom)">initialize</a>(SecureRandom random)</code></dt><dd class="description"> Initializes the key generator.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#initialize(SecureRandom,int)">initialize</a>(SecureRandom random, int length)</code></dt><dd class="description"> Initializes the key generator, and sets a specific key length
for use with algorithms that allow variable-length keys.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#isValidKeyLength(int)">isValidKeyLength</a>(int length)</code></dt><dd class="description"> Returns true iff <i>length</i> is a valid key length (in bytes)
for this algorithm.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#isWeakAllowed()">isWeakAllowed</a>()</code></dt><dd class="description"> Returns true if this object is allowed to generate weak and
semi-weak keys; false otherwise.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setWeakAllowed(boolean)">setWeakAllowed</a>(boolean allowWeak)</code></dt><dd class="description"> Sets whether this object is allowed to generate weak and
semi-weak keys.</dd></dl></td></tr></table></dd></dl><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="generateKey()" id="generateKey()"/><div class="member detail outer"><h3 class="member detail name">generateKey</h3><pre class="member detail synopsis">public <a href="../../xjava/security/SecretKey.html" title="Interface in xjava.security">SecretKey</a> generateKey()</pre><blockquote class="member detail name"><div class="member detail description"> Generates a key. This method generates a new random key every
time it is called.
<p/>
If a source of random bytes has not been set using one of the
<code>initialize</code> methods, <code>new SecureRandom()</code>
will be used.
</div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">the new key.</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="generateKey(byte[])" id="generateKey(byte[])"/><div class="member detail outer"><h3 class="member detail name">generateKey</h3><pre class="member detail synopsis">public <a href="../../xjava/security/SecretKey.html" title="Interface in xjava.security">SecretKey</a> generateKey(byte[] data)
throws <a href="../../xjava/security/WeakKeyException.html" title="Class in xjava.security">WeakKeyException</a>,
InvalidKeyException</pre><blockquote class="member detail name"><div class="member detail description"> Generates a key from an encoded byte array. The format of the
secret key is "RAW". The contents of <i>data</i> will not be
modified.
<p/>
The encoded key bytes may differ from <i>data</i> in order to
make sure that they represent a valid key. For example, if keys
for this algorithm conventionally include parity bits, those
bits will be set correctly. For most algorithms, <i>data</i> is
used unchanged.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">data</code><span class="separator"> - </span><span class="description">user supplied raw-encoded data from which a secret
key will be generated.</span></dd></dl></div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">the new key.</dd></dl></div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Throws:</b></dt><dd class="member detail thrown item"><code class="name"><a href="../../xjava/security/WeakKeyException.html" title="Class in xjava.security">WeakKeyException</a></code><span class="separator"> - </span><span class="description">if <i>isWeakAllowed()</i> is false, and
<i>data</i> represents a weak key for this algorithm.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getDefaultKeyLength()" id="getDefaultKeyLength()"/><div class="member detail outer"><h3 class="member detail name">getDefaultKeyLength</h3><pre class="member detail synopsis">public int getDefaultKeyLength()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the key length that will be used by
<code>generateKey()</code> to create new random keys. This is
either the default key length determined by the KeyGenerator
for this algorithm, or the length set using
<code>initialize(SecureRandom random, int length)</code>.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getMaximumKeyLength()" id="getMaximumKeyLength()"/><div class="member detail outer"><h3 class="member detail name">getMaximumKeyLength</h3><pre class="member detail synopsis">public int getMaximumKeyLength()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the maximum useful key length for this algorithm.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getMinimumKeyLength()" id="getMinimumKeyLength()"/><div class="member detail outer"><h3 class="member detail name">getMinimumKeyLength</h3><pre class="member detail synopsis">public int getMinimumKeyLength()</pre><blockquote class="member detail name"><div class="member detail description"> Returns the minimum key length for this algorithm.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="initialize(SecureRandom)" id="initialize(SecureRandom)"/><div class="member detail outer"><h3 class="member detail name">initialize</h3><pre class="member detail synopsis">public void initialize(SecureRandom random)</pre><blockquote class="member detail name"><div class="member detail description"> Initializes the key generator.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">random</code><span class="separator"> - </span><span class="description">the source of randomness for this generator.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="initialize(SecureRandom,int)" id="initialize(SecureRandom,int)"/><div class="member detail outer"><h3 class="member detail name">initialize</h3><pre class="member detail synopsis">public void initialize(SecureRandom random,
int length)</pre><blockquote class="member detail name"><div class="member detail description"> Initializes the key generator, and sets a specific key length
for use with algorithms that allow variable-length keys.
<p/>
The <i>length</i> parameter only affects randomly generated
keys (i.e. the <code>generateKey()</code> method without
parameters).
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">random</code><span class="separator"> - </span><span class="description">the source of randomness for this generator.</span></dd><dd class="item"><code class="name">length</code><span class="separator"> - </span><span class="description">the desired key length in bytes.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="isValidKeyLength(int)" id="isValidKeyLength(int)"/><div class="member detail outer"><h3 class="member detail name">isValidKeyLength</h3><pre class="member detail synopsis">public boolean isValidKeyLength(int length)</pre><blockquote class="member detail name"><div class="member detail description"> Returns true iff <i>length</i> is a valid key length (in bytes)
for this algorithm.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="isWeakAllowed()" id="isWeakAllowed()"/><div class="member detail outer"><h3 class="member detail name">isWeakAllowed</h3><pre class="member detail synopsis">public boolean isWeakAllowed()</pre><blockquote class="member detail name"><div class="member detail description"> Returns true if this object is allowed to generate weak and
semi-weak keys; false otherwise.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setWeakAllowed(boolean)" id="setWeakAllowed(boolean)"/><div class="member detail outer"><h3 class="member detail name">setWeakAllowed</h3><pre class="member detail synopsis">public void setWeakAllowed(boolean allowWeak)</pre><blockquote class="member detail name"><div class="member detail description"> Sets whether this object is allowed to generate weak and
semi-weak keys.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">allowWeak</code><span class="separator"> - </span><span class="description">true if weak/semi-weak keys are allowed.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><p class="navbar bottom spacer"> </p><table class="navbar div bottom"><tr><td><div class="navbar div top"><span class="navbar item enabled"><a href="../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../about.html">About</a></span></div></td></tr></table></body></html>