Modul soar_ops

TIPCommon.soar_ops.create_slo_message

TIPCommon.soar_ops.create_slo_message(slo: int, interval_days: Iterable[int], existing_comments: Iterable[str])

Mendapatkan pesan peringatan SLO berdasarkan interval waktu dan komentar yang ada.

Untuk parameter interval_days=[0, 1, 7, 14], fungsi mengirimkan pesan yang memperingatkan bahwa SLO akan dilanggar setelah jadwal berikutnya:

  • 7-14 hari hingga waktu habis masa berlaku.
  • 1-7 hari hingga waktu habis masa berlaku.
  • Saat SLO dilanggar.

Jika komentar sudah dikirim dalam interval pelanggaran saat ini, tidak ada komentar baru yang ditampilkan (None ditampilkan).

Parameter
slo int

Tanggal pelanggaran SLO dalam mikrodetik Unix (misalnya, 1_673_774_674_567)

interval_days Iterable[int]

Iterable yang berisi jumlah hari sejak peringatan pelanggaran waktu harus dikirim (misalnya, [0, 1, 3, 7, 14])

existing_comments Iterable[int]

Komentar yang ada untuk memeriksa apakah komentar sudah dikirim.

Meningkatkan

ValueError- Jika salah satu interval waktu negatif.

Hasil

Komentar akan ditampilkan jika ada. Jika tidak, None akan ditampilkan.

TIPCommon.soar_ops.get_clean_comment_body

TIPCommon.soar_ops.get_clean_comment_body(comment: str | CaseComment, prefix: str)

Menghapus awalan dari string komentar atau objek komentar.

Parameter
comment str | CaseComment

String komentar atau objek komentar untuk menghapus awalan.

prefix str

Awalan yang akan dihapus.

Meningkatkan

TypeError- Jika jenis komentar bukan str atau CaseComment.

Hasil

Komentar tanpa awalan.

Jenis hasil yang ditampilkan

str

TIPCommon.soar_ops.get_file

TIPCommon.soar_ops.get_file(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, identifier: str)→ bytes | None

Menampilkan konten file dalam byte.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.

identifier str

ID nama file beserta jalur lengkap.

Hasil

Data byte ID yang diberikan.

Jenis hasil yang ditampilkan

bytes | None

TIPCommon.soar_ops.get_secops_mode

TIPCommon.soar_ops.get_secops_mode()→ str | None

Menampilkan variabel lingkungan SECOPS_MODE.

Hasil

Variabel lingkungan SECOPS_MODE.

Jenis hasil yang ditampilkan

str | None

TIPCommon.soar_ops.get_soar_case_comments

TIPCommon.soar_ops.get_soar_case_comments(chronicle_soar: SiemplifyAction | SiemplifyJob, case_id: str | int)

Menampilkan daftar objek komentar dari kasus, menggunakan ID-nya.

Parameter
chronicle_soar SiemplifyAction | SiemplifyJob

Objek SDK.

case_id str | int

ID kasus yang komentarnya diambil.

Hasil

Daftar objek komentar.

Jenis hasil yang ditampilkan

list[base.action.CaseComment]

TIPCommon.soar_ops.get_user_by_id

TIPCommon.soar_ops.get_user_by_id(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, user_id: str)→ UserProfileCard | None

Mendapatkan objek UserProfileCard dari ID pengguna.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.

user_id str

ID pengguna, misalnya f6dc053c-58bb-4da5-95bb-739be7d297a2.

Hasil

Objek pengguna jika ditemukan; jika tidak, None.

Jenis hasil yang ditampilkan

UserProfileCard | None

TIPCommon.soar_ops.get_users_profile_cards_with_pagination

TIPCommon.soar_ops.get_users_profile_cards_with_pagination(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, search_term: str = '', page_size: int = 20, filter_by_role: bool = False, filter_disabled_users: bool = False, filter_support_users: bool = False, fetch_only_support_users: bool = False, filter_permission_types: list[int] | None = None)→ list[UserProfileCard]

Mendapatkan semua kartu profil pengguna menggunakan penomoran halaman. Ukuran halaman berfungsi sebagai batas jumlah pengguna dalam setiap iterasi.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.

search_term str

Istilah penelusuran.

Nilai defaultnya adalah ''.

page_size int

Jumlah pengguna yang akan ditampilkan.

Nilai defaultnya adalah 20.

filter_by_role bool

Tentukan apakah akan memfilter menurut peran.

Nilai defaultnya adalah False.

filter_disabled_users bool

Tentukan apakah akan memfilter pengguna yang dinonaktifkan.

Nilai defaultnya adalah False.

filter_support_users bool

Tentukan apakah akan memfilter pengguna dukungan.

Nilai defaultnya adalah False.

fetch_only_support_users bool

Menentukan apakah hanya pengguna dukungan yang akan ditampilkan.

Nilai defaultnya adalah False.

filter_permission_types list[int] | None

Daftar jenis izin filter (misalnya, 0).

Nilai defaultnya adalah None.

Hasil

Daftar semua pengguna.

Jenis hasil yang ditampilkan

list[UserProfileCard]

TIPCommon.soar_ops.is_slo_comment

TIPCommon.soar_ops.is_slo_comment(comment: str)

Memeriksa apakah komentar adalah komentar peringatan SLO.

Komentar SLO berupa peringatan SLO ("SLO akan dilanggar dalam {int} hari") atau pesan pelanggaran SLO ("SLO dilanggar").

Parameter
comment str

Komentar yang akan diperiksa.

Hasil

True jika komentar adalah komentar SLO. Jika tidak, False akan ditampilkan.

Jenis hasil yang ditampilkan

bool

TIPCommon.soar_ops.remove_prefix_from_comments

TIPCommon.soar_ops.remove_prefix_from_comments(comments: list[str], prefix: str)

Menghapus awalan (jika ada) dari daftar komentar.

Parameter
comments list[str]

Komentar untuk menghapus awalan.

prefix str

Awalan yang akan dihapus.

Hasil

Daftar semua komentar setelah awalan dihapus dari komentar tersebut

Jenis hasil yang ditampilkan

list[str]

TIPCommon.soar_ops.save_file

TIPCommon.soar_ops.save_file(chronicle_soar: SiemplifyAction | SiemplifyConnectorExecution | SiemplifyJob, path: str, name: str, content: bytes)→ bytes | None

Menyimpan file ke bucket Google Cloud atau jalur lokal.

Parameter

Parameter
chronicle_soar ChronicleSOAR

Objek Google Security Operations SOAR SDK.

path str

Jalur folder tempat file harus disimpan.

name str

Nama file yang akan disimpan.

content bytes

Konten file dalam format byte.

Hasil

Jalur ke file yang didownload.

Jenis hasil yang ditampilkan

str | None

Perlu bantuan lain? Dapatkan jawaban dari anggota Komunitas dan profesional Google SecOps.