diff --git a/Cargo.toml b/Cargo.toml index 5fd7b85..2259f12 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,9 +1,21 @@ [package] -name = "minihttp" +name = "tk-http" version = "0.1.0" authors = [ "Alexey Popravka ", "Paul Colomiets "] +license = "MIT/Apache-2.0" +readme = "README.rst" +keywords = ["http", "websockets", "tokio"] +categories = [ + "asynchronous", + "network-programming", + "web-programming::http-client", + "web-programming::http-server", + "web-programming::websocket", + ] +homepage = "http://github.com/tailhook/tk-http" +documentation = "http://docs.rs/tk-http" [dependencies] diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..8f71f43 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..ae6a802 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,19 @@ +Copyright (c) 2017 The tk-http Developers + +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. diff --git a/README.rst b/README.rst index 2626315..decb2d4 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,18 @@ -MiniHTTP -======== +Tk-HTTP +======= -.. image:: https://travis-ci.org/swindon-rs/minihttp.svg?branch=master - :target: https://travis-ci.org/swindon-rs/minihttp +.. image:: https://travis-ci.org/swindon-rs/tk-http.svg?branch=master + :target: https://travis-ci.org/swindon-rs/tk-http -:Status: Alpha -:Documentation: https://swindon-rs.github.io/minihttp/ +:Status: Beta +:Documentation: https://docs.rs/tk-http/ -Playing around with ``rust`` and it's async stuff ``futures-rs`` and ``tokio``. +Features: -Initially cloned from ``tokio-rs/tokio-minihttp`` repo. +* HTTP 1.1 and 1.0 support (plans to support for HTTP/2 with same API) +* Flexible configuration of pipelining both for client and server +* Comprehensive configuration of timeouts both for client and server +* Strict parsing of few selected headers which influence security +* Other headers go unparsed to keep CPU usage low +* Minimum copies of data: i.e. you can decode JSON directly from network buffer +* Generic over transport (so can be used over TLS or unix sockets) diff --git a/examples/chunked.rs b/examples/chunked.rs index 94bafd8..837e188 100644 --- a/examples/chunked.rs +++ b/examples/chunked.rs @@ -2,7 +2,7 @@ extern crate tokio_core; extern crate futures; extern crate tk_bufstream; extern crate netbuf; -extern crate minihttp; +extern crate tk_http; #[macro_use] extern crate log; extern crate env_logger; @@ -14,9 +14,9 @@ use tokio_core::io::Io; use futures::{Stream, Future}; use futures::future::{FutureResult, ok}; -use minihttp::Status; -use minihttp::server::buffered::{Request, BufferedDispatcher}; -use minihttp::server::{Encoder, EncoderDone, Config, Proto, Error}; +use tk_http::Status; +use tk_http::server::buffered::{Request, BufferedDispatcher}; +use tk_http::server::{Encoder, EncoderDone, Config, Proto, Error}; fn service(req: Request, mut e: Encoder) diff --git a/examples/hello_world.rs b/examples/hello_world.rs index aaa2c47..889d4e4 100644 --- a/examples/hello_world.rs +++ b/examples/hello_world.rs @@ -3,7 +3,7 @@ extern crate tokio_core; extern crate futures; extern crate tk_bufstream; extern crate netbuf; -extern crate minihttp; +extern crate tk_http; #[macro_use] extern crate log; extern crate env_logger; @@ -15,9 +15,9 @@ use tokio_core::io::Io; use futures::{Stream, Future}; use futures::future::{FutureResult, ok}; -use minihttp::{Status}; -use minihttp::server::buffered::{Request, BufferedDispatcher}; -use minihttp::server::{Encoder, EncoderDone, Config, Proto, Error}; +use tk_http::{Status}; +use tk_http::server::buffered::{Request, BufferedDispatcher}; +use tk_http::server::{Encoder, EncoderDone, Config, Proto, Error}; const BODY: &'static str = "Hello World!"; @@ -29,7 +29,7 @@ fn service(_: Request, mut e: Encoder) e.add_length(BODY.as_bytes().len() as u64).unwrap(); e.format_header("Date", time::now_utc().rfc822()).unwrap(); e.add_header("Server", - concat!("minihttp/", env!("CARGO_PKG_VERSION")) + concat!("tk_http/", env!("CARGO_PKG_VERSION")) ).unwrap(); if e.done_headers().unwrap() { e.write_body(BODY.as_bytes()); diff --git a/examples/sendfile.rs b/examples/sendfile.rs index d2a9e92..e88a366 100644 --- a/examples/sendfile.rs +++ b/examples/sendfile.rs @@ -3,7 +3,7 @@ extern crate futures; extern crate futures_cpupool; extern crate netbuf; extern crate argparse; -extern crate minihttp; +extern crate tk_http; extern crate tk_sendfile; extern crate tk_bufstream; #[macro_use] extern crate log; @@ -21,9 +21,9 @@ use futures_cpupool::CpuPool; use tk_sendfile::DiskPool; use futures::future::{ok}; -use minihttp::Status; -use minihttp::server::buffered::{BufferedDispatcher}; -use minihttp::server::{Encoder, Config, Proto, Error}; +use tk_http::Status; +use tk_http::server::buffered::{BufferedDispatcher}; +use tk_http::server::{Encoder, Config, Proto, Error}; fn main() { let mut filename = PathBuf::from("examples/sendfile.rs"); diff --git a/examples/tls_client.rs b/examples/tls_client.rs index f8a9c7f..d9a8752 100644 --- a/examples/tls_client.rs +++ b/examples/tls_client.rs @@ -1,7 +1,7 @@ extern crate argparse; extern crate env_logger; extern crate futures; -extern crate minihttp; +extern crate tk_http; extern crate tokio_core; extern crate url; extern crate rustls; @@ -19,8 +19,8 @@ use futures::{Future, Sink}; use rustls::ClientConfig; use tokio_core::net::TcpStream; use tokio_rustls::ClientConfigExt; -use minihttp::client::buffered::{Buffered}; -use minihttp::client::{Proto, Config, Error}; +use tk_http::client::buffered::{Buffered}; +use tk_http::client::{Proto, Config, Error}; pub fn main() { diff --git a/examples/websocket2.rs b/examples/websocket2.rs index 6eeb2e5..ffd37e0 100644 --- a/examples/websocket2.rs +++ b/examples/websocket2.rs @@ -3,7 +3,7 @@ extern crate tokio_core; extern crate futures; extern crate tk_bufstream; extern crate netbuf; -extern crate minihttp; +extern crate tk_http; #[macro_use] extern crate log; extern crate env_logger; @@ -17,12 +17,12 @@ use futures::{Stream, Future, Sink}; use futures::future::{FutureResult, ok}; use futures::sync::mpsc::{unbounded, UnboundedSender}; -use minihttp::{Status}; -use minihttp::server::buffered::{Request, BufferedDispatcher}; -use minihttp::server::{Encoder, EncoderDone, Config, Proto, Error}; -use minihttp::websocket::{Loop, Config as WebsockConfig, Dispatcher, Frame}; -use minihttp::websocket::{Error as WsErr}; -use minihttp::websocket::Packet::{self, Text}; +use tk_http::{Status}; +use tk_http::server::buffered::{Request, BufferedDispatcher}; +use tk_http::server::{Encoder, EncoderDone, Config, Proto, Error}; +use tk_http::websocket::{Loop, Config as WebsockConfig, Dispatcher, Frame}; +use tk_http::websocket::{Error as WsErr}; +use tk_http::websocket::Packet::{self, Text}; const INDEX: &'static str = include_str!("ws.html"); @@ -35,7 +35,7 @@ fn service(req: Request, mut e: Encoder) e.status(Status::SwitchingProtocol); e.format_header("Date", time::now_utc().rfc822()).unwrap(); e.add_header("Server", - concat!("minihttp/", env!("CARGO_PKG_VERSION")) + concat!("tk_http/", env!("CARGO_PKG_VERSION")) ).unwrap(); e.add_header("Connection", "upgrade").unwrap(); e.add_header("Upgrade", "websocket").unwrap(); @@ -52,7 +52,7 @@ fn service(req: Request, mut e: Encoder) e.format_header("Date", time::now_utc().rfc822()).unwrap(); e.add_header("Content-Type", ctype).unwrap(); e.add_header("Server", - concat!("minihttp/", env!("CARGO_PKG_VERSION")) + concat!("tk_http/", env!("CARGO_PKG_VERSION")) ).unwrap(); if e.done_headers().unwrap() { e.write_body(data.as_bytes()); diff --git a/examples/websockets.rs b/examples/websockets.rs index c90e106..55c7bdc 100644 --- a/examples/websockets.rs +++ b/examples/websockets.rs @@ -3,7 +3,7 @@ extern crate tokio_core; extern crate futures; extern crate tk_bufstream; extern crate netbuf; -extern crate minihttp; +extern crate tk_http; #[macro_use] extern crate log; extern crate env_logger; @@ -15,9 +15,9 @@ use tokio_core::io::Io; use futures::{Stream, Future}; use futures::future::{FutureResult, ok}; -use minihttp::{Status}; -use minihttp::server::buffered::{Request, BufferedDispatcher}; -use minihttp::server::{Encoder, EncoderDone, Config, Proto, Error}; +use tk_http::{Status}; +use tk_http::server::buffered::{Request, BufferedDispatcher}; +use tk_http::server::{Encoder, EncoderDone, Config, Proto, Error}; const INDEX: &'static str = include_str!("ws.html"); @@ -30,7 +30,7 @@ fn service(req: Request, mut e: Encoder) e.status(Status::SwitchingProtocol); e.format_header("Date", time::now_utc().rfc822()).unwrap(); e.add_header("Server", - concat!("minihttp/", env!("CARGO_PKG_VERSION")) + concat!("tk_http/", env!("CARGO_PKG_VERSION")) ).unwrap(); e.add_header("Connection", "upgrade").unwrap(); e.add_header("Upgrade", "websocket").unwrap(); @@ -47,7 +47,7 @@ fn service(req: Request, mut e: Encoder) e.format_header("Date", time::now_utc().rfc822()).unwrap(); e.add_header("Content-Type", ctype).unwrap(); e.add_header("Server", - concat!("minihttp/", env!("CARGO_PKG_VERSION")) + concat!("tk_http/", env!("CARGO_PKG_VERSION")) ).unwrap(); if e.done_headers().unwrap() { e.write_body(data.as_bytes()); diff --git a/examples/ws_cli.rs b/examples/ws_cli.rs index db4cfe9..10b2033 100644 --- a/examples/ws_cli.rs +++ b/examples/ws_cli.rs @@ -1,5 +1,5 @@ extern crate futures; -extern crate minihttp; +extern crate tk_http; extern crate argparse; extern crate env_logger; extern crate tokio_core; @@ -14,9 +14,9 @@ use futures::future::{FutureResult, ok}; use futures::sync::mpsc::unbounded; use tokio_core::net::TcpStream; use tokio_core::reactor::{Timeout}; -use minihttp::websocket::{Loop, Frame, Error, Dispatcher, Config}; -use minihttp::websocket::client::{HandshakeProto, SimpleAuthorizer}; -use minihttp::websocket::Packet::{Text}; +use tk_http::websocket::{Loop, Frame, Error, Dispatcher, Config}; +use tk_http::websocket::client::{HandshakeProto, SimpleAuthorizer}; +use tk_http::websocket::Packet::{Text}; struct Echo; diff --git a/src/websocket/client.rs b/src/websocket/client.rs index 171cac2..55132a9 100644 --- a/src/websocket/client.rs +++ b/src/websocket/client.rs @@ -111,7 +111,7 @@ impl Authorizer for SimpleAuthorizer { e.format_header("Origin", format_args!("http://{}{}", self.host, self.path)) .unwrap(); - e.add_header("User-Agent", concat!("minihttp/", + e.add_header("User-Agent", concat!("tk-http/", env!("CARGO_PKG_VERSION"))).unwrap(); e.done() }