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

[Synthetics] Fix MTLS settings for synthetics service in Kibana #136267

Merged
merged 2 commits into from
Jul 18, 2022
Merged
Show file tree
Hide file tree
Changes from all 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import { Logger } from '@kbn/core/server';
import { ServiceAPIClient } from './service_api_client';
import { UptimeServerSetup } from '../legacy_uptime/lib/adapters';
import { ServiceConfig } from '../../common/config';

jest.mock('@kbn/server-http-tools', () => ({
SslConfig: jest.fn().mockImplementation(({ certificate, key }) => ({ certificate, key })),
}));

describe('getHttpsAgent', () => {
it('does not use certs if basic auth is set', () => {
const apiClient = new ServiceAPIClient(
jest.fn() as unknown as Logger,
{ username: 'u', password: 'p' },
{ isDev: true } as UptimeServerSetup
);
const { options: result } = apiClient.getHttpsAgent('https://localhost:10001');
expect(result).not.toHaveProperty('cert');
expect(result).not.toHaveProperty('key');
});

it('rejectUnauthorised is true for requests out of localhost even in dev', () => {
const apiClient = new ServiceAPIClient(
jest.fn() as unknown as Logger,
{ tls: { certificate: 'crt', key: 'k' } } as ServiceConfig,
{ isDev: true } as UptimeServerSetup
);

const { options: result } = apiClient.getHttpsAgent('https://example.com');
expect(result).toEqual(expect.objectContaining({ rejectUnauthorized: true }));
});

it('use rejectUnauthorised as true out of dev for localhost', () => {
const apiClient = new ServiceAPIClient(
jest.fn() as unknown as Logger,
{ tls: { certificate: 'crt', key: 'k' } } as ServiceConfig,
{ isDev: false } as UptimeServerSetup
);

const { options: result } = apiClient.getHttpsAgent('https://localhost:10001');
expect(result).toEqual(expect.objectContaining({ rejectUnauthorized: true }));
});

it('uses certs when defined', () => {
const apiClient = new ServiceAPIClient(
jest.fn() as unknown as Logger,
{ tls: { certificate: 'crt', key: 'k' } } as ServiceConfig,
{ isDev: false } as UptimeServerSetup
);

const { options: result } = apiClient.getHttpsAgent('https://localhost:10001');
expect(result).toEqual(expect.objectContaining({ cert: 'crt', key: 'k' }));
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -55,22 +55,28 @@ export class ServiceAPIClient {
this.server = server;
}

getHttpsAgent(url: string) {
getHttpsAgent(targetUrl: string) {
const parsedTargetUrl = new URL(targetUrl);

const rejectUnauthorized = parsedTargetUrl.hostname !== 'localhost' || !this.server.isDev;
const baseHttpsAgent = new https.Agent({ rejectUnauthorized });
Comment on lines +61 to +62
Copy link
Contributor

Choose a reason for hiding this comment

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

i think this will prevent us from using basic auth in staging environment against qa or staging env. which is probably fine.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for adding this. I think it's a good think to clarify:

-> We couldn't use basic auth on those environments anyway because the server itself (service) will refuse basic auth.

The only environment in which basic auth should be enabled is dev.

Therefore this doesn't change the behaviour of the client.


const config = this.config;
if (url !== this.config.devUrl && this.authorization && this.server.isDev) {
return;
}

// If using basic-auth, ignore certificate configs
if (this.authorization) return baseHttpsAgent;

if (config.tls && config.tls.certificate && config.tls.key) {
const tlsConfig = new SslConfig(config.tls);

const rejectUnauthorized = process.env.NODE_ENV === 'production';

return new https.Agent({
rejectUnauthorized,
cert: tlsConfig.certificate,
key: tlsConfig.key,
});
}

return baseHttpsAgent;
}

async post(data: ServiceData) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ describe('SyntheticsService', () => {
return {
id: `loc-${n}`,
label: `Location ${n}`,
url: `example.com/${n}`,
url: `https://example.com/${n}`,
geo: {
lat: 0,
lon: 0,
Expand Down