@canton-network/wallet-gateway-remote 1.12.0 → 1.13.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.
Files changed (204) hide show
  1. package/README.md +105 -29
  2. package/dist/auth/jwt-auth-service.d.ts.map +1 -1
  3. package/dist/auth/jwt-auth-service.js +150 -77
  4. package/dist/config/Config.d.ts +146 -22
  5. package/dist/config/Config.d.ts.map +1 -1
  6. package/dist/config/Config.js +120 -6
  7. package/dist/config/ConfigUtils.d.ts.map +1 -1
  8. package/dist/config/ConfigUtils.js +3 -1
  9. package/dist/dapp-api/controller.d.ts.map +1 -1
  10. package/dist/dapp-api/controller.js +14 -19
  11. package/dist/dapp-api/rpc-gen/index.d.ts.map +1 -1
  12. package/dist/dapp-api/rpc-gen/typings.d.ts +3 -3
  13. package/dist/dapp-api/rpc-gen/typings.d.ts.map +1 -1
  14. package/dist/dapp-api/server.d.ts.map +1 -1
  15. package/dist/dapp-api/sse-sink.d.ts.map +1 -1
  16. package/dist/env.d.ts +1 -24
  17. package/dist/env.d.ts.map +1 -1
  18. package/dist/env.js +0 -23
  19. package/dist/example-config.d.ts +40 -4
  20. package/dist/example-config.d.ts.map +1 -1
  21. package/dist/example-config.js +44 -8
  22. package/dist/index.d.ts +3 -3
  23. package/dist/index.d.ts.map +1 -1
  24. package/dist/index.js +75 -28
  25. package/dist/init.d.ts.map +1 -1
  26. package/dist/init.js +24 -110
  27. package/dist/ledger/party-allocation-service.d.ts +1 -4
  28. package/dist/ledger/party-allocation-service.d.ts.map +1 -1
  29. package/dist/ledger/party-allocation-service.js +1 -3
  30. package/dist/ledger/self-issued-auth-service.d.ts +15 -15
  31. package/dist/ledger/self-issued-auth-service.d.ts.map +1 -1
  32. package/dist/ledger/self-issued-auth-service.js +44 -43
  33. package/dist/ledger/wallet-allocation/signing-providers/bitgo-wallet-allocator.d.ts.map +1 -1
  34. package/dist/ledger/wallet-allocation/signing-providers/bitgo-wallet-allocator.js +1 -1
  35. package/dist/ledger/wallet-allocation/signing-providers/blockdaemon-wallet-allocator.d.ts.map +1 -1
  36. package/dist/ledger/wallet-allocation/signing-providers/dfns-wallet-allocator.d.ts.map +1 -1
  37. package/dist/ledger/wallet-allocation/signing-providers/fireblocks-wallet-allocator.d.ts.map +1 -1
  38. package/dist/ledger/wallet-allocation/signing-providers/kernel-wallet-allocator.d.ts.map +1 -1
  39. package/dist/ledger/wallet-allocation/signing-providers/participant-wallet-allocator.d.ts.map +1 -1
  40. package/dist/ledger/wallet-allocation/signing-providers/securosys-wallet-allocator.d.ts.map +1 -1
  41. package/dist/ledger/wallet-allocation/wallet-allocation-service.d.ts +2 -2
  42. package/dist/ledger/wallet-allocation/wallet-allocation-service.d.ts.map +1 -1
  43. package/dist/ledger/wallet-allocation/wallet-allocation-service.js +2 -2
  44. package/dist/ledger/wallet-sync-service.d.ts +3 -0
  45. package/dist/ledger/wallet-sync-service.d.ts.map +1 -1
  46. package/dist/ledger/wallet-sync-service.js +143 -28
  47. package/dist/middleware/apiKeyAuth.d.ts.map +1 -1
  48. package/dist/middleware/apiKeyAuth.js +4 -8
  49. package/dist/middleware/errorHandler.d.ts +1 -1
  50. package/dist/middleware/errorHandler.d.ts.map +1 -1
  51. package/dist/middleware/jsonRpcHandler.d.ts.map +1 -1
  52. package/dist/middleware/jsonRpcHandler.js +3 -3
  53. package/dist/middleware/jwtAuth.d.ts +1 -1
  54. package/dist/middleware/jwtAuth.d.ts.map +1 -1
  55. package/dist/middleware/jwtAuth.js +17 -2
  56. package/dist/middleware/securityHeaders.d.ts.map +1 -1
  57. package/dist/middleware/sessionHandler.d.ts +3 -3
  58. package/dist/middleware/sessionHandler.d.ts.map +1 -1
  59. package/dist/middleware/sessionHandler.js +8 -8
  60. package/dist/signing/service-account-session.d.ts.map +1 -1
  61. package/dist/signing/service-account-session.js +1 -1
  62. package/dist/signing/signing-worker.d.ts +1 -1
  63. package/dist/signing/signing-worker.d.ts.map +1 -1
  64. package/dist/signing/signing-worker.js +2 -5
  65. package/dist/signing-providers-registration.d.ts +6 -0
  66. package/dist/signing-providers-registration.d.ts.map +1 -0
  67. package/dist/signing-providers-registration.js +216 -0
  68. package/dist/user-api/controller.d.ts +6 -3
  69. package/dist/user-api/controller.d.ts.map +1 -1
  70. package/dist/user-api/controller.js +218 -94
  71. package/dist/user-api/rpc-gen/index.d.ts +18 -9
  72. package/dist/user-api/rpc-gen/index.d.ts.map +1 -1
  73. package/dist/user-api/rpc-gen/index.js +6 -3
  74. package/dist/user-api/rpc-gen/schemas.d.ts.map +1 -1
  75. package/dist/user-api/rpc-gen/schemas.js +42 -10
  76. package/dist/user-api/rpc-gen/typings.d.ts +67 -45
  77. package/dist/user-api/rpc-gen/typings.d.ts.map +1 -1
  78. package/dist/user-api/server.d.ts.map +1 -1
  79. package/dist/web/frontend/404/index.html +2 -2
  80. package/dist/web/frontend/activities/index.html +3 -3
  81. package/dist/web/frontend/api-keys/add/index.html +2 -2
  82. package/dist/web/frontend/api-keys/index.html +2 -2
  83. package/dist/web/frontend/approve/index.html +4 -3
  84. package/dist/web/frontend/assets/404-D6hNG1H8.js +5 -0
  85. package/dist/web/frontend/assets/{activities-HZnPjlMp.js → activities-CSaNJ4Bw.js} +2 -2
  86. package/dist/web/frontend/assets/{addApiKey-BvkCtUF3.js → addApiKey-IKOYP6lC.js} +3 -3
  87. package/dist/web/frontend/assets/addIdentityProvider-CnRS1C3U.js +28 -0
  88. package/dist/web/frontend/assets/addNetwork-Wq0K3t5Z.js +38 -0
  89. package/dist/web/frontend/assets/{addParty-Cdoed_Yx.js → addParty-B0GaqKvG.js} +3 -2
  90. package/dist/web/frontend/assets/{apiKeys-BwV6ylWL.js → apiKeys-BgJyxg5r.js} +2 -2
  91. package/dist/web/frontend/assets/approve-kKlT_54l.js +27 -0
  92. package/dist/web/frontend/assets/callback-83Lr1QFW.js +7 -0
  93. package/dist/web/frontend/assets/common-BkYw_tO_.js +31 -0
  94. package/dist/web/frontend/assets/{editParty-OOjTHFay.js → editParty-DU9eMclk.js} +3 -2
  95. package/dist/web/frontend/assets/{identityProviders-BxJAq1Ne.js → identityProviders-sWmbKlSu.js} +2 -2
  96. package/dist/web/frontend/assets/{index-D1Brmwbg.js → index-AvzB2hln.js} +3 -3
  97. package/dist/web/frontend/assets/index-BF3EIXoM.js +2 -0
  98. package/dist/web/frontend/assets/{index-CG_aFABR.js → index-CGK8ht7_.js} +1 -1
  99. package/dist/web/frontend/assets/index-DRQ0oWml.js +4814 -0
  100. package/dist/web/frontend/assets/index-NgSpx7q_.js +3 -0
  101. package/dist/web/frontend/assets/login-BqK1nbQm.js +11 -0
  102. package/dist/web/frontend/assets/{networks-CBprjUF5.js → networks-C62lWsP4.js} +3 -3
  103. package/dist/web/frontend/assets/{reviewIdentityProvider-CCmKgN8N.js → reviewIdentityProvider-pILqo6EV.js} +4 -4
  104. package/dist/web/frontend/assets/{reviewNetwork-CX8Bmuf3.js → reviewNetwork-DZOWqkuG.js} +3 -3
  105. package/dist/web/frontend/assets/selfIssuedLogin-DarXIpvS.js +81 -0
  106. package/dist/web/frontend/assets/signMessage-k9b_lLxh.js +23 -0
  107. package/dist/web/frontend/callback/index.html +3 -2
  108. package/dist/web/frontend/identity-providers/add/index.html +2 -2
  109. package/dist/web/frontend/identity-providers/index.html +2 -2
  110. package/dist/web/frontend/identity-providers/review/index.html +2 -2
  111. package/dist/web/frontend/index.html +1 -1
  112. package/dist/web/frontend/login/index.html +3 -2
  113. package/dist/web/frontend/networks/add/index.html +2 -2
  114. package/dist/web/frontend/networks/index.html +2 -2
  115. package/dist/web/frontend/networks/review/index.html +2 -2
  116. package/dist/web/frontend/parties/add/index.html +5 -5
  117. package/dist/web/frontend/parties/edit/index.html +5 -5
  118. package/dist/web/frontend/parties/index.html +3 -3
  119. package/dist/web/frontend/{onboarding → self-issued-login}/index.html +6 -5
  120. package/dist/web/frontend/sign-message/index.html +2 -2
  121. package/dist/web/route-inputs.js +1 -1
  122. package/dist/web/server.d.ts.map +1 -1
  123. package/dist/web/server.js +1 -1
  124. package/package.json +49 -51
  125. package/dist/auth/jwt-auth-service.test.d.ts +0 -2
  126. package/dist/auth/jwt-auth-service.test.d.ts.map +0 -1
  127. package/dist/auth/jwt-auth-service.test.js +0 -659
  128. package/dist/config/Config.test.d.ts +0 -2
  129. package/dist/config/Config.test.d.ts.map +0 -1
  130. package/dist/config/Config.test.js +0 -26
  131. package/dist/dapp-api/controller.test.d.ts +0 -2
  132. package/dist/dapp-api/controller.test.d.ts.map +0 -1
  133. package/dist/dapp-api/controller.test.js +0 -531
  134. package/dist/dapp-api/server.test.d.ts +0 -2
  135. package/dist/dapp-api/server.test.d.ts.map +0 -1
  136. package/dist/dapp-api/server.test.js +0 -79
  137. package/dist/dapp-api/sse-sink.test.d.ts +0 -2
  138. package/dist/dapp-api/sse-sink.test.d.ts.map +0 -1
  139. package/dist/dapp-api/sse-sink.test.js +0 -30
  140. package/dist/ledger/party-allocation-service.test.d.ts +0 -2
  141. package/dist/ledger/party-allocation-service.test.d.ts.map +0 -1
  142. package/dist/ledger/party-allocation-service.test.js +0 -105
  143. package/dist/ledger/self-issued-auth-service.test.d.ts +0 -2
  144. package/dist/ledger/self-issued-auth-service.test.d.ts.map +0 -1
  145. package/dist/ledger/self-issued-auth-service.test.js +0 -454
  146. package/dist/ledger/wallet-allocation/wallet-allocation-service.test.d.ts +0 -2
  147. package/dist/ledger/wallet-allocation/wallet-allocation-service.test.d.ts.map +0 -1
  148. package/dist/ledger/wallet-allocation/wallet-allocation-service.test.js +0 -1005
  149. package/dist/ledger/wallet-sync-service.test.d.ts +0 -2
  150. package/dist/ledger/wallet-sync-service.test.d.ts.map +0 -1
  151. package/dist/ledger/wallet-sync-service.test.js +0 -1017
  152. package/dist/middleware/apiKeyAuth.test.d.ts +0 -2
  153. package/dist/middleware/apiKeyAuth.test.d.ts.map +0 -1
  154. package/dist/middleware/apiKeyAuth.test.js +0 -126
  155. package/dist/middleware/errorHandler.test.d.ts +0 -2
  156. package/dist/middleware/errorHandler.test.d.ts.map +0 -1
  157. package/dist/middleware/errorHandler.test.js +0 -138
  158. package/dist/middleware/jsonRpcHandler.test.d.ts +0 -2
  159. package/dist/middleware/jsonRpcHandler.test.d.ts.map +0 -1
  160. package/dist/middleware/jsonRpcHandler.test.js +0 -377
  161. package/dist/middleware/jwtAuth.test.d.ts +0 -2
  162. package/dist/middleware/jwtAuth.test.d.ts.map +0 -1
  163. package/dist/middleware/jwtAuth.test.js +0 -100
  164. package/dist/middleware/rateLimit.test.d.ts +0 -2
  165. package/dist/middleware/rateLimit.test.d.ts.map +0 -1
  166. package/dist/middleware/rateLimit.test.js +0 -56
  167. package/dist/middleware/securityHeaders.test.d.ts +0 -2
  168. package/dist/middleware/securityHeaders.test.d.ts.map +0 -1
  169. package/dist/middleware/securityHeaders.test.js +0 -18
  170. package/dist/middleware/sessionHandler.test.d.ts +0 -2
  171. package/dist/middleware/sessionHandler.test.d.ts.map +0 -1
  172. package/dist/middleware/sessionHandler.test.js +0 -215
  173. package/dist/signing/service-account-session.test.d.ts +0 -2
  174. package/dist/signing/service-account-session.test.d.ts.map +0 -1
  175. package/dist/signing/service-account-session.test.js +0 -88
  176. package/dist/signing/signing-worker.test.d.ts +0 -2
  177. package/dist/signing/signing-worker.test.d.ts.map +0 -1
  178. package/dist/signing/signing-worker.test.js +0 -158
  179. package/dist/user-api/controller.test.d.ts +0 -2
  180. package/dist/user-api/controller.test.d.ts.map +0 -1
  181. package/dist/user-api/controller.test.js +0 -1228
  182. package/dist/user-api/server.test.d.ts +0 -2
  183. package/dist/user-api/server.test.d.ts.map +0 -1
  184. package/dist/user-api/server.test.js +0 -117
  185. package/dist/user-api/token-network-matching.test.d.ts +0 -2
  186. package/dist/user-api/token-network-matching.test.d.ts.map +0 -1
  187. package/dist/user-api/token-network-matching.test.js +0 -66
  188. package/dist/utils.test.d.ts +0 -2
  189. package/dist/utils.test.d.ts.map +0 -1
  190. package/dist/utils.test.js +0 -24
  191. package/dist/web/frontend/assets/404-B1XXXMXN.js +0 -5
  192. package/dist/web/frontend/assets/addIdentityProvider-Dvjma837.js +0 -28
  193. package/dist/web/frontend/assets/addNetwork-Cahac0uo.js +0 -38
  194. package/dist/web/frontend/assets/approve-B0nIfe2y.js +0 -26
  195. package/dist/web/frontend/assets/callback-BieW5Ux2.js +0 -7
  196. package/dist/web/frontend/assets/common-Bv9twGrA.js +0 -31
  197. package/dist/web/frontend/assets/index-Bo6MnlYI.js +0 -2
  198. package/dist/web/frontend/assets/index-pMOoiNFq.js +0 -4887
  199. package/dist/web/frontend/assets/login-BHxgJEz_.js +0 -11
  200. package/dist/web/frontend/assets/onboarding-ChmWs-TC.js +0 -84
  201. package/dist/web/frontend/assets/signMessage-BN_6S5FV.js +0 -79
  202. package/dist/web/route-inputs.test.d.ts +0 -2
  203. package/dist/web/route-inputs.test.d.ts.map +0 -1
  204. 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
