src/bin/server.rs

   1 // Copyright 2021 Ian Jackson and contributors to Hippotat
   2 // SPDX-License-Identifier: GPL-3.0-or-later
   3 // There is NO WARRANTY.
   4
   5 use hippotat::prelude::*;
   6
   7 #[derive(StructOpt,Debug)]
   8 pub struct Opts {
   9   #[structopt(flatten)]
  10   log: LogOpts,
  11
  12   #[structopt(flatten)]
  13   config: config::Opts,
  14 }
  15
  16 const METADATA_MAX_LEN: usize = MAX_OVERHEAD;
  17
  18 type AllClients = HashMap<ClientName, ClientHandles>;
  19
  20 struct ClientHandles {
  21   ic: Arc<InstanceConfig>,
  22   web: tokio::sync::mpsc::Sender<WebRequest>,
  23 }
  24
  25 /// Sent from hyper worker pool task to client task
  26 #[allow(dead_code)] // xxx
  27 #[derive(Debug)]
  28 struct WebRequest {
  29   // initial part of body
  30   // used up to and including first 2 lines of metadata
  31   // end delimiter for the metadata not yet located, but in here somewhere
  32   initial: Box<[u8]>,
  33   initial_remaining: usize,
  34   length_hint: usize,
  35   body: hyper::body::Body,
  36   boundary_finder: multipart::BoundaryFinder,
  37   reply_to: tokio::sync::oneshot::Sender<WebResponse>,
  38   warnings: Warnings,
  39 }
  40
  41 /// Reply from client task to hyper worker pool task
  42 #[allow(dead_code)] // xxx
  43 #[derive(Debug)]
  44 struct WebResponse {
  45   warnings: Warnings,
  46   data: Result<WebResponseData, AE>,
  47 }
  48
  49 type WebResponseData = Vec<u8>;
  50
  51 #[throws(PacketError)]
  52 pub fn route_packet(packet: Box<[u8]>, daddr: IpAddr) {
  53   trace!("xxx discarding packet daddr={:?} len={}", daddr, packet.len());
  54 }
  55
  56 async fn handle(
  57   conn: Arc<String>,
  58   all_clients: Arc<AllClients>,
  59   req: hyper::Request<hyper::Body>
  60 ) -> Result<hyper::Response<hyper::Body>, hyper::http::Error> {
  61   if req.method() == Method::GET {
  62     let mut resp = hyper::Response::new(hyper::Body::from("hippotat\r\n"));
  63     resp.headers_mut().insert(
  64       "Content-Type",
  65       "text/plain; charset=US-ASCII".try_into().unwrap()
  66     );
  67     return Ok(resp)
  68   }
  69
  70   let mut warnings: Warnings = default();
  71
  72   async {
  73
  74     let get_header = |hn: &str| {
  75       let mut values = req.headers().get_all(hn).iter();
  76       let v = values.next().ok_or_else(|| anyhow!("missing {}", hn))?;
  77       if values.next().is_some() { throw!(anyhow!("multiple {}!", hn)); }
  78       let v = v.to_str().context(anyhow!("interpret {} as UTF-8", hn))?;
  79       Ok::<_,AE>(v)
  80     };
  81
  82     let mkboundary = |b: &'_ _| format!("\n--{}", b).into_bytes();
  83     let boundary = match (||{
  84       let t = get_header("Content-Type")?;
  85       let t: mime::Mime = t.parse().context("parse Content-Type")?;
  86       if t.type_() != "multipart" { throw!(anyhow!("not multipart/")) }
  87       let b = mime::BOUNDARY;
  88       let b = t.get_param(b).ok_or_else(|| anyhow!("missing boundary=..."))?;
  89       if t.subtype() != "form-data" {
  90         warnings.add(&"Content-Type not /form-data")?;
  91       }
  92       let b = mkboundary(b.as_str());
  93       Ok::<_,AE>(b)
  94     })() {
  95       Ok(y) => y,
  96       Err(e) => {
  97         warnings.add(&e.wrap_err("guessing boundary"))?;
  98         mkboundary("b")
  99       },
 100     };
 101
 102     let length_hint: usize = (||{
 103       let clength = get_header("Content-Length")?;
 104       let clength = clength.parse().context("parse Content-Length")?;
 105       Ok::<_,AE>(clength)
 106     })().unwrap_or_else(
 107       |e| { let _ = warnings.add(&e.wrap_err("parsing Content-Length")); 0 }
 108     );
 109
 110     let mut body = req.into_body();
 111     let initial = match read_limited_bytes(
 112       METADATA_MAX_LEN, default(), length_hint, &mut body
 113     ).await {
 114       Ok(all) => all,
 115       Err(ReadLimitedError::Truncated { sofar,.. }) => sofar,
 116       Err(ReadLimitedError::Hyper(e)) => throw!(e),
 117     };
 118
 119     let boundary_finder = memmem::Finder::new(&boundary);
 120     let mut boundary_iter = boundary_finder.find_iter(&initial);
 121
 122     let start = if initial.starts_with(&boundary[1..]) { boundary.len()-1 }
 123     else if let Some(start) = boundary_iter.next() { start + boundary.len() }
 124     else { throw!(anyhow!("initial boundary not found")) };
 125
 126     let comp = multipart::process_boundary
 127       (&mut warnings, &initial[start..], PartName::m)?
 128       .ok_or_else(|| anyhow!(r#"no "m" component"#))?;
 129
 130     if comp.name != PartName::m { throw!(anyhow!(
 131       r#"first multipart component must be name="m""#
 132     )) }
 133
 134     let mut meta = MetadataFieldIterator::new(comp.payload);
 135
 136     let client: ClientName = meta.need_parse().context("client addr")?;
 137
 138     let mut hmac_got = [0; HMAC_L];
 139     let (client_time, hmac_got_l) = (||{
 140       let token: &str = meta.need_next().context(r#"find in "m""#)?;
 141       let (time_t, hmac_b64) = token.split_once(' ')
 142         .ok_or_else(|| anyhow!("split"))?;
 143       let time_t = u64::from_str_radix(time_t, 16).context("parse time_t")?;
 144       let l = io::copy(
 145         &mut base64::read::DecoderReader::new(&mut hmac_b64.as_bytes(),
 146                                               BASE64_CONFIG),
 147         &mut &mut hmac_got[..]
 148       ).context("parse b64 token")?;
 149       let l = l.try_into()?;
 150       Ok::<_,AE>((time_t, l))
 151     })().context("token")?;
 152     let hmac_got = &hmac_got[0..hmac_got_l];
 153
 154     let client_name = client;
 155     let client = all_clients.get(&client_name);
 156
 157     // We attempt to hide whether the client exists we don't try to
 158     // hide the hash lookup computationgs, but we do try to hide the
 159     // HMAC computation by always doing it.  We hope that the compiler
 160     // doesn't produce a specialised implementation for the dummy
 161     // secret value.
 162     let client_exists = subtle::Choice::from(client.is_some() as u8);
 163     let secret = client.map(|c| c.ic.secret.0.as_bytes());
 164     let secret = secret.unwrap_or(&[0x55; HMAC_B][..]);
 165     let client_time_s = format!("{:x}", client_time);
 166     let hmac_exp = token_hmac(secret, client_time_s.as_bytes());
 167     // We also definitely want a consttime memeq for the hmac value
 168     let hmac_ok = hmac_got.ct_eq(&hmac_exp);
 169     //dbg!(DumpHex(&hmac_exp), client.is_some());
 170     //dbg!(DumpHex(hmac_got), hmac_ok, client_exists);
 171     if ! bool::from(hmac_ok & client_exists) {
 172       debug!("{} rejected client {}", &conn, &client_name);
 173       let body = hyper::Body::from("Not authorised\r\n");
 174       return Ok(
 175         hyper::Response::builder()
 176           .status(hyper::StatusCode::FORBIDDEN)
 177           .header("Content-Type", r#"text/plain; charset="utf-8""#)
 178           .body(body)
 179       )
 180     }
 181
 182     let client = client.unwrap();
 183     let now = time_t_now();
 184     let chk_skew = |a: u64, b: u64, c_ahead_behind| {
 185       if let Some(a_ahead) = a.checked_sub(b) {
 186         if a_ahead > client.ic.max_clock_skew.as_secs() {
 187           throw!(anyhow!("too much clock skew (client {} by {})",
 188                          c_ahead_behind, a_ahead));
 189         }
 190       }
 191       Ok::<_,AE>(())
 192     };
 193     chk_skew(client_time, now, "ahead")?;
 194     chk_skew(now, client_time, "behind")?;
 195
 196     let initial_remaining = meta.remaining_bytes_len();
 197
 198     //eprintln!("boundary={:?} start={} name={:?} client={}",
 199     // boundary, start, &comp.name, &client.ic);
 200
 201     let (reply_to, reply_recv) = tokio::sync::oneshot::channel();
 202     trace!("{} request xxx={}", &client.ic, initial.len());
 203     let wreq = WebRequest {
 204       initial,
 205       initial_remaining,
 206       length_hint,
 207       boundary_finder: boundary_finder.into_owned(),
 208       body,
 209       warnings: mem::take(&mut warnings),
 210       reply_to
 211     };
 212
 213     client.web.try_send(wreq)
 214       .map_err(|_| anyhow!("client task shut down!"))?;
 215
 216     let reply: WebResponse = reply_recv.await?;
 217     warnings = reply.warnings;
 218     let data = reply.data?;
 219
 220     if ! warnings.warnings.is_empty()
 221     && log::log_enabled!(log::Level::Trace) {
 222       trace!("{} {}: warnings {:?}", &conn, &client_name, &warnings.warnings);
 223     }
 224
 225     let data = hyper::Body::from(data);
 226     Ok::<_,AE>(
 227       hyper::Response::builder()
 228         .header("Content-Type", r#"application/octet-stream"#)
 229         .body(data)
 230     )
 231   }.await.unwrap_or_else(|e| {
 232     debug!("{} error {}", &conn, &e);
 233     let mut errmsg = format!("ERROR\n\n{:?}\n\n", &e);
 234     for w in warnings.warnings {
 235       write!(errmsg, "warning: {}\n", w).unwrap();
 236     }
 237     hyper::Response::builder()
 238       .status(hyper::StatusCode::BAD_REQUEST)
 239       .header("Content-Type", r#"text/plain; charset="utf-8""#)
 240       .body(errmsg.into())
 241   })
 242 }
 243
 244 #[allow(unused_variables)] // xxx
 245 #[allow(unused_mut)] // xxx
 246 async fn run_client(ic: Arc<InstanceConfig>,
 247                     mut web: mpsc::Receiver<WebRequest>)
 248                     -> Result<Void, AE>
 249 {
 250   struct Outstanding {
 251     reply_to: tokio::sync::oneshot::Sender<WebResponse>,
 252     oi: OutstandingInner,
 253   }
 254   #[derive(Debug)]
 255   struct OutstandingInner {
 256     target_requests_outstanding: u32,
 257   }
 258   let mut outstanding: VecDeque<Outstanding> = default();
 259   let  downbound: VecDeque<(/*xxx*/)> = default();
 260
 261   let try_send_response = |
 262     reply_to: tokio::sync::oneshot::Sender<WebResponse>,
 263     response: WebResponse
 264   | {
 265     reply_to.send(response)
 266       .unwrap_or_else(|_: WebResponse| () /* oh dear */ /* xxx trace? */);
 267   };
 268
 269   loop {
 270     if let Some(ret) = {
 271       if ! downbound.is_empty() {
 272         outstanding.pop_front()
 273       } else if let Some((i,_)) = outstanding.iter().enumerate().find({
 274         |(_,o)| outstanding.len() > o.oi.target_requests_outstanding.sat()
 275       }) {
 276         Some(outstanding.remove(i).unwrap())
 277       } else {
 278         None
 279       }
 280     } {
 281       let response = WebResponse {
 282         data: Ok(vec![ /* xxx */ ]),
 283         warnings: default(),
 284       };
 285
 286       dbg!(&response);
 287       try_send_response(ret.reply_to, response);
 288     }
 289
 290     select!{
 291       req = web.recv() =>
 292       {
 293         let WebRequest {
 294           initial, initial_remaining, length_hint, mut body,
 295           boundary_finder,
 296           reply_to, mut warnings,
 297         } = req.ok_or_else(|| anyhow!("webservers all shut down!"))?;
 298
 299         match async {
 300
 301           let initial_used = initial.len() - initial_remaining;
 302
 303           let whole_request = read_limited_bytes(
 304             ic.max_batch_up.sat(),
 305             initial,
 306             length_hint,
 307             &mut body
 308           ).await.context("read request body")?;
 309
 310           let (meta, mut comps) =
 311             multipart::ComponentIterator::resume_mid_component(
 312               &whole_request[initial_used..],
 313               boundary_finder
 314             ).context("resume parsing body, after auth checks")?;
 315
 316           let mut meta = MetadataFieldIterator::new(&meta);
 317
 318           macro_rules! meta {
 319             { $v:ident, ( $( $badcmp:tt )? ), $ret:expr,
 320               let $server:ident, $client:ident $($code:tt)*
 321             } => {
 322               let $v = (||{
 323                 let $server = ic.$v;
 324                 let $client $($code)*
 325                 $(
 326                   if $client $badcmp $server {
 327                     throw!(anyhow!("mismatch: client={:?} {} server={:?}",
 328                                    $client, stringify!($badcmp), $server));
 329                   }
 330                 )?
 331                 Ok::<_,AE>($ret)
 332               })().context(stringify!($v))?;
 333               dbg!(&$v);
 334             }
 335           }
 336
 337           meta!{
 338             target_requests_outstanding, ( != ), client,
 339             let server, client: u32 = meta.need_parse()?;
 340           }
 341
 342           meta!{
 343             http_timeout, ( > ), client,
 344             let server, client = Duration::from_secs(meta.need_parse()?);
 345           }
 346
 347           meta!{
 348             mtu, ( != ), client,
 349             let server, client: u32 = meta.parse()?.unwrap_or(server);
 350           }
 351
 352           meta!{
 353             max_batch_down, (), min(client, server),
 354             let server, client: u32 = meta.parse()?.unwrap_or(server);
 355           }
 356
 357           meta!{
 358             max_batch_up, ( > ), client,
 359             let server, client = meta.parse()?.unwrap_or(server);
 360           }
 361
 362           while let Some(comp) = comps.next(&mut warnings, PartName::d)? {
 363             if comp.name != PartName::d {
 364               warnings.add(&format_args!("unexpected part {:?}", comp.name))?;
 365             }
 366             checkn(Mime2Slip, mtu, comp.payload, |header| {
 367               let saddr = ip_packet_addr::<false>(header)?;
 368               if saddr != ic.link.client.0 { throw!(PE::Src(saddr)) }
 369               let daddr = ip_packet_addr::<true>(header)?;
 370               Ok(daddr)
 371             }, |(daddr,packet)| route_packet(daddr,packet),
 372                |e| Ok::<_,SlipFramesError<_>>({ warnings.add(&e)?; })
 373             )?;
 374           }
 375
 376           let oi = OutstandingInner {
 377             target_requests_outstanding,
 378           };
 379           Ok::<_,AE>(oi)
 380         }.await {
 381           Ok(oi) => outstanding.push_back(Outstanding { reply_to, oi }),
 382           Err(e) => {
 383             try_send_response(reply_to, WebResponse {
 384               data: Err(e),
 385               warnings,
 386             });
 387           },
 388         }
 389       }
 390     }
 391   }
 392   //Err(anyhow!("xxx"))
 393 }
 394
 395 #[tokio::main]
 396 async fn main() {
 397   let opts = Opts::from_args();
 398   let mut tasks: Vec<(
 399     JoinHandle<AE>,
 400     String,
 401   )> = vec![];
 402
 403   let (global, ipif) = config::startup(
 404     "hippotatd", LinkEnd::Server,
 405     &opts.config, &opts.log, |ics|
 406   {
 407     let global = config::InstanceConfigGlobal::from(&ics);
 408     let ipif = Ipif::start(&global.ipif, None)?;
 409
 410     let all_clients: AllClients = ics.into_iter().map(|ic| {
 411       let ic = Arc::new(ic);
 412
 413       let (web_send, web_recv) = mpsc::channel(
 414         5 // xxx should me max_requests_outstanding but that's
 415           // marked client-only so needs rework
 416       );
 417
 418       let ic_ = ic.clone();
 419       tasks.push((tokio::spawn(async move {
 420         run_client(ic_, web_recv).await.void_unwrap_err()
 421       }), format!("client {}", &ic)));
 422
 423       (ic.link.client,
 424        ClientHandles {
 425          ic,
 426          web: web_send,
 427        })
 428     }).collect();
 429     let all_clients = Arc::new(all_clients);
 430
 431     for addr in &global.addrs {
 432       let all_clients_ = all_clients.clone();
 433       let make_service = hyper::service::make_service_fn(move |conn| {
 434         let all_clients_ = all_clients_.clone();
 435         let conn = Arc::new(format!("[conn:{:?}]", conn));
 436         async { Ok::<_, Void>( hyper::service::service_fn(move |req| {
 437           handle(conn.clone(), all_clients_.clone(), req)
 438         }) ) } }
 439       );
 440
 441       let addr = SocketAddr::new(*addr, global.port);
 442       let server = hyper::Server::try_bind(&addr)
 443         .context("bind")?
 444         .http1_preserve_header_case(true)
 445         .serve(make_service);
 446       info!("listening on {}", &addr);
 447       let task = tokio::task::spawn(async move {
 448         match server.await {
 449           Ok(()) => anyhow!("shut down?!"),
 450           Err(e) => e.into(),
 451         }
 452       });
 453       tasks.push((task, format!("http server {}", addr)));
 454     }
 455
 456     Ok((global, ipif))
 457   });
 458
 459   let died = future::select_all(
 460     tasks.iter_mut().map(|e| &mut e.0)
 461   ).await;
 462   error!("xxx {:?}", &died);
 463
 464   ipif.quitting(None).await;
 465
 466   dbg!(global);
 467 }