accounts.rs 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212
  1. use crate::db::DbPool;
  2. use chrono::Utc;
  3. use rocket::serde::json::Json;
  4. use serde_json::Value;
  5. use crate::{
  6. api::{
  7. core::log_user_event, register_push_device, unregister_push_device, AnonymousNotify, EmptyResult, JsonResult,
  8. JsonUpcase, Notify, NumberOrString, PasswordData, UpdateType,
  9. },
  10. auth::{decode_delete, decode_invite, decode_verify_email, ClientHeaders, Headers},
  11. crypto,
  12. db::{models::*, DbConn},
  13. mail, CONFIG,
  14. };
  15. use rocket::{
  16. http::Status,
  17. request::{FromRequest, Outcome, Request},
  18. };
  19. pub fn routes() -> Vec<rocket::Route> {
  20. routes![
  21. register,
  22. profile,
  23. put_profile,
  24. post_profile,
  25. get_public_keys,
  26. post_keys,
  27. post_password,
  28. post_kdf,
  29. post_rotatekey,
  30. post_sstamp,
  31. post_email_token,
  32. post_email,
  33. post_verify_email,
  34. post_verify_email_token,
  35. post_delete_recover,
  36. post_delete_recover_token,
  37. post_device_token,
  38. delete_account,
  39. post_delete_account,
  40. revision_date,
  41. password_hint,
  42. prelogin,
  43. verify_password,
  44. api_key,
  45. rotate_api_key,
  46. get_known_device,
  47. get_known_device_from_path,
  48. put_avatar,
  49. put_device_token,
  50. put_clear_device_token,
  51. post_clear_device_token,
  52. post_auth_request,
  53. get_auth_request,
  54. put_auth_request,
  55. get_auth_request_response,
  56. get_auth_requests,
  57. ]
  58. }
  59. #[derive(Deserialize, Debug)]
  60. #[allow(non_snake_case)]
  61. pub struct RegisterData {
  62. Email: String,
  63. Kdf: Option<i32>,
  64. KdfIterations: Option<i32>,
  65. KdfMemory: Option<i32>,
  66. KdfParallelism: Option<i32>,
  67. Key: String,
  68. Keys: Option<KeysData>,
  69. MasterPasswordHash: String,
  70. MasterPasswordHint: Option<String>,
  71. Name: Option<String>,
  72. Token: Option<String>,
  73. #[allow(dead_code)]
  74. OrganizationUserId: Option<String>,
  75. }
  76. #[derive(Deserialize, Debug)]
  77. #[allow(non_snake_case)]
  78. struct KeysData {
  79. EncryptedPrivateKey: String,
  80. PublicKey: String,
  81. }
  82. /// Trims whitespace from password hints, and converts blank password hints to `None`.
  83. fn clean_password_hint(password_hint: &Option<String>) -> Option<String> {
  84. match password_hint {
  85. None => None,
  86. Some(h) => match h.trim() {
  87. "" => None,
  88. ht => Some(ht.to_string()),
  89. },
  90. }
  91. }
  92. fn enforce_password_hint_setting(password_hint: &Option<String>) -> EmptyResult {
  93. if password_hint.is_some() && !CONFIG.password_hints_allowed() {
  94. err!("Password hints have been disabled by the administrator. Remove the hint and try again.");
  95. }
  96. Ok(())
  97. }
  98. #[post("/accounts/register", data = "<data>")]
  99. async fn register(data: JsonUpcase<RegisterData>, conn: DbConn) -> JsonResult {
  100. _register(data, conn).await
  101. }
  102. pub async fn _register(data: JsonUpcase<RegisterData>, mut conn: DbConn) -> JsonResult {
  103. let data: RegisterData = data.into_inner().data;
  104. let email = data.Email.to_lowercase();
  105. // Check if the length of the username exceeds 50 characters (Same is Upstream Bitwarden)
  106. // This also prevents issues with very long usernames causing to large JWT's. See #2419
  107. if let Some(ref name) = data.Name {
  108. if name.len() > 50 {
  109. err!("The field Name must be a string with a maximum length of 50.");
  110. }
  111. }
  112. // Check against the password hint setting here so if it fails, the user
  113. // can retry without losing their invitation below.
  114. let password_hint = clean_password_hint(&data.MasterPasswordHint);
  115. enforce_password_hint_setting(&password_hint)?;
  116. let mut verified_by_invite = false;
  117. let mut user = match User::find_by_mail(&email, &mut conn).await {
  118. Some(mut user) => {
  119. if !user.password_hash.is_empty() {
  120. err!("Registration not allowed or user already exists")
  121. }
  122. if let Some(token) = data.Token {
  123. let claims = decode_invite(&token)?;
  124. if claims.email == email {
  125. // Verify the email address when signing up via a valid invite token
  126. verified_by_invite = true;
  127. user.verified_at = Some(Utc::now().naive_utc());
  128. user
  129. } else {
  130. err!("Registration email does not match invite email")
  131. }
  132. } else if Invitation::take(&email, &mut conn).await {
  133. for user_org in UserOrganization::find_invited_by_user(&user.uuid, &mut conn).await.iter_mut() {
  134. user_org.status = UserOrgStatus::Accepted as i32;
  135. user_org.save(&mut conn).await?;
  136. }
  137. user
  138. } else if CONFIG.is_signup_allowed(&email)
  139. || EmergencyAccess::find_invited_by_grantee_email(&email, &mut conn).await.is_some()
  140. {
  141. user
  142. } else {
  143. err!("Registration not allowed or user already exists")
  144. }
  145. }
  146. None => {
  147. // Order is important here; the invitation check must come first
  148. // because the vaultwarden admin can invite anyone, regardless
  149. // of other signup restrictions.
  150. if Invitation::take(&email, &mut conn).await || CONFIG.is_signup_allowed(&email) {
  151. User::new(email.clone())
  152. } else {
  153. err!("Registration not allowed or user already exists")
  154. }
  155. }
  156. };
  157. // Make sure we don't leave a lingering invitation.
  158. Invitation::take(&email, &mut conn).await;
  159. if let Some(client_kdf_type) = data.Kdf {
  160. user.client_kdf_type = client_kdf_type;
  161. }
  162. if let Some(client_kdf_iter) = data.KdfIterations {
  163. user.client_kdf_iter = client_kdf_iter;
  164. }
  165. user.client_kdf_memory = data.KdfMemory;
  166. user.client_kdf_parallelism = data.KdfParallelism;
  167. user.set_password(&data.MasterPasswordHash, Some(data.Key), true, None);
  168. user.password_hint = password_hint;
  169. // Add extra fields if present
  170. if let Some(name) = data.Name {
  171. user.name = name;
  172. }
  173. if let Some(keys) = data.Keys {
  174. user.private_key = Some(keys.EncryptedPrivateKey);
  175. user.public_key = Some(keys.PublicKey);
  176. }
  177. if CONFIG.mail_enabled() {
  178. if CONFIG.signups_verify() && !verified_by_invite {
  179. if let Err(e) = mail::send_welcome_must_verify(&user.email, &user.uuid).await {
  180. error!("Error sending welcome email: {:#?}", e);
  181. }
  182. user.last_verifying_at = Some(user.created_at);
  183. } else if let Err(e) = mail::send_welcome(&user.email).await {
  184. error!("Error sending welcome email: {:#?}", e);
  185. }
  186. }
  187. user.save(&mut conn).await?;
  188. Ok(Json(json!({
  189. "Object": "register",
  190. "CaptchaBypassToken": "",
  191. })))
  192. }
  193. #[get("/accounts/profile")]
  194. async fn profile(headers: Headers, mut conn: DbConn) -> Json<Value> {
  195. Json(headers.user.to_json(&mut conn).await)
  196. }
  197. #[derive(Deserialize, Debug)]
  198. #[allow(non_snake_case)]
  199. struct ProfileData {
  200. // Culture: String, // Ignored, always use en-US
  201. // MasterPasswordHint: Option<String>, // Ignored, has been moved to ChangePassData
  202. Name: String,
  203. }
  204. #[put("/accounts/profile", data = "<data>")]
  205. async fn put_profile(data: JsonUpcase<ProfileData>, headers: Headers, conn: DbConn) -> JsonResult {
  206. post_profile(data, headers, conn).await
  207. }
  208. #[post("/accounts/profile", data = "<data>")]
  209. async fn post_profile(data: JsonUpcase<ProfileData>, headers: Headers, mut conn: DbConn) -> JsonResult {
  210. let data: ProfileData = data.into_inner().data;
  211. // Check if the length of the username exceeds 50 characters (Same is Upstream Bitwarden)
  212. // This also prevents issues with very long usernames causing to large JWT's. See #2419
  213. if data.Name.len() > 50 {
  214. err!("The field Name must be a string with a maximum length of 50.");
  215. }
  216. let mut user = headers.user;
  217. user.name = data.Name;
  218. user.save(&mut conn).await?;
  219. Ok(Json(user.to_json(&mut conn).await))
  220. }
  221. #[derive(Deserialize)]
  222. #[allow(non_snake_case)]
  223. struct AvatarData {
  224. AvatarColor: Option<String>,
  225. }
  226. #[put("/accounts/avatar", data = "<data>")]
  227. async fn put_avatar(data: JsonUpcase<AvatarData>, headers: Headers, mut conn: DbConn) -> JsonResult {
  228. let data: AvatarData = data.into_inner().data;
  229. // It looks like it only supports the 6 hex color format.
  230. // If you try to add the short value it will not show that color.
  231. // Check and force 7 chars, including the #.
  232. if let Some(color) = &data.AvatarColor {
  233. if color.len() != 7 {
  234. err!("The field AvatarColor must be a HTML/Hex color code with a length of 7 characters")
  235. }
  236. }
  237. let mut user = headers.user;
  238. user.avatar_color = data.AvatarColor;
  239. user.save(&mut conn).await?;
  240. Ok(Json(user.to_json(&mut conn).await))
  241. }
  242. #[get("/users/<uuid>/public-key")]
  243. async fn get_public_keys(uuid: &str, _headers: Headers, mut conn: DbConn) -> JsonResult {
  244. let user = match User::find_by_uuid(uuid, &mut conn).await {
  245. Some(user) => user,
  246. None => err!("User doesn't exist"),
  247. };
  248. Ok(Json(json!({
  249. "UserId": user.uuid,
  250. "PublicKey": user.public_key,
  251. "Object":"userKey"
  252. })))
  253. }
  254. #[post("/accounts/keys", data = "<data>")]
  255. async fn post_keys(data: JsonUpcase<KeysData>, headers: Headers, mut conn: DbConn) -> JsonResult {
  256. let data: KeysData = data.into_inner().data;
  257. let mut user = headers.user;
  258. user.private_key = Some(data.EncryptedPrivateKey);
  259. user.public_key = Some(data.PublicKey);
  260. user.save(&mut conn).await?;
  261. Ok(Json(json!({
  262. "PrivateKey": user.private_key,
  263. "PublicKey": user.public_key,
  264. "Object":"keys"
  265. })))
  266. }
  267. #[derive(Deserialize)]
  268. #[allow(non_snake_case)]
  269. struct ChangePassData {
  270. MasterPasswordHash: String,
  271. NewMasterPasswordHash: String,
  272. MasterPasswordHint: Option<String>,
  273. Key: String,
  274. }
  275. #[post("/accounts/password", data = "<data>")]
  276. async fn post_password(
  277. data: JsonUpcase<ChangePassData>,
  278. headers: Headers,
  279. mut conn: DbConn,
  280. nt: Notify<'_>,
  281. ) -> EmptyResult {
  282. let data: ChangePassData = data.into_inner().data;
  283. let mut user = headers.user;
  284. if !user.check_valid_password(&data.MasterPasswordHash) {
  285. err!("Invalid password")
  286. }
  287. user.password_hint = clean_password_hint(&data.MasterPasswordHint);
  288. enforce_password_hint_setting(&user.password_hint)?;
  289. log_user_event(EventType::UserChangedPassword as i32, &user.uuid, headers.device.atype, &headers.ip.ip, &mut conn)
  290. .await;
  291. user.set_password(
  292. &data.NewMasterPasswordHash,
  293. Some(data.Key),
  294. true,
  295. Some(vec![String::from("post_rotatekey"), String::from("get_contacts"), String::from("get_public_keys")]),
  296. );
  297. let save_result = user.save(&mut conn).await;
  298. // Prevent loging out the client where the user requested this endpoint from.
  299. // If you do logout the user it will causes issues at the client side.
  300. // Adding the device uuid will prevent this.
  301. nt.send_logout(&user, Some(headers.device.uuid)).await;
  302. save_result
  303. }
  304. #[derive(Deserialize)]
  305. #[allow(non_snake_case)]
  306. struct ChangeKdfData {
  307. Kdf: i32,
  308. KdfIterations: i32,
  309. KdfMemory: Option<i32>,
  310. KdfParallelism: Option<i32>,
  311. MasterPasswordHash: String,
  312. NewMasterPasswordHash: String,
  313. Key: String,
  314. }
  315. #[post("/accounts/kdf", data = "<data>")]
  316. async fn post_kdf(data: JsonUpcase<ChangeKdfData>, headers: Headers, mut conn: DbConn, nt: Notify<'_>) -> EmptyResult {
  317. let data: ChangeKdfData = data.into_inner().data;
  318. let mut user = headers.user;
  319. if !user.check_valid_password(&data.MasterPasswordHash) {
  320. err!("Invalid password")
  321. }
  322. if data.Kdf == UserKdfType::Pbkdf2 as i32 && data.KdfIterations < 100_000 {
  323. err!("PBKDF2 KDF iterations must be at least 100000.")
  324. }
  325. if data.Kdf == UserKdfType::Argon2id as i32 {
  326. if data.KdfIterations < 1 {
  327. err!("Argon2 KDF iterations must be at least 1.")
  328. }
  329. if let Some(m) = data.KdfMemory {
  330. if !(15..=1024).contains(&m) {
  331. err!("Argon2 memory must be between 15 MB and 1024 MB.")
  332. }
  333. user.client_kdf_memory = data.KdfMemory;
  334. } else {
  335. err!("Argon2 memory parameter is required.")
  336. }
  337. if let Some(p) = data.KdfParallelism {
  338. if !(1..=16).contains(&p) {
  339. err!("Argon2 parallelism must be between 1 and 16.")
  340. }
  341. user.client_kdf_parallelism = data.KdfParallelism;
  342. } else {
  343. err!("Argon2 parallelism parameter is required.")
  344. }
  345. } else {
  346. user.client_kdf_memory = None;
  347. user.client_kdf_parallelism = None;
  348. }
  349. user.client_kdf_iter = data.KdfIterations;
  350. user.client_kdf_type = data.Kdf;
  351. user.set_password(&data.NewMasterPasswordHash, Some(data.Key), true, None);
  352. let save_result = user.save(&mut conn).await;
  353. nt.send_logout(&user, Some(headers.device.uuid)).await;
  354. save_result
  355. }
  356. #[derive(Deserialize)]
  357. #[allow(non_snake_case)]
  358. struct UpdateFolderData {
  359. Id: String,
  360. Name: String,
  361. }
  362. use super::ciphers::CipherData;
  363. #[derive(Deserialize)]
  364. #[allow(non_snake_case)]
  365. struct KeyData {
  366. Ciphers: Vec<CipherData>,
  367. Folders: Vec<UpdateFolderData>,
  368. Key: String,
  369. PrivateKey: String,
  370. MasterPasswordHash: String,
  371. }
  372. #[post("/accounts/key", data = "<data>")]
  373. async fn post_rotatekey(data: JsonUpcase<KeyData>, headers: Headers, mut conn: DbConn, nt: Notify<'_>) -> EmptyResult {
  374. let data: KeyData = data.into_inner().data;
  375. if !headers.user.check_valid_password(&data.MasterPasswordHash) {
  376. err!("Invalid password")
  377. }
  378. // Validate the import before continuing
  379. // Bitwarden does not process the import if there is one item invalid.
  380. // Since we check for the size of the encrypted note length, we need to do that here to pre-validate it.
  381. // TODO: See if we can optimize the whole cipher adding/importing and prevent duplicate code and checks.
  382. Cipher::validate_notes(&data.Ciphers)?;
  383. let user_uuid = &headers.user.uuid;
  384. // Update folder data
  385. for folder_data in data.Folders {
  386. let mut saved_folder = match Folder::find_by_uuid(&folder_data.Id, &mut conn).await {
  387. Some(folder) => folder,
  388. None => err!("Folder doesn't exist"),
  389. };
  390. if &saved_folder.user_uuid != user_uuid {
  391. err!("The folder is not owned by the user")
  392. }
  393. saved_folder.name = folder_data.Name;
  394. saved_folder.save(&mut conn).await?
  395. }
  396. // Update cipher data
  397. use super::ciphers::update_cipher_from_data;
  398. for cipher_data in data.Ciphers {
  399. let mut saved_cipher = match Cipher::find_by_uuid(cipher_data.Id.as_ref().unwrap(), &mut conn).await {
  400. Some(cipher) => cipher,
  401. None => err!("Cipher doesn't exist"),
  402. };
  403. if saved_cipher.user_uuid.as_ref().unwrap() != user_uuid {
  404. err!("The cipher is not owned by the user")
  405. }
  406. // Prevent triggering cipher updates via WebSockets by settings UpdateType::None
  407. // The user sessions are invalidated because all the ciphers were re-encrypted and thus triggering an update could cause issues.
  408. // We force the users to logout after the user has been saved to try and prevent these issues.
  409. update_cipher_from_data(&mut saved_cipher, cipher_data, &headers, false, &mut conn, &nt, UpdateType::None)
  410. .await?
  411. }
  412. // Update user data
  413. let mut user = headers.user;
  414. user.akey = data.Key;
  415. user.private_key = Some(data.PrivateKey);
  416. user.reset_security_stamp();
  417. let save_result = user.save(&mut conn).await;
  418. // Prevent loging out the client where the user requested this endpoint from.
  419. // If you do logout the user it will causes issues at the client side.
  420. // Adding the device uuid will prevent this.
  421. nt.send_logout(&user, Some(headers.device.uuid)).await;
  422. save_result
  423. }
  424. #[post("/accounts/security-stamp", data = "<data>")]
  425. async fn post_sstamp(
  426. data: JsonUpcase<PasswordData>,
  427. headers: Headers,
  428. mut conn: DbConn,
  429. nt: Notify<'_>,
  430. ) -> EmptyResult {
  431. let data: PasswordData = data.into_inner().data;
  432. let mut user = headers.user;
  433. if !user.check_valid_password(&data.MasterPasswordHash) {
  434. err!("Invalid password")
  435. }
  436. Device::delete_all_by_user(&user.uuid, &mut conn).await?;
  437. user.reset_security_stamp();
  438. let save_result = user.save(&mut conn).await;
  439. nt.send_logout(&user, None).await;
  440. save_result
  441. }
  442. #[derive(Deserialize)]
  443. #[allow(non_snake_case)]
  444. struct EmailTokenData {
  445. MasterPasswordHash: String,
  446. NewEmail: String,
  447. }
  448. #[post("/accounts/email-token", data = "<data>")]
  449. async fn post_email_token(data: JsonUpcase<EmailTokenData>, headers: Headers, mut conn: DbConn) -> EmptyResult {
  450. let data: EmailTokenData = data.into_inner().data;
  451. let mut user = headers.user;
  452. if !user.check_valid_password(&data.MasterPasswordHash) {
  453. err!("Invalid password")
  454. }
  455. if User::find_by_mail(&data.NewEmail, &mut conn).await.is_some() {
  456. err!("Email already in use");
  457. }
  458. if !CONFIG.is_email_domain_allowed(&data.NewEmail) {
  459. err!("Email domain not allowed");
  460. }
  461. let token = crypto::generate_email_token(6);
  462. if CONFIG.mail_enabled() {
  463. if let Err(e) = mail::send_change_email(&data.NewEmail, &token).await {
  464. error!("Error sending change-email email: {:#?}", e);
  465. }
  466. }
  467. user.email_new = Some(data.NewEmail);
  468. user.email_new_token = Some(token);
  469. user.save(&mut conn).await
  470. }
  471. #[derive(Deserialize)]
  472. #[allow(non_snake_case)]
  473. struct ChangeEmailData {
  474. MasterPasswordHash: String,
  475. NewEmail: String,
  476. Key: String,
  477. NewMasterPasswordHash: String,
  478. Token: NumberOrString,
  479. }
  480. #[post("/accounts/email", data = "<data>")]
  481. async fn post_email(
  482. data: JsonUpcase<ChangeEmailData>,
  483. headers: Headers,
  484. mut conn: DbConn,
  485. nt: Notify<'_>,
  486. ) -> EmptyResult {
  487. let data: ChangeEmailData = data.into_inner().data;
  488. let mut user = headers.user;
  489. if !user.check_valid_password(&data.MasterPasswordHash) {
  490. err!("Invalid password")
  491. }
  492. if User::find_by_mail(&data.NewEmail, &mut conn).await.is_some() {
  493. err!("Email already in use");
  494. }
  495. match user.email_new {
  496. Some(ref val) => {
  497. if val != &data.NewEmail {
  498. err!("Email change mismatch");
  499. }
  500. }
  501. None => err!("No email change pending"),
  502. }
  503. if CONFIG.mail_enabled() {
  504. // Only check the token if we sent out an email...
  505. match user.email_new_token {
  506. Some(ref val) => {
  507. if *val != data.Token.into_string() {
  508. err!("Token mismatch");
  509. }
  510. }
  511. None => err!("No email change pending"),
  512. }
  513. user.verified_at = Some(Utc::now().naive_utc());
  514. } else {
  515. user.verified_at = None;
  516. }
  517. user.email = data.NewEmail;
  518. user.email_new = None;
  519. user.email_new_token = None;
  520. user.set_password(&data.NewMasterPasswordHash, Some(data.Key), true, None);
  521. let save_result = user.save(&mut conn).await;
  522. nt.send_logout(&user, None).await;
  523. save_result
  524. }
  525. #[post("/accounts/verify-email")]
  526. async fn post_verify_email(headers: Headers) -> EmptyResult {
  527. let user = headers.user;
  528. if !CONFIG.mail_enabled() {
  529. err!("Cannot verify email address");
  530. }
  531. if let Err(e) = mail::send_verify_email(&user.email, &user.uuid).await {
  532. error!("Error sending verify_email email: {:#?}", e);
  533. }
  534. Ok(())
  535. }
  536. #[derive(Deserialize)]
  537. #[allow(non_snake_case)]
  538. struct VerifyEmailTokenData {
  539. UserId: String,
  540. Token: String,
  541. }
  542. #[post("/accounts/verify-email-token", data = "<data>")]
  543. async fn post_verify_email_token(data: JsonUpcase<VerifyEmailTokenData>, mut conn: DbConn) -> EmptyResult {
  544. let data: VerifyEmailTokenData = data.into_inner().data;
  545. let mut user = match User::find_by_uuid(&data.UserId, &mut conn).await {
  546. Some(user) => user,
  547. None => err!("User doesn't exist"),
  548. };
  549. let claims = match decode_verify_email(&data.Token) {
  550. Ok(claims) => claims,
  551. Err(_) => err!("Invalid claim"),
  552. };
  553. if claims.sub != user.uuid {
  554. err!("Invalid claim");
  555. }
  556. user.verified_at = Some(Utc::now().naive_utc());
  557. user.last_verifying_at = None;
  558. user.login_verify_count = 0;
  559. if let Err(e) = user.save(&mut conn).await {
  560. error!("Error saving email verification: {:#?}", e);
  561. }
  562. Ok(())
  563. }
  564. #[derive(Deserialize)]
  565. #[allow(non_snake_case)]
  566. struct DeleteRecoverData {
  567. Email: String,
  568. }
  569. #[post("/accounts/delete-recover", data = "<data>")]
  570. async fn post_delete_recover(data: JsonUpcase<DeleteRecoverData>, mut conn: DbConn) -> EmptyResult {
  571. let data: DeleteRecoverData = data.into_inner().data;
  572. if CONFIG.mail_enabled() {
  573. if let Some(user) = User::find_by_mail(&data.Email, &mut conn).await {
  574. if let Err(e) = mail::send_delete_account(&user.email, &user.uuid).await {
  575. error!("Error sending delete account email: {:#?}", e);
  576. }
  577. }
  578. Ok(())
  579. } else {
  580. // We don't support sending emails, but we shouldn't allow anybody
  581. // to delete accounts without at least logging in... And if the user
  582. // cannot remember their password then they will need to contact
  583. // the administrator to delete it...
  584. err!("Please contact the administrator to delete your account");
  585. }
  586. }
  587. #[derive(Deserialize)]
  588. #[allow(non_snake_case)]
  589. struct DeleteRecoverTokenData {
  590. UserId: String,
  591. Token: String,
  592. }
  593. #[post("/accounts/delete-recover-token", data = "<data>")]
  594. async fn post_delete_recover_token(data: JsonUpcase<DeleteRecoverTokenData>, mut conn: DbConn) -> EmptyResult {
  595. let data: DeleteRecoverTokenData = data.into_inner().data;
  596. let user = match User::find_by_uuid(&data.UserId, &mut conn).await {
  597. Some(user) => user,
  598. None => err!("User doesn't exist"),
  599. };
  600. let claims = match decode_delete(&data.Token) {
  601. Ok(claims) => claims,
  602. Err(_) => err!("Invalid claim"),
  603. };
  604. if claims.sub != user.uuid {
  605. err!("Invalid claim");
  606. }
  607. user.delete(&mut conn).await
  608. }
  609. #[post("/accounts/delete", data = "<data>")]
  610. async fn post_delete_account(data: JsonUpcase<PasswordData>, headers: Headers, conn: DbConn) -> EmptyResult {
  611. delete_account(data, headers, conn).await
  612. }
  613. #[delete("/accounts", data = "<data>")]
  614. async fn delete_account(data: JsonUpcase<PasswordData>, headers: Headers, mut conn: DbConn) -> EmptyResult {
  615. let data: PasswordData = data.into_inner().data;
  616. let user = headers.user;
  617. if !user.check_valid_password(&data.MasterPasswordHash) {
  618. err!("Invalid password")
  619. }
  620. user.delete(&mut conn).await
  621. }
  622. #[get("/accounts/revision-date")]
  623. fn revision_date(headers: Headers) -> JsonResult {
  624. let revision_date = headers.user.updated_at.timestamp_millis();
  625. Ok(Json(json!(revision_date)))
  626. }
  627. #[derive(Deserialize)]
  628. #[allow(non_snake_case)]
  629. struct PasswordHintData {
  630. Email: String,
  631. }
  632. #[post("/accounts/password-hint", data = "<data>")]
  633. async fn password_hint(data: JsonUpcase<PasswordHintData>, mut conn: DbConn) -> EmptyResult {
  634. if !CONFIG.mail_enabled() && !CONFIG.show_password_hint() {
  635. err!("This server is not configured to provide password hints.");
  636. }
  637. const NO_HINT: &str = "Sorry, you have no password hint...";
  638. let data: PasswordHintData = data.into_inner().data;
  639. let email = &data.Email;
  640. match User::find_by_mail(email, &mut conn).await {
  641. None => {
  642. // To prevent user enumeration, act as if the user exists.
  643. if CONFIG.mail_enabled() {
  644. // There is still a timing side channel here in that the code
  645. // paths that send mail take noticeably longer than ones that
  646. // don't. Add a randomized sleep to mitigate this somewhat.
  647. use rand::{rngs::SmallRng, Rng, SeedableRng};
  648. let mut rng = SmallRng::from_entropy();
  649. let delta: i32 = 100;
  650. let sleep_ms = (1_000 + rng.gen_range(-delta..=delta)) as u64;
  651. tokio::time::sleep(tokio::time::Duration::from_millis(sleep_ms)).await;
  652. Ok(())
  653. } else {
  654. err!(NO_HINT);
  655. }
  656. }
  657. Some(user) => {
  658. let hint: Option<String> = user.password_hint;
  659. if CONFIG.mail_enabled() {
  660. mail::send_password_hint(email, hint).await?;
  661. Ok(())
  662. } else if let Some(hint) = hint {
  663. err!(format!("Your password hint is: {hint}"));
  664. } else {
  665. err!(NO_HINT);
  666. }
  667. }
  668. }
  669. }
  670. #[derive(Deserialize)]
  671. #[allow(non_snake_case)]
  672. pub struct PreloginData {
  673. Email: String,
  674. }
  675. #[post("/accounts/prelogin", data = "<data>")]
  676. async fn prelogin(data: JsonUpcase<PreloginData>, conn: DbConn) -> Json<Value> {
  677. _prelogin(data, conn).await
  678. }
  679. pub async fn _prelogin(data: JsonUpcase<PreloginData>, mut conn: DbConn) -> Json<Value> {
  680. let data: PreloginData = data.into_inner().data;
  681. let (kdf_type, kdf_iter, kdf_mem, kdf_para) = match User::find_by_mail(&data.Email, &mut conn).await {
  682. Some(user) => (user.client_kdf_type, user.client_kdf_iter, user.client_kdf_memory, user.client_kdf_parallelism),
  683. None => (User::CLIENT_KDF_TYPE_DEFAULT, User::CLIENT_KDF_ITER_DEFAULT, None, None),
  684. };
  685. let result = json!({
  686. "Kdf": kdf_type,
  687. "KdfIterations": kdf_iter,
  688. "KdfMemory": kdf_mem,
  689. "KdfParallelism": kdf_para,
  690. });
  691. Json(result)
  692. }
  693. // https://github.com/bitwarden/server/blob/master/src/Api/Models/Request/Accounts/SecretVerificationRequestModel.cs
  694. #[derive(Deserialize)]
  695. #[allow(non_snake_case)]
  696. struct SecretVerificationRequest {
  697. MasterPasswordHash: String,
  698. }
  699. #[post("/accounts/verify-password", data = "<data>")]
  700. fn verify_password(data: JsonUpcase<SecretVerificationRequest>, headers: Headers) -> EmptyResult {
  701. let data: SecretVerificationRequest = data.into_inner().data;
  702. let user = headers.user;
  703. if !user.check_valid_password(&data.MasterPasswordHash) {
  704. err!("Invalid password")
  705. }
  706. Ok(())
  707. }
  708. async fn _api_key(
  709. data: JsonUpcase<SecretVerificationRequest>,
  710. rotate: bool,
  711. headers: Headers,
  712. mut conn: DbConn,
  713. ) -> JsonResult {
  714. use crate::util::format_date;
  715. let data: SecretVerificationRequest = data.into_inner().data;
  716. let mut user = headers.user;
  717. if !user.check_valid_password(&data.MasterPasswordHash) {
  718. err!("Invalid password")
  719. }
  720. if rotate || user.api_key.is_none() {
  721. user.api_key = Some(crypto::generate_api_key());
  722. user.save(&mut conn).await.expect("Error saving API key");
  723. }
  724. Ok(Json(json!({
  725. "ApiKey": user.api_key,
  726. "RevisionDate": format_date(&user.updated_at),
  727. "Object": "apiKey",
  728. })))
  729. }
  730. #[post("/accounts/api-key", data = "<data>")]
  731. async fn api_key(data: JsonUpcase<SecretVerificationRequest>, headers: Headers, conn: DbConn) -> JsonResult {
  732. _api_key(data, false, headers, conn).await
  733. }
  734. #[post("/accounts/rotate-api-key", data = "<data>")]
  735. async fn rotate_api_key(data: JsonUpcase<SecretVerificationRequest>, headers: Headers, conn: DbConn) -> JsonResult {
  736. _api_key(data, true, headers, conn).await
  737. }
  738. // This variant is deprecated: https://github.com/bitwarden/server/pull/2682
  739. #[get("/devices/knowndevice/<email>/<uuid>")]
  740. async fn get_known_device_from_path(email: &str, uuid: &str, mut conn: DbConn) -> JsonResult {
  741. // This endpoint doesn't have auth header
  742. let mut result = false;
  743. if let Some(user) = User::find_by_mail(email, &mut conn).await {
  744. result = Device::find_by_uuid_and_user(uuid, &user.uuid, &mut conn).await.is_some();
  745. }
  746. Ok(Json(json!(result)))
  747. }
  748. #[get("/devices/knowndevice")]
  749. async fn get_known_device(device: KnownDevice, conn: DbConn) -> JsonResult {
  750. get_known_device_from_path(&device.email, &device.uuid, conn).await
  751. }
  752. struct KnownDevice {
  753. email: String,
  754. uuid: String,
  755. }
  756. #[rocket::async_trait]
  757. impl<'r> FromRequest<'r> for KnownDevice {
  758. type Error = &'static str;
  759. async fn from_request(req: &'r Request<'_>) -> Outcome<Self, Self::Error> {
  760. let email = if let Some(email_b64) = req.headers().get_one("X-Request-Email") {
  761. let email_bytes = match data_encoding::BASE64URL_NOPAD.decode(email_b64.as_bytes()) {
  762. Ok(bytes) => bytes,
  763. Err(_) => {
  764. return Outcome::Failure((
  765. Status::BadRequest,
  766. "X-Request-Email value failed to decode as base64url",
  767. ));
  768. }
  769. };
  770. match String::from_utf8(email_bytes) {
  771. Ok(email) => email,
  772. Err(_) => {
  773. return Outcome::Failure((Status::BadRequest, "X-Request-Email value failed to decode as UTF-8"));
  774. }
  775. }
  776. } else {
  777. return Outcome::Failure((Status::BadRequest, "X-Request-Email value is required"));
  778. };
  779. let uuid = if let Some(uuid) = req.headers().get_one("X-Device-Identifier") {
  780. uuid.to_string()
  781. } else {
  782. return Outcome::Failure((Status::BadRequest, "X-Device-Identifier value is required"));
  783. };
  784. Outcome::Success(KnownDevice {
  785. email,
  786. uuid,
  787. })
  788. }
  789. }
  790. #[derive(Deserialize)]
  791. #[allow(non_snake_case)]
  792. struct PushToken {
  793. PushToken: String,
  794. }
  795. #[post("/devices/identifier/<uuid>/token", data = "<data>")]
  796. async fn post_device_token(uuid: &str, data: JsonUpcase<PushToken>, headers: Headers, conn: DbConn) -> EmptyResult {
  797. put_device_token(uuid, data, headers, conn).await
  798. }
  799. #[put("/devices/identifier/<uuid>/token", data = "<data>")]
  800. async fn put_device_token(uuid: &str, data: JsonUpcase<PushToken>, headers: Headers, mut conn: DbConn) -> EmptyResult {
  801. if !CONFIG.push_enabled() {
  802. return Ok(());
  803. }
  804. let data = data.into_inner().data;
  805. let token = data.PushToken;
  806. let mut device = match Device::find_by_uuid_and_user(&headers.device.uuid, &headers.user.uuid, &mut conn).await {
  807. Some(device) => device,
  808. None => err!(format!("Error: device {uuid} should be present before a token can be assigned")),
  809. };
  810. device.push_token = Some(token);
  811. if device.push_uuid.is_none() {
  812. device.push_uuid = Some(uuid::Uuid::new_v4().to_string());
  813. }
  814. if let Err(e) = device.save(&mut conn).await {
  815. err!(format!("An error occured while trying to save the device push token: {e}"));
  816. }
  817. if let Err(e) = register_push_device(headers.user.uuid, device).await {
  818. err!(format!("An error occured while proceeding registration of a device: {e}"));
  819. }
  820. Ok(())
  821. }
  822. #[put("/devices/identifier/<uuid>/clear-token")]
  823. async fn put_clear_device_token(uuid: &str, mut conn: DbConn) -> EmptyResult {
  824. // This only clears push token
  825. // https://github.com/bitwarden/core/blob/master/src/Api/Controllers/DevicesController.cs#L109
  826. // https://github.com/bitwarden/core/blob/master/src/Core/Services/Implementations/DeviceService.cs#L37
  827. // This is somehow not implemented in any app, added it in case it is required
  828. if !CONFIG.push_enabled() {
  829. return Ok(());
  830. }
  831. if let Some(device) = Device::find_by_uuid(uuid, &mut conn).await {
  832. Device::clear_push_token_by_uuid(uuid, &mut conn).await?;
  833. unregister_push_device(device.uuid).await?;
  834. }
  835. Ok(())
  836. }
  837. // On upstream server, both PUT and POST are declared. Implementing the POST method in case it would be useful somewhere
  838. #[post("/devices/identifier/<uuid>/clear-token")]
  839. async fn post_clear_device_token(uuid: &str, conn: DbConn) -> EmptyResult {
  840. put_clear_device_token(uuid, conn).await
  841. }
  842. #[derive(Debug, Deserialize)]
  843. #[allow(non_snake_case)]
  844. struct AuthRequestRequest {
  845. accessCode: String,
  846. deviceIdentifier: String,
  847. email: String,
  848. publicKey: String,
  849. #[serde(alias = "type")]
  850. _type: i32,
  851. }
  852. #[post("/auth-requests", data = "<data>")]
  853. async fn post_auth_request(
  854. data: Json<AuthRequestRequest>,
  855. headers: ClientHeaders,
  856. mut conn: DbConn,
  857. nt: Notify<'_>,
  858. ) -> JsonResult {
  859. let data = data.into_inner();
  860. let user = match User::find_by_mail(&data.email, &mut conn).await {
  861. Some(user) => user,
  862. None => {
  863. err!("AuthRequest doesn't exist")
  864. }
  865. };
  866. let mut auth_request = AuthRequest::new(
  867. user.uuid.clone(),
  868. data.deviceIdentifier.clone(),
  869. headers.device_type,
  870. headers.ip.ip.to_string(),
  871. data.accessCode,
  872. data.publicKey,
  873. );
  874. auth_request.save(&mut conn).await?;
  875. nt.send_auth_request(&user.uuid, &auth_request.uuid, &data.deviceIdentifier, &mut conn).await;
  876. Ok(Json(json!({
  877. "id": auth_request.uuid,
  878. "publicKey": auth_request.public_key,
  879. "requestDeviceType": DeviceType::from_i32(auth_request.device_type).to_string(),
  880. "requestIpAddress": auth_request.request_ip,
  881. "key": null,
  882. "masterPasswordHash": null,
  883. "creationDate": auth_request.creation_date.and_utc(),
  884. "responseDate": null,
  885. "requestApproved": false,
  886. "origin": CONFIG.domain_origin(),
  887. "object": "auth-request"
  888. })))
  889. }
  890. #[get("/auth-requests/<uuid>")]
  891. async fn get_auth_request(uuid: &str, mut conn: DbConn) -> JsonResult {
  892. let auth_request = match AuthRequest::find_by_uuid(uuid, &mut conn).await {
  893. Some(auth_request) => auth_request,
  894. None => {
  895. err!("AuthRequest doesn't exist")
  896. }
  897. };
  898. let response_date_utc = auth_request.response_date.map(|response_date| response_date.and_utc());
  899. Ok(Json(json!(
  900. {
  901. "id": uuid,
  902. "publicKey": auth_request.public_key,
  903. "requestDeviceType": DeviceType::from_i32(auth_request.device_type).to_string(),
  904. "requestIpAddress": auth_request.request_ip,
  905. "key": auth_request.enc_key,
  906. "masterPasswordHash": auth_request.master_password_hash,
  907. "creationDate": auth_request.creation_date.and_utc(),
  908. "responseDate": response_date_utc,
  909. "requestApproved": auth_request.approved,
  910. "origin": CONFIG.domain_origin(),
  911. "object":"auth-request"
  912. }
  913. )))
  914. }
  915. #[derive(Debug, Deserialize)]
  916. #[allow(non_snake_case)]
  917. struct AuthResponseRequest {
  918. deviceIdentifier: String,
  919. key: String,
  920. masterPasswordHash: Option<String>,
  921. requestApproved: bool,
  922. }
  923. #[put("/auth-requests/<uuid>", data = "<data>")]
  924. async fn put_auth_request(
  925. uuid: &str,
  926. data: Json<AuthResponseRequest>,
  927. mut conn: DbConn,
  928. ant: AnonymousNotify<'_>,
  929. nt: Notify<'_>,
  930. ) -> JsonResult {
  931. let data = data.into_inner();
  932. let mut auth_request: AuthRequest = match AuthRequest::find_by_uuid(uuid, &mut conn).await {
  933. Some(auth_request) => auth_request,
  934. None => {
  935. err!("AuthRequest doesn't exist")
  936. }
  937. };
  938. auth_request.approved = Some(data.requestApproved);
  939. auth_request.enc_key = Some(data.key);
  940. auth_request.master_password_hash = data.masterPasswordHash;
  941. auth_request.response_device_id = Some(data.deviceIdentifier.clone());
  942. auth_request.save(&mut conn).await?;
  943. if auth_request.approved.unwrap_or(false) {
  944. ant.send_auth_response(&auth_request.user_uuid, &auth_request.uuid).await;
  945. nt.send_auth_response(&auth_request.user_uuid, &auth_request.uuid, data.deviceIdentifier, &mut conn).await;
  946. }
  947. let response_date_utc = auth_request.response_date.map(|response_date| response_date.and_utc());
  948. Ok(Json(json!(
  949. {
  950. "id": uuid,
  951. "publicKey": auth_request.public_key,
  952. "requestDeviceType": DeviceType::from_i32(auth_request.device_type).to_string(),
  953. "requestIpAddress": auth_request.request_ip,
  954. "key": auth_request.enc_key,
  955. "masterPasswordHash": auth_request.master_password_hash,
  956. "creationDate": auth_request.creation_date.and_utc(),
  957. "responseDate": response_date_utc,
  958. "requestApproved": auth_request.approved,
  959. "origin": CONFIG.domain_origin(),
  960. "object":"auth-request"
  961. }
  962. )))
  963. }
  964. #[get("/auth-requests/<uuid>/response?<code>")]
  965. async fn get_auth_request_response(uuid: &str, code: &str, mut conn: DbConn) -> JsonResult {
  966. let auth_request = match AuthRequest::find_by_uuid(uuid, &mut conn).await {
  967. Some(auth_request) => auth_request,
  968. None => {
  969. err!("AuthRequest doesn't exist")
  970. }
  971. };
  972. if !auth_request.check_access_code(code) {
  973. err!("Access code invalid doesn't exist")
  974. }
  975. let response_date_utc = auth_request.response_date.map(|response_date| response_date.and_utc());
  976. Ok(Json(json!(
  977. {
  978. "id": uuid,
  979. "publicKey": auth_request.public_key,
  980. "requestDeviceType": DeviceType::from_i32(auth_request.device_type).to_string(),
  981. "requestIpAddress": auth_request.request_ip,
  982. "key": auth_request.enc_key,
  983. "masterPasswordHash": auth_request.master_password_hash,
  984. "creationDate": auth_request.creation_date.and_utc(),
  985. "responseDate": response_date_utc,
  986. "requestApproved": auth_request.approved,
  987. "origin": CONFIG.domain_origin(),
  988. "object":"auth-request"
  989. }
  990. )))
  991. }
  992. #[get("/auth-requests")]
  993. async fn get_auth_requests(headers: Headers, mut conn: DbConn) -> JsonResult {
  994. let auth_requests = AuthRequest::find_by_user(&headers.user.uuid, &mut conn).await;
  995. Ok(Json(json!({
  996. "data": auth_requests
  997. .iter()
  998. .filter(|request| request.approved.is_none())
  999. .map(|request| {
  1000. let response_date_utc = request.response_date.map(|response_date| response_date.and_utc());
  1001. json!({
  1002. "id": request.uuid,
  1003. "publicKey": request.public_key,
  1004. "requestDeviceType": DeviceType::from_i32(request.device_type).to_string(),
  1005. "requestIpAddress": request.request_ip,
  1006. "key": request.enc_key,
  1007. "masterPasswordHash": request.master_password_hash,
  1008. "creationDate": request.creation_date.and_utc(),
  1009. "responseDate": response_date_utc,
  1010. "requestApproved": request.approved,
  1011. "origin": CONFIG.domain_origin(),
  1012. "object":"auth-request"
  1013. })
  1014. }).collect::<Vec<Value>>(),
  1015. "continuationToken": null,
  1016. "object": "list"
  1017. })))
  1018. }
  1019. pub async fn purge_auth_requests(pool: DbPool) {
  1020. debug!("Purging auth requests");
  1021. if let Ok(mut conn) = pool.get().await {
  1022. AuthRequest::purge_expired_auth_requests(&mut conn).await;
  1023. } else {
  1024. error!("Failed to get DB connection while purging trashed ciphers")
  1025. }
  1026. }