mirror of
https://github.com/dani-garcia/vaultwarden.wiki.git
synced 2026-10-22 23:48:09 +03:00
[web-v2026.7.1] 2FA userVerificationToken for Authenticator, Email and Duo (#7563)
* 2FA using userVerificationToken * Fix 2FA Yubikeys * TwoFactor.find_by_user_and_type take enum parameter not i32 * log_user_event take enum parameter not i32 * Fix 2fa webauthn * Prevent 2FA claims reuse * 2fa webauthn return keys when deleting * 2fa reset twofactor_remember * Reject 2FA verification tokens issued for another provider The Email and Duo claims only have optional fields, so a userVerificationToken minted for another provider deserialized into them and was accepted. Each provider's claims now reject unknown fields, with a test that every token only parses as its own provider. Also fix the email 2FA login in the Playwright user setup, which used an undefined `mailBuffer`. --------- Co-authored-by: Timshel <timshel@users.noreply.github.com> Co-authored-by: Daniel García <dani-garcia@users.noreply.github.com>
This commit is contained in:
18 files changed
+667
-366
No files matched your search
@@ -3,7 +3,7 @@ import * as OTPAuth from "otpauth";
|
||||
|
||||
import * as utils from "../global-utils";
|
||||
import { createAccount, logUser } from './setups/user';
|
||||
import { activateTOTP, disableTOTP } from './setups/2fa';
|
||||
import { activateTOTP, disableTOTP, recoveryCodes } from './setups/2fa';
|
||||
|
||||
let users = utils.loadEnv();
|
||||
let totp;
|
||||
@@ -31,21 +31,42 @@ test('Authenticator 2fa', async ({ page }) => {
|
||||
|
||||
await utils.logout(test, page, users.user1);
|
||||
|
||||
await test.step('login', async () => {
|
||||
let timestamp = Date.now(); // Needed to use the next token
|
||||
timestamp = timestamp + (totp.period - (Math.floor(timestamp / 1000) % totp.period) + 1) * 1000;
|
||||
await logUser(test, page, users.user1, { totp });
|
||||
|
||||
await disableTOTP(test, page, users.user1);
|
||||
});
|
||||
|
||||
test('Recovery codes', async ({ context, page }) => {
|
||||
await logUser(test, page, users.user1);
|
||||
|
||||
await activateTOTP(test, page, users.user1);
|
||||
let recovery = await recoveryCodes(test, page, users.user1);
|
||||
|
||||
await utils.logout(test, page, users.user1);
|
||||
|
||||
await test.step('login', async () => {
|
||||
await page.getByLabel(/Email address/).fill(users.user1.email);
|
||||
await page.getByRole('button', { name: 'Continue' }).click();
|
||||
await page.getByRole('textbox', { name: 'Master password * (required)', exact: true }).fill(users.user1.password);
|
||||
await page.getByRole('button', { name: 'Log in', exact: true }).click();
|
||||
|
||||
await expect(page.getByRole('heading', { name: 'Verify your Identity' })).toBeVisible();
|
||||
await page.getByLabel(/Verification code/).fill(totp.generate({timestamp}));
|
||||
await page.getByRole('button', { name: 'Continue' }).click();
|
||||
|
||||
await expect(page).toHaveTitle(/Vaultwarden Web/);
|
||||
});
|
||||
|
||||
await disableTOTP(test, page, users.user1);
|
||||
const newPagePromise = context.waitForEvent('page');
|
||||
await page.getByRole('button', { name: 'Use your recovery code' }).click();
|
||||
const newPage = await newPagePromise;
|
||||
|
||||
const tabs = context.pages();
|
||||
await tabs[1].bringToFront();
|
||||
await expect(tabs[1].getByRole('heading', { name: 'Recover account two-step login' })).toBeVisible();
|
||||
await tabs[1].getByRole('textbox', { name: 'Email address * (required)' }).fill(users.user1.email);
|
||||
await tabs[1].getByRole('textbox', { name: 'Master password * (required)' }).fill(users.user1.password);
|
||||
await tabs[1].getByRole('textbox', { name: 'Recovery code * (required)' }).fill(recovery);
|
||||
await tabs[1].getByRole('button', { name: 'Submit' }).click();
|
||||
|
||||
await expect(tabs[1]).toHaveTitle(/Two-step login/);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -4,6 +4,24 @@ import * as OTPAuth from "otpauth";
|
||||
|
||||
import * as utils from '../../global-utils';
|
||||
|
||||
export async function recoveryCodes(test: Test, page: Page, user: { name: string, password: string }): string {
|
||||
return await test.step('Recovery code', async () => {
|
||||
await page.getByRole('button', { name: user.name }).click();
|
||||
await page.getByRole('menuitem', { name: 'Account settings' }).click();
|
||||
await page.getByRole('link', { name: 'Security' }).click();
|
||||
await page.getByRole('link', { name: 'Two-step login' }).click();
|
||||
|
||||
await page.getByRole('button', { name: 'View recovery code' }).click();
|
||||
await page.getByRole('textbox', { name: 'Master password * (required)', exact: true }).fill(user.password);
|
||||
await page.getByRole('button', { name: 'Continue' }).click();
|
||||
|
||||
const recovery = await page.getByRole('code').innerText();
|
||||
await page.getByLabel('Close').click();
|
||||
|
||||
return recovery;
|
||||
})
|
||||
}
|
||||
|
||||
export async function activateTOTP(test: Test, page: Page, user: { name: string, password: string }): OTPAuth.TOTP {
|
||||
return await test.step('Activate TOTP 2FA', async () => {
|
||||
await page.getByRole('button', { name: user.name }).click();
|
||||
@@ -21,7 +39,6 @@ export async function activateTOTP(test: Test, page: Page, user: { name: string,
|
||||
await page.getByLabel(/Verification code/).fill(totp.generate());
|
||||
await page.getByRole('button', { name: 'Turn on' }).click();
|
||||
await page.getByRole('heading', { name: 'Turned on', exact: true });
|
||||
await page.getByLabel('Close').click();
|
||||
|
||||
return totp;
|
||||
})
|
||||
|
||||
@@ -2,6 +2,7 @@ import { expect, type Browser, Page } from '@playwright/test';
|
||||
|
||||
import { type MailBuffer } from 'maildev';
|
||||
|
||||
import * as OTPAuth from "otpauth";
|
||||
import * as utils from '../../global-utils';
|
||||
import { retrieveEmailCode } from './2fa';
|
||||
|
||||
@@ -43,6 +44,7 @@ export async function logUser(
|
||||
mailBuffer ?: MailBuffer,
|
||||
mail2fa?: boolean,
|
||||
notNewDevice?: boolean,
|
||||
totp?: OTPAuth.TOTP,
|
||||
} = {}
|
||||
) {
|
||||
await test.step(`Log user ${user.email}`, async () => {
|
||||
@@ -55,11 +57,23 @@ export async function logUser(
|
||||
await page.getByRole('textbox', { name: 'Master password * (required)', exact: true }).fill(user.password);
|
||||
await page.getByRole('button', { name: 'Log in', exact: true }).click();
|
||||
|
||||
if( options.mail2fa ){
|
||||
if( options.mail2fa || options.totp ){
|
||||
let code;
|
||||
|
||||
await test.step('2FA check', async () => {
|
||||
await expect(page.getByRole('heading', { name: 'Verify your Identity' })).toBeVisible();
|
||||
let code = await retrieveEmailCode(test, page, options.mailBuffer);
|
||||
|
||||
if( options.totp ) {
|
||||
const totp = options.totp;
|
||||
let timestamp = Date.now(); // Needed to use the next token
|
||||
timestamp = timestamp + (totp.period - (Math.floor(timestamp / 1000) % totp.period) + 1) * 1000;
|
||||
code = totp.generate({timestamp});
|
||||
} else if( options.mail2fa ){
|
||||
code = await retrieveEmailCode(test, page, options.mailBuffer);
|
||||
}
|
||||
|
||||
await page.getByLabel(/Verification code/).fill(code);
|
||||
|
||||
await page.getByRole('button', { name: 'Continue' }).click();
|
||||
});
|
||||
}
|
||||
|
||||
@@ -493,8 +493,7 @@ async fn post_set_password(data: Json<SetPasswordData>, headers: Headers, conn:
|
||||
Membership::accept_user_invitations(&user.uuid, &conn).await?;
|
||||
}
|
||||
|
||||
log_user_event(EventType::UserChangedPassword as i32, &user.uuid, headers.device.atype, &headers.ip.ip, &conn)
|
||||
.await;
|
||||
log_user_event(EventType::UserChangedPassword, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
|
||||
user.save(&conn).await?;
|
||||
|
||||
@@ -640,8 +639,7 @@ async fn post_password(data: Json<ChangePassData>, headers: Headers, conn: DbCon
|
||||
err!("Invalid password")
|
||||
}
|
||||
|
||||
log_user_event(EventType::UserChangedPassword as i32, &user.uuid, headers.device.atype, &headers.ip.ip, &conn)
|
||||
.await;
|
||||
log_user_event(EventType::UserChangedPassword, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
|
||||
let (new_master_password_hash, new_key) =
|
||||
if let (Some(unlock_data), Some(authentication_data)) = (data.unlock_data, data.authentication_data) {
|
||||
@@ -1696,7 +1694,7 @@ async fn post_auth_request(
|
||||
nt.send_auth_request(&user.uuid, &auth_request.uuid, &device, &conn).await;
|
||||
|
||||
log_user_event(
|
||||
EventType::UserRequestedDeviceApproval as i32,
|
||||
EventType::UserRequestedDeviceApproval,
|
||||
&user.uuid,
|
||||
client_headers.device_type,
|
||||
&client_headers.ip.ip,
|
||||
@@ -1790,7 +1788,7 @@ async fn put_auth_request(
|
||||
nt.send_auth_response(&auth_request.user_uuid, &auth_request.uuid, &headers.device, &conn).await;
|
||||
|
||||
log_user_event(
|
||||
EventType::OrganizationUserApprovedAuthRequest as i32,
|
||||
EventType::OrganizationUserApprovedAuthRequest,
|
||||
&headers.user.uuid,
|
||||
headers.device.atype,
|
||||
&headers.ip.ip,
|
||||
@@ -1801,7 +1799,7 @@ async fn put_auth_request(
|
||||
// If denied, there's no reason to keep the request
|
||||
auth_request.delete(&conn).await?;
|
||||
log_user_event(
|
||||
EventType::OrganizationUserRejectedAuthRequest as i32,
|
||||
EventType::OrganizationUserRejectedAuthRequest,
|
||||
&headers.user.uuid,
|
||||
headers.device.atype,
|
||||
&headers.ip.ip,
|
||||
|
||||
@@ -242,11 +242,11 @@ async fn post_events_collect(data: Json<Vec<EventCollection>>, headers: Headers,
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub async fn log_user_event(event_type: i32, user_id: &UserId, device_type: i32, ip: &IpAddr, conn: &DbConn) {
|
||||
pub async fn log_user_event(event_type: EventType, user_id: &UserId, device_type: i32, ip: &IpAddr, conn: &DbConn) {
|
||||
if !CONFIG.org_events_enabled() {
|
||||
return;
|
||||
}
|
||||
log_user_event_impl(event_type, user_id, device_type, None, ip, conn).await;
|
||||
log_user_event_impl(event_type as i32, user_id, device_type, None, ip, conn).await;
|
||||
}
|
||||
|
||||
async fn log_user_event_impl(
|
||||
|
||||
@@ -2840,7 +2840,7 @@ async fn recover_account(
|
||||
|
||||
let fallback_2fa_email =
|
||||
if req.reset_two_factor && CONFIG.mail_enabled() && CONFIG.email_2fa_auto_fallback() && user.verified() {
|
||||
TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::Email as i32, &conn).await.is_none()
|
||||
TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::Email, &conn).await.is_none()
|
||||
} else {
|
||||
false
|
||||
};
|
||||
|
||||
@@ -3,11 +3,11 @@ use rocket::{Route, serde::json::Json};
|
||||
|
||||
use crate::{
|
||||
api::{EmptyResult, JsonResult, PasswordOrOtpData, core::log_user_event, core::two_factor::generate_recover_code},
|
||||
auth::{ClientIp, Headers},
|
||||
auth::{ClientIp, Headers, two_factor},
|
||||
crypto,
|
||||
db::{
|
||||
DbConn,
|
||||
models::{Device, EventType, TwoFactor, TwoFactorType, UserId},
|
||||
models::{EventType, TwoFactor, TwoFactorType, UserId},
|
||||
},
|
||||
util::NumberOrString,
|
||||
};
|
||||
@@ -20,27 +20,23 @@ pub fn routes() -> Vec<Route> {
|
||||
|
||||
#[post("/two-factor/get-authenticator", data = "<data>")]
|
||||
async fn generate_authenticator(data: Json<PasswordOrOtpData>, headers: Headers, conn: DbConn) -> JsonResult {
|
||||
let data: PasswordOrOtpData = data.into_inner();
|
||||
let user = headers.user;
|
||||
|
||||
data.validate(&user, false, &conn).await?;
|
||||
|
||||
let type_ = TwoFactorType::Authenticator as i32;
|
||||
let twofactor = TwoFactor::find_by_user_and_type(&user.uuid, type_, &conn).await;
|
||||
let twofactor = TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::Authenticator, &conn).await;
|
||||
|
||||
let (enabled, key) = match twofactor {
|
||||
Some(tf) => (true, tf.data),
|
||||
_ => (false, crypto::encode_random_bytes::<20>(&BASE32)),
|
||||
};
|
||||
|
||||
// Upstream seems to also return `userVerificationToken`, but doesn't seem to be used at all.
|
||||
// It should help prevent TOTP disclosure if someone keeps their vault unlocked.
|
||||
// Since it doesn't seem to be used, and also does not cause any issues, lets leave it out of the response.
|
||||
// See: https://github.com/bitwarden/server/blob/9ebe16587175b1c0e9208f84397bb75d0d595510/src/Api/Auth/Controllers/TwoFactorController.cs#L94
|
||||
Ok(Json(json!({
|
||||
"enabled": enabled,
|
||||
"key": key,
|
||||
"object": "twoFactorAuthenticator"
|
||||
"authenticator": json!({
|
||||
"enabled": enabled,
|
||||
"key": key,
|
||||
}),
|
||||
"userVerificationToken": two_factor::authenticator_token(user.uuid, key, enabled),
|
||||
})))
|
||||
}
|
||||
|
||||
@@ -49,8 +45,7 @@ async fn generate_authenticator(data: Json<PasswordOrOtpData>, headers: Headers,
|
||||
struct EnableAuthenticatorData {
|
||||
key: String,
|
||||
token: NumberOrString,
|
||||
master_password_hash: Option<String>,
|
||||
otp: Option<String>,
|
||||
user_verification_token: String,
|
||||
}
|
||||
|
||||
#[post("/two-factor/authenticator", data = "<data>")]
|
||||
@@ -61,12 +56,7 @@ async fn activate_authenticator(data: Json<EnableAuthenticatorData>, headers: He
|
||||
|
||||
let mut user = headers.user;
|
||||
|
||||
PasswordOrOtpData {
|
||||
master_password_hash: data.master_password_hash,
|
||||
otp: data.otp,
|
||||
}
|
||||
.validate(&user, true, &conn)
|
||||
.await?;
|
||||
two_factor::validate_authenticator(&data.user_verification_token, &user.uuid, &key, false)?;
|
||||
|
||||
// Validate key as base32 and 20 bytes length
|
||||
let decoded_key: Vec<u8> = if let Ok(decoded) = BASE32.decode(key.as_bytes()) {
|
||||
@@ -84,12 +74,13 @@ async fn activate_authenticator(data: Json<EnableAuthenticatorData>, headers: He
|
||||
|
||||
generate_recover_code(&mut user, &conn).await;
|
||||
|
||||
log_user_event(EventType::UserUpdated2fa as i32, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
log_user_event(EventType::UserUpdated2fa, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
|
||||
Ok(Json(json!({
|
||||
"enabled": true,
|
||||
"key": key,
|
||||
"object": "twoFactorAuthenticator"
|
||||
"authenticator": json!({
|
||||
"enabled": true,
|
||||
"key": key,
|
||||
}),
|
||||
})))
|
||||
}
|
||||
|
||||
@@ -125,8 +116,7 @@ pub async fn validate_totp_code(
|
||||
err!("Invalid TOTP secret")
|
||||
};
|
||||
|
||||
let mut twofactor = match TwoFactor::find_by_user_and_type(user_id, TwoFactorType::Authenticator as i32, conn).await
|
||||
{
|
||||
let mut twofactor = match TwoFactor::find_by_user_and_type(user_id, TwoFactorType::Authenticator, conn).await {
|
||||
Some(tf) => tf,
|
||||
_ => TwoFactor::new(user_id.clone(), TwoFactorType::Authenticator, secret.to_owned()),
|
||||
};
|
||||
@@ -184,37 +174,25 @@ pub async fn validate_totp_code(
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct DisableAuthenticatorData {
|
||||
key: String,
|
||||
master_password_hash: String,
|
||||
r#type: NumberOrString,
|
||||
user_verification_token: String,
|
||||
}
|
||||
|
||||
#[delete("/two-factor/authenticator", data = "<data>")]
|
||||
async fn disable_authenticator(data: Json<DisableAuthenticatorData>, headers: Headers, conn: DbConn) -> JsonResult {
|
||||
async fn disable_authenticator(data: Json<DisableAuthenticatorData>, headers: Headers, conn: DbConn) -> EmptyResult {
|
||||
let user = headers.user;
|
||||
let type_ = data.r#type.into_i32()?;
|
||||
|
||||
if !user.check_valid_password(&data.master_password_hash) {
|
||||
err!("Invalid password");
|
||||
}
|
||||
two_factor::validate_authenticator(&data.user_verification_token, &user.uuid, &data.key, true)?;
|
||||
|
||||
if let Some(twofactor) = TwoFactor::find_by_user_and_type(&user.uuid, type_, &conn).await {
|
||||
if let Some(twofactor) = TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::Authenticator, &conn).await {
|
||||
if twofactor.data == data.key {
|
||||
twofactor.delete(&conn).await?;
|
||||
Device::clear_twofactor_remember_by_user(&user.uuid, &conn).await?;
|
||||
log_user_event(EventType::UserDisabled2fa as i32, &user.uuid, headers.device.atype, &headers.ip.ip, &conn)
|
||||
.await;
|
||||
log_user_event(EventType::UserDisabled2fa, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
} else {
|
||||
err!(format!("TOTP key for user {} does not match recorded value, cannot deactivate", &user.email));
|
||||
}
|
||||
}
|
||||
|
||||
if TwoFactor::find_by_user(&user.uuid, &conn).await.is_empty() {
|
||||
super::enforce_2fa_policy(&user, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await?;
|
||||
}
|
||||
super::check_2fa_state(&user, headers.device.atype, &headers.ip.ip, &conn).await?;
|
||||
|
||||
Ok(Json(json!({
|
||||
"enabled": false,
|
||||
"keys": type_,
|
||||
"object": "twoFactorProvider"
|
||||
})))
|
||||
Ok(())
|
||||
}
|
||||
@@ -2,12 +2,12 @@ use chrono::Utc;
|
||||
use rocket::{Route, serde::json::Json};
|
||||
|
||||
use crate::{
|
||||
CONFIG,
|
||||
api::{
|
||||
ApiResult, EmptyResult, JsonResult, PasswordOrOtpData, core::log_user_event,
|
||||
core::two_factor::generate_recover_code,
|
||||
ApiResult, EmptyResult, JsonResult, PasswordOrOtpData,
|
||||
core::log_user_event,
|
||||
core::two_factor::{VerificationTokenData, generate_recover_code},
|
||||
},
|
||||
auth::Headers,
|
||||
auth::{Headers, two_factor, two_factor::DuoData},
|
||||
crypto,
|
||||
db::{
|
||||
DbConn,
|
||||
@@ -18,55 +18,7 @@ use crate::{
|
||||
};
|
||||
|
||||
pub fn routes() -> Vec<Route> {
|
||||
routes![get_duo, activate_duo, activate_duo_put,]
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
struct DuoData {
|
||||
host: String, // Duo API hostname
|
||||
ik: String, // client id
|
||||
sk: String, // client secret
|
||||
}
|
||||
|
||||
impl DuoData {
|
||||
fn global() -> Option<Self> {
|
||||
match (CONFIG._enable_duo(), CONFIG.duo_host()) {
|
||||
(true, Some(host)) => Some(Self {
|
||||
host,
|
||||
ik: CONFIG.duo_ikey().unwrap(),
|
||||
sk: CONFIG.duo_skey().unwrap(),
|
||||
}),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
fn msg(s: &str) -> Self {
|
||||
Self {
|
||||
host: s.into(),
|
||||
ik: s.into(),
|
||||
sk: s.into(),
|
||||
}
|
||||
}
|
||||
fn secret() -> Self {
|
||||
Self::msg("<global_secret>")
|
||||
}
|
||||
fn obscure(self) -> Self {
|
||||
let mut host = self.host;
|
||||
let mut ik = self.ik;
|
||||
let mut sk = self.sk;
|
||||
|
||||
let digits = 4;
|
||||
let replaced = "************";
|
||||
|
||||
host.replace_range(digits.., replaced);
|
||||
ik.replace_range(digits.., replaced);
|
||||
sk.replace_range(digits.., replaced);
|
||||
|
||||
Self {
|
||||
host,
|
||||
ik,
|
||||
sk,
|
||||
}
|
||||
}
|
||||
routes![get_duo, activate_duo, activate_duo_put, disable_duo,]
|
||||
}
|
||||
|
||||
enum DuoStatus {
|
||||
@@ -95,22 +47,19 @@ async fn get_duo(data: Json<PasswordOrOtpData>, headers: Headers, conn: DbConn)
|
||||
|
||||
data.validate(&user, false, &conn).await?;
|
||||
|
||||
let data = get_user_duo_data(&user.uuid, &conn).await;
|
||||
|
||||
let (enabled, data) = match data {
|
||||
let (enabled, duo) = match get_user_duo_data(&user.uuid, &conn).await {
|
||||
DuoStatus::Global(_) => (true, Some(DuoData::secret())),
|
||||
DuoStatus::User(data) => (true, Some(data.obscure())),
|
||||
DuoStatus::Disabled(true) => (false, Some(DuoData::msg(DISABLED_MESSAGE_DEFAULT))),
|
||||
DuoStatus::Disabled(false) => (false, None),
|
||||
};
|
||||
|
||||
let json = if let Some(data) = data {
|
||||
let duo_json = if let Some(data) = duo.as_ref() {
|
||||
json!({
|
||||
"enabled": enabled,
|
||||
"host": data.host,
|
||||
"clientSecret": data.sk,
|
||||
"clientId": data.ik,
|
||||
"object": "twoFactorDuo"
|
||||
})
|
||||
} else {
|
||||
json!({
|
||||
@@ -118,11 +67,13 @@ async fn get_duo(data: Json<PasswordOrOtpData>, headers: Headers, conn: DbConn)
|
||||
"host": null,
|
||||
"clientSecret": null,
|
||||
"clientId": null,
|
||||
"object": "twoFactorDuo"
|
||||
})
|
||||
};
|
||||
|
||||
Ok(Json(json))
|
||||
Ok(Json(rocket::serde::json::json!({
|
||||
"duo": duo_json,
|
||||
"userVerificationToken": two_factor::duo_token(user.uuid, duo, enabled),
|
||||
})))
|
||||
}
|
||||
|
||||
#[derive(Deserialize)]
|
||||
@@ -131,8 +82,7 @@ struct EnableDuoData {
|
||||
host: String,
|
||||
client_secret: String,
|
||||
client_id: String,
|
||||
master_password_hash: Option<String>,
|
||||
otp: Option<String>,
|
||||
user_verification_token: String,
|
||||
}
|
||||
|
||||
impl From<EnableDuoData> for DuoData {
|
||||
@@ -159,12 +109,7 @@ async fn activate_duo(data: Json<EnableDuoData>, headers: Headers, conn: DbConn)
|
||||
let data: EnableDuoData = data.into_inner();
|
||||
let mut user = headers.user;
|
||||
|
||||
PasswordOrOtpData {
|
||||
master_password_hash: data.master_password_hash.clone(),
|
||||
otp: data.otp.clone(),
|
||||
}
|
||||
.validate(&user, true, &conn)
|
||||
.await?;
|
||||
two_factor::validate_duo(&data.user_verification_token, &user.uuid, None, false)?;
|
||||
|
||||
let (data, data_str) = if check_duo_fields_custom(&data) {
|
||||
let data_req: DuoData = data.into();
|
||||
@@ -181,14 +126,15 @@ async fn activate_duo(data: Json<EnableDuoData>, headers: Headers, conn: DbConn)
|
||||
|
||||
generate_recover_code(&mut user, &conn).await;
|
||||
|
||||
log_user_event(EventType::UserUpdated2fa as i32, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
log_user_event(EventType::UserUpdated2fa, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
|
||||
Ok(Json(json!({
|
||||
"enabled": true,
|
||||
"host": data.host,
|
||||
"clientSecret": data.sk,
|
||||
"clientId": data.ik,
|
||||
"object": "twoFactorDuo"
|
||||
"duo": json!({
|
||||
"enabled": true,
|
||||
"host": data.host,
|
||||
"clientSecret": data.sk,
|
||||
"clientId": data.ik,
|
||||
}),
|
||||
})))
|
||||
}
|
||||
|
||||
@@ -197,6 +143,29 @@ async fn activate_duo_put(data: Json<EnableDuoData>, headers: Headers, conn: DbC
|
||||
activate_duo(data, headers, conn).await
|
||||
}
|
||||
|
||||
#[delete("/two-factor/duo", data = "<data>")]
|
||||
async fn disable_duo(data: Json<VerificationTokenData>, headers: Headers, conn: DbConn) -> EmptyResult {
|
||||
let user = headers.user;
|
||||
|
||||
if let Some(twofactor) = TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::Duo, &conn).await {
|
||||
// Apply the same transformation than in `get_duo` to check we are disabling the correct one
|
||||
let duo = match to_user_duo_data(&twofactor) {
|
||||
DuoStatus::Global(_) => Some(DuoData::secret()),
|
||||
DuoStatus::User(data) => Some(data.obscure()),
|
||||
DuoStatus::Disabled(_) => None,
|
||||
};
|
||||
|
||||
two_factor::validate_duo(&data.user_verification_token, &user.uuid, duo.as_ref(), true)?;
|
||||
|
||||
twofactor.delete(&conn).await?;
|
||||
log_user_event(EventType::UserDisabled2fa, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
}
|
||||
|
||||
super::check_2fa_state(&user, headers.device.atype, &headers.ip.ip, &conn).await?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn duo_api_request(method: &str, path: &str, params: &str, data: &DuoData) -> EmptyResult {
|
||||
use reqwest::{Method, header};
|
||||
use std::str::FromStr;
|
||||
@@ -222,13 +191,15 @@ async fn duo_api_request(method: &str, path: &str, params: &str, data: &DuoData)
|
||||
}
|
||||
|
||||
async fn get_user_duo_data(user_id: &UserId, conn: &DbConn) -> DuoStatus {
|
||||
let type_ = TwoFactorType::Duo as i32;
|
||||
|
||||
// If the user doesn't have an entry, disabled
|
||||
let Some(twofactor) = TwoFactor::find_by_user_and_type(user_id, type_, conn).await else {
|
||||
let Some(twofactor) = TwoFactor::find_by_user_and_type(user_id, TwoFactorType::Duo, conn).await else {
|
||||
return DuoStatus::Disabled(DuoData::global().is_some());
|
||||
};
|
||||
|
||||
to_user_duo_data(&twofactor)
|
||||
}
|
||||
|
||||
fn to_user_duo_data(twofactor: &TwoFactor) -> DuoStatus {
|
||||
// If the user has the required values, we use those
|
||||
if let Ok(data) = serde_json::from_str(&twofactor.data) {
|
||||
return DuoStatus::User(data);
|
||||
|
||||
@@ -5,9 +5,12 @@ use crate::{
|
||||
CONFIG,
|
||||
api::{
|
||||
EmptyResult, JsonResult, PasswordOrOtpData,
|
||||
core::{log_user_event, two_factor::generate_recover_code},
|
||||
core::{
|
||||
log_user_event,
|
||||
two_factor::{VerificationTokenData, generate_recover_code},
|
||||
},
|
||||
},
|
||||
auth::{ClientHeaders, Headers},
|
||||
auth::{ClientHeaders, Headers, two_factor},
|
||||
crypto,
|
||||
db::{
|
||||
DbConn,
|
||||
@@ -18,7 +21,7 @@ use crate::{
|
||||
};
|
||||
|
||||
pub fn routes() -> Vec<Route> {
|
||||
routes![get_email, send_email_login, send_email, email,]
|
||||
routes![get_email, send_email_login, send_email, email, disable_email]
|
||||
}
|
||||
|
||||
#[derive(Deserialize)]
|
||||
@@ -116,8 +119,8 @@ async fn send_email_login(data: Json<SendEmailLoginData>, client_headers: Client
|
||||
|
||||
/// Generate the token, save the data for later verification and send email to user
|
||||
pub async fn send_token(user_id: &UserId, conn: &DbConn) -> EmptyResult {
|
||||
let type_ = TwoFactorType::Email as i32;
|
||||
let mut twofactor = TwoFactor::find_by_user_and_type(user_id, type_, conn).await.map_res("Two factor not found")?;
|
||||
let mut twofactor =
|
||||
TwoFactor::find_by_user_and_type(user_id, TwoFactorType::Email, conn).await.map_res("Two factor not found")?;
|
||||
|
||||
let generated_token = crypto::generate_email_token(CONFIG.email_token_size());
|
||||
|
||||
@@ -140,18 +143,19 @@ async fn get_email(data: Json<PasswordOrOtpData>, headers: Headers, conn: DbConn
|
||||
data.validate(&user, false, &conn).await?;
|
||||
|
||||
let (enabled, mfa_email) =
|
||||
match TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::Email as i32, &conn).await {
|
||||
Some(x) => {
|
||||
let twofactor_data = EmailTokenData::from_json(&x.data)?;
|
||||
(true, json!(twofactor_data.email))
|
||||
}
|
||||
_ => (false, serde_json::value::Value::Null),
|
||||
if let Some(x) = TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::Email, &conn).await {
|
||||
let twofactor_data = EmailTokenData::from_json(&x.data)?;
|
||||
(true, Some(twofactor_data.email))
|
||||
} else {
|
||||
(false, None)
|
||||
};
|
||||
|
||||
Ok(Json(json!({
|
||||
"email": mfa_email,
|
||||
"enabled": enabled,
|
||||
"object": "twoFactorEmail"
|
||||
Ok(Json(rocket::serde::json::json!({
|
||||
"email": rocket::serde::json::json!({
|
||||
"enabled": enabled,
|
||||
"email": mfa_email,
|
||||
}),
|
||||
"userVerificationToken": two_factor::email_token(user.uuid, mfa_email, enabled),
|
||||
})))
|
||||
}
|
||||
|
||||
@@ -160,30 +164,22 @@ async fn get_email(data: Json<PasswordOrOtpData>, headers: Headers, conn: DbConn
|
||||
struct SendEmailData {
|
||||
/// Email where 2FA codes will be sent to, can be different than user email account.
|
||||
email: String,
|
||||
master_password_hash: Option<String>,
|
||||
otp: Option<String>,
|
||||
user_verification_token: String,
|
||||
}
|
||||
|
||||
/// Send a verification email to the specified email address to check whether it exists/belongs to user.
|
||||
#[post("/two-factor/send-email", data = "<data>")]
|
||||
async fn send_email(data: Json<SendEmailData>, headers: Headers, conn: DbConn) -> EmptyResult {
|
||||
async fn send_email(data: Json<SendEmailData>, headers: Headers, conn: DbConn) -> JsonResult {
|
||||
let data: SendEmailData = data.into_inner();
|
||||
let user = headers.user;
|
||||
|
||||
PasswordOrOtpData {
|
||||
master_password_hash: data.master_password_hash,
|
||||
otp: data.otp,
|
||||
}
|
||||
.validate(&user, false, &conn)
|
||||
.await?;
|
||||
two_factor::validate_email(&data.user_verification_token, &user.uuid, data.email.clone(), false)?;
|
||||
|
||||
if !CONFIG._enable_email_2fa() {
|
||||
err!("Email 2FA is disabled")
|
||||
}
|
||||
|
||||
let type_ = TwoFactorType::Email as i32;
|
||||
|
||||
if let Some(tf) = TwoFactor::find_by_user_and_type(&user.uuid, type_, &conn).await {
|
||||
if let Some(tf) = TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::Email, &conn).await {
|
||||
tf.delete(&conn).await?;
|
||||
}
|
||||
|
||||
@@ -191,12 +187,13 @@ async fn send_email(data: Json<SendEmailData>, headers: Headers, conn: DbConn) -
|
||||
let twofactor_data = EmailTokenData::new(data.email, Some(generated_token));
|
||||
|
||||
// Uses EmailVerificationChallenge as type to show that it's not verified yet.
|
||||
let twofactor = TwoFactor::new(user.uuid, TwoFactorType::EmailVerificationChallenge, twofactor_data.to_json());
|
||||
let twofactor =
|
||||
TwoFactor::new(user.uuid.clone(), TwoFactorType::EmailVerificationChallenge, twofactor_data.to_json());
|
||||
twofactor.save(&conn).await?;
|
||||
|
||||
mail::send_token(&twofactor_data.email, &twofactor_data.last_token.map_res("Token is empty")?).await?;
|
||||
|
||||
Ok(())
|
||||
Ok(Json(json!({})))
|
||||
}
|
||||
|
||||
#[derive(Deserialize, Serialize)]
|
||||
@@ -204,8 +201,7 @@ async fn send_email(data: Json<SendEmailData>, headers: Headers, conn: DbConn) -
|
||||
struct EmailData {
|
||||
email: String,
|
||||
token: String,
|
||||
master_password_hash: Option<String>,
|
||||
otp: Option<String>,
|
||||
user_verification_token: String,
|
||||
}
|
||||
|
||||
/// Verify email belongs to user and can be used for 2FA email codes.
|
||||
@@ -214,17 +210,11 @@ async fn email(data: Json<EmailData>, headers: Headers, conn: DbConn) -> JsonRes
|
||||
let data: EmailData = data.into_inner();
|
||||
let mut user = headers.user;
|
||||
|
||||
// This is the last step in the verification process, delete the otp directly afterwards
|
||||
PasswordOrOtpData {
|
||||
master_password_hash: data.master_password_hash,
|
||||
otp: data.otp,
|
||||
}
|
||||
.validate(&user, true, &conn)
|
||||
.await?;
|
||||
two_factor::validate_email(&data.user_verification_token, &user.uuid, data.email, false)?;
|
||||
|
||||
let type_ = TwoFactorType::EmailVerificationChallenge as i32;
|
||||
let mut twofactor =
|
||||
TwoFactor::find_by_user_and_type(&user.uuid, type_, &conn).await.map_res("Two factor not found")?;
|
||||
let mut twofactor = TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::EmailVerificationChallenge, &conn)
|
||||
.await
|
||||
.map_res("Two factor not found")?;
|
||||
|
||||
let mut email_data = EmailTokenData::from_json(&twofactor.data)?;
|
||||
|
||||
@@ -243,13 +233,26 @@ async fn email(data: Json<EmailData>, headers: Headers, conn: DbConn) -> JsonRes
|
||||
|
||||
generate_recover_code(&mut user, &conn).await;
|
||||
|
||||
log_user_event(EventType::UserUpdated2fa as i32, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
log_user_event(EventType::UserUpdated2fa, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
|
||||
Ok(Json(json!({
|
||||
"email": email_data.email,
|
||||
"enabled": "true",
|
||||
"object": "twoFactorEmail"
|
||||
})))
|
||||
Ok(Json(json!({})))
|
||||
}
|
||||
|
||||
#[delete("/two-factor/email", data = "<data>")]
|
||||
async fn disable_email(data: Json<VerificationTokenData>, headers: Headers, conn: DbConn) -> EmptyResult {
|
||||
let user = headers.user;
|
||||
|
||||
if let Some(twofactor) = TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::Email, &conn).await {
|
||||
let twofactor_data = EmailTokenData::from_json(&twofactor.data)?;
|
||||
two_factor::validate_email(&data.user_verification_token, &user.uuid, twofactor_data.email, true)?;
|
||||
|
||||
twofactor.delete(&conn).await?;
|
||||
log_user_event(EventType::UserDisabled2fa, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
}
|
||||
|
||||
super::check_2fa_state(&user, headers.device.atype, &headers.ip.ip, &conn).await?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Validate the email code when used as TwoFactor token mechanism
|
||||
@@ -261,9 +264,8 @@ pub async fn validate_email_code_str(
|
||||
conn: &DbConn,
|
||||
) -> EmptyResult {
|
||||
let mut email_data = EmailTokenData::from_json(data)?;
|
||||
let mut twofactor = TwoFactor::find_by_user_and_type(user_id, TwoFactorType::Email as i32, conn)
|
||||
.await
|
||||
.map_res("Two factor not found")?;
|
||||
let mut twofactor =
|
||||
TwoFactor::find_by_user_and_type(user_id, TwoFactorType::Email, conn).await.map_res("Two factor not found")?;
|
||||
let Some(issued_token) = &email_data.last_token else {
|
||||
err!(
|
||||
format!("No token available! IP: {ip}"),
|
||||
|
||||
@@ -7,10 +7,7 @@ use serde_json::Value;
|
||||
|
||||
use crate::{
|
||||
CONFIG,
|
||||
api::{
|
||||
EmptyResult, JsonResult, PasswordOrOtpData,
|
||||
core::{log_event, log_user_event},
|
||||
},
|
||||
api::{EmptyResult, JsonResult, PasswordOrOtpData, core::log_event},
|
||||
auth::Headers,
|
||||
crypto,
|
||||
db::{
|
||||
@@ -21,7 +18,6 @@ use crate::{
|
||||
},
|
||||
},
|
||||
mail,
|
||||
util::NumberOrString,
|
||||
};
|
||||
|
||||
pub mod authenticator;
|
||||
@@ -69,7 +65,7 @@ pub fn is_twofactor_provider_usable(provider_type: &TwoFactorType, provider_data
|
||||
}
|
||||
|
||||
pub fn routes() -> Vec<Route> {
|
||||
let mut routes = routes![get_twofactor, get_recover, disable_twofactor, get_device_verification_settings];
|
||||
let mut routes = routes![get_twofactor, get_recover, get_device_verification_settings];
|
||||
|
||||
routes.append(&mut authenticator::routes());
|
||||
routes.append(&mut duo::routes());
|
||||
@@ -81,6 +77,12 @@ pub fn routes() -> Vec<Route> {
|
||||
routes
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct VerificationTokenData {
|
||||
user_verification_token: String,
|
||||
}
|
||||
|
||||
#[get("/two-factor")]
|
||||
async fn get_twofactor(headers: Headers, conn: DbConn) -> Json<Value> {
|
||||
let twofactors = TwoFactor::find_by_user(&headers.user.uuid, &conn).await;
|
||||
@@ -120,45 +122,14 @@ async fn generate_recover_code(user: &mut User, conn: &DbConn) {
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct DisableTwoFactorData {
|
||||
master_password_hash: Option<String>,
|
||||
otp: Option<String>,
|
||||
r#type: NumberOrString,
|
||||
}
|
||||
|
||||
#[put("/two-factor/disable", data = "<data>")]
|
||||
async fn disable_twofactor(data: Json<DisableTwoFactorData>, headers: Headers, conn: DbConn) -> JsonResult {
|
||||
let data: DisableTwoFactorData = data.into_inner();
|
||||
let user = headers.user;
|
||||
|
||||
// Delete directly after a valid token has been provided
|
||||
PasswordOrOtpData {
|
||||
master_password_hash: data.master_password_hash,
|
||||
otp: data.otp,
|
||||
/// Call after a 2FA provider, or one of its keys, was removed. No remembered device may keep skipping
|
||||
/// the providers that are left, and once every provider is gone the 2FA policy applies.
|
||||
pub async fn check_2fa_state(user: &User, device_type: i32, ip: &std::net::IpAddr, conn: &DbConn) -> EmptyResult {
|
||||
Device::clear_twofactor_remember_by_user(&user.uuid, conn).await?;
|
||||
if TwoFactor::find_by_user(&user.uuid, conn).await.is_empty() {
|
||||
enforce_2fa_policy(user, &user.uuid, device_type, ip, conn).await?;
|
||||
}
|
||||
.validate(&user, true, &conn)
|
||||
.await?;
|
||||
|
||||
let type_ = data.r#type.into_i32()?;
|
||||
|
||||
if let Some(twofactor) = TwoFactor::find_by_user_and_type(&user.uuid, type_, &conn).await {
|
||||
twofactor.delete(&conn).await?;
|
||||
Device::clear_twofactor_remember_by_user(&user.uuid, &conn).await?;
|
||||
log_user_event(EventType::UserDisabled2fa as i32, &user.uuid, headers.device.atype, &headers.ip.ip, &conn)
|
||||
.await;
|
||||
}
|
||||
|
||||
if TwoFactor::find_by_user(&user.uuid, &conn).await.is_empty() {
|
||||
enforce_2fa_policy(&user, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await?;
|
||||
}
|
||||
|
||||
Ok(Json(json!({
|
||||
"enabled": false,
|
||||
"type": type_,
|
||||
"object": "twoFactorProvider"
|
||||
})))
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub async fn enforce_2fa_policy(
|
||||
|
||||
@@ -72,8 +72,7 @@ async fn request_otp(headers: Headers, conn: DbConn) -> EmptyResult {
|
||||
let user = headers.user;
|
||||
|
||||
// Only one Protected Action per user is allowed to take place, delete the previous one
|
||||
if let Some(pa) = TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::ProtectedActions as i32, &conn).await
|
||||
{
|
||||
if let Some(pa) = TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::ProtectedActions, &conn).await {
|
||||
let pa_data = ProtectedActionData::from_json(&pa.data)?;
|
||||
let elapsed = pa_data.time_since_sent().num_seconds();
|
||||
let delay = 30;
|
||||
@@ -125,7 +124,7 @@ pub async fn validate_protected_action_otp(
|
||||
delete_if_valid: bool,
|
||||
conn: &DbConn,
|
||||
) -> EmptyResult {
|
||||
let mut pa = TwoFactor::find_by_user_and_type(user_id, TwoFactorType::ProtectedActions as i32, conn)
|
||||
let mut pa = TwoFactor::find_by_user_and_type(user_id, TwoFactorType::ProtectedActions, conn)
|
||||
.await
|
||||
.map_res("Protected action token not found, try sending the code again or restart the process")?;
|
||||
let mut pa_data = ProtectedActionData::from_json(&pa.data)?;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
use std::{str::FromStr, sync::LazyLock, time::Duration};
|
||||
use std::{collections::HashSet, str::FromStr, sync::LazyLock, time::Duration};
|
||||
|
||||
use rocket::{Route, serde::json::Json};
|
||||
use serde_json::Value;
|
||||
@@ -18,16 +18,18 @@ use crate::{
|
||||
CONFIG,
|
||||
api::{
|
||||
EmptyResult, JsonResult, PasswordOrOtpData,
|
||||
core::{log_user_event, two_factor::generate_recover_code},
|
||||
core::{
|
||||
log_user_event,
|
||||
two_factor::{VerificationTokenData, generate_recover_code},
|
||||
},
|
||||
},
|
||||
auth::Headers,
|
||||
auth::{Headers, two_factor},
|
||||
crypto::ct_eq,
|
||||
db::{
|
||||
DbConn,
|
||||
models::{Device, EventType, TwoFactor, TwoFactorType, UserId},
|
||||
models::{EventType, TwoFactor, TwoFactorType, UserId},
|
||||
},
|
||||
error::Error,
|
||||
util::NumberOrString,
|
||||
};
|
||||
|
||||
static WEBAUTHN: LazyLock<Webauthn> = LazyLock::new(|| {
|
||||
@@ -45,7 +47,14 @@ static WEBAUTHN: LazyLock<Webauthn> = LazyLock::new(|| {
|
||||
});
|
||||
|
||||
pub fn routes() -> Vec<Route> {
|
||||
routes![get_webauthn, generate_webauthn_challenge, activate_webauthn, activate_webauthn_put, delete_webauthn,]
|
||||
routes![
|
||||
get_webauthn,
|
||||
generate_webauthn_challenge,
|
||||
activate_webauthn,
|
||||
activate_webauthn_put,
|
||||
delete_webauthn,
|
||||
delete_webauthns
|
||||
]
|
||||
}
|
||||
|
||||
// Some old u2f structs still needed for migrating from u2f to WebAuthn
|
||||
@@ -119,34 +128,36 @@ async fn get_webauthn(data: Json<PasswordOrOtpData>, headers: Headers, conn: DbC
|
||||
data.validate(&user, false, &conn).await?;
|
||||
|
||||
let (enabled, registrations) = get_webauthn_registrations(&user.uuid, &conn).await?;
|
||||
let keys: Vec<i32> = registrations.iter().map(|r| r.id).collect();
|
||||
let registrations_json: Vec<Value> = registrations.iter().map(WebauthnRegistration::to_json).collect();
|
||||
|
||||
Ok(Json(json!({
|
||||
"enabled": enabled,
|
||||
"keys": registrations_json,
|
||||
"object": "twoFactorWebAuthn"
|
||||
"webAuthn": json!({
|
||||
"enabled": enabled,
|
||||
"keys": registrations_json,
|
||||
}),
|
||||
"userVerificationToken": two_factor::webauthn_token(user.uuid, keys, enabled),
|
||||
})))
|
||||
}
|
||||
|
||||
#[post("/two-factor/get-webauthn-challenge", data = "<data>")]
|
||||
async fn generate_webauthn_challenge(data: Json<PasswordOrOtpData>, headers: Headers, conn: DbConn) -> JsonResult {
|
||||
let data: PasswordOrOtpData = data.into_inner();
|
||||
async fn generate_webauthn_challenge(data: Json<VerificationTokenData>, headers: Headers, conn: DbConn) -> JsonResult {
|
||||
let user = headers.user;
|
||||
|
||||
data.validate(&user, false, &conn).await?;
|
||||
|
||||
let registrations = get_webauthn_registrations(&user.uuid, &conn)
|
||||
.await?
|
||||
.1
|
||||
let (enabled, registrations) = get_webauthn_registrations(&user.uuid, &conn).await?;
|
||||
let keys: Vec<i32> = registrations.iter().map(|r| r.id).collect();
|
||||
let creds = registrations
|
||||
.into_iter()
|
||||
.map(|r| r.credential.cred_id().to_owned()) // We return the credentialIds to the clients to avoid double registering
|
||||
.collect();
|
||||
|
||||
two_factor::validate_webauthn(&data.user_verification_token, &user.uuid, &keys, enabled)?;
|
||||
|
||||
let (mut challenge, state) = WEBAUTHN.start_passkey_registration(
|
||||
Uuid::from_str(&user.uuid).expect("Failed to parse UUID"), // Should never fail
|
||||
&user.email,
|
||||
user.display_name(),
|
||||
Some(registrations),
|
||||
Some(creds),
|
||||
)?;
|
||||
|
||||
let mut state = serde_json::to_value(&state)?;
|
||||
@@ -166,17 +177,19 @@ async fn generate_webauthn_challenge(data: Json<PasswordOrOtpData>, headers: Hea
|
||||
let mut challenge_value = serde_json::to_value(challenge.public_key)?;
|
||||
challenge_value["status"] = "ok".into();
|
||||
challenge_value["errorMessage"] = "".into();
|
||||
Ok(Json(challenge_value))
|
||||
|
||||
Ok(Json(json!({
|
||||
"options": challenge_value
|
||||
})))
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct EnableWebauthnData {
|
||||
id: NumberOrString, // 1..5
|
||||
id: i32,
|
||||
name: String,
|
||||
device_response: RegisterPublicKeyCredentialCopy,
|
||||
master_password_hash: Option<String>,
|
||||
otp: Option<String>,
|
||||
user_verification_token: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize)]
|
||||
@@ -257,16 +270,14 @@ async fn activate_webauthn(data: Json<EnableWebauthnData>, headers: Headers, con
|
||||
let data: EnableWebauthnData = data.into_inner();
|
||||
let mut user = headers.user;
|
||||
|
||||
PasswordOrOtpData {
|
||||
master_password_hash: data.master_password_hash,
|
||||
otp: data.otp,
|
||||
}
|
||||
.validate(&user, true, &conn)
|
||||
.await?;
|
||||
let mut registrations: Vec<_> = get_webauthn_registrations(&user.uuid, &conn).await?.1;
|
||||
let keys: Vec<i32> = registrations.iter().map(|r| r.id).collect();
|
||||
two_factor::validate_webauthn(&data.user_verification_token, &user.uuid, &keys, !keys.is_empty())?;
|
||||
|
||||
// Retrieve and delete the saved challenge state
|
||||
let type_ = TwoFactorType::WebauthnRegisterChallenge as i32;
|
||||
let state = if let Some(tf) = TwoFactor::find_by_user_and_type(&user.uuid, type_, &conn).await {
|
||||
let state = if let Some(tf) =
|
||||
TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::WebauthnRegisterChallenge, &conn).await
|
||||
{
|
||||
let state: PasskeyRegistration = serde_json::from_str(&tf.data)?;
|
||||
tf.delete(&conn).await?;
|
||||
state
|
||||
@@ -277,10 +288,9 @@ async fn activate_webauthn(data: Json<EnableWebauthnData>, headers: Headers, con
|
||||
// Verify the credentials with the saved state
|
||||
let credential = WEBAUTHN.finish_passkey_registration(&data.device_response.into(), &state)?;
|
||||
|
||||
let mut registrations: Vec<_> = get_webauthn_registrations(&user.uuid, &conn).await?.1;
|
||||
// TODO: Check for repeated ID's
|
||||
registrations.push(WebauthnRegistration {
|
||||
id: data.id.into_i32()?,
|
||||
id: data.id,
|
||||
name: data.name,
|
||||
migrated: false,
|
||||
|
||||
@@ -293,13 +303,13 @@ async fn activate_webauthn(data: Json<EnableWebauthnData>, headers: Headers, con
|
||||
.await?;
|
||||
generate_recover_code(&mut user, &conn).await;
|
||||
|
||||
log_user_event(EventType::UserUpdated2fa as i32, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
log_user_event(EventType::UserUpdated2fa, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
|
||||
let keys_json: Vec<Value> = registrations.iter().map(WebauthnRegistration::to_json).collect();
|
||||
Ok(Json(json!({
|
||||
"enabled": true,
|
||||
"keys": keys_json,
|
||||
"object": "twoFactorU2f"
|
||||
"webAuthn": json!({
|
||||
"enabled": true,
|
||||
"keys": registrations.iter().map(WebauthnRegistration::to_json).collect::<Vec<Value>>(),
|
||||
}),
|
||||
})))
|
||||
}
|
||||
|
||||
@@ -310,58 +320,87 @@ async fn activate_webauthn_put(data: Json<EnableWebauthnData>, headers: Headers,
|
||||
|
||||
#[derive(Debug, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct DeleteU2FData {
|
||||
id: NumberOrString,
|
||||
master_password_hash: String,
|
||||
struct DeleteWebauthnData {
|
||||
id: i32,
|
||||
user_verification_token: String,
|
||||
}
|
||||
|
||||
#[delete("/two-factor/webauthn", data = "<data>")]
|
||||
async fn delete_webauthn(data: Json<DeleteU2FData>, headers: Headers, conn: DbConn) -> JsonResult {
|
||||
let id = data.id.into_i32()?;
|
||||
if !headers.user.check_valid_password(&data.master_password_hash) {
|
||||
err!("Invalid password");
|
||||
}
|
||||
async fn delete_webauthn(data: Json<DeleteWebauthnData>, headers: Headers, conn: DbConn) -> JsonResult {
|
||||
inner_delete_webauthns(&data.user_verification_token, |key| key.id != data.id, headers, &conn).await
|
||||
}
|
||||
|
||||
let Some(mut tf) =
|
||||
TwoFactor::find_by_user_and_type(&headers.user.uuid, TwoFactorType::Webauthn as i32, &conn).await
|
||||
else {
|
||||
#[delete("/two-factor/webauthn/all", data = "<data>")]
|
||||
async fn delete_webauthns(data: Json<VerificationTokenData>, headers: Headers, conn: DbConn) -> JsonResult {
|
||||
inner_delete_webauthns(&data.user_verification_token, |_| false, headers, &conn).await
|
||||
}
|
||||
|
||||
async fn inner_delete_webauthns(
|
||||
token: &str,
|
||||
retain: impl Fn(&WebauthnRegistration) -> bool,
|
||||
headers: Headers,
|
||||
conn: &DbConn,
|
||||
) -> JsonResult {
|
||||
let user = headers.user;
|
||||
|
||||
let Some(mut tf) = TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::Webauthn, conn).await else {
|
||||
err!("Webauthn data not found!")
|
||||
};
|
||||
|
||||
let mut data: Vec<WebauthnRegistration> = serde_json::from_str(&tf.data)?;
|
||||
let mut keys: Vec<WebauthnRegistration> = serde_json::from_str(&tf.data)?;
|
||||
let keys_id: Vec<i32> = keys.iter().map(|r| r.id).collect();
|
||||
|
||||
let Some(item_pos) = data.iter().position(|r| r.id == id) else {
|
||||
two_factor::validate_webauthn(token, &user.uuid, &keys_id, true)?;
|
||||
|
||||
let mut removed: HashSet<Vec<u8>> = HashSet::new();
|
||||
let mut migrated = false;
|
||||
|
||||
keys.retain(|key| {
|
||||
let retained = retain(key);
|
||||
if !retained {
|
||||
removed.insert(key.credential.cred_id().to_vec());
|
||||
migrated = migrated || key.migrated;
|
||||
}
|
||||
retained
|
||||
});
|
||||
|
||||
if removed.is_empty() {
|
||||
err!("Webauthn entry not found")
|
||||
};
|
||||
}
|
||||
|
||||
let removed_item = data.remove(item_pos);
|
||||
tf.data = serde_json::to_string(&data)?;
|
||||
tf.save(&conn).await?;
|
||||
drop(tf);
|
||||
Device::clear_twofactor_remember_by_user(&headers.user.uuid, &conn).await?;
|
||||
if keys.is_empty() {
|
||||
tf.delete(conn).await?;
|
||||
log_user_event(EventType::UserDisabled2fa, &user.uuid, headers.device.atype, &headers.ip.ip, conn).await;
|
||||
} else {
|
||||
tf.data = serde_json::to_string(&keys)?;
|
||||
tf.save(conn).await?;
|
||||
drop(tf);
|
||||
}
|
||||
|
||||
// If entry is migrated from u2f, delete the u2f entry as well
|
||||
if let Some(mut u2f) = TwoFactor::find_by_user_and_type(&headers.user.uuid, TwoFactorType::U2f as i32, &conn).await
|
||||
{
|
||||
let mut data: Vec<U2FRegistration> = if let Ok(d) = serde_json::from_str(&u2f.data) {
|
||||
d
|
||||
} else {
|
||||
if migrated && let Some(mut u2f) = TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::U2f, conn).await {
|
||||
let Ok(mut data) = serde_json::from_str::<Vec<U2FRegistration>>(&u2f.data) else {
|
||||
err!("Error parsing U2F data")
|
||||
};
|
||||
|
||||
data.retain(|r| r.reg.key_handle != removed_item.credential.cred_id().as_slice());
|
||||
let new_data_str = serde_json::to_string(&data)?;
|
||||
data.retain(|old| !removed.contains(&old.reg.key_handle));
|
||||
|
||||
u2f.data = new_data_str;
|
||||
u2f.save(&conn).await?;
|
||||
if data.is_empty() {
|
||||
u2f.delete(conn).await?;
|
||||
} else {
|
||||
let new_data_str = serde_json::to_string(&data)?;
|
||||
u2f.data = new_data_str;
|
||||
u2f.save(conn).await?;
|
||||
}
|
||||
}
|
||||
|
||||
let keys_json: Vec<Value> = data.iter().map(WebauthnRegistration::to_json).collect();
|
||||
super::check_2fa_state(&user, headers.device.atype, &headers.ip.ip, conn).await?;
|
||||
|
||||
Ok(Json(json!({
|
||||
"enabled": true,
|
||||
"keys": keys_json,
|
||||
"object": "twoFactorU2f"
|
||||
"webAuthn": json!({
|
||||
"enabled": !keys.is_empty(),
|
||||
"keys": keys.iter().map(WebauthnRegistration::to_json).collect::<Vec<Value>>(),
|
||||
}),
|
||||
})))
|
||||
}
|
||||
|
||||
@@ -369,8 +408,7 @@ pub async fn get_webauthn_registrations(
|
||||
user_id: &UserId,
|
||||
conn: &DbConn,
|
||||
) -> Result<(bool, Vec<WebauthnRegistration>), Error> {
|
||||
let type_ = TwoFactorType::Webauthn as i32;
|
||||
match TwoFactor::find_by_user_and_type(user_id, type_, conn).await {
|
||||
match TwoFactor::find_by_user_and_type(user_id, TwoFactorType::Webauthn, conn).await {
|
||||
Some(tf) => Ok((tf.enabled, serde_json::from_str(&tf.data)?)),
|
||||
None => Ok((false, Vec::new())), // If no data, return empty list
|
||||
}
|
||||
@@ -417,8 +455,9 @@ pub async fn generate_webauthn_login(user_id: &UserId, conn: &DbConn) -> JsonRes
|
||||
}
|
||||
|
||||
pub async fn validate_webauthn_login(user_id: &UserId, response: &str, conn: &DbConn) -> EmptyResult {
|
||||
let type_ = TwoFactorType::WebauthnLoginChallenge as i32;
|
||||
let mut state = if let Some(tf) = TwoFactor::find_by_user_and_type(user_id, type_, conn).await {
|
||||
let mut state = if let Some(tf) =
|
||||
TwoFactor::find_by_user_and_type(user_id, TwoFactorType::WebauthnLoginChallenge, conn).await
|
||||
{
|
||||
let state: PasskeyAuthentication = serde_json::from_str(&tf.data)?;
|
||||
tf.delete(conn).await?;
|
||||
state
|
||||
|
||||
@@ -10,9 +10,12 @@ use crate::{
|
||||
CONFIG,
|
||||
api::{
|
||||
EmptyResult, JsonResult, PasswordOrOtpData,
|
||||
core::{log_user_event, two_factor::generate_recover_code},
|
||||
core::{
|
||||
log_user_event,
|
||||
two_factor::{VerificationTokenData, generate_recover_code},
|
||||
},
|
||||
},
|
||||
auth::Headers,
|
||||
auth::{Headers, two_factor},
|
||||
db::{
|
||||
DbConn,
|
||||
models::{EventType, TwoFactor, TwoFactorType},
|
||||
@@ -22,7 +25,7 @@ use crate::{
|
||||
};
|
||||
|
||||
pub fn routes() -> Vec<Route> {
|
||||
routes![generate_yubikey, activate_yubikey, activate_yubikey_put,]
|
||||
routes![generate_yubikey, activate_yubikey, activate_yubikey_put, delete_yubikeys,]
|
||||
}
|
||||
|
||||
struct HttpClientTransport {
|
||||
@@ -60,8 +63,7 @@ struct EnableYubikeyData {
|
||||
key4: Option<String>,
|
||||
key5: Option<String>,
|
||||
nfc: bool,
|
||||
master_password_hash: Option<String>,
|
||||
otp: Option<String>,
|
||||
user_verification_token: String,
|
||||
}
|
||||
|
||||
#[derive(Deserialize, Serialize, Debug)]
|
||||
@@ -125,48 +127,29 @@ async fn generate_yubikey(data: Json<PasswordOrOtpData>, headers: Headers, conn:
|
||||
data.validate(&user, false, &conn).await?;
|
||||
|
||||
let user_id = &user.uuid;
|
||||
let yubikey_type = TwoFactorType::YubiKey as i32;
|
||||
|
||||
let r = TwoFactor::find_by_user_and_type(user_id, yubikey_type, &conn).await;
|
||||
|
||||
if let Some(r) = r {
|
||||
let yubikey_metadata: YubikeyMetadata = serde_json::from_str(&r.data)?;
|
||||
|
||||
let mut result = jsonify_yubikeys(yubikey_metadata.keys);
|
||||
|
||||
result["enabled"] = Value::Bool(true);
|
||||
result["nfc"] = Value::Bool(yubikey_metadata.nfc);
|
||||
result["object"] = Value::String("twoFactorU2f".to_owned());
|
||||
|
||||
Ok(Json(result))
|
||||
} else {
|
||||
Ok(Json(json!({
|
||||
"enabled": false,
|
||||
"object": "twoFactorU2f",
|
||||
})))
|
||||
}
|
||||
let (enabled, keys, yubikey_json) =
|
||||
if let Some(r) = TwoFactor::find_by_user_and_type(user_id, TwoFactorType::YubiKey, &conn).await {
|
||||
let yubikey_metadata: YubikeyMetadata = serde_json::from_str(&r.data)?;
|
||||
let enabled = !yubikey_metadata.keys.is_empty();
|
||||
let mut result = jsonify_yubikeys(yubikey_metadata.keys.clone());
|
||||
result["enabled"] = Value::Bool(enabled);
|
||||
result["nfc"] = Value::Bool(yubikey_metadata.nfc);
|
||||
(enabled, yubikey_metadata.keys, result)
|
||||
} else {
|
||||
(false, Vec::new(), json!({"enabled": false}))
|
||||
};
|
||||
Ok(Json(json!({
|
||||
"yubiKey": yubikey_json,
|
||||
"userVerificationToken": two_factor::yubikey_token(user.uuid, keys, enabled),
|
||||
})))
|
||||
}
|
||||
|
||||
#[post("/two-factor/yubikey", data = "<data>")]
|
||||
async fn activate_yubikey(data: Json<EnableYubikeyData>, headers: Headers, conn: DbConn) -> JsonResult {
|
||||
let data: EnableYubikeyData = data.into_inner();
|
||||
let mut user = headers.user;
|
||||
|
||||
PasswordOrOtpData {
|
||||
master_password_hash: data.master_password_hash.clone(),
|
||||
otp: data.otp.clone(),
|
||||
}
|
||||
.validate(&user, true, &conn)
|
||||
.await?;
|
||||
|
||||
// Check if we already have some data
|
||||
let mut yubikey_data =
|
||||
match TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::YubiKey as i32, &conn).await {
|
||||
Some(data) => data,
|
||||
None => TwoFactor::new(user.uuid.clone(), TwoFactorType::YubiKey, String::new()),
|
||||
};
|
||||
|
||||
let yubikeys = parse_yubikeys(&data);
|
||||
let mut user = headers.user;
|
||||
|
||||
if yubikeys.is_empty() {
|
||||
// Return an error to prevent saving empty keys which would cause users not being able to login anymore.
|
||||
@@ -174,6 +157,17 @@ async fn activate_yubikey(data: Json<EnableYubikeyData>, headers: Headers, conn:
|
||||
err!("A key is required.");
|
||||
}
|
||||
|
||||
// Check if we already have some data
|
||||
let mut yubikey_data =
|
||||
if let Some(yd) = TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::YubiKey, &conn).await {
|
||||
let ym: YubikeyMetadata = serde_json::from_str(&yd.data)?;
|
||||
two_factor::validate_yubikey(&data.user_verification_token, &user.uuid, &ym.keys, !ym.keys.is_empty())?;
|
||||
yd
|
||||
} else {
|
||||
two_factor::validate_yubikey(&data.user_verification_token, &user.uuid, &Vec::new(), false)?;
|
||||
TwoFactor::new(user.uuid.clone(), TwoFactorType::YubiKey, String::new())
|
||||
};
|
||||
|
||||
// Ensure they are valid OTPs
|
||||
for yubikey in &yubikeys {
|
||||
if yubikey.is_empty() || yubikey.len() == 12 {
|
||||
@@ -195,15 +189,12 @@ async fn activate_yubikey(data: Json<EnableYubikeyData>, headers: Headers, conn:
|
||||
|
||||
generate_recover_code(&mut user, &conn).await;
|
||||
|
||||
log_user_event(EventType::UserUpdated2fa as i32, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
log_user_event(EventType::UserUpdated2fa, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
|
||||
let mut result = jsonify_yubikeys(yubikey_metadata.keys);
|
||||
|
||||
result["enabled"] = Value::Bool(true);
|
||||
result["nfc"] = Value::Bool(yubikey_metadata.nfc);
|
||||
result["object"] = Value::String("twoFactorU2f".to_owned());
|
||||
|
||||
Ok(Json(result))
|
||||
Ok(Json(json!({"yubiKey": result})))
|
||||
}
|
||||
|
||||
#[put("/two-factor/yubikey", data = "<data>")]
|
||||
@@ -211,6 +202,23 @@ async fn activate_yubikey_put(data: Json<EnableYubikeyData>, headers: Headers, c
|
||||
activate_yubikey(data, headers, conn).await
|
||||
}
|
||||
|
||||
#[delete("/two-factor/yubikey", data = "<data>")]
|
||||
async fn delete_yubikeys(data: Json<VerificationTokenData>, headers: Headers, conn: DbConn) -> EmptyResult {
|
||||
let user = headers.user;
|
||||
|
||||
if let Some(r) = TwoFactor::find_by_user_and_type(&user.uuid, TwoFactorType::YubiKey, &conn).await {
|
||||
let yubikey_metadata: YubikeyMetadata = serde_json::from_str(&r.data)?;
|
||||
two_factor::validate_yubikey(&data.user_verification_token, &user.uuid, &yubikey_metadata.keys, true)?;
|
||||
|
||||
r.delete(&conn).await?;
|
||||
log_user_event(EventType::UserDisabled2fa, &user.uuid, headers.device.atype, &headers.ip.ip, &conn).await;
|
||||
}
|
||||
|
||||
super::check_2fa_state(&user, headers.device.atype, &headers.ip.ip, &conn).await?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub async fn validate_yubikey_login(response: &str, twofactor_data: &str) -> EmptyResult {
|
||||
if response.len() != 44 {
|
||||
err!("Invalid Yubikey OTP length");
|
||||
|
||||
+5
-6
@@ -118,7 +118,7 @@ async fn login(data: Form<ConnectData>, client_header: ClientHeaders, conn: DbCo
|
||||
match &login_result {
|
||||
Ok(_) => {
|
||||
log_user_event(
|
||||
EventType::UserLoggedIn as i32,
|
||||
EventType::UserLoggedIn,
|
||||
&user_id,
|
||||
client_header.device_type,
|
||||
&client_header.ip.ip,
|
||||
@@ -128,8 +128,7 @@ async fn login(data: Form<ConnectData>, client_header: ClientHeaders, conn: DbCo
|
||||
}
|
||||
Err(e) => {
|
||||
if let Some(ev) = e.get_event() {
|
||||
log_user_event(ev.event as i32, &user_id, client_header.device_type, &client_header.ip.ip, &conn)
|
||||
.await;
|
||||
log_user_event(ev.event, &user_id, client_header.device_type, &client_header.ip.ip, &conn).await;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -904,7 +903,7 @@ async fn twofactor_auth(
|
||||
|
||||
enforce_2fa_policy(user, &user.uuid, device.atype, &ip.ip, conn).await?;
|
||||
|
||||
log_user_event(EventType::UserRecovered2fa as i32, &user.uuid, device.atype, &ip.ip, conn).await;
|
||||
log_user_event(EventType::UserRecovered2fa, &user.uuid, device.atype, &ip.ip, conn).await;
|
||||
|
||||
if CONFIG.mail_enabled()
|
||||
&& let Err(e) =
|
||||
@@ -974,7 +973,7 @@ async fn json_err_twofactor(providers: &[i32], user: &User, data: &ConnectData,
|
||||
}
|
||||
|
||||
Some(tf_type @ TwoFactorType::YubiKey) => {
|
||||
let Some(twofactor) = TwoFactor::find_by_user_and_type(user_id, tf_type as i32, conn).await else {
|
||||
let Some(twofactor) = TwoFactor::find_by_user_and_type(user_id, tf_type, conn).await else {
|
||||
err!("No YubiKey devices registered")
|
||||
};
|
||||
|
||||
@@ -986,7 +985,7 @@ async fn json_err_twofactor(providers: &[i32], user: &User, data: &ConnectData,
|
||||
}
|
||||
|
||||
Some(tf_type @ TwoFactorType::Email) => {
|
||||
let Some(twofactor) = TwoFactor::find_by_user_and_type(user_id, tf_type as i32, conn).await else {
|
||||
let Some(twofactor) = TwoFactor::find_by_user_and_type(user_id, tf_type, conn).await else {
|
||||
err!("No twofactor email registered")
|
||||
};
|
||||
|
||||
|
||||
+1
-1
@@ -46,7 +46,7 @@ pub type JsonResult = ApiResult<Json<Value>>;
|
||||
pub type EmptyResult = ApiResult<()>;
|
||||
|
||||
// Common structs representing JSON data received
|
||||
#[derive(Deserialize)]
|
||||
#[derive(Debug, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
struct PasswordOrOtpData {
|
||||
#[serde(alias = "MasterPasswordHash")]
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
#[path = "auth/two_factor.rs"]
|
||||
pub mod two_factor;
|
||||
|
||||
#[path = "auth/send.rs"]
|
||||
pub mod send;
|
||||
pub type SendTokens = send::SendTokens;
|
||||
|
||||
@@ -0,0 +1,281 @@
|
||||
use chrono::{TimeDelta, Utc};
|
||||
use serde::{de::DeserializeOwned, ser::Serialize};
|
||||
use std::sync::LazyLock;
|
||||
|
||||
use crate::{
|
||||
CONFIG,
|
||||
api::{ApiResult, EmptyResult},
|
||||
auth::{decode_jwt, encode_jwt},
|
||||
db::models::UserId,
|
||||
};
|
||||
|
||||
static JWT_2FA_AUTH_ISSUER: LazyLock<String> = LazyLock::new(|| format!("{}|api.2fa", CONFIG.domain_origin()));
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
pub struct TwoFactorClaims<T> {
|
||||
// Not before
|
||||
pub nbf: i64,
|
||||
// Expiration time
|
||||
pub exp: i64,
|
||||
// Issuer
|
||||
pub iss: String,
|
||||
// Subject
|
||||
pub sub: UserId,
|
||||
|
||||
pub enabled: bool,
|
||||
|
||||
pub claims: T,
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct AuthenticatorClaims {
|
||||
#[serde(rename = "authenticator_key")]
|
||||
pub key: String,
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct DuoClaims {
|
||||
#[serde(rename = "duo_data")]
|
||||
pub data: Option<DuoData>,
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct WebauthnClaims {
|
||||
#[serde(rename = "webauthn_keys")]
|
||||
pub keys: Vec<i32>,
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct YubikeyClaims {
|
||||
#[serde(rename = "yubi_keys")]
|
||||
pub keys: Vec<String>,
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize, PartialEq)]
|
||||
pub struct DuoData {
|
||||
pub host: String, // Duo API hostname
|
||||
pub ik: String, // client id
|
||||
pub sk: String, // client secret
|
||||
}
|
||||
|
||||
impl DuoData {
|
||||
pub fn global() -> Option<Self> {
|
||||
match (CONFIG._enable_duo(), CONFIG.duo_host()) {
|
||||
(true, Some(host)) => Some(Self {
|
||||
host,
|
||||
ik: CONFIG.duo_ikey().unwrap(),
|
||||
sk: CONFIG.duo_skey().unwrap(),
|
||||
}),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
pub fn msg(s: &str) -> Self {
|
||||
Self {
|
||||
host: s.into(),
|
||||
ik: s.into(),
|
||||
sk: s.into(),
|
||||
}
|
||||
}
|
||||
pub fn secret() -> Self {
|
||||
Self::msg("<global_secret>")
|
||||
}
|
||||
pub fn obscure(self) -> Self {
|
||||
let mut host = self.host;
|
||||
let mut ik = self.ik;
|
||||
let mut sk = self.sk;
|
||||
|
||||
let digits = 4;
|
||||
let replaced = "************";
|
||||
|
||||
host.replace_range(digits.., replaced);
|
||||
ik.replace_range(digits.., replaced);
|
||||
sk.replace_range(digits.., replaced);
|
||||
|
||||
Self {
|
||||
host,
|
||||
ik,
|
||||
sk,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct EmailClaims {
|
||||
pub email: Option<String>,
|
||||
}
|
||||
|
||||
fn token<T: Serialize>(user_id: UserId, enabled: bool, claims: T) -> String {
|
||||
let time_now = Utc::now();
|
||||
let claims = TwoFactorClaims {
|
||||
nbf: time_now.timestamp(),
|
||||
exp: (time_now + TimeDelta::try_minutes(5).unwrap()).timestamp(),
|
||||
iss: JWT_2FA_AUTH_ISSUER.to_string(),
|
||||
sub: user_id,
|
||||
enabled,
|
||||
claims,
|
||||
};
|
||||
encode_jwt(&claims)
|
||||
}
|
||||
|
||||
fn validate<T: DeserializeOwned>(token: &str, user_id: &UserId, enabled: bool) -> ApiResult<T> {
|
||||
match decode_jwt::<TwoFactorClaims<T>>(token, JWT_2FA_AUTH_ISSUER.to_string()) {
|
||||
Ok(claims) => {
|
||||
if claims.sub != *user_id {
|
||||
err!("Invalid verification token: Invalid user");
|
||||
}
|
||||
if claims.enabled != enabled {
|
||||
err!("Invalid verification token: Invalid state");
|
||||
}
|
||||
Ok(claims.claims)
|
||||
}
|
||||
Err(err) => err!(format!("Failed to decode verification token: {err}")),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn authenticator_token(user_id: UserId, key: String, enabled: bool) -> String {
|
||||
token(
|
||||
user_id,
|
||||
enabled,
|
||||
AuthenticatorClaims {
|
||||
key,
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
pub fn validate_authenticator(token: &str, user_id: &UserId, key: &str, enabled: bool) -> EmptyResult {
|
||||
let claims = validate::<AuthenticatorClaims>(token, user_id, enabled)?;
|
||||
if claims.key != key {
|
||||
err!("Invalid verification token: Invalid key");
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn duo_token(user_id: UserId, data: Option<DuoData>, enabled: bool) -> String {
|
||||
token(
|
||||
user_id,
|
||||
enabled,
|
||||
DuoClaims {
|
||||
data,
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
// When disabling we check that it's the correct data
|
||||
pub fn validate_duo(token: &str, user_id: &UserId, data: Option<&DuoData>, enabled: bool) -> EmptyResult {
|
||||
let claims = validate::<DuoClaims>(token, user_id, enabled)?;
|
||||
if enabled && claims.data.as_ref() != data {
|
||||
err!("Invalid verification token: Invalid duo data");
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn email_token(user_id: UserId, email: Option<String>, enabled: bool) -> String {
|
||||
token(
|
||||
user_id,
|
||||
enabled,
|
||||
EmailClaims {
|
||||
email,
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
// When disabling we check that it's the correct `email`
|
||||
pub fn validate_email(token: &str, user_id: &UserId, email: String, enabled: bool) -> EmptyResult {
|
||||
let claims = validate::<EmailClaims>(token, user_id, enabled)?;
|
||||
if enabled && claims.email != Some(email) {
|
||||
err!("Invalid verification token: Invalid email");
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn webauthn_token(user_id: UserId, keys: Vec<i32>, enabled: bool) -> String {
|
||||
token(
|
||||
user_id,
|
||||
enabled,
|
||||
WebauthnClaims {
|
||||
keys,
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
pub fn validate_webauthn(token: &str, user_id: &UserId, keys: &[i32], enabled: bool) -> EmptyResult {
|
||||
let claims = validate::<WebauthnClaims>(token, user_id, enabled)?;
|
||||
if keys != claims.keys {
|
||||
err!("Invalid verification token: Invalid keys");
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn yubikey_token(user_id: UserId, keys: Vec<String>, enabled: bool) -> String {
|
||||
token(
|
||||
user_id,
|
||||
enabled,
|
||||
YubikeyClaims {
|
||||
keys,
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
pub fn validate_yubikey(token: &str, user_id: &UserId, keys: &Vec<String>, enabled: bool) -> EmptyResult {
|
||||
let claims = validate::<YubikeyClaims>(token, user_id, enabled)?;
|
||||
if *keys != claims.keys {
|
||||
err!("Invalid verification token: Invalid keys");
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use serde_json::{Value, from_value, to_value};
|
||||
|
||||
fn token<T: Serialize>(claims: T) -> Value {
|
||||
to_value(TwoFactorClaims {
|
||||
nbf: 0,
|
||||
exp: 0,
|
||||
iss: String::new(),
|
||||
sub: UserId::from(String::from("4ff0f0a4-0aa4-4c1d-9d43-1f2bd4d5e8b1")),
|
||||
enabled: false,
|
||||
claims,
|
||||
})
|
||||
.unwrap()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn claims_only_parse_as_their_own_provider() {
|
||||
let tokens = [
|
||||
token(AuthenticatorClaims {
|
||||
key: String::from("JBSWY3DPEHPK3PXP"),
|
||||
}),
|
||||
token(DuoClaims {
|
||||
data: None,
|
||||
}),
|
||||
token(WebauthnClaims {
|
||||
keys: vec![1],
|
||||
}),
|
||||
token(YubikeyClaims {
|
||||
keys: Vec::new(),
|
||||
}),
|
||||
token(EmailClaims {
|
||||
email: None,
|
||||
}),
|
||||
];
|
||||
for (issued, token) in tokens.iter().enumerate() {
|
||||
let parsed = [
|
||||
from_value::<TwoFactorClaims<AuthenticatorClaims>>(token.clone()).is_ok(),
|
||||
from_value::<TwoFactorClaims<DuoClaims>>(token.clone()).is_ok(),
|
||||
from_value::<TwoFactorClaims<WebauthnClaims>>(token.clone()).is_ok(),
|
||||
from_value::<TwoFactorClaims<YubikeyClaims>>(token.clone()).is_ok(),
|
||||
from_value::<TwoFactorClaims<EmailClaims>>(token.clone()).is_ok(),
|
||||
];
|
||||
for (checked, ok) in parsed.into_iter().enumerate() {
|
||||
assert_eq!(ok, issued == checked, "token {issued} parsed as {checked}");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -137,11 +137,11 @@ impl TwoFactor {
|
||||
.await
|
||||
}
|
||||
|
||||
pub async fn find_by_user_and_type(user_uuid: &UserId, atype: i32, conn: &DbConn) -> Option<Self> {
|
||||
pub async fn find_by_user_and_type(user_uuid: &UserId, atype: TwoFactorType, conn: &DbConn) -> Option<Self> {
|
||||
conn.run(move |conn| {
|
||||
twofactor::table
|
||||
.filter(twofactor::user_uuid.eq(user_uuid))
|
||||
.filter(twofactor::atype.eq(atype))
|
||||
.filter(twofactor::atype.eq(atype as i32))
|
||||
.first::<Self>(conn)
|
||||
.ok()
|
||||
})
|
||||
|
||||
Reference in new issue
Block a user