2018-11-15 09:14:08 +00:00
|
|
|
use std::collections::HashMap;
|
2020-07-21 09:10:36 +00:00
|
|
|
use std::path::PathBuf;
|
|
|
|
|
use std::time::SystemTime;
|
|
|
|
|
use std::fs::metadata;
|
2020-11-02 18:21:58 +00:00
|
|
|
use std::sync::{Arc, Mutex, RwLock};
|
2021-10-01 07:38:10 +00:00
|
|
|
use std::future::Future;
|
|
|
|
|
use std::pin::Pin;
|
2018-11-15 09:14:08 +00:00
|
|
|
|
2020-07-21 09:10:36 +00:00
|
|
|
use anyhow::{bail, Error, format_err};
|
2021-09-21 05:58:47 +00:00
|
|
|
use hyper::{Method, Body, Response};
|
|
|
|
|
use hyper::http::request::Parts;
|
|
|
|
|
|
2020-04-29 09:59:31 +00:00
|
|
|
use handlebars::Handlebars;
|
2020-07-21 09:10:36 +00:00
|
|
|
use serde::Serialize;
|
2018-11-15 09:14:08 +00:00
|
|
|
|
2019-11-21 13:36:28 +00:00
|
|
|
use proxmox::api::{ApiMethod, Router, RpcEnvironmentType};
|
2020-10-16 09:06:46 +00:00
|
|
|
use proxmox::tools::fs::{create_path, CreateOptions};
|
|
|
|
|
|
2021-09-30 10:31:38 +00:00
|
|
|
use crate::{ApiAuth, FileLogger, FileLogOptions, CommandSocket};
|
2019-11-21 13:36:28 +00:00
|
|
|
|
2021-10-01 07:38:10 +00:00
|
|
|
pub type GetIndexFn = &'static (dyn for<'a> Fn(Option<String>, Option<String>, &'a ApiConfig, Parts) -> Pin<Box<dyn Future<Output = Response<Body>> + Send + 'a>> + Send + Sync);
|
2021-09-21 05:58:47 +00:00
|
|
|
|
2021-09-30 09:59:21 +00:00
|
|
|
/// REST server configuration
|
2018-11-15 09:14:08 +00:00
|
|
|
pub struct ApiConfig {
|
|
|
|
|
basedir: PathBuf,
|
2018-11-15 10:46:13 +00:00
|
|
|
router: &'static Router,
|
2018-11-15 09:14:08 +00:00
|
|
|
aliases: HashMap<String, PathBuf>,
|
2019-01-28 12:17:03 +00:00
|
|
|
env_type: RpcEnvironmentType,
|
2020-07-21 09:10:36 +00:00
|
|
|
templates: RwLock<Handlebars<'static>>,
|
|
|
|
|
template_files: RwLock<HashMap<String, (SystemTime, PathBuf)>>,
|
2020-11-02 18:21:58 +00:00
|
|
|
request_log: Option<Arc<Mutex<FileLogger>>>,
|
2021-09-21 05:58:50 +00:00
|
|
|
auth_log: Option<Arc<Mutex<FileLogger>>>,
|
2021-09-30 09:59:21 +00:00
|
|
|
pub(crate) api_auth: Arc<dyn ApiAuth + Send + Sync>,
|
2021-09-21 05:58:47 +00:00
|
|
|
get_index_fn: GetIndexFn,
|
2018-11-15 09:14:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl ApiConfig {
|
2021-09-30 09:59:21 +00:00
|
|
|
/// Creates a new instance
|
|
|
|
|
///
|
|
|
|
|
/// `basedir` - File lookups are relative to this directory.
|
|
|
|
|
///
|
|
|
|
|
/// `router` - The REST API definition.
|
|
|
|
|
///
|
|
|
|
|
/// `env_type` - The environment type.
|
|
|
|
|
///
|
2021-10-01 04:43:30 +00:00
|
|
|
/// `api_auth` - The Authentication handler
|
2021-09-30 09:59:21 +00:00
|
|
|
///
|
|
|
|
|
/// `get_index_fn` - callback to generate the root page
|
|
|
|
|
/// (index). Please note that this fuctions gets a reference to
|
|
|
|
|
/// the [ApiConfig], so it can use [Handlebars] templates
|
|
|
|
|
/// ([render_template](Self::render_template) to generate pages.
|
2021-03-31 10:21:51 +00:00
|
|
|
pub fn new<B: Into<PathBuf>>(
|
|
|
|
|
basedir: B,
|
|
|
|
|
router: &'static Router,
|
|
|
|
|
env_type: RpcEnvironmentType,
|
|
|
|
|
api_auth: Arc<dyn ApiAuth + Send + Sync>,
|
2021-09-21 05:58:47 +00:00
|
|
|
get_index_fn: GetIndexFn,
|
2021-03-31 10:21:51 +00:00
|
|
|
) -> Result<Self, Error> {
|
2020-04-29 09:59:31 +00:00
|
|
|
Ok(Self {
|
2020-07-21 09:10:36 +00:00
|
|
|
basedir: basedir.into(),
|
2019-09-11 10:06:59 +00:00
|
|
|
router,
|
2018-11-15 09:14:08 +00:00
|
|
|
aliases: HashMap::new(),
|
2019-01-28 12:17:03 +00:00
|
|
|
env_type,
|
2020-07-21 09:10:36 +00:00
|
|
|
templates: RwLock::new(Handlebars::new()),
|
|
|
|
|
template_files: RwLock::new(HashMap::new()),
|
2020-10-16 09:06:46 +00:00
|
|
|
request_log: None,
|
2021-09-21 05:58:50 +00:00
|
|
|
auth_log: None,
|
2021-03-31 10:21:51 +00:00
|
|
|
api_auth,
|
2021-09-21 05:58:47 +00:00
|
|
|
get_index_fn,
|
2021-03-31 10:21:51 +00:00
|
|
|
})
|
2018-11-15 09:14:08 +00:00
|
|
|
}
|
|
|
|
|
|
2021-10-01 07:38:10 +00:00
|
|
|
pub(crate) async fn get_index(
|
2021-09-21 05:58:47 +00:00
|
|
|
&self,
|
|
|
|
|
auth_id: Option<String>,
|
|
|
|
|
language: Option<String>,
|
|
|
|
|
parts: Parts,
|
|
|
|
|
) -> Response<Body> {
|
2021-10-01 07:38:10 +00:00
|
|
|
(self.get_index_fn)(auth_id, language, self, parts).await
|
2021-09-21 05:58:47 +00:00
|
|
|
}
|
|
|
|
|
|
2021-09-30 09:59:21 +00:00
|
|
|
pub(crate) fn find_method(
|
2019-11-21 08:36:41 +00:00
|
|
|
&self,
|
|
|
|
|
components: &[&str],
|
|
|
|
|
method: Method,
|
|
|
|
|
uri_param: &mut HashMap<String, String>,
|
|
|
|
|
) -> Option<&'static ApiMethod> {
|
2018-11-15 09:14:08 +00:00
|
|
|
|
2019-05-07 09:08:30 +00:00
|
|
|
self.router.find_method(components, method, uri_param)
|
2018-11-15 09:14:08 +00:00
|
|
|
}
|
|
|
|
|
|
2021-09-30 09:59:21 +00:00
|
|
|
pub(crate) fn find_alias(&self, components: &[&str]) -> PathBuf {
|
2018-11-15 09:14:08 +00:00
|
|
|
|
|
|
|
|
let mut prefix = String::new();
|
|
|
|
|
let mut filename = self.basedir.clone();
|
|
|
|
|
let comp_len = components.len();
|
|
|
|
|
if comp_len >= 1 {
|
|
|
|
|
prefix.push_str(components[0]);
|
|
|
|
|
if let Some(subdir) = self.aliases.get(&prefix) {
|
|
|
|
|
filename.push(subdir);
|
2021-01-19 14:03:04 +00:00
|
|
|
components.iter().skip(1).for_each(|comp| filename.push(comp));
|
2018-12-01 14:21:25 +00:00
|
|
|
} else {
|
2021-01-19 14:03:04 +00:00
|
|
|
components.iter().for_each(|comp| filename.push(comp));
|
2018-11-15 09:14:08 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
filename
|
|
|
|
|
}
|
|
|
|
|
|
2021-09-30 09:59:21 +00:00
|
|
|
/// Register a path alias
|
|
|
|
|
///
|
|
|
|
|
/// This can be used to redirect file lookups to a specific
|
|
|
|
|
/// directory, e.g.:
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use proxmox_rest_server::ApiConfig;
|
|
|
|
|
/// // let mut config = ApiConfig::new(...);
|
|
|
|
|
/// # fn fake(config: &mut ApiConfig) {
|
|
|
|
|
/// config.add_alias("extjs", "/usr/share/javascript/extjs");
|
|
|
|
|
/// # }
|
|
|
|
|
/// ```
|
2018-11-15 09:14:08 +00:00
|
|
|
pub fn add_alias<S, P>(&mut self, alias: S, path: P)
|
|
|
|
|
where S: Into<String>,
|
|
|
|
|
P: Into<PathBuf>,
|
|
|
|
|
{
|
|
|
|
|
self.aliases.insert(alias.into(), path.into());
|
|
|
|
|
}
|
2019-01-28 12:17:03 +00:00
|
|
|
|
2021-09-30 09:59:21 +00:00
|
|
|
pub(crate) fn env_type(&self) -> RpcEnvironmentType {
|
2019-01-28 12:17:03 +00:00
|
|
|
self.env_type
|
|
|
|
|
}
|
2020-07-21 09:10:36 +00:00
|
|
|
|
2021-09-30 09:59:21 +00:00
|
|
|
/// Register a [Handlebars] template file
|
|
|
|
|
///
|
|
|
|
|
/// Those templates cane be use with [render_template](Self::render_template) to generate pages.
|
2020-07-21 09:10:36 +00:00
|
|
|
pub fn register_template<P>(&self, name: &str, path: P) -> Result<(), Error>
|
|
|
|
|
where
|
|
|
|
|
P: Into<PathBuf>
|
|
|
|
|
{
|
|
|
|
|
if self.template_files.read().unwrap().contains_key(name) {
|
|
|
|
|
bail!("template already registered");
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let path: PathBuf = path.into();
|
|
|
|
|
let metadata = metadata(&path)?;
|
|
|
|
|
let mtime = metadata.modified()?;
|
|
|
|
|
|
|
|
|
|
self.templates.write().unwrap().register_template_file(name, &path)?;
|
|
|
|
|
self.template_files.write().unwrap().insert(name.to_string(), (mtime, path));
|
|
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Checks if the template was modified since the last rendering
|
|
|
|
|
/// if yes, it loads a the new version of the template
|
|
|
|
|
pub fn render_template<T>(&self, name: &str, data: &T) -> Result<String, Error>
|
|
|
|
|
where
|
|
|
|
|
T: Serialize,
|
|
|
|
|
{
|
|
|
|
|
let path;
|
|
|
|
|
let mtime;
|
|
|
|
|
{
|
|
|
|
|
let template_files = self.template_files.read().unwrap();
|
|
|
|
|
let (old_mtime, old_path) = template_files.get(name).ok_or_else(|| format_err!("template not found"))?;
|
|
|
|
|
|
|
|
|
|
mtime = metadata(old_path)?.modified()?;
|
|
|
|
|
if mtime <= *old_mtime {
|
|
|
|
|
return self.templates.read().unwrap().render(name, data).map_err(|err| format_err!("{}", err));
|
|
|
|
|
}
|
|
|
|
|
path = old_path.to_path_buf();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
let mut template_files = self.template_files.write().unwrap();
|
|
|
|
|
let mut templates = self.templates.write().unwrap();
|
|
|
|
|
|
|
|
|
|
templates.register_template_file(name, &path)?;
|
|
|
|
|
template_files.insert(name.to_string(), (mtime, path));
|
|
|
|
|
|
|
|
|
|
templates.render(name, data).map_err(|err| format_err!("{}", err))
|
|
|
|
|
}
|
|
|
|
|
}
|
2020-10-16 09:06:46 +00:00
|
|
|
|
2021-09-30 09:59:21 +00:00
|
|
|
/// Enable the access log feature
|
|
|
|
|
///
|
|
|
|
|
/// When enabled, all requests are logged to the specified file.
|
|
|
|
|
/// This function also registers a `api-access-log-reopen`
|
2021-09-30 10:31:38 +00:00
|
|
|
/// command one the [CommandSocket].
|
2021-09-30 09:59:21 +00:00
|
|
|
pub fn enable_access_log<P>(
|
2020-11-02 18:21:58 +00:00
|
|
|
&mut self,
|
|
|
|
|
path: P,
|
2021-09-21 05:58:40 +00:00
|
|
|
dir_opts: Option<CreateOptions>,
|
|
|
|
|
file_opts: Option<CreateOptions>,
|
2021-09-30 10:31:38 +00:00
|
|
|
commando_sock: &mut CommandSocket,
|
2020-11-02 18:21:58 +00:00
|
|
|
) -> Result<(), Error>
|
2020-10-16 09:06:46 +00:00
|
|
|
where
|
|
|
|
|
P: Into<PathBuf>
|
|
|
|
|
{
|
|
|
|
|
let path: PathBuf = path.into();
|
|
|
|
|
if let Some(base) = path.parent() {
|
|
|
|
|
if !base.exists() {
|
2021-09-21 05:58:40 +00:00
|
|
|
create_path(base, None, dir_opts).map_err(|err| format_err!("{}", err))?;
|
2020-10-16 09:06:46 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let logger_options = FileLogOptions {
|
|
|
|
|
append: true,
|
2021-09-21 05:58:40 +00:00
|
|
|
file_opts: file_opts.unwrap_or(CreateOptions::default()),
|
2020-10-16 09:06:46 +00:00
|
|
|
..Default::default()
|
|
|
|
|
};
|
2020-11-02 18:21:58 +00:00
|
|
|
let request_log = Arc::new(Mutex::new(FileLogger::new(&path, logger_options)?));
|
|
|
|
|
self.request_log = Some(Arc::clone(&request_log));
|
|
|
|
|
|
|
|
|
|
commando_sock.register_command("api-access-log-reopen".into(), move |_args| {
|
2021-09-21 05:58:50 +00:00
|
|
|
println!("re-opening access-log file");
|
2020-11-02 18:21:58 +00:00
|
|
|
request_log.lock().unwrap().reopen()?;
|
|
|
|
|
Ok(serde_json::Value::Null)
|
|
|
|
|
})?;
|
2020-10-16 09:06:46 +00:00
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
|
}
|
2020-11-02 18:21:58 +00:00
|
|
|
|
2021-10-01 04:43:30 +00:00
|
|
|
/// Enable the authentication log feature
|
2021-09-30 09:59:21 +00:00
|
|
|
///
|
2021-10-01 04:43:30 +00:00
|
|
|
/// When enabled, all authentication requests are logged to the
|
2021-09-30 09:59:21 +00:00
|
|
|
/// specified file. This function also registers a
|
2021-09-30 10:31:38 +00:00
|
|
|
/// `api-auth-log-reopen` command one the [CommandSocket].
|
2021-09-21 05:58:50 +00:00
|
|
|
pub fn enable_auth_log<P>(
|
|
|
|
|
&mut self,
|
|
|
|
|
path: P,
|
|
|
|
|
dir_opts: Option<CreateOptions>,
|
|
|
|
|
file_opts: Option<CreateOptions>,
|
2021-09-30 10:31:38 +00:00
|
|
|
commando_sock: &mut CommandSocket,
|
2021-09-21 05:58:50 +00:00
|
|
|
) -> Result<(), Error>
|
|
|
|
|
where
|
|
|
|
|
P: Into<PathBuf>
|
|
|
|
|
{
|
|
|
|
|
let path: PathBuf = path.into();
|
|
|
|
|
if let Some(base) = path.parent() {
|
|
|
|
|
if !base.exists() {
|
|
|
|
|
create_path(base, None, dir_opts).map_err(|err| format_err!("{}", err))?;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
let logger_options = FileLogOptions {
|
|
|
|
|
append: true,
|
|
|
|
|
prefix_time: true,
|
|
|
|
|
file_opts: file_opts.unwrap_or(CreateOptions::default()),
|
|
|
|
|
..Default::default()
|
|
|
|
|
};
|
|
|
|
|
let auth_log = Arc::new(Mutex::new(FileLogger::new(&path, logger_options)?));
|
|
|
|
|
self.auth_log = Some(Arc::clone(&auth_log));
|
|
|
|
|
|
|
|
|
|
commando_sock.register_command("api-auth-log-reopen".into(), move |_args| {
|
|
|
|
|
println!("re-opening auth-log file");
|
|
|
|
|
auth_log.lock().unwrap().reopen()?;
|
|
|
|
|
Ok(serde_json::Value::Null)
|
|
|
|
|
})?;
|
|
|
|
|
|
|
|
|
|
Ok(())
|
|
|
|
|
}
|
|
|
|
|
|
2021-09-30 09:59:21 +00:00
|
|
|
pub(crate) fn get_access_log(&self) -> Option<&Arc<Mutex<FileLogger>>> {
|
2020-10-16 09:06:46 +00:00
|
|
|
self.request_log.as_ref()
|
|
|
|
|
}
|
2021-09-21 05:58:50 +00:00
|
|
|
|
2021-09-30 09:59:21 +00:00
|
|
|
pub(crate) fn get_auth_log(&self) -> Option<&Arc<Mutex<FileLogger>>> {
|
2021-09-21 05:58:50 +00:00
|
|
|
self.auth_log.as_ref()
|
|
|
|
|
}
|
2018-11-15 09:14:08 +00:00
|
|
|
}
|
