feat: support calculated risk table
Browse files- .vscode/launch.json +19 -0
- scribe_python_client/cli.py +5 -2
- scribe_python_client/client.py +16 -4
- scribe_python_client/constants.py +2 -1
.vscode/launch.json
CHANGED
|
@@ -26,6 +26,25 @@
|
|
| 26 |
"--lineage-graph-file",
|
| 27 |
"lineage_graph.html",
|
| 28 |
]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 29 |
}
|
|
|
|
| 30 |
]
|
| 31 |
}
|
|
|
|
| 26 |
"--lineage-graph-file",
|
| 27 |
"lineage_graph.html",
|
| 28 |
]
|
| 29 |
+
},
|
| 30 |
+
{
|
| 31 |
+
"name": "Test risk dataset",
|
| 32 |
+
"type": "debugpy",
|
| 33 |
+
"request": "launch",
|
| 34 |
+
"module": "scribe_python_client.cli",
|
| 35 |
+
"console": "internalConsole",
|
| 36 |
+
"args": [
|
| 37 |
+
"--api-call",
|
| 38 |
+
"query-risk",
|
| 39 |
+
"--env",
|
| 40 |
+
"dev",
|
| 41 |
+
"--query",
|
| 42 |
+
"{\"columns\": [\"logical_app\"], \"filters\": [], \"orderby\": [], \"row_limit\": 10}",
|
| 43 |
+
],
|
| 44 |
+
"env": {
|
| 45 |
+
"SCRIBE_TOKEN": "${env:SCRIBE_DEV_TOKEN}",
|
| 46 |
+
}
|
| 47 |
}
|
| 48 |
+
|
| 49 |
]
|
| 50 |
}
|
scribe_python_client/cli.py
CHANGED
|
@@ -18,7 +18,8 @@ def main():
|
|
| 18 |
"query-vulnerabilities",
|
| 19 |
"query-products",
|
| 20 |
"query-policy-results",
|
| 21 |
-
"query-lineage"
|
|
|
|
| 22 |
], help="Which API call to execute")
|
| 23 |
parser.add_argument("--api-token", required=False, default=os.getenv('SCRIBE_TOKEN'), help="Your API token from ScribeHub integrations page (defaults to SCRIBE_TOKEN environment variable)")
|
| 24 |
parser.add_argument("--env", default="prod", choices=["prod", "dev", "test", "ci"], help="Which environment to use")
|
|
@@ -49,7 +50,7 @@ def main():
|
|
| 49 |
if args.env != "prod":
|
| 50 |
base_url = f"https://api.{args.env}.scribesecurity.com"
|
| 51 |
|
| 52 |
-
client = ScribeClient(api_token=args.api_token, base_url=base_url)
|
| 53 |
|
| 54 |
logging.info(f"Executing API call: {args.api_call}")
|
| 55 |
|
|
@@ -79,6 +80,8 @@ def main():
|
|
| 79 |
if args.lineage_graph_file:
|
| 80 |
client.query_lineage(args.query, graph_filename=args.lineage_graph_file)
|
| 81 |
# logging.info(f"Lineage graph saved to {args.lineage_graph_file}")
|
|
|
|
|
|
|
| 82 |
|
| 83 |
if __name__ == "__main__":
|
| 84 |
main()
|
|
|
|
| 18 |
"query-vulnerabilities",
|
| 19 |
"query-products",
|
| 20 |
"query-policy-results",
|
| 21 |
+
"query-lineage",
|
| 22 |
+
"query-risk",
|
| 23 |
], help="Which API call to execute")
|
| 24 |
parser.add_argument("--api-token", required=False, default=os.getenv('SCRIBE_TOKEN'), help="Your API token from ScribeHub integrations page (defaults to SCRIBE_TOKEN environment variable)")
|
| 25 |
parser.add_argument("--env", default="prod", choices=["prod", "dev", "test", "ci"], help="Which environment to use")
|
|
|
|
| 50 |
if args.env != "prod":
|
| 51 |
base_url = f"https://api.{args.env}.scribesecurity.com"
|
| 52 |
|
| 53 |
+
client = ScribeClient(api_token=args.api_token, base_url=base_url, env = args.env)
|
| 54 |
|
| 55 |
logging.info(f"Executing API call: {args.api_call}")
|
| 56 |
|
|
|
|
| 80 |
if args.lineage_graph_file:
|
| 81 |
client.query_lineage(args.query, graph_filename=args.lineage_graph_file)
|
| 82 |
# logging.info(f"Lineage graph saved to {args.lineage_graph_file}")
|
| 83 |
+
elif args.api_call == "query-risk":
|
| 84 |
+
print(client.query_risk(querystr=args.query))
|
| 85 |
|
| 86 |
if __name__ == "__main__":
|
| 87 |
main()
|
scribe_python_client/client.py
CHANGED
|
@@ -14,7 +14,8 @@ from .constants import (
|
|
| 14 |
SCRIBE_PRODUCTS_DATASET,
|
| 15 |
SCRIBE_POLICY_DATASET,
|
| 16 |
SCRIBE_TEAM_STAT_DATASET,
|
| 17 |
-
SCRIBE_LINEAGE_DATASET
|
|
|
|
| 18 |
)
|
| 19 |
|
| 20 |
class ScribeClient:
|
|
@@ -23,6 +24,7 @@ class ScribeClient:
|
|
| 23 |
scribe_policy_dataset = SCRIBE_POLICY_DATASET
|
| 24 |
scribe_team_stat_dataset = SCRIBE_TEAM_STAT_DATASET
|
| 25 |
scribe_lineage_dataset=SCRIBE_LINEAGE_DATASET
|
|
|
|
| 26 |
|
| 27 |
def get_chache_data(self):
|
| 28 |
return {
|
|
@@ -43,7 +45,7 @@ class ScribeClient:
|
|
| 43 |
return True
|
| 44 |
return (datetime.datetime.now() - last_update).days > 1
|
| 45 |
|
| 46 |
-
def __init__(self, api_token=None, ignore_env = False, base_url="https://api.scribesecurity.com", refresh_interval=600, cached_data={}):
|
| 47 |
def update_from_cached_data(cached_data):
|
| 48 |
if "datasets" in cached_data:
|
| 49 |
self.datasets = cached_data["datasets"]
|
|
@@ -71,7 +73,7 @@ class ScribeClient:
|
|
| 71 |
if not self.api_token:
|
| 72 |
logging.error("No API token provided. Please set the SCRIBE_TOKEN environment variable or pass it as an argument.")
|
| 73 |
return
|
| 74 |
-
|
| 75 |
self.base_url = base_url
|
| 76 |
self.refresh_interval = refresh_interval
|
| 77 |
self.last_refresh = datetime.datetime.now() - datetime.timedelta(days=5) # Initialize to a time in the past
|
|
@@ -161,7 +163,8 @@ class ScribeClient:
|
|
| 161 |
return
|
| 162 |
jwt_name = decoded_token.get("name")
|
| 163 |
try:
|
| 164 |
-
|
|
|
|
| 165 |
logging.info(f"Team:{self.team_id}")
|
| 166 |
except Exception as e:
|
| 167 |
logging.error(f"Error extracting team ID: {e}")
|
|
@@ -1062,4 +1065,13 @@ class ScribeClient:
|
|
| 1062 |
r = self.query_superset(self.scribe_policy_dataset, query, time_tokens=["time_evaluated"])
|
| 1063 |
if r:
|
| 1064 |
return f"{title}\n{self.format_query_result_table(r)}"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1065 |
return "Error running query"
|
|
|
|
| 14 |
SCRIBE_PRODUCTS_DATASET,
|
| 15 |
SCRIBE_POLICY_DATASET,
|
| 16 |
SCRIBE_TEAM_STAT_DATASET,
|
| 17 |
+
SCRIBE_LINEAGE_DATASET,
|
| 18 |
+
SCRIBE_RISK_DATASET
|
| 19 |
)
|
| 20 |
|
| 21 |
class ScribeClient:
|
|
|
|
| 24 |
scribe_policy_dataset = SCRIBE_POLICY_DATASET
|
| 25 |
scribe_team_stat_dataset = SCRIBE_TEAM_STAT_DATASET
|
| 26 |
scribe_lineage_dataset=SCRIBE_LINEAGE_DATASET
|
| 27 |
+
scribe_risk_dataset = SCRIBE_RISK_DATASET
|
| 28 |
|
| 29 |
def get_chache_data(self):
|
| 30 |
return {
|
|
|
|
| 45 |
return True
|
| 46 |
return (datetime.datetime.now() - last_update).days > 1
|
| 47 |
|
| 48 |
+
def __init__(self, api_token=None, ignore_env = False, base_url="https://api.scribesecurity.com", refresh_interval=600, cached_data={}, env = "prod"):
|
| 49 |
def update_from_cached_data(cached_data):
|
| 50 |
if "datasets" in cached_data:
|
| 51 |
self.datasets = cached_data["datasets"]
|
|
|
|
| 73 |
if not self.api_token:
|
| 74 |
logging.error("No API token provided. Please set the SCRIBE_TOKEN environment variable or pass it as an argument.")
|
| 75 |
return
|
| 76 |
+
self.env = env
|
| 77 |
self.base_url = base_url
|
| 78 |
self.refresh_interval = refresh_interval
|
| 79 |
self.last_refresh = datetime.datetime.now() - datetime.timedelta(days=5) # Initialize to a time in the past
|
|
|
|
| 163 |
return
|
| 164 |
jwt_name = decoded_token.get("name")
|
| 165 |
try:
|
| 166 |
+
prefix = "scribe-hub-team" if self.env == "prod" else f"scribe-hub-{self.env}-team"
|
| 167 |
+
self.team_id = jwt_name.split(prefix)[1].split("-")[0]
|
| 168 |
logging.info(f"Team:{self.team_id}")
|
| 169 |
except Exception as e:
|
| 170 |
logging.error(f"Error extracting team ID: {e}")
|
|
|
|
| 1065 |
r = self.query_superset(self.scribe_policy_dataset, query, time_tokens=["time_evaluated"])
|
| 1066 |
if r:
|
| 1067 |
return f"{title}\n{self.format_query_result_table(r)}"
|
| 1068 |
+
return "Error running query"
|
| 1069 |
+
|
| 1070 |
+
def query_risk(self, querystr, title="", graph_filename=None) -> str:
|
| 1071 |
+
logging.debug(f"Query risk table with: {querystr}")
|
| 1072 |
+
query = self.querystr_to_json(querystr)
|
| 1073 |
+
if query:
|
| 1074 |
+
r = self.query_superset(self.scribe_risk_dataset, query, time_tokens=["timestamp"])
|
| 1075 |
+
if r:
|
| 1076 |
+
return f"{title}\n{self.format_query_result_table(r)}"
|
| 1077 |
return "Error running query"
|
scribe_python_client/constants.py
CHANGED
|
@@ -2,4 +2,5 @@ SCRIBE_VULNERABILITIES_DATASET = "API Vulnerabilities"
|
|
| 2 |
SCRIBE_PRODUCTS_DATASET = "asbom_filtered"
|
| 3 |
SCRIBE_POLICY_DATASET = "policy_initiative"
|
| 4 |
SCRIBE_TEAM_STAT_DATASET = "MARKETING Team activity"
|
| 5 |
-
SCRIBE_LINEAGE_DATASET = "extended_lineage_new"
|
|
|
|
|
|
| 2 |
SCRIBE_PRODUCTS_DATASET = "asbom_filtered"
|
| 3 |
SCRIBE_POLICY_DATASET = "policy_initiative"
|
| 4 |
SCRIBE_TEAM_STAT_DATASET = "MARKETING Team activity"
|
| 5 |
+
SCRIBE_LINEAGE_DATASET = "extended_lineage_new"
|
| 6 |
+
SCRIBE_RISK_DATASET = "product_risk_1.0"
|