Skip to content

Commit 7aa0da9

Browse files
committed
doc changes, fixed docker auto-build, moved licence to standalone file
1 parent aa729dd commit 7aa0da9

File tree

4 files changed

+20
-33
lines changed

4 files changed

+20
-33
lines changed

.github/goreleaser.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
# test this goreleaser config with:
2+
# - cd chisel/
3+
# - goreleaser --skip-publish --rm-dist --config .github/goreleaser.yml
14
builds:
25
- env:
36
- CGO_ENABLED=0
@@ -26,6 +29,9 @@ builds:
2629
goarm:
2730
- 6
2831
- 7
32+
gomips:
33+
- hardfloat
34+
- softfloat
2935
archives:
3036
- format: gz
3137
files:

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2019 Jaime Pillora <[email protected]>
3+
Copyright (c) 2020 Jaime Pillora <[email protected]>
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@ Chisel is a fast TCP tunnel, transported over HTTP, secured via SSH. Single exec
1414
- [Authenticated connections](#authentication); authenticated client connections with a users config file, authenticated server connections with fingerprint matching.
1515
- Client auto-reconnects with [exponential backoff](https://github.com/jpillora/backoff)
1616
- Client can create multiple tunnel endpoints over one TCP connection
17-
- Client can optionally pass through HTTP CONNECT proxies
17+
- Client can optionally pass through SOCKS or HTTP CONNECT proxies
18+
- Reverse port forwarding (Connections go through the server and out the client)
1819
- Server optionally doubles as a [reverse proxy](http://golang.org/pkg/net/http/httputil/#NewSingleHostReverseProxy)
1920
- Server optionally allows [SOCKS5](https://en.wikipedia.org/wiki/SOCKS) connections (See [guide below](#socks5-guide))
20-
- Reverse port forwarding (Connections go through the server and out the client)
21+
- Client optionally allows [SOCKS5](https://en.wikipedia.org/wiki/SOCKS) connections from a reversed port forward
2122

2223
### Install
2324

@@ -134,12 +135,11 @@ $ chisel server --help
134135
a SIGHUP to short-circuit the client reconnect timer
135136
136137
Version:
137-
X.Y.Z
138+
0.0.0-src (go1.14)
138139
139140
Read more:
140141
https://github.com/jpillora/chisel
141142
142-
143143
```
144144

145145
```
@@ -176,6 +176,8 @@ $ chisel client --help
176176
socks
177177
5000:socks
178178
R:2222:localhost:22
179+
R:socks
180+
R:5000:socks
179181
180182
When the chisel server has --socks5 enabled, remotes can
181183
specify "socks" in place of remote-host and remote-port.
@@ -187,6 +189,9 @@ $ chisel client --help
187189
be prefixed with R to denote that they are reversed. That
188190
is, the server will listen and accept connections, and they
189191
will be proxied through the client which specified the remote.
192+
Reverse remotes specifying "R:socks" will listen on the server's
193+
default socks port (1080) and terminate the connection at the
194+
client's internal SOCKS5 proxy.
190195
191196
Options:
192197
@@ -219,10 +224,10 @@ $ chisel client --help
219224
or: socks://admin:[email protected]:1080
220225
221226
--header, Set a custom header in the form "HeaderName: HeaderContent".
222-
Can be used multiple times. (e.g --header "Foo: Bar" --header "Hello: World")
227+
Can be used multiple times. (e.g --header "Foo: Bar" --header "Hello: World")
223228
224229
--hostname, Optionally set the 'Host' header (defaults to the host
225-
defined in the endpoint url).
230+
found in the server url).
226231
227232
--pid Generate pid file in current working directory
228233
@@ -236,12 +241,11 @@ $ chisel client --help
236241
a SIGHUP to short-circuit the client reconnect timer
237242
238243
Version:
239-
X.Y.Z
244+
0.0.0-src (go1.14)
240245
241246
Read more:
242247
https://github.com/jpillora/chisel
243248
244-
245249
```
246250

247251
### Security
@@ -375,26 +379,3 @@ See more [test/](test/)
375379
- Better, faster tests
376380
- Expose a stats page for proxy throughput
377381
- Treat client stdin/stdout as a socket
378-
379-
#### MIT License
380-
381-
Copyright © 2017 Jaime Pillora &lt;[email protected]&gt;
382-
383-
Permission is hereby granted, free of charge, to any person obtaining
384-
a copy of this software and associated documentation files (the
385-
'Software'), to deal in the Software without restriction, including
386-
without limitation the rights to use, copy, modify, merge, publish,
387-
distribute, sublicense, and/or sell copies of the Software, and to
388-
permit persons to whom the Software is furnished to do so, subject to
389-
the following conditions:
390-
391-
The above copyright notice and this permission notice shall be
392-
included in all copies or substantial portions of the Software.
393-
394-
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
395-
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
396-
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
397-
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
398-
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
399-
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
400-
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

client/client.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ func (c *Client) connectionLoop() {
221221
c.proxyURL.Scheme)
222222
break
223223
}
224-
var auth *proxy.Auth = nil
224+
var auth *proxy.Auth
225225
if c.proxyURL.User != nil {
226226
pass, _ := c.proxyURL.User.Password()
227227
auth = &proxy.Auth{

0 commit comments

Comments
 (0)