- ## Dfns
47
+ ## Signing providers
48
48
 
49
- 1. Create a service account in the Dfns dashboard with permissions to create and sign with Canton wallets, then download its credentials.
49
+ `signingProviders` configuration has two modes:
50
50
 
51
- 2. Set the following environment variables before starting the Gateway:
52
- - `DFNS_ORG_ID` — your Dfns organization ID (required; the driver is skipped if unset)
53
- - `DFNS_BASE_URL` — Dfns API base URL (defaults to `https://api.dfns.io`)
54
- - `DFNS_CRED_ID` — service account credential ID
55
- - `DFNS_PRIVATE_KEY` — service account private key (PEM)
56
- - `DFNS_AUTH_TOKEN` — service account auth token
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
- ## Fireblocks
58
+ ### Wallet Kernel
59
59
 
60
- 1. Complete steps 1–3 from the instructions at https://github.com/canton-network/wallet/tree/main/core/signing-fireblocks
60
+ **Gateway config:**
61
61
 
62
- 2. set the environment variable `FIREBLOCKS_API_KEY` (get it from `API User (ID)` column in fireblocks api users table).
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
- # Blockdaemon
65
+ **Environment variables:**
65
66
 
66
- 1. Create a system user in the Blockdaemon dashboard and save the API key displayed after successful creation.
67
+ - None
67
68
 
