path: root/cms-cgi/src/cgi.rs

// -*- coding: utf-8 -*-
//
// Simple CMS
//
// Copyright (C) 2011-2024 Michael Büsch <m@bues.ch>
//
// Licensed under the Apache License version 2.0
// or the MIT license, at your option.
// SPDX-License-Identifier: Apache-2.0 OR MIT

use anyhow::{self as ah, format_err as err, Context as _};
use cms_ident::Ident;
use cms_seccomp::Filter;
use cms_socket::{CmsSocketConnSync, MsgSerde as _};
use cms_socket_back::{Msg, SOCK_FILE};
use querystrong::QueryStrong;
use std::{
    collections::HashMap,
    env,
    ffi::OsString,
    io::{self, Read as _, Stdout, Write as _},
    path::Path,
    time::Instant,
};

const DEBUG: bool = false;

const MAX_CGIENV_LEN: usize = 1024 * 4;
const MAX_CGIENV_U32_LEN: usize = 10;
const MAX_POST_BODY_LEN: u32 = 1024 * 1024;

fn get_cgienv(name: &str) -> ah::Result<OsString> {
    let value = env::var_os(name).unwrap_or_default();
    if value.len() <= MAX_CGIENV_LEN {
        Ok(value)
    } else {
        Err(err!("Environment variable '{name}' is too long."))
    }
}

fn get_cgienv_str(name: &str) -> ah::Result<String> {
    if let Ok(s) = get_cgienv(name)?.into_string() {
        Ok(s)
    } else {
        Err(err!("Environment variable '{name}' is not valid UTF-8."))
    }
}

fn get_cgienv_u32(name: &str) -> ah::Result<u32> {
    let value = get_cgienv_str(name)?;
    let value = value.trim();
    if value.len() <= MAX_CGIENV_U32_LEN {
        Ok(value.parse::<u32>()?)
    } else {
        Err(err!("Environment variable '{name}' is too long (u32)."))
    }
}

fn get_cgienv_bool(name: &str) -> ah::Result<bool> {
    Ok(get_cgienv_str(name)?.trim() == "on")
}

fn out(f: &mut Stdout, data: &[u8]) {
    f.write_all(data).unwrap();
}

fn outstr(f: &mut Stdout, data: &str) {
    out(f, data.as_bytes());
}

fn response_200_ok(
    body: Option<&[u8]>,
    mime: &str,
    extra_headers: &[String],
    start_stamp: Option<Instant>,
) {
    let mut f = io::stdout();
    outstr(&mut f, &format!("Content-type: {mime}\n"));
    for header in extra_headers {
        outstr(&mut f, &format!("{header}\n"));
    }
    outstr(&mut f, "Status: 200 Ok\n");
    if let Some(start_stamp) = start_stamp {
        let runtime = (Instant::now() - start_stamp).as_micros();
        outstr(&mut f, &format!("X-CMS-Cgi-Runtime: {runtime} us\n"));
    }
    outstr(&mut f, "\n");
    if let Some(body) = body {
        out(&mut f, body);
    }
}

fn response_400_bad_request(err: &str) {
    let mut f = io::stdout();
    outstr(&mut f, "Content-type: text/plain\n");
    outstr(&mut f, "Status: 400 Bad Request\n");
    outstr(&mut f, "\n");
    outstr(&mut f, err);
}

fn response_500_internal_error(err: &str) {
    let mut f = io::stdout();
    outstr(&mut f, "Content-type: text/plain\n");
    outstr(&mut f, "Status: 500 Internal Server Error\n");
    outstr(&mut f, "\n");
    outstr(&mut f, err);
}

fn response_notok(status: u32, body: Option<&[u8]>, mime: &str) {
    let mut f = io::stdout();
    outstr(&mut f, &format!("Content-type: {mime}\n"));
    outstr(&mut f, &format!("Status: {status}\n"));
    outstr(&mut f, "\n");
    if let Some(body) = body {
        out(&mut f, body);
    }
}

pub struct Cgi {
    query: String,
    meth: String,
    path: String,
    body_len: u32,
    body_type: String,
    https: bool,
    host: String,
    cookie: OsString,
    backend: CmsSocketConnSync,
    start_stamp: Option<Instant>,
}

