-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathinitConfig.ts
More file actions
397 lines (352 loc) · 13.4 KB
/
Copy pathinitConfig.ts
File metadata and controls
397 lines (352 loc) · 13.4 KB
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
import fs from 'fs';
import {
Config,
EnclavedConfig,
MasterExpressConfig,
TlsMode,
AppMode,
EnvironmentName,
} from './shared/types';
import logger from './logger';
import { validateTlsCertificates, validateMasterExpressConfig } from './shared/appUtils';
export { Config, EnclavedConfig, MasterExpressConfig, TlsMode, AppMode, EnvironmentName };
function isNilOrNaN(val: unknown): val is null | undefined | number {
return val == null || (typeof val === 'number' && isNaN(val));
}
function readEnvVar(name: string): string | undefined {
if (process.env[name] !== undefined && process.env[name] !== '') {
return process.env[name];
}
}
function determineAppMode(): AppMode {
const mode = readEnvVar('APP_MODE') || readEnvVar('BITGO_APP_MODE');
if (!mode) {
throw new Error(
'APP_MODE environment variable is required. Set APP_MODE to either "enclaved" or "master-express"',
);
}
if (mode === 'master-express') {
return AppMode.MASTER_EXPRESS;
}
if (mode === 'enclaved') {
return AppMode.ENCLAVED;
}
throw new Error(`Invalid APP_MODE: ${mode}. Must be either "enclaved" or "master-express"`);
}
export { determineAppMode };
// ============================================================================
// ENCLAVED MODE CONFIGURATION
// ============================================================================
const defaultEnclavedConfig: EnclavedConfig = {
appMode: AppMode.ENCLAVED,
port: 3080,
bind: 'localhost',
timeout: 305 * 1000,
logFile: '',
kmsUrl: '', // Will be overridden by environment variable
tlsMode: TlsMode.MTLS,
mtlsRequestCert: true,
allowSelfSigned: false,
};
function determineTlsMode(): TlsMode {
const tlsMode = readEnvVar('TLS_MODE')?.toLowerCase();
if (!tlsMode) {
logger.warn('TLS_MODE not set, defaulting to MTLS. Set TLS_MODE=disabled to disable TLS.');
return TlsMode.MTLS;
}
if (tlsMode === 'disabled') {
return TlsMode.DISABLED;
}
if (tlsMode === 'mtls') {
return TlsMode.MTLS;
}
throw new Error(`Invalid TLS_MODE: ${tlsMode}. Must be either "disabled" or "mtls"`);
}
function enclavedEnvConfig(): Partial<EnclavedConfig> {
const kmsUrl = readEnvVar('KMS_URL');
if (!kmsUrl) {
logger.error('KMS_URL environment variable is required and cannot be empty');
throw new Error('KMS_URL environment variable is required and cannot be empty');
}
return {
appMode: AppMode.ENCLAVED,
port: Number(readEnvVar('ENCLAVED_EXPRESS_PORT')),
bind: readEnvVar('BIND'),
ipc: readEnvVar('IPC'),
debugNamespace: (readEnvVar('DEBUG_NAMESPACE') || '').split(',').filter(Boolean),
logFile: readEnvVar('LOGFILE'),
timeout: Number(readEnvVar('TIMEOUT')),
keepAliveTimeout: Number(readEnvVar('KEEP_ALIVE_TIMEOUT')),
headersTimeout: Number(readEnvVar('HEADERS_TIMEOUT')),
// KMS settings
kmsUrl,
// mTLS settings
keyPath: readEnvVar('TLS_KEY_PATH'),
crtPath: readEnvVar('TLS_CERT_PATH'),
tlsKey: readEnvVar('TLS_KEY'),
tlsCert: readEnvVar('TLS_CERT'),
tlsMode: determineTlsMode(),
mtlsRequestCert: readEnvVar('MTLS_REQUEST_CERT')?.toLowerCase() !== 'false',
mtlsAllowedClientFingerprints: readEnvVar('MTLS_ALLOWED_CLIENT_FINGERPRINTS')?.split(','),
allowSelfSigned: readEnvVar('ALLOW_SELF_SIGNED') === 'true',
};
}
function mergeEnclavedConfigs(...configs: Partial<EnclavedConfig>[]): EnclavedConfig {
function get<T extends keyof EnclavedConfig>(k: T): EnclavedConfig[T] {
return configs.reduce(
(entry: EnclavedConfig[T], config) =>
!isNilOrNaN(config[k]) ? (config[k] as EnclavedConfig[T]) : entry,
defaultEnclavedConfig[k],
);
}
return {
appMode: AppMode.ENCLAVED,
port: get('port'),
bind: get('bind'),
ipc: get('ipc'),
debugNamespace: get('debugNamespace'),
logFile: get('logFile'),
timeout: get('timeout'),
keepAliveTimeout: get('keepAliveTimeout'),
headersTimeout: get('headersTimeout'),
kmsUrl: get('kmsUrl'),
keyPath: get('keyPath'),
crtPath: get('crtPath'),
tlsKey: get('tlsKey'),
tlsCert: get('tlsCert'),
tlsMode: get('tlsMode'),
mtlsRequestCert: get('mtlsRequestCert'),
mtlsAllowedClientFingerprints: get('mtlsAllowedClientFingerprints'),
allowSelfSigned: get('allowSelfSigned'),
};
}
function configureEnclavedMode(): EnclavedConfig {
const env = enclavedEnvConfig();
let config = mergeEnclavedConfigs(env);
// Only load certificates if TLS is enabled
if (config.tlsMode !== TlsMode.DISABLED) {
// Handle file loading for TLS certificates
if (!config.tlsKey && config.keyPath) {
try {
config = { ...config, tlsKey: fs.readFileSync(config.keyPath, 'utf-8') };
logger.info(`Successfully loaded TLS private key from file: ${config.keyPath}`);
} catch (e) {
const err = e instanceof Error ? e : new Error(String(e));
throw new Error(`Failed to read TLS key from keyPath: ${err.message}`);
}
} else if (config.tlsKey) {
logger.debug('Using TLS private key from environment variable');
}
if (!config.tlsCert && config.crtPath) {
try {
config = { ...config, tlsCert: fs.readFileSync(config.crtPath, 'utf-8') };
logger.info(`Successfully loaded TLS certificate from file: ${config.crtPath}`);
} catch (e) {
const err = e instanceof Error ? e : new Error(String(e));
throw new Error(`Failed to read TLS certificate from crtPath: ${err.message}`);
}
} else if (config.tlsCert) {
logger.debug('Using TLS certificate from environment variable');
}
// Validate that certificates are properly loaded when TLS is enabled
validateTlsCertificates(config);
}
return config;
}
// ============================================================================
// MASTER EXPRESS MODE CONFIGURATION
// ============================================================================
const defaultMasterExpressConfig: MasterExpressConfig = {
appMode: AppMode.MASTER_EXPRESS,
port: 3081,
bind: 'localhost',
timeout: 305 * 1000,
logFile: '',
env: 'test',
disableEnvCheck: true,
authVersion: 2,
enclavedExpressUrl: '', // Will be overridden by environment variable
enclavedExpressCert: '', // Will be overridden by environment variable
tlsMode: TlsMode.MTLS,
mtlsRequestCert: true,
allowSelfSigned: false,
};
function determineProtocol(url: string, tlsMode: TlsMode, isBitGo = false): string {
const regex = new RegExp(/(^\w+:|^)\/\//);
const protocol = isBitGo ? 'https' : tlsMode === TlsMode.DISABLED ? 'http' : 'https';
if (regex.test(url)) {
return url.replace(/(^\w+:|^)\/\//, `${protocol}://`);
}
return `${protocol}://${url}`;
}
function masterExpressEnvConfig(): Partial<MasterExpressConfig> {
const enclavedExpressUrl = readEnvVar('ENCLAVED_EXPRESS_URL');
const enclavedExpressCert = readEnvVar('ENCLAVED_EXPRESS_CERT');
const tlsMode = determineTlsMode();
if (!enclavedExpressUrl) {
throw new Error('ENCLAVED_EXPRESS_URL environment variable is required and cannot be empty');
}
if (tlsMode === TlsMode.MTLS && !enclavedExpressCert) {
throw new Error('ENCLAVED_EXPRESS_CERT environment variable is required for MTLS mode.');
}
// Debug mTLS environment variables
const mtlsRequestCertRaw = readEnvVar('MTLS_REQUEST_CERT');
const allowSelfSignedRaw = readEnvVar('ALLOW_SELF_SIGNED');
const mtlsRequestCert = mtlsRequestCertRaw?.toLowerCase() !== 'false';
const allowSelfSigned = allowSelfSignedRaw === 'true';
return {
appMode: AppMode.MASTER_EXPRESS,
port: Number(readEnvVar('MASTER_EXPRESS_PORT')),
bind: readEnvVar('BIND'),
ipc: readEnvVar('IPC'),
debugNamespace: (readEnvVar('DEBUG_NAMESPACE') || '').split(',').filter(Boolean),
logFile: readEnvVar('LOGFILE'),
timeout: Number(readEnvVar('TIMEOUT')),
keepAliveTimeout: Number(readEnvVar('KEEP_ALIVE_TIMEOUT')),
headersTimeout: Number(readEnvVar('HEADERS_TIMEOUT')),
// BitGo API settings
env: readEnvVar('BITGO_ENV') as EnvironmentName,
customRootUri: readEnvVar('BITGO_CUSTOM_ROOT_URI'),
disableEnvCheck: readEnvVar('BITGO_DISABLE_ENV_CHECK') === 'true',
authVersion: Number(readEnvVar('BITGO_AUTH_VERSION')),
enclavedExpressUrl,
enclavedExpressCert,
customBitcoinNetwork: readEnvVar('BITGO_CUSTOM_BITCOIN_NETWORK'),
// mTLS settings
keyPath: readEnvVar('TLS_KEY_PATH'),
crtPath: readEnvVar('TLS_CERT_PATH'),
tlsKey: readEnvVar('TLS_KEY'),
tlsCert: readEnvVar('TLS_CERT'),
tlsMode,
mtlsRequestCert,
mtlsAllowedClientFingerprints: readEnvVar('MTLS_ALLOWED_CLIENT_FINGERPRINTS')?.split(','),
allowSelfSigned,
};
}
function mergeMasterExpressConfigs(
...configs: Partial<MasterExpressConfig>[]
): MasterExpressConfig {
function get<T extends keyof MasterExpressConfig>(k: T): MasterExpressConfig[T] {
return configs.reduce(
(entry: MasterExpressConfig[T], config) =>
!isNilOrNaN(config[k]) ? (config[k] as MasterExpressConfig[T]) : entry,
defaultMasterExpressConfig[k],
);
}
return {
appMode: AppMode.MASTER_EXPRESS,
port: get('port'),
bind: get('bind'),
ipc: get('ipc'),
debugNamespace: get('debugNamespace'),
logFile: get('logFile'),
timeout: get('timeout'),
keepAliveTimeout: get('keepAliveTimeout'),
headersTimeout: get('headersTimeout'),
env: get('env'),
customRootUri: get('customRootUri'),
disableEnvCheck: get('disableEnvCheck'),
authVersion: get('authVersion'),
enclavedExpressUrl: get('enclavedExpressUrl'),
enclavedExpressCert: get('enclavedExpressCert'),
customBitcoinNetwork: get('customBitcoinNetwork'),
keyPath: get('keyPath'),
crtPath: get('crtPath'),
tlsKey: get('tlsKey'),
tlsCert: get('tlsCert'),
tlsMode: get('tlsMode'),
mtlsRequestCert: get('mtlsRequestCert'),
mtlsAllowedClientFingerprints: get('mtlsAllowedClientFingerprints'),
allowSelfSigned: get('allowSelfSigned'),
};
}
export function configureMasterExpressMode(): MasterExpressConfig {
const env = masterExpressEnvConfig();
let config = mergeMasterExpressConfigs(env);
// Post-process URLs to ensure they use the correct protocol based on TLS mode
const updates: Partial<MasterExpressConfig> = {};
if (config.customRootUri) {
updates.customRootUri = determineProtocol(config.customRootUri, config.tlsMode, true);
}
if (config.enclavedExpressUrl) {
updates.enclavedExpressUrl = determineProtocol(
config.enclavedExpressUrl,
config.tlsMode,
false,
);
}
config = { ...config, ...updates };
// Only load certificates if TLS is enabled
if (config.tlsMode !== TlsMode.DISABLED) {
// Handle file loading for TLS certificates
if (!config.tlsKey && config.keyPath) {
try {
config = { ...config, tlsKey: fs.readFileSync(config.keyPath, 'utf-8') };
logger.info(`Successfully loaded TLS private key from file: ${config.keyPath}`);
} catch (e) {
const err = e instanceof Error ? e : new Error(String(e));
throw new Error(`Failed to read TLS key from keyPath: ${err.message}`);
}
} else if (config.tlsKey) {
logger.debug('Using TLS private key from environment variable');
}
if (!config.tlsCert && config.crtPath) {
try {
config = { ...config, tlsCert: fs.readFileSync(config.crtPath, 'utf-8') };
logger.info(`Successfully loaded TLS certificate from file: ${config.crtPath}`);
} catch (e) {
const err = e instanceof Error ? e : new Error(String(e));
throw new Error(`Failed to read TLS certificate from crtPath: ${err.message}`);
}
} else if (config.tlsCert) {
logger.debug('Using TLS certificate from environment variable');
}
// Validate that certificates are properly loaded when TLS is enabled
validateTlsCertificates(config);
}
// Handle cert loading for Enclaved Express (always required for Master Express)
if (config.enclavedExpressCert) {
try {
if (fs.existsSync(config.enclavedExpressCert)) {
config = {
...config,
enclavedExpressCert: fs.readFileSync(config.enclavedExpressCert, 'utf-8'),
};
logger.info(
`Successfully loaded Enclaved Express certificate from file: ${config.enclavedExpressCert.substring(
0,
50,
)}...`,
);
} else {
throw new Error(`Certificate file not found: ${config.enclavedExpressCert}`);
}
} catch (e) {
const err = e instanceof Error ? e : new Error(String(e));
throw new Error(`Failed to read enclaved express cert: ${err.message}`);
}
}
// Validate Master Express configuration
validateMasterExpressConfig(config);
return config;
}
// ============================================================================
// MAIN CONFIG FUNCTION
// ============================================================================
export function initConfig(): Config {
const appMode = determineAppMode();
if (appMode === AppMode.ENCLAVED) {
return configureEnclavedMode();
} else if (appMode === AppMode.MASTER_EXPRESS) {
return configureMasterExpressMode();
} else {
throw new Error(`Unknown app mode: ${appMode}`);
}
}
// Type guards for working with the union type
export function isEnclavedConfig(config: Config): config is EnclavedConfig {
return config.appMode === AppMode.ENCLAVED;
}
export function isMasterExpressConfig(config: Config): config is MasterExpressConfig {
return config.appMode === AppMode.MASTER_EXPRESS;
}