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
|
//! A plug and play http interface layer for various lockchain components
//!
//! The way this is done is by shimming a common REST interface (via actix-web) in
//! between common `lockchain-core` types and the `lockchain-client` library which
//! is a base wrapper around `reqwest` which uses this API.
//!
//! You can of course also use whatever other library, in whatever language you want
//! to access this API. Doing so via the *official* client gives you the ability to
//! negotiate version numbers and have more advanced error handling built-in.
//!
//! Ideally this shim-layer version should be the same as the `lockchain-core` it binds
//! against, however especially during development this won't always be the case.
//!
//! **Note**: API endpoint documentation can be found
//! [here](https://github.com/spacekookie/lockchain/tree/master/lockchain-http#api-reference)
#![feature(core_intrinsics)]
#[macro_use]
extern crate serde_derive;
extern crate env_logger;
extern crate serde;
extern crate actix_web;
extern crate lockchain_core as lockchain;
mod handlers;
pub mod models;
pub mod state;
use actix_web::{http, server, App};
use lockchain::traits::{Body, Vault};
use state::ApiState;
use std::error::Error;
use std::sync::{Arc, Mutex};
/// A simple rename of the long generic types that are returned for a new server
pub type HttpApi<V> = server::HttpServer<App<Arc<Mutex<V>>>>;
/// Create a new lockchain-http server for a vault state
///
/// Lifetime wise, vault needs to long as long as the server, which is returned to
/// call `run()` on. Make sure this is done in a thread, to not block your
/// mainapplication context
///
/// Additionally, provide a address bind and port string to bind to.
///
/// ## Example
///
/// ```norun
/// use lockchain_core::{traits::*, EncryptedBody};
/// use lockchain_http::create_server;
/// use lockchain_files::DataVault;
///
/// let server = create_server(
/// "localhost",
/// "8080",
/// DataVault::<EncryptedBody>::new("name", "some-location"),
/// ).run();
/// ```
pub fn create_server<B, V>(
bind: &str,
port: &str,
state: ApiState<B, V>,
) -> Result<HttpApi<ApiState<B, V>>, Box<Error>>
where
B: Body + 'static,
V: Vault<B> + 'static,
{
let state = Arc::new(Mutex::new(state));
server::new(move || {
vec![
App::with_state(Arc::clone(&state))
.resource("/vaults", |r| {
// Get existing vaults
r.method(http::Method::GET).with(handlers::get_vaults);
// Create new vault (if authorised)
r.method(http::Method::PUT).with(handlers::create_vault);
// Delete entire vault (if authorised)
r.method(http::Method::DELETE).with(handlers::delete_vault);
})
.resource("/vaults/scope", |r| {
// Bring an existing vault into scope (if authorised)
r.method(http::Method::PUT).with(handlers::scope_vault);
// Remove an existing vault from API scope (if authorised)
r.method(http::Method::DELETE).with(handlers::unscope_vault);
})
.resource("/vaults/{vaultid}", |r| {
// Update vault metadata (access rights, users, indices, etc)
r.method(http::Method::POST).with(handlers::update_vault)
})
.resource("/vaults/{vaultid}/records", |r| {
// Get the vault record index (omits records without access)
r.method(http::Method::GET).with(handlers::get_all_records);
// Create a new record (if authorised) in the vault
r.method(http::Method::PUT).with(handlers::create_record);
})
.resource("/vaults/{vaultid}/records/{recordid}", |r| {
// Get a specific record from a vault
r.method(http::Method::GET).with(handlers::get_record);
// Update a specific record
r.method(http::Method::POST).with(handlers::update_record);
// Delete a specific record from a vault
r.method(http::Method::DELETE).with(handlers::delete_record);
})
.resource("/users/login", |r| {
// Request a new auth token
r.method(http::Method::POST).with(handlers::authenticate)
})
.resource("/users/logout", |r| {
// Hand-in active auth token
r.method(http::Method::POST).with(handlers::deauthenticate)
})
.resource("/api", |r| {
r.method(http::Method::GET).with(handlers::api_data);
}),
]
}).bind(format!("{}:{}", bind, port))
.map_err(|e| e.into())
}
|
