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.

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

[Beats Management] Prevent timing attacks when checking auth tokens #19363

Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
21 changes: 21 additions & 0 deletions x-pack/plugins/beats/server/lib/crypto/are_tokens_equal.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/

import { timingSafeEqual } from 'crypto';

const RANDOM_TOKEN_1 = 'b48c4bda384a40cb91c6eb9b8849e77f';
const RANDOM_TOKEN_2 = '80a3819e3cd64f4399f1d4886be7a08b';

export function areTokensEqual(token1, token2) {
if ((typeof token1 !== 'string') || (typeof token2 !== 'string') || (token1.length !== token2.length)) {
// This prevents a more subtle timing attack where we know already the tokens aren't going to
// match but still we don't return fast. Instead we compare two pre-generated random tokens using
// the same comparison algorithm that we would use to compare two equal-length tokens.
return timingSafeEqual(Buffer.from(RANDOM_TOKEN_1, 'utf8'), Buffer.from(RANDOM_TOKEN_2, 'utf8'));
}

return timingSafeEqual(Buffer.from(token1, 'utf8'), Buffer.from(token2, 'utf8'));
}
7 changes: 7 additions & 0 deletions x-pack/plugins/beats/server/lib/crypto/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License;
* you may not use this file except in compliance with the Elastic License.
*/

export { areTokensEqual } from './are_tokens_equal';
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,14 @@ async function getEnrollmentToken(callWithInternalUser, enrollmentToken) {
};

const response = await callWithInternalUser('get', params);
return get(response, '_source.enrollment_token', {});
const token = get(response, '_source.enrollment_token', {});

// Elasticsearch might return fast if the token is not found. OR it might return fast
// if the token *is* found. Either way, an attacker could using a timing attack to figure
// out whether a token is valid or not. So we introduce a random delay in returning from
// this function to obscure the actual time it took for Elasticsearch to find the token.
const randomDelayInMs = 25 + Math.round(Math.random() * 200); // between 25 and 225 ms
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comment re. clamping. That's a lot harder to de-noise than this, see https://blog.ircmaxell.com/2014/11/its-all-about-time.html

This approach is basically spewing random numbers that even makes it reasonably easy to find the seed similar to this - https://franklinta.com/2014/08/31/predicting-the-next-math-random-in-java/

I don't think this timing sidechannel is a big deal (if the key isn't valid, it doesn't exist at this point?), but if we're going to remove it, I don't think random noise is the way :)

Copy link
Contributor Author

@ycombinator ycombinator May 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I'm starting to think protecting against a timing attack just to determine existence of an enrollment token is probably overkill in this case. That's because a) these enrollment tokens are meant to be short-lived and one-time use and b) they have an expiration time as well. In other words, by the time a timing attack might determine an enrollment token, it might've been used or have expired already.

So now I'm inclined to remove the random noise bit I implemented in 7af9c2d. @alexbrasetvik sounds like you're on board with that. @kobelb WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me!

return new Promise(resolve => setTimeout(() => resolve(token), randomDelayInMs));
}

function deleteUsedEnrollmentToken(callWithInternalUser, enrollmentToken) {
Expand Down Expand Up @@ -80,7 +87,7 @@ export function registerEnrollBeatRoute(server) {
try {
const enrollmentToken = request.headers['kbn-beats-enrollment-token'];
const { token, expires_on: expiresOn } = await getEnrollmentToken(callWithInternalUser, enrollmentToken);
if (!token || token !== enrollmentToken) {
if (!token) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the comparison here because it was unnecessary. The comparison was being done in ES when we tried to get a doc with _id = enrollment_token:${enrollmentToken} from ES.

return reply({ message: 'Invalid enrollment token' }).code(400);
}
if (moment(expiresOn).isBefore(moment())) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import { get } from 'lodash';
import { INDEX_NAMES } from '../../../common/constants';
import { callWithInternalUserFactory } from '../../lib/client';
import { wrapEsError } from '../../lib/error_wrappers';
import { areTokensEqual } from '../../lib/crypto';

async function getBeat(callWithInternalUser, beatId) {
const params = {
Expand Down Expand Up @@ -74,7 +75,7 @@ export function registerUpdateBeatRoute(server) {
return reply({ message: 'Beat not found' }).code(404);
}

const isAccessTokenValid = beat.access_token === request.headers['kbn-beats-access-token'];
const isAccessTokenValid = areTokensEqual(beat.access_token, request.headers['kbn-beats-access-token']);
if (!isAccessTokenValid) {
return reply({ message: 'Invalid access token' }).code(401);
}
Expand Down