signalapp/noise-java
signalapp/noise-java
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley 2016-07-09 09:50:53 +10:00
parent 4c31f6aaea
commit 05293f35d9
17 changed files with 148 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
allclasses-frame.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>All Classes (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>

4
allclasses-noframe.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>All Classes (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>

18
com/southernstorm/noise/protocol/CipherState.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>CipherState (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@ -311,7 +311,7 @@ extends <a href="../../../../com/southernstorm/noise/protocol/Destroyable.html"
int&nbsp;plaintextOffset,
int&nbsp;length)
throws javax.crypto.ShortBufferException,
javax.crypto.AEADBadTagException</pre>
javax.crypto.BadPaddingException</pre>
<div class="block">Decrypts a ciphertext buffer using the cipher and a block of associated data.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ad</code> - The associated data, or null if there is none.</dd><dd><code>ciphertext</code> - The buffer containing the ciphertext to decrypt.</dd><dd><code>ciphertextOffset</code> - The offset within the ciphertext buffer of
the first byte of ciphertext data.</dd><dd><code>plaintext</code> - The buffer to place the plaintext in. This can be
@ -321,7 +321,7 @@ extends <a href="../../../../com/southernstorm/noise/protocol/Destroyable.html"
<dt><span class="strong">Throws:</span></dt>
<dd><code>javax.crypto.ShortBufferException</code> - The plaintext buffer does not have
enough space to store the decrypted data.</dd>
<dd><code>javax.crypto.AEADBadTagException</code> - The MAC value failed to verify.</dd>
<dd><code>javax.crypto.BadPaddingException</code> - The MAC value failed to verify.</dd>
<dd><code>java.lang.IllegalStateException</code> - The nonce has wrapped around.
The plaintext and ciphertext buffers can be the same for in-place
@ -351,14 +351,10 @@ extends <a href="../../../../com/southernstorm/noise/protocol/Destroyable.html"
<pre>void&nbsp;setNonce(long&nbsp;nonce)</pre>
<div class="block">Sets the nonce value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>nonce</code> - The new nonce value, which must be greater than or equal
to the current value.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - The nonce is less than the current value.
to the current value.
Note that in this implementation, nonces are 63-bit quantities.
The Noise specification normally allows for 64-bit nonces.
Thie function is intended for testing purposes only.</dd></dl>
This function is intended for testing purposes only. If the nonce
value goes backwards then security may be compromised.</dd></dl>
</li>
</ul>
</li>

4
com/southernstorm/noise/protocol/CipherStatePair.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>CipherStatePair (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>

4
com/southernstorm/noise/protocol/DHState.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>DHState (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>

4
com/southernstorm/noise/protocol/Destroyable.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>Destroyable (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>

116
com/southernstorm/noise/protocol/HandshakeState.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>HandshakeState (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@ -223,90 +223,96 @@ implements <a href="../../../../com/southernstorm/noise/protocol/Destroyable.htm
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#fallback(java.lang.String)">fallback</a></strong>(java.lang.String&nbsp;patternName)</code>
<div class="block">Falls back to another handshake pattern.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#getAction()">getAction</a></strong>()</code>
<div class="block">Gets the next action that the application should perform for
the handshake part of the protocol.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/southernstorm/noise/protocol/DHState.html" title="interface in com.southernstorm.noise.protocol">DHState</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#getFixedEphemeralKey()">getFixedEphemeralKey</a></strong>()</code>
<div class="block">Gets the DHState object containing a fixed local ephemeral
key value for this handshake.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#getHandshakeHash()">getHandshakeHash</a></strong>()</code>
<div class="block">Gets the current value of the handshake hash.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/southernstorm/noise/protocol/DHState.html" title="interface in com.southernstorm.noise.protocol">DHState</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#getLocalKeyPair()">getLocalKeyPair</a></strong>()</code>
<div class="block">Gets the keypair object for the local static key.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#getProtocolName()">getProtocolName</a></strong>()</code>
<div class="block">Gets the name of the Noise protocol.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/southernstorm/noise/protocol/DHState.html" title="interface in com.southernstorm.noise.protocol">DHState</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#getRemotePublicKey()">getRemotePublicKey</a></strong>()</code>
<div class="block">Gets the public key object for the remote static key.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#getRole()">getRole</a></strong>()</code>
<div class="block">Gets the role for this handshake.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#hasLocalKeyPair()">hasLocalKeyPair</a></strong>()</code>
<div class="block">Determine if this handshake has already been configured
with a local static key.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#hasPreSharedKey()">hasPreSharedKey</a></strong>()</code>
<div class="block">Determine if this object has already been configured with a
pre-shared key.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#hasRemotePublicKey()">hasRemotePublicKey</a></strong>()</code>
<div class="block">Determine if this handshake has already been configured
with a remote static key.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#needsLocalKeyPair()">needsLocalKeyPair</a></strong>()</code>
<div class="block">Determine if this handshake requires a local static key.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#needsPreSharedKey()">needsPreSharedKey</a></strong>()</code>
<div class="block">Determine if this handshake needs a pre-shared key value
and one has not been configured yet.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#needsRemotePublicKey()">needsRemotePublicKey</a></strong>()</code>
<div class="block">Determine if this handshake requires a remote static key.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#readMessage(byte[],%20int,%20int,%20byte[],%20int)">readMessage</a></strong>(byte[]&nbsp;message,
int&nbsp;messageOffset,
@ -316,7 +322,7 @@ implements <a href="../../../../com/southernstorm/noise/protocol/Destroyable.htm
<div class="block">Reads a message payload during the handshake.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#setPreSharedKey(byte[],%20int,%20int)">setPreSharedKey</a></strong>(byte[]&nbsp;key,
int&nbsp;offset,
@ -324,7 +330,7 @@ implements <a href="../../../../com/southernstorm/noise/protocol/Destroyable.htm
<div class="block">Sets the pre-shared key for this handshake.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#setPrologue(byte[],%20int,%20int)">setPrologue</a></strong>(byte[]&nbsp;prologue,
int&nbsp;offset,
@ -332,14 +338,14 @@ implements <a href="../../../../com/southernstorm/noise/protocol/Destroyable.htm
<div class="block">Sets the prologue for this handshake.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/southernstorm/noise/protocol/CipherStatePair.html" title="class in com.southernstorm.noise.protocol">CipherStatePair</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#split()">split</a></strong>()</code>
<div class="block">Splits the transport encryption CipherState objects out of
this HandshakeState object once the handshake completes.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/southernstorm/noise/protocol/CipherStatePair.html" title="class in com.southernstorm.noise.protocol">CipherStatePair</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#split(byte[],%20int,%20int)">split</a></strong>(byte[]&nbsp;secondaryKey,
int&nbsp;offset,
@ -348,13 +354,13 @@ implements <a href="../../../../com/southernstorm/noise/protocol/Destroyable.htm
this HandshakeObject after mixing in a secondary symmetric key.</div>
</td>
</tr>
<tr class="altColor">
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#start()">start</a></strong>()</code>
<div class="block">Starts the handshake running.</div>
</td>
</tr>
<tr class="rowColor">
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#writeMessage(byte[],%20int,%20byte[],%20int,%20int)">writeMessage</a></strong>(byte[]&nbsp;message,
int&nbsp;messageOffset,
@ -708,8 +714,8 @@ implements <a href="../../../../com/southernstorm/noise/protocol/Destroyable.htm
<dd><code>java.lang.IllegalStateException</code> - The handshake has already started, or one or
more of the required parameters has not been supplied.</dd>
<dd><code>java.lang.UnsupportedOperationException</code> - An attempt was made to start a
"XXfallback" handshake pattern without first calling fallback() on a
previous "IK" handshake.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#getAction()"><code>getAction()</code></a>,
fallback handshake pattern without first calling fallback() on a
previous handshake.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#getAction()"><code>getAction()</code></a>,
<a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#writeMessage(byte[],%20int,%20byte[],%20int,%20int)"><code>writeMessage(byte[], int, byte[], int, int)</code></a>,
<a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#readMessage(byte[],%20int,%20int,%20byte[],%20int)"><code>readMessage(byte[], int, int, byte[], int)</code></a>,
<a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#fallback()"><code>fallback()</code></a></dd></dl>
@ -725,11 +731,11 @@ implements <a href="../../../../com/southernstorm/noise/protocol/Destroyable.htm
throws java.security.NoSuchAlgorithmException</pre>
<div class="block">Falls back to the "XXfallback" handshake pattern.
This function is used to help implement the "Noise Pipes" protocol.
It resets a HandshakeState object with the handshake pattern "IK",
converting it into an object with the handshake pattern "XXfallback".
Information from the previous session such as the local keypair,
the initiator's ephemeral key, the prologue value, and the
This function is intended used to help implement the "Noise Pipes" protocol.
It resets a HandshakeState object with the original handshake pattern
(usually "IK"), converting it into an object with the handshake pattern
"XXfallback". Information from the previous session such as the local
keypair, the initiator's ephemeral key, the prologue value, and the
pre-shared key, are passed to the new session.
Once the fallback has been initiated, the application can set
@ -739,13 +745,55 @@ implements <a href="../../../../com/southernstorm/noise/protocol/Destroyable.htm
session.
After setting any new parameters, the application calls start()
again to restart the handshake from where it left off before
the fallback.
again to restart the handshake from where it left off before the fallback.
Note that this function reverses the roles of initiator and responder.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - The handshake pattern is
not currently set to "IK".</dd>
<dd><code>java.lang.UnsupportedOperationException</code> - The current handshake pattern
is not compatible with "XXfallback".</dd>
<dd><code>java.lang.IllegalStateException</code> - The previous protocol has not started
or it has not reached the fallback position yet.</dd>
<dd><code>java.security.NoSuchAlgorithmException</code> - One of the cryptographic algorithms
that is specified in the new protocolName is not supported.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#start()"><code>start()</code></a></dd></dl>
</li>
</ul>
<a name="fallback(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fallback</h4>
<pre>public&nbsp;void&nbsp;fallback(java.lang.String&nbsp;patternName)
throws java.security.NoSuchAlgorithmException</pre>
<div class="block">Falls back to another handshake pattern.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>patternName</code> - The name of the pattern to fall back to;
e.g. "XXfallback", "NXfallback", etc.
This function resets a HandshakeState object with the original
handshake pattern, and converts it into an object with the new handshake
patternName. Information from the previous session such as the local
keypair, the initiator's ephemeral key, the prologue value, and the
pre-shared key, are passed to the new session.
Once the fallback has been initiated, the application can set
new values for the handshake parameters if the values from the
previous session do not apply. For example, the application may
use a different prologue for the fallback than for the original
session.
After setting any new parameters, the application calls start()
again to restart the handshake from where it left off before the fallback.
The new pattern may have greater key requirements than the original;
for example changing from "NK" from "XXfallback" requires that the
initiator's static public key be set. The application is responsible for
setting any extra keys before calling start().
Note that this function reverses the roles of initiator and responder.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - The current handshake pattern
is not compatible with the patternName, or patternName is not a
fallback pattern.</dd>
<dd><code>java.lang.IllegalStateException</code> - The previous protocol has not started
or it has not reached the fallback position yet.</dd>
<dd><code>java.security.NoSuchAlgorithmException</code> - One of the cryptographic algorithms
@ -806,7 +854,7 @@ implements <a href="../../../../com/southernstorm/noise/protocol/Destroyable.htm
byte[]&nbsp;payload,
int&nbsp;payloadOffset)
throws javax.crypto.ShortBufferException,
javax.crypto.AEADBadTagException</pre>
javax.crypto.BadPaddingException</pre>
<div class="block">Reads a message payload during the handshake.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - Buffer containing the incoming handshake
that was read from the transport.</dd><dd><code>messageOffset</code> - Offset of the first message byte.</dd><dd><code>messageLength</code> - The length of the incoming message.</dd><dd><code>payload</code> - Buffer that will be populated with the message payload.</dd><dd><code>payloadOffset</code> - Offset of the first byte in the
@ -817,7 +865,7 @@ implements <a href="../../../../com/southernstorm/noise/protocol/Destroyable.htm
<dd><code>javax.crypto.ShortBufferException</code> - The message buffer does not have
sufficient bytes for a valid message or the payload buffer does
not have enough space for the decrypted payload.</dd>
<dd><code>javax.crypto.AEADBadTagException</code> - A MAC value in the message failed
<dd><code>javax.crypto.BadPaddingException</code> - A MAC value in the message failed
to verify.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#getAction()"><code>getAction()</code></a>,
<a href="../../../../com/southernstorm/noise/protocol/HandshakeState.html#writeMessage(byte[],%20int,%20byte[],%20int,%20int)"><code>writeMessage(byte[], int, byte[], int, int)</code></a></dd></dl>
</li>

26
com/southernstorm/noise/protocol/Noise.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>Noise (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
@ -177,6 +177,12 @@ extends java.lang.Object</pre>
<div class="block">Generates random data using the system random number generator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/southernstorm/noise/protocol/Noise.html#setForceFallbacks(boolean)">setForceFallbacks</a></strong>(boolean&nbsp;force)</code>
<div class="block">Force the use of plain Java fallback crypto implementations.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
@ -246,6 +252,22 @@ extends java.lang.Object</pre>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - The data buffer to fill with random data.</dd></dl>
</li>
</ul>
<a name="setForceFallbacks(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForceFallbacks</h4>
<pre>public static&nbsp;void&nbsp;setForceFallbacks(boolean&nbsp;force)</pre>
<div class="block">Force the use of plain Java fallback crypto implementations.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>force</code> - Set to true for force fallbacks, false to
try to use the system implementation before falling back.
This function is intended for testing purposes to toggle between
the system JCA/JCE implementations and the plain Java fallback
reference implementations.</dd></dl>
</li>
</ul>
<a name="createDH(java.lang.String)">
<!-- -->
</a>

4
com/southernstorm/noise/protocol/package-frame.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>com.southernstorm.noise.protocol (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>

4
com/southernstorm/noise/protocol/package-summary.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>com.southernstorm.noise.protocol (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>

4
com/southernstorm/noise/protocol/package-tree.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>com.southernstorm.noise.protocol Class Hierarchy (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>

4
constant-values.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>Constant Field Values (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>

4
deprecated-list.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>Deprecated List (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>

4
help-doc.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>API Help (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>

12
index-all.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>Index (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="./stylesheet.css" title="Style">
</head>
<body>
@ -160,6 +160,10 @@
<dd>
<div class="block">Falls back to the "XXfallback" handshake pattern.</div>
</dd>
<dt><span class="strong"><a href="./com/southernstorm/noise/protocol/HandshakeState.html#fallback(java.lang.String)">fallback(String)</a></span> - Method in class com.southernstorm.noise.protocol.<a href="./com/southernstorm/noise/protocol/HandshakeState.html" title="class in com.southernstorm.noise.protocol">HandshakeState</a></dt>
<dd>
<div class="block">Falls back to another handshake pattern.</div>
</dd>
<dt><span class="strong"><a href="./com/southernstorm/noise/protocol/CipherState.html#fork(byte[],%20int)">fork(byte[], int)</a></span> - Method in interface com.southernstorm.noise.protocol.<a href="./com/southernstorm/noise/protocol/CipherState.html" title="interface in com.southernstorm.noise.protocol">CipherState</a></dt>
<dd>
<div class="block">Creates a new instance of this cipher and initializes it with a key.</div>
@ -386,6 +390,10 @@
<dd>
<div class="block">Destroys the receiving CipherState and retains only the sending CipherState.</div>
</dd>
<dt><span class="strong"><a href="./com/southernstorm/noise/protocol/Noise.html#setForceFallbacks(boolean)">setForceFallbacks(boolean)</a></span> - Static method in class com.southernstorm.noise.protocol.<a href="./com/southernstorm/noise/protocol/Noise.html" title="class in com.southernstorm.noise.protocol">Noise</a></dt>
<dd>
<div class="block">Force the use of plain Java fallback crypto implementations.</div>
</dd>
<dt><span class="strong"><a href="./com/southernstorm/noise/protocol/CipherState.html#setNonce(long)">setNonce(long)</a></span> - Method in interface com.southernstorm.noise.protocol.<a href="./com/southernstorm/noise/protocol/CipherState.html" title="interface in com.southernstorm.noise.protocol">CipherState</a></dt>
<dd>
<div class="block">Sets the nonce value.</div>

2
index.html
View File

@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc on Sat Jul 09 09:50:22 AEST 2016 -->
<title>Noise-Java</title>
<script type="text/javascript">
targetPage = "" + window.location.search;

4
overview-tree.html
View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_101) on Tue Jun 28 15:13:52 AEST 2016 -->
<!-- Generated by javadoc (version 1.7.0_101) on Sat Jul 09 09:50:22 AEST 2016 -->
<title>Class Hierarchy (Noise-Java)</title>
<meta name="date" content="2016-06-28">
<meta name="date" content="2016-07-09">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>