From 414efb636f0b56eb67be423708c5aede9f8aaba7 Mon Sep 17 00:00:00 2001
From: str4d <str4d@mail.i2p>
Date: Sat, 27 Jun 2015 14:08:57 +0000
Subject: [PATCH] Tunnel message dataspec
---
.../pages/site/docs/spec/tunnel-message.html | 35 +++++++++----------
1 file changed, 17 insertions(+), 18 deletions(-)
diff --git a/i2p2www/pages/site/docs/spec/tunnel-message.html b/i2p2www/pages/site/docs/spec/tunnel-message.html
index da44151c2..248c3b52a 100644
--- a/i2p2www/pages/site/docs/spec/tunnel-message.html
+++ b/i2p2www/pages/site/docs/spec/tunnel-message.html
@@ -52,7 +52,7 @@ These are the contents of a tunnel data message after encryption.
<h4>Definition</h4>
{% highlight lang='dataspec' %}
-Tunnel ID ::
+Tunnel ID :: `TunnelId`
4 bytes
the ID of the next hop
@@ -112,8 +112,8 @@ These are the contents of a tunnel data message when decrypted.
{% endhighlight %}
<h4>Definition</h4>
-<pre>
-Tunnel ID ::
+{% highlight lang='dataspec' %}
+Tunnel ID :: `TunnelId`
4 bytes
the ID of the next hop
@@ -133,10 +133,9 @@ Zero ::
1 byte
the value 0x00
-Delivery Instructions ::
+Delivery Instructions :: `TunnelMessageDeliveryInstructions`
length varies but is typically 7, 39, 43, or 47 bytes
Indicates the fragment and the routing for the fragment
- See <a href="#struct_TunnelMessageDeliveryInstructions">below</a> for specification
Message Fragment ::
1 to 996 bytes, actual maximum depends on delivery instruction size
@@ -144,7 +143,7 @@ Message Fragment ::
total size: 1028 Bytes
-</pre>
+{% endhighlight %}
<h4>Notes</h4>
<ul><li>
@@ -196,8 +195,8 @@ or a complete (unfragmented) I2NP message, and the instructions are:</p>
{% endhighlight %}
<h4>Definition</h4>
-<pre>
-flag:
+{% highlight lang='dataspec' %}
+flag ::
1 byte
Bit order: 76543210
bit 7: 0 to specify an initial fragment or an unfragmented message
@@ -212,39 +211,39 @@ flag:
If 1, extended options are included
bits 1-0: reserved, set to 0 for compatibility with future uses
-Tunnel ID:
+Tunnel ID :: `TunnelId`
4 bytes
Optional, present if delivery type is TUNNEL
The destination tunnel ID
-To Hash:
+To Hash ::
32 bytes
Optional, present if delivery type is DESTINATION, ROUTER, or TUNNEL
If DESTINATION, the SHA256 Hash of the destination
If ROUTER, the SHA256 Hash of the router
If TUNNEL, the SHA256 Hash of the gateway router
-Delay:
+Delay ::
1 byte
Optional, present if delay included flag is set
In tunnel messages: Unimplemented, never present; original specification:
bit 7: type (0 = strict, 1 = randomized)
bits 6-0: delay exponent (2^value minutes)
-Message ID:
+Message ID ::
4 bytes
Optional, present if this message is the first of 2 or more fragments
(i.e. if the fragmented bit is 1)
An ID that uniquely identifies all fragments as belonging to a single message
- (the current implementation uses the <a href="{{ site_url('docs/spec/i2np') }}#struct_I2NPMessageHeader">I2NP Message ID</a>)
+ (the current implementation uses `I2NPMessageHeader.msg_id`)
-Extended Options:
+Extended Options ::
2 or more bytes
Optional, present if extend options flag is set
Unimplemented, never present; original specification:
One byte length and then that many bytes
-size:
+size ::
2 bytes
The length of the fragment that follows
Valid values: 1 to approx. 960 in a tunnel message
@@ -254,7 +253,7 @@ Total length: Typical length is:
35 bytes for ROUTER / DESTINATION delivery or 39 bytes for TUNNEL delivery (unfragmented tunnel message);
39 bytes for ROUTER delivery or 43 bytes for TUNNEL delivery (first fragment)
-</pre>
+{% endhighlight %}
<h3>Follow-on Fragment Delivery Instructions</h3>
<p>If the MSB of the first byte is 1, this is a follow-on fragment, and the instructions are:</p>
@@ -265,7 +264,7 @@ Total length: Typical length is:
{% endhighlight %}
<h4>Definition</h4>
-<pre>
+{% highlight lang='dataspec' %}
frag ::
1 byte
Bit order: 76543210
@@ -286,7 +285,7 @@ size ::
valid values: 1 to 996
total length: 7 bytes
-</pre>
+{% endhighlight %}
<h3><a href="http://docs.i2p-projekt.de/javadoc/net/i2p/data/i2np/DeliveryInstructions.html">Delivery Instructions Javadoc</a></h3>
--
GitLab