data_models 모듈
이 모듈에는 다음을 나타내는 데이터 클래스가 포함되어 있습니다.
- 데이터 모델
- 알림
- 변수 컨테이너
- 일반 매개변수
- 커넥터 매개변수
class TIPCommon.data_models.AlertCard
클래스 TIPCommon.data_models.AlertCard(id_: int, creation_time_unix_time_ms: int, modification_time_unix_time_ms: int, identifier: str, status: int, name: str, priority: [AlertPriority](#TIPCommon.data_models.AlertPriority) | int | None, workflow_status: int | None, sla_expiration_unix_time: int | None, sla_critical_expiration_unix_time: int | None, start_time: int, end_time: int, alert_group_identifier: str, events_count: int, title: str, rule_generator: str, device_product: str, device_vendor: str, playbook_attached: bool | None, playbook_run_count: int | None, is_manual_alert: bool | None, sla: [SLA](#TIPCommon.data_models.SLA) | None, fields_groups: list[[FieldsGroup](#TIPCommon.data_models.FieldsGroup)], source_url: str | None, source_rule_url: str | None, siem_alert_id: str | None, additional_properties: str | None, case_id: int | None, ticket_id: str | None, closure_details: MutableMapping[str, Any] | None, event_count: int | None = None, product_families: list[str] | None = None, entity_cards: list[MutableMapping[str, Any]] | None = None, security_event_cards: list[MutableMapping[str, Any]] | None = None, involved_relations: list[MutableMapping[str, Any]] | None = None)
기본: object
AlertCard는 알림의 요약 카드를 나타내며, 플랫폼 내에서 시각화 및 추적에 사용되는 중요한 메타데이터와 상태 표시기를 캡슐화합니다.
메서드
다음 메서드는 구조화된 데이터에서 알림 카드의 직렬화 및 재구성을 용이하게 합니다.
| 메서드 | |
|---|---|
from_json() |
JSON 사전에서 |
to_json() |
|
속성
다음 표에서는 알림과 관련된 기본 구조 속성 및 복잡한 데이터 모델을 강조 표시합니다.
| 속성 | |
|---|---|
fields_groups |
알림과 연결된 그룹화된 필드의 목록으로, UI에서 구조화된 데이터를 표시하는 데 사용됩니다. |
sla |
알림의 응답 및 해결 기간을 정의하는 서비스수준계약 객체입니다. |
class TIPCommon.data_models.AlertEvent
클래스 TIPCommon.data_models.AlertEvent(fields: list[EventPropertyField], identifier: str, case_id: int, alert_identifier: str, name: str, product: str, port: str | None, source_system_name: str, outcome: str | None, time: int, type_: str, artifact_entities: list[str])
기본: object
AlertEvent는 알림과 연결된 개별 이벤트를 나타내며, 특정 원격 분석 데이터, 필드 속성, 항목 관계를 포함합니다.
메서드
다음 메서드는 구조화된 JSON 데이터에서 이벤트 객체의 재구성을 지원합니다.
| 메서드 | |
|---|---|
from_json() |
속성을 나타내는 JSON 사전에서 |
속성
다음 표에서는 이벤트와 관련된 기본 구조 속성 및 복잡한 데이터 모델을 강조합니다.
| 속성 | |
|---|---|
fields |
이벤트에 특정한 속성 필드 목록으로, 이벤트의 고유한 데이터 포인트를 정의합니다. |
artifact_entities |
이벤트 원격 분석에서 추출된 항목 식별자 목록입니다. |
class TIPCommon.data_models.AlertPriority
클래스 TIPCommon.data_models.AlertPriority(value)
기본: 열거형
AlertPriority는 플랫폼 내에서 알림을 분류하고 우선순위를 지정하는 데 사용되는 표준화된 정수 기반 심각도 수준을 정의합니다.
상수
다음 상수는 알림에 할당된 특정 우선순위 값을 나타냅니다.
| 상수 | |
|---|---|
CRITICAL |
100 |
HIGH |
80 |
MEDIUM |
60 |
LOW |
40 |
UNCHANGED |
0 |
INFORMATIVE |
-1 |
class TIPCommon.data_models.AttachmentMetadata
클래스 TIPCommon.data_models.AttachmentMetadata(raw_data: SingleJson)
기본: object
AttachmentMetadata는 파일 첨부와 연결된 설명 데이터와 속성을 캡슐화하여 구조화된 데이터 변환 및 검색을 위한 메서드를 제공합니다.
메서드
다음 메서드는 JSON 페이로드에서 케이스 객체를 재구성하는 표준화된 방법을 제공합니다.
| 메서드 | |
|---|---|
from_json() |
제공된 메타데이터 속성 사전을 사용하여 새 |
to_json() |
|
속성
다음 표에서는 첨부파일의 메타데이터 속성을 저장하는 데 사용되는 기본 데이터 구조를 강조 표시합니다.
| 속성 | |
|---|---|
raw_data |
소스에서 수신한 원시 메타데이터 속성을 포함하는 기본 사전입니다. |
class TIPCommon.data_models.BaseAlert
클래스 TIPCommon.data_models.BaseAlert(raw_data, alert_id)
기본: object
BaseAlert는 일반적인 보안 알림을 나타내는 기본 모델입니다. 고유한 플랫폼 식별자와 함께 원시 원격 분석을 저장하기 위한 표준화된 구조를 제공합니다.
메서드
다음 메서드를 사용하면 알림을 표준 형식으로 직렬화할 수 있습니다.
| 메서드 | |
|---|---|
to_json() |
|
속성
다음 표에서는 이 모델에서 관리하는 핵심 데이터 포인트를 강조합니다.
| 속성 | |
|---|---|
raw_data |
알림과 연결된 원시 데이터 페이로드입니다. |
alert_id |
알림에 할당된 고유 식별자입니다. |
예
다음 예에서는 BaseAlert를 초기화하고 원시 데이터와 직렬화된 출력에 액세스하는 방법을 보여줍니다.
>>> from data_models import BaseAlert
>>> alert = BaseAlert({'foo': 'bar'}, 100)
>>> alert.raw_data
{'foo': 'bar'}
>>> alert.alert_id
100
>>> alert.to_json()
{'foo': 'bar'}
class TIPCommon.data_models.BaseDataModel
클래스 TIPCommon.data_models.BaseDataModel(raw_data)
기본: object
BaseDataModel은 라이브러리 내 다양한 데이터 구조의 상위 클래스 역할을 하여 원시 입력 데이터와 직렬화의 일관된 처리를 보장합니다.
메서드
다음 메서드는 원시 데이터가 JSON 작업과 호환되는 형식으로 검색되도록 합니다.
| 메서드 | |
|---|---|
to_json() |
모델에 저장된 원시 데이터를 딕셔너리 형식으로 직렬화합니다. |
속성
다음 표에서는 기본 모델의 기본 데이터 스토리지를 설명합니다.
| 속성 | |
|---|---|
raw_data |
모델을 초기화하는 데 사용된 원래 원시 데이터 페이로드입니다. |
예
다음 예에서는 데이터 모델의 기본 초기화와 직렬화 메서드의 사용을 보여줍니다.
>>> from data_models import BaseDataModel
>>> data = BaseDataModel({'foo': 'bar'})
>>> data.raw_data
{'foo': 'bar'}
>>> data.to_json()
{'foo': 'bar'}
class TIPCommon.data_models.CaseDataStatus
클래스 TIPCommon.data_models.CaseDataStatus(value)
기본: 열거형
CaseDataStatus는 초기 수집부터 최종 종료 또는 병합에 이르기까지 플랫폼 내 케이스에 지원되는 운영 상태를 정의합니다.
상수
다음 상수는 케이스 데이터에 할당된 특정 상태 표시기를 나타냅니다.
| 상수 | |
|---|---|
NEW |
0 |
OPENED |
1 |
CLOSED |
2 |
ALL |
3 |
MERGED |
4 |
CREATION_PENDING |
5 |
class TIPCommon.data_models.CaseDetails
기본: object
CaseDetails는 상태 확인 속성과 케이스 데이터를 재구성하거나 직렬화하는 메서드를 비롯한 보안 케이스의 광범위한 뷰를 제공합니다.
메서드
다음 메서드는 객체 인스턴스와 구조화된 JSON 형식 간의 케이스 세부정보 변환을 관리합니다.
| 메서드 | |
|---|---|
from_json() |
케이스 속성의 사전에서 |
to_json() |
|
속성
다음 속성은 케이스의 현재 상태에 관한 논리적 표시기를 제공합니다.
| 속성 | |
|---|---|
is_closed |
케이스가 종료된 상태인지 여부를 나타내는 불리언 속성입니다. |
is_open |
케이스가 활성 상태인지 열려 있는지 나타내는 불리언 속성입니다. |
class TIPCommon.data_models.CaseOverviewInfo
클래스 TIPCommon.data_models.CaseOverviewInfo(id: 'int', create_time_ms: 'int', update_time_ms: 'int', display_id: 'str', display_name: 'str', alert_count: 'int', stage: 'str', priority: 'CasePriority', important: 'bool', description: 'str | None' = None, type: 'int | None' = None, assignee_full_name: 'str | None' = None, environment_data: 'EnvironmentData | None' = None, status: 'CaseDataStatus | None' = None, score: 'int | None' = None, case_sla: 'CaseSLAInfo | None' = None, alerts_sla: 'CaseSLAInfo | None' = None, incident: 'bool | None' = None, has_suspicious_entity: 'bool | None' = None, workflow_status: 'int | None' = None, tags: 'list[str]' = <factory>, products: 'list[str]' = <factory>, touched: 'bool | None' = None, merged: 'bool | None' = None, has_incident: 'bool | None' = None, alert_names: 'list[str]' = <factory>)
기본: object
CaseOverviewInfo는 보안 케이스의 개요를 제공하며, 대시보드 및 대기열 관리에 사용되는 메타데이터, 서비스수준계약 (SLA) 상태, 조직 세부정보를 집계합니다.
메서드
다음 메서드는 구조화된 JSON 데이터에서 케이스 개요 객체를 재구성하는 데 도움이 됩니다.
| 메서드 | |
|---|---|
from_json() |
케이스 요약 속성의 사전에서 |
속성
다음 표에서는 케이스 개요와 관련된 기본 구조 속성, 열거형, 주요 운영 측정항목을 강조 표시합니다.
| 속성 | |
|---|---|
priority |
케이스에 할당된 심각도 수준입니다. |
status |
케이스 데이터의 현재 운영 상태입니다. |
workflow_status |
플랫폼의 자동화된 워크플로 엔진 내의 현재 단계 또는 상태입니다. |
score |
케이스에 할당된 계산된 위험 또는 중요도 점수입니다. |
case_sla |
케이스 해결 수명 주기에 대한 SLA 추적 정보입니다. |
alerts_sla |
케이스에 포함된 개별 알림의 SLA 추적 정보입니다. |
environment_data |
케이스가 시작된 특정 조직 환경에 관한 메타데이터입니다. |
tags |
케이스와 연결된 사용자 정의 또는 시스템 생성 라벨 목록입니다. |
class TIPCommon.data_models.CasePriority
클래스 TIPCommon.data_models.CasePriority(value)
기본: 열거형
CasePriority는 플랫폼 내에서 케이스를 분류하고 우선순위를 지정하는 데 사용되는 표준화된 정수 기반 심각도 수준을 정의합니다.
상수
다음 상수는 케이스에 할당된 특정 우선순위 값을 나타냅니다.
| 상수 | |
|---|---|
CRITICAL |
100 |
HIGH |
80 |
MEDIUM |
60 |
LOW |
40 |
UNCHANGED |
0 |
INFORMATIVE |
-1 |
class TIPCommon.data_models.CaseSLAInfo
클래스 TIPCommon.data_models.CaseSLAInfo(expiration_time_ms: int | None = None, critical_expiration_time_ms: int | None = None, expiration_status: int | None = None, last_pause_remaining_time_ms: int | None = None)
기본: object
CaseSLAInfo는 서비스수준계약 (SLA) 추적 데이터를 캡슐화하여 만료 타임스탬프와 상태 표시기를 제공하여 적시에 인시던트에 대응할 수 있도록 합니다.
메서드
다음 메서드를 사용하면 구조화된 JSON 데이터에서 SLA 정보 객체를 만들 수 있습니다.
| 메서드 | |
|---|---|
from_json() |
SLA 속성 사전에서 |
속성
다음 표에서는 케이스 기한을 모니터링하는 데 사용되는 기본 타이밍 및 상태 속성을 강조 표시합니다.
| 속성 | |
|---|---|
expiration_time_ms |
표준 SLA가 만료되도록 설정된 Unix 타임스탬프 (밀리초 단위)입니다. |
critical_expiration_time_ms |
심각한 SLA 기준점에 도달한 시점의 Unix 타임스탬프 (밀리초)입니다. |
expiration_status |
SLA의 현재 상태를 나타내는 정수 표시기입니다. |
last_pause_remaining_time_ms |
마지막으로 일시중지된 시점에 SLA 시계에 남아 있는 시간입니다. |
class TIPCommon.data_models.CaseWallAttachment
클래스 TIPCommon.data_models.CaseWallAttachment(name, file_type, base64_blob, is_important, case_id=None, description=None)
기본: object
CaseWallAttachment는 케이스의 증거 월에 첨부된 파일 또는 데이터 객체를 나타냅니다. 여기에는 base64 형식의 원시 콘텐츠와 연결된 메타데이터가 포함됩니다.
속성
다음 표에서는 첨부파일과 관련된 기본 속성 및 콘텐츠 데이터를 보여줍니다.
| 속성 | |
|---|---|
name |
첨부파일의 파일 이름 또는 표시 이름입니다. |
file_type |
첨부된 데이터의 형식을 나타내는 MIME 유형 또는 파일 확장자입니다. |
base64_blob |
파일의 실제 콘텐츠로, base64 문자열로 인코딩됩니다. |
is_important |
첨부파일이 조사의 중요한 증거로 표시되었는지 여부를 나타내는 플래그입니다. |
class TIPCommon.data_models.ConnectorCard
클래스 TIPCommon.data_models.ConnectorCard(integration, display_name, identifier, is_enabled, is_remote, status)
기본: object
ConnectorCard는 특정 커넥터의 구성에 대한 요약을 제공하고
플랫폼 내의 현재 운영 상태를 나타냅니다.
메서드
다음 메서드는 구조화된 JSON 데이터에서 커넥터 카드 인스턴스를 쉽게 만들 수 있도록 지원합니다.
| 메서드 | |
|---|---|
from_json() |
커넥터 속성의 사전에서 |
속성
다음 표에서는 커넥터의 작동 상태와 식별 속성을 보여줍니다.
| 속성 | |
|---|---|
status |
커넥터의 현재 연결 및 상태입니다. |
is_enabled |
커넥터가 활성 상태이고 데이터를 처리하는지 여부를 나타냅니다. |
class TIPCommon.data_models.ConnectorConnectivityStatusEnum
클래스 TIPCommon.data_models.ConnectorConnectivityStatusEnum(value)
기본: 열거형
ConnectorConnectivityStatusEnum은 커넥터의 가능한 연결 상태를 정의하여 대상 통합과 성공적으로 통신하는지 여부를 나타냅니다.
상수
다음 상수는 커넥터 연결의 상태를 나타냅니다.
| 상수 | |
|---|---|
LIVE |
0 |
NO_CONNECTIVITY |
1 |
class TIPCommon.data_models.ConnectorParamTypes
클래스 TIPCommon.data_models.ConnectorParamTypes(value)
기본: 열거형
ConnectorParamTypes는 커넥터 구성 매개변수에 지원되는 데이터 유형을 정의합니다. 이러한 유형은 플랫폼 설정 내에서 적절한 유효성 검사와 UI 렌더링을 보장합니다.
상수
다음 상수는 매개변수에 사용할 수 있는 특정 데이터 유형을 나타냅니다.
| 상수 | |
|---|---|
BOOLEAN |
0 (불리언 전환) |
INTEGER |
1 (숫자 정수) |
STRING |
2 (표준 텍스트 문자열) |
PASSWORD |
3 (마스킹된 비밀번호 필드) |
IP |
4 (IP 주소) |
HOST |
5 (호스트 이름) |
URL |
6 (URL 문자열) |
DOMAIN |
7 (도메인 이름) |
EMAIL |
8 (이메일 주소) |
SCRIPT |
12 (기존 스크립트 매개변수) |
NULL |
-1 (잘못된 매개변수 유형) |
class TIPCommon.data_models.ConnectorParameter
클래스 TIPCommon.data_models.ConnectorParameter(raw_param)
기반: 매개변수
ConnectorParameter는 커넥터의 개별 구성 설정을 나타냅니다. 유효성 검사 유형, 필수 요구사항과 같은 특정 메타데이터를 포함하도록 기본 매개변수 모델을 확장합니다.
속성
다음 속성은 커넥터 매개변수의 구성 세부정보 및 제약 조건에 대한 액세스를 제공합니다.
| 속성 | |
|---|---|
name |
커넥터 구성 내에서 매개변수를 식별하는 데 사용되는 고유한 이름입니다. |
value |
매개변수에 할당된 현재 값입니다. |
type |
검증 및 UI 렌더링에 사용되는 매개변수의 데이터 유형입니다. |
mode |
매개변수의 작동 모드 또는 공개 상태 설정입니다. |
is_mandatory |
커넥터를 저장하거나 실행하기 전에 이 매개변수에 값을 제공해야 하는지 여부를 나타냅니다. |
예
다음 예에서는 원시 사전을 사용하여 ConnectorParameter를 초기화하고 속성에 액세스하는 방법을 보여줍니다.
>>> from data_models import ConnectorParameter, ConnectorParamTypes
>>> p = ConnectorParameter({
'param_name': 'api_root',
'type': ConnectorParamTypes.STRING,
'param_value': '[http://foo.bar](http://foo.bar)',
'is_mandatory': True,
'mode': 0
})
>>> print(p)
ConnectorParameter(name='api_root', value='[http://foo.bar](http://foo.bar)', type=2, mode=0, is_mandatory=True)
class TIPCommon.data_models.Container
클래스 TIPCommon.data_models.Container()
기본: object
Container는 변수를 속성으로 저장하기 위한 일반적인 동적 객체 역할을 합니다. 플랫폼의 여러 구성요소 간에 임의의 데이터 컬렉션을 전달하는 데 유용합니다.
예
다음 예시에서는 컨테이너를 초기화하고 변수를 동적으로 할당하고 검색하는 방법을 보여줍니다.
>>> from data_models import Container
>>> container = Container()
>>> container.one = 1
>>> container.one
1
class TIPCommon.data_models.CreateEntity
클래스 TIPCommon.data_models.CreateEntity(case_id, alert_identifier, entity_type, entity_identifier, entity_to_connect_regex, types_to_connect=None, is_primary_link=False, is_directional=False)
기본: object
CreateEntity는 새 항목을 만들어 기존 케이스 및 알림에 연결하는 데 필요한 안내를 캡슐화합니다. 여기에는 정규식 기반 연결 및 관계 매핑을 위한 로직이 포함됩니다.
메서드
다음 메서드는 항목 생성 안내를 플랫폼 호환 형식으로 변환하는 작업을 처리합니다.
| 메서드 | |
|---|---|
to_json() |
|
속성
다음 표에서는 플랫폼 내에서 새 항목과 그 관계를 정의하는 데 사용되는 기본 속성을 강조 표시합니다.
| 속성 | |
|---|---|
case_id |
항목이 생성될 케이스의 고유 식별자입니다. |
alert_identifier |
이 항목이 연결된 알림의 식별자입니다. |
entity_type |
항목의 분류입니다. |
entity_identifier |
항목을 식별하는 특정 값 또는 이름입니다. |
entity_to_connect_regex |
이 항목에 연결할 다른 항목을 식별하는 데 사용되는 정규 표현식입니다. |
types_to_connect |
정규식을 기반으로 연결할 수 있는 항목 유형의 특정 목록입니다. |
is_primary_link |
이 연결이 항목 간의 기본 관계를 나타내는지 여부를 나타냅니다. |
is_directional |
연결에 정의된 방향 (소스에서 타겟으로)이 있는지 아니면 상호적인지 확인합니다. |
class TIPCommon.data_models.CustomField
클래스 TIPCommon.data_models.CustomField(id, display_name, description, type, scopes)
기본: object
CustomField는 플랫폼 내에서 사용자 정의 데이터 필드를 나타냅니다. 조직 요구사항에 맞게 조정된 특정 메타데이터를 추가하여 표준 데이터 모델을 확장할 수 있습니다.
메서드
다음 메서드를 사용하면 구조화된 JSON 데이터에서 맞춤 필드 객체를 재구성할 수 있습니다.
| 메서드 | |
|---|---|
from_json() |
필드 속성의 사전에서 |
속성
다음 표에는 맞춤 필드의 기본 속성과 범위 제약 조건이 강조 표시되어 있습니다.
| 속성 | |
|---|---|
id |
맞춤 필드의 고유 식별자입니다. |
display_name |
플랫폼 UI에 표시되는 사람이 읽을 수 있는 라벨입니다. |
type |
필드의 데이터 유형입니다. |
scopes |
이 필드를 사용할 수 있는 애플리케이션 영역 목록 |
class TIPCommon.data_models.CustomFieldScope
클래스 TIPCommon.data_models.CustomFieldScope(value)
기본: 열거형
CustomFieldScope은 플랫폼 계층 구조 내에서 맞춤 필드가 적용되는 유효한 타겟을 정의합니다.
메서드
다음 메서드는 범위가 지정된 객체의 경로를 확인하는 유틸리티를 제공합니다.
| 메서드 | |
|---|---|
build_parent_path() |
지정된 상위 객체 식별자의 내부 플랫폼 경로를 생성합니다. |
상수
다음 상수는 맞춤 필드에 사용할 수 있는 특정 범위를 나타냅니다.
| 상수 | |
|---|---|
ALERTS |
'Alert' |
CASE |
'Case' |
class TIPCommon.data_models.CustomFieldValue
클래스 TIPCommon.data_models.CustomFieldValue(custom_field_id, values, scope, identifier)
기본: object
CustomFieldValue는 맞춤 필드 인스턴스에 할당된 특정 데이터를 나타냅니다. 필드 정의를 사용자 또는 자동화된 프로세스에서 제공하는 실제 콘텐츠에 연결합니다.
메서드
다음 메서드는 구조화된 JSON 데이터에서 맞춤 필드 값을 재구성하는 데 도움이 됩니다.
| 메서드 | |
|---|---|
from_json() |
값 속성의 사전에서 |
속성
다음 표에서는 맞춤 필드 값의 기본 속성과 컨텍스트 식별자를 강조합니다.
| 속성 | |
|---|---|
custom_field_id |
이 값이 속한 |
values |
필드에 저장된 실제 데이터를 나타내는 문자열 목록입니다. |
scope |
이 특정 값이 적용되는 애플리케이션 영역입니다. |
identifier |
이 값을 보유하는 특정 객체의 고유 식별자입니다. |
class TIPCommon.data_models.DataAccessContext
클래스 TIPCommon.data_models.DataAccessContext(global_access, assigned_scopes)
기본: object
DataAccessContext는 사용자 또는 프로세스의 권한 및 공개 상태 제약 조건을 정의하여 실행 중에 액세스할 수 있는 데이터 범위를 결정합니다.
메서드
다음 메서드는 객체 인스턴스와 JSON 형식 간의 액세스 컨텍스트 데이터 변환을 관리합니다.
| 메서드 | |
|---|---|
from_json() |
액세스 속성의 사전에서 |
to_json() |
|
속성
다음 표에서는 컨텍스트 내에 정의된 기본 액세스 제어를 강조 표시합니다.
| 속성 | |
|---|---|
global_access |
컨텍스트에서 모든 데이터 범위에 대한 무제한 액세스를 허용하는지 여부를 나타냅니다. |
assigned_scopes |
액세스가 명시적으로 부여된 특정 범위 또는 조직 단위의 목록입니다. |
class TIPCommon.data_models.DatabaseContextType
클래스 TIPCommon.data_models.DatabaseContextType(value)
기본: 열거형
DatabaseContextType은 데이터베이스 상호작용의 운영 컨텍스트를 지정하여 플랫폼의 올바른 논리적 세그먼트에서 데이터가 유지되거나 검색되도록 합니다.
상수
다음 상수는 데이터베이스 작업이 발생하는 플랫폼의 특정 영역을 나타냅니다.
| 상수 | |
|---|---|
GLOBAL |
0 (전역 시스템 전체 컨텍스트) |
CASE |
1 (특정 보안 케이스 컨텍스트) |
ALERT |
2 (개별 알림 컨텍스트) |
JOB |
3 (예약된 작업 또는 자동화 컨텍스트) |
CONNECTOR |
4 (데이터 커넥터 컨텍스트) |
class TIPCommon.data_models.DynamicParameter
클래스 TIPCommon.data_models.DynamicParameter(key: str, value: str)
기본: object
DynamicParameter는 시스템 구성요소 간에 런타임 구성 또는 맞춤 메타데이터를 전달하는 데 사용되는 유연한 키-값 쌍을 나타냅니다.
메서드
다음 메서드는 구조화된 JSON 데이터에서 동적 매개변수의 재구성을 처리합니다.
| 메서드 | |
|---|---|
from_json() |
키 및 값 속성의 사전에서 |
속성
다음 표에서는 동적 매개변수의 속성을 설명합니다.
| 속성 | |
|---|---|
key |
매개변수의 이름 또는 식별자입니다. |
value |
키와 연결된 데이터 콘텐츠입니다. |
class TIPCommon.data_models.EmailTemplate
클래스 TIPCommon.data_models.EmailTemplate(template_type, name, content, creator_user_name, for_migration, environments, _id, creation_time_unix_time_in_ms, modification_time_unix_time_in_ms)
기본: object
EmailTemplate은 플랫폼 내 알림 및 보고에 사용되는 표준화된 커뮤니케이션 형식을 나타냅니다. 메시지 콘텐츠, 메타데이터, 환경 제약 조건을 캡슐화합니다.
메서드
다음 메서드는 이메일 템플릿의 직렬화 및 재구성을 관리합니다.
| 메서드 | |
|---|---|
from_json() |
템플릿 데이터가 포함된 사전에서 |
to_json() |
|
속성
다음 표에서는 이메일 템플릿의 기본 속성과 구조적 데이터를 강조 표시합니다.
| 속성 | |
|---|---|
content |
이메일 템플릿의 본문 텍스트 또는 HTML 구조입니다. |
environments |
이 템플릿을 사용할 수 있는 조직 환경 목록입니다. |
template_type |
템플릿의 분류 또는 카테고리입니다. |
class TIPCommon.data_models.Entity
클래스 TIPCommon.data_models.Entity(raw_data, case_id, entity_type, enriched, artifact, vulnerable, suspicious, attacker, pivot, internal, manually_created, fields)
기본: object
항목은 보안 케이스 내에서 관찰할 수 있는 특정 항목 또는 관심 객체 (예: IP 주소, 파일 해시, 사용자)를 나타냅니다. 조사에서 항목의 역할이나 위험 수준을 나타내는 원시 원격 분석과 다양한 불리언 '태그'를 모두 추적합니다.
메서드
다음 메서드는 엔티티 객체의 직렬화 및 재구성을 관리합니다.
| 메서드 | |
|---|---|
from_json() |
엔티티 원격 분석 및 플래그가 포함된 사전에서 |
to_json() |
|
속성
다음 표에서는 항목과 관련된 기본 분류 플래그와 데이터 구조를 강조 표시합니다.
| 속성 | |
|---|---|
entity_type |
항목의 카테고리입니다. |
suspicious |
엔티티가 시스템 로직 또는 외부 인텔리전스에 의해 악성일 가능성이 있는 것으로 표시되었는지 나타냅니다. |
vulnerable |
엔티티에 기존 보안 취약점이 있는 것으로 알려져 있는지 여부를 나타냅니다. |
attacker |
엔티티가 악성 활동의 소스로 식별되면 플래그가 지정됩니다. |
internal |
엔티티가 조직의 내부 네트워크 또는 인프라에 속하는지 여부를 나타냅니다. |
fields |
항목과 연결된 추가 속성 또는 풍부한 데이터 포인트 목록입니다. |
class TIPCommon.data_models.EntityCard
클래스 TIPCommon.data_models.EntityCard(identifier, entity_type, is_suspicious, linked_entities)
기본: object
EntityCard는 항목의 요약된 뷰를 나타내며 일반적으로 UI 구성요소에 사용됩니다. 항목의 식별, 유형, 다른 항목과의 관계를 단순화된 구조로 집계합니다.
메서드
다음 메서드는 엔티티 카드의 직렬화 및 재구성을 관리합니다.
| 메서드 | |
|---|---|
from_json() |
항목 요약 데이터의 딕셔너리에서 |
to_json() |
|
속성
다음 표에서는 카드 내에서 항목을 식별하고 연결하는 데 사용되는 기본 속성을 강조 표시합니다.
| 속성 | |
|---|---|
identifier |
항목을 식별하는 고유한 값 또는 이름입니다. |
entity_type |
엔티티의 분류 카테고리입니다. |
is_suspicious |
엔티티의 의심스러운 상태를 나타내는 문자열 표시기 ( |
linked_entities |
이 특정 항목 카드와 관련된 다른 항목의 식별자 목록입니다. |
class TIPCommon.data_models.EnvironmentData
클래스 TIPCommon.data_models.EnvironmentData(environment, dynamic_parameters=<factory>, base64_image=None, platform=None)
기본: object
EnvironmentData는 특정 조직 환경의 구성 및 브랜딩 정보를 캡슐화합니다. 여기에는 멀티 테넌트 또는 다중 환경 배포에 사용되는 환경별 매개변수와 시각적 애셋이 포함됩니다.
메서드
다음 메서드는 구조화된 JSON 데이터에서 환경 데이터 객체를 쉽게 만들 수 있도록 지원합니다.
| 메서드 | |
|---|---|
from_json() |
환경 속성의 사전에서 |
속성
다음 표에서는 환경과 연결된 구성 매개변수와 브랜딩 애셋을 강조 표시합니다.
| 속성 | |
|---|---|
environment |
조직 환경의 이름입니다. |
dynamic_parameters |
이 환경의 구성에 특정한 맞춤 키-값 쌍 목록입니다. |
base64_image |
환경의 로고 또는 아이콘을 나타내는 선택적 base64 인코딩 문자열입니다. |
platform |
특정 플랫폼 또는 인프라 제공업체를 나타내는 정수 식별자입니다. |
class TIPCommon.data_models.EventCard
클래스 TIPCommon.data_models.EventCard(case_id, alert_identifier, event_id, name, time, product, port, outcome, artifact_entities, fields)
기본: object
EventCard는 특정 보안 이벤트의 간결하고 시각적인 요약을 나타냅니다. 조사 대시보드 및 이벤트 대기열에서 사용할 수 있도록 타이밍, 소스 제품, 결과와 같은 가장 중요한 원격 분석을 표시하도록 설계되었습니다.
메서드
다음 메서드는 객체 인스턴스와 JSON 형식 간의 이벤트 카드 데이터 변환을 관리합니다.
| 메서드 | |
|---|---|
from_json() |
이벤트 속성의 사전에서 |
to_json() |
|
속성
다음 표에서는 이벤트 카드 내에 저장된 기본 원격 분석 및 조직 식별자를 강조 표시합니다.
| 속성 | |
|---|---|
event_id |
특정 이벤트 레코드의 고유 식별자입니다. |
time |
이벤트가 발생한 시간을 나타내는 Unix 타임스탬프입니다. |
product |
이벤트 원격 분석을 생성한 보안 제품 또는 도구입니다. |
outcome |
이벤트의 기록된 결과입니다. |
artifact_entities |
케이스의 아티팩트 역할을 하는 이벤트 원격 분석 내에서 식별된 항목 목록입니다. |
fields |
이 이벤트의 데이터 페이로드에 특정한 추가 키-값 속성의 컬렉션입니다. |
class TIPCommon.data_models.EventPropertyField
클래스 TIPCommon.data_models.EventPropertyField(order, group_name, is_integration, is_highlight, items)
기본: object
EventPropertyField는 우선순위와 그룹화로 구성된 이벤트 속성의 구조화된 컬렉션을 정의합니다. 조사 초점을 위한 중요한 필드를 강조 표시하여 텔레메트리 데이터를 분류하는 데 사용됩니다.
메서드
다음 메서드는 구조화된 JSON 데이터에서 속성 필드 객체의 재구성을 처리합니다.
| 메서드 | |
|---|---|
from_json() |
필드 속성의 사전에서 |
속성
다음 표에서는 이벤트 속성 필드를 정의하는 메타데이터 및 콘텐츠 항목을 강조 표시합니다.
| 속성 | |
|---|---|
group_name |
이 필드가 속한 논리적 그룹의 이름입니다. |
is_highlight |
이 필드가 플랫폼 UI에서 우선순위가 높은 데이터 포인트로 시각적으로 강조되어야 하는지 나타냅니다. |
items |
이 속성 그룹에 포함된 특정 데이터 항목의 목록입니다. |
class TIPCommon.data_models.FieldGroupItem
클래스 TIPCommon.data_models.FieldGroupItem(original_name, name, value)
기본: object
FieldGroupItem은 필드 그룹 내의 특정 데이터 포인트를 나타내며, 원래 소스 이름과 사람이 읽을 수 있는 표시 이름 간의 매핑을 유지합니다.
메서드
다음 메서드는 필드 그룹 항목의 직렬화 및 재구성을 관리합니다.
| 메서드 | |
|---|---|
from_json() |
JSON 딕셔너리에서 |
to_json() |
|
class TIPCommon.data_models.FieldItem
클래스 TIPCommon.data_models.FieldItem(original_name, name, value)
기본: object
FieldItem은 원시 키, 매핑된 라벨, 연결된 값을 저장하는 개별 속성의 기본 데이터 구조입니다.
메서드
| 메서드 | |
|---|---|
from_json() |
필드 속성의 사전에서 |
class TIPCommon.data_models.FieldsGroup
클래스 TIPCommon.data_models.FieldsGroup(order, group_name, is_integration, is_highlight, hide_options, items)
기본: object
FieldsGroup은 여러 필드 항목을 논리적 컬렉션으로 정리하는 컨테이너 역할을 합니다. 주로 플랫폼의 사용자 인터페이스 내에서 데이터의 레이아웃과 표시 여부를 제어하는 데 사용됩니다.
메서드
다음 메서드는 객체 인스턴스와 구조화된 JSON 간의 필드 그룹 데이터 변환을 관리합니다.
| 메서드 | |
|---|---|
from_json() |
그룹 속성의 사전에서 |
to_json() |
|
속성
다음 표에서는 그룹의 표시 동작과 콘텐츠를 정의하는 속성을 강조 표시합니다.
| 속성 | |
|---|---|
group_name |
UI에서 그룹을 식별하는 데 사용되는 라벨입니다. |
is_highlight |
그룹을 시각적으로 강조해야 하는지 여부를 결정합니다. |
items |
그룹에 포함된 특정 데이터 포인트 목록입니다. |
class TIPCommon.data_models.GoogleServiceAccount
클래스 TIPCommon.data_models.GoogleServiceAccount(account_type, project_id, private_key_id, private_key, client_email, client_id, auth_uri, token_uri, auth_provider_x509_url, client_x509_cert_url)
기본: object
GoogleServiceAccount는 서비스 계정 사용자 인증 정보의 구조화된 표현을 제공합니다. Google Cloud Google 서비스와 상호작용하는 통합의 인증 세부정보를 관리하는 데 사용됩니다.
메서드
다음 메서드는 클라이언트 라이브러리에 필요한 표준 형식으로 사용자 인증 정보 데이터를 내보내는 작업을 용이하게 합니다.
| 메서드 | |
|---|---|
to_dict() |
서비스 계정 속성을 표준 |
class TIPCommon.data_models.Insight
클래스 TIPCommon.data_models.Insight(raw_data)
기본: object
통계는 플랫폼 또는 통합에 의해 생성된 개별 분석 결과 또는 관찰을 나타냅니다. 보안 조사를 위한 추가 컨텍스트 또는 권장 작업을 제공하는 원시 데이터를 캡슐화합니다.
메서드
다음 메서드는 통계 객체의 직렬화 및 재구성을 관리합니다.
| 메서드 | |
|---|---|
from_json() |
원시 통계 원격 분석의 사전에서 |
to_json() |
|
속성
| 속성 | |
|---|---|
raw_data |
통계의 구체적인 발견 항목과 측정항목이 포함된 기본 원시 데이터 페이로드입니다. |
class TIPCommon.data_models.InstalledIntegrationInstance
클래스 TIPCommon.data_models.InstalledIntegrationInstance(instance, identifier, integration_identifier, environment_identifier, instance_name)
기본: object
InstalledIntegrationInstance는 환경 내에 배포된 통합의 구성된 특정 인스턴스를 나타냅니다. 일반 통합 정의를 특정 환경 배포 및 이름 지정에 연결합니다.
메서드
다음 메서드는 객체 인스턴스와 구조화된 JSON 간의 통합 인스턴스 데이터 변환을 관리합니다.
| 메서드 | |
|---|---|
from_json() |
JSON 데이터를 |
to_json() |
통합 인스턴스 데이터를 JSON 호환 딕셔너리 형식으로 직렬화합니다. |
속성
다음 표에서는 여러 조직 환경에서 통합을 추적하는 데 사용되는 식별자를 강조 표시합니다.
| 속성 | |
|---|---|
instance_name |
이 특정 통합 인스턴스의 사용자 정의 이름입니다. |
integration_identifier |
상위 통합의 고유 식별자입니다. |
environment_identifier |
이 인스턴스가 설치된 조직 환경의 식별자입니다. |
class TIPCommon.data_models.InternalDomain
클래스 TIPCommon.data_models.InternalDomain(alias_name, id_, domain_display_name, environments_json, creation_time_unix_time_in_ms, modification_time_unix_time_in_ms)
기본: object
InternalDomain은 조직의 내부 인프라의 일부로 인식되는 도메인 식별자를 나타냅니다. 이러한 기록은 보안 조사 중에 내부 트래픽과 외부 위협을 구분하는 데 중요합니다.
메서드
다음 메서드는 내부 도메인 레코드의 직렬화 및 재구성을 관리합니다.
| 메서드 | |
|---|---|
from_json() |
JSON 딕셔너리에서 |
to_json() |
|
속성
다음 표에서는 내부 도메인을 식별하고 분류하는 데 사용되는 속성을 강조 표시합니다.
| 속성 | |
|---|---|
domain_display_name |
기본 도메인 이름입니다. |
alias_name |
플랫폼 내에서 도메인을 식별하는 데 사용되는 대체 이름 또는 라벨입니다. |
environments_json |
이 도메인이 내부로 간주되는 환경을 나열하는 JSON 형식 문자열입니다. |
class TIPCommon.data_models.JobParamType
클래스 TIPCommon.data_models.JobParamType(value)
기본: 열거형
JobParamType은 예약된 작업 또는 자동화 작업 내에서 사용되는 매개변수에 지원되는 데이터 유형을 정의합니다. 이러한 유형은 적절한 입력 유효성 검사와 플랫폼 수준 처리를 지원합니다.
상수
다음 상수는 작업 매개변수에 사용할 수 있는 특정 데이터 유형을 나타냅니다.
| 상수 | |
|---|---|
BOOLEAN |
0 |
INTEGER |
1 |
STRING |
2 |
PASSWORD |
3 |
IP |
4 |
HOST |
5 |
URL |
6 |
DOMAIN |
7 |
EMAIL |
8 |
NULL |
-1 |
class TIPCommon.data_models.Parameter
클래스 TIPCommon.data_models.Parameter(raw_param)
기본: object
Parameter는 라이브러리의 모든 매개변수 관련 모델의 기본 기본 클래스 역할을 합니다. 원시 구성 데이터를 처리하기 위한 일관된 인터페이스를 제공합니다.
속성
다음 속성은 매개변수를 초기화하는 데 사용되는 기본 데이터에 대한 액세스를 제공합니다.
| 속성 | |
|---|---|
raw_data |
매개변수의 구성을 포함하는 원래 사전 페이로드입니다. |
예
다음 예에서는 기본 Parameter 클래스를 초기화하고 원시 데이터에 액세스하는 방법을 보여줍니다.
>>> from data_models import Parameter
>>> p = Parameter({'foo': 'bar'})
>>> print(p)
Parameter(raw_data={'foo': 'bar'})
class TIPCommon.data_models.SLA
클래스 TIPCommon.data_models.SLA(sla_expiration_time, critical_expiration_time, expiration_status, remaining_time_since_last_pause)
기본: object
SLA (서비스수준계약)는 알림의 타이밍 제약 조건과 상태를 캡슐화합니다. 처리된 일시중지 로직을 비롯해 표준 및 중요한 기한에 대한 고정밀 추적을 제공합니다.
메서드
다음 메서드는 객체 인스턴스와 구조화된 JSON 간의 SLA 데이터 변환을 관리합니다.
| 메서드 | |
|---|---|
from_json() |
JSON 딕셔너리에서 |
to_json() |
|
속성
다음 표에서는 알림 만료를 추적하는 데 사용되는 핵심 타이밍 속성을 강조 표시합니다.
| 속성 | |
|---|---|
sla_expiration_time |
표준 SLA 만료 기한을 나타내는 Unix 타임스탬프입니다. |
critical_expiration_time |
중요 SLA 만료 기한을 나타내는 Unix 타임스탬프입니다. |
expiration_status |
SLA의 현재 상태입니다. |
class TIPCommon.data_models.ScriptContext
클래스 TIPCommon.data_models.ScriptContext(target_entities: 'str' = '', case_id: 'int | str | None' = None, alert_id: 'str' = '', environment: 'str' = '', workflow_id: 'str' = '', workflow_instance_id: 'str | None' = None, parameters: 'SingleJson' = <factory>, integration_identifier: 'str' = '', integration_instance: 'str' = '', action_definition_name: 'str' = '', original_requesting_user: 'str' = '', execution_deadline_unix_time_ms: 'int' = 0, async_polling_interval_in_sec: 'int' = 0, async_total_duration_deadline: 'int' = 0, script_timeout_deadline: 'int' = 0, default_result_value: 'str' = '', use_proxy_settings: 'bool' = False, max_json_result_size: 'int' = 15, vault_settings: 'SiemplifyVault | None' = None, environment_api_key: 'str | None' = None, unique_identifier: 'str' = '', job_api_key: 'str' = '', connector_context: 'ConnectorContext | None' = None)
기본: object
ScriptContext는 스크립트 실행에 필요한 환경, 식별자, 매개변수를 제공하는 포괄적인 컨테이너입니다. 타겟 엔티티와 워크플로 ID부터 프록시 및 보관 파일 구성과 같은 보안 설정까지 모든 것을 추적합니다.
메서드
다음 메서드를 사용하면 스크립트의 실행 컨텍스트를 수정하고 직렬화할 수 있습니다.
| 메서드 | |
|---|---|
to_json() |
|
update() |
제공된 사전의 값으로 컨텍스트 속성을 업데이트합니다. |
속성
컨텍스트가 광범위하므로 다음 표에서는 가장 중요한 실행 및 환경 식별자를 강조합니다.
| 속성 | |
|---|---|
case_id |
현재 스크립트 실행과 연결된 케이스의 식별자입니다. |
workflow_id |
현재 처리 중인 워크플로의 ID입니다. |
parameters |
스크립트에 전달된 런타임 매개변수가 포함된 사전입니다. |
execution_deadline_unix_time_ms |
스크립트 실행이 종료되어야 하는 시간을 나타내는 Unix 타임스탬프입니다. |
vault_settings |
플랫폼의 보관소에 저장된 민감한 정보에 액세스하기 위한 구성 설정입니다. |
class TIPCommon.data_models.SmimeEmailConfig
클래스 TIPCommon.data_models.SmimeEmailConfig(email, private_key_b64, certificate_b64, ca_certificate_b64)
기본: object
SmimeEmailConfig는 서명이나 암호화와 같은 S/MIME 작업을 실행하는 데 필요한 암호화 애셋과 이메일 메시지를 캡슐화합니다. 원시 이메일과 base64로 인코딩된 키 및 인증서를 보유합니다.
속성
다음 표에서는 이 구성 모델에서 관리하는 암호화 구성요소를 설명합니다.
| 속성 | |
|---|---|
email |
처리할 표준 Python 이메일 메시지 객체입니다. |
private_key_b64 |
서명 또는 복호화에 사용되는 base64로 인코딩된 비공개 키입니다. |
certificate_b64 |
비공개 키와 연결된 base64로 인코딩된 공개 인증서입니다. |
ca_certificate_b64 |
신뢰 체인을 확인하는 데 사용되는 base64로 인코딩된 인증 기관 (CA) 인증서입니다. |
class TIPCommon.data_models.SmimeType
클래스 TIPCommon.data_models.SmimeType(value)
기본: 열거형
SmimeType은 S/MIME 처리의 작동 모드를 정의하여 암호화를 통해 콘텐츠를 보호하는 것과 디지털 서명을 사용하여 발신자를 검증하는 것을 구분합니다.
상수
다음 상수는 지원되는 S/MIME 메시지 유형을 나타냅니다.
| 상수 | |
|---|---|
SIGNED |
'signed' (메일이 신뢰성을 보장하기 위해 디지털 서명됨) |
ENCRYPTED |
'encrypted' (메일 본문은 기밀성을 위해 암호화됨) |
class TIPCommon.data_models.TypedContainer
클래스 TIPCommon.data_models.TypedContainer()
기본: Generic[T]
TypedContainer는 특정 유형의 데이터를 보유하도록 설계된 일반 래퍼입니다. 저장된 객체가 IDE 및 정적 분석 도구에 의해 올바르게 처리되도록 유형 힌트와 인텔리센스를 제공하여 개발자 생산성을 향상합니다.
class TIPCommon.data_models.UserDetails
클래스 TIPCommon.data_models.UserDetails(id_: int, creation_time_unix_time_in_ms: int, modification_time_unix_time_in_ms: int, permission_group: str, permission_groups: list[str], soc_roles: list[str], is_disabled: bool, login_identifier: str, first_name: str, last_name: str, permission_type: int, role: int, soc_role_id: int, soc_role_ids: list[int], email: str, user_name: str, user_type: int, identity_provider: int, provider_name: str, advanced_reports_access: int, account_state: int, last_login_time: int, previous_login_time: int, last_password_change_time: int, last_password_change_notification_time: int, login_wrong_password_count: int, is_deleted: bool, deletion_time_unix_time_in_ms: int, environments: list[str], allowed_platforms: list[int], data_access_context: [DataAccessContext](#TIPCommon.data_models.DataAccessContext), soc_role: str | None, image_base64: str | None)
기본: object
UserDetails는 인증 메타데이터, 조직 역할, 세부 데이터 액세스 권한을 포함하는 플랫폼 사용자의 전체 프로필을 제공합니다. 사용자 세션을 관리하고 역할 기반 액세스 제어 (RBAC)를 적용하는 데 필수적입니다.
메서드
다음 메서드는 사용자 프로필 데이터의 재구성 및 직렬화를 용이하게 합니다.
| 메서드 | |
|---|---|
from_json() |
사용자 속성의 JSON 딕셔너리에서 |
to_json() |
|
속성
다음 표에서는 사용자의 기본 식별 및 권한 구조를 강조합니다.
| 속성 | |
|---|---|
user_name |
로그인 및 식별에 사용되는 고유한 시스템 사용자 이름입니다. |
soc_roles |
사용자에게 할당된 SOC 역할 목록으로, 사용자의 운영 권한을 정의합니다. |
data_access_context |
사용자가 액세스할 수 있는 데이터 범위와 조직 단위를 정의하는 컨텍스트입니다. |
is_disabled |
사용자 계정의 현재 로그인 제한 여부를 나타내는 불리언 플래그입니다. |
class TIPCommon.data_models.UserProfileCard
클래스 TIPCommon.data_models.UserProfileCard(raw_data, first_name, last_name, user_name, account_state)
기본: object
UserProfileCard는 전체 세부정보가 필요하지 않은 헤더나 연락처 카드와 같은 UI 구성요소에 표시하기 위한 사용자의 프로필에 관한 간단한 요약을 제공합니다.
메서드
| 메서드 | |
|---|---|
from_json() |
기본 프로필 속성의 사전에서 |
class TIPCommon.data_models.WallData
클래스 TIPCommon.data_models.WallData(raw_data, case_id, activity_kind, activity_data_json, favorite)
기본: object
WallData는 케이스의 'Wall' 또는 타임라인의 항목을 나타냅니다. 이 모델은 조사 수명 주기 중에 발생하는 활동 로그, 메모, 시스템 작업을 추적합니다.
메서드
| 메서드 | |
|---|---|
from_json() |
벽 활동의 JSON 딕셔너리에서 |
to_json() |
|
속성
| 속성 | |
|---|---|
activity_kind |
활동의 카테고리입니다. |
activity_data_json |
활동의 구체적인 세부정보 또는 페이로드가 포함된 JSON 형식 문자열입니다. |
favorite |
활동 항목이 고정되었는지 또는 빠른 참조를 위해 즐겨찾기로 표시되었는지를 나타냅니다. |
도움이 더 필요하신가요? 커뮤니티 회원 및 Google SecOps 전문가에게 문의하여 답변을 받으세요.