This crate is used to create and verify HTTP Signatures, defined here. It has support for Hyper, Rocket, and Reqwest types. In the future, I might also support Iron middleware for verification.
Since this crate is built to modularly require dependencies, running the examples is not as straightforward as for other projects. To run hyper_server and hyper_client, the proper commands are
bash
cargo run --example hyper_server --features use_hyper
and
bash
cargo run --example hyper_client --features use_hyper
The hyper examples are configured to talk to eachother by default. The server runs on port 3000, and the client POSTs on port 3000. They also use the Signature header to sign and verify the request.
The rocket server
bash
cargo run --example rocket --features use_rocket
runs on port 8000, and the reqwest client
bash
cargo run --example reqwest --features use_reqwest
GETs on port 8000. These examples use the Authorization header to sign and verify the request.
Add this to your Cargo.toml
toml
[dependencies.http-signatures]
version = "0.3"
features = ["use_hyper"]
Use it when building a request as follows. ```rust let keyid = "some-username-or-something"; let privatekey = Input::from(&privatekeyvec);
let client = Client::new();
let json = r#"{"library":"hyper"}"#; let mut req = Request::post("http://localhost:3000") .body(Body::from(json)) .unwrap(); req.headersmut().insert( CONTENTTYPE, HeaderValue::fromstr("application/json").unwrap(), ); req.headersmut().insert( CONTENTLENGTH, HeaderValue::fromstr(&format!("{}", json.len())).unwrap(), );
// Add the HTTP Signature req.withsignatureheader( keyid.into(), privatekey, SignatureAlgorithm::RSA(ShaSize::FiveTwelve), ).unwrap();
let post = client.request(req).and_then(|res| { println!("POST: {}", res.status());
res.into_body().concat2()
});
tokio::run(post.map(|| ()).maperr(|_| ())); ```
This is a very basic example server outline that should give you a general idea of how to set up a Hyper server that verifies HTTP Signatures. This is not meant to be code that actually works. ```rust const PHRASE: &str = "Hewwo, Mr. Obama???";
fn main() { let mut keyfile = File::open("tests/assets/public.der").unwrap(); let mut keyfilevec = Vec::new(); keyfile.readtoend(&mut keyfilevec).unwrap();
let key_arc = Arc::new(key_file_vec);
let service = move || {
let key = Arc::clone(&key_arc);
service_fn(move |req: Request<Body>| {
let verified = req.verify_signature_header(Input::from(&key));
verified
.into_future()
.map_err(|e| format!("{:?}", e))
.and_then(|_| {
println!("Succesfully verified request!");
Response::builder()
.header(CONTENT_LENGTH, PHRASE.len() as u64)
.body(Body::from(PHRASE))
.map_err(|e| format!("{:?}", e))
})
})
};
let addr = "127.0.0.1:3000".parse().unwrap();
let server = Server::bind(&addr)
.serve(service)
.map_err(|e| eprintln!("server error: {}", e));
rt::run(server);
} ```
Add this to your Cargo.toml
toml
[dependencies.http-signatures]
version = "0.3"
default-features = false
features = ["use_reqwest"]
In your code, use it when building a request as follows.
```rust let keyid = "some-username-or-something".into(); let privatekey = Input::from(&privatekeyvec);
let client = Client::new(); let mut req = client.get("http://localhost:8000").build().unwrap();
req.withauthorizationheader( keyid, privatekey, SignatureAlgorithm::RSA(ShaSize::FiveTwelve), ) .unwrap();
let res = client.execute(req).unwrap(); ```
Add this to your Cargo.toml
toml
[dependencies.http-signatures]
version = "0.3"
default-features = false
features = ["use_rocket"]
In your code, use it in a route like so
```rust
struct Verified;
impl<'a, 'r> FromRequest<'a, 'r> for Verified { type Error = ();
fn from_request(request: &'a Request<'r>) -> Outcome<Verified, ()> {
let res = request
.guard::<State<Vec<u8>>>()
.succeeded()
.ok_or(())
.and_then(|key| {
request
.verify_authorization_header(Input::from(&key))
.map_err(|e| println!("Error: {:?}", e))?;
Ok(Verified)
});
match res {
Ok(verified) => Success(verified),
Err(fail) => Failure((Status::Forbidden, fail)),
}
}
}
fn index(_verified: Verified) -> &'static str { "Successfully verified request" }
fn main() { let mut keyfile = File::open("tests/assets/public.der").unwrap(); let mut keyvec = Vec::new(); keyfile.readtoend(&mut keyvec).unwrap();
rocket::ignite()
.mount("/", routes![index])
.manage(key_vec)
.launch();
} ```
Please be aware that all code contributed to this project will be licensed under the GPL version 3.
HTTP Signatures is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
HTTP Signatures is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. This file is part of HTTP Signatures
You should have received a copy of the GNU General Public License along with HTTP Signatures If not, see http://www.gnu.org/licenses/.