Breaking down mega-package. Hello auth-db 1.0.0!
This commit is contained in:
17
lib/api/authenticate.ts
Normal file
17
lib/api/authenticate.ts
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
import { Auth, Log } from '..';
|
||||||
|
import { Action } from '../../constants/action';
|
||||||
|
import { getLoginToken } from '../utils/getLoginToken';
|
||||||
|
|
||||||
|
export const authenticate = async (username: string, password: string) => {
|
||||||
|
const doc = await Auth.findByUsername(username).catch();
|
||||||
|
if (!!doc && (await doc.authenticate(password))) {
|
||||||
|
Log.add(doc.id, Action.AUTHENTICATE);
|
||||||
|
return { ...doc, token: getLoginToken(doc) };
|
||||||
|
}
|
||||||
|
|
||||||
|
if (doc) {
|
||||||
|
Log.add(doc.id, Action.AUTHENTICATE_FAILURE);
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
};
|
||||||
15
lib/api/deleteStrategy.ts
Normal file
15
lib/api/deleteStrategy.ts
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
import { StringSchemaDefinition } from 'mongoose';
|
||||||
|
import { Auth, Strategy } from '..';
|
||||||
|
|
||||||
|
export const deleteStrategy = async (id: StringSchemaDefinition) => {
|
||||||
|
const strategy = await Strategy.findById(id);
|
||||||
|
|
||||||
|
if (strategy) {
|
||||||
|
const parentId = strategy.parent;
|
||||||
|
await strategy.deleteOne();
|
||||||
|
await Auth.findOneAndUpdate({ id: parentId, strategies: { $pull: id } });
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
};
|
||||||
18
lib/api/resetPasswordGet.ts
Normal file
18
lib/api/resetPasswordGet.ts
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
import { readOneByUsername } from '../dao/readOneByUsername';
|
||||||
|
import { Log, Token } from '..';
|
||||||
|
import { TokenType } from '../../constants/tokens';
|
||||||
|
import { Action } from '../../constants/action';
|
||||||
|
|
||||||
|
export const resetPasswordGet = async (username: string) => {
|
||||||
|
const doc = await readOneByUsername(username);
|
||||||
|
|
||||||
|
if (doc) {
|
||||||
|
Log.add(doc._id, Action.RESET_REQUEST);
|
||||||
|
return {
|
||||||
|
record: doc.record,
|
||||||
|
token: Token.getToken(TokenType.RESET, doc._id),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
};
|
||||||
38
lib/api/resetPasswordPost.ts
Normal file
38
lib/api/resetPasswordPost.ts
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
import { Types } from 'mongoose';
|
||||||
|
|
||||||
|
import { Log, Strategy, Token } from '..';
|
||||||
|
import { STRATEGIES } from '../../constants/strategies';
|
||||||
|
import { AuthDocument } from '../schema/auth';
|
||||||
|
import { getLoginToken } from '../utils/getLoginToken';
|
||||||
|
import { StrategyDocument } from '../schema/strategy';
|
||||||
|
import { Action } from '../../constants/action';
|
||||||
|
|
||||||
|
export const resetPasswordPost = async (token: string, password: string) => {
|
||||||
|
const parentId = await Token.validateResetToken(token);
|
||||||
|
|
||||||
|
if (parentId) {
|
||||||
|
let parent: AuthDocument;
|
||||||
|
let strategy: StrategyDocument | null = await Strategy.findOne({ parent: parentId, method: STRATEGIES.LOCAL });
|
||||||
|
|
||||||
|
if (strategy) {
|
||||||
|
parent = await strategy.getAuthRecord();
|
||||||
|
strategy.key = password;
|
||||||
|
await strategy.save();
|
||||||
|
} else {
|
||||||
|
strategy = await Strategy.create({
|
||||||
|
key: password,
|
||||||
|
method: STRATEGIES.LOCAL,
|
||||||
|
parent: <Types.ObjectId>parentId,
|
||||||
|
});
|
||||||
|
|
||||||
|
parent = await strategy.getAuthRecord();
|
||||||
|
parent.strategies.push(strategy._id);
|
||||||
|
await parent.save();
|
||||||
|
}
|
||||||
|
|
||||||
|
Log.add(parent._id, Action.RESET);
|
||||||
|
return { record: parent.record, token: getLoginToken(parent) };
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
};
|
||||||
9
lib/constants/action.ts
Normal file
9
lib/constants/action.ts
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
export enum Action {
|
||||||
|
AUTHENTICATE = 'AUTHENTICATE',
|
||||||
|
AUTHENTICATE_FAILURE = 'AUTHENTICATE_FAILURE',
|
||||||
|
CREATE = 'CREATE',
|
||||||
|
DELETE = 'DELETE',
|
||||||
|
RESET = 'RESET',
|
||||||
|
RESET_REQUEST = 'RESET_REQUEST',
|
||||||
|
UPDATE = 'UPDATE',
|
||||||
|
}
|
||||||
8
lib/constants/auth.ts
Normal file
8
lib/constants/auth.ts
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
export enum Status {
|
||||||
|
ACTIVE,
|
||||||
|
BLOCK_HARD,
|
||||||
|
BLOCK_SOFT,
|
||||||
|
DELETED,
|
||||||
|
INACTIVE,
|
||||||
|
UNVERIFIED,
|
||||||
|
}
|
||||||
10
lib/constants/db.ts
Normal file
10
lib/constants/db.ts
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
export const DB_HOST = process.env.DB_HOST;
|
||||||
|
export const DB_PORT = process.env.DB_PORT || 27017;
|
||||||
|
export const DB_USERNAME = process.env.DB_USERNAME;
|
||||||
|
export const DB_PASSWORD = process.env.DB_PASSWORD;
|
||||||
|
export const DB_NAME = process.env.DB_NAME;
|
||||||
|
|
||||||
|
export const COLL_AUTH = 'Auth';
|
||||||
|
export const COLL_LOG = 'Log';
|
||||||
|
export const COLL_STRATEGY = 'Strategy';
|
||||||
|
export const COLL_TOKEN = 'Token';
|
||||||
20
lib/constants/env.ts
Normal file
20
lib/constants/env.ts
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
export const PACKAGE_NAME = '@mifi/auth';
|
||||||
|
export const PORT = process.env.PORT || 9000;
|
||||||
|
|
||||||
|
export const SESSION_KEY = process.env.SESSION_KEY || 'secret-key';
|
||||||
|
|
||||||
|
export const JWT_AUDIENCE = process.env.JWT_AUDIENCE || 'mifi.dev';
|
||||||
|
export const JWT_ISSUER = process.env.JWT_ISSUER || PACKAGE_NAME;
|
||||||
|
export const JWT_SECRET = process.env.JWT_SECRET || 'secret';
|
||||||
|
|
||||||
|
export const LOGIN_VALID_TIMEOUT = process.env.LOGIN_VALID_TIMEOUT || '12h'; // ###d|h|m
|
||||||
|
export const RESET_VALID_TIMEOUT = process.env.RESET_VALID_TIMEOUT || '15m'; // ###d|h|m
|
||||||
|
export const VERIFY_VALID_TIMEOUT = process.env.VERIFY_VALID_TIMEOUT || '60d'; // ###d|h|m
|
||||||
|
export const DEFAULT_TOKEN_DAYS = process.env.DEFAULT_TOKEN_DAYS || 365;
|
||||||
|
|
||||||
|
export const ROUTE_PREFIX = process.env.ROUTE_PREFIX || '/auth';
|
||||||
|
export const LOGIN_ROUTE = process.env.LOGIN_ROUTE || '/login';
|
||||||
|
export const RESET_ROUTE = process.env.RESET_ROUTE || '/reset';
|
||||||
|
export const VERIFICATION_ROUTE = process.env.VERIFICATION_ROUTE || '/verification';
|
||||||
|
|
||||||
|
export const REQUIRE_VERIFICATION = process.env.REQUIRE_VERIFICATION || true;
|
||||||
12
lib/constants/errors.ts
Normal file
12
lib/constants/errors.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
export enum ErrorCodes {
|
||||||
|
RESET_REQUEST_DATA = 'RESET_REQUEST_DATA',
|
||||||
|
}
|
||||||
|
|
||||||
|
export const ErrorMessages = {
|
||||||
|
[ErrorCodes.RESET_REQUEST_DATA]: 'A valid username and password must be provided',
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getErrorBody = (code: ErrorCodes) => ({
|
||||||
|
code,
|
||||||
|
message: ErrorMessages[code],
|
||||||
|
});
|
||||||
7
lib/constants/strategies.ts
Normal file
7
lib/constants/strategies.ts
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
export enum STRATEGIES {
|
||||||
|
LOCAL,
|
||||||
|
APPLE,
|
||||||
|
FACEBOOK,
|
||||||
|
FIDO2,
|
||||||
|
GOOGLE,
|
||||||
|
}
|
||||||
4
lib/constants/tokens.ts
Normal file
4
lib/constants/tokens.ts
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
export enum TokenType {
|
||||||
|
RESET = 'RESET',
|
||||||
|
VERIFICATION = 'VERIFICATION',
|
||||||
|
}
|
||||||
37
lib/dao/create.ts
Normal file
37
lib/dao/create.ts
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
import { DatabaseError } from '@mifi/services-common/domain/errors/DatabaseError';
|
||||||
|
|
||||||
|
import { Auth, Log, Strategy, Token } from '..';
|
||||||
|
import { Auth as AuthProps } from '../schema/auth';
|
||||||
|
import { STRATEGIES } from '../constants/strategies';
|
||||||
|
import { REQUIRE_VERIFICATION } from '../constants/env';
|
||||||
|
import { TokenType } from '../constants/tokens';
|
||||||
|
import { Status } from '../constants/auth';
|
||||||
|
import { Action } from '../constants/action';
|
||||||
|
|
||||||
|
export const create = async ({ record, username, password }: AuthProps & { password: string }) => {
|
||||||
|
const status = REQUIRE_VERIFICATION ? Status.UNVERIFIED : Status.ACTIVE;
|
||||||
|
const doc = await Auth.create({
|
||||||
|
record,
|
||||||
|
status,
|
||||||
|
username,
|
||||||
|
}).catch((err) => {
|
||||||
|
throw new DatabaseError('failed to create user', { err });
|
||||||
|
});
|
||||||
|
if (doc) {
|
||||||
|
const strategy = await Strategy.create({ method: STRATEGIES.LOCAL, key: password, parent: doc._id }).catch(
|
||||||
|
(err) => {
|
||||||
|
throw new DatabaseError('failed to create strategy', { err });
|
||||||
|
},
|
||||||
|
);
|
||||||
|
if (strategy) {
|
||||||
|
doc.strategies.push(strategy._id);
|
||||||
|
await doc.save();
|
||||||
|
Log.add(doc._id, Action.CREATE);
|
||||||
|
return { doc, token: REQUIRE_VERIFICATION && (await Token.getToken(TokenType.VERIFICATION, doc._id)) };
|
||||||
|
}
|
||||||
|
await doc.deleteOne((err) => {
|
||||||
|
throw new DatabaseError('failed to remove invalid auth record', { err, doc });
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
};
|
||||||
15
lib/dao/deleteById.ts
Normal file
15
lib/dao/deleteById.ts
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
import { StringSchemaDefinition } from 'mongoose';
|
||||||
|
|
||||||
|
import { Auth, Log, Strategy, Token } from '..';
|
||||||
|
import { Status } from '../constants/auth';
|
||||||
|
import { Action } from '../constants/action';
|
||||||
|
|
||||||
|
export const deleteById = async (id: StringSchemaDefinition) => {
|
||||||
|
if (await Auth.findByIdAndUpdate(id, { status: Status.DELETED, strategies: [] }).catch()) {
|
||||||
|
await Strategy.deleteMany({ parent: id });
|
||||||
|
await Token.deleteMany({ auth: id });
|
||||||
|
Log.add(id, Action.DELETE);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
};
|
||||||
9
lib/dao/readAll.ts
Normal file
9
lib/dao/readAll.ts
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import { FilterQuery } from 'mongoose';
|
||||||
|
|
||||||
|
import { Auth } from '..';
|
||||||
|
import { Status } from '../constants/auth';
|
||||||
|
import { AuthDocument } from '../schema/auth';
|
||||||
|
|
||||||
|
export const readAll = async (query: FilterQuery<AuthDocument> = {}) => Auth.find(query);
|
||||||
|
|
||||||
|
export const readAllActive = async () => readAll({ status: { $ne: Status.DELETED } });
|
||||||
5
lib/dao/readOneById.ts
Normal file
5
lib/dao/readOneById.ts
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
import { Types } from 'mongoose';
|
||||||
|
|
||||||
|
import { Auth } from '..';
|
||||||
|
|
||||||
|
export const readOneById = async (id: Types.ObjectId) => Auth.findById(id);
|
||||||
5
lib/dao/readOneByRecord.ts
Normal file
5
lib/dao/readOneByRecord.ts
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
import { Types } from 'mongoose';
|
||||||
|
|
||||||
|
import { Auth } from '..';
|
||||||
|
|
||||||
|
export const readOneByRecord = async (record: Types.ObjectId) => Auth.findOne({ record });
|
||||||
3
lib/dao/readOneByUsername.ts
Normal file
3
lib/dao/readOneByUsername.ts
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
import { Auth } from '..';
|
||||||
|
|
||||||
|
export const readOneByUsername = async (username: string) => Auth.findOne({ username });
|
||||||
17
lib/index.ts
Normal file
17
lib/index.ts
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
import mongoose from 'mongoose';
|
||||||
|
|
||||||
|
import { DB_HOST, DB_NAME, DB_PASSWORD, DB_PORT, DB_USERNAME } from '../constants/db';
|
||||||
|
import { Auth } from './model/auth';
|
||||||
|
import { Log } from './model/log';
|
||||||
|
import { Strategy } from './model/strategy';
|
||||||
|
import { Token } from './model/token';
|
||||||
|
|
||||||
|
const connection = mongoose
|
||||||
|
.connect(`mongodb://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_NAME}`)
|
||||||
|
.then((c) => console.debug('Database connection established', { connection: c }))
|
||||||
|
.catch((error) => {
|
||||||
|
console.error('Mongo connection failure', error);
|
||||||
|
process.exit(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
export { connection, Auth, Log, Strategy, Token };
|
||||||
6
lib/model/auth.ts
Normal file
6
lib/model/auth.ts
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
import mongoose from 'mongoose';
|
||||||
|
|
||||||
|
import { AuthDocument, AuthModel, AuthSchema } from '../schema/auth';
|
||||||
|
import { COLL_AUTH } from '../constants/db';
|
||||||
|
|
||||||
|
export const Auth = mongoose.model<AuthDocument, AuthModel>(COLL_AUTH, AuthSchema);
|
||||||
6
lib/model/log.ts
Normal file
6
lib/model/log.ts
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
import mongoose from 'mongoose';
|
||||||
|
|
||||||
|
import { LogModel, Log as LogDocument, LogSchema } from '../schema/log';
|
||||||
|
import { COLL_LOG } from '../constants/db';
|
||||||
|
|
||||||
|
export const Log = mongoose.model<LogDocument, LogModel>(COLL_LOG, LogSchema);
|
||||||
6
lib/model/strategy.ts
Normal file
6
lib/model/strategy.ts
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
import mongoose from 'mongoose';
|
||||||
|
|
||||||
|
import { StrategyDocument, StrategyModel, StrategySchema } from '../schema/strategy';
|
||||||
|
import { COLL_STRATEGY } from '../constants/db';
|
||||||
|
|
||||||
|
export const Strategy = mongoose.model<StrategyDocument, StrategyModel>(COLL_STRATEGY, StrategySchema);
|
||||||
6
lib/model/token.ts
Normal file
6
lib/model/token.ts
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
import mongoose from 'mongoose';
|
||||||
|
|
||||||
|
import { TokenModel, Token as TokenDocument, TokenSchema } from '../schema/token';
|
||||||
|
import { COLL_TOKEN } from '../constants/db';
|
||||||
|
|
||||||
|
export const Token = mongoose.model<TokenDocument, TokenModel>(COLL_TOKEN, TokenSchema);
|
||||||
75
lib/schema/auth.ts
Normal file
75
lib/schema/auth.ts
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
import { Document, InferSchemaType, Model, Schema, StringSchemaDefinition, Types } from 'mongoose';
|
||||||
|
|
||||||
|
import { Status } from '../constants/auth';
|
||||||
|
import { COLL_STRATEGY } from '../constants/db';
|
||||||
|
import { STRATEGIES } from '../constants/strategies';
|
||||||
|
import { StrategyDocument } from './strategy';
|
||||||
|
import { verify } from '../utils/password';
|
||||||
|
|
||||||
|
export interface Auth {
|
||||||
|
is2FA?: boolean;
|
||||||
|
record: StringSchemaDefinition;
|
||||||
|
username: string;
|
||||||
|
status: Status;
|
||||||
|
strategies: Types.ObjectId[] | StrategyDocument[];
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AuthBaseDocument extends Auth, Document {
|
||||||
|
authenticate(password: string): Promise<boolean>;
|
||||||
|
getStrategy(method?: STRATEGIES): Promise<StrategyDocument | null>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AuthDocument extends AuthBaseDocument {
|
||||||
|
strategies: Types.ObjectId[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AuthPopulatedDocument extends AuthBaseDocument {
|
||||||
|
strategies: StrategyDocument[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AuthModel extends Model<AuthDocument> {
|
||||||
|
findByUsername(username: string): Promise<AuthDocument>;
|
||||||
|
getLocalStrategyForUsername(username: string): Promise<StrategyDocument>;
|
||||||
|
isUsernameAvailable(username: string): Promise<boolean>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const AuthSchema = new Schema<AuthDocument, AuthModel>(
|
||||||
|
{
|
||||||
|
is2FA: { type: Boolean, default: false },
|
||||||
|
record: { type: Types.ObjectId, unique: true },
|
||||||
|
status: { type: Number, enum: Status, default: Status.UNVERIFIED, index: true },
|
||||||
|
strategies: [{ type: Types.ObjectId, ref: COLL_STRATEGY, default: [] }],
|
||||||
|
username: { type: String, required: true, unique: true },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
minimize: true,
|
||||||
|
timestamps: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
AuthSchema.methods.authenticate = async function (this: AuthBaseDocument, password: string) {
|
||||||
|
const strategy = await this.getStrategy();
|
||||||
|
return !!strategy && verify(password, strategy.key);
|
||||||
|
};
|
||||||
|
|
||||||
|
AuthSchema.methods.getStrategy = async function (this: AuthBaseDocument, method = STRATEGIES.LOCAL) {
|
||||||
|
const doc = await this.populate<{ strategies: StrategyDocument[] }>('strategies');
|
||||||
|
return doc.strategies.filter((strategy) => strategy.method === method).pop() || null;
|
||||||
|
};
|
||||||
|
|
||||||
|
AuthSchema.statics = {
|
||||||
|
async findByUsername(username) {
|
||||||
|
return this.findOne({ username });
|
||||||
|
},
|
||||||
|
|
||||||
|
async getLocalStrategyForUsername(username) {
|
||||||
|
const doc = await this.findByUsername(username);
|
||||||
|
return !!doc && doc.getStrategy();
|
||||||
|
},
|
||||||
|
|
||||||
|
async isUsernameAvailable(username) {
|
||||||
|
return !this.findByUsername(username);
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export type AuthSchema = InferSchemaType<typeof AuthSchema>;
|
||||||
45
lib/schema/log.ts
Normal file
45
lib/schema/log.ts
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
import { InferSchemaType, Model, Schema, StringSchemaDefinition, Types } from 'mongoose';
|
||||||
|
|
||||||
|
import { Payload } from '@mifi/services-common/types/Payload';
|
||||||
|
|
||||||
|
import { Action } from '../constants/action';
|
||||||
|
|
||||||
|
export interface Log {
|
||||||
|
action: Action;
|
||||||
|
auth: StringSchemaDefinition;
|
||||||
|
payload?: Payload;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface LogModel extends Model<Log> {
|
||||||
|
add(id: StringSchemaDefinition, action: Action, payload?: Payload): void;
|
||||||
|
historyForUser(id: StringSchemaDefinition, action?: Action): Array<Log>;
|
||||||
|
loginsForUser(id: StringSchemaDefinition): Array<Log>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const LogSchema = new Schema<Log, LogModel>(
|
||||||
|
{
|
||||||
|
action: { type: String, enum: Action, required: true },
|
||||||
|
auth: { type: Types.ObjectId, index: true, required: true },
|
||||||
|
payload: { type: Object },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
minimize: true,
|
||||||
|
timestamps: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
LogSchema.statics = {
|
||||||
|
add(id, action, payload) {
|
||||||
|
this.create({ action, auth: id, payload }).catch();
|
||||||
|
},
|
||||||
|
|
||||||
|
async historyForUser(id, action) {
|
||||||
|
return this.find({ auth: id, action });
|
||||||
|
},
|
||||||
|
|
||||||
|
async loginsForUser(id) {
|
||||||
|
return this.find({ auth: id, action: Action.AUTHENTICATE });
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export type LogSchema = InferSchemaType<typeof LogSchema>;
|
||||||
81
lib/schema/strategy.ts
Normal file
81
lib/schema/strategy.ts
Normal file
@@ -0,0 +1,81 @@
|
|||||||
|
import { Document, InferSchemaType, Model, Schema, StringSchemaDefinition, Types } from 'mongoose';
|
||||||
|
|
||||||
|
import { STRATEGIES } from '../constants/strategies';
|
||||||
|
import { encrypt } from '../utils/password';
|
||||||
|
import { COLL_AUTH } from '../constants/db';
|
||||||
|
import { AuthDocument } from './auth';
|
||||||
|
import { Strategy } from '..';
|
||||||
|
|
||||||
|
export interface Strategy {
|
||||||
|
method: STRATEGIES;
|
||||||
|
parent: StringSchemaDefinition | AuthDocument;
|
||||||
|
externalId?: string;
|
||||||
|
key: string;
|
||||||
|
profile?: { [key: string]: string | boolean | number };
|
||||||
|
forceReset?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface StrategyBaseDocument extends Strategy, Document {
|
||||||
|
getAuthRecord(): Promise<AuthDocument>;
|
||||||
|
getPopulatedStrategy(): Promise<StrategyPopulatedDocument>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface StrategyDocument extends StrategyBaseDocument {
|
||||||
|
parent: StringSchemaDefinition;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface StrategyPopulatedDocument extends StrategyBaseDocument {
|
||||||
|
parent: AuthDocument;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type StrategyModel = Model<StrategyDocument>;
|
||||||
|
|
||||||
|
export const StrategySchema = new Schema<StrategyDocument, StrategyModel>(
|
||||||
|
{
|
||||||
|
method: {
|
||||||
|
type: Number,
|
||||||
|
enum: STRATEGIES,
|
||||||
|
index: true,
|
||||||
|
},
|
||||||
|
externalId: { type: String, index: true },
|
||||||
|
forceReset: { type: Boolean },
|
||||||
|
key: { type: String, required: true, trim: true },
|
||||||
|
parent: {
|
||||||
|
type: Types.ObjectId,
|
||||||
|
ref: COLL_AUTH,
|
||||||
|
required: true,
|
||||||
|
},
|
||||||
|
profile: {},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
minimize: true,
|
||||||
|
timestamps: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
StrategySchema.methods.getPopulatedStrategy = async function (this: StrategyModel) {
|
||||||
|
return this.populate<StrategyPopulatedDocument>('parent');
|
||||||
|
};
|
||||||
|
|
||||||
|
StrategySchema.methods.getAuthRecord = async function (this: StrategyModel) {
|
||||||
|
return (await this.getPopulatedStrategy()).parent;
|
||||||
|
};
|
||||||
|
|
||||||
|
StrategySchema.pre('save', async function save(next) {
|
||||||
|
if (typeof this.method === 'undefined') {
|
||||||
|
return next(new Error(`Strategy requires a method.`));
|
||||||
|
}
|
||||||
|
|
||||||
|
if (await Strategy.findOne({ method: this.method, parent: this.parent })) {
|
||||||
|
return next(new Error(`${this.method} strategy already exists for this user.`));
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this.method !== STRATEGIES.LOCAL || !this.isModified('key')) {
|
||||||
|
return next();
|
||||||
|
}
|
||||||
|
|
||||||
|
this.key = encrypt(this.key);
|
||||||
|
return next();
|
||||||
|
});
|
||||||
|
|
||||||
|
export type StrategySchema = InferSchemaType<typeof StrategySchema>;
|
||||||
65
lib/schema/token.ts
Normal file
65
lib/schema/token.ts
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
import { InferSchemaType, Model, Schema, StringSchemaDefinition, Types } from 'mongoose';
|
||||||
|
|
||||||
|
import { TokenType } from '../constants/tokens';
|
||||||
|
import { getDefaultExpiresFor } from '../utils/getDefaultExpiresFor';
|
||||||
|
import { sign, verify } from '../utils/jwt';
|
||||||
|
|
||||||
|
export interface Token {
|
||||||
|
auth: StringSchemaDefinition;
|
||||||
|
expires?: number;
|
||||||
|
type: TokenType;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface TokenModel extends Model<Token> {
|
||||||
|
cleanupExpiredTokens(): { success: boolean; deletedCount: number };
|
||||||
|
getToken(type: TokenType, auth: Types.ObjectId, expires?: number): string;
|
||||||
|
validateResetToken(token: string): Types.ObjectId | false;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const TokenSchema = new Schema<Token, TokenModel>(
|
||||||
|
{
|
||||||
|
auth: { type: Types.ObjectId, index: true },
|
||||||
|
expires: { type: Number, required: true },
|
||||||
|
type: { type: String, enum: TokenType, required: true },
|
||||||
|
},
|
||||||
|
{
|
||||||
|
minimize: true,
|
||||||
|
timestamps: true,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
TokenSchema.statics = {
|
||||||
|
async cleanupExpiredTokens() {
|
||||||
|
const { acknowledged, deletedCount } = await this.deleteMany({ expires: { $lte: Date.now() } });
|
||||||
|
return { success: acknowledged, deletedCount };
|
||||||
|
},
|
||||||
|
|
||||||
|
async getToken(type: TokenType, auth: StringSchemaDefinition, expires?: number) {
|
||||||
|
const existing = await this.findOne({ type, auth });
|
||||||
|
if (existing) {
|
||||||
|
await existing.deleteOne();
|
||||||
|
}
|
||||||
|
|
||||||
|
const doc = await this.create({ type, auth, expires: expires || getDefaultExpiresFor(type) });
|
||||||
|
return sign({
|
||||||
|
sub: `${doc._id}`,
|
||||||
|
exp: doc.expires,
|
||||||
|
});
|
||||||
|
},
|
||||||
|
|
||||||
|
async validateResetToken(token: string) {
|
||||||
|
const { sub } = verify(token);
|
||||||
|
|
||||||
|
if (sub) {
|
||||||
|
const record = await this.findById(sub);
|
||||||
|
if (record) {
|
||||||
|
await record.deleteOne();
|
||||||
|
return !!record?.expires && record.expires >= Date.now() && record.auth;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export type TokenSchema = InferSchemaType<typeof TokenSchema>;
|
||||||
15
lib/utils/getDefaultExpiresFor.ts
Normal file
15
lib/utils/getDefaultExpiresFor.ts
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
import { LOGIN_VALID_TIMEOUT, RESET_VALID_TIMEOUT, VERIFY_VALID_TIMEOUT } from '../constants/env';
|
||||||
|
import { TokenType } from '../constants/tokens';
|
||||||
|
import { parseTimeoutToMs } from '../utils/parseTimeoutToMs';
|
||||||
|
|
||||||
|
export const getDefaultExpiresFor = (type: TokenType | void) => {
|
||||||
|
if (type === TokenType.RESET) {
|
||||||
|
return Date.now() + parseTimeoutToMs(RESET_VALID_TIMEOUT);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (type === TokenType.VERIFICATION) {
|
||||||
|
return Date.now() + parseTimeoutToMs(VERIFY_VALID_TIMEOUT);
|
||||||
|
}
|
||||||
|
|
||||||
|
return Date.now() + parseTimeoutToMs(LOGIN_VALID_TIMEOUT);
|
||||||
|
};
|
||||||
11
lib/utils/getLoginToken.ts
Normal file
11
lib/utils/getLoginToken.ts
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
import { sign } from '../utils/jwt';
|
||||||
|
import { LOGIN_VALID_TIMEOUT } from '../constants/env';
|
||||||
|
import { parseTimeoutToMs } from '../utils/parseTimeoutToMs';
|
||||||
|
import { AuthDocument } from '../schema/auth';
|
||||||
|
|
||||||
|
export const getLoginToken = ({ record: sub, status }: AuthDocument) =>
|
||||||
|
sign({
|
||||||
|
sub: <string>sub,
|
||||||
|
status,
|
||||||
|
exp: Date.now() + parseTimeoutToMs(LOGIN_VALID_TIMEOUT),
|
||||||
|
});
|
||||||
35
lib/utils/jwt.ts
Normal file
35
lib/utils/jwt.ts
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
import jwt from 'jsonwebtoken';
|
||||||
|
import { JWT_AUDIENCE, JWT_ISSUER, JWT_SECRET } from '../constants/env';
|
||||||
|
export interface TokenProps {
|
||||||
|
aud?: string;
|
||||||
|
exp?: number | Date;
|
||||||
|
iss?: string;
|
||||||
|
sub: string | null;
|
||||||
|
[key: string]: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type SignProps = string | TokenProps | void;
|
||||||
|
|
||||||
|
export const sign = (props: SignProps) => {
|
||||||
|
const today = new Date();
|
||||||
|
const { sub = null, ...rest }: TokenProps =
|
||||||
|
typeof props === 'string' || typeof props === 'undefined' ? { sub: props || null } : props;
|
||||||
|
let { exp } = rest;
|
||||||
|
if (!exp) {
|
||||||
|
exp = new Date(today);
|
||||||
|
exp.setDate(today.getDate() + parseInt(process.env.JWT_DAYS_VALID as string));
|
||||||
|
exp = exp.getTime() / 1000;
|
||||||
|
}
|
||||||
|
return jwt.sign(
|
||||||
|
{
|
||||||
|
exp,
|
||||||
|
sub,
|
||||||
|
aud: rest.aud || JWT_AUDIENCE,
|
||||||
|
iat: today.getTime(),
|
||||||
|
iss: rest.iss || JWT_ISSUER,
|
||||||
|
},
|
||||||
|
JWT_SECRET,
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const verify = (token: string) => jwt.verify(token, JWT_SECRET);
|
||||||
5
lib/utils/links.ts
Normal file
5
lib/utils/links.ts
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
import { RESET_ROUTE, ROUTE_PREFIX, VERIFICATION_ROUTE } from '../constants/env';
|
||||||
|
|
||||||
|
export const getPasswordResetPath = (token: string) => `${ROUTE_PREFIX}${RESET_ROUTE}?t=${token}`;
|
||||||
|
|
||||||
|
export const getVerificationPath = (token: string) => `${ROUTE_PREFIX}${VERIFICATION_ROUTE}?t=${token}`;
|
||||||
13
lib/utils/parseTimeoutToMs.ts
Normal file
13
lib/utils/parseTimeoutToMs.ts
Normal file
@@ -0,0 +1,13 @@
|
|||||||
|
export const parseTimeoutToMs = (timeout: string) => {
|
||||||
|
const match = timeout.match(/(?<number>\d+)(?<unit>d|h|m)/gi)?.groups || {};
|
||||||
|
const { number, unit } = match;
|
||||||
|
switch (unit) {
|
||||||
|
case 'd':
|
||||||
|
return 1000 * 60 * 60 * 24 * parseInt(number);
|
||||||
|
case 'h':
|
||||||
|
return 1000 * 60 * 60 * parseInt(number);
|
||||||
|
case 'm':
|
||||||
|
default:
|
||||||
|
return 1000 * 60 * parseInt(number) || 1;
|
||||||
|
}
|
||||||
|
};
|
||||||
12
lib/utils/password.ts
Normal file
12
lib/utils/password.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
import { pbkdf2Sync, randomBytes } from 'crypto';
|
||||||
|
|
||||||
|
export const encrypt = (password: string) => {
|
||||||
|
const salt = randomBytes(16).toString('hex');
|
||||||
|
const hash = pbkdf2Sync(password, salt, 10000, 512, 'sha512').toString('hex');
|
||||||
|
return `${salt}:${hash}`;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const verify = (test: string, secret: string) => {
|
||||||
|
const [salt, hash] = secret.split(':');
|
||||||
|
return pbkdf2Sync(test, salt, 10000, 512, 'sha512').toString('hex') === hash;
|
||||||
|
};
|
||||||
11
lib/utils/tokens.ts
Normal file
11
lib/utils/tokens.ts
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
import { sign } from './jwt';
|
||||||
|
import { LOGIN_VALID_TIMEOUT } from '../constants/env';
|
||||||
|
import { Status } from '../constants/auth';
|
||||||
|
import { parseTimeoutToMs } from './parseTimeoutToMs';
|
||||||
|
|
||||||
|
export const generateLoginToken = (sub: string, status: Status) =>
|
||||||
|
sign({
|
||||||
|
sub,
|
||||||
|
status,
|
||||||
|
exp: Date.now() + parseTimeoutToMs(LOGIN_VALID_TIMEOUT),
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user