Upstream/bitwarden-browser
1
0
Fork 0
mirror of https://github.com/bitwarden/browser.git synced 2024-09-23 03:22:50 +02:00
Code Issues Projects Releases Wiki Activity

improve typing for fido2 message type values (#10420)

Browse Source
This commit is contained in:
Jonathan Prusik 2024-08-06 14:56:59 -04:00 committed by GitHub
parent 4a5a0ca537
commit 887b98988a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 42 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
apps/browser/src/vault/fido2/browser-fido2-user-interface.service.ts
View File

@ -30,6 +30,22 @@ import { closeFido2Popout, openFido2Popout } from "../popup/utils/vault-popout-w
const BrowserFido2MessageName = "BrowserFido2UserInterfaceServiceMessage"; const BrowserFido2MessageName = "BrowserFido2UserInterfaceServiceMessage";
export const BrowserFido2MessageTypes = {
ConnectResponse: "ConnectResponse",
NewSessionCreatedRequest: "NewSessionCreatedRequest",
PickCredentialRequest: "PickCredentialRequest",
PickCredentialResponse: "PickCredentialResponse",
ConfirmNewCredentialRequest: "ConfirmNewCredentialRequest",
ConfirmNewCredentialResponse: "ConfirmNewCredentialResponse",
InformExcludedCredentialRequest: "InformExcludedCredentialRequest",
InformCredentialNotFoundRequest: "InformCredentialNotFoundRequest",
AbortRequest: "AbortRequest",
AbortResponse: "AbortResponse",
} as const;
export type BrowserFido2MessageTypeValue =
(typeof BrowserFido2MessageTypes)[keyof typeof BrowserFido2MessageTypes];
export class SessionClosedError extends Error { export class SessionClosedError extends Error {
constructor() { constructor() {
super("Fido2UserInterfaceSession was closed"); super("Fido2UserInterfaceSession was closed");
@ -39,30 +55,30 @@ export class SessionClosedError extends Error {
export type BrowserFido2Message = { sessionId: string } & ( export type BrowserFido2Message = { sessionId: string } & (
| /** | /**
* This message is used by popouts to announce that they are ready * This message is used by popouts to announce that they are ready
* to recieve messages. * to receive messages.
**/ { **/ {
type: "ConnectResponse"; type: typeof BrowserFido2MessageTypes.ConnectResponse;
} }
/** /**
* This message is used to announce the creation of a new session. * This message is used to announce the creation of a new session.
* It is used by popouts to know when to close. * It is used by popouts to know when to close.
**/ **/
| { | {
type: "NewSessionCreatedRequest"; type: typeof BrowserFido2MessageTypes.NewSessionCreatedRequest;
} }
| { | {
type: "PickCredentialRequest"; type: typeof BrowserFido2MessageTypes.PickCredentialRequest;
cipherIds: string[]; cipherIds: string[];
userVerification: boolean; userVerification: boolean;
fallbackSupported: boolean; fallbackSupported: boolean;
} }
| { | {
type: "PickCredentialResponse"; type: typeof BrowserFido2MessageTypes.PickCredentialResponse;
cipherId?: string; cipherId?: string;
userVerified: boolean; userVerified: boolean;
} }
| { | {
type: "ConfirmNewCredentialRequest"; type: typeof BrowserFido2MessageTypes.ConfirmNewCredentialRequest;
credentialName: string; credentialName: string;
userName: string; userName: string;
userHandle: string; userHandle: string;
@ -71,24 +87,24 @@ export type BrowserFido2Message = { sessionId: string } & (
rpId: string; rpId: string;
} }
| { | {
type: "ConfirmNewCredentialResponse"; type: typeof BrowserFido2MessageTypes.ConfirmNewCredentialResponse;
cipherId: string; cipherId: string;
userVerified: boolean; userVerified: boolean;
} }
| { | {
type: "InformExcludedCredentialRequest"; type: typeof BrowserFido2MessageTypes.InformExcludedCredentialRequest;
existingCipherIds: string[]; existingCipherIds: string[];
fallbackSupported: boolean; fallbackSupported: boolean;
} }
| { | {
type: "InformCredentialNotFoundRequest"; type: typeof BrowserFido2MessageTypes.InformCredentialNotFoundRequest;
fallbackSupported: boolean; fallbackSupported: boolean;
} }
| { | {
type: "AbortRequest"; type: typeof BrowserFido2MessageTypes.AbortRequest;
} }
| { | {
type: "AbortResponse"; type: typeof BrowserFido2MessageTypes.AbortResponse;
fallbackRequested: boolean; fallbackRequested: boolean;
} }
); );
@ -138,7 +154,7 @@ export class BrowserFido2UserInterfaceSession implements Fido2UserInterfaceSessi
static abortPopout(sessionId: string, fallbackRequested = false) { static abortPopout(sessionId: string, fallbackRequested = false) {
this.sendMessage({ this.sendMessage({
sessionId: sessionId, sessionId: sessionId,
type: "AbortResponse", type: BrowserFido2MessageTypes.AbortResponse,
fallbackRequested: fallbackRequested, fallbackRequested: fallbackRequested,
}); });
} }
@ -146,7 +162,7 @@ export class BrowserFido2UserInterfaceSession implements Fido2UserInterfaceSessi
static confirmNewCredentialResponse(sessionId: string, cipherId: string, userVerified: boolean) { static confirmNewCredentialResponse(sessionId: string, cipherId: string, userVerified: boolean) {
this.sendMessage({ this.sendMessage({
sessionId: sessionId, sessionId: sessionId,
type: "ConfirmNewCredentialResponse", type: BrowserFido2MessageTypes.ConfirmNewCredentialResponse,
cipherId, cipherId,
userVerified, userVerified,
}); });
@ -169,7 +185,7 @@ export class BrowserFido2UserInterfaceSession implements Fido2UserInterfaceSessi
) { ) {
this.messages$ this.messages$
.pipe( .pipe(
filter((msg) => msg.type === "ConnectResponse"), filter((msg) => msg.type === BrowserFido2MessageTypes.ConnectResponse),
take(1), take(1),
takeUntil(this.destroy$), takeUntil(this.destroy$),
) )
@ -185,7 +201,7 @@ export class BrowserFido2UserInterfaceSession implements Fido2UserInterfaceSessi
// eslint-disable-next-line @typescript-eslint/no-floating-promises // eslint-disable-next-line @typescript-eslint/no-floating-promises
this.close(); this.close();
BrowserFido2UserInterfaceSession.sendMessage({ BrowserFido2UserInterfaceSession.sendMessage({
type: "AbortRequest", type: BrowserFido2MessageTypes.AbortRequest,
sessionId: this.sessionId, sessionId: this.sessionId,
}); });
}); });
@ -193,12 +209,12 @@ export class BrowserFido2UserInterfaceSession implements Fido2UserInterfaceSessi
// Handle session aborted by user // Handle session aborted by user
this.messages$ this.messages$
.pipe( .pipe(
filter((msg) => msg.type === "AbortResponse"), filter((msg) => msg.type === BrowserFido2MessageTypes.AbortResponse),
take(1), take(1),
takeUntil(this.destroy$), takeUntil(this.destroy$),
) )
.subscribe((msg) => { .subscribe((msg) => {
if (msg.type === "AbortResponse") { if (msg.type === BrowserFido2MessageTypes.AbortResponse) {
// FIXME: Verify that this floating promise is intentional. If it is, add an explanatory comment and ensure there is proper error handling. // FIXME: Verify that this floating promise is intentional. If it is, add an explanatory comment and ensure there is proper error handling.
// eslint-disable-next-line @typescript-eslint/no-floating-promises // eslint-disable-next-line @typescript-eslint/no-floating-promises
this.close(); this.close();
@ -217,7 +233,7 @@ export class BrowserFido2UserInterfaceSession implements Fido2UserInterfaceSessi
); );
BrowserFido2UserInterfaceSession.sendMessage({ BrowserFido2UserInterfaceSession.sendMessage({
type: "NewSessionCreatedRequest", type: BrowserFido2MessageTypes.NewSessionCreatedRequest,
sessionId, sessionId,
}); });
} }
@ -227,7 +243,7 @@ export class BrowserFido2UserInterfaceSession implements Fido2UserInterfaceSessi
userVerification, userVerification,
}: PickCredentialParams): Promise<{ cipherId: string; userVerified: boolean }> { }: PickCredentialParams): Promise<{ cipherId: string; userVerified: boolean }> {
const data: BrowserFido2Message = { const data: BrowserFido2Message = {
type: "PickCredentialRequest", type: BrowserFido2MessageTypes.PickCredentialRequest,
cipherIds, cipherIds,
sessionId: this.sessionId, sessionId: this.sessionId,
userVerification, userVerification,
@ -235,7 +251,7 @@ export class BrowserFido2UserInterfaceSession implements Fido2UserInterfaceSessi
}; };
await this.send(data); await this.send(data);
const response = await this.receive("PickCredentialResponse"); const response = await this.receive(BrowserFido2MessageTypes.PickCredentialResponse);
return { cipherId: response.cipherId, userVerified: response.userVerified }; return { cipherId: response.cipherId, userVerified: response.userVerified };
} }
@ -248,7 +264,7 @@ export class BrowserFido2UserInterfaceSession implements Fido2UserInterfaceSessi
rpId, rpId,
}: NewCredentialParams): Promise<{ cipherId: string; userVerified: boolean }> { }: NewCredentialParams): Promise<{ cipherId: string; userVerified: boolean }> {
const data: BrowserFido2Message = { const data: BrowserFido2Message = {
type: "ConfirmNewCredentialRequest", type: BrowserFido2MessageTypes.ConfirmNewCredentialRequest,
sessionId: this.sessionId, sessionId: this.sessionId,
credentialName, credentialName,
userName, userName,
@ -259,21 +275,21 @@ export class BrowserFido2UserInterfaceSession implements Fido2UserInterfaceSessi
}; };
await this.send(data); await this.send(data);
const response = await this.receive("ConfirmNewCredentialResponse"); const response = await this.receive(BrowserFido2MessageTypes.ConfirmNewCredentialResponse);
return { cipherId: response.cipherId, userVerified: response.userVerified }; return { cipherId: response.cipherId, userVerified: response.userVerified };
} }
async informExcludedCredential(existingCipherIds: string[]): Promise<void> { async informExcludedCredential(existingCipherIds: string[]): Promise<void> {
const data: BrowserFido2Message = { const data: BrowserFido2Message = {
type: "InformExcludedCredentialRequest", type: BrowserFido2MessageTypes.InformExcludedCredentialRequest,
sessionId: this.sessionId, sessionId: this.sessionId,
existingCipherIds, existingCipherIds,
fallbackSupported: this.fallbackSupported, fallbackSupported: this.fallbackSupported,
}; };
await this.send(data); await this.send(data);
await this.receive("AbortResponse"); await this.receive(BrowserFido2MessageTypes.AbortResponse);
} }
async ensureUnlockedVault(): Promise<void> { async ensureUnlockedVault(): Promise<void> {
@ -284,13 +300,13 @@ export class BrowserFido2UserInterfaceSession implements Fido2UserInterfaceSessi
async informCredentialNotFound(): Promise<void> { async informCredentialNotFound(): Promise<void> {
const data: BrowserFido2Message = { const data: BrowserFido2Message = {
type: "InformCredentialNotFoundRequest", type: BrowserFido2MessageTypes.InformCredentialNotFoundRequest,
sessionId: this.sessionId, sessionId: this.sessionId,
fallbackSupported: this.fallbackSupported, fallbackSupported: this.fallbackSupported,
}; };
await this.send(data); await this.send(data);
await this.receive("AbortResponse"); await this.receive(BrowserFido2MessageTypes.AbortResponse);
} }
async close() { async close() {