@stellar/typescript-wallet-sdk 4.0.0 → 4.0.1

package/CHANGELOG.MD

@@ -1,3 +1,16 @@
+# Release notes - Typescript Wallet SDK - 4.0.1
+
+### Changed
+* `Server.signChallengeTransaction`: validate the challenge with `WebAuth.readChallengeTx`, as `Sep10.sign` already does, and verify it was issued for `accountKp` before signing (#250)
+* `Server.signChallengeTransaction`: validation failures now throw `ChallengeValidationFailedError` instead of `ChallengeTxnInvalidSignatureError` (#250)
+
+### Added
+* Optional `homeDomain` on `SignChallengeTxnParams`, accepting a string or an array of strings for anchors serving multiple home domains. Defaults to `anchorDomain` (#250)
+* `ChallengeTxnClientAccountMismatchError`, exported via `Exceptions` (#250)
+
+### Deprecated
+* `ChallengeTxnInvalidSignatureError` is no longer thrown and will be removed in the next major release. Catch `ChallengeValidationFailedError` instead (#250)
+
 # Release notes - Typescript Wallet SDK - 4.0.0
 
 ### BREAKING CHANGES

package/lib/bundle.js

@@ -2234,7 +2234,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.Sep7UriTypeNotSupportedError = exports.Sep7LongMsgError = exports.Sep7InvalidUriError = exports.AuthHeaderClientDomainRequiredError = exports.AuthHeaderSigningKeypairRequiredError = exports.DomainSigningModifiedError = exports.DefaultSignerDomainAccountError = exports.SigningKeypairMissingSecretError = exports.InvalidJsonError = exports.UnknownAnchorTransactionError = exports.AllowHttpOnNonTestnetError = exports.ChallengeTxnInvalidSignatureError = exports.ChallengeTxnIncorrectSequenceError = exports.NetworkPassphraseMismatchError = exports.ChallengeValidationFailedError = exports.MissingSigningKeyError = exports.Sep38PriceOnlyOneAmountError = exports.NoAccountAndNoSponsorError = exports.DeviceKeyEqualsMasterKeyError = exports.NoAccountSignersError = exports.UnableToDeduceKeyError = exports.NoDeviceKeyForAccountError = exports.LostSignerKeyNotFound = exports.NotAllSignaturesFetchedError = exports.RecoveryIdentityNotFoundError = exports.RecoveryServerNotFoundError = exports.KYCServerNotFoundError = exports.CustomerNotFoundError = exports.Sep9InfoRequiredError = exports.WithdrawalTxMemoError = exports.PathPayOnlyOneAmountError = exports.WithdrawalTxMissingMemoError = exports.WithdrawalTxMissingDestinationError = exports.WithdrawalTxNotPendingUserTransferStartError = exports.OperationsLimitExceededError = exports.SignerRequiredError = exports.TransactionSubmitWithFeeIncreaseFailedError = exports.ExpiredTokenError = exports.InvalidTokenError = exports.MissingTokenError = exports.InsufficientStartingBalanceError = exports.TransactionSubmitFailedError = exports.AccountDoesNotExistError = exports.InvalidTransactionsResponseError = exports.InvalidTransactionResponseError = exports.MissingTransactionIdError = exports.ClientDomainWithMemoError = exports.InvalidMemoError = exports.AssetNotSupportedError = exports.ServerRequestFailedError = void 0;
+exports.Sep7LongMsgError = exports.Sep7InvalidUriError = exports.AuthHeaderClientDomainRequiredError = exports.AuthHeaderSigningKeypairRequiredError = exports.DomainSigningModifiedError = exports.DefaultSignerDomainAccountError = exports.SigningKeypairMissingSecretError = exports.InvalidJsonError = exports.UnknownAnchorTransactionError = exports.AllowHttpOnNonTestnetError = exports.ChallengeTxnClientAccountMismatchError = exports.ChallengeTxnInvalidSignatureError = exports.ChallengeTxnIncorrectSequenceError = exports.NetworkPassphraseMismatchError = exports.ChallengeValidationFailedError = exports.MissingSigningKeyError = exports.Sep38PriceOnlyOneAmountError = exports.NoAccountAndNoSponsorError = exports.DeviceKeyEqualsMasterKeyError = exports.NoAccountSignersError = exports.UnableToDeduceKeyError = exports.NoDeviceKeyForAccountError = exports.LostSignerKeyNotFound = exports.NotAllSignaturesFetchedError = exports.RecoveryIdentityNotFoundError = exports.RecoveryServerNotFoundError = exports.KYCServerNotFoundError = exports.CustomerNotFoundError = exports.Sep9InfoRequiredError = exports.WithdrawalTxMemoError = exports.PathPayOnlyOneAmountError = exports.WithdrawalTxMissingMemoError = exports.WithdrawalTxMissingDestinationError = exports.WithdrawalTxNotPendingUserTransferStartError = exports.OperationsLimitExceededError = exports.SignerRequiredError = exports.TransactionSubmitWithFeeIncreaseFailedError = exports.ExpiredTokenError = exports.InvalidTokenError = exports.MissingTokenError = exports.InsufficientStartingBalanceError = exports.TransactionSubmitFailedError = exports.AccountDoesNotExistError = exports.InvalidTransactionsResponseError = exports.InvalidTransactionResponseError = exports.MissingTransactionIdError = exports.ClientDomainWithMemoError = exports.InvalidMemoError = exports.AssetNotSupportedError = exports.ServerRequestFailedError = void 0;
+exports.Sep7UriTypeNotSupportedError = void 0;
 var axios_1 = __importDefault(__webpack_require__(/*! axios */ "../../node_modules/axios/dist/node/axios.cjs"));
 var Utils_1 = __webpack_require__(/*! ../Utils */ "./src/walletSdk/Utils/index.ts");
 var ServerRequestFailedError = /** @class */ (function (_super) {
@@ -2628,6 +2629,12 @@ var ChallengeTxnIncorrectSequenceError = /** @class */ (function (_super) {
     return ChallengeTxnIncorrectSequenceError;
 }(Error));
 exports.ChallengeTxnIncorrectSequenceError = ChallengeTxnIncorrectSequenceError;
+/**
+ * @deprecated No longer thrown. `Server.signChallengeTransaction` now validates
+ * challenges with `WebAuth.readChallengeTx` and reports every failure, including
+ * an invalid server signature, as `ChallengeValidationFailedError`. This class
+ * will be removed in the next major release.
+ */
 var ChallengeTxnInvalidSignatureError = /** @class */ (function (_super) {
     __extends(ChallengeTxnInvalidSignatureError, _super);
     function ChallengeTxnInvalidSignatureError() {
@@ -2638,6 +2645,17 @@ var ChallengeTxnInvalidSignatureError = /** @class */ (function (_super) {
     return ChallengeTxnInvalidSignatureError;
 }(Error));
 exports.ChallengeTxnInvalidSignatureError = ChallengeTxnInvalidSignatureError;
+var ChallengeTxnClientAccountMismatchError = /** @class */ (function (_super) {
+    __extends(ChallengeTxnClientAccountMismatchError, _super);
+    function ChallengeTxnClientAccountMismatchError(expected, received) {
+        var _this = _super.call(this, "Challenge transaction client account mismatch: expected \"".concat(expected, "\" ") +
+            "but challenge was issued for \"".concat(received, "\"")) || this;
+        Object.setPrototypeOf(_this, ChallengeTxnClientAccountMismatchError.prototype);
+        return _this;
+    }
+    return ChallengeTxnClientAccountMismatchError;
+}(Error));
+exports.ChallengeTxnClientAccountMismatchError = ChallengeTxnClientAccountMismatchError;
 var AllowHttpOnNonTestnetError = /** @class */ (function (_super) {
     __extends(AllowHttpOnNonTestnetError, _super);
     function AllowHttpOnNonTestnetError() {
@@ -4454,33 +4472,59 @@ var Utils_1 = __webpack_require__(/*! ../Utils */ "./src/walletSdk/Utils/index.t
 var Exceptions_1 = __webpack_require__(/*! ../Exceptions */ "./src/walletSdk/Exceptions/index.ts");
 /**
  * Helper method for signing a SEP-10 challenge transaction if valid.
+ *
+ * The challenge is validated with `WebAuth.readChallengeTx` from
+ * `@stellar/stellar-sdk` — the same validator used by `Sep10.sign()` — which
+ * checks the full SEP-10 structure and binds the challenge to the expected
+ * anchor: the transaction source must be the anchor's `SIGNING_KEY`, the
+ * `<home domain> auth` operation must match the expected home domain, and any
+ * `web_auth_domain` operation must match the host of the anchor's
+ * `WEB_AUTH_ENDPOINT` (falling back to `anchorDomain` when the TOML omits it).
+ * The client account the challenge was issued for is then checked against
+ * `accountKp`, so this helper only signs challenges meant for it. Muxed client
+ * accounts are supported: the comparison is made on the underlying `G...`
+ * address, since that is the key that signs. The muxed id itself is not pinned
+ * — a caller that needs to bind a specific subaccount should check the
+ * challenge's client account itself.
+ *
  * @param {SignChallengeTxnParams} params - The Authentication params.
  * @param {AccountKeypair} params.accountKp - Keypair for the Stellar account signing the transaction.
  * @param {string} [params.challengeTx] - The challenge transaction given by an anchor for authentication.
  * @param {string} [params.networkPassphrase] - The network passphrase for the network authenticating on.
  * @param {string} [params.anchorDomain] - Domain hosting stellar.toml file containing `SIGNING_KEY`.
+ * @param {string|string[]} [params.homeDomain] - Expected home domain(s) of the challenge. Defaults to `anchorDomain`.
  * @returns {Promise<SignChallengeTxnResponse>} The signed transaction.
  */
 var signChallengeTransaction = function (_a) {
-    var accountKp = _a.accountKp, challengeTx = _a.challengeTx, networkPassphrase = _a.networkPassphrase, anchorDomain = _a.anchorDomain;
+    var accountKp = _a.accountKp, challengeTx = _a.challengeTx, networkPassphrase = _a.networkPassphrase, anchorDomain = _a.anchorDomain, homeDomain = _a.homeDomain;
     return __awaiter(void 0, void 0, void 0, function () {
-        var tx, tomlResp, parsedToml, anchorKp, isValid;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
+        var parsedTx, tomlResp, _b, signingKey, webAuthEndpoint, tx, clientAccountID, webAuthDomain;
+        var _c;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
                 case 0:
-                    tx = stellar_sdk_1.TransactionBuilder.fromXDR(challengeTx, networkPassphrase);
-                    if (parseInt(tx.sequence) !== 0) {
+                    parsedTx = stellar_sdk_1.TransactionBuilder.fromXDR(challengeTx, networkPassphrase);
+                    if (parseInt(parsedTx.sequence) !== 0) {
                         throw new Exceptions_1.ChallengeTxnIncorrectSequenceError();
                     }
                     return [4 /*yield*/, stellar_sdk_1.StellarToml.Resolver.resolve(anchorDomain)];
                 case 1:
-                    tomlResp = _b.sent();
-                    parsedToml = (0, Utils_1.parseToml)(tomlResp);
-                    anchorKp = stellar_sdk_1.Keypair.fromPublicKey(parsedToml.signingKey);
-                    isValid = tx.signatures.length &&
-                        anchorKp.verify(tx.hash(), tx.signatures[0].signature());
-                    if (!isValid) {
-                        throw new Exceptions_1.ChallengeTxnInvalidSignatureError();
+                    tomlResp = _d.sent();
+                    _b = (0, Utils_1.parseToml)(tomlResp), signingKey = _b.signingKey, webAuthEndpoint = _b.webAuthEndpoint;
+                    try {
+                        webAuthDomain = webAuthEndpoint
+                            ? new URL(webAuthEndpoint).hostname
+                            : anchorDomain;
+                        (_c = stellar_sdk_1.WebAuth.readChallengeTx(challengeTx, signingKey, networkPassphrase, homeDomain !== null && homeDomain !== void 0 ? homeDomain : anchorDomain, webAuthDomain), tx = _c.tx, clientAccountID = _c.clientAccountID);
+                    }
+                    catch (e) {
+                        throw new Exceptions_1.ChallengeValidationFailedError(e instanceof Error ? e : new Error(String(e)));
+                    }
+                    // readChallengeTx returns the operation source verbatim, which is an `M...`
+                    // address for a muxed client account. accountKp.publicKey is always the
+                    // underlying `G...` key, so compare base addresses.
+                    if ((0, stellar_sdk_1.extractBaseAddress)(clientAccountID) !== accountKp.publicKey) {
+                        throw new Exceptions_1.ChallengeTxnClientAccountMismatchError(accountKp.publicKey, clientAccountID);
                     }
                     accountKp.sign(tx);
                     return [2 /*return*/, {
@@ -54261,7 +54305,7 @@ function includes(array, value) {
 /***/ ((module) => {
 
 "use strict";
-module.exports = JSON.parse('{"name":"@stellar/typescript-wallet-sdk","version":"4.0.0","engines":{"node":">=22"},"browser":"./lib/bundle_browser.js","main":"./lib/bundle.js","types":"./lib/index.d.ts","license":"Apache-2.0","private":false,"devDependencies":{"@babel/preset-env":"^7.20.2","@babel/preset-typescript":"^7.23.3","@stellar/prettier-config":"^1.0.1","@stellar/tsconfig":"^1.0.2","@types/jest":"^29.4.0","@types/lodash":"^4.14.194","@types/sinon":"^10.0.15","@typescript-eslint/eslint-plugin":"^6.7.5","@typescript-eslint/parser":"^6.7.5","babel-jest":"^29.4.1","crypto-browserify":"^3.12.0","dotenv":"^16.3.1","eslint":"^8.51.0","eslint-config-prettier":"^9.0.0","eslint-plugin-jsdoc":"^46.8.2","express":"^4.19.2","husky":"^8.0.0","jest":"^29.4.1","lint-staged":"^14.0.1","npm-run-all":"^4.1.5","playwright":"^1.43.1","prettier":"^2.0.5","pretty-quick":"^2.0.1","process":"^0.11.10","sinon":"^15.1.0","smol-toml":"^1.7.1","stream-browserify":"^3.0.0","ts-jest":"^29.0.5","ts-loader":"^9.4.2","ts-node":"^10.9.1","tslib":"^2.5.0","typescript":"^5.0.4","webpack":"^5.83.1","webpack-cli":"^5.1.1"},"dependencies":{"@stablelib/base64":"^2.0.0","@stablelib/utf8":"^2.0.0","@stellar/stellar-sdk":"16.2.0","axios":"^1.4.0","base64url":"^3.0.1","https-browserify":"^1.0.0","jws":"^4.0.0","lodash":"^4.17.21","query-string":"^7.1.3","stream-http":"^3.2.0","tweetnacl":"^1.0.3","url":"^0.11.0","util":"^0.12.5","utility-types":"^3.10.0","vm-browserify":"^1.1.2"},"scripts":{"test":"jest --watchAll","test:ci":"jest --ci","test:e2e:ci":"jest --config jest.e2e.config.js --ci","test:recovery:ci":"jest --config jest.integration.config.js recovery.test.ts --ci","test:anchorplatform:ci":"yarn jest --config jest.integration.config.js anchorplatform.test.ts --ci","build:web":"webpack --config webpack.config.js","build:node":"webpack --env NODE=true --config webpack.config.js","build":"run-p build:web build:node","example:sep10Server":"ts-node examples/sep10/sep10Server.ts","example:sep10Wallet":"ts-node examples/sep10/sep10Wallet.ts","example:sep24":"ts-node examples/sep24/sep24.ts","example:sep12":"ts-node examples/sep12/sep12.ts"}}');
+module.exports = JSON.parse('{"name":"@stellar/typescript-wallet-sdk","version":"4.0.1","engines":{"node":">=22"},"browser":"./lib/bundle_browser.js","main":"./lib/bundle.js","types":"./lib/index.d.ts","license":"Apache-2.0","private":false,"devDependencies":{"@babel/preset-env":"^7.20.2","@babel/preset-typescript":"^7.23.3","@stellar/prettier-config":"^1.0.1","@stellar/tsconfig":"^1.0.2","@types/jest":"^29.4.0","@types/lodash":"^4.14.194","@types/sinon":"^10.0.15","@typescript-eslint/eslint-plugin":"^6.7.5","@typescript-eslint/parser":"^6.7.5","babel-jest":"^29.4.1","crypto-browserify":"^3.12.0","dotenv":"^16.3.1","eslint":"^8.51.0","eslint-config-prettier":"^9.0.0","eslint-plugin-jsdoc":"^46.8.2","express":"^4.19.2","husky":"^8.0.0","jest":"^29.4.1","lint-staged":"^14.0.1","npm-run-all":"^4.1.5","playwright":"^1.43.1","prettier":"^2.0.5","pretty-quick":"^2.0.1","process":"^0.11.10","sinon":"^15.1.0","smol-toml":"^1.7.1","stream-browserify":"^3.0.0","ts-jest":"^29.0.5","ts-loader":"^9.4.2","ts-node":"^10.9.1","tslib":"^2.5.0","typescript":"^5.0.4","webpack":"^5.83.1","webpack-cli":"^5.1.1"},"dependencies":{"@stablelib/base64":"^2.0.0","@stablelib/utf8":"^2.0.0","@stellar/stellar-sdk":"16.2.0","axios":"^1.4.0","base64url":"^3.0.1","https-browserify":"^1.0.0","jws":"^4.0.0","lodash":"^4.17.21","query-string":"^7.1.3","stream-http":"^3.2.0","tweetnacl":"^1.0.3","url":"^0.11.0","util":"^0.12.5","utility-types":"^3.10.0","vm-browserify":"^1.1.2"},"scripts":{"test":"jest --watchAll","test:ci":"jest --ci","test:e2e:ci":"jest --config jest.e2e.config.js --ci","test:recovery:ci":"jest --config jest.integration.config.js recovery.test.ts --ci","test:anchorplatform:ci":"yarn jest --config jest.integration.config.js anchorplatform.test.ts --ci","build:web":"webpack --config webpack.config.js","build:node":"webpack --env NODE=true --config webpack.config.js","build":"run-p build:web build:node","example:sep10Server":"ts-node examples/sep10/sep10Server.ts","example:sep10Wallet":"ts-node examples/sep10/sep10Wallet.ts","example:sep24":"ts-node examples/sep24/sep24.ts","example:sep12":"ts-node examples/sep12/sep12.ts"}}');
 
 /***/ }),