      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    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
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282

    // Copyright 2015-2017 Parity Technologies (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/>.

    //! Session handlers factory.

    use ws;
    use authcode_store::AuthCodes;
    use std::path::{PathBuf, Path};
    use std::sync::Arc;
    use std::str::FromStr;
    use jsonrpc_core::{Metadata};
    use jsonrpc_core::reactor::RpcHandler;
    use util::{H256, version};

    #[cfg(feature = "parity-ui")]
    mod ui {
    	extern crate parity_ui as ui;
    	extern crate parity_dapps_glue as dapps;

    	use self::dapps::WebApp;

    	#[derive(Default)]
    	pub struct Handler {
    		ui: ui::App,
    	}

    	impl Handler {
    		pub fn handle(&self, req: &str) -> Option<&dapps::File> {
    			let file = match req {
    				"" | "/" => "index.html",
    				path => &path[1..],
    			};
    			self.ui.file(file)
    		}
    	}
    }
    #[cfg(not(feature = "parity-ui"))]
    mod ui {
    	pub struct File {
    		pub content: &'static [u8],
    		pub content_type: &'static str,
    	}

    	#[derive(Default)]
    	pub struct Handler;

    	impl Handler {
    		pub fn handle(&self, _req: &str) -> Option<&File> {
    			None
    		}
    	}
    }

    const HOME_DOMAIN: &'static str = "home.parity";

    fn origin_is_allowed(self_origin: &str, header: Option<&[u8]>) -> bool {
    	match header {
    		None => false,
    		Some(h) => {
    			let v = String::from_utf8(h.to_owned()).ok();
    			match v {
    				Some(ref origin) if origin.starts_with("chrome-extension://") => true,
    				Some(ref origin) if origin.starts_with(self_origin) => true,
    				Some(ref origin) if origin.starts_with(&format!("http://{}", self_origin)) => true,
    				Some(ref origin) if origin.starts_with(HOME_DOMAIN) => true,
    				Some(ref origin) if origin.starts_with(&format!("http://{}", HOME_DOMAIN)) => true,
    				_ => false
    			}
    		}
    	}
    }

    fn auth_is_valid(codes_path: &Path, protocols: ws::Result<Vec<&str>>) -> bool {
    	match protocols {
    		Ok(ref protocols) if protocols.len() == 1 => {
    			protocols.iter().any(|protocol| {
    				let mut split = protocol.split('_');
    				let auth = split.next().and_then(|v| H256::from_str(v).ok());
    				let time = split.next().and_then(|v| u64::from_str_radix(v, 10).ok());

    				if let (Some(auth), Some(time)) = (auth, time) {
    					// Check if the code is valid
    					AuthCodes::from_file(codes_path)
    						.map(|mut codes| {
    							// remove old tokens
    							codes.clear_garbage();

    							let res = codes.is_valid(&auth, time);
    							// make sure to save back authcodes - it might have been modified
    							if codes.to_file(codes_path).is_err() {
    								warn!(target: "signer", "Couldn't save authorization codes to file.");
    							}
    							res
    						})
    						.unwrap_or(false)
    				} else {
    					false
    				}
    			})
    		},
    		_ => false
    	}
    }

    fn add_headers(mut response: ws::Response, mime: &str) -> ws::Response {
    	let content_len = format!("{}", response.len());
    	{
    		let mut headers = response.headers_mut();
    		headers.push(("X-Frame-Options".into(), b"SAMEORIGIN".to_vec()));
    		headers.push(("X-XSS-Protection".into(), b"1; mode=block".to_vec()));
    		headers.push(("X-Content-Type-Options".into(), b"nosniff".to_vec()));
    		headers.push(("Server".into(), b"Parity/SignerUI".to_vec()));
    		headers.push(("Content-Length".into(), content_len.as_bytes().to_vec()));
    		headers.push(("Content-Type".into(), mime.as_bytes().to_vec()));
    		headers.push(("Connection".into(), b"close".to_vec()));
    	}
    	response
    }

    pub struct Session<M: Metadata> {
    	out: ws::Sender,
    	skip_origin_validation: bool,
    	self_origin: String,
    	authcodes_path: PathBuf,
    	handler: RpcHandler<M>,
    	file_handler: Arc<ui::Handler>,
    }

    impl<M: Metadata> ws::Handler for Session<M> {
    	#[cfg_attr(feature="dev", allow(collapsible_if))]
    	fn on_request(&mut self, req: &ws::Request) -> ws::Result<(ws::Response)> {
    		trace!(target: "signer", "Handling request: {:?}", req);

    		// TODO [ToDr] ws server is not handling proxied requests correctly:
    		// Trim domain name from resource part:
    		let resource = req.resource().trim_left_matches(&format!("http://{}", HOME_DOMAIN));

    		// Styles file is allowed for error pages to display nicely.
    		let is_styles_file = resource == "/styles.css";

    		// Check request origin and host header.
    		if !self.skip_origin_validation {
    			let origin = req.header("origin").or_else(|| req.header("Origin")).map(|x| &x[..]);
    			let host = req.header("host").or_else(|| req.header("Host")).map(|x| &x[..]);

    			let is_valid = origin_is_allowed(&self.self_origin, origin) || (origin.is_none() && origin_is_allowed(&self.self_origin, host));
    			let is_valid = is_styles_file || is_valid;

    			if !is_valid {
    				warn!(target: "signer", "Blocked connection to Signer API from untrusted origin.");
    				return Ok(error(
    						ErrorType::Forbidden,
    						"URL Blocked",
    						"You are not allowed to access Trusted Signer using this URL.",
    						Some(&format!("Use: http://{}", self.self_origin)),
    				));
    			}
    		}

    		// PROXY requests when running behind home.parity
    		if req.method() == "CONNECT" {
    			let mut res = ws::Response::ok("".into());
    			res.headers_mut().push(("Content-Length".into(), b"0".to_vec()));
    			res.headers_mut().push(("Connection".into(), b"keep-alive".to_vec()));
    			return Ok(res);
    		}

    		// Detect if it's a websocket request
    		// (styles file skips origin validation, so make sure to prevent WS connections on this resource)
    		if req.header("sec-websocket-key").is_some() && !is_styles_file {
    			// Check authorization
    			if !auth_is_valid(&self.authcodes_path, req.protocols()) {
    				info!(target: "signer", "Unauthorized connection to Signer API blocked.");
    				return Ok(error(ErrorType::Forbidden, "Not Authorized", "Request to this API was not authorized.", None));
    			}

    			let protocols = req.protocols().expect("Existence checked by authorization.");
    			let protocol = protocols.get(0).expect("Proved by authorization.");
    			return ws::Response::from_request(req).map(|mut res| {
    				// To make WebSockets connection successful we need to send back the protocol header.
    				res.set_protocol(protocol);
    				res
    			});
    		}

    		debug!(target: "signer", "Requesting resource: {:?}", resource);
    		// Otherwise try to serve a page.
    		Ok(self.file_handler.handle(resource)
    			.map_or_else(
    				// return 404 not found
    				|| error(ErrorType::NotFound, "Not found", "Requested file was not found.", None),
    				// or serve the file
    				|f| add_headers(ws::Response::ok_raw(f.content.to_vec()), f.content_type)
    			))
    	}

    	fn on_message(&mut self, msg: ws::Message) -> ws::Result<()> {
    		let req = msg.as_text()?;
    		let out = self.out.clone();
    		// TODO [ToDr] Extract metadata for PubSub/Session
    		let metadata = Default::default();

    		self.handler.handle_request(req, metadata, move |response| {
    			if let Some(result) = response {
    				let res = out.send(result);
    				if let Err(e) = res {
    					warn!(target: "signer", "Error while sending response: {:?}", e);
    				}
    			}
    		});
    		Ok(())
    	}
    }

    pub struct Factory<M: Metadata> {
    	handler: RpcHandler<M>,
    	skip_origin_validation: bool,
    	self_origin: String,
    	authcodes_path: PathBuf,
    	file_handler: Arc<ui::Handler>,
    }

    impl<M: Metadata> Factory<M> {
    	pub fn new(handler: RpcHandler<M>, self_origin: String, authcodes_path: PathBuf, skip_origin_validation: bool) -> Self {
    		Factory {
    			handler: handler,
    			skip_origin_validation: skip_origin_validation,
    			self_origin: self_origin,
    			authcodes_path: authcodes_path,
    			file_handler: Arc::new(ui::Handler::default()),
    		}
    	}
    }

    impl<M: Metadata> ws::Factory for Factory<M> {
    	type Handler = Session<M>;

    	fn connection_made(&mut self, sender: ws::Sender) -> Self::Handler {
    		Session {
    			out: sender,
    			handler: self.handler.clone(),
    			skip_origin_validation: self.skip_origin_validation,
    			self_origin: self.self_origin.clone(),
    			authcodes_path: self.authcodes_path.clone(),
    			file_handler: self.file_handler.clone(),
    		}
    	}
    }

    enum ErrorType {
    	NotFound,
    	Forbidden,
    }

    fn error(error: ErrorType, title: &str, message: &str, details: Option<&str>) -> ws::Response {
    	let content = format!(
    		include_str!("./error_tpl.html"),
    		title=title,
    		meta="",
    		message=message,
    		details=details.unwrap_or(""),
    		version=version(),
    	);
    	let res = match error {
    		ErrorType::NotFound => ws::Response::not_found(content),
    		ErrorType::Forbidden => ws::Response::forbidden(content),
    	};
    	add_headers(res, "text/html")
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)