ee59a7cc8e
Before this PR, this phrasing appears to have been copied from
the [rust project](f0fe716dbc (license)),
but it does not appear that any of your code is BSD licensed.
Also, it is a little ambigious if there are portions that are not
covered by MIT/Apache.
This patch instead draws it's phrasing from
[futures-rs](https://github.com/rust-lang-nursery/futures-rs). Does
this phrasing align more with what you intended?
Closes #29
67 lines
2.2 KiB
Markdown
67 lines
2.2 KiB
Markdown
# tokio-rustls
|
|
[](https://travis-ci.org/quininer/tokio-rustls)
|
|
[](https://ci.appveyor.com/project/quininer/tokio-rustls)
|
|
[](https://crates.io/crates/tokio-rustls)
|
|
[](https://github.com/quininer/tokio-rustls/blob/master/LICENSE-MIT)
|
|
[](https://github.com/quininer/tokio-rustls/blob/master/LICENSE-APACHE)
|
|
[](https://docs.rs/tokio-rustls/)
|
|
|
|
Asynchronous TLS/SSL streams for [Tokio](https://tokio.rs/) using
|
|
[Rustls](https://github.com/ctz/rustls).
|
|
|
|
### Basic Structure of a Client
|
|
|
|
```rust
|
|
use webpki::DNSNameRef;
|
|
use tokio_rustls::{ TlsConnector, rustls::ClientConfig };
|
|
|
|
// ...
|
|
|
|
let mut config = ClientConfig::new();
|
|
config.root_store.add_server_trust_anchors(&webpki_roots::TLS_SERVER_ROOTS);
|
|
let config = TlsConnector::from(Arc::new(config));
|
|
let dnsname = DNSNameRef::try_from_ascii_str("www.rust-lang.org").unwrap();
|
|
|
|
TcpStream::connect(&addr)
|
|
.and_then(move |socket| config.connect(dnsname, socket))
|
|
|
|
// ...
|
|
```
|
|
|
|
### Client Example Program
|
|
|
|
See [examples/client](examples/client/src/main.rs). You can run it with:
|
|
|
|
```sh
|
|
cd examples/client
|
|
cargo run -- hsts.badssl.com
|
|
```
|
|
|
|
### Server Example Program
|
|
|
|
See [examples/server](examples/server/src/main.rs). You can run it with:
|
|
|
|
```sh
|
|
cd examples/server
|
|
cargo run -- 127.0.0.1 --cert mycert.der --key mykey.der
|
|
```
|
|
|
|
### License & Origin
|
|
|
|
This project is licensed under either of
|
|
|
|
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
|
|
http://www.apache.org/licenses/LICENSE-2.0)
|
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
|
|
http://opensource.org/licenses/MIT)
|
|
|
|
at your option.
|
|
|
|
This started as a fork of [tokio-tls](https://github.com/tokio-rs/tokio-tls).
|
|
|
|
### Contribution
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
|
for inclusion in tokio-rustls by you, as defined in the Apache-2.0 license, shall be
|
|
dual licensed as above, without any additional terms or conditions.
|