impl Cgi {
    pub fn new(rundir: &Path) -> ah::Result<Self> {
        let start_stamp = if DEBUG { Some(Instant::now()) } else { None };

        let sock_path = rundir.join(SOCK_FILE);
        let Ok(backend) = CmsSocketConnSync::connect(&sock_path) else {
            response_500_internal_error("Backend connection failed.");
            return Err(err!("Backend connection failed."));
        };

        // Install seccomp filter.
        // See build.rs for the filter definition.
        {
            Filter::deserialize(include_bytes!(concat!(
                env!("OUT_DIR"),
                "/seccomp_filter.bpf"
            )))
            .install()
            .context("Install seccomp filter")?;
        }

        let query = get_cgienv_str("QUERY_STRING").unwrap_or_default();
        let meth = get_cgienv_str("REQUEST_METHOD")?.trim().to_string();
        let path = get_cgienv_str("PATH_INFO").unwrap_or_default();
        let body_len = get_cgienv_u32("CONTENT_LENGTH").unwrap_or_default();
        let body_type = get_cgienv_str("CONTENT_TYPE").unwrap_or_default();
        let https = get_cgienv_bool("HTTPS")?;
        let host = get_cgienv_str("HTTP_HOST").unwrap_or_default();
        let cookie = get_cgienv("HTTP_COOKIE")?;

        Ok(Self {
            query,
            meth,
            path,
            body_len,
            body_type,
            https,
            host,
            cookie,
            backend,
            start_stamp,
        })
    }

    pub fn run(&mut self) {
        let Ok(path) = self.path.parse::<Ident>();
        let Ok(path) = path.into_checked_sys() else {
            response_400_bad_request("URI path contains invalid chars.");
            return;
        };

        let Ok(q) = QueryStrong::parse(&self.query) else {
            response_400_bad_request("Invalid QUERY_STRING in URI.");
            return;
        };
        let mut query = HashMap::with_capacity(q.len());
        if let Some(q) = q.as_map() {
            for (n, v) in q {
                if let querystrong::Value::String(v) = v {
                    query.insert(n.to_string(), v.as_bytes().to_vec());
                }
            }
        }

        match &self.meth[..] {
            "GET" | "HEAD" => {
                let request = Msg::Get {
                    host: self.host.clone(),
                    path: path.downgrade(),
                    https: self.https,
                    cookie: self.cookie.as_encoded_bytes().to_vec(),
                    query,
                };
                if self.backend.send_msg(&request).is_err() {
                    response_500_internal_error("Backend send failed.");
                    return;
                }
            }
            "POST" => {
                if self.body_len == 0 {
                    response_400_bad_request("POST: CONTENT_LENGTH is zero.");
                    return;
                }
                if self.body_len > MAX_POST_BODY_LEN {
                    response_400_bad_request("POST: CONTENT_LENGTH is too large.");
                    return;
                }
                if self.body_type.is_empty() {
                    response_400_bad_request("POST: Invalid CONTENT_TYPE.");
                    return;
                }

                let mut body = vec![0; self.body_len.try_into().unwrap()];
                if io::stdin().read_exact(&mut body).is_err() {
                    response_500_internal_error("CGI stdin read failed.");
                    return;
                }

                let request = Msg::Post {
                    host: self.host.clone(),
                    path: path.downgrade(),
                    https: self.https,
                    cookie: self.cookie.as_encoded_bytes().to_vec(),
                    query,
                    body,
                    body_mime: self.body_type.clone(),
                };
                if self.backend.send_msg(&request).is_err() {
                    response_500_internal_error("Backend send failed.");
                    return;
                }
            }
            _ => {
                let meth = &self.meth;
                response_400_bad_request(&format!("Unsupported REQUEST_METHOD: '{meth}'"));
                return;
            }
        }

        let msg = self.backend.recv_msg(Msg::try_msg_deserialize);
        match msg {
            Ok(Some(Msg::Reply {
                status,
                body,
                mime,
                extra_headers,
            })) => {
                let body = if self.meth == "HEAD" {
                    None
                } else {
                    Some(&body[..])
                };
                match status {
                    200 => response_200_ok(body, &mime, &extra_headers, self.start_stamp),
                    status => response_notok(status, body, &mime),
                }
            }
            Ok(Some(Msg::Get { .. })) | Ok(Some(Msg::Post { .. })) => {
                response_500_internal_error("Invalid backend message received.");
            }
            Ok(None) => {
                response_500_internal_error("Backend disconnected.");
            }
            Err(_) => {
                response_500_internal_error("Backend receive error.");
            }
        }
    }
}

// vim: ts=4 sw=4 expandtab