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 286
// Copyright 2015-2019 Parity Technologies (UK) Ltd.
// This file is part of Parity Ethereum.
// Parity Ethereum 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 Ethereum 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 Ethereum. If not, see <http://www.gnu.org/licenses/>.
//! Parity-specific metadata extractors.
use crate::rpc::{http_common::HttpMetaExtractor, Metadata, Origin};
use cfx_types::H256;
use jsonrpc_pubsub::Session;
use jsonrpc_tcp_server as tcp;
use jsonrpc_ws_server as ws;
use std::sync::Arc;
//use ws;
/// Common HTTP & IPC metadata extractor.
pub struct RpcExtractor;
impl HttpMetaExtractor for RpcExtractor {
type Metadata = Metadata;
fn read_metadata(
&self, origin: Option<String>, user_agent: Option<String>,
) -> Metadata {
Metadata {
origin: Origin::Rpc(format!(
"{} / {}",
origin.unwrap_or_else(|| "unknown origin".to_string()),
user_agent.unwrap_or_else(|| "unknown agent".to_string())
)),
session: None,
}
}
}
impl tcp::MetaExtractor<Metadata> for RpcExtractor {
fn extract(&self, req: &tcp::RequestContext) -> Metadata {
Metadata {
origin: Origin::Tcp(req.peer_addr),
session: Some(Arc::new(Session::new(req.sender.clone()))),
}
}
}
impl ws::MetaExtractor<Metadata> for RpcExtractor {
fn extract(&self, req: &ws::RequestContext) -> Metadata {
Metadata {
origin: Origin::Ws {
session: H256::from_low_u64_be(req.session_id),
},
session: Some(Arc::new(Session::new(req.sender()))),
}
}
}
///// WebSockets server metadata extractor and request middleware.
//pub struct WsExtractor {
// authcodes_path: Option<PathBuf>,
//}
//
//impl WsExtractor {
// /// Creates new `WsExtractor` with given authcodes path.
// pub fn new(path: Option<&Path>) -> Self {
// WsExtractor {
// authcodes_path: path.map(ToOwned::to_owned),
// }
// }
//}
//
//impl ws::MetaExtractor<Metadata> for WsExtractor {
// fn extract(&self, req: &ws::RequestContext) -> Metadata {
// let id = req.session_id as u64;
//
// let origin = match self.authcodes_path {
// Some(ref path) => {
// let authorization = req
// .protocols
// .get(0)
// .and_then(|p| auth_token_hash(&path, p, true));
// match authorization {
// Some(id) => Origin::Signer { session: id },
// None => Origin::Ws {
// session: H256::from_low_u64_be(id),
// },
// }
// }
// None => Origin::Ws {
// session: H256::from_low_u64_be(id),
// },
// };
// let session = Some(Arc::new(Session::new(req.sender())));
// Metadata { origin, session }
// }
//}
//
//impl ws::RequestMiddleware for WsExtractor {
// fn process(&self, req: &ws::ws::Request) -> ws::MiddlewareAction {
// use self::ws::ws::Response;
//
// // Reply with 200 OK to HEAD requests.
// if req.method() == "HEAD" {
// let mut response = Response::new(200, "OK", vec![]);
// add_security_headers(&mut response);
// return Some(response).into();
// }
//
// // Display WS info.
// if req.header("sec-websocket-key").is_none() {
// let mut response = Response::new(200, "OK", b"WebSocket interface
// is active. Open WS connection to access RPC.".to_vec());
// add_security_headers(&mut response); return Some(response).into();
// }
//
// // If protocol is provided it needs to be valid.
// let protocols = req.protocols().ok().unwrap_or_else(Vec::new);
// if let Some(ref path) = self.authcodes_path {
// if protocols.len() == 1 {
// let authorization = auth_token_hash(&path, protocols[0],
// false); if authorization.is_none() {
// warn!(
// "Blocked connection from {} using invalid token.",
// req.header("origin")
// .and_then(|e| ::std::str::from_utf8(e).ok())
// .unwrap_or("Unknown Origin")
// );
// let mut response = Response::new(403, "Forbidden",
// vec![]); add_security_headers(&mut response);
// return Some(response).into();
// }
// }
// }
//
// // Otherwise just proceed.
// ws::MiddlewareAction::Proceed
// }
//}
//
//fn add_security_headers(res: &mut ws::ws::Response) {
// let headers = res.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(("Content-Security-Policy".into(),
// b"default-src 'self';form-action
// 'none';block-all-mixed-content;sandbox allow-scripts;".to_vec() ));
//}
//
//fn auth_token_hash(
// codes_path: &Path, protocol: &str, save_file: bool,
//) -> Option<H256> {
// let mut split = protocol.split('_');
// let auth = split.next().and_then(|v| v.parse().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
// return authcodes::AuthCodes::from_file(codes_path)
// .ok()
// .and_then(|mut codes| {
// // remove old tokens
// codes.clear_garbage();
//
// let res = codes.is_valid(&auth, time);
//
// if save_file {
// // 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."); }
// }
//
// if res {
// Some(auth)
// } else {
// None
// }
// });
// }
//
// None
//}
//
///// WebSockets RPC usage statistics.
//pub struct WsStats {
// stats: Arc<RpcStats>,
//}
//
//impl WsStats {
// /// Creates new WS usage tracker.
// pub fn new(stats: Arc<RpcStats>) -> Self { WsStats { stats } }
//}
//
//impl ws::SessionStats for WsStats {
// fn open_session(&self, _id: ws::SessionId) { self.stats.open_session() }
//
// fn close_session(&self, _id: ws::SessionId) { self.stats.close_session() }
//}
//
///// WebSockets middleware dispatching requests to different handles dependning
///// on metadata.
//pub struct WsDispatcher<M: core::Middleware<Metadata>> {
// full_handler: core::MetaIoHandler<Metadata, M>,
//}
//
//impl<M: core::Middleware<Metadata>> WsDispatcher<M> {
// /// Create new `WsDispatcher` with given full handler.
// pub fn new(full_handler: core::MetaIoHandler<Metadata, M>) -> Self {
// WsDispatcher { full_handler }
// }
//}
//
//impl<M: core::Middleware<Metadata>> core::Middleware<Metadata>
// for WsDispatcher<M>
//{
// type CallFuture = core::middleware::NoopCallFuture;
// type Future = Either<
// core::FutureRpcResult<M::Future, M::CallFuture>,
// core::FutureResponse,
// >;
//
// fn on_request<F, X>(
// &self, request: core::Request, meta: Metadata, process: F,
// ) -> Either<Self::Future, X>
// where
// F: FnOnce(core::Request, Metadata) -> X,
// X: core::futures::Future<Item = Option<core::Response>, Error = ()>
// + Send
// + 'static,
// {
// let use_full = match &meta.origin {
// Origin::Signer { .. } => true,
// _ => false,
// };
//
// if use_full {
// Either::A(Either::A(
// self.full_handler.handle_rpc_request(request, meta),
// ))
// } else {
// Either::B(process(request, meta))
// }
// }
//}
#[cfg(test)]
mod tests {
use super::{HttpMetaExtractor, Origin, RpcExtractor};
#[test]
fn should_extract_rpc_origin() {
// given
let extractor = RpcExtractor;
// when
let meta1 = extractor.read_metadata(None, None);
let meta2 = extractor
.read_metadata(None, Some("https://conflux-chain.org".to_owned()));
let meta3 = extractor
.read_metadata(None, Some("https://conflux-chain.org".to_owned()));
// then
assert_eq!(
meta1.origin,
Origin::Rpc("unknown origin / unknown agent".into())
);
assert_eq!(
meta2.origin,
Origin::Rpc("unknown origin / https://conflux-chain.org".into())
);
assert_eq!(
meta3.origin,
Origin::Rpc("unknown origin / https://conflux-chain.org".into())
);
}
}