-
Notifications
You must be signed in to change notification settings - Fork 134
/
Users.ts
203 lines (171 loc) · 5.82 KB
/
Users.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
import {argon2id, argon2Verify} from 'hash-wasm';
import crypto from 'crypto';
import Datastore from 'nedb-promises';
import fs from 'fs';
import path from 'path';
import {AccessLevel} from '../../shared/schema/constants/Auth';
import config from '../../config';
import {bootstrapServicesForUser, destroyUserServices} from '../services';
import type {ClientConnectionSettings} from '../../shared/schema/ClientConnectionSettings';
import type {Credentials, UserInDatabase} from '../../shared/schema/Auth';
const hashPassword = async (password: string): Promise<string> => {
return argon2id({
password: password,
salt: crypto.randomBytes(16),
parallelism: 1,
iterations: 256,
memorySize: 512,
hashLength: 32,
outputType: 'encoded',
});
};
class Users {
private db = (() => {
const db = Datastore.create({
autoload: true,
filename: path.join(config.dbPath, 'users.db'),
});
db.ensureIndex({fieldName: 'username', unique: true});
return db;
})();
private configUser: UserInDatabase = {
_id: '_config',
timestamp: 0,
username: '_config',
password: '',
client: config.configUser as ClientConnectionSettings,
level: AccessLevel.ADMINISTRATOR,
};
getConfigUser(): Readonly<UserInDatabase> {
return this.configUser;
}
async bootstrapServicesForAllUsers(): Promise<void> {
return this.listUsers()
.then((users) => Promise.all(users.map((user) => bootstrapServicesForUser(user))))
.then(() => undefined);
}
/**
* Validates the provided password against the hashed password in database
*
* @param {Pick<Credentials, 'username' | 'password'>} credentials - Username and password
* @return {Promise<AccessLevel>} - Returns access level of the user if matched or rejects with error.
*/
async comparePassword(credentials: Pick<Credentials, 'username' | 'password'>): Promise<AccessLevel> {
return this.db.findOne<Credentials>({username: credentials.username}).then((user) => {
// Wrong data provided
if (credentials?.password == null) {
throw new Error();
}
// Username not found.
if (user == null) {
throw new Error();
}
return argon2Verify({
password: credentials.password,
hash: user.password,
}).then((isMatch) => {
if (isMatch) {
return user.level;
} else {
throw new Error();
}
});
});
}
/**
* Creates a new user.
* Note that validation function always expects an argon2 hash.
*
* @param {Credentials} credentials - Full credentials of a user.
* @param {boolean} shouldHash - Should the password be hashed or stored as-is.
* @return {Promise<UserInDatabase>} - Returns the created user or rejects with error.
*/
async createUser(credentials: Credentials, shouldHash = true): Promise<UserInDatabase> {
const hashed = shouldHash ? await hashPassword(credentials.password).catch(() => undefined) : credentials.password;
if (this.db == null || hashed == null) {
throw new Error();
}
return this.db
.insert({
...credentials,
password: hashed,
timestamp: Math.ceil(Date.now() / 1000),
})
.catch((err) => {
if (err.message.includes('violates the unique constraint')) {
throw new Error('Username already exists.');
}
throw new Error();
});
}
/**
* Removes a user.
*
* @param {string} username - Name of the user to be removed.
* @return {Promise<string>} - Returns ID of removed user or rejects with error.
*/
async removeUser(username: string): Promise<string> {
return this.db.findOne<Credentials>({username}).then(async ({_id}) => {
destroyUserServices(_id);
await this.db.remove({username}, {});
await fs.promises.rmdir(path.join(config.dbPath, _id), {recursive: true}).catch(() => undefined);
return _id;
});
}
/**
* Updates a user.
*
* @param {string} username - Name of the user to be updated.
* @param {Partial<Credentials>} userRecordPatch - Changes to the user.
* @return {Promise<string>} - Returns new username of updated user or rejects with error.
*/
async updateUser(username: string, userRecordPatch: Partial<Credentials>): Promise<string> {
const patch: Omit<Partial<UserInDatabase>, '_id'> = userRecordPatch;
if (patch.password != null) {
patch.password = await hashPassword(patch.password);
}
if (Object.keys(patch).length > 1 || patch.client == null) {
patch.timestamp = Math.ceil(Date.now() / 1000);
}
return this.db.update({username}, {$set: patch}, {}).then((numUsersUpdated) => {
if (numUsersUpdated === 0) {
throw new Error();
}
return userRecordPatch.username || username;
});
}
/**
* Looks up a user.
*
* @param {string} username - Name of the user to be updated.
* @return {Promise<UserInDatabase>} - Returns a user or rejects with error.
*/
async lookupUser(username: string): Promise<UserInDatabase> {
if (config.authMethod === 'none') {
return this.getConfigUser();
}
return this.db.findOne<UserInDatabase>({username});
}
/**
* Lists users.
*
* @return {Promise<UserInDatabase[]>} - Returns users or rejects with error.
*/
async listUsers(): Promise<UserInDatabase[]> {
if (config.authMethod === 'none') {
return [this.getConfigUser()];
}
return this.db.find<UserInDatabase>({});
}
/**
* Gets the number of users and route to appropriate handler.
*/
async initialUserGate(handlers: {handleInitialUser: () => void; handleSubsequentUser: () => void}): Promise<void> {
const userCount = await this.db.count({});
if (userCount && userCount > 0) {
return handlers.handleSubsequentUser();
}
return handlers.handleInitialUser();
}
}
export default new Users();