@ -1,10 +1,9 @@
use chrono ::Utc ; use chrono ::Utc ;
use derive_more ::{ AsRef , Deref , Display , From } ; use derive_more ::{ AsRef , Deref , Display , From , Into } ;
use regex ::Regex ; use regex ::Regex ;
use std ::time ::Duration ; use std ::time ::Duration ;
use url ::Url ; use url ::Url ;
use mini_moka ::sync ::Cache ;
use once_cell ::sync ::Lazy ; use once_cell ::sync ::Lazy ;
use crate ::{ use crate ::{
@ -12,7 +11,7 @@ use crate::{
auth , auth ,
auth ::{ AuthMethod , AuthTokens , TokenWrapper , BW_EXPIRATION , DEFAULT_REFRESH_VALIDITY } , auth ::{ AuthMethod , AuthTokens , TokenWrapper , BW_EXPIRATION , DEFAULT_REFRESH_VALIDITY } ,
db ::{ db ::{
models ::{ Device , SsoNonce , User } , models ::{ Device , OIDCAuthenticatedUser , OIDCCodeWrapper , SsoAuth , SsoUser , User } ,
DbConn , DbConn ,
} , } ,
sso_client ::Client , sso_client ::Client ,
@ -21,12 +20,9 @@ use crate::{
pub static FAKE_IDENTIFIER : & str = "Vaultwarden" ; pub static FAKE_IDENTIFIER : & str = "Vaultwarden" ;
static AC_CACHE : Lazy < Cache < OIDCState , AuthenticatedUser > > =
Lazy ::new ( | | Cache ::builder ( ) . max_capacity ( 1000 ) . time_to_live ( Duration ::from_secs ( 10 * 60 ) ) . build ( ) ) ;
static SSO_JWT_ISSUER : Lazy < String > = Lazy ::new ( | | format ! ( "{}|sso" , CONFIG . domain_origin ( ) ) ) ; static SSO_JWT_ISSUER : Lazy < String > = Lazy ::new ( | | format ! ( "{}|sso" , CONFIG . domain_origin ( ) ) ) ;
pub static NONCE _EXPIRATIONLazy < chrono ::Duration > = Lazy ::new ( | | chrono ::TimeDelta ::try_minutes ( 10 ) . unwrap ( ) ) ; pub static SSO_AUTH_EXPIRATION : Lazy < chrono ::Duration > = Lazy ::new ( | | chrono ::TimeDelta ::try_minutes ( 10 ) . unwrap ( ) ) ;
#[ derive(
#[ derive(
Clone , Clone ,
@ -48,6 +44,47 @@ pub static NONCE_EXPIRATION: Lazy<chrono::Duration> = Lazy::new(|| chrono::TimeD
#[ from(forward) ] #[ from(forward) ]
pub struct OIDCCode ( String ) ; pub struct OIDCCode ( String ) ;
#[ derive(
Clone ,
Debug ,
Default ,
DieselNewType ,
FromForm ,
PartialEq ,
Eq ,
Hash ,
Serialize ,
Deserialize ,
AsRef ,
Deref ,
Display ,
From ,
Into ,
) ]
#[ deref(forward) ]
#[ into(owned) ]
pub struct OIDCCodeChallenge ( String ) ;
#[ derive(
Clone ,
Debug ,
Default ,
DieselNewType ,
FromForm ,
PartialEq ,
Eq ,
Hash ,
Serialize ,
Deserialize ,
AsRef ,
Deref ,
Display ,
Into ,
) ]
#[ deref(forward) ]
#[ into(owned) ]
pub struct OIDCCodeVerifier ( String ) ;
#[ derive(
#[ derive(
Clone , Clone ,
Debug , Debug ,
@ -92,40 +129,6 @@ pub fn encode_ssotoken_claims() -> String {
auth ::encode_jwt ( & claims ) auth ::encode_jwt ( & claims )
} }
#[ derive(Debug, Serialize, Deserialize) ]
pub enum OIDCCodeWrapper {
Ok {
state : OIDCState ,
code : OIDCCode ,
} ,
Error {
state : OIDCState ,
error : String ,
error_description : Option < String > ,
} ,
}
#[ derive(Debug, Serialize, Deserialize) ]
struct OIDCCodeClaims {
// Expiration time
pub exp : i64 ,
// Issuer
pub iss : String ,
pub code : OIDCCodeWrapper ,
}
pub fn encode_code_claims ( code : OIDCCodeWrapper ) -> String {
let time_now = Utc ::now ( ) ;
let claims = OIDCCodeClaims {
exp : ( time_now + chrono ::TimeDelta ::try_minutes ( 5 ) . unwrap ( ) ) . timestamp ( ) ,
iss : SSO_JWT_ISSUER . to_string ( ) ,
code ,
} ;
auth ::encode_jwt ( & claims )
}
#[ derive(Clone, Debug, Serialize, Deserialize) ] #[ derive(Clone, Debug, Serialize, Deserialize) ]
struct BasicTokenClaims { struct BasicTokenClaims {
iat : Option < i64 > , iat : Option < i64 > ,
@ -163,10 +166,10 @@ pub fn decode_state(base64_state: String) -> ApiResult<OIDCState> {
Ok ( state ) Ok ( state )
} }
// The `nonce` allow to protect against replay attacks
// redirect_uri from: https://github.com/bitwarden/server/blob/main/src/Identity/IdentityServer/ApiClient.cs
// redirect_uri from: https://github.com/bitwarden/server/blob/main/src/Identity/IdentityServer/ApiClient.cs
pub async fn authorize_url ( pub async fn authorize_url (
state : OIDCState , state : OIDCState ,
client_challenge : OIDCCodeChallenge ,
client_id : & str , client_id : & str ,
raw_redirect_uri : & str , raw_redirect_uri : & str ,
mut conn : DbConn , mut conn : DbConn ,
@ -184,8 +187,8 @@ pub async fn authorize_url(
_ = > err ! ( format ! ( "Unsupported client {client_id}" ) ) , _ = > err ! ( format ! ( "Unsupported client {client_id}" ) ) ,
} ; } ;
let ( auth_url , nonce ) = Client ::authorize_url ( state , redirect_uri ) . await ? ; let ( auth_url , sso_auth ) = Client ::authorize_url ( state , client_challeng e , redirect_uri ) . await ? ;
nonce . save ( & mut conn ) . await ? ; sso_auth . save ( & mut conn ) . await ? ;
Ok ( auth_url ) Ok ( auth_url )
} }
@ -215,78 +218,45 @@ impl OIDCIdentifier {
} }
} }
#[ derive(Clone, Debug) ]
pub struct AuthenticatedUser {
pub refresh_token : Option < String > ,
pub access_token : String ,
pub expires_in : Option < Duration > ,
pub identifier : OIDCIdentifier ,
pub email : String ,
pub email_verified : Option < bool > ,
pub user_name : Option < String > ,
}
#[ derive(Clone, Debug) ]
pub struct UserInformation {
pub state : OIDCState ,
pub identifier : OIDCIdentifier ,
pub email : String ,
pub email_verified : Option < bool > ,
pub user_name : Option < String > ,
}
async fn decode_code_claims ( code : & str , conn : & mut DbConn ) -> ApiResult < ( OIDCCode , OIDCState ) > {
match auth ::decode_jwt ::< OIDCCodeClaims > ( code , SSO_JWT_ISSUER . to_string ( ) ) {
Ok ( code_claims ) = > match code_claims . code {
OIDCCodeWrapper ::Ok {
state ,
code ,
} = > Ok ( ( code , state ) ) ,
OIDCCodeWrapper ::Error {
state ,
error ,
error_description ,
} = > {
if let Err ( err ) = SsoNonce ::delete ( & state , conn ) . await {
error ! ( "Failed to delete database sso_nonce using {state}: {err}" )
}
err ! ( format ! (
"SSO authorization failed: {error}, {}" ,
error_description . as_ref ( ) . unwrap_or ( & String ::new ( ) )
) )
}
} ,
Err ( err ) = > err ! ( format ! ( "Failed to decode code wrapper: {err}" ) ) ,
}
}
// During the 2FA flow we will
// During the 2FA flow we will
// - retrieve the user information and then only discover he needs 2FA.
// - retrieve the user information and then only discover he needs 2FA.
// - second time we will rely on the `AC_CACHE` since the `code` has already been exchanged.
// - second time we will rely on the `AC_CACHE` since the `code` has already been exchanged.
// The `nonce` will ensure that the user is authorized only once.
// The `SsoAuth` will ensure that the user is authorized only once.
// We return only the `UserInformation` to force calling `redeem` to obtain the `refresh_token`.
pub async fn exchange_code (
pub async fn exchange_code ( wrapped_code : & str , conn : & mut DbConn ) -> ApiResult < UserInformation > { state : & OIDCState ,
client_verifier : OIDCCodeVerifier ,
conn : & mut DbConn ,
) -> ApiResult < ( SsoAuth , OIDCAuthenticatedUser ) > {
use openidconnect ::OAuth2TokenResponse ; use openidconnect ::OAuth2TokenResponse ;
let ( code , state ) = decode_code_claims ( wrapped_code , conn ) . await ? ; let mut sso_auth = match SsoAuth ::find ( state , conn ) . await {
None = > err ! ( format ! ( "Invalid state cannot retrieve sso auth" ) ) ,
Some ( sso_auth ) = > sso_auth ,
} ;
if let Some ( authenticated_user ) = AC_CACHE . get ( & state ) { if let Some ( authenticated_user ) = sso_auth . auth_response . clone ( ) {
return Ok ( UserInformation { return Ok ( ( sso_auth , authenticated_user ) ) ;
state ,
identifier : authenticated_user . identifier ,
email : authenticated_user . email ,
email_verified : authenticated_user . email_verified ,
user_name : authenticated_user . user_name ,
} ) ;
} }
let nonce = match SsoNonce ::find ( & state , conn ) . await { let code = match sso_auth . code_response . clone ( ) {
None = > err ! ( format ! ( "Invalid state cannot retrieve nonce" ) ) , Some ( OIDCCodeWrapper ::Ok {
Some ( nonce ) = > nonce , code ,
} ) = > code . clone ( ) ,
Some ( OIDCCodeWrapper ::Error {
error ,
error_description ,
} ) = > {
sso_auth . delete ( conn ) . await ? ;
err ! ( format ! ( "SSO authorization failed: {error}, {}" , error_description . as_ref ( ) . unwrap_or ( & String ::new ( ) ) ) )
}
None = > {
sso_auth . delete ( conn ) . await ? ;
err ! ( "Missing authorization provider return" ) ;
}
} ; } ;
let client = Client ::cached ( ) . await ? ; let client = Client ::cached ( ) . await ? ;
let ( token_response , id_claims ) = client . exchange_code ( code , nonce ) . await ? ; let ( token_response , id_claims ) = client . exchange_code ( code , client_verifier , & sso_auth ) . await ? ;
let user_info = client . user_info ( token_response . access_token ( ) . to_owned ( ) ) . await ? ; let user_info = client . user_info ( token_response . access_token ( ) . to_owned ( ) ) . await ? ;
@ -306,7 +276,7 @@ pub async fn exchange_code(wrapped_code: &str, conn: &mut DbConn) -> ApiResult<U
let identifier = OIDCIdentifier ::new ( id_claims . issuer ( ) , id_claims . subject ( ) ) ; let identifier = OIDCIdentifier ::new ( id_claims . issuer ( ) , id_claims . subject ( ) ) ;
let authenticated_user = AuthenticatedUser { let authenticated_user = OIDC AuthenticatedUser {
refresh_token : refresh_token . cloned ( ) , refresh_token : refresh_token . cloned ( ) ,
access_token : token_response . access_token ( ) . secret ( ) . clone ( ) , access_token : token_response . access_token ( ) . secret ( ) . clone ( ) ,
expires_in : token_response . expires_in ( ) , expires_in : token_response . expires_in ( ) ,
@ -317,29 +287,49 @@ pub async fn exchange_code(wrapped_code: &str, conn: &mut DbConn) -> ApiResult<U
} ; } ;
debug ! ( "Authenticated user {authenticated_user:?}" ) ; debug ! ( "Authenticated user {authenticated_user:?}" ) ;
sso_auth . auth_response = Some ( authenticated_user . clone ( ) ) ;
sso_auth . updated_at = Utc ::now ( ) . naive_utc ( ) ;
sso_auth . save ( conn ) . await ? ;
AC_CACHE . insert ( state . clone ( ) , authenticated_user ) ; Ok ( ( sso_auth , authenticated_user ) )
Ok ( UserInformation {
state ,
identifier ,
email ,
email_verified ,
user_name ,
} )
} }
// User has passed 2FA flow we can delete `nonce` and clear the cache.
// User has passed 2FA flow we can delete auth info from database
pub async fn redeem ( state : & OIDCState , conn : & mut DbConn ) -> ApiResult < AuthenticatedUser > { pub async fn redeem (
if let Err ( err ) = SsoNonce ::delete ( state , conn ) . await { device : & Device ,
error ! ( "Failed to delete database sso_nonce using {state}: {err}" ) user : & User ,
client_id : Option < String > ,
sso_user : Option < SsoUser > ,
sso_auth : SsoAuth ,
auth_user : OIDCAuthenticatedUser ,
conn : & mut DbConn ,
) -> ApiResult < AuthTokens > {
sso_auth . delete ( conn ) . await ? ;
if sso_user . is_none ( ) {
let user_sso = SsoUser {
user_uuid : user . uuid . clone ( ) ,
identifier : auth_user . identifier . clone ( ) ,
} ;
user_sso . save ( conn ) . await ? ;
} }
if let Some ( au ) = AC_CACHE . get ( state ) { if ! CONFIG . sso_auth_only_not_session ( ) {
AC_CACHE . invalidate ( state ) ; let now = Utc ::now ( ) ;
Ok ( au )
let ( ap_nbf , ap_exp ) =
match ( decode_token_claims ( "access_token" , & auth_user . access_token ) , auth_user . expires_in ) {
( Ok ( ap ) , _ ) = > ( ap . nbf ( ) , ap . exp ) ,
( Err ( _ ) , Some ( exp ) ) = > ( now . timestamp ( ) , ( now + exp ) . timestamp ( ) ) ,
_ = > err ! ( "Non jwt access_token and empty expires_in" ) ,
} ;
let access_claims =
auth ::LoginJwtClaims ::new ( device , user , ap_nbf , ap_exp , AuthMethod ::Sso . scope_vec ( ) , client_id , now ) ;
_create_auth_tokens ( device , auth_user . refresh_token , access_claims , auth_user . access_token )
} else { } else {
err ! ( "Failed to retrieve user info from sso cache" ) Ok ( AuthTokens ::new ( device , user , AuthMethod ::Sso , client_id ) )
} }
} }
Timshel
6 days ago
GitHub