@technomoron/apicore-server 1.0.0-beta.1

package/dist/esm/passkey/models.d.ts

@@ -0,0 +1,34 @@
+import { Model, type InferAttributes, type InferCreationAttributes, type ModelStatic, type Sequelize } from 'sequelize';
+export declare class PasskeyCredentialModel extends Model<InferAttributes<PasskeyCredentialModel>, InferCreationAttributes<PasskeyCredentialModel>> {
+    credentialId: Buffer;
+    userId: number;
+    publicKey: Buffer;
+    counter: number;
+    transports: string[] | null;
+    backedUp: boolean;
+    deviceType: string;
+    label: string | null;
+    createdDomain: string | null;
+    createdUserAgent: string | null;
+    createdBrowser: string | null;
+    createdOs: string | null;
+    createdDevice: string | null;
+    createdIp: string | null;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export declare class PasskeyChallengeModel extends Model<InferAttributes<PasskeyChallengeModel>, InferCreationAttributes<PasskeyChallengeModel>> {
+    challenge: string;
+    action: 'register' | 'authenticate';
+    userId: number | null;
+    login: string | null;
+    expiresAt: Date;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export declare function initPasskeyCredentialModel(sequelize: Sequelize, options?: {
+    tablePrefix?: string;
+}): ModelStatic<PasskeyCredentialModel>;
+export declare function initPasskeyChallengeModel(sequelize: Sequelize, options?: {
+    tablePrefix?: string;
+}): ModelStatic<PasskeyChallengeModel>;

package/dist/esm/passkey/models.js

@@ -0,0 +1,135 @@
+import { DataTypes, Model } from 'sequelize';
+import { applyTablePrefix, integerIdType } from '../sequelize-utils.js';
+export class PasskeyCredentialModel extends Model {
+}
+export class PasskeyChallengeModel extends Model {
+}
+export function initPasskeyCredentialModel(sequelize, options = {}) {
+    const idType = integerIdType(sequelize);
+    return PasskeyCredentialModel.init({
+        credentialId: {
+            field: 'credential_id',
+            type: DataTypes.STRING(768),
+            primaryKey: true,
+            allowNull: false,
+            get() {
+                const raw = this.getDataValue('credentialId');
+                if (!raw) {
+                    return raw;
+                }
+                if (Buffer.isBuffer(raw)) {
+                    return raw;
+                }
+                return Buffer.from(raw, 'base64');
+            },
+            set(value) {
+                const encoded = typeof value === 'string' ? value : value.toString('base64');
+                this.setDataValue('credentialId', encoded);
+            }
+        },
+        userId: {
+            field: 'user_id',
+            type: idType,
+            allowNull: false
+        },
+        publicKey: {
+            field: 'public_key',
+            type: DataTypes.BLOB,
+            allowNull: false
+        },
+        counter: {
+            type: DataTypes.INTEGER,
+            allowNull: false,
+            defaultValue: 0
+        },
+        transports: {
+            type: DataTypes.JSON,
+            allowNull: true
+        },
+        backedUp: {
+            field: 'backed_up',
+            type: DataTypes.BOOLEAN,
+            allowNull: false,
+            defaultValue: false
+        },
+        deviceType: {
+            field: 'device_type',
+            type: DataTypes.STRING(32),
+            allowNull: false,
+            defaultValue: 'multiDevice'
+        },
+        label: {
+            type: DataTypes.STRING(120),
+            allowNull: true
+        },
+        createdDomain: {
+            field: 'created_domain',
+            type: DataTypes.STRING(255),
+            allowNull: true
+        },
+        createdUserAgent: {
+            field: 'created_user_agent',
+            type: DataTypes.TEXT,
+            allowNull: true
+        },
+        createdBrowser: {
+            field: 'created_browser',
+            type: DataTypes.STRING(120),
+            allowNull: true
+        },
+        createdOs: {
+            field: 'created_os',
+            type: DataTypes.STRING(120),
+            allowNull: true
+        },
+        createdDevice: {
+            field: 'created_device',
+            type: DataTypes.STRING(120),
+            allowNull: true
+        },
+        createdIp: {
+            field: 'created_ip',
+            type: DataTypes.STRING(45),
+            allowNull: true
+        }
+    }, {
+        sequelize,
+        tableName: applyTablePrefix(options.tablePrefix, 'passkey_credentials'),
+        timestamps: true,
+        underscored: true
+    });
+}
+export function initPasskeyChallengeModel(sequelize, options = {}) {
+    const idType = integerIdType(sequelize);
+    return PasskeyChallengeModel.init({
+        challenge: {
+            type: DataTypes.STRING(255),
+            primaryKey: true,
+            allowNull: false
+        },
+        action: {
+            type: DataTypes.STRING(16),
+            allowNull: false
+        },
+        userId: {
+            field: 'user_id',
+            type: idType,
+            allowNull: true
+        },
+        login: {
+            type: DataTypes.STRING(128),
+            allowNull: true
+        },
+        expiresAt: {
+            field: 'expires_at',
+            type: DataTypes.DATE,
+            allowNull: false
+        }
+    }, {
+        sequelize,
+        tableName: applyTablePrefix(options.tablePrefix, 'passkey_challenges'),
+        timestamps: true,
+        underscored: true,
+        indexes: [{ fields: ['expires_at'] }, { fields: ['user_id'] }]
+    });
+}

package/dist/esm/passkey/sequelize.d.ts

@@ -0,0 +1,42 @@
+import { type ModelStatic, type Sequelize } from 'sequelize';
+import { PasskeyStore } from './base.js';
+import { PasskeyChallengeModel, PasskeyCredentialModel } from './models.js';
+import type { PasskeyChallengeRecord, PasskeyUserDescriptor, StoredPasskeyCredential } from './types.js';
+import type { AuthIdentifier } from '../auth-api/types.js';
+export interface SequelizePasskeyStoreOptions {
+    sequelize: Sequelize;
+    tablePrefix?: string;
+    credentialModel?: ModelStatic<PasskeyCredentialModel>;
+    challengeModel?: ModelStatic<PasskeyChallengeModel>;
+    credentialModelFactory?: (sequelize: Sequelize, options?: {
+        tablePrefix?: string;
+    }) => ModelStatic<PasskeyCredentialModel>;
+    challengeModelFactory?: (sequelize: Sequelize, options?: {
+        tablePrefix?: string;
+    }) => ModelStatic<PasskeyChallengeModel>;
+    resolveUser: (params: {
+        userId?: AuthIdentifier;
+        login?: string;
+    }) => Promise<PasskeyUserDescriptor | null>;
+}
+export declare class SequelizePasskeyStore extends PasskeyStore {
+    private readonly resolveUserFn;
+    private readonly credentials;
+    private readonly challenges;
+    constructor(options: SequelizePasskeyStoreOptions);
+    resolveUser(params: {
+        userId?: AuthIdentifier;
+        login?: string;
+    }): Promise<PasskeyUserDescriptor | null>;
+    listUserCredentials(userId: AuthIdentifier): Promise<StoredPasskeyCredential[]>;
+    deleteCredential(credentialId: Buffer | string): Promise<boolean>;
+    findCredentialById(credentialId: Buffer): Promise<StoredPasskeyCredential | null>;
+    saveCredential(record: StoredPasskeyCredential): Promise<void>;
+    updateCredentialCounter(credentialId: Buffer, counter: number): Promise<void>;
+    saveChallenge(record: PasskeyChallengeRecord): Promise<void>;
+    getChallenge(challenge: string): Promise<PasskeyChallengeRecord | null>;
+    consumeChallenge(challenge: string): Promise<PasskeyChallengeRecord | null>;
+    cleanupChallenges(now: Date): Promise<void>;
+    private toChallengeRecord;
+    private toStoredCredential;
+}

package/dist/esm/passkey/sequelize.js

@@ -0,0 +1,122 @@
+import { Op, Transaction } from 'sequelize';
+import { normalizeNumericUserId } from '../auth-api/user-id.js';
+import { PasskeyStore } from './base.js';
+import { initPasskeyChallengeModel, initPasskeyCredentialModel } from './models.js';
+function encodeCredentialId(value) {
+    return Buffer.isBuffer(value) ? value.toString('base64') : value;
+}
+export class SequelizePasskeyStore extends PasskeyStore {
+    constructor(options) {
+        super();
+        if (!options?.sequelize) {
+            throw new Error('SequelizePasskeyStore requires an initialised Sequelize instance');
+        }
+        this.resolveUserFn = options.resolveUser;
+        this.credentials =
+            options.credentialModel ??
+                (options.credentialModelFactory ?? initPasskeyCredentialModel)(options.sequelize, {
+                    tablePrefix: options.tablePrefix
+                });
+        this.challenges =
+            options.challengeModel ??
+                (options.challengeModelFactory ?? initPasskeyChallengeModel)(options.sequelize, {
+                    tablePrefix: options.tablePrefix
+                });
+    }
+    async resolveUser(params) {
+        return this.resolveUserFn(params);
+    }
+    async listUserCredentials(userId) {
+        const models = await this.credentials.findAll({ where: { userId: normalizeNumericUserId(userId) } });
+        return models.map((model) => this.toStoredCredential(model));
+    }
+    async deleteCredential(credentialId) {
+        const encoded = Buffer.isBuffer(credentialId) ? credentialId.toString('base64') : credentialId;
+        const deleted = await this.credentials.destroy({ where: { credentialId: encoded } });
+        return deleted > 0;
+    }
+    async findCredentialById(credentialId) {
+        const model = await this.credentials.findByPk(encodeCredentialId(credentialId));
+        return model ? this.toStoredCredential(model) : null;
+    }
+    async saveCredential(record) {
+        await this.credentials.upsert({
+            credentialId: record.credentialId,
+            userId: normalizeNumericUserId(record.userId),
+            publicKey: record.publicKey,
+            counter: record.counter,
+            transports: record.transports ?? null,
+            backedUp: record.backedUp,
+            deviceType: record.deviceType,
+            label: record.label ?? null,
+            createdDomain: record.createdDomain ?? null,
+            createdUserAgent: record.createdUserAgent ?? null,
+            createdBrowser: record.createdBrowser ?? null,
+            createdOs: record.createdOs ?? null,
+            createdDevice: record.createdDevice ?? null,
+            createdIp: record.createdIp ?? null
+        });
+    }
+    async updateCredentialCounter(credentialId, counter) {
+        await this.credentials.update({ counter }, { where: { credentialId: encodeCredentialId(credentialId) } });
+    }
+    async saveChallenge(record) {
+        await this.challenges.upsert({
+            challenge: record.challenge,
+            action: record.action,
+            userId: record.userId !== undefined ? normalizeNumericUserId(record.userId) : null,
+            login: record.login ?? null,
+            expiresAt: record.expiresAt
+        });
+    }
+    async getChallenge(challenge) {
+        const model = await this.challenges.findByPk(challenge);
+        return model ? this.toChallengeRecord(model) : null;
+    }
+    async consumeChallenge(challenge) {
+        const sequelize = this.challenges.sequelize;
+        if (!sequelize) {
+            throw new Error('Challenge model is not bound to a Sequelize instance');
+        }
+        return sequelize.transaction({ isolationLevel: Transaction.ISOLATION_LEVELS.READ_COMMITTED }, async (transaction) => {
+            const model = await this.challenges.findByPk(challenge, { transaction, lock: true });
+            if (!model) {
+                return null;
+            }
+            await model.destroy({ transaction });
+            return this.toChallengeRecord(model);
+        });
+    }
+    async cleanupChallenges(now) {
+        await this.challenges.destroy({ where: { expiresAt: { [Op.lte]: now } } });
+    }
+    toChallengeRecord(model) {
+        return {
+            challenge: model.challenge,
+            action: model.action,
+            userId: model.userId !== null ? String(model.userId) : undefined,
+            login: model.login ?? undefined,
+            expiresAt: model.expiresAt
+        };
+    }
+    toStoredCredential(model) {
+        return {
+            userId: String(model.userId),
+            credentialId: model.credentialId,
+            publicKey: model.publicKey,
+            counter: model.counter,
+            transports: (model.transports ?? undefined),
+            backedUp: model.backedUp,
+            deviceType: model.deviceType,
+            label: model.label ?? undefined,
+            createdDomain: model.createdDomain ?? undefined,
+            createdUserAgent: model.createdUserAgent ?? undefined,
+            createdBrowser: model.createdBrowser ?? undefined,
+            createdOs: model.createdOs ?? undefined,
+            createdDevice: model.createdDevice ?? undefined,
+            createdIp: model.createdIp ?? undefined,
+            createdAt: model.createdAt ?? undefined,
+            updatedAt: model.updatedAt ?? undefined
+        };
+    }
+}

package/dist/esm/passkey/service.d.ts

@@ -0,0 +1,21 @@
+import type { PasskeyChallenge, PasskeyChallengeParams, PasskeyStorageAdapter, PasskeyVerificationParams, PasskeyVerificationResult, PasskeyServiceConfig, StoredPasskeyCredential } from './types.js';
+import type { AuthIdentifier } from '../auth-api/types.js';
+export type { CredentialDeviceType, PasskeyChallenge, PasskeyChallengeParams, PasskeyChallengeRecord, PasskeyUserDescriptor, PasskeyVerificationParams, PasskeyVerificationResult, PasskeyServiceConfig, PasskeyStorageAdapter, StoredPasskeyCredential } from './types.js';
+type Logger = Pick<typeof console, 'error' | 'warn'>;
+export declare class PasskeyService {
+    private readonly config;
+    private readonly adapter;
+    private readonly logger;
+    constructor(config: PasskeyServiceConfig, adapter: PasskeyStorageAdapter, logger?: Logger);
+    listUserCredentials(userId: AuthIdentifier): Promise<StoredPasskeyCredential[]>;
+    deleteCredential(credentialId: Buffer | string, userId?: AuthIdentifier): Promise<boolean>;
+    createChallenge(params: PasskeyChallengeParams): Promise<PasskeyChallenge>;
+    verifyResponse(params: PasskeyVerificationParams): Promise<PasskeyVerificationResult>;
+    private createRegistrationChallenge;
+    private createAuthenticationChallenge;
+    private verifyRegistration;
+    private verifyAuthentication;
+    private requireUser;
+    private createExpiry;
+    private requireUserVerification;
+}