Documentație

Actions

Funcții ajutătoare de acțiune expuse scripturilor CYBERQUEST prin CQ.Actions.

Prezentare generală

Spațiul de nume CQ.Actions pune la dispoziție funcțiile ajutătoare TI și SSL, destinate utilizării în scripturile CYBERQUEST.

Membri disponibili

Cale de acces	Funcție ajutătoare exportată
`CQ.Actions.TI`	`TI`
`CQ.Actions.SSL`	`SSL`

Utilizare

‎

TI

CQ.Actions.TI administrează listele de blocare Threat Intelligence. Înainte de a lansa o cerere TI, configurați gazda țintă și tokenul bearer:

CQ.Actions.TI.setHost("https://webapplication");
CQ.Actions.TI.setBearerToken("token");

Configurare și funcții ajutătoare

Metodă	Parametri	Returnează
`setHost(value)`	`value` (șir): URL-ul de bază al API-ului.	`undefined`
`getHost()`	Niciunul.	Șirul gazdei configurate. Generează o excepție dacă este nedefinit.
`setBearerToken(value)`	Șirul tokenului bearer, fără prefixul `Bearer`.	`undefined`
`validateBearerToken()`	Niciunul.	`undefined`. Generează o excepție dacă autentificarea lipsește.
`setBody(data)`	Orice valoare serializabilă în JSON.	`undefined`
`getOutput(response)`	Un obiect `HttpResponse`.	JSON parsat sau `{}`.
`addSecondsToNow(seconds)`	Numărul de secunde.	Șir dată-oră în formatul `YYYY-MM-DD HH:mm:ss`.

Operațiuni Threat Intelligence

Metodă	Parametri	Returnează
`CheckListInTI(data)`	Obiect care conține `list` și `type`.	Răspunsul API parsat sau `{}`.
`CheckAndBlockIP(data, expires, comment, list)`	O valoare sau un tablou; expirare, comentariu și listă opționale.	Răspunsul API parsat sau `{}`.
`GetBlockedIps(list)`	Numele listei, opțional.	`IntegrationHTTPResponse`, al cărui `data` este un tablou de intrări IP.
`GetBlockedDomains(list)`	Numele listei, opțional.	`IntegrationHTTPResponse`, al cărui `data` este un tablou de intrări de domenii.
`AddBlockedIps(data, expires, comment, list)`	O valoare sau un tablou; expirare, comentariu și listă opționale.	Răspunsul API parsat sau `{}`.
`AddBlockedDomains(data, expires, comment, list)`	O valoare sau un tablou; expirare, comentariu și listă opționale.	Răspunsul API parsat sau `{}`.
`RemoveBlockedIps(data)`	O valoare IP sau un tablou.	Răspunsul API parsat sau `{}`.
`RemoveBlockedDomains(data)`	O valoare de domeniu sau un tablou.	Răspunsul API parsat sau `{}`.

Pentru operațiunile de adăugare și de verificare-și-blocare, expires are valoarea implicită null, comment valoarea "", iar list valoarea null. O valoare întreagă a lui expires este interpretată ca număr de secunde față de momentul curent.

SSL

CQ.Actions.SSL validează certificatele TLS pentru una sau mai multe gazde.

CQ.Actions.SSL.validateCertificate(host);
CQ.Actions.SSL.validateCertificates(hosts);

Metodă	Parametri	Returnează
`validateCertificate(host)`	`host` (șir): numele gazdei de validat.	Obiect rezultat cu `isSuccess` și `data`.
`validateCertificates(hosts)`	`hosts` (tablou de șiruri).	`{ isSuccess, data }`, unde `data` conține câte un rezultat pentru fiecare gazdă.

În cazul metodei validateCertificate, data conține STDOUT și STDERR. Atunci când data de expirare a certificatului poate fi parsată, conține în plus expiration_date și days_difference. O intrare invalidă returnează { isSuccess: false, message }.