You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`src/initConfig.ts` - Configuration loading and validation
50
56
-`src/routes/` - Express routes for both modes
@@ -53,47 +59,56 @@ Enclaved BitGo Express is a secure cryptocurrency signing server with two operat
53
59
-`src/shared/` - Shared utilities and types
54
60
55
61
### Configuration
62
+
56
63
Configuration is managed through environment variables with defaults defined in `src/initConfig.ts`. The application requires specific environment variables depending on the mode:
57
64
58
65
#### Common Variables
59
-
-`APP_MODE` - Set to "enclaved" or "master-express"
66
+
67
+
-`APP_MODE` - Set to "secured" or "master-express"
60
68
-`TLS_MODE` - Set to "mtls" or "disabled"
61
69
-`BIND` - Address to bind to (default: localhost)
62
70
-`TIMEOUT` - Request timeout in milliseconds (default: 305000)
63
71
64
-
#### Enclaved Mode Specific
65
-
-`ENCLAVED_EXPRESS_PORT` - Port to listen on (default: 3080)
72
+
#### Secured Mode Specific
73
+
74
+
-`SECURED_EXPRESS_PORT` - Port to listen on (default: 3080)
66
75
-`KMS_URL` - Required KMS service URL
67
76
68
77
#### Master Express Mode Specific
78
+
69
79
-`MASTER_EXPRESS_PORT` - Port to listen on (default: 3081)
70
80
-`BITGO_ENV` - BitGo environment (default: test)
71
-
-`ENCLAVED_EXPRESS_URL` - Required URL for the Enclaved Express server
72
-
-`ENCLAVED_EXPRESS_CERT` - Required path to Enclaved Express certificate
81
+
-`SECURED_EXPRESS_URL` - Required URL for the Secured Express server
82
+
-`SECURED_EXPRESS_CERT` - Required path to Secured Express certificate
Copy file name to clipboardExpand all lines: README.md
+40-39Lines changed: 40 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,28 @@
1
-
# Enclaved BitGo Express
1
+
# Secured BitGo Express
2
2
3
-
A secure, mTLS-enabled cryptocurrency signing server with two operational modes: Enclaved Express (dedicated signer) and Master Express (API gateway with integrated signing capabilities).
3
+
A secure, mTLS-enabled cryptocurrency signing server with two operational modes: Secured Express (dedicated signer) and Master Express (API gateway with integrated signing capabilities).
4
4
5
5
## Overview
6
6
7
7
This application provides secure cryptocurrency operations with mutual TLS (mTLS) authentication:
8
8
9
-
-**Enclaved Mode**: Lightweight signing server for secure key operations
9
+
-**Secured Mode**: Lightweight signing server for secure key operations
10
10
-**Master Express Mode**: Full BitGo Express functionality with integrated signing
11
11
-**mTLS Security**: Client certificate validation for secure communications
12
12
-**Flexible Configuration**: Environment-based setup with file or variable-based certificates
13
13
14
14
## Architecture
15
15
16
-
-**Enclaved Express** (Port 3080): Focused signing operations with KMS integration
17
-
-**Master Express** (Port 3081): Full BitGo API functionality with secure communication to Enclaved Express
16
+
-**Secured Express** (Port 3080): Focused signing operations with KMS integration
17
+
-**Master Express** (Port 3081): Full BitGo API functionality with secure communication to Secured Express
18
18
19
19
## Configuration
20
20
21
21
Configuration is managed through environment variables:
22
22
23
23
### Required Settings
24
24
25
-
-`APP_MODE` - Application mode (required: "enclaved" or "master-express")
25
+
-`APP_MODE` - Application mode (required: "secured" or "master-express")
26
26
27
27
### Network Settings
28
28
@@ -31,9 +31,9 @@ Configuration is managed through environment variables:
0 commit comments