kytv/I2P_Website
1
0
Fork 0
forked from I2P_Developers/i2p.www
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

samv3 tweaks and intrapage links

Browse Source
This commit is contained in:
zzz
2016-02-10 15:01:13 +00:00
parent 8d4c83548b
commit f091c500d3
1 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
i2p2www/pages/site/docs/api/samv3.html
View File

@@ -74,9 +74,9 @@ Version 3.2 was introduced in I2P release 0.9.24.
<h4>SSL and Authentication</h4> <h4>SSL and Authentication</h4>
<ul> <ul>
<li>USER/PASSWORD in the HELLO parameters for authorization. See below. <li>USER/PASSWORD in the HELLO parameters for authorization. See <a href="#userpw">below</a>.
<li>Optional authorization configuration with the AUTH command. See below. <li>Optional authorization configuration with the AUTH command. See <a href="#auth">below</a>.
<li>Optional SSL/TLS support on the control socket <li>Optional SSL/TLS support on the control socket. See <a href="#ssl">below</a>.
<li>STREAM FORWARD option SSL=true <li>STREAM FORWARD option SSL=true
</ul> </ul>
@@ -87,7 +87,7 @@ Version 3.2 was introduced in I2P release 0.9.24.
<h4>Command Line Parsing and Keepalive</h4> <h4>Command Line Parsing and Keepalive</h4>
<ul> <ul>
<li>Optional commands QUIT, STOP and EXIT to close the session and socket. See below. <li>Optional commands QUIT, STOP and EXIT to close the session and socket. See <a href="#quit">below</a>.
<li>Command parsing will properly handle UTF-8 <li>Command parsing will properly handle UTF-8
<li>Command parsing reliably handles whitespace inside quotes <li>Command parsing reliably handles whitespace inside quotes
<li>A backslash '\' may escape quotes on the command line <li>A backslash '\' may escape quotes on the command line
@@ -99,22 +99,23 @@ Version 3.2 was introduced in I2P release 0.9.24.
<h3>Version 3.3 Proposal</h3> <h3>Version 3.3 Changes</h3>
<p> <p>
Version 3.3 is not yet implemented, and the changes listed below are preliminary. The version 3.3 changes listed below are preliminary.
Scheduled for I2P release 0.9.25. Scheduled for I2P release 0.9.25.
<ul> <ul>
<li>The same session may be used for streams, datagrams, and raw simultaneously. <li>The same session may be used for streams, datagrams, and raw simultaneously.
Incoming packets and streams will be routed based on I2P protocol and to-port. Incoming packets and streams will be routed based on I2P protocol and to-port.
See <a href="#master">the MASTER section below</a>. See <a href="#master">the MASTER section below</a>.
<li>DATAGRAM SEND and RAW SEND now support options SEND_TAGS, TAG_THRESHOLD, EXPIRES, and SEND_LEASESET. <li>DATAGRAM SEND and RAW SEND now support options SEND_TAGS, TAG_THRESHOLD, EXPIRES, and SEND_LEASESET.
See <a href="#v3dgsend">the datagram sending section below</a>.
</ul> </ul>
</p> </p>
<h2>Version 3 Protocol</h2> <h2>Version 3 Protocol</h2>
<h3>Simple Anonymous Messaging (SAM version 3.0) Specification Overview</h3> <h3>Simple Anonymous Messaging (SAM) Version 3.3 Specification Overview</h3>
<p> <p>
The client application talks to the SAM bridge, which deals with The client application talks to the SAM bridge, which deals with
all of the I2P functionality (using the streaming all of the I2P functionality (using the streaming
@@ -239,14 +240,14 @@ If some error occurred, such as a bad request format, it replies with:
</p> </p>
<h4>SSL</h4> <h4 id="ssl">SSL</h4>
<p> <p>
The server's control socket may optionally offer SSL/TLS support, as configured on the server and client. The server's control socket may optionally offer SSL/TLS support, as configured on the server and client.
Implementations may offer other transport layers as well; this is outside the scope of the protocol definition. Implementations may offer other transport layers as well; this is outside the scope of the protocol definition.
</p> </p>
<h4>Authorization</h4> <h4 id="userpw">Authorization</h4>
<p> <p>
For authorization, client adds USER="xxx" PASSWORD="yyy" to the HELLO parameters. For authorization, client adds USER="xxx" PASSWORD="yyy" to the HELLO parameters.
Double quotes for user and password are recommended but not required. Double quotes for user and password are recommended but not required.
@@ -723,7 +724,7 @@ following format.
This is all on one line (space separated), shown on multiple lines for clarity: This is all on one line (space separated), shown on multiple lines for clarity:
<pre> <pre>
3.0 # As of SAM 3.2, any 3.x is allowed 3.0 # As of SAM 3.2, any "3.x" is allowed. Prior to that, "3.0" is required.
$nickname $nickname
$destination $destination
[FROM_PORT=nnn] # SAM 3.2 or higher only, default 0 [FROM_PORT=nnn] # SAM 3.2 or higher only, default 0
@@ -1215,7 +1216,7 @@ If a timeout occurs waiting for a PONG from the bridge, the client may simply di
</p> </p>
<h4>QUIT/STOP/EXIT (SAM 3.2 or higher, optional features)</h4> <h4 id="quit">QUIT/STOP/EXIT (SAM 3.2 or higher, optional features)</h4>
<p> <p>
Commands QUIT, STOP and EXIT will close the session and socket. Commands QUIT, STOP and EXIT will close the session and socket.
Implementation is optional, for ease in testing via telnet. Implementation is optional, for ease in testing via telnet.
@@ -1235,7 +1236,7 @@ implementation-specific and outside the scope of this specification.
<h4>Authorization Configuration (SAM 3.2 or higher, optional feature)</h4> <h4 id="auth">Authorization Configuration (SAM 3.2 or higher, optional feature)</h4>
<p> <p>
Authorization configuration using the AUTH command. Authorization configuration using the AUTH command.
A SAM server may implement these commands to facilite persistent storage of credentials. A SAM server may implement these commands to facilite persistent storage of credentials.