idk/sam-forwarder
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
idk
2018-09-18 00:47:51 -04:00
parent c2bf0bd822
commit 3c415e114a
4 changed files with 132 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md.asc
View File

@@ -80,12 +80,12 @@ I'm eventually going to make the manager implement net.Conn. This won't be
exposed in the default application probably though, but rather as a library. exposed in the default application probably though, but rather as a library.
-----BEGIN PGP SIGNATURE----- -----BEGIN PGP SIGNATURE-----
iQEzBAEBCAAdFiEEcNIGBzi++AUjrK/311wDs5teFOEFAluggSwACgkQ11wDs5te iQEzBAEBCAAdFiEEcNIGBzi++AUjrK/311wDs5teFOEFAlugg3cACgkQ11wDs5te
FOFEKQgAk/9CV9A6LGibqTV9sb3044eSTWT9SRG1RdtcwqSjrUZtmskIDgVugijA FOE4qwgAj8yOnHYZsJkGa/wNPzA0p7AGivMfGAYZWuagKLPFU8X+FbnasLnD5sI/
PILyK7REjfeajctojqgTlVM4xnB4rLz8Q4qameNZ59BZGfhwrM9Ma7WaOdLMSkXH UO4FBGjRVasEdV9cBQBu3d/ZBP3551udaoVLY5UUKpOK0kxy4rpb9AHvtLZasnyC
y55Hnz081AB4sk649mRnB1D9uEBQ0nPgPlBi4/fDMCLKou4AlDbWy8W89j+ZdcEA 7cqITn7O/MxkeAz/MFWGUdAcSE3D5m6L7jKx/Yw7lvh3ouVhjLUr0Ad2k/ngi1t0
P+/TJ6F34+44IB7kvJtvlTpZJoio9wSpSES6xZ/EEaJd7MN2rCzDW62HV1ClPCzM 3yV24q01FZB+DPHeUm1QHjjRqHw2747pQuuAxS22S7YbXDJQjdAx41NWtRM0fy94
EIKMuW2AVu/xd0LvFOhBA5u5SKsMoHmT+GVfSvGZadjzNmW75Uz94Sk2cPwDWSnI fJ5aOlL7ID6qGly4Y80OX28RGZRKGVDNQcDzakm9V0YeZLz4Mq4HO5A1dlBd8Qt3
QEFJjnFzNeINGNbGPff65uWuJo48GQ== grazhUB/6OY+IHIeBZCXoL3Mhcquig==
=UxJ6 =eEdy
-----END PGP SIGNATURE----- -----END PGP SIGNATURE-----

17
USAGE.md
View File