68
- 2. set the environment variables
69
+ ### Participant
69
70
 
70
- - `BLOCKDAEMON_API_URL` - The base URL for the Blockdaemon API
71
- - `BLOCKDAEMON_API_KEY` - Your Blockdaemon API key
71
+ **Gateway config:**
72
72
 
73
- ## Securosys
73
+ - `signingProviders.participant` - set it to `{}` to enable
74
74
 
75
- The Securosys TSB signing driver is registered at startup as `securosys` when
76
- `SECUROSYS_TSB_BASE_URL` is set. Set these environment variables before starting
77
- the Gateway:
75
+ **Environment variables:**
78
76
 
79
- - `SECUROSYS_TSB_BASE_URL` — TSB base URL
80
- - `SECUROSYS_TSB_KEY_MANAGEMENT_API_KEY` — `X-API-KEY` optional for key-management endpoints
81
- - `SECUROSYS_TSB_KEY_OPERATION_API_KEY` — `X-API-KEY` optional for signing/request endpoints
82
- - `SECUROSYS_TSB_BEARER_TOKEN` — optional bearer token for access-token mode
83
- - `SECUROSYS_TSB_MTLS_P12_PATH` — optional client PKCS#12/P12 file for mTLS
84
- - `SECUROSYS_TSB_MTLS_P12_PASSWORD` — optional PKCS#12/P12 password
85
- - `SECUROSYS_TSB_KEY_PASSWORD` — optional TSB key password
86
- - `SECUROSYS_TSB_SIGNATURE_ALGORITHM` — TSB signature algorithm, defaults to `EDDSA`
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,7 +174,7 @@ 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 `splice-wallet-kernel/wallet-gateway/test/config.json`, specify the connection settings for both databases (store and signingStore). The connection should look like this (it is important that `store.connection.database !== signingStore.connection.database !== 'postgres'`):
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
  {
@@ -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,EAGnB,MAAM,kCAAkC,CAAA;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mCAAmC,CAAA;AAU9D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAqKlC;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,KAAK,EAAE,QAAQ,MAAM,KAAG,WAiH5D,CAAA"}
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;AAkNlC;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,UAAW,KAAK,UAAU,MAAM,KAAG,WAkL7D,CAAA"}
@@ -1,7 +1,7 @@
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 { resolveUserEmail, } from '@canton-network/core-wallet-auth';
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;
@@ -55,6 +55,38 @@ function getSelfIssuedUserId(payload) {
55
55
  }
56
56
  return usr;
57
57
  }
