summaryrefslogtreecommitdiff
path: root/src/db/schema.py
diff options
context:
space:
mode:
authorKristofer Hallin <kristofer@sunet.se>2022-04-12 13:49:05 +0200
committerKristofer Hallin <kristofer@sunet.se>2022-04-12 13:49:05 +0200
commit509bf7fe6a4589d525b21f179ce8cb730c0d4e59 (patch)
tree975714991716efe60ce67e82e143c825a8eb27c0 /src/db/schema.py
parent16f5009ac0d630c5f25c9d6cb4e8fb026ae628f9 (diff)
parent2aebcdeca17f9b46d90f5255dd4d03caa358701e (diff)
Merged main and updated stuff.
Diffstat (limited to 'src/db/schema.py')
-rw-r--r--src/db/schema.py154
1 files changed, 107 insertions, 47 deletions
diff --git a/src/db/schema.py b/src/db/schema.py
index 37da5aa..9bdf130 100644
--- a/src/db/schema.py
+++ b/src/db/schema.py
@@ -1,75 +1,135 @@
import json
+import sys
+import traceback
import jsonschema
+# fmt:off
+# NOTE: Commented out properties are left intentionally, so it is easier to see
+# what properties are optional.
schema = {
"$schema": "http://json-schema.org/schema#",
"type": "object",
"properties": {
- "document_version": {
- "type": "integer"
- },
- "ip": {
- "type": "string"
- },
- "port": {
- "type": "integer"
- },
- "whois_description": {
- "type": "string"
- },
- "asn": {
- "type": "string"
- },
- "asn_country_code": {
- "type": "string"
- },
- "ptr": {
- "type": "string"
- },
- "abuse_mail": {
- "type": "string"
- },
- "domain": {
- "type": "string"
- },
- "timestamp_in_utc": {
- "type": "string"
+ "document_version": {"type": "integer"},
+ "ip": {"type": "string"},
+ "port": {"type": "integer"},
+ "whois_description": {"type": "string"},
+ "asn": {"type": "string"},
+ "asn_country_code": {"type": "string"},
+ "ptr": {"type": "string"},
+ "abuse_mail": {"type": "string"},
+ "domain": {"type": "string"},
+ "timestamp_in_utc": {"type": "string"},
+ "display_name": {"type": "string"},
+ "description": {"type": "string"},
+ "custom_data": {
+ "type": "object",
+ "patternProperties": {
+ ".*": {
+ "type": "object",
+ "properties": {
+ "display_name": {"type": "string"},
+ "data": {"type": ["string", "boolean", "integer"]},
+ "description": {"type": "string"},
+ },
+ "required": [
+ "display_name",
+ "data",
+ # "description"
+ ]
+ },
+ },
},
- "user_presentation": {
+ "result": {
"type": "object",
- "properties": {
- "description": {
- "type": "string"
+ "patternProperties": {
+ ".*": {
+ "type": "object",
+ "properties": {
+ "display_name": {"type": "string"},
+ "vulnerable": {"type": "boolean"},
+ "investigation_needed": {"type": "boolean"},
+ "reliability": {"type": "integer"},
+ "description": {"type": "string"},
+ },
+ "oneOf": [
+ {
+ "required": [
+ "display_name",
+ "vulnerable",
+ # "reliability", # TODO: reliability is required if vulnerable = true
+ # "description",
+ ]
+ },
+ {
+ "required": [
+ "display_name",
+ "investigation_needed",
+ # "reliability", # TODO: reliability is required if investigation_needed = true
+ # "description",
+ ]
+ },
+ ]
},
- "data": {
- "type": "object"
- }
- }
- }
+ },
+ },
},
"required": [
"document_version",
"ip",
"port",
+ "whois_description",
+ "asn",
+ "asn_country_code",
+ "ptr",
+ "abuse_mail",
+ "domain",
"timestamp_in_utc",
- "user_presentation"
- ]
+ "display_name",
+ # "description",
+ # "custom_data",
+ "result",
+ ],
}
+# fmt:on
+
+
+def get_index_keys():
+ keys = list()
+ for key in schema["properties"]:
+ keys.append(key)
+ return keys
+
+
+def as_index_list():
+ index_list = list()
+ for key in schema["properties"]:
+ name = f"{key}-json-index"
+ index = {
+ "index": {
+ "fields": [
+ key,
+ ]
+ },
+ "name": name,
+ "type": "json"
+ }
+ index_list.append(index)
+
+ return index_list
def validate_collector_data(json_blob):
try:
jsonschema.validate(json_blob, schema)
except jsonschema.exceptions.ValidationError as e:
- print(f'Validation failed with error: {e}')
- return False
-
- return True
+ return f"Validation failed with error: {e.message}"
+ return ""
-if __name__ == '__main__':
- with open('example_data.json') as fd:
+if __name__ == "__main__":
+ with open(sys.argv[1]) as fd:
json_data = json.loads(fd.read())
- validate_collector_data(json_data)
+ print(validate_collector_data(json_data))