forked from v2ray/v2ray-core
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
204b895
commit c072d38
Showing
42 changed files
with
13,683 additions
and
22 deletions.
There are no files selected for viewing
23 changes: 23 additions & 0 deletions
23
external/github.com/refraction-networking/utls/CONTRIBUTING.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# How to Contribute | ||
|
||
We'd love to accept your patches and contributions to this project. There are | ||
just a few small guidelines you need to follow. | ||
|
||
## Contributor License Agreement | ||
|
||
Contributions to this project must be accompanied by a Contributor License | ||
Agreement. You (or your employer) retain the copyright to your contribution, | ||
this simply gives us permission to use and redistribute your contributions as | ||
part of the project. Head over to <https://cla.developers.google.com/> to see | ||
your current agreements on file or to sign a new one. | ||
|
||
You generally only need to submit a CLA once, so if you've already submitted one | ||
(even if it was for a different project), you probably don't need to do it | ||
again. | ||
|
||
## Code reviews | ||
|
||
All submissions, including submissions by project members, require review. We | ||
use GitHub pull requests for this purpose. Consult | ||
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more | ||
information on using pull requests. |
69 changes: 69 additions & 0 deletions
69
external/github.com/refraction-networking/utls/CONTRIBUTORS_GUIDE.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
# How this package works | ||
### Chapter 1: [Making private things public](./u_public.go) | ||
There are numerous handshake-related structs in crypto/tls, most of which are either private or have private fields. | ||
One of them — `clientHandshakeState` — has private function `handshake()`, | ||
which is called in the beginning of default handshake. | ||
Unfortunately, user will not be able to directly access this struct outside of tls package. | ||
As a result, we decided to employ following workaround: declare public copies of private structs. | ||
Now user is free to manipulate fields of public `ClientHandshakeState`. | ||
Then, right before handshake, we can shallow-copy public state into private `clientHandshakeState`, | ||
call `handshake()` on it and carry on with default Golang handshake process. | ||
After handshake is done we shallow-copy private state back to public, allowing user to read results of handshake. | ||
|
||
### Chapter 2: [TLSExtension](./u_tls_extensions.go) | ||
The way we achieve reasonable flexibilty with extensions is inspired by | ||
[ztls'](https://github.com/zmap/zcrypto/blob/master/tls/handshake_extensions.go) design. | ||
However, our design has several differences, so we wrote it from scratch. | ||
This design allows us to have an array of `TLSExtension` objects and then marshal them in order: | ||
```Golang | ||
type TLSExtension interface { | ||
writeToUConn(*UConn) error | ||
|
||
Len() int // includes header | ||
|
||
// Read reads up to len(p) bytes into p. | ||
// It returns the number of bytes read (0 <= n <= len(p)) and any error encountered. | ||
Read(p []byte) (n int, err error) // implements io.Reader | ||
} | ||
``` | ||
`writeToUConn()` applies appropriate per-extension changes to `UConn`. | ||
|
||
`Len()` provides the size of marshaled extension, so we can allocate appropriate buffer beforehand, | ||
catch out-of-bound errors easily and guide size-dependent extensions such as padding. | ||
|
||
`Read(buffer []byte)` _writes(see: io.Reader interface)_ marshaled extensions into provided buffer. | ||
This avoids extra allocations. | ||
|
||
### Chapter 3: [UConn](./u_conn.go) | ||
`UConn` extends standard `tls.Conn`. Most notably, it stores slice with `TLSExtension`s and public | ||
`ClientHandshakeState`. | ||
Whenever `UConn.BuildHandshakeState()` gets called (happens automatically in `UConn.Handshake()` | ||
or could be called manually), config will be applied according to chosen `ClientHelloID`. | ||
From contributor's view there are 2 main behaviors: | ||
* `HelloGolang` simply calls default Golang's [`makeClientHello()`](./handshake_client.go) | ||
and directly stores it into `HandshakeState.Hello`. utls-specific stuff is ignored. | ||
* Other ClientHelloIDs fill `UConn.Hello.{Random, CipherSuites, CompressionMethods}` and `UConn.Extensions` with | ||
per-parrot setup, which then gets applied to appropriate standard tls structs, | ||
and then marshaled by utls into `HandshakeState.Hello`. | ||
|
||
### Chapter 4: Tests | ||
|
||
Tests exist, but coverage is very limited. What's covered is a conjunction of | ||
* TLS 1.2 | ||
* Working parrots without any unsupported extensions (only Android 5.1 at this time) | ||
* Ciphersuites offered by parrot. | ||
* Ciphersuites supported by Golang | ||
* Simple conversation with reference implementation of OpenSSL. | ||
(e.g. no automatic checks for renegotiations, parroting quality and such) | ||
|
||
plus we test some other minor things. | ||
Basically, current tests aim to provide a sanity check. | ||
|
||
# Merging upstream | ||
```Bash | ||
git remote add -f golang git@github.com:golang/go.git | ||
git checkout -b golang-upstream golang/master | ||
git subtree split -P src/crypto/tls/ -b golang-tls-upstream | ||
git checkout master | ||
git merge --no-commit golang-tls-upstream | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
Copyright (c) 2009 The Go Authors. All rights reserved. | ||
|
||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are | ||
met: | ||
|
||
* Redistributions of source code must retain the above copyright | ||
notice, this list of conditions and the following disclaimer. | ||
* Redistributions in binary form must reproduce the above | ||
copyright notice, this list of conditions and the following disclaimer | ||
in the documentation and/or other materials provided with the | ||
distribution. | ||
* Neither the name of Google Inc. nor the names of its | ||
contributors may be used to endorse or promote products derived from | ||
this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
161 changes: 161 additions & 0 deletions
161
external/github.com/refraction-networking/utls/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,161 @@ | ||
# uTLS | ||
[](https://travis-ci.org/refraction-networking/utls) | ||
[](https://godoc.org/github.com/refraction-networking/utls#UConn) | ||
--- | ||
uTLS is a fork of "crypto/tls", which provides ClientHello fingerprinting resistance, low-level access to handshake, fake session tickets and some other features. Handshake is still performed by "crypto/tls", this library merely changes ClientHello part of it and provides low-level access. | ||
Golang 1.11+ is required. | ||
If you have any questions, bug reports or contributions, you are welcome to publish those on GitHub. If you want to do so in private, you can contact one of developers personally via sergey.frolov@colorado.edu | ||
# Features | ||
## Low-level access to handshake | ||
* Read/write access to all bits of client hello message. | ||
* Read access to fields of ClientHandshakeState, which, among other things, includes ServerHello and MasterSecret. | ||
* Read keystream. Can be used, for example, to "write" something in ciphertext. | ||
## ClientHello fingerprinting resistance | ||
Golang's ClientHello has a very unique fingerprint, which especially sticks out on mobile clients, | ||
where Golang is not too popular yet. | ||
Some members of anti-censorship community are concerned that their tools could be trivially blocked based on | ||
ClientHello with relatively small collateral damage. There are multiple solutions to this issue. | ||
### Randomized handshake | ||
This package can generate randomized ClientHello using only extensions and cipherSuites "crypto/tls" already supports. | ||
This provides a solid moving target without any compatibility or parrot-is-dead attack risks. | ||
**Feedback about opinionated implementation details of randomized handshake is appreciated.** | ||
### Parroting | ||
This package can be used to parrot ClientHello of popular browsers. | ||
There are some caveats to this parroting: | ||
* We are forced to offer ciphersuites and tls extensions that are not supported by crypto/tls. | ||
This is not a problem, if you fully control the server and turn unsupported things off on server side. | ||
* Parroting could be imperfect, and there is no parroting beyond ClientHello. | ||
#### Compatibility risks of available parrots | ||
|
||
| Parrot | Ciphers* | Signature* | Unsupported extensions | TLS Fingerprint ID | | ||
| ------------- | -------- | ---------- | ---------------------- | --------------------------------------------- | | ||
| Chrome 62 | no | no | ChannelID | [0a4a74aeebd1bb66](https://tlsfingerprint.io/id/0a4a74aeebd1bb66) | | ||
| Chrome 70 | no | no | ChannelID, Encrypted Certs | [bc4c7e42f4961cd7](https://tlsfingerprint.io/id/bc4c7e42f4961cd7) | | ||
| Firefox 56 | very low | no | None | [c884bad7f40bee56](https://tlsfingerprint.io/id/c884bad7f40bee56) | | ||
| Firefox 63 | very low | no | MaxRecordSize | [6bfedc5d5c740d58](https://tlsfingerprint.io/id/6bfedc5d5c740d58) | | ||
| iOS 11.1 | low** | no | None | [71a81bafd58e1301](https://tlsfingerprint.io/id/71a81bafd58e1301) | | ||
|
||
\* Denotes very rough guesstimate of likelihood that unsupported things will get echoed back by the server in the wild, | ||
*visibly breaking the connection*. | ||
\*\* No risk, if `utls.EnableWeakCiphers()` is called prior to using it. | ||
|
||
#### Parrots FAQ | ||
> Does it really look like, say, Google Chrome with all the [GREASE](https://tools.ietf.org/html/draft-davidben-tls-grease-01) and stuff? | ||
It LGTM, but please open up Wireshark and check. If you see something — [say something](issues). | ||
|
||
> Aren't there side channels? Everybody knows that the ~~bird is a word~~[parrot is dead](https://people.cs.umass.edu/~amir/papers/parrot.pdf) | ||
There sure are. If you found one that approaches practicality at line speed — [please tell us](issues). | ||
|
||
#### Things to implement in Golang to make parrots better | ||
uTLS is fundamentially limited in parroting, because Golang's "crypto/tls" doesn't support many things. Would be nice to have: | ||
* ChannelID extension | ||
* In general, any modern crypto is likely to be useful going forward. | ||
### Custom Handshake | ||
It is possible to create custom handshake by | ||
1) Use `HelloCustom` as an argument for `UClient()` to get empty config | ||
2) Fill tls header fields: UConn.Hello.{Random, CipherSuites, CompressionMethods}, if needed, or stick to defaults. | ||
3) Configure and add various [TLS Extensions](u_tls_extensions.go) to UConn.Extensions: they will be marshaled in order. | ||
4) Set Session and SessionCache, as needed. | ||
|
||
If you need to manually control all the bytes on the wire(certainly not recommended!), | ||
you can set UConn.HandshakeStateBuilt = true, and marshal clientHello into UConn.HandshakeState.Hello.raw yourself. | ||
In this case you will be responsible for modifying other parts of Config and ClientHelloMsg to reflect your setup | ||
and not confuse "crypto/tls", which will be processing response from server. | ||
## Fake Session Tickets | ||
Fake session tickets is a very nifty trick that allows power users to hide parts of handshake, which may have some very fingerprintable features of handshake, and saves 1 RTT. | ||
Currently, there is a simple function to set session ticket to any desired state: | ||
|
||
```Golang | ||
// If you want you session tickets to be reused - use same cache on following connections | ||
func (uconn *UConn) SetSessionState(session *ClientSessionState) | ||
``` | ||
|
||
Note that session tickets (fake ones or otherwise) are not reused. | ||
To reuse tickets, create a shared cache and set it on current and further configs: | ||
|
||
```Golang | ||
// If you want you session tickets to be reused - use same cache on following connections | ||
func (uconn *UConn) SetSessionCache(cache ClientSessionCache) | ||
``` | ||
|
||
# Client Hello IDs | ||
See full list of `clientHelloID` values [here](https://godoc.org/github.com/refraction-networking/utls#ClientHelloID). | ||
There are different behaviors you can get, depending on your `clientHelloID`: | ||
|
||
1. ```utls.HelloRandomized``` adds/reorders extensions, ciphersuites, etc. randomly. | ||
`HelloRandomized` adds ALPN in 50% of cases, you may want to use `HelloRandomizedALPN` or | ||
`HelloRandomizedNoALPN` to choose specific behavior explicitly, as ALPN might affect application layer. | ||
2. ```utls.HelloGolang``` | ||
HelloGolang will use default "crypto/tls" handshake marshaling codepath, which WILL | ||
overwrite your changes to Hello(Config, Session are fine). | ||
You might want to call BuildHandshakeState() before applying any changes. | ||
UConn.Extensions will be completely ignored. | ||
3. ```utls.HelloCustom``` | ||
will prepare ClientHello with empty uconn.Extensions so you can fill it with TLSExtension's manually. | ||
4. The rest will will parrot given browser. Such parrots include, for example: | ||
* `utls.HelloChrome_Auto`- parrots recommended(usually latest) Google Chrome version | ||
* `utls.HelloChrome_58` - parrots Google Chrome 58 | ||
* `utls.HelloFirefox_Auto` - parrots recommended(usually latest) Firefox version | ||
* `utls.HelloFirefox_55` - parrots Firefox 55 | ||
|
||
# Usage | ||
## Examples | ||
Find basic examples [here](examples/examples.go). | ||
Here's a more [advanced example](https://github.com/sergeyfrolov/gotapdance/blob//9a777f35a04b0c4c5dacd30bca0e9224eb737b5e/tapdance/conn_raw.go#L275-L292) showing how to generate randomized ClientHello, modify generated ciphersuites a bit, and proceed with the handshake. | ||
### Migrating from "crypto/tls" | ||
Here's how default "crypto/tls" is typically used: | ||
```Golang | ||
dialConn, err := net.Dial("tcp", "172.217.11.46:443") | ||
if err != nil { | ||
fmt.Printf("net.Dial() failed: %+v\n", err) | ||
return | ||
} | ||
|
||
config := tls.Config{ServerName: "www.google.com"} | ||
tlsConn := tls.Client(dialConn, &config) | ||
n, err = tlsConn.Write("Hello, World!") | ||
//... | ||
``` | ||
To start using using uTLS: | ||
1. Import this library (e.g. `import tls "github.com/refraction-networking/utls"`) | ||
2. Pick the [Client Hello ID](#client-hello-ids) | ||
3. Simply substitute `tlsConn := tls.Client(dialConn, &config)` | ||
with `tlsConn := tls.UClient(dialConn, &config, tls.clientHelloID)` | ||
|
||
### Customizing handshake | ||
Some customizations(such as setting session ticket/clientHello) have easy-to-use functions for them. The idea is to make common manipulations easy: | ||
```Golang | ||
cRandom := []byte{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} | ||
tlsConn.SetClientRandom(cRandom) | ||
masterSecret := make([]byte, 48) | ||
copy(masterSecret, []byte("masterSecret is NOT sent over the wire")) // you may use it for real security | ||
|
||
// Create a session ticket that wasn't actually issued by the server. | ||
sessionState := utls.MakeClientSessionState(sessionTicket, uint16(tls.VersionTLS12), | ||
tls.TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, | ||
masterSecret, | ||
nil, nil) | ||
tlsConn.SetSessionState(sessionState) | ||
``` | ||
|
||
For other customizations there are following functions | ||
``` | ||
// you can use this to build the state manually and change it | ||
// for example use Randomized ClientHello, and add more extensions | ||
func (uconn *UConn) BuildHandshakeState() error | ||
``` | ||
``` | ||
// Then apply the changes and marshal final bytes, which will be sent | ||
func (uconn *UConn) MarshalClientHello() error | ||
``` | ||
|
||
## Contributors' guide | ||
Please refer to [this document](./CONTRIBUTORS_GUIDE.md) if you're interested in internals | ||
|
||
## Credits | ||
The initial development of uTLS was completed during an internship at [Google Jigsaw](https://jigsaw.google.com/). This is not an official Google product. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
// Copyright 2009 The Go Authors. All rights reserved. | ||
// Use of this source code is governed by a BSD-style | ||
// license that can be found in the LICENSE file. | ||
|
||
package tls | ||
|
||
import "strconv" | ||
|
||
type alert uint8 | ||
|
||
const ( | ||
// alert level | ||
alertLevelWarning = 1 | ||
alertLevelError = 2 | ||
) | ||
|
||
const ( | ||
alertCloseNotify alert = 0 | ||
alertUnexpectedMessage alert = 10 | ||
alertBadRecordMAC alert = 20 | ||
alertDecryptionFailed alert = 21 | ||
alertRecordOverflow alert = 22 | ||
alertDecompressionFailure alert = 30 | ||
alertHandshakeFailure alert = 40 | ||
alertBadCertificate alert = 42 | ||
alertUnsupportedCertificate alert = 43 | ||
alertCertificateRevoked alert = 44 | ||
alertCertificateExpired alert = 45 | ||
alertCertificateUnknown alert = 46 | ||
alertIllegalParameter alert = 47 | ||
alertUnknownCA alert = 48 | ||
alertAccessDenied alert = 49 | ||
alertDecodeError alert = 50 | ||
alertDecryptError alert = 51 | ||
alertProtocolVersion alert = 70 | ||
alertInsufficientSecurity alert = 71 | ||
alertInternalError alert = 80 | ||
alertInappropriateFallback alert = 86 | ||
alertUserCanceled alert = 90 | ||
alertNoRenegotiation alert = 100 | ||
alertMissingExtension alert = 109 | ||
alertUnsupportedExtension alert = 110 | ||
alertNoApplicationProtocol alert = 120 | ||
) | ||
|
||
var alertText = map[alert]string{ | ||
alertCloseNotify: "close notify", | ||
alertUnexpectedMessage: "unexpected message", | ||
alertBadRecordMAC: "bad record MAC", | ||
alertDecryptionFailed: "decryption failed", | ||
alertRecordOverflow: "record overflow", | ||
alertDecompressionFailure: "decompression failure", | ||
alertHandshakeFailure: "handshake failure", | ||
alertBadCertificate: "bad certificate", | ||
alertUnsupportedCertificate: "unsupported certificate", | ||
alertCertificateRevoked: "revoked certificate", | ||
alertCertificateExpired: "expired certificate", | ||
alertCertificateUnknown: "unknown certificate", | ||
alertIllegalParameter: "illegal parameter", | ||
alertUnknownCA: "unknown certificate authority", | ||
alertAccessDenied: "access denied", | ||
alertDecodeError: "error decoding message", | ||
alertDecryptError: "error decrypting message", | ||
alertProtocolVersion: "protocol version not supported", | ||
alertInsufficientSecurity: "insufficient security level", | ||
alertInternalError: "internal error", | ||
alertInappropriateFallback: "inappropriate fallback", | ||
alertUserCanceled: "user canceled", | ||
alertNoRenegotiation: "no renegotiation", | ||
alertMissingExtension: "missing extension", | ||
alertUnsupportedExtension: "unsupported extension", | ||
alertNoApplicationProtocol: "no application protocol", | ||
} | ||
|
||
func (e alert) String() string { | ||
s, ok := alertText[e] | ||
if ok { | ||
return "tls: " + s | ||
} | ||
return "tls: alert(" + strconv.Itoa(int(e)) + ")" | ||
} | ||
|
||
func (e alert) Error() string { | ||
return e.String() | ||
} |
Oops, something went wrong.