Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added client attribution to SEP-10 helpers #720

Merged
merged 4 commits into from
Nov 4, 2021
Merged

Added client attribution to SEP-10 helpers #720

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
27fe915
added client attribution to SEP-10 helpers
JakeUrban Nov 3, 2021
96fb1ab
Update src/utils.ts
JakeUrban Nov 4, 2021
9278edc
make PR adjustments
JakeUrban Nov 4, 2021
2f1db82
update CHANGELOG.md
JakeUrban Nov 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 45 additions & 2 deletions src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ export namespace Utils {
networkPassphrase: string,
webAuthDomain: string,
memo: string | null = null,
clientDomain: string | null = null,
clientSigningKey: string | null = null,
): string {
if (clientAccountID.startsWith("M") && memo) {
throw Error("memo cannot be used if clientAccountID is a muxed account");
Expand Down Expand Up @@ -88,6 +90,19 @@ export namespace Utils {
}),
);

if (clientDomain) {
if (!clientSigningKey) {
throw Error("clientSigningKey is required if clientDomain is provided");
}
builder.addOperation(
Operation.manageData({
name: `client_domain`,
value: clientDomain,
source: clientSigningKey,
}),
);
}

if (memo) {
builder.addMemo(Memo.id(memo));
}
Expand Down Expand Up @@ -284,7 +299,7 @@ export namespace Utils {
"The transaction has operations that are not of type 'manageData'",
);
}
if (op.source !== serverAccountID) {
if (op.source !== serverAccountID && op.name !== "client_domain") {
throw new InvalidSep10ChallengeError(
"The transaction has operations that are unrecognized",
);
Expand Down Expand Up @@ -533,6 +548,14 @@ export namespace Utils {
);
}

let clientSigningKey;
for (const op of tx.operations) {
if (op.type === "manageData" && op.name === "client_domain") {
clientSigningKey = op.source;
break;
}
}
JakeUrban marked this conversation as resolved.
Show resolved Hide resolved

// Verify all the transaction's signers (server and client) in one
// hit. We do this in one hit here even though the server signature was
// checked in the ReadChallengeTx to ensure that every signature and signer
Expand All @@ -541,16 +564,32 @@ export namespace Utils {
serverKP.publicKey(),
...Array.from(clientSigners),
];
if (clientSigningKey) { allSigners.push(clientSigningKey); }

const signersFound: string[] = gatherTxSigners(tx, allSigners);

let serverSignatureFound = false;
let clientSigningKeySignatureFound = false;
for (const signer of signersFound) {
if (signer === serverKP.publicKey()) { serverSignatureFound = true; }
if (signer === clientSigningKey) { clientSigningKeySignatureFound = true; }
}

// Confirm we matched a signature to the server signer.
if (signersFound.indexOf(serverKP.publicKey()) === -1) {
if (!serverSignatureFound) {
throw new InvalidSep10ChallengeError(
"Transaction not signed by server: '" + serverKP.publicKey() + "'",
);
}

// Confirm we matched a signature to the client domain's signer
if (clientSigningKey && !clientSigningKeySignatureFound) {
throw new InvalidSep10ChallengeError(
"Transaction not signed by the source account of the 'client_domain' " +
"ManageData operation",
);
}

// Confirm we matched at least one given signer with the transaction signatures
if (signersFound.length === 1) {
throw new InvalidSep10ChallengeError(
Expand All @@ -567,6 +606,10 @@ export namespace Utils {

// Remove the server public key before returning
signersFound.splice(signersFound.indexOf(serverKP.publicKey()), 1);
if (clientSigningKey) {
// Remove the client domain public key public key before returning
signersFound.splice(signersFound.indexOf(clientSigningKey), 1);
}

return signersFound;
}
Expand Down
146 changes: 143 additions & 3 deletions test/unit/utils_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,27 +95,31 @@ describe('Utils', function() {

it('returns challenge which follows SEP0010 spec', function() {
let keypair = StellarSdk.Keypair.random();
let clientSigningKeypair = StellarSdk.Keypair.random();

const challenge = StellarSdk.Utils.buildChallengeTx(
keypair,
"GBDIT5GUJ7R5BXO3GJHFXJ6AZ5UQK6MNOIDMPQUSMXLIHTUNR2Q5CFNF",
"testanchor.stellar.org",
300,
StellarSdk.Networks.TESTNET,
"testanchor.stellar.org"
"testanchor.stellar.org",
null,
"testdomain",
clientSigningKeypair.publicKey()
);

const transaction = new StellarSdk.Transaction(challenge, StellarSdk.Networks.TESTNET);

expect(transaction.sequence).to.eql("0");
expect(transaction.source).to.eql(keypair.publicKey());
expect(transaction.operations.length).to.eql(2);
expect(transaction.operations.length).to.eql(3);

const { maxTime, minTime } = transaction.timeBounds;

expect(parseInt(maxTime) - parseInt(minTime)).to.eql(300);

const [ operation1, operation2 ] = transaction.operations;
const [ operation1, operation2, operation3 ] = transaction.operations;

expect(operation1.name).to.eql("testanchor.stellar.org auth");
expect(operation1.source).to.eql("GBDIT5GUJ7R5BXO3GJHFXJ6AZ5UQK6MNOIDMPQUSMXLIHTUNR2Q5CFNF");
Expand All @@ -127,6 +131,11 @@ describe('Utils', function() {
expect(operation2.source).to.eql(keypair.publicKey());
expect(operation2.type).to.eql("manageData");
expect(operation2.value.toString()).to.eql("testanchor.stellar.org");

expect(operation3.name).to.eql("client_domain");
expect(operation3.source).to.eql(clientSigningKeypair.publicKey());
expect(operation3.type).to.eql("manageData");
expect(operation3.value.toString()).to.eql("testdomain");
});

it('uses the passed-in timeout', function() {
Expand Down Expand Up @@ -169,6 +178,24 @@ describe('Utils', function() {
);
});

it("throws an error if clientSigningKey is not passed", function() {
expect(() =>
StellarSdk.Utils.buildChallengeTx(
StellarSdk.Keypair.random(),
StellarSdk.Keypair.random().publicKey(),
"testanchor.stellar.org",
600,
StellarSdk.Networks.TESTNET,
"testanchor.stellar.org",
null,
"testdomain",
null
)
).to.throw(
/clientSigningKey is required if clientDomain is provided/
);
});

});

describe("Utils.readChallengeTx", function() {
Expand Down Expand Up @@ -1424,6 +1451,31 @@ describe('Utils', function() {
memo: null
});
});

it("validates a challenge containing a 'client_domain' manageData operation", () => {
let keypair = StellarSdk.Keypair.random();
let clientSigningKeypair = StellarSdk.Keypair.random();

const challenge = StellarSdk.Utils.buildChallengeTx(
keypair,
"GBDIT5GUJ7R5BXO3GJHFXJ6AZ5UQK6MNOIDMPQUSMXLIHTUNR2Q5CFNF",
"testanchor.stellar.org",
300,
StellarSdk.Networks.TESTNET,
"testanchor.stellar.org",
null,
"testdomain",
clientSigningKeypair.publicKey()
);

StellarSdk.Utils.readChallengeTx(
JakeUrban marked this conversation as resolved.
Show resolved Hide resolved
challenge,
keypair.publicKey(),
StellarSdk.Networks.TESTNET,
"testanchor.stellar.org",
"testanchor.stellar.org"
);
});
});

describe("Utils.verifyChallengeTxThreshold", function() {
Expand Down Expand Up @@ -2387,6 +2439,94 @@ describe('Utils', function() {
/No verifiable client signers provided, at least one G... address must be provided/,
);
});

it("validates challenges containing client domain signers", () => {
const serverKP = StellarSdk.Keypair.random();
const clientKP = StellarSdk.Keypair.random();
const clientSigningKey = StellarSdk.Keypair.random();
const challenge = StellarSdk.Utils.buildChallengeTx(
serverKP,
clientKP.publicKey(),
"SDF",
300,
StellarSdk.Networks.TESTNET,
"testanchor.stellar.org",
null,
"testdomain",
clientSigningKey.publicKey()
);

clock.tick(200);

const transaction = new StellarSdk.Transaction(
challenge,
StellarSdk.Networks.TESTNET
);

transaction.sign(clientKP);
transaction.sign(clientSigningKey);

const signedChallenge = transaction
.toEnvelope()
.toXDR("base64")
.toString();

const signersFound = StellarSdk.Utils.verifyChallengeTxSigners(
signedChallenge,
serverKP.publicKey(),
StellarSdk.Networks.TESTNET,
[clientKP.publicKey()],
"SDF",
"testanchor.stellar.org"
);

expect(signersFound.indexOf(clientSigningKey.publicKey())).to.eql(-1);
});

it("throws an error if a challenge with a client_domain operation doesn't have a matching signature", () => {
const serverKP = StellarSdk.Keypair.random();
const clientKP = StellarSdk.Keypair.random();
const clientSigningKeypair = StellarSdk.Keypair.random();
const challenge = StellarSdk.Utils.buildChallengeTx(
serverKP,
clientKP.publicKey(),
"SDF",
300,
StellarSdk.Networks.TESTNET,
"testanchor.stellar.org",
null,
"testdomain",
clientSigningKeypair.publicKey()
);

clock.tick(200);

const transaction = new StellarSdk.Transaction(
challenge,
StellarSdk.Networks.TESTNET
);

transaction.sign(clientKP);

const signedChallenge = transaction
.toEnvelope()
.toXDR("base64")
.toString();

expect(() =>
StellarSdk.Utils.verifyChallengeTxSigners(
signedChallenge,
serverKP.publicKey(),
StellarSdk.Networks.TESTNET,
[clientKP.publicKey()],
"SDF",
"testanchor.stellar.org"
)
).to.throw(
StellarSdk.InvalidSep10ChallengeError,
/Transaction not signed by the source account of the 'client_domain' ManageData operation/
);
});
});

describe('Utils.verifyTxSignedBy', function() {
Expand Down