58
+ /**
59
+ * Fetches the JWKS for `createRemoteJWKSet`. jose reports a failed JWKS
60
+ * request as a generic error, indistinguishable from a bad token, so fail with
61
+ * IdpUnavailableError instead.
62
+ */
63
+ async function fetchJwks(url, options) {
64
+ let response;
65
+ try {
66
+ response = await fetch(url, options);
67
+ }
68
+ catch (error) {
69
+ throw new IdpUnavailableError(`Failed to fetch JWKS: ${error instanceof Error ? error.message : String(error)}`, { cause: error });
70
+ }
71
+ // Exactly 200, not any 2xx: jose's own JWKS fetch requires it (and OIDC
72
+ // Discovery 4.2 does for the discovery document). Anything else would
73
+ // surface from jose as a generic error and be mistaken for a bad token.
74
+ if (response.status !== 200) {
75
+ throw new IdpUnavailableError(`Failed to fetch JWKS: ${response.status} ${response.statusText}`);
76
+ }
77
+ let jwks;
78
+ try {
79
+ jwks = await response.json();
80
+ }
81
+ catch (error) {
82
+ throw new IdpUnavailableError('JWKS response is not valid JSON', {
83
+ cause: error,
84
+ });
85
+ }
86
+ // The original headers (content-length, content-encoding) don't describe
87
+ // the re-serialized body
88
+ return Response.json(jwks);
89
+ }
58
90
  function normalizeAudienceClaim(value) {
59
91
  if (typeof value === 'string') {
60
92
  return [value];
@@ -119,86 +151,127 @@ async function verifySelfIssuedToken(jwt, payload, store, logger) {
119
151
  * @param logger - Logger instance for logging debug and warning messages.
120
152
  * @returns An AuthService implementation that verifies JWT tokens.
121
153
  */
122
- export const jwtAuthService = (store, logger) => ({
123
- verifyToken: async (accessToken) => {
124
- if (!accessToken || !accessToken.startsWith('Bearer ')) {
154
+ export const jwtAuthService = (store, logger) => {
155
+ // Reused across verifications so the IDP isn't contacted on every request
156
+ const oidc = createOidcClient();
157
+ // One per jwks_uri of the configured IDPs. jose caches the keys itself,
158
+ // it refetches them after its cacheMaxAge and early for an unknown kid
159
+ const remoteJwks = new Map();
160
+ function getJwks(jwksUri) {
161
+ let jwks = remoteJwks.get(jwksUri);
162
+ if (!jwks) {
163
+ const remote = createRemoteJWKSet(new URL(jwksUri), {
164
+ [customFetch]: fetchJwks,
165
+ });
166
+ jwks = async (protectedHeader, token) => {
167
+ try {
168
+ return await remote(protectedHeader, token);
169
+ }
170
+ catch (error) {
171
+ // Thrown by jose when a key of the fetched JWKS can't be used,
172
+ // drop invalid jwks from cache and keep session alive
173
+ if (error instanceof errors.JWKSInvalid) {
174
+ remoteJwks.delete(jwksUri);
175
+ throw new IdpUnavailableError(`JWKS response is not valid: ${error.message}`, { cause: error });
176
+ }
177
+ throw error;
178
+ }
179
+ };
180
+ remoteJwks.set(jwksUri, jwks);
181
+ }
182
+ return jwks;
183
+ }
184
+ /**
185
+ * Resolves the email of an already verified user from the userinfo
186
+ * endpoint. Failures are logged and resolve to undefined, the email is
187
+ * optional.
188
+ */
189
+ async function resolveUserEmail(config, authContext) {
190
+ if (!config.userinfo_endpoint) {
125
191
  return undefined;
126
192
  }
127
- const jwt = accessToken.split(' ')[1];
128
- logger.debug({ jwt }, 'Verifying JWT token');
129
193
  try {
130
- const decoded = decodeJwt(jwt);
131
- const iss = decoded.iss;
132
- if (!iss) {
133
- logger.warn('JWT does not contain an issuer');
134
- return undefined;
135
- }
136
- if (iss === decoded.sub) {
137
- return await verifySelfIssuedToken(jwt, decoded, store, logger);
138
- }
139
- const idps = await store.listIdps();
140
- const idp = idps.find((i) => i.type !== 'self_issued' && i.issuer === iss);
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`);
194
+ const userInfo = await oidc.fetchUserInfo(config.userinfo_endpoint, authContext.accessToken, authContext.userId);
195
+ return getEmail(userInfo.email);
196
+ }
197
+ catch (error) {
198
+ logger.warn({ err: error }, 'Failed to resolve user email from OIDC userinfo');
199
+ return undefined;
200
+ }
201
+ }
202
+ return {
203
+ verifyToken: async (accessToken) => {
204
+ if (!accessToken || !accessToken.startsWith('Bearer ')) {
169
205
  return undefined;
170
206
  }
171
- const tokenAudiences = normalizeAudienceClaim(payload.aud);
172
- if (tokenAudiences.length === 0) {
173
- logger.warn('JWT does not contain an audience claim');
174
- return undefined;
207
+ const jwt = accessToken.split(' ')[1];
208
+ logger.debug({ jwt }, 'Verifying JWT token');
209
+ try {
210
+ const decoded = decodeJwt(jwt);
211
+ const iss = decoded.iss;
212
+ if (!iss) {
213
+ logger.warn('JWT does not contain an issuer');
214
+ return undefined;
215
+ }
216
+ if (iss === decoded.sub) {
217
+ return await verifySelfIssuedToken(jwt, decoded, store, logger);
218
+ }
219
+ const idps = await store.listIdps();
220
+ const idp = idps.find((i) => i.type !== 'self_issued' && i.issuer === iss);
221
+ if (!idp) {
222
+ logger.warn(`No identity provider found for issuer: ${iss}`);
223
+ return undefined;
224
+ }
225
+ if (!decoded.scope && !decoded.scp) {
226
+ logger.warn('JWT does not contain a scope claim');
227
+ return undefined;
228
+ }
229
+ if (idp.type == 'self_signed') {
230
+ return await verifySelfSignedToken(jwt, idp, store, logger);
231
+ }
232
+ logger.debug({ idp }, 'Using IDP');
233
+ const config = await oidc.fetchDiscovery(idp.configUrl, idp.issuer);
234
+ const networks = await store.listNetworks();
235
+ const networksForIdp = networks.filter((n) => n.identityProviderId === idp.id);
236
+ const expectedAudiences = networksForIdp
237
+ .map((n) => n.auth.audience)
238
+ .filter((aud) => aud !== undefined && aud !== '');
239
+ if (expectedAudiences.length === 0) {
240
+ logger.warn(`No networks configured for IDP ${idp.id}, cannot validate audience`);
241
+ return undefined;
242
+ }
243
+ const jwks = getJwks(config.jwks_uri);
244
+ const { payload } = await jwtVerify(jwt, jwks, {
245
+ algorithms: ['RS256'],
246
+ issuer: idp.issuer,
247
+ audience: expectedAudiences,
248
+ });
249
+ if (!payload.sub) {
250
+ return undefined;
251
+ }
252
+ logger.debug({
253
+ userId: payload.sub,
254
+ accessToken: jwt,
255
+ email: getEmail(decoded.email),
256
+ }, 'JWT verified');
257
+ const authContext = {
258
+ userId: payload.sub,
259
+ accessToken: jwt,
260
+ };
261
+ const email = getEmail(decoded.email) ??
262
+ (await resolveUserEmail(config, authContext));
263
+ return email ? { ...authContext, email } : authContext;
175
264
  }
176
- const audMatch = tokenAudiences.some((aud) => expectedAudiences.includes(aud));
177
- if (!audMatch) {
178
- logger.warn({
179
- tokenAudiences,
180
- expectedAudiences,
181
- }, 'JWT audience does not match any configured network');
265
+ catch (error) {
266
+ if (error instanceof IdpUnavailableError) {
267
+ logger.warn(error, `Failed to verify token: ${error.message}`);
268
+ throw error;
269
+ }
270
+ if (error instanceof Error) {
271
+ logger.warn(error, `Failed to verify token: ${error.message}`);
272
+ }
182
273
  return undefined;
183
274
  }
184
- logger.debug({
185
- userId: payload.sub,
186
- accessToken: jwt,
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
- });
275
+ },
276
+ };
277
+ };