@authup/server-core 1.0.0-beta.52 → 1.0.0-beta.53

package/dist/core/entities/user-authenticator/service.d.ts

@@ -0,0 +1,89 @@
+import { EventName, UserAuthenticatorKind, UserAuthenticatorValidator } from '@authup/core-kit';
+import type { User, UserAuthenticator } from '@authup/core-kit';
+import { AbstractEntityService } from '@authup/server-kit';
+import type { ActorContext, EntityRepositoryFindManyResult, ICache } from '@authup/server-kit';
+import type { IRealmCipher } from '../../key/index.ts';
+import type { IEventService } from '../event/index.ts';
+import type { IMailClient, IMailTemplateRenderer } from '../../mail/index.ts';
+import type { IUserRepository } from '../user/index.ts';
+import type { IUserAuthenticatorRepository, IUserAuthenticatorService, UserAuthenticatorChallengeStatus, UserAuthenticatorEnrollResult, UserAuthenticatorSendContext, UserAuthenticatorServiceContext, UserAuthenticatorServiceOptions, UserAuthenticatorVerifyContext, UserAuthenticatorVerifyInput, UserAuthenticatorWebauthnParameters } from './types.ts';
+import type { WebauthnContext } from './webauthn.ts';
+type VerifyLock = {
+    status: 'acquired';
+    value: string;
+} | {
+    status: 'busy' | 'unavailable';
+};
+type VerifyLockLease = {
+    renew: () => Promise<boolean>;
+    stop: () => Promise<void>;
+};
+export declare class UserAuthenticatorService extends AbstractEntityService implements IUserAuthenticatorService {
+    protected repository: IUserAuthenticatorRepository;
+    protected userRepository: IUserRepository;
+    protected cache: ICache;
+    protected cipher: IRealmCipher;
+    protected eventService?: IEventService;
+    protected mailClient?: IMailClient;
+    protected mailTemplateRenderer?: IMailTemplateRenderer;
+    protected options: UserAuthenticatorServiceOptions;
+    protected validator: UserAuthenticatorValidator;
+    constructor(ctx: UserAuthenticatorServiceContext);
+    protected isOwnedBy(entity: UserAuthenticator, actor: ActorContext): boolean;
+    /**
+     * The secret/codes columns never leave the service — reads return the
+     * row with both nulled (defense in depth on top of select:false).
+     */
+    protected sanitize(entity: UserAuthenticator): UserAuthenticator;
+    getMany(query: Record<string, any>, actor: ActorContext, options?: {
+        userId?: string;
+    }): Promise<EntityRepositoryFindManyResult<UserAuthenticator>>;
+    getOne(id: string, actor: ActorContext, options?: {
+        userId?: string;
+    }): Promise<UserAuthenticator>;
+    protected resolveOne(id: string, userId?: string): Promise<UserAuthenticator>;
+    enroll(data: Record<string, any>, actor: ActorContext): Promise<UserAuthenticatorEnrollResult>;
+    protected enrollWebauthn(user: User, name: string | null): Promise<UserAuthenticatorEnrollResult>;
+    protected enrollEmail(user: User, name: string | null): Promise<UserAuthenticatorEnrollResult>;
+    protected resolveTargetUser(userId: string | undefined, actor: ActorContext, validated: Record<string, any>): Promise<User>;
+    protected enrollTotp(user: User, name: string | null): Promise<UserAuthenticatorEnrollResult>;
+    protected enrollRecovery(user: User, name: string | null): Promise<UserAuthenticatorEnrollResult>;
+    confirm(id: string, code: string, actor: ActorContext, options?: {
+        userId?: string;
+    }): Promise<UserAuthenticator>;
+    protected confirmWebauthn(entity: UserAuthenticator, response: string): Promise<UserAuthenticator>;
+    delete(id: string, actor: ActorContext, options?: {
+        userId?: string;
+    }): Promise<UserAuthenticator>;
+    verify(userId: string, input: UserAuthenticatorVerifyInput, ctx?: UserAuthenticatorVerifyContext): Promise<boolean>;
+    protected verifyTotp(device: UserAuthenticator, token: string): Promise<boolean>;
+    protected verifyRecovery(device: UserAuthenticator, code: string): Promise<boolean>;
+    protected parseWebauthnParameters(device: UserAuthenticator): UserAuthenticatorWebauthnParameters | null;
+    protected verifyWebauthnDevice(userId: string, device: UserAuthenticator, response: string): Promise<number | null>;
+    protected verifyEmail(userId: string, response: string): Promise<boolean>;
+    sendChallenge(userId: string, kind: `${UserAuthenticatorKind}`, ctx?: UserAuthenticatorSendContext): Promise<void>;
+    hasConfirmed(userId: string): Promise<boolean>;
+    challenge(userId: string, options?: {
+        issueMaterial?: boolean;
+    }): Promise<UserAuthenticatorChallengeStatus>;
+    protected assertEnabled(): void;
+    protected assertMail(): void;
+    protected assertWebauthn(): WebauthnContext;
+    protected buildAttemptCacheKey(userId: string): string;
+    protected buildThrottleCacheKey(userId: string): string;
+    protected buildEmailCodeCacheKey(userId: string): string;
+    protected buildEmailSendCacheKey(userId: string): string;
+    protected buildWebauthnCacheKey(prefix: string, userId: string): string;
+    protected buildVerifyLockCacheKey(userId: string): string;
+    protected acquireVerifyLock(key: string): Promise<VerifyLock>;
+    protected maintainVerifyLock(key: string, value: string): VerifyLockLease;
+    protected releaseVerifyLock(key: string, value: string): Promise<void>;
+    protected assertNotThrottled(userId: string): Promise<void>;
+    protected assertNotThrottledOrRetry(userId: string): Promise<void>;
+    protected bumpAttempts(userId: string): Promise<void>;
+    protected resetAttempts(userId: string): Promise<void>;
+    protected recordEvent(name: `${EventName}`, entity: UserAuthenticator): Promise<void>;
+    protected recordChallengeEvent(name: `${EventName}`, userId: string, kind: string, ctx: UserAuthenticatorVerifyContext, entity?: UserAuthenticator): Promise<void>;
+}
+export {};
+//# sourceMappingURL=service.d.ts.map

