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.

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

[Security Solution][Detections] Adds more granular validation for nested fields #92041

Merged
merged 3 commits into from
Feb 20, 2021
Merged

[Security Solution][Detections] Adds more granular validation for nested fields #92041

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
62d0152
adds more granual validation for nested fields
dplumlee Feb 19, 2021
57e0237
changes schema name
dplumlee Feb 19, 2021
932d97e
simpler return type
dplumlee Feb 19, 2021
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
3 changes: 2 additions & 1 deletion x-pack/plugins/lists/common/schemas/types/non_empty_nested_entries_array.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ import { entriesMatchAny } from './entry_match_any';
import { entriesMatch } from './entry_match';
import { entriesExists } from './entry_exists';

export const nestedEntriesArray = t.array(t.union([entriesMatch, entriesMatchAny, entriesExists]));
export const nestedEntries = t.union([entriesMatch, entriesMatchAny, entriesExists]);
dplumlee marked this conversation as resolved.
Show resolved Hide resolved
export const nestedEntriesArray = t.array(nestedEntries);
export type NestedEntriesArray = t.TypeOf<typeof nestedEntriesArray>;

/**
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/lists/common/shared_exports.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ export {
listSchema,
entry,
entriesNested,
nestedEntries,
dplumlee marked this conversation as resolved.
Show resolved Hide resolved
entriesMatch,
entriesMatchAny,
entriesExists,
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/security_solution/common/shared_imports.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ export {
listSchema,
entry,
entriesNested,
nestedEntries,
entriesMatch,
entriesMatchAny,
entriesExists,
Expand Down
46 changes: 46 additions & 0 deletions x-pack/plugins/security_solution/public/common/components/exceptions/helpers.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,52 @@ describe('Exception helpers', () => {
expect(output).toEqual([{ ...getExceptionListItemSchemaMock() }]);
});

test('it removes the "nested" entry entries with "value" of empty string', () => {
const { entries, ...rest } = { ...getExceptionListItemSchemaMock() };
const mockEmptyException: EntryNested = {
field: 'host.name',
type: OperatorTypeEnum.NESTED,
entries: [getEntryMatchMock(), { ...getEntryMatchMock(), value: '' }],
};
const output: Array<
ExceptionListItemSchema | CreateExceptionListItemSchema
> = filterExceptionItems([
{
...rest,
entries: [...entries, mockEmptyException],
},
]);

expect(output).toEqual([
{
...getExceptionListItemSchemaMock(),
entries: [
...getExceptionListItemSchemaMock().entries,
{ ...mockEmptyException, entries: [getEntryMatchMock()] },
],
},
]);
});

test('it removes the "nested" entry item if all its entries are invalid', () => {
const { entries, ...rest } = { ...getExceptionListItemSchemaMock() };
const mockEmptyException: EntryNested = {
field: 'host.name',
type: OperatorTypeEnum.NESTED,
entries: [{ ...getEntryMatchMock(), value: '' }],
};
const output: Array<
ExceptionListItemSchema | CreateExceptionListItemSchema
> = filterExceptionItems([
{
...rest,
entries: [...entries, mockEmptyException],
},
]);

expect(output).toEqual([{ ...getExceptionListItemSchemaMock() }]);
});

test('it removes `temporaryId` from items', () => {
const { meta, ...rest } = getNewExceptionItem({
listId: '123',
Expand Down
38 changes: 29 additions & 9 deletions x-pack/plugins/security_solution/public/common/components/exceptions/helpers.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import {
comment,
entry,
entriesNested,
nestedEntries,
createExceptionListItemSchema,
exceptionListItemSchema,
UpdateExceptionListItemSchema,
Expand Down Expand Up @@ -173,16 +174,35 @@ export const filterExceptionItems = (
): Array<ExceptionListItemSchema | CreateExceptionListItemSchema> => {
return exceptions.reduce<Array<ExceptionListItemSchema | CreateExceptionListItemSchema>>(
(acc, exception) => {
const entries = exception.entries.filter((t) => {
const [validatedEntry] = validate(t, entry);
const [validatedNestedEntry] = validate(t, entriesNested);
const entries = exception.entries.reduce<BuilderEntry[]>((nestedAcc, singleEntry) => {
if (singleEntry.type === 'nested') {
const nestedEntriesArray = singleEntry.entries.filter((singleNestedEntry) => {
const [validatedNestedEntry] = validate(singleNestedEntry, nestedEntries);

if (validatedNestedEntry != null) {
return true;
}
return false;
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: could just replace with return validatedNestedEntry != null

});

const [validatedNestedEntry] = validate(
{ ...singleEntry, entries: nestedEntriesArray },
entriesNested
);

if (validatedNestedEntry != null) {
return [...nestedAcc, validatedNestedEntry];
}
return nestedAcc;
} else {
const [validatedEntry] = validate(singleEntry, entry);

if (validatedEntry != null || validatedNestedEntry != null) {
return true;
if (validatedEntry != null) {
return [...nestedAcc, validatedEntry];
}
return nestedAcc;
}

return false;
});
}, []);

const item = { ...exception, entries };

Expand Down Expand Up @@ -401,7 +421,7 @@ export const getCodeSignatureValue = (
return codeSignature.map((signature) => {
return {
subjectName: signature.subject_name ?? '',
trusted: signature.trusted ?? '',
trusted: signature.trusted.toString() ?? '',
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixes another bug where we were passing in a boolean type when the builder expected a string so it was marking it as invalid

};
});
} else {
Expand Down