digital_shadows_consts.py

# Copyright (c) 2025-2026 Splunk Inc.
#
# Licensed 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.
# File: digital_shadows_consts.py
#
# Licensed under Apache 2.0 (https://www.apache.org/licenses/LICENSE-2.0.txt)
#

# Must match json configuration object in digital_shadows.json

# API Keys
DS_API_KEY_CFG = "ds_api_key"  # pragma: allowlist secret
DS_API_SECRET_KEY_CFG = "ds_api_secret_key"  # pragma: allowlist secret

# Action not supported message
DS_ACTION_NOT_SUPPORTED = "Action {} not supported"

# Test Connectivity action messages
DS_TEST_CONNECTIVITY_MESSAGE = "Testing Digital Shadows API credentials"
DS_TEST_CONNECTIVITY_MESSAGE_PASS = "Connectivity Test Passed"
DS_TEST_CONNECTIVITY_MESSAGE_FAIL = "Connectivity Test Failed"

# Lookup Username related messages
DS_LOOKUP_USERNAME_SUCCESS = "Digital Shadows username lookup successful"
DS_LOOKUP_USERNAME_NOT_FOUND = "Username not found in Digital Shadows Breach database"

# OnPoll action messages
DS_POLL_BREACH_COMPLETE = "Digital Shadows Breach {} ingested ({} of {})"
DS_POLL_INCIDENT_COMPLETE = "Digital Shadows Incident {} ingested ({} of {})"

DS_GET_INCIDENT_SUCCESS = "Digital Shadows incident fetched"

DS_GET_INTELLIGENCE_INCIDENT_SUCCESS = "Digital Shadows intel-incident fetched"

# Data Breach action messages
DS_GET_BREACH_SUCCESS = "Digital Shadows data breaches fetched"
DS_GET_BREACH_NOT_FOUND = "Data breach not found in Digital Shadows"

# Infrastructure related messages
DS_GET_INFRASTRUCTURE_SUCCESS = "Digital Shadows infrastructure ip-ports fetched"
DS_GET_INFRASTRUCTURE_NOT_FOUND = "Infrastructure ip-ports not found in Digital Shadows"

DS_GET_INFRASTRUCTURE_SSL_SUCCESS = "Digital Shadows infrastructure ssl fetched"
DS_GET_INFRASTRUCTURE_SSL_NOT_FOUND = "Infrastructure ssl not found in Digital Shadows"

DS_GET_INFRASTRUCTURE_VULNERABILITIES_SUCCESS = "Digital Shadows infrastructure Vulnerabilities fetched"
DS_GET_INFRASTRUCTURE_VULNERABILITIES_NOT_FOUND = "Infrastructure Vulnerabilities not found in Digital Shadows"

# Subtypes
DS_DL_SUBTYPE = ["CREDENTIAL_COMPROMISE", "CUSTOMER_DETAILS", "INTELLECTUAL_PROPERTY", "INTERNALLY_MARKED_DOCUMENT"]
DS_DL_SUBTYPE.extend(["LEGACY_MARKED_DOCUMENT", "PROTECTIVELY_MARKED_DOCUMENT", "TECHNICAL_LEAKAGE", "UNMARKED_DOCUMENT"])
DS_BP_SUBTYPE = ["BRAND_MISUSE", "DEFAMATION", "MOBILE_APPLICATION", "NEGATIVE_PUBLICITY", "PHISHING_ATTEMPT", "SPOOF_PROFILE"]
DS_INFR_SUBTYPE = ["CVE", "DOMAIN_CERTIFICATE_ISSUE", "EXPOSED_PORT"]
DS_PS_SUBTYPE = ["COMPANY_THREAT", "EMPLOYEE_THREAT", "PERSONAL_INFORMATION"]
DS_SMC_SUBTYPE = ["CORPORATE_INFORMATION", "PERSONAL_INFORMATION", "TECHNICAL_INFORMATION"]

# Exception message handling constants
ERROR_CODE_MESSAGE = "Error code unavailable"
ERROR_MESSAGE_UNAVAILABLE = "Error message unavailable. Please check the asset configuration and|or action parameters"
PARSE_ERROR_MESSAGE = "Unable to parse the error message. Please check the asset configuration and|or action parameters"

# Integer validation constants
VALID_INTEGER_MESSAGE = "Please provide a valid integer value in the {key}"
NON_NEGATIVE_INTEGER_MESSAGE = "Please provide a valid non-negative integer value in the {key}"

# Parameter Keys
BREACH_ID_KEY = "'breach_id' action parameter"
BREACH_RECORD_ID_KEY = "'breach_record_id' action parameter"
INCIDENT_ID_KEY = "'incident_id' action parameter"
INTEL_INCIDENT_ID_KEY = "'intel_incident_id' action parameter"
HISTORY_DAYS_INTERVAL_KEY = "'history_days_interval' config parameter"

# Service error message
SERVICE_ERROR_MESSAGE = "Error occurred while using the Digital Shadows Service."