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

[csp] Telemetry for csp configuration #43223

Merged
merged 3 commits into from
Aug 14, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/*
* 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 sinon from 'sinon';
import {
DEFAULT_CSP_RULES,
epixa marked this conversation as resolved.
Show resolved Hide resolved
DEFAULT_CSP_STRICT,
DEFAULT_CSP_WARN_LEGACY_BROWSERS,
} from '../../../../../../../../src/legacy/server/csp';
import {
getMockCallWithInternal,
getMockKbnServer,
getMockTaskFetch,
} from '../../../../test_utils';
import { createCspCollector } from './csp_collector';

test('fetches whether strict mode is enabled', async () => {
const { collector, mockConfig } = setupCollector();

expect((await collector.fetch()).strict).toEqual(true);

mockConfig.get.withArgs('csp.strict').returns(false);
expect((await collector.fetch()).strict).toEqual(false);
});

test('fetches whether the legacy browser warning is enabled', async () => {
const { collector, mockConfig } = setupCollector();

expect((await collector.fetch()).warnLegacyBrowsers).toEqual(true);

mockConfig.get.withArgs('csp.warnLegacyBrowsers').returns(false);
expect((await collector.fetch()).warnLegacyBrowsers).toEqual(false);
});

test('fetches whether the csp rules have been changed or not', async () => {
const { collector, mockConfig } = setupCollector();

expect((await collector.fetch()).rulesChangedFromDefault).toEqual(false);

mockConfig.get.withArgs('csp.rules').returns(['not', 'default']);
expect((await collector.fetch()).rulesChangedFromDefault).toEqual(true);
});

test('does not include raw csp.rules', async () => {
epixa marked this conversation as resolved.
Show resolved Hide resolved
const { collector, mockConfig } = setupCollector();

expect(await collector.fetch()).not.toHaveProperty('rules');

mockConfig.get.withArgs('csp.rules').returns(['not', 'default']);
expect(await collector.fetch()).not.toHaveProperty('rules');
});

test('does not arbitrarily fetch other csp configurations (e.g. whitelist only)', async () => {
const { collector, mockConfig } = setupCollector();

mockConfig.get.withArgs('csp.foo').returns('bar');

expect(await collector.fetch()).not.toHaveProperty('foo');
});

function setupCollector() {
const mockConfig = { get: sinon.stub() };
mockConfig.get.withArgs('csp.rules').returns(DEFAULT_CSP_RULES);
mockConfig.get.withArgs('csp.strict').returns(DEFAULT_CSP_STRICT);
mockConfig.get.withArgs('csp.warnLegacyBrowsers').returns(DEFAULT_CSP_WARN_LEGACY_BROWSERS);

const mockKbnServer = getMockKbnServer(getMockCallWithInternal(), getMockTaskFetch(), mockConfig);

return { mockConfig, collector: createCspCollector(mockKbnServer) };
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/*
* 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 {
createCSPRuleString,
DEFAULT_CSP_RULES,
} from '../../../../../../../../src/legacy/server/csp';
import { HapiServer } from '../../../../';

export function createCspCollector(server: HapiServer) {
return {
type: 'csp',
isReady: () => true,
async fetch() {
const config = server.config();

// It's important that we do not send the value of csp.rules here as it
// can be customized with values that can be identifiable to given
// installs, such as URLs
const defaultRulesString = createCSPRuleString([...DEFAULT_CSP_RULES]);
epixa marked this conversation as resolved.
Show resolved Hide resolved
const actualRulesString = createCSPRuleString(config.get('csp.rules'));
epixa marked this conversation as resolved.
Show resolved Hide resolved

return {
strict: config.get('csp.strict'),
warnLegacyBrowsers: config.get('csp.warnLegacyBrowsers'),
rulesChangedFromDefault: defaultRulesString !== actualRulesString,
};
},
};
}

export function registerCspCollector(server: HapiServer): void {
const { usage } = server;
const collector = usage.collectorSet.makeUsageCollector(createCspCollector(server));
usage.collectorSet.register(collector);
}
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 { registerCspCollector } from './csp_collector';
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
*/

import { HapiServer } from '../../../';
import { registerCspCollector } from './csp';
import { registerVisualizationsCollector } from './visualizations/register_usage_collector';

export function registerCollectors(server: HapiServer) {
registerVisualizationsCollector(server);
registerCspCollector(server);
}
11 changes: 9 additions & 2 deletions x-pack/legacy/plugins/oss_telemetry/test_utils/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,16 @@ export const getMockTaskFetch = (docs: TaskInstance[] = defaultMockTaskDocs) =>
return () => Promise.resolve({ docs });
};

export const getMockConfig = () => {
return {
get: () => '',
};
};

export const getMockKbnServer = (
mockCallWithInternal = getMockCallWithInternal(),
mockTaskFetch = getMockTaskFetch()
mockTaskFetch = getMockTaskFetch(),
mockConfig = getMockConfig()
): HapiServer => ({
plugins: {
elasticsearch: {
Expand All @@ -53,6 +60,6 @@ export const getMockKbnServer = (
register: () => undefined,
},
},
config: () => ({ get: () => '' }),
config: () => mockConfig,
log: () => undefined,
});