package/dist/core/entities/user-authenticator/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../../../src/core/entities/user-authenticator/service.ts"],"names":[],"mappings":"AAUA,OAAO,EACH,SAAS,EAKT,qBAAqB,EACrB,0BAA0B,EAC7B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAUhE,OAAO,EACH,qBAAqB,EAIxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EACR,YAAY,EACZ,8BAA8B,EAC9B,MAAM,EACT,MAAM,oBAAoB,CAAC;AAK5B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAE9E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AA8BxD,OAAO,KAAK,EACR,4BAA4B,EAC5B,yBAAyB,EACzB,gCAAgC,EAChC,6BAA6B,EAE7B,4BAA4B,EAC5B,+BAA+B,EAC/B,+BAA+B,EAE/B,8BAA8B,EAC9B,4BAA4B,EAC5B,mCAAmC,EACtC,MAAM,YAAY,CAAC;AACpB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAYrD,KAAK,UAAU,GAAG;IACd,MAAM,EAAE,UAAU,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACjB,GAAG;IACA,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;CAClC,CAAC;AAEF,KAAK,eAAe,GAAG;IACnB,KAAK,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7B,CAAC;AAEF,qBAAa,wBAAyB,SAAQ,qBAAsB,YAAW,yBAAyB;IACpG,SAAS,CAAC,UAAU,EAAE,4BAA4B,CAAC;IAEnD,SAAS,CAAC,cAAc,EAAE,eAAe,CAAC;IAE1C,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;IAExB,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC;IAE/B,SAAS,CAAC,YAAY,CAAC,EAAE,aAAa,CAAC;IAEvC,SAAS,CAAC,UAAU,CAAC,EAAE,WAAW,CAAC;IAEnC,SAAS,CAAC,oBAAoB,CAAC,EAAE,qBAAqB,CAAC;IAEvD,SAAS,CAAC,OAAO,EAAE,+BAA+B,CAAC;IAEnD,SAAS,CAAC,SAAS,EAAE,0BAA0B,CAAC;gBAEpC,GAAG,EAAE,+BAA+B;IAchD,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO;IAM5E;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,iBAAiB,GAAG,iBAAiB;IAU1D,OAAO,CACT,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC1B,KAAK,EAAE,YAAY,EACnB,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAClC,OAAO,CAAC,8BAA8B,CAAC,iBAAiB,CAAC,CAAC;IA+CvD,MAAM,CACR,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,YAAY,EACnB,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAClC,OAAO,CAAC,iBAAiB,CAAC;cAiBb,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAa7E,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,6BAA6B,CAAC;cA4CpF,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,6BAA6B,CAAC;cA+CvF,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,6BAA6B,CAAC;cA6CpF,iBAAiB,CAC7B,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,KAAK,EAAE,YAAY,EACnB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,OAAO,CAAC,IAAI,CAAC;cA8BA,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,6BAA6B,CAAC;cAuCnF,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,6BAA6B,CAAC;IA0CjG,OAAO,CACT,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,YAAY,EACnB,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAClC,OAAO,CAAC,iBAAiB,CAAC;cAoDb,eAAe,CAAC,MAAM,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA2ClG,MAAM,CACR,EAAE,EAAE,MAAM,EACV,KAAK,EAAE,YAAY,EACnB,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO,GAClC,OAAO,CAAC,iBAAiB,CAAC;IAyBvB,MAAM,CACR,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,4BAA4B,EACnC,GAAG,GAAE,8BAAmC,GACzC,OAAO,CAAC,OAAO,CAAC;cAqHH,UAAU,CAAC,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;cAwDtE,cAAc,CAAC,MAAM,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAuBzF,SAAS,CAAC,uBAAuB,CAAC,MAAM,EAAE,iBAAiB,GAAG,mCAAmC,GAAG,IAAI;cAWxF,oBAAoB,CAChC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,iBAAiB,EACzB,QAAQ,EAAE,MAAM,GACjB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;cAmCT,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAezE,aAAa,CACf,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,qBAAqB,EAAE,EAChC,GAAG,GAAE,4BAAiC,GACvC,OAAO,CAAC,IAAI,CAAC;IAwEV,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAI9C,SAAS,CACX,MAAM,EAAE,MAAM,EACd,OAAO,GAAE;QAAE,aAAa,CAAC,EAAE,OAAO,CAAA;KAAO,GAC1C,OAAO,CAAC,gCAAgC,CAAC;IAsD5C,SAAS,CAAC,aAAa,IAAI,IAAI;IAS/B,SAAS,CAAC,UAAU,IAAI,IAAI;IAS5B,SAAS,CAAC,cAAc,IAAI,eAAe;IAa3C,SAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAOtD,SAAS,CAAC,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAOvD,SAAS,CAAC,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAOxD,SAAS,CAAC,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAOxD,SAAS,CAAC,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAIvE,SAAS,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;cAOzC,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAYnE,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,eAAe;cAsCzD,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;cAQ5D,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;cAYjD,yBAAyB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;cAYxD,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;cA2B3C,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;cAS5C,WAAW,CACvB,IAAI,EAAE,GAAG,SAAS,EAAE,EACpB,MAAM,EAAE,iBAAiB,GAC1B,OAAO,CAAC,IAAI,CAAC;cAaA,oBAAoB,CAChC,IAAI,EAAE,GAAG,SAAS,EAAE,EACpB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,8BAA8B,EACnC,MAAM,CAAC,EAAE,iBAAiB,GAC3B,OAAO,CAAC,IAAI,CAAC;CAenB"}