mirror of
https://github.com/bitwarden/browser
synced 2025-12-20 18:23:31 +00:00
9a66aea1c9
* initial impl * rename file to fix linter error * Rename vNext-policy-state.ts to vnext-policy-state.ts * fix masterPasswordPolicyOptions$ * fix ts-strict errors, refactor policies$ and tests * cleanup * cleanup --------- Co-authored-by: Thomas Rittson <31796059+eliykat@users.noreply.github.com>
69 lines
3.0 KiB
TypeScript
69 lines
3.0 KiB
TypeScript
import { Observable } from "rxjs";
|
|
|
|
import { UserId } from "../../../types/guid";
|
|
import { PolicyType } from "../../enums";
|
|
import { PolicyData } from "../../models/data/policy.data";
|
|
import { MasterPasswordPolicyOptions } from "../../models/domain/master-password-policy-options";
|
|
import { Policy } from "../../models/domain/policy";
|
|
import { ResetPasswordPolicyOptions } from "../../models/domain/reset-password-policy-options";
|
|
|
|
export abstract class vNextPolicyService {
|
|
/**
|
|
* All policies for the provided user from sync data.
|
|
* May include policies that are disabled or otherwise do not apply to the user. Be careful using this!
|
|
* Consider {@link policiesByType$} instead, which will only return policies that should be enforced against the user.
|
|
*/
|
|
abstract policies$: (userId: UserId) => Observable<Policy[]>;
|
|
|
|
/**
|
|
* @returns all {@link Policy} objects of a given type that apply to the specified user.
|
|
* A policy "applies" if it is enabled and the user is not exempt (e.g. because they are an Owner).
|
|
* @param policyType the {@link PolicyType} to search for
|
|
* @param userId the {@link UserId} to search against
|
|
*/
|
|
abstract policiesByType$: (policyType: PolicyType, userId: UserId) => Observable<Policy[]>;
|
|
|
|
/**
|
|
* @returns true if a policy of the specified type applies to the specified user, otherwise false.
|
|
* A policy "applies" if it is enabled and the user is not exempt (e.g. because they are an Owner).
|
|
* This does not take into account the policy's configuration - if that is important, use {@link policiesByType$} to get the
|
|
* {@link Policy} objects and then filter by Policy.data.
|
|
*/
|
|
abstract policyAppliesToUser$: (policyType: PolicyType, userId: UserId) => Observable<boolean>;
|
|
|
|
// Policy specific interfaces
|
|
|
|
/**
|
|
* Combines all Master Password policies that apply to the user.
|
|
* @returns a set of options which represent the minimum Master Password settings that the user must
|
|
* comply with in order to comply with **all** Master Password policies.
|
|
*/
|
|
abstract masterPasswordPolicyOptions$: (
|
|
userId: UserId,
|
|
policies?: Policy[],
|
|
) => Observable<MasterPasswordPolicyOptions | undefined>;
|
|
|
|
/**
|
|
* Evaluates whether a proposed Master Password complies with all Master Password policies that apply to the user.
|
|
*/
|
|
abstract evaluateMasterPassword: (
|
|
passwordStrength: number,
|
|
newPassword: string,
|
|
enforcedPolicyOptions?: MasterPasswordPolicyOptions,
|
|
) => boolean;
|
|
|
|
/**
|
|
* @returns {@link ResetPasswordPolicyOptions} for the specified organization and a boolean indicating whether the policy
|
|
* is enabled
|
|
*/
|
|
abstract getResetPasswordPolicyOptions: (
|
|
policies: Policy[],
|
|
orgId: string,
|
|
) => [ResetPasswordPolicyOptions, boolean];
|
|
}
|
|
|
|
export abstract class vNextInternalPolicyService extends vNextPolicyService {
|
|
abstract upsert: (policy: PolicyData, userId: UserId) => Promise<void>;
|
|
abstract replace: (policies: { [id: string]: PolicyData }, userId: UserId) => Promise<void>;
|
|
}
|