From 25ec6254ea89559636053998cf20fb53c2a212ec Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Thu, 16 Jun 2022 11:31:42 -0500 Subject: [PATCH 1/3] Add type annotations to `scripts.generator` modules (#1950) * add type hints to csv_generator * introduce csv generator unit tests * finish adding types to intermediate generator * returns a tuple * add type hints to beats generator * unused import * add type hints to elasticsearch generator * use snake_case * changelog --- CHANGELOG.next.md | 2 + scripts/generators/beats.py | 84 ++++++++++++---- scripts/generators/csv_generator.py | 38 ++++--- scripts/generators/es_template.py | 120 +++++++++++++++++------ scripts/generators/intermediate_files.py | 20 ++-- scripts/schema/subset_filter.py | 3 +- scripts/tests/test_es_template.py | 6 +- scripts/tests/unit/test_csv_generator.py | 67 +++++++++++++ 8 files changed, 263 insertions(+), 77 deletions(-) create mode 100644 scripts/tests/unit/test_csv_generator.py diff --git a/CHANGELOG.next.md b/CHANGELOG.next.md index 74b160883f..3238f123e8 100644 --- a/CHANGELOG.next.md +++ b/CHANGELOG.next.md @@ -60,6 +60,8 @@ Thanks, you're awesome :-) --> #### Improvements +* Additional type annotations. #1950 + #### Deprecated ## 8.3.0 (Hard Feature Freeze) diff --git a/scripts/generators/beats.py b/scripts/generators/beats.py index 1929344d85..b6422a86fd 100644 --- a/scripts/generators/beats.py +++ b/scripts/generators/beats.py @@ -17,19 +17,33 @@ from os.path import join from collections import OrderedDict +from typing import ( + Dict, + List, + OrderedDict, +) + from generators import ecs_helpers +from _types import ( + Field, + FieldNestedEntry, +) -def generate(ecs_nested, ecs_version, out_dir): +def generate( + ecs_nested: Dict[str, FieldNestedEntry], + ecs_version: str, + out_dir: str +) -> None: # base first - beats_fields = fieldset_field_array(ecs_nested['base']['fields'], ecs_nested['base']['prefix']) + beats_fields: List[OrderedDict] = fieldset_field_array(ecs_nested['base']['fields'], ecs_nested['base']['prefix']) - allowed_fieldset_keys = ['name', 'title', 'group', 'description', 'footnote', 'type'] + allowed_fieldset_keys: List[str] = ['name', 'title', 'group', 'description', 'footnote', 'type'] # other fieldsets for fieldset_name in sorted(ecs_nested): if 'base' == fieldset_name: continue - fieldset = ecs_nested[fieldset_name] + fieldset: FieldNestedEntry = ecs_nested[fieldset_name] # Handle when `root:true` if fieldset.get('root', False): @@ -45,7 +59,7 @@ def generate(ecs_nested, ecs_version, out_dir): # Set default_field configuration. set_default_field(beats_fields, df_allowlist) - beats_file = OrderedDict() + beats_file: OrderedDict = OrderedDict() beats_file['key'] = 'ecs' beats_file['title'] = 'ECS' beats_file['description'] = 'ECS Fields.' @@ -70,24 +84,52 @@ def set_default_field(fields, df_allowlist, df=False, path=''): set_default_field(fld['multi_fields'], df_allowlist, df=expected, path=fld_path) -def fieldset_field_array(source_fields, fieldset_prefix): - allowed_keys = ['name', 'level', 'required', 'type', 'object_type', - 'ignore_above', 'multi_fields', 'format', 'input_format', - 'output_format', 'output_precision', 'description', - 'example', 'enabled', 'index', 'doc_values', 'path', - 'scaling_factor', 'pattern'] - multi_fields_allowed_keys = ['name', 'type', 'norms', 'default_field', 'normalizer', 'ignore_above'] +def fieldset_field_array( + source_fields: Dict[str, Field], + fieldset_prefix: str +) -> List[OrderedDict]: + allowed_keys: List[str] = [ + 'name', + 'level', + 'required', + 'type', + 'object_type', + 'ignore_above', + 'multi_fields', + 'format', + 'input_format', + 'output_format', + 'output_precision', + 'description', + 'example', + 'enabled', + 'index', + 'doc_values', + 'path', + 'scaling_factor', + 'pattern' + ] + + multi_fields_allowed_keys: List[str] = [ + 'name', + 'type', + 'norms', + 'default_field', + 'normalizer', + 'ignore_above' + ] + + fields: List[OrderedDict] = [] - fields = [] for nested_field_name in source_fields: - ecs_field = source_fields[nested_field_name] - beats_field = ecs_helpers.dict_copy_keys_ordered(ecs_field, allowed_keys) + ecs_field: Field = source_fields[nested_field_name] + beats_field: OrderedDict = ecs_helpers.dict_copy_keys_ordered(ecs_field, allowed_keys) if '' == fieldset_prefix: contextual_name = nested_field_name else: contextual_name = '.'.join(nested_field_name.split('.')[1:]) - cleaned_multi_fields = [] + cleaned_multi_fields: OrderedDict = [] if 'multi_fields' in ecs_field: for mf in ecs_field['multi_fields']: cleaned_multi_fields.append( @@ -102,16 +144,20 @@ def fieldset_field_array(source_fields, fieldset_prefix): # Helpers -def write_beats_yaml(beats_file, ecs_version, out_dir): +def write_beats_yaml( + beats_file: OrderedDict, + ecs_version: str, + out_dir: str +) -> None: ecs_helpers.make_dirs(join(out_dir, 'beats')) - warning = file_header().format(version=ecs_version) + warning: str = file_header().format(version=ecs_version) ecs_helpers.yaml_dump(join(out_dir, 'beats/fields.ecs.yml'), [beats_file], preamble=warning) # Templates -def file_header(): +def file_header() -> str: return """ # WARNING! Do not edit this file directly, it was generated by the ECS project, # based on ECS version {version}. diff --git a/scripts/generators/csv_generator.py b/scripts/generators/csv_generator.py index 39e3ecae54..8f83469e09 100644 --- a/scripts/generators/csv_generator.py +++ b/scripts/generators/csv_generator.py @@ -15,22 +15,30 @@ # specific language governing permissions and limitations # under the License. +import _csv import csv import sys +from typing import ( + Dict, + List, +) from os.path import join from generator import ecs_helpers +from _types import ( + Field, +) -def generate(ecs_flat, version, out_dir): +def generate(ecs_flat: Dict[str, Field], version: str, out_dir: str) -> None: ecs_helpers.make_dirs(join(out_dir, 'csv')) sorted_fields = base_first(ecs_flat) save_csv(join(out_dir, 'csv/fields.csv'), sorted_fields, version) -def base_first(ecs_flat): - base_list = [] - sorted_list = [] +def base_first(ecs_flat: Dict[str, Field]) -> List[Field]: + base_list: List[Field] = [] + sorted_list: List[Field] = [] for field_name in sorted(ecs_flat): if '.' in field_name: sorted_list.append(ecs_flat[field_name]) @@ -39,27 +47,27 @@ def base_first(ecs_flat): return base_list + sorted_list -def save_csv(file, sorted_fields, version): - open_mode = "wb" +def save_csv(file: str, sorted_fields: List[Field], version: str) -> None: + open_mode: str = "wb" if sys.version_info >= (3, 0): - open_mode = "w" + open_mode: str = "w" with open(file, open_mode) as csvfile: - schema_writer = csv.writer(csvfile, - delimiter=',', - quoting=csv.QUOTE_MINIMAL, - lineterminator='\n') + schema_writer: _csv._writer = csv.writer(csvfile, + delimiter=',', + quoting=csv.QUOTE_MINIMAL, + lineterminator='\n') schema_writer.writerow(["ECS_Version", "Indexed", "Field_Set", "Field", "Type", "Level", "Normalization", "Example", "Description"]) for field in sorted_fields: - key_parts = field['flat_name'].split('.') + key_parts: List[str] = field['flat_name'].split('.') if len(key_parts) == 1: - field_set = 'base' + field_set: str = 'base' else: - field_set = key_parts[0] + field_set: str = key_parts[0] - indexed = str(field.get('index', True)).lower() + indexed: str = str(field.get('index', True)).lower() schema_writer.writerow([ version, indexed, diff --git a/scripts/generators/es_template.py b/scripts/generators/es_template.py index 2d32398323..555892cef1 100644 --- a/scripts/generators/es_template.py +++ b/scripts/generators/es_template.py @@ -17,15 +17,31 @@ import json import sys +from typing import ( + Dict, + List, + Optional, + Union +) from os.path import join from generators import ecs_helpers +from _types import ( + Field, + FieldNestedEntry, +) # Composable Template -def generate(ecs_nested, ecs_version, out_dir, mapping_settings_file, template_settings_file): +def generate( + ecs_nested: Dict[str, FieldNestedEntry], + ecs_version: str, + out_dir: str, + mapping_settings_file: str, + template_settings_file: str +) -> None: """This generates all artifacts for the composable template approach""" all_component_templates(ecs_nested, ecs_version, out_dir) component_names = component_name_convention(ecs_version, ecs_nested) @@ -40,9 +56,13 @@ def save_composable_template(ecs_version, component_names, out_dir, mapping_sett save_json(filename, template) -def all_component_templates(ecs_nested, ecs_version, out_dir): +def all_component_templates( + ecs_nested: Dict[str, FieldNestedEntry], + ecs_version: str, + out_dir: str +) -> None: """Generate one component template per field set""" - component_dir = join(out_dir, 'elasticsearch/composable/component') + component_dir: str = join(out_dir, 'elasticsearch/composable/component') ecs_helpers.make_dirs(component_dir) for (fieldset_name, fieldset) in candidate_components(ecs_nested).items(): @@ -54,11 +74,17 @@ def all_component_templates(ecs_nested, ecs_version, out_dir): save_component_template(fieldset_name, field['level'], ecs_version, component_dir, field_mappings) -def save_component_template(template_name, field_level, ecs_version, out_dir, field_mappings): - filename = join(out_dir, template_name) + ".json" - reference_url = "https://www.elastic.co/guide/en/ecs/current/ecs-{}.html".format(template_name) +def save_component_template( + template_name: str, + field_level: str, + ecs_version: str, + out_dir: str, + field_mappings: Dict +) -> None: + filename: str = join(out_dir, template_name) + ".json" + reference_url: str = "https://www.elastic.co/guide/en/ecs/current/ecs-{}.html".format(template_name) - template = { + template: Dict = { 'template': {'mappings': {'properties': field_mappings}}, '_meta': { 'ecs_version': ecs_version, @@ -72,17 +98,20 @@ def save_component_template(template_name, field_level, ecs_version, out_dir, fi save_json(filename, template) -def component_name_convention(ecs_version, ecs_nested): - version = ecs_version.replace('+', '-') - names = [] +def component_name_convention( + ecs_version: str, + ecs_nested: Dict[str, FieldNestedEntry] +) -> List[str]: + version: str = ecs_version.replace('+', '-') + names: List[str] = [] for (fieldset_name, fieldset) in candidate_components(ecs_nested).items(): names.append("ecs_{}_{}".format(version, fieldset_name.lower())) return names -def candidate_components(ecs_nested): +def candidate_components(ecs_nested: Dict[str, FieldNestedEntry]) -> Dict[str, FieldNestedEntry]: """Returns same structure as ecs_nested, but skips all field sets with reusable.top_level: False""" - components = {} + components: Dict[str, FieldNestedEntry] = {} for (fieldset_name, fieldset) in ecs_nested.items(): if fieldset.get('reusable', None): if not fieldset['reusable']['top_level']: @@ -94,7 +123,13 @@ def candidate_components(ecs_nested): # Legacy template -def generate_legacy(ecs_flat, ecs_version, out_dir, mapping_settings_file, template_settings_file,): +def generate_legacy( + ecs_flat: Dict[str, Field], + ecs_version: str, + out_dir: str, + mapping_settings_file: str, + template_settings_file: str +) -> None: """Generate the legacy index template""" field_mappings = {} for flat_name in sorted(ecs_flat): @@ -102,26 +137,35 @@ def generate_legacy(ecs_flat, ecs_version, out_dir, mapping_settings_file, templ name_parts = flat_name.split('.') dict_add_nested(field_mappings, name_parts, entry_for(field)) - mappings_section = mapping_settings(mapping_settings_file) + mappings_section: Dict = mapping_settings(mapping_settings_file) mappings_section['properties'] = field_mappings generate_legacy_template_version(ecs_version, mappings_section, out_dir, template_settings_file) -def generate_legacy_template_version(ecs_version, mappings_section, out_dir, template_settings_file): +def generate_legacy_template_version( + ecs_version: str, + mappings_section: Dict, + out_dir: str, + template_settings_file: str +) -> None: ecs_helpers.make_dirs(join(out_dir, 'elasticsearch', "legacy")) - template = template_settings(ecs_version, mappings_section, template_settings_file, isLegacy=True) + template: Dict = template_settings(ecs_version, mappings_section, template_settings_file, is_legacy=True) - filename = join(out_dir, "elasticsearch/legacy/template.json") + filename: str = join(out_dir, "elasticsearch/legacy/template.json") save_json(filename, template) # Common helpers -def dict_add_nested(dct, name_parts, value): - current_nesting = name_parts[0] - rest_name_parts = name_parts[1:] +def dict_add_nested( + dct: Dict, + name_parts: List[str], + value: Dict +) -> None: + current_nesting: str = name_parts[0] + rest_name_parts: List[str] = name_parts[1:] if len(rest_name_parts) > 0: dct.setdefault(current_nesting, {}) dct[current_nesting].setdefault('properties', {}) @@ -137,8 +181,8 @@ def dict_add_nested(dct, name_parts, value): dct[current_nesting] = value -def entry_for(field): - field_entry = {'type': field['type']} +def entry_for(field: Field) -> Dict: + field_entry: Dict = {'type': field['type']} try: if field['type'] == 'object' or field['type'] == 'nested': if 'enabled' in field and not field['enabled']: @@ -175,7 +219,7 @@ def entry_for(field): return field_entry -def mapping_settings(mapping_settings_file): +def mapping_settings(mapping_settings_file: str) -> Dict: if mapping_settings_file: with open(mapping_settings_file) as f: mappings = json.load(f) @@ -184,23 +228,35 @@ def mapping_settings(mapping_settings_file): return mappings -def template_settings(ecs_version, mappings_section, template_settings_file, isLegacy=False, component_names=None): +def template_settings( + ecs_version: str, + mappings_section: Dict, + template_settings_file: Union[str, None], + is_legacy: Optional[bool] = False, + component_names: Optional[List[str]] = None +) -> Dict: if template_settings_file: with open(template_settings_file) as f: template = json.load(f) else: - if isLegacy: + if is_legacy: template = default_legacy_template_settings(ecs_version) else: template = default_template_settings(ecs_version) - finalize_template(template, ecs_version, isLegacy, mappings_section, component_names) + finalize_template(template, ecs_version, is_legacy, mappings_section, component_names) return template -def finalize_template(template, ecs_version, isLegacy, mappings_section, component_names): - if isLegacy: +def finalize_template( + template: Dict, + ecs_version: str, + is_legacy: bool, + mappings_section: Dict, + component_names: List[str] +) -> None: + if is_legacy: if mappings_section: template['mappings'] = mappings_section @@ -218,7 +274,7 @@ def finalize_template(template, ecs_version, isLegacy, mappings_section, compone } -def save_json(file, data): +def save_json(file: str, data: Dict) -> None: open_mode = "wb" if sys.version_info >= (3, 0): open_mode = "w" @@ -227,7 +283,7 @@ def save_json(file, data): jsonfile.write('\n') -def default_template_settings(ecs_version): +def default_template_settings(ecs_version: str) -> Dict: return { "index_patterns": ["try-ecs-*"], "_meta": { @@ -250,7 +306,7 @@ def default_template_settings(ecs_version): } -def default_legacy_template_settings(ecs_version): +def default_legacy_template_settings(ecs_version: str) -> Dict: return { "index_patterns": ["try-ecs-*"], "_meta": {"version": ecs_version}, @@ -268,7 +324,7 @@ def default_legacy_template_settings(ecs_version): } -def default_mapping_settings(): +def default_mapping_settings() -> Dict: return { "date_detection": False, "dynamic_templates": [ diff --git a/scripts/generators/intermediate_files.py b/scripts/generators/intermediate_files.py index 0a647ca1b6..076330315b 100644 --- a/scripts/generators/intermediate_files.py +++ b/scripts/generators/intermediate_files.py @@ -19,6 +19,7 @@ from os.path import join from typing import ( Dict, + Tuple, ) from schema import visitor @@ -26,17 +27,22 @@ from _types import ( Field, FieldEntry, + FieldNestedEntry, ) -def generate(fields, out_dir, default_dirs): +def generate( + fields: Dict[str, FieldEntry], + out_dir: str, + default_dirs: bool +) -> Tuple[Dict[str, FieldNestedEntry], Dict[str, Field]]: ecs_helpers.make_dirs(join(out_dir)) # Should only be used for debugging ECS development if default_dirs: ecs_helpers.yaml_dump(join(out_dir, 'ecs.yml'), fields) - flat = generate_flat_fields(fields) - nested = generate_nested_fields(fields) + flat: Dict[str, Field] = generate_flat_fields(fields) + nested: Dict[str, FieldNestedEntry] = generate_nested_fields(fields) ecs_helpers.yaml_dump(join(out_dir, 'ecs_flat.yml'), flat) ecs_helpers.yaml_dump(join(out_dir, 'ecs_nested.yml'), nested) @@ -55,16 +61,16 @@ def accumulate_field(details: FieldEntry, memo: Field) -> None: """Visitor function that accumulates all field details in the memo dict""" if 'schema_details' in details or ecs_helpers.is_intermediate(details): return - field_details = copy.deepcopy(details['field_details']) + field_details: Field = copy.deepcopy(details['field_details']) remove_internal_attributes(field_details) flat_name = field_details['flat_name'] memo[flat_name] = field_details -def generate_nested_fields(fields): +def generate_nested_fields(fields: Dict[str, FieldEntry]) -> Dict[str, FieldNestedEntry]: """Generate ecs_nested.yml""" - nested = {} + nested: Dict[str, FieldNestedEntry] = {} # Flatten each field set, but keep all resulting fields nested under their # parent/host field set. for (name, details) in fields.items(): @@ -94,7 +100,7 @@ def generate_nested_fields(fields): # Helper functions -def remove_internal_attributes(field_details): +def remove_internal_attributes(field_details: Field) -> None: """Remove attributes only relevant to the deeply nested structure, but not to ecs_flat/nested.yml.""" field_details.pop('node_name', None) field_details.pop('intermediate', None) diff --git a/scripts/schema/subset_filter.py b/scripts/schema/subset_filter.py index 4d19233070..8b5f0d1762 100644 --- a/scripts/schema/subset_filter.py +++ b/scripts/schema/subset_filter.py @@ -22,6 +22,7 @@ Dict, List, Optional, + Tuple, ) from generators import intermediate_files @@ -41,7 +42,7 @@ def filter( fields: Dict[str, FieldEntry], subset_file_globs: List[str], out_dir: str -) -> Dict[str, FieldEntry]: +) -> Tuple[Dict[str, FieldEntry], Dict[str, FieldEntry]]: subsets: List[Dict[str, Any]] = load_subset_definitions(subset_file_globs) for subset in subsets: subfields: Dict[str, FieldEntry] = extract_matching_fields(fields, subset['fields']) diff --git a/scripts/tests/test_es_template.py b/scripts/tests/test_es_template.py index c74e32e039..f4034c37c4 100644 --- a/scripts/tests/test_es_template.py +++ b/scripts/tests/test_es_template.py @@ -189,11 +189,11 @@ def test_legacy_template_settings_override(self): ecs_version = 100 default = es_template.default_legacy_template_settings(ecs_version) - generated_template = es_template.template_settings(ecs_version, None, None, isLegacy=True) + generated_template = es_template.template_settings(ecs_version, None, None, is_legacy=True) self.assertEqual(generated_template, default) generated_template = es_template.template_settings( - ecs_version, None, './usage-example/fields/template-settings-legacy.json', isLegacy=True) + ecs_version, None, './usage-example/fields/template-settings-legacy.json', is_legacy=True) self.assertNotEqual(generated_template, default) def test_default_composable_template_settings(self): @@ -207,7 +207,7 @@ def test_default_composable_template_settings(self): self.assertEqual(generated_template, default) generated_template = es_template.template_settings( - ecs_version, None, './usage-example/fields/template-settings.json', isLegacy=True) + ecs_version, None, './usage-example/fields/template-settings.json', is_legacy=True) self.assertNotEqual(generated_template, default) diff --git a/scripts/tests/unit/test_csv_generator.py b/scripts/tests/unit/test_csv_generator.py new file mode 100644 index 0000000000..5057e67e24 --- /dev/null +++ b/scripts/tests/unit/test_csv_generator.py @@ -0,0 +1,67 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +import mock +import os +import sys +import unittest + +sys.path.append(os.path.join(os.path.dirname(__file__), '../..')) + +from generators import csv_generator + + +class TestGeneratorsCsvFields(unittest.TestCase): + def test_base_first(self): + fields = { + '@timestamp': { + 'dashed_name': 'timestamp' + }, + 'host.name': { + 'dashed_name': 'host-name' + } + } + sorted_base_first = csv_generator.base_first(fields) + self.assertIsInstance(sorted_base_first, list) + self.assertIsInstance(sorted_base_first[0], dict) + self.assertEqual(sorted_base_first[0].get('dashed_name'), 'timestamp') + + @mock.patch("builtins.open", new_callable=mock.mock_open) + @mock.patch('generators.csv_generator.csv') + def test_csv_writing(self, mock_csv, _): + mock_csv.writer = mock.Mock(writerow=mock.Mock()) + fields = [{ + 'example': '2016-05-23T08:05:34.853Z', + 'flat_name': '@timestamp', + 'level': 'core', + 'name': '@timestamp', + 'normalize': [], + 'required': True, + 'short': 'Date/time when the event originated.', + 'type': 'date' + }] + + csv_generator.save_csv('ecs.csv', fields, '0.0.1') + + self.assertEqual(mock_csv.writer.call_count, 1) + self.assertEqual(mock_csv.writer().writerow.call_count, 2) + mock_csv.writer().writerow.assert_has_calls([ + mock.call(['ECS_Version', 'Indexed', 'Field_Set', 'Field', 'Type', + 'Level', 'Normalization', 'Example', 'Description']), + mock.call(['0.0.1', 'true', 'base', '@timestamp', 'date', 'core', '', + '2016-05-23T08:05:34.853Z', 'Date/time when the event originated.']) + ]) From 4a3ec76664d25d756e63e2beeedaf2b30a45540f Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Mon, 20 Jun 2022 14:54:32 -0500 Subject: [PATCH 2/3] `expected_values` in field definitions (#1952) * render expected_values in field details j2 template * add check of examples against expected_values * document expected_values attr * incorporate cell formatting option * note --strict validation of example against expected_values * escape unintended copyright text replacements --- USAGE.md | 1 + docs/fields/field-details.asciidoc | 1154 +++++++++---------- experimental/generated/beats/fields.ecs.yml | 32 +- experimental/generated/csv/fields.csv | 28 +- experimental/generated/ecs/ecs_flat.yml | 56 +- experimental/generated/ecs/ecs_nested.yml | 64 +- generated/beats/fields.ecs.yml | 32 +- generated/csv/fields.csv | 28 +- generated/ecs/ecs_flat.yml | 56 +- generated/ecs/ecs_nested.yml | 64 +- schemas/README.md | 1 + schemas/x509.yml | 4 +- scripts/schema/cleaner.py | 27 +- scripts/templates/field_details.j2 | 13 +- scripts/tests/unit/test_schema_cleaner.py | 68 ++ 15 files changed, 857 insertions(+), 771 deletions(-) diff --git a/USAGE.md b/USAGE.md index afc925d755..b29cdaa637 100644 --- a/USAGE.md +++ b/USAGE.md @@ -416,6 +416,7 @@ Strict mode requires the following conditions, else the script exits on an excep * Short descriptions must be less than or equal to 120 characters. * Example values containing arrays or objects must be quoted to avoid unexpected YAML interpretation when the schema files or artifacts are relied on downstream. * If a regex `pattern` is defined, the example values will be checked against it. +* If `expected_values` is defined, the example value(s) will be checked against the list. The current artifacts generated and published in the ECS repo will always be created using strict mode. However, older ECS versions (pre `v1.5.0`) will cause an exception if attempting to generate them using `--strict`. This is due to schema validation checks introduced after that version was released. diff --git a/docs/fields/field-details.asciidoc b/docs/fields/field-details.asciidoc index 74e6ecbda3..16352bd6be 100644 --- a/docs/fields/field-details.asciidoc +++ b/docs/fields/field-details.asciidoc @@ -16,7 +16,7 @@ The `base` field set contains all fields which are at the root of the events. Th [[field-timestamp]] <> -| Date/time when the event originated. +a| Date/time when the event originated. This is the date/time extracted from the event, typically representing when the event was generated by the source. @@ -38,7 +38,7 @@ example: `2016-05-23T08:05:34.853Z` [[field-labels]] <> -| Custom key/value pairs. +a| Custom key/value pairs. Can be used to add meta information to events. Should not contain nested objects. All values are stored as keyword. @@ -58,7 +58,7 @@ example: `{"application": "foo-bar", "env": "production"}` [[field-message]] <> -| For log events the message field contains the log message, optimized for viewing in a log viewer. +a| For log events the message field contains the log message, optimized for viewing in a log viewer. For structured logs without an original message field, other fields can be concatenated to form a human-readable summary of the event. @@ -78,7 +78,7 @@ example: `Hello World` [[field-tags]] <> -| List of keywords used to tag each event. +a| List of keywords used to tag each event. type: keyword @@ -116,7 +116,7 @@ Examples include Beats. Agents may also run on observers. ECS agent.* fields sha [[field-agent-build-original]] <> -| Extended build information for the agent. +a| Extended build information for the agent. This field is intended to contain any build information that a data source may provide, no specific formatting is required. @@ -134,7 +134,7 @@ example: `metricbeat version 7.6.0 (amd64), libbeat 7.6.0 [6a23e8f8f30f5001ba344 [[field-agent-ephemeral-id]] <> -| Ephemeral identifier of this agent (if one exists). +a| Ephemeral identifier of this agent (if one exists). This id normally changes across restarts, but `agent.id` does not. @@ -152,7 +152,7 @@ example: `8a4f500f` [[field-agent-id]] <> -| Unique identifier of this agent (if one exists). +a| Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. @@ -170,7 +170,7 @@ example: `8a4f500d` [[field-agent-name]] <> -| Custom name of the agent. +a| Custom name of the agent. This is a name that can be given to an agent. This can be helpful if for example two Filebeat instances are running on the same host but a human readable separation is needed on which Filebeat instance data is coming from. @@ -188,7 +188,7 @@ example: `foo` [[field-agent-type]] <> -| Type of the agent. +a| Type of the agent. The agent type always stays the same and should be given by the agent used. In case of Filebeat the agent would always be Filebeat also if two Filebeat instances are run on the same machine. @@ -206,7 +206,7 @@ example: `filebeat` [[field-agent-version]] <> -| Version of the agent. +a| Version of the agent. type: keyword @@ -239,7 +239,7 @@ An autonomous system (AS) is a collection of connected Internet Protocol (IP) ro [[field-as-number]] <> -| Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. +a| Unique number allocated to the autonomous system. The autonomous system number (ASN) uniquely identifies each network on the Internet. type: long @@ -255,7 +255,7 @@ example: `15169` [[field-as-organization-name]] <> -| Organization name. +a| Organization name. type: keyword @@ -317,7 +317,7 @@ Client / server representations can add semantic context to an exchange, which i [[field-client-address]] <> -| Some event client addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field. +a| Some event client addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field. Then it should be duplicated to `.ip` or `.domain`, depending on which one it is. @@ -335,7 +335,7 @@ type: keyword [[field-client-bytes]] <> -| Bytes sent from the client to the server. +a| Bytes sent from the client to the server. type: long @@ -351,7 +351,7 @@ example: `184` [[field-client-domain]] <> -| The domain name of the client system. +a| The domain name of the client system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment. @@ -369,7 +369,7 @@ example: `foo.example.com` [[field-client-ip]] <> -| IP address of the client (IPv4 or IPv6). +a| IP address of the client (IPv4 or IPv6). type: ip @@ -385,7 +385,7 @@ type: ip [[field-client-mac]] <> -| MAC address of the client. +a| MAC address of the client. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. @@ -403,7 +403,7 @@ example: `00-00-5E-00-53-23` [[field-client-nat-ip]] <> -| Translated IP of source based NAT sessions (e.g. internal client to internet). +a| Translated IP of source based NAT sessions (e.g. internal client to internet). Typically connections traversing load balancers, firewalls, or routers. @@ -421,7 +421,7 @@ type: ip [[field-client-nat-port]] <> -| Translated port of source based NAT sessions (e.g. internal client to internet). +a| Translated port of source based NAT sessions (e.g. internal client to internet). Typically connections traversing load balancers, firewalls, or routers. @@ -439,7 +439,7 @@ type: long [[field-client-packets]] <> -| Packets sent from the client to the server. +a| Packets sent from the client to the server. type: long @@ -455,7 +455,7 @@ example: `12` [[field-client-port]] <> -| Port of the client. +a| Port of the client. type: long @@ -471,7 +471,7 @@ type: long [[field-client-registered-domain]] <> -| The highest registered client domain, stripped of the subdomain. +a| The highest registered client domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". @@ -491,7 +491,7 @@ example: `example.com` [[field-client-subdomain]] <> -| The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. +a| The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period. @@ -509,7 +509,7 @@ example: `east` [[field-client-top-level-domain]] <> -| The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". +a| The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk". @@ -581,7 +581,7 @@ Fields related to the cloud or infrastructure the events are coming from. [[field-cloud-account-id]] <> -| The cloud account or organization id used to identify different entities in a multi-tenant environment. +a| The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. @@ -599,7 +599,7 @@ example: `666777888999` [[field-cloud-account-name]] <> -| The cloud account name or alias used to identify different entities in a multi-tenant environment. +a| The cloud account name or alias used to identify different entities in a multi-tenant environment. Examples: AWS account name, Google Cloud ORG display name. @@ -617,7 +617,7 @@ example: `elastic-dev` [[field-cloud-availability-zone]] <> -| Availability zone in which this host, resource, or service is located. +a| Availability zone in which this host, resource, or service is located. type: keyword @@ -633,7 +633,7 @@ example: `us-east-1c` [[field-cloud-instance-id]] <> -| Instance ID of the host machine. +a| Instance ID of the host machine. type: keyword @@ -649,7 +649,7 @@ example: `i-1234567890abcdef0` [[field-cloud-instance-name]] <> -| Instance name of the host machine. +a| Instance name of the host machine. type: keyword @@ -665,7 +665,7 @@ type: keyword [[field-cloud-machine-type]] <> -| Machine type of the host machine. +a| Machine type of the host machine. type: keyword @@ -681,7 +681,7 @@ example: `t2.medium` [[field-cloud-project-id]] <> -| The cloud project identifier. +a| The cloud project identifier. Examples: Google Cloud Project id, Azure Project id. @@ -699,7 +699,7 @@ example: `my-project` [[field-cloud-project-name]] <> -| The cloud project name. +a| The cloud project name. Examples: Google Cloud Project name, Azure Project name. @@ -717,7 +717,7 @@ example: `my project` [[field-cloud-provider]] <> -| Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. +a| Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. type: keyword @@ -733,7 +733,7 @@ example: `aws` [[field-cloud-region]] <> -| Region in which this host, resource, or service is located. +a| Region in which this host, resource, or service is located. type: keyword @@ -749,7 +749,7 @@ example: `us-east-1` [[field-cloud-service-name]] <> -| The cloud service name is intended to distinguish services running on different platforms within a provider, eg AWS EC2 vs Lambda, GCP GCE vs App Engine, Azure VM vs App Server. +a| The cloud service name is intended to distinguish services running on different platforms within a provider, eg AWS EC2 vs Lambda, GCP GCE vs App Engine, Azure VM vs App Server. Examples: app engine, app service, cloud run, fargate, lambda. @@ -835,7 +835,7 @@ These fields contain information about binary code signatures. [[field-code-signature-digest-algorithm]] <> -| The hashing algorithm used to sign the process. +a| The hashing algorithm used to sign the process. This value can distinguish signatures when a file is signed multiple times by the same signer but with a different digest algorithm. @@ -853,7 +853,7 @@ example: `sha256` [[field-code-signature-exists]] <> -| Boolean to capture if a signature is present. +a| Boolean to capture if a signature is present. type: boolean @@ -869,7 +869,7 @@ example: `true` [[field-code-signature-signing-id]] <> -| The identifier used to sign the process. +a| The identifier used to sign the process. This is used to identify the application manufactured by a software vendor. The field is relevant to Apple *OS only. @@ -887,7 +887,7 @@ example: `com.apple.xpc.proxy` [[field-code-signature-status]] <> -| Additional information about the certificate status. +a| Additional information about the certificate status. This is useful for logging cryptographic errors with the certificate validity or trust status. Leave unpopulated if the validity or trust of the certificate was unchecked. @@ -905,7 +905,7 @@ example: `ERROR_UNTRUSTED_ROOT` [[field-code-signature-subject-name]] <> -| Subject name of the code signer +a| Subject name of the code signer type: keyword @@ -921,7 +921,7 @@ example: `Microsoft Corporation` [[field-code-signature-team-id]] <> -| The team identifier used to sign the process. +a| The team identifier used to sign the process. This is used to identify the team or vendor of a software product. The field is relevant to Apple *OS only. @@ -939,7 +939,7 @@ example: `EQHXZ8M8AV` [[field-code-signature-timestamp]] <> -| Date and time when the code signature was generated and signed. +a| Date and time when the code signature was generated and signed. type: date @@ -955,7 +955,7 @@ example: `2021-01-01T12:10:30Z` [[field-code-signature-trusted]] <> -| Stores the trust status of the certificate chain. +a| Stores the trust status of the certificate chain. Validating the trust of the certificate chain may be complicated, and this field should only be populated by tools that actively check the status. @@ -973,7 +973,7 @@ example: `true` [[field-code-signature-valid]] <> -| Boolean to capture if the digital signature is verified against the binary content. +a| Boolean to capture if the digital signature is verified against the binary content. Leave unpopulated if a certificate was unchecked. @@ -1023,7 +1023,7 @@ These fields help correlate data based containers from any runtime. [[field-container-cpu-usage]] <> -| Percent CPU used which is normalized by the number of CPU cores and it ranges from 0 to 1. Scaling factor: 1000. +a| Percent CPU used which is normalized by the number of CPU cores and it ranges from 0 to 1. Scaling factor: 1000. type: scaled_float @@ -1039,7 +1039,7 @@ type: scaled_float [[field-container-disk-read-bytes]] <> -| The total number of bytes (gauge) read successfully (aggregated from all disks) since the last metric collection. +a| The total number of bytes (gauge) read successfully (aggregated from all disks) since the last metric collection. type: long @@ -1055,7 +1055,7 @@ type: long [[field-container-disk-write-bytes]] <> -| The total number of bytes (gauge) written successfully (aggregated from all disks) since the last metric collection. +a| The total number of bytes (gauge) written successfully (aggregated from all disks) since the last metric collection. type: long @@ -1071,7 +1071,7 @@ type: long [[field-container-id]] <> -| Unique container id. +a| Unique container id. type: keyword @@ -1087,7 +1087,7 @@ type: keyword [[field-container-image-hash-all]] <> -| An array of digests of the image the container was built on. Each digest consists of the hash algorithm and value in this format: `algorithm:value`. Algorithm names should align with the field names in the ECS hash field set. +a| An array of digests of the image the container was built on. Each digest consists of the hash algorithm and value in this format: `algorithm:value`. Algorithm names should align with the field names in the ECS hash field set. type: keyword @@ -1106,7 +1106,7 @@ example: `[sha256:f8fefc80e3273dc756f288a63945820d6476ad64883892c771b5e2ece6bf1b [[field-container-image-name]] <> -| Name of the image the container was built on. +a| Name of the image the container was built on. type: keyword @@ -1122,7 +1122,7 @@ type: keyword [[field-container-image-tag]] <> -| Container image tags. +a| Container image tags. type: keyword @@ -1141,7 +1141,7 @@ Note: this field should contain an array of values. [[field-container-labels]] <> -| Image labels. +a| Image labels. type: object @@ -1157,7 +1157,7 @@ type: object [[field-container-memory-usage]] <> -| Memory usage percentage and it ranges from 0 to 1. Scaling factor: 1000. +a| Memory usage percentage and it ranges from 0 to 1. Scaling factor: 1000. type: scaled_float @@ -1173,7 +1173,7 @@ type: scaled_float [[field-container-name]] <> -| Container name. +a| Container name. type: keyword @@ -1189,7 +1189,7 @@ type: keyword [[field-container-network-egress-bytes]] <> -| The number of bytes (gauge) sent out on all network interfaces by the container since the last metric collection. +a| The number of bytes (gauge) sent out on all network interfaces by the container since the last metric collection. type: long @@ -1205,7 +1205,7 @@ type: long [[field-container-network-ingress-bytes]] <> -| The number of bytes received (gauge) on all network interfaces by the container since the last metric collection. +a| The number of bytes received (gauge) on all network interfaces by the container since the last metric collection. type: long @@ -1221,7 +1221,7 @@ type: long [[field-container-runtime]] <> -| Runtime managing this container. +a| Runtime managing this container. type: keyword @@ -1260,7 +1260,7 @@ beta::[ These fields are in beta and are subject to change.] [[field-data-stream-dataset]] <> -| The field can contain anything that makes sense to signify the source of the data. +a| The field can contain anything that makes sense to signify the source of the data. Examples include `nginx.access`, `prometheus`, `endpoint` etc. For data streams that otherwise fit, but that do not have dataset set we use the value "generic" for the dataset value. `event.dataset` should have the same value as `data_stream.dataset`. @@ -1284,7 +1284,7 @@ example: `nginx.access` [[field-data-stream-namespace]] <> -| A user defined namespace. Namespaces are useful to allow grouping of data. +a| A user defined namespace. Namespaces are useful to allow grouping of data. Many users already organize their indices this way, and the data stream naming scheme now provides this best practice as a default. Many users will populate this field with `default`. If no value is used, it falls back to `default`. @@ -1308,7 +1308,7 @@ example: `production` [[field-data-stream-type]] <> -| An overarching type for the data stream. +a| An overarching type for the data stream. Currently allowed values are "logs" and "metrics". We expect to also add "traces" and "synthetics" in the near future. @@ -1345,7 +1345,7 @@ Destination fields are usually populated in conjunction with source fields. The [[field-destination-address]] <> -| Some event destination addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field. +a| Some event destination addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field. Then it should be duplicated to `.ip` or `.domain`, depending on which one it is. @@ -1363,7 +1363,7 @@ type: keyword [[field-destination-bytes]] <> -| Bytes sent from the destination to the source. +a| Bytes sent from the destination to the source. type: long @@ -1379,7 +1379,7 @@ example: `184` [[field-destination-domain]] <> -| The domain name of the destination system. +a| The domain name of the destination system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment. @@ -1397,7 +1397,7 @@ example: `foo.example.com` [[field-destination-ip]] <> -| IP address of the destination (IPv4 or IPv6). +a| IP address of the destination (IPv4 or IPv6). type: ip @@ -1413,7 +1413,7 @@ type: ip [[field-destination-mac]] <> -| MAC address of the destination. +a| MAC address of the destination. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. @@ -1431,7 +1431,7 @@ example: `00-00-5E-00-53-23` [[field-destination-nat-ip]] <> -| Translated ip of destination based NAT sessions (e.g. internet to private DMZ) +a| Translated ip of destination based NAT sessions (e.g. internet to private DMZ) Typically used with load balancers, firewalls, or routers. @@ -1449,7 +1449,7 @@ type: ip [[field-destination-nat-port]] <> -| Port the source session is translated to by NAT Device. +a| Port the source session is translated to by NAT Device. Typically used with load balancers, firewalls, or routers. @@ -1467,7 +1467,7 @@ type: long [[field-destination-packets]] <> -| Packets sent from the destination to the source. +a| Packets sent from the destination to the source. type: long @@ -1483,7 +1483,7 @@ example: `12` [[field-destination-port]] <> -| Port of the destination. +a| Port of the destination. type: long @@ -1499,7 +1499,7 @@ type: long [[field-destination-registered-domain]] <> -| The highest registered destination domain, stripped of the subdomain. +a| The highest registered destination domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". @@ -1519,7 +1519,7 @@ example: `example.com` [[field-destination-subdomain]] <> -| The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. +a| The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period. @@ -1537,7 +1537,7 @@ example: `east` [[field-destination-top-level-domain]] <> -| The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". +a| The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk". @@ -1619,7 +1619,7 @@ Many operating systems refer to "shared code libraries" with different names, bu [[field-dll-name]] <> -| Name of the library. +a| Name of the library. This generally maps to the name of the file on disk. @@ -1637,7 +1637,7 @@ example: `kernel32.dll` [[field-dll-path]] <> -| Full file path of the library. +a| Full file path of the library. type: keyword @@ -1709,7 +1709,7 @@ DNS events should either represent a single DNS query prior to getting answers ( [[field-dns-answers]] <> -| An array containing an object for each answer section returned by the server. +a| An array containing an object for each answer section returned by the server. The main keys that should be present in these objects are defined by ECS. Records that have more information may contain more keys than what ECS defines. @@ -1732,7 +1732,7 @@ Note: this field should contain an array of values. [[field-dns-answers-class]] <> -| The class of DNS data contained in this resource record. +a| The class of DNS data contained in this resource record. type: keyword @@ -1748,7 +1748,7 @@ example: `IN` [[field-dns-answers-data]] <> -| The data describing the resource. +a| The data describing the resource. The meaning of this data depends on the type and class of the resource record. @@ -1766,7 +1766,7 @@ example: `10.10.10.10` [[field-dns-answers-name]] <> -| The domain name to which this resource record pertains. +a| The domain name to which this resource record pertains. If a chain of CNAME is being resolved, each answer's `name` should be the one that corresponds with the answer's `data`. It should not simply be the original `question.name` repeated. @@ -1784,7 +1784,7 @@ example: `www.example.com` [[field-dns-answers-ttl]] <> -| The time interval in seconds that this resource record may be cached before it should be discarded. Zero values mean that the data should not be cached. +a| The time interval in seconds that this resource record may be cached before it should be discarded. Zero values mean that the data should not be cached. type: long @@ -1800,7 +1800,7 @@ example: `180` [[field-dns-answers-type]] <> -| The type of data contained in this resource record. +a| The type of data contained in this resource record. type: keyword @@ -1816,7 +1816,7 @@ example: `CNAME` [[field-dns-header-flags]] <> -| Array of 2 letter DNS header flags. +a| Array of 2 letter DNS header flags. Expected values are: AA, TC, RD, RA, AD, CD, DO. @@ -1837,7 +1837,7 @@ example: `["RD", "RA"]` [[field-dns-id]] <> -| The DNS packet identifier assigned by the program that generated the query. The identifier is copied to the response. +a| The DNS packet identifier assigned by the program that generated the query. The identifier is copied to the response. type: keyword @@ -1853,7 +1853,7 @@ example: `62111` [[field-dns-op-code]] <> -| The DNS operation code that specifies the kind of query in the message. This value is set by the originator of a query and copied into the response. +a| The DNS operation code that specifies the kind of query in the message. This value is set by the originator of a query and copied into the response. type: keyword @@ -1869,7 +1869,7 @@ example: `QUERY` [[field-dns-question-class]] <> -| The class of records being queried. +a| The class of records being queried. type: keyword @@ -1885,7 +1885,7 @@ example: `IN` [[field-dns-question-name]] <> -| The name being queried. +a| The name being queried. If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n respectively. @@ -1903,7 +1903,7 @@ example: `www.example.com` [[field-dns-question-registered-domain]] <> -| The highest registered domain, stripped of the subdomain. +a| The highest registered domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". @@ -1923,7 +1923,7 @@ example: `example.com` [[field-dns-question-subdomain]] <> -| The subdomain is all of the labels under the registered_domain. +a| The subdomain is all of the labels under the registered_domain. If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period. @@ -1941,7 +1941,7 @@ example: `www` [[field-dns-question-top-level-domain]] <> -| The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". +a| The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk". @@ -1959,7 +1959,7 @@ example: `co.uk` [[field-dns-question-type]] <> -| The type of record being queried. +a| The type of record being queried. type: keyword @@ -1975,7 +1975,7 @@ example: `AAAA` [[field-dns-resolved-ip]] <> -| Array containing all IPs seen in `answers.data`. +a| Array containing all IPs seen in `answers.data`. The `answers` array can be difficult to use, because of the variety of data formats it can contain. Extracting all IP addresses seen in there to `dns.resolved_ip` makes it possible to index them as IP addresses, and makes them easier to visualize and query for. @@ -1996,7 +1996,7 @@ example: `["10.10.10.10", "10.10.10.11"]` [[field-dns-response-code]] <> -| The DNS response code. +a| The DNS response code. type: keyword @@ -2012,7 +2012,7 @@ example: `NOERROR` [[field-dns-type]] <> -| The type of DNS event captured, query or answer. +a| The type of DNS event captured, query or answer. If your source of DNS events only gives you DNS queries, you should only create dns events of type `dns.type:query`. @@ -2049,7 +2049,7 @@ Meta-information specific to ECS. [[field-ecs-version]] <> -| ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. +a| ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. @@ -2086,7 +2086,7 @@ beta::[ These fields are in beta and are subject to change.] [[field-elf-architecture]] <> -| Machine architecture of the ELF file. +a| Machine architecture of the ELF file. type: keyword @@ -2102,7 +2102,7 @@ example: `x86-64` [[field-elf-byte-order]] <> -| Byte sequence of ELF file. +a| Byte sequence of ELF file. type: keyword @@ -2118,7 +2118,7 @@ example: `Little Endian` [[field-elf-cpu-type]] <> -| CPU type of the ELF file. +a| CPU type of the ELF file. type: keyword @@ -2134,7 +2134,7 @@ example: `Intel` [[field-elf-creation-date]] <> -| Extracted when possible from the file's metadata. Indicates when it was built or compiled. It can also be faked by malware creators. +a| Extracted when possible from the file's metadata. Indicates when it was built or compiled. It can also be faked by malware creators. type: date @@ -2150,7 +2150,7 @@ type: date [[field-elf-exports]] <> -| List of exported element names and types. +a| List of exported element names and types. type: flattened @@ -2169,7 +2169,7 @@ Note: this field should contain an array of values. [[field-elf-header-abi-version]] <> -| Version of the ELF Application Binary Interface (ABI). +a| Version of the ELF Application Binary Interface (ABI). type: keyword @@ -2185,7 +2185,7 @@ type: keyword [[field-elf-header-class]] <> -| Header class of the ELF file. +a| Header class of the ELF file. type: keyword @@ -2201,7 +2201,7 @@ type: keyword [[field-elf-header-data]] <> -| Data table of the ELF header. +a| Data table of the ELF header. type: keyword @@ -2217,7 +2217,7 @@ type: keyword [[field-elf-header-entrypoint]] <> -| Header entrypoint of the ELF file. +a| Header entrypoint of the ELF file. type: long @@ -2233,7 +2233,7 @@ type: long [[field-elf-header-object-version]] <> -| "0x1" for original ELF files. +a| "0x1" for original ELF files. type: keyword @@ -2249,7 +2249,7 @@ type: keyword [[field-elf-header-os-abi]] <> -| Application Binary Interface (ABI) of the Linux OS. +a| Application Binary Interface (ABI) of the Linux OS. type: keyword @@ -2265,7 +2265,7 @@ type: keyword [[field-elf-header-type]] <> -| Header type of the ELF file. +a| Header type of the ELF file. type: keyword @@ -2281,7 +2281,7 @@ type: keyword [[field-elf-header-version]] <> -| Version of the ELF header. +a| Version of the ELF header. type: keyword @@ -2297,7 +2297,7 @@ type: keyword [[field-elf-imports]] <> -| List of imported element names and types. +a| List of imported element names and types. type: flattened @@ -2316,7 +2316,7 @@ Note: this field should contain an array of values. [[field-elf-sections]] <> -| An array containing an object for each section of the ELF file. +a| An array containing an object for each section of the ELF file. The keys that should be present in these objects are defined by sub-fields underneath `elf.sections.*`. @@ -2337,7 +2337,7 @@ Note: this field should contain an array of values. [[field-elf-sections-chi2]] <> -| Chi-square probability distribution of the section. +a| Chi-square probability distribution of the section. type: long @@ -2353,7 +2353,7 @@ type: long [[field-elf-sections-entropy]] <> -| Shannon entropy calculation from the section. +a| Shannon entropy calculation from the section. type: long @@ -2369,7 +2369,7 @@ type: long [[field-elf-sections-flags]] <> -| ELF Section List flags. +a| ELF Section List flags. type: keyword @@ -2385,7 +2385,7 @@ type: keyword [[field-elf-sections-name]] <> -| ELF Section List name. +a| ELF Section List name. type: keyword @@ -2401,7 +2401,7 @@ type: keyword [[field-elf-sections-physical-offset]] <> -| ELF Section List offset. +a| ELF Section List offset. type: keyword @@ -2417,7 +2417,7 @@ type: keyword [[field-elf-sections-physical-size]] <> -| ELF Section List physical size. +a| ELF Section List physical size. type: long @@ -2433,7 +2433,7 @@ type: long [[field-elf-sections-type]] <> -| ELF Section List type. +a| ELF Section List type. type: keyword @@ -2449,7 +2449,7 @@ type: keyword [[field-elf-sections-virtual-address]] <> -| ELF Section List virtual address. +a| ELF Section List virtual address. type: long @@ -2465,7 +2465,7 @@ type: long [[field-elf-sections-virtual-size]] <> -| ELF Section List virtual size. +a| ELF Section List virtual size. type: long @@ -2481,7 +2481,7 @@ type: long [[field-elf-segments]] <> -| An array containing an object for each segment of the ELF file. +a| An array containing an object for each segment of the ELF file. The keys that should be present in these objects are defined by sub-fields underneath `elf.segments.*`. @@ -2502,7 +2502,7 @@ Note: this field should contain an array of values. [[field-elf-segments-sections]] <> -| ELF object segment sections. +a| ELF object segment sections. type: keyword @@ -2518,7 +2518,7 @@ type: keyword [[field-elf-segments-type]] <> -| ELF object segment type. +a| ELF object segment type. type: keyword @@ -2534,7 +2534,7 @@ type: keyword [[field-elf-shared-libraries]] <> -| List of shared libraries used by this ELF object. +a| List of shared libraries used by this ELF object. type: keyword @@ -2553,7 +2553,7 @@ Note: this field should contain an array of values. [[field-elf-telfhash]] <> -| telfhash symbol hash for ELF file. +a| telfhash symbol hash for ELF file. type: keyword @@ -2599,7 +2599,7 @@ This field set focuses on the email message header, body, and attachments. Netwo [[field-email-attachments]] <> -| A list of objects describing the attachment files sent along with an email message. +a| A list of objects describing the attachment files sent along with an email message. type: nested @@ -2618,7 +2618,7 @@ Note: this field should contain an array of values. [[field-email-attachments-file-extension]] <> -| Attachment file extension, excluding the leading dot. +a| Attachment file extension, excluding the leading dot. type: keyword @@ -2634,7 +2634,7 @@ example: `txt` [[field-email-attachments-file-mime-type]] <> -| The MIME media type of the attachment. +a| The MIME media type of the attachment. This value will typically be extracted from the `Content-Type` MIME header field. @@ -2652,7 +2652,7 @@ example: `text/plain` [[field-email-attachments-file-name]] <> -| Name of the attachment file including the file extension. +a| Name of the attachment file including the file extension. type: keyword @@ -2668,7 +2668,7 @@ example: `attachment.txt` [[field-email-attachments-file-size]] <> -| Attachment file size in bytes. +a| Attachment file size in bytes. type: long @@ -2684,7 +2684,7 @@ example: `64329` [[field-email-bcc-address]] <> -| The email address of BCC recipient +a| The email address of BCC recipient type: keyword @@ -2703,7 +2703,7 @@ example: `bcc.user1@example.com` [[field-email-cc-address]] <> -| The email address of CC recipient +a| The email address of CC recipient type: keyword @@ -2722,7 +2722,7 @@ example: `cc.user1@example.com` [[field-email-content-type]] <> -| Information about how the message is to be displayed. +a| Information about how the message is to be displayed. Typically a MIME type. @@ -2740,7 +2740,7 @@ example: `text/plain` [[field-email-delivery-timestamp]] <> -| The date and time when the email message was received by the service or client. +a| The date and time when the email message was received by the service or client. type: date @@ -2756,7 +2756,7 @@ example: `2020-11-10T22:12:34.8196921Z` [[field-email-direction]] <> -| The direction of the message based on the sending and receiving domains. +a| The direction of the message based on the sending and receiving domains. type: keyword @@ -2772,7 +2772,7 @@ example: `inbound` [[field-email-from-address]] <> -| The email address of the sender, typically from the RFC 5322 `From:` header field. +a| The email address of the sender, typically from the RFC 5322 `From:` header field. type: keyword @@ -2791,7 +2791,7 @@ example: `sender@example.com` [[field-email-local-id]] <> -| Unique identifier given to the email by the source that created the event. +a| Unique identifier given to the email by the source that created the event. Identifier is not persistent across hops. @@ -2809,7 +2809,7 @@ example: `c26dbea0-80d5-463b-b93c-4e8b708219ce` [[field-email-message-id]] <> -| Identifier from the RFC 5322 `Message-ID:` email header that refers to a particular email message. +a| Identifier from the RFC 5322 `Message-ID:` email header that refers to a particular email message. type: wildcard @@ -2825,7 +2825,7 @@ example: `81ce15$8r2j59@mail01.example.com` [[field-email-origination-timestamp]] <> -| The date and time the email message was composed. Many email clients will fill in this value automatically when the message is sent by a user. +a| The date and time the email message was composed. Many email clients will fill in this value automatically when the message is sent by a user. type: date @@ -2841,7 +2841,7 @@ example: `2020-11-10T22:12:34.8196921Z` [[field-email-reply-to-address]] <> -| The address that replies should be delivered to based on the value in the RFC 5322 `Reply-To:` header. +a| The address that replies should be delivered to based on the value in the RFC 5322 `Reply-To:` header. type: keyword @@ -2860,7 +2860,7 @@ example: `reply.here@example.com` [[field-email-sender-address]] <> -| Per RFC 5322, specifies the address responsible for the actual transmission of the message. +a| Per RFC 5322, specifies the address responsible for the actual transmission of the message. type: keyword @@ -2876,7 +2876,7 @@ type: keyword [[field-email-subject]] <> -| A brief summary of the topic of the message. +a| A brief summary of the topic of the message. type: keyword @@ -2898,7 +2898,7 @@ example: `Please see this important message.` [[field-email-to-address]] <> -| The email address of recipient +a| The email address of recipient type: keyword @@ -2917,7 +2917,7 @@ example: `user1@example.com` [[field-email-x-mailer]] <> -| The name of the application that was used to draft and send the original email message. +a| The name of the application that was used to draft and send the original email message. type: keyword @@ -2975,7 +2975,7 @@ Use them for errors that happen while fetching events or in cases where the even [[field-error-code]] <> -| Error code describing the error. +a| Error code describing the error. type: keyword @@ -2991,7 +2991,7 @@ type: keyword [[field-error-id]] <> -| Unique identifier for the error. +a| Unique identifier for the error. type: keyword @@ -3007,7 +3007,7 @@ type: keyword [[field-error-message]] <> -| Error message. +a| Error message. type: match_only_text @@ -3023,7 +3023,7 @@ type: match_only_text [[field-error-stack-trace]] <> -| The stack trace of this error in plain text. +a| The stack trace of this error in plain text. type: wildcard @@ -3045,7 +3045,7 @@ Multi-fields: [[field-error-type]] <> -| The type of the error, for example the class name of the exception. +a| The type of the error, for example the class name of the exception. type: keyword @@ -3080,7 +3080,7 @@ A log is defined as an event containing details of something that happened. Log [[field-event-action]] <> -| The action captured by the event. +a| The action captured by the event. This describes the information in the event. It is more specific than `event.category`. Examples are `group-add`, `process-started`, `file-created`. The value is normally defined by the implementer. @@ -3098,7 +3098,7 @@ example: `user-password-change` [[field-event-agent-id-status]] <> -| Agents are normally responsible for populating the `agent.id` field value. If the system receiving events is capable of validating the value based on authentication information for the client then this field can be used to reflect the outcome of that validation. +a| Agents are normally responsible for populating the `agent.id` field value. If the system receiving events is capable of validating the value based on authentication information for the client then this field can be used to reflect the outcome of that validation. For example if the agent's connection is authenticated with mTLS and the client cert contains the ID of the agent to which the cert was issued then the `agent.id` value in events can be checked against the certificate. If the values match then `event.agent_id_status: verified` is added to the event, otherwise one of the other allowed values should be used. @@ -3128,7 +3128,7 @@ example: `verified` [[field-event-category]] <> -| This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy. +a| This is one of four ECS Categorization Fields, and indicates the second level in the ECS category hierarchy. `event.category` represents the "big buckets" of ECS categories. For example, filtering on `event.category:process` yields all events relating to process activity. This field is closely related to `event.type`, which is used as a subcategory. @@ -3158,7 +3158,7 @@ To learn more about when to use which value, visit the page [[field-event-code]] <> -| Identification code for this event, if one exists. +a| Identification code for this event, if one exists. Some event sources use event codes to identify messages unambiguously, regardless of message language or wording adjustments over time. An example of this is the Windows Event ID. @@ -3176,7 +3176,7 @@ example: `4648` [[field-event-created]] <> -| event.created contains the date/time when the event was first read by an agent, or by your pipeline. +a| event.created contains the date/time when the event was first read by an agent, or by your pipeline. This field is distinct from @timestamp in that @timestamp typically contain the time extracted from the original event. @@ -3198,7 +3198,7 @@ example: `2016-05-23T08:05:34.857Z` [[field-event-dataset]] <> -| Name of the dataset. +a| Name of the dataset. If an event source publishes more than one type of log or events (e.g. access log, error log), the dataset is used to specify which one the event comes from. @@ -3218,7 +3218,7 @@ example: `apache.access` [[field-event-duration]] <> -| Duration of the event in nanoseconds. +a| Duration of the event in nanoseconds. If event.start and event.end are known this value should be the difference between the end and start time. @@ -3236,7 +3236,7 @@ type: long [[field-event-end]] <> -| event.end contains the date when the event ended or when the activity was last observed. +a| event.end contains the date when the event ended or when the activity was last observed. type: date @@ -3252,7 +3252,7 @@ type: date [[field-event-hash]] <> -| Hash (perhaps logstash fingerprint) of raw field to be able to demonstrate log integrity. +a| Hash (perhaps logstash fingerprint) of raw field to be able to demonstrate log integrity. type: keyword @@ -3268,7 +3268,7 @@ example: `123456789012345678901234567890ABCD` [[field-event-id]] <> -| Unique ID to describe the event. +a| Unique ID to describe the event. type: keyword @@ -3284,7 +3284,7 @@ example: `8a4f500d` [[field-event-ingested]] <> -| Timestamp when an event arrived in the central data store. +a| Timestamp when an event arrived in the central data store. This is different from `@timestamp`, which is when the event originally occurred. It's also different from `event.created`, which is meant to capture the first time an agent saw the event. @@ -3304,7 +3304,7 @@ example: `2016-05-23T08:05:35.101Z` [[field-event-kind]] <> -| This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. +a| This is one of four ECS Categorization Fields, and indicates the highest level in the ECS category hierarchy. `event.kind` gives high-level information about what type of information the event contains, without being specific to the contents of the event. For example, values of this field distinguish alert events from metric events. @@ -3331,7 +3331,7 @@ To learn more about when to use which value, visit the page [[field-event-module]] <> -| Name of the module this data is coming from. +a| Name of the module this data is coming from. If your monitoring agent supports the concept of modules or plugins to process events of a given source (e.g. Apache logs), `event.module` should contain the name of this module. @@ -3349,7 +3349,7 @@ example: `apache` [[field-event-original]] <> -| Raw text message of entire event. Used to demonstrate log integrity or where the full log message (before splitting it up in multiple parts) may be required, e.g. for reindex. +a| Raw text message of entire event. Used to demonstrate log integrity or where the full log message (before splitting it up in multiple parts) may be required, e.g. for reindex. This field is not indexed and doc_values are disabled. It cannot be searched, but it can be retrieved from `_source`. If users wish to override this and index this field, please see `Field data types` in the `Elasticsearch Reference`. @@ -3367,7 +3367,7 @@ example: `Sep 19 08:26:10 host CEF:0|Security| threatmanager|1.0& [[field-event-outcome]] <> -| This is one of four ECS Categorization Fields, and indicates the lowest level in the ECS category hierarchy. +a| This is one of four ECS Categorization Fields, and indicates the lowest level in the ECS category hierarchy. `event.outcome` simply denotes whether the event represents a success or a failure from the perspective of the entity that produced the event. @@ -3398,7 +3398,7 @@ To learn more about when to use which value, visit the page [[field-event-provider]] <> -| Source of the event. +a| Source of the event. Event transports such as Syslog or the Windows Event Log typically mention the source of an event. It can be the name of the software that generated the event (e.g. Sysmon, httpd), or of a subsystem of the operating system (kernel, Microsoft-Windows-Security-Auditing). @@ -3416,7 +3416,7 @@ example: `kernel` [[field-event-reason]] <> -| Reason why this event happened, according to the source. +a| Reason why this event happened, according to the source. This describes the why of a particular action or outcome captured in the event. Where `event.action` captures the action from the event, `event.reason` describes why that action was taken. For example, a web proxy with an `event.action` which denied the request may also populate `event.reason` with the reason why (e.g. `blocked site`). @@ -3434,7 +3434,7 @@ example: `Terminated an unexpected process` [[field-event-reference]] <> -| Reference URL linking to additional information about this event. +a| Reference URL linking to additional information about this event. This URL links to a static definition of this event. Alert events, indicated by `event.kind:alert`, are a common use case for this field. @@ -3452,7 +3452,7 @@ example: `https://system.example.com/event/#0001234` [[field-event-risk-score]] <> -| Risk score or priority of the event (e.g. security solutions). Use your system's original value here. +a| Risk score or priority of the event (e.g. security solutions). Use your system's original value here. type: float @@ -3468,7 +3468,7 @@ type: float [[field-event-risk-score-norm]] <> -| Normalized risk score or priority of the event, on a scale of 0 to 100. +a| Normalized risk score or priority of the event, on a scale of 0 to 100. This is mainly useful if you use more than one system that assigns risk scores, and you want to see a normalized value across all systems. @@ -3486,7 +3486,7 @@ type: float [[field-event-sequence]] <> -| Sequence number of the event. +a| Sequence number of the event. The sequence number is a value published by some event sources, to make the exact ordering of events unambiguous, regardless of the timestamp precision. @@ -3504,7 +3504,7 @@ type: long [[field-event-severity]] <> -| The numeric severity of the event according to your event source. +a| The numeric severity of the event according to your event source. What the different severity values mean can be different between sources and use cases. It's up to the implementer to make sure severities are consistent across events from the same source. @@ -3524,7 +3524,7 @@ example: `7` [[field-event-start]] <> -| event.start contains the date when the event started or when the activity was first observed. +a| event.start contains the date when the event started or when the activity was first observed. type: date @@ -3540,7 +3540,7 @@ type: date [[field-event-timezone]] <> -| This field should be populated when the event's timestamp does not include timezone information already (e.g. default Syslog timestamps). It's optional otherwise. +a| This field should be populated when the event's timestamp does not include timezone information already (e.g. default Syslog timestamps). It's optional otherwise. Acceptable timezone formats are: a canonical ID (e.g. "Europe/Amsterdam"), abbreviated (e.g. "EST") or an HH:mm differential (e.g. "-05:00"). @@ -3558,7 +3558,7 @@ type: keyword [[field-event-type]] <> -| This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy. +a| This is one of four ECS Categorization Fields, and indicates the third level in the ECS category hierarchy. `event.type` represents a categorization "sub-bucket" that, when used along with the `event.category` field values, enables filtering events down to a level appropriate for single visualization. @@ -3588,7 +3588,7 @@ To learn more about when to use which value, visit the page [[field-event-url]] <> -| URL linking to an external system to continue investigation of this event. +a| URL linking to an external system to continue investigation of this event. This URL links to another system where in-depth investigation of the specific occurrence of this event can take place. Alert events, indicated by `event.kind:alert`, are a common use case for this field. @@ -3625,7 +3625,7 @@ beta::[ These fields are in beta and are subject to change.] [[field-faas-coldstart]] <> -| Boolean value indicating a cold start of a function. +a| Boolean value indicating a cold start of a function. type: boolean @@ -3641,7 +3641,7 @@ type: boolean [[field-faas-execution]] <> -| The execution ID of the current function execution. +a| The execution ID of the current function execution. type: keyword @@ -3657,7 +3657,7 @@ example: `af9d5aa4-a685-4c5f-a22b-444f80b3cc28` [[field-faas-id]] <> -| The unique identifier of a serverless function. +a| The unique identifier of a serverless function. For AWS Lambda it's the function ARN (Amazon Resource Name) without a version or alias suffix. @@ -3675,7 +3675,7 @@ example: `arn:aws:lambda:us-west-2:123456789012:function:my-function` [[field-faas-name]] <> -| The name of a serverless function. +a| The name of a serverless function. type: keyword @@ -3691,7 +3691,7 @@ example: `my-function` [[field-faas-trigger]] <> -| Details about the function trigger. +a| Details about the function trigger. type: nested @@ -3707,7 +3707,7 @@ type: nested [[field-faas-trigger-request-id]] <> -| The ID of the trigger request , message, event, etc. +a| The ID of the trigger request , message, event, etc. type: keyword @@ -3723,7 +3723,7 @@ example: `123456789` [[field-faas-trigger-type]] <> -| The trigger for the function execution. +a| The trigger for the function execution. Expected values are: @@ -3751,7 +3751,7 @@ example: `http` [[field-faas-version]] <> -| The version of a serverless function. +a| The version of a serverless function. type: keyword @@ -3786,7 +3786,7 @@ File objects can be associated with host events, network events, and/or file eve [[field-file-accessed]] <> -| Last time the file was accessed. +a| Last time the file was accessed. Note that not all filesystems keep track of access time. @@ -3804,7 +3804,7 @@ type: date [[field-file-attributes]] <> -| Array of file attributes. +a| Array of file attributes. Attributes names will vary by platform. Here's a non-exhaustive list of values that are expected in this field: archive, compressed, directory, encrypted, execute, hidden, read, readonly, system, write. @@ -3825,7 +3825,7 @@ example: `["readonly", "system"]` [[field-file-created]] <> -| File creation time. +a| File creation time. Note that not all filesystems store the creation time. @@ -3843,7 +3843,7 @@ type: date [[field-file-ctime]] <> -| Last time the file attributes or metadata changed. +a| Last time the file attributes or metadata changed. Note that changes to the file content will update `mtime`. This implies `ctime` will be adjusted at the same time, since `mtime` is an attribute of the file. @@ -3861,7 +3861,7 @@ type: date [[field-file-device]] <> -| Device that is the source of the file. +a| Device that is the source of the file. type: keyword @@ -3877,7 +3877,7 @@ example: `sda` [[field-file-directory]] <> -| Directory where the file is located. It should include the drive letter, when appropriate. +a| Directory where the file is located. It should include the drive letter, when appropriate. type: keyword @@ -3893,7 +3893,7 @@ example: `/home/alice` [[field-file-drive-letter]] <> -| Drive letter where the file is located. This field is only relevant on Windows. +a| Drive letter where the file is located. This field is only relevant on Windows. The value should be uppercase, and not include the colon. @@ -3911,7 +3911,7 @@ example: `C` [[field-file-extension]] <> -| File extension, excluding the leading dot. +a| File extension, excluding the leading dot. Note that when the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz"). @@ -3929,7 +3929,7 @@ example: `png` [[field-file-fork-name]] <> -| A fork is additional data associated with a filesystem object. +a| A fork is additional data associated with a filesystem object. On Linux, a resource fork is used to store additional data with a filesystem object. A file always has at least one fork for the data portion, and additional forks may exist. @@ -3949,7 +3949,7 @@ example: `Zone.Identifer` [[field-file-gid]] <> -| Primary group ID (GID) of the file. +a| Primary group ID (GID) of the file. type: keyword @@ -3965,7 +3965,7 @@ example: `1001` [[field-file-group]] <> -| Primary group name of the file. +a| Primary group name of the file. type: keyword @@ -3981,7 +3981,7 @@ example: `alice` [[field-file-inode]] <> -| Inode representing the file in the filesystem. +a| Inode representing the file in the filesystem. type: keyword @@ -3997,7 +3997,7 @@ example: `256383` [[field-file-mime-type]] <> -| MIME type should identify the format of the file or stream of bytes using https://www.iana.org/assignments/media-types/media-types.xhtml[IANA official types], where possible. When more than one type is applicable, the most specific type should be used. +a| MIME type should identify the format of the file or stream of bytes using https://www.iana.org/assignments/media-types/media-types.xhtml[IANA official types], where possible. When more than one type is applicable, the most specific type should be used. type: keyword @@ -4013,7 +4013,7 @@ type: keyword [[field-file-mode]] <> -| Mode of the file in octal representation. +a| Mode of the file in octal representation. type: keyword @@ -4029,7 +4029,7 @@ example: `0640` [[field-file-mtime]] <> -| Last time the file content was modified. +a| Last time the file content was modified. type: date @@ -4045,7 +4045,7 @@ type: date [[field-file-name]] <> -| Name of the file including the extension, without the directory. +a| Name of the file including the extension, without the directory. type: keyword @@ -4061,7 +4061,7 @@ example: `example.png` [[field-file-owner]] <> -| File owner's username. +a| File owner's username. type: keyword @@ -4077,7 +4077,7 @@ example: `alice` [[field-file-path]] <> -| Full path to the file, including the file name. It should include the drive letter, when appropriate. +a| Full path to the file, including the file name. It should include the drive letter, when appropriate. type: keyword @@ -4099,7 +4099,7 @@ example: `/home/alice/example.png` [[field-file-size]] <> -| File size in bytes. +a| File size in bytes. Only relevant when `file.type` is "file". @@ -4117,7 +4117,7 @@ example: `16384` [[field-file-target-path]] <> -| Target path for symlinks. +a| Target path for symlinks. type: keyword @@ -4139,7 +4139,7 @@ Multi-fields: [[field-file-type]] <> -| File type (file, dir, or symlink). +a| File type (file, dir, or symlink). type: keyword @@ -4155,7 +4155,7 @@ example: `file` [[field-file-uid]] <> -| The user ID (UID) or security identifier (SID) of the file owner. +a| The user ID (UID) or security identifier (SID) of the file owner. type: keyword @@ -4252,7 +4252,7 @@ This geolocation information can be derived from techniques such as Geo IP, or b [[field-geo-city-name]] <> -| City name. +a| City name. type: keyword @@ -4268,7 +4268,7 @@ example: `Montreal` [[field-geo-continent-code]] <> -| Two-letter code representing continent's name. +a| Two-letter code representing continent's name. type: keyword @@ -4284,7 +4284,7 @@ example: `NA` [[field-geo-continent-name]] <> -| Name of the continent. +a| Name of the continent. type: keyword @@ -4300,7 +4300,7 @@ example: `North America` [[field-geo-country-iso-code]] <> -| Country ISO code. +a| Country ISO code. type: keyword @@ -4316,7 +4316,7 @@ example: `CA` [[field-geo-country-name]] <> -| Country name. +a| Country name. type: keyword @@ -4332,7 +4332,7 @@ example: `Canada` [[field-geo-location]] <> -| Longitude and latitude. +a| Longitude and latitude. type: geo_point @@ -4348,7 +4348,7 @@ example: `{ "lon": -73.614830, "lat": 45.505918 }` [[field-geo-name]] <> -| User-defined description of a location, at the level of granularity they care about. +a| User-defined description of a location, at the level of granularity they care about. Could be the name of their data centers, the floor number, if this describes a local physical entity, city names. @@ -4368,7 +4368,7 @@ example: `boston-dc` [[field-geo-postal-code]] <> -| Postal code associated with the location. +a| Postal code associated with the location. Values appropriate for this field may also be known as a postcode or ZIP code and will vary widely from country to country. @@ -4386,7 +4386,7 @@ example: `94040` [[field-geo-region-iso-code]] <> -| Region ISO code. +a| Region ISO code. type: keyword @@ -4402,7 +4402,7 @@ example: `CA-QC` [[field-geo-region-name]] <> -| Region name. +a| Region name. type: keyword @@ -4418,7 +4418,7 @@ example: `Quebec` [[field-geo-timezone]] <> -| The time zone of the location, such as IANA time zone name. +a| The time zone of the location, such as IANA time zone name. type: keyword @@ -4474,7 +4474,7 @@ The group fields are meant to represent groups that are relevant to the event. [[field-group-domain]] <> -| Name of the directory the group is a member of. +a| Name of the directory the group is a member of. For example, an LDAP or Active Directory domain name. @@ -4492,7 +4492,7 @@ type: keyword [[field-group-id]] <> -| Unique identifier for the group on the system/platform. +a| Unique identifier for the group on the system/platform. type: keyword @@ -4508,7 +4508,7 @@ type: keyword [[field-group-name]] <> -| Name of the group. +a| Name of the group. type: keyword @@ -4564,7 +4564,7 @@ Note that this fieldset is used for common hashes that may be computed over a ra [[field-hash-md5]] <> -| MD5 hash. +a| MD5 hash. type: keyword @@ -4580,7 +4580,7 @@ type: keyword [[field-hash-sha1]] <> -| SHA1 hash. +a| SHA1 hash. type: keyword @@ -4596,7 +4596,7 @@ type: keyword [[field-hash-sha256]] <> -| SHA256 hash. +a| SHA256 hash. type: keyword @@ -4612,7 +4612,7 @@ type: keyword [[field-hash-sha384]] <> -| SHA384 hash. +a| SHA384 hash. type: keyword @@ -4628,7 +4628,7 @@ type: keyword [[field-hash-sha512]] <> -| SHA512 hash. +a| SHA512 hash. type: keyword @@ -4644,7 +4644,7 @@ type: keyword [[field-hash-ssdeep]] <> -| SSDEEP hash. +a| SSDEEP hash. type: keyword @@ -4660,7 +4660,7 @@ type: keyword [[field-hash-tlsh]] <> -| TLSH hash. +a| TLSH hash. type: keyword @@ -4710,7 +4710,7 @@ ECS host.* fields should be populated with details about the host on which the e [[field-host-architecture]] <> -| Operating system architecture. +a| Operating system architecture. type: keyword @@ -4726,7 +4726,7 @@ example: `x86_64` [[field-host-boot-id]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Linux boot uuid taken from /proc/sys/kernel/random/boot_id. Note the boot_id value from /proc may or may not be the same in containers as on the host. Some container runtimes will bind mount a new boot_id value onto the proc file in each container. @@ -4744,7 +4744,7 @@ example: `88a1f0ed-5ae5-41ee-af6b-41921c311872` [[field-host-cpu-usage]] <> -| Percent CPU used which is normalized by the number of CPU cores and it ranges from 0 to 1. +a| Percent CPU used which is normalized by the number of CPU cores and it ranges from 0 to 1. Scaling factor: 1000. @@ -4764,7 +4764,7 @@ type: scaled_float [[field-host-disk-read-bytes]] <> -| The total number of bytes (gauge) read successfully (aggregated from all disks) since the last metric collection. +a| The total number of bytes (gauge) read successfully (aggregated from all disks) since the last metric collection. type: long @@ -4780,7 +4780,7 @@ type: long [[field-host-disk-write-bytes]] <> -| The total number of bytes (gauge) written successfully (aggregated from all disks) since the last metric collection. +a| The total number of bytes (gauge) written successfully (aggregated from all disks) since the last metric collection. type: long @@ -4796,7 +4796,7 @@ type: long [[field-host-domain]] <> -| Name of the domain of which the host is a member. +a| Name of the domain of which the host is a member. For example, on Windows this could be the host's Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host's LDAP provider. @@ -4814,7 +4814,7 @@ example: `CONTOSO` [[field-host-hostname]] <> -| Hostname of the host. +a| Hostname of the host. It normally contains what the `hostname` command returns on the host machine. @@ -4832,7 +4832,7 @@ type: keyword [[field-host-id]] <> -| Unique host id. +a| Unique host id. As hostname is not always unique, use values that are meaningful in your environment. @@ -4852,7 +4852,7 @@ type: keyword [[field-host-ip]] <> -| Host ip addresses. +a| Host ip addresses. type: ip @@ -4871,7 +4871,7 @@ Note: this field should contain an array of values. [[field-host-mac]] <> -| Host MAC addresses. +a| Host MAC addresses. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. @@ -4892,7 +4892,7 @@ example: `["00-00-5E-00-53-23", "00-00-5E-00-53-24"]` [[field-host-name]] <> -| Name of the host. +a| Name of the host. It can contain what `hostname` returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use. @@ -4910,7 +4910,7 @@ type: keyword [[field-host-network-egress-bytes]] <> -| The number of bytes (gauge) sent out on all network interfaces by the host since the last metric collection. +a| The number of bytes (gauge) sent out on all network interfaces by the host since the last metric collection. type: long @@ -4926,7 +4926,7 @@ type: long [[field-host-network-egress-packets]] <> -| The number of packets (gauge) sent out on all network interfaces by the host since the last metric collection. +a| The number of packets (gauge) sent out on all network interfaces by the host since the last metric collection. type: long @@ -4942,7 +4942,7 @@ type: long [[field-host-network-ingress-bytes]] <> -| The number of bytes received (gauge) on all network interfaces by the host since the last metric collection. +a| The number of bytes received (gauge) on all network interfaces by the host since the last metric collection. type: long @@ -4958,7 +4958,7 @@ type: long [[field-host-network-ingress-packets]] <> -| The number of packets (gauge) received on all network interfaces by the host since the last metric collection. +a| The number of packets (gauge) received on all network interfaces by the host since the last metric collection. type: long @@ -4974,7 +4974,7 @@ type: long [[field-host-pid-ns-ino]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] This is the inode number of the namespace in the namespace file system (nsfs). Unsigned int inum in include/linux/ns_common.h. @@ -4992,7 +4992,7 @@ example: `256383` [[field-host-type]] <> -| Type of host. +a| Type of host. For Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment. @@ -5010,7 +5010,7 @@ type: keyword [[field-host-uptime]] <> -| Seconds the host has been up. +a| Seconds the host has been up. type: long @@ -5073,7 +5073,7 @@ Fields related to HTTP activity. Use the `url` field set to store the url of the [[field-http-request-body-bytes]] <> -| Size in bytes of the request body. +a| Size in bytes of the request body. type: long @@ -5089,7 +5089,7 @@ example: `887` [[field-http-request-body-content]] <> -| The full HTTP request body. +a| The full HTTP request body. type: wildcard @@ -5111,7 +5111,7 @@ example: `Hello world` [[field-http-request-bytes]] <> -| Total size in bytes of the request (body and headers). +a| Total size in bytes of the request (body and headers). type: long @@ -5127,7 +5127,7 @@ example: `1437` [[field-http-request-id]] <> -| A unique identifier for each HTTP request to correlate logs between clients and servers in transactions. +a| A unique identifier for each HTTP request to correlate logs between clients and servers in transactions. The id may be contained in a non-standard HTTP header, such as `X-Request-ID` or `X-Correlation-ID`. @@ -5145,7 +5145,7 @@ example: `123e4567-e89b-12d3-a456-426614174000` [[field-http-request-method]] <> -| HTTP request method. +a| HTTP request method. The value should retain its casing from the original event. For example, `GET`, `get`, and `GeT` are all considered valid values for this field. @@ -5163,7 +5163,7 @@ example: `POST` [[field-http-request-mime-type]] <> -| Mime type of the body of the request. +a| Mime type of the body of the request. This value must only be populated based on the content of the request body, not on the `Content-Type` header. Comparing the mime type of a request with the request's Content-Type header can be helpful in detecting threats or misconfigured clients. @@ -5181,7 +5181,7 @@ example: `image/gif` [[field-http-request-referrer]] <> -| Referrer for this HTTP request. +a| Referrer for this HTTP request. type: keyword @@ -5197,7 +5197,7 @@ example: `https://blog.example.com/` [[field-http-response-body-bytes]] <> -| Size in bytes of the response body. +a| Size in bytes of the response body. type: long @@ -5213,7 +5213,7 @@ example: `887` [[field-http-response-body-content]] <> -| The full HTTP response body. +a| The full HTTP response body. type: wildcard @@ -5235,7 +5235,7 @@ example: `Hello world` [[field-http-response-bytes]] <> -| Total size in bytes of the response (body and headers). +a| Total size in bytes of the response (body and headers). type: long @@ -5251,7 +5251,7 @@ example: `1437` [[field-http-response-mime-type]] <> -| Mime type of the body of the response. +a| Mime type of the body of the response. This value must only be populated based on the content of the response body, not on the `Content-Type` header. Comparing the mime type of a response with the response's Content-Type header can be helpful in detecting misconfigured servers. @@ -5269,7 +5269,7 @@ example: `image/gif` [[field-http-response-status-code]] <> -| HTTP response status code. +a| HTTP response status code. type: long @@ -5285,7 +5285,7 @@ example: `404` [[field-http-version]] <> -| HTTP version. +a| HTTP version. type: keyword @@ -5318,7 +5318,7 @@ The interface fields are used to record ingress and egress interface information [[field-interface-alias]] <> -| Interface alias as reported by the system, typically used in firewall implementations for e.g. inside, outside, or dmz logical interface naming. +a| Interface alias as reported by the system, typically used in firewall implementations for e.g. inside, outside, or dmz logical interface naming. type: keyword @@ -5334,7 +5334,7 @@ example: `outside` [[field-interface-id]] <> -| Interface ID as reported by an observer (typically SNMP interface ID). +a| Interface ID as reported by an observer (typically SNMP interface ID). type: keyword @@ -5350,7 +5350,7 @@ example: `10` [[field-interface-name]] <> -| Interface name as reported by the system. +a| Interface name as reported by the system. type: keyword @@ -5398,7 +5398,7 @@ The details specific to your event source are typically not logged under `log.*` [[field-log-file-path]] <> -| Full path to the log file this event came from, including the file name. It should include the drive letter, when appropriate. +a| Full path to the log file this event came from, including the file name. It should include the drive letter, when appropriate. If the event wasn't read from a log file, do not populate this field. @@ -5416,7 +5416,7 @@ example: `/var/log/fun-times.log` [[field-log-level]] <> -| Original log level of the log event. +a| Original log level of the log event. If the source of the event provides a log level or textual severity, this is the one that goes in `log.level`. If your source doesn't specify one, you may put your event transport's severity here (e.g. Syslog severity). @@ -5436,7 +5436,7 @@ example: `error` [[field-log-logger]] <> -| The name of the logger inside an application. This is usually the name of the class which initialized the logger, or can be a custom name. +a| The name of the logger inside an application. This is usually the name of the class which initialized the logger, or can be a custom name. type: keyword @@ -5452,7 +5452,7 @@ example: `org.elasticsearch.bootstrap.Bootstrap` [[field-log-origin-file-line]] <> -| The line number of the file containing the source code which originated the log event. +a| The line number of the file containing the source code which originated the log event. type: long @@ -5468,7 +5468,7 @@ example: `42` [[field-log-origin-file-name]] <> -| The name of the file containing the source code which originated the log event. +a| The name of the file containing the source code which originated the log event. Note that this field is not meant to capture the log file. The correct field to capture the log file is `log.file.path`. @@ -5486,7 +5486,7 @@ example: `Bootstrap.java` [[field-log-origin-function]] <> -| The name of the function or method which originated the log event. +a| The name of the function or method which originated the log event. type: keyword @@ -5502,7 +5502,7 @@ example: `init` [[field-log-syslog]] <> -| The Syslog metadata of the event, if the event was transmitted via Syslog. Please see RFCs 5424 or 3164. +a| The Syslog metadata of the event, if the event was transmitted via Syslog. Please see RFCs 5424 or 3164. type: object @@ -5518,7 +5518,7 @@ type: object [[field-log-syslog-appname]] <> -| The device or application that originated the Syslog message, if available. +a| The device or application that originated the Syslog message, if available. type: keyword @@ -5534,7 +5534,7 @@ example: `sshd` [[field-log-syslog-facility-code]] <> -| The Syslog numeric facility of the log event, if available. +a| The Syslog numeric facility of the log event, if available. According to RFCs 5424 and 3164, this value should be an integer between 0 and 23. @@ -5552,7 +5552,7 @@ example: `23` [[field-log-syslog-facility-name]] <> -| The Syslog text-based facility of the log event, if available. +a| The Syslog text-based facility of the log event, if available. type: keyword @@ -5568,7 +5568,7 @@ example: `local7` [[field-log-syslog-hostname]] <> -| The hostname, FQDN, or IP of the machine that originally sent the Syslog message. This is sourced from the hostname field of the syslog header. Depending on the environment, this value may be different from the host that handled the event, especially if the host handling the events is acting as a collector. +a| The hostname, FQDN, or IP of the machine that originally sent the Syslog message. This is sourced from the hostname field of the syslog header. Depending on the environment, this value may be different from the host that handled the event, especially if the host handling the events is acting as a collector. type: keyword @@ -5584,7 +5584,7 @@ example: `example-host` [[field-log-syslog-msgid]] <> -| An identifier for the type of Syslog message, if available. Only applicable for RFC 5424 messages. +a| An identifier for the type of Syslog message, if available. Only applicable for RFC 5424 messages. type: keyword @@ -5600,7 +5600,7 @@ example: `ID47` [[field-log-syslog-priority]] <> -| Syslog numeric priority of the event, if available. +a| Syslog numeric priority of the event, if available. According to RFCs 5424 and 3164, the priority is 8 * facility + severity. This number is therefore expected to contain a value between 0 and 191. @@ -5618,7 +5618,7 @@ example: `135` [[field-log-syslog-procid]] <> -| The process name or ID that originated the Syslog message, if available. +a| The process name or ID that originated the Syslog message, if available. type: keyword @@ -5634,7 +5634,7 @@ example: `12345` [[field-log-syslog-severity-code]] <> -| The Syslog numeric severity of the log event, if available. +a| The Syslog numeric severity of the log event, if available. If the event source publishing via Syslog provides a different numeric severity value (e.g. firewall, IDS), your source's numeric severity should go to `event.severity`. If the event source does not specify a distinct severity, you can optionally copy the Syslog severity to `event.severity`. @@ -5652,7 +5652,7 @@ example: `3` [[field-log-syslog-severity-name]] <> -| The Syslog numeric severity of the log event, if available. +a| The Syslog numeric severity of the log event, if available. If the event source publishing via Syslog provides a different severity value (e.g. firewall, IDS), your source's text severity should go to `log.level`. If the event source does not specify a distinct severity, you can optionally copy the Syslog severity to `log.level`. @@ -5670,7 +5670,7 @@ example: `Error` [[field-log-syslog-structured-data]] <> -| Structured data expressed in RFC 5424 messages, if available. These are key-value pairs formed from the structured data portion of the syslog message, as defined in RFC 5424 Section 6.3. +a| Structured data expressed in RFC 5424 messages, if available. These are key-value pairs formed from the structured data portion of the syslog message, as defined in RFC 5424 Section 6.3. type: flattened @@ -5686,7 +5686,7 @@ type: flattened [[field-log-syslog-version]] <> -| The version of the Syslog protocol specification. Only applicable for RFC 5424 messages. +a| The version of the Syslog protocol specification. Only applicable for RFC 5424 messages. type: keyword @@ -5721,7 +5721,7 @@ The network.* fields should be populated with details about the network activity [[field-network-application]] <> -| When a specific application or service is identified from network connection details (source/dest IPs, ports, certificates, or wire format), this field captures the application's or service's name. +a| When a specific application or service is identified from network connection details (source/dest IPs, ports, certificates, or wire format), this field captures the application's or service's name. For example, the original event identifies the network connection being from a specific web service in a `https` network connection, like `facebook` or `twitter`. @@ -5741,7 +5741,7 @@ example: `aim` [[field-network-bytes]] <> -| Total bytes transferred in both directions. +a| Total bytes transferred in both directions. If `source.bytes` and `destination.bytes` are known, `network.bytes` is their sum. @@ -5759,7 +5759,7 @@ example: `368` [[field-network-community-id]] <> -| A hash of source and destination IPs and ports, as well as the protocol used in a communication. This is a tool-agnostic standard to identify flows. +a| A hash of source and destination IPs and ports, as well as the protocol used in a communication. This is a tool-agnostic standard to identify flows. Learn more at https://github.com/corelight/community-id-spec. @@ -5777,7 +5777,7 @@ example: `1:hO+sN4H+MG5MY/8hIrXPqc4ZQz0=` [[field-network-direction]] <> -| Direction of the network traffic. +a| Direction of the network traffic. Recommended values are: @@ -5817,7 +5817,7 @@ example: `inbound` [[field-network-forwarded-ip]] <> -| Host IP address when the source IP address is the proxy. +a| Host IP address when the source IP address is the proxy. type: ip @@ -5833,7 +5833,7 @@ example: `192.1.1.2` [[field-network-iana-number]] <> -| IANA Protocol Number (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Standardized list of protocols. This aligns well with NetFlow and sFlow related logs which use the IANA Protocol Number. +a| IANA Protocol Number (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Standardized list of protocols. This aligns well with NetFlow and sFlow related logs which use the IANA Protocol Number. type: keyword @@ -5849,7 +5849,7 @@ example: `6` [[field-network-inner]] <> -| Network.inner fields are added in addition to network.vlan fields to describe the innermost VLAN when q-in-q VLAN tagging is present. Allowed fields include vlan.id and vlan.name. Inner vlan fields are typically used when sending traffic with multiple 802.1q encapsulations to a network sensor (e.g. Zeek, Wireshark.) +a| Network.inner fields are added in addition to network.vlan fields to describe the innermost VLAN when q-in-q VLAN tagging is present. Allowed fields include vlan.id and vlan.name. Inner vlan fields are typically used when sending traffic with multiple 802.1q encapsulations to a network sensor (e.g. Zeek, Wireshark.) type: object @@ -5865,7 +5865,7 @@ type: object [[field-network-name]] <> -| Name given by operators to sections of their network. +a| Name given by operators to sections of their network. type: keyword @@ -5881,7 +5881,7 @@ example: `Guest Wifi` [[field-network-packets]] <> -| Total packets transferred in both directions. +a| Total packets transferred in both directions. If `source.packets` and `destination.packets` are known, `network.packets` is their sum. @@ -5899,7 +5899,7 @@ example: `24` [[field-network-protocol]] <> -| In the OSI Model this would be the Application Layer protocol. For example, `http`, `dns`, or `ssh`. +a| In the OSI Model this would be the Application Layer protocol. For example, `http`, `dns`, or `ssh`. The field value must be normalized to lowercase for querying. @@ -5917,7 +5917,7 @@ example: `http` [[field-network-transport]] <> -| Same as network.iana_number, but instead using the Keyword name of the transport layer (udp, tcp, ipv6-icmp, etc.) +a| Same as network.iana_number, but instead using the Keyword name of the transport layer (udp, tcp, ipv6-icmp, etc.) The field value must be normalized to lowercase for querying. @@ -5935,7 +5935,7 @@ example: `tcp` [[field-network-type]] <> -| In the OSI Model this would be the Network Layer. ipv4, ipv6, ipsec, pim, etc +a| In the OSI Model this would be the Network Layer. ipv4, ipv6, ipsec, pim, etc The field value must be normalized to lowercase for querying. @@ -6002,7 +6002,7 @@ This could be a custom hardware appliance or a server that has been configured t [[field-observer-egress]] <> -| Observer.egress holds information like interface number and name, vlan, and zone information to classify egress traffic. Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic. +a| Observer.egress holds information like interface number and name, vlan, and zone information to classify egress traffic. Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic. type: object @@ -6018,7 +6018,7 @@ type: object [[field-observer-egress-zone]] <> -| Network zone of outbound traffic as reported by the observer to categorize the destination area of egress traffic, e.g. Internal, External, DMZ, HR, Legal, etc. +a| Network zone of outbound traffic as reported by the observer to categorize the destination area of egress traffic, e.g. Internal, External, DMZ, HR, Legal, etc. type: keyword @@ -6034,7 +6034,7 @@ example: `Public_Internet` [[field-observer-hostname]] <> -| Hostname of the observer. +a| Hostname of the observer. type: keyword @@ -6050,7 +6050,7 @@ type: keyword [[field-observer-ingress]] <> -| Observer.ingress holds information like interface number and name, vlan, and zone information to classify ingress traffic. Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic. +a| Observer.ingress holds information like interface number and name, vlan, and zone information to classify ingress traffic. Single armed monitoring such as a network sensor on a span port should only use observer.ingress to categorize traffic. type: object @@ -6066,7 +6066,7 @@ type: object [[field-observer-ingress-zone]] <> -| Network zone of incoming traffic as reported by the observer to categorize the source area of ingress traffic. e.g. internal, External, DMZ, HR, Legal, etc. +a| Network zone of incoming traffic as reported by the observer to categorize the source area of ingress traffic. e.g. internal, External, DMZ, HR, Legal, etc. type: keyword @@ -6082,7 +6082,7 @@ example: `DMZ` [[field-observer-ip]] <> -| IP addresses of the observer. +a| IP addresses of the observer. type: ip @@ -6101,7 +6101,7 @@ Note: this field should contain an array of values. [[field-observer-mac]] <> -| MAC addresses of the observer. +a| MAC addresses of the observer. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. @@ -6122,7 +6122,7 @@ example: `["00-00-5E-00-53-23", "00-00-5E-00-53-24"]` [[field-observer-name]] <> -| Custom name of the observer. +a| Custom name of the observer. This is a name that can be given to an observer. This can be helpful for example if multiple firewalls of the same model are used in an organization. @@ -6142,7 +6142,7 @@ example: `1_proxySG` [[field-observer-product]] <> -| The product name of the observer. +a| The product name of the observer. type: keyword @@ -6158,7 +6158,7 @@ example: `s200` [[field-observer-serial-number]] <> -| Observer serial number. +a| Observer serial number. type: keyword @@ -6174,7 +6174,7 @@ type: keyword [[field-observer-type]] <> -| The type of the observer the data is coming from. +a| The type of the observer the data is coming from. There is no predefined list of observer types. Some examples are `forwarder`, `firewall`, `ids`, `ips`, `proxy`, `poller`, `sensor`, `APM server`. @@ -6192,7 +6192,7 @@ example: `firewall` [[field-observer-vendor]] <> -| Vendor name of the observer. +a| Vendor name of the observer. type: keyword @@ -6208,7 +6208,7 @@ example: `Symantec` [[field-observer-version]] <> -| Observer version. +a| Observer version. type: keyword @@ -6299,7 +6299,7 @@ Fields that describe the resources which container orchestrators manage or act u [[field-orchestrator-api-version]] <> -| API version being used to carry out the action +a| API version being used to carry out the action type: keyword @@ -6315,7 +6315,7 @@ example: `v1beta1` [[field-orchestrator-cluster-id]] <> -| Unique ID of the cluster. +a| Unique ID of the cluster. type: keyword @@ -6331,7 +6331,7 @@ type: keyword [[field-orchestrator-cluster-name]] <> -| Name of the cluster. +a| Name of the cluster. type: keyword @@ -6347,7 +6347,7 @@ type: keyword [[field-orchestrator-cluster-url]] <> -| URL of the API used to manage the cluster. +a| URL of the API used to manage the cluster. type: keyword @@ -6363,7 +6363,7 @@ type: keyword [[field-orchestrator-cluster-version]] <> -| The version of the cluster. +a| The version of the cluster. type: keyword @@ -6379,7 +6379,7 @@ type: keyword [[field-orchestrator-namespace]] <> -| Namespace in which the action is taking place. +a| Namespace in which the action is taking place. type: keyword @@ -6395,7 +6395,7 @@ example: `kube-system` [[field-orchestrator-organization]] <> -| Organization affected by the event (for multi-tenant orchestrator setups). +a| Organization affected by the event (for multi-tenant orchestrator setups). type: keyword @@ -6411,7 +6411,7 @@ example: `elastic` [[field-orchestrator-resource-id]] <> -| Unique ID of the resource being acted upon. +a| Unique ID of the resource being acted upon. type: keyword @@ -6427,7 +6427,7 @@ type: keyword [[field-orchestrator-resource-ip]] <> -| IP address assigned to the resource associated with the event being observed. In the case of a Kubernetes Pod, this array would contain only one element: the IP of the Pod (as opposed to the Node on which the Pod is running). +a| IP address assigned to the resource associated with the event being observed. In the case of a Kubernetes Pod, this array would contain only one element: the IP of the Pod (as opposed to the Node on which the Pod is running). type: ip @@ -6446,7 +6446,7 @@ Note: this field should contain an array of values. [[field-orchestrator-resource-name]] <> -| Name of the resource being acted upon. +a| Name of the resource being acted upon. type: keyword @@ -6462,7 +6462,7 @@ example: `test-pod-cdcws` [[field-orchestrator-resource-parent-type]] <> -| Type or kind of the parent resource associated with the event being observed. In Kubernetes, this will be the name of a built-in workload resource (e.g., Deployment, StatefulSet, DaemonSet). +a| Type or kind of the parent resource associated with the event being observed. In Kubernetes, this will be the name of a built-in workload resource (e.g., Deployment, StatefulSet, DaemonSet). type: keyword @@ -6478,7 +6478,7 @@ example: `DaemonSet` [[field-orchestrator-resource-type]] <> -| Type of resource being acted upon. +a| Type of resource being acted upon. type: keyword @@ -6494,7 +6494,7 @@ example: `service` [[field-orchestrator-type]] <> -| Orchestrator cluster type (e.g. kubernetes, nomad or cloudfoundry). +a| Orchestrator cluster type (e.g. kubernetes, nomad or cloudfoundry). type: keyword @@ -6529,7 +6529,7 @@ These fields help you arrange or filter data stored in an index by one or multip [[field-organization-id]] <> -| Unique identifier for the organization. +a| Unique identifier for the organization. type: keyword @@ -6545,7 +6545,7 @@ type: keyword [[field-organization-name]] <> -| Organization name. +a| Organization name. type: keyword @@ -6584,7 +6584,7 @@ The OS fields contain information about the operating system. [[field-os-family]] <> -| OS family (such as redhat, debian, freebsd, windows). +a| OS family (such as redhat, debian, freebsd, windows). type: keyword @@ -6600,7 +6600,7 @@ example: `debian` [[field-os-full]] <> -| Operating system name, including the version or code name. +a| Operating system name, including the version or code name. type: keyword @@ -6622,7 +6622,7 @@ example: `Mac OS Mojave` [[field-os-kernel]] <> -| Operating system kernel version as a raw string. +a| Operating system kernel version as a raw string. type: keyword @@ -6638,7 +6638,7 @@ example: `4.4.0-112-generic` [[field-os-name]] <> -| Operating system name, without the version. +a| Operating system name, without the version. type: keyword @@ -6660,7 +6660,7 @@ example: `Mac OS X` [[field-os-platform]] <> -| Operating system platform (such centos, ubuntu, windows). +a| Operating system platform (such centos, ubuntu, windows). type: keyword @@ -6676,7 +6676,7 @@ example: `darwin` [[field-os-type]] <> -| Use the `os.type` field to categorize the operating system into one of the broad commercial families. +a| Use the `os.type` field to categorize the operating system into one of the broad commercial families. One of these following values should be used (lowercase): linux, macos, unix, windows. @@ -6696,7 +6696,7 @@ example: `macos` [[field-os-version]] <> -| Operating system version as a raw string. +a| Operating system version as a raw string. type: keyword @@ -6742,7 +6742,7 @@ These fields contain information about an installed software package. It contain [[field-package-architecture]] <> -| Package architecture. +a| Package architecture. type: keyword @@ -6758,7 +6758,7 @@ example: `x86_64` [[field-package-build-version]] <> -| Additional information about the build version of the installed package. +a| Additional information about the build version of the installed package. For example use the commit SHA of a non-released package. @@ -6776,7 +6776,7 @@ example: `36f4f7e89dd61b0988b12ee000b98966867710cd` [[field-package-checksum]] <> -| Checksum of the installed package for verification. +a| Checksum of the installed package for verification. type: keyword @@ -6792,7 +6792,7 @@ example: `68b329da9893e34099c7d8ad5cb9c940` [[field-package-description]] <> -| Description of the package. +a| Description of the package. type: keyword @@ -6808,7 +6808,7 @@ example: `Open source programming language to build simple/reliable/efficient so [[field-package-install-scope]] <> -| Indicating how the package was installed, e.g. user-local, global. +a| Indicating how the package was installed, e.g. user-local, global. type: keyword @@ -6824,7 +6824,7 @@ example: `global` [[field-package-installed]] <> -| Time when package was installed. +a| Time when package was installed. type: date @@ -6840,7 +6840,7 @@ type: date [[field-package-license]] <> -| License under which the package was released. +a| License under which the package was released. Use a short name, e.g. the license identifier from SPDX License List where possible (https://spdx.org/licenses/). @@ -6858,7 +6858,7 @@ example: `Apache License 2.0` [[field-package-name]] <> -| Package name +a| Package name type: keyword @@ -6874,7 +6874,7 @@ example: `go` [[field-package-path]] <> -| Path where the package is installed. +a| Path where the package is installed. type: keyword @@ -6890,7 +6890,7 @@ example: `/usr/local/Cellar/go/1.12.9/` [[field-package-reference]] <> -| Home page or reference URL of the software in this package, if available. +a| Home page or reference URL of the software in this package, if available. type: keyword @@ -6906,7 +6906,7 @@ example: `https://golang.org` [[field-package-size]] <> -| Package size in bytes. +a| Package size in bytes. type: long @@ -6922,7 +6922,7 @@ example: `62231` [[field-package-type]] <> -| Type of package. +a| Type of package. This should contain the package file type, rather than the package manager name. Examples: rpm, dpkg, brew, npm, gem, nupkg, jar. @@ -6940,7 +6940,7 @@ example: `rpm` [[field-package-version]] <> -| Package version +a| Package version type: keyword @@ -6973,7 +6973,7 @@ These fields contain Windows Portable Executable (PE) metadata. [[field-pe-architecture]] <> -| CPU architecture target for the file. +a| CPU architecture target for the file. type: keyword @@ -6989,7 +6989,7 @@ example: `x64` [[field-pe-company]] <> -| Internal company name of the file, provided at compile-time. +a| Internal company name of the file, provided at compile-time. type: keyword @@ -7005,7 +7005,7 @@ example: `Microsoft Corporation` [[field-pe-description]] <> -| Internal description of the file, provided at compile-time. +a| Internal description of the file, provided at compile-time. type: keyword @@ -7021,7 +7021,7 @@ example: `Paint` [[field-pe-file-version]] <> -| Internal version of the file, provided at compile-time. +a| Internal version of the file, provided at compile-time. type: keyword @@ -7037,7 +7037,7 @@ example: `6.3.9600.17415` [[field-pe-imphash]] <> -| A hash of the imports in a PE file. An imphash -- or import hash -- can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values. +a| A hash of the imports in a PE file. An imphash -- or import hash -- can be used to fingerprint binaries even after recompilation or other code-level transformations have occurred, which would change more traditional hash values. Learn more at https://www.fireeye.com/blog/threat-research/2014/01/tracking-malware-import-hashing.html. @@ -7055,7 +7055,7 @@ example: `0c6803c4e922103c4dca5963aad36ddf` [[field-pe-original-file-name]] <> -| Internal name of the file, provided at compile-time. +a| Internal name of the file, provided at compile-time. type: keyword @@ -7071,7 +7071,7 @@ example: `MSPAINT.EXE` [[field-pe-pehash]] <> -| A hash of the PE header and data from one or more PE sections. An pehash can be used to cluster files by transforming structural information about a file into a hash value. +a| A hash of the PE header and data from one or more PE sections. An pehash can be used to cluster files by transforming structural information about a file into a hash value. Learn more at https://www.usenix.org/legacy/events/leet09/tech/full_papers/wicherski/wicherski_html/index.html. @@ -7089,7 +7089,7 @@ example: `73ff189b63cd6be375a7ff25179a38d347651975` [[field-pe-product]] <> -| Internal product name of the file, provided at compile-time. +a| Internal product name of the file, provided at compile-time. type: keyword @@ -7137,7 +7137,7 @@ These fields can help you correlate metrics information with a process id/name f [[field-process-args]] <> -| Array of process arguments, starting with the absolute path to the executable. +a| Array of process arguments, starting with the absolute path to the executable. May be filtered to protect sensitive information. @@ -7158,7 +7158,7 @@ example: `["/usr/bin/ssh", "-l", "user", "10.0.0.16"]` [[field-process-args-count]] <> -| Length of the process.args array. +a| Length of the process.args array. This field can be useful for querying or performing bucket analysis on how many arguments were provided to start a process. More arguments may be an indication of suspicious activity. @@ -7176,7 +7176,7 @@ example: `4` [[field-process-command-line]] <> -| Full command line that started the process, including the absolute path to the executable, and all arguments. +a| Full command line that started the process, including the absolute path to the executable, and all arguments. Some arguments may be filtered to protect sensitive information. @@ -7200,7 +7200,7 @@ example: `/usr/bin/ssh -l user 10.0.0.16` [[field-process-end]] <> -| The time the process ended. +a| The time the process ended. type: date @@ -7216,7 +7216,7 @@ example: `2016-05-23T08:05:34.853Z` [[field-process-entity-id]] <> -| Unique identifier for the process. +a| Unique identifier for the process. The implementation of this is specified by the data source, but some examples of what could be used here are a process-generated UUID, Sysmon Process GUIDs, or a hash of some uniquely identifying components of a process. @@ -7236,7 +7236,7 @@ example: `c2c455d9f99375d` [[field-process-entry-meta-type]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] The entry type for the entry session leader. Values include: init(e.g systemd), sshd, ssm, kubelet, teleport, terminal, console @@ -7256,7 +7256,7 @@ type: keyword [[field-process-env-vars]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Environment variables (`env_vars`) set at the time of the event. May be filtered to protect sensitive information. @@ -7276,7 +7276,7 @@ example: `{"USER": "elastic","LANG": "en_US.UTF-8","HOME": "/home/elastic"}` [[field-process-executable]] <> -| Absolute path to the process executable. +a| Absolute path to the process executable. type: keyword @@ -7298,7 +7298,7 @@ example: `/usr/bin/ssh` [[field-process-exit-code]] <> -| The exit code of the process, if this is a termination event. +a| The exit code of the process, if this is a termination event. The field should be absent if there is no exit code for the event (e.g. process start). @@ -7316,7 +7316,7 @@ example: `137` [[field-process-interactive]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Whether the process is connected to an interactive shell. @@ -7338,7 +7338,7 @@ example: `True` [[field-process-name]] <> -| Process name. +a| Process name. Sometimes called program name or similar. @@ -7362,7 +7362,7 @@ example: `ssh` [[field-process-pgid]] <> -| Deprecated for removal in next major version release. This field is superseded by `process.group_leader.pid`. +a| Deprecated for removal in next major version release. This field is superseded by `process.group_leader.pid`. Identifier of the group of processes the process belongs to. @@ -7380,7 +7380,7 @@ type: long [[field-process-pid]] <> -| Process id. +a| Process id. type: long @@ -7396,7 +7396,7 @@ example: `4242` [[field-process-same-as-process]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] This boolean is used to identify if a leader process is the same as the top level process. @@ -7422,7 +7422,7 @@ example: `True` [[field-process-start]] <> -| The time the process started. +a| The time the process started. type: date @@ -7438,7 +7438,7 @@ example: `2016-05-23T08:05:34.853Z` [[field-process-thread-id]] <> -| Thread ID. +a| Thread ID. type: long @@ -7454,7 +7454,7 @@ example: `4242` [[field-process-thread-name]] <> -| Thread name. +a| Thread name. type: keyword @@ -7470,7 +7470,7 @@ example: `thread-0` [[field-process-title]] <> -| Process title. +a| Process title. The proctitle, some times the same as process name. Can also be different: for example a browser setting its title to the web page currently opened. @@ -7494,7 +7494,7 @@ Multi-fields: [[field-process-tty]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Information about the controlling TTY device. If set, the process belongs to an interactive session. @@ -7512,7 +7512,7 @@ type: object [[field-process-tty-char-device-major]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] The major number identifies the driver associated with the device. The character device's major and minor numbers can be algorithmically combined to produce the more familiar terminal identifiers such as "ttyS0" and "pts/0. For more details, please refer to the Linux kernel documentation. @@ -7530,7 +7530,7 @@ example: `1` [[field-process-tty-char-device-minor]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] The minor number is used only by the driver specified by the major number; other parts of the kernel don’t use it, and merely pass it along to the driver. It is common for a driver to control several devices; the minor number provides a way for the driver to differentiate among them. @@ -7548,7 +7548,7 @@ example: `128` [[field-process-uptime]] <> -| Seconds the process has been up. +a| Seconds the process has been up. type: long @@ -7564,7 +7564,7 @@ example: `1325` [[field-process-working-directory]] <> -| The working directory of the process. +a| The working directory of the process. type: keyword @@ -7821,7 +7821,7 @@ Fields related to Windows Registry operations. [[field-registry-data-bytes]] <> -| Original bytes written with base64 encoding. +a| Original bytes written with base64 encoding. For Windows registry operations, such as SetValueEx and RegQueryValueEx, this corresponds to the data pointed by `lp_data`. This is optional but provides better recoverability and should be populated for REG_BINARY encoded values. @@ -7839,7 +7839,7 @@ example: `ZQBuAC0AVQBTAAAAZQBuAAAAAAA=` [[field-registry-data-strings]] <> -| Content when writing string types. +a| Content when writing string types. Populated as an array when writing string data to the registry. For single string registry types (REG_SZ, REG_EXPAND_SZ), this should be an array with one string. For sequences of string with REG_MULTI_SZ, this array will be variable length. For numeric data, such as REG_DWORD and REG_QWORD, this should be populated with the decimal representation (e.g `"1"`). @@ -7860,7 +7860,7 @@ example: `["C:\rta\red_ttp\bin\myapp.exe"]` [[field-registry-data-type]] <> -| Standard registry type for encoding contents +a| Standard registry type for encoding contents type: keyword @@ -7876,7 +7876,7 @@ example: `REG_SZ` [[field-registry-hive]] <> -| Abbreviated name for the hive. +a| Abbreviated name for the hive. type: keyword @@ -7892,7 +7892,7 @@ example: `HKLM` [[field-registry-key]] <> -| Hive-relative path of keys. +a| Hive-relative path of keys. type: keyword @@ -7908,7 +7908,7 @@ example: `SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution Opti [[field-registry-path]] <> -| Full path, including hive, key and value +a| Full path, including hive, key and value type: keyword @@ -7924,7 +7924,7 @@ example: `HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Image File Execution [[field-registry-value]] <> -| Name of the value written. +a| Name of the value written. type: keyword @@ -7974,7 +7974,7 @@ A concrete example is IP addresses, which can be under host, observer, source, d [[field-related-hash]] <> -| All the hashes seen on your event. Populating this field, then using it to search for hashes can help in situations where you're unsure what the hash algorithm is (and therefore which key name to search). +a| All the hashes seen on your event. Populating this field, then using it to search for hashes can help in situations where you're unsure what the hash algorithm is (and therefore which key name to search). type: keyword @@ -7993,7 +7993,7 @@ Note: this field should contain an array of values. [[field-related-hosts]] <> -| All hostnames or other host identifiers seen on your event. Example identifiers include FQDNs, domain names, workstation names, or aliases. +a| All hostnames or other host identifiers seen on your event. Example identifiers include FQDNs, domain names, workstation names, or aliases. type: keyword @@ -8012,7 +8012,7 @@ Note: this field should contain an array of values. [[field-related-ip]] <> -| All of the IPs seen on your event. +a| All of the IPs seen on your event. type: ip @@ -8031,7 +8031,7 @@ Note: this field should contain an array of values. [[field-related-user]] <> -| All the user names or other user identifiers seen on the event. +a| All the user names or other user identifiers seen on the event. type: keyword @@ -8069,7 +8069,7 @@ Examples of data sources that would populate the rule fields include: network ad [[field-rule-author]] <> -| Name, organization, or pseudonym of the author or authors who created the rule used to generate this event. +a| Name, organization, or pseudonym of the author or authors who created the rule used to generate this event. type: keyword @@ -8088,7 +8088,7 @@ example: `["Star-Lord"]` [[field-rule-category]] <> -| A categorization value keyword used by the entity using the rule for detection of this event. +a| A categorization value keyword used by the entity using the rule for detection of this event. type: keyword @@ -8104,7 +8104,7 @@ example: `Attempted Information Leak` [[field-rule-description]] <> -| The description of the rule generating the event. +a| The description of the rule generating the event. type: keyword @@ -8120,7 +8120,7 @@ example: `Block requests to public DNS over HTTPS / TLS protocols` [[field-rule-id]] <> -| A rule ID that is unique within the scope of an agent, observer, or other entity using the rule for detection of this event. +a| A rule ID that is unique within the scope of an agent, observer, or other entity using the rule for detection of this event. type: keyword @@ -8136,7 +8136,7 @@ example: `101` [[field-rule-license]] <> -| Name of the license under which the rule used to generate this event is made available. +a| Name of the license under which the rule used to generate this event is made available. type: keyword @@ -8152,7 +8152,7 @@ example: `Apache 2.0` [[field-rule-name]] <> -| The name of the rule or signature generating the event. +a| The name of the rule or signature generating the event. type: keyword @@ -8168,7 +8168,7 @@ example: `BLOCK_DNS_over_TLS` [[field-rule-reference]] <> -| Reference URL to additional information about the rule used to generate this event. +a| Reference URL to additional information about the rule used to generate this event. The URL can point to the vendor's documentation about the rule. If that's not available, it can also be a link to a more general page describing this type of alert. @@ -8186,7 +8186,7 @@ example: `https://en.wikipedia.org/wiki/DNS_over_TLS` [[field-rule-ruleset]] <> -| Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member. +a| Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member. type: keyword @@ -8202,7 +8202,7 @@ example: `Standard_Protocol_Filters` [[field-rule-uuid]] <> -| A rule ID that is unique within the scope of a set or group of agents, observers, or other entities using the rule for detection of this event. +a| A rule ID that is unique within the scope of a set or group of agents, observers, or other entities using the rule for detection of this event. type: keyword @@ -8218,7 +8218,7 @@ example: `1100110011` [[field-rule-version]] <> -| The version / revision of the rule being used for analysis. +a| The version / revision of the rule being used for analysis. type: keyword @@ -8255,7 +8255,7 @@ Client / server representations can add semantic context to an exchange, which i [[field-server-address]] <> -| Some event server addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field. +a| Some event server addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field. Then it should be duplicated to `.ip` or `.domain`, depending on which one it is. @@ -8273,7 +8273,7 @@ type: keyword [[field-server-bytes]] <> -| Bytes sent from the server to the client. +a| Bytes sent from the server to the client. type: long @@ -8289,7 +8289,7 @@ example: `184` [[field-server-domain]] <> -| The domain name of the server system. +a| The domain name of the server system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment. @@ -8307,7 +8307,7 @@ example: `foo.example.com` [[field-server-ip]] <> -| IP address of the server (IPv4 or IPv6). +a| IP address of the server (IPv4 or IPv6). type: ip @@ -8323,7 +8323,7 @@ type: ip [[field-server-mac]] <> -| MAC address of the server. +a| MAC address of the server. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. @@ -8341,7 +8341,7 @@ example: `00-00-5E-00-53-23` [[field-server-nat-ip]] <> -| Translated ip of destination based NAT sessions (e.g. internet to private DMZ) +a| Translated ip of destination based NAT sessions (e.g. internet to private DMZ) Typically used with load balancers, firewalls, or routers. @@ -8359,7 +8359,7 @@ type: ip [[field-server-nat-port]] <> -| Translated port of destination based NAT sessions (e.g. internet to private DMZ) +a| Translated port of destination based NAT sessions (e.g. internet to private DMZ) Typically used with load balancers, firewalls, or routers. @@ -8377,7 +8377,7 @@ type: long [[field-server-packets]] <> -| Packets sent from the server to the client. +a| Packets sent from the server to the client. type: long @@ -8393,7 +8393,7 @@ example: `12` [[field-server-port]] <> -| Port of the server. +a| Port of the server. type: long @@ -8409,7 +8409,7 @@ type: long [[field-server-registered-domain]] <> -| The highest registered server domain, stripped of the subdomain. +a| The highest registered server domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". @@ -8429,7 +8429,7 @@ example: `example.com` [[field-server-subdomain]] <> -| The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. +a| The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period. @@ -8447,7 +8447,7 @@ example: `east` [[field-server-top-level-domain]] <> -| The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". +a| The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk". @@ -8521,7 +8521,7 @@ These fields help you find and correlate logs for a specific service and version [[field-service-address]] <> -| Address where data about this service was collected from. +a| Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets). @@ -8539,7 +8539,7 @@ example: `172.26.0.2:5432` [[field-service-environment]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Identifies the environment where the service is running. @@ -8559,7 +8559,7 @@ example: `production` [[field-service-ephemeral-id]] <> -| Ephemeral identifier of this service (if one exists). +a| Ephemeral identifier of this service (if one exists). This id normally changes across restarts, but `service.id` does not. @@ -8577,7 +8577,7 @@ example: `8a4f500f` [[field-service-id]] <> -| Unique identifier of the running service. If the service is comprised of many nodes, the `service.id` should be the same for all nodes. +a| Unique identifier of the running service. If the service is comprised of many nodes, the `service.id` should be the same for all nodes. This id should uniquely identify the service. This makes it possible to correlate logs and metrics for one specific service, no matter which particular node emitted the event. @@ -8597,7 +8597,7 @@ example: `d37e5ebfe0ae6c4972dbe9f0174a1637bb8247f6` [[field-service-name]] <> -| Name of the service data is collected from. +a| Name of the service data is collected from. The name of the service is normally user given. This allows for distributed services that run on multiple hosts to correlate the related instances based on the name. @@ -8617,7 +8617,7 @@ example: `elasticsearch-metrics` [[field-service-node-name]] <> -| Name of a service node. +a| Name of a service node. This allows for two nodes of the same service running on the same host to be differentiated. Therefore, `service.node.name` should typically be unique across nodes of a given service. @@ -8637,7 +8637,7 @@ example: `instance-0000000016` [[field-service-node-role]] <> -| Role of a service node. +a| Role of a service node. This allows for distinction between different running roles of the same service. @@ -8661,7 +8661,7 @@ example: `background-tasks` [[field-service-state]] <> -| Current state of the service. +a| Current state of the service. type: keyword @@ -8677,7 +8677,7 @@ type: keyword [[field-service-type]] <> -| The type of the service data is collected from. +a| The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. @@ -8697,7 +8697,7 @@ example: `elasticsearch` [[field-service-version]] <> -| Version of the service the data was collected from. +a| Version of the service the data was collected from. This allows to look at a data set only for a specific version of a service. @@ -8785,7 +8785,7 @@ Source fields are usually populated in conjunction with destination fields. The [[field-source-address]] <> -| Some event source addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field. +a| Some event source addresses are defined ambiguously. The event will sometimes list an IP, a domain or a unix socket. You should always store the raw address in the `.address` field. Then it should be duplicated to `.ip` or `.domain`, depending on which one it is. @@ -8803,7 +8803,7 @@ type: keyword [[field-source-bytes]] <> -| Bytes sent from the source to the destination. +a| Bytes sent from the source to the destination. type: long @@ -8819,7 +8819,7 @@ example: `184` [[field-source-domain]] <> -| The domain name of the source system. +a| The domain name of the source system. This value may be a host name, a fully qualified domain name, or another host naming format. The value may derive from the original event or be added from enrichment. @@ -8837,7 +8837,7 @@ example: `foo.example.com` [[field-source-ip]] <> -| IP address of the source (IPv4 or IPv6). +a| IP address of the source (IPv4 or IPv6). type: ip @@ -8853,7 +8853,7 @@ type: ip [[field-source-mac]] <> -| MAC address of the source. +a| MAC address of the source. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. @@ -8871,7 +8871,7 @@ example: `00-00-5E-00-53-23` [[field-source-nat-ip]] <> -| Translated ip of source based NAT sessions (e.g. internal client to internet) +a| Translated ip of source based NAT sessions (e.g. internal client to internet) Typically connections traversing load balancers, firewalls, or routers. @@ -8889,7 +8889,7 @@ type: ip [[field-source-nat-port]] <> -| Translated port of source based NAT sessions. (e.g. internal client to internet) +a| Translated port of source based NAT sessions. (e.g. internal client to internet) Typically used with load balancers, firewalls, or routers. @@ -8907,7 +8907,7 @@ type: long [[field-source-packets]] <> -| Packets sent from the source to the destination. +a| Packets sent from the source to the destination. type: long @@ -8923,7 +8923,7 @@ example: `12` [[field-source-port]] <> -| Port of the source. +a| Port of the source. type: long @@ -8939,7 +8939,7 @@ type: long [[field-source-registered-domain]] <> -| The highest registered source domain, stripped of the subdomain. +a| The highest registered source domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". @@ -8959,7 +8959,7 @@ example: `example.com` [[field-source-subdomain]] <> -| The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. +a| The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period. @@ -8977,7 +8977,7 @@ example: `east` [[field-source-top-level-domain]] <> -| The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". +a| The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk". @@ -9059,7 +9059,7 @@ These fields are for users to classify alerts from all of their sources (e.g. ID [[field-threat-enrichments]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] A list of associated indicators objects enriching the event, and the context of that association/enrichment. @@ -9080,7 +9080,7 @@ Note: this field should contain an array of values. [[field-threat-enrichments-indicator]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Object containing associated indicators enriching the event. @@ -9098,7 +9098,7 @@ type: object [[field-threat-enrichments-indicator-confidence]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence scales may be added as custom fields. @@ -9128,7 +9128,7 @@ example: `Medium` [[field-threat-enrichments-indicator-description]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Describes the type of action conducted by the threat. @@ -9146,7 +9146,7 @@ example: `IP x.x.x.x was observed delivering the Angler EK.` [[field-threat-enrichments-indicator-email-address]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Identifies a threat indicator as an email address (irrespective of direction). @@ -9164,7 +9164,7 @@ example: `phish@example.com` [[field-threat-enrichments-indicator-first-seen]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] The date and time when intelligence source first reported sighting this indicator. @@ -9182,7 +9182,7 @@ example: `2020-11-05T17:25:47.000Z` [[field-threat-enrichments-indicator-ip]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Identifies a threat indicator as an IP address (irrespective of direction). @@ -9200,7 +9200,7 @@ example: `1.2.3.4` [[field-threat-enrichments-indicator-last-seen]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] The date and time when intelligence source last reported sighting this indicator. @@ -9218,7 +9218,7 @@ example: `2020-11-05T17:25:47.000Z` [[field-threat-enrichments-indicator-marking-tlp]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Traffic Light Protocol sharing markings. Recommended values are: @@ -9244,7 +9244,7 @@ example: `White` [[field-threat-enrichments-indicator-modified-at]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] The date and time when intelligence source last modified information for this indicator. @@ -9262,7 +9262,7 @@ example: `2020-11-05T17:25:47.000Z` [[field-threat-enrichments-indicator-port]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Identifies a threat indicator as a port number (irrespective of direction). @@ -9280,7 +9280,7 @@ example: `443` [[field-threat-enrichments-indicator-provider]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] The name of the indicator's provider. @@ -9298,7 +9298,7 @@ example: `lrz_urlhaus` [[field-threat-enrichments-indicator-reference]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Reference URL linking to additional information about this indicator. @@ -9316,7 +9316,7 @@ example: `https://system.example.com/indicator/0001234` [[field-threat-enrichments-indicator-scanner-stats]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Count of AV/EDR vendors that successfully detected malicious file or URL. @@ -9334,7 +9334,7 @@ example: `4` [[field-threat-enrichments-indicator-sightings]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Number of times this indicator was observed conducting threat activity. @@ -9352,7 +9352,7 @@ example: `20` [[field-threat-enrichments-indicator-type]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Type of indicator as represented by Cyber Observable in STIX 2.0. Recommended values: @@ -9404,7 +9404,7 @@ example: `ipv4-addr` [[field-threat-enrichments-matched-atomic]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Identifies the atomic indicator value that matched a local environment endpoint or network event. @@ -9422,7 +9422,7 @@ example: `bad-domain.com` [[field-threat-enrichments-matched-field]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Identifies the field of the atomic indicator that matched a local environment endpoint or network event. @@ -9440,7 +9440,7 @@ example: `file.hash.sha256` [[field-threat-enrichments-matched-id]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Identifies the _id of the indicator document enriching the event. @@ -9458,7 +9458,7 @@ example: `ff93aee5-86a1-4a61-b0e6-0cdc313d01b5` [[field-threat-enrichments-matched-index]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Identifies the _index of the indicator document enriching the event. @@ -9476,7 +9476,7 @@ example: `filebeat-8.0.0-2021.05.23-000011` [[field-threat-enrichments-matched-occurred]] <> -| Indicates when the indicator match was generated +a| Indicates when the indicator match was generated type: date @@ -9492,7 +9492,7 @@ example: `2021-10-05T17:00:58.326Z` [[field-threat-enrichments-matched-type]] <> -| beta:[ This field is beta and subject to change. ] +a| beta:[ This field is beta and subject to change. ] Identifies the type of match that caused the event to be enriched with the given indicator @@ -9510,7 +9510,7 @@ example: `indicator_match_rule` [[field-threat-feed-dashboard-id]] <> -| The saved object ID of the dashboard belonging to the threat feed for displaying dashboard links to threat feeds in Kibana. +a| The saved object ID of the dashboard belonging to the threat feed for displaying dashboard links to threat feeds in Kibana. type: keyword @@ -9526,7 +9526,7 @@ example: `5ba16340-72e6-11eb-a3e3-b3cc7c78a70f` [[field-threat-feed-description]] <> -| Description of the threat feed in a UI friendly format. +a| Description of the threat feed in a UI friendly format. type: keyword @@ -9542,7 +9542,7 @@ example: `Threat feed from the AlienVault Open Threat eXchange network.` [[field-threat-feed-name]] <> -| The name of the threat feed in UI friendly format. +a| The name of the threat feed in UI friendly format. type: keyword @@ -9558,7 +9558,7 @@ example: `AlienVault OTX` [[field-threat-feed-reference]] <> -| Reference information for the threat feed in a UI friendly format. +a| Reference information for the threat feed in a UI friendly format. type: keyword @@ -9574,7 +9574,7 @@ example: `https://otx.alienvault.com` [[field-threat-framework]] <> -| Name of the threat framework used to further categorize and classify the tactic and technique of the reported threat. Framework classification can be provided by detecting systems, evaluated at ingest time, or retrospectively tagged to events. +a| Name of the threat framework used to further categorize and classify the tactic and technique of the reported threat. Framework classification can be provided by detecting systems, evaluated at ingest time, or retrospectively tagged to events. type: keyword @@ -9590,7 +9590,7 @@ example: `MITRE ATT&CK` [[field-threat-group-alias]] <> -| The alias(es) of the group for a set of related intrusion activity that are tracked by a common name in the security community. +a| The alias(es) of the group for a set of related intrusion activity that are tracked by a common name in the security community. While not required, you can use a MITRE ATT&CK® group alias(es). @@ -9611,7 +9611,7 @@ example: `[ "Magecart Group 6" ]` [[field-threat-group-id]] <> -| The id of the group for a set of related intrusion activity that are tracked by a common name in the security community. +a| The id of the group for a set of related intrusion activity that are tracked by a common name in the security community. While not required, you can use a MITRE ATT&CK® group id. @@ -9629,7 +9629,7 @@ example: `G0037` [[field-threat-group-name]] <> -| The name of the group for a set of related intrusion activity that are tracked by a common name in the security community. +a| The name of the group for a set of related intrusion activity that are tracked by a common name in the security community. While not required, you can use a MITRE ATT&CK® group name. @@ -9647,7 +9647,7 @@ example: `FIN6` [[field-threat-group-reference]] <> -| The reference URL of the group for a set of related intrusion activity that are tracked by a common name in the security community. +a| The reference URL of the group for a set of related intrusion activity that are tracked by a common name in the security community. While not required, you can use a MITRE ATT&CK® group reference URL. @@ -9665,7 +9665,7 @@ example: `https://attack.mitre.org/groups/G0037/` [[field-threat-indicator-confidence]] <> -| Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence scales may be added as custom fields. +a| Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence scales may be added as custom fields. Expected values are: @@ -9693,7 +9693,7 @@ example: `Medium` [[field-threat-indicator-description]] <> -| Describes the type of action conducted by the threat. +a| Describes the type of action conducted by the threat. type: keyword @@ -9709,7 +9709,7 @@ example: `IP x.x.x.x was observed delivering the Angler EK.` [[field-threat-indicator-email-address]] <> -| Identifies a threat indicator as an email address (irrespective of direction). +a| Identifies a threat indicator as an email address (irrespective of direction). type: keyword @@ -9725,7 +9725,7 @@ example: `phish@example.com` [[field-threat-indicator-first-seen]] <> -| The date and time when intelligence source first reported sighting this indicator. +a| The date and time when intelligence source first reported sighting this indicator. type: date @@ -9741,7 +9741,7 @@ example: `2020-11-05T17:25:47.000Z` [[field-threat-indicator-ip]] <> -| Identifies a threat indicator as an IP address (irrespective of direction). +a| Identifies a threat indicator as an IP address (irrespective of direction). type: ip @@ -9757,7 +9757,7 @@ example: `1.2.3.4` [[field-threat-indicator-last-seen]] <> -| The date and time when intelligence source last reported sighting this indicator. +a| The date and time when intelligence source last reported sighting this indicator. type: date @@ -9773,7 +9773,7 @@ example: `2020-11-05T17:25:47.000Z` [[field-threat-indicator-marking-tlp]] <> -| Traffic Light Protocol sharing markings. +a| Traffic Light Protocol sharing markings. Recommended values are: @@ -9799,7 +9799,7 @@ example: `WHITE` [[field-threat-indicator-modified-at]] <> -| The date and time when intelligence source last modified information for this indicator. +a| The date and time when intelligence source last modified information for this indicator. type: date @@ -9815,7 +9815,7 @@ example: `2020-11-05T17:25:47.000Z` [[field-threat-indicator-port]] <> -| Identifies a threat indicator as a port number (irrespective of direction). +a| Identifies a threat indicator as a port number (irrespective of direction). type: long @@ -9831,7 +9831,7 @@ example: `443` [[field-threat-indicator-provider]] <> -| The name of the indicator's provider. +a| The name of the indicator's provider. type: keyword @@ -9847,7 +9847,7 @@ example: `lrz_urlhaus` [[field-threat-indicator-reference]] <> -| Reference URL linking to additional information about this indicator. +a| Reference URL linking to additional information about this indicator. type: keyword @@ -9863,7 +9863,7 @@ example: `https://system.example.com/indicator/0001234` [[field-threat-indicator-scanner-stats]] <> -| Count of AV/EDR vendors that successfully detected malicious file or URL. +a| Count of AV/EDR vendors that successfully detected malicious file or URL. type: long @@ -9879,7 +9879,7 @@ example: `4` [[field-threat-indicator-sightings]] <> -| Number of times this indicator was observed conducting threat activity. +a| Number of times this indicator was observed conducting threat activity. type: long @@ -9895,7 +9895,7 @@ example: `20` [[field-threat-indicator-type]] <> -| Type of indicator as represented by Cyber Observable in STIX 2.0. +a| Type of indicator as represented by Cyber Observable in STIX 2.0. Recommended values: @@ -9947,7 +9947,7 @@ example: `ipv4-addr` [[field-threat-software-alias]] <> -| The alias(es) of the software for a set of related intrusion activity that are tracked by a common name in the security community. +a| The alias(es) of the software for a set of related intrusion activity that are tracked by a common name in the security community. While not required, you can use a MITRE ATT&CK® associated software description. @@ -9968,7 +9968,7 @@ example: `[ "X-Agent" ]` [[field-threat-software-id]] <> -| The id of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. +a| The id of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. While not required, you can use a MITRE ATT&CK® software id. @@ -9986,7 +9986,7 @@ example: `S0552` [[field-threat-software-name]] <> -| The name of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. +a| The name of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. While not required, you can use a MITRE ATT&CK® software name. @@ -10004,7 +10004,7 @@ example: `AdFind` [[field-threat-software-platforms]] <> -| The platforms of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. +a| The platforms of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. Recommended Values: @@ -10049,7 +10049,7 @@ example: `[ "Windows" ]` [[field-threat-software-reference]] <> -| The reference URL of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. +a| The reference URL of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. While not required, you can use a MITRE ATT&CK® software reference URL. @@ -10067,7 +10067,7 @@ example: `https://attack.mitre.org/software/S0552/` [[field-threat-software-type]] <> -| The type of software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. +a| The type of software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. Recommended values @@ -10093,7 +10093,7 @@ example: `Tool` [[field-threat-tactic-id]] <> -| The id of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/ ) +a| The id of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/ ) type: keyword @@ -10112,7 +10112,7 @@ example: `TA0002` [[field-threat-tactic-name]] <> -| Name of the type of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/) +a| Name of the type of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/) type: keyword @@ -10131,7 +10131,7 @@ example: `Execution` [[field-threat-tactic-reference]] <> -| The reference url of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/ ) +a| The reference url of tactic used by this threat. You can use a MITRE ATT&CK® tactic, for example. (ex. https://attack.mitre.org/tactics/TA0002/ ) type: keyword @@ -10150,7 +10150,7 @@ example: `https://attack.mitre.org/tactics/TA0002/` [[field-threat-technique-id]] <> -| The id of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) +a| The id of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) type: keyword @@ -10169,7 +10169,7 @@ example: `T1059` [[field-threat-technique-name]] <> -| The name of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) +a| The name of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) type: keyword @@ -10194,7 +10194,7 @@ example: `Command and Scripting Interpreter` [[field-threat-technique-reference]] <> -| The reference url of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) +a| The reference url of technique used by this threat. You can use a MITRE ATT&CK® technique, for example. (ex. https://attack.mitre.org/techniques/T1059/) type: keyword @@ -10213,7 +10213,7 @@ example: `https://attack.mitre.org/techniques/T1059/` [[field-threat-technique-subtechnique-id]] <> -| The full id of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/) +a| The full id of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/) type: keyword @@ -10232,7 +10232,7 @@ example: `T1059.001` [[field-threat-technique-subtechnique-name]] <> -| The name of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/) +a| The name of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/) type: keyword @@ -10257,7 +10257,7 @@ example: `PowerShell` [[field-threat-technique-subtechnique-reference]] <> -| The reference url of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/) +a| The reference url of subtechnique used by this threat. You can use a MITRE ATT&CK® subtechnique, for example. (ex. https://attack.mitre.org/techniques/T1059/001/) type: keyword @@ -10408,7 +10408,7 @@ Fields related to a TLS connection. These fields focus on the TLS protocol itsel [[field-tls-cipher]] <> -| String indicating the cipher used during the current connection. +a| String indicating the cipher used during the current connection. type: keyword @@ -10424,7 +10424,7 @@ example: `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256` [[field-tls-client-certificate]] <> -| PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list. +a| PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list. type: keyword @@ -10440,7 +10440,7 @@ example: `MII...` [[field-tls-client-certificate-chain]] <> -| Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of `client.certificate` since that value should be the first certificate in the chain. +a| Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of `client.certificate` since that value should be the first certificate in the chain. type: keyword @@ -10459,7 +10459,7 @@ example: `["MII...", "MII..."]` [[field-tls-client-hash-md5]] <> -| Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. +a| Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. type: keyword @@ -10475,7 +10475,7 @@ example: `0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC` [[field-tls-client-hash-sha1]] <> -| Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. +a| Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. type: keyword @@ -10491,7 +10491,7 @@ example: `9E393D93138888D288266C2D915214D1D1CCEB2A` [[field-tls-client-hash-sha256]] <> -| Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. +a| Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. type: keyword @@ -10507,7 +10507,7 @@ example: `0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0` [[field-tls-client-issuer]] <> -| Distinguished name of subject of the issuer of the x.509 certificate presented by the client. +a| Distinguished name of subject of the issuer of the x.509 certificate presented by the client. type: keyword @@ -10523,7 +10523,7 @@ example: `CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com` [[field-tls-client-ja3]] <> -| A hash that identifies clients based on how they perform an SSL/TLS handshake. +a| A hash that identifies clients based on how they perform an SSL/TLS handshake. type: keyword @@ -10539,7 +10539,7 @@ example: `d4e5b18d6b55c71272893221c96ba240` [[field-tls-client-not-after]] <> -| Date/Time indicating when client certificate is no longer considered valid. +a| Date/Time indicating when client certificate is no longer considered valid. type: date @@ -10555,7 +10555,7 @@ example: `2021-01-01T00:00:00.000Z` [[field-tls-client-not-before]] <> -| Date/Time indicating when client certificate is first considered valid. +a| Date/Time indicating when client certificate is first considered valid. type: date @@ -10571,7 +10571,7 @@ example: `1970-01-01T00:00:00.000Z` [[field-tls-client-server-name]] <> -| Also called an SNI, this tells the server which hostname to which the client is attempting to connect to. When this value is available, it should get copied to `destination.domain`. +a| Also called an SNI, this tells the server which hostname to which the client is attempting to connect to. When this value is available, it should get copied to `destination.domain`. type: keyword @@ -10587,7 +10587,7 @@ example: `www.elastic.co` [[field-tls-client-subject]] <> -| Distinguished name of subject of the x.509 certificate presented by the client. +a| Distinguished name of subject of the x.509 certificate presented by the client. type: keyword @@ -10603,7 +10603,7 @@ example: `CN=myclient, OU=Documentation Team, DC=example, DC=com` [[field-tls-client-supported-ciphers]] <> -| Array of ciphers offered by the client during the client hello. +a| Array of ciphers offered by the client during the client hello. type: keyword @@ -10622,7 +10622,7 @@ example: `["TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_25 [[field-tls-curve]] <> -| String indicating the curve used for the given cipher, when applicable. +a| String indicating the curve used for the given cipher, when applicable. type: keyword @@ -10638,7 +10638,7 @@ example: `secp256r1` [[field-tls-established]] <> -| Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel. +a| Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel. type: boolean @@ -10654,7 +10654,7 @@ type: boolean [[field-tls-next-protocol]] <> -| String indicating the protocol being tunneled. Per the values in the IANA registry (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids), this string should be lower case. +a| String indicating the protocol being tunneled. Per the values in the IANA registry (https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids), this string should be lower case. type: keyword @@ -10670,7 +10670,7 @@ example: `http/1.1` [[field-tls-resumed]] <> -| Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation. +a| Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation. type: boolean @@ -10686,7 +10686,7 @@ type: boolean [[field-tls-server-certificate]] <> -| PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of `server.certificate_chain` since this value also exists in that list. +a| PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of `server.certificate_chain` since this value also exists in that list. type: keyword @@ -10702,7 +10702,7 @@ example: `MII...` [[field-tls-server-certificate-chain]] <> -| Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of `server.certificate` since that value should be the first certificate in the chain. +a| Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of `server.certificate` since that value should be the first certificate in the chain. type: keyword @@ -10721,7 +10721,7 @@ example: `["MII...", "MII..."]` [[field-tls-server-hash-md5]] <> -| Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. +a| Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. type: keyword @@ -10737,7 +10737,7 @@ example: `0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC` [[field-tls-server-hash-sha1]] <> -| Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. +a| Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. type: keyword @@ -10753,7 +10753,7 @@ example: `9E393D93138888D288266C2D915214D1D1CCEB2A` [[field-tls-server-hash-sha256]] <> -| Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. +a| Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. type: keyword @@ -10769,7 +10769,7 @@ example: `0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0` [[field-tls-server-issuer]] <> -| Subject of the issuer of the x.509 certificate presented by the server. +a| Subject of the issuer of the x.509 certificate presented by the server. type: keyword @@ -10785,7 +10785,7 @@ example: `CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com` [[field-tls-server-ja3s]] <> -| A hash that identifies servers based on how they perform an SSL/TLS handshake. +a| A hash that identifies servers based on how they perform an SSL/TLS handshake. type: keyword @@ -10801,7 +10801,7 @@ example: `394441ab65754e2207b1e1b457b3641d` [[field-tls-server-not-after]] <> -| Timestamp indicating when server certificate is no longer considered valid. +a| Timestamp indicating when server certificate is no longer considered valid. type: date @@ -10817,7 +10817,7 @@ example: `2021-01-01T00:00:00.000Z` [[field-tls-server-not-before]] <> -| Timestamp indicating when server certificate is first considered valid. +a| Timestamp indicating when server certificate is first considered valid. type: date @@ -10833,7 +10833,7 @@ example: `1970-01-01T00:00:00.000Z` [[field-tls-server-subject]] <> -| Subject of the x.509 certificate presented by the server. +a| Subject of the x.509 certificate presented by the server. type: keyword @@ -10849,7 +10849,7 @@ example: `CN=www.example.com, OU=Infrastructure Team, DC=example, DC=com` [[field-tls-version]] <> -| Numeric part of the version parsed from the original string. +a| Numeric part of the version parsed from the original string. type: keyword @@ -10865,7 +10865,7 @@ example: `1.2` [[field-tls-version-protocol]] <> -| Normalized lowercase protocol name parsed from original string. +a| Normalized lowercase protocol name parsed from original string. type: keyword @@ -10930,7 +10930,7 @@ Unlike most field sets in ECS, the tracing fields are *not* nested under the fie [[field-span-id]] <> -| Unique identifier of the span within the scope of its trace. +a| Unique identifier of the span within the scope of its trace. A span represents an operation within a transaction, such as a request to another service, or a database query. @@ -10948,7 +10948,7 @@ example: `3ff9a8981b7ccd5a` [[field-trace-id]] <> -| Unique identifier of the trace. +a| Unique identifier of the trace. A trace groups multiple events like transactions that belong together. For example, a user request handled by multiple inter-connected services. @@ -10966,7 +10966,7 @@ example: `4bf92f3577b34da6a3ce929d0e0e4736` [[field-transaction-id]] <> -| Unique identifier of the transaction within the scope of its trace. +a| Unique identifier of the transaction within the scope of its trace. A transaction is the highest level of work measured within a service, such as a request to a server. @@ -11001,7 +11001,7 @@ URL fields provide support for complete or partial URLs, and supports the breaki [[field-url-domain]] <> -| Domain of the url, such as "www.elastic.co". +a| Domain of the url, such as "www.elastic.co". In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the `domain` field. @@ -11021,7 +11021,7 @@ example: `www.elastic.co` [[field-url-extension]] <> -| The field contains the file extension from the original request url, excluding the leading dot. +a| The field contains the file extension from the original request url, excluding the leading dot. The file extension is only set if it exists, as not every url has a file extension. @@ -11043,7 +11043,7 @@ example: `png` [[field-url-fragment]] <> -| Portion of the url after the `#`, such as "top". +a| Portion of the url after the `#`, such as "top". The `#` is not part of the fragment. @@ -11061,7 +11061,7 @@ type: keyword [[field-url-full]] <> -| If full URLs are important to your use case, they should be stored in `url.full`, whether this field is reconstructed or present in the event source. +a| If full URLs are important to your use case, they should be stored in `url.full`, whether this field is reconstructed or present in the event source. type: wildcard @@ -11083,7 +11083,7 @@ example: `https://www.elastic.co:443/search?q=elasticsearch#top` [[field-url-original]] <> -| Unmodified original url as seen in the event source. +a| Unmodified original url as seen in the event source. Note that in network monitoring, the observed URL may be a full URL, whereas in access logs, the URL is often just represented as a path. @@ -11109,7 +11109,7 @@ example: `https://www.elastic.co:443/search?q=elasticsearch#top or /search?q=ela [[field-url-password]] <> -| Password of the request. +a| Password of the request. type: keyword @@ -11125,7 +11125,7 @@ type: keyword [[field-url-path]] <> -| Path of the request, such as "/search". +a| Path of the request, such as "/search". type: wildcard @@ -11141,7 +11141,7 @@ type: wildcard [[field-url-port]] <> -| Port of the request, such as 443. +a| Port of the request, such as 443. type: long @@ -11157,7 +11157,7 @@ example: `443` [[field-url-query]] <> -| The query field describes the query string of the request, such as "q=elasticsearch". +a| The query field describes the query string of the request, such as "q=elasticsearch". The `?` is excluded from the query string. If a URL contains no `?`, there is no query field. If there is a `?` but no query, the query field exists with an empty string. The `exists` query can be used to differentiate between the two cases. @@ -11175,7 +11175,7 @@ type: keyword [[field-url-registered-domain]] <> -| The highest registered url domain, stripped of the subdomain. +a| The highest registered url domain, stripped of the subdomain. For example, the registered domain for "foo.example.com" is "example.com". @@ -11195,7 +11195,7 @@ example: `example.com` [[field-url-scheme]] <> -| Scheme of the request, such as "https". +a| Scheme of the request, such as "https". Note: The `:` is not part of the scheme. @@ -11213,7 +11213,7 @@ example: `https` [[field-url-subdomain]] <> -| The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. +a| The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. For example the subdomain portion of "www.east.mydomain.co.uk" is "east". If the domain has multiple levels of subdomain, such as "sub2.sub1.example.com", the subdomain field should contain "sub2.sub1", with no trailing period. @@ -11231,7 +11231,7 @@ example: `east` [[field-url-top-level-domain]] <> -| The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". +a| The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is "com". This value can be determined precisely with a list like the public suffix list (http://publicsuffix.org). Trying to approximate this by simply taking the last label will not work well for effective TLDs such as "co.uk". @@ -11249,7 +11249,7 @@ example: `co.uk` [[field-url-username]] <> -| Username of the request. +a| Username of the request. type: keyword @@ -11297,7 +11297,7 @@ Fields can have one entry or multiple entries. If a user has more than one id, p [[field-user-domain]] <> -| Name of the directory the user is a member of. +a| Name of the directory the user is a member of. For example, an LDAP or Active Directory domain name. @@ -11315,7 +11315,7 @@ type: keyword [[field-user-email]] <> -| User email address. +a| User email address. type: keyword @@ -11331,7 +11331,7 @@ type: keyword [[field-user-full-name]] <> -| User's full name, if available. +a| User's full name, if available. type: keyword @@ -11353,7 +11353,7 @@ example: `Albert Einstein` [[field-user-hash]] <> -| Unique user hash to correlate information for a user in anonymized form. +a| Unique user hash to correlate information for a user in anonymized form. Useful if `user.id` or `user.name` contain confidential information and cannot be used. @@ -11371,7 +11371,7 @@ type: keyword [[field-user-id]] <> -| Unique identifier of the user. +a| Unique identifier of the user. type: keyword @@ -11387,7 +11387,7 @@ example: `S-1-5-21-202424912787-2692429404-2351956786-1000` [[field-user-name]] <> -| Short name or login of the user. +a| Short name or login of the user. type: keyword @@ -11409,7 +11409,7 @@ example: `a.einstein` [[field-user-roles]] <> -| Array of user roles at the time of the event. +a| Array of user roles at the time of the event. type: keyword @@ -11526,7 +11526,7 @@ They often show up in web service logs coming from the parsed user agent string. [[field-user-agent-device-name]] <> -| Name of the device. +a| Name of the device. type: keyword @@ -11542,7 +11542,7 @@ example: `iPhone` [[field-user-agent-name]] <> -| Name of the user agent. +a| Name of the user agent. type: keyword @@ -11558,7 +11558,7 @@ example: `Safari` [[field-user-agent-original]] <> -| Unparsed user_agent string. +a| Unparsed user_agent string. type: keyword @@ -11580,7 +11580,7 @@ example: `Mozilla/5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605 [[field-user-agent-version]] <> -| Version of the user agent. +a| Version of the user agent. type: keyword @@ -11642,7 +11642,7 @@ Observer.ingress and observer.egress VLAN values are used to record observer spe [[field-vlan-id]] <> -| VLAN ID as reported by the observer. +a| VLAN ID as reported by the observer. type: keyword @@ -11658,7 +11658,7 @@ example: `10` [[field-vlan-name]] <> -| Optional VLAN name as reported by the observer. +a| Optional VLAN name as reported by the observer. type: keyword @@ -11706,7 +11706,7 @@ The vulnerability fields describe information about a vulnerability that is rele [[field-vulnerability-category]] <> -| The type of system or architecture that the vulnerability affects. These may be platform-specific (for example, Debian or SUSE) or general (for example, Database or Firewall). For example (https://qualysguard.qualys.com/qwebhelp/fo_portal/knowledgebase/vulnerability_categories.htm[Qualys vulnerability categories]) +a| The type of system or architecture that the vulnerability affects. These may be platform-specific (for example, Debian or SUSE) or general (for example, Database or Firewall). For example (https://qualysguard.qualys.com/qwebhelp/fo_portal/knowledgebase/vulnerability_categories.htm[Qualys vulnerability categories]) This field must be an array. @@ -11727,7 +11727,7 @@ example: `["Firewall"]` [[field-vulnerability-classification]] <> -| The classification of the vulnerability scoring system. For example (https://www.first.org/cvss/) +a| The classification of the vulnerability scoring system. For example (https://www.first.org/cvss/) type: keyword @@ -11743,7 +11743,7 @@ example: `CVSS` [[field-vulnerability-description]] <> -| The description of the vulnerability that provides additional context of the vulnerability. For example (https://cve.mitre.org/about/faqs.html#cve_entry_descriptions_created[Common Vulnerabilities and Exposure CVE description]) +a| The description of the vulnerability that provides additional context of the vulnerability. For example (https://cve.mitre.org/about/faqs.html#cve_entry_descriptions_created[Common Vulnerabilities and Exposure CVE description]) type: keyword @@ -11765,7 +11765,7 @@ example: `In macOS before 2.12.6, there is a vulnerability in the RPC...` [[field-vulnerability-enumeration]] <> -| The type of identifier used for this vulnerability. For example (https://cve.mitre.org/about/) +a| The type of identifier used for this vulnerability. For example (https://cve.mitre.org/about/) type: keyword @@ -11781,7 +11781,7 @@ example: `CVE` [[field-vulnerability-id]] <> -| The identification (ID) is the number portion of a vulnerability entry. It includes a unique identification number for the vulnerability. For example (https://cve.mitre.org/about/faqs.html#what_is_cve_id)[Common Vulnerabilities and Exposure CVE ID] +a| The identification (ID) is the number portion of a vulnerability entry. It includes a unique identification number for the vulnerability. For example (https://cve.mitre.org/about/faqs.html#what_is_cve_id)[Common Vulnerabilities and Exposure CVE ID] type: keyword @@ -11797,7 +11797,7 @@ example: `CVE-2019-00001` [[field-vulnerability-reference]] <> -| A resource that provides additional information, context, and mitigations for the identified vulnerability. +a| A resource that provides additional information, context, and mitigations for the identified vulnerability. type: keyword @@ -11813,7 +11813,7 @@ example: `https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-6111` [[field-vulnerability-report-id]] <> -| The report or scan identification number. +a| The report or scan identification number. type: keyword @@ -11829,7 +11829,7 @@ example: `20191018.0001` [[field-vulnerability-scanner-vendor]] <> -| The name of the vulnerability scanner vendor. +a| The name of the vulnerability scanner vendor. type: keyword @@ -11845,7 +11845,7 @@ example: `Tenable` [[field-vulnerability-score-base]] <> -| Scores can range from 0.0 to 10.0, with 10.0 being the most severe. +a| Scores can range from 0.0 to 10.0, with 10.0 being the most severe. Base scores cover an assessment for exploitability metrics (attack vector, complexity, privileges, and user interaction), impact metrics (confidentiality, integrity, and availability), and scope. For example (https://www.first.org/cvss/specification-document) @@ -11863,7 +11863,7 @@ example: `5.5` [[field-vulnerability-score-environmental]] <> -| Scores can range from 0.0 to 10.0, with 10.0 being the most severe. +a| Scores can range from 0.0 to 10.0, with 10.0 being the most severe. Environmental scores cover an assessment for any modified Base metrics, confidentiality, integrity, and availability requirements. For example (https://www.first.org/cvss/specification-document) @@ -11881,7 +11881,7 @@ example: `5.5` [[field-vulnerability-score-temporal]] <> -| Scores can range from 0.0 to 10.0, with 10.0 being the most severe. +a| Scores can range from 0.0 to 10.0, with 10.0 being the most severe. Temporal scores cover an assessment for code maturity, remediation level, and confidence. For example (https://www.first.org/cvss/specification-document) @@ -11899,7 +11899,7 @@ type: float [[field-vulnerability-score-version]] <> -| The National Vulnerability Database (NVD) provides qualitative severity rankings of "Low", "Medium", and "High" for CVSS v2.0 base score ranges in addition to the severity ratings for CVSS v3.0 as they are defined in the CVSS v3.0 specification. +a| The National Vulnerability Database (NVD) provides qualitative severity rankings of "Low", "Medium", and "High" for CVSS v2.0 base score ranges in addition to the severity ratings for CVSS v3.0 as they are defined in the CVSS v3.0 specification. CVSS is owned and managed by FIRST.Org, Inc. (FIRST), a US-based non-profit organization, whose mission is to help computer security incident response teams across the world. For example (https://nvd.nist.gov/vuln-metrics/cvss) @@ -11917,7 +11917,7 @@ example: `2.0` [[field-vulnerability-severity]] <> -| The severity of the vulnerability can help with metrics and internal prioritization regarding remediation. For example (https://nvd.nist.gov/vuln-metrics/cvss) +a| The severity of the vulnerability can help with metrics and internal prioritization regarding remediation. For example (https://nvd.nist.gov/vuln-metrics/cvss) type: keyword @@ -11954,7 +11954,7 @@ Events that contain certificate information about network connections, should us [[field-x509-alternative-names]] <> -| List of subject alternative names (SAN). Name types vary by certificate authority and certificate type but commonly contain IP addresses, DNS names (and wildcards), and email addresses. +a| List of subject alternative names (SAN). Name types vary by certificate authority and certificate type but commonly contain IP addresses, DNS names (and wildcards), and email addresses. type: keyword @@ -11973,7 +11973,7 @@ example: `*.elastic.co` [[field-x509-issuer-common-name]] <> -| List of common name (CN) of issuing certificate authority. +a| List of common name (CN) of issuing certificate authority. type: keyword @@ -11992,7 +11992,7 @@ example: `Example SHA2 High Assurance Server CA` [[field-x509-issuer-country]] <> -| List of country (C) codes +a| List of country \(C) codes type: keyword @@ -12011,7 +12011,7 @@ example: `US` [[field-x509-issuer-distinguished-name]] <> -| Distinguished name (DN) of issuing certificate authority. +a| Distinguished name (DN) of issuing certificate authority. type: keyword @@ -12027,7 +12027,7 @@ example: `C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assuranc [[field-x509-issuer-locality]] <> -| List of locality names (L) +a| List of locality names (L) type: keyword @@ -12046,7 +12046,7 @@ example: `Mountain View` [[field-x509-issuer-organization]] <> -| List of organizations (O) of issuing certificate authority. +a| List of organizations (O) of issuing certificate authority. type: keyword @@ -12065,7 +12065,7 @@ example: `Example Inc` [[field-x509-issuer-organizational-unit]] <> -| List of organizational units (OU) of issuing certificate authority. +a| List of organizational units (OU) of issuing certificate authority. type: keyword @@ -12084,7 +12084,7 @@ example: `www.example.com` [[field-x509-issuer-state-or-province]] <> -| List of state or province names (ST, S, or P) +a| List of state or province names (ST, S, or P) type: keyword @@ -12103,7 +12103,7 @@ example: `California` [[field-x509-not-after]] <> -| Time at which the certificate is no longer considered valid. +a| Time at which the certificate is no longer considered valid. type: date @@ -12119,7 +12119,7 @@ example: `2020-07-16T03:15:39Z` [[field-x509-not-before]] <> -| Time at which the certificate is first considered valid. +a| Time at which the certificate is first considered valid. type: date @@ -12135,7 +12135,7 @@ example: `2019-08-16T01:40:25Z` [[field-x509-public-key-algorithm]] <> -| Algorithm used to generate the public key. +a| Algorithm used to generate the public key. type: keyword @@ -12151,7 +12151,7 @@ example: `RSA` [[field-x509-public-key-curve]] <> -| The curve used by the elliptic curve public key algorithm. This is algorithm specific. +a| The curve used by the elliptic curve public key algorithm. This is algorithm specific. type: keyword @@ -12167,7 +12167,7 @@ example: `nistp521` [[field-x509-public-key-exponent]] <> -| Exponent used to derive the public key. This is algorithm specific. +a| Exponent used to derive the public key. This is algorithm specific. type: long @@ -12183,7 +12183,7 @@ example: `65537` [[field-x509-public-key-size]] <> -| The size of the public key space in bits. +a| The size of the public key space in bits. type: long @@ -12199,7 +12199,7 @@ example: `2048` [[field-x509-serial-number]] <> -| Unique serial number issued by the certificate authority. For consistency, if this value is alphanumeric, it should be formatted without colons and uppercase characters. +a| Unique serial number issued by the certificate authority. For consistency, if this value is alphanumeric, it should be formatted without colons and uppercase characters. type: keyword @@ -12215,7 +12215,7 @@ example: `55FBB9C7DEBF09809D12CCAA` [[field-x509-signature-algorithm]] <> -| Identifier for certificate signature algorithm. We recommend using names found in Go Lang Crypto library. See https://github.com/golang/go/blob/go1.14/src/crypto/x509/x509.go#L337-L353. +a| Identifier for certificate signature algorithm. We recommend using names found in Go Lang Crypto library. See https://github.com/golang/go/blob/go1.14/src/crypto/x509/x509.go#L337-L353. type: keyword @@ -12231,7 +12231,7 @@ example: `SHA256-RSA` [[field-x509-subject-common-name]] <> -| List of common names (CN) of subject. +a| List of common names (CN) of subject. type: keyword @@ -12250,7 +12250,7 @@ example: `shared.global.example.net` [[field-x509-subject-country]] <> -| List of country (C) code +a| List of country \(C) code type: keyword @@ -12269,7 +12269,7 @@ example: `US` [[field-x509-subject-distinguished-name]] <> -| Distinguished name (DN) of the certificate subject entity. +a| Distinguished name (DN) of the certificate subject entity. type: keyword @@ -12285,7 +12285,7 @@ example: `C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.globa [[field-x509-subject-locality]] <> -| List of locality names (L) +a| List of locality names (L) type: keyword @@ -12304,7 +12304,7 @@ example: `San Francisco` [[field-x509-subject-organization]] <> -| List of organizations (O) of subject. +a| List of organizations (O) of subject. type: keyword @@ -12323,7 +12323,7 @@ example: `Example, Inc.` [[field-x509-subject-organizational-unit]] <> -| List of organizational units (OU) of subject. +a| List of organizational units (OU) of subject. type: keyword @@ -12342,7 +12342,7 @@ Note: this field should contain an array of values. [[field-x509-subject-state-or-province]] <> -| List of state or province names (ST, S, or P) +a| List of state or province names (ST, S, or P) type: keyword @@ -12361,7 +12361,7 @@ example: `California` [[field-x509-version-number]] <> -| Version of x509 format. +a| Version of x509 format. type: keyword diff --git a/experimental/generated/beats/fields.ecs.yml b/experimental/generated/beats/fields.ecs.yml index 69d40432e2..45414f6986 100644 --- a/experimental/generated/beats/fields.ecs.yml +++ b/experimental/generated/beats/fields.ecs.yml @@ -3068,7 +3068,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: x509.issuer.distinguished_name @@ -3176,7 +3176,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: x509.subject.distinguished_name @@ -8856,7 +8856,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: enrichments.indicator.file.x509.issuer.distinguished_name @@ -8964,7 +8964,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: enrichments.indicator.file.x509.subject.distinguished_name @@ -9401,7 +9401,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: enrichments.indicator.x509.issuer.distinguished_name @@ -9509,7 +9509,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: enrichments.indicator.x509.subject.distinguished_name @@ -10281,7 +10281,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: indicator.file.x509.issuer.distinguished_name @@ -10389,7 +10389,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: indicator.file.x509.subject.distinguished_name @@ -10826,7 +10826,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: indicator.x509.issuer.distinguished_name @@ -10934,7 +10934,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: indicator.x509.subject.distinguished_name @@ -11244,7 +11244,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: client.x509.issuer.distinguished_name @@ -11352,7 +11352,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: client.x509.subject.distinguished_name @@ -11526,7 +11526,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: server.x509.issuer.distinguished_name @@ -11634,7 +11634,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: server.x509.subject.distinguished_name @@ -12481,7 +12481,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: issuer.distinguished_name @@ -12589,7 +12589,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: subject.distinguished_name diff --git a/experimental/generated/csv/fields.csv b/experimental/generated/csv/fields.csv index 8f84bddd83..e4ac06599a 100644 --- a/experimental/generated/csv/fields.csv +++ b/experimental/generated/csv/fields.csv @@ -332,7 +332,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,file,file.uid,keyword,extended,,1001,The user ID (UID) or security identifier (SID) of the file owner. 8.5.0-dev+exp,true,file,file.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev+exp,true,file,file.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev+exp,true,file,file.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev+exp,true,file,file.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev+exp,true,file,file.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev+exp,true,file,file.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev+exp,true,file,file.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -347,7 +347,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,file,file.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev+exp,true,file,file.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev+exp,true,file,file.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev+exp,true,file,file.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev+exp,true,file,file.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev+exp,true,file,file.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev+exp,true,file,file.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev+exp,true,file,file.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. @@ -1046,7 +1046,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.uid,keyword,extended,,1001,The user ID (UID) or security identifier (SID) of the file owner. 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -1061,7 +1061,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.file.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. @@ -1115,7 +1115,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.url.username,keyword,extended,,,Username of the request. 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -1130,7 +1130,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. @@ -1237,7 +1237,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,threat,threat.indicator.file.uid,keyword,extended,,1001,The user ID (UID) or security identifier (SID) of the file owner. 8.5.0-dev+exp,true,threat,threat.indicator.file.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev+exp,true,threat,threat.indicator.file.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev+exp,true,threat,threat.indicator.file.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev+exp,true,threat,threat.indicator.file.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev+exp,true,threat,threat.indicator.file.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev+exp,true,threat,threat.indicator.file.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev+exp,true,threat,threat.indicator.file.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -1252,7 +1252,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,threat,threat.indicator.file.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev+exp,true,threat,threat.indicator.file.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev+exp,true,threat,threat.indicator.file.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev+exp,true,threat,threat.indicator.file.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev+exp,true,threat,threat.indicator.file.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev+exp,true,threat,threat.indicator.file.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev+exp,true,threat,threat.indicator.file.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev+exp,true,threat,threat.indicator.file.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. @@ -1306,7 +1306,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,threat,threat.indicator.url.username,keyword,extended,,,Username of the request. 8.5.0-dev+exp,true,threat,threat.indicator.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev+exp,true,threat,threat.indicator.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev+exp,true,threat,threat.indicator.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev+exp,true,threat,threat.indicator.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev+exp,true,threat,threat.indicator.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev+exp,true,threat,threat.indicator.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev+exp,true,threat,threat.indicator.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -1321,7 +1321,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,threat,threat.indicator.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev+exp,true,threat,threat.indicator.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev+exp,true,threat,threat.indicator.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev+exp,true,threat,threat.indicator.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev+exp,true,threat,threat.indicator.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev+exp,true,threat,threat.indicator.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev+exp,true,threat,threat.indicator.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev+exp,true,threat,threat.indicator.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. @@ -1360,7 +1360,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,tls,tls.client.supported_ciphers,keyword,extended,array,"[""TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"", ""TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"", ""...""]",Array of ciphers offered by the client during the client hello. 8.5.0-dev+exp,true,tls,tls.client.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev+exp,true,tls,tls.client.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev+exp,true,tls,tls.client.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev+exp,true,tls,tls.client.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev+exp,true,tls,tls.client.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev+exp,true,tls,tls.client.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev+exp,true,tls,tls.client.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -1375,7 +1375,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,tls,tls.client.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev+exp,true,tls,tls.client.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev+exp,true,tls,tls.client.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev+exp,true,tls,tls.client.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev+exp,true,tls,tls.client.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev+exp,true,tls,tls.client.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev+exp,true,tls,tls.client.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev+exp,true,tls,tls.client.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. @@ -1398,7 +1398,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,tls,tls.server.subject,keyword,extended,,"CN=www.example.com, OU=Infrastructure Team, DC=example, DC=com",Subject of the x.509 certificate presented by the server. 8.5.0-dev+exp,true,tls,tls.server.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev+exp,true,tls,tls.server.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev+exp,true,tls,tls.server.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev+exp,true,tls,tls.server.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev+exp,true,tls,tls.server.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev+exp,true,tls,tls.server.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev+exp,true,tls,tls.server.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -1413,7 +1413,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,tls,tls.server.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev+exp,true,tls,tls.server.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev+exp,true,tls,tls.server.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev+exp,true,tls,tls.server.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev+exp,true,tls,tls.server.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev+exp,true,tls,tls.server.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev+exp,true,tls,tls.server.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev+exp,true,tls,tls.server.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. diff --git a/experimental/generated/ecs/ecs_flat.yml b/experimental/generated/ecs/ecs_flat.yml index 7ab5b83ed7..6849bb3c8e 100644 --- a/experimental/generated/ecs/ecs_flat.yml +++ b/experimental/generated/ecs/ecs_flat.yml @@ -4491,7 +4491,7 @@ file.x509.issuer.common_name: type: keyword file.x509.issuer.country: dashed_name: file-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: file.x509.issuer.country ignore_above: 1024 @@ -4500,7 +4500,7 @@ file.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword file.x509.issuer.distinguished_name: dashed_name: file-x509-issuer-distinguished-name @@ -4681,7 +4681,7 @@ file.x509.subject.common_name: type: keyword file.x509.subject.country: dashed_name: file-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: file.x509.subject.country ignore_above: 1024 @@ -4690,7 +4690,7 @@ file.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword file.x509.subject.distinguished_name: dashed_name: file-x509-subject-distinguished-name @@ -13189,7 +13189,7 @@ threat.enrichments.indicator.file.x509.issuer.common_name: type: keyword threat.enrichments.indicator.file.x509.issuer.country: dashed_name: threat-enrichments-indicator-file-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.enrichments.indicator.file.x509.issuer.country ignore_above: 1024 @@ -13198,7 +13198,7 @@ threat.enrichments.indicator.file.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.enrichments.indicator.file.x509.issuer.distinguished_name: dashed_name: threat-enrichments-indicator-file-x509-issuer-distinguished-name @@ -13379,7 +13379,7 @@ threat.enrichments.indicator.file.x509.subject.common_name: type: keyword threat.enrichments.indicator.file.x509.subject.country: dashed_name: threat-enrichments-indicator-file-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.enrichments.indicator.file.x509.subject.country ignore_above: 1024 @@ -13388,7 +13388,7 @@ threat.enrichments.indicator.file.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.enrichments.indicator.file.x509.subject.distinguished_name: dashed_name: threat-enrichments-indicator-file-x509-subject-distinguished-name @@ -14082,7 +14082,7 @@ threat.enrichments.indicator.x509.issuer.common_name: type: keyword threat.enrichments.indicator.x509.issuer.country: dashed_name: threat-enrichments-indicator-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.enrichments.indicator.x509.issuer.country ignore_above: 1024 @@ -14091,7 +14091,7 @@ threat.enrichments.indicator.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.enrichments.indicator.x509.issuer.distinguished_name: dashed_name: threat-enrichments-indicator-x509-issuer-distinguished-name @@ -14272,7 +14272,7 @@ threat.enrichments.indicator.x509.subject.common_name: type: keyword threat.enrichments.indicator.x509.subject.country: dashed_name: threat-enrichments-indicator-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.enrichments.indicator.x509.subject.country ignore_above: 1024 @@ -14281,7 +14281,7 @@ threat.enrichments.indicator.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.enrichments.indicator.x509.subject.distinguished_name: dashed_name: threat-enrichments-indicator-x509-subject-distinguished-name @@ -15570,7 +15570,7 @@ threat.indicator.file.x509.issuer.common_name: type: keyword threat.indicator.file.x509.issuer.country: dashed_name: threat-indicator-file-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.indicator.file.x509.issuer.country ignore_above: 1024 @@ -15579,7 +15579,7 @@ threat.indicator.file.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.indicator.file.x509.issuer.distinguished_name: dashed_name: threat-indicator-file-x509-issuer-distinguished-name @@ -15760,7 +15760,7 @@ threat.indicator.file.x509.subject.common_name: type: keyword threat.indicator.file.x509.subject.country: dashed_name: threat-indicator-file-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.indicator.file.x509.subject.country ignore_above: 1024 @@ -15769,7 +15769,7 @@ threat.indicator.file.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.indicator.file.x509.subject.distinguished_name: dashed_name: threat-indicator-file-x509-subject-distinguished-name @@ -16452,7 +16452,7 @@ threat.indicator.x509.issuer.common_name: type: keyword threat.indicator.x509.issuer.country: dashed_name: threat-indicator-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.indicator.x509.issuer.country ignore_above: 1024 @@ -16461,7 +16461,7 @@ threat.indicator.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.indicator.x509.issuer.distinguished_name: dashed_name: threat-indicator-x509-issuer-distinguished-name @@ -16642,7 +16642,7 @@ threat.indicator.x509.subject.common_name: type: keyword threat.indicator.x509.subject.country: dashed_name: threat-indicator-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.indicator.x509.subject.country ignore_above: 1024 @@ -16651,7 +16651,7 @@ threat.indicator.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.indicator.x509.subject.distinguished_name: dashed_name: threat-indicator-x509-subject-distinguished-name @@ -17131,7 +17131,7 @@ tls.client.x509.issuer.common_name: type: keyword tls.client.x509.issuer.country: dashed_name: tls-client-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: tls.client.x509.issuer.country ignore_above: 1024 @@ -17140,7 +17140,7 @@ tls.client.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword tls.client.x509.issuer.distinguished_name: dashed_name: tls-client-x509-issuer-distinguished-name @@ -17321,7 +17321,7 @@ tls.client.x509.subject.common_name: type: keyword tls.client.x509.subject.country: dashed_name: tls-client-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: tls.client.x509.subject.country ignore_above: 1024 @@ -17330,7 +17330,7 @@ tls.client.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword tls.client.x509.subject.distinguished_name: dashed_name: tls-client-x509-subject-distinguished-name @@ -17608,7 +17608,7 @@ tls.server.x509.issuer.common_name: type: keyword tls.server.x509.issuer.country: dashed_name: tls-server-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: tls.server.x509.issuer.country ignore_above: 1024 @@ -17617,7 +17617,7 @@ tls.server.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword tls.server.x509.issuer.distinguished_name: dashed_name: tls-server-x509-issuer-distinguished-name @@ -17798,7 +17798,7 @@ tls.server.x509.subject.common_name: type: keyword tls.server.x509.subject.country: dashed_name: tls-server-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: tls.server.x509.subject.country ignore_above: 1024 @@ -17807,7 +17807,7 @@ tls.server.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword tls.server.x509.subject.distinguished_name: dashed_name: tls-server-x509-subject-distinguished-name diff --git a/experimental/generated/ecs/ecs_nested.yml b/experimental/generated/ecs/ecs_nested.yml index 6327948495..dd4d7e5305 100644 --- a/experimental/generated/ecs/ecs_nested.yml +++ b/experimental/generated/ecs/ecs_nested.yml @@ -5403,7 +5403,7 @@ file: type: keyword file.x509.issuer.country: dashed_name: file-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: file.x509.issuer.country ignore_above: 1024 @@ -5412,7 +5412,7 @@ file: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword file.x509.issuer.distinguished_name: dashed_name: file-x509-issuer-distinguished-name @@ -5593,7 +5593,7 @@ file: type: keyword file.x509.subject.country: dashed_name: file-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: file.x509.subject.country ignore_above: 1024 @@ -5602,7 +5602,7 @@ file: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword file.x509.subject.distinguished_name: dashed_name: file-x509-subject-distinguished-name @@ -15259,7 +15259,7 @@ threat: type: keyword threat.enrichments.indicator.file.x509.issuer.country: dashed_name: threat-enrichments-indicator-file-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.enrichments.indicator.file.x509.issuer.country ignore_above: 1024 @@ -15268,7 +15268,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.enrichments.indicator.file.x509.issuer.distinguished_name: dashed_name: threat-enrichments-indicator-file-x509-issuer-distinguished-name @@ -15449,7 +15449,7 @@ threat: type: keyword threat.enrichments.indicator.file.x509.subject.country: dashed_name: threat-enrichments-indicator-file-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.enrichments.indicator.file.x509.subject.country ignore_above: 1024 @@ -15458,7 +15458,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.enrichments.indicator.file.x509.subject.distinguished_name: dashed_name: threat-enrichments-indicator-file-x509-subject-distinguished-name @@ -16156,7 +16156,7 @@ threat: type: keyword threat.enrichments.indicator.x509.issuer.country: dashed_name: threat-enrichments-indicator-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.enrichments.indicator.x509.issuer.country ignore_above: 1024 @@ -16165,7 +16165,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.enrichments.indicator.x509.issuer.distinguished_name: dashed_name: threat-enrichments-indicator-x509-issuer-distinguished-name @@ -16346,7 +16346,7 @@ threat: type: keyword threat.enrichments.indicator.x509.subject.country: dashed_name: threat-enrichments-indicator-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.enrichments.indicator.x509.subject.country ignore_above: 1024 @@ -16355,7 +16355,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.enrichments.indicator.x509.subject.distinguished_name: dashed_name: threat-enrichments-indicator-x509-subject-distinguished-name @@ -17644,7 +17644,7 @@ threat: type: keyword threat.indicator.file.x509.issuer.country: dashed_name: threat-indicator-file-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.indicator.file.x509.issuer.country ignore_above: 1024 @@ -17653,7 +17653,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.indicator.file.x509.issuer.distinguished_name: dashed_name: threat-indicator-file-x509-issuer-distinguished-name @@ -17834,7 +17834,7 @@ threat: type: keyword threat.indicator.file.x509.subject.country: dashed_name: threat-indicator-file-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.indicator.file.x509.subject.country ignore_above: 1024 @@ -17843,7 +17843,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.indicator.file.x509.subject.distinguished_name: dashed_name: threat-indicator-file-x509-subject-distinguished-name @@ -18530,7 +18530,7 @@ threat: type: keyword threat.indicator.x509.issuer.country: dashed_name: threat-indicator-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.indicator.x509.issuer.country ignore_above: 1024 @@ -18539,7 +18539,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.indicator.x509.issuer.distinguished_name: dashed_name: threat-indicator-x509-issuer-distinguished-name @@ -18720,7 +18720,7 @@ threat: type: keyword threat.indicator.x509.subject.country: dashed_name: threat-indicator-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.indicator.x509.subject.country ignore_above: 1024 @@ -18729,7 +18729,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.indicator.x509.subject.distinguished_name: dashed_name: threat-indicator-x509-subject-distinguished-name @@ -19279,7 +19279,7 @@ tls: type: keyword tls.client.x509.issuer.country: dashed_name: tls-client-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: tls.client.x509.issuer.country ignore_above: 1024 @@ -19288,7 +19288,7 @@ tls: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword tls.client.x509.issuer.distinguished_name: dashed_name: tls-client-x509-issuer-distinguished-name @@ -19469,7 +19469,7 @@ tls: type: keyword tls.client.x509.subject.country: dashed_name: tls-client-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: tls.client.x509.subject.country ignore_above: 1024 @@ -19478,7 +19478,7 @@ tls: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword tls.client.x509.subject.distinguished_name: dashed_name: tls-client-x509-subject-distinguished-name @@ -19759,7 +19759,7 @@ tls: type: keyword tls.server.x509.issuer.country: dashed_name: tls-server-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: tls.server.x509.issuer.country ignore_above: 1024 @@ -19768,7 +19768,7 @@ tls: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword tls.server.x509.issuer.distinguished_name: dashed_name: tls-server-x509-issuer-distinguished-name @@ -19949,7 +19949,7 @@ tls: type: keyword tls.server.x509.subject.country: dashed_name: tls-server-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: tls.server.x509.subject.country ignore_above: 1024 @@ -19958,7 +19958,7 @@ tls: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword tls.server.x509.subject.distinguished_name: dashed_name: tls-server-x509-subject-distinguished-name @@ -21400,7 +21400,7 @@ x509: type: keyword x509.issuer.country: dashed_name: x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: x509.issuer.country ignore_above: 1024 @@ -21408,7 +21408,7 @@ x509: name: issuer.country normalize: - array - short: List of country (C) codes + short: List of country \(C) codes type: keyword x509.issuer.distinguished_name: dashed_name: x509-issuer-distinguished-name @@ -21575,7 +21575,7 @@ x509: type: keyword x509.subject.country: dashed_name: x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: x509.subject.country ignore_above: 1024 @@ -21583,7 +21583,7 @@ x509: name: subject.country normalize: - array - short: List of country (C) code + short: List of country \(C) code type: keyword x509.subject.distinguished_name: dashed_name: x509-subject-distinguished-name diff --git a/generated/beats/fields.ecs.yml b/generated/beats/fields.ecs.yml index e6d03132f1..06789dd668 100644 --- a/generated/beats/fields.ecs.yml +++ b/generated/beats/fields.ecs.yml @@ -3018,7 +3018,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: x509.issuer.distinguished_name @@ -3126,7 +3126,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: x509.subject.distinguished_name @@ -8806,7 +8806,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: enrichments.indicator.file.x509.issuer.distinguished_name @@ -8914,7 +8914,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: enrichments.indicator.file.x509.subject.distinguished_name @@ -9351,7 +9351,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: enrichments.indicator.x509.issuer.distinguished_name @@ -9459,7 +9459,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: enrichments.indicator.x509.subject.distinguished_name @@ -10231,7 +10231,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: indicator.file.x509.issuer.distinguished_name @@ -10339,7 +10339,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: indicator.file.x509.subject.distinguished_name @@ -10776,7 +10776,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: indicator.x509.issuer.distinguished_name @@ -10884,7 +10884,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: indicator.x509.subject.distinguished_name @@ -11194,7 +11194,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: client.x509.issuer.distinguished_name @@ -11302,7 +11302,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: client.x509.subject.distinguished_name @@ -11476,7 +11476,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: server.x509.issuer.distinguished_name @@ -11584,7 +11584,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: server.x509.subject.distinguished_name @@ -12431,7 +12431,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) codes + description: List of country \(C) codes example: US default_field: false - name: issuer.distinguished_name @@ -12539,7 +12539,7 @@ level: extended type: keyword ignore_above: 1024 - description: List of country (C) code + description: List of country \(C) code example: US default_field: false - name: subject.distinguished_name diff --git a/generated/csv/fields.csv b/generated/csv/fields.csv index ea1be4ca42..ed24ea22df 100644 --- a/generated/csv/fields.csv +++ b/generated/csv/fields.csv @@ -325,7 +325,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,file,file.uid,keyword,extended,,1001,The user ID (UID) or security identifier (SID) of the file owner. 8.5.0-dev,true,file,file.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev,true,file,file.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev,true,file,file.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev,true,file,file.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev,true,file,file.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev,true,file,file.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev,true,file,file.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -340,7 +340,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,file,file.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev,true,file,file.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev,true,file,file.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev,true,file,file.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev,true,file,file.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev,true,file,file.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev,true,file,file.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev,true,file,file.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. @@ -1039,7 +1039,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,threat,threat.enrichments.indicator.file.uid,keyword,extended,,1001,The user ID (UID) or security identifier (SID) of the file owner. 8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -1054,7 +1054,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev,true,threat,threat.enrichments.indicator.file.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. @@ -1108,7 +1108,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,threat,threat.enrichments.indicator.url.username,keyword,extended,,,Username of the request. 8.5.0-dev,true,threat,threat.enrichments.indicator.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev,true,threat,threat.enrichments.indicator.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev,true,threat,threat.enrichments.indicator.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev,true,threat,threat.enrichments.indicator.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev,true,threat,threat.enrichments.indicator.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev,true,threat,threat.enrichments.indicator.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev,true,threat,threat.enrichments.indicator.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -1123,7 +1123,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,threat,threat.enrichments.indicator.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev,true,threat,threat.enrichments.indicator.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev,true,threat,threat.enrichments.indicator.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev,true,threat,threat.enrichments.indicator.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev,true,threat,threat.enrichments.indicator.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev,true,threat,threat.enrichments.indicator.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev,true,threat,threat.enrichments.indicator.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev,true,threat,threat.enrichments.indicator.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. @@ -1230,7 +1230,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,threat,threat.indicator.file.uid,keyword,extended,,1001,The user ID (UID) or security identifier (SID) of the file owner. 8.5.0-dev,true,threat,threat.indicator.file.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev,true,threat,threat.indicator.file.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev,true,threat,threat.indicator.file.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev,true,threat,threat.indicator.file.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev,true,threat,threat.indicator.file.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev,true,threat,threat.indicator.file.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev,true,threat,threat.indicator.file.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -1245,7 +1245,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,threat,threat.indicator.file.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev,true,threat,threat.indicator.file.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev,true,threat,threat.indicator.file.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev,true,threat,threat.indicator.file.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev,true,threat,threat.indicator.file.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev,true,threat,threat.indicator.file.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev,true,threat,threat.indicator.file.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev,true,threat,threat.indicator.file.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. @@ -1299,7 +1299,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,threat,threat.indicator.url.username,keyword,extended,,,Username of the request. 8.5.0-dev,true,threat,threat.indicator.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev,true,threat,threat.indicator.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev,true,threat,threat.indicator.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev,true,threat,threat.indicator.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev,true,threat,threat.indicator.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev,true,threat,threat.indicator.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev,true,threat,threat.indicator.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -1314,7 +1314,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,threat,threat.indicator.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev,true,threat,threat.indicator.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev,true,threat,threat.indicator.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev,true,threat,threat.indicator.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev,true,threat,threat.indicator.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev,true,threat,threat.indicator.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev,true,threat,threat.indicator.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev,true,threat,threat.indicator.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. @@ -1353,7 +1353,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,tls,tls.client.supported_ciphers,keyword,extended,array,"[""TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"", ""TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"", ""...""]",Array of ciphers offered by the client during the client hello. 8.5.0-dev,true,tls,tls.client.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev,true,tls,tls.client.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev,true,tls,tls.client.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev,true,tls,tls.client.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev,true,tls,tls.client.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev,true,tls,tls.client.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev,true,tls,tls.client.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -1368,7 +1368,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,tls,tls.client.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev,true,tls,tls.client.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev,true,tls,tls.client.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev,true,tls,tls.client.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev,true,tls,tls.client.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev,true,tls,tls.client.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev,true,tls,tls.client.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev,true,tls,tls.client.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. @@ -1391,7 +1391,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,tls,tls.server.subject,keyword,extended,,"CN=www.example.com, OU=Infrastructure Team, DC=example, DC=com",Subject of the x.509 certificate presented by the server. 8.5.0-dev,true,tls,tls.server.x509.alternative_names,keyword,extended,array,*.elastic.co,List of subject alternative names (SAN). 8.5.0-dev,true,tls,tls.server.x509.issuer.common_name,keyword,extended,array,Example SHA2 High Assurance Server CA,List of common name (CN) of issuing certificate authority. -8.5.0-dev,true,tls,tls.server.x509.issuer.country,keyword,extended,array,US,List of country (C) codes +8.5.0-dev,true,tls,tls.server.x509.issuer.country,keyword,extended,array,US,List of country \(C) codes 8.5.0-dev,true,tls,tls.server.x509.issuer.distinguished_name,keyword,extended,,"C=US, O=Example Inc, OU=www.example.com, CN=Example SHA2 High Assurance Server CA",Distinguished name (DN) of issuing certificate authority. 8.5.0-dev,true,tls,tls.server.x509.issuer.locality,keyword,extended,array,Mountain View,List of locality names (L) 8.5.0-dev,true,tls,tls.server.x509.issuer.organization,keyword,extended,array,Example Inc,List of organizations (O) of issuing certificate authority. @@ -1406,7 +1406,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,tls,tls.server.x509.serial_number,keyword,extended,,55FBB9C7DEBF09809D12CCAA,Unique serial number issued by the certificate authority. 8.5.0-dev,true,tls,tls.server.x509.signature_algorithm,keyword,extended,,SHA256-RSA,Identifier for certificate signature algorithm. 8.5.0-dev,true,tls,tls.server.x509.subject.common_name,keyword,extended,array,shared.global.example.net,List of common names (CN) of subject. -8.5.0-dev,true,tls,tls.server.x509.subject.country,keyword,extended,array,US,List of country (C) code +8.5.0-dev,true,tls,tls.server.x509.subject.country,keyword,extended,array,US,List of country \(C) code 8.5.0-dev,true,tls,tls.server.x509.subject.distinguished_name,keyword,extended,,"C=US, ST=California, L=San Francisco, O=Example, Inc., CN=shared.global.example.net",Distinguished name (DN) of the certificate subject entity. 8.5.0-dev,true,tls,tls.server.x509.subject.locality,keyword,extended,array,San Francisco,List of locality names (L) 8.5.0-dev,true,tls,tls.server.x509.subject.organization,keyword,extended,array,"Example, Inc.",List of organizations (O) of subject. diff --git a/generated/ecs/ecs_flat.yml b/generated/ecs/ecs_flat.yml index d65d305f2f..f399d2aa14 100644 --- a/generated/ecs/ecs_flat.yml +++ b/generated/ecs/ecs_flat.yml @@ -4422,7 +4422,7 @@ file.x509.issuer.common_name: type: keyword file.x509.issuer.country: dashed_name: file-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: file.x509.issuer.country ignore_above: 1024 @@ -4431,7 +4431,7 @@ file.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword file.x509.issuer.distinguished_name: dashed_name: file-x509-issuer-distinguished-name @@ -4612,7 +4612,7 @@ file.x509.subject.common_name: type: keyword file.x509.subject.country: dashed_name: file-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: file.x509.subject.country ignore_above: 1024 @@ -4621,7 +4621,7 @@ file.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword file.x509.subject.distinguished_name: dashed_name: file-x509-subject-distinguished-name @@ -13120,7 +13120,7 @@ threat.enrichments.indicator.file.x509.issuer.common_name: type: keyword threat.enrichments.indicator.file.x509.issuer.country: dashed_name: threat-enrichments-indicator-file-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.enrichments.indicator.file.x509.issuer.country ignore_above: 1024 @@ -13129,7 +13129,7 @@ threat.enrichments.indicator.file.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.enrichments.indicator.file.x509.issuer.distinguished_name: dashed_name: threat-enrichments-indicator-file-x509-issuer-distinguished-name @@ -13310,7 +13310,7 @@ threat.enrichments.indicator.file.x509.subject.common_name: type: keyword threat.enrichments.indicator.file.x509.subject.country: dashed_name: threat-enrichments-indicator-file-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.enrichments.indicator.file.x509.subject.country ignore_above: 1024 @@ -13319,7 +13319,7 @@ threat.enrichments.indicator.file.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.enrichments.indicator.file.x509.subject.distinguished_name: dashed_name: threat-enrichments-indicator-file-x509-subject-distinguished-name @@ -14013,7 +14013,7 @@ threat.enrichments.indicator.x509.issuer.common_name: type: keyword threat.enrichments.indicator.x509.issuer.country: dashed_name: threat-enrichments-indicator-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.enrichments.indicator.x509.issuer.country ignore_above: 1024 @@ -14022,7 +14022,7 @@ threat.enrichments.indicator.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.enrichments.indicator.x509.issuer.distinguished_name: dashed_name: threat-enrichments-indicator-x509-issuer-distinguished-name @@ -14203,7 +14203,7 @@ threat.enrichments.indicator.x509.subject.common_name: type: keyword threat.enrichments.indicator.x509.subject.country: dashed_name: threat-enrichments-indicator-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.enrichments.indicator.x509.subject.country ignore_above: 1024 @@ -14212,7 +14212,7 @@ threat.enrichments.indicator.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.enrichments.indicator.x509.subject.distinguished_name: dashed_name: threat-enrichments-indicator-x509-subject-distinguished-name @@ -15501,7 +15501,7 @@ threat.indicator.file.x509.issuer.common_name: type: keyword threat.indicator.file.x509.issuer.country: dashed_name: threat-indicator-file-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.indicator.file.x509.issuer.country ignore_above: 1024 @@ -15510,7 +15510,7 @@ threat.indicator.file.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.indicator.file.x509.issuer.distinguished_name: dashed_name: threat-indicator-file-x509-issuer-distinguished-name @@ -15691,7 +15691,7 @@ threat.indicator.file.x509.subject.common_name: type: keyword threat.indicator.file.x509.subject.country: dashed_name: threat-indicator-file-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.indicator.file.x509.subject.country ignore_above: 1024 @@ -15700,7 +15700,7 @@ threat.indicator.file.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.indicator.file.x509.subject.distinguished_name: dashed_name: threat-indicator-file-x509-subject-distinguished-name @@ -16383,7 +16383,7 @@ threat.indicator.x509.issuer.common_name: type: keyword threat.indicator.x509.issuer.country: dashed_name: threat-indicator-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.indicator.x509.issuer.country ignore_above: 1024 @@ -16392,7 +16392,7 @@ threat.indicator.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.indicator.x509.issuer.distinguished_name: dashed_name: threat-indicator-x509-issuer-distinguished-name @@ -16573,7 +16573,7 @@ threat.indicator.x509.subject.common_name: type: keyword threat.indicator.x509.subject.country: dashed_name: threat-indicator-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.indicator.x509.subject.country ignore_above: 1024 @@ -16582,7 +16582,7 @@ threat.indicator.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.indicator.x509.subject.distinguished_name: dashed_name: threat-indicator-x509-subject-distinguished-name @@ -17062,7 +17062,7 @@ tls.client.x509.issuer.common_name: type: keyword tls.client.x509.issuer.country: dashed_name: tls-client-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: tls.client.x509.issuer.country ignore_above: 1024 @@ -17071,7 +17071,7 @@ tls.client.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword tls.client.x509.issuer.distinguished_name: dashed_name: tls-client-x509-issuer-distinguished-name @@ -17252,7 +17252,7 @@ tls.client.x509.subject.common_name: type: keyword tls.client.x509.subject.country: dashed_name: tls-client-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: tls.client.x509.subject.country ignore_above: 1024 @@ -17261,7 +17261,7 @@ tls.client.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword tls.client.x509.subject.distinguished_name: dashed_name: tls-client-x509-subject-distinguished-name @@ -17539,7 +17539,7 @@ tls.server.x509.issuer.common_name: type: keyword tls.server.x509.issuer.country: dashed_name: tls-server-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: tls.server.x509.issuer.country ignore_above: 1024 @@ -17548,7 +17548,7 @@ tls.server.x509.issuer.country: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword tls.server.x509.issuer.distinguished_name: dashed_name: tls-server-x509-issuer-distinguished-name @@ -17729,7 +17729,7 @@ tls.server.x509.subject.common_name: type: keyword tls.server.x509.subject.country: dashed_name: tls-server-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: tls.server.x509.subject.country ignore_above: 1024 @@ -17738,7 +17738,7 @@ tls.server.x509.subject.country: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword tls.server.x509.subject.distinguished_name: dashed_name: tls-server-x509-subject-distinguished-name diff --git a/generated/ecs/ecs_nested.yml b/generated/ecs/ecs_nested.yml index c5442831d1..93dbffdd15 100644 --- a/generated/ecs/ecs_nested.yml +++ b/generated/ecs/ecs_nested.yml @@ -5323,7 +5323,7 @@ file: type: keyword file.x509.issuer.country: dashed_name: file-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: file.x509.issuer.country ignore_above: 1024 @@ -5332,7 +5332,7 @@ file: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword file.x509.issuer.distinguished_name: dashed_name: file-x509-issuer-distinguished-name @@ -5513,7 +5513,7 @@ file: type: keyword file.x509.subject.country: dashed_name: file-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: file.x509.subject.country ignore_above: 1024 @@ -5522,7 +5522,7 @@ file: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword file.x509.subject.distinguished_name: dashed_name: file-x509-subject-distinguished-name @@ -15179,7 +15179,7 @@ threat: type: keyword threat.enrichments.indicator.file.x509.issuer.country: dashed_name: threat-enrichments-indicator-file-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.enrichments.indicator.file.x509.issuer.country ignore_above: 1024 @@ -15188,7 +15188,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.enrichments.indicator.file.x509.issuer.distinguished_name: dashed_name: threat-enrichments-indicator-file-x509-issuer-distinguished-name @@ -15369,7 +15369,7 @@ threat: type: keyword threat.enrichments.indicator.file.x509.subject.country: dashed_name: threat-enrichments-indicator-file-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.enrichments.indicator.file.x509.subject.country ignore_above: 1024 @@ -15378,7 +15378,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.enrichments.indicator.file.x509.subject.distinguished_name: dashed_name: threat-enrichments-indicator-file-x509-subject-distinguished-name @@ -16076,7 +16076,7 @@ threat: type: keyword threat.enrichments.indicator.x509.issuer.country: dashed_name: threat-enrichments-indicator-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.enrichments.indicator.x509.issuer.country ignore_above: 1024 @@ -16085,7 +16085,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.enrichments.indicator.x509.issuer.distinguished_name: dashed_name: threat-enrichments-indicator-x509-issuer-distinguished-name @@ -16266,7 +16266,7 @@ threat: type: keyword threat.enrichments.indicator.x509.subject.country: dashed_name: threat-enrichments-indicator-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.enrichments.indicator.x509.subject.country ignore_above: 1024 @@ -16275,7 +16275,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.enrichments.indicator.x509.subject.distinguished_name: dashed_name: threat-enrichments-indicator-x509-subject-distinguished-name @@ -17564,7 +17564,7 @@ threat: type: keyword threat.indicator.file.x509.issuer.country: dashed_name: threat-indicator-file-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.indicator.file.x509.issuer.country ignore_above: 1024 @@ -17573,7 +17573,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.indicator.file.x509.issuer.distinguished_name: dashed_name: threat-indicator-file-x509-issuer-distinguished-name @@ -17754,7 +17754,7 @@ threat: type: keyword threat.indicator.file.x509.subject.country: dashed_name: threat-indicator-file-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.indicator.file.x509.subject.country ignore_above: 1024 @@ -17763,7 +17763,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.indicator.file.x509.subject.distinguished_name: dashed_name: threat-indicator-file-x509-subject-distinguished-name @@ -18450,7 +18450,7 @@ threat: type: keyword threat.indicator.x509.issuer.country: dashed_name: threat-indicator-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: threat.indicator.x509.issuer.country ignore_above: 1024 @@ -18459,7 +18459,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword threat.indicator.x509.issuer.distinguished_name: dashed_name: threat-indicator-x509-issuer-distinguished-name @@ -18640,7 +18640,7 @@ threat: type: keyword threat.indicator.x509.subject.country: dashed_name: threat-indicator-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: threat.indicator.x509.subject.country ignore_above: 1024 @@ -18649,7 +18649,7 @@ threat: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword threat.indicator.x509.subject.distinguished_name: dashed_name: threat-indicator-x509-subject-distinguished-name @@ -19199,7 +19199,7 @@ tls: type: keyword tls.client.x509.issuer.country: dashed_name: tls-client-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: tls.client.x509.issuer.country ignore_above: 1024 @@ -19208,7 +19208,7 @@ tls: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword tls.client.x509.issuer.distinguished_name: dashed_name: tls-client-x509-issuer-distinguished-name @@ -19389,7 +19389,7 @@ tls: type: keyword tls.client.x509.subject.country: dashed_name: tls-client-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: tls.client.x509.subject.country ignore_above: 1024 @@ -19398,7 +19398,7 @@ tls: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword tls.client.x509.subject.distinguished_name: dashed_name: tls-client-x509-subject-distinguished-name @@ -19679,7 +19679,7 @@ tls: type: keyword tls.server.x509.issuer.country: dashed_name: tls-server-x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: tls.server.x509.issuer.country ignore_above: 1024 @@ -19688,7 +19688,7 @@ tls: normalize: - array original_fieldset: x509 - short: List of country (C) codes + short: List of country \(C) codes type: keyword tls.server.x509.issuer.distinguished_name: dashed_name: tls-server-x509-issuer-distinguished-name @@ -19869,7 +19869,7 @@ tls: type: keyword tls.server.x509.subject.country: dashed_name: tls-server-x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: tls.server.x509.subject.country ignore_above: 1024 @@ -19878,7 +19878,7 @@ tls: normalize: - array original_fieldset: x509 - short: List of country (C) code + short: List of country \(C) code type: keyword tls.server.x509.subject.distinguished_name: dashed_name: tls-server-x509-subject-distinguished-name @@ -21320,7 +21320,7 @@ x509: type: keyword x509.issuer.country: dashed_name: x509-issuer-country - description: List of country (C) codes + description: List of country \(C) codes example: US flat_name: x509.issuer.country ignore_above: 1024 @@ -21328,7 +21328,7 @@ x509: name: issuer.country normalize: - array - short: List of country (C) codes + short: List of country \(C) codes type: keyword x509.issuer.distinguished_name: dashed_name: x509-issuer-distinguished-name @@ -21495,7 +21495,7 @@ x509: type: keyword x509.subject.country: dashed_name: x509-subject-country - description: List of country (C) code + description: List of country \(C) code example: US flat_name: x509.subject.country ignore_above: 1024 @@ -21503,7 +21503,7 @@ x509: name: subject.country normalize: - array - short: List of country (C) code + short: List of country \(C) code type: keyword x509.subject.distinguished_name: dashed_name: x509-subject-distinguished-name diff --git a/schemas/README.md b/schemas/README.md index f9a43f2fe6..7762616e13 100644 --- a/schemas/README.md +++ b/schemas/README.md @@ -166,6 +166,7 @@ Supported keys to describe fields on a `wildcard` field. - format: Field format that can be used in a Kibana index template. - pattern (optional): A regular expression that expresses the expected constraints of the field's string values. +- expected_values (optional): An array of expected values for the field. Schema consumers can validate integrations and mapped data against the listed values. These values are the recommended convention, but users may also use other values. - normalize: Normalization steps that should be applied at ingestion time. Supported values: - array: the content of the field should be an array (even when there's only one value). - beta (optional): Adds a beta marker for the field to the description. The text provided in this attribute is used as content of the beta marker in the documentation. Note that when a whole field set is marked as beta, it is not necessary nor recommended to mark all fields in the field set as beta. Beta notices should not have newlines. diff --git a/schemas/x509.yml b/schemas/x509.yml index 7d2254d632..906b63279b 100644 --- a/schemas/x509.yml +++ b/schemas/x509.yml @@ -108,7 +108,7 @@ type: keyword normalize: - array - description: List of country (C) codes + description: List of country \(C) codes example: US - name: signature_algorithm @@ -183,7 +183,7 @@ type: keyword normalize: - array - description: List of country (C) code + description: List of country \(C) code example: US - name: public_key_algorithm diff --git a/scripts/schema/cleaner.py b/scripts/schema/cleaner.py index 7338851a47..f6c68f4337 100644 --- a/scripts/schema/cleaner.py +++ b/scripts/schema/cleaner.py @@ -274,29 +274,36 @@ def check_example_value(field: Union[List, FieldEntry], strict: Optional[bool] = Checks if value of the example field is of type list or dict. Fails or warns (depending on strict mode) if so. """ - example_value: Union[List, FieldEntry] = field['field_details'].get('example', None) - pattern = field['field_details'].get('pattern', None) - name = field['field_details']['name'] + example_value: str = field['field_details'].get('example', '') + pattern: str = field['field_details'].get('pattern', '') + expected_values: List[str] = field['field_details'].get('expected_values', []) + name: str = field['field_details']['name'] if isinstance(example_value, (list, dict)): field_name: str = field['field_details']['name'] msg: str = f"Example value for field `{field_name}` contains an object or array which must be quoted to avoid YAML interpretation." strict_warning_handler(msg, strict) - if pattern: - # Examples with arrays must be handled - if 'array' in field['field_details']['normalize']: - # strips unnecessary chars in order to split each example value - example_values = example_value.translate(str.maketrans('', '', '"[] ')).split(',') - else: - example_values = [example_value] + # Examples with arrays must be handled + if 'array' in field['field_details'].get('normalize', []): + # strips unnecessary chars in order to split each example value + example_values = example_value.translate(str.maketrans('', '', '"[] ')).split(',') + else: + example_values = [example_value] + if pattern: for example_value in example_values: match = re.match(pattern, example_value) if not match: msg = f"Example value for field `{name}` does not match the regex defined in the pattern attribute: `{pattern}`." strict_warning_handler(msg, strict) + if expected_values: + for example_value in example_values: + if example_value not in expected_values: + msg = f"Example value `{example_value}` for field `{name}` is not one of the values defined in `expected_value`: {expected_values}." + strict_warning_handler(msg, strict) + def single_line_beta_description(schema_or_field: FieldEntry, strict: Optional[bool] = True) -> None: if "\n" in schema_or_field['field_details']['beta']: diff --git a/scripts/templates/field_details.j2 b/scripts/templates/field_details.j2 index 136c9d7827..15c0158f89 100644 --- a/scripts/templates/field_details.j2 +++ b/scripts/templates/field_details.j2 @@ -34,13 +34,22 @@ beta::[ {{ fieldset['beta'] }}] {# `Description` column -#} {#- Beta fields will add the `beta` label -#} {% if field['beta'] -%} -| beta:[ {{ field['beta'] }} ] +a| beta:[ {{ field['beta'] }} ] {{ field['description']|replace("\n", "\n\n") }} {%- else -%} -| {{ field['description']|replace("\n", "\n\n") }} +a| {{ field['description']|replace("\n", "\n\n") }} {%- endif %} +{#- iterate through each expected value -#} +{%- if field['expected_values'] %} + +Expected values for this field: +{% for val in field['expected_values'] %} +* `{{ val }}` +{%- endfor %}{# for expected_values #} +{%- endif %}{# if 'expected_values' #} + type: {{ field['type'] }} {% if 'multi_fields' in field -%} diff --git a/scripts/tests/unit/test_schema_cleaner.py b/scripts/tests/unit/test_schema_cleaner.py index 7cec6626e7..5cf269a672 100644 --- a/scripts/tests/unit/test_schema_cleaner.py +++ b/scripts/tests/unit/test_schema_cleaner.py @@ -471,6 +471,74 @@ def test_example_array_of_values_mismatch_with_patterns_strict_disabled(self): except Exception: self.fail("clean.check_example_value() raised Exception unexpectedly.") + def test_example_mismatch_with_expected_values(self): + field = { + 'field_details': { + 'name': 'text', + 'expected_values': [ + 'foo', + 'bar' + ], + 'example': 'foobar', + } + } + with self.assertRaisesRegex(ValueError, 'not one of the values defined in `expected_value`'): + cleaner.check_example_value(field) + + def test_example_array_mismatch_with_expected_values(self): + field = { + 'field_details': { + 'name': 'text', + 'expected_values': [ + 'foo', + 'bar' + ], + 'example': '["foobar"]', + 'normalize': [ + 'array' + ] + } + } + with self.assertRaisesRegex(ValueError, 'not one of the values defined in `expected_value`'): + cleaner.check_example_value(field) + + def test_example_mismatch_with_expected_values_strict_disabled(self): + field = { + 'field_details': { + 'name': 'text', + 'expected_values': [ + 'foo', + 'bar' + ], + 'example': 'foobar', + } + } + try: + with self.assertWarnsRegex(UserWarning, 'not one of the values defined in `expected_value`'): + cleaner.check_example_value(field, strict=False) + except Exception: + self.fail("clean.check_example_value() raised Exception unexpectedly.") + + def test_example_with_array_mismatch_with_expected_values_strict_disabled(self): + field = { + 'field_details': { + 'name': 'text', + 'expected_values': [ + 'foo', + 'bar' + ], + 'example': '["foobar"]', + 'normalize': [ + 'array' + ] + } + } + try: + with self.assertWarnsRegex(UserWarning, 'not one of the values defined in `expected_value`'): + cleaner.check_example_value(field, strict=False) + except Exception: + self.fail("clean.check_example_value() raised Exception unexpectedly.") + def test_very_long_short_override_description_raises(self): schema = { 'schema_details': { From 97584d44d3cfd76ddf138e6a36466c07a92fa3f5 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Thu, 23 Jun 2022 15:42:04 -0500 Subject: [PATCH 3/3] Define initial set of field `expected_values` (#1962) * define expected_values and adjust descriptions accordingly * update artifacts * changelog --- CHANGELOG.next.md | 3 + docs/fields/field-details.asciidoc | 277 ++++++++------------ experimental/generated/beats/fields.ecs.yml | 113 +++----- experimental/generated/csv/fields.csv | 2 +- experimental/generated/ecs/ecs_flat.yml | 208 ++++++++++----- experimental/generated/ecs/ecs_nested.yml | 227 +++++++++++----- generated/beats/fields.ecs.yml | 113 +++----- generated/csv/fields.csv | 2 +- generated/ecs/ecs_flat.yml | 208 ++++++++++----- generated/ecs/ecs_nested.yml | 227 +++++++++++----- schemas/dns.yml | 10 +- schemas/faas.yml | 13 +- schemas/network.yml | 17 +- schemas/os.yml | 9 +- schemas/threat.yml | 164 ++++++------ 15 files changed, 917 insertions(+), 676 deletions(-) diff --git a/CHANGELOG.next.md b/CHANGELOG.next.md index 3238f123e8..2be5298ed9 100644 --- a/CHANGELOG.next.md +++ b/CHANGELOG.next.md @@ -43,6 +43,7 @@ Thanks, you're awesome :-) --> #### Added * Add `service.node.role` #1916 +* Initial set of `expected_values`. #1962 #### Improvements @@ -58,6 +59,8 @@ Thanks, you're awesome :-) --> #### Added +* Introduce `expected_values` attribute. #1952 + #### Improvements * Additional type annotations. #1950 diff --git a/docs/fields/field-details.asciidoc b/docs/fields/field-details.asciidoc index 16352bd6be..6f1d11bc0a 100644 --- a/docs/fields/field-details.asciidoc +++ b/docs/fields/field-details.asciidoc @@ -1818,7 +1818,15 @@ example: `CNAME` a| Array of 2 letter DNS header flags. -Expected values are: AA, TC, RD, RA, AD, CD, DO. +Expected values for this field: + +* `AA` +* `TC` +* `RD` +* `RA` +* `AD` +* `CD` +* `DO` type: keyword @@ -3725,17 +3733,13 @@ example: `123456789` a| The trigger for the function execution. -Expected values are: - - * http - - * pubsub - - * datasource - - * timer +Expected values for this field: - * other +* `http` +* `pubsub` +* `datasource` +* `timer` +* `other` type: keyword @@ -5779,30 +5783,22 @@ example: `1:hO+sN4H+MG5MY/8hIrXPqc4ZQz0=` a| Direction of the network traffic. -Recommended values are: - - * ingress - - * egress - - * inbound - - * outbound - - * internal - - * external - - * unknown - - - When mapping events from a host-based monitoring context, populate this field from the host's point of view, using the values "ingress" or "egress". When mapping events from a network or perimeter-based monitoring context, populate this field from the point of view of the network perimeter, using the values "inbound", "outbound", "internal" or "external". Note that "internal" is not crossing perimeter boundaries, and is meant to describe communication between two hosts within the perimeter. Note also that "external" is meant to describe traffic between two hosts that are external to the perimeter. This could for example be useful for ISPs or VPN service providers. +Expected values for this field: + +* `ingress` +* `egress` +* `inbound` +* `outbound` +* `internal` +* `external` +* `unknown` + type: keyword @@ -6678,9 +6674,14 @@ example: `darwin` a| Use the `os.type` field to categorize the operating system into one of the broad commercial families. -One of these following values should be used (lowercase): linux, macos, unix, windows. +If the OS you're dealing with is not listed as an expected value, the field should not be populated. Please let us know by opening an issue with ECS, to propose its addition. + +Expected values for this field: -If the OS you're dealing with is not in the list, the field should not be populated. Please let us know by opening an issue with ECS, to propose its addition. +* `linux` +* `macos` +* `unix` +* `windows` type: keyword @@ -9100,19 +9101,15 @@ type: object a| beta:[ This field is beta and subject to change. ] -Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence scales may be added as custom fields. - -Expected values are: - - * Not Specified +Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence scales may be added as custom fields. - * None +Expected values for this field: - * Low - - * Medium - - * High +* `Not Specified` +* `None` +* `Low` +* `Medium` +* `High` type: keyword @@ -9220,21 +9217,20 @@ example: `2020-11-05T17:25:47.000Z` a| beta:[ This field is beta and subject to change. ] -Traffic Light Protocol sharing markings. Recommended values are: - - * WHITE +Traffic Light Protocol sharing markings. - * GREEN +Expected values for this field: - * AMBER - - * RED +* `WHITE` +* `GREEN` +* `AMBER` +* `RED` type: keyword -example: `White` +example: `WHITE` | extended @@ -9354,41 +9350,27 @@ example: `20` a| beta:[ This field is beta and subject to change. ] -Type of indicator as represented by Cyber Observable in STIX 2.0. Recommended values: - - * autonomous-system - - * artifact - - * directory - - * domain-name - - * email-addr - - * file - - * ipv4-addr - - * ipv6-addr - - * mac-addr - - * mutex - - * port - - * process - - * software - - * url +Type of indicator as represented by Cyber Observable in STIX 2.0. - * user-account +Expected values for this field: - * windows-registry-key - - * x509-certificate +* `autonomous-system` +* `artifact` +* `directory` +* `domain-name` +* `email-addr` +* `file` +* `ipv4-addr` +* `ipv6-addr` +* `mac-addr` +* `mutex` +* `port` +* `process` +* `software` +* `url` +* `user-account` +* `windows-registry-key` +* `x509-certificate` type: keyword @@ -9665,19 +9647,15 @@ example: `https://attack.mitre.org/groups/G0037/` [[field-threat-indicator-confidence]] <> -a| Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence scales may be added as custom fields. - -Expected values are: - - * Not Specified - - * None - - * Low +a| Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence scales may be added as custom fields. - * Medium +Expected values for this field: - * High +* `Not Specified` +* `None` +* `Low` +* `Medium` +* `High` type: keyword @@ -9775,15 +9753,12 @@ example: `2020-11-05T17:25:47.000Z` a| Traffic Light Protocol sharing markings. -Recommended values are: +Expected values for this field: - * WHITE - - * GREEN - - * AMBER - - * RED +* `WHITE` +* `GREEN` +* `AMBER` +* `RED` type: keyword @@ -9897,41 +9872,25 @@ example: `20` a| Type of indicator as represented by Cyber Observable in STIX 2.0. -Recommended values: - - * autonomous-system - - * artifact - - * directory - - * domain-name - - * email-addr - - * file - - * ipv4-addr - - * ipv6-addr - - * mac-addr - - * mutex - - * port +Expected values for this field: - * process - - * software - - * url - - * user-account - - * windows-registry-key - - * x509-certificate +* `autonomous-system` +* `artifact` +* `directory` +* `domain-name` +* `email-addr` +* `file` +* `ipv4-addr` +* `ipv6-addr` +* `mac-addr` +* `mutex` +* `port` +* `process` +* `software` +* `url` +* `user-account` +* `windows-registry-key` +* `x509-certificate` type: keyword @@ -10006,31 +9965,20 @@ example: `AdFind` a| The platforms of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. -Recommended Values: - - * AWS - - * Azure - - * Azure AD - - * GCP - - * Linux +While not required, you can use MITRE ATT&CK® software platform values. - * macOS +Expected values for this field: - * Network - - * Office 365 - - * SaaS - - * Windows - - - -While not required, you can use a MITRE ATT&CK® software platforms. +* `AWS` +* `Azure` +* `Azure AD` +* `GCP` +* `Linux` +* `macOS` +* `Network` +* `Office 365` +* `SaaS` +* `Windows` type: keyword @@ -10069,15 +10017,12 @@ example: `https://attack.mitre.org/software/S0552/` a| The type of software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. -Recommended values - - * Malware - - * Tool - +While not required, you can use a MITRE ATT&CK® software type. +Expected values for this field: - While not required, you can use a MITRE ATT&CK® software type. +* `Malware` +* `Tool` type: keyword diff --git a/experimental/generated/beats/fields.ecs.yml b/experimental/generated/beats/fields.ecs.yml index 45414f6986..3218ca398e 100644 --- a/experimental/generated/beats/fields.ecs.yml +++ b/experimental/generated/beats/fields.ecs.yml @@ -1569,9 +1569,7 @@ level: extended type: keyword ignore_above: 1024 - description: 'Array of 2 letter DNS header flags. - - Expected values are: AA, TC, RD, RA, AD, CD, DO.' + description: Array of 2 letter DNS header flags. example: '["RD", "RA"]' - name: id level: extended @@ -2496,8 +2494,7 @@ level: extended type: keyword ignore_above: 1024 - description: "The trigger for the function execution.\nExpected values are:\n\ - \ * http\n * pubsub\n * datasource\n * timer\n * other" + description: The trigger for the function execution. example: http default_field: false - name: version @@ -3636,12 +3633,9 @@ description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos default_field: false - name: os.version @@ -4030,18 +4024,20 @@ level: core type: keyword ignore_above: 1024 - description: "Direction of the network traffic.\nRecommended values are:\n \ - \ * ingress\n * egress\n * inbound\n * outbound\n * internal\n * external\n\ - \ * unknown\n\nWhen mapping events from a host-based monitoring context,\ - \ populate this field from the host's point of view, using the values \"ingress\"\ - \ or \"egress\".\nWhen mapping events from a network or perimeter-based monitoring\ - \ context, populate this field from the point of view of the network perimeter,\ - \ using the values \"inbound\", \"outbound\", \"internal\" or \"external\"\ - .\nNote that \"internal\" is not crossing perimeter boundaries, and is meant\ - \ to describe communication between two hosts within the perimeter. Note also\ - \ that \"external\" is meant to describe traffic between two hosts that are\ - \ external to the perimeter. This could for example be useful for ISPs or\ - \ VPN service providers." + description: 'Direction of the network traffic. + + When mapping events from a host-based monitoring context, populate this field + from the host''s point of view, using the values "ingress" or "egress". + + When mapping events from a network or perimeter-based monitoring context, + populate this field from the point of view of the network perimeter, using + the values "inbound", "outbound", "internal" or "external". + + Note that "internal" is not crossing perimeter boundaries, and is meant to + describe communication between two hosts within the perimeter. Note also that + "external" is meant to describe traffic between two hosts that are external + to the perimeter. This could for example be useful for ISPs or VPN service + providers.' example: inbound - name: forwarded_ip level: core @@ -4414,12 +4410,9 @@ description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos default_field: false - name: os.version @@ -4634,12 +4627,9 @@ description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos default_field: false - name: version @@ -8267,10 +8257,9 @@ level: extended type: keyword ignore_above: 1024 - description: "Identifies\_the\_vendor-neutral confidence\_rating\_using\_the\ - \ None/Low/Medium/High\_scale defined in Appendix A of the STIX 2.1 framework.\ - \ Vendor-specific confidence scales may be added as custom fields.\nExpected\ - \ values are:\n * Not Specified\n * None\n * Low\n * Medium\n * High" + description: Identifies the vendor-neutral confidence rating using the None/Low/Medium/High + scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence + scales may be added as custom fields. example: Medium default_field: false - name: enrichments.indicator.description @@ -9118,9 +9107,8 @@ level: extended type: keyword ignore_above: 1024 - description: "Traffic Light Protocol sharing markings. Recommended values are:\n\ - \ * WHITE\n * GREEN\n * AMBER\n * RED" - example: White + description: Traffic Light Protocol sharing markings. + example: WHITE default_field: false - name: enrichments.indicator.modified_at level: extended @@ -9226,11 +9214,7 @@ level: extended type: keyword ignore_above: 1024 - description: "Type of indicator as represented by Cyber Observable in STIX 2.0.\ - \ Recommended values:\n * autonomous-system\n * artifact\n * directory\n\ - \ * domain-name\n * email-addr\n * file\n * ipv4-addr\n * ipv6-addr\n\ - \ * mac-addr\n * mutex\n * port\n * process\n * software\n * url\n \ - \ * user-account\n * windows-registry-key\n * x509-certificate" + description: Type of indicator as represented by Cyber Observable in STIX 2.0. example: ipv4-addr default_field: false - name: enrichments.indicator.url.domain @@ -9692,10 +9676,9 @@ level: extended type: keyword ignore_above: 1024 - description: "Identifies\_the\_vendor-neutral confidence\_rating\_using\_the\ - \ None/Low/Medium/High\_scale defined in Appendix A of the STIX 2.1 framework.\ - \ Vendor-specific confidence scales may be added as custom fields.\nExpected\ - \ values are:\n * Not Specified\n * None\n * Low\n * Medium\n * High" + description: Identifies the vendor-neutral confidence rating using the None/Low/Medium/High + scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence + scales may be added as custom fields. example: Medium default_field: false - name: indicator.description @@ -10543,8 +10526,7 @@ level: extended type: keyword ignore_above: 1024 - description: "Traffic Light Protocol sharing markings.\nRecommended values are:\n\ - \ * WHITE\n * GREEN\n * AMBER\n * RED" + description: Traffic Light Protocol sharing markings. example: WHITE default_field: false - name: indicator.modified_at @@ -10651,11 +10633,7 @@ level: extended type: keyword ignore_above: 1024 - description: "Type of indicator as represented by Cyber Observable in STIX 2.0.\n\ - Recommended values:\n * autonomous-system\n * artifact\n * directory\n\ - \ * domain-name\n * email-addr\n * file\n * ipv4-addr\n * ipv6-addr\n\ - \ * mac-addr\n * mutex\n * port\n * process\n * software\n * url\n \ - \ * user-account\n * windows-registry-key\n * x509-certificate" + description: Type of indicator as represented by Cyber Observable in STIX 2.0. example: ipv4-addr default_field: false - name: indicator.url.domain @@ -11010,10 +10988,8 @@ type: keyword ignore_above: 1024 description: "The platforms of the software used by this threat to conduct behavior\ - \ commonly modeled using MITRE ATT&CK\xAE.\nRecommended Values:\n * AWS\n\ - \ * Azure\n * Azure AD\n * GCP\n * Linux\n * macOS\n * Network\n *\ - \ Office 365\n * SaaS\n * Windows\n\nWhile not required, you can use a MITRE\ - \ ATT&CK\xAE software platforms." + \ commonly modeled using MITRE ATT&CK\xAE.\nWhile not required, you can use\ + \ MITRE ATT&CK\xAE software platform values." example: '[ "Windows" ]' default_field: false - name: software.reference @@ -11030,8 +11006,8 @@ type: keyword ignore_above: 1024 description: "The type of software used by this threat to conduct behavior commonly\ - \ modeled using MITRE ATT&CK\xAE.\nRecommended values\n * Malware\n * Tool\n\ - \n While not required, you can use a MITRE ATT&CK\xAE software type." + \ modeled using MITRE ATT&CK\xAE.\nWhile not required, you can use a MITRE\ + \ ATT&CK\xAE software type." example: Tool default_field: false - name: tactic.id @@ -12258,12 +12234,9 @@ description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos default_field: false - name: os.version diff --git a/experimental/generated/csv/fields.csv b/experimental/generated/csv/fields.csv index e4ac06599a..db3ebeb048 100644 --- a/experimental/generated/csv/fields.csv +++ b/experimental/generated/csv/fields.csv @@ -1082,7 +1082,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.geo.timezone,keyword,core,,America/Argentina/Buenos_Aires,Time zone. 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.ip,ip,extended,,1.2.3.4,Indicator IP address 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.last_seen,date,extended,,2020-11-05T17:25:47.000Z,Date/time indicator was last reported. -8.5.0-dev+exp,true,threat,threat.enrichments.indicator.marking.tlp,keyword,extended,,White,Indicator TLP marking +8.5.0-dev+exp,true,threat,threat.enrichments.indicator.marking.tlp,keyword,extended,,WHITE,Indicator TLP marking 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.modified_at,date,extended,,2020-11-05T17:25:47.000Z,Date/time indicator was last updated. 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.port,long,extended,,443,Indicator port 8.5.0-dev+exp,true,threat,threat.enrichments.indicator.provider,keyword,extended,,lrz_urlhaus,Indicator provider diff --git a/experimental/generated/ecs/ecs_flat.yml b/experimental/generated/ecs/ecs_flat.yml index 6849bb3c8e..76cb23baef 100644 --- a/experimental/generated/ecs/ecs_flat.yml +++ b/experimental/generated/ecs/ecs_flat.yml @@ -2112,10 +2112,16 @@ dns.answers.type: type: keyword dns.header_flags: dashed_name: dns-header-flags - description: 'Array of 2 letter DNS header flags. - - Expected values are: AA, TC, RD, RA, AD, CD, DO.' + description: Array of 2 letter DNS header flags. example: '["RD", "RA"]' + expected_values: + - AA + - TC + - RD + - RA + - AD + - CD + - DO flat_name: dns.header_flags ignore_above: 1024 level: extended @@ -3530,9 +3536,14 @@ faas.trigger.request_id: type: keyword faas.trigger.type: dashed_name: faas-trigger-type - description: "The trigger for the function execution.\nExpected values are:\n *\ - \ http\n * pubsub\n * datasource\n * timer\n * other" + description: The trigger for the function execution. example: http + expected_values: + - http + - pubsub + - datasource + - timer + - other flat_name: faas.trigger.type ignore_above: 1024 level: extended @@ -5194,12 +5205,15 @@ host.os.type: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be populated. - Please let us know by opening an issue with ECS, to propose its addition.' + If the OS you''re dealing with is not listed as an expected value, the field should + not be populated. Please let us know by opening an issue with ECS, to propose + its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: host.os.type ignore_above: 1024 level: extended @@ -5731,18 +5745,28 @@ network.community_id: type: keyword network.direction: dashed_name: network-direction - description: "Direction of the network traffic.\nRecommended values are:\n * ingress\n\ - \ * egress\n * inbound\n * outbound\n * internal\n * external\n * unknown\n\ - \nWhen mapping events from a host-based monitoring context, populate this field\ - \ from the host's point of view, using the values \"ingress\" or \"egress\".\n\ - When mapping events from a network or perimeter-based monitoring context, populate\ - \ this field from the point of view of the network perimeter, using the values\ - \ \"inbound\", \"outbound\", \"internal\" or \"external\".\nNote that \"internal\"\ - \ is not crossing perimeter boundaries, and is meant to describe communication\ - \ between two hosts within the perimeter. Note also that \"external\" is meant\ - \ to describe traffic between two hosts that are external to the perimeter. This\ - \ could for example be useful for ISPs or VPN service providers." + description: 'Direction of the network traffic. + + When mapping events from a host-based monitoring context, populate this field + from the host''s point of view, using the values "ingress" or "egress". + + When mapping events from a network or perimeter-based monitoring context, populate + this field from the point of view of the network perimeter, using the values "inbound", + "outbound", "internal" or "external". + + Note that "internal" is not crossing perimeter boundaries, and is meant to describe + communication between two hosts within the perimeter. Note also that "external" + is meant to describe traffic between two hosts that are external to the perimeter. + This could for example be useful for ISPs or VPN service providers.' example: inbound + expected_values: + - ingress + - egress + - inbound + - outbound + - internal + - external + - unknown flat_name: network.direction ignore_above: 1024 level: core @@ -6337,12 +6361,15 @@ observer.os.type: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be populated. - Please let us know by opening an issue with ECS, to propose its addition.' + If the OS you''re dealing with is not listed as an expected value, the field should + not be populated. Please let us know by opening an issue with ECS, to propose + its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: observer.os.type ignore_above: 1024 level: extended @@ -12190,11 +12217,16 @@ threat.enrichments.indicator.as.organization.name: threat.enrichments.indicator.confidence: beta: This field is beta and subject to change. dashed_name: threat-enrichments-indicator-confidence - description: "Identifies\_the\_vendor-neutral confidence\_rating\_using\_the None/Low/Medium/High\_\ - scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence\ - \ scales may be added as custom fields.\nExpected values are:\n * Not Specified\n\ - \ * None\n * Low\n * Medium\n * High" + description: Identifies the vendor-neutral confidence rating using the None/Low/Medium/High + scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence + scales may be added as custom fields. example: Medium + expected_values: + - Not Specified + - None + - Low + - Medium + - High flat_name: threat.enrichments.indicator.confidence ignore_above: 1024 level: extended @@ -13643,9 +13675,13 @@ threat.enrichments.indicator.last_seen: threat.enrichments.indicator.marking.tlp: beta: This field is beta and subject to change. dashed_name: threat-enrichments-indicator-marking-tlp - description: "Traffic Light Protocol sharing markings. Recommended values are:\n\ - \ * WHITE\n * GREEN\n * AMBER\n * RED" - example: White + description: Traffic Light Protocol sharing markings. + example: WHITE + expected_values: + - WHITE + - GREEN + - AMBER + - RED flat_name: threat.enrichments.indicator.marking.tlp ignore_above: 1024 level: extended @@ -13821,12 +13857,26 @@ threat.enrichments.indicator.sightings: threat.enrichments.indicator.type: beta: This field is beta and subject to change. dashed_name: threat-enrichments-indicator-type - description: "Type of indicator as represented by Cyber Observable in STIX 2.0.\ - \ Recommended values:\n * autonomous-system\n * artifact\n * directory\n *\ - \ domain-name\n * email-addr\n * file\n * ipv4-addr\n * ipv6-addr\n * mac-addr\n\ - \ * mutex\n * port\n * process\n * software\n * url\n * user-account\n \ - \ * windows-registry-key\n * x509-certificate" + description: Type of indicator as represented by Cyber Observable in STIX 2.0. example: ipv4-addr + expected_values: + - autonomous-system + - artifact + - directory + - domain-name + - email-addr + - file + - ipv4-addr + - ipv6-addr + - mac-addr + - mutex + - port + - process + - software + - url + - user-account + - windows-registry-key + - x509-certificate flat_name: threat.enrichments.indicator.type ignore_above: 1024 level: extended @@ -14573,11 +14623,16 @@ threat.indicator.as.organization.name: type: keyword threat.indicator.confidence: dashed_name: threat-indicator-confidence - description: "Identifies\_the\_vendor-neutral confidence\_rating\_using\_the None/Low/Medium/High\_\ - scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence\ - \ scales may be added as custom fields.\nExpected values are:\n * Not Specified\n\ - \ * None\n * Low\n * Medium\n * High" + description: Identifies the vendor-neutral confidence rating using the None/Low/Medium/High + scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence + scales may be added as custom fields. example: Medium + expected_values: + - Not Specified + - None + - Low + - Medium + - High flat_name: threat.indicator.confidence ignore_above: 1024 level: extended @@ -16020,9 +16075,13 @@ threat.indicator.last_seen: type: date threat.indicator.marking.tlp: dashed_name: threat-indicator-marking-tlp - description: "Traffic Light Protocol sharing markings.\nRecommended values are:\n\ - \ * WHITE\n * GREEN\n * AMBER\n * RED" + description: Traffic Light Protocol sharing markings. example: WHITE + expected_values: + - WHITE + - GREEN + - AMBER + - RED flat_name: threat.indicator.marking.tlp ignore_above: 1024 level: extended @@ -16191,12 +16250,26 @@ threat.indicator.sightings: type: long threat.indicator.type: dashed_name: threat-indicator-type - description: "Type of indicator as represented by Cyber Observable in STIX 2.0.\n\ - Recommended values:\n * autonomous-system\n * artifact\n * directory\n * domain-name\n\ - \ * email-addr\n * file\n * ipv4-addr\n * ipv6-addr\n * mac-addr\n * mutex\n\ - \ * port\n * process\n * software\n * url\n * user-account\n * windows-registry-key\n\ - \ * x509-certificate" + description: Type of indicator as represented by Cyber Observable in STIX 2.0. example: ipv4-addr + expected_values: + - autonomous-system + - artifact + - directory + - domain-name + - email-addr + - file + - ipv4-addr + - ipv6-addr + - mac-addr + - mutex + - port + - process + - software + - url + - user-account + - windows-registry-key + - x509-certificate flat_name: threat.indicator.type ignore_above: 1024 level: extended @@ -16771,11 +16844,20 @@ threat.software.name: threat.software.platforms: dashed_name: threat-software-platforms description: "The platforms of the software used by this threat to conduct behavior\ - \ commonly modeled using MITRE ATT&CK\xAE.\nRecommended Values:\n * AWS\n *\ - \ Azure\n * Azure AD\n * GCP\n * Linux\n * macOS\n * Network\n * Office\ - \ 365\n * SaaS\n * Windows\n\nWhile not required, you can use a MITRE ATT&CK\xAE\ - \ software platforms." + \ commonly modeled using MITRE ATT&CK\xAE.\nWhile not required, you can use MITRE\ + \ ATT&CK\xAE software platform values." example: '[ "Windows" ]' + expected_values: + - AWS + - Azure + - Azure AD + - GCP + - Linux + - macOS + - Network + - Office 365 + - SaaS + - Windows flat_name: threat.software.platforms ignore_above: 1024 level: extended @@ -16800,9 +16882,12 @@ threat.software.reference: threat.software.type: dashed_name: threat-software-type description: "The type of software used by this threat to conduct behavior commonly\ - \ modeled using MITRE ATT&CK\xAE.\nRecommended values\n * Malware\n * Tool\n\ - \n While not required, you can use a MITRE ATT&CK\xAE software type." + \ modeled using MITRE ATT&CK\xAE.\nWhile not required, you can use a MITRE ATT&CK\xAE\ + \ software type." example: Tool + expected_values: + - Malware + - Tool flat_name: threat.software.type ignore_above: 1024 level: extended @@ -18766,12 +18851,15 @@ user_agent.os.type: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be populated. - Please let us know by opening an issue with ECS, to propose its addition.' + If the OS you''re dealing with is not listed as an expected value, the field should + not be populated. Please let us know by opening an issue with ECS, to propose + its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: user_agent.os.type ignore_above: 1024 level: extended diff --git a/experimental/generated/ecs/ecs_nested.yml b/experimental/generated/ecs/ecs_nested.yml index dd4d7e5305..5225eacfe2 100644 --- a/experimental/generated/ecs/ecs_nested.yml +++ b/experimental/generated/ecs/ecs_nested.yml @@ -2598,10 +2598,16 @@ dns: type: keyword dns.header_flags: dashed_name: dns-header-flags - description: 'Array of 2 letter DNS header flags. - - Expected values are: AA, TC, RD, RA, AD, CD, DO.' + description: Array of 2 letter DNS header flags. example: '["RD", "RA"]' + expected_values: + - AA + - TC + - RD + - RA + - AD + - CD + - DO flat_name: dns.header_flags ignore_above: 1024 level: extended @@ -4427,9 +4433,14 @@ faas: type: keyword faas.trigger.type: dashed_name: faas-trigger-type - description: "The trigger for the function execution.\nExpected values are:\n\ - \ * http\n * pubsub\n * datasource\n * timer\n * other" + description: The trigger for the function execution. example: http + expected_values: + - http + - pubsub + - datasource + - timer + - other flat_name: faas.trigger.type ignore_above: 1024 level: extended @@ -6466,13 +6477,15 @@ host: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: host.os.type ignore_above: 1024 level: extended @@ -7085,19 +7098,29 @@ network: type: keyword network.direction: dashed_name: network-direction - description: "Direction of the network traffic.\nRecommended values are:\n \ - \ * ingress\n * egress\n * inbound\n * outbound\n * internal\n * external\n\ - \ * unknown\n\nWhen mapping events from a host-based monitoring context,\ - \ populate this field from the host's point of view, using the values \"ingress\"\ - \ or \"egress\".\nWhen mapping events from a network or perimeter-based monitoring\ - \ context, populate this field from the point of view of the network perimeter,\ - \ using the values \"inbound\", \"outbound\", \"internal\" or \"external\"\ - .\nNote that \"internal\" is not crossing perimeter boundaries, and is meant\ - \ to describe communication between two hosts within the perimeter. Note also\ - \ that \"external\" is meant to describe traffic between two hosts that are\ - \ external to the perimeter. This could for example be useful for ISPs or\ - \ VPN service providers." + description: 'Direction of the network traffic. + + When mapping events from a host-based monitoring context, populate this field + from the host''s point of view, using the values "ingress" or "egress". + + When mapping events from a network or perimeter-based monitoring context, + populate this field from the point of view of the network perimeter, using + the values "inbound", "outbound", "internal" or "external". + + Note that "internal" is not crossing perimeter boundaries, and is meant to + describe communication between two hosts within the perimeter. Note also that + "external" is meant to describe traffic between two hosts that are external + to the perimeter. This could for example be useful for ISPs or VPN service + providers.' example: inbound + expected_values: + - ingress + - egress + - inbound + - outbound + - internal + - external + - unknown flat_name: network.direction ignore_above: 1024 level: core @@ -7727,13 +7750,15 @@ observer: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: observer.os.type ignore_above: 1024 level: extended @@ -8103,13 +8128,15 @@ os: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: os.type ignore_above: 1024 level: extended @@ -14260,11 +14287,16 @@ threat: threat.enrichments.indicator.confidence: beta: This field is beta and subject to change. dashed_name: threat-enrichments-indicator-confidence - description: "Identifies\_the\_vendor-neutral confidence\_rating\_using\_the\ - \ None/Low/Medium/High\_scale defined in Appendix A of the STIX 2.1 framework.\ - \ Vendor-specific confidence scales may be added as custom fields.\nExpected\ - \ values are:\n * Not Specified\n * None\n * Low\n * Medium\n * High" + description: Identifies the vendor-neutral confidence rating using the None/Low/Medium/High + scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence + scales may be added as custom fields. example: Medium + expected_values: + - Not Specified + - None + - Low + - Medium + - High flat_name: threat.enrichments.indicator.confidence ignore_above: 1024 level: extended @@ -15714,9 +15746,13 @@ threat: threat.enrichments.indicator.marking.tlp: beta: This field is beta and subject to change. dashed_name: threat-enrichments-indicator-marking-tlp - description: "Traffic Light Protocol sharing markings. Recommended values are:\n\ - \ * WHITE\n * GREEN\n * AMBER\n * RED" - example: White + description: Traffic Light Protocol sharing markings. + example: WHITE + expected_values: + - WHITE + - GREEN + - AMBER + - RED flat_name: threat.enrichments.indicator.marking.tlp ignore_above: 1024 level: extended @@ -15893,12 +15929,26 @@ threat: threat.enrichments.indicator.type: beta: This field is beta and subject to change. dashed_name: threat-enrichments-indicator-type - description: "Type of indicator as represented by Cyber Observable in STIX 2.0.\ - \ Recommended values:\n * autonomous-system\n * artifact\n * directory\n\ - \ * domain-name\n * email-addr\n * file\n * ipv4-addr\n * ipv6-addr\n\ - \ * mac-addr\n * mutex\n * port\n * process\n * software\n * url\n \ - \ * user-account\n * windows-registry-key\n * x509-certificate" + description: Type of indicator as represented by Cyber Observable in STIX 2.0. example: ipv4-addr + expected_values: + - autonomous-system + - artifact + - directory + - domain-name + - email-addr + - file + - ipv4-addr + - ipv6-addr + - mac-addr + - mutex + - port + - process + - software + - url + - user-account + - windows-registry-key + - x509-certificate flat_name: threat.enrichments.indicator.type ignore_above: 1024 level: extended @@ -16647,11 +16697,16 @@ threat: type: keyword threat.indicator.confidence: dashed_name: threat-indicator-confidence - description: "Identifies\_the\_vendor-neutral confidence\_rating\_using\_the\ - \ None/Low/Medium/High\_scale defined in Appendix A of the STIX 2.1 framework.\ - \ Vendor-specific confidence scales may be added as custom fields.\nExpected\ - \ values are:\n * Not Specified\n * None\n * Low\n * Medium\n * High" + description: Identifies the vendor-neutral confidence rating using the None/Low/Medium/High + scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence + scales may be added as custom fields. example: Medium + expected_values: + - Not Specified + - None + - Low + - Medium + - High flat_name: threat.indicator.confidence ignore_above: 1024 level: extended @@ -18095,9 +18150,13 @@ threat: type: date threat.indicator.marking.tlp: dashed_name: threat-indicator-marking-tlp - description: "Traffic Light Protocol sharing markings.\nRecommended values are:\n\ - \ * WHITE\n * GREEN\n * AMBER\n * RED" + description: Traffic Light Protocol sharing markings. example: WHITE + expected_values: + - WHITE + - GREEN + - AMBER + - RED flat_name: threat.indicator.marking.tlp ignore_above: 1024 level: extended @@ -18267,12 +18326,26 @@ threat: type: long threat.indicator.type: dashed_name: threat-indicator-type - description: "Type of indicator as represented by Cyber Observable in STIX 2.0.\n\ - Recommended values:\n * autonomous-system\n * artifact\n * directory\n\ - \ * domain-name\n * email-addr\n * file\n * ipv4-addr\n * ipv6-addr\n\ - \ * mac-addr\n * mutex\n * port\n * process\n * software\n * url\n \ - \ * user-account\n * windows-registry-key\n * x509-certificate" + description: Type of indicator as represented by Cyber Observable in STIX 2.0. example: ipv4-addr + expected_values: + - autonomous-system + - artifact + - directory + - domain-name + - email-addr + - file + - ipv4-addr + - ipv6-addr + - mac-addr + - mutex + - port + - process + - software + - url + - user-account + - windows-registry-key + - x509-certificate flat_name: threat.indicator.type ignore_above: 1024 level: extended @@ -18849,11 +18922,20 @@ threat: threat.software.platforms: dashed_name: threat-software-platforms description: "The platforms of the software used by this threat to conduct behavior\ - \ commonly modeled using MITRE ATT&CK\xAE.\nRecommended Values:\n * AWS\n\ - \ * Azure\n * Azure AD\n * GCP\n * Linux\n * macOS\n * Network\n *\ - \ Office 365\n * SaaS\n * Windows\n\nWhile not required, you can use a MITRE\ - \ ATT&CK\xAE software platforms." + \ commonly modeled using MITRE ATT&CK\xAE.\nWhile not required, you can use\ + \ MITRE ATT&CK\xAE software platform values." example: '[ "Windows" ]' + expected_values: + - AWS + - Azure + - Azure AD + - GCP + - Linux + - macOS + - Network + - Office 365 + - SaaS + - Windows flat_name: threat.software.platforms ignore_above: 1024 level: extended @@ -18878,9 +18960,12 @@ threat: threat.software.type: dashed_name: threat-software-type description: "The type of software used by this threat to conduct behavior commonly\ - \ modeled using MITRE ATT&CK\xAE.\nRecommended values\n * Malware\n * Tool\n\ - \n While not required, you can use a MITRE ATT&CK\xAE software type." + \ modeled using MITRE ATT&CK\xAE.\nWhile not required, you can use a MITRE\ + \ ATT&CK\xAE software type." example: Tool + expected_values: + - Malware + - Tool flat_name: threat.software.type ignore_above: 1024 level: extended @@ -21064,13 +21149,15 @@ user_agent: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: user_agent.os.type ignore_above: 1024 level: extended diff --git a/generated/beats/fields.ecs.yml b/generated/beats/fields.ecs.yml index 06789dd668..3b0b29e29b 100644 --- a/generated/beats/fields.ecs.yml +++ b/generated/beats/fields.ecs.yml @@ -1519,9 +1519,7 @@ level: extended type: keyword ignore_above: 1024 - description: 'Array of 2 letter DNS header flags. - - Expected values are: AA, TC, RD, RA, AD, CD, DO.' + description: Array of 2 letter DNS header flags. example: '["RD", "RA"]' - name: id level: extended @@ -2446,8 +2444,7 @@ level: extended type: keyword ignore_above: 1024 - description: "The trigger for the function execution.\nExpected values are:\n\ - \ * http\n * pubsub\n * datasource\n * timer\n * other" + description: The trigger for the function execution. example: http default_field: false - name: version @@ -3586,12 +3583,9 @@ description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos default_field: false - name: os.version @@ -3980,18 +3974,20 @@ level: core type: keyword ignore_above: 1024 - description: "Direction of the network traffic.\nRecommended values are:\n \ - \ * ingress\n * egress\n * inbound\n * outbound\n * internal\n * external\n\ - \ * unknown\n\nWhen mapping events from a host-based monitoring context,\ - \ populate this field from the host's point of view, using the values \"ingress\"\ - \ or \"egress\".\nWhen mapping events from a network or perimeter-based monitoring\ - \ context, populate this field from the point of view of the network perimeter,\ - \ using the values \"inbound\", \"outbound\", \"internal\" or \"external\"\ - .\nNote that \"internal\" is not crossing perimeter boundaries, and is meant\ - \ to describe communication between two hosts within the perimeter. Note also\ - \ that \"external\" is meant to describe traffic between two hosts that are\ - \ external to the perimeter. This could for example be useful for ISPs or\ - \ VPN service providers." + description: 'Direction of the network traffic. + + When mapping events from a host-based monitoring context, populate this field + from the host''s point of view, using the values "ingress" or "egress". + + When mapping events from a network or perimeter-based monitoring context, + populate this field from the point of view of the network perimeter, using + the values "inbound", "outbound", "internal" or "external". + + Note that "internal" is not crossing perimeter boundaries, and is meant to + describe communication between two hosts within the perimeter. Note also that + "external" is meant to describe traffic between two hosts that are external + to the perimeter. This could for example be useful for ISPs or VPN service + providers.' example: inbound - name: forwarded_ip level: core @@ -4364,12 +4360,9 @@ description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos default_field: false - name: os.version @@ -4584,12 +4577,9 @@ description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos default_field: false - name: version @@ -8217,10 +8207,9 @@ level: extended type: keyword ignore_above: 1024 - description: "Identifies\_the\_vendor-neutral confidence\_rating\_using\_the\ - \ None/Low/Medium/High\_scale defined in Appendix A of the STIX 2.1 framework.\ - \ Vendor-specific confidence scales may be added as custom fields.\nExpected\ - \ values are:\n * Not Specified\n * None\n * Low\n * Medium\n * High" + description: Identifies the vendor-neutral confidence rating using the None/Low/Medium/High + scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence + scales may be added as custom fields. example: Medium default_field: false - name: enrichments.indicator.description @@ -9068,9 +9057,8 @@ level: extended type: keyword ignore_above: 1024 - description: "Traffic Light Protocol sharing markings. Recommended values are:\n\ - \ * WHITE\n * GREEN\n * AMBER\n * RED" - example: White + description: Traffic Light Protocol sharing markings. + example: WHITE default_field: false - name: enrichments.indicator.modified_at level: extended @@ -9176,11 +9164,7 @@ level: extended type: keyword ignore_above: 1024 - description: "Type of indicator as represented by Cyber Observable in STIX 2.0.\ - \ Recommended values:\n * autonomous-system\n * artifact\n * directory\n\ - \ * domain-name\n * email-addr\n * file\n * ipv4-addr\n * ipv6-addr\n\ - \ * mac-addr\n * mutex\n * port\n * process\n * software\n * url\n \ - \ * user-account\n * windows-registry-key\n * x509-certificate" + description: Type of indicator as represented by Cyber Observable in STIX 2.0. example: ipv4-addr default_field: false - name: enrichments.indicator.url.domain @@ -9642,10 +9626,9 @@ level: extended type: keyword ignore_above: 1024 - description: "Identifies\_the\_vendor-neutral confidence\_rating\_using\_the\ - \ None/Low/Medium/High\_scale defined in Appendix A of the STIX 2.1 framework.\ - \ Vendor-specific confidence scales may be added as custom fields.\nExpected\ - \ values are:\n * Not Specified\n * None\n * Low\n * Medium\n * High" + description: Identifies the vendor-neutral confidence rating using the None/Low/Medium/High + scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence + scales may be added as custom fields. example: Medium default_field: false - name: indicator.description @@ -10493,8 +10476,7 @@ level: extended type: keyword ignore_above: 1024 - description: "Traffic Light Protocol sharing markings.\nRecommended values are:\n\ - \ * WHITE\n * GREEN\n * AMBER\n * RED" + description: Traffic Light Protocol sharing markings. example: WHITE default_field: false - name: indicator.modified_at @@ -10601,11 +10583,7 @@ level: extended type: keyword ignore_above: 1024 - description: "Type of indicator as represented by Cyber Observable in STIX 2.0.\n\ - Recommended values:\n * autonomous-system\n * artifact\n * directory\n\ - \ * domain-name\n * email-addr\n * file\n * ipv4-addr\n * ipv6-addr\n\ - \ * mac-addr\n * mutex\n * port\n * process\n * software\n * url\n \ - \ * user-account\n * windows-registry-key\n * x509-certificate" + description: Type of indicator as represented by Cyber Observable in STIX 2.0. example: ipv4-addr default_field: false - name: indicator.url.domain @@ -10960,10 +10938,8 @@ type: keyword ignore_above: 1024 description: "The platforms of the software used by this threat to conduct behavior\ - \ commonly modeled using MITRE ATT&CK\xAE.\nRecommended Values:\n * AWS\n\ - \ * Azure\n * Azure AD\n * GCP\n * Linux\n * macOS\n * Network\n *\ - \ Office 365\n * SaaS\n * Windows\n\nWhile not required, you can use a MITRE\ - \ ATT&CK\xAE software platforms." + \ commonly modeled using MITRE ATT&CK\xAE.\nWhile not required, you can use\ + \ MITRE ATT&CK\xAE software platform values." example: '[ "Windows" ]' default_field: false - name: software.reference @@ -10980,8 +10956,8 @@ type: keyword ignore_above: 1024 description: "The type of software used by this threat to conduct behavior commonly\ - \ modeled using MITRE ATT&CK\xAE.\nRecommended values\n * Malware\n * Tool\n\ - \n While not required, you can use a MITRE ATT&CK\xAE software type." + \ modeled using MITRE ATT&CK\xAE.\nWhile not required, you can use a MITRE\ + \ ATT&CK\xAE software type." example: Tool default_field: false - name: tactic.id @@ -12208,12 +12184,9 @@ description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos default_field: false - name: os.version diff --git a/generated/csv/fields.csv b/generated/csv/fields.csv index ed24ea22df..0a97f3799e 100644 --- a/generated/csv/fields.csv +++ b/generated/csv/fields.csv @@ -1075,7 +1075,7 @@ ECS_Version,Indexed,Field_Set,Field,Type,Level,Normalization,Example,Description 8.5.0-dev,true,threat,threat.enrichments.indicator.geo.timezone,keyword,core,,America/Argentina/Buenos_Aires,Time zone. 8.5.0-dev,true,threat,threat.enrichments.indicator.ip,ip,extended,,1.2.3.4,Indicator IP address 8.5.0-dev,true,threat,threat.enrichments.indicator.last_seen,date,extended,,2020-11-05T17:25:47.000Z,Date/time indicator was last reported. -8.5.0-dev,true,threat,threat.enrichments.indicator.marking.tlp,keyword,extended,,White,Indicator TLP marking +8.5.0-dev,true,threat,threat.enrichments.indicator.marking.tlp,keyword,extended,,WHITE,Indicator TLP marking 8.5.0-dev,true,threat,threat.enrichments.indicator.modified_at,date,extended,,2020-11-05T17:25:47.000Z,Date/time indicator was last updated. 8.5.0-dev,true,threat,threat.enrichments.indicator.port,long,extended,,443,Indicator port 8.5.0-dev,true,threat,threat.enrichments.indicator.provider,keyword,extended,,lrz_urlhaus,Indicator provider diff --git a/generated/ecs/ecs_flat.yml b/generated/ecs/ecs_flat.yml index f399d2aa14..2f3068b46b 100644 --- a/generated/ecs/ecs_flat.yml +++ b/generated/ecs/ecs_flat.yml @@ -2043,10 +2043,16 @@ dns.answers.type: type: keyword dns.header_flags: dashed_name: dns-header-flags - description: 'Array of 2 letter DNS header flags. - - Expected values are: AA, TC, RD, RA, AD, CD, DO.' + description: Array of 2 letter DNS header flags. example: '["RD", "RA"]' + expected_values: + - AA + - TC + - RD + - RA + - AD + - CD + - DO flat_name: dns.header_flags ignore_above: 1024 level: extended @@ -3461,9 +3467,14 @@ faas.trigger.request_id: type: keyword faas.trigger.type: dashed_name: faas-trigger-type - description: "The trigger for the function execution.\nExpected values are:\n *\ - \ http\n * pubsub\n * datasource\n * timer\n * other" + description: The trigger for the function execution. example: http + expected_values: + - http + - pubsub + - datasource + - timer + - other flat_name: faas.trigger.type ignore_above: 1024 level: extended @@ -5125,12 +5136,15 @@ host.os.type: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be populated. - Please let us know by opening an issue with ECS, to propose its addition.' + If the OS you''re dealing with is not listed as an expected value, the field should + not be populated. Please let us know by opening an issue with ECS, to propose + its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: host.os.type ignore_above: 1024 level: extended @@ -5662,18 +5676,28 @@ network.community_id: type: keyword network.direction: dashed_name: network-direction - description: "Direction of the network traffic.\nRecommended values are:\n * ingress\n\ - \ * egress\n * inbound\n * outbound\n * internal\n * external\n * unknown\n\ - \nWhen mapping events from a host-based monitoring context, populate this field\ - \ from the host's point of view, using the values \"ingress\" or \"egress\".\n\ - When mapping events from a network or perimeter-based monitoring context, populate\ - \ this field from the point of view of the network perimeter, using the values\ - \ \"inbound\", \"outbound\", \"internal\" or \"external\".\nNote that \"internal\"\ - \ is not crossing perimeter boundaries, and is meant to describe communication\ - \ between two hosts within the perimeter. Note also that \"external\" is meant\ - \ to describe traffic between two hosts that are external to the perimeter. This\ - \ could for example be useful for ISPs or VPN service providers." + description: 'Direction of the network traffic. + + When mapping events from a host-based monitoring context, populate this field + from the host''s point of view, using the values "ingress" or "egress". + + When mapping events from a network or perimeter-based monitoring context, populate + this field from the point of view of the network perimeter, using the values "inbound", + "outbound", "internal" or "external". + + Note that "internal" is not crossing perimeter boundaries, and is meant to describe + communication between two hosts within the perimeter. Note also that "external" + is meant to describe traffic between two hosts that are external to the perimeter. + This could for example be useful for ISPs or VPN service providers.' example: inbound + expected_values: + - ingress + - egress + - inbound + - outbound + - internal + - external + - unknown flat_name: network.direction ignore_above: 1024 level: core @@ -6268,12 +6292,15 @@ observer.os.type: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be populated. - Please let us know by opening an issue with ECS, to propose its addition.' + If the OS you''re dealing with is not listed as an expected value, the field should + not be populated. Please let us know by opening an issue with ECS, to propose + its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: observer.os.type ignore_above: 1024 level: extended @@ -12121,11 +12148,16 @@ threat.enrichments.indicator.as.organization.name: threat.enrichments.indicator.confidence: beta: This field is beta and subject to change. dashed_name: threat-enrichments-indicator-confidence - description: "Identifies\_the\_vendor-neutral confidence\_rating\_using\_the None/Low/Medium/High\_\ - scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence\ - \ scales may be added as custom fields.\nExpected values are:\n * Not Specified\n\ - \ * None\n * Low\n * Medium\n * High" + description: Identifies the vendor-neutral confidence rating using the None/Low/Medium/High + scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence + scales may be added as custom fields. example: Medium + expected_values: + - Not Specified + - None + - Low + - Medium + - High flat_name: threat.enrichments.indicator.confidence ignore_above: 1024 level: extended @@ -13574,9 +13606,13 @@ threat.enrichments.indicator.last_seen: threat.enrichments.indicator.marking.tlp: beta: This field is beta and subject to change. dashed_name: threat-enrichments-indicator-marking-tlp - description: "Traffic Light Protocol sharing markings. Recommended values are:\n\ - \ * WHITE\n * GREEN\n * AMBER\n * RED" - example: White + description: Traffic Light Protocol sharing markings. + example: WHITE + expected_values: + - WHITE + - GREEN + - AMBER + - RED flat_name: threat.enrichments.indicator.marking.tlp ignore_above: 1024 level: extended @@ -13752,12 +13788,26 @@ threat.enrichments.indicator.sightings: threat.enrichments.indicator.type: beta: This field is beta and subject to change. dashed_name: threat-enrichments-indicator-type - description: "Type of indicator as represented by Cyber Observable in STIX 2.0.\ - \ Recommended values:\n * autonomous-system\n * artifact\n * directory\n *\ - \ domain-name\n * email-addr\n * file\n * ipv4-addr\n * ipv6-addr\n * mac-addr\n\ - \ * mutex\n * port\n * process\n * software\n * url\n * user-account\n \ - \ * windows-registry-key\n * x509-certificate" + description: Type of indicator as represented by Cyber Observable in STIX 2.0. example: ipv4-addr + expected_values: + - autonomous-system + - artifact + - directory + - domain-name + - email-addr + - file + - ipv4-addr + - ipv6-addr + - mac-addr + - mutex + - port + - process + - software + - url + - user-account + - windows-registry-key + - x509-certificate flat_name: threat.enrichments.indicator.type ignore_above: 1024 level: extended @@ -14504,11 +14554,16 @@ threat.indicator.as.organization.name: type: keyword threat.indicator.confidence: dashed_name: threat-indicator-confidence - description: "Identifies\_the\_vendor-neutral confidence\_rating\_using\_the None/Low/Medium/High\_\ - scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence\ - \ scales may be added as custom fields.\nExpected values are:\n * Not Specified\n\ - \ * None\n * Low\n * Medium\n * High" + description: Identifies the vendor-neutral confidence rating using the None/Low/Medium/High + scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence + scales may be added as custom fields. example: Medium + expected_values: + - Not Specified + - None + - Low + - Medium + - High flat_name: threat.indicator.confidence ignore_above: 1024 level: extended @@ -15951,9 +16006,13 @@ threat.indicator.last_seen: type: date threat.indicator.marking.tlp: dashed_name: threat-indicator-marking-tlp - description: "Traffic Light Protocol sharing markings.\nRecommended values are:\n\ - \ * WHITE\n * GREEN\n * AMBER\n * RED" + description: Traffic Light Protocol sharing markings. example: WHITE + expected_values: + - WHITE + - GREEN + - AMBER + - RED flat_name: threat.indicator.marking.tlp ignore_above: 1024 level: extended @@ -16122,12 +16181,26 @@ threat.indicator.sightings: type: long threat.indicator.type: dashed_name: threat-indicator-type - description: "Type of indicator as represented by Cyber Observable in STIX 2.0.\n\ - Recommended values:\n * autonomous-system\n * artifact\n * directory\n * domain-name\n\ - \ * email-addr\n * file\n * ipv4-addr\n * ipv6-addr\n * mac-addr\n * mutex\n\ - \ * port\n * process\n * software\n * url\n * user-account\n * windows-registry-key\n\ - \ * x509-certificate" + description: Type of indicator as represented by Cyber Observable in STIX 2.0. example: ipv4-addr + expected_values: + - autonomous-system + - artifact + - directory + - domain-name + - email-addr + - file + - ipv4-addr + - ipv6-addr + - mac-addr + - mutex + - port + - process + - software + - url + - user-account + - windows-registry-key + - x509-certificate flat_name: threat.indicator.type ignore_above: 1024 level: extended @@ -16702,11 +16775,20 @@ threat.software.name: threat.software.platforms: dashed_name: threat-software-platforms description: "The platforms of the software used by this threat to conduct behavior\ - \ commonly modeled using MITRE ATT&CK\xAE.\nRecommended Values:\n * AWS\n *\ - \ Azure\n * Azure AD\n * GCP\n * Linux\n * macOS\n * Network\n * Office\ - \ 365\n * SaaS\n * Windows\n\nWhile not required, you can use a MITRE ATT&CK\xAE\ - \ software platforms." + \ commonly modeled using MITRE ATT&CK\xAE.\nWhile not required, you can use MITRE\ + \ ATT&CK\xAE software platform values." example: '[ "Windows" ]' + expected_values: + - AWS + - Azure + - Azure AD + - GCP + - Linux + - macOS + - Network + - Office 365 + - SaaS + - Windows flat_name: threat.software.platforms ignore_above: 1024 level: extended @@ -16731,9 +16813,12 @@ threat.software.reference: threat.software.type: dashed_name: threat-software-type description: "The type of software used by this threat to conduct behavior commonly\ - \ modeled using MITRE ATT&CK\xAE.\nRecommended values\n * Malware\n * Tool\n\ - \n While not required, you can use a MITRE ATT&CK\xAE software type." + \ modeled using MITRE ATT&CK\xAE.\nWhile not required, you can use a MITRE ATT&CK\xAE\ + \ software type." example: Tool + expected_values: + - Malware + - Tool flat_name: threat.software.type ignore_above: 1024 level: extended @@ -18697,12 +18782,15 @@ user_agent.os.type: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be populated. - Please let us know by opening an issue with ECS, to propose its addition.' + If the OS you''re dealing with is not listed as an expected value, the field should + not be populated. Please let us know by opening an issue with ECS, to propose + its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: user_agent.os.type ignore_above: 1024 level: extended diff --git a/generated/ecs/ecs_nested.yml b/generated/ecs/ecs_nested.yml index 93dbffdd15..680bee23a2 100644 --- a/generated/ecs/ecs_nested.yml +++ b/generated/ecs/ecs_nested.yml @@ -2518,10 +2518,16 @@ dns: type: keyword dns.header_flags: dashed_name: dns-header-flags - description: 'Array of 2 letter DNS header flags. - - Expected values are: AA, TC, RD, RA, AD, CD, DO.' + description: Array of 2 letter DNS header flags. example: '["RD", "RA"]' + expected_values: + - AA + - TC + - RD + - RA + - AD + - CD + - DO flat_name: dns.header_flags ignore_above: 1024 level: extended @@ -4347,9 +4353,14 @@ faas: type: keyword faas.trigger.type: dashed_name: faas-trigger-type - description: "The trigger for the function execution.\nExpected values are:\n\ - \ * http\n * pubsub\n * datasource\n * timer\n * other" + description: The trigger for the function execution. example: http + expected_values: + - http + - pubsub + - datasource + - timer + - other flat_name: faas.trigger.type ignore_above: 1024 level: extended @@ -6386,13 +6397,15 @@ host: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: host.os.type ignore_above: 1024 level: extended @@ -7005,19 +7018,29 @@ network: type: keyword network.direction: dashed_name: network-direction - description: "Direction of the network traffic.\nRecommended values are:\n \ - \ * ingress\n * egress\n * inbound\n * outbound\n * internal\n * external\n\ - \ * unknown\n\nWhen mapping events from a host-based monitoring context,\ - \ populate this field from the host's point of view, using the values \"ingress\"\ - \ or \"egress\".\nWhen mapping events from a network or perimeter-based monitoring\ - \ context, populate this field from the point of view of the network perimeter,\ - \ using the values \"inbound\", \"outbound\", \"internal\" or \"external\"\ - .\nNote that \"internal\" is not crossing perimeter boundaries, and is meant\ - \ to describe communication between two hosts within the perimeter. Note also\ - \ that \"external\" is meant to describe traffic between two hosts that are\ - \ external to the perimeter. This could for example be useful for ISPs or\ - \ VPN service providers." + description: 'Direction of the network traffic. + + When mapping events from a host-based monitoring context, populate this field + from the host''s point of view, using the values "ingress" or "egress". + + When mapping events from a network or perimeter-based monitoring context, + populate this field from the point of view of the network perimeter, using + the values "inbound", "outbound", "internal" or "external". + + Note that "internal" is not crossing perimeter boundaries, and is meant to + describe communication between two hosts within the perimeter. Note also that + "external" is meant to describe traffic between two hosts that are external + to the perimeter. This could for example be useful for ISPs or VPN service + providers.' example: inbound + expected_values: + - ingress + - egress + - inbound + - outbound + - internal + - external + - unknown flat_name: network.direction ignore_above: 1024 level: core @@ -7647,13 +7670,15 @@ observer: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: observer.os.type ignore_above: 1024 level: extended @@ -8023,13 +8048,15 @@ os: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: os.type ignore_above: 1024 level: extended @@ -14180,11 +14207,16 @@ threat: threat.enrichments.indicator.confidence: beta: This field is beta and subject to change. dashed_name: threat-enrichments-indicator-confidence - description: "Identifies\_the\_vendor-neutral confidence\_rating\_using\_the\ - \ None/Low/Medium/High\_scale defined in Appendix A of the STIX 2.1 framework.\ - \ Vendor-specific confidence scales may be added as custom fields.\nExpected\ - \ values are:\n * Not Specified\n * None\n * Low\n * Medium\n * High" + description: Identifies the vendor-neutral confidence rating using the None/Low/Medium/High + scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence + scales may be added as custom fields. example: Medium + expected_values: + - Not Specified + - None + - Low + - Medium + - High flat_name: threat.enrichments.indicator.confidence ignore_above: 1024 level: extended @@ -15634,9 +15666,13 @@ threat: threat.enrichments.indicator.marking.tlp: beta: This field is beta and subject to change. dashed_name: threat-enrichments-indicator-marking-tlp - description: "Traffic Light Protocol sharing markings. Recommended values are:\n\ - \ * WHITE\n * GREEN\n * AMBER\n * RED" - example: White + description: Traffic Light Protocol sharing markings. + example: WHITE + expected_values: + - WHITE + - GREEN + - AMBER + - RED flat_name: threat.enrichments.indicator.marking.tlp ignore_above: 1024 level: extended @@ -15813,12 +15849,26 @@ threat: threat.enrichments.indicator.type: beta: This field is beta and subject to change. dashed_name: threat-enrichments-indicator-type - description: "Type of indicator as represented by Cyber Observable in STIX 2.0.\ - \ Recommended values:\n * autonomous-system\n * artifact\n * directory\n\ - \ * domain-name\n * email-addr\n * file\n * ipv4-addr\n * ipv6-addr\n\ - \ * mac-addr\n * mutex\n * port\n * process\n * software\n * url\n \ - \ * user-account\n * windows-registry-key\n * x509-certificate" + description: Type of indicator as represented by Cyber Observable in STIX 2.0. example: ipv4-addr + expected_values: + - autonomous-system + - artifact + - directory + - domain-name + - email-addr + - file + - ipv4-addr + - ipv6-addr + - mac-addr + - mutex + - port + - process + - software + - url + - user-account + - windows-registry-key + - x509-certificate flat_name: threat.enrichments.indicator.type ignore_above: 1024 level: extended @@ -16567,11 +16617,16 @@ threat: type: keyword threat.indicator.confidence: dashed_name: threat-indicator-confidence - description: "Identifies\_the\_vendor-neutral confidence\_rating\_using\_the\ - \ None/Low/Medium/High\_scale defined in Appendix A of the STIX 2.1 framework.\ - \ Vendor-specific confidence scales may be added as custom fields.\nExpected\ - \ values are:\n * Not Specified\n * None\n * Low\n * Medium\n * High" + description: Identifies the vendor-neutral confidence rating using the None/Low/Medium/High + scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence + scales may be added as custom fields. example: Medium + expected_values: + - Not Specified + - None + - Low + - Medium + - High flat_name: threat.indicator.confidence ignore_above: 1024 level: extended @@ -18015,9 +18070,13 @@ threat: type: date threat.indicator.marking.tlp: dashed_name: threat-indicator-marking-tlp - description: "Traffic Light Protocol sharing markings.\nRecommended values are:\n\ - \ * WHITE\n * GREEN\n * AMBER\n * RED" + description: Traffic Light Protocol sharing markings. example: WHITE + expected_values: + - WHITE + - GREEN + - AMBER + - RED flat_name: threat.indicator.marking.tlp ignore_above: 1024 level: extended @@ -18187,12 +18246,26 @@ threat: type: long threat.indicator.type: dashed_name: threat-indicator-type - description: "Type of indicator as represented by Cyber Observable in STIX 2.0.\n\ - Recommended values:\n * autonomous-system\n * artifact\n * directory\n\ - \ * domain-name\n * email-addr\n * file\n * ipv4-addr\n * ipv6-addr\n\ - \ * mac-addr\n * mutex\n * port\n * process\n * software\n * url\n \ - \ * user-account\n * windows-registry-key\n * x509-certificate" + description: Type of indicator as represented by Cyber Observable in STIX 2.0. example: ipv4-addr + expected_values: + - autonomous-system + - artifact + - directory + - domain-name + - email-addr + - file + - ipv4-addr + - ipv6-addr + - mac-addr + - mutex + - port + - process + - software + - url + - user-account + - windows-registry-key + - x509-certificate flat_name: threat.indicator.type ignore_above: 1024 level: extended @@ -18769,11 +18842,20 @@ threat: threat.software.platforms: dashed_name: threat-software-platforms description: "The platforms of the software used by this threat to conduct behavior\ - \ commonly modeled using MITRE ATT&CK\xAE.\nRecommended Values:\n * AWS\n\ - \ * Azure\n * Azure AD\n * GCP\n * Linux\n * macOS\n * Network\n *\ - \ Office 365\n * SaaS\n * Windows\n\nWhile not required, you can use a MITRE\ - \ ATT&CK\xAE software platforms." + \ commonly modeled using MITRE ATT&CK\xAE.\nWhile not required, you can use\ + \ MITRE ATT&CK\xAE software platform values." example: '[ "Windows" ]' + expected_values: + - AWS + - Azure + - Azure AD + - GCP + - Linux + - macOS + - Network + - Office 365 + - SaaS + - Windows flat_name: threat.software.platforms ignore_above: 1024 level: extended @@ -18798,9 +18880,12 @@ threat: threat.software.type: dashed_name: threat-software-type description: "The type of software used by this threat to conduct behavior commonly\ - \ modeled using MITRE ATT&CK\xAE.\nRecommended values\n * Malware\n * Tool\n\ - \n While not required, you can use a MITRE ATT&CK\xAE software type." + \ modeled using MITRE ATT&CK\xAE.\nWhile not required, you can use a MITRE\ + \ ATT&CK\xAE software type." example: Tool + expected_values: + - Malware + - Tool flat_name: threat.software.type ignore_above: 1024 level: extended @@ -20984,13 +21069,15 @@ user_agent: description: 'Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, - windows. - - If the OS you''re dealing with is not in the list, the field should not be - populated. Please let us know by opening an issue with ECS, to propose its - addition.' + If the OS you''re dealing with is not listed as an expected value, the field + should not be populated. Please let us know by opening an issue with ECS, + to propose its addition.' example: macos + expected_values: + - linux + - macos + - unix + - windows flat_name: user_agent.os.type ignore_above: 1024 level: extended diff --git a/schemas/dns.yml b/schemas/dns.yml index 29826f72cd..1dc8a3bdb9 100644 --- a/schemas/dns.yml +++ b/schemas/dns.yml @@ -68,8 +68,14 @@ short: Array of DNS header flags. description: > Array of 2 letter DNS header flags. - - Expected values are: AA, TC, RD, RA, AD, CD, DO. + expected_values: + - AA + - TC + - RD + - RA + - AD + - CD + - DO example: "[\"RD\", \"RA\"]" normalize: - array diff --git a/schemas/faas.yml b/schemas/faas.yml index 77053e7767..aeeff3de9f 100644 --- a/schemas/faas.yml +++ b/schemas/faas.yml @@ -69,13 +69,12 @@ short: The trigger for the function execution. description: > The trigger for the function execution. - - Expected values are: - * http - * pubsub - * datasource - * timer - * other + expected_values: + - http + - pubsub + - datasource + - timer + - other example: http - name: trigger.request_id level: extended diff --git a/schemas/network.yml b/schemas/network.yml index cca7f4b563..6a6f1e045f 100644 --- a/schemas/network.yml +++ b/schemas/network.yml @@ -99,15 +99,6 @@ description: > Direction of the network traffic. - Recommended values are: - * ingress - * egress - * inbound - * outbound - * internal - * external - * unknown - When mapping events from a host-based monitoring context, populate this field from the host's point of view, using the values "ingress" or "egress". @@ -120,6 +111,14 @@ that "external" is meant to describe traffic between two hosts that are external to the perimeter. This could for example be useful for ISPs or VPN service providers. + expected_values: + - ingress + - egress + - inbound + - outbound + - internal + - external + - unknown example: inbound - name: forwarded_ip diff --git a/schemas/os.yml b/schemas/os.yml index 040110bf69..3a8be5933b 100644 --- a/schemas/os.yml +++ b/schemas/os.yml @@ -38,10 +38,13 @@ Use the `os.type` field to categorize the operating system into one of the broad commercial families. - One of these following values should be used (lowercase): linux, macos, unix, windows. - - If the OS you're dealing with is not in the list, the field should not be populated. + If the OS you're dealing with is not listed as an expected value, the field should not be populated. Please let us know by opening an issue with ECS, to propose its addition. + expected_values: + - linux + - macos + - unix + - windows example: macos - name: platform diff --git a/schemas/threat.yml b/schemas/threat.yml index 6e01b1044b..6da587aae6 100644 --- a/schemas/threat.yml +++ b/schemas/threat.yml @@ -92,24 +92,24 @@ beta: This field is beta and subject to change. description: > Type of indicator as represented by Cyber Observable in STIX 2.0. - Recommended values: - * autonomous-system - * artifact - * directory - * domain-name - * email-addr - * file - * ipv4-addr - * ipv6-addr - * mac-addr - * mutex - * port - * process - * software - * url - * user-account - * windows-registry-key - * x509-certificate + expected_values: + - autonomous-system + - artifact + - directory + - domain-name + - email-addr + - file + - ipv4-addr + - ipv6-addr + - mac-addr + - mutex + - port + - process + - software + - url + - user-account + - windows-registry-key + - x509-certificate example: ipv4-addr - name: enrichments.indicator.description @@ -136,15 +136,14 @@ short: Indicator confidence rating beta: This field is beta and subject to change. description: > - Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific + Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence scales may be added as custom fields. - - Expected values are: - * Not Specified - * None - * Low - * Medium - * High + expected_values: + - Not Specified + - None + - Low + - Medium + - High example: Medium - name: enrichments.indicator.ip @@ -181,12 +180,12 @@ beta: This field is beta and subject to change. description: > Traffic Light Protocol sharing markings. - Recommended values are: - * WHITE - * GREEN - * AMBER - * RED - example: White + expected_values: + - WHITE + - GREEN + - AMBER + - RED + example: WHITE - name: enrichments.indicator.reference level: extended @@ -385,26 +384,24 @@ short: Type of indicator description: > Type of indicator as represented by Cyber Observable in STIX 2.0. - - Recommended values: - * autonomous-system - * artifact - * directory - * domain-name - * email-addr - * file - * ipv4-addr - * ipv6-addr - * mac-addr - * mutex - * port - * process - * software - * url - * user-account - * windows-registry-key - * x509-certificate - + expected_values: + - autonomous-system + - artifact + - directory + - domain-name + - email-addr + - file + - ipv4-addr + - ipv6-addr + - mac-addr + - mutex + - port + - process + - software + - url + - user-account + - windows-registry-key + - x509-certificate example: ipv4-addr - name: indicator.description @@ -430,15 +427,14 @@ type: keyword short: Indicator confidence rating description: > - Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific + Identifies the vendor-neutral confidence rating using the None/Low/Medium/High scale defined in Appendix A of the STIX 2.1 framework. Vendor-specific confidence scales may be added as custom fields. - - Expected values are: - * Not Specified - * None - * Low - * Medium - * High + expected_values: + - Not Specified + - None + - Low + - Medium + - High example: Medium - name: indicator.ip @@ -474,13 +470,11 @@ short: Indicator TLP marking description: > Traffic Light Protocol sharing markings. - - Recommended values are: - * WHITE - * GREEN - * AMBER - * RED - + expected_values: + - WHITE + - GREEN + - AMBER + - RED example: WHITE - name: indicator.reference @@ -539,19 +533,18 @@ description: > The platforms of the software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. - Recommended Values: - * AWS - * Azure - * Azure AD - * GCP - * Linux - * macOS - * Network - * Office 365 - * SaaS - * Windows - - While not required, you can use a MITRE ATT&CK® software platforms. + While not required, you can use MITRE ATT&CK® software platform values. + expected_values: + - AWS + - Azure + - Azure AD + - GCP + - Linux + - macOS + - Network + - Office 365 + - SaaS + - Windows example: '[ "Windows" ]' normalize: - array @@ -573,11 +566,10 @@ description: > The type of software used by this threat to conduct behavior commonly modeled using MITRE ATT&CK®. - Recommended values - * Malware - * Tool - - While not required, you can use a MITRE ATT&CK® software type. + While not required, you can use a MITRE ATT&CK® software type. + expected_values: + - Malware + - Tool example: "Tool" - name: tactic.id @@ -604,7 +596,6 @@ normalize: - array - - name: tactic.reference level: extended type: keyword @@ -617,7 +608,6 @@ normalize: - array - - name: technique.id level: extended type: keyword