| 1 |
<?xml version="1.0" encoding="UTF-8"?> |
| 2 |
<?xml-stylesheet type="text/xsl" href="transform.xsl"?> |
| 3 |
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" |
| 4 |
"http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"> |
| 5 |
<article> |
| 6 |
<articleinfo> |
| 7 |
<title><inlinemediaobject> |
| 8 |
<imageobject> |
| 9 |
<imagedata align="center" fileref="resources/ProteanLogo.png" |
| 10 |
scale="30"/> |
| 11 |
</imageobject> |
| 12 |
</inlinemediaobject> <emphasis>norp</emphasis> User's Guide</title> |
| 13 |
|
| 14 |
<titleabbrev><emphasis>norp</emphasis> User's Guide</titleabbrev> |
| 15 |
|
| 16 |
<abstract> |
| 17 |
<para>The NRL Nack-Oriented Proxy (<emphasis>norp</emphasis>) project |
| 18 |
includes software for an RFC 1928 SOCKS5-compatible proxy server daemon |
| 19 |
that is able to use the RFC 5740 Nack-Oriented Reliable Multicast (NORM) |
| 20 |
transport protocol for efficient and robust data transfer between |
| 21 |
<emphasis>norp</emphasis> proxy instances. The <emphasis>norp</emphasis> |
| 22 |
proxy automatically supports conventional SOCKS TCP proxy operation when |
| 23 |
a remote <emphasis>norp</emphasis> peer is unavailable. This software |
| 24 |
was developed by the <ulink url="http://www.nrl.navy.mil/">Naval |
| 25 |
Research Laboratory</ulink> (NRL) PROTocol Engineering Advanced |
| 26 |
Networking Research Group. The NRL reference implementation of NORM used |
| 27 |
here is available from <ulink |
| 28 |
url="http://www.nrl.navy.mil/itd/ncs/products/norm">http://www.nrl.navy.mil/itd/ncs/products/norm</ulink>.</para> |
| 29 |
</abstract> |
| 30 |
</articleinfo> |
| 31 |
|
| 32 |
<sect1> |
| 33 |
<title>Overview</title> |
| 34 |
|
| 35 |
<para>The <emphasis>norp</emphasis> application ....</para> |
| 36 |
</sect1> |
| 37 |
|
| 38 |
<sect1 id="TheoryOfOperation"> |
| 39 |
<title>Theory of Operation</title> |
| 40 |
|
| 41 |
<para>The <emphasis>norp</emphasis> program acts as a SOCKS proxy server. |
| 42 |
It supports the SOCKS5 "CONNECT", "BIND" and "UDP-ASSOCIATE" proxy methods |
| 43 |
for conventional SOCKS proxy operation. The current |
| 44 |
<emphasis>norp</emphasis> implementation does not require (or support) any |
| 45 |
client authentication. Future versions may provide authentication or other |
| 46 |
access control mechanisms. The current <emphasis>norp</emphasis> |
| 47 |
implementation only provides NORM transport for the SOCKS TCP "CONNECT" |
| 48 |
requests. SOCKS "UDP-ASSOCIATE" over NORM will be supported in a future |
| 49 |
version.</para> |
| 50 |
|
| 51 |
<para>Unlike a conventional SOCKS server, it is expected that the |
| 52 |
<emphasis>norp</emphasis> daemon can be installed and run as a local |
| 53 |
"loopback" server that is co-resident on the host running applications |
| 54 |
that wish to take advantage of NORM transport benefits. The |
| 55 |
<emphasis>norp</emphasis> daemon implements its own signaling protocol |
| 56 |
that will automatically determine, upon TCP (or UDP) connection |
| 57 |
establishment, if a remote destination is also similarly |
| 58 |
"<emphasis>norp</emphasis>-enabled" and establish a NORM transport |
| 59 |
connection as the proxy connection. Otherwise a "business-as-usual" TCP |
| 60 |
(or UDP) connection is established on the application's behalf and thus |
| 61 |
compatibility with "non-<emphasis>norp</emphasis>" hosts is also |
| 62 |
supported. <xref linkend="norpConcept"/> illustrates this high level |
| 63 |
concept of operation.</para> |
| 64 |
|
| 65 |
<para><figure id="norpConcept"> |
| 66 |
<title>NORP Concept of Operation</title> |
| 67 |
|
| 68 |
<mediaobject> |
| 69 |
<imageobject> |
| 70 |
<imagedata fileref="resources/norpConcept.png" format="PNG" |
| 71 |
scale="50"/> |
| 72 |
</imageobject> |
| 73 |
</mediaobject> |
| 74 |
</figure></para> |
| 75 |
|
| 76 |
<para><emphasis>TBD - provide some more details on norp signaling for peer |
| 77 |
detection and NORM session establishment</emphasis></para> |
| 78 |
|
| 79 |
<para>Note that as an alternative to making proxied connections directly |
| 80 |
to connection destination addresses as illustrated above, a remote |
| 81 |
<emphasis>norp</emphasis> peer "correspondent" can be specified as part of |
| 82 |
the <literal>forward</literal> command or, for SOCKS connections, with the |
| 83 |
<literal>correspondent</literal> command (see command descriptions below). |
| 84 |
Future versions of <emphasis>norp</emphasis> will include more |
| 85 |
sophisticated "routing" options for different destinations and traffic |
| 86 |
types.</para> |
| 87 |
|
| 88 |
<sect2> |
| 89 |
<title>SOCKS Loopback and Intermediate System</title> |
| 90 |
|
| 91 |
<para>As noted above the principal use case for |
| 92 |
<emphasis>norp</emphasis> is to act as a local, "loopback" SOCKS server |
| 93 |
that can be used in conjunction with a properly configured SOCKS client. |
| 94 |
In this way, all of the configuration parameters are localized and |
| 95 |
implicit and no precoordinated configuration with |
| 96 |
<emphasis>norp</emphasis> peers (or non-<emphasis>norp</emphasis> hosts) |
| 97 |
is required other than using a common UDP port number for NORP |
| 98 |
signaling.</para> |
| 99 |
|
| 100 |
<para>However, there may be use cases where it may be desirable to |
| 101 |
deploy <emphasis>norp</emphasis> on intermediate systems at the |
| 102 |
connection originating site (or domain) and/or the destination site(s) |
| 103 |
(or domain(s)). This is easily supported by the |
| 104 |
<emphasis>norp</emphasis> design and future norp versions will provide |
| 105 |
configuration options for this type of deployment.</para> |
| 106 |
</sect2> |
| 107 |
|
| 108 |
<sect2> |
| 109 |
<title>NORM Protocol Usage</title> |
| 110 |
|
| 111 |
<para><emphasis>TBD - describe how the NORM streaming capability is used |
| 112 |
in a flow-controlled, positively-acknowledged fashion to provide a |
| 113 |
reliable TCP proxy function. Also describe the NORM congestion control |
| 114 |
options here.</emphasis></para> |
| 115 |
</sect2> |
| 116 |
</sect1> |
| 117 |
|
| 118 |
<sect1 id="Usage"> |
| 119 |
<title>Usage</title> |
| 120 |
|
| 121 |
<para>Typically, <emphasis>norp</emphasis> can be run in its default |
| 122 |
configuration with no command-line options required. However, a number of |
| 123 |
options are available via the command-line. This is a summary of |
| 124 |
<emphasis>norp</emphasis> usage:</para> |
| 125 |
|
| 126 |
<para><informalexample> |
| 127 |
<programlisting><?dbfo keep-together="always"?>norp [interface <ifaceName>][address <publicAddr>][sport <socksPort>][port <norpPort>] |
| 128 |
[norm {on|off}][id <normId>][nport <normPort>][cce | ccl | rate <bits/sec>] |
| 129 |
[limit <bits/sec>][persist <seconds>][segment <segmentSize>] |
| 130 |
[correspondent <remoteNorpAddr>][forward <tcpPort>,<destAddr>/<destPort>[,<remoteNorpAddr>]] |
| 131 |
[version][debug <level>][trace][dlog <debugLog>][lport <localNorpPort>][rport <remoteNorpPort>]</programlisting> |
| 132 |
|
| 133 |
<para>The <emphasis>norp</emphasis> program command-line options |
| 134 |
include ...</para> |
| 135 |
</informalexample></para> |
| 136 |
|
| 137 |
<table> |
| 138 |
<title><emphasis><emphasis>norp</emphasis></emphasis> Command-line |
| 139 |
Options</title> |
| 140 |
|
| 141 |
<?dbfo keep-together="always"?> |
| 142 |
|
| 143 |
<tgroup cols="2"> |
| 144 |
<colspec colname="Command" colwidth="1*"/> |
| 145 |
|
| 146 |
<colspec colname="Description" colwidth="2.5*"/> |
| 147 |
|
| 148 |
<tbody> |
| 149 |
<row> |
| 150 |
<entry align="left"><literal>interface |
| 151 |
<interfaceName></literal></entry> |
| 152 |
|
| 153 |
<entry>The given <literal><interfaceName></literal> |
| 154 |
specifies the name (or IP address) of the host network interface |
| 155 |
<emphasis>norp</emphasis> uses as its "public" proxy address. |
| 156 |
Currently a single interface may be designated for an instance of |
| 157 |
<emphasis>norp</emphasis>. Future version of |
| 158 |
<emphasis>norp</emphasis> may allow for multiple interfaces to be |
| 159 |
designated depending upon the source and/or destination address of |
| 160 |
SOCKS proxy connections.</entry> |
| 161 |
</row> |
| 162 |
|
| 163 |
<row> |
| 164 |
<entry><literal>address <publicAddr></literal></entry> |
| 165 |
|
| 166 |
<entry>This is similar to the "<literal>interface</literal>" |
| 167 |
command, but allows a specific address to be set. For example, |
| 168 |
hosts with multiple addresses assigned may wish to use a specific |
| 169 |
address for proxy functions.</entry> |
| 170 |
</row> |
| 171 |
|
| 172 |
<row> |
| 173 |
<entry><literal>sport <socksPort></literal></entry> |
| 174 |
|
| 175 |
<entry>This command is used to specify the port number on which |
| 176 |
the <emphasis>norp</emphasis> server listens for SOCKS client |
| 177 |
connections. The default port is currently port number |
| 178 |
7000.</entry> |
| 179 |
</row> |
| 180 |
|
| 181 |
<row> |
| 182 |
<entry><literal>port <norpPort></literal></entry> |
| 183 |
|
| 184 |
<entry>This command is used to specify the UDP port number used |
| 185 |
for <emphasis>norp</emphasis> session setup signaling. The default |
| 186 |
<emphasis>norp</emphasis> UDP signaling port is 7001. The |
| 187 |
configured <emphasis>norp</emphasis> port number (and NORM port |
| 188 |
number) MUST be unblocked by any network firewalls between |
| 189 |
<emphasis>norp</emphasis> peers. The given port number is used by |
| 190 |
<emphasis>norp</emphasis> to listen for remote connection request |
| 191 |
and is used as the destination port to signal remote |
| 192 |
<emphasis>norp</emphasis> peers.</entry> |
| 193 |
</row> |
| 194 |
|
| 195 |
<row> |
| 196 |
<entry><literal>norm {on | off}</literal></entry> |
| 197 |
|
| 198 |
<entry>By default, <emphasis>norp</emphasis> attempts to signal |
| 199 |
the SOCKS connection endpoint to setup a NORM transport connection |
| 200 |
to handle reliable data transfer for the TCP connection being |
| 201 |
instantiated. This command with the "<literal>off</literal>" |
| 202 |
argument will disable this function and <emphasis>norp</emphasis> |
| 203 |
will act as a conventional SOCKS proxy server.</entry> |
| 204 |
</row> |
| 205 |
|
| 206 |
<row> |
| 207 |
<entry><literal>id <normId></literal></entry> |
| 208 |
|
| 209 |
<entry>By default, <emphasis>norp</emphasis> will attempt to |
| 210 |
self-configure a NORM protocol node identifier using the IP |
| 211 |
address of the server host. This command allows a specific NORM |
| 212 |
node identifier value to be set. It is generally not necessary to |
| 213 |
explicitly set this value for <emphasis>norp</emphasis> unicast |
| 214 |
proxy connections.</entry> |
| 215 |
</row> |
| 216 |
|
| 217 |
<row> |
| 218 |
<entry><constant>nport <normPort></constant></entry> |
| 219 |
|
| 220 |
<entry>This command can be used to specify a UDP port number that |
| 221 |
will be used for NORM protocol transport connections. The default |
| 222 |
NORM port number used by <emphasis>norp</emphasis> is 7002. The |
| 223 |
configured NORM port number (and <emphasis>norp</emphasis> UDP |
| 224 |
signaling <literal>port</literal> number) MUST be unblocked by any |
| 225 |
network firewalls between <emphasis>norp</emphasis> peers.</entry> |
| 226 |
</row> |
| 227 |
|
| 228 |
<row> |
| 229 |
<entry><literal>cce</literal></entry> |
| 230 |
|
| 231 |
<entry>This option enables NORM-CCE congestion control operation |
| 232 |
that uses Explicit Congestion Notification (ECN) information for |
| 233 |
NORM protocol end-to-end transmission rate adaption. This is an |
| 234 |
alternative to the TCP-friendly congestion control mechanism used |
| 235 |
for NORM by default. Routers in the path of the |
| 236 |
<emphasis>norp</emphasis> peers using the NORM-CCE option MUST be |
| 237 |
configured for ECN packet marking in response to |
| 238 |
congestion.</entry> |
| 239 |
</row> |
| 240 |
|
| 241 |
<row> |
| 242 |
<entry><literal>ccl</literal></entry> |
| 243 |
|
| 244 |
<entry>This option enables experimental NORM-CCL ("Loss Tolerant") |
| 245 |
congestion control operation that uses some simple heuristics to |
| 246 |
try to differentiate packet loss due to congestion versus duo to |
| 247 |
channel bit errors. This is another alternative to the |
| 248 |
TCP-friendly congestion control mechanism used for NORM by |
| 249 |
default. No special intermediate system configuration is required, |
| 250 |
and while more loss tolerant than the default TCP-friendly |
| 251 |
behavior, is not as effective as the NORM-CCE mode of |
| 252 |
operation.</entry> |
| 253 |
</row> |
| 254 |
|
| 255 |
<row> |
| 256 |
<entry><literal>rate <bits/sec></literal></entry> |
| 257 |
|
| 258 |
<entry>This option causes <emphasis>norp</emphasis> to use a |
| 259 |
preset and fixed transmission rate for each proxied data flow |
| 260 |
(e.g. TCP connection). This should only be used when the network |
| 261 |
connectivity usage is carefully pre-planned and previsioned for |
| 262 |
the expected (i.e. <emphasis>a priori</emphasis> known) flows. At |
| 263 |
this time, one common transmission rate is used for all |
| 264 |
flows.</entry> |
| 265 |
</row> |
| 266 |
|
| 267 |
<row> |
| 268 |
<entry><literal>limit <bits/sec></literal></entry> |
| 269 |
|
| 270 |
<entry>This option sets a limit for the |
| 271 |
<emphasis>cumulative</emphasis> transmit rate for |
| 272 |
<emphasis>all</emphasis> flows that <emphasis>norp</emphasis> is |
| 273 |
proxying. For automated congestion operation, this can also work |
| 274 |
to "jump start" the usual "slow start" transport rate control by |
| 275 |
setting the lower bound of rate adjustment based on the limit |
| 276 |
<literal><bits/sec> / <numFlows></literal>. For |
| 277 |
example, a single flow will immediately "jump" to close the full |
| 278 |
limit rate, while the second of two flows would "jump" to half of |
| 279 |
the "limit" rate. Also, by setting a limit based on <emphasis>a |
| 280 |
priori</emphasis> connectivity information, this can avoid rate |
| 281 |
adjustment "overshoot" and help congestion control operate more |
| 282 |
effectively as compared to a "blind" situation. IMPORTANT: This |
| 283 |
options should only be applied when the connectivity path is well |
| 284 |
known and the impact of the lower bound enforcement here will not |
| 285 |
adversely impact other network traffic flows. A future option may |
| 286 |
be provided to further reduce or eliminate the lower bound |
| 287 |
enforcement that would eliminate this concern in less controlled |
| 288 |
network deployments. A limit value of "-1.0" (default) disables |
| 289 |
the limit enforcement.</entry> |
| 290 |
</row> |
| 291 |
|
| 292 |
<row> |
| 293 |
<entry><literal>segment <segmentSize></literal></entry> |
| 294 |
|
| 295 |
<entry>This option sets the NORM protocol maximum packet payload |
| 296 |
size where is <parameter><segmentSize></parameter> is in |
| 297 |
units of bytes. . For <emphasis>norp</emphasis> that uses the |
| 298 |
NORM_OBJECT_STREAM, the maximum NORM UDP payload size is 40 bytes |
| 299 |
of NORM header plus the configured segment size. The resultant |
| 300 |
total maximum IPv4 UDP packet size (including IP and UDP headers) |
| 301 |
is then 28 + 40 + <parameter><segmentSize></parameter> |
| 302 |
bytes. For IPv6, the resultant maximum packet size is 48 + 40 + |
| 303 |
<parameter><segmentSize></parameter> bytes. The default NORM |
| 304 |
segment size, if this option is not invoked, is 1400 bytes, |
| 305 |
resulting in NORM UDP packets with 1440 byte payloads. Thus, for |
| 306 |
IPv4 that has 28 bytes of IP + UDP header, this results in a |
| 307 |
maximum <emphasis>norp</emphasis> packet size of 1468 bytes while, |
| 308 |
for IPv6, the maximum <emphasis>norp</emphasis> packet size would |
| 309 |
be 1488 bytes.</entry> |
| 310 |
</row> |
| 311 |
|
| 312 |
<row> |
| 313 |
<entry><literal>correspondent |
| 314 |
<remoteNorpAddr></literal></entry> |
| 315 |
|
| 316 |
<entry>This option causes <emphasis>norp</emphasis> to "route" |
| 317 |
connections through a <emphasis>norp</emphasis> peer at the |
| 318 |
specified <parameter><remoteNorpAddr></parameter>. This is |
| 319 |
an alternative to the default behavior where |
| 320 |
<emphasis>norp</emphasis> attempts to connect directly to the |
| 321 |
connection destination addresses.</entry> |
| 322 |
</row> |
| 323 |
|
| 324 |
<row> |
| 325 |
<entry><literal>persist <seconds></literal></entry> |
| 326 |
|
| 327 |
<entry>This option controls how persistently norp attempts to |
| 328 |
deliver data to the remote endpoint when the remote endpoint fails |
| 329 |
to acknowledge reception. A persist value of -1 makes norp |
| 330 |
infinitely persistent and the corresponding norp session remains |
| 331 |
in place until all data is delivered. If not, an orphaned session |
| 332 |
will remain in place if the remote endpoint is permanently |
| 333 |
disconnected. The default persist value is 120 seconds (2 |
| 334 |
minutes).</entry> |
| 335 |
</row> |
| 336 |
|
| 337 |
<row> |
| 338 |
<entry><literal>forward |
| 339 |
<tcpPort>,<dstAddr>/<dstPort>[,<norpAddr>]</literal></entry> |
| 340 |
|
| 341 |
<entry>This command sets up a "preset" TCP proxy (non-SOCKS) port |
| 342 |
forwarding session by listening on the specified TCP |
| 343 |
<parameter><tcpPort></parameter> for connections and then |
| 344 |
connecting to the given remote |
| 345 |
<parameter><dstAddr>/<dstPort></parameter>. |
| 346 |
Optionally, a separate remote |
| 347 |
<parameter><norpAddr></parameter> may be given. Otherwise, a |
| 348 |
<emphasis>norp</emphasis> proxy connection is attempted to the |
| 349 |
given <parameter><dstAddr></parameter> platform on the |
| 350 |
<emphasis>norp</emphasis> <parameter><port></parameter> (or |
| 351 |
<parameter><rport></parameter> if specified). Note that |
| 352 |
multiple such "preset" proxy sessions may be specified on the |
| 353 |
command-line and each "preset" proxy session can handle multiple |
| 354 |
connections as needed.</entry> |
| 355 |
</row> |
| 356 |
|
| 357 |
<row> |
| 358 |
<entry><literal>debug <debugLevel></literal></entry> |
| 359 |
|
| 360 |
<entrytbl cols="1"> |
| 361 |
<tbody> |
| 362 |
<row> |
| 363 |
<entry>This command can be used to control the verbosity of |
| 364 |
<emphasis>norp</emphasis> debug logging output. Generally, |
| 365 |
the range of the value is 0-12. A higher value results in |
| 366 |
more verbose, detailed debug output.</entry> |
| 367 |
</row> |
| 368 |
</tbody> |
| 369 |
</entrytbl> |
| 370 |
</row> |
| 371 |
|
| 372 |
<row> |
| 373 |
<entry><literal>trace</literal></entry> |
| 374 |
|
| 375 |
<entry>This command enables NORM send and receive packet trace |
| 376 |
logging.</entry> |
| 377 |
</row> |
| 378 |
|
| 379 |
<row> |
| 380 |
<entry><literal>dlog <fileName></literal></entry> |
| 381 |
|
| 382 |
<entrytbl cols="1"> |
| 383 |
<tbody> |
| 384 |
<row> |
| 385 |
<entry>This command can be used to direct |
| 386 |
<emphasis>norp</emphasis> debug logging output to a given |
| 387 |
file. The default <emphasis>norp</emphasis> debug logging is |
| 388 |
to STDERR.</entry> |
| 389 |
</row> |
| 390 |
</tbody> |
| 391 |
</entrytbl> |
| 392 |
</row> |
| 393 |
|
| 394 |
<row> |
| 395 |
<entry><literal>lport <localNorpPort></literal></entry> |
| 396 |
|
| 397 |
<entry>This command can enable single host, loopback testing by a |
| 398 |
having <emphasis>norp</emphasis> listen on a different port number |
| 399 |
than which it uses as the destination port for remote |
| 400 |
<emphasis>norp</emphasis> peer signaling. E.g., two |
| 401 |
<emphasis>norp</emphasis> instances on a single machine can be set |
| 402 |
up with unique <literal><localNorpPort></literal> values and |
| 403 |
then use the "<literal>rport</literal>" command to specify each |
| 404 |
other's destination <emphasis>norp</emphasis> port |
| 405 |
numbers.</entry> |
| 406 |
</row> |
| 407 |
|
| 408 |
<row> |
| 409 |
<entry><literal>rport <remoteNorpPort></literal></entry> |
| 410 |
|
| 411 |
<entry>This command is intended to be used in conjunction with the |
| 412 |
"<literal>lport</literal>" command to allow separate specification |
| 413 |
of the destination port number used for remote |
| 414 |
<emphasis>norp</emphasis> peer signaling.</entry> |
| 415 |
</row> |
| 416 |
</tbody> |
| 417 |
</tgroup> |
| 418 |
</table> |
| 419 |
|
| 420 |
<sect2> |
| 421 |
<title>SOCKS Client Configuration</title> |
| 422 |
|
| 423 |
<para><emphasis>TBD - provide overview and examples (for specific SOCKS |
| 424 |
clients of note such as Dante, Proxifier, etc) of SOCKS client |
| 425 |
configuration</emphasis></para> |
| 426 |
</sect2> |
| 427 |
|
| 428 |
<sect2 id="ExampleUsage"> |
| 429 |
<title>Usage Examples</title> |
| 430 |
|
| 431 |
<para>The SOCKS client(s) must be configured to use the |
| 432 |
<emphasis>norp</emphasis> server unless a preset TCP port |
| 433 |
<literal>forward</literal> is specified. For example the Dante proxy |
| 434 |
distribution (available from <ulink |
| 435 |
url="http://www.inet.no/dante/">http://www.inet.no/dante/</ulink>) has a |
| 436 |
<emphasis>socksify</emphasis> command that is installed and can be used |
| 437 |
to launch existing network applications so their socket communications |
| 438 |
are directed through the configured server. With Dante, a SOCKS |
| 439 |
configuration file (typically <filename>/etc/socks.conf</filename>) or |
| 440 |
the <constant>SOCKS5_SERVER</constant> environment variable can be used |
| 441 |
to set the server address and port number.</para> |
| 442 |
|
| 443 |
<para>The <emphasis>norp</emphasis> "server" is a lightweight module and |
| 444 |
can be installed on the same end systems requiring the performance |
| 445 |
benefits of NORM transport. In this case the SOCKS client server |
| 446 |
configuration is the loopback address and <emphasis>norp</emphasis> |
| 447 |
SOCKS port number (i.e. <literal>127.0.0.1:7000</literal>). The locally |
| 448 |
installed norp SOCKS server will signal remote network destinations |
| 449 |
(e.g., upon TCP connection initiation) to determine if the destination |
| 450 |
is <emphasis>norp</emphasis>-capable. If possible, it will establish a |
| 451 |
NORM-connection to the remote <emphasis>norp</emphasis> correspondent |
| 452 |
that connects to the final destination. Otherwise a direct TCP |
| 453 |
connection (or UDP relay) will be made to the remote destination.</para> |
| 454 |
</sect2> |
| 455 |
</sect1> |
| 456 |
|
| 457 |
<sect1 id="Commands"> |
| 458 |
<title>The "NORP" UDP Signaling Message Format</title> |
| 459 |
|
| 460 |
<para>The <emphasis>norp</emphasis> proxy uses UDP signaling to confirm |
| 461 |
presence of a remote <emphasis>norp</emphasis> peer and to set up (and |
| 462 |
tear down) NORM transport protocol sessions to support the proxied TCP |
| 463 |
(and eventually UDP) transport connections. The norp instance originating |
| 464 |
a SOCKS session request is referred to here as the "originator" and the |
| 465 |
remote norp peer to which the request is directed is referred to as the |
| 466 |
"correspondent". The <emphasis>norp</emphasis> "originator" is the server |
| 467 |
associated with the SOCKS client making a request while the |
| 468 |
"correspondent" establishes connections with the remote SOCKS |
| 469 |
destination.</para> |
| 470 |
|
| 471 |
<para>The following UDP payload format is used for NORP signaling:</para> |
| 472 |
|
| 473 |
<para><programlisting><?dbfo keep-together="always"?>0 1 2 3 |
| 474 |
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 |
| 475 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 476 |
| msgType | reserved | sessionId | |
| 477 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 478 |
| normNodeId | |
| 479 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 480 |
| normSrcPort | normDstPort | |
| 481 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 482 |
| timestamp_sec | |
| 483 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 484 |
| timestamp_usec | |
| 485 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 486 |
| content ... |
| 487 |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |
| 488 |
|
| 489 |
</programlisting></para> |
| 490 |
|
| 491 |
<para>The NORP message types include:</para> |
| 492 |
|
| 493 |
<variablelist> |
| 494 |
<varlistentry> |
| 495 |
<term>SOCKS_REQ</term> |
| 496 |
|
| 497 |
<listitem> |
| 498 |
<para>The message content contains a SOCKS5 Request message from the |
| 499 |
"originator" to the "correspondent" <emphasis>norp</emphasis> |
| 500 |
server.</para> |
| 501 |
</listitem> |
| 502 |
</varlistentry> |
| 503 |
|
| 504 |
<varlistentry> |
| 505 |
<term>ACK_REQ</term> |
| 506 |
|
| 507 |
<listitem> |
| 508 |
<para>The message is used to acknowledge receipt of a SOCKS_REQ |
| 509 |
message. There is no "content"</para> |
| 510 |
</listitem> |
| 511 |
</varlistentry> |
| 512 |
|
| 513 |
<varlistentry> |
| 514 |
<term>SOCKS_REP</term> |
| 515 |
|
| 516 |
<listitem> |
| 517 |
<para>The message content contains a SOCKS5 Reply message from the |
| 518 |
"correspondent" <emphasis>norp</emphasis> server.</para> |
| 519 |
</listitem> |
| 520 |
</varlistentry> |
| 521 |
|
| 522 |
<varlistentry> |
| 523 |
<term>ACK_REP</term> |
| 524 |
|
| 525 |
<listitem> |
| 526 |
<para>The message is used to acknowledge receipt of a SOCKS_REP |
| 527 |
message. There is no "content".</para> |
| 528 |
</listitem> |
| 529 |
</varlistentry> |
| 530 |
|
| 531 |
<varlistentry> |
| 532 |
<term>ORIG_END</term> |
| 533 |
|
| 534 |
<listitem> |
| 535 |
<para>This message indicates the "originator" |
| 536 |
<emphasis>norp</emphasis> server is terminating the given session. |
| 537 |
There is no "content".</para> |
| 538 |
</listitem> |
| 539 |
</varlistentry> |
| 540 |
|
| 541 |
<varlistentry> |
| 542 |
<term>CORR_END</term> |
| 543 |
|
| 544 |
<listitem> |
| 545 |
<para>This message indicates the "correspondent" |
| 546 |
<emphasis>norp</emphasis> server is terminating the given session. |
| 547 |
There is no "content".</para> |
| 548 |
</listitem> |
| 549 |
</varlistentry> |
| 550 |
|
| 551 |
<varlistentry> |
| 552 |
<term>ACK_END</term> |
| 553 |
|
| 554 |
<listitem> |
| 555 |
<para>This message is used to acknowledge receipt of either an |
| 556 |
ORIG_END or CORR_END message. There is no "content".</para> |
| 557 |
</listitem> |
| 558 |
</varlistentry> |
| 559 |
</variablelist> |
| 560 |
|
| 561 |
<para><emphasis>TBD - describe NORP signaling and the message format given |
| 562 |
here.</emphasis></para> |
| 563 |
</sect1> |
| 564 |
|
| 565 |
<sect1> |
| 566 |
<title>Future Plans</title> |
| 567 |
|
| 568 |
<para>There are a number of additional features and refinements planned |
| 569 |
for the <emphasis>norp</emphasis> implementation. Some of these |
| 570 |
include:</para> |
| 571 |
|
| 572 |
<orderedlist> |
| 573 |
<listitem> |
| 574 |
<para>Source / destination configuration and "routing" options</para> |
| 575 |
</listitem> |
| 576 |
|
| 577 |
<listitem> |
| 578 |
<para>Data compression options</para> |
| 579 |
</listitem> |
| 580 |
|
| 581 |
<listitem> |
| 582 |
<para>Security features</para> |
| 583 |
</listitem> |
| 584 |
</orderedlist> |
| 585 |
</sect1> |
| 586 |
</article> |