1
0
mirror of https://github.com/bitwarden/browser synced 2025-12-10 05:13:29 +00:00

feat(auth): [PM-9693] Refresh LoginDecryptionOptionsComponent (#11782)

Creates a refreshed and consolidated `LoginDecryptionOptionsComponent` for use on all visual clients, which will be used when the `UnauthenticatedExtensionUIRefresh` feature flag is on.
This commit is contained in:
rr-bw
2024-11-21 13:31:20 -08:00
committed by GitHub
parent 228817b85f
commit 9f99454b37
31 changed files with 742 additions and 38 deletions

View File

@@ -24,6 +24,11 @@ export * from "./login/login-secondary-content.component";
export * from "./login/login-component.service";
export * from "./login/default-login-component.service";
// login decryption options
export * from "./login-decryption-options/login-decryption-options.component";
export * from "./login-decryption-options/login-decryption-options.service";
export * from "./login-decryption-options/default-login-decryption-options.service";
// login via auth request
export * from "./login-via-auth-request/login-via-auth-request.component";

View File

@@ -0,0 +1,37 @@
import { MockProxy, mock } from "jest-mock-extended";
import { MessagingService } from "@bitwarden/common/platform/abstractions/messaging.service";
import { DefaultLoginDecryptionOptionsService } from "./default-login-decryption-options.service";
describe("DefaultLoginDecryptionOptionsService", () => {
let service: DefaultLoginDecryptionOptionsService;
let messagingService: MockProxy<MessagingService>;
beforeEach(() => {
messagingService = mock<MessagingService>();
service = new DefaultLoginDecryptionOptionsService(messagingService);
});
it("should instantiate the service", () => {
expect(service).not.toBeFalsy();
});
describe("handleCreateUserSuccess()", () => {
it("should return null", async () => {
const result = await service.handleCreateUserSuccess();
expect(result).toBeNull();
});
});
describe("logOut()", () => {
it("should send a logout message", async () => {
await service.logOut();
expect(messagingService.send).toHaveBeenCalledWith("logout");
});
});
});

View File

@@ -0,0 +1,15 @@
import { MessagingService } from "@bitwarden/common/platform/abstractions/messaging.service";
import { LoginDecryptionOptionsService } from "./login-decryption-options.service";
export class DefaultLoginDecryptionOptionsService implements LoginDecryptionOptionsService {
constructor(protected messagingService: MessagingService) {}
handleCreateUserSuccess(): Promise<void | null> {
return null;
}
async logOut(): Promise<void> {
this.messagingService.send("logout");
}
}

View File

@@ -0,0 +1,60 @@
<ng-container *ngIf="loading">
<div class="text-center">
<i
class="bwi bwi-spinner bwi-spin bwi-2x tw-text-muted"
title="{{ 'loading' | i18n }}"
aria-hidden="true"
></i>
<span class="tw-sr-only">{{ "loading" | i18n }}</span>
</div>
</ng-container>
<form *ngIf="!loading" [formGroup]="formGroup">
<bit-form-control>
<input type="checkbox" bitCheckbox formControlName="rememberDevice" />
<bit-label>{{ "rememberThisDevice" | i18n }}</bit-label>
<bit-hint bitTypography="body2">{{ "uncheckIfPublicDevice" | i18n }}</bit-hint>
</bit-form-control>
</form>
<ng-container *ngIf="state === State.NewUser">
<button type="button" bitButton block buttonType="primary" [bitAction]="createUser">
{{ "continue" | i18n }}
</button>
</ng-container>
<ng-container *ngIf="state === State.ExistingUserUntrustedDevice">
<div class="tw-grid tw-gap-3">
<ng-container *ngIf="canApproveFromOtherDevice">
<button type="button" bitButton block buttonType="primary" (click)="approveFromOtherDevice()">
{{ "approveFromYourOtherDevice" | i18n }}
</button>
<div *ngIf="canApproveWithMasterPassword || canRequestAdminApproval" class="tw-text-center">
{{ "or" | i18n }}
</div>
</ng-container>
<button
*ngIf="canApproveWithMasterPassword"
type="button"
bitButton
block
buttonType="secondary"
(click)="approveWithMasterPassword()"
>
{{ "useMasterPassword" | i18n }}
</button>
<button
*ngIf="canRequestAdminApproval"
type="button"
bitButton
block
buttonType="secondary"
(click)="requestAdminApproval()"
>
{{ "requestAdminApproval" | i18n }}
</button>
</div>
</ng-container>

View File

@@ -0,0 +1,299 @@
import { CommonModule } from "@angular/common";
import { Component, DestroyRef, OnInit } from "@angular/core";
import { takeUntilDestroyed } from "@angular/core/rxjs-interop";
import { FormBuilder, FormControl, ReactiveFormsModule } from "@angular/forms";
import { Router } from "@angular/router";
import { catchError, defer, firstValueFrom, from, map, of, switchMap, throwError } from "rxjs";
import { JslibModule } from "@bitwarden/angular/jslib.module";
import {
LoginEmailServiceAbstraction,
UserDecryptionOptions,
UserDecryptionOptionsServiceAbstraction,
} from "@bitwarden/auth/common";
import { ApiService } from "@bitwarden/common/abstractions/api.service";
import { OrganizationApiServiceAbstraction } from "@bitwarden/common/admin-console/abstractions/organization/organization-api.service.abstraction";
import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
import { DeviceTrustServiceAbstraction } from "@bitwarden/common/auth/abstractions/device-trust.service.abstraction";
import { PasswordResetEnrollmentServiceAbstraction } from "@bitwarden/common/auth/abstractions/password-reset-enrollment.service.abstraction";
import { SsoLoginServiceAbstraction } from "@bitwarden/common/auth/abstractions/sso-login.service.abstraction";
import { ClientType } from "@bitwarden/common/enums";
import { KeysRequest } from "@bitwarden/common/models/request/keys.request";
import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
import { MessagingService } from "@bitwarden/common/platform/abstractions/messaging.service";
import { PlatformUtilsService } from "@bitwarden/common/platform/abstractions/platform-utils.service";
import { ValidationService } from "@bitwarden/common/platform/abstractions/validation.service";
import { UserId } from "@bitwarden/common/types/guid";
import {
AsyncActionsModule,
ButtonModule,
CheckboxModule,
FormFieldModule,
ToastService,
TypographyModule,
} from "@bitwarden/components";
import { KeyService } from "@bitwarden/key-management";
import { AnonLayoutWrapperDataService } from "../anon-layout/anon-layout-wrapper-data.service";
import { LoginDecryptionOptionsService } from "./login-decryption-options.service";
enum State {
NewUser,
ExistingUserUntrustedDevice,
}
@Component({
standalone: true,
templateUrl: "./login-decryption-options.component.html",
imports: [
AsyncActionsModule,
ButtonModule,
CheckboxModule,
CommonModule,
FormFieldModule,
JslibModule,
ReactiveFormsModule,
TypographyModule,
],
})
export class LoginDecryptionOptionsComponent implements OnInit {
private activeAccountId: UserId;
private clientType: ClientType;
private email: string;
protected loading = false;
protected state: State;
protected State = State;
protected formGroup = this.formBuilder.group({
rememberDevice: [true], // Remember device means for the user to trust the device
});
private get rememberDeviceControl(): FormControl<boolean> {
return this.formGroup.controls.rememberDevice;
}
// New User Properties
private newUserOrgId: string;
// Existing User Untrusted Device Properties
protected canApproveFromOtherDevice = false;
protected canRequestAdminApproval = false;
protected canApproveWithMasterPassword = false;
constructor(
private accountService: AccountService,
private anonLayoutWrapperDataService: AnonLayoutWrapperDataService,
private apiService: ApiService,
private destroyRef: DestroyRef,
private deviceTrustService: DeviceTrustServiceAbstraction,
private formBuilder: FormBuilder,
private i18nService: I18nService,
private keyService: KeyService,
private loginDecryptionOptionsService: LoginDecryptionOptionsService,
private loginEmailService: LoginEmailServiceAbstraction,
private messagingService: MessagingService,
private organizationApiService: OrganizationApiServiceAbstraction,
private passwordResetEnrollmentService: PasswordResetEnrollmentServiceAbstraction,
private platformUtilsService: PlatformUtilsService,
private router: Router,
private ssoLoginService: SsoLoginServiceAbstraction,
private toastService: ToastService,
private userDecryptionOptionsService: UserDecryptionOptionsServiceAbstraction,
private validationService: ValidationService,
) {
this.clientType === this.platformUtilsService.getClientType();
}
async ngOnInit() {
this.loading = true;
this.activeAccountId = (await firstValueFrom(this.accountService.activeAccount$))?.id;
this.email = await firstValueFrom(
this.accountService.activeAccount$.pipe(map((a) => a?.email)),
);
if (!this.email) {
await this.handleMissingEmail();
return;
}
this.observeAndPersistRememberDeviceValueChanges();
await this.setRememberDeviceDefaultValueFromState();
try {
const userDecryptionOptions = await firstValueFrom(
this.userDecryptionOptionsService.userDecryptionOptions$,
);
if (
!userDecryptionOptions?.trustedDeviceOption?.hasAdminApproval &&
!userDecryptionOptions?.hasMasterPassword
) {
/**
* We are dealing with a new account if both are true:
* - User does NOT have admin approval (i.e. has not enrolled in admin reset)
* - User does NOT have a master password
*/
await this.loadNewUserData();
} else {
this.loadExistingUserUntrustedDeviceData(userDecryptionOptions);
}
} catch (err) {
this.validationService.showError(err);
} finally {
this.loading = false;
}
}
private async handleMissingEmail() {
this.toastService.showToast({
variant: "error",
title: null,
message: this.i18nService.t("activeUserEmailNotFoundLoggingYouOut"),
});
setTimeout(async () => {
// We can't simply redirect to `/login` because the user is authed and the unauthGuard
// will prevent navigation. We must logout the user first via messagingService, which
// redirects to `/`, which will be handled by the redirectGuard to navigate the user to `/login`.
// The timeout just gives the user a chance to see the error toast before process reload runs on logout.
await this.loginDecryptionOptionsService.logOut();
}, 5000);
}
private observeAndPersistRememberDeviceValueChanges() {
this.rememberDeviceControl.valueChanges
.pipe(
takeUntilDestroyed(this.destroyRef),
switchMap((value) =>
defer(() => this.deviceTrustService.setShouldTrustDevice(this.activeAccountId, value)),
),
)
.subscribe();
}
private async setRememberDeviceDefaultValueFromState() {
const rememberDeviceFromState = await this.deviceTrustService.getShouldTrustDevice(
this.activeAccountId,
);
const rememberDevice = rememberDeviceFromState ?? true;
this.rememberDeviceControl.setValue(rememberDevice);
}
private async loadNewUserData() {
this.state = State.NewUser;
this.anonLayoutWrapperDataService.setAnonLayoutWrapperData({
pageTitle: {
key: "loggedInExclamation",
},
pageSubtitle: {
key: "rememberThisDeviceToMakeFutureLoginsSeamless",
},
});
const autoEnrollStatus$ = defer(() =>
this.ssoLoginService.getActiveUserOrganizationSsoIdentifier(),
).pipe(
switchMap((organizationIdentifier) => {
if (organizationIdentifier == undefined) {
return throwError(() => new Error(this.i18nService.t("ssoIdentifierRequired")));
}
return from(this.organizationApiService.getAutoEnrollStatus(organizationIdentifier));
}),
catchError((err: unknown) => {
this.validationService.showError(err);
return of(undefined);
}),
);
const autoEnrollStatus = await firstValueFrom(autoEnrollStatus$);
this.newUserOrgId = autoEnrollStatus.id;
}
private loadExistingUserUntrustedDeviceData(userDecryptionOptions: UserDecryptionOptions) {
this.state = State.ExistingUserUntrustedDevice;
this.anonLayoutWrapperDataService.setAnonLayoutWrapperData({
pageTitle: {
key: "deviceApprovalRequiredV2",
},
pageSubtitle: {
key: "selectAnApprovalOptionBelow",
},
});
this.canApproveFromOtherDevice =
userDecryptionOptions?.trustedDeviceOption?.hasLoginApprovingDevice || false;
this.canRequestAdminApproval =
userDecryptionOptions?.trustedDeviceOption?.hasAdminApproval || false;
this.canApproveWithMasterPassword = userDecryptionOptions?.hasMasterPassword || false;
}
protected createUser = async () => {
if (this.state !== State.NewUser) {
return;
}
try {
const { publicKey, privateKey } = await this.keyService.initAccount();
const keysRequest = new KeysRequest(publicKey, privateKey.encryptedString);
await this.apiService.postAccountKeys(keysRequest);
this.toastService.showToast({
variant: "success",
title: null,
message: this.i18nService.t("accountSuccessfullyCreated"),
});
await this.passwordResetEnrollmentService.enroll(this.newUserOrgId);
if (this.formGroup.value.rememberDevice) {
await this.deviceTrustService.trustDevice(this.activeAccountId);
}
await this.loginDecryptionOptionsService.handleCreateUserSuccess();
if (this.clientType === ClientType.Desktop) {
this.messagingService.send("redrawMenu");
}
await this.handleCreateUserSuccessNavigation();
} catch (err) {
this.validationService.showError(err);
}
};
private async handleCreateUserSuccessNavigation() {
if (this.clientType === ClientType.Browser) {
await this.router.navigate(["/tabs/vault"]);
} else {
await this.router.navigate(["/vault"]);
}
}
protected async approveFromOtherDevice() {
this.loginEmailService.setLoginEmail(this.email);
await this.router.navigate(["/login-with-device"]);
}
protected async approveWithMasterPassword() {
await this.router.navigate(["/lock"], {
queryParams: {
from: "login-initiated",
},
});
}
protected async requestAdminApproval() {
this.loginEmailService.setLoginEmail(this.email);
await this.router.navigate(["/admin-approval-requested"]);
}
}

View File

@@ -0,0 +1,10 @@
export abstract class LoginDecryptionOptionsService {
/**
* Handles client-specific logic that runs after a user was successfully created
*/
abstract handleCreateUserSuccess(): Promise<void | null>;
/**
* Logs the user out
*/
abstract logOut(): Promise<void>;
}