@canton-network/wallet-gateway-remote 1.12.0 → 1.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +107 -31
- package/dist/auth/jwt-auth-service.d.ts.map +1 -1
- package/dist/auth/jwt-auth-service.js +164 -77
- package/dist/config/Config.d.ts +407 -24
- package/dist/config/Config.d.ts.map +1 -1
- package/dist/config/Config.js +146 -11
- package/dist/config/ConfigUtils.d.ts +16 -1
- package/dist/config/ConfigUtils.d.ts.map +1 -1
- package/dist/config/ConfigUtils.js +150 -60
- package/dist/dapp-api/controller.d.ts +13 -1
- package/dist/dapp-api/controller.d.ts.map +1 -1
- package/dist/dapp-api/controller.js +16 -20
- package/dist/dapp-api/rpc-gen/index.d.ts.map +1 -1
- package/dist/dapp-api/rpc-gen/typings.d.ts +33 -3
- package/dist/dapp-api/rpc-gen/typings.d.ts.map +1 -1
- package/dist/dapp-api/server.d.ts +10 -5
- package/dist/dapp-api/server.d.ts.map +1 -1
- package/dist/dapp-api/server.js +10 -3
- package/dist/dapp-api/sse-sink.d.ts.map +1 -1
- package/dist/env.d.ts +1 -24
- package/dist/env.d.ts.map +1 -1
- package/dist/env.js +0 -23
- package/dist/example-config.d.ts +94 -62
- package/dist/example-config.d.ts.map +1 -1
- package/dist/example-config.js +95 -61
- package/dist/index.d.ts +3 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +82 -32
- package/dist/init.d.ts.map +1 -1
- package/dist/init.js +86 -127
- package/dist/ledger/party-allocation-service.d.ts +1 -4
- package/dist/ledger/party-allocation-service.d.ts.map +1 -1
- package/dist/ledger/party-allocation-service.js +1 -3
- package/dist/ledger/wallet-allocation/signing-providers/bitgo-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/bitgo-wallet-allocator.js +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/blockdaemon-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/dfns-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/fireblocks-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/kernel-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/participant-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/signing-providers/securosys-wallet-allocator.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/wallet-allocation-service.d.ts +2 -2
- package/dist/ledger/wallet-allocation/wallet-allocation-service.d.ts.map +1 -1
- package/dist/ledger/wallet-allocation/wallet-allocation-service.js +2 -2
- package/dist/ledger/wallet-sync-service.d.ts +14 -1
- package/dist/ledger/wallet-sync-service.d.ts.map +1 -1
- package/dist/ledger/wallet-sync-service.js +240 -72
- package/dist/middleware/apiKeyAuth.d.ts.map +1 -1
- package/dist/middleware/apiKeyAuth.js +4 -8
- package/dist/middleware/errorHandler.d.ts +1 -1
- package/dist/middleware/errorHandler.d.ts.map +1 -1
- package/dist/middleware/jsonRpcHandler.d.ts.map +1 -1
- package/dist/middleware/jsonRpcHandler.js +3 -3
- package/dist/middleware/jwtAuth.d.ts +1 -1
- package/dist/middleware/jwtAuth.d.ts.map +1 -1
- package/dist/middleware/jwtAuth.js +17 -2
- package/dist/middleware/rateLimit.d.ts.map +1 -1
- package/dist/middleware/rateLimit.js +3 -9
- package/dist/middleware/securityHeaders.d.ts.map +1 -1
- package/dist/middleware/sessionHandler.d.ts +3 -3
- package/dist/middleware/sessionHandler.d.ts.map +1 -1
- package/dist/middleware/sessionHandler.js +8 -8
- package/dist/notices/server-notices.d.ts +24 -0
- package/dist/notices/server-notices.d.ts.map +1 -0
- package/dist/notices/server-notices.js +40 -0
- package/dist/notices/server-status-service.d.ts +11 -0
- package/dist/notices/server-status-service.d.ts.map +1 -0
- package/dist/notices/server-status-service.js +17 -0
- package/dist/signing/service-account-session.d.ts +16 -2
- package/dist/signing/service-account-session.d.ts.map +1 -1
- package/dist/signing/service-account-session.js +32 -1
- package/dist/signing-providers-registration.d.ts +7 -0
- package/dist/signing-providers-registration.d.ts.map +1 -0
- package/dist/signing-providers-registration.js +276 -0
- package/dist/user-api/controller.d.ts +25 -4
- package/dist/user-api/controller.d.ts.map +1 -1
- package/dist/user-api/controller.js +218 -235
- package/dist/user-api/rpc-gen/index.d.ts +27 -9
- package/dist/user-api/rpc-gen/index.d.ts.map +1 -1
- package/dist/user-api/rpc-gen/index.js +9 -3
- package/dist/user-api/rpc-gen/schemas.d.ts.map +1 -1
- package/dist/user-api/rpc-gen/schemas.js +86 -11
- package/dist/user-api/rpc-gen/typings.d.ts +158 -58
- package/dist/user-api/rpc-gen/typings.d.ts.map +1 -1
- package/dist/user-api/server.d.ts +7 -5
- package/dist/user-api/server.d.ts.map +1 -1
- package/dist/user-api/server.js +7 -2
- package/dist/web/frontend/404/index.html +3 -2
- package/dist/web/frontend/activities/index.html +4 -3
- package/dist/web/frontend/admin/index.html +16 -0
- package/dist/web/frontend/api-keys/add/index.html +3 -2
- package/dist/web/frontend/api-keys/index.html +3 -2
- package/dist/web/frontend/approve/index.html +4 -3
- package/dist/web/frontend/assets/404-N2p-H94F.js +5 -0
- package/dist/web/frontend/assets/activities-CIyMcvMq.js +71 -0
- package/dist/web/frontend/assets/addApiKey-DD_HxolC.js +92 -0
- package/dist/web/frontend/assets/addIdentityProvider-DNaST3bz.js +28 -0
- package/dist/web/frontend/assets/addNetwork-BwV-qK9L.js +38 -0
- package/dist/web/frontend/assets/addParty-DtBW1rpV.js +14 -0
- package/dist/web/frontend/assets/admin-CKAkdJym.js +53 -0
- package/dist/web/frontend/assets/apiKeys-CcnbBkNH.js +68 -0
- package/dist/web/frontend/assets/approve-33mo5eC8.js +27 -0
- package/dist/web/frontend/assets/callback-lKGXXz-1.js +7 -0
- package/dist/web/frontend/assets/common-DaUa4tUM.js +15 -0
- package/dist/web/frontend/assets/dist-BW5ACUmw.js +2 -0
- package/dist/web/frontend/assets/dist-CVv1nHd6.js +1 -0
- package/dist/web/frontend/assets/editParty-ZifjLzYx.js +15 -0
- package/dist/web/frontend/assets/frontend-Bs6UVmG1.js +4968 -0
- package/dist/web/frontend/assets/identityProviders-D5s7N-Ec.js +76 -0
- package/dist/web/frontend/assets/login-BAJsIB9G.js +11 -0
- package/dist/web/frontend/assets/networks-Do-zoG5E.js +78 -0
- package/dist/web/frontend/assets/parties-DFcN190b.js +51 -0
- package/dist/web/frontend/assets/reviewIdentityProvider-C2tsrpKc.js +43 -0
- package/dist/web/frontend/assets/reviewNetwork-BEGzls61.js +43 -0
- package/dist/web/frontend/assets/rolldown-runtime-pP25SEvz.js +1 -0
- package/dist/web/frontend/assets/selfIssuedLogin-a2KenO2P.js +112 -0
- package/dist/web/frontend/assets/signMessage-CQF0sCMe.js +23 -0
- package/dist/web/frontend/callback/index.html +3 -2
- package/dist/web/frontend/identity-providers/add/index.html +3 -2
- package/dist/web/frontend/identity-providers/index.html +3 -2
- package/dist/web/frontend/identity-providers/review/index.html +3 -2
- package/dist/web/frontend/index.html +2 -1
- package/dist/web/frontend/login/index.html +4 -11
- package/dist/web/frontend/networks/add/index.html +3 -2
- package/dist/web/frontend/networks/index.html +3 -2
- package/dist/web/frontend/networks/review/index.html +3 -2
- package/dist/web/frontend/parties/add/index.html +5 -5
- package/dist/web/frontend/parties/edit/index.html +5 -5
- package/dist/web/frontend/parties/index.html +4 -3
- package/dist/web/frontend/self-issued-login/index.html +16 -0
- package/dist/web/frontend/sign-message/index.html +3 -2
- package/dist/web/route-inputs.d.ts.map +1 -1
- package/dist/web/route-inputs.js +2 -1
- package/dist/web/server.d.ts.map +1 -1
- package/dist/web/server.js +1 -1
- package/package.json +53 -51
- package/dist/auth/jwt-auth-service.test.d.ts +0 -2
- package/dist/auth/jwt-auth-service.test.d.ts.map +0 -1
- package/dist/auth/jwt-auth-service.test.js +0 -659
- package/dist/config/Config.test.d.ts +0 -2
- package/dist/config/Config.test.d.ts.map +0 -1
- package/dist/config/Config.test.js +0 -26
- package/dist/dapp-api/controller.test.d.ts +0 -2
- package/dist/dapp-api/controller.test.d.ts.map +0 -1
- package/dist/dapp-api/controller.test.js +0 -531
- package/dist/dapp-api/server.test.d.ts +0 -2
- package/dist/dapp-api/server.test.d.ts.map +0 -1
- package/dist/dapp-api/server.test.js +0 -79
- package/dist/dapp-api/sse-sink.test.d.ts +0 -2
- package/dist/dapp-api/sse-sink.test.d.ts.map +0 -1
- package/dist/dapp-api/sse-sink.test.js +0 -30
- package/dist/ledger/party-allocation-service.test.d.ts +0 -2
- package/dist/ledger/party-allocation-service.test.d.ts.map +0 -1
- package/dist/ledger/party-allocation-service.test.js +0 -105
- package/dist/ledger/self-issued-auth-service.d.ts +0 -50
- package/dist/ledger/self-issued-auth-service.d.ts.map +0 -1
- package/dist/ledger/self-issued-auth-service.js +0 -263
- package/dist/ledger/self-issued-auth-service.test.d.ts +0 -2
- package/dist/ledger/self-issued-auth-service.test.d.ts.map +0 -1
- package/dist/ledger/self-issued-auth-service.test.js +0 -454
- package/dist/ledger/wallet-allocation/wallet-allocation-service.test.d.ts +0 -2
- package/dist/ledger/wallet-allocation/wallet-allocation-service.test.d.ts.map +0 -1
- package/dist/ledger/wallet-allocation/wallet-allocation-service.test.js +0 -1005
- package/dist/ledger/wallet-sync-service.test.d.ts +0 -2
- package/dist/ledger/wallet-sync-service.test.d.ts.map +0 -1
- package/dist/ledger/wallet-sync-service.test.js +0 -1017
- package/dist/middleware/apiKeyAuth.test.d.ts +0 -2
- package/dist/middleware/apiKeyAuth.test.d.ts.map +0 -1
- package/dist/middleware/apiKeyAuth.test.js +0 -126
- package/dist/middleware/errorHandler.test.d.ts +0 -2
- package/dist/middleware/errorHandler.test.d.ts.map +0 -1
- package/dist/middleware/errorHandler.test.js +0 -138
- package/dist/middleware/jsonRpcHandler.test.d.ts +0 -2
- package/dist/middleware/jsonRpcHandler.test.d.ts.map +0 -1
- package/dist/middleware/jsonRpcHandler.test.js +0 -377
- package/dist/middleware/jwtAuth.test.d.ts +0 -2
- package/dist/middleware/jwtAuth.test.d.ts.map +0 -1
- package/dist/middleware/jwtAuth.test.js +0 -100
- package/dist/middleware/rateLimit.test.d.ts +0 -2
- package/dist/middleware/rateLimit.test.d.ts.map +0 -1
- package/dist/middleware/rateLimit.test.js +0 -56
- package/dist/middleware/securityHeaders.test.d.ts +0 -2
- package/dist/middleware/securityHeaders.test.d.ts.map +0 -1
- package/dist/middleware/securityHeaders.test.js +0 -18
- package/dist/middleware/sessionHandler.test.d.ts +0 -2
- package/dist/middleware/sessionHandler.test.d.ts.map +0 -1
- package/dist/middleware/sessionHandler.test.js +0 -215
- package/dist/signing/service-account-session.test.d.ts +0 -2
- package/dist/signing/service-account-session.test.d.ts.map +0 -1
- package/dist/signing/service-account-session.test.js +0 -88
- package/dist/signing/signing-worker.d.ts +0 -86
- package/dist/signing/signing-worker.d.ts.map +0 -1
- package/dist/signing/signing-worker.js +0 -216
- package/dist/signing/signing-worker.test.d.ts +0 -2
- package/dist/signing/signing-worker.test.d.ts.map +0 -1
- package/dist/signing/signing-worker.test.js +0 -158
- package/dist/user-api/controller.test.d.ts +0 -2
- package/dist/user-api/controller.test.d.ts.map +0 -1
- package/dist/user-api/controller.test.js +0 -1228
- package/dist/user-api/server.test.d.ts +0 -2
- package/dist/user-api/server.test.d.ts.map +0 -1
- package/dist/user-api/server.test.js +0 -117
- package/dist/user-api/token-network-matching.test.d.ts +0 -2
- package/dist/user-api/token-network-matching.test.d.ts.map +0 -1
- package/dist/user-api/token-network-matching.test.js +0 -66
- package/dist/utils.test.d.ts +0 -2
- package/dist/utils.test.d.ts.map +0 -1
- package/dist/utils.test.js +0 -24
- package/dist/web/frontend/assets/404-B1XXXMXN.js +0 -5
- package/dist/web/frontend/assets/activities-HZnPjlMp.js +0 -61
- package/dist/web/frontend/assets/addApiKey-BvkCtUF3.js +0 -92
- package/dist/web/frontend/assets/addIdentityProvider-Dvjma837.js +0 -28
- package/dist/web/frontend/assets/addNetwork-Cahac0uo.js +0 -38
- package/dist/web/frontend/assets/addParty-Cdoed_Yx.js +0 -13
- package/dist/web/frontend/assets/apiKeys-BwV6ylWL.js +0 -68
- package/dist/web/frontend/assets/approve-B0nIfe2y.js +0 -26
- package/dist/web/frontend/assets/callback-BieW5Ux2.js +0 -7
- package/dist/web/frontend/assets/common-Bv9twGrA.js +0 -31
- package/dist/web/frontend/assets/editParty-OOjTHFay.js +0 -14
- package/dist/web/frontend/assets/identityProviders-BxJAq1Ne.js +0 -71
- package/dist/web/frontend/assets/index-Bo6MnlYI.js +0 -2
- package/dist/web/frontend/assets/index-CG_aFABR.js +0 -1
- package/dist/web/frontend/assets/index-D1Brmwbg.js +0 -93
- package/dist/web/frontend/assets/index-pMOoiNFq.js +0 -4887
- package/dist/web/frontend/assets/login-BHxgJEz_.js +0 -11
- package/dist/web/frontend/assets/networks-CBprjUF5.js +0 -73
- package/dist/web/frontend/assets/onboarding-ChmWs-TC.js +0 -84
- package/dist/web/frontend/assets/reviewIdentityProvider-CCmKgN8N.js +0 -43
- package/dist/web/frontend/assets/reviewNetwork-CX8Bmuf3.js +0 -43
- package/dist/web/frontend/assets/signMessage-BN_6S5FV.js +0 -79
- package/dist/web/frontend/onboarding/index.html +0 -23
- package/dist/web/route-inputs.test.d.ts +0 -2
- package/dist/web/route-inputs.test.d.ts.map +0 -1
- package/dist/web/route-inputs.test.js +0 -30
package/README.md
CHANGED
|
@@ -44,50 +44,126 @@ wallet-gateway --config-schema
|
|
|
44
44
|
|
|
45
45
|
The JSON-RPC API specs from `api-specs/` are generated into strongly-typed method builders for the remote RPC server. To update the codegen, run `pnpm generate:dapp`.
|
|
46
46
|
|
|
47
|
-
##
|
|
47
|
+
## Signing providers
|
|
48
48
|
|
|
49
|
-
|
|
49
|
+
`signingProviders` configuration has two modes:
|
|
50
50
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
51
|
+
- **Legacy** - for backwards compatibility only, will be removed in the future. Omit the `signingProviders` config property. Every provider stays available
|
|
52
|
+
when its required environment variables are set. Non-secret settings also come
|
|
53
|
+
from those environment variables.
|
|
54
|
+
- **Explicit** - include `signingProviders` config property. Each listed provider is opt-in by
|
|
55
|
+
presence of its key. Non-secret settings come from the config object. Secret values stay in the environment variables,
|
|
56
|
+
Config allows altering names of those variables via `*Env` fields (each defaults to the name used in legacy config).
|
|
57
57
|
|
|
58
|
-
|
|
58
|
+
### Wallet Kernel
|
|
59
59
|
|
|
60
|
-
|
|
60
|
+
**Gateway config:**
|
|
61
61
|
|
|
62
|
-
|
|
62
|
+
- `signingProviders.walletKernel` - set it to {} to enable
|
|
63
|
+
- `signingStore` - required for this provider, the provider is unavailable when the signing store is omitted
|
|
63
64
|
|
|
64
|
-
|
|
65
|
+
**Environment variables:**
|
|
65
66
|
|
|
66
|
-
|
|
67
|
+
- None
|
|
67
68
|
|
|
68
|
-
|
|
69
|
+
### Participant
|
|
69
70
|
|
|
70
|
-
|
|
71
|
-
- `BLOCKDAEMON_API_KEY` - Your Blockdaemon API key
|
|
71
|
+
**Gateway config:**
|
|
72
72
|
|
|
73
|
-
|
|
73
|
+
- `signingProviders.participant` - set it to `{}` to enable
|
|
74
74
|
|
|
75
|
-
|
|
76
|
-
`SECUROSYS_TSB_BASE_URL` is set. Set these environment variables before starting
|
|
77
|
-
the Gateway:
|
|
75
|
+
**Environment variables:**
|
|
78
76
|
|
|
79
|
-
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
77
|
+
- None
|
|
78
|
+
|
|
79
|
+
### Dfns
|
|
80
|
+
|
|
81
|
+
Create a service account in the Dfns dashboard with permissions to create and sign with Canton wallets, then download its credentials.
|
|
82
|
+
|
|
83
|
+
**Gateway config:**
|
|
84
|
+
|
|
85
|
+
- `signingProviders.dfns` - include this object to enable
|
|
86
|
+
- `signingProviders.dfns.orgId` - required
|
|
87
|
+
- `signingProviders.dfns.credId` - required
|
|
88
|
+
- `signingProviders.dfns.baseUrl` - optional, defaults to `https://api.dfns.io`
|
|
89
|
+
- `signingProviders.dfns.privateKeyEnv` - optional name of the env var that holds the service account private key (PEM), defaults to `DFNS_PRIVATE_KEY`
|
|
90
|
+
- `signingProviders.dfns.authTokenEnv` - optional name of the env var that holds the service account auth token, defaults to `DFNS_AUTH_TOKEN`
|
|
91
|
+
|
|
92
|
+
**Environment variables:**
|
|
93
|
+
|
|
94
|
+
- The variables named by `privateKeyEnv` and `authTokenEnv` (defaults above)
|
|
95
|
+
|
|
96
|
+
### Fireblocks
|
|
97
|
+
|
|
98
|
+
Complete steps 1–3 from the instructions at https://github.com/canton-network/wallet/tree/main/core/signing-fireblocks.
|
|
99
|
+
|
|
100
|
+
**Gateway config:**
|
|
101
|
+
|
|
102
|
+
- `signingProviders.fireblocks` - include this object to enable
|
|
103
|
+
- `signingProviders.fireblocks.apiPath` - optional, defaults to `https://api.fireblocks.io/v1`
|
|
104
|
+
- `signingProviders.fireblocks.apiKeyEnv` - optional name of the env var that holds the API key, defaults to `FIREBLOCKS_API_KEY`
|
|
105
|
+
- `signingProviders.fireblocks.secretEnv` - optional name of the env var that holds the API secret, defaults to `FIREBLOCKS_SECRET`
|
|
106
|
+
|
|
107
|
+
**Environment variables:**
|
|
108
|
+
|
|
109
|
+
- The variables named by `apiKeyEnv` and `secretEnv` (defaults above)
|
|
110
|
+
|
|
111
|
+
### Blockdaemon
|
|
112
|
+
|
|
113
|
+
Create a system user in the Blockdaemon dashboard and save the API key displayed after successful creation.
|
|
114
|
+
|
|
115
|
+
**Gateway config:**
|
|
116
|
+
|
|
117
|
+
- `signingProviders.blockdaemon` - include this object to enable
|
|
118
|
+
- `signingProviders.blockdaemon.baseUrl` - optional, defaults to `http://localhost:5080/api/cwp/canton`
|
|
119
|
+
- `signingProviders.blockdaemon.caip2` - optional, defaults to `canton:testnet`
|
|
120
|
+
- `signingProviders.blockdaemon.apiKeyEnv` - optional name of the env var that holds the API key, defaults to `BLOCKDAEMON_API_KEY`
|
|
121
|
+
|
|
122
|
+
**Environment variables:**
|
|
123
|
+
|
|
124
|
+
- The variable named by `apiKeyEnv` (default above)
|
|
125
|
+
|
|
126
|
+
### Securosys
|
|
127
|
+
|
|
128
|
+
**Gateway config:**
|
|
129
|
+
|
|
130
|
+
- `signingProviders.securosys` - include this object to enable
|
|
131
|
+
- `signingProviders.securosys.baseUrl` - required
|
|
132
|
+
- `signingProviders.securosys.mtlsP12Path` - optional client PKCS#12/P12 file for mTLS
|
|
133
|
+
- `signingProviders.securosys.signatureAlgorithm` - optional TSB signature algorithm, defaults to `EDDSA`
|
|
134
|
+
- `signingProviders.securosys.keyManagementApiKeyEnv` - optional name of the env var that holds the key-management API key, defaults to `SECUROSYS_TSB_KEY_MANAGEMENT_API_KEY`
|
|
135
|
+
- `signingProviders.securosys.keyOperationApiKeyEnv` - optional name of the env var that holds the key-operation API key, defaults to `SECUROSYS_TSB_KEY_OPERATION_API_KEY`
|
|
136
|
+
- `signingProviders.securosys.bearerTokenEnv` - optional name of the env var that holds the bearer token, defaults to `SECUROSYS_TSB_BEARER_TOKEN`
|
|
137
|
+
- `signingProviders.securosys.mtlsP12PasswordEnv` - optional name of the env var that holds the PKCS#12/P12 password, defaults to `SECUROSYS_TSB_MTLS_P12_PASSWORD`
|
|
138
|
+
- `signingProviders.securosys.keyPasswordEnv` - optional name of the env var that holds the TSB key password, defaults to `SECUROSYS_TSB_KEY_PASSWORD`
|
|
139
|
+
|
|
140
|
+
**Environment variables:**
|
|
141
|
+
|
|
142
|
+
- The variables named by the `*Env` fields (defaults above)
|
|
87
143
|
|
|
88
144
|
See [`@canton-network/core-signing-securosys`](../../core/signing-securosys/README.md)
|
|
89
145
|
for key creation, public-key, and signature format details.
|
|
90
146
|
|
|
147
|
+
### BitGo
|
|
148
|
+
|
|
149
|
+
Create a long-lived access token in the BitGo dashboard and note the enterprise
|
|
150
|
+
ID used for wallet creation.
|
|
151
|
+
|
|
152
|
+
**Gateway config:**
|
|
153
|
+
|
|
154
|
+
- `signingProviders.bitgo` - include this object to enable
|
|
155
|
+
- `signingProviders.bitgo.baseUrl` - optional, defaults to `https://app.bitgo.com`
|
|
156
|
+
- `signingProviders.bitgo.enterpriseId` - optional, required for wallet creation and restart-safe transaction lookup
|
|
157
|
+
- `signingProviders.bitgo.coin` - optional, auto-detected from the API URL when omitted
|
|
158
|
+
- `signingProviders.bitgo.accessTokenEnv` - optional name of the env var that holds the access token, defaults to `BITGO_ACCESS_TOKEN`
|
|
159
|
+
|
|
160
|
+
**Environment variables:**
|
|
161
|
+
|
|
162
|
+
- The variable named by `accessTokenEnv` (default above)
|
|
163
|
+
|
|
164
|
+
See [`@canton-network/core-signing-bitgo`](../../core/signing-bitgo/README.md)
|
|
165
|
+
for credential setup and driver behavior.
|
|
166
|
+
|
|
91
167
|
## Postgres connection
|
|
92
168
|
|
|
93
169
|
To create a Postgres database you need to:
|
|
@@ -98,14 +174,14 @@ To create a Postgres database you need to:
|
|
|
98
174
|
$ docker run --network=host --name some-postgres -e POSTGRES_PASSWORD=postgres -d postgres
|
|
99
175
|
```
|
|
100
176
|
|
|
101
|
-
2. In the file
|
|
177
|
+
2. In the file `/wallet-gateway/test/config.json`, specify the connection settings for both databases - store (required) and signingStore (optional, only needed for signing provider `wallet-kernel`). The connection should look like this (it is important that `store.connection.database !== signingStore.connection.database !== 'postgres'`):
|
|
102
178
|
|
|
103
179
|
```json
|
|
104
180
|
{
|
|
105
181
|
"store": {
|
|
106
182
|
"connection": {
|
|
107
183
|
"type": "postgres",
|
|
108
|
-
"
|
|
184
|
+
"passwordEnv": "WG_TEST_POSTGRES_PASSWORD",
|
|
109
185
|
"port": 5432,
|
|
110
186
|
"user": "postgres",
|
|
111
187
|
"host": "0.0.0.0",
|
|
@@ -115,7 +191,7 @@ $ docker run --network=host --name some-postgres -e POSTGRES_PASSWORD=postgres -
|
|
|
115
191
|
"signingStore": {
|
|
116
192
|
"connection": {
|
|
117
193
|
"type": "postgres",
|
|
118
|
-
"
|
|
194
|
+
"passwordEnv": "WG_TEST_POSTGRES_PASSWORD",
|
|
119
195
|
"port": 5432,
|
|
120
196
|
"user": "postgres",
|
|
121
197
|
"host": "0.0.0.0",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"jwt-auth-service.d.ts","sourceRoot":"","sources":["../../src/auth/jwt-auth-service.ts"],"names":[],"mappings":"AAGA,OAAO,EAEH,KAAK,WAAW,
|
|
1
|
+
{"version":3,"file":"jwt-auth-service.d.ts","sourceRoot":"","sources":["../../src/auth/jwt-auth-service.ts"],"names":[],"mappings":"AAGA,OAAO,EAEH,KAAK,WAAW,EAKnB,MAAM,kCAAkC,CAAA;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAA;AAa9D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAkOlC;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,UAAW,KAAK,UAAU,MAAM,KAAG,WAsL7D,CAAA"}
|
|
@@ -1,13 +1,25 @@
|
|
|
1
1
|
// Copyright (c) 2025-2026 Digital Asset (Switzerland) GmbH and/or its affiliates. All rights reserved.
|
|
2
2
|
// SPDX-License-Identifier: Apache-2.0
|
|
3
|
-
import {
|
|
4
|
-
import { createRemoteJWKSet, decodeJwt, decodeProtectedHeader, importJWK, jwtVerify, base64url, } from 'jose';
|
|
3
|
+
import { createOidcClient, IdpUnavailableError, } from '@canton-network/core-wallet-auth';
|
|
4
|
+
import { createRemoteJWKSet, customFetch, decodeJwt, errors, decodeProtectedHeader, importJWK, jwtVerify, base64url, } from 'jose';
|
|
5
5
|
function getEmail(value) {
|
|
6
6
|
if (typeof value !== 'string' || value.length === 0) {
|
|
7
7
|
return undefined;
|
|
8
8
|
}
|
|
9
9
|
return value;
|
|
10
10
|
}
|
|
11
|
+
/**
|
|
12
|
+
* App-only access tokens, such as Entra ID client-credentials tokens, carry
|
|
13
|
+
* application permissions in `roles` and omit `scope` and `scp`. The claim
|
|
14
|
+
* values are not matched; a non-empty role is enough, same as scope.
|
|
15
|
+
*/
|
|
16
|
+
function hasRolesClaim(roles) {
|
|
17
|
+
if (typeof roles === 'string') {
|
|
18
|
+
return roles.length > 0;
|
|
19
|
+
}
|
|
20
|
+
return (Array.isArray(roles) &&
|
|
21
|
+
roles.some((role) => typeof role === 'string' && role.length > 0));
|
|
22
|
+
}
|
|
11
23
|
/**
|
|
12
24
|
* Verifies a self-signed token against the secret of the network named by
|
|
13
25
|
* the `kid` header, and rejects it if that network belongs to another IDP.
|
|
@@ -55,6 +67,38 @@ function getSelfIssuedUserId(payload) {
|
|
|
55
67
|
}
|
|
56
68
|
return usr;
|
|
57
69
|
}
|
|
70
|
+
/**
|
|
71
|
+
* Fetches the JWKS for `createRemoteJWKSet`. jose reports a failed JWKS
|
|
72
|
+
* request as a generic error, indistinguishable from a bad token, so fail with
|
|
73
|
+
* IdpUnavailableError instead.
|
|
74
|
+
*/
|
|
75
|
+
async function fetchJwks(url, options) {
|
|
76
|
+
let response;
|
|
77
|
+
try {
|
|
78
|
+
response = await fetch(url, options);
|
|
79
|
+
}
|
|
80
|
+
catch (error) {
|
|
81
|
+
throw new IdpUnavailableError(`Failed to fetch JWKS: ${error instanceof Error ? error.message : String(error)}`, { cause: error });
|
|
82
|
+
}
|
|
83
|
+
// Exactly 200, not any 2xx: jose's own JWKS fetch requires it (and OIDC
|
|
84
|
+
// Discovery 4.2 does for the discovery document). Anything else would
|
|
85
|
+
// surface from jose as a generic error and be mistaken for a bad token.
|
|
86
|
+
if (response.status !== 200) {
|
|
87
|
+
throw new IdpUnavailableError(`Failed to fetch JWKS: ${response.status} ${response.statusText}`);
|
|
88
|
+
}
|
|
89
|
+
let jwks;
|
|
90
|
+
try {
|
|
91
|
+
jwks = await response.json();
|
|
92
|
+
}
|
|
93
|
+
catch (error) {
|
|
94
|
+
throw new IdpUnavailableError('JWKS response is not valid JSON', {
|
|
95
|
+
cause: error,
|
|
96
|
+
});
|
|
97
|
+
}
|
|
98
|
+
// The original headers (content-length, content-encoding) don't describe
|
|
99
|
+
// the re-serialized body
|
|
100
|
+
return Response.json(jwks);
|
|
101
|
+
}
|
|
58
102
|
function normalizeAudienceClaim(value) {
|
|
59
103
|
if (typeof value === 'string') {
|
|
60
104
|
return [value];
|
|
@@ -119,86 +163,129 @@ async function verifySelfIssuedToken(jwt, payload, store, logger) {
|
|
|
119
163
|
* @param logger - Logger instance for logging debug and warning messages.
|
|
120
164
|
* @returns An AuthService implementation that verifies JWT tokens.
|
|
121
165
|
*/
|
|
122
|
-
export const jwtAuthService = (store, logger) =>
|
|
123
|
-
|
|
124
|
-
|
|
166
|
+
export const jwtAuthService = (store, logger) => {
|
|
167
|
+
// Reused across verifications so the IDP isn't contacted on every request
|
|
168
|
+
const oidc = createOidcClient();
|
|
169
|
+
// One per jwks_uri of the configured IDPs. jose caches the keys itself,
|
|
170
|
+
// it refetches them after its cacheMaxAge and early for an unknown kid
|
|
171
|
+
const remoteJwks = new Map();
|
|
172
|
+
function getJwks(jwksUri) {
|
|
173
|
+
let jwks = remoteJwks.get(jwksUri);
|
|
174
|
+
if (!jwks) {
|
|
175
|
+
const remote = createRemoteJWKSet(new URL(jwksUri), {
|
|
176
|
+
[customFetch]: fetchJwks,
|
|
177
|
+
});
|
|
178
|
+
jwks = async (protectedHeader, token) => {
|
|
179
|
+
try {
|
|
180
|
+
return await remote(protectedHeader, token);
|
|
181
|
+
}
|
|
182
|
+
catch (error) {
|
|
183
|
+
// Thrown by jose when a key of the fetched JWKS can't be used,
|
|
184
|
+
// drop invalid jwks from cache and keep session alive
|
|
185
|
+
if (error instanceof errors.JWKSInvalid) {
|
|
186
|
+
remoteJwks.delete(jwksUri);
|
|
187
|
+
throw new IdpUnavailableError(`JWKS response is not valid: ${error.message}`, { cause: error });
|
|
188
|
+
}
|
|
189
|
+
throw error;
|
|
190
|
+
}
|
|
191
|
+
};
|
|
192
|
+
remoteJwks.set(jwksUri, jwks);
|
|
193
|
+
}
|
|
194
|
+
return jwks;
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* Resolves the email of an already verified user from the userinfo
|
|
198
|
+
* endpoint. Failures are logged and resolve to undefined, the email is
|
|
199
|
+
* optional.
|
|
200
|
+
*/
|
|
201
|
+
async function resolveUserEmail(config, authContext) {
|
|
202
|
+
if (!config.userinfo_endpoint) {
|
|
125
203
|
return undefined;
|
|
126
204
|
}
|
|
127
|
-
const jwt = accessToken.split(' ')[1];
|
|
128
|
-
logger.debug({ jwt }, 'Verifying JWT token');
|
|
129
205
|
try {
|
|
130
|
-
const
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
if (!idp) {
|
|
142
|
-
logger.warn(`No identity provider found for issuer: ${iss}`);
|
|
143
|
-
return undefined;
|
|
144
|
-
}
|
|
145
|
-
if (!decoded.scope && !decoded.scp) {
|
|
146
|
-
logger.warn('JWT does not contain a scope claim');
|
|
147
|
-
return undefined;
|
|
148
|
-
}
|
|
149
|
-
if (idp.type == 'self_signed') {
|
|
150
|
-
return await verifySelfSignedToken(jwt, idp, store, logger);
|
|
151
|
-
}
|
|
152
|
-
logger.debug({ idp }, 'Using IDP');
|
|
153
|
-
const response = await fetch(idp.configUrl);
|
|
154
|
-
const config = await response.json();
|
|
155
|
-
const jwks = createRemoteJWKSet(new URL(config.jwks_uri));
|
|
156
|
-
const { payload } = await jwtVerify(jwt, jwks, {
|
|
157
|
-
algorithms: ['RS256'],
|
|
158
|
-
});
|
|
159
|
-
if (!payload.sub) {
|
|
160
|
-
return undefined;
|
|
161
|
-
}
|
|
162
|
-
const networks = await store.listNetworks();
|
|
163
|
-
const networksForIdp = networks.filter((n) => n.identityProviderId === idp.id);
|
|
164
|
-
const expectedAudiences = networksForIdp
|
|
165
|
-
.map((n) => n.auth.audience)
|
|
166
|
-
.filter((aud) => aud !== undefined && aud !== '');
|
|
167
|
-
if (expectedAudiences.length === 0) {
|
|
168
|
-
logger.warn(`No networks configured for IDP ${idp.id}, cannot validate audience`);
|
|
206
|
+
const userInfo = await oidc.fetchUserInfo(config.userinfo_endpoint, authContext.accessToken, authContext.userId);
|
|
207
|
+
return getEmail(userInfo.email);
|
|
208
|
+
}
|
|
209
|
+
catch (error) {
|
|
210
|
+
logger.warn({ err: error }, 'Failed to resolve user email from OIDC userinfo');
|
|
211
|
+
return undefined;
|
|
212
|
+
}
|
|
213
|
+
}
|
|
214
|
+
return {
|
|
215
|
+
verifyToken: async (accessToken) => {
|
|
216
|
+
if (!accessToken || !accessToken.startsWith('Bearer ')) {
|
|
169
217
|
return undefined;
|
|
170
218
|
}
|
|
171
|
-
const
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
219
|
+
const jwt = accessToken.split(' ')[1];
|
|
220
|
+
logger.debug({ jwt }, 'Verifying JWT token');
|
|
221
|
+
try {
|
|
222
|
+
const decoded = decodeJwt(jwt);
|
|
223
|
+
const iss = decoded.iss;
|
|
224
|
+
if (!iss) {
|
|
225
|
+
logger.warn('JWT does not contain an issuer');
|
|
226
|
+
return undefined;
|
|
227
|
+
}
|
|
228
|
+
if (iss === decoded.sub) {
|
|
229
|
+
return await verifySelfIssuedToken(jwt, decoded, store, logger);
|
|
230
|
+
}
|
|
231
|
+
const idps = await store.listIdps();
|
|
232
|
+
const idp = idps.find((i) => i.type !== 'self_issued' && i.issuer === iss);
|
|
233
|
+
if (!idp) {
|
|
234
|
+
logger.warn(`No identity provider found for issuer: ${iss}`);
|
|
235
|
+
return undefined;
|
|
236
|
+
}
|
|
237
|
+
if (!decoded.scope &&
|
|
238
|
+
!decoded.scp &&
|
|
239
|
+
!hasRolesClaim(decoded.roles)) {
|
|
240
|
+
logger.warn('JWT does not contain a scope or roles claim');
|
|
241
|
+
return undefined;
|
|
242
|
+
}
|
|
243
|
+
if (idp.type == 'self_signed') {
|
|
244
|
+
return await verifySelfSignedToken(jwt, idp, store, logger);
|
|
245
|
+
}
|
|
246
|
+
logger.debug({ idp }, 'Using IDP');
|
|
247
|
+
const config = await oidc.fetchDiscovery(idp.configUrl, idp.issuer);
|
|
248
|
+
const networks = await store.listNetworks();
|
|
249
|
+
const networksForIdp = networks.filter((n) => n.identityProviderId === idp.id);
|
|
250
|
+
const expectedAudiences = networksForIdp
|
|
251
|
+
.map((n) => n.auth.audience)
|
|
252
|
+
.filter((aud) => aud !== undefined && aud !== '');
|
|
253
|
+
if (expectedAudiences.length === 0) {
|
|
254
|
+
logger.warn(`No networks configured for IDP ${idp.id}, cannot validate audience`);
|
|
255
|
+
return undefined;
|
|
256
|
+
}
|
|
257
|
+
const jwks = getJwks(config.jwks_uri);
|
|
258
|
+
const { payload } = await jwtVerify(jwt, jwks, {
|
|
259
|
+
algorithms: ['RS256'],
|
|
260
|
+
issuer: idp.issuer,
|
|
261
|
+
audience: expectedAudiences,
|
|
262
|
+
});
|
|
263
|
+
if (!payload.sub) {
|
|
264
|
+
return undefined;
|
|
265
|
+
}
|
|
266
|
+
logger.debug({
|
|
267
|
+
userId: payload.sub,
|
|
268
|
+
accessToken: jwt,
|
|
269
|
+
email: getEmail(decoded.email),
|
|
270
|
+
}, 'JWT verified');
|
|
271
|
+
const authContext = {
|
|
272
|
+
userId: payload.sub,
|
|
273
|
+
accessToken: jwt,
|
|
274
|
+
};
|
|
275
|
+
const email = getEmail(decoded.email) ??
|
|
276
|
+
(await resolveUserEmail(config, authContext));
|
|
277
|
+
return email ? { ...authContext, email } : authContext;
|
|
175
278
|
}
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
279
|
+
catch (error) {
|
|
280
|
+
if (error instanceof IdpUnavailableError) {
|
|
281
|
+
logger.warn(error, `Failed to verify token: ${error.message}`);
|
|
282
|
+
throw error;
|
|
283
|
+
}
|
|
284
|
+
if (error instanceof Error) {
|
|
285
|
+
logger.warn(error, `Failed to verify token: ${error.message}`);
|
|
286
|
+
}
|
|
182
287
|
return undefined;
|
|
183
288
|
}
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
email: getEmail(decoded.email),
|
|
188
|
-
}, 'JWT verified');
|
|
189
|
-
const authContext = {
|
|
190
|
-
userId: payload.sub,
|
|
191
|
-
accessToken: jwt,
|
|
192
|
-
};
|
|
193
|
-
const email = getEmail(decoded.email) ??
|
|
194
|
-
(await resolveUserEmail(authContext, idp, logger));
|
|
195
|
-
return email ? { ...authContext, email } : authContext;
|
|
196
|
-
}
|
|
197
|
-
catch (error) {
|
|
198
|
-
if (error instanceof Error) {
|
|
199
|
-
logger.warn(error, `Failed to verify token: ${error.message}`);
|
|
200
|
-
}
|
|
201
|
-
return undefined;
|
|
202
|
-
}
|
|
203
|
-
},
|
|
204
|
-
});
|
|
289
|
+
},
|
|
290
|
+
};
|
|
291
|
+
};
|