Skip to content

fix(#11090): remove password from rate limiter lookup keys #11091

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

Open
YASHSHARMAOFFICIALLY wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(#11090): remove password from rate limiter lookup keys #11091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 0 additions & 6 deletions api/src/services/rate-limit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,10 @@ const getKeys = (req) => {
if (req.body?.user) {
keys.push(req.body.user);
}
if (req.body?.password) {
keys.push(req.body.password);
}
const basicAuth = auth.basicAuthCredentials(req);
if (basicAuth?.username) {
keys.push(basicAuth.username);
}
if (basicAuth?.password) {
keys.push(basicAuth.password);
}
return keys;
};

Expand Down
21 changes: 7 additions & 14 deletions api/tests/mocha/services/rate-limit.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,28 +59,24 @@ describe('rate-limit service', () => {
auth.basicAuthCredentials.returns({ username: 'basicuser', password: 'basicpass' });
rateLimit.get.withArgs('quay').resolves();
rateLimit.get.withArgs('key').resolves({ remainingPoints: 1 });
rateLimit.get.withArgs('kee').resolves({ remainingPoints: 1 });
rateLimit.get.withArgs('basicuser').resolves({ remainingPoints: 1 });
rateLimit.get.withArgs('basicpass').resolves({ remainingPoints: 1 });
const actual = await service.isLimited(req);
chai.expect(actual).to.be.false;
chai.expect(rateLimit.get.callCount).to.equal(5);
chai.expect(rateLimit.get.callCount).to.equal(3);
});

it('returns false when any limit reached', async () => {
it('returns true when any limit reached', async () => {
const req = {
ip: 'quay',
body: { user: 'key', password: 'kee' }
};
auth.basicAuthCredentials.returns({ username: 'basicuser', password: 'basicpass' });
rateLimit.get.withArgs('quay').resolves();
rateLimit.get.withArgs('key').resolves({ remainingPoints: 1 });
rateLimit.get.withArgs('kee').resolves({ remainingPoints: 0 });
rateLimit.get.withArgs('key').resolves({ remainingPoints: 0 });
rateLimit.get.withArgs('basicuser').resolves({ remainingPoints: 1 });
rateLimit.get.withArgs('basicpass').resolves({ remainingPoints: 1 });
const actual = await service.isLimited(req);
chai.expect(actual).to.be.true;
chai.expect(rateLimit.get.callCount).to.equal(3); // it short circuits when the first key is found to be limited
chai.expect(rateLimit.get.callCount).to.equal(2);
});

});
Expand All @@ -95,12 +91,10 @@ describe('rate-limit service', () => {
auth.basicAuthCredentials.returns({ username: 'basicuser', password: 'basicpass' });
rateLimit.consume.resolves();
await service.consume(req);
chai.expect(rateLimit.consume.callCount).to.equal(5);
chai.expect(rateLimit.consume.callCount).to.equal(3);
chai.expect(rateLimit.consume.args[0][0]).to.equal('quay');
chai.expect(rateLimit.consume.args[1][0]).to.equal('key');
chai.expect(rateLimit.consume.args[2][0]).to.equal('kee');
chai.expect(rateLimit.consume.args[3][0]).to.equal('basicuser');
chai.expect(rateLimit.consume.args[4][0]).to.equal('basicpass');
chai.expect(rateLimit.consume.args[2][0]).to.equal('basicuser');
});

it('ignores rejections', async () => {
Expand All @@ -110,9 +104,8 @@ describe('rate-limit service', () => {
};
rateLimit.consume.withArgs('quay').rejects(); // rate limit exceeded
rateLimit.consume.withArgs('key').resolves();
rateLimit.consume.withArgs('kee').resolves();
await service.consume(req);
chai.expect(rateLimit.consume.callCount).to.equal(3);
chai.expect(rateLimit.consume.callCount).to.equal(2);
});

});
Expand Down
Loading