openethereum/dapps/src/router/mod.rs

266 lines
7.8 KiB
Rust
Raw Normal View History

2016-04-07 12:10:26 +02:00
// Copyright 2015, 2016 Ethcore (UK) Ltd.
// This file is part of Parity.
// Parity 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.
// Parity 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.
// You should have received a copy of the GNU General Public License
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
//! Router implementation
2016-04-08 15:25:20 +02:00
//! Processes request handling authorization and dispatching it to proper application.
pub mod auth;
mod host_validation;
2016-04-07 12:10:26 +02:00
use DAPPS_DOMAIN;
2016-04-07 18:22:53 +02:00
use std::sync::Arc;
2016-05-13 18:40:20 +02:00
use std::collections::HashMap;
use url::{Url, Host};
use hyper::{self, server, Next, Encoder, Decoder, Control};
use hyper::net::HttpStream;
2016-05-13 18:40:20 +02:00
use apps;
use apps::fetcher::AppFetcher;
use endpoint::{Endpoint, Endpoints, EndpointPath};
use handlers::{Redirection, extract_url};
use self::auth::{Authorization, Authorized};
2016-04-07 18:22:53 +02:00
2016-05-13 18:40:20 +02:00
/// Special endpoints are accessible on every domain (every dapp)
#[derive(Debug, PartialEq, Hash, Eq)]
pub enum SpecialEndpoint {
Rpc,
Api,
2016-05-13 18:40:20 +02:00
Utils,
None,
}
pub struct Router<A: Authorization + 'static> {
control: Option<Control>,
main_page: &'static str,
endpoints: Arc<Endpoints>,
fetch: Arc<AppFetcher>,
2016-05-13 18:40:20 +02:00
special: Arc<HashMap<SpecialEndpoint, Box<Endpoint>>>,
authorization: Arc<A>,
2016-08-25 08:57:13 +02:00
allowed_hosts: Option<Vec<String>>,
handler: Box<server::Handler<HttpStream> + Send>,
2016-04-07 12:10:26 +02:00
}
impl<A: Authorization + 'static> server::Handler<HttpStream> for Router<A> {
fn on_request(&mut self, req: server::Request<HttpStream>) -> Next {
2016-09-01 10:16:04 +02:00
// Choose proper handler depending on path / domain
let url = extract_url(&req);
let endpoint = extract_endpoint(&url);
let is_utils = endpoint.1 == SpecialEndpoint::Utils;
// Validate Host header
2016-08-25 08:57:13 +02:00
if let Some(ref hosts) = self.allowed_hosts {
2016-09-01 10:16:04 +02:00
let is_valid = is_utils || host_validation::is_valid(&req, hosts, self.endpoints.keys().cloned().collect());
if !is_valid {
2016-08-25 08:57:13 +02:00
self.handler = host_validation::host_invalid_response();
return self.handler.on_request(req);
}
}
2016-05-12 14:45:09 +02:00
// Check authorization
let auth = self.authorization.is_authorized(&req);
if let Authorized::No(handler) = auth {
self.handler = handler;
return self.handler.on_request(req);
}
2016-05-12 14:45:09 +02:00
self.handler = match endpoint {
// First check special endpoints
(ref path, ref endpoint) if self.special.contains_key(endpoint) => {
self.special.get(endpoint).unwrap().to_handler(path.clone().unwrap_or_default())
},
// Then delegate to dapp
(Some(ref path), _) if self.endpoints.contains_key(&path.app_id) => {
self.endpoints.get(&path.app_id).unwrap().to_handler(path.clone())
},
2016-08-30 16:05:18 +02:00
// Try to resolve and fetch the dapp
(Some(ref path), _) if self.fetch.contains(&path.app_id) => {
let control = self.control.take().expect("on_request is called only once, thus control is always defined.");
self.fetch.to_handler(path.clone(), control)
},
// Redirection to main page (maybe 404 instead?)
(Some(ref path), _) if *req.method() == hyper::method::Method::Get => {
let address = apps::redirection_address(path.using_dapps_domains, self.main_page);
Redirection::new(address.as_str())
},
2016-08-30 16:05:18 +02:00
// Redirect any GET request to home.
_ if *req.method() == hyper::method::Method::Get => {
let address = apps::redirection_address(false, self.main_page);
Redirection::new(address.as_str())
},
// RPC by default
_ => {
self.special.get(&SpecialEndpoint::Rpc).unwrap().to_handler(EndpointPath::default())
2016-04-08 15:25:20 +02:00
}
};
2016-05-12 14:45:09 +02:00
// Delegate on_request to proper handler
2016-05-12 14:45:09 +02:00
self.handler.on_request(req)
}
/// This event occurs each time the `Request` is ready to be read from.
fn on_request_readable(&mut self, decoder: &mut Decoder<HttpStream>) -> Next {
self.handler.on_request_readable(decoder)
}
/// This event occurs after the first time this handled signals `Next::write()`.
fn on_response(&mut self, response: &mut server::Response) -> Next {
self.handler.on_response(response)
}
/// This event occurs each time the `Response` is ready to be written to.
fn on_response_writable(&mut self, encoder: &mut Encoder<HttpStream>) -> Next {
self.handler.on_response_writable(encoder)
2016-04-07 12:10:26 +02:00
}
}
impl<A: Authorization> Router<A> {
pub fn new(
control: Control,
main_page: &'static str,
app_fetcher: Arc<AppFetcher>,
endpoints: Arc<Endpoints>,
2016-05-13 18:40:20 +02:00
special: Arc<HashMap<SpecialEndpoint, Box<Endpoint>>>,
authorization: Arc<A>,
2016-08-25 08:57:13 +02:00
allowed_hosts: Option<Vec<String>>,
) -> Self {
2016-05-13 18:40:20 +02:00
let handler = special.get(&SpecialEndpoint::Rpc).unwrap().to_handler(EndpointPath::default());
2016-04-07 12:10:26 +02:00
Router {
control: Some(control),
main_page: main_page,
endpoints: endpoints,
fetch: app_fetcher,
2016-05-13 18:40:20 +02:00
special: special,
authorization: authorization,
2016-08-25 08:57:13 +02:00
allowed_hosts: allowed_hosts,
handler: handler,
2016-04-07 12:10:26 +02:00
}
}
2016-05-12 15:05:59 +02:00
}
2016-04-07 12:10:26 +02:00
fn extract_endpoint(url: &Option<Url>) -> (Option<EndpointPath>, SpecialEndpoint) {
fn special_endpoint(url: &Url) -> SpecialEndpoint {
if url.path.len() <= 1 {
return SpecialEndpoint::None;
}
2016-05-13 18:40:20 +02:00
match url.path[0].as_ref() {
2016-05-13 18:40:20 +02:00
apps::RPC_PATH => SpecialEndpoint::Rpc,
apps::API_PATH => SpecialEndpoint::Api,
apps::UTILS_PATH => SpecialEndpoint::Utils,
_ => SpecialEndpoint::None,
}
2016-04-07 12:10:26 +02:00
}
2016-05-12 15:05:59 +02:00
match *url {
Some(ref url) => match url.host {
Host::Domain(ref domain) if domain.ends_with(DAPPS_DOMAIN) => {
let len = domain.len() - DAPPS_DOMAIN.len();
2016-05-12 15:05:59 +02:00
let id = domain[0..len].to_owned();
(Some(EndpointPath {
app_id: id,
host: domain.clone(),
port: url.port,
using_dapps_domains: true,
}), special_endpoint(url))
2016-05-12 15:05:59 +02:00
},
_ if url.path.len() > 1 => {
2016-05-12 14:45:09 +02:00
let id = url.path[0].clone();
(Some(EndpointPath {
app_id: id.clone(),
host: format!("{}", url.host),
port: url.port,
using_dapps_domains: false,
}), special_endpoint(url))
},
_ => (None, special_endpoint(url)),
2016-05-12 15:05:59 +02:00
},
_ => (None, SpecialEndpoint::None)
2016-04-07 12:10:26 +02:00
}
}
2016-05-12 14:45:09 +02:00
2016-05-12 15:05:59 +02:00
#[test]
fn should_extract_endpoint() {
assert_eq!(extract_endpoint(&None), (None, SpecialEndpoint::None));
2016-05-12 15:05:59 +02:00
// With path prefix
assert_eq!(
extract_endpoint(&Url::parse("http://localhost:8080/status/index.html").ok()),
(Some(EndpointPath {
app_id: "status".to_owned(),
host: "localhost".to_owned(),
port: 8080,
using_dapps_domains: false,
}), SpecialEndpoint::None)
);
2016-05-12 15:05:59 +02:00
// With path prefix
assert_eq!(
extract_endpoint(&Url::parse("http://localhost:8080/rpc/").ok()),
(Some(EndpointPath {
app_id: "rpc".to_owned(),
host: "localhost".to_owned(),
port: 8080,
using_dapps_domains: false,
}), SpecialEndpoint::Rpc)
);
2016-05-12 15:05:59 +02:00
2016-05-13 18:40:20 +02:00
assert_eq!(
extract_endpoint(&Url::parse("http://my.status.parity/parity-utils/inject.js").ok()),
2016-05-13 18:40:20 +02:00
(Some(EndpointPath {
app_id: "my.status".to_owned(),
host: "my.status.parity".to_owned(),
2016-05-13 18:40:20 +02:00
port: 80,
using_dapps_domains: true,
2016-05-13 18:40:20 +02:00
}), SpecialEndpoint::Utils)
);
2016-05-12 15:05:59 +02:00
// By Subdomain
assert_eq!(
extract_endpoint(&Url::parse("http://my.status.parity/test.html").ok()),
(Some(EndpointPath {
app_id: "my.status".to_owned(),
host: "my.status.parity".to_owned(),
port: 80,
using_dapps_domains: true,
}), SpecialEndpoint::None)
);
2016-05-12 15:05:59 +02:00
// RPC by subdomain
assert_eq!(
extract_endpoint(&Url::parse("http://my.status.parity/rpc/").ok()),
(Some(EndpointPath {
app_id: "my.status".to_owned(),
host: "my.status.parity".to_owned(),
port: 80,
using_dapps_domains: true,
}), SpecialEndpoint::Rpc)
);
// API by subdomain
assert_eq!(
extract_endpoint(&Url::parse("http://my.status.parity/api/").ok()),
(Some(EndpointPath {
app_id: "my.status".to_owned(),
host: "my.status.parity".to_owned(),
port: 80,
using_dapps_domains: true,
}), SpecialEndpoint::Api)
);
2016-05-12 14:45:09 +02:00
}