      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
    283
    284
    285

    // 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/>.

    use std::ops::{Deref, DerefMut};
    use std::sync::Arc;

    use devtools::http_client;
    use devtools::RandomTempPath;

    use rpc::ConfirmationsQueue;
    use jsonrpc_core::IoHandler;
    use jsonrpc_core::reactor::RpcEventLoop;
    use rand;

    use ServerBuilder;
    use Server;
    use AuthCodes;

    /// Struct representing authcodes
    pub struct GuardedAuthCodes {
    	authcodes: AuthCodes,
    	/// The path to the mock authcodes
    	pub path: RandomTempPath,
    }
    impl Deref for GuardedAuthCodes {
    	type Target = AuthCodes;
    	fn deref(&self) -> &Self::Target {
    		&self.authcodes
    	}
    }
    impl DerefMut for GuardedAuthCodes {
    	fn deref_mut(&mut self) -> &mut AuthCodes {
    		&mut self.authcodes
    	}
    }

    /// Server with event loop
    pub struct ServerLoop {
    	/// Signer Server
    	pub server: Server,
    	/// RPC Event Loop
    	pub event_loop: RpcEventLoop,
    }

    impl Deref for ServerLoop {
    	type Target = Server;

    	fn deref(&self) -> &Self::Target {
    		&self.server
    	}
    }

    /// Setup a mock signer for tests
    pub fn serve() -> (ServerLoop, usize, GuardedAuthCodes) {
    	let mut path = RandomTempPath::new();
    	path.panic_on_drop_failure = false;
    	let queue = Arc::new(ConfirmationsQueue::default());
    	let builder = ServerBuilder::new(queue, path.to_path_buf());
    	let port = 35000 + rand::random::<usize>() % 10000;
    	let event_loop = RpcEventLoop::spawn();
    	let handler = event_loop.handler(Arc::new(IoHandler::default().into()));
    	let server = builder.start(format!("127.0.0.1:{}", port).parse().unwrap(), handler).unwrap();
    	let res = ServerLoop {
    		server: server,
    		event_loop: event_loop,
    	};

    	(res, port, GuardedAuthCodes {
    		authcodes: AuthCodes::from_file(&path).unwrap(),
    		path: path,
    	})
    }

    /// Test a single request to running server
    pub fn request(server: ServerLoop, request: &str) -> http_client::Response {
    	http_client::request(server.server.addr(), request)
    }

    #[cfg(test)]
    mod testing {
    	use std::time;
    	use util::Hashable;
    	use devtools::http_client;
    	use super::{serve, request};

    	#[test]
    	fn should_reject_invalid_host() {
    		// given
    		let server = serve().0;

    		// when
    		let response = request(server,
    			"\
    				GET / HTTP/1.1\r\n\
    				Host: test:8180\r\n\
    				Connection: close\r\n\
    				\r\n\
    				{}
    			"
    		);

    		// then
    		assert_eq!(response.status, "HTTP/1.1 403 FORBIDDEN".to_owned());
    		assert!(response.body.contains("URL Blocked"));
    		http_client::assert_security_headers_present(&response.headers, None);
    	}

    	#[test]
    	fn should_allow_home_parity_host() {
    		// given
    		let server = serve().0;

    		// when
    		let response = request(server,
    			"\
    				GET http://home.parity/ HTTP/1.1\r\n\
    				Host: home.parity\r\n\
    				Connection: close\r\n\
    				\r\n\
    				{}
    			"
    		);

    		// then
    		assert_eq!(response.status, "HTTP/1.1 200 OK".to_owned());
    		http_client::assert_security_headers_present(&response.headers, None);
    	}

    	#[test]
    	fn should_serve_styles_even_on_disallowed_domain() {
    		// given
    		let server = serve().0;

    		// when
    		let response = request(server,
    			"\
    				GET /styles.css HTTP/1.1\r\n\
    				Host: test:8180\r\n\
    				Connection: close\r\n\
    				\r\n\
    				{}
    			"
    		);

    		// then
    		assert_eq!(response.status, "HTTP/1.1 200 OK".to_owned());
    		http_client::assert_security_headers_present(&response.headers, None);
    	}

    	#[test]
    	fn should_return_200_ok_for_connect_requests() {
    		// given
    		let server = serve().0;

    		// when
    		let response = request(server,
    			"\
    				CONNECT home.parity:8080 HTTP/1.1\r\n\
    				Host: home.parity\r\n\
    				Connection: close\r\n\
    				\r\n\
    				{}
    			"
    		);

    		// then
    		assert_eq!(response.status, "HTTP/1.1 200 OK".to_owned());
    	}

    	#[test]
    	fn should_block_if_authorization_is_incorrect() {
    		// given
    		let (server, port, _) = serve();

    		// when
    		let response = request(server,
    			&format!("\
    				GET / HTTP/1.1\r\n\
    				Host: 127.0.0.1:{}\r\n\
    				Connection: Upgrade\r\n\
    				Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==\r\n\
    				Sec-WebSocket-Protocol: wrong\r\n\
    				Sec-WebSocket-Version: 13\r\n\
    				\r\n\
    				{{}}
    			", port)
    		);

    		// then
    		assert_eq!(response.status, "HTTP/1.1 403 FORBIDDEN".to_owned());
    		http_client::assert_security_headers_present(&response.headers, None);
    	}

    	#[test]
    	fn should_allow_if_authorization_is_correct() {
    		// given
    		let (server, port, mut authcodes) = serve();
    		let code = authcodes.generate_new().unwrap().replace("-", "");
    		authcodes.to_file(&authcodes.path).unwrap();
    		let timestamp = time::UNIX_EPOCH.elapsed().unwrap().as_secs();

    		// when
    		let response = request(server,
    			&format!("\
    				GET / HTTP/1.1\r\n\
    				Host: 127.0.0.1:{}\r\n\
    				Connection: Close\r\n\
    				Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==\r\n\
    				Sec-WebSocket-Protocol: {:?}_{}\r\n\
    				Sec-WebSocket-Version: 13\r\n\
    				\r\n\
    				{{}}
    			",
    			port,
    			format!("{}:{}", code, timestamp).sha3(),
    			timestamp,
    			)
    		);

    		// then
    		assert_eq!(response.status, "HTTP/1.1 101 Switching Protocols".to_owned());
    	}

    	#[test]
    	fn should_allow_initial_connection_but_only_once() {
    		// given
    		let (server, port, authcodes) = serve();
    		let code = "initial";
    		let timestamp = time::UNIX_EPOCH.elapsed().unwrap().as_secs();
    		assert!(authcodes.is_empty());

    		// when
    		let response1 = http_client::request(server.addr(),
    			&format!("\
    				GET / HTTP/1.1\r\n\
    				Host: 127.0.0.1:{}\r\n\
    				Connection: Close\r\n\
    				Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==\r\n\
    				Sec-WebSocket-Protocol:{:?}_{}\r\n\
    				Sec-WebSocket-Version: 13\r\n\
    				\r\n\
    				{{}}
    			",
    			port,
    			format!("{}:{}", code, timestamp).sha3(),
    			timestamp,
    			)
    		);
    		let response2 = http_client::request(server.addr(),
    			&format!("\
    				GET / HTTP/1.1\r\n\
    				Host: 127.0.0.1:{}\r\n\
    				Connection: Close\r\n\
    				Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==\r\n\
    				Sec-WebSocket-Protocol:{:?}_{}\r\n\
    				Sec-WebSocket-Version: 13\r\n\
    				\r\n\
    				{{}}
    			",
    			port,
    			format!("{}:{}", code, timestamp).sha3(),
    			timestamp,
    			)
    		);

    		// then
    		assert_eq!(response1.status, "HTTP/1.1 101 Switching Protocols".to_owned());
    		assert_eq!(response2.status, "HTTP/1.1 403 FORBIDDEN".to_owned());
    		http_client::assert_security_headers_present(&response2.headers, None);
    	}
    }

# 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`)