def orca_client() -> OrcaClient:
api_key = "dummy api key"
client = BaseClient(base_url=ORCA_API_DNS_NAME,
verify=True,
headers={'Authorization': f'Bearer {api_key}'},
proxy=True)
return OrcaClient(client=client)
def test_get_alerts_queries_limit(requests_mock,
orca_client: OrcaClient) -> None:
mock_response = {
"version": "0.1.0",
"status": "success",
"total_items": 58,
"total_ungrouped_items": 58,
"total_supported_items": 10000,
"next_page_token": "mock_next_page",
"data": [{
"type": "malware"
}]
}
start_queries_count = len(requests_mock.request_history)
requests_mock.get(f"{DUMMY_ORCA_API_DNS_NAME}/query/alerts",
json=mock_response)
orca_client.get_all_alerts(first_fetch=None)
end_queries_count = len(requests_mock.request_history)
assert end_queries_count - start_queries_count == ORCA_HTTP_QUERIES_LIMIT
def test_get_alerts_by_non_existent_type_should_return_empty_list(requests_mock, orca_client: OrcaClient) -> None:
NON_EXISTENT_ALERT_TYPE = "non_existent_alert_type"
mock_response = {
"version": "0.1.0",
"status": "success",
"total_items": 0,
"total_ungrouped_items": 0,
"total_supported_items": 10000,
"data": []}
requests_mock.get(f"{ORCA_API_DNS_NAME}/alerts?type={NON_EXISTENT_ALERT_TYPE}", json=mock_response)
res = orca_client.get_alerts_by_filter(alert_type=NON_EXISTENT_ALERT_TYPE)
assert res == []
def test_test_module_fail(requests_mock, orca_client: OrcaClient) -> None:
mock_response = {
"detail": "Given token not valid for any token type",
"code": "token_not_valid",
"messages": [
{
"token_class": "AccessTokenWithExpiration",
"token_type": "access",
"message": "Token is invalid or expired"
}
],
"status_code": 403
}
requests_mock.get(f"{ORCA_API_DNS_NAME}/user/action?", json=mock_response)
res = orca_client.validate_api_key()
assert res == "Test failed becasue the Orca API key that was entered is invalid, please provide a valid API key"
def test_test_module_success(requests_mock, orca_client: OrcaClient) -> None:
mock_response = {
"status": "success",
"data": {
"user_id": "77777634-7777-7777-7777-f49f77777777",
"email": "*****@*****.**",
"first": "System",
"last": "Testing",
"full_name": "System Testing",
"profile_picture": "",
"organization_id": "e3dab69a-5555-5555-5555-c5b8881cd2fe",
"organization_name": "Orca Security",
"feature_flags": {},
"has_cloud_accounts": True,
"has_scanned_cloud_accounts": True
}
}
requests_mock.get(f"{ORCA_API_DNS_NAME}/user/action?", json=mock_response)
res = orca_client.validate_api_key()
assert res == "ok"
def test_get_asset_nonexistent(requests_mock, orca_client: OrcaClient) -> None:
mock_response = {"error": ""}
requests_mock.get(f"{ORCA_API_DNS_NAME}/assets/1234567", json=mock_response)
res = orca_client.get_asset(asset_unique_id="1234567")
assert res == "Asset Not Found"
def test_get_asset_should_succeed(requests_mock, orca_client: OrcaClient) -> None:
mock_response = {
"type": "vmimage",
"asset_category": "Image",
"asset_subcategory": "VM Image",
"cloud_provider_id": "111111111111",
"cloud_provider": "aws",
"cloud_account_id": "10b11111-1111-1111-91d5-11111de11111",
"cloud_vendor_id": "111111111111",
"account_name": "111111111111",
"asset_unique_id": "vmimage_111111e11111_ami-11111c111111d7911",
"asset_name": "my_test_image-1231asdasjdn",
"asset_type": "vmimage",
"asset_type_string": "VM Image",
"group_unique_id": "vmimage_111111e11111_ami-11111c111111d7911",
"group_name": "my_test_image-1231asdasjdn",
"group_type": "vmimage",
"group_type_string": "NonGroup",
"cluster_unique_id": "vmimage_111111e11111_ami-11111c111111d7911",
"cluster_name": "my_test_image-1231asdasjdn",
"cluster_type": "vmimage",
"level": 0,
"asset_vendor_id": "ami-11111c111111d7911",
"internet_facing": False,
"internet_facing_new": False,
"create_time": "2020-07-28T09:10:01+00:00",
"container_id": "main",
"compute": {
"distribution_name": "Ubuntu",
"distribution_version": "18.04",
"disks": [
{
"size": "7.75 GB",
"used": "2.06 GB"
}
],
"total_disks_bytes": 8326123520,
"roles": [
{
"type": "database",
"name": "mysql",
"is_public": False,
"detected_evidence": [
"/var/lib/mysql/mysqldb2",
"/var/lib/mysql/mysqldb1"
]
},
{
"type": "ssh",
"name": "ssh",
"is_public": False
},
{
"type": "web",
"name": "haproxy",
"is_public": False
},
{
"type": "database",
"name": "postgresql",
"is_public": False,
"detected_evidence": [
"/var/lib/postgresql/10/main/base/1",
"/var/lib/postgresql/10/main",
"/var/lib/postgresql/10/main/base/13017",
"/var/lib/postgresql/10/main/base/16384",
"/var/lib/postgresql/10/main/base/13018"
]
}
]
},
"vmimage": {
"image_id": "ami-11111c111111d7911",
"image_owner_id": "111111111111",
"image_name": "my_test_image-1231asdasjdn",
"image_description": ""
},
"configuration": {},
"state": {
"status": "exists",
"status_time": "2020-11-08T13:04:34+00:00",
"created_at": "2020-11-08T13:04:34+00:00",
"last_seen": "2020-12-30T10:44:11+00:00",
"score": 1,
"severity": "compromised",
"safe_since": None,
"unsafe_since": "2020-11-08T13:04:34+00:00"
}
}
requests_mock.get(f"{ORCA_API_DNS_NAME}/assets/vmimage_111111e11111_ami-11111c111111d7911", json=mock_response)
res = orca_client.get_asset(asset_unique_id="vmimage_111111e11111_ami-11111c111111d7911")
assert res == mock_response
def test_get_alerts_by_type_malware_should_succeed(requests_mock, orca_client: OrcaClient) -> None:
mock_response = {
"version": "0.1.0",
"status": "success",
"total_items": 6,
"total_ungrouped_items": 6,
"total_supported_items": 10000,
"data": [
{
"type": "malware",
"rule_id": "r1111ea1111",
"type_string": "Malware",
"type_key": "/test_eicar_file",
"category": "Malware",
"description": "Malware EICAR-Test-File found on asset",
"details": "We have detected a file infected with EICAR-Test-File on the asset.",
"recommendation": "Remediate the host and attend additional alerts on the host to close the infection path.",
"alert_labels": [
"malware_found"
],
"asset_category": "Storage",
"cloud_provider_id": "111111111111",
"cloud_provider": "aws",
"cloud_account_id": "10b11111-1111-1111-91d5-11111de11111",
"cloud_vendor_id": "111111111111",
"account_name": "111111111111",
"asset_unique_id": "storage_111111e11111_scan-me-s3-bucket-s8rrr",
"asset_name": "scan-me-s3-bucket-s8rrr",
"asset_type": "storage",
"asset_type_string": "AWS S3 Bucket",
"group_unique_id": "storage_111111e11111_scan-me-s3-bucket-s8rrr",
"group_name": "scan-me-s3-bucket-s8rrr",
"group_type": "storage",
"group_type_string": "NonGroup",
"group_val": "nongroup",
"cluster_unique_id": "storage_111111e11111_scan-me-s3-bucket-s8rrr",
"cluster_name": "scan-me-s3-bucket-s8rrr",
"cluster_type": "storage",
"level": 0,
"asset_state": "enabled",
"asset_labels": [
"internet_facing",
"pii"
],
"asset_vendor_id": "scan-me-s3-bucket-s8rrr",
"asset_regions": [
"us-east-1"
],
"asset_regions_names": [
"N. Virginia"
],
"source": "test_eicar_file",
"findings": {
"malware": [
{
"type": "malware",
"labels": [
"malware_found"
],
"virus_names": [
"EICAR-Test-File"
],
"modification_time": "2020-04-26T14:26:11+00:00",
"file": "/test_eicar_file",
"sha256": "275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f",
"sha1": "3395856ce81f2b7382dee72602f798b642f14140",
"md5": "44d88612fea8a8f36de82e1278abb02f",
"has_macro": False
}
]
},
"configuration": {
"user_status": "closed",
"jira_issue_link": "https://www.jira.com/myproject",
"jira_issue": "TP-41"
},
"state": {
"alert_id": "orca-59",
"status": "in_progress",
"status_time": "2020-12-30T09:57:33+00:00",
"created_at": "2020-11-08T12:58:52+00:00",
"last_seen": "2020-12-30T10:35:46+00:00",
"score": 1,
"severity": "compromised",
"low_since": None,
"high_since": "2020-12-15T15:33:49+00:00",
"in_verification": None
},
"priv": {
"key": "3ea22222274111114b011111bb311111",
"score": 1,
"orig_score": 1,
"alert_id": "orca-59",
"full_scan_time": "2020-12-30T10:35:46+00:00",
"organization_id": "11111111-1111-1111-1111-c111881c1111",
"organization_name": "Orca Security",
"context": "data",
"account_action_id_ctx": {
"data": "11111111-1111-1111-1111-8a529a011111"
},
"scan_id_ctx": {
"data": "11111111-1111-1111-1111-8a529a011111_111111111111_bucket-111111e11111-us-east-1"
},
"first_seen": "2020-11-08T13:03:37+00:00"
},
"hdr": {
"asset_category": "Storage",
"organization_id": "11111111-1111-1111-1111-c111881c1111",
"organization_name": "Orca Security",
"cloud_provider": "aws",
"cloud_provider_id": "111111111111",
"cloud_account_id": "10b11111-1111-1111-91d5-11111de11111",
"context": "data",
"asset_unique_id": "storage_111111e11111_scan-me-s3-bucket-s8rrr",
"asset_type": "storage",
"asset_type_string": "AWS S3 Bucket",
"asset_name": "scan-me-s3-bucket-s8rrr",
"group_unique_id": "storage_111111e11111_scan-me-s3-bucket-s8rrr",
"group_name": "scan-me-s3-bucket-s8rrr",
"group_type": "storage",
"group_type_string": "NonGroup",
"cluster_unique_id": "storage_111111e11111_scan-me-s3-bucket-s8rrr",
"cluster_type": "storage",
"cluster_name": "scan-me-s3-bucket-s8rrr",
"level": 0,
"group_val": "nongroup",
"asset_vendor_id": "scan-me-s3-bucket-s8rrr",
"cloud_vendor_id": "111111111111",
"asset_state": "enabled",
"account_name": "111111111111",
"asset_labels": [
"internet_facing"
]
},
"insert_time": "2020-12-30T10:45:21+00:00"
}
]
}
requests_mock.get(f"{ORCA_API_DNS_NAME}/alerts?type=malware", json=mock_response)
res = orca_client.get_alerts_by_filter(alert_type="malware")
assert res[0] == mock_response['data'][0]