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

[Connectors] Checking for undefined config and secrets during connector validation #122696

Merged
merged 6 commits into from
Jan 19, 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
2 changes: 1 addition & 1 deletion x-pack/plugins/actions/server/lib/action_executor.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ test('throws an error when connector is invalid', async () => {
actionId: '1',
status: 'error',
retry: false,
message: `error validating action type connector: error`,
message: `error validating action type connector: config must be defined`,
});
});

Expand Down
57 changes: 53 additions & 4 deletions x-pack/plugins/actions/server/lib/validate_with_schema.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ test('should validate when validators return incoming value', () => {
params: selfValidator,
config: selfValidator,
secrets: selfValidator,
connector: () => null,
},
};

Expand All @@ -83,7 +84,7 @@ test('should validate when validators return incoming value', () => {
result = validateSecrets(actionType, testValue);
expect(result).toEqual(testValue);

result = validateConnector(actionType, { config: testValue });
result = validateConnector(actionType, { config: testValue, secrets: { user: 'test' } });
expect(result).toBeNull();
});

Expand All @@ -99,6 +100,7 @@ test('should validate when validators return different values', () => {
params: selfValidator,
config: selfValidator,
secrets: selfValidator,
connector: () => null,
},
};

Expand Down Expand Up @@ -133,9 +135,7 @@ test('should throw with expected error when validators fail', () => {
params: erroringValidator,
config: erroringValidator,
secrets: erroringValidator,
connector: () => {
return 'test error';
},
connector: () => 'test error',
},
};

Expand Down Expand Up @@ -180,3 +180,52 @@ test('should work with @kbn/config-schema', () => {
`"error validating action params: [foo]: expected value of type [string] but got [undefined]"`
);
});

describe('validateConnectors', () => {
const testValue = { any: ['old', 'thing'] };
const selfValidator = { validate: (value: Record<string, unknown>) => value };
const actionType: ActionType = {
id: 'foo',
name: 'bar',
minimumLicenseRequired: 'basic',
executor,
validate: {
params: selfValidator,
config: selfValidator,
secrets: selfValidator,
connector: () => null,
},
};

test('should throw error when connector config is null', () => {
expect(() =>
validateConnector(actionType, { config: null, secrets: { user: 'test' } })
).toThrowErrorMatchingInlineSnapshot(
`"error validating action type connector: config must be defined"`
);
});

test('should throw error when connector config is undefined', () => {
expect(() =>
validateConnector(actionType, { config: undefined, secrets: { user: 'test' } })
).toThrowErrorMatchingInlineSnapshot(
`"error validating action type connector: config must be defined"`
);
});

test('should throw error when connector secrets is null', () => {
expect(() =>
validateConnector(actionType, { config: testValue, secrets: null })
).toThrowErrorMatchingInlineSnapshot(
`"error validating action type connector: secrets must be defined"`
);
});

test('should throw error when connector secrets is undefined', () => {
expect(() =>
validateConnector(actionType, { config: testValue, secrets: undefined })
).toThrowErrorMatchingInlineSnapshot(
`"error validating action type connector: secrets must be defined"`
);
});
});
20 changes: 16 additions & 4 deletions x-pack/plugins/actions/server/lib/validate_with_schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,22 @@ export function validateConnector<
ExecutorResultData = void
>(actionType: ActionType<Config, Secrets, Params, ExecutorResultData>, value: unknown) {
if (actionType.validate && actionType.validate.connector) {
const connectorValue = value as { config: Config; secrets: Secrets };
const result = actionType.validate.connector(connectorValue.config, connectorValue.secrets);
if (result !== null) {
throw Boom.badRequest(`error validating action type connector: ${result}`);
try {
const connectorValue = value as { config: Config; secrets: Secrets };

// Connector config and secrets should be defined
if (connectorValue.config == null) {
throw new Error(`config must be defined`);
}
if (connectorValue.secrets == null) {
throw new Error(`secrets must be defined`);
}
const result = actionType.validate.connector(connectorValue.config, connectorValue.secrets);
if (result !== null) {
throw new Error(result);
}
} catch (err) {
throw Boom.badRequest(`error validating action type connector: ${err.message}`);
}
}
return null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,35 @@ export default function createGetTests({ getService }: FtrProviderContext) {
expect(connectorWithoutService.body.config).key('service');
expect(connectorWithoutService.body.config.service).to.eql('other');
});

it('decryption error during migration', async () => {
const badEmailConnector = await supertest.get(
`${getUrlPrefix(``)}/api/actions/connector/0f8f2810-0a59-11ec-9a7c-fd0c2b83ff7d`
);

expect(badEmailConnector.status).to.eql(200);
expect(badEmailConnector.body.secrets).to.eql(undefined);

const response = await supertest
.post(
`${getUrlPrefix(``)}/api/actions/connector/0f8f2810-0a59-11ec-9a7c-fd0c2b83ff7d/_execute`
)
.set('kbn-xsrf', 'foo')
.send({
params: {
message: 'am i working?',
to: ['[email protected]'],
subject: 'test',
},
});

expect(response.status).to.eql(200);
expect(response.body).to.eql({
connector_id: '0f8f2810-0a59-11ec-9a7c-fd0c2b83ff7d',
status: 'error',
message: `error validating action type connector: secrets must be defined`,
retry: false,
});
});
});
}
32 changes: 32 additions & 0 deletions x-pack/test/functional/es_archives/actions/data.json
Original file line number Diff line number Diff line change
Expand Up @@ -174,3 +174,35 @@
}
}
}

{
"type": "doc",
"value": {
"id": "action:0f8f2810-0a59-11ec-9a7c-fd0c2b83ff7d",
"index": ".kibana_1",
"source": {
"action": {
"actionTypeId" : ".email",
"name" : "test email connector cant decrypt",
"isMissingSecrets" : false,
"config" : {
"hasAuth" : true,
"from" : "[email protected]",
"host" : "some.non.existent.com",
"port" : 465,
"service" : "other",
"secure" : true
},
"secrets" : "V2EJEtTv3yTFi1kdglhNahasdfnKYWCS+J7aWCJQU+eEqGPZEz6n7G1NsBWoh7IY0FteLTilTteQXyY/Eg3k/7bb0G8Mz+WBZ1mRvUggGTFqgoOptyUsvHoBhv0R/1bCTCabN3Pe88AfnC+VDXqwuMifpmgKEEsKF3H8VONv7TYO02FW"
},
"migrationVersion": {
"action": "7.14.0"
},
"coreMigrationVersion" : "7.15.0",
"references": [
],
"type": "action",
"updated_at": "2021-08-31T12:43:37.117Z"
}
}
}