@@ -97,6 +97,8 @@ Usage of ./bin/samcatd:
-accesslist value -accesslist value
Specify an access list member(can be used multiple times) Specify an access list member(can be used multiple times)
-c Client proxy mode(true or false) -c Client proxy mode(true or false)
-cr string
Encrypt/decrypt the key files with a passfile
-ct int -ct int
Reduce tunnel quantity after X (milliseconds) (default 600000) Reduce tunnel quantity after X (milliseconds) (default 600000)
-d string -d string
@@ -108,13 +110,13 @@ Usage of ./bin/samcatd:
-i string -i string
Destination for client tunnels. Ignored for service tunnels. (default "none") Destination for client tunnels. Ignored for service tunnels. (default "none")
-ib int -ib int
Set inbound tunnel backup quantity(0 to 5) (default 4) Set inbound tunnel backup quantity(0 to 5) (default 2)
-ic int
Set inbound tunnel quantity(0 to 15) (default 6)
-ih -ih
Inject X-I2P-DEST headers Inject X-I2P-DEST headers
-il int -il int
Set inbound tunnel length(0 to 7) (default 3) Set inbound tunnel length(0 to 7) (default 3)
-iq int
Set inbound tunnel quantity(0 to 15) (default 6)
-iv int -iv int
Set inbound tunnel length variance(-7 to 7) Set inbound tunnel length variance(-7 to 7)
-k string -k string
@@ -123,11 +125,11 @@ Usage of ./bin/samcatd:
-n string -n string
Tunnel name, this must be unique but can be anything. (default "forwarder") Tunnel name, this must be unique but can be anything. (default "forwarder")
-ob int -ob int
Set outbound tunnel backup quantity(0 to 5) (default 4) Set outbound tunnel backup quantity(0 to 5) (default 2)
-oc int
Set outbound tunnel quantity(0 to 15) (default 6)
-ol int -ol int
Set outbound tunnel length(0 to 7) (default 3) Set outbound tunnel length(0 to 7) (default 3)
-oq int
Set outbound tunnel quantity(0 to 15) (default 6)
-ov int -ov int
Set outbound tunnel length variance(-7 to 7) Set outbound tunnel length variance(-7 to 7)
-p string -p string
@@ -137,7 +139,7 @@ Usage of ./bin/samcatd:
-psk string -psk string
private signing key for encrypted leaseset (default "none") private signing key for encrypted leaseset (default "none")
-r Reduce tunnel quantity when idle(true or false) -r Reduce tunnel quantity when idle(true or false)
-rc int -rq int
Reduce idle tunnel quantity to X (0 to 5) (default 3) Reduce idle tunnel quantity to X (0 to 5) (default 3)
-rt int -rt int
Reduce tunnel quantity after X (milliseconds) (default 600000) Reduce tunnel quantity after X (milliseconds) (default 600000)
@@ -150,6 +152,7 @@ Usage of ./bin/samcatd:
-tls string -tls string
(Currently inoperative. Target TLS port(HTTPS Port of service to forward to i2p) (Currently inoperative. Target TLS port(HTTPS Port of service to forward to i2p)
-u UDP mode(true or false) -u UDP mode(true or false)
-w Start web administration interface
-x Close tunnel idle(true or false) -x Close tunnel idle(true or false)
-z Uze gzip(true or false) -z Uze gzip(true or false)
-zi -zi

1
etc/samcatd/tunnels.ini
View File

@@ -19,6 +19,7 @@ i2cp.reduceIdleTime = 3000000
i2cp.reduceQuantity = 2 i2cp.reduceQuantity = 2
i2cp.enableWhiteList = false i2cp.enableWhiteList = false
i2cp.enableBlackList = false i2cp.enableBlackList = false
keyfile = "/usr/share/samcatd/samcatd"
[sam-forwarder] [sam-forwarder]
type = server type = server

160
example/www/index.html
View File

@@ -68,74 +68,140 @@
Allow zero-hop, non-anonymous tunnels in(true or false) Allow zero-hop, non-anonymous tunnels in(true or false)
-zeroout -zeroout
Allow zero-hop, non-anonymous tunnels out(true or false)</code></pre> Allow zero-hop, non-anonymous tunnels out(true or false)</code></pre>
<h1 id="eephttpd---static-file-server-automatically-forwarded-to-i2p">eephttpd - Static file server automatically forwarded to i2p</h1> <h1 id="samcatd---router-independent-tunnel-management-for-i2p">samcatd - Router-independent tunnel management for i2p</h1>
<p>samcatd is a daemon which runs a group of forwarding proxies to provide services over i2p independent of the router. It also serves as a generalized i2p networking utility for power-users. It's intended to be a Swiss-army knife for the SAM API.</p>
<h2 id="usage-1">usage:</h2> <h2 id="usage-1">usage:</h2>
<p>eephttpd is a static http server which automatically runs on i2p with the help of the SAM bridge. By default it will only be available from the localhost and it's i2p tunnel. It can be masked from the localhost using a container.</p> <pre><code>flag needs an argument: -h
<pre><code>Usage of ./bin/eephttpd: Usage of ./bin/samcatd:
-a string -a string
hostname to serve on (default &quot;127.0.0.1&quot;) Type of access list to use, can be &quot;whitelist&quot; &quot;blacklist&quot; or &quot;none&quot;. (default &quot;none&quot;)
-c Use an encrypted leaseset(true or false) -accesslist value
Specify an access list member(can be used multiple times)
-c Client proxy mode(true or false)
-cr string
Encrypt/decrypt the key files with a passfile
-ct int
Reduce tunnel quantity after X (milliseconds) (default 600000)
-d string -d string
the directory of static files to host(default ./www) (default &quot;./www&quot;) Directory to save tunnel configuration file in.
-f string -f string
Use an ini file for configuration (default &quot;none&quot;) Use an ini file for configuration(config file options override passed arguments for now.) (default &quot;none&quot;)
-g Uze gzip(true or false) (default true) -h string
-i save i2p keys(and thus destinations) across reboots (default true) Target host(Host of service to forward to i2p) (default &quot;127.0.0.1&quot;)
-i string
Destination for client tunnels. Ignored for service tunnels. (default &quot;none&quot;)
-ib int -ib int
Set inbound tunnel backup quantity(0 to 5) (default 4) Set inbound tunnel backup quantity(0 to 5) (default 2)
-ih
Inject X-I2P-DEST headers
-il int -il int
Set inbound tunnel length(0 to 7) (default 3) Set inbound tunnel length(0 to 7) (default 3)
-iq int -iq int
Set inbound tunnel quantity(0 to 15) (default 8) Set inbound tunnel quantity(0 to 15) (default 6)
-iv int -iv int
Set inbound tunnel length variance(-7 to 7) Set inbound tunnel length variance(-7 to 7)
-l string -k string
Type of access list to use, can be &quot;whitelist&quot; &quot;blacklist&quot; or &quot;none&quot;. (default &quot;none&quot;) key for encrypted leaseset (default &quot;none&quot;)
-m string -l Use an encrypted leaseset(true or false) (default true)
Certificate name to use (default &quot;cert&quot;)
-n string -n string
name to give the tunnel(default static-eepSite) (default &quot;static-eepSite&quot;) Tunnel name, this must be unique but can be anything. (default &quot;forwarder&quot;)
-ob int -ob int
Set outbound tunnel backup quantity(0 to 5) (default 4) Set outbound tunnel backup quantity(0 to 5) (default 2)
-ol int -ol int
Set outbound tunnel length(0 to 7) (default 3) Set outbound tunnel length(0 to 7) (default 3)
-oq int -oq int
Set outbound tunnel quantity(0 to 15) (default 8) Set outbound tunnel quantity(0 to 15) (default 6)
-ov int -ov int
Set outbound tunnel length variance(-7 to 7) Set outbound tunnel length variance(-7 to 7)
-p string -p string
port to serve locally on (default &quot;7880&quot;) Target port(Port of service to forward to i2p) (default &quot;8081&quot;)
-pk string
private key for encrypted leaseset (default &quot;none&quot;)
-psk string
private signing key for encrypted leaseset (default &quot;none&quot;)
-r Reduce tunnel quantity when idle(true or false) -r Reduce tunnel quantity when idle(true or false)
-rc int -rq int
Reduce idle tunnel quantity to X (0 to 5) (default 3) Reduce idle tunnel quantity to X (0 to 5) (default 3)
-rt int -rt int
Reduce tunnel quantity after X (milliseconds) (default 600000) Reduce tunnel quantity after X (milliseconds) (default 600000)
-s string -s Start a tunnel with the passed parameters(Otherwise, they will be treated as default values.)
the directory to save the keys in(default ./) (default &quot;.&quot;)
-sh string -sh string
sam host to connect to (default &quot;127.0.0.1&quot;) SAM host (default &quot;127.0.0.1&quot;)
-sp string -sp string
sam port to connect to (default &quot;7656&quot;) SAM port (default &quot;7656&quot;)
-t Generate or use an existing TLS certificate -t Use saved file and persist tunnel(If false, tunnel will not persist after program is stopped.
-x Inject X-I2P-DEST headers (default true) -tls string
-z Allow zero-hop, non-anonymous tunnels(true or false)</code></pre> (Currently inoperative. Target TLS port(HTTPS Port of service to forward to i2p)
<h3 id="build-in-docker">build in docker</h3> -u UDP mode(true or false)
<pre><code>docker build --build-arg user=eephttpd --build-arg path=example/www -f Dockerfile -t eyedeekay/eephttpd .</code></pre> -w Start web administration interface
<h3 id="run-in-docker">Run in docker</h3> -x Close tunnel idle(true or false)
<pre><code>docker run -i -t -d \ -z Uze gzip(true or false)
--name eephttpd-volume \ -zi
--volume eephttpd:/home/eephttpd/ \ Allow zero-hop, non-anonymous tunnels in(true or false)
eyedeekay/eephttpd</code></pre> -zo
<pre><code>docker run -i -t -d \ Allow zero-hop, non-anonymous tunnels out(true or false)</code></pre>
--network si \ <h1 id="example-config---valid-for-both-ephsite-and-samcat">example config - valid for both ephsite and samcat</h1>
--env samhost=sam-host \ <p>Options are still being added, pretty much as fast as I can put them in. For up-to-the-minute options, see <a href="config/CHECKLIST.md">the checklist</a></p>
--env samport=7656 \ <p>(<strong>ephsite</strong> will only use top-level options, but they can be labeled or unlabeled)</p>
--env args=-r # Additional arguments to pass to eephttpd\ <p>(<strong>samcatd</strong> treats the first set of options it sees as the default, and does not start tunnels based on unlabeled options unless passed the -s flag.)</p>
--network-alias eephttpd \ <pre><code>
--hostname eephttpd \ ## Defaults, these are only invoked with the -start option or if labeled tunnels
--name eephttpd \ ## are not present(samcatd instructions)
--restart always \
--volumes-from eephttpd-volume \ inbound.length = 3
eyedeekay/eephttpd</code></pre> outbound.length = 6
<h2 id="instance">instance</h2> inbound.lengthVariance = 0
<p>a running instance of eephttpd with the example index file is availble on</p> outbound.lengthVariance = 0
inbound.backupQuantity = 3
outbound.backupQuantity = 3
inbound.quantity = 5
outbound.quantity = 5
inbound.allowZeroHop = false
outbound.allowZeroHop = false
i2cp.encryptLeaseSet = false
gzip = true
i2cp.reduceOnIdle = true
i2cp.reduceIdleTime = 3000000
i2cp.reduceQuantity = 2
i2cp.enableWhiteList = false
i2cp.enableBlackList = false
[sam-forwarder]
type = server
host = 127.0.0.1
port = 8081
inbound.length = 3
outbound.length = 6
keys = forwarder
[sam-forwarder-two]
type = client
host = 127.0.0.1
port = 8082
inbound.length = 6
outbound.length = 3
keys = forwarder-two
[sam-forwarder-three]
type = udpclient
host = 127.0.0.1
port = 8083
inbound.length = 3
outbound.length = 6
keys = forwarder-three
[sam-forwarder-four]
type = udpserver
host = 127.0.0.1
port = 8084
inbound.length = 6
outbound.length = 3
keys = forwarder-four
[sam-forwarder-five]
type = http
host = 127.0.0.1
port = 8085
inbound.length = 3
outbound.length = 6
keys = forwarder-five</code></pre>