lbx-jwt/src/models/credentials.model.ts

Provides JWT authentication for loopback applications. Includes storing roles inside tokens and handling refreshing. Built-in reuse detection.

import { Entity, model, property } from '@loopback/repository';

/**
 * The credentials of an user.
 * They are stored separately so its less likely there are sent to the frontend by accident.
 */
@model()
export class Credentials extends Entity {

    /**
     * The id of the credentials.
     */
    @property({
        type: 'string',
        required: true,
        defaultFn: 'uuidv4',
        id: true
    })
    id: string;

    /**
     * The password of the user.
     * Is stored as a hashed string.
     */
    @property({
        type: 'string',
        required: true,
        jsonSchema: {
            minLength: 12
        }
    })
    password: string;

    /**
     * The two factor authentication secret.
     * Unique for each user and is needed to validate two factor codes.
     */
    @property({
        type: 'string',
        required: false
    })
    twoFactorSecret?: string;

    /**
     * The two factor url that is needed to display a qr code.
     */
    @property({
        type: 'string',
        required: false
    })
    twoFactorAuthUrl?: string;

    /**
     * The user that this credentials belong to.
     */
    @property({
        type: 'string',
        required: true
    })
    baseUserId: string;

    constructor(data?: Partial<Credentials>) {
        super(data);
    }
}

/**
 * Properties of the entity relations.
 */
export interface CredentialsRelations {
    // describe navigational properties here
}

/**
 * The entity with its relation properties.
 */
export type CredentialsWithRelations = Credentials & CredentialsRelations;