diff --git a/apps/web/src/app/vault/org-vault/vault-header/vault-header.component.ts b/apps/web/src/app/vault/org-vault/vault-header/vault-header.component.ts
index d9930d2271..5e64067a82 100644
--- a/apps/web/src/app/vault/org-vault/vault-header/vault-header.component.ts
+++ b/apps/web/src/app/vault/org-vault/vault-header/vault-header.component.ts
@@ -13,11 +13,11 @@ import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.servic
import { CipherType } from "@bitwarden/common/vault/enums";
import { TreeNode } from "@bitwarden/common/vault/models/domain/tree-node";
import {
- DialogService,
- SimpleDialogOptions,
BreadcrumbsModule,
+ DialogService,
MenuModule,
SearchModule,
+ SimpleDialogOptions,
} from "@bitwarden/components";
import { HeaderModule } from "../../../layouts/header/header.module";
@@ -88,8 +88,6 @@ export class VaultHeaderComponent implements OnInit {
protected CollectionDialogTabType = CollectionDialogTabType;
protected organizations$ = this.organizationService.organizations$;
- protected restrictProviderAccessFlag = false;
-
/**
* Whether the extension refresh feature flag is enabled.
*/
@@ -108,9 +106,6 @@ export class VaultHeaderComponent implements OnInit {
) {}
async ngOnInit() {
- this.restrictProviderAccessFlag = await this.configService.getFeatureFlag(
- FeatureFlag.RestrictProviderAccess,
- );
this.extensionRefreshEnabled = await this.configService.getFeatureFlag(
FeatureFlag.ExtensionRefresh,
);
@@ -245,11 +240,7 @@ export class VaultHeaderComponent implements OnInit {
}
get canCreateCipher(): boolean {
- if (
- this.organization?.isProviderUser &&
- this.restrictProviderAccessFlag &&
- !this.organization?.isMember
- ) {
+ if (this.organization?.isProviderUser && !this.organization?.isMember) {
return false;
}
return true;
diff --git a/apps/web/src/app/vault/org-vault/vault.component.html b/apps/web/src/app/vault/org-vault/vault.component.html
index 63160abea6..ed7f6b1e3e 100644
--- a/apps/web/src/app/vault/org-vault/vault.component.html
+++ b/apps/web/src/app/vault/org-vault/vault.component.html
@@ -70,7 +70,6 @@
[viewingOrgVault]="true"
[addAccessStatus]="addAccessStatus$ | async"
[addAccessToggle]="showAddAccessToggle"
- [restrictProviderAccess]="restrictProviderAccessEnabled"
>
diff --git a/apps/web/src/app/vault/org-vault/vault.component.ts b/apps/web/src/app/vault/org-vault/vault.component.ts
index f9652fe08c..add1ecbe3e 100644
--- a/apps/web/src/app/vault/org-vault/vault.component.ts
+++ b/apps/web/src/app/vault/org-vault/vault.component.ts
@@ -43,9 +43,7 @@ import { OrganizationService } from "@bitwarden/common/admin-console/abstraction
import { Organization } from "@bitwarden/common/admin-console/models/domain/organization";
import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
import { EventType } from "@bitwarden/common/enums";
-import { FeatureFlag } from "@bitwarden/common/enums/feature-flag.enum";
import { BroadcasterService } from "@bitwarden/common/platform/abstractions/broadcaster.service";
-import { ConfigService } from "@bitwarden/common/platform/abstractions/config/config.service";
import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
import { MessagingService } from "@bitwarden/common/platform/abstractions/messaging.service";
@@ -172,17 +170,8 @@ export class VaultComponent implements OnInit, OnDestroy {
protected orgRevokedUsers: OrganizationUserUserDetailsResponse[];
- private _restrictProviderAccessFlagEnabled: boolean;
- protected get restrictProviderAccessEnabled(): boolean {
- return this._restrictProviderAccessFlagEnabled;
- }
-
protected get hideVaultFilters(): boolean {
- return (
- this.restrictProviderAccessEnabled &&
- this.organization?.isProviderUser &&
- !this.organization?.isMember
- );
+ return this.organization?.isProviderUser && !this.organization?.isMember;
}
private searchText$ = new Subject();
@@ -218,7 +207,6 @@ export class VaultComponent implements OnInit, OnDestroy {
private apiService: ApiService,
private collectionService: CollectionService,
private organizationUserApiService: OrganizationUserApiService,
- protected configService: ConfigService,
private toastService: ToastService,
private accountService: AccountService,
) {}
@@ -230,10 +218,6 @@ export class VaultComponent implements OnInit, OnDestroy {
: "trashCleanupWarning",
);
- this._restrictProviderAccessFlagEnabled = await this.configService.getFeatureFlag(
- FeatureFlag.RestrictProviderAccess,
- );
-
const filter$ = this.routedVaultFilterService.filter$;
const organizationId$ = filter$.pipe(
map((filter) => filter.organizationId),
@@ -325,7 +309,7 @@ export class VaultComponent implements OnInit, OnDestroy {
this.editableCollections$ = this.allCollectionsWithoutUnassigned$.pipe(
map((collections) => {
// Users that can edit all ciphers can implicitly add to / edit within any collection
- if (this.organization.canEditAllCiphers(this.restrictProviderAccessEnabled)) {
+ if (this.organization.canEditAllCiphers) {
return collections;
}
// The user is only allowed to add/edit items to assigned collections that are not readonly
@@ -362,16 +346,12 @@ export class VaultComponent implements OnInit, OnDestroy {
// Restricted providers (who are not members) do not have access org cipher endpoint below
// Return early to avoid 404 response
- if (
- this.restrictProviderAccessEnabled &&
- !organization.isMember &&
- organization.isProviderUser
- ) {
+ if (!organization.isMember && organization.isProviderUser) {
return [];
}
// If the user can edit all ciphers for the organization then fetch them ALL.
- if (organization.canEditAllCiphers(this.restrictProviderAccessEnabled)) {
+ if (organization.canEditAllCiphers) {
ciphers = await this.cipherService.getAllFromApiForOrganization(organization.id);
} else {
// Otherwise, only fetch ciphers they have access to (includes unassigned for admins).
@@ -476,11 +456,8 @@ export class VaultComponent implements OnInit, OnDestroy {
]).pipe(
map(([filter, collection, organization]) => {
return (
- (filter.collectionId === Unassigned &&
- !organization.canEditUnassignedCiphers(this.restrictProviderAccessEnabled)) ||
- (!organization.canEditAllCiphers(this.restrictProviderAccessEnabled) &&
- collection != undefined &&
- !collection.node.assigned)
+ (filter.collectionId === Unassigned && !organization.canEditUnassignedCiphers) ||
+ (!organization.canEditAllCiphers && collection != undefined && !collection.node.assigned)
);
}),
shareReplay({ refCount: true, bufferSize: 1 }),
@@ -525,7 +502,7 @@ export class VaultComponent implements OnInit, OnDestroy {
}
const canEditCipher =
- organization.canEditAllCiphers(this.restrictProviderAccessEnabled) ||
+ organization.canEditAllCiphers ||
(await firstValueFrom(allCipherMap$))[cipherId] != undefined;
if (canEditCipher) {
@@ -758,15 +735,9 @@ export class VaultComponent implements OnInit, OnDestroy {
this.allCollectionsWithoutUnassigned$.pipe(
map((c) => {
return c.sort((a, b) => {
- if (
- a.canEditItems(this.organization, this.restrictProviderAccessEnabled) &&
- !b.canEditItems(this.organization, this.restrictProviderAccessEnabled)
- ) {
+ if (a.canEditItems(this.organization) && !b.canEditItems(this.organization)) {
return -1;
- } else if (
- !a.canEditItems(this.organization, this.restrictProviderAccessEnabled) &&
- b.canEditItems(this.organization, this.restrictProviderAccessEnabled)
- ) {
+ } else if (!a.canEditItems(this.organization) && b.canEditItems(this.organization)) {
return 1;
} else {
return a.name.localeCompare(b.name);
@@ -1001,9 +972,7 @@ export class VaultComponent implements OnInit, OnDestroy {
const unassignedCiphers: string[] = [];
// If user has edit all Access no need to check for unassigned ciphers
- const canEditAll = this.organization.canEditAllCiphers(this.restrictProviderAccessEnabled);
-
- if (canEditAll) {
+ if (this.organization.canEditAllCiphers) {
ciphers.map((cipher) => {
editAccessCiphers.push(cipher.id);
});
@@ -1042,7 +1011,7 @@ export class VaultComponent implements OnInit, OnDestroy {
}
async deleteCipher(c: CipherView): Promise {
- if (!c.edit && !this.organization.canEditAllCiphers(this.restrictProviderAccessEnabled)) {
+ if (!c.edit && !this.organization.canEditAllCiphers) {
this.showMissingPermissionsError();
return;
}
@@ -1146,9 +1115,7 @@ export class VaultComponent implements OnInit, OnDestroy {
const canDeleteCollections =
collections == null || collections.every((c) => c.canDelete(organization));
const canDeleteCiphers =
- ciphers == null ||
- ciphers.every((c) => c.edit) ||
- this.organization.canEditAllCiphers(this.restrictProviderAccessEnabled);
+ ciphers == null || ciphers.every((c) => c.edit) || this.organization.canEditAllCiphers;
if (!canDeleteCiphers || !canDeleteCollections) {
this.showMissingPermissionsError();
@@ -1351,8 +1318,7 @@ export class VaultComponent implements OnInit, OnDestroy {
}
protected deleteCipherWithServer(id: string, permanent: boolean, isUnassigned: boolean) {
- const asAdmin =
- this.organization?.canEditAllCiphers(this.restrictProviderAccessEnabled) || isUnassigned;
+ const asAdmin = this.organization?.canEditAllCiphers || isUnassigned;
return permanent
? this.cipherService.deleteWithServer(id, asAdmin)
: this.cipherService.softDeleteWithServer(id, asAdmin);
diff --git a/apps/web/src/connectors/redirect.html b/apps/web/src/connectors/redirect.html
new file mode 100644
index 0000000000..13b05fb17e
--- /dev/null
+++ b/apps/web/src/connectors/redirect.html
@@ -0,0 +1,29 @@
+
+
+
+
+
+
+
+ Bitwarden Web vault
+
+
+
+
+
+
+
+
+
+
+
![Bitwarden]()
+
+
+
+
{{ subtitle }}
diff --git a/libs/auth/src/angular/icons/index.ts b/libs/auth/src/angular/icons/index.ts
index 3bdbbe4a18..166b2d1f2e 100644
--- a/libs/auth/src/angular/icons/index.ts
+++ b/libs/auth/src/angular/icons/index.ts
@@ -3,5 +3,6 @@ export * from "./bitwarden-shield.icon";
export * from "./lock.icon";
export * from "./registration-check-email.icon";
export * from "./registration-expired-link.icon";
+export * from "./user-lock.icon";
export * from "./user-verification-biometrics-fingerprint.icon";
export * from "./wave.icon";
diff --git a/libs/auth/src/angular/icons/lock.icon.ts b/libs/auth/src/angular/icons/lock.icon.ts
index 981b520010..198733d0dc 100644
--- a/libs/auth/src/angular/icons/lock.icon.ts
+++ b/libs/auth/src/angular/icons/lock.icon.ts
@@ -2,16 +2,16 @@ import { svgIcon } from "@bitwarden/components";
export const LockIcon = svgIcon`
`;
diff --git a/libs/auth/src/angular/icons/user-lock.icon.ts b/libs/auth/src/angular/icons/user-lock.icon.ts
new file mode 100644
index 0000000000..fef00a09a9
--- /dev/null
+++ b/libs/auth/src/angular/icons/user-lock.icon.ts
@@ -0,0 +1,22 @@
+import { svgIcon } from "@bitwarden/components";
+
+export const UserLockIcon = svgIcon`
+
+`;
diff --git a/libs/auth/src/angular/index.ts b/libs/auth/src/angular/index.ts
index 3ba0b8ef71..d153cf5355 100644
--- a/libs/auth/src/angular/index.ts
+++ b/libs/auth/src/angular/index.ts
@@ -27,6 +27,9 @@ export * from "./login/default-login.service";
// password callout
export * from "./password-callout/password-callout.component";
+// password hint
+export * from "./password-hint/password-hint.component";
+
// registration
export * from "./registration/registration-start/registration-start.component";
export * from "./registration/registration-finish/registration-finish.component";
diff --git a/libs/auth/src/angular/password-hint/password-hint.component.html b/libs/auth/src/angular/password-hint/password-hint.component.html
new file mode 100644
index 0000000000..2a811a1b3b
--- /dev/null
+++ b/libs/auth/src/angular/password-hint/password-hint.component.html
@@ -0,0 +1,40 @@
+
diff --git a/libs/auth/src/angular/password-hint/password-hint.component.ts b/libs/auth/src/angular/password-hint/password-hint.component.ts
new file mode 100644
index 0000000000..1ae1fd337b
--- /dev/null
+++ b/libs/auth/src/angular/password-hint/password-hint.component.ts
@@ -0,0 +1,107 @@
+import { CommonModule } from "@angular/common";
+import { Component, OnInit } from "@angular/core";
+import { FormBuilder, ReactiveFormsModule, Validators } from "@angular/forms";
+import { Router, RouterModule } from "@angular/router";
+import { firstValueFrom } from "rxjs";
+
+import { JslibModule } from "@bitwarden/angular/jslib.module";
+import { LoginEmailServiceAbstraction } from "@bitwarden/auth/common";
+import { ApiService } from "@bitwarden/common/abstractions/api.service";
+import { PasswordHintRequest } from "@bitwarden/common/auth/models/request/password-hint.request";
+import { ClientType } from "@bitwarden/common/enums";
+import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
+import { PlatformUtilsService } from "@bitwarden/common/platform/abstractions/platform-utils.service";
+import {
+ AsyncActionsModule,
+ ButtonModule,
+ FormFieldModule,
+ ToastService,
+} from "@bitwarden/components";
+
+@Component({
+ standalone: true,
+ templateUrl: "./password-hint.component.html",
+ imports: [
+ AsyncActionsModule,
+ ButtonModule,
+ CommonModule,
+ FormFieldModule,
+ JslibModule,
+ ReactiveFormsModule,
+ RouterModule,
+ ],
+})
+export class PasswordHintComponent implements OnInit {
+ protected clientType: ClientType;
+
+ protected formGroup = this.formBuilder.group({
+ email: ["", [Validators.required, Validators.email]],
+ });
+
+ protected get email() {
+ return this.formGroup.controls.email.value;
+ }
+
+ constructor(
+ private apiService: ApiService,
+ private formBuilder: FormBuilder,
+ private i18nService: I18nService,
+ private loginEmailService: LoginEmailServiceAbstraction,
+ private platformUtilsService: PlatformUtilsService,
+ private toastService: ToastService,
+ private router: Router,
+ ) {
+ this.clientType = this.platformUtilsService.getClientType();
+ }
+
+ async ngOnInit(): Promise
{
+ const email = (await firstValueFrom(this.loginEmailService.loginEmail$)) ?? "";
+ this.formGroup.controls.email.setValue(email);
+ }
+
+ submit = async () => {
+ const isEmailValid = this.validateEmailOrShowToast(this.email);
+ if (!isEmailValid) {
+ return;
+ }
+
+ await this.apiService.postPasswordHint(new PasswordHintRequest(this.email));
+
+ this.toastService.showToast({
+ variant: "success",
+ title: null,
+ message: this.i18nService.t("masterPassSent"),
+ });
+
+ await this.router.navigate(["login"]);
+ };
+
+ protected async cancel() {
+ this.loginEmailService.setLoginEmail(this.email);
+ await this.router.navigate(["login"]);
+ }
+
+ private validateEmailOrShowToast(email: string): boolean {
+ // If email is null or empty, show error toast and return false
+ if (email == null || email === "") {
+ this.toastService.showToast({
+ variant: "error",
+ title: this.i18nService.t("errorOccurred"),
+ message: this.i18nService.t("emailRequired"),
+ });
+ return false;
+ }
+
+ // If not a valid email format, show error toast and return false
+ if (email.indexOf("@") === -1) {
+ this.toastService.showToast({
+ variant: "error",
+ title: this.i18nService.t("errorOccurred"),
+ message: this.i18nService.t("invalidEmail"),
+ });
+ return false;
+ }
+
+ return true; // email is valid
+ }
+}
diff --git a/libs/auth/src/angular/registration/registration-finish/default-registration-finish.service.ts b/libs/auth/src/angular/registration/registration-finish/default-registration-finish.service.ts
index 85faf87144..63b01be995 100644
--- a/libs/auth/src/angular/registration/registration-finish/default-registration-finish.service.ts
+++ b/libs/auth/src/angular/registration/registration-finish/default-registration-finish.service.ts
@@ -23,6 +23,9 @@ export class DefaultRegistrationFinishService implements RegistrationFinishServi
email: string,
passwordInputResult: PasswordInputResult,
emailVerificationToken?: string,
+ orgSponsoredFreeFamilyPlanToken?: string,
+ acceptEmergencyAccessInviteToken?: string,
+ emergencyAccessId?: string,
): Promise {
const [newUserKey, newEncUserKey] = await this.cryptoService.makeUserKey(
passwordInputResult.masterKey,
@@ -35,10 +38,13 @@ export class DefaultRegistrationFinishService implements RegistrationFinishServi
const registerRequest = await this.buildRegisterRequest(
email,
- emailVerificationToken,
passwordInputResult,
newEncUserKey.encryptedString,
userAsymmetricKeys,
+ emailVerificationToken,
+ orgSponsoredFreeFamilyPlanToken,
+ acceptEmergencyAccessInviteToken,
+ emergencyAccessId,
);
const capchaBypassToken = await this.accountApiService.registerFinish(registerRequest);
@@ -48,19 +54,21 @@ export class DefaultRegistrationFinishService implements RegistrationFinishServi
protected async buildRegisterRequest(
email: string,
- emailVerificationToken: string,
passwordInputResult: PasswordInputResult,
encryptedUserKey: EncryptedString,
userAsymmetricKeys: [string, EncString],
+ emailVerificationToken?: string,
+ orgSponsoredFreeFamilyPlanToken?: string, // web only
+ acceptEmergencyAccessInviteToken?: string, // web only
+ emergencyAccessId?: string, // web only
): Promise {
const userAsymmetricKeysRequest = new KeysRequest(
userAsymmetricKeys[0],
userAsymmetricKeys[1].encryptedString,
);
- return new RegisterFinishRequest(
+ const registerFinishRequest = new RegisterFinishRequest(
email,
- emailVerificationToken,
passwordInputResult.masterKeyHash,
passwordInputResult.hint,
encryptedUserKey,
@@ -68,5 +76,11 @@ export class DefaultRegistrationFinishService implements RegistrationFinishServi
passwordInputResult.kdfConfig.kdfType,
passwordInputResult.kdfConfig.iterations,
);
+
+ if (emailVerificationToken) {
+ registerFinishRequest.emailVerificationToken = emailVerificationToken;
+ }
+
+ return registerFinishRequest;
}
}
diff --git a/libs/auth/src/angular/registration/registration-finish/registration-finish.component.ts b/libs/auth/src/angular/registration/registration-finish/registration-finish.component.ts
index 3c7e31b5de..ef40d95dce 100644
--- a/libs/auth/src/angular/registration/registration-finish/registration-finish.component.ts
+++ b/libs/auth/src/angular/registration/registration-finish/registration-finish.component.ts
@@ -33,11 +33,21 @@ export class RegistrationFinishComponent implements OnInit, OnDestroy {
submitting = false;
email: string;
- // Note: this token is the email verification token. It is always supplied as a query param, but
+ // Note: this token is the email verification token. When it is supplied as a query param,
// it either comes from the email verification email or, if email verification is disabled server side
// via global settings, it comes directly from the registration-start component directly.
+ // It is not provided when the user is coming from another emailed invite (ex: org invite or enterprise
+ // org sponsored free family plan invite).
emailVerificationToken: string;
+ // this token is provided when the user is coming from an emailed invite to
+ // setup a free family plan sponsored by an organization but they don't have an account yet.
+ orgSponsoredFreeFamilyPlanToken: string;
+
+ // this token is provided when the user is coming from an emailed invite to accept an emergency access invite
+ acceptEmergencyAccessInviteToken: string;
+ emergencyAccessId: string;
+
masterPasswordPolicyOptions: MasterPasswordPolicyOptions | null = null;
constructor(
@@ -69,6 +79,15 @@ export class RegistrationFinishComponent implements OnInit, OnDestroy {
if (qParams.token != null) {
this.emailVerificationToken = qParams.token;
}
+
+ if (qParams.orgSponsoredFreeFamilyPlanToken != null) {
+ this.orgSponsoredFreeFamilyPlanToken = qParams.orgSponsoredFreeFamilyPlanToken;
+ }
+
+ if (qParams.acceptEmergencyAccessInviteToken != null && qParams.emergencyAccessId) {
+ this.acceptEmergencyAccessInviteToken = qParams.acceptEmergencyAccessInviteToken;
+ this.emergencyAccessId = qParams.emergencyAccessId;
+ }
}),
switchMap((qParams: Params) => {
if (
@@ -100,6 +119,9 @@ export class RegistrationFinishComponent implements OnInit, OnDestroy {
this.email,
passwordInputResult,
this.emailVerificationToken,
+ this.orgSponsoredFreeFamilyPlanToken,
+ this.acceptEmergencyAccessInviteToken,
+ this.emergencyAccessId,
);
} catch (e) {
this.validationService.showError(e);
diff --git a/libs/auth/src/angular/registration/registration-finish/registration-finish.service.ts b/libs/auth/src/angular/registration/registration-finish/registration-finish.service.ts
index 63e23182f6..b585aa78ed 100644
--- a/libs/auth/src/angular/registration/registration-finish/registration-finish.service.ts
+++ b/libs/auth/src/angular/registration/registration-finish/registration-finish.service.ts
@@ -14,12 +14,18 @@ export abstract class RegistrationFinishService {
*
* @param email The email address of the user.
* @param passwordInputResult The password input result.
- * @param emailVerificationToken The optional email verification token. Not present in org invite scenarios.
+ * @param emailVerificationToken The optional email verification token. Not present in emailed invite scenarios (ex: org invite).
+ * @param orgSponsoredFreeFamilyPlanToken The optional org sponsored free family plan token.
+ * @param acceptEmergencyAccessInviteToken The optional accept emergency access invite token.
+ * @param emergencyAccessId The optional emergency access id which is required to validate the emergency access invite token.
* Returns a promise which resolves to the captcha bypass token string upon a successful account creation.
*/
abstract finishRegistration(
email: string,
passwordInputResult: PasswordInputResult,
emailVerificationToken?: string,
+ orgSponsoredFreeFamilyPlanToken?: string,
+ acceptEmergencyAccessInviteToken?: string,
+ emergencyAccessId?: string,
): Promise;
}
diff --git a/libs/common/src/admin-console/abstractions/organization/organization.service.abstraction.ts b/libs/common/src/admin-console/abstractions/organization/organization.service.abstraction.ts
index 218051b9e4..0cea2aee53 100644
--- a/libs/common/src/admin-console/abstractions/organization/organization.service.abstraction.ts
+++ b/libs/common/src/admin-console/abstractions/organization/organization.service.abstraction.ts
@@ -113,6 +113,9 @@ export abstract class OrganizationService {
* https://bitwarden.atlassian.net/browse/AC-2252.
*/
getFromState: (id: string) => Promise;
+ /**
+ * Emits true if the user can create or manage a Free Bitwarden Families sponsorship.
+ */
canManageSponsorships$: Observable;
hasOrganizations: () => Promise;
get$: (id: string) => Observable;
diff --git a/libs/common/src/admin-console/models/domain/organization.ts b/libs/common/src/admin-console/models/domain/organization.ts
index 490c799ad1..8c28bcb493 100644
--- a/libs/common/src/admin-console/models/domain/organization.ts
+++ b/libs/common/src/admin-console/models/domain/organization.ts
@@ -183,14 +183,7 @@ export class Organization {
return this.isAdmin || this.permissions.editAnyCollection;
}
- canEditUnassignedCiphers(restrictProviderAccessFlagEnabled: boolean) {
- // Providers can access items until the restrictProviderAccess flag is enabled
- // After the flag is enabled and removed, this block will be deleted
- // so that they permanently lose access to items
- if (this.isProviderUser && !restrictProviderAccessFlagEnabled) {
- return true;
- }
-
+ get canEditUnassignedCiphers() {
return (
this.type === OrganizationUserType.Admin ||
this.type === OrganizationUserType.Owner ||
@@ -198,14 +191,7 @@ export class Organization {
);
}
- canEditAllCiphers(restrictProviderAccessFlagEnabled: boolean) {
- // Providers can access items until the restrictProviderAccess flag is enabled
- // After the flag is enabled and removed, this block will be deleted
- // so that they permanently lose access to items
- if (this.isProviderUser && !restrictProviderAccessFlagEnabled) {
- return true;
- }
-
+ get canEditAllCiphers() {
// The allowAdminAccessToAllCollectionItems flag can restrict admins
// Custom users with canEditAnyCollection are not affected by allowAdminAccessToAllCollectionItems flag
return (
diff --git a/libs/common/src/auth/abstractions/auth.service.ts b/libs/common/src/auth/abstractions/auth.service.ts
index 36d5d219b2..df408e76f8 100644
--- a/libs/common/src/auth/abstractions/auth.service.ts
+++ b/libs/common/src/auth/abstractions/auth.service.ts
@@ -16,5 +16,5 @@ export abstract class AuthService {
abstract authStatusFor$(userId: UserId): Observable;
/** @deprecated use {@link activeAccountStatus$} instead */
abstract getAuthStatus: (userId?: string) => Promise;
- abstract logOut: (callback: () => void) => void;
+ abstract logOut: (callback: () => void, userId?: string) => void;
}
diff --git a/libs/common/src/auth/models/request/registration/register-finish.request.ts b/libs/common/src/auth/models/request/registration/register-finish.request.ts
index 22275fb228..6a36bf8213 100644
--- a/libs/common/src/auth/models/request/registration/register-finish.request.ts
+++ b/libs/common/src/auth/models/request/registration/register-finish.request.ts
@@ -5,7 +5,6 @@ import { EncryptedString } from "../../../../platform/models/domain/enc-string";
export class RegisterFinishRequest {
constructor(
public email: string,
- public emailVerificationToken: string,
public masterPasswordHash: string,
public masterPasswordHint: string,
@@ -18,6 +17,11 @@ export class RegisterFinishRequest {
public kdfMemory?: number,
public kdfParallelism?: number,
+ public emailVerificationToken?: string,
+ public orgSponsoredFreeFamilyPlanToken?: string,
+ public acceptEmergencyAccessInviteToken?: string,
+ public acceptEmergencyAccessId?: string,
+
// Org Invite data (only applies on web)
public organizationUserId?: string,
public orgInviteToken?: string,
diff --git a/libs/common/src/auth/services/auth.service.ts b/libs/common/src/auth/services/auth.service.ts
index 25e7b92edf..307da55a5e 100644
--- a/libs/common/src/auth/services/auth.service.ts
+++ b/libs/common/src/auth/services/auth.service.ts
@@ -93,8 +93,8 @@ export class AuthService implements AuthServiceAbstraction {
return await firstValueFrom(this.authStatusFor$(userId as UserId));
}
- logOut(callback: () => void) {
+ logOut(callback: () => void, userId?: string): void {
callback();
- this.messageSender.send("loggedOut");
+ this.messageSender.send("loggedOut", { userId });
}
}
diff --git a/libs/common/src/enums/feature-flag.enum.ts b/libs/common/src/enums/feature-flag.enum.ts
index 221c2f469a..26390a66fc 100644
--- a/libs/common/src/enums/feature-flag.enum.ts
+++ b/libs/common/src/enums/feature-flag.enum.ts
@@ -12,7 +12,6 @@ export enum FeatureFlag {
EnableDeleteProvider = "AC-1218-delete-provider",
ExtensionRefresh = "extension-refresh",
PersistPopupView = "persist-popup-view",
- RestrictProviderAccess = "restrict-provider-access",
PM4154_BulkEncryptionService = "PM-4154-bulk-encryption-service",
UseTreeWalkerApiForPageDetailsCollection = "use-tree-walker-api-for-page-details-collection",
EmailVerification = "email-verification",
@@ -59,7 +58,6 @@ export const DefaultFeatureFlagValue = {
[FeatureFlag.EnableDeleteProvider]: FALSE,
[FeatureFlag.ExtensionRefresh]: FALSE,
[FeatureFlag.PersistPopupView]: FALSE,
- [FeatureFlag.RestrictProviderAccess]: FALSE,
[FeatureFlag.PM4154_BulkEncryptionService]: FALSE,
[FeatureFlag.UseTreeWalkerApiForPageDetailsCollection]: FALSE,
[FeatureFlag.EmailVerification]: FALSE,
diff --git a/libs/common/src/platform/misc/lazy.ts b/libs/common/src/platform/misc/lazy.ts
index fb85b93678..96b4d03364 100644
--- a/libs/common/src/platform/misc/lazy.ts
+++ b/libs/common/src/platform/misc/lazy.ts
@@ -1,6 +1,7 @@
+const NoValue = Symbol("NoValue");
+
export class Lazy {
- private _value: T | undefined = undefined;
- private _isCreated = false;
+ private _value: T | typeof NoValue = NoValue;
constructor(private readonly factory: () => T) {}
@@ -10,11 +11,10 @@ export class Lazy {
* @returns The value produced by your factory.
*/
get(): T {
- if (!this._isCreated) {
- this._value = this.factory();
- this._isCreated = true;
+ if (this._value === NoValue) {
+ return (this._value = this.factory());
}
- return this._value as T;
+ return this._value;
}
}
diff --git a/libs/common/src/services/vault-timeout/vault-timeout.service.ts b/libs/common/src/services/vault-timeout/vault-timeout.service.ts
index d9efef44f4..c40e4687b7 100644
--- a/libs/common/src/services/vault-timeout/vault-timeout.service.ts
+++ b/libs/common/src/services/vault-timeout/vault-timeout.service.ts
@@ -1,4 +1,4 @@
-import { combineLatest, filter, firstValueFrom, map, switchMap, timeout } from "rxjs";
+import { combineLatest, concatMap, filter, firstValueFrom, map, timeout } from "rxjs";
import { LogoutReason } from "@bitwarden/auth/common";
import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
@@ -79,7 +79,7 @@ export class VaultTimeoutService implements VaultTimeoutServiceAbstraction {
this.accountService.activeAccount$,
this.accountService.accountActivity$,
]).pipe(
- switchMap(async ([activeAccount, accountActivity]) => {
+ concatMap(async ([activeAccount, accountActivity]) => {
const activeUserId = activeAccount?.id;
for (const userIdString in accountActivity) {
const userId = userIdString as UserId;
diff --git a/libs/common/src/tools/dependencies.ts b/libs/common/src/tools/dependencies.ts
index 0488291b44..8b860591d5 100644
--- a/libs/common/src/tools/dependencies.ts
+++ b/libs/common/src/tools/dependencies.ts
@@ -77,7 +77,7 @@ export type SingleUserDependency = {
export type OnDependency = {
/** The stream that controls emissions
*/
- on$: Observable;
+ on$: Observable;
};
/** A pattern for types that emit when a dependency is `true`.
diff --git a/libs/common/src/tools/integration/rpc/integration-request.ts b/libs/common/src/tools/integration/rpc/integration-request.ts
index 84a7b517ab..9f1808a632 100644
--- a/libs/common/src/tools/integration/rpc/integration-request.ts
+++ b/libs/common/src/tools/integration/rpc/integration-request.ts
@@ -1,11 +1,6 @@
+import { GenerationRequest } from "../../types";
+
/** Options that provide contextual information about the application state
* when an integration is invoked.
*/
-export type IntegrationRequest = {
- /** @param website The domain of the website the requested integration is used
- * within. This should be set to `null` when the request is not specific
- * to any website.
- * @remarks this field contains sensitive data
- */
- website: string | null;
-};
+export type IntegrationRequest = Partial;
diff --git a/libs/common/src/tools/types.ts b/libs/common/src/tools/types.ts
index 0c2f2832ea..83d69edb06 100644
--- a/libs/common/src/tools/types.ts
+++ b/libs/common/src/tools/types.ts
@@ -46,3 +46,20 @@ export type Constraints = {
/** utility type for methods that evaluate constraints generically. */
export type AnyConstraint = PrimitiveConstraint & StringConstraints & NumberConstraints;
+
+/** Options that provide contextual information about the application state
+ * when a generator is invoked.
+ */
+export type VaultItemRequest = {
+ /** The domain of the website the requested credential is used
+ * within. This should be set to `null` when the request is not specific
+ * to any website.
+ * @remarks this field contains sensitive data
+ */
+ website: string | null;
+};
+
+/** Options that provide contextual information about the application state
+ * when a generator is invoked.
+ */
+export type GenerationRequest = Partial;
diff --git a/libs/common/src/vault/abstractions/folder/folder-api.service.abstraction.ts b/libs/common/src/vault/abstractions/folder/folder-api.service.abstraction.ts
index d29ff71290..1762400b3d 100644
--- a/libs/common/src/vault/abstractions/folder/folder-api.service.abstraction.ts
+++ b/libs/common/src/vault/abstractions/folder/folder-api.service.abstraction.ts
@@ -5,4 +5,5 @@ export class FolderApiServiceAbstraction {
save: (folder: Folder) => Promise;
delete: (id: string) => Promise;
get: (id: string) => Promise;
+ deleteAll: () => Promise;
}
diff --git a/libs/common/src/vault/models/view/collection.view.ts b/libs/common/src/vault/models/view/collection.view.ts
index 0a05007b66..873f538ca6 100644
--- a/libs/common/src/vault/models/view/collection.view.ts
+++ b/libs/common/src/vault/models/view/collection.view.ts
@@ -38,18 +38,14 @@ export class CollectionView implements View, ITreeNodeObject {
}
}
- canEditItems(org: Organization, restrictProviderAccess: boolean): boolean {
+ canEditItems(org: Organization): boolean {
if (org != null && org.id !== this.organizationId) {
throw new Error(
"Id of the organization provided does not match the org id of the collection.",
);
}
- return (
- org?.canEditAllCiphers(restrictProviderAccess) ||
- this.manage ||
- (this.assigned && !this.readOnly)
- );
+ return org?.canEditAllCiphers || this.manage || (this.assigned && !this.readOnly);
}
/**
diff --git a/libs/common/src/vault/services/folder/folder-api.service.ts b/libs/common/src/vault/services/folder/folder-api.service.ts
index c618c95872..e46df37c17 100644
--- a/libs/common/src/vault/services/folder/folder-api.service.ts
+++ b/libs/common/src/vault/services/folder/folder-api.service.ts
@@ -32,6 +32,11 @@ export class FolderApiService implements FolderApiServiceAbstraction {
await this.folderService.delete(id);
}
+ async deleteAll(): Promise {
+ await this.apiService.send("DELETE", "/folders/all", null, true, false);
+ await this.folderService.clear();
+ }
+
async get(id: string): Promise {
const r = await this.apiService.send("GET", "/folders/" + id, null, true, true);
return new FolderResponse(r);
diff --git a/libs/components/src/icon/icons/no-results.ts b/libs/components/src/icon/icons/no-results.ts
index 02e03f4c4e..7ed886a06e 100644
--- a/libs/components/src/icon/icons/no-results.ts
+++ b/libs/components/src/icon/icons/no-results.ts
@@ -2,17 +2,17 @@ import { svgIcon } from "../icon";
export const NoResults = svgIcon`
`;
diff --git a/libs/components/src/tw-theme.css b/libs/components/src/tw-theme.css
index 6234ba380b..6e5bb32eda 100644
--- a/libs/components/src/tw-theme.css
+++ b/libs/components/src/tw-theme.css
@@ -42,6 +42,9 @@
--color-info-600: 85 85 85;
--color-info-700: 59 58 58;
+ --color-art-primary: 2 15 102;
+ --color-art-accent: 85 85 85;
+
--color-text-main: 33 37 41;
--color-text-muted: 109 117 126;
--color-text-contrast: 255 255 255;
@@ -90,6 +93,9 @@
--color-info-600: 164 176 198;
--color-info-700: 209 215 226;
+ --color-art-primary: 226 227 228;
+ --color-art-accent: 164 176 198;
+
--color-text-main: 255 255 255;
--color-text-muted: 186 192 206;
--color-text-contrast: 25 30 38;
diff --git a/libs/components/tailwind.config.base.js b/libs/components/tailwind.config.base.js
index 236baed74c..537e731f14 100644
--- a/libs/components/tailwind.config.base.js
+++ b/libs/components/tailwind.config.base.js
@@ -54,6 +54,10 @@ module.exports = {
600: rgba("--color-info-600"),
700: rgba("--color-info-700"),
},
+ art: {
+ primary: rgba("--color-art-primary"),
+ accent: rgba("--color-art-accent"),
+ },
text: {
main: rgba("--color-text-main"),
muted: rgba("--color-text-muted"),
diff --git a/libs/tools/export/vault-export/vault-export-ui/src/components/export.component.html b/libs/tools/export/vault-export/vault-export-ui/src/components/export.component.html
index 626934b20e..7555b20697 100644
--- a/libs/tools/export/vault-export/vault-export-ui/src/components/export.component.html
+++ b/libs/tools/export/vault-export/vault-export-ui/src/components/export.component.html
@@ -87,7 +87,9 @@
[disabled]="!filePassword"
appStopClick
bitSuffix
- (click)="copyPasswordToClipboard()"
+ [appCopyClick]="filePassword"
+ [valueLabel]="'password' | i18n"
+ showToast
>
{{ "exportPasswordDescription" | i18n }}
diff --git a/libs/tools/export/vault-export/vault-export-ui/src/components/export.component.ts b/libs/tools/export/vault-export/vault-export-ui/src/components/export.component.ts
index d83d189cd7..e4f5ec9d32 100644
--- a/libs/tools/export/vault-export/vault-export-ui/src/components/export.component.ts
+++ b/libs/tools/export/vault-export/vault-export-ui/src/components/export.component.ts
@@ -121,7 +121,6 @@ export class ExportComponent implements OnInit, OnDestroy, AfterViewInit {
encryptedExportType = EncryptedExportType;
protected showFilePassword: boolean;
- filePasswordValue: string = null;
private _disabledByPolicy = false;
organizations$: Observable;
@@ -278,18 +277,9 @@ export class ExportComponent implements OnInit, OnDestroy, AfterViewInit {
generatePassword = async () => {
const [options] = await this.passwordGenerationService.getOptions();
- this.filePasswordValue = await this.passwordGenerationService.generatePassword(options);
- this.exportForm.get("filePassword").setValue(this.filePasswordValue);
- this.exportForm.get("confirmFilePassword").setValue(this.filePasswordValue);
- };
-
- copyPasswordToClipboard = async () => {
- this.platformUtilsService.copyToClipboard(this.filePasswordValue);
- this.toastService.showToast({
- variant: "success",
- title: null,
- message: this.i18nService.t("valueCopied", this.i18nService.t("password")),
- });
+ const generatedPassword = await this.passwordGenerationService.generatePassword(options);
+ this.exportForm.get("filePassword").setValue(generatedPassword);
+ this.exportForm.get("confirmFilePassword").setValue(generatedPassword);
};
submit = async () => {
diff --git a/libs/tools/generator/components/src/dependencies.ts b/libs/tools/generator/components/src/dependencies.ts
index 927c3811c8..d96ff0db8d 100644
--- a/libs/tools/generator/components/src/dependencies.ts
+++ b/libs/tools/generator/components/src/dependencies.ts
@@ -4,41 +4,60 @@ import { ReactiveFormsModule } from "@angular/forms";
import { JslibModule } from "@bitwarden/angular/jslib.module";
import { safeProvider } from "@bitwarden/angular/platform/utils/safe-provider";
+import { SafeInjectionToken } from "@bitwarden/angular/services/injection-tokens";
import { JslibServicesModule } from "@bitwarden/angular/services/jslib-services.module";
import { PolicyService } from "@bitwarden/common/admin-console/abstractions/policy/policy.service.abstraction";
+import { CryptoService } from "@bitwarden/common/platform/abstractions/crypto.service";
import { StateProvider } from "@bitwarden/common/platform/state";
import {
CardComponent,
CheckboxModule,
ColorPasswordModule,
FormFieldModule,
+ IconButtonModule,
InputModule,
+ ItemModule,
SectionComponent,
SectionHeaderComponent,
+ ToggleGroupModule,
} from "@bitwarden/components";
-import { CredentialGeneratorService } from "@bitwarden/generator-core";
+import {
+ createRandomizer,
+ CredentialGeneratorService,
+ Randomizer,
+} from "@bitwarden/generator-core";
+
+const RANDOMIZER = new SafeInjectionToken("Randomizer");
/** Shared module containing generator component dependencies */
@NgModule({
- imports: [SectionComponent, SectionHeaderComponent, CardComponent],
+ imports: [CardComponent, SectionComponent, SectionHeaderComponent],
exports: [
+ CardComponent,
+ CheckboxModule,
+ CommonModule,
+ ColorPasswordModule,
+ FormFieldModule,
+ IconButtonModule,
+ InputModule,
+ ItemModule,
JslibModule,
JslibServicesModule,
- FormFieldModule,
- CommonModule,
ReactiveFormsModule,
- ColorPasswordModule,
- InputModule,
- CheckboxModule,
SectionComponent,
SectionHeaderComponent,
- CardComponent,
+ ToggleGroupModule,
],
providers: [
+ safeProvider({
+ provide: RANDOMIZER,
+ useFactory: createRandomizer,
+ deps: [CryptoService],
+ }),
safeProvider({
provide: CredentialGeneratorService,
useClass: CredentialGeneratorService,
- deps: [StateProvider, PolicyService],
+ deps: [RANDOMIZER, StateProvider, PolicyService],
}),
],
declarations: [],
diff --git a/libs/tools/generator/components/src/index.ts b/libs/tools/generator/components/src/index.ts
index 5915c5d59f..4423f8a1ec 100644
--- a/libs/tools/generator/components/src/index.ts
+++ b/libs/tools/generator/components/src/index.ts
@@ -2,3 +2,4 @@ export { PassphraseSettingsComponent } from "./passphrase-settings.component";
export { CredentialGeneratorHistoryComponent } from "./credential-generator-history.component";
export { EmptyCredentialHistoryComponent } from "./empty-credential-history.component";
export { PasswordSettingsComponent } from "./password-settings.component";
+export { PasswordGeneratorComponent } from "./password-generator.component";
diff --git a/libs/tools/generator/components/src/password-generator.component.html b/libs/tools/generator/components/src/password-generator.component.html
new file mode 100644
index 0000000000..db5a1ed379
--- /dev/null
+++ b/libs/tools/generator/components/src/password-generator.component.html
@@ -0,0 +1,44 @@
+
+
+ {{ "password" | i18n }}
+
+
+ {{ "passphrase" | i18n }}
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/libs/tools/generator/components/src/password-generator.component.ts b/libs/tools/generator/components/src/password-generator.component.ts
new file mode 100644
index 0000000000..6c84d83c4c
--- /dev/null
+++ b/libs/tools/generator/components/src/password-generator.component.ts
@@ -0,0 +1,117 @@
+import { Component, EventEmitter, Input, NgZone, OnDestroy, OnInit, Output } from "@angular/core";
+import { BehaviorSubject, distinctUntilChanged, map, Subject, switchMap, takeUntil } from "rxjs";
+
+import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
+import { UserId } from "@bitwarden/common/types/guid";
+import { CredentialGeneratorService, Generators, GeneratorType } from "@bitwarden/generator-core";
+import { GeneratedCredential } from "@bitwarden/generator-history";
+
+import { DependenciesModule } from "./dependencies";
+import { PassphraseSettingsComponent } from "./passphrase-settings.component";
+import { PasswordSettingsComponent } from "./password-settings.component";
+
+/** Options group for passwords */
+@Component({
+ standalone: true,
+ selector: "bit-password-generator",
+ templateUrl: "password-generator.component.html",
+ imports: [DependenciesModule, PasswordSettingsComponent, PassphraseSettingsComponent],
+})
+export class PasswordGeneratorComponent implements OnInit, OnDestroy {
+ constructor(
+ private generatorService: CredentialGeneratorService,
+ private accountService: AccountService,
+ private zone: NgZone,
+ ) {}
+
+ /** Binds the passphrase component to a specific user's settings.
+ * When this input is not provided, the form binds to the active
+ * user
+ */
+ @Input()
+ userId: UserId | null;
+
+ /** tracks the currently selected credential type */
+ protected credentialType$ = new BehaviorSubject("password");
+
+ /** Emits the last generated value. */
+ protected readonly value$ = new BehaviorSubject("");
+
+ /** Emits when the userId changes */
+ protected readonly userId$ = new BehaviorSubject(null);
+
+ /** Emits when a new credential is requested */
+ protected readonly generate$ = new Subject();
+
+ /** Tracks changes to the selected credential type
+ * @param type the new credential type
+ */
+ protected onCredentialTypeChanged(type: GeneratorType) {
+ if (this.credentialType$.value !== type) {
+ this.credentialType$.next(type);
+ this.generate$.next();
+ }
+ }
+
+ /** Emits credentials created from a generation request. */
+ @Output()
+ readonly onGenerated = new EventEmitter();
+
+ async ngOnInit() {
+ if (this.userId) {
+ this.userId$.next(this.userId);
+ } else {
+ this.accountService.activeAccount$
+ .pipe(
+ map((acct) => acct.id),
+ distinctUntilChanged(),
+ takeUntil(this.destroyed),
+ )
+ .subscribe(this.userId$);
+ }
+
+ this.credentialType$
+ .pipe(
+ switchMap((type) => this.typeToGenerator$(type)),
+ takeUntil(this.destroyed),
+ )
+ .subscribe((generated) => {
+ // update subjects within the angular zone so that the
+ // template bindings refresh immediately
+ this.zone.run(() => {
+ this.onGenerated.next(generated);
+ this.value$.next(generated.credential);
+ });
+ });
+ }
+
+ private typeToGenerator$(type: GeneratorType) {
+ const dependencies = {
+ on$: this.generate$,
+ userId$: this.userId$,
+ };
+
+ switch (type) {
+ case "password":
+ return this.generatorService.generate$(Generators.Password, dependencies);
+
+ case "passphrase":
+ return this.generatorService.generate$(Generators.Passphrase, dependencies);
+ default:
+ throw new Error(`Invalid generator type: "${type}"`);
+ }
+ }
+
+ private readonly destroyed = new Subject();
+ ngOnDestroy(): void {
+ // tear down subscriptions
+ this.destroyed.complete();
+
+ // finalize subjects
+ this.generate$.complete();
+ this.value$.complete();
+
+ // finalize component bindings
+ this.onGenerated.complete();
+ }
+}
diff --git a/libs/tools/generator/core/src/data/generators.ts b/libs/tools/generator/core/src/data/generators.ts
index 94e289be03..f71d484f9c 100644
--- a/libs/tools/generator/core/src/data/generators.ts
+++ b/libs/tools/generator/core/src/data/generators.ts
@@ -1,5 +1,8 @@
+import { Randomizer } from "../abstractions";
+import { PasswordRandomizer } from "../engine";
import { PASSPHRASE_SETTINGS, PASSWORD_SETTINGS } from "../strategies/storage";
import {
+ CredentialGenerator,
PassphraseGenerationOptions,
PassphraseGeneratorPolicy,
PasswordGenerationOptions,
@@ -14,6 +17,12 @@ import { DefaultPasswordGenerationOptions } from "./default-password-generation-
import { Policies } from "./policies";
const PASSPHRASE = Object.freeze({
+ category: "passphrase",
+ engine: {
+ create(randomizer: Randomizer): CredentialGenerator {
+ return new PasswordRandomizer(randomizer);
+ },
+ },
settings: {
initial: DefaultPassphraseGenerationOptions,
constraints: {
@@ -32,6 +41,12 @@ const PASSPHRASE = Object.freeze({
>);
const PASSWORD = Object.freeze({
+ category: "password",
+ engine: {
+ create(randomizer: Randomizer): CredentialGenerator {
+ return new PasswordRandomizer(randomizer);
+ },
+ },
settings: {
initial: DefaultPasswordGenerationOptions,
constraints: {
diff --git a/libs/tools/generator/core/src/engine/password-randomizer.spec.ts b/libs/tools/generator/core/src/engine/password-randomizer.spec.ts
index bbc31a4a29..fca98855fd 100644
--- a/libs/tools/generator/core/src/engine/password-randomizer.spec.ts
+++ b/libs/tools/generator/core/src/engine/password-randomizer.spec.ts
@@ -335,4 +335,40 @@ describe("PasswordRandomizer", () => {
expect(result).toEqual("foo-foo");
});
});
+
+ describe("generate", () => {
+ it("processes password generation options", async () => {
+ const password = new PasswordRandomizer(randomizer);
+
+ const result = await password.generate(
+ {},
+ {
+ length: 10,
+ },
+ );
+
+ expect(result.category).toEqual("password");
+ });
+
+ it("processes passphrase generation options", async () => {
+ const password = new PasswordRandomizer(randomizer);
+
+ const result = await password.generate(
+ {},
+ {
+ numWords: 10,
+ },
+ );
+
+ expect(result.category).toEqual("passphrase");
+ });
+
+ it("throws when it cannot recognize the options type", async () => {
+ const password = new PasswordRandomizer(randomizer);
+
+ const result = password.generate({}, {});
+
+ await expect(result).rejects.toBeInstanceOf(Error);
+ });
+ });
});
diff --git a/libs/tools/generator/core/src/engine/password-randomizer.ts b/libs/tools/generator/core/src/engine/password-randomizer.ts
index 438ea8b8b4..c3a2e2b5d9 100644
--- a/libs/tools/generator/core/src/engine/password-randomizer.ts
+++ b/libs/tools/generator/core/src/engine/password-randomizer.ts
@@ -1,13 +1,26 @@
import { EFFLongWordList } from "@bitwarden/common/platform/misc/wordlist";
+import { GenerationRequest } from "@bitwarden/common/tools/types";
+
+import {
+ CredentialGenerator,
+ GeneratedCredential,
+ PassphraseGenerationOptions,
+ PasswordGenerationOptions,
+} from "../types";
+import { optionsToEffWordListRequest, optionsToRandomAsciiRequest } from "../util";
import { Randomizer } from "./abstractions";
import { Ascii } from "./data";
import { CharacterSet, EffWordListRequest, RandomAsciiRequest } from "./types";
/** Generation algorithms that produce randomized secrets */
-export class PasswordRandomizer {
+export class PasswordRandomizer
+ implements
+ CredentialGenerator,
+ CredentialGenerator
+{
/** Instantiates the password randomizer
- * @param random data source for random data
+ * @param randomizer data source for random data
*/
constructor(private randomizer: Randomizer) {}
@@ -52,6 +65,41 @@ export class PasswordRandomizer {
return wordList.join(request.separator);
}
+
+ generate(
+ request: GenerationRequest,
+ settings: PasswordGenerationOptions,
+ ): Promise;
+ generate(
+ request: GenerationRequest,
+ settings: PassphraseGenerationOptions,
+ ): Promise;
+ async generate(
+ _request: GenerationRequest,
+ settings: PasswordGenerationOptions | PassphraseGenerationOptions,
+ ) {
+ if (isPasswordGenerationOptions(settings)) {
+ const request = optionsToRandomAsciiRequest(settings);
+ const password = await this.randomAscii(request);
+
+ return new GeneratedCredential(password, "password", Date.now());
+ } else if (isPassphraseGenerationOptions(settings)) {
+ const request = optionsToEffWordListRequest(settings);
+ const passphrase = await this.randomEffLongWords(request);
+
+ return new GeneratedCredential(passphrase, "passphrase", Date.now());
+ }
+
+ throw new Error("Invalid settings received by generator.");
+ }
+}
+
+function isPasswordGenerationOptions(settings: any): settings is PasswordGenerationOptions {
+ return "length" in (settings ?? {});
+}
+
+function isPassphraseGenerationOptions(settings: any): settings is PassphraseGenerationOptions {
+ return "numWords" in (settings ?? {});
}
// given a generator request, convert each of its `number | undefined` properties
diff --git a/libs/tools/generator/core/src/services/credential-generator.service.spec.ts b/libs/tools/generator/core/src/services/credential-generator.service.spec.ts
index 31f5134918..5b784b3d07 100644
--- a/libs/tools/generator/core/src/services/credential-generator.service.spec.ts
+++ b/libs/tools/generator/core/src/services/credential-generator.service.spec.ts
@@ -1,5 +1,5 @@
import { mock } from "jest-mock-extended";
-import { BehaviorSubject, firstValueFrom } from "rxjs";
+import { BehaviorSubject, filter, firstValueFrom, Subject } from "rxjs";
import { PolicyService } from "@bitwarden/common/admin-console/abstractions/policy/policy.service.abstraction";
import { PolicyType } from "@bitwarden/common/admin-console/enums";
@@ -8,9 +8,14 @@ import { GENERATOR_DISK, UserKeyDefinition } from "@bitwarden/common/platform/st
import { Constraints } from "@bitwarden/common/tools/types";
import { OrganizationId, PolicyId, UserId } from "@bitwarden/common/types/guid";
-import { FakeStateProvider, FakeAccountService, awaitAsync } from "../../../../../common/spec";
-import { PolicyEvaluator } from "../abstractions";
-import { CredentialGeneratorConfiguration } from "../types";
+import {
+ FakeStateProvider,
+ FakeAccountService,
+ awaitAsync,
+ ObservableTracker,
+} from "../../../../../common/spec";
+import { PolicyEvaluator, Randomizer } from "../abstractions";
+import { CredentialGeneratorConfiguration, GeneratedCredential } from "../types";
import { CredentialGeneratorService } from "./credential-generator.service";
@@ -34,8 +39,23 @@ const somePolicy = new Policy({
enabled: true,
});
+const SomeTime = new Date(1);
+const SomeCategory = "passphrase";
+
// fake the configuration
const SomeConfiguration: CredentialGeneratorConfiguration = {
+ category: SomeCategory,
+ engine: {
+ create: (randomizer) => {
+ return {
+ generate: (request, settings) => {
+ const credential = request.website ? `${request.website}|${settings.foo}` : settings.foo;
+ const result = new GeneratedCredential(credential, SomeCategory, SomeTime);
+ return Promise.resolve(result);
+ },
+ };
+ },
+ },
settings: {
initial: { foo: "initial" },
constraints: { foo: {} },
@@ -87,6 +107,9 @@ const accountService = new FakeAccountService({
// fake state
const stateProvider = new FakeStateProvider(accountService);
+// fake randomizer
+const randomizer = mock();
+
describe("CredentialGeneratorService", () => {
beforeEach(async () => {
await accountService.switchAccount(SomeUser);
@@ -94,10 +117,242 @@ describe("CredentialGeneratorService", () => {
jest.clearAllMocks();
});
+ describe("generate$", () => {
+ it("emits a generation for the active user when subscribed", async () => {
+ const settings = { foo: "value" };
+ await stateProvider.setUserState(SettingsKey, settings, SomeUser);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
+ const generated = new ObservableTracker(generator.generate$(SomeConfiguration));
+
+ const result = await generated.expectEmission();
+
+ expect(result).toEqual(new GeneratedCredential("value", SomeCategory, SomeTime));
+ });
+
+ it("follows the active user", async () => {
+ const someSettings = { foo: "some value" };
+ const anotherSettings = { foo: "another value" };
+ await stateProvider.setUserState(SettingsKey, someSettings, SomeUser);
+ await stateProvider.setUserState(SettingsKey, anotherSettings, AnotherUser);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
+ const generated = new ObservableTracker(generator.generate$(SomeConfiguration));
+
+ await accountService.switchAccount(AnotherUser);
+ await generated.pauseUntilReceived(2);
+ generated.unsubscribe();
+
+ expect(generated.emissions).toEqual([
+ new GeneratedCredential("some value", SomeCategory, SomeTime),
+ new GeneratedCredential("another value", SomeCategory, SomeTime),
+ ]);
+ });
+
+ it("emits a generation when the settings change", async () => {
+ const someSettings = { foo: "some value" };
+ const anotherSettings = { foo: "another value" };
+ await stateProvider.setUserState(SettingsKey, someSettings, SomeUser);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
+ const generated = new ObservableTracker(generator.generate$(SomeConfiguration));
+
+ await stateProvider.setUserState(SettingsKey, anotherSettings, SomeUser);
+ await generated.pauseUntilReceived(2);
+ generated.unsubscribe();
+
+ expect(generated.emissions).toEqual([
+ new GeneratedCredential("some value", SomeCategory, SomeTime),
+ new GeneratedCredential("another value", SomeCategory, SomeTime),
+ ]);
+ });
+
+ // FIXME: test these when the fake state provider can create the required emissions
+ it.todo("errors when the settings error");
+ it.todo("completes when the settings complete");
+
+ it("includes `website$`'s last emitted value", async () => {
+ const settings = { foo: "value" };
+ await stateProvider.setUserState(SettingsKey, settings, SomeUser);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
+ const website$ = new BehaviorSubject("some website");
+ const generated = new ObservableTracker(generator.generate$(SomeConfiguration, { website$ }));
+
+ const result = await generated.expectEmission();
+
+ expect(result).toEqual(new GeneratedCredential("some website|value", SomeCategory, SomeTime));
+ });
+
+ it("errors when `website$` errors", async () => {
+ await stateProvider.setUserState(SettingsKey, null, SomeUser);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
+ const website$ = new BehaviorSubject("some website");
+ let error = null;
+
+ generator.generate$(SomeConfiguration, { website$ }).subscribe({
+ error: (e: unknown) => {
+ error = e;
+ },
+ });
+ website$.error({ some: "error" });
+ await awaitAsync();
+
+ expect(error).toEqual({ some: "error" });
+ });
+
+ it("completes when `website$` completes", async () => {
+ await stateProvider.setUserState(SettingsKey, null, SomeUser);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
+ const website$ = new BehaviorSubject("some website");
+ let completed = false;
+
+ generator.generate$(SomeConfiguration, { website$ }).subscribe({
+ complete: () => {
+ completed = true;
+ },
+ });
+ website$.complete();
+ await awaitAsync();
+
+ expect(completed).toBeTruthy();
+ });
+
+ it("emits a generation for a specific user when `user$` supplied", async () => {
+ await stateProvider.setUserState(SettingsKey, { foo: "value" }, SomeUser);
+ await stateProvider.setUserState(SettingsKey, { foo: "another" }, AnotherUser);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
+ const userId$ = new BehaviorSubject(AnotherUser).asObservable();
+ const generated = new ObservableTracker(generator.generate$(SomeConfiguration, { userId$ }));
+
+ const result = await generated.expectEmission();
+
+ expect(result).toEqual(new GeneratedCredential("another", SomeCategory, SomeTime));
+ });
+
+ it("emits a generation for a specific user when `user$` emits", async () => {
+ await stateProvider.setUserState(SettingsKey, { foo: "value" }, SomeUser);
+ await stateProvider.setUserState(SettingsKey, { foo: "another" }, AnotherUser);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
+ const userId = new BehaviorSubject(SomeUser);
+ const userId$ = userId.pipe(filter((u) => !!u));
+ const generated = new ObservableTracker(generator.generate$(SomeConfiguration, { userId$ }));
+
+ userId.next(AnotherUser);
+ const result = await generated.pauseUntilReceived(2);
+
+ expect(result).toEqual([
+ new GeneratedCredential("value", SomeCategory, SomeTime),
+ new GeneratedCredential("another", SomeCategory, SomeTime),
+ ]);
+ });
+
+ it("errors when `user$` errors", async () => {
+ await stateProvider.setUserState(SettingsKey, null, SomeUser);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
+ const userId$ = new BehaviorSubject(SomeUser);
+ let error = null;
+
+ generator.generate$(SomeConfiguration, { userId$ }).subscribe({
+ error: (e: unknown) => {
+ error = e;
+ },
+ });
+ userId$.error({ some: "error" });
+ await awaitAsync();
+
+ expect(error).toEqual({ some: "error" });
+ });
+
+ it("completes when `user$` completes", async () => {
+ await stateProvider.setUserState(SettingsKey, null, SomeUser);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
+ const userId$ = new BehaviorSubject(SomeUser);
+ let completed = false;
+
+ generator.generate$(SomeConfiguration, { userId$ }).subscribe({
+ complete: () => {
+ completed = true;
+ },
+ });
+ userId$.complete();
+ await awaitAsync();
+
+ expect(completed).toBeTruthy();
+ });
+
+ it("emits a generation only when `on$` emits", async () => {
+ // This test breaks from arrange/act/assert because it is testing causality
+ await stateProvider.setUserState(SettingsKey, { foo: "value" }, SomeUser);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
+ const on$ = new Subject();
+ const results: any[] = [];
+
+ // confirm no emission during subscription
+ const sub = generator
+ .generate$(SomeConfiguration, { on$ })
+ .subscribe((result) => results.push(result));
+ await awaitAsync();
+ expect(results.length).toEqual(0);
+
+ // confirm forwarded emission
+ on$.next();
+ await awaitAsync();
+ expect(results).toEqual([new GeneratedCredential("value", SomeCategory, SomeTime)]);
+
+ // confirm updating settings does not cause an emission
+ await stateProvider.setUserState(SettingsKey, { foo: "next" }, SomeUser);
+ await awaitAsync();
+ expect(results.length).toBe(1);
+
+ // confirm forwarded emission takes latest value
+ on$.next();
+ await awaitAsync();
+ sub.unsubscribe();
+
+ expect(results).toEqual([
+ new GeneratedCredential("value", SomeCategory, SomeTime),
+ new GeneratedCredential("next", SomeCategory, SomeTime),
+ ]);
+ });
+
+ it("errors when `on$` errors", async () => {
+ await stateProvider.setUserState(SettingsKey, { foo: "value" }, SomeUser);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
+ const on$ = new Subject();
+ let error: any = null;
+
+ // confirm no emission during subscription
+ generator.generate$(SomeConfiguration, { on$ }).subscribe({
+ error: (e: unknown) => {
+ error = e;
+ },
+ });
+ on$.error({ some: "error" });
+ await awaitAsync();
+
+ expect(error).toEqual({ some: "error" });
+ });
+
+ it("completes when `on$` completes", async () => {
+ await stateProvider.setUserState(SettingsKey, { foo: "value" }, SomeUser);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
+ const on$ = new Subject();
+ let complete = false;
+
+ // confirm no emission during subscription
+ generator.generate$(SomeConfiguration, { on$ }).subscribe({
+ complete: () => {
+ complete = true;
+ },
+ });
+ on$.complete();
+ await awaitAsync();
+
+ expect(complete).toBeTruthy();
+ });
+ });
+
describe("settings$", () => {
it("defaults to the configuration's initial settings if settings aren't found", async () => {
await stateProvider.setUserState(SettingsKey, null, SomeUser);
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const result = await firstValueFrom(generator.settings$(SomeConfiguration));
@@ -107,7 +362,7 @@ describe("CredentialGeneratorService", () => {
it("reads from the active user's configuration-defined storage", async () => {
const settings = { foo: "value" };
await stateProvider.setUserState(SettingsKey, settings, SomeUser);
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const result = await firstValueFrom(generator.settings$(SomeConfiguration));
@@ -119,7 +374,7 @@ describe("CredentialGeneratorService", () => {
await stateProvider.setUserState(SettingsKey, settings, SomeUser);
const policy$ = new BehaviorSubject([somePolicy]);
policyService.getAll$.mockReturnValue(policy$);
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const result = await firstValueFrom(generator.settings$(SomeConfiguration));
@@ -131,7 +386,7 @@ describe("CredentialGeneratorService", () => {
const anotherSettings = { foo: "another" };
await stateProvider.setUserState(SettingsKey, someSettings, SomeUser);
await stateProvider.setUserState(SettingsKey, anotherSettings, AnotherUser);
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const results: any = [];
const sub = generator.settings$(SomeConfiguration).subscribe((r) => results.push(r));
@@ -148,7 +403,7 @@ describe("CredentialGeneratorService", () => {
await stateProvider.setUserState(SettingsKey, { foo: "value" }, SomeUser);
const anotherSettings = { foo: "another" };
await stateProvider.setUserState(SettingsKey, anotherSettings, AnotherUser);
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const userId$ = new BehaviorSubject(AnotherUser).asObservable();
const result = await firstValueFrom(generator.settings$(SomeConfiguration, { userId$ }));
@@ -161,7 +416,7 @@ describe("CredentialGeneratorService", () => {
await stateProvider.setUserState(SettingsKey, someSettings, SomeUser);
const anotherSettings = { foo: "another" };
await stateProvider.setUserState(SettingsKey, anotherSettings, AnotherUser);
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const userId = new BehaviorSubject(SomeUser);
const userId$ = userId.asObservable();
const results: any = [];
@@ -180,7 +435,7 @@ describe("CredentialGeneratorService", () => {
it("errors when the arbitrary user's stream errors", async () => {
await stateProvider.setUserState(SettingsKey, null, SomeUser);
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const userId = new BehaviorSubject(SomeUser);
const userId$ = userId.asObservable();
let error = null;
@@ -198,7 +453,7 @@ describe("CredentialGeneratorService", () => {
it("completes when the arbitrary user's stream completes", async () => {
await stateProvider.setUserState(SettingsKey, null, SomeUser);
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const userId = new BehaviorSubject(SomeUser);
const userId$ = userId.asObservable();
let completed = false;
@@ -216,7 +471,7 @@ describe("CredentialGeneratorService", () => {
it("ignores repeated arbitrary user emissions", async () => {
await stateProvider.setUserState(SettingsKey, null, SomeUser);
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const userId = new BehaviorSubject(SomeUser);
const userId$ = userId.asObservable();
let count = 0;
@@ -240,7 +495,7 @@ describe("CredentialGeneratorService", () => {
describe("settings", () => {
it("writes to the user's state", async () => {
const singleUserId$ = new BehaviorSubject(SomeUser).asObservable();
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const subject = await generator.settings(SomeConfiguration, { singleUserId$ });
subject.next({ foo: "next value" });
@@ -253,7 +508,7 @@ describe("CredentialGeneratorService", () => {
it("waits for the user to become available", async () => {
const singleUserId = new BehaviorSubject(null);
const singleUserId$ = singleUserId.asObservable();
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
let completed = false;
const promise = generator.settings(SomeConfiguration, { singleUserId$ }).then((settings) => {
@@ -271,7 +526,7 @@ describe("CredentialGeneratorService", () => {
describe("policy$", () => {
it("creates a disabled policy evaluator when there is no policy", async () => {
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const userId$ = new BehaviorSubject(SomeUser).asObservable();
const result = await firstValueFrom(generator.policy$(SomeConfiguration, { userId$ }));
@@ -281,7 +536,7 @@ describe("CredentialGeneratorService", () => {
});
it("creates an active policy evaluator when there is a policy", async () => {
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const userId$ = new BehaviorSubject(SomeUser).asObservable();
const policy$ = new BehaviorSubject([somePolicy]);
policyService.getAll$.mockReturnValue(policy$);
@@ -293,7 +548,7 @@ describe("CredentialGeneratorService", () => {
});
it("follows policy emissions", async () => {
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const userId = new BehaviorSubject(SomeUser);
const userId$ = userId.asObservable();
const somePolicySubject = new BehaviorSubject([somePolicy]);
@@ -316,7 +571,7 @@ describe("CredentialGeneratorService", () => {
});
it("follows user emissions", async () => {
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const userId = new BehaviorSubject(SomeUser);
const userId$ = userId.asObservable();
const somePolicy$ = new BehaviorSubject([somePolicy]).asObservable();
@@ -340,7 +595,7 @@ describe("CredentialGeneratorService", () => {
});
it("errors when the user errors", async () => {
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const userId = new BehaviorSubject(SomeUser);
const userId$ = userId.asObservable();
const expectedError = { some: "error" };
@@ -358,7 +613,7 @@ describe("CredentialGeneratorService", () => {
});
it("completes when the user completes", async () => {
- const generator = new CredentialGeneratorService(stateProvider, policyService);
+ const generator = new CredentialGeneratorService(randomizer, stateProvider, policyService);
const userId = new BehaviorSubject(SomeUser);
const userId$ = userId.asObservable();
diff --git a/libs/tools/generator/core/src/services/credential-generator.service.ts b/libs/tools/generator/core/src/services/credential-generator.service.ts
index 891d0016fe..d2012ecf20 100644
--- a/libs/tools/generator/core/src/services/credential-generator.service.ts
+++ b/libs/tools/generator/core/src/services/credential-generator.service.ts
@@ -1,5 +1,7 @@
import {
+ BehaviorSubject,
combineLatest,
+ concatMap,
distinctUntilChanged,
endWith,
filter,
@@ -8,32 +10,84 @@ import {
map,
mergeMap,
Observable,
+ race,
switchMap,
takeUntil,
+ withLatestFrom,
} from "rxjs";
+import { Simplify } from "type-fest";
import { PolicyService } from "@bitwarden/common/admin-console/abstractions/policy/policy.service.abstraction";
import { StateProvider } from "@bitwarden/common/platform/state";
-import { SingleUserDependency, UserDependency } from "@bitwarden/common/tools/dependencies";
+import {
+ OnDependency,
+ SingleUserDependency,
+ UserDependency,
+} from "@bitwarden/common/tools/dependencies";
import { UserStateSubject } from "@bitwarden/common/tools/state/user-state-subject";
import { Constraints } from "@bitwarden/common/tools/types";
-import { PolicyEvaluator } from "../abstractions";
+import { PolicyEvaluator, Randomizer } from "../abstractions";
import { mapPolicyToEvaluatorV2 } from "../rx";
import { CredentialGeneratorConfiguration as Configuration } from "../types/credential-generator-configuration";
type Policy$Dependencies = UserDependency;
type Settings$Dependencies = Partial;
+type Generate$Dependencies = Simplify & Partial> & {
+ /** Emits the active website when subscribed.
+ *
+ * The generator does not respond to emissions of this interface;
+ * If it is provided, the generator blocks until a value becomes available.
+ * When `website$` is omitted, the generator uses the empty string instead.
+ * When `website$` completes, the generator completes.
+ * When `website$` errors, the generator forwards the error.
+ */
+ website$?: Observable;
+};
// FIXME: once the modernization is complete, switch the type parameters
// in `PolicyEvaluator` and bake-in the constraints type.
type Evaluator = PolicyEvaluator & Constraints;
export class CredentialGeneratorService {
constructor(
+ private randomizer: Randomizer,
private stateProvider: StateProvider,
private policyService: PolicyService,
) {}
+ /** Generates a stream of credentials
+ * @param configuration determines which generator's settings are loaded
+ * @param dependencies.on$ when specified, a new credential is emitted when
+ * this emits. Otherwise, a new credential is emitted when the settings
+ * update.
+ */
+ generate$(
+ configuration: Readonly>,
+ dependencies?: Generate$Dependencies,
+ ) {
+ // instantiate the engine
+ const engine = configuration.engine.create(this.randomizer);
+
+ // stream blocks until all of these values are received
+ const website$ = dependencies?.website$ ?? new BehaviorSubject(null);
+ const request$ = website$.pipe(map((website) => ({ website })));
+ const settings$ = this.settings$(configuration, dependencies);
+
+ // monitor completion
+ const requestComplete$ = request$.pipe(ignoreElements(), endWith(true));
+ const settingsComplete$ = request$.pipe(ignoreElements(), endWith(true));
+ const complete$ = race(requestComplete$, settingsComplete$);
+
+ // generation proper
+ const generate$ = (dependencies?.on$ ?? settings$).pipe(
+ withLatestFrom(request$, settings$),
+ concatMap(([, request, settings]) => engine.generate(request, settings)),
+ takeUntil(complete$),
+ );
+
+ return generate$;
+ }
+
/** Get the settings for the provided configuration
* @param configuration determines which generator's settings are loaded
* @param dependencies.userId$ identifies the user to which the settings are bound.
@@ -82,7 +136,7 @@ export class CredentialGeneratorService {
* @remarks the subject enforces policy for the settings
*/
async settings(
- configuration: Configuration,
+ configuration: Readonly>,
dependencies: SingleUserDependency,
) {
const userId = await firstValueFrom(
diff --git a/libs/tools/generator/core/src/strategies/passphrase-generator-strategy.spec.ts b/libs/tools/generator/core/src/strategies/passphrase-generator-strategy.spec.ts
index f9b346e02b..6591b179fc 100644
--- a/libs/tools/generator/core/src/strategies/passphrase-generator-strategy.spec.ts
+++ b/libs/tools/generator/core/src/strategies/passphrase-generator-strategy.spec.ts
@@ -17,7 +17,7 @@ import { PASSPHRASE_SETTINGS } from "./storage";
const SomeUser = "some user" as UserId;
-describe("Password generation strategy", () => {
+describe("Passphrase generation strategy", () => {
describe("toEvaluator()", () => {
it("should map to the policy evaluator", async () => {
const strategy = new PassphraseGeneratorStrategy(null, null);
diff --git a/libs/tools/generator/core/src/strategies/passphrase-generator-strategy.ts b/libs/tools/generator/core/src/strategies/passphrase-generator-strategy.ts
index fe2731f9dd..37d8b9e3fb 100644
--- a/libs/tools/generator/core/src/strategies/passphrase-generator-strategy.ts
+++ b/libs/tools/generator/core/src/strategies/passphrase-generator-strategy.ts
@@ -2,11 +2,11 @@ import { PolicyType } from "@bitwarden/common/admin-console/enums";
import { StateProvider } from "@bitwarden/common/platform/state";
import { GeneratorStrategy } from "../abstractions";
-import { DefaultPassphraseBoundaries, DefaultPassphraseGenerationOptions, Policies } from "../data";
+import { DefaultPassphraseGenerationOptions, Policies } from "../data";
import { PasswordRandomizer } from "../engine";
import { mapPolicyToEvaluator } from "../rx";
import { PassphraseGenerationOptions, PassphraseGeneratorPolicy } from "../types";
-import { observe$PerUserId, sharedStateByUserId } from "../util";
+import { observe$PerUserId, optionsToEffWordListRequest, sharedStateByUserId } from "../util";
import { PASSPHRASE_SETTINGS } from "./storage";
@@ -33,13 +33,7 @@ export class PassphraseGeneratorStrategy
// algorithm
async generate(options: PassphraseGenerationOptions): Promise {
- const requestWords = options.numWords ?? DefaultPassphraseGenerationOptions.numWords;
- const request = {
- numberOfWords: Math.max(requestWords, DefaultPassphraseBoundaries.numWords.min),
- capitalize: options.capitalize ?? DefaultPassphraseGenerationOptions.capitalize,
- number: options.includeNumber ?? DefaultPassphraseGenerationOptions.includeNumber,
- separator: options.wordSeparator ?? DefaultPassphraseGenerationOptions.wordSeparator,
- };
+ const request = optionsToEffWordListRequest(options);
return this.randomizer.randomEffLongWords(request);
}
diff --git a/libs/tools/generator/core/src/strategies/password-generator-strategy.ts b/libs/tools/generator/core/src/strategies/password-generator-strategy.ts
index 9ed62490c0..9ff8a3d88b 100644
--- a/libs/tools/generator/core/src/strategies/password-generator-strategy.ts
+++ b/libs/tools/generator/core/src/strategies/password-generator-strategy.ts
@@ -6,7 +6,7 @@ import { Policies, DefaultPasswordGenerationOptions } from "../data";
import { PasswordRandomizer } from "../engine";
import { mapPolicyToEvaluator } from "../rx";
import { PasswordGenerationOptions, PasswordGeneratorPolicy } from "../types";
-import { observe$PerUserId, sharedStateByUserId, sum } from "../util";
+import { observe$PerUserId, optionsToRandomAsciiRequest, sharedStateByUserId } from "../util";
import { PASSWORD_SETTINGS } from "./storage";
@@ -32,62 +32,7 @@ export class PasswordGeneratorStrategy
// algorithm
async generate(options: PasswordGenerationOptions): Promise {
- // converts password generation option sets, which are defined by
- // an "enabled" and "quantity" parameter, to the password engine's
- // parameters, which represent disabled options as `undefined`
- // properties.
- function process(
- // values read from the options
- enabled: boolean,
- quantity: number,
- // value used if an option is missing
- defaultEnabled: boolean,
- defaultQuantity: number,
- ) {
- const isEnabled = enabled ?? defaultEnabled;
- const actualQuantity = quantity ?? defaultQuantity;
- const result = isEnabled ? actualQuantity : undefined;
-
- return result;
- }
-
- const request = {
- uppercase: process(
- options.uppercase,
- options.minUppercase,
- DefaultPasswordGenerationOptions.uppercase,
- DefaultPasswordGenerationOptions.minUppercase,
- ),
- lowercase: process(
- options.lowercase,
- options.minLowercase,
- DefaultPasswordGenerationOptions.lowercase,
- DefaultPasswordGenerationOptions.minLowercase,
- ),
- digits: process(
- options.number,
- options.minNumber,
- DefaultPasswordGenerationOptions.number,
- DefaultPasswordGenerationOptions.minNumber,
- ),
- special: process(
- options.special,
- options.minSpecial,
- DefaultPasswordGenerationOptions.special,
- DefaultPasswordGenerationOptions.minSpecial,
- ),
- ambiguous: options.ambiguous ?? DefaultPasswordGenerationOptions.ambiguous,
- all: 0,
- };
-
- // engine represents character sets as "include only"; you assert how many all
- // characters there can be rather than a total length. This conversion has
- // the character classes win, so that the result is always consistent with policy
- // minimums.
- const required = sum(request.uppercase, request.lowercase, request.digits, request.special);
- const remaining = (options.length ?? 0) - required;
- request.all = Math.max(remaining, 0);
-
+ const request = optionsToRandomAsciiRequest(options);
const result = await this.randomizer.randomAscii(request);
return result;
diff --git a/libs/tools/generator/core/src/types/credential-category.ts b/libs/tools/generator/core/src/types/credential-category.ts
new file mode 100644
index 0000000000..54c8c5ed8e
--- /dev/null
+++ b/libs/tools/generator/core/src/types/credential-category.ts
@@ -0,0 +1,5 @@
+/** Kinds of credentials that can be stored by the history service
+ * password - a secret consisting of arbitrary characters used to authenticate a user
+ * passphrase - a secret consisting of words used to authenticate a user
+ */
+export type CredentialCategory = "password" | "passphrase";
diff --git a/libs/tools/generator/core/src/types/credential-generator-configuration.ts b/libs/tools/generator/core/src/types/credential-generator-configuration.ts
index 2a8b07b0e8..80d977a73c 100644
--- a/libs/tools/generator/core/src/types/credential-generator-configuration.ts
+++ b/libs/tools/generator/core/src/types/credential-generator-configuration.ts
@@ -1,9 +1,29 @@
import { UserKeyDefinition } from "@bitwarden/common/platform/state";
import { Constraints } from "@bitwarden/common/tools/types";
+import { Randomizer } from "../abstractions";
import { PolicyConfiguration } from "../types";
+import { CredentialCategory } from "./credential-category";
+import { CredentialGenerator } from "./credential-generator";
+
export type CredentialGeneratorConfiguration = {
+ /** Category describing usage of the credential generated by this configuration
+ */
+ category: CredentialCategory;
+
+ /** An algorithm that generates credentials when ran. */
+ engine: {
+ /** Factory for the generator
+ */
+ // FIXME: note that this erases the engine's type so that credentials are
+ // generated uniformly. This property needs to be maintained for
+ // the credential generator, but engine configurations should return
+ // the underlying type. `create` may be able to do double-duty w/ an
+ // engine definition if `CredentialGenerator` can be made covariant.
+ create: (randomizer: Randomizer) => CredentialGenerator;
+ };
+ /** Defines the stored parameters for credential generation */
settings: {
/** value used when an account's settings haven't been initialized */
initial: Readonly>;
diff --git a/libs/tools/generator/core/src/types/credential-generator.ts b/libs/tools/generator/core/src/types/credential-generator.ts
new file mode 100644
index 0000000000..c95ff25aff
--- /dev/null
+++ b/libs/tools/generator/core/src/types/credential-generator.ts
@@ -0,0 +1,12 @@
+import { GenerationRequest } from "@bitwarden/common/tools/types";
+
+import { GeneratedCredential } from "./generated-credential";
+
+/** An algorithm that generates credentials. */
+export type CredentialGenerator = {
+ /** Generates a credential
+ * @param request runtime parameters
+ * @param settings stored parameters
+ */
+ generate: (request: GenerationRequest, settings: Settings) => Promise;
+};
diff --git a/libs/tools/generator/core/src/types/generated-credential.spec.ts b/libs/tools/generator/core/src/types/generated-credential.spec.ts
new file mode 100644
index 0000000000..a687676576
--- /dev/null
+++ b/libs/tools/generator/core/src/types/generated-credential.spec.ts
@@ -0,0 +1,58 @@
+import { CredentialCategory, GeneratedCredential } from ".";
+
+describe("GeneratedCredential", () => {
+ describe("constructor", () => {
+ it("assigns credential", () => {
+ const result = new GeneratedCredential("example", "passphrase", new Date(100));
+
+ expect(result.credential).toEqual("example");
+ });
+
+ it("assigns category", () => {
+ const result = new GeneratedCredential("example", "passphrase", new Date(100));
+
+ expect(result.category).toEqual("passphrase");
+ });
+
+ it("passes through date parameters", () => {
+ const result = new GeneratedCredential("example", "password", new Date(100));
+
+ expect(result.generationDate).toEqual(new Date(100));
+ });
+
+ it("converts numeric dates to Dates", () => {
+ const result = new GeneratedCredential("example", "password", 100);
+
+ expect(result.generationDate).toEqual(new Date(100));
+ });
+ });
+
+ it("toJSON converts from a credential into a JSON object", () => {
+ const credential = new GeneratedCredential("example", "password", new Date(100));
+
+ const result = credential.toJSON();
+
+ expect(result).toEqual({
+ credential: "example",
+ category: "password" as CredentialCategory,
+ generationDate: 100,
+ });
+ });
+
+ it("fromJSON converts Json objects into credentials", () => {
+ const jsonValue = {
+ credential: "example",
+ category: "password" as CredentialCategory,
+ generationDate: 100,
+ };
+
+ const result = GeneratedCredential.fromJSON(jsonValue);
+
+ expect(result).toBeInstanceOf(GeneratedCredential);
+ expect(result).toEqual({
+ credential: "example",
+ category: "password",
+ generationDate: new Date(100),
+ });
+ });
+});
diff --git a/libs/tools/generator/core/src/types/generated-credential.ts b/libs/tools/generator/core/src/types/generated-credential.ts
new file mode 100644
index 0000000000..ff174b04a5
--- /dev/null
+++ b/libs/tools/generator/core/src/types/generated-credential.ts
@@ -0,0 +1,47 @@
+import { Jsonify } from "type-fest";
+
+import { CredentialCategory } from "./credential-category";
+
+/** A credential generation result */
+export class GeneratedCredential {
+ /**
+ * Instantiates a generated credential
+ * @param credential The value of the generated credential (e.g. a password)
+ * @param category The kind of credential
+ * @param generationDate The date that the credential was generated.
+ * Numeric values should are interpreted using {@link Date.valueOf}
+ * semantics.
+ */
+ constructor(
+ readonly credential: string,
+ readonly category: CredentialCategory,
+ generationDate: Date | number,
+ ) {
+ if (typeof generationDate === "number") {
+ this.generationDate = new Date(generationDate);
+ } else {
+ this.generationDate = generationDate;
+ }
+ }
+
+ /** The date that the credential was generated */
+ generationDate: Date;
+
+ /** Constructs a credential from its `toJSON` representation */
+ static fromJSON(jsonValue: Jsonify) {
+ return new GeneratedCredential(
+ jsonValue.credential,
+ jsonValue.category,
+ jsonValue.generationDate,
+ );
+ }
+
+ /** Serializes a credential to a JSON-compatible object */
+ toJSON() {
+ return {
+ credential: this.credential,
+ category: this.category,
+ generationDate: this.generationDate.valueOf(),
+ };
+ }
+}
diff --git a/libs/tools/generator/core/src/types/index.ts b/libs/tools/generator/core/src/types/index.ts
index 786b15b9d1..229ac1c0c3 100644
--- a/libs/tools/generator/core/src/types/index.ts
+++ b/libs/tools/generator/core/src/types/index.ts
@@ -1,8 +1,11 @@
export * from "./boundary";
export * from "./catchall-generator-options";
+export * from "./credential-category";
+export * from "./credential-generator";
export * from "./credential-generator-configuration";
export * from "./eff-username-generator-options";
export * from "./forwarder-options";
+export * from "./generated-credential";
export * from "./generator-options";
export * from "./generator-type";
export * from "./no-policy";
diff --git a/libs/tools/generator/core/src/util.spec.ts b/libs/tools/generator/core/src/util.spec.ts
index 32bdc3ad3a..7ffd869535 100644
--- a/libs/tools/generator/core/src/util.spec.ts
+++ b/libs/tools/generator/core/src/util.spec.ts
@@ -1,4 +1,5 @@
-import { sum } from "./util";
+import { DefaultPassphraseGenerationOptions } from "./data";
+import { optionsToEffWordListRequest, optionsToRandomAsciiRequest, sum } from "./util";
describe("sum", () => {
it("returns 0 when the list is empty", () => {
@@ -15,3 +16,411 @@ describe("sum", () => {
expect(sum(1, 2, 3)).toBe(6);
});
});
+
+describe("optionsToRandomAsciiRequest", () => {
+ it("should map options", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 20,
+ ambiguous: true,
+ uppercase: true,
+ lowercase: true,
+ number: true,
+ special: true,
+ minUppercase: 1,
+ minLowercase: 2,
+ minNumber: 3,
+ minSpecial: 4,
+ });
+
+ expect(result).toEqual({
+ all: 10,
+ uppercase: 1,
+ lowercase: 2,
+ digits: 3,
+ special: 4,
+ ambiguous: true,
+ });
+ });
+
+ it("should disable uppercase", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 3,
+ ambiguous: true,
+ uppercase: false,
+ lowercase: true,
+ number: true,
+ special: true,
+ minUppercase: 1,
+ minLowercase: 1,
+ minNumber: 1,
+ minSpecial: 1,
+ });
+
+ expect(result).toEqual({
+ all: 0,
+ uppercase: undefined,
+ lowercase: 1,
+ digits: 1,
+ special: 1,
+ ambiguous: true,
+ });
+ });
+
+ it("should disable lowercase", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 3,
+ ambiguous: true,
+ uppercase: true,
+ lowercase: false,
+ number: true,
+ special: true,
+ minUppercase: 1,
+ minLowercase: 1,
+ minNumber: 1,
+ minSpecial: 1,
+ });
+
+ expect(result).toEqual({
+ all: 0,
+ uppercase: 1,
+ lowercase: undefined,
+ digits: 1,
+ special: 1,
+ ambiguous: true,
+ });
+ });
+
+ it("should disable digits", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 3,
+ ambiguous: true,
+ uppercase: true,
+ lowercase: true,
+ number: false,
+ special: true,
+ minUppercase: 1,
+ minLowercase: 1,
+ minNumber: 1,
+ minSpecial: 1,
+ });
+
+ expect(result).toEqual({
+ all: 0,
+ uppercase: 1,
+ lowercase: 1,
+ digits: undefined,
+ special: 1,
+ ambiguous: true,
+ });
+ });
+
+ it("should disable special", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 3,
+ ambiguous: true,
+ uppercase: true,
+ lowercase: true,
+ number: true,
+ special: false,
+ minUppercase: 1,
+ minLowercase: 1,
+ minNumber: 1,
+ minSpecial: 1,
+ });
+
+ expect(result).toEqual({
+ all: 0,
+ uppercase: 1,
+ lowercase: 1,
+ digits: 1,
+ special: undefined,
+ ambiguous: true,
+ });
+ });
+
+ it("should override length with minimums", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 20,
+ ambiguous: true,
+ uppercase: true,
+ lowercase: true,
+ number: true,
+ special: true,
+ minUppercase: 1,
+ minLowercase: 2,
+ minNumber: 3,
+ minSpecial: 4,
+ });
+
+ expect(result).toEqual({
+ all: 10,
+ uppercase: 1,
+ lowercase: 2,
+ digits: 3,
+ special: 4,
+ ambiguous: true,
+ });
+ });
+
+ it("should default uppercase", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 2,
+ ambiguous: true,
+ lowercase: true,
+ number: true,
+ special: true,
+ minUppercase: 2,
+ minLowercase: 0,
+ minNumber: 0,
+ minSpecial: 0,
+ });
+
+ expect(result).toEqual({
+ all: 0,
+ uppercase: 2,
+ lowercase: 0,
+ digits: 0,
+ special: 0,
+ ambiguous: true,
+ });
+ });
+
+ it("should default lowercase", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 0,
+ ambiguous: true,
+ uppercase: true,
+ number: true,
+ special: true,
+ minUppercase: 0,
+ minLowercase: 2,
+ minNumber: 0,
+ minSpecial: 0,
+ });
+
+ expect(result).toEqual({
+ all: 0,
+ uppercase: 0,
+ lowercase: 2,
+ digits: 0,
+ special: 0,
+ ambiguous: true,
+ });
+ });
+
+ it("should default number", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 0,
+ ambiguous: true,
+ uppercase: true,
+ lowercase: true,
+ special: true,
+ minUppercase: 0,
+ minLowercase: 0,
+ minNumber: 2,
+ minSpecial: 0,
+ });
+
+ expect(result).toEqual({
+ all: 0,
+ uppercase: 0,
+ lowercase: 0,
+ digits: 2,
+ special: 0,
+ ambiguous: true,
+ });
+ });
+
+ it("should default special", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 0,
+ ambiguous: true,
+ uppercase: true,
+ lowercase: true,
+ number: true,
+ minUppercase: 0,
+ minLowercase: 0,
+ minNumber: 0,
+ minSpecial: 0,
+ });
+
+ expect(result).toEqual({
+ all: 0,
+ uppercase: 0,
+ lowercase: 0,
+ digits: 0,
+ special: undefined,
+ ambiguous: true,
+ });
+ });
+
+ it("should default minUppercase", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 0,
+ ambiguous: true,
+ uppercase: true,
+ lowercase: true,
+ number: true,
+ special: true,
+ minLowercase: 0,
+ minNumber: 0,
+ minSpecial: 0,
+ });
+
+ expect(result).toEqual({
+ all: 0,
+ uppercase: 1,
+ lowercase: 0,
+ digits: 0,
+ special: 0,
+ ambiguous: true,
+ });
+ });
+
+ it("should default minLowercase", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 0,
+ ambiguous: true,
+ uppercase: true,
+ lowercase: true,
+ number: true,
+ special: true,
+ minUppercase: 0,
+ minNumber: 0,
+ minSpecial: 0,
+ });
+
+ expect(result).toEqual({
+ all: 0,
+ uppercase: 0,
+ lowercase: 1,
+ digits: 0,
+ special: 0,
+ ambiguous: true,
+ });
+ });
+
+ it("should default minNumber", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 0,
+ ambiguous: true,
+ uppercase: true,
+ lowercase: true,
+ number: true,
+ special: true,
+ minUppercase: 0,
+ minLowercase: 0,
+ minSpecial: 0,
+ });
+
+ expect(result).toEqual({
+ all: 0,
+ uppercase: 0,
+ lowercase: 0,
+ digits: 1,
+ special: 0,
+ ambiguous: true,
+ });
+ });
+
+ it("should default minSpecial", async () => {
+ const result = optionsToRandomAsciiRequest({
+ length: 0,
+ ambiguous: true,
+ uppercase: true,
+ lowercase: true,
+ number: true,
+ special: true,
+ minUppercase: 0,
+ minLowercase: 0,
+ minNumber: 0,
+ });
+
+ expect(result).toEqual({
+ all: 0,
+ uppercase: 0,
+ lowercase: 0,
+ digits: 0,
+ special: 0,
+ ambiguous: true,
+ });
+ });
+});
+
+describe("optionsToEffWordListRequest", () => {
+ it("should map options", async () => {
+ const result = optionsToEffWordListRequest({
+ numWords: 4,
+ capitalize: true,
+ includeNumber: true,
+ wordSeparator: "!",
+ });
+
+ expect(result).toEqual({
+ numberOfWords: 4,
+ capitalize: true,
+ number: true,
+ separator: "!",
+ });
+ });
+
+ it("should default numWords", async () => {
+ const result = optionsToEffWordListRequest({
+ capitalize: true,
+ includeNumber: true,
+ wordSeparator: "!",
+ });
+
+ expect(result).toEqual({
+ numberOfWords: DefaultPassphraseGenerationOptions.numWords,
+ capitalize: true,
+ number: true,
+ separator: "!",
+ });
+ });
+
+ it("should default capitalize", async () => {
+ const result = optionsToEffWordListRequest({
+ numWords: 4,
+ includeNumber: true,
+ wordSeparator: "!",
+ });
+
+ expect(result).toEqual({
+ numberOfWords: 4,
+ capitalize: DefaultPassphraseGenerationOptions.capitalize,
+ number: true,
+ separator: "!",
+ });
+ });
+
+ it("should default includeNumber", async () => {
+ const result = optionsToEffWordListRequest({
+ numWords: 4,
+ capitalize: true,
+ wordSeparator: "!",
+ });
+
+ expect(result).toEqual({
+ numberOfWords: 4,
+ capitalize: true,
+ number: DefaultPassphraseGenerationOptions.includeNumber,
+ separator: "!",
+ });
+ });
+
+ it("should default wordSeparator", async () => {
+ const result = optionsToEffWordListRequest({
+ numWords: 4,
+ capitalize: true,
+ includeNumber: true,
+ });
+
+ expect(result).toEqual({
+ numberOfWords: 4,
+ capitalize: true,
+ number: true,
+ separator: DefaultPassphraseGenerationOptions.wordSeparator,
+ });
+ });
+});
diff --git a/libs/tools/generator/core/src/util.ts b/libs/tools/generator/core/src/util.ts
index cca2c75834..21e901765e 100644
--- a/libs/tools/generator/core/src/util.ts
+++ b/libs/tools/generator/core/src/util.ts
@@ -7,6 +7,13 @@ import {
} from "@bitwarden/common/platform/state";
import { UserId } from "@bitwarden/common/types/guid";
+import {
+ DefaultPassphraseBoundaries,
+ DefaultPassphraseGenerationOptions,
+ DefaultPasswordGenerationOptions,
+} from "./data";
+import { PassphraseGenerationOptions, PasswordGenerationOptions } from "./types";
+
/** construct a method that outputs a copy of `defaultValue` as an observable. */
export function observe$PerUserId(
create: () => Partial,
@@ -50,3 +57,79 @@ export function sharedStateByUserId(key: UserKeyDefinition, provid
/** returns the sum of items in the list. */
export const sum = (...items: number[]) =>
(items ?? []).reduce((sum: number, current: number) => sum + (current ?? 0), 0);
+
+/* converts password generation option sets, which are defined by
+ * an "enabled" and "quantity" parameter, to the password engine's
+ * parameters, which represent disabled options as `undefined`
+ * properties.
+ */
+export function optionsToRandomAsciiRequest(options: PasswordGenerationOptions) {
+ // helper for processing common option sets
+ function process(
+ // values read from the options
+ enabled: boolean,
+ quantity: number,
+ // value used if an option is missing
+ defaultEnabled: boolean,
+ defaultQuantity: number,
+ ) {
+ const isEnabled = enabled ?? defaultEnabled;
+ const actualQuantity = quantity ?? defaultQuantity;
+ const result = isEnabled ? actualQuantity : undefined;
+
+ return result;
+ }
+
+ const request = {
+ uppercase: process(
+ options.uppercase,
+ options.minUppercase,
+ DefaultPasswordGenerationOptions.uppercase,
+ DefaultPasswordGenerationOptions.minUppercase,
+ ),
+ lowercase: process(
+ options.lowercase,
+ options.minLowercase,
+ DefaultPasswordGenerationOptions.lowercase,
+ DefaultPasswordGenerationOptions.minLowercase,
+ ),
+ digits: process(
+ options.number,
+ options.minNumber,
+ DefaultPasswordGenerationOptions.number,
+ DefaultPasswordGenerationOptions.minNumber,
+ ),
+ special: process(
+ options.special,
+ options.minSpecial,
+ DefaultPasswordGenerationOptions.special,
+ DefaultPasswordGenerationOptions.minSpecial,
+ ),
+ ambiguous: options.ambiguous ?? DefaultPasswordGenerationOptions.ambiguous,
+ all: 0,
+ };
+
+ // engine represents character sets as "include only"; you assert how many all
+ // characters there can be rather than a total length. This conversion has
+ // the character classes win, so that the result is always consistent with policy
+ // minimums.
+ const required = sum(request.uppercase, request.lowercase, request.digits, request.special);
+ const remaining = (options.length ?? 0) - required;
+ request.all = Math.max(remaining, 0);
+
+ return request;
+}
+
+/* converts passphrase generation option sets to the eff word list request
+ */
+export function optionsToEffWordListRequest(options: PassphraseGenerationOptions) {
+ const requestWords = options.numWords ?? DefaultPassphraseGenerationOptions.numWords;
+ const request = {
+ numberOfWords: Math.max(requestWords, DefaultPassphraseBoundaries.numWords.min),
+ capitalize: options.capitalize ?? DefaultPassphraseGenerationOptions.capitalize,
+ number: options.includeNumber ?? DefaultPassphraseGenerationOptions.includeNumber,
+ separator: options.wordSeparator ?? DefaultPassphraseGenerationOptions.wordSeparator,
+ };
+
+ return request;
+}
diff --git a/libs/tools/send/send-ui/src/icons/no-send.icon.ts b/libs/tools/send/send-ui/src/icons/no-send.icon.ts
index e1442ad702..555d802460 100644
--- a/libs/tools/send/send-ui/src/icons/no-send.icon.ts
+++ b/libs/tools/send/send-ui/src/icons/no-send.icon.ts
@@ -2,12 +2,12 @@ import { svgIcon } from "@bitwarden/components";
export const NoSendsIcon = svgIcon`
`;
diff --git a/libs/tools/send/send-ui/src/icons/send-created.icon.ts b/libs/tools/send/send-ui/src/icons/send-created.icon.ts
index bb4bc2dd3b..099baebb9a 100644
--- a/libs/tools/send/send-ui/src/icons/send-created.icon.ts
+++ b/libs/tools/send/send-ui/src/icons/send-created.icon.ts
@@ -2,12 +2,12 @@ import { svgIcon } from "@bitwarden/components";
export const SendCreatedIcon = svgIcon`