-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathindex.html
350 lines (347 loc) · 10.2 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
<html>
<head>
<title>
sam-forwarder
</title>
<meta name="author" content="eyedeekay" />
<meta name="description" content="sam-forwarder" />
<meta name="keywords" content="master" />
<link rel="stylesheet" type="text/css" href="style.css" />
<link rel="stylesheet" type="text/css" href="showhider.css" />
</head>
<body>
<div id="navbar">
<a href="#shownav">
Show navigation
</a>
<div id="shownav">
<div id="hidenav">
<ul>
<li>
<a href="..">
Up one level ^
</a>
</li>
<li>
<a href="index.html">
index
</a>
</li>
<li>
<a href="LICENSE.html">
LICENSE
</a>
</li>
</ul>
<br>
<a href="#hidenav">
Hide Navigation
</a>
</div>
</div>
</div>
<h1>
<a href="#sam-forwarder" rel="nofollow">
<span></span>
</a>
sam-forwarder
</h1>
<p>
Forward a local port to i2p over the SAM API, or proxy a destination to a port
on the local host. This is no longer substantially a work-in-progress, it's a
very useful way of configuring applications in an i2ptunnel-like way. TCP and
UDP are supported, but there may be some lingering bugs in UDP, please report
them if found.
</p>
<p>
<strong>
STATUS:
</strong>
This project is maintained. I will respond to issues, pull requests,
and feature requests within a few days. I am not adding many new features to it
at this time.
</p>
<h2>
<a href="#getting" rel="nofollow">
<span></span>
</a>
getting
</h2>
<pre><code> go get -u github.com/eyedeekay/sam-forwarder/samcatd
# for now
</code></pre>
<h2>
<a href="#building" rel="nofollow">
<span></span>
</a>
building
</h2>
<p>
Just:
</p>
<pre><code> make deps build
</code></pre>
<p>
and it will be in the folder ./bin/
</p>
<p>
<a href="https://travis-ci.org/eyedeekay/sam-forwarder" rel="nofollow">
<img src="https://travis-ci.org/eyedeekay/sam-forwarder.svg?branch=master" alt="Build Status">
</a>
</p>
<h2>
<a href="#usage" rel="nofollow">
<span></span>
</a>
Usage:
</h2>
<p>
There are a number of ways to use sam-forwarder:
</p>
<h3>
<a href="#usage-configuration-as-an-application-start-here-for-samcatd" rel="nofollow">
<span></span>
</a>
<a href="docs/USAGE.md" rel="nofollow">
usage/configuration
</a>
as an application(Start here for samcatd)
</h3>
<h3>
<a href="#embedding-in-other-applications" rel="nofollow">
<span></span>
</a>
<a href="docs/EMBEDDING.md" rel="nofollow">
embedding
</a>
in other applications
</h3>
<h3>
<a href="#encapsulate-configuration-for-i2p-enabled-packages" rel="nofollow">
<span></span>
</a>
<a href="docs/PACKAGECONF.md" rel="nofollow">
encapsulate
</a>
configuration for i2p-enabled packages
</h3>
<h3>
<a href="#implement-the-interface-for-fine-grained-control-over-sam-connections" rel="nofollow">
<span></span>
</a>
<a href="interface/README.md" rel="nofollow">
implement
</a>
the interface for fine-grained control over SAM connections
</h3>
<h2>
<a href="#binaries" rel="nofollow">
<span></span>
</a>
binaries
</h2>
<p>
The standalone application for configuring tunnels is named samcatd and it's
main package is in the directory
<code>
./samcatd
</code>
. It works as a cli and is
capable of running a WebUI, which is currently view-only. In a future time, the
WebUI will also be capable of configuring and editing tunnels.
</p>
<p>
The previous application ephsite has been fully retired. If you were using it,
it can usually be replaced with
<code>
samcatd -s
</code>
and your existing arguments.
</p>
<h1>
<a href="#current-limitations" rel="nofollow">
<span></span>
</a>
Current limitations:
</h1>
<p>
I need samcatd to accept a configuration folder identical to
/etc/i2pd/tunnels.conf.d, since part of the point of this is to be compatible
with i2pd's tunnels configuration. Once this is done, I'll resume turning it
into a .deb package.
</p>
<p>
It doesn't encrypt the .i2pkeys file by default, so if someone can steal them,
then they can use them to construct tunnels to impersonate you. Experimental
support for encrypted saves has been added. The idea is that only the person
with the key will be able to decrypt and start the tunnels. It is up to the user
to determine how to go about managing these keys. Right now this system is
pretty bad. I'll be addressing that soon too.
</p>
<p>
Experimental support for KCP-based error correction and streaming-over-datagrams
is in the works. Some kind of reverse-proxy or filter is also an obvious choice.
</p>
<p>
I've only enabled the use of a subset of the i2cp and tunnel configuration
options, the ones I use the most and for no other real reason assume other
people use the most. They're pretty easy to add, it's just boring.
<em>
If you
</em>
<em>
want an i2cp or tunnel option that isn't available, bring it to my attention
</em>
<em>
please.
</em>
I'm pretty responsive when people actually contact me, it'll probably
be added within 24 hours. I intend to have configuration options for all
relevant i2cp and tunnel options, which I'm keeping track of
<a href="config/CHECKLIST.md" rel="nofollow">
here
</a>
.
</p>
<p>
I need to just change how the configuration is done entirely. I want it to work
with the configuration formats used by each I2P router.
</p>
<p>
TLS configuration is experimental. I have decided to implement optional,
automatically-configured self-signed TLS certificates. No CA support is planned
as an alternative CA would have to be used and no apparent option exists which
would be usable. If you're working on anything like that, I would like very
to know.
</p>
<h2>
<a href="#stuff-that-s-using-it" rel="nofollow">
<span></span>
</a>
Stuff that's using it:
</h2>
<p>
Mostly mine, but this is all Free-as-in-Freedom for anyone to use:
</p>
<ul>
<li>
<a href="https://github.com/eyedeekay/eephttpd" rel="nofollow">
eephttpd
</a>
</li>
<li>
<a href="https://github.com/eyedeekay/wikigopher" rel="nofollow">
my fork of wikigopher
</a>
</li>
<li>
<a href="https://github.com/s-gv/orangeforum" rel="nofollow">
orangeforum
</a>
</li>
</ul>
<h2>
<a href="#donate" rel="nofollow">
<span></span>
</a>
Donate
</h2>
<h3>
<a href="#monero-wallet-address" rel="nofollow">
<span></span>
</a>
Monero Wallet Address
</h3>
<p>
XMR:43V6cTZrUfAb9JD6Dmn3vjdT9XxLbiE27D1kaoehb359ACaHs8191mR4RsJH7hGjRTiAoSwFQAVdsCBToXXPAqTMDdP2bZB
</p>
<h3>
<a href="#bitcoin-wallet-address" rel="nofollow">
<span></span>
</a>
Bitcoin Wallet Address
</h3>
<p>
BTC:159M8MEUwhTzE9RXmcZxtigKaEjgfwRbHt
</p>
<h2>
<a href="#index" rel="nofollow">
<span></span>
</a>
Index
</h2>
<ul>
<li>
<a href="index.html" rel="nofollow">
readme
</a>
</li>
<li>
<a href="usage.html" rel="nofollow">
usage
</a>
</li>
<li>
<a href="packageconf.html" rel="nofollow">
configuration
</a>
</li>
<li>
<a href="embedding.html" rel="nofollow">
embedding
</a>
</li>
<li>
<a href="interface.htnl" rel="nofollow">
interface
</a>
</li>
</ul>
<div id="sourcecode">
<ul>
<li>
<a href="https://github.com/eyedeekay/sam-forwarder">
Source Code: (https://github.com/eyedeekay/sam-forwarder)
</a>
</li>
</ul>
</div>
<div>
<a href="#show">
Show license
</a>
<div id="show">
<div id="hide">
<pre><code>Copyright 2018 eyedeekay <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
</code></pre>
<a href="#hide">
Hide license
</a>
</div>
</div>
</div>
<div>
<iframe src="https://snowflake.torproject.org/embed.html" width="320" height="240" frameborder="0" scrolling="no"></iframe>
</div>
<div>
<a href="https://geti2p.net/">
<img src="i2plogo.png"></img>
I2P
</a>
</div>
</body>
</html>