tyler
/
proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
proxmox-backup/proxmox-rest-server/examples/minimal-rest-server.rs

230 lines
5.6 KiB
Rust
Raw Normal View History

proxmox-rest-server: use new ServerAdapter trait instead of callbacks Async callbacks are a PITA, so we now pass a single trait object which implements check_auth and get_index.
2021-10-05 09:01:05 +00:00
use std::sync::Mutex;
examples: add example for a simple rest server with a small api show how to generally start a daemon that serves a rest api + index page api calls are (prefixed with either /api2/json or /api2/extjs): / GET listing /ping GET returns "pong" /items GET lists existing items POST lets user create new items /items/{id} GET returns the content of a single item PUT updates an item DELETE deletes an item Contains a small dummy user/authinfo Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-29 07:04:19 +00:00
use std::collections::HashMap;
proxmox-rest-server: make check_auth async
2021-10-01 05:29:11 +00:00
use std::future::Future;
use std::pin::Pin;
examples: add example for a simple rest server with a small api show how to generally start a daemon that serves a rest api + index page api calls are (prefixed with either /api2/json or /api2/extjs): / GET listing /ping GET returns "pong" /items GET lists existing items POST lets user create new items /items/{id} GET returns the content of a single item PUT updates an item DELETE deletes an item Contains a small dummy user/authinfo Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-29 07:04:19 +00:00
use anyhow::{bail, format_err, Error};
use lazy_static::lazy_static;
proxmox-rest-server: use new ServerAdapter trait instead of callbacks Async callbacks are a PITA, so we now pass a single trait object which implements check_auth and get_index.
2021-10-05 09:01:05 +00:00
use hyper::{Body, Response, Method};
use http::request::Parts;
use http::HeaderMap;
examples: add example for a simple rest server with a small api show how to generally start a daemon that serves a rest api + index page api calls are (prefixed with either /api2/json or /api2/extjs): / GET listing /ping GET returns "pong" /items GET lists existing items POST lets user create new items /items/{id} GET returns the content of a single item PUT updates an item DELETE deletes an item Contains a small dummy user/authinfo Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-29 07:04:19 +00:00
update to first proxmox crate split Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
2021-10-08 09:19:37 +00:00
use proxmox_schema::api;
use proxmox_router::{list_subdirs_api_method, SubdirMap, Router, RpcEnvironmentType, UserInformation};
proxmox-rest-server: use new ServerAdapter trait instead of callbacks Async callbacks are a PITA, so we now pass a single trait object which implements check_auth and get_index.
2021-10-05 09:01:05 +00:00
use proxmox_rest_server::{ServerAdapter, ApiConfig, AuthError, RestServer, RestEnvironment};
// Create a Dummy User information system
examples: add example for a simple rest server with a small api show how to generally start a daemon that serves a rest api + index page api calls are (prefixed with either /api2/json or /api2/extjs): / GET listing /ping GET returns "pong" /items GET lists existing items POST lets user create new items /items/{id} GET returns the content of a single item PUT updates an item DELETE deletes an item Contains a small dummy user/authinfo Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-29 07:04:19 +00:00
struct DummyUserInfo;
impl UserInformation for DummyUserInfo {
fn is_superuser(&self, _userid: &str) -> bool {
proxmox-rest-server: use new ServerAdapter trait instead of callbacks Async callbacks are a PITA, so we now pass a single trait object which implements check_auth and get_index.
2021-10-05 09:01:05 +00:00
// Always return true here, so we have access to everthing
examples: add example for a simple rest server with a small api show how to generally start a daemon that serves a rest api + index page api calls are (prefixed with either /api2/json or /api2/extjs): / GET listing /ping GET returns "pong" /items GET lists existing items POST lets user create new items /items/{id} GET returns the content of a single item PUT updates an item DELETE deletes an item Contains a small dummy user/authinfo Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-29 07:04:19 +00:00
true
}
fn is_group_member(&self, _userid: &str, group: &str) -> bool {
group == "Group"
}
fn lookup_privs(&self, _userid: &str, _path: &[&str]) -> u64 {
u64::MAX
}
}
proxmox-rest-server: use new ServerAdapter trait instead of callbacks Async callbacks are a PITA, so we now pass a single trait object which implements check_auth and get_index.
2021-10-05 09:01:05 +00:00
struct MinimalServer;
// implement the server adapter
impl ServerAdapter for MinimalServer {
examples: add example for a simple rest server with a small api show how to generally start a daemon that serves a rest api + index page api calls are (prefixed with either /api2/json or /api2/extjs): / GET listing /ping GET returns "pong" /items GET lists existing items POST lets user create new items /items/{id} GET returns the content of a single item PUT updates an item DELETE deletes an item Contains a small dummy user/authinfo Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-29 07:04:19 +00:00
proxmox-rest-server: use new ServerAdapter trait instead of callbacks Async callbacks are a PITA, so we now pass a single trait object which implements check_auth and get_index.
2021-10-05 09:01:05 +00:00
// normally this would check and authenticate the user
fn check_auth(
&self,
_headers: &HeaderMap,
_method: &Method,
) -> Pin<Box<dyn Future<Output = Result<(String, Box<dyn UserInformation + Sync + Send>), AuthError>> + Send>> {
proxmox-rest-server: make check_auth async
2021-10-01 05:29:11 +00:00
Box::pin(async move {
// get some global/cached userinfo
let userinfo: Box<dyn UserInformation + Sync + Send> = Box::new(DummyUserInfo);
// Do some user checks, e.g. cookie/csrf
Ok(("User".to_string(), userinfo))
})
examples: add example for a simple rest server with a small api show how to generally start a daemon that serves a rest api + index page api calls are (prefixed with either /api2/json or /api2/extjs): / GET listing /ping GET returns "pong" /items GET lists existing items POST lets user create new items /items/{id} GET returns the content of a single item PUT updates an item DELETE deletes an item Contains a small dummy user/authinfo Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-29 07:04:19 +00:00
}
proxmox-rest-server: use new ServerAdapter trait instead of callbacks Async callbacks are a PITA, so we now pass a single trait object which implements check_auth and get_index.
2021-10-05 09:01:05 +00:00
// this should return the index page of the webserver
// iow. what the user browses to
fn get_index(
&self,
_env: RestEnvironment,
_parts: Parts,
) -> Pin<Box<dyn Future<Output = Response<Body>> + Send>> {
Box::pin(async move {
// build an index page
http::Response::builder()
.body("hello world".into())
.unwrap()
})
}
examples: add example for a simple rest server with a small api show how to generally start a daemon that serves a rest api + index page api calls are (prefixed with either /api2/json or /api2/extjs): / GET listing /ping GET returns "pong" /items GET lists existing items POST lets user create new items /items/{id} GET returns the content of a single item PUT updates an item DELETE deletes an item Contains a small dummy user/authinfo Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-29 07:04:19 +00:00
}
// a few examples on how to do api calls with the Router
#[api]
/// A simple ping method. returns "pong"
fn ping() -> Result<String, Error> {
Ok("pong".to_string())
}
lazy_static! {
static ref ITEM_MAP: Mutex<HashMap<String, String>> = Mutex::new(HashMap::new());
}
#[api]
/// Lists all current items
fn list_items() -> Result<Vec<String>, Error> {
misc clippy fixes the trivial ones ;) Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
2022-02-08 13:57:16 +00:00
Ok(ITEM_MAP.lock().unwrap().keys().cloned().collect())
examples: add example for a simple rest server with a small api show how to generally start a daemon that serves a rest api + index page api calls are (prefixed with either /api2/json or /api2/extjs): / GET listing /ping GET returns "pong" /items GET lists existing items POST lets user create new items /items/{id} GET returns the content of a single item PUT updates an item DELETE deletes an item Contains a small dummy user/authinfo Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-29 07:04:19 +00:00
}
#[api(
input: {
properties: {
name: {
type: String,
description: "The name",
},
value: {
type: String,
description: "The value",
},
},
},
)]
/// creates a new item
fn create_item(name: String, value: String) -> Result<(), Error> {
let mut map = ITEM_MAP.lock().unwrap();
if map.contains_key(&name) {
bail!("{} already exists", name);
}
map.insert(name, value);
Ok(())
}
#[api(
input: {
properties: {
name: {
type: String,
description: "The name",
},
},
},
)]
/// returns the value of an item
fn get_item(name: String) -> Result<String, Error> {
ITEM_MAP.lock().unwrap().get(&name).map(|s| s.to_string()).ok_or_else(|| format_err!("no such item '{}'", name))
}
#[api(
input: {
properties: {
name: {
type: String,
description: "The name",
},
value: {
type: String,
description: "The value",
},
},
},
)]
/// updates an item
fn update_item(name: String, value: String) -> Result<(), Error> {
if let Some(val) = ITEM_MAP.lock().unwrap().get_mut(&name) {
*val = value;
} else {
bail!("no such item '{}'", name);
}
Ok(())
}
#[api(
input: {
properties: {
name: {
type: String,
description: "The name",
},
},
},
)]
/// deletes an item
fn delete_item(name: String) -> Result<(), Error> {
if ITEM_MAP.lock().unwrap().remove(&name).is_none() {
bail!("no such item '{}'", name);
}
Ok(())
}
const ITEM_ROUTER: Router = Router::new()
.get(&API_METHOD_GET_ITEM)
.put(&API_METHOD_UPDATE_ITEM)
.delete(&API_METHOD_DELETE_ITEM);
const SUBDIRS: SubdirMap = &[
(
"items",
&Router::new()
.get(&API_METHOD_LIST_ITEMS)
.post(&API_METHOD_CREATE_ITEM)
.match_all("name", &ITEM_ROUTER)
),
(
"ping",
&Router::new()
.get(&API_METHOD_PING)
),
];
const ROUTER: Router = Router::new()
.get(&list_subdirs_api_method!(SUBDIRS))
.subdirs(SUBDIRS);
async fn run() -> Result<(), Error> {
// we first have to configure the api environment (basedir etc.)
let config = ApiConfig::new(
"/var/tmp/",
&ROUTER,
RpcEnvironmentType::PUBLIC,
proxmox-rest-server: use new ServerAdapter trait instead of callbacks Async callbacks are a PITA, so we now pass a single trait object which implements check_auth and get_index.
2021-10-05 09:01:05 +00:00
MinimalServer,
examples: add example for a simple rest server with a small api show how to generally start a daemon that serves a rest api + index page api calls are (prefixed with either /api2/json or /api2/extjs): / GET listing /ping GET returns "pong" /items GET lists existing items POST lets user create new items /items/{id} GET returns the content of a single item PUT updates an item DELETE deletes an item Contains a small dummy user/authinfo Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-29 07:04:19 +00:00
)?;
let rest_server = RestServer::new(config);
// then we have to create a daemon that listens, accepts and serves
// the api to clients
proxmox_rest_server::daemon::create_daemon(
([127, 0, 0, 1], 65000).into(),
daemon: simlify code (make it easier to use)
2021-09-29 09:21:32 +00:00
move |listener| {
examples: add example for a simple rest server with a small api show how to generally start a daemon that serves a rest api + index page api calls are (prefixed with either /api2/json or /api2/extjs): / GET listing /ping GET returns "pong" /items GET lists existing items POST lets user create new items /items/{id} GET returns the content of a single item PUT updates an item DELETE deletes an item Contains a small dummy user/authinfo Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-29 07:04:19 +00:00
let incoming = hyper::server::conn::AddrIncoming::from_listener(listener)?;
daemon: simlify code (make it easier to use)
2021-09-29 09:21:32 +00:00
Ok(async move {
hyper::Server::builder(incoming)
examples: add example for a simple rest server with a small api show how to generally start a daemon that serves a rest api + index page api calls are (prefixed with either /api2/json or /api2/extjs): / GET listing /ping GET returns "pong" /items GET lists existing items POST lets user create new items /items/{id} GET returns the content of a single item PUT updates an item DELETE deletes an item Contains a small dummy user/authinfo Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-29 07:04:19 +00:00
.serve(rest_server)
daemon: simlify code (make it easier to use)
2021-09-29 09:21:32 +00:00
.await?;
Ok(())
})
examples: add example for a simple rest server with a small api show how to generally start a daemon that serves a rest api + index page api calls are (prefixed with either /api2/json or /api2/extjs): / GET listing /ping GET returns "pong" /items GET lists existing items POST lets user create new items /items/{id} GET returns the content of a single item PUT updates an item DELETE deletes an item Contains a small dummy user/authinfo Signed-off-by: Dominik Csapak <d.csapak@proxmox.com> Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-09-29 07:04:19 +00:00
},
).await?;
Ok(())
}
fn main() -> Result<(), Error> {
let rt = tokio::runtime::Runtime::new()?;
rt.block_on(async { run().await })
}