admin.rs 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805
  1. use once_cell::sync::Lazy;
  2. use serde::de::DeserializeOwned;
  3. use serde_json::Value;
  4. use std::env;
  5. use rocket::serde::json::Json;
  6. use rocket::{
  7. form::Form,
  8. http::{Cookie, CookieJar, MediaType, SameSite, Status},
  9. request::{FromRequest, Outcome, Request},
  10. response::{content::RawHtml as Html, Redirect},
  11. Catcher, Route,
  12. };
  13. use crate::{
  14. api::{core::log_event, unregister_push_device, ApiResult, EmptyResult, JsonResult, Notify, NumberOrString},
  15. auth::{decode_admin, encode_jwt, generate_admin_claims, ClientIp},
  16. config::ConfigBuilder,
  17. db::{backup_database, get_sql_server_version, models::*, DbConn, DbConnType},
  18. error::{Error, MapResult},
  19. mail,
  20. util::{
  21. docker_base_image, format_naive_datetime_local, get_display_size, get_reqwest_client, is_running_in_docker,
  22. },
  23. CONFIG, VERSION,
  24. };
  25. pub fn routes() -> Vec<Route> {
  26. if !CONFIG.disable_admin_token() && !CONFIG.is_admin_token_set() {
  27. return routes![admin_disabled];
  28. }
  29. routes![
  30. get_users_json,
  31. get_user_json,
  32. get_user_by_mail_json,
  33. post_admin_login,
  34. admin_page,
  35. admin_page_login,
  36. invite_user,
  37. logout,
  38. delete_user,
  39. deauth_user,
  40. disable_user,
  41. enable_user,
  42. remove_2fa,
  43. update_user_org_type,
  44. update_revision_users,
  45. post_config,
  46. delete_config,
  47. backup_db,
  48. test_smtp,
  49. users_overview,
  50. organizations_overview,
  51. delete_organization,
  52. diagnostics,
  53. get_diagnostics_config,
  54. resend_user_invite,
  55. ]
  56. }
  57. pub fn catchers() -> Vec<Catcher> {
  58. if !CONFIG.disable_admin_token() && !CONFIG.is_admin_token_set() {
  59. catchers![]
  60. } else {
  61. catchers![admin_login]
  62. }
  63. }
  64. static DB_TYPE: Lazy<&str> = Lazy::new(|| {
  65. DbConnType::from_url(&CONFIG.database_url())
  66. .map(|t| match t {
  67. DbConnType::sqlite => "SQLite",
  68. DbConnType::mysql => "MySQL",
  69. DbConnType::postgresql => "PostgreSQL",
  70. })
  71. .unwrap_or("Unknown")
  72. });
  73. static CAN_BACKUP: Lazy<bool> =
  74. Lazy::new(|| DbConnType::from_url(&CONFIG.database_url()).map(|t| t == DbConnType::sqlite).unwrap_or(false));
  75. #[get("/")]
  76. fn admin_disabled() -> &'static str {
  77. "The admin panel is disabled, please configure the 'ADMIN_TOKEN' variable to enable it"
  78. }
  79. const COOKIE_NAME: &str = "VW_ADMIN";
  80. const ADMIN_PATH: &str = "/admin";
  81. const DT_FMT: &str = "%Y-%m-%d %H:%M:%S %Z";
  82. const BASE_TEMPLATE: &str = "admin/base";
  83. const ACTING_ADMIN_USER: &str = "vaultwarden-admin-00000-000000000000";
  84. fn admin_path() -> String {
  85. format!("{}{}", CONFIG.domain_path(), ADMIN_PATH)
  86. }
  87. #[derive(Debug)]
  88. struct IpHeader(Option<String>);
  89. #[rocket::async_trait]
  90. impl<'r> FromRequest<'r> for IpHeader {
  91. type Error = ();
  92. async fn from_request(req: &'r Request<'_>) -> Outcome<Self, Self::Error> {
  93. if req.headers().get_one(&CONFIG.ip_header()).is_some() {
  94. Outcome::Success(IpHeader(Some(CONFIG.ip_header())))
  95. } else if req.headers().get_one("X-Client-IP").is_some() {
  96. Outcome::Success(IpHeader(Some(String::from("X-Client-IP"))))
  97. } else if req.headers().get_one("X-Real-IP").is_some() {
  98. Outcome::Success(IpHeader(Some(String::from("X-Real-IP"))))
  99. } else if req.headers().get_one("X-Forwarded-For").is_some() {
  100. Outcome::Success(IpHeader(Some(String::from("X-Forwarded-For"))))
  101. } else {
  102. Outcome::Success(IpHeader(None))
  103. }
  104. }
  105. }
  106. fn admin_url() -> String {
  107. format!("{}{}", CONFIG.domain_origin(), admin_path())
  108. }
  109. #[derive(Responder)]
  110. enum AdminResponse {
  111. #[response(status = 200)]
  112. Ok(ApiResult<Html<String>>),
  113. #[response(status = 401)]
  114. Unauthorized(ApiResult<Html<String>>),
  115. #[response(status = 429)]
  116. TooManyRequests(ApiResult<Html<String>>),
  117. }
  118. #[catch(401)]
  119. fn admin_login(request: &Request<'_>) -> ApiResult<Html<String>> {
  120. if request.format() == Some(&MediaType::JSON) {
  121. err_code!("Authorization failed.", Status::Unauthorized.code);
  122. }
  123. let redirect = request.segments::<std::path::PathBuf>(0..).unwrap_or_default().display().to_string();
  124. render_admin_login(None, Some(redirect))
  125. }
  126. fn render_admin_login(msg: Option<&str>, redirect: Option<String>) -> ApiResult<Html<String>> {
  127. // If there is an error, show it
  128. let msg = msg.map(|msg| format!("Error: {msg}"));
  129. let json = json!({
  130. "page_content": "admin/login",
  131. "error": msg,
  132. "redirect": redirect,
  133. "urlpath": CONFIG.domain_path()
  134. });
  135. // Return the page
  136. let text = CONFIG.render_template(BASE_TEMPLATE, &json)?;
  137. Ok(Html(text))
  138. }
  139. #[derive(FromForm)]
  140. struct LoginForm {
  141. token: String,
  142. redirect: Option<String>,
  143. }
  144. #[post("/", data = "<data>")]
  145. fn post_admin_login(data: Form<LoginForm>, cookies: &CookieJar<'_>, ip: ClientIp) -> Result<Redirect, AdminResponse> {
  146. let data = data.into_inner();
  147. let redirect = data.redirect;
  148. if crate::ratelimit::check_limit_admin(&ip.ip).is_err() {
  149. return Err(AdminResponse::TooManyRequests(render_admin_login(
  150. Some("Too many requests, try again later."),
  151. redirect,
  152. )));
  153. }
  154. // If the token is invalid, redirect to login page
  155. if !_validate_token(&data.token) {
  156. error!("Invalid admin token. IP: {}", ip.ip);
  157. Err(AdminResponse::Unauthorized(render_admin_login(Some("Invalid admin token, please try again."), redirect)))
  158. } else {
  159. // If the token received is valid, generate JWT and save it as a cookie
  160. let claims = generate_admin_claims();
  161. let jwt = encode_jwt(&claims);
  162. let cookie = Cookie::build((COOKIE_NAME, jwt))
  163. .path(admin_path())
  164. .max_age(rocket::time::Duration::minutes(CONFIG.admin_session_lifetime()))
  165. .same_site(SameSite::Strict)
  166. .http_only(true);
  167. cookies.add(cookie);
  168. if let Some(redirect) = redirect {
  169. Ok(Redirect::to(format!("{}{}", admin_path(), redirect)))
  170. } else {
  171. Err(AdminResponse::Ok(render_admin_page()))
  172. }
  173. }
  174. }
  175. fn _validate_token(token: &str) -> bool {
  176. match CONFIG.admin_token().as_ref() {
  177. None => false,
  178. Some(t) if t.starts_with("$argon2") => {
  179. use argon2::password_hash::PasswordVerifier;
  180. match argon2::password_hash::PasswordHash::new(t) {
  181. Ok(h) => {
  182. // NOTE: hash params from `ADMIN_TOKEN` are used instead of what is configured in the `Argon2` instance.
  183. argon2::Argon2::default().verify_password(token.trim().as_ref(), &h).is_ok()
  184. }
  185. Err(e) => {
  186. error!("The configured Argon2 PHC in `ADMIN_TOKEN` is invalid: {e}");
  187. false
  188. }
  189. }
  190. }
  191. Some(t) => crate::crypto::ct_eq(t.trim(), token.trim()),
  192. }
  193. }
  194. #[derive(Serialize)]
  195. struct AdminTemplateData {
  196. page_content: String,
  197. page_data: Option<Value>,
  198. logged_in: bool,
  199. urlpath: String,
  200. }
  201. impl AdminTemplateData {
  202. fn new(page_content: &str, page_data: Value) -> Self {
  203. Self {
  204. page_content: String::from(page_content),
  205. page_data: Some(page_data),
  206. logged_in: true,
  207. urlpath: CONFIG.domain_path(),
  208. }
  209. }
  210. fn render(self) -> Result<String, Error> {
  211. CONFIG.render_template(BASE_TEMPLATE, &self)
  212. }
  213. }
  214. fn render_admin_page() -> ApiResult<Html<String>> {
  215. let settings_json = json!({
  216. "config": CONFIG.prepare_json(),
  217. "can_backup": *CAN_BACKUP,
  218. });
  219. let text = AdminTemplateData::new("admin/settings", settings_json).render()?;
  220. Ok(Html(text))
  221. }
  222. #[get("/")]
  223. fn admin_page(_token: AdminToken) -> ApiResult<Html<String>> {
  224. render_admin_page()
  225. }
  226. #[get("/", rank = 2)]
  227. fn admin_page_login() -> ApiResult<Html<String>> {
  228. render_admin_login(None, None)
  229. }
  230. #[derive(Deserialize, Debug)]
  231. #[allow(non_snake_case)]
  232. struct InviteData {
  233. email: String,
  234. }
  235. async fn get_user_or_404(uuid: &str, conn: &mut DbConn) -> ApiResult<User> {
  236. if let Some(user) = User::find_by_uuid(uuid, conn).await {
  237. Ok(user)
  238. } else {
  239. err_code!("User doesn't exist", Status::NotFound.code);
  240. }
  241. }
  242. #[post("/invite", data = "<data>")]
  243. async fn invite_user(data: Json<InviteData>, _token: AdminToken, mut conn: DbConn) -> JsonResult {
  244. let data: InviteData = data.into_inner();
  245. if User::find_by_mail(&data.email, &mut conn).await.is_some() {
  246. err_code!("User already exists", Status::Conflict.code)
  247. }
  248. let mut user = User::new(data.email);
  249. async fn _generate_invite(user: &User, conn: &mut DbConn) -> EmptyResult {
  250. if CONFIG.mail_enabled() {
  251. mail::send_invite(&user.email, &user.uuid, None, None, &CONFIG.invitation_org_name(), None).await
  252. } else {
  253. let invitation = Invitation::new(&user.email);
  254. invitation.save(conn).await
  255. }
  256. }
  257. _generate_invite(&user, &mut conn).await.map_err(|e| e.with_code(Status::InternalServerError.code))?;
  258. user.save(&mut conn).await.map_err(|e| e.with_code(Status::InternalServerError.code))?;
  259. Ok(Json(user.to_json(&mut conn).await))
  260. }
  261. #[post("/test/smtp", data = "<data>")]
  262. async fn test_smtp(data: Json<InviteData>, _token: AdminToken) -> EmptyResult {
  263. let data: InviteData = data.into_inner();
  264. if CONFIG.mail_enabled() {
  265. mail::send_test(&data.email).await
  266. } else {
  267. err!("Mail is not enabled")
  268. }
  269. }
  270. #[get("/logout")]
  271. fn logout(cookies: &CookieJar<'_>) -> Redirect {
  272. cookies.remove(Cookie::build(COOKIE_NAME).path(admin_path()));
  273. Redirect::to(admin_path())
  274. }
  275. #[get("/users")]
  276. async fn get_users_json(_token: AdminToken, mut conn: DbConn) -> Json<Value> {
  277. let users = User::get_all(&mut conn).await;
  278. let mut users_json = Vec::with_capacity(users.len());
  279. for u in users {
  280. let mut usr = u.to_json(&mut conn).await;
  281. usr["UserEnabled"] = json!(u.enabled);
  282. usr["CreatedAt"] = json!(format_naive_datetime_local(&u.created_at, DT_FMT));
  283. usr["LastActive"] = match u.last_active(&mut conn).await {
  284. Some(dt) => json!(format_naive_datetime_local(&dt, DT_FMT)),
  285. None => json!(None::<String>),
  286. };
  287. users_json.push(usr);
  288. }
  289. Json(Value::Array(users_json))
  290. }
  291. #[get("/users/overview")]
  292. async fn users_overview(_token: AdminToken, mut conn: DbConn) -> ApiResult<Html<String>> {
  293. let users = User::get_all(&mut conn).await;
  294. let mut users_json = Vec::with_capacity(users.len());
  295. for u in users {
  296. let mut usr = u.to_json(&mut conn).await;
  297. usr["cipher_count"] = json!(Cipher::count_owned_by_user(&u.uuid, &mut conn).await);
  298. usr["attachment_count"] = json!(Attachment::count_by_user(&u.uuid, &mut conn).await);
  299. usr["attachment_size"] = json!(get_display_size(Attachment::size_by_user(&u.uuid, &mut conn).await as i32));
  300. usr["user_enabled"] = json!(u.enabled);
  301. usr["created_at"] = json!(format_naive_datetime_local(&u.created_at, DT_FMT));
  302. usr["last_active"] = match u.last_active(&mut conn).await {
  303. Some(dt) => json!(format_naive_datetime_local(&dt, DT_FMT)),
  304. None => json!("Never"),
  305. };
  306. users_json.push(usr);
  307. }
  308. let text = AdminTemplateData::new("admin/users", json!(users_json)).render()?;
  309. Ok(Html(text))
  310. }
  311. #[get("/users/by-mail/<mail>")]
  312. async fn get_user_by_mail_json(mail: &str, _token: AdminToken, mut conn: DbConn) -> JsonResult {
  313. if let Some(u) = User::find_by_mail(mail, &mut conn).await {
  314. let mut usr = u.to_json(&mut conn).await;
  315. usr["UserEnabled"] = json!(u.enabled);
  316. usr["CreatedAt"] = json!(format_naive_datetime_local(&u.created_at, DT_FMT));
  317. Ok(Json(usr))
  318. } else {
  319. err_code!("User doesn't exist", Status::NotFound.code);
  320. }
  321. }
  322. #[get("/users/<uuid>")]
  323. async fn get_user_json(uuid: &str, _token: AdminToken, mut conn: DbConn) -> JsonResult {
  324. let u = get_user_or_404(uuid, &mut conn).await?;
  325. let mut usr = u.to_json(&mut conn).await;
  326. usr["UserEnabled"] = json!(u.enabled);
  327. usr["CreatedAt"] = json!(format_naive_datetime_local(&u.created_at, DT_FMT));
  328. Ok(Json(usr))
  329. }
  330. #[post("/users/<uuid>/delete")]
  331. async fn delete_user(uuid: &str, token: AdminToken, mut conn: DbConn) -> EmptyResult {
  332. let user = get_user_or_404(uuid, &mut conn).await?;
  333. // Get the user_org records before deleting the actual user
  334. let user_orgs = UserOrganization::find_any_state_by_user(uuid, &mut conn).await;
  335. let res = user.delete(&mut conn).await;
  336. for user_org in user_orgs {
  337. log_event(
  338. EventType::OrganizationUserRemoved as i32,
  339. &user_org.uuid,
  340. &user_org.org_uuid,
  341. String::from(ACTING_ADMIN_USER),
  342. 14, // Use UnknownBrowser type
  343. &token.ip.ip,
  344. &mut conn,
  345. )
  346. .await;
  347. }
  348. res
  349. }
  350. #[post("/users/<uuid>/deauth")]
  351. async fn deauth_user(uuid: &str, _token: AdminToken, mut conn: DbConn, nt: Notify<'_>) -> EmptyResult {
  352. let mut user = get_user_or_404(uuid, &mut conn).await?;
  353. nt.send_logout(&user, None).await;
  354. if CONFIG.push_enabled() {
  355. for device in Device::find_push_devices_by_user(&user.uuid, &mut conn).await {
  356. match unregister_push_device(device.uuid).await {
  357. Ok(r) => r,
  358. Err(e) => error!("Unable to unregister devices from Bitwarden server: {}", e),
  359. };
  360. }
  361. }
  362. Device::delete_all_by_user(&user.uuid, &mut conn).await?;
  363. user.reset_security_stamp();
  364. user.save(&mut conn).await
  365. }
  366. #[post("/users/<uuid>/disable")]
  367. async fn disable_user(uuid: &str, _token: AdminToken, mut conn: DbConn, nt: Notify<'_>) -> EmptyResult {
  368. let mut user = get_user_or_404(uuid, &mut conn).await?;
  369. Device::delete_all_by_user(&user.uuid, &mut conn).await?;
  370. user.reset_security_stamp();
  371. user.enabled = false;
  372. let save_result = user.save(&mut conn).await;
  373. nt.send_logout(&user, None).await;
  374. save_result
  375. }
  376. #[post("/users/<uuid>/enable")]
  377. async fn enable_user(uuid: &str, _token: AdminToken, mut conn: DbConn) -> EmptyResult {
  378. let mut user = get_user_or_404(uuid, &mut conn).await?;
  379. user.enabled = true;
  380. user.save(&mut conn).await
  381. }
  382. #[post("/users/<uuid>/remove-2fa")]
  383. async fn remove_2fa(uuid: &str, _token: AdminToken, mut conn: DbConn) -> EmptyResult {
  384. let mut user = get_user_or_404(uuid, &mut conn).await?;
  385. TwoFactor::delete_all_by_user(&user.uuid, &mut conn).await?;
  386. user.totp_recover = None;
  387. user.save(&mut conn).await
  388. }
  389. #[post("/users/<uuid>/invite/resend")]
  390. async fn resend_user_invite(uuid: &str, _token: AdminToken, mut conn: DbConn) -> EmptyResult {
  391. if let Some(user) = User::find_by_uuid(uuid, &mut conn).await {
  392. //TODO: replace this with user.status check when it will be available (PR#3397)
  393. if !user.password_hash.is_empty() {
  394. err_code!("User already accepted invitation", Status::BadRequest.code);
  395. }
  396. if CONFIG.mail_enabled() {
  397. mail::send_invite(&user.email, &user.uuid, None, None, &CONFIG.invitation_org_name(), None).await
  398. } else {
  399. Ok(())
  400. }
  401. } else {
  402. err_code!("User doesn't exist", Status::NotFound.code);
  403. }
  404. }
  405. #[derive(Deserialize, Debug)]
  406. struct UserOrgTypeData {
  407. user_type: NumberOrString,
  408. user_uuid: String,
  409. org_uuid: String,
  410. }
  411. #[post("/users/org_type", data = "<data>")]
  412. async fn update_user_org_type(data: Json<UserOrgTypeData>, token: AdminToken, mut conn: DbConn) -> EmptyResult {
  413. let data: UserOrgTypeData = data.into_inner();
  414. let mut user_to_edit =
  415. match UserOrganization::find_by_user_and_org(&data.user_uuid, &data.org_uuid, &mut conn).await {
  416. Some(user) => user,
  417. None => err!("The specified user isn't member of the organization"),
  418. };
  419. let new_type = match UserOrgType::from_str(&data.user_type.into_string()) {
  420. Some(new_type) => new_type as i32,
  421. None => err!("Invalid type"),
  422. };
  423. if user_to_edit.atype == UserOrgType::Owner && new_type != UserOrgType::Owner {
  424. // Removing owner permission, check that there is at least one other confirmed owner
  425. if UserOrganization::count_confirmed_by_org_and_type(&data.org_uuid, UserOrgType::Owner, &mut conn).await <= 1 {
  426. err!("Can't change the type of the last owner")
  427. }
  428. }
  429. // This check is also done at api::organizations::{accept_invite(), _confirm_invite, _activate_user(), edit_user()}, update_user_org_type
  430. // It returns different error messages per function.
  431. if new_type < UserOrgType::Admin {
  432. match OrgPolicy::is_user_allowed(&user_to_edit.user_uuid, &user_to_edit.org_uuid, true, &mut conn).await {
  433. Ok(_) => {}
  434. Err(OrgPolicyErr::TwoFactorMissing) => {
  435. err!("You cannot modify this user to this type because it has no two-step login method activated");
  436. }
  437. Err(OrgPolicyErr::SingleOrgEnforced) => {
  438. err!("You cannot modify this user to this type because it is a member of an organization which forbids it");
  439. }
  440. }
  441. }
  442. log_event(
  443. EventType::OrganizationUserUpdated as i32,
  444. &user_to_edit.uuid,
  445. &data.org_uuid,
  446. String::from(ACTING_ADMIN_USER),
  447. 14, // Use UnknownBrowser type
  448. &token.ip.ip,
  449. &mut conn,
  450. )
  451. .await;
  452. user_to_edit.atype = new_type;
  453. user_to_edit.save(&mut conn).await
  454. }
  455. #[post("/users/update_revision")]
  456. async fn update_revision_users(_token: AdminToken, mut conn: DbConn) -> EmptyResult {
  457. User::update_all_revisions(&mut conn).await
  458. }
  459. #[get("/organizations/overview")]
  460. async fn organizations_overview(_token: AdminToken, mut conn: DbConn) -> ApiResult<Html<String>> {
  461. let organizations = Organization::get_all(&mut conn).await;
  462. let mut organizations_json = Vec::with_capacity(organizations.len());
  463. for o in organizations {
  464. let mut org = o.to_json();
  465. org["user_count"] = json!(UserOrganization::count_by_org(&o.uuid, &mut conn).await);
  466. org["cipher_count"] = json!(Cipher::count_by_org(&o.uuid, &mut conn).await);
  467. org["collection_count"] = json!(Collection::count_by_org(&o.uuid, &mut conn).await);
  468. org["group_count"] = json!(Group::count_by_org(&o.uuid, &mut conn).await);
  469. org["event_count"] = json!(Event::count_by_org(&o.uuid, &mut conn).await);
  470. org["attachment_count"] = json!(Attachment::count_by_org(&o.uuid, &mut conn).await);
  471. org["attachment_size"] = json!(get_display_size(Attachment::size_by_org(&o.uuid, &mut conn).await as i32));
  472. organizations_json.push(org);
  473. }
  474. let text = AdminTemplateData::new("admin/organizations", json!(organizations_json)).render()?;
  475. Ok(Html(text))
  476. }
  477. #[post("/organizations/<uuid>/delete")]
  478. async fn delete_organization(uuid: &str, _token: AdminToken, mut conn: DbConn) -> EmptyResult {
  479. let org = Organization::find_by_uuid(uuid, &mut conn).await.map_res("Organization doesn't exist")?;
  480. org.delete(&mut conn).await
  481. }
  482. #[derive(Deserialize)]
  483. struct WebVaultVersion {
  484. version: String,
  485. }
  486. #[derive(Deserialize)]
  487. struct GitRelease {
  488. tag_name: String,
  489. }
  490. #[derive(Deserialize)]
  491. struct GitCommit {
  492. sha: String,
  493. }
  494. #[derive(Deserialize)]
  495. struct TimeApi {
  496. year: u16,
  497. month: u8,
  498. day: u8,
  499. hour: u8,
  500. minute: u8,
  501. seconds: u8,
  502. }
  503. async fn get_json_api<T: DeserializeOwned>(url: &str) -> Result<T, Error> {
  504. let json_api = get_reqwest_client();
  505. Ok(json_api.get(url).send().await?.error_for_status()?.json::<T>().await?)
  506. }
  507. async fn has_http_access() -> bool {
  508. let http_access = get_reqwest_client();
  509. match http_access.head("https://github.com/dani-garcia/vaultwarden").send().await {
  510. Ok(r) => r.status().is_success(),
  511. _ => false,
  512. }
  513. }
  514. use cached::proc_macro::cached;
  515. /// Cache this function to prevent API call rate limit. Github only allows 60 requests per hour, and we use 3 here already.
  516. /// It will cache this function for 300 seconds (5 minutes) which should prevent the exhaustion of the rate limit.
  517. #[cached(time = 300, sync_writes = true)]
  518. async fn get_release_info(has_http_access: bool, running_within_docker: bool) -> (String, String, String) {
  519. // If the HTTP Check failed, do not even attempt to check for new versions since we were not able to connect with github.com anyway.
  520. if has_http_access {
  521. (
  522. match get_json_api::<GitRelease>("https://api.github.com/repos/dani-garcia/vaultwarden/releases/latest")
  523. .await
  524. {
  525. Ok(r) => r.tag_name,
  526. _ => "-".to_string(),
  527. },
  528. match get_json_api::<GitCommit>("https://api.github.com/repos/dani-garcia/vaultwarden/commits/main").await {
  529. Ok(mut c) => {
  530. c.sha.truncate(8);
  531. c.sha
  532. }
  533. _ => "-".to_string(),
  534. },
  535. // Do not fetch the web-vault version when running within Docker.
  536. // The web-vault version is embedded within the container it self, and should not be updated manually
  537. if running_within_docker {
  538. "-".to_string()
  539. } else {
  540. match get_json_api::<GitRelease>(
  541. "https://api.github.com/repos/dani-garcia/bw_web_builds/releases/latest",
  542. )
  543. .await
  544. {
  545. Ok(r) => r.tag_name.trim_start_matches('v').to_string(),
  546. _ => "-".to_string(),
  547. }
  548. },
  549. )
  550. } else {
  551. ("-".to_string(), "-".to_string(), "-".to_string())
  552. }
  553. }
  554. async fn get_ntp_time(has_http_access: bool) -> String {
  555. if has_http_access {
  556. if let Ok(ntp_time) = get_json_api::<TimeApi>("https://www.timeapi.io/api/Time/current/zone?timeZone=UTC").await
  557. {
  558. return format!(
  559. "{year}-{month:02}-{day:02} {hour:02}:{minute:02}:{seconds:02} UTC",
  560. year = ntp_time.year,
  561. month = ntp_time.month,
  562. day = ntp_time.day,
  563. hour = ntp_time.hour,
  564. minute = ntp_time.minute,
  565. seconds = ntp_time.seconds
  566. );
  567. }
  568. }
  569. String::from("Unable to fetch NTP time.")
  570. }
  571. #[get("/diagnostics")]
  572. async fn diagnostics(_token: AdminToken, ip_header: IpHeader, mut conn: DbConn) -> ApiResult<Html<String>> {
  573. use chrono::prelude::*;
  574. use std::net::ToSocketAddrs;
  575. // Get current running versions
  576. let web_vault_version: WebVaultVersion =
  577. match std::fs::read_to_string(format!("{}/{}", CONFIG.web_vault_folder(), "vw-version.json")) {
  578. Ok(s) => serde_json::from_str(&s)?,
  579. _ => match std::fs::read_to_string(format!("{}/{}", CONFIG.web_vault_folder(), "version.json")) {
  580. Ok(s) => serde_json::from_str(&s)?,
  581. _ => WebVaultVersion {
  582. version: String::from("Version file missing"),
  583. },
  584. },
  585. };
  586. // Execute some environment checks
  587. let running_within_docker = is_running_in_docker();
  588. let has_http_access = has_http_access().await;
  589. let uses_proxy = env::var_os("HTTP_PROXY").is_some()
  590. || env::var_os("http_proxy").is_some()
  591. || env::var_os("HTTPS_PROXY").is_some()
  592. || env::var_os("https_proxy").is_some();
  593. // Check if we are able to resolve DNS entries
  594. let dns_resolved = match ("github.com", 0).to_socket_addrs().map(|mut i| i.next()) {
  595. Ok(Some(a)) => a.ip().to_string(),
  596. _ => "Unable to resolve domain name.".to_string(),
  597. };
  598. let (latest_release, latest_commit, latest_web_build) =
  599. get_release_info(has_http_access, running_within_docker).await;
  600. let ip_header_name = match &ip_header.0 {
  601. Some(h) => h,
  602. _ => "",
  603. };
  604. let diagnostics_json = json!({
  605. "dns_resolved": dns_resolved,
  606. "current_release": VERSION,
  607. "latest_release": latest_release,
  608. "latest_commit": latest_commit,
  609. "web_vault_enabled": &CONFIG.web_vault_enabled(),
  610. "web_vault_version": web_vault_version.version.trim_start_matches('v'),
  611. "latest_web_build": latest_web_build,
  612. "running_within_docker": running_within_docker,
  613. "docker_base_image": if running_within_docker { docker_base_image() } else { "Not applicable" },
  614. "has_http_access": has_http_access,
  615. "ip_header_exists": &ip_header.0.is_some(),
  616. "ip_header_match": ip_header_name == CONFIG.ip_header(),
  617. "ip_header_name": ip_header_name,
  618. "ip_header_config": &CONFIG.ip_header(),
  619. "uses_proxy": uses_proxy,
  620. "db_type": *DB_TYPE,
  621. "db_version": get_sql_server_version(&mut conn).await,
  622. "admin_url": format!("{}/diagnostics", admin_url()),
  623. "overrides": &CONFIG.get_overrides().join(", "),
  624. "host_arch": std::env::consts::ARCH,
  625. "host_os": std::env::consts::OS,
  626. "server_time_local": Local::now().format("%Y-%m-%d %H:%M:%S %Z").to_string(),
  627. "server_time": Utc::now().format("%Y-%m-%d %H:%M:%S UTC").to_string(), // Run the server date/time check as late as possible to minimize the time difference
  628. "ntp_time": get_ntp_time(has_http_access).await, // Run the ntp check as late as possible to minimize the time difference
  629. });
  630. let text = AdminTemplateData::new("admin/diagnostics", diagnostics_json).render()?;
  631. Ok(Html(text))
  632. }
  633. #[get("/diagnostics/config")]
  634. fn get_diagnostics_config(_token: AdminToken) -> Json<Value> {
  635. let support_json = CONFIG.get_support_json();
  636. Json(support_json)
  637. }
  638. #[post("/config", data = "<data>")]
  639. fn post_config(data: Json<ConfigBuilder>, _token: AdminToken) -> EmptyResult {
  640. let data: ConfigBuilder = data.into_inner();
  641. CONFIG.update_config(data)
  642. }
  643. #[post("/config/delete")]
  644. fn delete_config(_token: AdminToken) -> EmptyResult {
  645. CONFIG.delete_user_config()
  646. }
  647. #[post("/config/backup_db")]
  648. async fn backup_db(_token: AdminToken, mut conn: DbConn) -> EmptyResult {
  649. if *CAN_BACKUP {
  650. backup_database(&mut conn).await
  651. } else {
  652. err!("Can't back up current DB (Only SQLite supports this feature)");
  653. }
  654. }
  655. pub struct AdminToken {
  656. ip: ClientIp,
  657. }
  658. #[rocket::async_trait]
  659. impl<'r> FromRequest<'r> for AdminToken {
  660. type Error = &'static str;
  661. async fn from_request(request: &'r Request<'_>) -> Outcome<Self, Self::Error> {
  662. let ip = match ClientIp::from_request(request).await {
  663. Outcome::Success(ip) => ip,
  664. _ => err_handler!("Error getting Client IP"),
  665. };
  666. if CONFIG.disable_admin_token() {
  667. Outcome::Success(Self {
  668. ip,
  669. })
  670. } else {
  671. let cookies = request.cookies();
  672. let access_token = match cookies.get(COOKIE_NAME) {
  673. Some(cookie) => cookie.value(),
  674. None => {
  675. let requested_page =
  676. request.segments::<std::path::PathBuf>(0..).unwrap_or_default().display().to_string();
  677. // When the requested page is empty, it is `/admin`, in that case, Forward, so it will render the login page
  678. // Else, return a 401 failure, which will be caught
  679. if requested_page.is_empty() {
  680. return Outcome::Forward(Status::Unauthorized);
  681. } else {
  682. return Outcome::Error((Status::Unauthorized, "Unauthorized"));
  683. }
  684. }
  685. };
  686. if decode_admin(access_token).is_err() {
  687. // Remove admin cookie
  688. cookies.remove(Cookie::build(COOKIE_NAME).path(admin_path()));
  689. error!("Invalid or expired admin JWT. IP: {}.", &ip.ip);
  690. return Outcome::Error((Status::Unauthorized, "Session expired"));
  691. }
  692. Outcome::Success(Self {
  693. ip,
  694. })
  695. }
  696. }
  697. }