@cryptotaxi247 / CoPilot / commits / 34cef750

mkdocs site

Taylor committed Jul 11, 2023 at 16:00 UTC 34cef750eb4bd61a3d9b5a9d7d59da8d6939fe7f

15 files changed +17258 -4650

backend/site/404.html

+47 -20

@@ -189,8 +189,8 @@

189

190

191 <li class="md-tabs__item">

192 - <a href="/alerts/" class="md-tabs__link">

193 - Alerts

192 + <a href="/wazuhindexer/" class="md-tabs__link">

193 + Wazuh-Indexer

194 </a>

195 </li>

196

@@ -201,8 +201,8 @@

201

202

203 <li class="md-tabs__item">

204 - <a href="/artifacts/" class="md-tabs__link">

205 - Artifacts

204 + <a href="/dfiriris/" class="md-tabs__link">

205 + Dfir-Iris

206 </a>

207 </li>

208

@@ -213,8 +213,8 @@

213

214

215 <li class="md-tabs__item">

216 - <a href="/cases/" class="md-tabs__link">

217 - Cases

216 + <a href="/graylog/" class="md-tabs__link">

217 + Graylog

218 </a>

219 </li>

220

@@ -225,8 +225,8 @@

225

226

227 <li class="md-tabs__item">

228 - <a href="/graylog/" class="md-tabs__link">

229 - Graylog

228 + <a href="/wazuhmanager/" class="md-tabs__link">

229 + Wazuh-Manager

230 </a>

231 </li>

232

@@ -237,8 +237,20 @@

237

238

239 <li class="md-tabs__item">

240 - <a href="/wazuhmanager/" class="md-tabs__link">

241 - Wazuh-Manager

240 + <a href="/velociraptor/" class="md-tabs__link">

241 + Velociraptor

242 + </a>

243 + </li>

244 +

245 +

246 +

247 +

248 +

249 +

250 +

251 + <li class="md-tabs__item">

252 + <a href="/shuffle/" class="md-tabs__link">

253 + Shuffle

254 </a>

255 </li>

256

@@ -330,8 +342,8 @@

342

343

344 <li class="md-nav__item">

333 - <a href="/alerts/" class="md-nav__link">

334 - Alerts

345 + <a href="/wazuhindexer/" class="md-nav__link">

346 + Wazuh-Indexer

347 </a>

348 </li>

349

@@ -345,8 +357,8 @@

357

358

359 <li class="md-nav__item">

348 - <a href="/artifacts/" class="md-nav__link">

349 - Artifacts

360 + <a href="/dfiriris/" class="md-nav__link">

361 + Dfir-Iris

362 </a>

363 </li>

364

@@ -360,8 +372,8 @@

372

373

374 <li class="md-nav__item">

363 - <a href="/cases/" class="md-nav__link">

364 - Cases

375 + <a href="/graylog/" class="md-nav__link">

376 + Graylog

377 </a>

378 </li>

379

@@ -375,8 +387,8 @@

387

388

389 <li class="md-nav__item">

378 - <a href="/graylog/" class="md-nav__link">

379 - Graylog

390 + <a href="/wazuhmanager/" class="md-nav__link">

391 + Wazuh-Manager

392 </a>

393 </li>

394

@@ -390,8 +402,23 @@

402

403

404 <li class="md-nav__item">

393 - <a href="/wazuhmanager/" class="md-nav__link">

394 - Wazuh-Manager

405 + <a href="/velociraptor/" class="md-nav__link">

406 + Velociraptor

407 + </a>

408 + </li>

409 +

410 +

411 +

412 +

413 +

414 +

415 +

416 +

417 +

418 +

419 + <li class="md-nav__item">

420 + <a href="/shuffle/" class="md-nav__link">

421 + Shuffle

422 </a>

423 </li>

424

backend/site/agents/index.html

+48 -21

@@ -12,7 +12,7 @@

12 <link rel="prev" href="../connectors/">

15 - <link rel="next" href="../alerts/">

15 + <link rel="next" href="../wazuhindexer/">

17 <link rel="icon" href="../assets/images/favicon.png">

18 <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18">

@@ -200,8 +200,8 @@

200

201

202 <li class="md-tabs__item">

203 - <a href="../alerts/" class="md-tabs__link">

204 - Alerts

203 + <a href="../wazuhindexer/" class="md-tabs__link">

204 + Wazuh-Indexer

205 </a>

206 </li>

207

@@ -212,8 +212,8 @@

212

213

214 <li class="md-tabs__item">

215 - <a href="../artifacts/" class="md-tabs__link">

216 - Artifacts

215 + <a href="../dfiriris/" class="md-tabs__link">

216 + Dfir-Iris

217 </a>

218 </li>

219

@@ -224,8 +224,8 @@

224

225

226 <li class="md-tabs__item">

227 - <a href="../cases/" class="md-tabs__link">

228 - Cases

227 + <a href="../graylog/" class="md-tabs__link">

228 + Graylog

229 </a>

230 </li>

231

@@ -236,8 +236,8 @@

236

237

238 <li class="md-tabs__item">

239 - <a href="../graylog/" class="md-tabs__link">

240 - Graylog

239 + <a href="../wazuhmanager/" class="md-tabs__link">

240 + Wazuh-Manager

241 </a>

242 </li>

243

@@ -248,8 +248,20 @@

248

249

250 <li class="md-tabs__item">

251 - <a href="../wazuhmanager/" class="md-tabs__link">

252 - Wazuh-Manager

251 + <a href="../velociraptor/" class="md-tabs__link">

252 + Velociraptor

253 + </a>

254 + </li>

255 +

256 +

257 +

258 +

259 +

260 +

261 +

262 + <li class="md-tabs__item">

263 + <a href="../shuffle/" class="md-tabs__link">

264 + Shuffle

265 </a>

266 </li>

267

@@ -631,8 +643,8 @@

643

644

645 <li class="md-nav__item">

634 - <a href="../alerts/" class="md-nav__link">

635 - Alerts

646 + <a href="../wazuhindexer/" class="md-nav__link">

647 + Wazuh-Indexer

648 </a>

649 </li>

650

@@ -646,8 +658,8 @@

658

659

660 <li class="md-nav__item">

649 - <a href="../artifacts/" class="md-nav__link">

650 - Artifacts

661 + <a href="../dfiriris/" class="md-nav__link">

662 + Dfir-Iris

663 </a>

664 </li>

665

@@ -661,8 +673,8 @@

673

674

675 <li class="md-nav__item">

664 - <a href="../cases/" class="md-nav__link">

665 - Cases

676 + <a href="../graylog/" class="md-nav__link">

677 + Graylog

678 </a>

679 </li>

680

@@ -676,8 +688,8 @@

688

689

690 <li class="md-nav__item">

679 - <a href="../graylog/" class="md-nav__link">

680 - Graylog

691 + <a href="../wazuhmanager/" class="md-nav__link">

692 + Wazuh-Manager

693 </a>

694 </li>

695

@@ -691,8 +703,23 @@

703

704

705 <li class="md-nav__item">

694 - <a href="../wazuhmanager/" class="md-nav__link">

695 - Wazuh-Manager

706 + <a href="../velociraptor/" class="md-nav__link">

707 + Velociraptor

708 + </a>

709 + </li>

710 +

711 +

712 +

713 +

714 +

715 +

716 +

717 +

718 +

719 +

720 + <li class="md-nav__item">

721 + <a href="../shuffle/" class="md-nav__link">

722 + Shuffle

723 </a>

724 </li>

725

backend/site/alerts/index.html deleted

-1398

@@ -1,1398 +0,0 @@

1 -

2 -<!doctype html>

3 -<html lang="en" class="no-js">

4 - <head>

5 -

6 - <meta charset="utf-8">

7 - <meta name="viewport" content="width=device-width,initial-scale=1">

8 -

9 -

10 -

11 -

12 - <link rel="prev" href="../agents/">

13 -

14 -

15 - <link rel="next" href="../artifacts/">

16 -

17 - <link rel="icon" href="../assets/images/favicon.png">

18 - <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18">

19 -

20 -

21 -

22 - <title>Alerts - SOCFortress CoPilot</title>

23 -

24 -

25 -

26 - <link rel="stylesheet" href="../assets/stylesheets/main.26e3688c.min.css">

27 -

28 -

29 - <link rel="stylesheet" href="../assets/stylesheets/palette.ecc896b0.min.css">

30 -

31 -

32 -

33 -

34 -

35 -

36 -

37 -

38 -

39 - <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>

40 - <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">

41 - <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>

42 -

43 -

44 -

45 - <link rel="stylesheet" href="../assets/_mkdocstrings.css">

46 -

47 - <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>

48 -

49 -

50 -

51 -

52 -

53 -

54 - </head>

55 -

56 -

57 -

58 -

59 -

60 -

61 -

62 -

63 -

64 - <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="purple">

65 -

66 -

67 -

68 - <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>

69 -

70 - <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">

71 - <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">

72 - <label class="md-overlay" for="__drawer"></label>

73 - <div data-md-component="skip">

74 -

75 -

76 - <a href="#alerts-overview" class="md-skip">

77 - Skip to content

78 - </a>

79 -

80 - </div>

81 - <div data-md-component="announce">

82 -

83 - </div>

84 -

85 -

86 -

87 -

88 -<header class="md-header" data-md-component="header">

89 - <nav class="md-header__inner md-grid" aria-label="Header">

90 - <a href=".." title="SOCFortress CoPilot" class="md-header__button md-logo" aria-label="SOCFortress CoPilot" data-md-component="logo">

91 -

92 -

93 - <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

94 -

95 - </a>

96 - <label class="md-header__button md-icon" for="__drawer">

97 - <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>

98 - </label>

99 - <div class="md-header__title" data-md-component="header-title">

100 - <div class="md-header__ellipsis">

101 - <div class="md-header__topic">

102 -

103 - SOCFortress CoPilot

104 -

105 - </div>

106 - <div class="md-header__topic" data-md-component="header-topic">

107 -

108 -

109 - Alerts

110 -

111 -

112 - </div>

113 - </div>

114 - </div>

115 -

116 -

117 - <form class="md-header__option" data-md-component="palette">

118 -

119 -

120 -

121 -

122 - <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="purple" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">

123 -

124 - <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>

125 - <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6zm0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4zM7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z"/></svg>

126 - </label>

127 -

128 -

129 -

130 -

131 -

132 - <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="teal" data-md-color-accent="lime" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">

133 -

134 - <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>

135 - <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3Z"/></svg>

136 - </label>

137 -

138 -

139 - </form>

140 -

141 -

142 -

143 -

144 -

145 - </nav>

146 -

147 -</header>

148 -

149 - <div class="md-container" data-md-component="container">

150 -

151 -

152 -

153 -

154 -

155 -<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">

156 - <div class="md-grid">

157 - <ul class="md-tabs__list">

158 -

159 -

160 -

161 -

162 -

163 -

164 - <li class="md-tabs__item">

165 - <a href=".." class="md-tabs__link">

166 - Home

167 - </a>

168 - </li>

169 -

170 -

171 -

172 -

173 -

174 -

175 -

176 - <li class="md-tabs__item">

177 - <a href="../connectors/" class="md-tabs__link">

178 - Connectors

179 - </a>

180 - </li>

181 -

182 -

183 -

184 -

185 -

186 -

187 -

188 - <li class="md-tabs__item">

189 - <a href="../agents/" class="md-tabs__link">

190 - Agents

191 - </a>

192 - </li>

193 -

194 -

195 -

196 -

197 -

198 -

199 -

200 -

201 -

202 - <li class="md-tabs__item">

203 - <a href="./" class="md-tabs__link md-tabs__link--active">

204 - Alerts

205 - </a>

206 - </li>

207 -

208 -

209 -

210 -

211 -

212 -

213 -

214 - <li class="md-tabs__item">

215 - <a href="../artifacts/" class="md-tabs__link">

216 - Artifacts

217 - </a>

218 - </li>

219 -

220 -

221 -

222 -

223 -

224 -

225 -

226 - <li class="md-tabs__item">

227 - <a href="../cases/" class="md-tabs__link">

228 - Cases

229 - </a>

230 - </li>

231 -

232 -

233 -

234 -

235 -

236 -

237 -

238 - <li class="md-tabs__item">

239 - <a href="../graylog/" class="md-tabs__link">

240 - Graylog

241 - </a>

242 - </li>

243 -

244 -

245 -

246 -

247 -

248 -

249 -

250 - <li class="md-tabs__item">

251 - <a href="../wazuhmanager/" class="md-tabs__link">

252 - Wazuh-Manager

253 - </a>

254 - </li>

255 -

256 -

257 - </ul>

258 - </div>

259 -</nav>

260 -

261 -

262 -

263 - <main class="md-main" data-md-component="main">

264 - <div class="md-main__inner md-grid">

265 -

266 -

267 -

268 - <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >

269 - <div class="md-sidebar__scrollwrap">

270 - <div class="md-sidebar__inner">

271 -

272 -

273 -

274 -

275 -

276 -

277 -

278 -<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">

279 - <label class="md-nav__title" for="__drawer">

280 - <a href=".." title="SOCFortress CoPilot" class="md-nav__button md-logo" aria-label="SOCFortress CoPilot" data-md-component="logo">

281 -

282 -

283 - <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

284 -

285 - </a>

286 - SOCFortress CoPilot

287 - </label>

288 -

289 - <ul class="md-nav__list" data-md-scrollfix>

290 -

291 -

292 -

293 -

294 -

295 -

296 -

297 -

298 - <li class="md-nav__item">

299 - <a href=".." class="md-nav__link">

300 - Home

301 - </a>

302 - </li>

303 -

304 -

305 -

306 -

307 -

308 -

309 -

310 -

311 -

312 -

313 - <li class="md-nav__item">

314 - <a href="../connectors/" class="md-nav__link">

315 - Connectors

316 - </a>

317 - </li>

318 -

319 -

320 -

321 -

322 -

323 -

324 -

325 -

326 -

327 -

328 - <li class="md-nav__item">

329 - <a href="../agents/" class="md-nav__link">

330 - Agents

331 - </a>

332 - </li>

333 -

334 -

335 -

336 -

337 -

338 -

339 -

340 -

341 -

342 -

343 -

344 -

345 - <li class="md-nav__item md-nav__item--active">

346 -

347 - <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">

348 -

349 -

350 -

351 - <label class="md-nav__link md-nav__link--active" for="__toc">

352 - Alerts

353 -

354 - </label>

355 -

356 - <a href="./" class="md-nav__link md-nav__link--active">

357 - Alerts

358 - </a>

359 -

360 -

361 -

362 -<nav class="md-nav md-nav--secondary" aria-label="Table of contents">

363 -

364 -

365 -

366 -

367 - <label class="md-nav__title" for="__toc">

368 -

369 - Table of contents

370 - </label>

371 - <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

372 -

373 - <li class="md-nav__item">

374 - <a href="#alerts-overview" class="md-nav__link">

375 - Alerts Overview

376 - </a>

377 -

378 - <nav class="md-nav" aria-label="Alerts Overview">

379 - <ul class="md-nav__list">

380 -

381 - <li class="md-nav__item">

382 - <a href="#alert-routes" class="md-nav__link">

383 - Alert Routes

384 - </a>

385 -

386 -</li>

387 -

388 - </ul>

389 - </nav>

390 -

391 -</li>

392 -

393 - <li class="md-nav__item">

394 - <a href="#app.routes.alerts" class="md-nav__link">

395 - app.routes.alerts

396 - </a>

397 -

398 -</li>

399 -

400 - <li class="md-nav__item">

401 - <a href="#app.routes.alerts.get_alerts" class="md-nav__link">

402 - get_alerts()

403 - </a>

404 -

405 - <nav class="md-nav" aria-label="get_alerts()">

406 - <ul class="md-nav__list">

407 -

408 - <li class="md-nav__item">

409 - <a href="#alert-services" class="md-nav__link">

410 - Alert Services

411 - </a>

412 -

413 -</li>

414 -

415 - </ul>

416 - </nav>

417 -

418 -</li>

419 -

420 - <li class="md-nav__item">

421 - <a href="#app.services.WazuhIndexer.alerts" class="md-nav__link">

422 - app.services.WazuhIndexer.alerts

423 - </a>

424 -

425 -</li>

426 -

427 - <li class="md-nav__item">

428 - <a href="#app.services.WazuhIndexer.alerts.AlertsService" class="md-nav__link">

429 - AlertsService

430 - </a>

431 -

432 - <nav class="md-nav" aria-label="AlertsService">

433 - <ul class="md-nav__list">

434 -

435 - <li class="md-nav__item">

436 - <a href="#app.services.WazuhIndexer.alerts.AlertsService.__init__" class="md-nav__link">

437 - __init__()

438 - </a>

439 -

440 -</li>

441 -

442 - <li class="md-nav__item">

443 - <a href="#app.services.WazuhIndexer.alerts.AlertsService.collect_alerts" class="md-nav__link">

444 - collect_alerts()

445 - </a>

446 -

447 -</li>

448 -

449 - <li class="md-nav__item">

450 - <a href="#app.services.WazuhIndexer.alerts.AlertsService.is_index_skipped" class="md-nav__link">

451 - is_index_skipped()

452 - </a>

453 -

454 -</li>

455 -

456 - </ul>

457 - </nav>

458 -

459 -</li>

460 -

461 - </ul>

462 -

463 -</nav>

464 -

465 - </li>

466 -

467 -

468 -

469 -

470 -

471 -

472 -

473 -

474 -

475 -

476 - <li class="md-nav__item">

477 - <a href="../artifacts/" class="md-nav__link">

478 - Artifacts

479 - </a>

480 - </li>

481 -

482 -

483 -

484 -

485 -

486 -

487 -

488 -

489 -

490 -

491 - <li class="md-nav__item">

492 - <a href="../cases/" class="md-nav__link">

493 - Cases

494 - </a>

495 - </li>

496 -

497 -

498 -

499 -

500 -

501 -

502 -

503 -

504 -

505 -

506 - <li class="md-nav__item">

507 - <a href="../graylog/" class="md-nav__link">

508 - Graylog

509 - </a>

510 - </li>

511 -

512 -

513 -

514 -

515 -

516 -

517 -

518 -

519 -

520 -

521 - <li class="md-nav__item">

522 - <a href="../wazuhmanager/" class="md-nav__link">

523 - Wazuh-Manager

524 - </a>

525 - </li>

526 -

527 -

528 -

529 - </ul>

530 -</nav>

531 - </div>

532 - </div>

533 - </div>

534 -

535 -

536 -

537 -

538 - <div class="md-content" data-md-component="content">

539 - <article class="md-content__inner md-typeset">

540 -

541 -

542 -

543 -

544 - <h1>Alerts</h1>

545 -

546 -<h2 id="alerts-overview">Alerts Overview</h2>

547 -<h3 id="alert-routes">Alert Routes</h3>

548 -

549 -

550 -<div class="doc doc-object doc-module">

551 -

552 -

553 -<a id="app.routes.alerts"></a>

554 - <div class="doc doc-contents first">

555 -

556 -

557 -

558 - <div class="doc doc-children">

559 -

560 -

561 -

562 -

563 -

564 -

565 -

566 -

567 -

568 -<div class="doc doc-object doc-function">

569 -

570 -

571 -

572 -<h2 id="app.routes.alerts.get_alerts" class="doc doc-heading">

573 -<code class="highlight language-python">get_alerts()</code>

574 -

575 -</h2>

576 -

577 -

578 - <div class="doc doc-contents ">

579 -

580 - Retrieves all alerts from the AlertsService.

581 -This endpoint retrieves all available alerts from the AlertsService. It does this by creating an instance of

582 -the AlertsService class and calling its <code>collect_alerts</code> method. The result is a list of all alerts currently

583 -available.

584 -

585 - Returns:

586 - <table>

587 - <thead>

588 - <tr>

589 -<th>Name</th> <th>Type</th>

590 - <th>Description</th>

591 - </tr>

592 - </thead>

593 - <tbody>

594 - <tr>

595 -<td><code>jsonify</code></td> <td>

596 - <code>jsonify</code>

597 - </td>

598 - <td>

599 - <div class="doc-md-description">

600 - A JSON response containing a list of alerts. Each item in the list is a dictionary representing an alert,

601 - </div>

602 - </td>

603 - </tr>

604 - <tr>

605 -<td></td> <td>

606 - <code>jsonify</code>

607 - </td>

608 - <td>

609 - <div class="doc-md-description">

610 - containing all its associated data.

611 - </div>

612 - </td>

613 - </tr>

614 - </tbody>

615 - </table>

616 -

617 - <details class="quote">

618 - <summary>Source code in <code>app\routes\alerts.py</code></summary>

619 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-9"> 9</a>

620 -<a href="#__codelineno-0-10">10</a>

621 -<a href="#__codelineno-0-11">11</a>

622 -<a href="#__codelineno-0-12">12</a>

623 -<a href="#__codelineno-0-13">13</a>

624 -<a href="#__codelineno-0-14">14</a>

625 -<a href="#__codelineno-0-15">15</a>

626 -<a href="#__codelineno-0-16">16</a>

627 -<a href="#__codelineno-0-17">17</a>

628 -<a href="#__codelineno-0-18">18</a>

629 -<a href="#__codelineno-0-19">19</a>

630 -<a href="#__codelineno-0-20">20</a>

631 -<a href="#__codelineno-0-21">21</a>

632 -<a href="#__codelineno-0-22">22</a>

633 -<a href="#__codelineno-0-23">23</a>

634 -<a href="#__codelineno-0-24">24</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-9" name="__codelineno-0-9"></a>@bp.route("/alerts", methods=["GET"])

635 -<a id="__codelineno-0-10" name="__codelineno-0-10"></a>def get_alerts() -> jsonify:

636 -<a id="__codelineno-0-11" name="__codelineno-0-11"></a> """

637 -<a id="__codelineno-0-12" name="__codelineno-0-12"></a> Retrieves all alerts from the AlertsService.

638 -<a id="__codelineno-0-13" name="__codelineno-0-13"></a>

639 -<a id="__codelineno-0-14" name="__codelineno-0-14"></a> This endpoint retrieves all available alerts from the AlertsService. It does this by creating an instance of

640 -<a id="__codelineno-0-15" name="__codelineno-0-15"></a> the AlertsService class and calling its `collect_alerts` method. The result is a list of all alerts currently

641 -<a id="__codelineno-0-16" name="__codelineno-0-16"></a> available.

642 -<a id="__codelineno-0-17" name="__codelineno-0-17"></a>

643 -<a id="__codelineno-0-18" name="__codelineno-0-18"></a> Returns:

644 -<a id="__codelineno-0-19" name="__codelineno-0-19"></a> jsonify: A JSON response containing a list of alerts. Each item in the list is a dictionary representing an alert,

645 -<a id="__codelineno-0-20" name="__codelineno-0-20"></a> containing all its associated data.

646 -<a id="__codelineno-0-21" name="__codelineno-0-21"></a> """

647 -<a id="__codelineno-0-22" name="__codelineno-0-22"></a> service = AlertsService()

648 -<a id="__codelineno-0-23" name="__codelineno-0-23"></a> alerts = service.collect_alerts()

649 -<a id="__codelineno-0-24" name="__codelineno-0-24"></a> return jsonify(alerts)

650 -</code></pre></div></td></tr></table></div>

651 - </details>

652 - </div>

653 -

654 -</div>

655 -

656 -

657 -

658 - </div>

659 -

660 - </div>

661 -

662 -</div>

663 -<h3 id="alert-services">Alert Services</h3>

664 -

665 -

666 -<div class="doc doc-object doc-module">

667 -

668 -

669 -<a id="app.services.WazuhIndexer.alerts"></a>

670 - <div class="doc doc-contents first">

671 -

672 -

673 -

674 - <div class="doc doc-children">

675 -

676 -

677 -

678 -

679 -

680 -

681 -

682 -

683 -<div class="doc doc-object doc-class">

684 -

685 -

686 -

687 -<h2 id="app.services.WazuhIndexer.alerts.AlertsService" class="doc doc-heading">

688 - <code>AlertsService</code>

689 -

690 -

691 -</h2>

692 -

693 -

694 - <div class="doc doc-contents ">

695 -

696 -

697 - A service class that encapsulates the logic for pulling alerts from the Wazuh-Indexer.

698 -

699 - Attributes:

700 - <table>

701 - <thead>

702 - <tr>

703 - <th>Name</th>

704 - <th>Type</th>

705 - <th>Description</th>

706 - </tr>

707 - </thead>

708 - <tbody>

709 - <tr>

710 - <td><code>connector_url</code></td>

711 - <td>

712 - <code>str</code>

713 - </td>

714 - <td>

715 - <div class="doc-md-description">

716 - The url to the Wazuh-Indexer.

717 - </div>

718 - </td>

719 - </tr>

720 - <tr>

721 - <td><code>connector_username</code></td>

722 - <td>

723 - <code>str</code>

724 - </td>

725 - <td>

726 - <div class="doc-md-description">

727 - The username for the Wazuh-Indexer.

728 - </div>

729 - </td>

730 - </tr>

731 - <tr>

732 - <td><code>connector_password</code></td>

733 - <td>

734 - <code>str</code>

735 - </td>

736 - <td>

737 - <div class="doc-md-description">

738 - The password for the Wazuh-Indexer.

739 - </div>

740 - </td>

741 - </tr>

742 - <tr>

743 - <td><code>es</code></td>

744 - <td>

745 - <code>Elasticsearch</code>

746 - </td>

747 - <td>

748 - <div class="doc-md-description">

749 - The Elasticsearch client.

750 - </div>

751 - </td>

752 - </tr>

753 - </tbody>

754 - </table>

755 -

756 -

757 - <details class="quote">

758 - <summary>Source code in <code>app\services\WazuhIndexer\alerts.py</code></summary>

759 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-9"> 9</a>

760 -<a href="#__codelineno-0-10"> 10</a>

761 -<a href="#__codelineno-0-11"> 11</a>

762 -<a href="#__codelineno-0-12"> 12</a>

763 -<a href="#__codelineno-0-13"> 13</a>

764 -<a href="#__codelineno-0-14"> 14</a>

765 -<a href="#__codelineno-0-15"> 15</a>

766 -<a href="#__codelineno-0-16"> 16</a>

767 -<a href="#__codelineno-0-17"> 17</a>

768 -<a href="#__codelineno-0-18"> 18</a>

769 -<a href="#__codelineno-0-19"> 19</a>

770 -<a href="#__codelineno-0-20"> 20</a>

771 -<a href="#__codelineno-0-21"> 21</a>

772 -<a href="#__codelineno-0-22"> 22</a>

773 -<a href="#__codelineno-0-23"> 23</a>

774 -<a href="#__codelineno-0-24"> 24</a>

775 -<a href="#__codelineno-0-25"> 25</a>

776 -<a href="#__codelineno-0-26"> 26</a>

777 -<a href="#__codelineno-0-27"> 27</a>

778 -<a href="#__codelineno-0-28"> 28</a>

779 -<a href="#__codelineno-0-29"> 29</a>

780 -<a href="#__codelineno-0-30"> 30</a>

781 -<a href="#__codelineno-0-31"> 31</a>

782 -<a href="#__codelineno-0-32"> 32</a>

783 -<a href="#__codelineno-0-33"> 33</a>

784 -<a href="#__codelineno-0-34"> 34</a>

785 -<a href="#__codelineno-0-35"> 35</a>

786 -<a href="#__codelineno-0-36"> 36</a>

787 -<a href="#__codelineno-0-37"> 37</a>

788 -<a href="#__codelineno-0-38"> 38</a>

789 -<a href="#__codelineno-0-39"> 39</a>

790 -<a href="#__codelineno-0-40"> 40</a>

791 -<a href="#__codelineno-0-41"> 41</a>

792 -<a href="#__codelineno-0-42"> 42</a>

793 -<a href="#__codelineno-0-43"> 43</a>

794 -<a href="#__codelineno-0-44"> 44</a>

795 -<a href="#__codelineno-0-45"> 45</a>

796 -<a href="#__codelineno-0-46"> 46</a>

797 -<a href="#__codelineno-0-47"> 47</a>

798 -<a href="#__codelineno-0-48"> 48</a>

799 -<a href="#__codelineno-0-49"> 49</a>

800 -<a href="#__codelineno-0-50"> 50</a>

801 -<a href="#__codelineno-0-51"> 51</a>

802 -<a href="#__codelineno-0-52"> 52</a>

803 -<a href="#__codelineno-0-53"> 53</a>

804 -<a href="#__codelineno-0-54"> 54</a>

805 -<a href="#__codelineno-0-55"> 55</a>

806 -<a href="#__codelineno-0-56"> 56</a>

807 -<a href="#__codelineno-0-57"> 57</a>

808 -<a href="#__codelineno-0-58"> 58</a>

809 -<a href="#__codelineno-0-59"> 59</a>

810 -<a href="#__codelineno-0-60"> 60</a>

811 -<a href="#__codelineno-0-61"> 61</a>

812 -<a href="#__codelineno-0-62"> 62</a>

813 -<a href="#__codelineno-0-63"> 63</a>

814 -<a href="#__codelineno-0-64"> 64</a>

815 -<a href="#__codelineno-0-65"> 65</a>

816 -<a href="#__codelineno-0-66"> 66</a>

817 -<a href="#__codelineno-0-67"> 67</a>

818 -<a href="#__codelineno-0-68"> 68</a>

819 -<a href="#__codelineno-0-69"> 69</a>

820 -<a href="#__codelineno-0-70"> 70</a>

821 -<a href="#__codelineno-0-71"> 71</a>

822 -<a href="#__codelineno-0-72"> 72</a>

823 -<a href="#__codelineno-0-73"> 73</a>

824 -<a href="#__codelineno-0-74"> 74</a>

825 -<a href="#__codelineno-0-75"> 75</a>

826 -<a href="#__codelineno-0-76"> 76</a>

827 -<a href="#__codelineno-0-77"> 77</a>

828 -<a href="#__codelineno-0-78"> 78</a>

829 -<a href="#__codelineno-0-79"> 79</a>

830 -<a href="#__codelineno-0-80"> 80</a>

831 -<a href="#__codelineno-0-81"> 81</a>

832 -<a href="#__codelineno-0-82"> 82</a>

833 -<a href="#__codelineno-0-83"> 83</a>

834 -<a href="#__codelineno-0-84"> 84</a>

835 -<a href="#__codelineno-0-85"> 85</a>

836 -<a href="#__codelineno-0-86"> 86</a>

837 -<a href="#__codelineno-0-87"> 87</a>

838 -<a href="#__codelineno-0-88"> 88</a>

839 -<a href="#__codelineno-0-89"> 89</a>

840 -<a href="#__codelineno-0-90"> 90</a>

841 -<a href="#__codelineno-0-91"> 91</a>

842 -<a href="#__codelineno-0-92"> 92</a>

843 -<a href="#__codelineno-0-93"> 93</a>

844 -<a href="#__codelineno-0-94"> 94</a>

845 -<a href="#__codelineno-0-95"> 95</a>

846 -<a href="#__codelineno-0-96"> 96</a>

847 -<a href="#__codelineno-0-97"> 97</a>

848 -<a href="#__codelineno-0-98"> 98</a>

849 -<a href="#__codelineno-0-99"> 99</a>

850 -<a href="#__codelineno-0-100">100</a>

851 -<a href="#__codelineno-0-101">101</a>

852 -<a href="#__codelineno-0-102">102</a>

853 -<a href="#__codelineno-0-103">103</a>

854 -<a href="#__codelineno-0-104">104</a>

855 -<a href="#__codelineno-0-105">105</a>

856 -<a href="#__codelineno-0-106">106</a>

857 -<a href="#__codelineno-0-107">107</a>

858 -<a href="#__codelineno-0-108">108</a>

859 -<a href="#__codelineno-0-109">109</a>

860 -<a href="#__codelineno-0-110">110</a>

861 -<a href="#__codelineno-0-111">111</a>

862 -<a href="#__codelineno-0-112">112</a>

863 -<a href="#__codelineno-0-113">113</a>

864 -<a href="#__codelineno-0-114">114</a>

865 -<a href="#__codelineno-0-115">115</a>

866 -<a href="#__codelineno-0-116">116</a>

867 -<a href="#__codelineno-0-117">117</a>

868 -<a href="#__codelineno-0-118">118</a>

869 -<a href="#__codelineno-0-119">119</a>

870 -<a href="#__codelineno-0-120">120</a>

871 -<a href="#__codelineno-0-121">121</a>

872 -<a href="#__codelineno-0-122">122</a>

873 -<a href="#__codelineno-0-123">123</a>

874 -<a href="#__codelineno-0-124">124</a>

875 -<a href="#__codelineno-0-125">125</a>

876 -<a href="#__codelineno-0-126">126</a>

877 -<a href="#__codelineno-0-127">127</a>

878 -<a href="#__codelineno-0-128">128</a>

879 -<a href="#__codelineno-0-129">129</a>

880 -<a href="#__codelineno-0-130">130</a>

881 -<a href="#__codelineno-0-131">131</a>

882 -<a href="#__codelineno-0-132">132</a>

883 -<a href="#__codelineno-0-133">133</a>

884 -<a href="#__codelineno-0-134">134</a>

885 -<a href="#__codelineno-0-135">135</a>

886 -<a href="#__codelineno-0-136">136</a>

887 -<a href="#__codelineno-0-137">137</a>

888 -<a href="#__codelineno-0-138">138</a>

889 -<a href="#__codelineno-0-139">139</a>

890 -<a href="#__codelineno-0-140">140</a>

891 -<a href="#__codelineno-0-141">141</a>

892 -<a href="#__codelineno-0-142">142</a>

893 -<a href="#__codelineno-0-143">143</a>

894 -<a href="#__codelineno-0-144">144</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-9" name="__codelineno-0-9"></a>class AlertsService:

895 -<a id="__codelineno-0-10" name="__codelineno-0-10"></a> """

896 -<a id="__codelineno-0-11" name="__codelineno-0-11"></a> A service class that encapsulates the logic for pulling alerts from the Wazuh-Indexer.

897 -<a id="__codelineno-0-12" name="__codelineno-0-12"></a>

898 -<a id="__codelineno-0-13" name="__codelineno-0-13"></a> Attributes:

899 -<a id="__codelineno-0-14" name="__codelineno-0-14"></a> connector_url (str): The url to the Wazuh-Indexer.

900 -<a id="__codelineno-0-15" name="__codelineno-0-15"></a> connector_username (str): The username for the Wazuh-Indexer.

901 -<a id="__codelineno-0-16" name="__codelineno-0-16"></a> connector_password (str): The password for the Wazuh-Indexer.

902 -<a id="__codelineno-0-17" name="__codelineno-0-17"></a> es (Elasticsearch): The Elasticsearch client.

903 -<a id="__codelineno-0-18" name="__codelineno-0-18"></a> """

904 -<a id="__codelineno-0-19" name="__codelineno-0-19"></a>

905 -<a id="__codelineno-0-20" name="__codelineno-0-20"></a> SKIP_INDEX_NAMES: Dict[str, bool] = {

906 -<a id="__codelineno-0-21" name="__codelineno-0-21"></a> "wazuh-statistics": True,

907 -<a id="__codelineno-0-22" name="__codelineno-0-22"></a> "wazuh-monitoring": True,

908 -<a id="__codelineno-0-23" name="__codelineno-0-23"></a> }

909 -<a id="__codelineno-0-24" name="__codelineno-0-24"></a>

910 -<a id="__codelineno-0-25" name="__codelineno-0-25"></a> def __init__(self):

911 -<a id="__codelineno-0-26" name="__codelineno-0-26"></a> """

912 -<a id="__codelineno-0-27" name="__codelineno-0-27"></a> Initializes the service by collecting Wazuh-Indexer details and creating an Elasticsearch client.

913 -<a id="__codelineno-0-28" name="__codelineno-0-28"></a> """

914 -<a id="__codelineno-0-29" name="__codelineno-0-29"></a> (

915 -<a id="__codelineno-0-30" name="__codelineno-0-30"></a> self.connector_url,

916 -<a id="__codelineno-0-31" name="__codelineno-0-31"></a> self.connector_username,

917 -<a id="__codelineno-0-32" name="__codelineno-0-32"></a> self.connector_password,

918 -<a id="__codelineno-0-33" name="__codelineno-0-33"></a> ) = UniversalService().collect_wazuhindexer_details("Wazuh-Indexer")

919 -<a id="__codelineno-0-34" name="__codelineno-0-34"></a> self.es = Elasticsearch(

920 -<a id="__codelineno-0-35" name="__codelineno-0-35"></a> [self.connector_url],

921 -<a id="__codelineno-0-36" name="__codelineno-0-36"></a> http_auth=(self.connector_username, self.connector_password),

922 -<a id="__codelineno-0-37" name="__codelineno-0-37"></a> verify_certs=False,

923 -<a id="__codelineno-0-38" name="__codelineno-0-38"></a> timeout=15,

924 -<a id="__codelineno-0-39" name="__codelineno-0-39"></a> max_retries=10,

925 -<a id="__codelineno-0-40" name="__codelineno-0-40"></a> retry_on_timeout=False,

926 -<a id="__codelineno-0-41" name="__codelineno-0-41"></a> )

927 -<a id="__codelineno-0-42" name="__codelineno-0-42"></a>

928 -<a id="__codelineno-0-43" name="__codelineno-0-43"></a> def is_index_skipped(self, index_name: str) -> bool:

929 -<a id="__codelineno-0-44" name="__codelineno-0-44"></a> """

930 -<a id="__codelineno-0-45" name="__codelineno-0-45"></a> Checks whether the given index name should be skipped.

931 -<a id="__codelineno-0-46" name="__codelineno-0-46"></a>

932 -<a id="__codelineno-0-47" name="__codelineno-0-47"></a> Args:

933 -<a id="__codelineno-0-48" name="__codelineno-0-48"></a> index_name (str): The name of the index.

934 -<a id="__codelineno-0-49" name="__codelineno-0-49"></a>

935 -<a id="__codelineno-0-50" name="__codelineno-0-50"></a> Returns:

936 -<a id="__codelineno-0-51" name="__codelineno-0-51"></a> bool: True if the index should be skipped, False otherwise.

937 -<a id="__codelineno-0-52" name="__codelineno-0-52"></a> """

938 -<a id="__codelineno-0-53" name="__codelineno-0-53"></a> for skipped in self.SKIP_INDEX_NAMES:

939 -<a id="__codelineno-0-54" name="__codelineno-0-54"></a> if index_name.startswith(skipped):

940 -<a id="__codelineno-0-55" name="__codelineno-0-55"></a> return True

941 -<a id="__codelineno-0-56" name="__codelineno-0-56"></a> return False

942 -<a id="__codelineno-0-57" name="__codelineno-0-57"></a>

943 -<a id="__codelineno-0-58" name="__codelineno-0-58"></a> def collect_alerts(self) -> Dict[str, object]:

944 -<a id="__codelineno-0-59" name="__codelineno-0-59"></a> """

945 -<a id="__codelineno-0-60" name="__codelineno-0-60"></a> Collects the alerts from the Wazuh-Indexer where the index name starts with "wazuh_"

946 -<a id="__codelineno-0-61" name="__codelineno-0-61"></a> and is not in the SKIP_INDEX_NAMES list.

947 -<a id="__codelineno-0-62" name="__codelineno-0-62"></a> Returns the 10 previous alerts based on the `timestamp_utc` field.

948 -<a id="__codelineno-0-63" name="__codelineno-0-63"></a>

949 -<a id="__codelineno-0-64" name="__codelineno-0-64"></a> Returns:

950 -<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Dict[str, object]: A dictionary containing success status and alerts or an error message.

951 -<a id="__codelineno-0-66" name="__codelineno-0-66"></a> """

952 -<a id="__codelineno-0-67" name="__codelineno-0-67"></a> if not all(

953 -<a id="__codelineno-0-68" name="__codelineno-0-68"></a> [self.connector_url, self.connector_username, self.connector_password],

954 -<a id="__codelineno-0-69" name="__codelineno-0-69"></a> ):

955 -<a id="__codelineno-0-70" name="__codelineno-0-70"></a> return {

956 -<a id="__codelineno-0-71" name="__codelineno-0-71"></a> "message": "Failed to collect Wazuh-Indexer details",

957 -<a id="__codelineno-0-72" name="__codelineno-0-72"></a> "success": False,

958 -<a id="__codelineno-0-73" name="__codelineno-0-73"></a> }

959 -<a id="__codelineno-0-74" name="__codelineno-0-74"></a>

960 -<a id="__codelineno-0-75" name="__codelineno-0-75"></a> indices_list = UniversalService().collect_indices()

961 -<a id="__codelineno-0-76" name="__codelineno-0-76"></a> if not indices_list["success"]:

962 -<a id="__codelineno-0-77" name="__codelineno-0-77"></a> return {"message": "Failed to collect indices", "success": False}

963 -<a id="__codelineno-0-78" name="__codelineno-0-78"></a>

964 -<a id="__codelineno-0-79" name="__codelineno-0-79"></a> alerts_summary = []

965 -<a id="__codelineno-0-80" name="__codelineno-0-80"></a> for index_name in indices_list["indices_list"]:

966 -<a id="__codelineno-0-81" name="__codelineno-0-81"></a> if not index_name.startswith("wazuh_") or self.is_index_skipped(index_name):

967 -<a id="__codelineno-0-82" name="__codelineno-0-82"></a> continue

968 -<a id="__codelineno-0-83" name="__codelineno-0-83"></a>

969 -<a id="__codelineno-0-84" name="__codelineno-0-84"></a> alerts = self._collect_alerts(index_name)

970 -<a id="__codelineno-0-85" name="__codelineno-0-85"></a> if alerts["success"] and len(alerts["alerts"]) > 0:

971 -<a id="__codelineno-0-86" name="__codelineno-0-86"></a> alerts_summary.append(

972 -<a id="__codelineno-0-87" name="__codelineno-0-87"></a> {

973 -<a id="__codelineno-0-88" name="__codelineno-0-88"></a> "index_name": index_name,

974 -<a id="__codelineno-0-89" name="__codelineno-0-89"></a> "total_alerts": len(alerts["alerts"]),

975 -<a id="__codelineno-0-90" name="__codelineno-0-90"></a> "last_10_alerts": alerts["alerts"],

976 -<a id="__codelineno-0-91" name="__codelineno-0-91"></a> },

977 -<a id="__codelineno-0-92" name="__codelineno-0-92"></a> )

978 -<a id="__codelineno-0-93" name="__codelineno-0-93"></a>

979 -<a id="__codelineno-0-94" name="__codelineno-0-94"></a> return {

980 -<a id="__codelineno-0-95" name="__codelineno-0-95"></a> "message": "Successfully collected alerts",

981 -<a id="__codelineno-0-96" name="__codelineno-0-96"></a> "success": True,

982 -<a id="__codelineno-0-97" name="__codelineno-0-97"></a> "alerts_summary": alerts_summary,

983 -<a id="__codelineno-0-98" name="__codelineno-0-98"></a> }

984 -<a id="__codelineno-0-99" name="__codelineno-0-99"></a>

985 -<a id="__codelineno-0-100" name="__codelineno-0-100"></a> def _collect_alerts(self, index_name: str) -> Dict[str, object]:

986 -<a id="__codelineno-0-101" name="__codelineno-0-101"></a> """

987 -<a id="__codelineno-0-102" name="__codelineno-0-102"></a> Elasticsearch query to get the 10 most recent alerts where the `rule_level` is 12 or higher or the

988 -<a id="__codelineno-0-103" name="__codelineno-0-103"></a> `syslog_level` field is `ALERT` and return the results in descending order by the `timestamp_utc` field.

989 -<a id="__codelineno-0-104" name="__codelineno-0-104"></a>

990 -<a id="__codelineno-0-105" name="__codelineno-0-105"></a> Args:

991 -<a id="__codelineno-0-106" name="__codelineno-0-106"></a> index_name (str): The name of the index to query.

992 -<a id="__codelineno-0-107" name="__codelineno-0-107"></a>

993 -<a id="__codelineno-0-108" name="__codelineno-0-108"></a> Returns:

994 -<a id="__codelineno-0-109" name="__codelineno-0-109"></a> Dict[str, object]: A dictionary containing success status and alerts or an error message.

995 -<a id="__codelineno-0-110" name="__codelineno-0-110"></a> """

996 -<a id="__codelineno-0-111" name="__codelineno-0-111"></a> logger.info(f"Collecting alerts from {index_name}")

997 -<a id="__codelineno-0-112" name="__codelineno-0-112"></a> query = self._build_query()

998 -<a id="__codelineno-0-113" name="__codelineno-0-113"></a> try:

999 -<a id="__codelineno-0-114" name="__codelineno-0-114"></a> alerts = self.es.search(index=index_name, body=query, size=10)

1000 -<a id="__codelineno-0-115" name="__codelineno-0-115"></a> alerts_list = [alert for alert in alerts["hits"]["hits"]]

1001 -<a id="__codelineno-0-116" name="__codelineno-0-116"></a> return {

1002 -<a id="__codelineno-0-117" name="__codelineno-0-117"></a> "message": "Successfully collected alerts",

1003 -<a id="__codelineno-0-118" name="__codelineno-0-118"></a> "success": True,

1004 -<a id="__codelineno-0-119" name="__codelineno-0-119"></a> "alerts": alerts_list,

1005 -<a id="__codelineno-0-120" name="__codelineno-0-120"></a> }

1006 -<a id="__codelineno-0-121" name="__codelineno-0-121"></a> except Exception as e:

1007 -<a id="__codelineno-0-122" name="__codelineno-0-122"></a> logger.error(f"Failed to collect alerts: {e}")

1008 -<a id="__codelineno-0-123" name="__codelineno-0-123"></a> return {"message": "Failed to collect alerts", "success": False}

1009 -<a id="__codelineno-0-124" name="__codelineno-0-124"></a>

1010 -<a id="__codelineno-0-125" name="__codelineno-0-125"></a> @staticmethod

1011 -<a id="__codelineno-0-126" name="__codelineno-0-126"></a> def _build_query() -> Dict[str, object]:

1012 -<a id="__codelineno-0-127" name="__codelineno-0-127"></a> """

1013 -<a id="__codelineno-0-128" name="__codelineno-0-128"></a> Builds the Elasticsearch query to get the 10 most recent alerts where the `rule_level` is 12 or higher or

1014 -<a id="__codelineno-0-129" name="__codelineno-0-129"></a> the `syslog_level` field is `ALERT`.

1015 -<a id="__codelineno-0-130" name="__codelineno-0-130"></a>

1016 -<a id="__codelineno-0-131" name="__codelineno-0-131"></a> Returns:

1017 -<a id="__codelineno-0-132" name="__codelineno-0-132"></a> Dict[str, object]: A dictionary representing the Elasticsearch query.

1018 -<a id="__codelineno-0-133" name="__codelineno-0-133"></a> """

1019 -<a id="__codelineno-0-134" name="__codelineno-0-134"></a> return {

1020 -<a id="__codelineno-0-135" name="__codelineno-0-135"></a> "query": {

1021 -<a id="__codelineno-0-136" name="__codelineno-0-136"></a> "bool": {

1022 -<a id="__codelineno-0-137" name="__codelineno-0-137"></a> "should": [

1023 -<a id="__codelineno-0-138" name="__codelineno-0-138"></a> {"range": {"rule_level": {"gte": 12}}},

1024 -<a id="__codelineno-0-139" name="__codelineno-0-139"></a> {"match": {"syslog_level": "ALERT"}},

1025 -<a id="__codelineno-0-140" name="__codelineno-0-140"></a> ],

1026 -<a id="__codelineno-0-141" name="__codelineno-0-141"></a> },

1027 -<a id="__codelineno-0-142" name="__codelineno-0-142"></a> },

1028 -<a id="__codelineno-0-143" name="__codelineno-0-143"></a> "sort": [{"timestamp_utc": {"order": "desc"}}],

1029 -<a id="__codelineno-0-144" name="__codelineno-0-144"></a> }

1030 -</code></pre></div></td></tr></table></div>

1031 - </details>

1032 -

1033 -

1034 -

1035 - <div class="doc doc-children">

1036 -

1037 -

1038 -

1039 -

1040 -

1041 -

1042 -

1043 -

1044 -

1045 -<div class="doc doc-object doc-function">

1046 -

1047 -

1048 -

1049 -<h3 id="app.services.WazuhIndexer.alerts.AlertsService.__init__" class="doc doc-heading">

1050 -<code class="highlight language-python">__init__()</code>

1051 -

1052 -</h3>

1053 -

1054 -

1055 - <div class="doc doc-contents ">

1056 -

1057 - Initializes the service by collecting Wazuh-Indexer details and creating an Elasticsearch client.

1058 -

1059 - <details class="quote">

1060 - <summary>Source code in <code>app\services\WazuhIndexer\alerts.py</code></summary>

1061 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-25">25</a>

1062 -<a href="#__codelineno-0-26">26</a>

1063 -<a href="#__codelineno-0-27">27</a>

1064 -<a href="#__codelineno-0-28">28</a>

1065 -<a href="#__codelineno-0-29">29</a>

1066 -<a href="#__codelineno-0-30">30</a>

1067 -<a href="#__codelineno-0-31">31</a>

1068 -<a href="#__codelineno-0-32">32</a>

1069 -<a href="#__codelineno-0-33">33</a>

1070 -<a href="#__codelineno-0-34">34</a>

1071 -<a href="#__codelineno-0-35">35</a>

1072 -<a href="#__codelineno-0-36">36</a>

1073 -<a href="#__codelineno-0-37">37</a>

1074 -<a href="#__codelineno-0-38">38</a>

1075 -<a href="#__codelineno-0-39">39</a>

1076 -<a href="#__codelineno-0-40">40</a>

1077 -<a href="#__codelineno-0-41">41</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-25" name="__codelineno-0-25"></a>def __init__(self):

1078 -<a id="__codelineno-0-26" name="__codelineno-0-26"></a> """

1079 -<a id="__codelineno-0-27" name="__codelineno-0-27"></a> Initializes the service by collecting Wazuh-Indexer details and creating an Elasticsearch client.

1080 -<a id="__codelineno-0-28" name="__codelineno-0-28"></a> """

1081 -<a id="__codelineno-0-29" name="__codelineno-0-29"></a> (

1082 -<a id="__codelineno-0-30" name="__codelineno-0-30"></a> self.connector_url,

1083 -<a id="__codelineno-0-31" name="__codelineno-0-31"></a> self.connector_username,

1084 -<a id="__codelineno-0-32" name="__codelineno-0-32"></a> self.connector_password,

1085 -<a id="__codelineno-0-33" name="__codelineno-0-33"></a> ) = UniversalService().collect_wazuhindexer_details("Wazuh-Indexer")

1086 -<a id="__codelineno-0-34" name="__codelineno-0-34"></a> self.es = Elasticsearch(

1087 -<a id="__codelineno-0-35" name="__codelineno-0-35"></a> [self.connector_url],

1088 -<a id="__codelineno-0-36" name="__codelineno-0-36"></a> http_auth=(self.connector_username, self.connector_password),

1089 -<a id="__codelineno-0-37" name="__codelineno-0-37"></a> verify_certs=False,

1090 -<a id="__codelineno-0-38" name="__codelineno-0-38"></a> timeout=15,

1091 -<a id="__codelineno-0-39" name="__codelineno-0-39"></a> max_retries=10,

1092 -<a id="__codelineno-0-40" name="__codelineno-0-40"></a> retry_on_timeout=False,

1093 -<a id="__codelineno-0-41" name="__codelineno-0-41"></a> )

1094 -</code></pre></div></td></tr></table></div>

1095 - </details>

1096 - </div>

1097 -

1098 -</div>

1099 -

1100 -<div class="doc doc-object doc-function">

1101 -

1102 -

1103 -

1104 -<h3 id="app.services.WazuhIndexer.alerts.AlertsService.collect_alerts" class="doc doc-heading">

1105 -<code class="highlight language-python">collect_alerts()</code>

1106 -

1107 -</h3>

1108 -

1109 -

1110 - <div class="doc doc-contents ">

1111 -

1112 - Collects the alerts from the Wazuh-Indexer where the index name starts with "wazuh_"

1113 -and is not in the SKIP_INDEX_NAMES list.

1114 -Returns the 10 previous alerts based on the <code>timestamp_utc</code> field.

1115 -

1116 - Returns:

1117 - <table>

1118 - <thead>

1119 - <tr>

1120 - <th>Type</th>

1121 - <th>Description</th>

1122 - </tr>

1123 - </thead>

1124 - <tbody>

1125 - <tr>

1126 - <td>

1127 - <code>Dict[str, object]</code>

1128 - </td>

1129 - <td>

1130 - <div class="doc-md-description">

1131 - Dict[str, object]: A dictionary containing success status and alerts or an error message.

1132 - </div>

1133 - </td>

1134 - </tr>

1135 - </tbody>

1136 - </table>

1137 -

1138 - <details class="quote">

1139 - <summary>Source code in <code>app\services\WazuhIndexer\alerts.py</code></summary>

1140 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-58">58</a>

1141 -<a href="#__codelineno-0-59">59</a>

1142 -<a href="#__codelineno-0-60">60</a>

1143 -<a href="#__codelineno-0-61">61</a>

1144 -<a href="#__codelineno-0-62">62</a>

1145 -<a href="#__codelineno-0-63">63</a>

1146 -<a href="#__codelineno-0-64">64</a>

1147 -<a href="#__codelineno-0-65">65</a>

1148 -<a href="#__codelineno-0-66">66</a>

1149 -<a href="#__codelineno-0-67">67</a>

1150 -<a href="#__codelineno-0-68">68</a>

1151 -<a href="#__codelineno-0-69">69</a>

1152 -<a href="#__codelineno-0-70">70</a>

1153 -<a href="#__codelineno-0-71">71</a>

1154 -<a href="#__codelineno-0-72">72</a>

1155 -<a href="#__codelineno-0-73">73</a>

1156 -<a href="#__codelineno-0-74">74</a>

1157 -<a href="#__codelineno-0-75">75</a>

1158 -<a href="#__codelineno-0-76">76</a>

1159 -<a href="#__codelineno-0-77">77</a>

1160 -<a href="#__codelineno-0-78">78</a>

1161 -<a href="#__codelineno-0-79">79</a>

1162 -<a href="#__codelineno-0-80">80</a>

1163 -<a href="#__codelineno-0-81">81</a>

1164 -<a href="#__codelineno-0-82">82</a>

1165 -<a href="#__codelineno-0-83">83</a>

1166 -<a href="#__codelineno-0-84">84</a>

1167 -<a href="#__codelineno-0-85">85</a>

1168 -<a href="#__codelineno-0-86">86</a>

1169 -<a href="#__codelineno-0-87">87</a>

1170 -<a href="#__codelineno-0-88">88</a>

1171 -<a href="#__codelineno-0-89">89</a>

1172 -<a href="#__codelineno-0-90">90</a>

1173 -<a href="#__codelineno-0-91">91</a>

1174 -<a href="#__codelineno-0-92">92</a>

1175 -<a href="#__codelineno-0-93">93</a>

1176 -<a href="#__codelineno-0-94">94</a>

1177 -<a href="#__codelineno-0-95">95</a>

1178 -<a href="#__codelineno-0-96">96</a>

1179 -<a href="#__codelineno-0-97">97</a>

1180 -<a href="#__codelineno-0-98">98</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-58" name="__codelineno-0-58"></a>def collect_alerts(self) -> Dict[str, object]:

1181 -<a id="__codelineno-0-59" name="__codelineno-0-59"></a> """

1182 -<a id="__codelineno-0-60" name="__codelineno-0-60"></a> Collects the alerts from the Wazuh-Indexer where the index name starts with "wazuh_"

1183 -<a id="__codelineno-0-61" name="__codelineno-0-61"></a> and is not in the SKIP_INDEX_NAMES list.

1184 -<a id="__codelineno-0-62" name="__codelineno-0-62"></a> Returns the 10 previous alerts based on the `timestamp_utc` field.

1185 -<a id="__codelineno-0-63" name="__codelineno-0-63"></a>

1186 -<a id="__codelineno-0-64" name="__codelineno-0-64"></a> Returns:

1187 -<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Dict[str, object]: A dictionary containing success status and alerts or an error message.

1188 -<a id="__codelineno-0-66" name="__codelineno-0-66"></a> """

1189 -<a id="__codelineno-0-67" name="__codelineno-0-67"></a> if not all(

1190 -<a id="__codelineno-0-68" name="__codelineno-0-68"></a> [self.connector_url, self.connector_username, self.connector_password],

1191 -<a id="__codelineno-0-69" name="__codelineno-0-69"></a> ):

1192 -<a id="__codelineno-0-70" name="__codelineno-0-70"></a> return {

1193 -<a id="__codelineno-0-71" name="__codelineno-0-71"></a> "message": "Failed to collect Wazuh-Indexer details",

1194 -<a id="__codelineno-0-72" name="__codelineno-0-72"></a> "success": False,

1195 -<a id="__codelineno-0-73" name="__codelineno-0-73"></a> }

1196 -<a id="__codelineno-0-74" name="__codelineno-0-74"></a>

1197 -<a id="__codelineno-0-75" name="__codelineno-0-75"></a> indices_list = UniversalService().collect_indices()

1198 -<a id="__codelineno-0-76" name="__codelineno-0-76"></a> if not indices_list["success"]:

1199 -<a id="__codelineno-0-77" name="__codelineno-0-77"></a> return {"message": "Failed to collect indices", "success": False}

1200 -<a id="__codelineno-0-78" name="__codelineno-0-78"></a>

1201 -<a id="__codelineno-0-79" name="__codelineno-0-79"></a> alerts_summary = []

1202 -<a id="__codelineno-0-80" name="__codelineno-0-80"></a> for index_name in indices_list["indices_list"]:

1203 -<a id="__codelineno-0-81" name="__codelineno-0-81"></a> if not index_name.startswith("wazuh_") or self.is_index_skipped(index_name):

1204 -<a id="__codelineno-0-82" name="__codelineno-0-82"></a> continue

1205 -<a id="__codelineno-0-83" name="__codelineno-0-83"></a>

1206 -<a id="__codelineno-0-84" name="__codelineno-0-84"></a> alerts = self._collect_alerts(index_name)

1207 -<a id="__codelineno-0-85" name="__codelineno-0-85"></a> if alerts["success"] and len(alerts["alerts"]) > 0:

1208 -<a id="__codelineno-0-86" name="__codelineno-0-86"></a> alerts_summary.append(

1209 -<a id="__codelineno-0-87" name="__codelineno-0-87"></a> {

1210 -<a id="__codelineno-0-88" name="__codelineno-0-88"></a> "index_name": index_name,

1211 -<a id="__codelineno-0-89" name="__codelineno-0-89"></a> "total_alerts": len(alerts["alerts"]),

1212 -<a id="__codelineno-0-90" name="__codelineno-0-90"></a> "last_10_alerts": alerts["alerts"],

1213 -<a id="__codelineno-0-91" name="__codelineno-0-91"></a> },

1214 -<a id="__codelineno-0-92" name="__codelineno-0-92"></a> )

1215 -<a id="__codelineno-0-93" name="__codelineno-0-93"></a>

1216 -<a id="__codelineno-0-94" name="__codelineno-0-94"></a> return {

1217 -<a id="__codelineno-0-95" name="__codelineno-0-95"></a> "message": "Successfully collected alerts",

1218 -<a id="__codelineno-0-96" name="__codelineno-0-96"></a> "success": True,

1219 -<a id="__codelineno-0-97" name="__codelineno-0-97"></a> "alerts_summary": alerts_summary,

1220 -<a id="__codelineno-0-98" name="__codelineno-0-98"></a> }

1221 -</code></pre></div></td></tr></table></div>

1222 - </details>

1223 - </div>

1224 -

1225 -</div>

1226 -

1227 -<div class="doc doc-object doc-function">

1228 -

1229 -

1230 -

1231 -<h3 id="app.services.WazuhIndexer.alerts.AlertsService.is_index_skipped" class="doc doc-heading">

1232 -<code class="highlight language-python">is_index_skipped(index_name)</code>

1233 -

1234 -</h3>

1235 -

1236 -

1237 - <div class="doc doc-contents ">

1238 -

1239 - Checks whether the given index name should be skipped.

1240 -

1241 - Parameters:

1242 - <table>

1243 - <thead>

1244 - <tr>

1245 - <th>Name</th>

1246 - <th>Type</th>

1247 - <th>Description</th>

1248 - <th>Default</th>

1249 - </tr>

1250 - </thead>

1251 - <tbody>

1252 - <tr>

1253 - <td><code>index_name</code></td>

1254 - <td>

1255 - <code>str</code>

1256 - </td>

1257 - <td>

1258 - <div class="doc-md-description">

1259 - The name of the index.

1260 - </div>

1261 - </td>

1262 - <td>

1263 - required

1264 - </td>

1265 - </tr>

1266 - </tbody>

1267 - </table>

1268 -

1269 - Returns:

1270 - <table>

1271 - <thead>

1272 - <tr>

1273 -<th>Name</th> <th>Type</th>

1274 - <th>Description</th>

1275 - </tr>

1276 - </thead>

1277 - <tbody>

1278 - <tr>

1279 -<td><code>bool</code></td> <td>

1280 - <code>bool</code>

1281 - </td>

1282 - <td>

1283 - <div class="doc-md-description">

1284 - True if the index should be skipped, False otherwise.

1285 - </div>

1286 - </td>

1287 - </tr>

1288 - </tbody>

1289 - </table>

1290 -

1291 - <details class="quote">

1292 - <summary>Source code in <code>app\services\WazuhIndexer\alerts.py</code></summary>

1293 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-43">43</a>

1294 -<a href="#__codelineno-0-44">44</a>

1295 -<a href="#__codelineno-0-45">45</a>

1296 -<a href="#__codelineno-0-46">46</a>

1297 -<a href="#__codelineno-0-47">47</a>

1298 -<a href="#__codelineno-0-48">48</a>

1299 -<a href="#__codelineno-0-49">49</a>

1300 -<a href="#__codelineno-0-50">50</a>

1301 -<a href="#__codelineno-0-51">51</a>

1302 -<a href="#__codelineno-0-52">52</a>

1303 -<a href="#__codelineno-0-53">53</a>

1304 -<a href="#__codelineno-0-54">54</a>

1305 -<a href="#__codelineno-0-55">55</a>

1306 -<a href="#__codelineno-0-56">56</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-43" name="__codelineno-0-43"></a>def is_index_skipped(self, index_name: str) -> bool:

1307 -<a id="__codelineno-0-44" name="__codelineno-0-44"></a> """

1308 -<a id="__codelineno-0-45" name="__codelineno-0-45"></a> Checks whether the given index name should be skipped.

1309 -<a id="__codelineno-0-46" name="__codelineno-0-46"></a>

1310 -<a id="__codelineno-0-47" name="__codelineno-0-47"></a> Args:

1311 -<a id="__codelineno-0-48" name="__codelineno-0-48"></a> index_name (str): The name of the index.

1312 -<a id="__codelineno-0-49" name="__codelineno-0-49"></a>

1313 -<a id="__codelineno-0-50" name="__codelineno-0-50"></a> Returns:

1314 -<a id="__codelineno-0-51" name="__codelineno-0-51"></a> bool: True if the index should be skipped, False otherwise.

1315 -<a id="__codelineno-0-52" name="__codelineno-0-52"></a> """

1316 -<a id="__codelineno-0-53" name="__codelineno-0-53"></a> for skipped in self.SKIP_INDEX_NAMES:

1317 -<a id="__codelineno-0-54" name="__codelineno-0-54"></a> if index_name.startswith(skipped):

1318 -<a id="__codelineno-0-55" name="__codelineno-0-55"></a> return True

1319 -<a id="__codelineno-0-56" name="__codelineno-0-56"></a> return False

1320 -</code></pre></div></td></tr></table></div>

1321 - </details>

1322 - </div>

1323 -

1324 -</div>

1325 -

1326 -

1327 -

1328 - </div>

1329 -

1330 - </div>

1331 -

1332 -</div>

1333 -

1334 -

1335 -

1336 -

1337 - </div>

1338 -

1339 - </div>

1340 -

1341 -</div>

1342 -

1343 -

1344 -

1345 -

1346 -

1347 -

1348 - </article>

1349 - </div>

1350 -

1351 -

1352 - <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>

1353 -

1354 - </div>

1355 -

1356 - <button type="button" class="md-top md-icon" data-md-component="top" hidden>

1357 - <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg>

1358 - Back to top

1359 - </button>

1360 -

1361 - </main>

1362 -

1363 - <footer class="md-footer">

1364 -

1365 - <div class="md-footer-meta md-typeset">

1366 - <div class="md-footer-meta__inner md-grid">

1367 - <div class="md-copyright">

1368 -

1369 - <div class="md-copyright__highlight">

1371 -

1372 - </div>

1373 -

1374 -

1375 - Made with

1376 - <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">

1377 - Material for MkDocs

1378 - </a>

1379 -

1380 -</div>

1381 -

1382 - </div>

1383 - </div>

1384 -</footer>

1385 -

1386 - </div>

1387 - <div class="md-dialog" data-md-component="dialog">

1388 - <div class="md-dialog__inner md-typeset"></div>

1389 - </div>

1390 -

1391 - <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.sections", "toc.integrate", "navigation.top", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy"], "search": "../assets/javascripts/workers/search.74e28a9f.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>

1392 -

1393 -

1394 - <script src="../assets/javascripts/bundle.220ee61c.min.js"></script>

1395 -

1396 -

1397 - </body>

1398 -</html>

\ No newline at end of file

backend/site/cases/index.html deleted

-2127

@@ -1,2127 +0,0 @@

1 -

2 -<!doctype html>

3 -<html lang="en" class="no-js">

4 - <head>

5 -

6 - <meta charset="utf-8">

7 - <meta name="viewport" content="width=device-width,initial-scale=1">

8 -

9 -

10 -

11 -

12 - <link rel="prev" href="../artifacts/">

13 -

14 -

15 - <link rel="next" href="../graylog/">

16 -

17 - <link rel="icon" href="../assets/images/favicon.png">

18 - <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18">

19 -

20 -

21 -

22 - <title>Cases - SOCFortress CoPilot</title>

23 -

24 -

25 -

26 - <link rel="stylesheet" href="../assets/stylesheets/main.26e3688c.min.css">

27 -

28 -

29 - <link rel="stylesheet" href="../assets/stylesheets/palette.ecc896b0.min.css">

30 -

31 -

32 -

33 -

34 -

35 -

36 -

37 -

38 -

39 - <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>

40 - <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">

41 - <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>

42 -

43 -

44 -

45 - <link rel="stylesheet" href="../assets/_mkdocstrings.css">

46 -

48 -

49 -

50 -

51 -

52 -

53 -

54 - </head>

55 -

56 -

57 -

58 -

59 -

60 -

61 -

62 -

63 -

64 - <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="purple">

65 -

66 -

67 -

69 -

70 - <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">

71 - <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">

72 - <label class="md-overlay" for="__drawer"></label>

73 - <div data-md-component="skip">

74 -

75 -

76 - <a href="#cases-overview" class="md-skip">

77 - Skip to content

78 - </a>

79 -

80 - </div>

81 - <div data-md-component="announce">

82 -

83 - </div>

84 -

85 -

86 -

87 -

88 -<header class="md-header" data-md-component="header">

89 - <nav class="md-header__inner md-grid" aria-label="Header">

90 - <a href=".." title="SOCFortress CoPilot" class="md-header__button md-logo" aria-label="SOCFortress CoPilot" data-md-component="logo">

91 -

92 -

94 -

95 - </a>

96 - <label class="md-header__button md-icon" for="__drawer">

97 - <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>

98 - </label>

99 - <div class="md-header__title" data-md-component="header-title">

100 - <div class="md-header__ellipsis">

101 - <div class="md-header__topic">

102 -

103 - SOCFortress CoPilot

104 -

105 - </div>

106 - <div class="md-header__topic" data-md-component="header-topic">

107 -

108 -

109 - Cases

110 -

111 -

112 - </div>

113 - </div>

114 - </div>

115 -

116 -

117 - <form class="md-header__option" data-md-component="palette">

118 -

119 -

120 -

121 -

123 -

124 - <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>

126 - </label>

127 -

128 -

129 -

130 -

131 -

133 -

134 - <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>

136 - </label>

137 -

138 -

139 - </form>

140 -

141 -

142 -

143 -

144 -

145 - </nav>

146 -

147 -</header>

148 -

149 - <div class="md-container" data-md-component="container">

150 -

151 -

152 -

153 -

154 -

155 -<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">

156 - <div class="md-grid">

157 - <ul class="md-tabs__list">

158 -

159 -

160 -

161 -

162 -

163 -

164 - <li class="md-tabs__item">

165 - <a href=".." class="md-tabs__link">

166 - Home

167 - </a>

168 - </li>

169 -

170 -

171 -

172 -

173 -

174 -

175 -

176 - <li class="md-tabs__item">

177 - <a href="../connectors/" class="md-tabs__link">

178 - Connectors

179 - </a>

180 - </li>

181 -

182 -

183 -

184 -

185 -

186 -

187 -

188 - <li class="md-tabs__item">

189 - <a href="../agents/" class="md-tabs__link">

190 - Agents

191 - </a>

192 - </li>

193 -

194 -

195 -

196 -

197 -

198 -

199 -

200 - <li class="md-tabs__item">

201 - <a href="../alerts/" class="md-tabs__link">

202 - Alerts

203 - </a>

204 - </li>

205 -

206 -

207 -

208 -

209 -

210 -

211 -

212 - <li class="md-tabs__item">

213 - <a href="../artifacts/" class="md-tabs__link">

214 - Artifacts

215 - </a>

216 - </li>

217 -

218 -

219 -

220 -

221 -

222 -

223 -

224 -

225 -

226 - <li class="md-tabs__item">

227 - <a href="./" class="md-tabs__link md-tabs__link--active">

228 - Cases

229 - </a>

230 - </li>

231 -

232 -

233 -

234 -

235 -

236 -

237 -

238 - <li class="md-tabs__item">

239 - <a href="../graylog/" class="md-tabs__link">

240 - Graylog

241 - </a>

242 - </li>

243 -

244 -

245 -

246 -

247 -

248 -

249 -

250 - <li class="md-tabs__item">

251 - <a href="../wazuhmanager/" class="md-tabs__link">

252 - Wazuh-Manager

253 - </a>

254 - </li>

255 -

256 -

257 - </ul>

258 - </div>

259 -</nav>

260 -

261 -

262 -

263 - <main class="md-main" data-md-component="main">

264 - <div class="md-main__inner md-grid">

265 -

266 -

267 -

268 - <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >

269 - <div class="md-sidebar__scrollwrap">

270 - <div class="md-sidebar__inner">

271 -

272 -

273 -

274 -

275 -

276 -

277 -

278 -<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">

279 - <label class="md-nav__title" for="__drawer">

280 - <a href=".." title="SOCFortress CoPilot" class="md-nav__button md-logo" aria-label="SOCFortress CoPilot" data-md-component="logo">

281 -

282 -

284 -

285 - </a>

286 - SOCFortress CoPilot

287 - </label>

288 -

289 - <ul class="md-nav__list" data-md-scrollfix>

290 -

291 -

292 -

293 -

294 -

295 -

296 -

297 -

298 - <li class="md-nav__item">

299 - <a href=".." class="md-nav__link">

300 - Home

301 - </a>

302 - </li>

303 -

304 -

305 -

306 -

307 -

308 -

309 -

310 -

311 -

312 -

313 - <li class="md-nav__item">

314 - <a href="../connectors/" class="md-nav__link">

315 - Connectors

316 - </a>

317 - </li>

318 -

319 -

320 -

321 -

322 -

323 -

324 -

325 -

326 -

327 -

328 - <li class="md-nav__item">

329 - <a href="../agents/" class="md-nav__link">

330 - Agents

331 - </a>

332 - </li>

333 -

334 -

335 -

336 -

337 -

338 -

339 -

340 -

341 -

342 -

343 - <li class="md-nav__item">

344 - <a href="../alerts/" class="md-nav__link">

345 - Alerts

346 - </a>

347 - </li>

348 -

349 -

350 -

351 -

352 -

353 -

354 -

355 -

356 -

357 -

358 - <li class="md-nav__item">

359 - <a href="../artifacts/" class="md-nav__link">

360 - Artifacts

361 - </a>

362 - </li>

363 -

364 -

365 -

366 -

367 -

368 -

369 -

370 -

371 -

372 -

373 -

374 -

375 - <li class="md-nav__item md-nav__item--active">

376 -

377 - <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">

378 -

379 -

380 -

381 - <label class="md-nav__link md-nav__link--active" for="__toc">

382 - Cases

383 -

384 - </label>

385 -

386 - <a href="./" class="md-nav__link md-nav__link--active">

387 - Cases

388 - </a>

389 -

390 -

391 -

392 -<nav class="md-nav md-nav--secondary" aria-label="Table of contents">

393 -

394 -

395 -

396 -

397 - <label class="md-nav__title" for="__toc">

398 -

399 - Table of contents

400 - </label>

401 - <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

402 -

403 - <li class="md-nav__item">

404 - <a href="#cases-overview" class="md-nav__link">

405 - Cases Overview

406 - </a>

407 -

408 - <nav class="md-nav" aria-label="Cases Overview">

409 - <ul class="md-nav__list">

410 -

411 - <li class="md-nav__item">

412 - <a href="#cases-model" class="md-nav__link">

413 - Cases Model

414 - </a>

415 -

416 -</li>

417 -

418 - </ul>

419 - </nav>

420 -

421 -</li>

422 -

423 - <li class="md-nav__item">

424 - <a href="#app.models.cases" class="md-nav__link">

425 - app.models.cases

426 - </a>

427 -

428 -</li>

429 -

430 - <li class="md-nav__item">

431 - <a href="#app.models.cases.Case" class="md-nav__link">

432 - Case

433 - </a>

434 -

435 - <nav class="md-nav" aria-label="Case">

436 - <ul class="md-nav__list">

437 -

438 - <li class="md-nav__item">

439 - <a href="#app.models.cases.Case.__init__" class="md-nav__link">

440 - __init__()

441 - </a>

442 -

443 -</li>

444 -

445 - <li class="md-nav__item">

446 - <a href="#app.models.cases.Case.__repr__" class="md-nav__link">

447 - __repr__()

448 - </a>

449 -

450 -</li>

451 -

452 - </ul>

453 - </nav>

454 -

455 -</li>

456 -

457 - <li class="md-nav__item">

458 - <a href="#app.models.cases.CaseSchema" class="md-nav__link">

459 - CaseSchema

460 - </a>

461 -

462 - <nav class="md-nav" aria-label="CaseSchema">

463 - <ul class="md-nav__list">

464 -

465 - <li class="md-nav__item">

466 - <a href="#app.models.cases.CaseSchema.Meta" class="md-nav__link">

467 - Meta

468 - </a>

469 -

470 -</li>

471 -

472 - <li class="md-nav__item">

473 - <a href="#cases-routes" class="md-nav__link">

474 - Cases Routes

475 - </a>

476 -

477 -</li>

478 -

479 - </ul>

480 - </nav>

481 -

482 -</li>

483 -

484 - <li class="md-nav__item">

485 - <a href="#app.routes.dfir_iris" class="md-nav__link">

486 - app.routes.dfir_iris

487 - </a>

488 -

489 -</li>

490 -

491 - <li class="md-nav__item">

492 - <a href="#app.routes.dfir_iris.create_case_note" class="md-nav__link">

493 - create_case_note()

494 - </a>

495 -

496 -</li>

497 -

498 - <li class="md-nav__item">

499 - <a href="#app.routes.dfir_iris.get_alerts" class="md-nav__link">

500 - get_alerts()

501 - </a>

502 -

503 -</li>

504 -

505 - <li class="md-nav__item">

506 - <a href="#app.routes.dfir_iris.get_case" class="md-nav__link">

507 - get_case()

508 - </a>

509 -

510 -</li>

511 -

512 - <li class="md-nav__item">

513 - <a href="#app.routes.dfir_iris.get_case_assets" class="md-nav__link">

514 - get_case_assets()

515 - </a>

516 -

517 -</li>

518 -

519 - <li class="md-nav__item">

520 - <a href="#app.routes.dfir_iris.get_case_notes" class="md-nav__link">

521 - get_case_notes()

522 - </a>

523 -

524 -</li>

525 -

526 - <li class="md-nav__item">

527 - <a href="#app.routes.dfir_iris.get_cases" class="md-nav__link">

528 - get_cases()

529 - </a>

530 -

531 - <nav class="md-nav" aria-label="get_cases()">

532 - <ul class="md-nav__list">

533 -

534 - <li class="md-nav__item">

535 - <a href="#cases-services" class="md-nav__link">

536 - Cases Services

537 - </a>

538 -

539 -</li>

540 -

541 - </ul>

542 - </nav>

543 -

544 -</li>

545 -

546 - <li class="md-nav__item">

547 - <a href="#app.services.DFIR_IRIS.cases" class="md-nav__link">

548 - app.services.DFIR_IRIS.cases

549 - </a>

550 -

551 -</li>

552 -

553 - <li class="md-nav__item">

554 - <a href="#app.services.DFIR_IRIS.cases.CasesService" class="md-nav__link">

555 - CasesService

556 - </a>

557 -

558 - <nav class="md-nav" aria-label="CasesService">

559 - <ul class="md-nav__list">

560 -

561 - <li class="md-nav__item">

562 - <a href="#app.services.DFIR_IRIS.cases.CasesService.check_case_id" class="md-nav__link">

563 - check_case_id()

564 - </a>

565 -

566 -</li>

567 -

568 - <li class="md-nav__item">

569 - <a href="#app.services.DFIR_IRIS.cases.CasesService.get_case" class="md-nav__link">

570 - get_case()

571 - </a>

572 -

573 -</li>

574 -

575 - <li class="md-nav__item">

576 - <a href="#app.services.DFIR_IRIS.cases.CasesService.list_cases" class="md-nav__link">

577 - list_cases()

578 - </a>

579 -

580 -</li>

581 -

582 - </ul>

583 - </nav>

584 -

585 -</li>

586 -

587 - </ul>

588 -

589 -</nav>

590 -

591 - </li>

592 -

593 -

594 -

595 -

596 -

597 -

598 -

599 -

600 -

601 -

602 - <li class="md-nav__item">

603 - <a href="../graylog/" class="md-nav__link">

604 - Graylog

605 - </a>

606 - </li>

607 -

608 -

609 -

610 -

611 -

612 -

613 -

614 -

615 -

616 -

617 - <li class="md-nav__item">

618 - <a href="../wazuhmanager/" class="md-nav__link">

619 - Wazuh-Manager

620 - </a>

621 - </li>

622 -

623 -

624 -

625 - </ul>

626 -</nav>

627 - </div>

628 - </div>

629 - </div>

630 -

631 -

632 -

633 -

634 - <div class="md-content" data-md-component="content">

635 - <article class="md-content__inner md-typeset">

636 -

637 -

638 -

639 -

640 - <h1>Cases</h1>

641 -

642 -<h2 id="cases-overview">Cases Overview</h2>

643 -<h3 id="cases-model">Cases Model</h3>

644 -

645 -

646 -<div class="doc doc-object doc-module">

647 -

648 -

649 -<a id="app.models.cases"></a>

650 - <div class="doc doc-contents first">

651 -

652 -

653 -

654 - <div class="doc doc-children">

655 -

656 -

657 -

658 -

659 -

660 -

661 -

662 -

663 -<div class="doc doc-object doc-class">

664 -

665 -

666 -

667 -<h2 id="app.models.cases.Case" class="doc doc-heading">

668 - <code>Case</code>

669 -

670 -

671 -</h2>

672 -

673 -

674 - <div class="doc doc-contents ">

675 -

676 - Bases: <code>db.Model</code>

677 -

678 -

679 - Class for cases which stores the case ID, case name, and a list of agents.

680 -This class inherits from SQLAlchemy's Model class.

681 -

682 -

683 - <details class="quote">

684 - <summary>Source code in <code>app\models\cases.py</code></summary>

685 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-10">10</a>

686 -<a href="#__codelineno-0-11">11</a>

687 -<a href="#__codelineno-0-12">12</a>

688 -<a href="#__codelineno-0-13">13</a>

689 -<a href="#__codelineno-0-14">14</a>

690 -<a href="#__codelineno-0-15">15</a>

691 -<a href="#__codelineno-0-16">16</a>

692 -<a href="#__codelineno-0-17">17</a>

693 -<a href="#__codelineno-0-18">18</a>

694 -<a href="#__codelineno-0-19">19</a>

695 -<a href="#__codelineno-0-20">20</a>

696 -<a href="#__codelineno-0-21">21</a>

697 -<a href="#__codelineno-0-22">22</a>

698 -<a href="#__codelineno-0-23">23</a>

699 -<a href="#__codelineno-0-24">24</a>

700 -<a href="#__codelineno-0-25">25</a>

701 -<a href="#__codelineno-0-26">26</a>

702 -<a href="#__codelineno-0-27">27</a>

703 -<a href="#__codelineno-0-28">28</a>

704 -<a href="#__codelineno-0-29">29</a>

705 -<a href="#__codelineno-0-30">30</a>

706 -<a href="#__codelineno-0-31">31</a>

707 -<a href="#__codelineno-0-32">32</a>

708 -<a href="#__codelineno-0-33">33</a>

709 -<a href="#__codelineno-0-34">34</a>

710 -<a href="#__codelineno-0-35">35</a>

711 -<a href="#__codelineno-0-36">36</a>

712 -<a href="#__codelineno-0-37">37</a>

713 -<a href="#__codelineno-0-38">38</a>

714 -<a href="#__codelineno-0-39">39</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-10" name="__codelineno-0-10"></a>class Case(db.Model):

715 -<a id="__codelineno-0-11" name="__codelineno-0-11"></a> """

716 -<a id="__codelineno-0-12" name="__codelineno-0-12"></a> Class for cases which stores the case ID, case name, and a list of agents.

717 -<a id="__codelineno-0-13" name="__codelineno-0-13"></a> This class inherits from SQLAlchemy's Model class.

718 -<a id="__codelineno-0-14" name="__codelineno-0-14"></a> """

719 -<a id="__codelineno-0-15" name="__codelineno-0-15"></a>

720 -<a id="__codelineno-0-16" name="__codelineno-0-16"></a> id: Column[Integer] = db.Column(db.Integer, primary_key=True)

721 -<a id="__codelineno-0-17" name="__codelineno-0-17"></a> case_id: Column[Integer] = db.Column(db.Integer)

722 -<a id="__codelineno-0-18" name="__codelineno-0-18"></a> case_name: Column[String] = db.Column(db.String(100))

723 -<a id="__codelineno-0-19" name="__codelineno-0-19"></a> agents: Column[String] = db.Column(db.String(1000))

724 -<a id="__codelineno-0-20" name="__codelineno-0-20"></a>

725 -<a id="__codelineno-0-21" name="__codelineno-0-21"></a> def __init__(self, case_id: int, case_name: str, agents: str):

726 -<a id="__codelineno-0-22" name="__codelineno-0-22"></a> """

727 -<a id="__codelineno-0-23" name="__codelineno-0-23"></a> Initialize a new instance of the Case class.

728 -<a id="__codelineno-0-24" name="__codelineno-0-24"></a>

729 -<a id="__codelineno-0-25" name="__codelineno-0-25"></a> :param case_id: The ID of the case.

730 -<a id="__codelineno-0-26" name="__codelineno-0-26"></a> :param case_name: The name of the case.

731 -<a id="__codelineno-0-27" name="__codelineno-0-27"></a> :param agents: A comma-separated string of agents associated with the case.

732 -<a id="__codelineno-0-28" name="__codelineno-0-28"></a> """

733 -<a id="__codelineno-0-29" name="__codelineno-0-29"></a> self.case_id = case_id

734 -<a id="__codelineno-0-30" name="__codelineno-0-30"></a> self.case_name = case_name

735 -<a id="__codelineno-0-31" name="__codelineno-0-31"></a> self.agents = agents

736 -<a id="__codelineno-0-32" name="__codelineno-0-32"></a>

737 -<a id="__codelineno-0-33" name="__codelineno-0-33"></a> def __repr__(self) -> str:

738 -<a id="__codelineno-0-34" name="__codelineno-0-34"></a> """

739 -<a id="__codelineno-0-35" name="__codelineno-0-35"></a> Returns a string representation of the Case instance.

740 -<a id="__codelineno-0-36" name="__codelineno-0-36"></a>

741 -<a id="__codelineno-0-37" name="__codelineno-0-37"></a> :return: A string representation of the case ID.

742 -<a id="__codelineno-0-38" name="__codelineno-0-38"></a> """

743 -<a id="__codelineno-0-39" name="__codelineno-0-39"></a> return f"<Case {self.case_id}>"

744 -</code></pre></div></td></tr></table></div>

745 - </details>

746 -

747 -

748 -

749 - <div class="doc doc-children">

750 -

751 -

752 -

753 -

754 -

755 -

756 -

757 -

758 -

759 -<div class="doc doc-object doc-function">

760 -

761 -

762 -

763 -<h3 id="app.models.cases.Case.__init__" class="doc doc-heading">

764 -<code class="highlight language-python">__init__(case_id, case_name, agents)</code>

765 -

766 -</h3>

767 -

768 -

769 - <div class="doc doc-contents ">

770 -

771 - Initialize a new instance of the Case class.

772 -:param case_id: The ID of the case.

773 -:param case_name: The name of the case.

774 -:param agents: A comma-separated string of agents associated with the case.

775 -

776 - <details class="quote">

777 - <summary>Source code in <code>app\models\cases.py</code></summary>

778 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-21">21</a>

779 -<a href="#__codelineno-0-22">22</a>

780 -<a href="#__codelineno-0-23">23</a>

781 -<a href="#__codelineno-0-24">24</a>

782 -<a href="#__codelineno-0-25">25</a>

783 -<a href="#__codelineno-0-26">26</a>

784 -<a href="#__codelineno-0-27">27</a>

785 -<a href="#__codelineno-0-28">28</a>

786 -<a href="#__codelineno-0-29">29</a>

787 -<a href="#__codelineno-0-30">30</a>

788 -<a href="#__codelineno-0-31">31</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-21" name="__codelineno-0-21"></a>def __init__(self, case_id: int, case_name: str, agents: str):

789 -<a id="__codelineno-0-22" name="__codelineno-0-22"></a> """

790 -<a id="__codelineno-0-23" name="__codelineno-0-23"></a> Initialize a new instance of the Case class.

791 -<a id="__codelineno-0-24" name="__codelineno-0-24"></a>

792 -<a id="__codelineno-0-25" name="__codelineno-0-25"></a> :param case_id: The ID of the case.

793 -<a id="__codelineno-0-26" name="__codelineno-0-26"></a> :param case_name: The name of the case.

794 -<a id="__codelineno-0-27" name="__codelineno-0-27"></a> :param agents: A comma-separated string of agents associated with the case.

795 -<a id="__codelineno-0-28" name="__codelineno-0-28"></a> """

796 -<a id="__codelineno-0-29" name="__codelineno-0-29"></a> self.case_id = case_id

797 -<a id="__codelineno-0-30" name="__codelineno-0-30"></a> self.case_name = case_name

798 -<a id="__codelineno-0-31" name="__codelineno-0-31"></a> self.agents = agents

799 -</code></pre></div></td></tr></table></div>

800 - </details>

801 - </div>

802 -

803 -</div>

804 -

805 -<div class="doc doc-object doc-function">

806 -

807 -

808 -

809 -<h3 id="app.models.cases.Case.__repr__" class="doc doc-heading">

810 -<code class="highlight language-python">__repr__()</code>

811 -

812 -</h3>

813 -

814 -

815 - <div class="doc doc-contents ">

816 -

817 - Returns a string representation of the Case instance.

818 -:return: A string representation of the case ID.

819 -

820 - <details class="quote">

821 - <summary>Source code in <code>app\models\cases.py</code></summary>

822 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-33">33</a>

823 -<a href="#__codelineno-0-34">34</a>

824 -<a href="#__codelineno-0-35">35</a>

825 -<a href="#__codelineno-0-36">36</a>

826 -<a href="#__codelineno-0-37">37</a>

827 -<a href="#__codelineno-0-38">38</a>

828 -<a href="#__codelineno-0-39">39</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-33" name="__codelineno-0-33"></a>def __repr__(self) -> str:

829 -<a id="__codelineno-0-34" name="__codelineno-0-34"></a> """

830 -<a id="__codelineno-0-35" name="__codelineno-0-35"></a> Returns a string representation of the Case instance.

831 -<a id="__codelineno-0-36" name="__codelineno-0-36"></a>

832 -<a id="__codelineno-0-37" name="__codelineno-0-37"></a> :return: A string representation of the case ID.

833 -<a id="__codelineno-0-38" name="__codelineno-0-38"></a> """

834 -<a id="__codelineno-0-39" name="__codelineno-0-39"></a> return f"<Case {self.case_id}>"

835 -</code></pre></div></td></tr></table></div>

836 - </details>

837 - </div>

838 -

839 -</div>

840 -

841 -

842 -

843 - </div>

844 -

845 - </div>

846 -

847 -</div>

848 -

849 -<div class="doc doc-object doc-class">

850 -

851 -

852 -

853 -<h2 id="app.models.cases.CaseSchema" class="doc doc-heading">

854 - <code>CaseSchema</code>

855 -

856 -

857 -</h2>

858 -

859 -

860 - <div class="doc doc-contents ">

861 -

862 - Bases: <code>ma.Schema</code>

863 -

864 -

865 - Schema for serializing and deserializing instances of the Case class.

866 -

867 -

868 - <details class="quote">

869 - <summary>Source code in <code>app\models\cases.py</code></summary>

870 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-42">42</a>

871 -<a href="#__codelineno-0-43">43</a>

872 -<a href="#__codelineno-0-44">44</a>

873 -<a href="#__codelineno-0-45">45</a>

874 -<a href="#__codelineno-0-46">46</a>

875 -<a href="#__codelineno-0-47">47</a>

876 -<a href="#__codelineno-0-48">48</a>

877 -<a href="#__codelineno-0-49">49</a>

878 -<a href="#__codelineno-0-50">50</a>

879 -<a href="#__codelineno-0-51">51</a>

880 -<a href="#__codelineno-0-52">52</a>

881 -<a href="#__codelineno-0-53">53</a>

882 -<a href="#__codelineno-0-54">54</a>

883 -<a href="#__codelineno-0-55">55</a>

884 -<a href="#__codelineno-0-56">56</a>

885 -<a href="#__codelineno-0-57">57</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-42" name="__codelineno-0-42"></a>class CaseSchema(ma.Schema):

886 -<a id="__codelineno-0-43" name="__codelineno-0-43"></a> """

887 -<a id="__codelineno-0-44" name="__codelineno-0-44"></a> Schema for serializing and deserializing instances of the Case class.

888 -<a id="__codelineno-0-45" name="__codelineno-0-45"></a> """

889 -<a id="__codelineno-0-46" name="__codelineno-0-46"></a>

890 -<a id="__codelineno-0-47" name="__codelineno-0-47"></a> class Meta:

891 -<a id="__codelineno-0-48" name="__codelineno-0-48"></a> """

892 -<a id="__codelineno-0-49" name="__codelineno-0-49"></a> Meta class defines the fields to be serialized/deserialized.

893 -<a id="__codelineno-0-50" name="__codelineno-0-50"></a> """

894 -<a id="__codelineno-0-51" name="__codelineno-0-51"></a>

895 -<a id="__codelineno-0-52" name="__codelineno-0-52"></a> fields: tuple = (

896 -<a id="__codelineno-0-53" name="__codelineno-0-53"></a> "id",

897 -<a id="__codelineno-0-54" name="__codelineno-0-54"></a> "case_id",

898 -<a id="__codelineno-0-55" name="__codelineno-0-55"></a> "case_name",

899 -<a id="__codelineno-0-56" name="__codelineno-0-56"></a> "agents",

900 -<a id="__codelineno-0-57" name="__codelineno-0-57"></a> )

901 -</code></pre></div></td></tr></table></div>

902 - </details>

903 -

904 -

905 -

906 - <div class="doc doc-children">

907 -

908 -

909 -

910 -

911 -

912 -

913 -

914 -

915 -<div class="doc doc-object doc-class">

916 -

917 -

918 -

919 -<h3 id="app.models.cases.CaseSchema.Meta" class="doc doc-heading">

920 - <code>Meta</code>

921 -

922 -

923 -</h3>

924 -

925 -

926 - <div class="doc doc-contents ">

927 -

928 -

929 - Meta class defines the fields to be serialized/deserialized.

930 -

931 -

932 - <details class="quote">

933 - <summary>Source code in <code>app\models\cases.py</code></summary>

934 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-47">47</a>

935 -<a href="#__codelineno-0-48">48</a>

936 -<a href="#__codelineno-0-49">49</a>

937 -<a href="#__codelineno-0-50">50</a>

938 -<a href="#__codelineno-0-51">51</a>

939 -<a href="#__codelineno-0-52">52</a>

940 -<a href="#__codelineno-0-53">53</a>

941 -<a href="#__codelineno-0-54">54</a>

942 -<a href="#__codelineno-0-55">55</a>

943 -<a href="#__codelineno-0-56">56</a>

944 -<a href="#__codelineno-0-57">57</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-47" name="__codelineno-0-47"></a>class Meta:

945 -<a id="__codelineno-0-48" name="__codelineno-0-48"></a> """

946 -<a id="__codelineno-0-49" name="__codelineno-0-49"></a> Meta class defines the fields to be serialized/deserialized.

947 -<a id="__codelineno-0-50" name="__codelineno-0-50"></a> """

948 -<a id="__codelineno-0-51" name="__codelineno-0-51"></a>

949 -<a id="__codelineno-0-52" name="__codelineno-0-52"></a> fields: tuple = (

950 -<a id="__codelineno-0-53" name="__codelineno-0-53"></a> "id",

951 -<a id="__codelineno-0-54" name="__codelineno-0-54"></a> "case_id",

952 -<a id="__codelineno-0-55" name="__codelineno-0-55"></a> "case_name",

953 -<a id="__codelineno-0-56" name="__codelineno-0-56"></a> "agents",

954 -<a id="__codelineno-0-57" name="__codelineno-0-57"></a> )

955 -</code></pre></div></td></tr></table></div>

956 - </details>

957 -

958 -

959 -

960 - <div class="doc doc-children">

961 -

962 -

963 -

964 -

965 -

966 -

967 -

968 -

969 -

970 -

971 -

972 - </div>

973 -

974 - </div>

975 -

976 -</div>

977 -

978 -

979 -

980 -

981 - </div>

982 -

983 - </div>

984 -

985 -</div>

986 -

987 -

988 -

989 -

990 - </div>

991 -

992 - </div>

993 -

994 -</div>

995 -<h3 id="cases-routes">Cases Routes</h3>

996 -

997 -

998 -<div class="doc doc-object doc-module">

999 -

1000 -

1001 -<a id="app.routes.dfir_iris"></a>

1002 - <div class="doc doc-contents first">

1003 -

1004 -

1005 -

1006 - <div class="doc doc-children">

1007 -

1008 -

1009 -

1010 -

1011 -

1012 -

1013 -

1014 -

1015 -

1016 -<div class="doc doc-object doc-function">

1017 -

1018 -

1019 -

1020 -<h2 id="app.routes.dfir_iris.create_case_note" class="doc doc-heading">

1021 -<code class="highlight language-python">create_case_note(case_id)</code>

1022 -

1023 -</h2>

1024 -

1025 -

1026 - <div class="doc doc-contents ">

1027 -

1028 - Endpoint to create a note for a specific case in DFIR IRIS.

1029 -

1030 - Parameters:

1031 - <table>

1032 - <thead>

1033 - <tr>

1034 - <th>Name</th>

1035 - <th>Type</th>

1036 - <th>Description</th>

1037 - <th>Default</th>

1038 - </tr>

1039 - </thead>

1040 - <tbody>

1041 - <tr>

1042 - <td><code>case_id</code></td>

1043 - <td>

1044 - <code>str</code>

1045 - </td>

1046 - <td>

1047 - <div class="doc-md-description">

1048 - The ID of the case to create a note for.

1049 - </div>

1050 - </td>

1051 - <td>

1052 - required

1053 - </td>

1054 - </tr>

1055 - </tbody>

1056 - </table>

1057 -

1058 - Returns:

1059 - <table>

1060 - <thead>

1061 - <tr>

1062 -<th>Name</th> <th>Type</th>

1063 - <th>Description</th>

1064 - </tr>

1065 - </thead>

1066 - <tbody>

1067 - <tr>

1068 -<td><code>json</code></td> <td>

1069 - </td>

1070 - <td>

1071 - <div class="doc-md-description">

1072 - A JSON response containing the result of the note creation operation.

1073 - </div>

1074 - </td>

1075 - </tr>

1076 - </tbody>

1077 - </table>

1078 -

1079 - <details class="quote">

1080 - <summary>Source code in <code>app\routes\dfir_iris.py</code></summary>

1081 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-57">57</a>

1082 -<a href="#__codelineno-0-58">58</a>

1083 -<a href="#__codelineno-0-59">59</a>

1084 -<a href="#__codelineno-0-60">60</a>

1085 -<a href="#__codelineno-0-61">61</a>

1086 -<a href="#__codelineno-0-62">62</a>

1087 -<a href="#__codelineno-0-63">63</a>

1088 -<a href="#__codelineno-0-64">64</a>

1089 -<a href="#__codelineno-0-65">65</a>

1090 -<a href="#__codelineno-0-66">66</a>

1091 -<a href="#__codelineno-0-67">67</a>

1092 -<a href="#__codelineno-0-68">68</a>

1093 -<a href="#__codelineno-0-69">69</a>

1094 -<a href="#__codelineno-0-70">70</a>

1095 -<a href="#__codelineno-0-71">71</a>

1096 -<a href="#__codelineno-0-72">72</a>

1097 -<a href="#__codelineno-0-73">73</a>

1098 -<a href="#__codelineno-0-74">74</a>

1099 -<a href="#__codelineno-0-75">75</a>

1100 -<a href="#__codelineno-0-76">76</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-57" name="__codelineno-0-57"></a>@bp.route("/dfir_iris/cases/<case_id>/note", methods=["POST"])

1101 -<a id="__codelineno-0-58" name="__codelineno-0-58"></a>def create_case_note(case_id: str):

1102 -<a id="__codelineno-0-59" name="__codelineno-0-59"></a> """

1103 -<a id="__codelineno-0-60" name="__codelineno-0-60"></a> Endpoint to create a note for a specific case in DFIR IRIS.

1104 -<a id="__codelineno-0-61" name="__codelineno-0-61"></a>

1105 -<a id="__codelineno-0-62" name="__codelineno-0-62"></a> Args:

1106 -<a id="__codelineno-0-63" name="__codelineno-0-63"></a> case_id (str): The ID of the case to create a note for.

1107 -<a id="__codelineno-0-64" name="__codelineno-0-64"></a>

1108 -<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Returns:

1109 -<a id="__codelineno-0-66" name="__codelineno-0-66"></a> json: A JSON response containing the result of the note creation operation.

1110 -<a id="__codelineno-0-67" name="__codelineno-0-67"></a> """

1111 -<a id="__codelineno-0-68" name="__codelineno-0-68"></a> note_title = request.json["note_title"]

1112 -<a id="__codelineno-0-69" name="__codelineno-0-69"></a> note_content = request.json["note_content"]

1113 -<a id="__codelineno-0-70" name="__codelineno-0-70"></a> notes_service = NotesService()

1114 -<a id="__codelineno-0-71" name="__codelineno-0-71"></a> created_note = notes_service.create_case_note(

1115 -<a id="__codelineno-0-72" name="__codelineno-0-72"></a> cid=case_id,

1116 -<a id="__codelineno-0-73" name="__codelineno-0-73"></a> note_title=note_title,

1117 -<a id="__codelineno-0-74" name="__codelineno-0-74"></a> note_content=note_content,

1118 -<a id="__codelineno-0-75" name="__codelineno-0-75"></a> )

1119 -<a id="__codelineno-0-76" name="__codelineno-0-76"></a> return created_note

1120 -</code></pre></div></td></tr></table></div>

1121 - </details>

1122 - </div>

1123 -

1124 -</div>

1125 -

1126 -<div class="doc doc-object doc-function">

1127 -

1128 -

1129 -

1130 -<h2 id="app.routes.dfir_iris.get_alerts" class="doc doc-heading">

1131 -<code class="highlight language-python">get_alerts()</code>

1132 -

1133 -</h2>

1134 -

1135 -

1136 - <div class="doc doc-contents ">

1137 -

1138 - Endpoint to retrieve all alerts from DFIR IRIS.

1139 -

1140 - Returns:

1141 - <table>

1142 - <thead>

1143 - <tr>

1144 -<th>Name</th> <th>Type</th>

1145 - <th>Description</th>

1146 - </tr>

1147 - </thead>

1148 - <tbody>

1149 - <tr>

1150 -<td><code>json</code></td> <td>

1151 - </td>

1152 - <td>

1153 - <div class="doc-md-description">

1154 - A JSON response containing the list of alerts.

1155 - </div>

1156 - </td>

1157 - </tr>

1158 - </tbody>

1159 - </table>

1160 -

1161 - <details class="quote">

1162 - <summary>Source code in <code>app\routes\dfir_iris.py</code></summary>

1163 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-95"> 95</a>

1164 -<a href="#__codelineno-0-96"> 96</a>

1165 -<a href="#__codelineno-0-97"> 97</a>

1166 -<a href="#__codelineno-0-98"> 98</a>

1167 -<a href="#__codelineno-0-99"> 99</a>

1168 -<a href="#__codelineno-0-100">100</a>

1169 -<a href="#__codelineno-0-101">101</a>

1170 -<a href="#__codelineno-0-102">102</a>

1171 -<a href="#__codelineno-0-103">103</a>

1172 -<a href="#__codelineno-0-104">104</a>

1173 -<a href="#__codelineno-0-105">105</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-95" name="__codelineno-0-95"></a>@bp.route("/dfir_iris/alerts", methods=["GET"])

1174 -<a id="__codelineno-0-96" name="__codelineno-0-96"></a>def get_alerts():

1175 -<a id="__codelineno-0-97" name="__codelineno-0-97"></a> """

1176 -<a id="__codelineno-0-98" name="__codelineno-0-98"></a> Endpoint to retrieve all alerts from DFIR IRIS.

1177 -<a id="__codelineno-0-99" name="__codelineno-0-99"></a>

1178 -<a id="__codelineno-0-100" name="__codelineno-0-100"></a> Returns:

1179 -<a id="__codelineno-0-101" name="__codelineno-0-101"></a> json: A JSON response containing the list of alerts.

1180 -<a id="__codelineno-0-102" name="__codelineno-0-102"></a> """

1181 -<a id="__codelineno-0-103" name="__codelineno-0-103"></a> service = AlertsService()

1182 -<a id="__codelineno-0-104" name="__codelineno-0-104"></a> alerts = service.list_alerts()

1183 -<a id="__codelineno-0-105" name="__codelineno-0-105"></a> return alerts

1184 -</code></pre></div></td></tr></table></div>

1185 - </details>

1186 - </div>

1187 -

1188 -</div>

1189 -

1190 -<div class="doc doc-object doc-function">

1191 -

1192 -

1193 -

1194 -<h2 id="app.routes.dfir_iris.get_case" class="doc doc-heading">

1195 -<code class="highlight language-python">get_case(case_id)</code>

1196 -

1197 -</h2>

1198 -

1199 -

1200 - <div class="doc doc-contents ">

1201 -

1202 - Endpoint to retrieve a specific case from DFIR IRIS.

1203 -

1204 - Parameters:

1205 - <table>

1206 - <thead>

1207 - <tr>

1208 - <th>Name</th>

1209 - <th>Type</th>

1210 - <th>Description</th>

1211 - <th>Default</th>

1212 - </tr>

1213 - </thead>

1214 - <tbody>

1215 - <tr>

1216 - <td><code>case_id</code></td>

1217 - <td>

1218 - <code>str</code>

1219 - </td>

1220 - <td>

1221 - <div class="doc-md-description">

1222 - The ID of the case to retrieve.

1223 - </div>

1224 - </td>

1225 - <td>

1226 - required

1227 - </td>

1228 - </tr>

1229 - </tbody>

1230 - </table>

1231 -

1232 - Returns:

1233 - <table>

1234 - <thead>

1235 - <tr>

1236 -<th>Name</th> <th>Type</th>

1237 - <th>Description</th>

1238 - </tr>

1239 - </thead>

1240 - <tbody>

1241 - <tr>

1242 -<td><code>json</code></td> <td>

1243 - </td>

1244 - <td>

1245 - <div class="doc-md-description">

1246 - A JSON response containing the case data.

1247 - </div>

1248 - </td>

1249 - </tr>

1250 - </tbody>

1251 - </table>

1252 -

1253 - <details class="quote">

1254 - <summary>Source code in <code>app\routes\dfir_iris.py</code></summary>

1255 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-25">25</a>

1256 -<a href="#__codelineno-0-26">26</a>

1257 -<a href="#__codelineno-0-27">27</a>

1258 -<a href="#__codelineno-0-28">28</a>

1259 -<a href="#__codelineno-0-29">29</a>

1260 -<a href="#__codelineno-0-30">30</a>

1261 -<a href="#__codelineno-0-31">31</a>

1262 -<a href="#__codelineno-0-32">32</a>

1263 -<a href="#__codelineno-0-33">33</a>

1264 -<a href="#__codelineno-0-34">34</a>

1265 -<a href="#__codelineno-0-35">35</a>

1266 -<a href="#__codelineno-0-36">36</a>

1267 -<a href="#__codelineno-0-37">37</a>

1268 -<a href="#__codelineno-0-38">38</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-25" name="__codelineno-0-25"></a>@bp.route("/dfir_iris/cases/<case_id>", methods=["GET"])

1269 -<a id="__codelineno-0-26" name="__codelineno-0-26"></a>def get_case(case_id: str):

1270 -<a id="__codelineno-0-27" name="__codelineno-0-27"></a> """

1271 -<a id="__codelineno-0-28" name="__codelineno-0-28"></a> Endpoint to retrieve a specific case from DFIR IRIS.

1272 -<a id="__codelineno-0-29" name="__codelineno-0-29"></a>

1273 -<a id="__codelineno-0-30" name="__codelineno-0-30"></a> Args:

1274 -<a id="__codelineno-0-31" name="__codelineno-0-31"></a> case_id (str): The ID of the case to retrieve.

1275 -<a id="__codelineno-0-32" name="__codelineno-0-32"></a>

1276 -<a id="__codelineno-0-33" name="__codelineno-0-33"></a> Returns:

1277 -<a id="__codelineno-0-34" name="__codelineno-0-34"></a> json: A JSON response containing the case data.

1278 -<a id="__codelineno-0-35" name="__codelineno-0-35"></a> """

1279 -<a id="__codelineno-0-36" name="__codelineno-0-36"></a> service = CasesService()

1280 -<a id="__codelineno-0-37" name="__codelineno-0-37"></a> case = service.get_case(case_id=case_id)

1281 -<a id="__codelineno-0-38" name="__codelineno-0-38"></a> return case

1282 -</code></pre></div></td></tr></table></div>

1283 - </details>

1284 - </div>

1285 -

1286 -</div>

1287 -

1288 -<div class="doc doc-object doc-function">

1289 -

1290 -

1291 -

1292 -<h2 id="app.routes.dfir_iris.get_case_assets" class="doc doc-heading">

1293 -<code class="highlight language-python">get_case_assets(case_id)</code>

1294 -

1295 -</h2>

1296 -

1297 -

1298 - <div class="doc doc-contents ">

1299 -

1300 - Endpoint to retrieve assets of a specific case from DFIR IRIS.

1301 -

1302 - Parameters:

1303 - <table>

1304 - <thead>

1305 - <tr>

1306 - <th>Name</th>

1307 - <th>Type</th>

1308 - <th>Description</th>

1309 - <th>Default</th>

1310 - </tr>

1311 - </thead>

1312 - <tbody>

1313 - <tr>

1314 - <td><code>case_id</code></td>

1315 - <td>

1316 - <code>str</code>

1317 - </td>

1318 - <td>

1319 - <div class="doc-md-description">

1320 - The ID of the case to retrieve assets from.

1321 - </div>

1322 - </td>

1323 - <td>

1324 - required

1325 - </td>

1326 - </tr>

1327 - </tbody>

1328 - </table>

1329 -

1330 - Returns:

1331 - <table>

1332 - <thead>

1333 - <tr>

1334 -<th>Name</th> <th>Type</th>

1335 - <th>Description</th>

1336 - </tr>

1337 - </thead>

1338 - <tbody>

1339 - <tr>

1340 -<td><code>json</code></td> <td>

1341 - </td>

1342 - <td>

1343 - <div class="doc-md-description">

1344 - A JSON response containing the list of assets for the case.

1345 - </div>

1346 - </td>

1347 - </tr>

1348 - </tbody>

1349 - </table>

1350 -

1351 - <details class="quote">

1352 - <summary>Source code in <code>app\routes\dfir_iris.py</code></summary>

1353 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-79">79</a>

1354 -<a href="#__codelineno-0-80">80</a>

1355 -<a href="#__codelineno-0-81">81</a>

1356 -<a href="#__codelineno-0-82">82</a>

1357 -<a href="#__codelineno-0-83">83</a>

1358 -<a href="#__codelineno-0-84">84</a>

1359 -<a href="#__codelineno-0-85">85</a>

1360 -<a href="#__codelineno-0-86">86</a>

1361 -<a href="#__codelineno-0-87">87</a>

1362 -<a href="#__codelineno-0-88">88</a>

1363 -<a href="#__codelineno-0-89">89</a>

1364 -<a href="#__codelineno-0-90">90</a>

1365 -<a href="#__codelineno-0-91">91</a>

1366 -<a href="#__codelineno-0-92">92</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-79" name="__codelineno-0-79"></a>@bp.route("/dfir_iris/cases/<case_id>/assets", methods=["GET"])

1367 -<a id="__codelineno-0-80" name="__codelineno-0-80"></a>def get_case_assets(case_id: str):

1368 -<a id="__codelineno-0-81" name="__codelineno-0-81"></a> """

1369 -<a id="__codelineno-0-82" name="__codelineno-0-82"></a> Endpoint to retrieve assets of a specific case from DFIR IRIS.

1370 -<a id="__codelineno-0-83" name="__codelineno-0-83"></a>

1371 -<a id="__codelineno-0-84" name="__codelineno-0-84"></a> Args:

1372 -<a id="__codelineno-0-85" name="__codelineno-0-85"></a> case_id (str): The ID of the case to retrieve assets from.

1373 -<a id="__codelineno-0-86" name="__codelineno-0-86"></a>

1374 -<a id="__codelineno-0-87" name="__codelineno-0-87"></a> Returns:

1375 -<a id="__codelineno-0-88" name="__codelineno-0-88"></a> json: A JSON response containing the list of assets for the case.

1376 -<a id="__codelineno-0-89" name="__codelineno-0-89"></a> """

1377 -<a id="__codelineno-0-90" name="__codelineno-0-90"></a> asset_service = AssetsService()

1378 -<a id="__codelineno-0-91" name="__codelineno-0-91"></a> assets = asset_service.get_case_assets(cid=case_id)

1379 -<a id="__codelineno-0-92" name="__codelineno-0-92"></a> return assets

1380 -</code></pre></div></td></tr></table></div>

1381 - </details>

1382 - </div>

1383 -

1384 -</div>

1385 -

1386 -<div class="doc doc-object doc-function">

1387 -

1388 -

1389 -

1390 -<h2 id="app.routes.dfir_iris.get_case_notes" class="doc doc-heading">

1391 -<code class="highlight language-python">get_case_notes(case_id)</code>

1392 -

1393 -</h2>

1394 -

1395 -

1396 - <div class="doc doc-contents ">

1397 -

1398 - Endpoint to retrieve notes of a specific case from DFIR IRIS.

1399 -

1400 - Parameters:

1401 - <table>

1402 - <thead>

1403 - <tr>

1404 - <th>Name</th>

1405 - <th>Type</th>

1406 - <th>Description</th>

1407 - <th>Default</th>

1408 - </tr>

1409 - </thead>

1410 - <tbody>

1411 - <tr>

1412 - <td><code>case_id</code></td>

1413 - <td>

1414 - <code>str</code>

1415 - </td>

1416 - <td>

1417 - <div class="doc-md-description">

1418 - The ID of the case to retrieve notes from.

1419 - </div>

1420 - </td>

1421 - <td>

1422 - required

1423 - </td>

1424 - </tr>

1425 - </tbody>

1426 - </table>

1427 -

1428 - Returns:

1429 - <table>

1430 - <thead>

1431 - <tr>

1432 -<th>Name</th> <th>Type</th>

1433 - <th>Description</th>

1434 - </tr>

1435 - </thead>

1436 - <tbody>

1437 - <tr>

1438 -<td><code>json</code></td> <td>

1439 - </td>

1440 - <td>

1441 - <div class="doc-md-description">

1442 - A JSON response containing the list of notes for the case.

1443 - </div>

1444 - </td>

1445 - </tr>

1446 - </tbody>

1447 - </table>

1448 -

1449 - <details class="quote">

1450 - <summary>Source code in <code>app\routes\dfir_iris.py</code></summary>

1451 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-41">41</a>

1452 -<a href="#__codelineno-0-42">42</a>

1453 -<a href="#__codelineno-0-43">43</a>

1454 -<a href="#__codelineno-0-44">44</a>

1455 -<a href="#__codelineno-0-45">45</a>

1456 -<a href="#__codelineno-0-46">46</a>

1457 -<a href="#__codelineno-0-47">47</a>

1458 -<a href="#__codelineno-0-48">48</a>

1459 -<a href="#__codelineno-0-49">49</a>

1460 -<a href="#__codelineno-0-50">50</a>

1461 -<a href="#__codelineno-0-51">51</a>

1462 -<a href="#__codelineno-0-52">52</a>

1463 -<a href="#__codelineno-0-53">53</a>

1464 -<a href="#__codelineno-0-54">54</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-41" name="__codelineno-0-41"></a>@bp.route("/dfir_iris/cases/<case_id>/notes", methods=["GET"])

1465 -<a id="__codelineno-0-42" name="__codelineno-0-42"></a>def get_case_notes(case_id: int):

1466 -<a id="__codelineno-0-43" name="__codelineno-0-43"></a> """

1467 -<a id="__codelineno-0-44" name="__codelineno-0-44"></a> Endpoint to retrieve notes of a specific case from DFIR IRIS.

1468 -<a id="__codelineno-0-45" name="__codelineno-0-45"></a>

1469 -<a id="__codelineno-0-46" name="__codelineno-0-46"></a> Args:

1470 -<a id="__codelineno-0-47" name="__codelineno-0-47"></a> case_id (str): The ID of the case to retrieve notes from.

1471 -<a id="__codelineno-0-48" name="__codelineno-0-48"></a>

1472 -<a id="__codelineno-0-49" name="__codelineno-0-49"></a> Returns:

1473 -<a id="__codelineno-0-50" name="__codelineno-0-50"></a> json: A JSON response containing the list of notes for the case.

1474 -<a id="__codelineno-0-51" name="__codelineno-0-51"></a> """

1475 -<a id="__codelineno-0-52" name="__codelineno-0-52"></a> notes_service = NotesService()

1476 -<a id="__codelineno-0-53" name="__codelineno-0-53"></a> notes = notes_service.get_case_notes(search_term="%", cid=case_id)

1477 -<a id="__codelineno-0-54" name="__codelineno-0-54"></a> return notes

1478 -</code></pre></div></td></tr></table></div>

1479 - </details>

1480 - </div>

1481 -

1482 -</div>

1483 -

1484 -<div class="doc doc-object doc-function">

1485 -

1486 -

1487 -

1488 -<h2 id="app.routes.dfir_iris.get_cases" class="doc doc-heading">

1489 -<code class="highlight language-python">get_cases()</code>

1490 -

1491 -</h2>

1492 -

1493 -

1494 - <div class="doc doc-contents ">

1495 -

1496 - Endpoint to retrieve all the cases from DFIR IRIS.

1497 -

1498 - Returns:

1499 - <table>

1500 - <thead>

1501 - <tr>

1502 -<th>Name</th> <th>Type</th>

1503 - <th>Description</th>

1504 - </tr>

1505 - </thead>

1506 - <tbody>

1507 - <tr>

1508 -<td><code>json</code></td> <td>

1509 - </td>

1510 - <td>

1511 - <div class="doc-md-description">

1512 - A JSON response containing the list of cases.

1513 - </div>

1514 - </td>

1515 - </tr>

1516 - </tbody>

1517 - </table>

1518 -

1519 - <details class="quote">

1520 - <summary>Source code in <code>app\routes\dfir_iris.py</code></summary>

1521 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-12">12</a>

1522 -<a href="#__codelineno-0-13">13</a>

1523 -<a href="#__codelineno-0-14">14</a>

1524 -<a href="#__codelineno-0-15">15</a>

1525 -<a href="#__codelineno-0-16">16</a>

1526 -<a href="#__codelineno-0-17">17</a>

1527 -<a href="#__codelineno-0-18">18</a>

1528 -<a href="#__codelineno-0-19">19</a>

1529 -<a href="#__codelineno-0-20">20</a>

1530 -<a href="#__codelineno-0-21">21</a>

1531 -<a href="#__codelineno-0-22">22</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-12" name="__codelineno-0-12"></a>@bp.route("/dfir_iris/cases", methods=["GET"])

1532 -<a id="__codelineno-0-13" name="__codelineno-0-13"></a>def get_cases():

1533 -<a id="__codelineno-0-14" name="__codelineno-0-14"></a> """

1534 -<a id="__codelineno-0-15" name="__codelineno-0-15"></a> Endpoint to retrieve all the cases from DFIR IRIS.

1535 -<a id="__codelineno-0-16" name="__codelineno-0-16"></a>

1536 -<a id="__codelineno-0-17" name="__codelineno-0-17"></a> Returns:

1537 -<a id="__codelineno-0-18" name="__codelineno-0-18"></a> json: A JSON response containing the list of cases.

1538 -<a id="__codelineno-0-19" name="__codelineno-0-19"></a> """

1539 -<a id="__codelineno-0-20" name="__codelineno-0-20"></a> service = CasesService()

1540 -<a id="__codelineno-0-21" name="__codelineno-0-21"></a> cases = service.list_cases()

1541 -<a id="__codelineno-0-22" name="__codelineno-0-22"></a> return cases

1542 -</code></pre></div></td></tr></table></div>

1543 - </details>

1544 - </div>

1545 -

1546 -</div>

1547 -

1548 -

1549 -

1550 - </div>

1551 -

1552 - </div>

1553 -

1554 -</div>

1555 -<h3 id="cases-services">Cases Services</h3>

1556 -

1557 -

1558 -<div class="doc doc-object doc-module">

1559 -

1560 -

1561 -<a id="app.services.DFIR_IRIS.cases"></a>

1562 - <div class="doc doc-contents first">

1563 -

1564 -

1565 -

1566 - <div class="doc doc-children">

1567 -

1568 -

1569 -

1570 -

1571 -

1572 -

1573 -

1574 -

1575 -<div class="doc doc-object doc-class">

1576 -

1577 -

1578 -

1579 -<h2 id="app.services.DFIR_IRIS.cases.CasesService" class="doc doc-heading">

1580 - <code>CasesService</code>

1581 -

1582 -

1583 -</h2>

1584 -

1585 -

1586 - <div class="doc doc-contents ">

1587 -

1588 -

1589 - A service class that encapsulates the logic for pulling cases from DFIR-IRIS.

1590 -

1591 -

1592 - <details class="quote">

1593 - <summary>Source code in <code>app\services\DFIR_IRIS\cases.py</code></summary>

1594 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-14"> 14</a>

1595 -<a href="#__codelineno-0-15"> 15</a>

1596 -<a href="#__codelineno-0-16"> 16</a>

1597 -<a href="#__codelineno-0-17"> 17</a>

1598 -<a href="#__codelineno-0-18"> 18</a>

1599 -<a href="#__codelineno-0-19"> 19</a>

1600 -<a href="#__codelineno-0-20"> 20</a>

1601 -<a href="#__codelineno-0-21"> 21</a>

1602 -<a href="#__codelineno-0-22"> 22</a>

1603 -<a href="#__codelineno-0-23"> 23</a>

1604 -<a href="#__codelineno-0-24"> 24</a>

1605 -<a href="#__codelineno-0-25"> 25</a>

1606 -<a href="#__codelineno-0-26"> 26</a>

1607 -<a href="#__codelineno-0-27"> 27</a>

1608 -<a href="#__codelineno-0-28"> 28</a>

1609 -<a href="#__codelineno-0-29"> 29</a>

1610 -<a href="#__codelineno-0-30"> 30</a>

1611 -<a href="#__codelineno-0-31"> 31</a>

1612 -<a href="#__codelineno-0-32"> 32</a>

1613 -<a href="#__codelineno-0-33"> 33</a>

1614 -<a href="#__codelineno-0-34"> 34</a>

1615 -<a href="#__codelineno-0-35"> 35</a>

1616 -<a href="#__codelineno-0-36"> 36</a>

1617 -<a href="#__codelineno-0-37"> 37</a>

1618 -<a href="#__codelineno-0-38"> 38</a>

1619 -<a href="#__codelineno-0-39"> 39</a>

1620 -<a href="#__codelineno-0-40"> 40</a>

1621 -<a href="#__codelineno-0-41"> 41</a>

1622 -<a href="#__codelineno-0-42"> 42</a>

1623 -<a href="#__codelineno-0-43"> 43</a>

1624 -<a href="#__codelineno-0-44"> 44</a>

1625 -<a href="#__codelineno-0-45"> 45</a>

1626 -<a href="#__codelineno-0-46"> 46</a>

1627 -<a href="#__codelineno-0-47"> 47</a>

1628 -<a href="#__codelineno-0-48"> 48</a>

1629 -<a href="#__codelineno-0-49"> 49</a>

1630 -<a href="#__codelineno-0-50"> 50</a>

1631 -<a href="#__codelineno-0-51"> 51</a>

1632 -<a href="#__codelineno-0-52"> 52</a>

1633 -<a href="#__codelineno-0-53"> 53</a>

1634 -<a href="#__codelineno-0-54"> 54</a>

1635 -<a href="#__codelineno-0-55"> 55</a>

1636 -<a href="#__codelineno-0-56"> 56</a>

1637 -<a href="#__codelineno-0-57"> 57</a>

1638 -<a href="#__codelineno-0-58"> 58</a>

1639 -<a href="#__codelineno-0-59"> 59</a>

1640 -<a href="#__codelineno-0-60"> 60</a>

1641 -<a href="#__codelineno-0-61"> 61</a>

1642 -<a href="#__codelineno-0-62"> 62</a>

1643 -<a href="#__codelineno-0-63"> 63</a>

1644 -<a href="#__codelineno-0-64"> 64</a>

1645 -<a href="#__codelineno-0-65"> 65</a>

1646 -<a href="#__codelineno-0-66"> 66</a>

1647 -<a href="#__codelineno-0-67"> 67</a>

1648 -<a href="#__codelineno-0-68"> 68</a>

1649 -<a href="#__codelineno-0-69"> 69</a>

1650 -<a href="#__codelineno-0-70"> 70</a>

1651 -<a href="#__codelineno-0-71"> 71</a>

1652 -<a href="#__codelineno-0-72"> 72</a>

1653 -<a href="#__codelineno-0-73"> 73</a>

1654 -<a href="#__codelineno-0-74"> 74</a>

1655 -<a href="#__codelineno-0-75"> 75</a>

1656 -<a href="#__codelineno-0-76"> 76</a>

1657 -<a href="#__codelineno-0-77"> 77</a>

1658 -<a href="#__codelineno-0-78"> 78</a>

1659 -<a href="#__codelineno-0-79"> 79</a>

1660 -<a href="#__codelineno-0-80"> 80</a>

1661 -<a href="#__codelineno-0-81"> 81</a>

1662 -<a href="#__codelineno-0-82"> 82</a>

1663 -<a href="#__codelineno-0-83"> 83</a>

1664 -<a href="#__codelineno-0-84"> 84</a>

1665 -<a href="#__codelineno-0-85"> 85</a>

1666 -<a href="#__codelineno-0-86"> 86</a>

1667 -<a href="#__codelineno-0-87"> 87</a>

1668 -<a href="#__codelineno-0-88"> 88</a>

1669 -<a href="#__codelineno-0-89"> 89</a>

1670 -<a href="#__codelineno-0-90"> 90</a>

1671 -<a href="#__codelineno-0-91"> 91</a>

1672 -<a href="#__codelineno-0-92"> 92</a>

1673 -<a href="#__codelineno-0-93"> 93</a>

1674 -<a href="#__codelineno-0-94"> 94</a>

1675 -<a href="#__codelineno-0-95"> 95</a>

1676 -<a href="#__codelineno-0-96"> 96</a>

1677 -<a href="#__codelineno-0-97"> 97</a>

1678 -<a href="#__codelineno-0-98"> 98</a>

1679 -<a href="#__codelineno-0-99"> 99</a>

1680 -<a href="#__codelineno-0-100">100</a>

1681 -<a href="#__codelineno-0-101">101</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-14" name="__codelineno-0-14"></a>class CasesService:

1682 -<a id="__codelineno-0-15" name="__codelineno-0-15"></a> """

1683 -<a id="__codelineno-0-16" name="__codelineno-0-16"></a> A service class that encapsulates the logic for pulling cases from DFIR-IRIS.

1684 -<a id="__codelineno-0-17" name="__codelineno-0-17"></a> """

1685 -<a id="__codelineno-0-18" name="__codelineno-0-18"></a>

1686 -<a id="__codelineno-0-19" name="__codelineno-0-19"></a> def __init__(self):

1687 -<a id="__codelineno-0-20" name="__codelineno-0-20"></a> self.universal_service = UniversalService("DFIR-IRIS")

1688 -<a id="__codelineno-0-21" name="__codelineno-0-21"></a> session_result = self.universal_service.create_session()

1689 -<a id="__codelineno-0-22" name="__codelineno-0-22"></a>

1690 -<a id="__codelineno-0-23" name="__codelineno-0-23"></a> if not session_result["success"]:

1691 -<a id="__codelineno-0-24" name="__codelineno-0-24"></a> logger.error(session_result["message"])

1692 -<a id="__codelineno-0-25" name="__codelineno-0-25"></a> self.iris_session = None

1693 -<a id="__codelineno-0-26" name="__codelineno-0-26"></a> else:

1694 -<a id="__codelineno-0-27" name="__codelineno-0-27"></a> self.iris_session = session_result["session"]

1695 -<a id="__codelineno-0-28" name="__codelineno-0-28"></a>

1696 -<a id="__codelineno-0-29" name="__codelineno-0-29"></a> def list_cases(self) -> Dict[str, object]:

1697 -<a id="__codelineno-0-30" name="__codelineno-0-30"></a> """

1698 -<a id="__codelineno-0-31" name="__codelineno-0-31"></a> Lists all cases from DFIR-IRIS

1699 -<a id="__codelineno-0-32" name="__codelineno-0-32"></a>

1700 -<a id="__codelineno-0-33" name="__codelineno-0-33"></a> Returns:

1701 -<a id="__codelineno-0-34" name="__codelineno-0-34"></a> dict: A dictionary containing the success status, a message and potentially the cases.

1702 -<a id="__codelineno-0-35" name="__codelineno-0-35"></a> """

1703 -<a id="__codelineno-0-36" name="__codelineno-0-36"></a> if self.iris_session is None:

1704 -<a id="__codelineno-0-37" name="__codelineno-0-37"></a> return {

1705 -<a id="__codelineno-0-38" name="__codelineno-0-38"></a> "success": False,

1706 -<a id="__codelineno-0-39" name="__codelineno-0-39"></a> "message": "DFIR-IRIS session was not successfully created.",

1707 -<a id="__codelineno-0-40" name="__codelineno-0-40"></a> }

1708 -<a id="__codelineno-0-41" name="__codelineno-0-41"></a>

1709 -<a id="__codelineno-0-42" name="__codelineno-0-42"></a> logger.info("Collecting cases from DFIR-IRIS")

1710 -<a id="__codelineno-0-43" name="__codelineno-0-43"></a> case = Case(session=self.iris_session)

1711 -<a id="__codelineno-0-44" name="__codelineno-0-44"></a> result = self.universal_service.fetch_and_parse_data(

1712 -<a id="__codelineno-0-45" name="__codelineno-0-45"></a> self.iris_session,

1713 -<a id="__codelineno-0-46" name="__codelineno-0-46"></a> case.list_cases,

1714 -<a id="__codelineno-0-47" name="__codelineno-0-47"></a> )

1715 -<a id="__codelineno-0-48" name="__codelineno-0-48"></a>

1716 -<a id="__codelineno-0-49" name="__codelineno-0-49"></a> if not result["success"]:

1717 -<a id="__codelineno-0-50" name="__codelineno-0-50"></a> return {

1718 -<a id="__codelineno-0-51" name="__codelineno-0-51"></a> "success": False,

1719 -<a id="__codelineno-0-52" name="__codelineno-0-52"></a> "message": "Failed to collect cases from DFIR-IRIS",

1720 -<a id="__codelineno-0-53" name="__codelineno-0-53"></a> }

1721 -<a id="__codelineno-0-54" name="__codelineno-0-54"></a>

1722 -<a id="__codelineno-0-55" name="__codelineno-0-55"></a> return {

1723 -<a id="__codelineno-0-56" name="__codelineno-0-56"></a> "success": True,

1724 -<a id="__codelineno-0-57" name="__codelineno-0-57"></a> "message": "Successfully collected cases from DFIR-IRIS",

1725 -<a id="__codelineno-0-58" name="__codelineno-0-58"></a> "cases": result["data"],

1726 -<a id="__codelineno-0-59" name="__codelineno-0-59"></a> }

1727 -<a id="__codelineno-0-60" name="__codelineno-0-60"></a>

1728 -<a id="__codelineno-0-61" name="__codelineno-0-61"></a> def get_case(self, case_id: int) -> bool:

1729 -<a id="__codelineno-0-62" name="__codelineno-0-62"></a> """

1730 -<a id="__codelineno-0-63" name="__codelineno-0-63"></a> Gets a case from DFIR-IRIS and returns all the details

1731 -<a id="__codelineno-0-64" name="__codelineno-0-64"></a>

1732 -<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Returns:

1733 -<a id="__codelineno-0-66" name="__codelineno-0-66"></a> dict: A dictionary containing the success status, a message and potentially the case.

1734 -<a id="__codelineno-0-67" name="__codelineno-0-67"></a> """

1735 -<a id="__codelineno-0-68" name="__codelineno-0-68"></a> if self.iris_session is None:

1736 -<a id="__codelineno-0-69" name="__codelineno-0-69"></a> return {

1737 -<a id="__codelineno-0-70" name="__codelineno-0-70"></a> "success": False,

1738 -<a id="__codelineno-0-71" name="__codelineno-0-71"></a> "message": "DFIR-IRIS session was not successfully created.",

1739 -<a id="__codelineno-0-72" name="__codelineno-0-72"></a> }

1740 -<a id="__codelineno-0-73" name="__codelineno-0-73"></a>

1741 -<a id="__codelineno-0-74" name="__codelineno-0-74"></a> logger.info(f"Collecting case {case_id} from DFIR-IRIS")

1742 -<a id="__codelineno-0-75" name="__codelineno-0-75"></a> case = Case(session=self.iris_session)

1743 -<a id="__codelineno-0-76" name="__codelineno-0-76"></a> result = self.universal_service.fetch_and_parse_data(

1744 -<a id="__codelineno-0-77" name="__codelineno-0-77"></a> self.iris_session,

1745 -<a id="__codelineno-0-78" name="__codelineno-0-78"></a> case.get_case,

1746 -<a id="__codelineno-0-79" name="__codelineno-0-79"></a> case_id,

1747 -<a id="__codelineno-0-80" name="__codelineno-0-80"></a> )

1748 -<a id="__codelineno-0-81" name="__codelineno-0-81"></a>

1749 -<a id="__codelineno-0-82" name="__codelineno-0-82"></a> if not result["success"]:

1750 -<a id="__codelineno-0-83" name="__codelineno-0-83"></a> return {

1751 -<a id="__codelineno-0-84" name="__codelineno-0-84"></a> "success": False,

1752 -<a id="__codelineno-0-85" name="__codelineno-0-85"></a> "message": f"Failed to collect case {case_id} from DFIR-IRIS",

1753 -<a id="__codelineno-0-86" name="__codelineno-0-86"></a> }

1754 -<a id="__codelineno-0-87" name="__codelineno-0-87"></a>

1755 -<a id="__codelineno-0-88" name="__codelineno-0-88"></a> return {

1756 -<a id="__codelineno-0-89" name="__codelineno-0-89"></a> "success": True,

1757 -<a id="__codelineno-0-90" name="__codelineno-0-90"></a> "message": f"Successfully collected case {case_id} from DFIR-IRIS",

1758 -<a id="__codelineno-0-91" name="__codelineno-0-91"></a> "case": result["data"],

1759 -<a id="__codelineno-0-92" name="__codelineno-0-92"></a> }

1760 -<a id="__codelineno-0-93" name="__codelineno-0-93"></a>

1761 -<a id="__codelineno-0-94" name="__codelineno-0-94"></a> def check_case_id(self, case_id: int) -> bool:

1762 -<a id="__codelineno-0-95" name="__codelineno-0-95"></a> """

1763 -<a id="__codelineno-0-96" name="__codelineno-0-96"></a> Checks if a case exists in DFIR-IRIS

1764 -<a id="__codelineno-0-97" name="__codelineno-0-97"></a>

1765 -<a id="__codelineno-0-98" name="__codelineno-0-98"></a> Returns:

1766 -<a id="__codelineno-0-99" name="__codelineno-0-99"></a> dict: A dictionary containing the success status, a message and potentially the case.

1767 -<a id="__codelineno-0-100" name="__codelineno-0-100"></a> """

1768 -<a id="__codelineno-0-101" name="__codelineno-0-101"></a> return self.get_case(case_id)

1769 -</code></pre></div></td></tr></table></div>

1770 - </details>

1771 -

1772 -

1773 -

1774 - <div class="doc doc-children">

1775 -

1776 -

1777 -

1778 -

1779 -

1780 -

1781 -

1782 -

1783 -

1784 -<div class="doc doc-object doc-function">

1785 -

1786 -

1787 -

1788 -<h3 id="app.services.DFIR_IRIS.cases.CasesService.check_case_id" class="doc doc-heading">

1789 -<code class="highlight language-python">check_case_id(case_id)</code>

1790 -

1791 -</h3>

1792 -

1793 -

1794 - <div class="doc doc-contents ">

1795 -

1796 - Checks if a case exists in DFIR-IRIS

1797 -

1798 - Returns:

1799 - <table>

1800 - <thead>

1801 - <tr>

1802 -<th>Name</th> <th>Type</th>

1803 - <th>Description</th>

1804 - </tr>

1805 - </thead>

1806 - <tbody>

1807 - <tr>

1808 -<td><code>dict</code></td> <td>

1809 - <code>bool</code>

1810 - </td>

1811 - <td>

1812 - <div class="doc-md-description">

1813 - A dictionary containing the success status, a message and potentially the case.

1814 - </div>

1815 - </td>

1816 - </tr>

1817 - </tbody>

1818 - </table>

1819 -

1820 - <details class="quote">

1821 - <summary>Source code in <code>app\services\DFIR_IRIS\cases.py</code></summary>

1822 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-94"> 94</a>

1823 -<a href="#__codelineno-0-95"> 95</a>

1824 -<a href="#__codelineno-0-96"> 96</a>

1825 -<a href="#__codelineno-0-97"> 97</a>

1826 -<a href="#__codelineno-0-98"> 98</a>

1827 -<a href="#__codelineno-0-99"> 99</a>

1828 -<a href="#__codelineno-0-100">100</a>

1829 -<a href="#__codelineno-0-101">101</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-94" name="__codelineno-0-94"></a>def check_case_id(self, case_id: int) -> bool:

1830 -<a id="__codelineno-0-95" name="__codelineno-0-95"></a> """

1831 -<a id="__codelineno-0-96" name="__codelineno-0-96"></a> Checks if a case exists in DFIR-IRIS

1832 -<a id="__codelineno-0-97" name="__codelineno-0-97"></a>

1833 -<a id="__codelineno-0-98" name="__codelineno-0-98"></a> Returns:

1834 -<a id="__codelineno-0-99" name="__codelineno-0-99"></a> dict: A dictionary containing the success status, a message and potentially the case.

1835 -<a id="__codelineno-0-100" name="__codelineno-0-100"></a> """

1836 -<a id="__codelineno-0-101" name="__codelineno-0-101"></a> return self.get_case(case_id)

1837 -</code></pre></div></td></tr></table></div>

1838 - </details>

1839 - </div>

1840 -

1841 -</div>

1842 -

1843 -<div class="doc doc-object doc-function">

1844 -

1845 -

1846 -

1847 -<h3 id="app.services.DFIR_IRIS.cases.CasesService.get_case" class="doc doc-heading">

1848 -<code class="highlight language-python">get_case(case_id)</code>

1849 -

1850 -</h3>

1851 -

1852 -

1853 - <div class="doc doc-contents ">

1854 -

1855 - Gets a case from DFIR-IRIS and returns all the details

1856 -

1857 - Returns:

1858 - <table>

1859 - <thead>

1860 - <tr>

1861 -<th>Name</th> <th>Type</th>

1862 - <th>Description</th>

1863 - </tr>

1864 - </thead>

1865 - <tbody>

1866 - <tr>

1867 -<td><code>dict</code></td> <td>

1868 - <code>bool</code>

1869 - </td>

1870 - <td>

1871 - <div class="doc-md-description">

1872 - A dictionary containing the success status, a message and potentially the case.

1873 - </div>

1874 - </td>

1875 - </tr>

1876 - </tbody>

1877 - </table>

1878 -

1879 - <details class="quote">

1880 - <summary>Source code in <code>app\services\DFIR_IRIS\cases.py</code></summary>

1881 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-61">61</a>

1882 -<a href="#__codelineno-0-62">62</a>

1883 -<a href="#__codelineno-0-63">63</a>

1884 -<a href="#__codelineno-0-64">64</a>

1885 -<a href="#__codelineno-0-65">65</a>

1886 -<a href="#__codelineno-0-66">66</a>

1887 -<a href="#__codelineno-0-67">67</a>

1888 -<a href="#__codelineno-0-68">68</a>

1889 -<a href="#__codelineno-0-69">69</a>

1890 -<a href="#__codelineno-0-70">70</a>

1891 -<a href="#__codelineno-0-71">71</a>

1892 -<a href="#__codelineno-0-72">72</a>

1893 -<a href="#__codelineno-0-73">73</a>

1894 -<a href="#__codelineno-0-74">74</a>

1895 -<a href="#__codelineno-0-75">75</a>

1896 -<a href="#__codelineno-0-76">76</a>

1897 -<a href="#__codelineno-0-77">77</a>

1898 -<a href="#__codelineno-0-78">78</a>

1899 -<a href="#__codelineno-0-79">79</a>

1900 -<a href="#__codelineno-0-80">80</a>

1901 -<a href="#__codelineno-0-81">81</a>

1902 -<a href="#__codelineno-0-82">82</a>

1903 -<a href="#__codelineno-0-83">83</a>

1904 -<a href="#__codelineno-0-84">84</a>

1905 -<a href="#__codelineno-0-85">85</a>

1906 -<a href="#__codelineno-0-86">86</a>

1907 -<a href="#__codelineno-0-87">87</a>

1908 -<a href="#__codelineno-0-88">88</a>

1909 -<a href="#__codelineno-0-89">89</a>

1910 -<a href="#__codelineno-0-90">90</a>

1911 -<a href="#__codelineno-0-91">91</a>

1912 -<a href="#__codelineno-0-92">92</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-61" name="__codelineno-0-61"></a>def get_case(self, case_id: int) -> bool:

1913 -<a id="__codelineno-0-62" name="__codelineno-0-62"></a> """

1914 -<a id="__codelineno-0-63" name="__codelineno-0-63"></a> Gets a case from DFIR-IRIS and returns all the details

1915 -<a id="__codelineno-0-64" name="__codelineno-0-64"></a>

1916 -<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Returns:

1917 -<a id="__codelineno-0-66" name="__codelineno-0-66"></a> dict: A dictionary containing the success status, a message and potentially the case.

1918 -<a id="__codelineno-0-67" name="__codelineno-0-67"></a> """

1919 -<a id="__codelineno-0-68" name="__codelineno-0-68"></a> if self.iris_session is None:

1920 -<a id="__codelineno-0-69" name="__codelineno-0-69"></a> return {

1921 -<a id="__codelineno-0-70" name="__codelineno-0-70"></a> "success": False,

1922 -<a id="__codelineno-0-71" name="__codelineno-0-71"></a> "message": "DFIR-IRIS session was not successfully created.",

1923 -<a id="__codelineno-0-72" name="__codelineno-0-72"></a> }

1924 -<a id="__codelineno-0-73" name="__codelineno-0-73"></a>

1925 -<a id="__codelineno-0-74" name="__codelineno-0-74"></a> logger.info(f"Collecting case {case_id} from DFIR-IRIS")

1926 -<a id="__codelineno-0-75" name="__codelineno-0-75"></a> case = Case(session=self.iris_session)

1927 -<a id="__codelineno-0-76" name="__codelineno-0-76"></a> result = self.universal_service.fetch_and_parse_data(

1928 -<a id="__codelineno-0-77" name="__codelineno-0-77"></a> self.iris_session,

1929 -<a id="__codelineno-0-78" name="__codelineno-0-78"></a> case.get_case,

1930 -<a id="__codelineno-0-79" name="__codelineno-0-79"></a> case_id,

1931 -<a id="__codelineno-0-80" name="__codelineno-0-80"></a> )

1932 -<a id="__codelineno-0-81" name="__codelineno-0-81"></a>

1933 -<a id="__codelineno-0-82" name="__codelineno-0-82"></a> if not result["success"]:

1934 -<a id="__codelineno-0-83" name="__codelineno-0-83"></a> return {

1935 -<a id="__codelineno-0-84" name="__codelineno-0-84"></a> "success": False,

1936 -<a id="__codelineno-0-85" name="__codelineno-0-85"></a> "message": f"Failed to collect case {case_id} from DFIR-IRIS",

1937 -<a id="__codelineno-0-86" name="__codelineno-0-86"></a> }

1938 -<a id="__codelineno-0-87" name="__codelineno-0-87"></a>

1939 -<a id="__codelineno-0-88" name="__codelineno-0-88"></a> return {

1940 -<a id="__codelineno-0-89" name="__codelineno-0-89"></a> "success": True,

1941 -<a id="__codelineno-0-90" name="__codelineno-0-90"></a> "message": f"Successfully collected case {case_id} from DFIR-IRIS",

1942 -<a id="__codelineno-0-91" name="__codelineno-0-91"></a> "case": result["data"],

1943 -<a id="__codelineno-0-92" name="__codelineno-0-92"></a> }

1944 -</code></pre></div></td></tr></table></div>

1945 - </details>

1946 - </div>

1947 -

1948 -</div>

1949 -

1950 -<div class="doc doc-object doc-function">

1951 -

1952 -

1953 -

1954 -<h3 id="app.services.DFIR_IRIS.cases.CasesService.list_cases" class="doc doc-heading">

1955 -<code class="highlight language-python">list_cases()</code>

1956 -

1957 -</h3>

1958 -

1959 -

1960 - <div class="doc doc-contents ">

1961 -

1962 - Lists all cases from DFIR-IRIS

1963 -

1964 - Returns:

1965 - <table>

1966 - <thead>

1967 - <tr>

1968 -<th>Name</th> <th>Type</th>

1969 - <th>Description</th>

1970 - </tr>

1971 - </thead>

1972 - <tbody>

1973 - <tr>

1974 -<td><code>dict</code></td> <td>

1975 - <code>Dict[str, object]</code>

1976 - </td>

1977 - <td>

1978 - <div class="doc-md-description">

1979 - A dictionary containing the success status, a message and potentially the cases.

1980 - </div>

1981 - </td>

1982 - </tr>

1983 - </tbody>

1984 - </table>

1985 -

1986 - <details class="quote">

1987 - <summary>Source code in <code>app\services\DFIR_IRIS\cases.py</code></summary>

1988 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-29">29</a>

1989 -<a href="#__codelineno-0-30">30</a>

1990 -<a href="#__codelineno-0-31">31</a>

1991 -<a href="#__codelineno-0-32">32</a>

1992 -<a href="#__codelineno-0-33">33</a>

1993 -<a href="#__codelineno-0-34">34</a>

1994 -<a href="#__codelineno-0-35">35</a>

1995 -<a href="#__codelineno-0-36">36</a>

1996 -<a href="#__codelineno-0-37">37</a>

1997 -<a href="#__codelineno-0-38">38</a>

1998 -<a href="#__codelineno-0-39">39</a>

1999 -<a href="#__codelineno-0-40">40</a>

2000 -<a href="#__codelineno-0-41">41</a>

2001 -<a href="#__codelineno-0-42">42</a>

2002 -<a href="#__codelineno-0-43">43</a>

2003 -<a href="#__codelineno-0-44">44</a>

2004 -<a href="#__codelineno-0-45">45</a>

2005 -<a href="#__codelineno-0-46">46</a>

2006 -<a href="#__codelineno-0-47">47</a>

2007 -<a href="#__codelineno-0-48">48</a>

2008 -<a href="#__codelineno-0-49">49</a>

2009 -<a href="#__codelineno-0-50">50</a>

2010 -<a href="#__codelineno-0-51">51</a>

2011 -<a href="#__codelineno-0-52">52</a>

2012 -<a href="#__codelineno-0-53">53</a>

2013 -<a href="#__codelineno-0-54">54</a>

2014 -<a href="#__codelineno-0-55">55</a>

2015 -<a href="#__codelineno-0-56">56</a>

2016 -<a href="#__codelineno-0-57">57</a>

2017 -<a href="#__codelineno-0-58">58</a>

2018 -<a href="#__codelineno-0-59">59</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-29" name="__codelineno-0-29"></a>def list_cases(self) -> Dict[str, object]:

2019 -<a id="__codelineno-0-30" name="__codelineno-0-30"></a> """

2020 -<a id="__codelineno-0-31" name="__codelineno-0-31"></a> Lists all cases from DFIR-IRIS

2021 -<a id="__codelineno-0-32" name="__codelineno-0-32"></a>

2022 -<a id="__codelineno-0-33" name="__codelineno-0-33"></a> Returns:

2023 -<a id="__codelineno-0-34" name="__codelineno-0-34"></a> dict: A dictionary containing the success status, a message and potentially the cases.

2024 -<a id="__codelineno-0-35" name="__codelineno-0-35"></a> """

2025 -<a id="__codelineno-0-36" name="__codelineno-0-36"></a> if self.iris_session is None:

2026 -<a id="__codelineno-0-37" name="__codelineno-0-37"></a> return {

2027 -<a id="__codelineno-0-38" name="__codelineno-0-38"></a> "success": False,

2028 -<a id="__codelineno-0-39" name="__codelineno-0-39"></a> "message": "DFIR-IRIS session was not successfully created.",

2029 -<a id="__codelineno-0-40" name="__codelineno-0-40"></a> }

2030 -<a id="__codelineno-0-41" name="__codelineno-0-41"></a>

2031 -<a id="__codelineno-0-42" name="__codelineno-0-42"></a> logger.info("Collecting cases from DFIR-IRIS")

2032 -<a id="__codelineno-0-43" name="__codelineno-0-43"></a> case = Case(session=self.iris_session)

2033 -<a id="__codelineno-0-44" name="__codelineno-0-44"></a> result = self.universal_service.fetch_and_parse_data(

2034 -<a id="__codelineno-0-45" name="__codelineno-0-45"></a> self.iris_session,

2035 -<a id="__codelineno-0-46" name="__codelineno-0-46"></a> case.list_cases,

2036 -<a id="__codelineno-0-47" name="__codelineno-0-47"></a> )

2037 -<a id="__codelineno-0-48" name="__codelineno-0-48"></a>

2038 -<a id="__codelineno-0-49" name="__codelineno-0-49"></a> if not result["success"]:

2039 -<a id="__codelineno-0-50" name="__codelineno-0-50"></a> return {

2040 -<a id="__codelineno-0-51" name="__codelineno-0-51"></a> "success": False,

2041 -<a id="__codelineno-0-52" name="__codelineno-0-52"></a> "message": "Failed to collect cases from DFIR-IRIS",

2042 -<a id="__codelineno-0-53" name="__codelineno-0-53"></a> }

2043 -<a id="__codelineno-0-54" name="__codelineno-0-54"></a>

2044 -<a id="__codelineno-0-55" name="__codelineno-0-55"></a> return {

2045 -<a id="__codelineno-0-56" name="__codelineno-0-56"></a> "success": True,

2046 -<a id="__codelineno-0-57" name="__codelineno-0-57"></a> "message": "Successfully collected cases from DFIR-IRIS",

2047 -<a id="__codelineno-0-58" name="__codelineno-0-58"></a> "cases": result["data"],

2048 -<a id="__codelineno-0-59" name="__codelineno-0-59"></a> }

2049 -</code></pre></div></td></tr></table></div>

2050 - </details>

2051 - </div>

2052 -

2053 -</div>

2054 -

2055 -

2056 -

2057 - </div>

2058 -

2059 - </div>

2060 -

2061 -</div>

2062 -

2063 -

2064 -

2065 -

2066 - </div>

2067 -

2068 - </div>

2069 -

2070 -</div>

2071 -

2072 -

2073 -

2074 -

2075 -

2076 -

2077 - </article>

2078 - </div>

2079 -

2080 -

2081 - <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>

2082 -

2083 - </div>

2084 -

2085 - <button type="button" class="md-top md-icon" data-md-component="top" hidden>

2086 - <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg>

2087 - Back to top

2088 - </button>

2089 -

2090 - </main>

2091 -

2092 - <footer class="md-footer">

2093 -

2094 - <div class="md-footer-meta md-typeset">

2095 - <div class="md-footer-meta__inner md-grid">

2096 - <div class="md-copyright">

2097 -

2098 - <div class="md-copyright__highlight">

2100 -

2101 - </div>

2102 -

2103 -

2104 - Made with

2105 - <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">

2106 - Material for MkDocs

2107 - </a>

2108 -

2109 -</div>

2110 -

2111 - </div>

2112 - </div>

2113 -</footer>

2114 -

2115 - </div>

2116 - <div class="md-dialog" data-md-component="dialog">

2117 - <div class="md-dialog__inner md-typeset"></div>

2118 - </div>

2119 -

2120 - <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.sections", "toc.integrate", "navigation.top", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy"], "search": "../assets/javascripts/workers/search.74e28a9f.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>

2121 -

2122 -

2123 - <script src="../assets/javascripts/bundle.220ee61c.min.js"></script>

2124 -

2125 -

2126 - </body>

2127 -</html>

\ No newline at end of file

backend/site/connectors/index.html

+47 -20

@@ -200,8 +200,8 @@

200

201

202 <li class="md-tabs__item">

203 - <a href="../alerts/" class="md-tabs__link">

204 - Alerts

203 + <a href="../wazuhindexer/" class="md-tabs__link">

204 + Wazuh-Indexer

205 </a>

206 </li>

207

@@ -212,8 +212,8 @@

212

213

214 <li class="md-tabs__item">

215 - <a href="../artifacts/" class="md-tabs__link">

216 - Artifacts

215 + <a href="../dfiriris/" class="md-tabs__link">

216 + Dfir-Iris

217 </a>

218 </li>

219

@@ -224,8 +224,8 @@

224

225

226 <li class="md-tabs__item">

227 - <a href="../cases/" class="md-tabs__link">

228 - Cases

227 + <a href="../graylog/" class="md-tabs__link">

228 + Graylog

229 </a>

230 </li>

231

@@ -236,8 +236,8 @@

236

237

238 <li class="md-tabs__item">

239 - <a href="../graylog/" class="md-tabs__link">

240 - Graylog

239 + <a href="../wazuhmanager/" class="md-tabs__link">

240 + Wazuh-Manager

241 </a>

242 </li>

243

@@ -248,8 +248,20 @@

248

249

250 <li class="md-tabs__item">

251 - <a href="../wazuhmanager/" class="md-tabs__link">

252 - Wazuh-Manager

251 + <a href="../velociraptor/" class="md-tabs__link">

252 + Velociraptor

253 + </a>

254 + </li>

255 +

256 +

257 +

258 +

259 +

260 +

261 +

262 + <li class="md-tabs__item">

263 + <a href="../shuffle/" class="md-tabs__link">

264 + Shuffle

265 </a>

266 </li>

267

@@ -743,8 +755,8 @@

755

756

757 <li class="md-nav__item">

746 - <a href="../alerts/" class="md-nav__link">

747 - Alerts

758 + <a href="../wazuhindexer/" class="md-nav__link">

759 + Wazuh-Indexer

760 </a>

761 </li>

762

@@ -758,8 +770,8 @@

770

771

772 <li class="md-nav__item">

761 - <a href="../artifacts/" class="md-nav__link">

762 - Artifacts

773 + <a href="../dfiriris/" class="md-nav__link">

774 + Dfir-Iris

775 </a>

776 </li>

777

@@ -773,8 +785,8 @@

785

786

787 <li class="md-nav__item">

776 - <a href="../cases/" class="md-nav__link">

777 - Cases

788 + <a href="../graylog/" class="md-nav__link">

789 + Graylog

790 </a>

791 </li>

792

@@ -788,8 +800,8 @@

800

801

802 <li class="md-nav__item">

791 - <a href="../graylog/" class="md-nav__link">

792 - Graylog

803 + <a href="../wazuhmanager/" class="md-nav__link">

804 + Wazuh-Manager

805 </a>

806 </li>

807

@@ -803,8 +815,23 @@

815

816

817 <li class="md-nav__item">

806 - <a href="../wazuhmanager/" class="md-nav__link">

807 - Wazuh-Manager

818 + <a href="../velociraptor/" class="md-nav__link">

819 + Velociraptor

820 + </a>

821 + </li>

822 +

823 +

824 +

825 +

826 +

827 +

828 +

829 +

830 +

831 +

832 + <li class="md-nav__item">

833 + <a href="../shuffle/" class="md-nav__link">

834 + Shuffle

835 </a>

836 </li>

837

backend/site/dfiriris/index.html new

+4716

@@ -0,0 +1,4716 @@

1 +

2 +<!doctype html>

3 +<html lang="en" class="no-js">

4 + <head>

5 +

6 + <meta charset="utf-8">

7 + <meta name="viewport" content="width=device-width,initial-scale=1">

8 +

9 +

10 +

11 +

12 + <link rel="prev" href="../wazuhindexer/">

13 +

14 +

15 + <link rel="next" href="../graylog/">

16 +

17 + <link rel="icon" href="../assets/images/favicon.png">

18 + <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18">

19 +

20 +

21 +

22 + <title>Dfir-Iris - SOCFortress CoPilot</title>

23 +

24 +

25 +

26 + <link rel="stylesheet" href="../assets/stylesheets/main.26e3688c.min.css">

27 +

28 +

29 + <link rel="stylesheet" href="../assets/stylesheets/palette.ecc896b0.min.css">

30 +

31 +

32 +

33 +

34 +

35 +

36 +

37 +

38 +

39 + <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>

40 + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">

41 + <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>

42 +

43 +

44 +

45 + <link rel="stylesheet" href="../assets/_mkdocstrings.css">

46 +

47 + <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>

48 +

49 +

50 +

51 +

52 +

53 +

54 + </head>

55 +

56 +

57 +

58 +

59 +

60 +

61 +

62 +

63 +

64 + <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="purple">

65 +

66 +

67 +

68 + <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>

69 +

70 + <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">

71 + <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">

72 + <label class="md-overlay" for="__drawer"></label>

73 + <div data-md-component="skip">

74 +

75 +

76 + <a href="#dfir-iris-overview" class="md-skip">

77 + Skip to content

78 + </a>

79 +

80 + </div>

81 + <div data-md-component="announce">

82 +

83 + </div>

84 +

85 +

86 +

87 +

88 +<header class="md-header" data-md-component="header">

89 + <nav class="md-header__inner md-grid" aria-label="Header">

90 + <a href=".." title="SOCFortress CoPilot" class="md-header__button md-logo" aria-label="SOCFortress CoPilot" data-md-component="logo">

91 +

92 +

93 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

94 +

95 + </a>

96 + <label class="md-header__button md-icon" for="__drawer">

97 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>

98 + </label>

99 + <div class="md-header__title" data-md-component="header-title">

100 + <div class="md-header__ellipsis">

101 + <div class="md-header__topic">

102 +

103 + SOCFortress CoPilot

104 +

105 + </div>

106 + <div class="md-header__topic" data-md-component="header-topic">

107 +

108 +

109 + Dfir-Iris

110 +

111 +

112 + </div>

113 + </div>

114 + </div>

115 +

116 +

117 + <form class="md-header__option" data-md-component="palette">

118 +

119 +

120 +

121 +

122 + <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="purple" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">

123 +

124 + <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>

125 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6zm0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4zM7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z"/></svg>

126 + </label>

127 +

128 +

129 +

130 +

131 +

132 + <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="teal" data-md-color-accent="lime" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">

133 +

134 + <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>

135 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3Z"/></svg>

136 + </label>

137 +

138 +

139 + </form>

140 +

141 +

142 +

143 +

144 +

145 + </nav>

146 +

147 +</header>

148 +

149 + <div class="md-container" data-md-component="container">

150 +

151 +

152 +

153 +

154 +

155 +<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">

156 + <div class="md-grid">

157 + <ul class="md-tabs__list">

158 +

159 +

160 +

161 +

162 +

163 +

164 + <li class="md-tabs__item">

165 + <a href=".." class="md-tabs__link">

166 + Home

167 + </a>

168 + </li>

169 +

170 +

171 +

172 +

173 +

174 +

175 +

176 + <li class="md-tabs__item">

177 + <a href="../connectors/" class="md-tabs__link">

178 + Connectors

179 + </a>

180 + </li>

181 +

182 +

183 +

184 +

185 +

186 +

187 +

188 + <li class="md-tabs__item">

189 + <a href="../agents/" class="md-tabs__link">

190 + Agents

191 + </a>

192 + </li>

193 +

194 +

195 +

196 +

197 +

198 +

199 +

200 + <li class="md-tabs__item">

201 + <a href="../wazuhindexer/" class="md-tabs__link">

202 + Wazuh-Indexer

203 + </a>

204 + </li>

205 +

206 +

207 +

208 +

209 +

210 +

211 +

212 +

213 +

214 + <li class="md-tabs__item">

215 + <a href="./" class="md-tabs__link md-tabs__link--active">

216 + Dfir-Iris

217 + </a>

218 + </li>

219 +

220 +

221 +

222 +

223 +

224 +

225 +

226 + <li class="md-tabs__item">

227 + <a href="../graylog/" class="md-tabs__link">

228 + Graylog

229 + </a>

230 + </li>

231 +

232 +

233 +

234 +

235 +

236 +

237 +

238 + <li class="md-tabs__item">

239 + <a href="../wazuhmanager/" class="md-tabs__link">

240 + Wazuh-Manager

241 + </a>

242 + </li>

243 +

244 +

245 +

246 +

247 +

248 +

249 +

250 + <li class="md-tabs__item">

251 + <a href="../velociraptor/" class="md-tabs__link">

252 + Velociraptor

253 + </a>

254 + </li>

255 +

256 +

257 +

258 +

259 +

260 +

261 +

262 + <li class="md-tabs__item">

263 + <a href="../shuffle/" class="md-tabs__link">

264 + Shuffle

265 + </a>

266 + </li>

267 +

268 +

269 + </ul>

270 + </div>

271 +</nav>

272 +

273 +

274 +

275 + <main class="md-main" data-md-component="main">

276 + <div class="md-main__inner md-grid">

277 +

278 +

279 +

280 + <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >

281 + <div class="md-sidebar__scrollwrap">

282 + <div class="md-sidebar__inner">

283 +

284 +

285 +

286 +

287 +

288 +

289 +

290 +<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">

291 + <label class="md-nav__title" for="__drawer">

292 + <a href=".." title="SOCFortress CoPilot" class="md-nav__button md-logo" aria-label="SOCFortress CoPilot" data-md-component="logo">

293 +

294 +

295 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

296 +

297 + </a>

298 + SOCFortress CoPilot

299 + </label>

300 +

301 + <ul class="md-nav__list" data-md-scrollfix>

302 +

303 +

304 +

305 +

306 +

307 +

308 +

309 +

310 + <li class="md-nav__item">

311 + <a href=".." class="md-nav__link">

312 + Home

313 + </a>

314 + </li>

315 +

316 +

317 +

318 +

319 +

320 +

321 +

322 +

323 +

324 +

325 + <li class="md-nav__item">

326 + <a href="../connectors/" class="md-nav__link">

327 + Connectors

328 + </a>

329 + </li>

330 +

331 +

332 +

333 +

334 +

335 +

336 +

337 +

338 +

339 +

340 + <li class="md-nav__item">

341 + <a href="../agents/" class="md-nav__link">

342 + Agents

343 + </a>

344 + </li>

345 +

346 +

347 +

348 +

349 +

350 +

351 +

352 +

353 +

354 +

355 + <li class="md-nav__item">

356 + <a href="../wazuhindexer/" class="md-nav__link">

357 + Wazuh-Indexer

358 + </a>

359 + </li>

360 +

361 +

362 +

363 +

364 +

365 +

366 +

367 +

368 +

369 +

370 +

371 +

372 + <li class="md-nav__item md-nav__item--active">

373 +

374 + <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">

375 +

376 +

377 +

378 + <label class="md-nav__link md-nav__link--active" for="__toc">

379 + Dfir-Iris

380 +

381 + </label>

382 +

383 + <a href="./" class="md-nav__link md-nav__link--active">

384 + Dfir-Iris

385 + </a>

386 +

387 +

388 +

389 +<nav class="md-nav md-nav--secondary" aria-label="Table of contents">

390 +

391 +

392 +

393 +

394 + <label class="md-nav__title" for="__toc">

395 +

396 + Table of contents

397 + </label>

398 + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

399 +

400 + <li class="md-nav__item">

401 + <a href="#dfir-iris-overview" class="md-nav__link">

402 + Dfir-Iris Overview

403 + </a>

404 +

405 + <nav class="md-nav" aria-label="Dfir-Iris Overview">

406 + <ul class="md-nav__list">

407 +

408 + <li class="md-nav__item">

409 + <a href="#cases-model" class="md-nav__link">

410 + Cases Model

411 + </a>

412 +

413 +</li>

414 +

415 + </ul>

416 + </nav>

417 +

418 +</li>

419 +

420 + <li class="md-nav__item">

421 + <a href="#app.models.cases" class="md-nav__link">

422 + app.models.cases

423 + </a>

424 +

425 +</li>

426 +

427 + <li class="md-nav__item">

428 + <a href="#app.models.cases.Case" class="md-nav__link">

429 + Case

430 + </a>

431 +

432 + <nav class="md-nav" aria-label="Case">

433 + <ul class="md-nav__list">

434 +

435 + <li class="md-nav__item">

436 + <a href="#app.models.cases.Case.__init__" class="md-nav__link">

437 + __init__()

438 + </a>

439 +

440 +</li>

441 +

442 + <li class="md-nav__item">

443 + <a href="#app.models.cases.Case.__repr__" class="md-nav__link">

444 + __repr__()

445 + </a>

446 +

447 +</li>

448 +

449 + </ul>

450 + </nav>

451 +

452 +</li>

453 +

454 + <li class="md-nav__item">

455 + <a href="#app.models.cases.CaseSchema" class="md-nav__link">

456 + CaseSchema

457 + </a>

458 +

459 + <nav class="md-nav" aria-label="CaseSchema">

460 + <ul class="md-nav__list">

461 +

462 + <li class="md-nav__item">

463 + <a href="#app.models.cases.CaseSchema.Meta" class="md-nav__link">

464 + Meta

465 + </a>

466 +

467 +</li>

468 +

469 + <li class="md-nav__item">

470 + <a href="#cases-routes" class="md-nav__link">

471 + Cases Routes

472 + </a>

473 +

474 +</li>

475 +

476 + </ul>

477 + </nav>

478 +

479 +</li>

480 +

481 + <li class="md-nav__item">

482 + <a href="#app.routes.dfir_iris.get_cases" class="md-nav__link">

483 + app.routes.dfir_iris.get_cases

484 + </a>

485 +

486 +</li>

487 +

488 + <li class="md-nav__item">

489 + <a href="#app.routes.dfir_iris.get_case" class="md-nav__link">

490 + app.routes.dfir_iris.get_case

491 + </a>

492 +

493 + <nav class="md-nav" aria-label="app.routes.dfir_iris.get_case">

494 + <ul class="md-nav__list">

495 +

496 + <li class="md-nav__item">

497 + <a href="#notes-routes" class="md-nav__link">

498 + Notes Routes

499 + </a>

500 +

501 +</li>

502 +

503 + </ul>

504 + </nav>

505 +

506 +</li>

507 +

508 + <li class="md-nav__item">

509 + <a href="#app.routes.dfir_iris.get_case_notes" class="md-nav__link">

510 + app.routes.dfir_iris.get_case_notes

511 + </a>

512 +

513 +</li>

514 +

515 + <li class="md-nav__item">

516 + <a href="#app.routes.dfir_iris.create_case_note" class="md-nav__link">

517 + app.routes.dfir_iris.create_case_note

518 + </a>

519 +

520 + <nav class="md-nav" aria-label="app.routes.dfir_iris.create_case_note">

521 + <ul class="md-nav__list">

522 +

523 + <li class="md-nav__item">

524 + <a href="#assets-routes" class="md-nav__link">

525 + Assets Routes

526 + </a>

527 +

528 +</li>

529 +

530 + </ul>

531 + </nav>

532 +

533 +</li>

534 +

535 + <li class="md-nav__item">

536 + <a href="#app.routes.dfir_iris.get_case_assets" class="md-nav__link">

537 + app.routes.dfir_iris.get_case_assets

538 + </a>

539 +

540 + <nav class="md-nav" aria-label="app.routes.dfir_iris.get_case_assets">

541 + <ul class="md-nav__list">

542 +

543 + <li class="md-nav__item">

544 + <a href="#alerts-routes" class="md-nav__link">

545 + Alerts Routes

546 + </a>

547 +

548 +</li>

549 +

550 + </ul>

551 + </nav>

552 +

553 +</li>

554 +

555 + <li class="md-nav__item">

556 + <a href="#app.routes.dfir_iris.get_alerts" class="md-nav__link">

557 + app.routes.dfir_iris.get_alerts

558 + </a>

559 +

560 + <nav class="md-nav" aria-label="app.routes.dfir_iris.get_alerts">

561 + <ul class="md-nav__list">

562 +

563 + <li class="md-nav__item">

564 + <a href="#alerts-services" class="md-nav__link">

565 + Alerts Services

566 + </a>

567 +

568 +</li>

569 +

570 + </ul>

571 + </nav>

572 +

573 +</li>

574 +

575 + <li class="md-nav__item">

576 + <a href="#app.services.DFIR_IRIS.alerts" class="md-nav__link">

577 + app.services.DFIR_IRIS.alerts

578 + </a>

579 +

580 +</li>

581 +

582 + <li class="md-nav__item">

583 + <a href="#app.services.DFIR_IRIS.alerts.AlertsService" class="md-nav__link">

584 + AlertsService

585 + </a>

586 +

587 + <nav class="md-nav" aria-label="AlertsService">

588 + <ul class="md-nav__list">

589 +

590 + <li class="md-nav__item">

591 + <a href="#app.services.DFIR_IRIS.alerts.AlertsService.__init__" class="md-nav__link">

592 + __init__()

593 + </a>

594 +

595 +</li>

596 +

597 + <li class="md-nav__item">

598 + <a href="#app.services.DFIR_IRIS.alerts.AlertsService.list_alerts" class="md-nav__link">

599 + list_alerts()

600 + </a>

601 +

602 +</li>

603 +

604 + <li class="md-nav__item">

605 + <a href="#cases-services" class="md-nav__link">

606 + Cases Services

607 + </a>

608 +

609 +</li>

610 +

611 + </ul>

612 + </nav>

613 +

614 +</li>

615 +

616 + <li class="md-nav__item">

617 + <a href="#app.services.DFIR_IRIS.cases" class="md-nav__link">

618 + app.services.DFIR_IRIS.cases

619 + </a>

620 +

621 +</li>

622 +

623 + <li class="md-nav__item">

624 + <a href="#app.services.DFIR_IRIS.cases.CasesService" class="md-nav__link">

625 + CasesService

626 + </a>

627 +

628 + <nav class="md-nav" aria-label="CasesService">

629 + <ul class="md-nav__list">

630 +

631 + <li class="md-nav__item">

632 + <a href="#app.services.DFIR_IRIS.cases.CasesService.check_case_id" class="md-nav__link">

633 + check_case_id()

634 + </a>

635 +

636 +</li>

637 +

638 + <li class="md-nav__item">

639 + <a href="#app.services.DFIR_IRIS.cases.CasesService.get_case" class="md-nav__link">

640 + get_case()

641 + </a>

642 +

643 +</li>

644 +

645 + <li class="md-nav__item">

646 + <a href="#app.services.DFIR_IRIS.cases.CasesService.list_cases" class="md-nav__link">

647 + list_cases()

648 + </a>

649 +

650 +</li>

651 +

652 + <li class="md-nav__item">

653 + <a href="#assets-services" class="md-nav__link">

654 + Assets Services

655 + </a>

656 +

657 +</li>

658 +

659 + </ul>

660 + </nav>

661 +

662 +</li>

663 +

664 + <li class="md-nav__item">

665 + <a href="#app.services.DFIR_IRIS.assets" class="md-nav__link">

666 + app.services.DFIR_IRIS.assets

667 + </a>

668 +

669 +</li>

670 +

671 + <li class="md-nav__item">

672 + <a href="#app.services.DFIR_IRIS.assets.AssetsService" class="md-nav__link">

673 + AssetsService

674 + </a>

675 +

676 + <nav class="md-nav" aria-label="AssetsService">

677 + <ul class="md-nav__list">

678 +

679 + <li class="md-nav__item">

680 + <a href="#app.services.DFIR_IRIS.assets.AssetsService.__init__" class="md-nav__link">

681 + __init__()

682 + </a>

683 +

684 +</li>

685 +

686 + <li class="md-nav__item">

687 + <a href="#app.services.DFIR_IRIS.assets.AssetsService.get_case_assets" class="md-nav__link">

688 + get_case_assets()

689 + </a>

690 +

691 +</li>

692 +

693 + <li class="md-nav__item">

694 + <a href="#notes-services" class="md-nav__link">

695 + Notes Services

696 + </a>

697 +

698 +</li>

699 +

700 + </ul>

701 + </nav>

702 +

703 +</li>

704 +

705 + <li class="md-nav__item">

706 + <a href="#app.services.DFIR_IRIS.notes" class="md-nav__link">

707 + app.services.DFIR_IRIS.notes

708 + </a>

709 +

710 +</li>

711 +

712 + <li class="md-nav__item">

713 + <a href="#app.services.DFIR_IRIS.notes.NotesService" class="md-nav__link">

714 + NotesService

715 + </a>

716 +

717 + <nav class="md-nav" aria-label="NotesService">

718 + <ul class="md-nav__list">

719 +

720 + <li class="md-nav__item">

721 + <a href="#app.services.DFIR_IRIS.notes.NotesService.__init__" class="md-nav__link">

722 + __init__()

723 + </a>

724 +

725 +</li>

726 +

727 + <li class="md-nav__item">

728 + <a href="#app.services.DFIR_IRIS.notes.NotesService.create_case_note" class="md-nav__link">

729 + create_case_note()

730 + </a>

731 +

732 +</li>

733 +

734 + <li class="md-nav__item">

735 + <a href="#app.services.DFIR_IRIS.notes.NotesService.get_case_notes" class="md-nav__link">

736 + get_case_notes()

737 + </a>

738 +

739 +</li>

740 +

741 + <li class="md-nav__item">

742 + <a href="#universal-services" class="md-nav__link">

743 + Universal Services

744 + </a>

745 +

746 +</li>

747 +

748 + </ul>

749 + </nav>

750 +

751 +</li>

752 +

753 + <li class="md-nav__item">

754 + <a href="#app.services.DFIR_IRIS.universal" class="md-nav__link">

755 + app.services.DFIR_IRIS.universal

756 + </a>

757 +

758 +</li>

759 +

760 + <li class="md-nav__item">

761 + <a href="#app.services.DFIR_IRIS.universal.UniversalService" class="md-nav__link">

762 + UniversalService

763 + </a>

764 +

765 + <nav class="md-nav" aria-label="UniversalService">

766 + <ul class="md-nav__list">

767 +

768 + <li class="md-nav__item">

769 + <a href="#app.services.DFIR_IRIS.universal.UniversalService.__init__" class="md-nav__link">

770 + __init__()

771 + </a>

772 +

773 +</li>

774 +

775 + <li class="md-nav__item">

776 + <a href="#app.services.DFIR_IRIS.universal.UniversalService.collect_iris_details" class="md-nav__link">

777 + collect_iris_details()

778 + </a>

779 +

780 +</li>

781 +

782 + <li class="md-nav__item">

783 + <a href="#app.services.DFIR_IRIS.universal.UniversalService.create_session" class="md-nav__link">

784 + create_session()

785 + </a>

786 +

787 +</li>

788 +

789 + <li class="md-nav__item">

790 + <a href="#app.services.DFIR_IRIS.universal.UniversalService.fetch_and_parse_data" class="md-nav__link">

791 + fetch_and_parse_data()

792 + </a>

793 +

794 +</li>

795 +

796 + </ul>

797 + </nav>

798 +

799 +</li>

800 +

801 + </ul>

802 +

803 +</nav>

804 +

805 + </li>

806 +

807 +

808 +

809 +

810 +

811 +

812 +

813 +

814 +

815 +

816 + <li class="md-nav__item">

817 + <a href="../graylog/" class="md-nav__link">

818 + Graylog

819 + </a>

820 + </li>

821 +

822 +

823 +

824 +

825 +

826 +

827 +

828 +

829 +

830 +

831 + <li class="md-nav__item">

832 + <a href="../wazuhmanager/" class="md-nav__link">

833 + Wazuh-Manager

834 + </a>

835 + </li>

836 +

837 +

838 +

839 +

840 +

841 +

842 +

843 +

844 +

845 +

846 + <li class="md-nav__item">

847 + <a href="../velociraptor/" class="md-nav__link">

848 + Velociraptor

849 + </a>

850 + </li>

851 +

852 +

853 +

854 +

855 +

856 +

857 +

858 +

859 +

860 +

861 + <li class="md-nav__item">

862 + <a href="../shuffle/" class="md-nav__link">

863 + Shuffle

864 + </a>

865 + </li>

866 +

867 +

868 +

869 + </ul>

870 +</nav>

871 + </div>

872 + </div>

873 + </div>

874 +

875 +

876 +

877 +

878 + <div class="md-content" data-md-component="content">

879 + <article class="md-content__inner md-typeset">

880 +

881 +

882 +

883 +

884 + <h1>Dfir-Iris</h1>

885 +

886 +<h2 id="dfir-iris-overview">Dfir-Iris Overview</h2>

887 +<h3 id="cases-model">Cases Model</h3>

888 +

889 +

890 +<div class="doc doc-object doc-module">

891 +

892 +

893 +<a id="app.models.cases"></a>

894 + <div class="doc doc-contents first">

895 +

896 +

897 +

898 + <div class="doc doc-children">

899 +

900 +

901 +

902 +

903 +

904 +

905 +

906 +

907 +<div class="doc doc-object doc-class">

908 +

909 +

910 +

911 +<h2 id="app.models.cases.Case" class="doc doc-heading">

912 + <code>Case</code>

913 +

914 +

915 +</h2>

916 +

917 +

918 + <div class="doc doc-contents ">

919 +

920 + Bases: <code>db.Model</code>

921 +

922 +

923 + Class for cases which stores the case ID, case name, and a list of agents.

924 +This class inherits from SQLAlchemy's Model class.

925 +

926 +

927 + <details class="quote">

928 + <summary>Source code in <code>app\models\cases.py</code></summary>

929 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-10">10</a>

930 +<a href="#__codelineno-0-11">11</a>

931 +<a href="#__codelineno-0-12">12</a>

932 +<a href="#__codelineno-0-13">13</a>

933 +<a href="#__codelineno-0-14">14</a>

934 +<a href="#__codelineno-0-15">15</a>

935 +<a href="#__codelineno-0-16">16</a>

936 +<a href="#__codelineno-0-17">17</a>

937 +<a href="#__codelineno-0-18">18</a>

938 +<a href="#__codelineno-0-19">19</a>

939 +<a href="#__codelineno-0-20">20</a>

940 +<a href="#__codelineno-0-21">21</a>

941 +<a href="#__codelineno-0-22">22</a>

942 +<a href="#__codelineno-0-23">23</a>

943 +<a href="#__codelineno-0-24">24</a>

944 +<a href="#__codelineno-0-25">25</a>

945 +<a href="#__codelineno-0-26">26</a>

946 +<a href="#__codelineno-0-27">27</a>

947 +<a href="#__codelineno-0-28">28</a>

948 +<a href="#__codelineno-0-29">29</a>

949 +<a href="#__codelineno-0-30">30</a>

950 +<a href="#__codelineno-0-31">31</a>

951 +<a href="#__codelineno-0-32">32</a>

952 +<a href="#__codelineno-0-33">33</a>

953 +<a href="#__codelineno-0-34">34</a>

954 +<a href="#__codelineno-0-35">35</a>

955 +<a href="#__codelineno-0-36">36</a>

956 +<a href="#__codelineno-0-37">37</a>

957 +<a href="#__codelineno-0-38">38</a>

958 +<a href="#__codelineno-0-39">39</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-10" name="__codelineno-0-10"></a>class Case(db.Model):

959 +<a id="__codelineno-0-11" name="__codelineno-0-11"></a> """

960 +<a id="__codelineno-0-12" name="__codelineno-0-12"></a> Class for cases which stores the case ID, case name, and a list of agents.

961 +<a id="__codelineno-0-13" name="__codelineno-0-13"></a> This class inherits from SQLAlchemy's Model class.

962 +<a id="__codelineno-0-14" name="__codelineno-0-14"></a> """

963 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a>

964 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> id: Column[Integer] = db.Column(db.Integer, primary_key=True)

965 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> case_id: Column[Integer] = db.Column(db.Integer)

966 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> case_name: Column[String] = db.Column(db.String(100))

967 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> agents: Column[String] = db.Column(db.String(1000))

968 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a>

969 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> def __init__(self, case_id: int, case_name: str, agents: str):

970 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> """

971 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> Initialize a new instance of the Case class.

972 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a>

973 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> :param case_id: The ID of the case.

974 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> :param case_name: The name of the case.

975 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> :param agents: A comma-separated string of agents associated with the case.

976 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> """

977 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> self.case_id = case_id

978 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> self.case_name = case_name

979 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> self.agents = agents

980 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a>

981 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> def __repr__(self) -> str:

982 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> """

983 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> Returns a string representation of the Case instance.

984 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a>

985 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> :return: A string representation of the case ID.

986 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> """

987 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> return f"<Case {self.case_id}>"

988 +</code></pre></div></td></tr></table></div>

989 + </details>

990 +

991 +

992 +

993 + <div class="doc doc-children">

994 +

995 +

996 +

997 +

998 +

999 +

1000 +

1001 +

1002 +

1003 +<div class="doc doc-object doc-function">

1004 +

1005 +

1006 +

1007 +<h3 id="app.models.cases.Case.__init__" class="doc doc-heading">

1008 +<code class="highlight language-python">__init__(case_id, case_name, agents)</code>

1009 +

1010 +</h3>

1011 +

1012 +

1013 + <div class="doc doc-contents ">

1014 +

1015 + Initialize a new instance of the Case class.

1016 +:param case_id: The ID of the case.

1017 +:param case_name: The name of the case.

1018 +:param agents: A comma-separated string of agents associated with the case.

1019 +

1020 + <details class="quote">

1021 + <summary>Source code in <code>app\models\cases.py</code></summary>

1022 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-21">21</a>

1023 +<a href="#__codelineno-0-22">22</a>

1024 +<a href="#__codelineno-0-23">23</a>

1025 +<a href="#__codelineno-0-24">24</a>

1026 +<a href="#__codelineno-0-25">25</a>

1027 +<a href="#__codelineno-0-26">26</a>

1028 +<a href="#__codelineno-0-27">27</a>

1029 +<a href="#__codelineno-0-28">28</a>

1030 +<a href="#__codelineno-0-29">29</a>

1031 +<a href="#__codelineno-0-30">30</a>

1032 +<a href="#__codelineno-0-31">31</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-21" name="__codelineno-0-21"></a>def __init__(self, case_id: int, case_name: str, agents: str):

1033 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> """

1034 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> Initialize a new instance of the Case class.

1035 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a>

1036 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> :param case_id: The ID of the case.

1037 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> :param case_name: The name of the case.

1038 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> :param agents: A comma-separated string of agents associated with the case.

1039 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> """

1040 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> self.case_id = case_id

1041 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> self.case_name = case_name

1042 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> self.agents = agents

1043 +</code></pre></div></td></tr></table></div>

1044 + </details>

1045 + </div>

1046 +

1047 +</div>

1048 +

1049 +<div class="doc doc-object doc-function">

1050 +

1051 +

1052 +

1053 +<h3 id="app.models.cases.Case.__repr__" class="doc doc-heading">

1054 +<code class="highlight language-python">__repr__()</code>

1055 +

1056 +</h3>

1057 +

1058 +

1059 + <div class="doc doc-contents ">

1060 +

1061 + Returns a string representation of the Case instance.

1062 +:return: A string representation of the case ID.

1063 +

1064 + <details class="quote">

1065 + <summary>Source code in <code>app\models\cases.py</code></summary>

1066 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-33">33</a>

1067 +<a href="#__codelineno-0-34">34</a>

1068 +<a href="#__codelineno-0-35">35</a>

1069 +<a href="#__codelineno-0-36">36</a>

1070 +<a href="#__codelineno-0-37">37</a>

1071 +<a href="#__codelineno-0-38">38</a>

1072 +<a href="#__codelineno-0-39">39</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-33" name="__codelineno-0-33"></a>def __repr__(self) -> str:

1073 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> """

1074 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> Returns a string representation of the Case instance.

1075 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a>

1076 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> :return: A string representation of the case ID.

1077 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> """

1078 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> return f"<Case {self.case_id}>"

1079 +</code></pre></div></td></tr></table></div>

1080 + </details>

1081 + </div>

1082 +

1083 +</div>

1084 +

1085 +

1086 +

1087 + </div>

1088 +

1089 + </div>

1090 +

1091 +</div>

1092 +

1093 +<div class="doc doc-object doc-class">

1094 +

1095 +

1096 +

1097 +<h2 id="app.models.cases.CaseSchema" class="doc doc-heading">

1098 + <code>CaseSchema</code>

1099 +

1100 +

1101 +</h2>

1102 +

1103 +

1104 + <div class="doc doc-contents ">

1105 +

1106 + Bases: <code>ma.Schema</code>

1107 +

1108 +

1109 + Schema for serializing and deserializing instances of the Case class.

1110 +

1111 +

1112 + <details class="quote">

1113 + <summary>Source code in <code>app\models\cases.py</code></summary>

1114 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-42">42</a>

1115 +<a href="#__codelineno-0-43">43</a>

1116 +<a href="#__codelineno-0-44">44</a>

1117 +<a href="#__codelineno-0-45">45</a>

1118 +<a href="#__codelineno-0-46">46</a>

1119 +<a href="#__codelineno-0-47">47</a>

1120 +<a href="#__codelineno-0-48">48</a>

1121 +<a href="#__codelineno-0-49">49</a>

1122 +<a href="#__codelineno-0-50">50</a>

1123 +<a href="#__codelineno-0-51">51</a>

1124 +<a href="#__codelineno-0-52">52</a>

1125 +<a href="#__codelineno-0-53">53</a>

1126 +<a href="#__codelineno-0-54">54</a>

1127 +<a href="#__codelineno-0-55">55</a>

1128 +<a href="#__codelineno-0-56">56</a>

1129 +<a href="#__codelineno-0-57">57</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-42" name="__codelineno-0-42"></a>class CaseSchema(ma.Schema):

1130 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> """

1131 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> Schema for serializing and deserializing instances of the Case class.

1132 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> """

1133 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a>

1134 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> class Meta:

1135 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> """

1136 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> Meta class defines the fields to be serialized/deserialized.

1137 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> """

1138 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a>

1139 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> fields: tuple = (

1140 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> "id",

1141 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> "case_id",

1142 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> "case_name",

1143 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> "agents",

1144 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> )

1145 +</code></pre></div></td></tr></table></div>

1146 + </details>

1147 +

1148 +

1149 +

1150 + <div class="doc doc-children">

1151 +

1152 +

1153 +

1154 +

1155 +

1156 +

1157 +

1158 +

1159 +<div class="doc doc-object doc-class">

1160 +

1161 +

1162 +

1163 +<h3 id="app.models.cases.CaseSchema.Meta" class="doc doc-heading">

1164 + <code>Meta</code>

1165 +

1166 +

1167 +</h3>

1168 +

1169 +

1170 + <div class="doc doc-contents ">

1171 +

1172 +

1173 + Meta class defines the fields to be serialized/deserialized.

1174 +

1175 +

1176 + <details class="quote">

1177 + <summary>Source code in <code>app\models\cases.py</code></summary>

1178 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-47">47</a>

1179 +<a href="#__codelineno-0-48">48</a>

1180 +<a href="#__codelineno-0-49">49</a>

1181 +<a href="#__codelineno-0-50">50</a>

1182 +<a href="#__codelineno-0-51">51</a>

1183 +<a href="#__codelineno-0-52">52</a>

1184 +<a href="#__codelineno-0-53">53</a>

1185 +<a href="#__codelineno-0-54">54</a>

1186 +<a href="#__codelineno-0-55">55</a>

1187 +<a href="#__codelineno-0-56">56</a>

1188 +<a href="#__codelineno-0-57">57</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-47" name="__codelineno-0-47"></a>class Meta:

1189 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> """

1190 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> Meta class defines the fields to be serialized/deserialized.

1191 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> """

1192 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a>

1193 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> fields: tuple = (

1194 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> "id",

1195 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> "case_id",

1196 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> "case_name",

1197 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> "agents",

1198 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> )

1199 +</code></pre></div></td></tr></table></div>

1200 + </details>

1201 +

1202 +

1203 +

1204 + <div class="doc doc-children">

1205 +

1206 +

1207 +

1208 +

1209 +

1210 +

1211 +

1212 +

1213 +

1214 +

1215 +

1216 + </div>

1217 +

1218 + </div>

1219 +

1220 +</div>

1221 +

1222 +

1223 +

1224 +

1225 + </div>

1226 +

1227 + </div>

1228 +

1229 +</div>

1230 +

1231 +

1232 +

1233 +

1234 + </div>

1235 +

1236 + </div>

1237 +

1238 +</div>

1239 +<h3 id="cases-routes">Cases Routes</h3>

1240 +

1241 +

1242 +<div class="doc doc-object doc-function">

1243 +

1244 +

1245 +<a id="app.routes.dfir_iris.get_cases"></a>

1246 + <div class="doc doc-contents first">

1247 +

1248 + Handle GET requests at the "/cases" endpoint. Retrieve all cases from DFIR IRIS.

1249 +

1250 + Returns:

1251 + <table>

1252 + <thead>

1253 + <tr>

1254 +<th>Name</th> <th>Type</th>

1255 + <th>Description</th>

1256 + </tr>

1257 + </thead>

1258 + <tbody>

1259 + <tr>

1260 +<td><code>Response</code></td> <td>

1261 + </td>

1262 + <td>

1263 + <div class="doc-md-description">

1264 + A Flask Response object carrying a JSON representation of the list of cases.

1265 + </div>

1266 + </td>

1267 + </tr>

1268 + </tbody>

1269 + </table>

1270 +

1271 + <details class="quote">

1272 + <summary>Source code in <code>app\routes\dfir_iris.py</code></summary>

1273 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-12">12</a>

1274 +<a href="#__codelineno-0-13">13</a>

1275 +<a href="#__codelineno-0-14">14</a>

1276 +<a href="#__codelineno-0-15">15</a>

1277 +<a href="#__codelineno-0-16">16</a>

1278 +<a href="#__codelineno-0-17">17</a>

1279 +<a href="#__codelineno-0-18">18</a>

1280 +<a href="#__codelineno-0-19">19</a>

1281 +<a href="#__codelineno-0-20">20</a>

1282 +<a href="#__codelineno-0-21">21</a>

1283 +<a href="#__codelineno-0-22">22</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-12" name="__codelineno-0-12"></a>@bp.route("/dfir_iris/cases", methods=["GET"])

1284 +<a id="__codelineno-0-13" name="__codelineno-0-13"></a>def get_cases():

1285 +<a id="__codelineno-0-14" name="__codelineno-0-14"></a> """

1286 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a> Handle GET requests at the "/cases" endpoint. Retrieve all cases from DFIR IRIS.

1287 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a>

1288 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> Returns:

1289 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> Response: A Flask Response object carrying a JSON representation of the list of cases.

1290 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> """

1291 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> service = CasesService()

1292 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> cases = service.list_cases()

1293 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> return cases

1294 +</code></pre></div></td></tr></table></div>

1295 + </details>

1296 + </div>

1297 +

1298 +</div>

1299 +

1300 +<div class="doc doc-object doc-function">

1301 +

1302 +

1303 +<a id="app.routes.dfir_iris.get_case"></a>

1304 + <div class="doc doc-contents first">

1305 +

1306 + Handle GET requests at the "/cases/<case_id>" endpoint. Retrieve a specific case from DFIR IRIS.

1307 +

1308 + Parameters:

1309 + <table>

1310 + <thead>

1311 + <tr>

1312 + <th>Name</th>

1313 + <th>Type</th>

1314 + <th>Description</th>

1315 + <th>Default</th>

1316 + </tr>

1317 + </thead>

1318 + <tbody>

1319 + <tr>

1320 + <td><code>case_id</code></td>

1321 + <td>

1322 + <code>str</code>

1323 + </td>

1324 + <td>

1325 + <div class="doc-md-description">

1326 + The ID of the case to retrieve.

1327 + </div>

1328 + </td>

1329 + <td>

1330 + required

1331 + </td>

1332 + </tr>

1333 + </tbody>

1334 + </table>

1335 +

1336 + Returns:

1337 + <table>

1338 + <thead>

1339 + <tr>

1340 +<th>Name</th> <th>Type</th>

1341 + <th>Description</th>

1342 + </tr>

1343 + </thead>

1344 + <tbody>

1345 + <tr>

1346 +<td><code>Response</code></td> <td>

1347 + </td>

1348 + <td>

1349 + <div class="doc-md-description">

1350 + A Flask Response object carrying a JSON representation of the case data.

1351 + </div>

1352 + </td>

1353 + </tr>

1354 + </tbody>

1355 + </table>

1356 +

1357 + <details class="quote">

1358 + <summary>Source code in <code>app\routes\dfir_iris.py</code></summary>

1359 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-25">25</a>

1360 +<a href="#__codelineno-0-26">26</a>

1361 +<a href="#__codelineno-0-27">27</a>

1362 +<a href="#__codelineno-0-28">28</a>

1363 +<a href="#__codelineno-0-29">29</a>

1364 +<a href="#__codelineno-0-30">30</a>

1365 +<a href="#__codelineno-0-31">31</a>

1366 +<a href="#__codelineno-0-32">32</a>

1367 +<a href="#__codelineno-0-33">33</a>

1368 +<a href="#__codelineno-0-34">34</a>

1369 +<a href="#__codelineno-0-35">35</a>

1370 +<a href="#__codelineno-0-36">36</a>

1371 +<a href="#__codelineno-0-37">37</a>

1372 +<a href="#__codelineno-0-38">38</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-25" name="__codelineno-0-25"></a>@bp.route("/dfir_iris/cases/<case_id>", methods=["GET"])

1373 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a>def get_case(case_id: str):

1374 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> """

1375 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> Handle GET requests at the "/cases/<case_id>" endpoint. Retrieve a specific case from DFIR IRIS.

1376 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a>

1377 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> Args:

1378 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> case_id (str): The ID of the case to retrieve.

1379 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a>

1380 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> Returns:

1381 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> Response: A Flask Response object carrying a JSON representation of the case data.

1382 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> """

1383 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> service = CasesService()

1384 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> case = service.get_case(case_id=case_id)

1385 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> return case

1386 +</code></pre></div></td></tr></table></div>

1387 + </details>

1388 + </div>

1389 +

1390 +</div>

1391 +<h3 id="notes-routes">Notes Routes</h3>

1392 +

1393 +

1394 +<div class="doc doc-object doc-function">

1395 +

1396 +

1397 +<a id="app.routes.dfir_iris.get_case_notes"></a>

1398 + <div class="doc doc-contents first">

1399 +

1400 + Handle GET requests at the "/cases/<case_id>/notes" endpoint. Retrieve notes of a specific case from DFIR IRIS.

1401 +

1402 + Parameters:

1403 + <table>

1404 + <thead>

1405 + <tr>

1406 + <th>Name</th>

1407 + <th>Type</th>

1408 + <th>Description</th>

1409 + <th>Default</th>

1410 + </tr>

1411 + </thead>

1412 + <tbody>

1413 + <tr>

1414 + <td><code>case_id</code></td>

1415 + <td>

1416 + <code>str</code>

1417 + </td>

1418 + <td>

1419 + <div class="doc-md-description">

1420 + The ID of the case to retrieve notes from.

1421 + </div>

1422 + </td>

1423 + <td>

1424 + required

1425 + </td>

1426 + </tr>

1427 + </tbody>

1428 + </table>

1429 +

1430 + Returns:

1431 + <table>

1432 + <thead>

1433 + <tr>

1434 +<th>Name</th> <th>Type</th>

1435 + <th>Description</th>

1436 + </tr>

1437 + </thead>

1438 + <tbody>

1439 + <tr>

1440 +<td><code>Response</code></td> <td>

1441 + </td>

1442 + <td>

1443 + <div class="doc-md-description">

1444 + A Flask Response object carrying a JSON representation of the list of notes for the case.

1445 + </div>

1446 + </td>

1447 + </tr>

1448 + </tbody>

1449 + </table>

1450 +

1451 + <details class="quote">

1452 + <summary>Source code in <code>app\routes\dfir_iris.py</code></summary>

1453 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-41">41</a>

1454 +<a href="#__codelineno-0-42">42</a>

1455 +<a href="#__codelineno-0-43">43</a>

1456 +<a href="#__codelineno-0-44">44</a>

1457 +<a href="#__codelineno-0-45">45</a>

1458 +<a href="#__codelineno-0-46">46</a>

1459 +<a href="#__codelineno-0-47">47</a>

1460 +<a href="#__codelineno-0-48">48</a>

1461 +<a href="#__codelineno-0-49">49</a>

1462 +<a href="#__codelineno-0-50">50</a>

1463 +<a href="#__codelineno-0-51">51</a>

1464 +<a href="#__codelineno-0-52">52</a>

1465 +<a href="#__codelineno-0-53">53</a>

1466 +<a href="#__codelineno-0-54">54</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-41" name="__codelineno-0-41"></a>@bp.route("/dfir_iris/cases/<case_id>/notes", methods=["GET"])

1467 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a>def get_case_notes(case_id: int):

1468 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> """

1469 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> Handle GET requests at the "/cases/<case_id>/notes" endpoint. Retrieve notes of a specific case from DFIR IRIS.

1470 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a>

1471 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> Args:

1472 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> case_id (str): The ID of the case to retrieve notes from.

1473 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a>

1474 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> Returns:

1475 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> Response: A Flask Response object carrying a JSON representation of the list of notes for the case.

1476 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> """

1477 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> notes_service = NotesService()

1478 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> notes = notes_service.get_case_notes(search_term="%", cid=case_id)

1479 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> return notes

1480 +</code></pre></div></td></tr></table></div>

1481 + </details>

1482 + </div>

1483 +

1484 +</div>

1485 +

1486 +<div class="doc doc-object doc-function">

1487 +

1488 +

1489 +<a id="app.routes.dfir_iris.create_case_note"></a>

1490 + <div class="doc doc-contents first">

1491 +

1492 + Handle POST requests at the "/cases/<case_id>/note" endpoint. Create a note for a specific case in DFIR IRIS.

1493 +

1494 + Parameters:

1495 + <table>

1496 + <thead>

1497 + <tr>

1498 + <th>Name</th>

1499 + <th>Type</th>

1500 + <th>Description</th>

1501 + <th>Default</th>

1502 + </tr>

1503 + </thead>

1504 + <tbody>

1505 + <tr>

1506 + <td><code>case_id</code></td>

1507 + <td>

1508 + <code>str</code>

1509 + </td>

1510 + <td>

1511 + <div class="doc-md-description">

1512 + The ID of the case to create a note for.

1513 + </div>

1514 + </td>

1515 + <td>

1516 + required

1517 + </td>

1518 + </tr>

1519 + </tbody>

1520 + </table>

1521 +

1522 + Returns:

1523 + <table>

1524 + <thead>

1525 + <tr>

1526 +<th>Name</th> <th>Type</th>

1527 + <th>Description</th>

1528 + </tr>

1529 + </thead>

1530 + <tbody>

1531 + <tr>

1532 +<td><code>Response</code></td> <td>

1533 + </td>

1534 + <td>

1535 + <div class="doc-md-description">

1536 + A Flask Response object carrying a JSON representation of the result of the note creation operation.

1537 + </div>

1538 + </td>

1539 + </tr>

1540 + </tbody>

1541 + </table>

1542 +

1543 + <details class="quote">

1544 + <summary>Source code in <code>app\routes\dfir_iris.py</code></summary>

1545 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-57">57</a>

1546 +<a href="#__codelineno-0-58">58</a>

1547 +<a href="#__codelineno-0-59">59</a>

1548 +<a href="#__codelineno-0-60">60</a>

1549 +<a href="#__codelineno-0-61">61</a>

1550 +<a href="#__codelineno-0-62">62</a>

1551 +<a href="#__codelineno-0-63">63</a>

1552 +<a href="#__codelineno-0-64">64</a>

1553 +<a href="#__codelineno-0-65">65</a>

1554 +<a href="#__codelineno-0-66">66</a>

1555 +<a href="#__codelineno-0-67">67</a>

1556 +<a href="#__codelineno-0-68">68</a>

1557 +<a href="#__codelineno-0-69">69</a>

1558 +<a href="#__codelineno-0-70">70</a>

1559 +<a href="#__codelineno-0-71">71</a>

1560 +<a href="#__codelineno-0-72">72</a>

1561 +<a href="#__codelineno-0-73">73</a>

1562 +<a href="#__codelineno-0-74">74</a>

1563 +<a href="#__codelineno-0-75">75</a>

1564 +<a href="#__codelineno-0-76">76</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-57" name="__codelineno-0-57"></a>@bp.route("/dfir_iris/cases/<case_id>/note", methods=["POST"])

1565 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a>def create_case_note(case_id: str):

1566 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> """

1567 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> Handle POST requests at the "/cases/<case_id>/note" endpoint. Create a note for a specific case in DFIR IRIS.

1568 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a>

1569 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> Args:

1570 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> case_id (str): The ID of the case to create a note for.

1571 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a>

1572 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Returns:

1573 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> Response: A Flask Response object carrying a JSON representation of the result of the note creation operation.

1574 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> """

1575 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> note_title = request.json["note_title"]

1576 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> note_content = request.json["note_content"]

1577 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> notes_service = NotesService()

1578 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> created_note = notes_service.create_case_note(

1579 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> cid=case_id,

1580 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> note_title=note_title,

1581 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> note_content=note_content,

1582 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> )

1583 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> return created_note

1584 +</code></pre></div></td></tr></table></div>

1585 + </details>

1586 + </div>

1587 +

1588 +</div>

1589 +<h3 id="assets-routes">Assets Routes</h3>

1590 +

1591 +

1592 +<div class="doc doc-object doc-function">

1593 +

1594 +

1595 +<a id="app.routes.dfir_iris.get_case_assets"></a>

1596 + <div class="doc doc-contents first">

1597 +

1598 + Handle GET requests at the "/cases/<case_id>/assets" endpoint. Retrieve assets of a specific case from DFIR IRIS.

1599 +

1600 + Parameters:

1601 + <table>

1602 + <thead>

1603 + <tr>

1604 + <th>Name</th>

1605 + <th>Type</th>

1606 + <th>Description</th>

1607 + <th>Default</th>

1608 + </tr>

1609 + </thead>

1610 + <tbody>

1611 + <tr>

1612 + <td><code>case_id</code></td>

1613 + <td>

1614 + <code>str</code>

1615 + </td>

1616 + <td>

1617 + <div class="doc-md-description">

1618 + The ID of the case to retrieve assets from.

1619 + </div>

1620 + </td>

1621 + <td>

1622 + required

1623 + </td>

1624 + </tr>

1625 + </tbody>

1626 + </table>

1627 +

1628 + Returns:

1629 + <table>

1630 + <thead>

1631 + <tr>

1632 +<th>Name</th> <th>Type</th>

1633 + <th>Description</th>

1634 + </tr>

1635 + </thead>

1636 + <tbody>

1637 + <tr>

1638 +<td><code>Response</code></td> <td>

1639 + </td>

1640 + <td>

1641 + <div class="doc-md-description">

1642 + A Flask Response object carrying a JSON representation of the list of assets for the case.

1643 + </div>

1644 + </td>

1645 + </tr>

1646 + </tbody>

1647 + </table>

1648 +

1649 + <details class="quote">

1650 + <summary>Source code in <code>app\routes\dfir_iris.py</code></summary>

1651 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-79">79</a>

1652 +<a href="#__codelineno-0-80">80</a>

1653 +<a href="#__codelineno-0-81">81</a>

1654 +<a href="#__codelineno-0-82">82</a>

1655 +<a href="#__codelineno-0-83">83</a>

1656 +<a href="#__codelineno-0-84">84</a>

1657 +<a href="#__codelineno-0-85">85</a>

1658 +<a href="#__codelineno-0-86">86</a>

1659 +<a href="#__codelineno-0-87">87</a>

1660 +<a href="#__codelineno-0-88">88</a>

1661 +<a href="#__codelineno-0-89">89</a>

1662 +<a href="#__codelineno-0-90">90</a>

1663 +<a href="#__codelineno-0-91">91</a>

1664 +<a href="#__codelineno-0-92">92</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-79" name="__codelineno-0-79"></a>@bp.route("/dfir_iris/cases/<case_id>/assets", methods=["GET"])

1665 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a>def get_case_assets(case_id: str):

1666 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> """

1667 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> Handle GET requests at the "/cases/<case_id>/assets" endpoint. Retrieve assets of a specific case from DFIR IRIS.

1668 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a>

1669 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> Args:

1670 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> case_id (str): The ID of the case to retrieve assets from.

1671 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a>

1672 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> Returns:

1673 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> Response: A Flask Response object carrying a JSON representation of the list of assets for the case.

1674 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> """

1675 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> asset_service = AssetsService()

1676 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> assets = asset_service.get_case_assets(cid=case_id)

1677 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> return assets

1678 +</code></pre></div></td></tr></table></div>

1679 + </details>

1680 + </div>

1681 +

1682 +</div>

1683 +<h3 id="alerts-routes">Alerts Routes</h3>

1684 +

1685 +

1686 +<div class="doc doc-object doc-function">

1687 +

1688 +

1689 +<a id="app.routes.dfir_iris.get_alerts"></a>

1690 + <div class="doc doc-contents first">

1691 +

1692 + Handle GET requests at the "/alerts" endpoint. Retrieve all alerts from DFIR IRIS.

1693 +

1694 + Returns:

1695 + <table>

1696 + <thead>

1697 + <tr>

1698 +<th>Name</th> <th>Type</th>

1699 + <th>Description</th>

1700 + </tr>

1701 + </thead>

1702 + <tbody>

1703 + <tr>

1704 +<td><code>Response</code></td> <td>

1705 + </td>

1706 + <td>

1707 + <div class="doc-md-description">

1708 + A Flask Response object carrying a JSON representation of the list of alerts.

1709 + </div>

1710 + </td>

1711 + </tr>

1712 + </tbody>

1713 + </table>

1714 +

1715 + <details class="quote">

1716 + <summary>Source code in <code>app\routes\dfir_iris.py</code></summary>

1717 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-95"> 95</a>

1718 +<a href="#__codelineno-0-96"> 96</a>

1719 +<a href="#__codelineno-0-97"> 97</a>

1720 +<a href="#__codelineno-0-98"> 98</a>

1721 +<a href="#__codelineno-0-99"> 99</a>

1722 +<a href="#__codelineno-0-100">100</a>

1723 +<a href="#__codelineno-0-101">101</a>

1724 +<a href="#__codelineno-0-102">102</a>

1725 +<a href="#__codelineno-0-103">103</a>

1726 +<a href="#__codelineno-0-104">104</a>

1727 +<a href="#__codelineno-0-105">105</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-95" name="__codelineno-0-95"></a>@bp.route("/dfir_iris/alerts", methods=["GET"])

1728 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a>def get_alerts():

1729 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> """

1730 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> Handle GET requests at the "/alerts" endpoint. Retrieve all alerts from DFIR IRIS.

1731 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a>

1732 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> Returns:

1733 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> Response: A Flask Response object carrying a JSON representation of the list of alerts.

1734 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> """

1735 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> service = AlertsService()

1736 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a> alerts = service.list_alerts()

1737 +<a id="__codelineno-0-105" name="__codelineno-0-105"></a> return alerts

1738 +</code></pre></div></td></tr></table></div>

1739 + </details>

1740 + </div>

1741 +

1742 +</div>

1743 +<h3 id="alerts-services">Alerts Services</h3>

1744 +

1745 +

1746 +<div class="doc doc-object doc-module">

1747 +

1748 +

1749 +<a id="app.services.DFIR_IRIS.alerts"></a>

1750 + <div class="doc doc-contents first">

1751 +

1752 +

1753 +

1754 + <div class="doc doc-children">

1755 +

1756 +

1757 +

1758 +

1759 +

1760 +

1761 +

1762 +

1763 +<div class="doc doc-object doc-class">

1764 +

1765 +

1766 +

1767 +<h2 id="app.services.DFIR_IRIS.alerts.AlertsService" class="doc doc-heading">

1768 + <code>AlertsService</code>

1769 +

1770 +

1771 +</h2>

1772 +

1773 +

1774 + <div class="doc doc-contents ">

1775 +

1776 +

1777 + A service class that encapsulates the logic for pulling alerts from DFIR-IRIS. It creates a DFIR-IRIS session upon

1778 +initialization and uses it to fetch alerts.

1779 +

1780 +

1781 + <details class="quote">

1782 + <summary>Source code in <code>app\services\DFIR_IRIS\alerts.py</code></summary>

1783 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-13">13</a>

1784 +<a href="#__codelineno-0-14">14</a>

1785 +<a href="#__codelineno-0-15">15</a>

1786 +<a href="#__codelineno-0-16">16</a>

1787 +<a href="#__codelineno-0-17">17</a>

1788 +<a href="#__codelineno-0-18">18</a>

1789 +<a href="#__codelineno-0-19">19</a>

1790 +<a href="#__codelineno-0-20">20</a>

1791 +<a href="#__codelineno-0-21">21</a>

1792 +<a href="#__codelineno-0-22">22</a>

1793 +<a href="#__codelineno-0-23">23</a>

1794 +<a href="#__codelineno-0-24">24</a>

1795 +<a href="#__codelineno-0-25">25</a>

1796 +<a href="#__codelineno-0-26">26</a>

1797 +<a href="#__codelineno-0-27">27</a>

1798 +<a href="#__codelineno-0-28">28</a>

1799 +<a href="#__codelineno-0-29">29</a>

1800 +<a href="#__codelineno-0-30">30</a>

1801 +<a href="#__codelineno-0-31">31</a>

1802 +<a href="#__codelineno-0-32">32</a>

1803 +<a href="#__codelineno-0-33">33</a>

1804 +<a href="#__codelineno-0-34">34</a>

1805 +<a href="#__codelineno-0-35">35</a>

1806 +<a href="#__codelineno-0-36">36</a>

1807 +<a href="#__codelineno-0-37">37</a>

1808 +<a href="#__codelineno-0-38">38</a>

1809 +<a href="#__codelineno-0-39">39</a>

1810 +<a href="#__codelineno-0-40">40</a>

1811 +<a href="#__codelineno-0-41">41</a>

1812 +<a href="#__codelineno-0-42">42</a>

1813 +<a href="#__codelineno-0-43">43</a>

1814 +<a href="#__codelineno-0-44">44</a>

1815 +<a href="#__codelineno-0-45">45</a>

1816 +<a href="#__codelineno-0-46">46</a>

1817 +<a href="#__codelineno-0-47">47</a>

1818 +<a href="#__codelineno-0-48">48</a>

1819 +<a href="#__codelineno-0-49">49</a>

1820 +<a href="#__codelineno-0-50">50</a>

1821 +<a href="#__codelineno-0-51">51</a>

1822 +<a href="#__codelineno-0-52">52</a>

1823 +<a href="#__codelineno-0-53">53</a>

1824 +<a href="#__codelineno-0-54">54</a>

1825 +<a href="#__codelineno-0-55">55</a>

1826 +<a href="#__codelineno-0-56">56</a>

1827 +<a href="#__codelineno-0-57">57</a>

1828 +<a href="#__codelineno-0-58">58</a>

1829 +<a href="#__codelineno-0-59">59</a>

1830 +<a href="#__codelineno-0-60">60</a>

1831 +<a href="#__codelineno-0-61">61</a>

1832 +<a href="#__codelineno-0-62">62</a>

1833 +<a href="#__codelineno-0-63">63</a>

1834 +<a href="#__codelineno-0-64">64</a>

1835 +<a href="#__codelineno-0-65">65</a>

1836 +<a href="#__codelineno-0-66">66</a>

1837 +<a href="#__codelineno-0-67">67</a>

1838 +<a href="#__codelineno-0-68">68</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-13" name="__codelineno-0-13"></a>class AlertsService:

1839 +<a id="__codelineno-0-14" name="__codelineno-0-14"></a> """

1840 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a> A service class that encapsulates the logic for pulling alerts from DFIR-IRIS. It creates a DFIR-IRIS session upon

1841 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> initialization and uses it to fetch alerts.

1842 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> """

1843 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a>

1844 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> def __init__(self):

1845 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> """

1846 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> Initializes the AlertsService by creating a UniversalService object for "DFIR-IRIS" and establishing a session.

1847 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> If the session creation is unsuccessful, an error is logged and the iris_session attribute is set to None.

1848 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> """

1849 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> self.universal_service = UniversalService("DFIR-IRIS")

1850 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> session_result = self.universal_service.create_session()

1851 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a>

1852 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> if not session_result["success"]:

1853 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> logger.error(session_result["message"])

1854 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> self.iris_session = None

1855 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> else:

1856 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> self.iris_session = session_result["session"]

1857 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a>

1858 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> def list_alerts(self) -> Dict[str, object]:

1859 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> """

1860 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> List all alerts from DFIR-IRIS. If the iris_session attribute is None, this indicates that the session creation

1861 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> was unsuccessful, and a dictionary with "success" set to False is returned. Otherwise, it attempts to fetch and

1862 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> parse the alerts data.

1863 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a>

1864 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> Returns:

1865 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> dict: A dictionary containing the success status, a message, and potentially the fetched alerts. The

1866 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> "success" key is a boolean indicating whether the operation was successful. The "message" key is a string

1867 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> providing details about the operation. The "results" key, included when "success" is True, contains the

1868 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> fetched alerts data.

1869 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> """

1870 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> if self.iris_session is None:

1871 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> return {

1872 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> "success": False,

1873 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> "message": "DFIR-IRIS session was not successfully created.",

1874 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> }

1875 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a>

1876 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> logger.info("Collecting cases from DFIR-IRIS")

1877 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> alert = Alert(session=self.iris_session)

1878 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> result = self.universal_service.fetch_and_parse_data(

1879 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> self.iris_session,

1880 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> alert.filter_alerts,

1881 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> )

1882 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a>

1883 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> if not result["success"]:

1884 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> return {

1885 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> "success": False,

1886 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> "message": "Failed to collect cases from DFIR-IRIS",

1887 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> }

1888 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a>

1889 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> return {

1890 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> "success": True,

1891 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> "message": "Successfully collected cases from DFIR-IRIS",

1892 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> "results": result["data"],

1893 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> }

1894 +</code></pre></div></td></tr></table></div>

1895 + </details>

1896 +

1897 +

1898 +

1899 + <div class="doc doc-children">

1900 +

1901 +

1902 +

1903 +

1904 +

1905 +

1906 +

1907 +

1908 +

1909 +<div class="doc doc-object doc-function">

1910 +

1911 +

1912 +

1913 +<h3 id="app.services.DFIR_IRIS.alerts.AlertsService.__init__" class="doc doc-heading">

1914 +<code class="highlight language-python">__init__()</code>

1915 +

1916 +</h3>

1917 +

1918 +

1919 + <div class="doc doc-contents ">

1920 +

1921 + Initializes the AlertsService by creating a UniversalService object for "DFIR-IRIS" and establishing a session.

1922 +If the session creation is unsuccessful, an error is logged and the iris_session attribute is set to None.

1923 +

1924 + <details class="quote">

1925 + <summary>Source code in <code>app\services\DFIR_IRIS\alerts.py</code></summary>

1926 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-19">19</a>

1927 +<a href="#__codelineno-0-20">20</a>

1928 +<a href="#__codelineno-0-21">21</a>

1929 +<a href="#__codelineno-0-22">22</a>

1930 +<a href="#__codelineno-0-23">23</a>

1931 +<a href="#__codelineno-0-24">24</a>

1932 +<a href="#__codelineno-0-25">25</a>

1933 +<a href="#__codelineno-0-26">26</a>

1934 +<a href="#__codelineno-0-27">27</a>

1935 +<a href="#__codelineno-0-28">28</a>

1936 +<a href="#__codelineno-0-29">29</a>

1937 +<a href="#__codelineno-0-30">30</a>

1938 +<a href="#__codelineno-0-31">31</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-19" name="__codelineno-0-19"></a>def __init__(self):

1939 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> """

1940 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> Initializes the AlertsService by creating a UniversalService object for "DFIR-IRIS" and establishing a session.

1941 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> If the session creation is unsuccessful, an error is logged and the iris_session attribute is set to None.

1942 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> """

1943 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> self.universal_service = UniversalService("DFIR-IRIS")

1944 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> session_result = self.universal_service.create_session()

1945 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a>

1946 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> if not session_result["success"]:

1947 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> logger.error(session_result["message"])

1948 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> self.iris_session = None

1949 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> else:

1950 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> self.iris_session = session_result["session"]

1951 +</code></pre></div></td></tr></table></div>

1952 + </details>

1953 + </div>

1954 +

1955 +</div>

1956 +

1957 +<div class="doc doc-object doc-function">

1958 +

1959 +

1960 +

1961 +<h3 id="app.services.DFIR_IRIS.alerts.AlertsService.list_alerts" class="doc doc-heading">

1962 +<code class="highlight language-python">list_alerts()</code>

1963 +

1964 +</h3>

1965 +

1966 +

1967 + <div class="doc doc-contents ">

1968 +

1969 + List all alerts from DFIR-IRIS. If the iris_session attribute is None, this indicates that the session creation

1970 +was unsuccessful, and a dictionary with "success" set to False is returned. Otherwise, it attempts to fetch and

1971 +parse the alerts data.

1972 +

1973 + Returns:

1974 + <table>

1975 + <thead>

1976 + <tr>

1977 +<th>Name</th> <th>Type</th>

1978 + <th>Description</th>

1979 + </tr>

1980 + </thead>

1981 + <tbody>

1982 + <tr>

1983 +<td><code>dict</code></td> <td>

1984 + <code>Dict[str, object]</code>

1985 + </td>

1986 + <td>

1987 + <div class="doc-md-description">

1988 + A dictionary containing the success status, a message, and potentially the fetched alerts. The

1989 + </div>

1990 + </td>

1991 + </tr>

1992 + <tr>

1993 +<td></td> <td>

1994 + <code>Dict[str, object]</code>

1995 + </td>

1996 + <td>

1997 + <div class="doc-md-description">

1998 + "success" key is a boolean indicating whether the operation was successful. The "message" key is a string

1999 + </div>

2000 + </td>

2001 + </tr>

2002 + <tr>

2003 +<td></td> <td>

2004 + <code>Dict[str, object]</code>

2005 + </td>

2006 + <td>

2007 + <div class="doc-md-description">

2008 + providing details about the operation. The "results" key, included when "success" is True, contains the

2009 + </div>

2010 + </td>

2011 + </tr>

2012 + <tr>

2013 +<td></td> <td>

2014 + <code>Dict[str, object]</code>

2015 + </td>

2016 + <td>

2017 + <div class="doc-md-description">

2018 + fetched alerts data.

2019 + </div>

2020 + </td>

2021 + </tr>

2022 + </tbody>

2023 + </table>

2024 +

2025 + <details class="quote">

2026 + <summary>Source code in <code>app\services\DFIR_IRIS\alerts.py</code></summary>

2027 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-33">33</a>

2028 +<a href="#__codelineno-0-34">34</a>

2029 +<a href="#__codelineno-0-35">35</a>

2030 +<a href="#__codelineno-0-36">36</a>

2031 +<a href="#__codelineno-0-37">37</a>

2032 +<a href="#__codelineno-0-38">38</a>

2033 +<a href="#__codelineno-0-39">39</a>

2034 +<a href="#__codelineno-0-40">40</a>

2035 +<a href="#__codelineno-0-41">41</a>

2036 +<a href="#__codelineno-0-42">42</a>

2037 +<a href="#__codelineno-0-43">43</a>

2038 +<a href="#__codelineno-0-44">44</a>

2039 +<a href="#__codelineno-0-45">45</a>

2040 +<a href="#__codelineno-0-46">46</a>

2041 +<a href="#__codelineno-0-47">47</a>

2042 +<a href="#__codelineno-0-48">48</a>

2043 +<a href="#__codelineno-0-49">49</a>

2044 +<a href="#__codelineno-0-50">50</a>

2045 +<a href="#__codelineno-0-51">51</a>

2046 +<a href="#__codelineno-0-52">52</a>

2047 +<a href="#__codelineno-0-53">53</a>

2048 +<a href="#__codelineno-0-54">54</a>

2049 +<a href="#__codelineno-0-55">55</a>

2050 +<a href="#__codelineno-0-56">56</a>

2051 +<a href="#__codelineno-0-57">57</a>

2052 +<a href="#__codelineno-0-58">58</a>

2053 +<a href="#__codelineno-0-59">59</a>

2054 +<a href="#__codelineno-0-60">60</a>

2055 +<a href="#__codelineno-0-61">61</a>

2056 +<a href="#__codelineno-0-62">62</a>

2057 +<a href="#__codelineno-0-63">63</a>

2058 +<a href="#__codelineno-0-64">64</a>

2059 +<a href="#__codelineno-0-65">65</a>

2060 +<a href="#__codelineno-0-66">66</a>

2061 +<a href="#__codelineno-0-67">67</a>

2062 +<a href="#__codelineno-0-68">68</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-33" name="__codelineno-0-33"></a>def list_alerts(self) -> Dict[str, object]:

2063 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> """

2064 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> List all alerts from DFIR-IRIS. If the iris_session attribute is None, this indicates that the session creation

2065 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> was unsuccessful, and a dictionary with "success" set to False is returned. Otherwise, it attempts to fetch and

2066 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> parse the alerts data.

2067 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a>

2068 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> Returns:

2069 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> dict: A dictionary containing the success status, a message, and potentially the fetched alerts. The

2070 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> "success" key is a boolean indicating whether the operation was successful. The "message" key is a string

2071 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> providing details about the operation. The "results" key, included when "success" is True, contains the

2072 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> fetched alerts data.

2073 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> """

2074 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> if self.iris_session is None:

2075 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> return {

2076 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> "success": False,

2077 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> "message": "DFIR-IRIS session was not successfully created.",

2078 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> }

2079 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a>

2080 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> logger.info("Collecting cases from DFIR-IRIS")

2081 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> alert = Alert(session=self.iris_session)

2082 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> result = self.universal_service.fetch_and_parse_data(

2083 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> self.iris_session,

2084 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> alert.filter_alerts,

2085 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> )

2086 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a>

2087 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> if not result["success"]:

2088 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> return {

2089 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> "success": False,

2090 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> "message": "Failed to collect cases from DFIR-IRIS",

2091 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> }

2092 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a>

2093 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> return {

2094 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> "success": True,

2095 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> "message": "Successfully collected cases from DFIR-IRIS",

2096 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> "results": result["data"],

2097 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> }

2098 +</code></pre></div></td></tr></table></div>

2099 + </details>

2100 + </div>

2101 +

2102 +</div>

2103 +

2104 +

2105 +

2106 + </div>

2107 +

2108 + </div>

2109 +

2110 +</div>

2111 +

2112 +

2113 +

2114 +

2115 + </div>

2116 +

2117 + </div>

2118 +

2119 +</div>

2120 +<h3 id="cases-services">Cases Services</h3>

2121 +

2122 +

2123 +<div class="doc doc-object doc-module">

2124 +

2125 +

2126 +<a id="app.services.DFIR_IRIS.cases"></a>

2127 + <div class="doc doc-contents first">

2128 +

2129 +

2130 +

2131 + <div class="doc doc-children">

2132 +

2133 +

2134 +

2135 +

2136 +

2137 +

2138 +

2139 +

2140 +<div class="doc doc-object doc-class">

2141 +

2142 +

2143 +

2144 +<h2 id="app.services.DFIR_IRIS.cases.CasesService" class="doc doc-heading">

2145 + <code>CasesService</code>

2146 +

2147 +

2148 +</h2>

2149 +

2150 +

2151 + <div class="doc doc-contents ">

2152 +

2153 +

2154 + A service class that encapsulates the logic for pulling cases from DFIR-IRIS.

2155 +

2156 +

2157 + <details class="quote">

2158 + <summary>Source code in <code>app\services\DFIR_IRIS\cases.py</code></summary>

2159 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-14"> 14</a>

2160 +<a href="#__codelineno-0-15"> 15</a>

2161 +<a href="#__codelineno-0-16"> 16</a>

2162 +<a href="#__codelineno-0-17"> 17</a>

2163 +<a href="#__codelineno-0-18"> 18</a>

2164 +<a href="#__codelineno-0-19"> 19</a>

2165 +<a href="#__codelineno-0-20"> 20</a>

2166 +<a href="#__codelineno-0-21"> 21</a>

2167 +<a href="#__codelineno-0-22"> 22</a>

2168 +<a href="#__codelineno-0-23"> 23</a>

2169 +<a href="#__codelineno-0-24"> 24</a>

2170 +<a href="#__codelineno-0-25"> 25</a>

2171 +<a href="#__codelineno-0-26"> 26</a>

2172 +<a href="#__codelineno-0-27"> 27</a>

2173 +<a href="#__codelineno-0-28"> 28</a>

2174 +<a href="#__codelineno-0-29"> 29</a>

2175 +<a href="#__codelineno-0-30"> 30</a>

2176 +<a href="#__codelineno-0-31"> 31</a>

2177 +<a href="#__codelineno-0-32"> 32</a>

2178 +<a href="#__codelineno-0-33"> 33</a>

2179 +<a href="#__codelineno-0-34"> 34</a>

2180 +<a href="#__codelineno-0-35"> 35</a>

2181 +<a href="#__codelineno-0-36"> 36</a>

2182 +<a href="#__codelineno-0-37"> 37</a>

2183 +<a href="#__codelineno-0-38"> 38</a>

2184 +<a href="#__codelineno-0-39"> 39</a>

2185 +<a href="#__codelineno-0-40"> 40</a>

2186 +<a href="#__codelineno-0-41"> 41</a>

2187 +<a href="#__codelineno-0-42"> 42</a>

2188 +<a href="#__codelineno-0-43"> 43</a>

2189 +<a href="#__codelineno-0-44"> 44</a>

2190 +<a href="#__codelineno-0-45"> 45</a>

2191 +<a href="#__codelineno-0-46"> 46</a>

2192 +<a href="#__codelineno-0-47"> 47</a>

2193 +<a href="#__codelineno-0-48"> 48</a>

2194 +<a href="#__codelineno-0-49"> 49</a>

2195 +<a href="#__codelineno-0-50"> 50</a>

2196 +<a href="#__codelineno-0-51"> 51</a>

2197 +<a href="#__codelineno-0-52"> 52</a>

2198 +<a href="#__codelineno-0-53"> 53</a>

2199 +<a href="#__codelineno-0-54"> 54</a>

2200 +<a href="#__codelineno-0-55"> 55</a>

2201 +<a href="#__codelineno-0-56"> 56</a>

2202 +<a href="#__codelineno-0-57"> 57</a>

2203 +<a href="#__codelineno-0-58"> 58</a>

2204 +<a href="#__codelineno-0-59"> 59</a>

2205 +<a href="#__codelineno-0-60"> 60</a>

2206 +<a href="#__codelineno-0-61"> 61</a>

2207 +<a href="#__codelineno-0-62"> 62</a>

2208 +<a href="#__codelineno-0-63"> 63</a>

2209 +<a href="#__codelineno-0-64"> 64</a>

2210 +<a href="#__codelineno-0-65"> 65</a>

2211 +<a href="#__codelineno-0-66"> 66</a>

2212 +<a href="#__codelineno-0-67"> 67</a>

2213 +<a href="#__codelineno-0-68"> 68</a>

2214 +<a href="#__codelineno-0-69"> 69</a>

2215 +<a href="#__codelineno-0-70"> 70</a>

2216 +<a href="#__codelineno-0-71"> 71</a>

2217 +<a href="#__codelineno-0-72"> 72</a>

2218 +<a href="#__codelineno-0-73"> 73</a>

2219 +<a href="#__codelineno-0-74"> 74</a>

2220 +<a href="#__codelineno-0-75"> 75</a>

2221 +<a href="#__codelineno-0-76"> 76</a>

2222 +<a href="#__codelineno-0-77"> 77</a>

2223 +<a href="#__codelineno-0-78"> 78</a>

2224 +<a href="#__codelineno-0-79"> 79</a>

2225 +<a href="#__codelineno-0-80"> 80</a>

2226 +<a href="#__codelineno-0-81"> 81</a>

2227 +<a href="#__codelineno-0-82"> 82</a>

2228 +<a href="#__codelineno-0-83"> 83</a>

2229 +<a href="#__codelineno-0-84"> 84</a>

2230 +<a href="#__codelineno-0-85"> 85</a>

2231 +<a href="#__codelineno-0-86"> 86</a>

2232 +<a href="#__codelineno-0-87"> 87</a>

2233 +<a href="#__codelineno-0-88"> 88</a>

2234 +<a href="#__codelineno-0-89"> 89</a>

2235 +<a href="#__codelineno-0-90"> 90</a>

2236 +<a href="#__codelineno-0-91"> 91</a>

2237 +<a href="#__codelineno-0-92"> 92</a>

2238 +<a href="#__codelineno-0-93"> 93</a>

2239 +<a href="#__codelineno-0-94"> 94</a>

2240 +<a href="#__codelineno-0-95"> 95</a>

2241 +<a href="#__codelineno-0-96"> 96</a>

2242 +<a href="#__codelineno-0-97"> 97</a>

2243 +<a href="#__codelineno-0-98"> 98</a>

2244 +<a href="#__codelineno-0-99"> 99</a>

2245 +<a href="#__codelineno-0-100">100</a>

2246 +<a href="#__codelineno-0-101">101</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-14" name="__codelineno-0-14"></a>class CasesService:

2247 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a> """

2248 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> A service class that encapsulates the logic for pulling cases from DFIR-IRIS.

2249 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> """

2250 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a>

2251 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> def __init__(self):

2252 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> self.universal_service = UniversalService("DFIR-IRIS")

2253 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> session_result = self.universal_service.create_session()

2254 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a>

2255 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> if not session_result["success"]:

2256 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> logger.error(session_result["message"])

2257 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> self.iris_session = None

2258 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> else:

2259 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> self.iris_session = session_result["session"]

2260 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a>

2261 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> def list_cases(self) -> Dict[str, object]:

2262 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> """

2263 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> Lists all cases from DFIR-IRIS

2264 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a>

2265 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> Returns:

2266 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> dict: A dictionary containing the success status, a message and potentially the cases.

2267 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> """

2268 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> if self.iris_session is None:

2269 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> return {

2270 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> "success": False,

2271 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> "message": "DFIR-IRIS session was not successfully created.",

2272 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> }

2273 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a>

2274 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> logger.info("Collecting cases from DFIR-IRIS")

2275 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> case = Case(session=self.iris_session)

2276 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> result = self.universal_service.fetch_and_parse_data(

2277 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> self.iris_session,

2278 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> case.list_cases,

2279 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> )

2280 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a>

2281 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> if not result["success"]:

2282 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> return {

2283 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> "success": False,

2284 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> "message": "Failed to collect cases from DFIR-IRIS",

2285 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> }

2286 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a>

2287 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> return {

2288 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> "success": True,

2289 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> "message": "Successfully collected cases from DFIR-IRIS",

2290 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> "cases": result["data"],

2291 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> }

2292 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a>

2293 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> def get_case(self, case_id: int) -> bool:

2294 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> """

2295 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> Gets a case from DFIR-IRIS and returns all the details

2296 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a>

2297 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Returns:

2298 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> dict: A dictionary containing the success status, a message and potentially the case.

2299 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> """

2300 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> if self.iris_session is None:

2301 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> return {

2302 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> "success": False,

2303 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> "message": "DFIR-IRIS session was not successfully created.",

2304 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> }

2305 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a>

2306 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> logger.info(f"Collecting case {case_id} from DFIR-IRIS")

2307 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> case = Case(session=self.iris_session)

2308 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> result = self.universal_service.fetch_and_parse_data(

2309 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> self.iris_session,

2310 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> case.get_case,

2311 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> case_id,

2312 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> )

2313 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a>

2314 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> if not result["success"]:

2315 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> return {

2316 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> "success": False,

2317 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> "message": f"Failed to collect case {case_id} from DFIR-IRIS",

2318 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> }

2319 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a>

2320 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> return {

2321 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> "success": True,

2322 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> "message": f"Successfully collected case {case_id} from DFIR-IRIS",

2323 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> "case": result["data"],

2324 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> }

2325 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a>

2326 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> def check_case_id(self, case_id: int) -> bool:

2327 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> """

2328 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> Checks if a case exists in DFIR-IRIS

2329 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a>

2330 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> Returns:

2331 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a> dict: A dictionary containing the success status, a message and potentially the case.

2332 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> """

2333 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> return self.get_case(case_id)

2334 +</code></pre></div></td></tr></table></div>

2335 + </details>

2336 +

2337 +

2338 +

2339 + <div class="doc doc-children">

2340 +

2341 +

2342 +

2343 +

2344 +

2345 +

2346 +

2347 +

2348 +

2349 +<div class="doc doc-object doc-function">

2350 +

2351 +

2352 +

2353 +<h3 id="app.services.DFIR_IRIS.cases.CasesService.check_case_id" class="doc doc-heading">

2354 +<code class="highlight language-python">check_case_id(case_id)</code>

2355 +

2356 +</h3>

2357 +

2358 +

2359 + <div class="doc doc-contents ">

2360 +

2361 + Checks if a case exists in DFIR-IRIS

2362 +

2363 + Returns:

2364 + <table>

2365 + <thead>

2366 + <tr>

2367 +<th>Name</th> <th>Type</th>

2368 + <th>Description</th>

2369 + </tr>

2370 + </thead>

2371 + <tbody>

2372 + <tr>

2373 +<td><code>dict</code></td> <td>

2374 + <code>bool</code>

2375 + </td>

2376 + <td>

2377 + <div class="doc-md-description">

2378 + A dictionary containing the success status, a message and potentially the case.

2379 + </div>

2380 + </td>

2381 + </tr>

2382 + </tbody>

2383 + </table>

2384 +

2385 + <details class="quote">

2386 + <summary>Source code in <code>app\services\DFIR_IRIS\cases.py</code></summary>

2387 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-94"> 94</a>

2388 +<a href="#__codelineno-0-95"> 95</a>

2389 +<a href="#__codelineno-0-96"> 96</a>

2390 +<a href="#__codelineno-0-97"> 97</a>

2391 +<a href="#__codelineno-0-98"> 98</a>

2392 +<a href="#__codelineno-0-99"> 99</a>

2393 +<a href="#__codelineno-0-100">100</a>

2394 +<a href="#__codelineno-0-101">101</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-94" name="__codelineno-0-94"></a>def check_case_id(self, case_id: int) -> bool:

2395 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> """

2396 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> Checks if a case exists in DFIR-IRIS

2397 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a>

2398 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> Returns:

2399 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a> dict: A dictionary containing the success status, a message and potentially the case.

2400 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> """

2401 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> return self.get_case(case_id)

2402 +</code></pre></div></td></tr></table></div>

2403 + </details>

2404 + </div>

2405 +

2406 +</div>

2407 +

2408 +<div class="doc doc-object doc-function">

2409 +

2410 +

2411 +

2412 +<h3 id="app.services.DFIR_IRIS.cases.CasesService.get_case" class="doc doc-heading">

2413 +<code class="highlight language-python">get_case(case_id)</code>

2414 +

2415 +</h3>

2416 +

2417 +

2418 + <div class="doc doc-contents ">

2419 +

2420 + Gets a case from DFIR-IRIS and returns all the details

2421 +

2422 + Returns:

2423 + <table>

2424 + <thead>

2425 + <tr>

2426 +<th>Name</th> <th>Type</th>

2427 + <th>Description</th>

2428 + </tr>

2429 + </thead>

2430 + <tbody>

2431 + <tr>

2432 +<td><code>dict</code></td> <td>

2433 + <code>bool</code>

2434 + </td>

2435 + <td>

2436 + <div class="doc-md-description">

2437 + A dictionary containing the success status, a message and potentially the case.

2438 + </div>

2439 + </td>

2440 + </tr>

2441 + </tbody>

2442 + </table>

2443 +

2444 + <details class="quote">

2445 + <summary>Source code in <code>app\services\DFIR_IRIS\cases.py</code></summary>

2446 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-61">61</a>

2447 +<a href="#__codelineno-0-62">62</a>

2448 +<a href="#__codelineno-0-63">63</a>

2449 +<a href="#__codelineno-0-64">64</a>

2450 +<a href="#__codelineno-0-65">65</a>

2451 +<a href="#__codelineno-0-66">66</a>

2452 +<a href="#__codelineno-0-67">67</a>

2453 +<a href="#__codelineno-0-68">68</a>

2454 +<a href="#__codelineno-0-69">69</a>

2455 +<a href="#__codelineno-0-70">70</a>

2456 +<a href="#__codelineno-0-71">71</a>

2457 +<a href="#__codelineno-0-72">72</a>

2458 +<a href="#__codelineno-0-73">73</a>

2459 +<a href="#__codelineno-0-74">74</a>

2460 +<a href="#__codelineno-0-75">75</a>

2461 +<a href="#__codelineno-0-76">76</a>

2462 +<a href="#__codelineno-0-77">77</a>

2463 +<a href="#__codelineno-0-78">78</a>

2464 +<a href="#__codelineno-0-79">79</a>

2465 +<a href="#__codelineno-0-80">80</a>

2466 +<a href="#__codelineno-0-81">81</a>

2467 +<a href="#__codelineno-0-82">82</a>

2468 +<a href="#__codelineno-0-83">83</a>

2469 +<a href="#__codelineno-0-84">84</a>

2470 +<a href="#__codelineno-0-85">85</a>

2471 +<a href="#__codelineno-0-86">86</a>

2472 +<a href="#__codelineno-0-87">87</a>

2473 +<a href="#__codelineno-0-88">88</a>

2474 +<a href="#__codelineno-0-89">89</a>

2475 +<a href="#__codelineno-0-90">90</a>

2476 +<a href="#__codelineno-0-91">91</a>

2477 +<a href="#__codelineno-0-92">92</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-61" name="__codelineno-0-61"></a>def get_case(self, case_id: int) -> bool:

2478 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> """

2479 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> Gets a case from DFIR-IRIS and returns all the details

2480 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a>

2481 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Returns:

2482 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> dict: A dictionary containing the success status, a message and potentially the case.

2483 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> """

2484 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> if self.iris_session is None:

2485 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> return {

2486 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> "success": False,

2487 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> "message": "DFIR-IRIS session was not successfully created.",

2488 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> }

2489 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a>

2490 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> logger.info(f"Collecting case {case_id} from DFIR-IRIS")

2491 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> case = Case(session=self.iris_session)

2492 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> result = self.universal_service.fetch_and_parse_data(

2493 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> self.iris_session,

2494 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> case.get_case,

2495 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> case_id,

2496 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> )

2497 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a>

2498 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> if not result["success"]:

2499 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> return {

2500 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> "success": False,

2501 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> "message": f"Failed to collect case {case_id} from DFIR-IRIS",

2502 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> }

2503 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a>

2504 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> return {

2505 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> "success": True,

2506 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> "message": f"Successfully collected case {case_id} from DFIR-IRIS",

2507 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> "case": result["data"],

2508 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> }

2509 +</code></pre></div></td></tr></table></div>

2510 + </details>

2511 + </div>

2512 +

2513 +</div>

2514 +

2515 +<div class="doc doc-object doc-function">

2516 +

2517 +

2518 +

2519 +<h3 id="app.services.DFIR_IRIS.cases.CasesService.list_cases" class="doc doc-heading">

2520 +<code class="highlight language-python">list_cases()</code>

2521 +

2522 +</h3>

2523 +

2524 +

2525 + <div class="doc doc-contents ">

2526 +

2527 + Lists all cases from DFIR-IRIS

2528 +

2529 + Returns:

2530 + <table>

2531 + <thead>

2532 + <tr>

2533 +<th>Name</th> <th>Type</th>

2534 + <th>Description</th>

2535 + </tr>

2536 + </thead>

2537 + <tbody>

2538 + <tr>

2539 +<td><code>dict</code></td> <td>

2540 + <code>Dict[str, object]</code>

2541 + </td>

2542 + <td>

2543 + <div class="doc-md-description">

2544 + A dictionary containing the success status, a message and potentially the cases.

2545 + </div>

2546 + </td>

2547 + </tr>

2548 + </tbody>

2549 + </table>

2550 +

2551 + <details class="quote">

2552 + <summary>Source code in <code>app\services\DFIR_IRIS\cases.py</code></summary>

2553 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-29">29</a>

2554 +<a href="#__codelineno-0-30">30</a>

2555 +<a href="#__codelineno-0-31">31</a>

2556 +<a href="#__codelineno-0-32">32</a>

2557 +<a href="#__codelineno-0-33">33</a>

2558 +<a href="#__codelineno-0-34">34</a>

2559 +<a href="#__codelineno-0-35">35</a>

2560 +<a href="#__codelineno-0-36">36</a>

2561 +<a href="#__codelineno-0-37">37</a>

2562 +<a href="#__codelineno-0-38">38</a>

2563 +<a href="#__codelineno-0-39">39</a>

2564 +<a href="#__codelineno-0-40">40</a>

2565 +<a href="#__codelineno-0-41">41</a>

2566 +<a href="#__codelineno-0-42">42</a>

2567 +<a href="#__codelineno-0-43">43</a>

2568 +<a href="#__codelineno-0-44">44</a>

2569 +<a href="#__codelineno-0-45">45</a>

2570 +<a href="#__codelineno-0-46">46</a>

2571 +<a href="#__codelineno-0-47">47</a>

2572 +<a href="#__codelineno-0-48">48</a>

2573 +<a href="#__codelineno-0-49">49</a>

2574 +<a href="#__codelineno-0-50">50</a>

2575 +<a href="#__codelineno-0-51">51</a>

2576 +<a href="#__codelineno-0-52">52</a>

2577 +<a href="#__codelineno-0-53">53</a>

2578 +<a href="#__codelineno-0-54">54</a>

2579 +<a href="#__codelineno-0-55">55</a>

2580 +<a href="#__codelineno-0-56">56</a>

2581 +<a href="#__codelineno-0-57">57</a>

2582 +<a href="#__codelineno-0-58">58</a>

2583 +<a href="#__codelineno-0-59">59</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-29" name="__codelineno-0-29"></a>def list_cases(self) -> Dict[str, object]:

2584 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> """

2585 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> Lists all cases from DFIR-IRIS

2586 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a>

2587 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> Returns:

2588 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> dict: A dictionary containing the success status, a message and potentially the cases.

2589 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> """

2590 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> if self.iris_session is None:

2591 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> return {

2592 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> "success": False,

2593 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> "message": "DFIR-IRIS session was not successfully created.",

2594 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> }

2595 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a>

2596 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> logger.info("Collecting cases from DFIR-IRIS")

2597 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> case = Case(session=self.iris_session)

2598 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> result = self.universal_service.fetch_and_parse_data(

2599 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> self.iris_session,

2600 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> case.list_cases,

2601 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> )

2602 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a>

2603 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> if not result["success"]:

2604 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> return {

2605 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> "success": False,

2606 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> "message": "Failed to collect cases from DFIR-IRIS",

2607 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> }

2608 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a>

2609 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> return {

2610 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> "success": True,

2611 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> "message": "Successfully collected cases from DFIR-IRIS",

2612 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> "cases": result["data"],

2613 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> }

2614 +</code></pre></div></td></tr></table></div>

2615 + </details>

2616 + </div>

2617 +

2618 +</div>

2619 +

2620 +

2621 +

2622 + </div>

2623 +

2624 + </div>

2625 +

2626 +</div>

2627 +

2628 +

2629 +

2630 +

2631 + </div>

2632 +

2633 + </div>

2634 +

2635 +</div>

2636 +<h3 id="assets-services">Assets Services</h3>

2637 +

2638 +

2639 +<div class="doc doc-object doc-module">

2640 +

2641 +

2642 +<a id="app.services.DFIR_IRIS.assets"></a>

2643 + <div class="doc doc-contents first">

2644 +

2645 +

2646 +

2647 + <div class="doc doc-children">

2648 +

2649 +

2650 +

2651 +

2652 +

2653 +

2654 +

2655 +

2656 +<div class="doc doc-object doc-class">

2657 +

2658 +

2659 +

2660 +<h2 id="app.services.DFIR_IRIS.assets.AssetsService" class="doc doc-heading">

2661 + <code>AssetsService</code>

2662 +

2663 +

2664 +</h2>

2665 +

2666 +

2667 + <div class="doc doc-contents ">

2668 +

2669 +

2670 + A service class that encapsulates the logic for pulling case assets from DFIR-IRIS. It creates a DFIR-IRIS session upon

2671 +initialization and uses it to fetch case assets.

2672 +

2673 +

2674 + <details class="quote">

2675 + <summary>Source code in <code>app\services\DFIR_IRIS\assets.py</code></summary>

2676 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-14">14</a>

2677 +<a href="#__codelineno-0-15">15</a>

2678 +<a href="#__codelineno-0-16">16</a>

2679 +<a href="#__codelineno-0-17">17</a>

2680 +<a href="#__codelineno-0-18">18</a>

2681 +<a href="#__codelineno-0-19">19</a>

2682 +<a href="#__codelineno-0-20">20</a>

2683 +<a href="#__codelineno-0-21">21</a>

2684 +<a href="#__codelineno-0-22">22</a>

2685 +<a href="#__codelineno-0-23">23</a>

2686 +<a href="#__codelineno-0-24">24</a>

2687 +<a href="#__codelineno-0-25">25</a>

2688 +<a href="#__codelineno-0-26">26</a>

2689 +<a href="#__codelineno-0-27">27</a>

2690 +<a href="#__codelineno-0-28">28</a>

2691 +<a href="#__codelineno-0-29">29</a>

2692 +<a href="#__codelineno-0-30">30</a>

2693 +<a href="#__codelineno-0-31">31</a>

2694 +<a href="#__codelineno-0-32">32</a>

2695 +<a href="#__codelineno-0-33">33</a>

2696 +<a href="#__codelineno-0-34">34</a>

2697 +<a href="#__codelineno-0-35">35</a>

2698 +<a href="#__codelineno-0-36">36</a>

2699 +<a href="#__codelineno-0-37">37</a>

2700 +<a href="#__codelineno-0-38">38</a>

2701 +<a href="#__codelineno-0-39">39</a>

2702 +<a href="#__codelineno-0-40">40</a>

2703 +<a href="#__codelineno-0-41">41</a>

2704 +<a href="#__codelineno-0-42">42</a>

2705 +<a href="#__codelineno-0-43">43</a>

2706 +<a href="#__codelineno-0-44">44</a>

2707 +<a href="#__codelineno-0-45">45</a>

2708 +<a href="#__codelineno-0-46">46</a>

2709 +<a href="#__codelineno-0-47">47</a>

2710 +<a href="#__codelineno-0-48">48</a>

2711 +<a href="#__codelineno-0-49">49</a>

2712 +<a href="#__codelineno-0-50">50</a>

2713 +<a href="#__codelineno-0-51">51</a>

2714 +<a href="#__codelineno-0-52">52</a>

2715 +<a href="#__codelineno-0-53">53</a>

2716 +<a href="#__codelineno-0-54">54</a>

2717 +<a href="#__codelineno-0-55">55</a>

2718 +<a href="#__codelineno-0-56">56</a>

2719 +<a href="#__codelineno-0-57">57</a>

2720 +<a href="#__codelineno-0-58">58</a>

2721 +<a href="#__codelineno-0-59">59</a>

2722 +<a href="#__codelineno-0-60">60</a>

2723 +<a href="#__codelineno-0-61">61</a>

2724 +<a href="#__codelineno-0-62">62</a>

2725 +<a href="#__codelineno-0-63">63</a>

2726 +<a href="#__codelineno-0-64">64</a>

2727 +<a href="#__codelineno-0-65">65</a>

2728 +<a href="#__codelineno-0-66">66</a>

2729 +<a href="#__codelineno-0-67">67</a>

2730 +<a href="#__codelineno-0-68">68</a>

2731 +<a href="#__codelineno-0-69">69</a>

2732 +<a href="#__codelineno-0-70">70</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-14" name="__codelineno-0-14"></a>class AssetsService:

2733 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a> """

2734 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> A service class that encapsulates the logic for pulling case assets from DFIR-IRIS. It creates a DFIR-IRIS session upon

2735 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> initialization and uses it to fetch case assets.

2736 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> """

2737 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a>

2738 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> def __init__(self):

2739 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> """

2740 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> Initializes the AssetsService by creating a UniversalService object for "DFIR-IRIS" and establishing a session.

2741 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> If the session creation is unsuccessful, an error is logged and the iris_session attribute is set to None.

2742 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> """

2743 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> self.universal_service = UniversalService("DFIR-IRIS")

2744 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> session_result = self.universal_service.create_session()

2745 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a>

2746 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> if not session_result["success"]:

2747 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> logger.error(session_result["message"])

2748 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> self.iris_session = None

2749 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> else:

2750 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> self.iris_session = session_result["session"]

2751 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a>

2752 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> def get_case_assets(self, cid: int) -> Dict[str, object]:

2753 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> """

2754 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> Retrieves the assets of a specific case from DFIR-IRIS. If the iris_session attribute is None, this indicates

2755 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> that the session creation was unsuccessful, and a dictionary with "success" set to False is returned. Otherwise,

2756 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> it attempts to fetch and parse the assets data for the case specified by the `cid` parameter.

2757 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a>

2758 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> Args:

2759 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> cid (int): The ID of the case for which to retrieve assets.

2760 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a>

2761 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> Returns:

2762 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> dict: A dictionary containing the success status, a message, and potentially the fetched assets. The

2763 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> "success" key is a boolean indicating whether the operation was successful. The "message" key is a string

2764 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> providing details about the operation. If "success" is True, the dictionary also contains the "data" key

2765 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> with the fetched assets.

2766 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> """

2767 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> if self.iris_session is None:

2768 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> return {

2769 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> "success": False,

2770 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> "message": "DFIR-IRIS session was not successfully created.",

2771 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> }

2772 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a>

2773 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> logger.info(f"Collecting case {cid} assets from DFIR-IRIS")

2774 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> case = Case(session=self.iris_session)

2775 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> cid = int(cid)

2776 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> result = self.universal_service.fetch_and_parse_data(

2777 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> self.iris_session,

2778 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> case.list_assets,

2779 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> cid,

2780 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> )

2781 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a>

2782 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> if not result["success"]:

2783 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> return {

2784 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> "success": False,

2785 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> "message": "Failed to collect notes from DFIR-IRIS",

2786 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> }

2787 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a>

2788 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> return result

2789 +</code></pre></div></td></tr></table></div>

2790 + </details>

2791 +

2792 +

2793 +

2794 + <div class="doc doc-children">

2795 +

2796 +

2797 +

2798 +

2799 +

2800 +

2801 +

2802 +

2803 +

2804 +<div class="doc doc-object doc-function">

2805 +

2806 +

2807 +

2808 +<h3 id="app.services.DFIR_IRIS.assets.AssetsService.__init__" class="doc doc-heading">

2809 +<code class="highlight language-python">__init__()</code>

2810 +

2811 +</h3>

2812 +

2813 +

2814 + <div class="doc doc-contents ">

2815 +

2816 + Initializes the AssetsService by creating a UniversalService object for "DFIR-IRIS" and establishing a session.

2817 +If the session creation is unsuccessful, an error is logged and the iris_session attribute is set to None.

2818 +

2819 + <details class="quote">

2820 + <summary>Source code in <code>app\services\DFIR_IRIS\assets.py</code></summary>

2821 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-20">20</a>

2822 +<a href="#__codelineno-0-21">21</a>

2823 +<a href="#__codelineno-0-22">22</a>

2824 +<a href="#__codelineno-0-23">23</a>

2825 +<a href="#__codelineno-0-24">24</a>

2826 +<a href="#__codelineno-0-25">25</a>

2827 +<a href="#__codelineno-0-26">26</a>

2828 +<a href="#__codelineno-0-27">27</a>

2829 +<a href="#__codelineno-0-28">28</a>

2830 +<a href="#__codelineno-0-29">29</a>

2831 +<a href="#__codelineno-0-30">30</a>

2832 +<a href="#__codelineno-0-31">31</a>

2833 +<a href="#__codelineno-0-32">32</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-20" name="__codelineno-0-20"></a>def __init__(self):

2834 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> """

2835 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> Initializes the AssetsService by creating a UniversalService object for "DFIR-IRIS" and establishing a session.

2836 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> If the session creation is unsuccessful, an error is logged and the iris_session attribute is set to None.

2837 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> """

2838 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> self.universal_service = UniversalService("DFIR-IRIS")

2839 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> session_result = self.universal_service.create_session()

2840 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a>

2841 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> if not session_result["success"]:

2842 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> logger.error(session_result["message"])

2843 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> self.iris_session = None

2844 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> else:

2845 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> self.iris_session = session_result["session"]

2846 +</code></pre></div></td></tr></table></div>

2847 + </details>

2848 + </div>

2849 +

2850 +</div>

2851 +

2852 +<div class="doc doc-object doc-function">

2853 +

2854 +

2855 +

2856 +<h3 id="app.services.DFIR_IRIS.assets.AssetsService.get_case_assets" class="doc doc-heading">

2857 +<code class="highlight language-python">get_case_assets(cid)</code>

2858 +

2859 +</h3>

2860 +

2861 +

2862 + <div class="doc doc-contents ">

2863 +

2864 + Retrieves the assets of a specific case from DFIR-IRIS. If the iris_session attribute is None, this indicates

2865 +that the session creation was unsuccessful, and a dictionary with "success" set to False is returned. Otherwise,

2866 +it attempts to fetch and parse the assets data for the case specified by the <code>cid</code> parameter.

2867 +

2868 + Parameters:

2869 + <table>

2870 + <thead>

2871 + <tr>

2872 + <th>Name</th>

2873 + <th>Type</th>

2874 + <th>Description</th>

2875 + <th>Default</th>

2876 + </tr>

2877 + </thead>

2878 + <tbody>

2879 + <tr>

2880 + <td><code>cid</code></td>

2881 + <td>

2882 + <code>int</code>

2883 + </td>

2884 + <td>

2885 + <div class="doc-md-description">

2886 + The ID of the case for which to retrieve assets.

2887 + </div>

2888 + </td>

2889 + <td>

2890 + required

2891 + </td>

2892 + </tr>

2893 + </tbody>

2894 + </table>

2895 +

2896 + Returns:

2897 + <table>

2898 + <thead>

2899 + <tr>

2900 +<th>Name</th> <th>Type</th>

2901 + <th>Description</th>

2902 + </tr>

2903 + </thead>

2904 + <tbody>

2905 + <tr>

2906 +<td><code>dict</code></td> <td>

2907 + <code>Dict[str, object]</code>

2908 + </td>

2909 + <td>

2910 + <div class="doc-md-description">

2911 + A dictionary containing the success status, a message, and potentially the fetched assets. The

2912 + </div>

2913 + </td>

2914 + </tr>

2915 + <tr>

2916 +<td></td> <td>

2917 + <code>Dict[str, object]</code>

2918 + </td>

2919 + <td>

2920 + <div class="doc-md-description">

2921 + "success" key is a boolean indicating whether the operation was successful. The "message" key is a string

2922 + </div>

2923 + </td>

2924 + </tr>

2925 + <tr>

2926 +<td></td> <td>

2927 + <code>Dict[str, object]</code>

2928 + </td>

2929 + <td>

2930 + <div class="doc-md-description">

2931 + providing details about the operation. If "success" is True, the dictionary also contains the "data" key

2932 + </div>

2933 + </td>

2934 + </tr>

2935 + <tr>

2936 +<td></td> <td>

2937 + <code>Dict[str, object]</code>

2938 + </td>

2939 + <td>

2940 + <div class="doc-md-description">

2941 + with the fetched assets.

2942 + </div>

2943 + </td>

2944 + </tr>

2945 + </tbody>

2946 + </table>

2947 +

2948 + <details class="quote">

2949 + <summary>Source code in <code>app\services\DFIR_IRIS\assets.py</code></summary>

2950 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-34">34</a>

2951 +<a href="#__codelineno-0-35">35</a>

2952 +<a href="#__codelineno-0-36">36</a>

2953 +<a href="#__codelineno-0-37">37</a>

2954 +<a href="#__codelineno-0-38">38</a>

2955 +<a href="#__codelineno-0-39">39</a>

2956 +<a href="#__codelineno-0-40">40</a>

2957 +<a href="#__codelineno-0-41">41</a>

2958 +<a href="#__codelineno-0-42">42</a>

2959 +<a href="#__codelineno-0-43">43</a>

2960 +<a href="#__codelineno-0-44">44</a>

2961 +<a href="#__codelineno-0-45">45</a>

2962 +<a href="#__codelineno-0-46">46</a>

2963 +<a href="#__codelineno-0-47">47</a>

2964 +<a href="#__codelineno-0-48">48</a>

2965 +<a href="#__codelineno-0-49">49</a>

2966 +<a href="#__codelineno-0-50">50</a>

2967 +<a href="#__codelineno-0-51">51</a>

2968 +<a href="#__codelineno-0-52">52</a>

2969 +<a href="#__codelineno-0-53">53</a>

2970 +<a href="#__codelineno-0-54">54</a>

2971 +<a href="#__codelineno-0-55">55</a>

2972 +<a href="#__codelineno-0-56">56</a>

2973 +<a href="#__codelineno-0-57">57</a>

2974 +<a href="#__codelineno-0-58">58</a>

2975 +<a href="#__codelineno-0-59">59</a>

2976 +<a href="#__codelineno-0-60">60</a>

2977 +<a href="#__codelineno-0-61">61</a>

2978 +<a href="#__codelineno-0-62">62</a>

2979 +<a href="#__codelineno-0-63">63</a>

2980 +<a href="#__codelineno-0-64">64</a>

2981 +<a href="#__codelineno-0-65">65</a>

2982 +<a href="#__codelineno-0-66">66</a>

2983 +<a href="#__codelineno-0-67">67</a>

2984 +<a href="#__codelineno-0-68">68</a>

2985 +<a href="#__codelineno-0-69">69</a>

2986 +<a href="#__codelineno-0-70">70</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-34" name="__codelineno-0-34"></a>def get_case_assets(self, cid: int) -> Dict[str, object]:

2987 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> """

2988 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> Retrieves the assets of a specific case from DFIR-IRIS. If the iris_session attribute is None, this indicates

2989 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> that the session creation was unsuccessful, and a dictionary with "success" set to False is returned. Otherwise,

2990 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> it attempts to fetch and parse the assets data for the case specified by the `cid` parameter.

2991 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a>

2992 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> Args:

2993 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> cid (int): The ID of the case for which to retrieve assets.

2994 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a>

2995 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> Returns:

2996 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> dict: A dictionary containing the success status, a message, and potentially the fetched assets. The

2997 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> "success" key is a boolean indicating whether the operation was successful. The "message" key is a string

2998 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> providing details about the operation. If "success" is True, the dictionary also contains the "data" key

2999 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> with the fetched assets.

3000 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> """

3001 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> if self.iris_session is None:

3002 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> return {

3003 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> "success": False,

3004 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> "message": "DFIR-IRIS session was not successfully created.",

3005 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> }

3006 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a>

3007 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> logger.info(f"Collecting case {cid} assets from DFIR-IRIS")

3008 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> case = Case(session=self.iris_session)

3009 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> cid = int(cid)

3010 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> result = self.universal_service.fetch_and_parse_data(

3011 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> self.iris_session,

3012 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> case.list_assets,

3013 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> cid,

3014 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> )

3015 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a>

3016 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> if not result["success"]:

3017 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> return {

3018 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> "success": False,

3019 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> "message": "Failed to collect notes from DFIR-IRIS",

3020 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> }

3021 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a>

3022 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> return result

3023 +</code></pre></div></td></tr></table></div>

3024 + </details>

3025 + </div>

3026 +

3027 +</div>

3028 +

3029 +

3030 +

3031 + </div>

3032 +

3033 + </div>

3034 +

3035 +</div>

3036 +

3037 +

3038 +

3039 +

3040 + </div>

3041 +

3042 + </div>

3043 +

3044 +</div>

3045 +<h3 id="notes-services">Notes Services</h3>

3046 +

3047 +

3048 +<div class="doc doc-object doc-module">

3049 +

3050 +

3051 +<a id="app.services.DFIR_IRIS.notes"></a>

3052 + <div class="doc doc-contents first">

3053 +

3054 +

3055 +

3056 + <div class="doc doc-children">

3057 +

3058 +

3059 +

3060 +

3061 +

3062 +

3063 +

3064 +

3065 +<div class="doc doc-object doc-class">

3066 +

3067 +

3068 +

3069 +<h2 id="app.services.DFIR_IRIS.notes.NotesService" class="doc doc-heading">

3070 + <code>NotesService</code>

3071 +

3072 +

3073 +</h2>

3074 +

3075 +

3076 + <div class="doc doc-contents ">

3077 +

3078 +

3079 + A service class that encapsulates the logic for pulling and managing case notes from DFIR-IRIS. This class handles

3080 +fetching and creating case notes. It creates a DFIR-IRIS session upon initialization and uses it to interact with

3081 +the DFIR-IRIS case notes.

3082 +

3083 +

3084 + <details class="quote">

3085 + <summary>Source code in <code>app\services\DFIR_IRIS\notes.py</code></summary>

3086 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-14"> 14</a>

3087 +<a href="#__codelineno-0-15"> 15</a>

3088 +<a href="#__codelineno-0-16"> 16</a>

3089 +<a href="#__codelineno-0-17"> 17</a>

3090 +<a href="#__codelineno-0-18"> 18</a>

3091 +<a href="#__codelineno-0-19"> 19</a>

3092 +<a href="#__codelineno-0-20"> 20</a>

3093 +<a href="#__codelineno-0-21"> 21</a>

3094 +<a href="#__codelineno-0-22"> 22</a>

3095 +<a href="#__codelineno-0-23"> 23</a>

3096 +<a href="#__codelineno-0-24"> 24</a>

3097 +<a href="#__codelineno-0-25"> 25</a>

3098 +<a href="#__codelineno-0-26"> 26</a>

3099 +<a href="#__codelineno-0-27"> 27</a>

3100 +<a href="#__codelineno-0-28"> 28</a>

3101 +<a href="#__codelineno-0-29"> 29</a>

3102 +<a href="#__codelineno-0-30"> 30</a>

3103 +<a href="#__codelineno-0-31"> 31</a>

3104 +<a href="#__codelineno-0-32"> 32</a>

3105 +<a href="#__codelineno-0-33"> 33</a>

3106 +<a href="#__codelineno-0-34"> 34</a>

3107 +<a href="#__codelineno-0-35"> 35</a>

3108 +<a href="#__codelineno-0-36"> 36</a>

3109 +<a href="#__codelineno-0-37"> 37</a>

3110 +<a href="#__codelineno-0-38"> 38</a>

3111 +<a href="#__codelineno-0-39"> 39</a>

3112 +<a href="#__codelineno-0-40"> 40</a>

3113 +<a href="#__codelineno-0-41"> 41</a>

3114 +<a href="#__codelineno-0-42"> 42</a>

3115 +<a href="#__codelineno-0-43"> 43</a>

3116 +<a href="#__codelineno-0-44"> 44</a>

3117 +<a href="#__codelineno-0-45"> 45</a>

3118 +<a href="#__codelineno-0-46"> 46</a>

3119 +<a href="#__codelineno-0-47"> 47</a>

3120 +<a href="#__codelineno-0-48"> 48</a>

3121 +<a href="#__codelineno-0-49"> 49</a>

3122 +<a href="#__codelineno-0-50"> 50</a>

3123 +<a href="#__codelineno-0-51"> 51</a>

3124 +<a href="#__codelineno-0-52"> 52</a>

3125 +<a href="#__codelineno-0-53"> 53</a>

3126 +<a href="#__codelineno-0-54"> 54</a>

3127 +<a href="#__codelineno-0-55"> 55</a>

3128 +<a href="#__codelineno-0-56"> 56</a>

3129 +<a href="#__codelineno-0-57"> 57</a>

3130 +<a href="#__codelineno-0-58"> 58</a>

3131 +<a href="#__codelineno-0-59"> 59</a>

3132 +<a href="#__codelineno-0-60"> 60</a>

3133 +<a href="#__codelineno-0-61"> 61</a>

3134 +<a href="#__codelineno-0-62"> 62</a>

3135 +<a href="#__codelineno-0-63"> 63</a>

3136 +<a href="#__codelineno-0-64"> 64</a>

3137 +<a href="#__codelineno-0-65"> 65</a>

3138 +<a href="#__codelineno-0-66"> 66</a>

3139 +<a href="#__codelineno-0-67"> 67</a>

3140 +<a href="#__codelineno-0-68"> 68</a>

3141 +<a href="#__codelineno-0-69"> 69</a>

3142 +<a href="#__codelineno-0-70"> 70</a>

3143 +<a href="#__codelineno-0-71"> 71</a>

3144 +<a href="#__codelineno-0-72"> 72</a>

3145 +<a href="#__codelineno-0-73"> 73</a>

3146 +<a href="#__codelineno-0-74"> 74</a>

3147 +<a href="#__codelineno-0-75"> 75</a>

3148 +<a href="#__codelineno-0-76"> 76</a>

3149 +<a href="#__codelineno-0-77"> 77</a>

3150 +<a href="#__codelineno-0-78"> 78</a>

3151 +<a href="#__codelineno-0-79"> 79</a>

3152 +<a href="#__codelineno-0-80"> 80</a>

3153 +<a href="#__codelineno-0-81"> 81</a>

3154 +<a href="#__codelineno-0-82"> 82</a>

3155 +<a href="#__codelineno-0-83"> 83</a>

3156 +<a href="#__codelineno-0-84"> 84</a>

3157 +<a href="#__codelineno-0-85"> 85</a>

3158 +<a href="#__codelineno-0-86"> 86</a>

3159 +<a href="#__codelineno-0-87"> 87</a>

3160 +<a href="#__codelineno-0-88"> 88</a>

3161 +<a href="#__codelineno-0-89"> 89</a>

3162 +<a href="#__codelineno-0-90"> 90</a>

3163 +<a href="#__codelineno-0-91"> 91</a>

3164 +<a href="#__codelineno-0-92"> 92</a>

3165 +<a href="#__codelineno-0-93"> 93</a>

3166 +<a href="#__codelineno-0-94"> 94</a>

3167 +<a href="#__codelineno-0-95"> 95</a>

3168 +<a href="#__codelineno-0-96"> 96</a>

3169 +<a href="#__codelineno-0-97"> 97</a>

3170 +<a href="#__codelineno-0-98"> 98</a>

3171 +<a href="#__codelineno-0-99"> 99</a>

3172 +<a href="#__codelineno-0-100">100</a>

3173 +<a href="#__codelineno-0-101">101</a>

3174 +<a href="#__codelineno-0-102">102</a>

3175 +<a href="#__codelineno-0-103">103</a>

3176 +<a href="#__codelineno-0-104">104</a>

3177 +<a href="#__codelineno-0-105">105</a>

3178 +<a href="#__codelineno-0-106">106</a>

3179 +<a href="#__codelineno-0-107">107</a>

3180 +<a href="#__codelineno-0-108">108</a>

3181 +<a href="#__codelineno-0-109">109</a>

3182 +<a href="#__codelineno-0-110">110</a>

3183 +<a href="#__codelineno-0-111">111</a>

3184 +<a href="#__codelineno-0-112">112</a>

3185 +<a href="#__codelineno-0-113">113</a>

3186 +<a href="#__codelineno-0-114">114</a>

3187 +<a href="#__codelineno-0-115">115</a>

3188 +<a href="#__codelineno-0-116">116</a>

3189 +<a href="#__codelineno-0-117">117</a>

3190 +<a href="#__codelineno-0-118">118</a>

3191 +<a href="#__codelineno-0-119">119</a>

3192 +<a href="#__codelineno-0-120">120</a>

3193 +<a href="#__codelineno-0-121">121</a>

3194 +<a href="#__codelineno-0-122">122</a>

3195 +<a href="#__codelineno-0-123">123</a>

3196 +<a href="#__codelineno-0-124">124</a>

3197 +<a href="#__codelineno-0-125">125</a>

3198 +<a href="#__codelineno-0-126">126</a>

3199 +<a href="#__codelineno-0-127">127</a>

3200 +<a href="#__codelineno-0-128">128</a>

3201 +<a href="#__codelineno-0-129">129</a>

3202 +<a href="#__codelineno-0-130">130</a>

3203 +<a href="#__codelineno-0-131">131</a>

3204 +<a href="#__codelineno-0-132">132</a>

3205 +<a href="#__codelineno-0-133">133</a>

3206 +<a href="#__codelineno-0-134">134</a>

3207 +<a href="#__codelineno-0-135">135</a>

3208 +<a href="#__codelineno-0-136">136</a>

3209 +<a href="#__codelineno-0-137">137</a>

3210 +<a href="#__codelineno-0-138">138</a>

3211 +<a href="#__codelineno-0-139">139</a>

3212 +<a href="#__codelineno-0-140">140</a>

3213 +<a href="#__codelineno-0-141">141</a>

3214 +<a href="#__codelineno-0-142">142</a>

3215 +<a href="#__codelineno-0-143">143</a>

3216 +<a href="#__codelineno-0-144">144</a>

3217 +<a href="#__codelineno-0-145">145</a>

3218 +<a href="#__codelineno-0-146">146</a>

3219 +<a href="#__codelineno-0-147">147</a>

3220 +<a href="#__codelineno-0-148">148</a>

3221 +<a href="#__codelineno-0-149">149</a>

3222 +<a href="#__codelineno-0-150">150</a>

3223 +<a href="#__codelineno-0-151">151</a>

3224 +<a href="#__codelineno-0-152">152</a>

3225 +<a href="#__codelineno-0-153">153</a>

3226 +<a href="#__codelineno-0-154">154</a>

3227 +<a href="#__codelineno-0-155">155</a>

3228 +<a href="#__codelineno-0-156">156</a>

3229 +<a href="#__codelineno-0-157">157</a>

3230 +<a href="#__codelineno-0-158">158</a>

3231 +<a href="#__codelineno-0-159">159</a>

3232 +<a href="#__codelineno-0-160">160</a>

3233 +<a href="#__codelineno-0-161">161</a>

3234 +<a href="#__codelineno-0-162">162</a>

3235 +<a href="#__codelineno-0-163">163</a>

3236 +<a href="#__codelineno-0-164">164</a>

3237 +<a href="#__codelineno-0-165">165</a>

3238 +<a href="#__codelineno-0-166">166</a>

3239 +<a href="#__codelineno-0-167">167</a>

3240 +<a href="#__codelineno-0-168">168</a>

3241 +<a href="#__codelineno-0-169">169</a>

3242 +<a href="#__codelineno-0-170">170</a>

3243 +<a href="#__codelineno-0-171">171</a>

3244 +<a href="#__codelineno-0-172">172</a>

3245 +<a href="#__codelineno-0-173">173</a>

3246 +<a href="#__codelineno-0-174">174</a>

3247 +<a href="#__codelineno-0-175">175</a>

3248 +<a href="#__codelineno-0-176">176</a>

3249 +<a href="#__codelineno-0-177">177</a>

3250 +<a href="#__codelineno-0-178">178</a>

3251 +<a href="#__codelineno-0-179">179</a>

3252 +<a href="#__codelineno-0-180">180</a>

3253 +<a href="#__codelineno-0-181">181</a>

3254 +<a href="#__codelineno-0-182">182</a>

3255 +<a href="#__codelineno-0-183">183</a>

3256 +<a href="#__codelineno-0-184">184</a>

3257 +<a href="#__codelineno-0-185">185</a>

3258 +<a href="#__codelineno-0-186">186</a>

3259 +<a href="#__codelineno-0-187">187</a>

3260 +<a href="#__codelineno-0-188">188</a>

3261 +<a href="#__codelineno-0-189">189</a>

3262 +<a href="#__codelineno-0-190">190</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-14" name="__codelineno-0-14"></a>class NotesService:

3263 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a> """

3264 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> A service class that encapsulates the logic for pulling and managing case notes from DFIR-IRIS. This class handles

3265 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> fetching and creating case notes. It creates a DFIR-IRIS session upon initialization and uses it to interact with

3266 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> the DFIR-IRIS case notes.

3267 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> """

3268 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a>

3269 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> def __init__(self):

3270 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> """

3271 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> Initializes the NotesService by creating a UniversalService object for "DFIR-IRIS" and establishing a session.

3272 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> If the session creation is unsuccessful, an error is logged and the iris_session attribute is set to None.

3273 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> """

3274 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> self.universal_service = UniversalService("DFIR-IRIS")

3275 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> session_result = self.universal_service.create_session()

3276 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a>

3277 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> if not session_result["success"]:

3278 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> logger.error(session_result["message"])

3279 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> self.iris_session = None

3280 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> else:

3281 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> self.iris_session = session_result["session"]

3282 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a>

3283 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> def get_case_notes(self, search_term: str, cid: int) -> Dict[str, object]:

3284 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> """

3285 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> Retrieves the notes of a specific case from DFIR-IRIS. If the iris_session attribute is None, this indicates

3286 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> that the session creation was unsuccessful, and a dictionary with "success" set to False is returned. Otherwise,

3287 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> it attempts to fetch and parse the notes data for the case specified by the `cid` parameter.

3288 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a>

3289 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> Args:

3290 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> search_term (str): The search term to use when fetching case notes.

3291 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> cid (int): The ID of the case for which to retrieve notes.

3292 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a>

3293 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> Returns:

3294 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> dict: A dictionary containing the success status, a message, and potentially the fetched notes. The

3295 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> "success" key is a boolean indicating whether the operation was successful. The "message" key is a string

3296 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> providing details about the operation. If "success" is True, the dictionary also contains the "data" key

3297 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> with the fetched notes.

3298 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> """

3299 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> if self.iris_session is None:

3300 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> return {

3301 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> "success": False,

3302 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> "message": "DFIR-IRIS session was not successfully created.",

3303 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> }

3304 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a>

3305 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> logger.info(f"Collecting case {cid} from DFIR-IRIS")

3306 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> case = Case(session=self.iris_session)

3307 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> cid = int(cid)

3308 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> result = self.universal_service.fetch_and_parse_data(

3309 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> self.iris_session,

3310 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> case.search_notes,

3311 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> search_term,

3312 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> cid,

3313 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> )

3314 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a>

3315 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> if not result["success"]:

3316 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> return {

3317 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> "success": False,

3318 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> "message": "Failed to collect notes from DFIR-IRIS",

3319 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> }

3320 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a>

3321 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> # Loop through the notes and get the details

3322 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> for note in result["data"]:

3323 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> note_details = self._get_case_note_details(note["note_id"], cid)

3324 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> if not note_details["success"]:

3325 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> return {

3326 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> "success": False,

3327 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> "message": "Failed to collect notes from DFIR-IRIS",

3328 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> }

3329 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> note["note_details"] = note_details["notes"]

3330 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a>

3331 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> return result

3332 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a>

3333 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> def _get_case_note_details(self, note_id: int, cid: int) -> Dict[str, object]:

3334 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> """

3335 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> Retrieves the details of a specific note of a specific case from DFIR-IRIS. If the iris_session attribute is None,

3336 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> this indicates that the session creation was unsuccessful, and a dictionary with "success" set to False is

3337 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> returned. Otherwise, it attempts to fetch and parse the note data for the note specified by the `note_id`

3338 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> parameter and the case specified by the `cid` parameter.

3339 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a>

3340 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> Args:

3341 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a> note_id (int): The ID of the note for which to retrieve details.

3342 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> cid (int): The ID of the case for which to retrieve the note details.

3343 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a>

3344 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> Returns:

3345 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> dict: A dictionary containing the success status, a message, and potentially the fetched note details. The

3346 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> "success" key is a boolean indicating whether the operation was successful. The "message" key is a string

3347 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a> providing details about the operation. If "success" is True, the dictionary also contains the "notes" key

3348 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> with the fetched note details.

3349 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> """

3350 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> if self.iris_session is None:

3351 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> return {

3352 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a> "success": False,

3353 +<a id="__codelineno-0-105" name="__codelineno-0-105"></a> "message": "DFIR-IRIS session was not successfully created.",

3354 +<a id="__codelineno-0-106" name="__codelineno-0-106"></a> }

3355 +<a id="__codelineno-0-107" name="__codelineno-0-107"></a>

3356 +<a id="__codelineno-0-108" name="__codelineno-0-108"></a> logger.info(f"Collecting case {cid} from DFIR-IRIS")

3357 +<a id="__codelineno-0-109" name="__codelineno-0-109"></a> case = Case(session=self.iris_session)

3358 +<a id="__codelineno-0-110" name="__codelineno-0-110"></a> result = self.universal_service.fetch_and_parse_data(

3359 +<a id="__codelineno-0-111" name="__codelineno-0-111"></a> self.iris_session,

3360 +<a id="__codelineno-0-112" name="__codelineno-0-112"></a> case.get_note,

3361 +<a id="__codelineno-0-113" name="__codelineno-0-113"></a> note_id,

3362 +<a id="__codelineno-0-114" name="__codelineno-0-114"></a> cid,

3363 +<a id="__codelineno-0-115" name="__codelineno-0-115"></a> )

3364 +<a id="__codelineno-0-116" name="__codelineno-0-116"></a>

3365 +<a id="__codelineno-0-117" name="__codelineno-0-117"></a> if not result["success"]:

3366 +<a id="__codelineno-0-118" name="__codelineno-0-118"></a> return {

3367 +<a id="__codelineno-0-119" name="__codelineno-0-119"></a> "success": False,

3368 +<a id="__codelineno-0-120" name="__codelineno-0-120"></a> "message": "Failed to collect notes from DFIR-IRIS",

3369 +<a id="__codelineno-0-121" name="__codelineno-0-121"></a> }

3370 +<a id="__codelineno-0-122" name="__codelineno-0-122"></a>

3371 +<a id="__codelineno-0-123" name="__codelineno-0-123"></a> return {

3372 +<a id="__codelineno-0-124" name="__codelineno-0-124"></a> "success": True,

3373 +<a id="__codelineno-0-125" name="__codelineno-0-125"></a> "message": "Successfully collected notes from DFIR-IRIS",

3374 +<a id="__codelineno-0-126" name="__codelineno-0-126"></a> "notes": result["data"],

3375 +<a id="__codelineno-0-127" name="__codelineno-0-127"></a> }

3376 +<a id="__codelineno-0-128" name="__codelineno-0-128"></a>

3377 +<a id="__codelineno-0-129" name="__codelineno-0-129"></a> def create_case_note(

3378 +<a id="__codelineno-0-130" name="__codelineno-0-130"></a> self,

3379 +<a id="__codelineno-0-131" name="__codelineno-0-131"></a> cid: int,

3380 +<a id="__codelineno-0-132" name="__codelineno-0-132"></a> note_title: str,

3381 +<a id="__codelineno-0-133" name="__codelineno-0-133"></a> note_content: str,

3382 +<a id="__codelineno-0-134" name="__codelineno-0-134"></a> ) -> Dict[str, object]:

3383 +<a id="__codelineno-0-135" name="__codelineno-0-135"></a> """

3384 +<a id="__codelineno-0-136" name="__codelineno-0-136"></a> Creates a note for a specific case in DFIR-IRIS. If the iris_session attribute is None, this indicates that

3385 +<a id="__codelineno-0-137" name="__codelineno-0-137"></a> the session creation was unsuccessful, and a dictionary with "success" set to False is returned. Otherwise,

3386 +<a id="__codelineno-0-138" name="__codelineno-0-138"></a> it attempts to create a note with the specified `note_title` and `note_content` for the case specified by the

3387 +<a id="__codelineno-0-139" name="__codelineno-0-139"></a> `cid` parameter.

3388 +<a id="__codelineno-0-140" name="__codelineno-0-140"></a>

3389 +<a id="__codelineno-0-141" name="__codelineno-0-141"></a> Args:

3390 +<a id="__codelineno-0-142" name="__codelineno-0-142"></a> cid (int): The ID of the case for which to create a note.

3391 +<a id="__codelineno-0-143" name="__codelineno-0-143"></a> note_title (str): The title of the note to create.

3392 +<a id="__codelineno-0-144" name="__codelineno-0-144"></a> note_content (str): The content of the note to create.

3393 +<a id="__codelineno-0-145" name="__codelineno-0-145"></a>

3394 +<a id="__codelineno-0-146" name="__codelineno-0-146"></a> Returns:

3395 +<a id="__codelineno-0-147" name="__codelineno-0-147"></a> dict: A dictionary containing the success status, a message, and potentially the created note. The

3396 +<a id="__codelineno-0-148" name="__codelineno-0-148"></a> "success" key is a boolean indicating whether the operation was successful. The "message" key is a string

3397 +<a id="__codelineno-0-149" name="__codelineno-0-149"></a> providing details about the operation. If "success" is True, the dictionary also contains the "notes" key

3398 +<a id="__codelineno-0-150" name="__codelineno-0-150"></a> with the created note.

3399 +<a id="__codelineno-0-151" name="__codelineno-0-151"></a> """

3400 +<a id="__codelineno-0-152" name="__codelineno-0-152"></a> if self.iris_session is None:

3401 +<a id="__codelineno-0-153" name="__codelineno-0-153"></a> return {

3402 +<a id="__codelineno-0-154" name="__codelineno-0-154"></a> "success": False,

3403 +<a id="__codelineno-0-155" name="__codelineno-0-155"></a> "message": "DFIR-IRIS session was not successfully created.",

3404 +<a id="__codelineno-0-156" name="__codelineno-0-156"></a> }

3405 +<a id="__codelineno-0-157" name="__codelineno-0-157"></a>

3406 +<a id="__codelineno-0-158" name="__codelineno-0-158"></a> logger.info(f"Creating case {cid} note in DFIR-IRIS")

3407 +<a id="__codelineno-0-159" name="__codelineno-0-159"></a> case = Case(session=self.iris_session)

3408 +<a id="__codelineno-0-160" name="__codelineno-0-160"></a> cid = int(cid)

3409 +<a id="__codelineno-0-161" name="__codelineno-0-161"></a> # Creating Group for New Note

3410 +<a id="__codelineno-0-162" name="__codelineno-0-162"></a> note_group = self.universal_service.fetch_and_parse_data(

3411 +<a id="__codelineno-0-163" name="__codelineno-0-163"></a> self.iris_session,

3412 +<a id="__codelineno-0-164" name="__codelineno-0-164"></a> case.add_notes_group,

3413 +<a id="__codelineno-0-165" name="__codelineno-0-165"></a> note_title,

3414 +<a id="__codelineno-0-166" name="__codelineno-0-166"></a> cid,

3415 +<a id="__codelineno-0-167" name="__codelineno-0-167"></a> )

3416 +<a id="__codelineno-0-168" name="__codelineno-0-168"></a>

3417 +<a id="__codelineno-0-169" name="__codelineno-0-169"></a> if not note_group["success"]:

3418 +<a id="__codelineno-0-170" name="__codelineno-0-170"></a> return {"success": False, "message": "Failed to create note in DFIR-IRIS"}

3419 +<a id="__codelineno-0-171" name="__codelineno-0-171"></a> note_group_id = note_group["data"]["group_id"]

3420 +<a id="__codelineno-0-172" name="__codelineno-0-172"></a> custom_attributes = {}

3421 +<a id="__codelineno-0-173" name="__codelineno-0-173"></a> result = self.universal_service.fetch_and_parse_data(

3422 +<a id="__codelineno-0-174" name="__codelineno-0-174"></a> self.iris_session,

3423 +<a id="__codelineno-0-175" name="__codelineno-0-175"></a> case.add_note,

3424 +<a id="__codelineno-0-176" name="__codelineno-0-176"></a> note_title,

3425 +<a id="__codelineno-0-177" name="__codelineno-0-177"></a> note_content,

3426 +<a id="__codelineno-0-178" name="__codelineno-0-178"></a> note_group_id,

3427 +<a id="__codelineno-0-179" name="__codelineno-0-179"></a> custom_attributes,

3428 +<a id="__codelineno-0-180" name="__codelineno-0-180"></a> cid,

3429 +<a id="__codelineno-0-181" name="__codelineno-0-181"></a> )

3430 +<a id="__codelineno-0-182" name="__codelineno-0-182"></a>

3431 +<a id="__codelineno-0-183" name="__codelineno-0-183"></a> if not result["success"]:

3432 +<a id="__codelineno-0-184" name="__codelineno-0-184"></a> return {"success": False, "message": "Failed to create note in DFIR-IRIS"}

3433 +<a id="__codelineno-0-185" name="__codelineno-0-185"></a>

3434 +<a id="__codelineno-0-186" name="__codelineno-0-186"></a> return {

3435 +<a id="__codelineno-0-187" name="__codelineno-0-187"></a> "success": True,

3436 +<a id="__codelineno-0-188" name="__codelineno-0-188"></a> "message": "Successfully created note in DFIR-IRIS",

3437 +<a id="__codelineno-0-189" name="__codelineno-0-189"></a> "notes": result["data"],

3438 +<a id="__codelineno-0-190" name="__codelineno-0-190"></a> }

3439 +</code></pre></div></td></tr></table></div>

3440 + </details>

3441 +

3442 +

3443 +

3444 + <div class="doc doc-children">

3445 +

3446 +

3447 +

3448 +

3449 +

3450 +

3451 +

3452 +

3453 +

3454 +<div class="doc doc-object doc-function">

3455 +

3456 +

3457 +

3458 +<h3 id="app.services.DFIR_IRIS.notes.NotesService.__init__" class="doc doc-heading">

3459 +<code class="highlight language-python">__init__()</code>

3460 +

3461 +</h3>

3462 +

3463 +

3464 + <div class="doc doc-contents ">

3465 +

3466 + Initializes the NotesService by creating a UniversalService object for "DFIR-IRIS" and establishing a session.

3467 +If the session creation is unsuccessful, an error is logged and the iris_session attribute is set to None.

3468 +

3469 + <details class="quote">

3470 + <summary>Source code in <code>app\services\DFIR_IRIS\notes.py</code></summary>

3471 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-21">21</a>

3472 +<a href="#__codelineno-0-22">22</a>

3473 +<a href="#__codelineno-0-23">23</a>

3474 +<a href="#__codelineno-0-24">24</a>

3475 +<a href="#__codelineno-0-25">25</a>

3476 +<a href="#__codelineno-0-26">26</a>

3477 +<a href="#__codelineno-0-27">27</a>

3478 +<a href="#__codelineno-0-28">28</a>

3479 +<a href="#__codelineno-0-29">29</a>

3480 +<a href="#__codelineno-0-30">30</a>

3481 +<a href="#__codelineno-0-31">31</a>

3482 +<a href="#__codelineno-0-32">32</a>

3483 +<a href="#__codelineno-0-33">33</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-21" name="__codelineno-0-21"></a>def __init__(self):

3484 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> """

3485 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> Initializes the NotesService by creating a UniversalService object for "DFIR-IRIS" and establishing a session.

3486 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> If the session creation is unsuccessful, an error is logged and the iris_session attribute is set to None.

3487 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> """

3488 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> self.universal_service = UniversalService("DFIR-IRIS")

3489 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> session_result = self.universal_service.create_session()

3490 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a>

3491 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> if not session_result["success"]:

3492 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> logger.error(session_result["message"])

3493 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> self.iris_session = None

3494 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> else:

3495 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> self.iris_session = session_result["session"]

3496 +</code></pre></div></td></tr></table></div>

3497 + </details>

3498 + </div>

3499 +

3500 +</div>

3501 +

3502 +<div class="doc doc-object doc-function">

3503 +

3504 +

3505 +

3506 +<h3 id="app.services.DFIR_IRIS.notes.NotesService.create_case_note" class="doc doc-heading">

3507 +<code class="highlight language-python">create_case_note(cid, note_title, note_content)</code>

3508 +

3509 +</h3>

3510 +

3511 +

3512 + <div class="doc doc-contents ">

3513 +

3514 + Creates a note for a specific case in DFIR-IRIS. If the iris_session attribute is None, this indicates that

3515 +the session creation was unsuccessful, and a dictionary with "success" set to False is returned. Otherwise,

3516 +it attempts to create a note with the specified <code>note_title</code> and <code>note_content</code> for the case specified by the

3517 +<code>cid</code> parameter.

3518 +

3519 + Parameters:

3520 + <table>

3521 + <thead>

3522 + <tr>

3523 + <th>Name</th>

3524 + <th>Type</th>

3525 + <th>Description</th>

3526 + <th>Default</th>

3527 + </tr>

3528 + </thead>

3529 + <tbody>

3530 + <tr>

3531 + <td><code>cid</code></td>

3532 + <td>

3533 + <code>int</code>

3534 + </td>

3535 + <td>

3536 + <div class="doc-md-description">

3537 + The ID of the case for which to create a note.

3538 + </div>

3539 + </td>

3540 + <td>

3541 + required

3542 + </td>

3543 + </tr>

3544 + <tr>

3545 + <td><code>note_title</code></td>

3546 + <td>

3547 + <code>str</code>

3548 + </td>

3549 + <td>

3550 + <div class="doc-md-description">

3551 + The title of the note to create.

3552 + </div>

3553 + </td>

3554 + <td>

3555 + required

3556 + </td>

3557 + </tr>

3558 + <tr>

3559 + <td><code>note_content</code></td>

3560 + <td>

3561 + <code>str</code>

3562 + </td>

3563 + <td>

3564 + <div class="doc-md-description">

3565 + The content of the note to create.

3566 + </div>

3567 + </td>

3568 + <td>

3569 + required

3570 + </td>

3571 + </tr>

3572 + </tbody>

3573 + </table>

3574 +

3575 + Returns:

3576 + <table>

3577 + <thead>

3578 + <tr>

3579 +<th>Name</th> <th>Type</th>

3580 + <th>Description</th>

3581 + </tr>

3582 + </thead>

3583 + <tbody>

3584 + <tr>

3585 +<td><code>dict</code></td> <td>

3586 + <code>Dict[str, object]</code>

3587 + </td>

3588 + <td>

3589 + <div class="doc-md-description">

3590 + A dictionary containing the success status, a message, and potentially the created note. The

3591 + </div>

3592 + </td>

3593 + </tr>

3594 + <tr>

3595 +<td></td> <td>

3596 + <code>Dict[str, object]</code>

3597 + </td>

3598 + <td>

3599 + <div class="doc-md-description">

3600 + "success" key is a boolean indicating whether the operation was successful. The "message" key is a string

3601 + </div>

3602 + </td>

3603 + </tr>

3604 + <tr>

3605 +<td></td> <td>

3606 + <code>Dict[str, object]</code>

3607 + </td>

3608 + <td>

3609 + <div class="doc-md-description">

3610 + providing details about the operation. If "success" is True, the dictionary also contains the "notes" key

3611 + </div>

3612 + </td>

3613 + </tr>

3614 + <tr>

3615 +<td></td> <td>

3616 + <code>Dict[str, object]</code>

3617 + </td>

3618 + <td>

3619 + <div class="doc-md-description">

3620 + with the created note.

3621 + </div>

3622 + </td>

3623 + </tr>

3624 + </tbody>

3625 + </table>

3626 +

3627 + <details class="quote">

3628 + <summary>Source code in <code>app\services\DFIR_IRIS\notes.py</code></summary>

3629 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-129">129</a>

3630 +<a href="#__codelineno-0-130">130</a>

3631 +<a href="#__codelineno-0-131">131</a>

3632 +<a href="#__codelineno-0-132">132</a>

3633 +<a href="#__codelineno-0-133">133</a>

3634 +<a href="#__codelineno-0-134">134</a>

3635 +<a href="#__codelineno-0-135">135</a>

3636 +<a href="#__codelineno-0-136">136</a>

3637 +<a href="#__codelineno-0-137">137</a>

3638 +<a href="#__codelineno-0-138">138</a>

3639 +<a href="#__codelineno-0-139">139</a>

3640 +<a href="#__codelineno-0-140">140</a>

3641 +<a href="#__codelineno-0-141">141</a>

3642 +<a href="#__codelineno-0-142">142</a>

3643 +<a href="#__codelineno-0-143">143</a>

3644 +<a href="#__codelineno-0-144">144</a>

3645 +<a href="#__codelineno-0-145">145</a>

3646 +<a href="#__codelineno-0-146">146</a>

3647 +<a href="#__codelineno-0-147">147</a>

3648 +<a href="#__codelineno-0-148">148</a>

3649 +<a href="#__codelineno-0-149">149</a>

3650 +<a href="#__codelineno-0-150">150</a>

3651 +<a href="#__codelineno-0-151">151</a>

3652 +<a href="#__codelineno-0-152">152</a>

3653 +<a href="#__codelineno-0-153">153</a>

3654 +<a href="#__codelineno-0-154">154</a>

3655 +<a href="#__codelineno-0-155">155</a>

3656 +<a href="#__codelineno-0-156">156</a>

3657 +<a href="#__codelineno-0-157">157</a>

3658 +<a href="#__codelineno-0-158">158</a>

3659 +<a href="#__codelineno-0-159">159</a>

3660 +<a href="#__codelineno-0-160">160</a>

3661 +<a href="#__codelineno-0-161">161</a>

3662 +<a href="#__codelineno-0-162">162</a>

3663 +<a href="#__codelineno-0-163">163</a>

3664 +<a href="#__codelineno-0-164">164</a>

3665 +<a href="#__codelineno-0-165">165</a>

3666 +<a href="#__codelineno-0-166">166</a>

3667 +<a href="#__codelineno-0-167">167</a>

3668 +<a href="#__codelineno-0-168">168</a>

3669 +<a href="#__codelineno-0-169">169</a>

3670 +<a href="#__codelineno-0-170">170</a>

3671 +<a href="#__codelineno-0-171">171</a>

3672 +<a href="#__codelineno-0-172">172</a>

3673 +<a href="#__codelineno-0-173">173</a>

3674 +<a href="#__codelineno-0-174">174</a>

3675 +<a href="#__codelineno-0-175">175</a>

3676 +<a href="#__codelineno-0-176">176</a>

3677 +<a href="#__codelineno-0-177">177</a>

3678 +<a href="#__codelineno-0-178">178</a>

3679 +<a href="#__codelineno-0-179">179</a>

3680 +<a href="#__codelineno-0-180">180</a>

3681 +<a href="#__codelineno-0-181">181</a>

3682 +<a href="#__codelineno-0-182">182</a>

3683 +<a href="#__codelineno-0-183">183</a>

3684 +<a href="#__codelineno-0-184">184</a>

3685 +<a href="#__codelineno-0-185">185</a>

3686 +<a href="#__codelineno-0-186">186</a>

3687 +<a href="#__codelineno-0-187">187</a>

3688 +<a href="#__codelineno-0-188">188</a>

3689 +<a href="#__codelineno-0-189">189</a>

3690 +<a href="#__codelineno-0-190">190</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-129" name="__codelineno-0-129"></a>def create_case_note(

3691 +<a id="__codelineno-0-130" name="__codelineno-0-130"></a> self,

3692 +<a id="__codelineno-0-131" name="__codelineno-0-131"></a> cid: int,

3693 +<a id="__codelineno-0-132" name="__codelineno-0-132"></a> note_title: str,

3694 +<a id="__codelineno-0-133" name="__codelineno-0-133"></a> note_content: str,

3695 +<a id="__codelineno-0-134" name="__codelineno-0-134"></a>) -> Dict[str, object]:

3696 +<a id="__codelineno-0-135" name="__codelineno-0-135"></a> """

3697 +<a id="__codelineno-0-136" name="__codelineno-0-136"></a> Creates a note for a specific case in DFIR-IRIS. If the iris_session attribute is None, this indicates that

3698 +<a id="__codelineno-0-137" name="__codelineno-0-137"></a> the session creation was unsuccessful, and a dictionary with "success" set to False is returned. Otherwise,

3699 +<a id="__codelineno-0-138" name="__codelineno-0-138"></a> it attempts to create a note with the specified `note_title` and `note_content` for the case specified by the

3700 +<a id="__codelineno-0-139" name="__codelineno-0-139"></a> `cid` parameter.

3701 +<a id="__codelineno-0-140" name="__codelineno-0-140"></a>

3702 +<a id="__codelineno-0-141" name="__codelineno-0-141"></a> Args:

3703 +<a id="__codelineno-0-142" name="__codelineno-0-142"></a> cid (int): The ID of the case for which to create a note.

3704 +<a id="__codelineno-0-143" name="__codelineno-0-143"></a> note_title (str): The title of the note to create.

3705 +<a id="__codelineno-0-144" name="__codelineno-0-144"></a> note_content (str): The content of the note to create.

3706 +<a id="__codelineno-0-145" name="__codelineno-0-145"></a>

3707 +<a id="__codelineno-0-146" name="__codelineno-0-146"></a> Returns:

3708 +<a id="__codelineno-0-147" name="__codelineno-0-147"></a> dict: A dictionary containing the success status, a message, and potentially the created note. The

3709 +<a id="__codelineno-0-148" name="__codelineno-0-148"></a> "success" key is a boolean indicating whether the operation was successful. The "message" key is a string

3710 +<a id="__codelineno-0-149" name="__codelineno-0-149"></a> providing details about the operation. If "success" is True, the dictionary also contains the "notes" key

3711 +<a id="__codelineno-0-150" name="__codelineno-0-150"></a> with the created note.

3712 +<a id="__codelineno-0-151" name="__codelineno-0-151"></a> """

3713 +<a id="__codelineno-0-152" name="__codelineno-0-152"></a> if self.iris_session is None:

3714 +<a id="__codelineno-0-153" name="__codelineno-0-153"></a> return {

3715 +<a id="__codelineno-0-154" name="__codelineno-0-154"></a> "success": False,

3716 +<a id="__codelineno-0-155" name="__codelineno-0-155"></a> "message": "DFIR-IRIS session was not successfully created.",

3717 +<a id="__codelineno-0-156" name="__codelineno-0-156"></a> }

3718 +<a id="__codelineno-0-157" name="__codelineno-0-157"></a>

3719 +<a id="__codelineno-0-158" name="__codelineno-0-158"></a> logger.info(f"Creating case {cid} note in DFIR-IRIS")

3720 +<a id="__codelineno-0-159" name="__codelineno-0-159"></a> case = Case(session=self.iris_session)

3721 +<a id="__codelineno-0-160" name="__codelineno-0-160"></a> cid = int(cid)

3722 +<a id="__codelineno-0-161" name="__codelineno-0-161"></a> # Creating Group for New Note

3723 +<a id="__codelineno-0-162" name="__codelineno-0-162"></a> note_group = self.universal_service.fetch_and_parse_data(

3724 +<a id="__codelineno-0-163" name="__codelineno-0-163"></a> self.iris_session,

3725 +<a id="__codelineno-0-164" name="__codelineno-0-164"></a> case.add_notes_group,

3726 +<a id="__codelineno-0-165" name="__codelineno-0-165"></a> note_title,

3727 +<a id="__codelineno-0-166" name="__codelineno-0-166"></a> cid,

3728 +<a id="__codelineno-0-167" name="__codelineno-0-167"></a> )

3729 +<a id="__codelineno-0-168" name="__codelineno-0-168"></a>

3730 +<a id="__codelineno-0-169" name="__codelineno-0-169"></a> if not note_group["success"]:

3731 +<a id="__codelineno-0-170" name="__codelineno-0-170"></a> return {"success": False, "message": "Failed to create note in DFIR-IRIS"}

3732 +<a id="__codelineno-0-171" name="__codelineno-0-171"></a> note_group_id = note_group["data"]["group_id"]

3733 +<a id="__codelineno-0-172" name="__codelineno-0-172"></a> custom_attributes = {}

3734 +<a id="__codelineno-0-173" name="__codelineno-0-173"></a> result = self.universal_service.fetch_and_parse_data(

3735 +<a id="__codelineno-0-174" name="__codelineno-0-174"></a> self.iris_session,

3736 +<a id="__codelineno-0-175" name="__codelineno-0-175"></a> case.add_note,

3737 +<a id="__codelineno-0-176" name="__codelineno-0-176"></a> note_title,

3738 +<a id="__codelineno-0-177" name="__codelineno-0-177"></a> note_content,

3739 +<a id="__codelineno-0-178" name="__codelineno-0-178"></a> note_group_id,

3740 +<a id="__codelineno-0-179" name="__codelineno-0-179"></a> custom_attributes,

3741 +<a id="__codelineno-0-180" name="__codelineno-0-180"></a> cid,

3742 +<a id="__codelineno-0-181" name="__codelineno-0-181"></a> )

3743 +<a id="__codelineno-0-182" name="__codelineno-0-182"></a>

3744 +<a id="__codelineno-0-183" name="__codelineno-0-183"></a> if not result["success"]:

3745 +<a id="__codelineno-0-184" name="__codelineno-0-184"></a> return {"success": False, "message": "Failed to create note in DFIR-IRIS"}

3746 +<a id="__codelineno-0-185" name="__codelineno-0-185"></a>

3747 +<a id="__codelineno-0-186" name="__codelineno-0-186"></a> return {

3748 +<a id="__codelineno-0-187" name="__codelineno-0-187"></a> "success": True,

3749 +<a id="__codelineno-0-188" name="__codelineno-0-188"></a> "message": "Successfully created note in DFIR-IRIS",

3750 +<a id="__codelineno-0-189" name="__codelineno-0-189"></a> "notes": result["data"],

3751 +<a id="__codelineno-0-190" name="__codelineno-0-190"></a> }

3752 +</code></pre></div></td></tr></table></div>

3753 + </details>

3754 + </div>

3755 +

3756 +</div>

3757 +

3758 +<div class="doc doc-object doc-function">

3759 +

3760 +

3761 +

3762 +<h3 id="app.services.DFIR_IRIS.notes.NotesService.get_case_notes" class="doc doc-heading">

3763 +<code class="highlight language-python">get_case_notes(search_term, cid)</code>

3764 +

3765 +</h3>

3766 +

3767 +

3768 + <div class="doc doc-contents ">

3769 +

3770 + Retrieves the notes of a specific case from DFIR-IRIS. If the iris_session attribute is None, this indicates

3771 +that the session creation was unsuccessful, and a dictionary with "success" set to False is returned. Otherwise,

3772 +it attempts to fetch and parse the notes data for the case specified by the <code>cid</code> parameter.

3773 +

3774 + Parameters:

3775 + <table>

3776 + <thead>

3777 + <tr>

3778 + <th>Name</th>

3779 + <th>Type</th>

3780 + <th>Description</th>

3781 + <th>Default</th>

3782 + </tr>

3783 + </thead>

3784 + <tbody>

3785 + <tr>

3786 + <td><code>search_term</code></td>

3787 + <td>

3788 + <code>str</code>

3789 + </td>

3790 + <td>

3791 + <div class="doc-md-description">

3792 + The search term to use when fetching case notes.

3793 + </div>

3794 + </td>

3795 + <td>

3796 + required

3797 + </td>

3798 + </tr>

3799 + <tr>

3800 + <td><code>cid</code></td>

3801 + <td>

3802 + <code>int</code>

3803 + </td>

3804 + <td>

3805 + <div class="doc-md-description">

3806 + The ID of the case for which to retrieve notes.

3807 + </div>

3808 + </td>

3809 + <td>

3810 + required

3811 + </td>

3812 + </tr>

3813 + </tbody>

3814 + </table>

3815 +

3816 + Returns:

3817 + <table>

3818 + <thead>

3819 + <tr>

3820 +<th>Name</th> <th>Type</th>

3821 + <th>Description</th>

3822 + </tr>

3823 + </thead>

3824 + <tbody>

3825 + <tr>

3826 +<td><code>dict</code></td> <td>

3827 + <code>Dict[str, object]</code>

3828 + </td>

3829 + <td>

3830 + <div class="doc-md-description">

3831 + A dictionary containing the success status, a message, and potentially the fetched notes. The

3832 + </div>

3833 + </td>

3834 + </tr>

3835 + <tr>

3836 +<td></td> <td>

3837 + <code>Dict[str, object]</code>

3838 + </td>

3839 + <td>

3840 + <div class="doc-md-description">

3841 + "success" key is a boolean indicating whether the operation was successful. The "message" key is a string

3842 + </div>

3843 + </td>

3844 + </tr>

3845 + <tr>

3846 +<td></td> <td>

3847 + <code>Dict[str, object]</code>

3848 + </td>

3849 + <td>

3850 + <div class="doc-md-description">

3851 + providing details about the operation. If "success" is True, the dictionary also contains the "data" key

3852 + </div>

3853 + </td>

3854 + </tr>

3855 + <tr>

3856 +<td></td> <td>

3857 + <code>Dict[str, object]</code>

3858 + </td>

3859 + <td>

3860 + <div class="doc-md-description">

3861 + with the fetched notes.

3862 + </div>

3863 + </td>

3864 + </tr>

3865 + </tbody>

3866 + </table>

3867 +

3868 + <details class="quote">

3869 + <summary>Source code in <code>app\services\DFIR_IRIS\notes.py</code></summary>

3870 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-35">35</a>

3871 +<a href="#__codelineno-0-36">36</a>

3872 +<a href="#__codelineno-0-37">37</a>

3873 +<a href="#__codelineno-0-38">38</a>

3874 +<a href="#__codelineno-0-39">39</a>

3875 +<a href="#__codelineno-0-40">40</a>

3876 +<a href="#__codelineno-0-41">41</a>

3877 +<a href="#__codelineno-0-42">42</a>

3878 +<a href="#__codelineno-0-43">43</a>

3879 +<a href="#__codelineno-0-44">44</a>

3880 +<a href="#__codelineno-0-45">45</a>

3881 +<a href="#__codelineno-0-46">46</a>

3882 +<a href="#__codelineno-0-47">47</a>

3883 +<a href="#__codelineno-0-48">48</a>

3884 +<a href="#__codelineno-0-49">49</a>

3885 +<a href="#__codelineno-0-50">50</a>

3886 +<a href="#__codelineno-0-51">51</a>

3887 +<a href="#__codelineno-0-52">52</a>

3888 +<a href="#__codelineno-0-53">53</a>

3889 +<a href="#__codelineno-0-54">54</a>

3890 +<a href="#__codelineno-0-55">55</a>

3891 +<a href="#__codelineno-0-56">56</a>

3892 +<a href="#__codelineno-0-57">57</a>

3893 +<a href="#__codelineno-0-58">58</a>

3894 +<a href="#__codelineno-0-59">59</a>

3895 +<a href="#__codelineno-0-60">60</a>

3896 +<a href="#__codelineno-0-61">61</a>

3897 +<a href="#__codelineno-0-62">62</a>

3898 +<a href="#__codelineno-0-63">63</a>

3899 +<a href="#__codelineno-0-64">64</a>

3900 +<a href="#__codelineno-0-65">65</a>

3901 +<a href="#__codelineno-0-66">66</a>

3902 +<a href="#__codelineno-0-67">67</a>

3903 +<a href="#__codelineno-0-68">68</a>

3904 +<a href="#__codelineno-0-69">69</a>

3905 +<a href="#__codelineno-0-70">70</a>

3906 +<a href="#__codelineno-0-71">71</a>

3907 +<a href="#__codelineno-0-72">72</a>

3908 +<a href="#__codelineno-0-73">73</a>

3909 +<a href="#__codelineno-0-74">74</a>

3910 +<a href="#__codelineno-0-75">75</a>

3911 +<a href="#__codelineno-0-76">76</a>

3912 +<a href="#__codelineno-0-77">77</a>

3913 +<a href="#__codelineno-0-78">78</a>

3914 +<a href="#__codelineno-0-79">79</a>

3915 +<a href="#__codelineno-0-80">80</a>

3916 +<a href="#__codelineno-0-81">81</a>

3917 +<a href="#__codelineno-0-82">82</a>

3918 +<a href="#__codelineno-0-83">83</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-35" name="__codelineno-0-35"></a>def get_case_notes(self, search_term: str, cid: int) -> Dict[str, object]:

3919 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> """

3920 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> Retrieves the notes of a specific case from DFIR-IRIS. If the iris_session attribute is None, this indicates

3921 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> that the session creation was unsuccessful, and a dictionary with "success" set to False is returned. Otherwise,

3922 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> it attempts to fetch and parse the notes data for the case specified by the `cid` parameter.

3923 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a>

3924 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> Args:

3925 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> search_term (str): The search term to use when fetching case notes.

3926 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> cid (int): The ID of the case for which to retrieve notes.

3927 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a>

3928 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> Returns:

3929 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> dict: A dictionary containing the success status, a message, and potentially the fetched notes. The

3930 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> "success" key is a boolean indicating whether the operation was successful. The "message" key is a string

3931 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> providing details about the operation. If "success" is True, the dictionary also contains the "data" key

3932 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> with the fetched notes.

3933 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> """

3934 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> if self.iris_session is None:

3935 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> return {

3936 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> "success": False,

3937 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> "message": "DFIR-IRIS session was not successfully created.",

3938 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> }

3939 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a>

3940 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> logger.info(f"Collecting case {cid} from DFIR-IRIS")

3941 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> case = Case(session=self.iris_session)

3942 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> cid = int(cid)

3943 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> result = self.universal_service.fetch_and_parse_data(

3944 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> self.iris_session,

3945 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> case.search_notes,

3946 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> search_term,

3947 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> cid,

3948 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> )

3949 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a>

3950 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> if not result["success"]:

3951 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> return {

3952 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> "success": False,

3953 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> "message": "Failed to collect notes from DFIR-IRIS",

3954 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> }

3955 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a>

3956 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> # Loop through the notes and get the details

3957 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> for note in result["data"]:

3958 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> note_details = self._get_case_note_details(note["note_id"], cid)

3959 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> if not note_details["success"]:

3960 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> return {

3961 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> "success": False,

3962 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> "message": "Failed to collect notes from DFIR-IRIS",

3963 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> }

3964 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> note["note_details"] = note_details["notes"]

3965 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a>

3966 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> return result

3967 +</code></pre></div></td></tr></table></div>

3968 + </details>

3969 + </div>

3970 +

3971 +</div>

3972 +

3973 +

3974 +

3975 + </div>

3976 +

3977 + </div>

3978 +

3979 +</div>

3980 +

3981 +

3982 +

3983 +

3984 + </div>

3985 +

3986 + </div>

3987 +

3988 +</div>

3989 +<h3 id="universal-services">Universal Services</h3>

3990 +

3991 +

3992 +<div class="doc doc-object doc-module">

3993 +

3994 +

3995 +<a id="app.services.DFIR_IRIS.universal"></a>

3996 + <div class="doc doc-contents first">

3997 +

3998 +

3999 +

4000 + <div class="doc doc-children">

4001 +

4002 +

4003 +

4004 +

4005 +

4006 +

4007 +

4008 +

4009 +<div class="doc doc-object doc-class">

4010 +

4011 +

4012 +

4013 +<h2 id="app.services.DFIR_IRIS.universal.UniversalService" class="doc doc-heading">

4014 + <code>UniversalService</code>

4015 +

4016 +

4017 +</h2>

4018 +

4019 +

4020 + <div class="doc doc-contents ">

4021 +

4022 +

4023 + A service class that encapsulates the logic for interfacing with DFIR-IRIS. This class handles tasks like creating a session,

4024 +fetching and parsing data, and retrieving connector details.

4025 +

4026 +

4027 + <details class="quote">

4028 + <summary>Source code in <code>app\services\DFIR_IRIS\universal.py</code></summary>

4029 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-20"> 20</a>

4030 +<a href="#__codelineno-0-21"> 21</a>

4031 +<a href="#__codelineno-0-22"> 22</a>

4032 +<a href="#__codelineno-0-23"> 23</a>

4033 +<a href="#__codelineno-0-24"> 24</a>

4034 +<a href="#__codelineno-0-25"> 25</a>

4035 +<a href="#__codelineno-0-26"> 26</a>

4036 +<a href="#__codelineno-0-27"> 27</a>

4037 +<a href="#__codelineno-0-28"> 28</a>

4038 +<a href="#__codelineno-0-29"> 29</a>

4039 +<a href="#__codelineno-0-30"> 30</a>

4040 +<a href="#__codelineno-0-31"> 31</a>

4041 +<a href="#__codelineno-0-32"> 32</a>

4042 +<a href="#__codelineno-0-33"> 33</a>

4043 +<a href="#__codelineno-0-34"> 34</a>

4044 +<a href="#__codelineno-0-35"> 35</a>

4045 +<a href="#__codelineno-0-36"> 36</a>

4046 +<a href="#__codelineno-0-37"> 37</a>

4047 +<a href="#__codelineno-0-38"> 38</a>

4048 +<a href="#__codelineno-0-39"> 39</a>

4049 +<a href="#__codelineno-0-40"> 40</a>

4050 +<a href="#__codelineno-0-41"> 41</a>

4051 +<a href="#__codelineno-0-42"> 42</a>

4052 +<a href="#__codelineno-0-43"> 43</a>

4053 +<a href="#__codelineno-0-44"> 44</a>

4054 +<a href="#__codelineno-0-45"> 45</a>

4055 +<a href="#__codelineno-0-46"> 46</a>

4056 +<a href="#__codelineno-0-47"> 47</a>

4057 +<a href="#__codelineno-0-48"> 48</a>

4058 +<a href="#__codelineno-0-49"> 49</a>

4059 +<a href="#__codelineno-0-50"> 50</a>

4060 +<a href="#__codelineno-0-51"> 51</a>

4061 +<a href="#__codelineno-0-52"> 52</a>

4062 +<a href="#__codelineno-0-53"> 53</a>

4063 +<a href="#__codelineno-0-54"> 54</a>

4064 +<a href="#__codelineno-0-55"> 55</a>

4065 +<a href="#__codelineno-0-56"> 56</a>

4066 +<a href="#__codelineno-0-57"> 57</a>

4067 +<a href="#__codelineno-0-58"> 58</a>

4068 +<a href="#__codelineno-0-59"> 59</a>

4069 +<a href="#__codelineno-0-60"> 60</a>

4070 +<a href="#__codelineno-0-61"> 61</a>

4071 +<a href="#__codelineno-0-62"> 62</a>

4072 +<a href="#__codelineno-0-63"> 63</a>

4073 +<a href="#__codelineno-0-64"> 64</a>

4074 +<a href="#__codelineno-0-65"> 65</a>

4075 +<a href="#__codelineno-0-66"> 66</a>

4076 +<a href="#__codelineno-0-67"> 67</a>

4077 +<a href="#__codelineno-0-68"> 68</a>

4078 +<a href="#__codelineno-0-69"> 69</a>

4079 +<a href="#__codelineno-0-70"> 70</a>

4080 +<a href="#__codelineno-0-71"> 71</a>

4081 +<a href="#__codelineno-0-72"> 72</a>

4082 +<a href="#__codelineno-0-73"> 73</a>

4083 +<a href="#__codelineno-0-74"> 74</a>

4084 +<a href="#__codelineno-0-75"> 75</a>

4085 +<a href="#__codelineno-0-76"> 76</a>

4086 +<a href="#__codelineno-0-77"> 77</a>

4087 +<a href="#__codelineno-0-78"> 78</a>

4088 +<a href="#__codelineno-0-79"> 79</a>

4089 +<a href="#__codelineno-0-80"> 80</a>

4090 +<a href="#__codelineno-0-81"> 81</a>

4091 +<a href="#__codelineno-0-82"> 82</a>

4092 +<a href="#__codelineno-0-83"> 83</a>

4093 +<a href="#__codelineno-0-84"> 84</a>

4094 +<a href="#__codelineno-0-85"> 85</a>

4095 +<a href="#__codelineno-0-86"> 86</a>

4096 +<a href="#__codelineno-0-87"> 87</a>

4097 +<a href="#__codelineno-0-88"> 88</a>

4098 +<a href="#__codelineno-0-89"> 89</a>

4099 +<a href="#__codelineno-0-90"> 90</a>

4100 +<a href="#__codelineno-0-91"> 91</a>

4101 +<a href="#__codelineno-0-92"> 92</a>

4102 +<a href="#__codelineno-0-93"> 93</a>

4103 +<a href="#__codelineno-0-94"> 94</a>

4104 +<a href="#__codelineno-0-95"> 95</a>

4105 +<a href="#__codelineno-0-96"> 96</a>

4106 +<a href="#__codelineno-0-97"> 97</a>

4107 +<a href="#__codelineno-0-98"> 98</a>

4108 +<a href="#__codelineno-0-99"> 99</a>

4109 +<a href="#__codelineno-0-100">100</a>

4110 +<a href="#__codelineno-0-101">101</a>

4111 +<a href="#__codelineno-0-102">102</a>

4112 +<a href="#__codelineno-0-103">103</a>

4113 +<a href="#__codelineno-0-104">104</a>

4114 +<a href="#__codelineno-0-105">105</a>

4115 +<a href="#__codelineno-0-106">106</a>

4116 +<a href="#__codelineno-0-107">107</a>

4117 +<a href="#__codelineno-0-108">108</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-20" name="__codelineno-0-20"></a>class UniversalService:

4118 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> """

4119 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> A service class that encapsulates the logic for interfacing with DFIR-IRIS. This class handles tasks like creating a session,

4120 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> fetching and parsing data, and retrieving connector details.

4121 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> """

4122 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a>

4123 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> def __init__(self, connector_name: str) -> None:

4124 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> """

4125 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> Initializes the UniversalService by collecting DFIR-IRIS details associated with the specified connector name.

4126 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a>

4127 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> Args:

4128 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> connector_name (str): The name of the DFIR-IRIS connector.

4129 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> """

4130 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> self.connector_url, self.connector_api_key = self.collect_iris_details(

4131 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> connector_name,

4132 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> )

4133 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a>

4134 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> def collect_iris_details(self, connector_name: str) -> Tuple[Optional[str], Optional[str]]:

4135 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> """

4136 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> Collects the details of the DFIR-IRIS connector.

4137 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a>

4138 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> Args:

4139 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> connector_name (str): The name of the DFIR-IRIS connector.

4140 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a>

4141 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> Returns:

4142 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> tuple: A tuple containing the connection URL and API key. If the connection is not successful, both elements of the tuple are None.

4143 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> """

4144 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> connector_instance = connector_factory.create(connector_name, connector_name)

4145 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> connection_successful = connector_instance.verify_connection()

4146 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> if connection_successful:

4147 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> connection_details = Connector.get_connector_info_from_db(connector_name)

4148 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> return (

4149 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> connection_details.get("connector_url"),

4150 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> connection_details.get("connector_api_key"),

4151 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> )

4152 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> else:

4153 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> return None, None

4154 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a>

4155 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> def create_session(self) -> Dict[str, Union[bool, Optional[ClientSession], str]]:

4156 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> """

4157 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> Creates a session with DFIR-IRIS.

4158 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a>

4159 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> This method creates a session with DFIR-IRIS and returns a dictionary with a success status and the session object.

4160 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> If a session cannot be established, an error is logged and a dictionary with "success" set to False and an error message is returned.

4161 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a>

4162 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Returns:

4163 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> dict: A dictionary containing the success status and either the session object or an error message.

4164 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> """

4165 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> try:

4166 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> logger.info("Creating session with DFIR-IRIS.")

4167 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> session = ClientSession(

4168 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> host=self.connector_url,

4169 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> apikey=self.connector_api_key,

4170 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> agent="iris-client",

4171 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> ssl_verify=False,

4172 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> timeout=120,

4173 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> proxy=None,

4174 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> )

4175 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> logger.info("Session created.")

4176 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> return {"success": True, "session": session}

4177 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> except Exception as e:

4178 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> logger.error(f"Error creating session with DFIR-IRIS: {e}")

4179 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> return {

4180 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> "success": False,

4181 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> "message": "Connection to DFIR-IRIS unsuccessful.",

4182 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> }

4183 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a>

4184 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> def fetch_and_parse_data(self, session: ClientSession, action: Callable, *args) -> Dict[str, Union[bool, Optional[Dict]]]:

4185 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> """

4186 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> Fetches and parses data from DFIR-IRIS using a specified action.

4187 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a>

4188 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> Args:

4189 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> session (ClientSession): The DFIR-IRIS session object.

4190 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a> action (Callable): The function to execute to fetch data from DFIR-IRIS. This function should accept *args.

4191 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> args: The arguments to pass to the action function.

4192 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a>

4193 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> Returns:

4194 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> dict: A dictionary containing the success status and either the fetched data or None if the operation was unsuccessful.

4195 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> """

4196 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a> try:

4197 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> logger.info(f"Executing {action.__name__}... on args: {args}")

4198 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> status = action(*args)

4199 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> assert_api_resp(status, soft_fail=False)

4200 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> data = get_data_from_resp(status)

4201 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a> logger.info(f"Successfully executed {action.__name__}")

4202 +<a id="__codelineno-0-105" name="__codelineno-0-105"></a> return {"success": True, "data": data}

4203 +<a id="__codelineno-0-106" name="__codelineno-0-106"></a> except Exception as err:

4204 +<a id="__codelineno-0-107" name="__codelineno-0-107"></a> logger.error(f"Failed to execute {action.__name__}: {err}")

4205 +<a id="__codelineno-0-108" name="__codelineno-0-108"></a> return {"success": False}

4206 +</code></pre></div></td></tr></table></div>

4207 + </details>

4208 +

4209 +

4210 +

4211 + <div class="doc doc-children">

4212 +

4213 +

4214 +

4215 +

4216 +

4217 +

4218 +

4219 +

4220 +

4221 +<div class="doc doc-object doc-function">

4222 +

4223 +

4224 +

4225 +<h3 id="app.services.DFIR_IRIS.universal.UniversalService.__init__" class="doc doc-heading">

4226 +<code class="highlight language-python">__init__(connector_name)</code>

4227 +

4228 +</h3>

4229 +

4230 +

4231 + <div class="doc doc-contents ">

4232 +

4233 + Initializes the UniversalService by collecting DFIR-IRIS details associated with the specified connector name.

4234 +

4235 + Parameters:

4236 + <table>

4237 + <thead>

4238 + <tr>

4239 + <th>Name</th>

4240 + <th>Type</th>

4241 + <th>Description</th>

4242 + <th>Default</th>

4243 + </tr>

4244 + </thead>

4245 + <tbody>

4246 + <tr>

4247 + <td><code>connector_name</code></td>

4248 + <td>

4249 + <code>str</code>

4250 + </td>

4251 + <td>

4252 + <div class="doc-md-description">

4253 + The name of the DFIR-IRIS connector.

4254 + </div>

4255 + </td>

4256 + <td>

4257 + required

4258 + </td>

4259 + </tr>

4260 + </tbody>

4261 + </table>

4262 +

4263 + <details class="quote">

4264 + <summary>Source code in <code>app\services\DFIR_IRIS\universal.py</code></summary>

4265 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-26">26</a>

4266 +<a href="#__codelineno-0-27">27</a>

4267 +<a href="#__codelineno-0-28">28</a>

4268 +<a href="#__codelineno-0-29">29</a>

4269 +<a href="#__codelineno-0-30">30</a>

4270 +<a href="#__codelineno-0-31">31</a>

4271 +<a href="#__codelineno-0-32">32</a>

4272 +<a href="#__codelineno-0-33">33</a>

4273 +<a href="#__codelineno-0-34">34</a>

4274 +<a href="#__codelineno-0-35">35</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-26" name="__codelineno-0-26"></a>def __init__(self, connector_name: str) -> None:

4275 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> """

4276 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> Initializes the UniversalService by collecting DFIR-IRIS details associated with the specified connector name.

4277 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a>

4278 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> Args:

4279 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> connector_name (str): The name of the DFIR-IRIS connector.

4280 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> """

4281 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> self.connector_url, self.connector_api_key = self.collect_iris_details(

4282 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> connector_name,

4283 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> )

4284 +</code></pre></div></td></tr></table></div>

4285 + </details>

4286 + </div>

4287 +

4288 +</div>

4289 +

4290 +<div class="doc doc-object doc-function">

4291 +

4292 +

4293 +

4294 +<h3 id="app.services.DFIR_IRIS.universal.UniversalService.collect_iris_details" class="doc doc-heading">

4295 +<code class="highlight language-python">collect_iris_details(connector_name)</code>

4296 +

4297 +</h3>

4298 +

4299 +

4300 + <div class="doc doc-contents ">

4301 +

4302 + Collects the details of the DFIR-IRIS connector.

4303 +

4304 + Parameters:

4305 + <table>

4306 + <thead>

4307 + <tr>

4308 + <th>Name</th>

4309 + <th>Type</th>

4310 + <th>Description</th>

4311 + <th>Default</th>

4312 + </tr>

4313 + </thead>

4314 + <tbody>

4315 + <tr>

4316 + <td><code>connector_name</code></td>

4317 + <td>

4318 + <code>str</code>

4319 + </td>

4320 + <td>

4321 + <div class="doc-md-description">

4322 + The name of the DFIR-IRIS connector.

4323 + </div>

4324 + </td>

4325 + <td>

4326 + required

4327 + </td>

4328 + </tr>

4329 + </tbody>

4330 + </table>

4331 +

4332 + Returns:

4333 + <table>

4334 + <thead>

4335 + <tr>

4336 +<th>Name</th> <th>Type</th>

4337 + <th>Description</th>

4338 + </tr>

4339 + </thead>

4340 + <tbody>

4341 + <tr>

4342 +<td><code>tuple</code></td> <td>

4343 + <code>Tuple[Optional[str], Optional[str]]</code>

4344 + </td>

4345 + <td>

4346 + <div class="doc-md-description">

4347 + A tuple containing the connection URL and API key. If the connection is not successful, both elements of the tuple are None.

4348 + </div>

4349 + </td>

4350 + </tr>

4351 + </tbody>

4352 + </table>

4353 +

4354 + <details class="quote">

4355 + <summary>Source code in <code>app\services\DFIR_IRIS\universal.py</code></summary>

4356 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-37">37</a>

4357 +<a href="#__codelineno-0-38">38</a>

4358 +<a href="#__codelineno-0-39">39</a>

4359 +<a href="#__codelineno-0-40">40</a>

4360 +<a href="#__codelineno-0-41">41</a>

4361 +<a href="#__codelineno-0-42">42</a>

4362 +<a href="#__codelineno-0-43">43</a>

4363 +<a href="#__codelineno-0-44">44</a>

4364 +<a href="#__codelineno-0-45">45</a>

4365 +<a href="#__codelineno-0-46">46</a>

4366 +<a href="#__codelineno-0-47">47</a>

4367 +<a href="#__codelineno-0-48">48</a>

4368 +<a href="#__codelineno-0-49">49</a>

4369 +<a href="#__codelineno-0-50">50</a>

4370 +<a href="#__codelineno-0-51">51</a>

4371 +<a href="#__codelineno-0-52">52</a>

4372 +<a href="#__codelineno-0-53">53</a>

4373 +<a href="#__codelineno-0-54">54</a>

4374 +<a href="#__codelineno-0-55">55</a>

4375 +<a href="#__codelineno-0-56">56</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-37" name="__codelineno-0-37"></a>def collect_iris_details(self, connector_name: str) -> Tuple[Optional[str], Optional[str]]:

4376 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> """

4377 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> Collects the details of the DFIR-IRIS connector.

4378 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a>

4379 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> Args:

4380 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> connector_name (str): The name of the DFIR-IRIS connector.

4381 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a>

4382 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> Returns:

4383 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> tuple: A tuple containing the connection URL and API key. If the connection is not successful, both elements of the tuple are None.

4384 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> """

4385 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> connector_instance = connector_factory.create(connector_name, connector_name)

4386 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> connection_successful = connector_instance.verify_connection()

4387 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> if connection_successful:

4388 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> connection_details = Connector.get_connector_info_from_db(connector_name)

4389 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> return (

4390 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> connection_details.get("connector_url"),

4391 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> connection_details.get("connector_api_key"),

4392 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> )

4393 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> else:

4394 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> return None, None

4395 +</code></pre></div></td></tr></table></div>

4396 + </details>

4397 + </div>

4398 +

4399 +</div>

4400 +

4401 +<div class="doc doc-object doc-function">

4402 +

4403 +

4404 +

4405 +<h3 id="app.services.DFIR_IRIS.universal.UniversalService.create_session" class="doc doc-heading">

4406 +<code class="highlight language-python">create_session()</code>

4407 +

4408 +</h3>

4409 +

4410 +

4411 + <div class="doc doc-contents ">

4412 +

4413 + Creates a session with DFIR-IRIS.

4414 +This method creates a session with DFIR-IRIS and returns a dictionary with a success status and the session object.

4415 +If a session cannot be established, an error is logged and a dictionary with "success" set to False and an error message is returned.

4416 +

4417 + Returns:

4418 + <table>

4419 + <thead>

4420 + <tr>

4421 +<th>Name</th> <th>Type</th>

4422 + <th>Description</th>

4423 + </tr>

4424 + </thead>

4425 + <tbody>

4426 + <tr>

4427 +<td><code>dict</code></td> <td>

4428 + <code>Dict[str, Union[bool, Optional[ClientSession], str]]</code>

4429 + </td>

4430 + <td>

4431 + <div class="doc-md-description">

4432 + A dictionary containing the success status and either the session object or an error message.

4433 + </div>

4434 + </td>

4435 + </tr>

4436 + </tbody>

4437 + </table>

4438 +

4439 + <details class="quote">

4440 + <summary>Source code in <code>app\services\DFIR_IRIS\universal.py</code></summary>

4441 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-58">58</a>

4442 +<a href="#__codelineno-0-59">59</a>

4443 +<a href="#__codelineno-0-60">60</a>

4444 +<a href="#__codelineno-0-61">61</a>

4445 +<a href="#__codelineno-0-62">62</a>

4446 +<a href="#__codelineno-0-63">63</a>

4447 +<a href="#__codelineno-0-64">64</a>

4448 +<a href="#__codelineno-0-65">65</a>

4449 +<a href="#__codelineno-0-66">66</a>

4450 +<a href="#__codelineno-0-67">67</a>

4451 +<a href="#__codelineno-0-68">68</a>

4452 +<a href="#__codelineno-0-69">69</a>

4453 +<a href="#__codelineno-0-70">70</a>

4454 +<a href="#__codelineno-0-71">71</a>

4455 +<a href="#__codelineno-0-72">72</a>

4456 +<a href="#__codelineno-0-73">73</a>

4457 +<a href="#__codelineno-0-74">74</a>

4458 +<a href="#__codelineno-0-75">75</a>

4459 +<a href="#__codelineno-0-76">76</a>

4460 +<a href="#__codelineno-0-77">77</a>

4461 +<a href="#__codelineno-0-78">78</a>

4462 +<a href="#__codelineno-0-79">79</a>

4463 +<a href="#__codelineno-0-80">80</a>

4464 +<a href="#__codelineno-0-81">81</a>

4465 +<a href="#__codelineno-0-82">82</a>

4466 +<a href="#__codelineno-0-83">83</a>

4467 +<a href="#__codelineno-0-84">84</a>

4468 +<a href="#__codelineno-0-85">85</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-58" name="__codelineno-0-58"></a>def create_session(self) -> Dict[str, Union[bool, Optional[ClientSession], str]]:

4469 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> """

4470 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> Creates a session with DFIR-IRIS.

4471 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a>

4472 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> This method creates a session with DFIR-IRIS and returns a dictionary with a success status and the session object.

4473 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> If a session cannot be established, an error is logged and a dictionary with "success" set to False and an error message is returned.

4474 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a>

4475 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Returns:

4476 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> dict: A dictionary containing the success status and either the session object or an error message.

4477 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> """

4478 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> try:

4479 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> logger.info("Creating session with DFIR-IRIS.")

4480 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> session = ClientSession(

4481 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> host=self.connector_url,

4482 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> apikey=self.connector_api_key,

4483 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> agent="iris-client",

4484 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> ssl_verify=False,

4485 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> timeout=120,

4486 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> proxy=None,

4487 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> )

4488 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> logger.info("Session created.")

4489 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> return {"success": True, "session": session}

4490 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> except Exception as e:

4491 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> logger.error(f"Error creating session with DFIR-IRIS: {e}")

4492 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> return {

4493 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> "success": False,

4494 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> "message": "Connection to DFIR-IRIS unsuccessful.",

4495 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> }

4496 +</code></pre></div></td></tr></table></div>

4497 + </details>

4498 + </div>

4499 +

4500 +</div>

4501 +

4502 +<div class="doc doc-object doc-function">

4503 +

4504 +

4505 +

4506 +<h3 id="app.services.DFIR_IRIS.universal.UniversalService.fetch_and_parse_data" class="doc doc-heading">

4507 +<code class="highlight language-python">fetch_and_parse_data(session, action, *args)</code>

4508 +

4509 +</h3>

4510 +

4511 +

4512 + <div class="doc doc-contents ">

4513 +

4514 + Fetches and parses data from DFIR-IRIS using a specified action.

4515 +

4516 + Parameters:

4517 + <table>

4518 + <thead>

4519 + <tr>

4520 + <th>Name</th>

4521 + <th>Type</th>

4522 + <th>Description</th>

4523 + <th>Default</th>

4524 + </tr>

4525 + </thead>

4526 + <tbody>

4527 + <tr>

4528 + <td><code>session</code></td>

4529 + <td>

4530 + <code>ClientSession</code>

4531 + </td>

4532 + <td>

4533 + <div class="doc-md-description">

4534 + The DFIR-IRIS session object.

4535 + </div>

4536 + </td>

4537 + <td>

4538 + required

4539 + </td>

4540 + </tr>

4541 + <tr>

4542 + <td><code>action</code></td>

4543 + <td>

4544 + <code>Callable</code>

4545 + </td>

4546 + <td>

4547 + <div class="doc-md-description">

4548 + The function to execute to fetch data from DFIR-IRIS. This function should accept *args.

4549 + </div>

4550 + </td>

4551 + <td>

4552 + required

4553 + </td>

4554 + </tr>

4555 + <tr>

4556 + <td><code>args</code></td>

4557 + <td>

4558 + </td>

4559 + <td>

4560 + <div class="doc-md-description">

4561 + The arguments to pass to the action function.

4562 + </div>

4563 + </td>

4564 + <td>

4565 + <code>()</code>

4566 + </td>

4567 + </tr>

4568 + </tbody>

4569 + </table>

4570 +

4571 + Returns:

4572 + <table>

4573 + <thead>

4574 + <tr>

4575 +<th>Name</th> <th>Type</th>

4576 + <th>Description</th>

4577 + </tr>

4578 + </thead>

4579 + <tbody>

4580 + <tr>

4581 +<td><code>dict</code></td> <td>

4582 + <code>Dict[str, Union[bool, Optional[Dict]]]</code>

4583 + </td>

4584 + <td>

4585 + <div class="doc-md-description">

4586 + A dictionary containing the success status and either the fetched data or None if the operation was unsuccessful.

4587 + </div>

4588 + </td>

4589 + </tr>

4590 + </tbody>

4591 + </table>

4592 +

4593 + <details class="quote">

4594 + <summary>Source code in <code>app\services\DFIR_IRIS\universal.py</code></summary>

4595 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-87"> 87</a>

4596 +<a href="#__codelineno-0-88"> 88</a>

4597 +<a href="#__codelineno-0-89"> 89</a>

4598 +<a href="#__codelineno-0-90"> 90</a>

4599 +<a href="#__codelineno-0-91"> 91</a>

4600 +<a href="#__codelineno-0-92"> 92</a>

4601 +<a href="#__codelineno-0-93"> 93</a>

4602 +<a href="#__codelineno-0-94"> 94</a>

4603 +<a href="#__codelineno-0-95"> 95</a>

4604 +<a href="#__codelineno-0-96"> 96</a>

4605 +<a href="#__codelineno-0-97"> 97</a>

4606 +<a href="#__codelineno-0-98"> 98</a>

4607 +<a href="#__codelineno-0-99"> 99</a>

4608 +<a href="#__codelineno-0-100">100</a>

4609 +<a href="#__codelineno-0-101">101</a>

4610 +<a href="#__codelineno-0-102">102</a>

4611 +<a href="#__codelineno-0-103">103</a>

4612 +<a href="#__codelineno-0-104">104</a>

4613 +<a href="#__codelineno-0-105">105</a>

4614 +<a href="#__codelineno-0-106">106</a>

4615 +<a href="#__codelineno-0-107">107</a>

4616 +<a href="#__codelineno-0-108">108</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-87" name="__codelineno-0-87"></a>def fetch_and_parse_data(self, session: ClientSession, action: Callable, *args) -> Dict[str, Union[bool, Optional[Dict]]]:

4617 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> """

4618 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> Fetches and parses data from DFIR-IRIS using a specified action.

4619 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a>

4620 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> Args:

4621 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> session (ClientSession): The DFIR-IRIS session object.

4622 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a> action (Callable): The function to execute to fetch data from DFIR-IRIS. This function should accept *args.

4623 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> args: The arguments to pass to the action function.

4624 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a>

4625 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> Returns:

4626 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> dict: A dictionary containing the success status and either the fetched data or None if the operation was unsuccessful.

4627 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> """

4628 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a> try:

4629 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> logger.info(f"Executing {action.__name__}... on args: {args}")

4630 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> status = action(*args)

4631 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> assert_api_resp(status, soft_fail=False)

4632 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> data = get_data_from_resp(status)

4633 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a> logger.info(f"Successfully executed {action.__name__}")

4634 +<a id="__codelineno-0-105" name="__codelineno-0-105"></a> return {"success": True, "data": data}

4635 +<a id="__codelineno-0-106" name="__codelineno-0-106"></a> except Exception as err:

4636 +<a id="__codelineno-0-107" name="__codelineno-0-107"></a> logger.error(f"Failed to execute {action.__name__}: {err}")

4637 +<a id="__codelineno-0-108" name="__codelineno-0-108"></a> return {"success": False}

4638 +</code></pre></div></td></tr></table></div>

4639 + </details>

4640 + </div>

4641 +

4642 +</div>

4643 +

4644 +

4645 +

4646 + </div>

4647 +

4648 + </div>

4649 +

4650 +</div>

4651 +

4652 +

4653 +

4654 +

4655 + </div>

4656 +

4657 + </div>

4658 +

4659 +</div>

4660 +

4661 +

4662 +

4663 +

4664 +

4665 +

4666 + </article>

4667 + </div>

4668 +

4669 +

4670 + <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>

4671 +

4672 + </div>

4673 +

4674 + <button type="button" class="md-top md-icon" data-md-component="top" hidden>

4675 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg>

4676 + Back to top

4677 + </button>

4678 +

4679 + </main>

4680 +

4681 + <footer class="md-footer">

4682 +

4683 + <div class="md-footer-meta md-typeset">

4684 + <div class="md-footer-meta__inner md-grid">

4685 + <div class="md-copyright">

4686 +

4687 + <div class="md-copyright__highlight">

4689 +

4690 + </div>

4691 +

4692 +

4693 + Made with

4694 + <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">

4695 + Material for MkDocs

4696 + </a>

4697 +

4698 +</div>

4699 +

4700 + </div>

4701 + </div>

4702 +</footer>

4703 +

4704 + </div>

4705 + <div class="md-dialog" data-md-component="dialog">

4706 + <div class="md-dialog__inner md-typeset"></div>

4707 + </div>

4708 +

4709 + <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.sections", "toc.integrate", "navigation.top", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy"], "search": "../assets/javascripts/workers/search.74e28a9f.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>

4710 +

4711 +

4712 + <script src="../assets/javascripts/bundle.220ee61c.min.js"></script>

4713 +

4714 +

4715 + </body>

4716 +</html>

\ No newline at end of file

backend/site/graylog/index.html

+58 -31

@@ -9,7 +9,7 @@

12 - <link rel="prev" href="../cases/">

12 + <link rel="prev" href="../dfiriris/">

15 <link rel="next" href="../wazuhmanager/">

@@ -198,8 +198,8 @@

198

199

200 <li class="md-tabs__item">

201 - <a href="../alerts/" class="md-tabs__link">

202 - Alerts

201 + <a href="../wazuhindexer/" class="md-tabs__link">

202 + Wazuh-Indexer

203 </a>

204 </li>

205

@@ -210,8 +210,8 @@

210

211

212 <li class="md-tabs__item">

213 - <a href="../artifacts/" class="md-tabs__link">

214 - Artifacts

213 + <a href="../dfiriris/" class="md-tabs__link">

214 + Dfir-Iris

215 </a>

216 </li>

217

@@ -219,11 +219,13 @@

219

220

221

222 +

223 +

224

225

226 <li class="md-tabs__item">

225 - <a href="../cases/" class="md-tabs__link">

226 - Cases

227 + <a href="./" class="md-tabs__link md-tabs__link--active">

228 + Graylog

229 </a>

230 </li>

231

@@ -231,13 +233,23 @@

233

234

235

234 -

236 +

237 +

238 + <li class="md-tabs__item">

239 + <a href="../wazuhmanager/" class="md-tabs__link">

240 + Wazuh-Manager

241 + </a>

242 + </li>

243 +

244 +

245 +

246 +

247

248

249

250 <li class="md-tabs__item">

239 - <a href="./" class="md-tabs__link md-tabs__link--active">

240 - Graylog

251 + <a href="../velociraptor/" class="md-tabs__link">

252 + Velociraptor

253 </a>

254 </li>

255

@@ -248,8 +260,8 @@

260

261

262 <li class="md-tabs__item">

251 - <a href="../wazuhmanager/" class="md-tabs__link">

252 - Wazuh-Manager

263 + <a href="../shuffle/" class="md-tabs__link">

264 + Shuffle

265 </a>

266 </li>

267

@@ -341,8 +353,8 @@

353

354

355 <li class="md-nav__item">

344 - <a href="../alerts/" class="md-nav__link">

345 - Alerts

356 + <a href="../wazuhindexer/" class="md-nav__link">

357 + Wazuh-Indexer

358 </a>

359 </li>

360

@@ -356,23 +368,8 @@

368

369

370 <li class="md-nav__item">

359 - <a href="../artifacts/" class="md-nav__link">

360 - Artifacts

361 - </a>

362 - </li>

363 -

364 -

365 -

366 -

367 -

368 -

369 -

370 -

371 -

372 -

373 - <li class="md-nav__item">

374 - <a href="../cases/" class="md-nav__link">

375 - Cases

371 + <a href="../dfiriris/" class="md-nav__link">

372 + Dfir-Iris

373 </a>

374 </li>

375

@@ -751,6 +748,36 @@

748

749

750

751 +

752 +

753 +

754 +

755 +

756 +

757 +

758 + <li class="md-nav__item">

759 + <a href="../velociraptor/" class="md-nav__link">

760 + Velociraptor

761 + </a>

762 + </li>

763 +

764 +

765 +

766 +

767 +

768 +

769 +

770 +

771 +

772 +

773 + <li class="md-nav__item">

774 + <a href="../shuffle/" class="md-nav__link">

775 + Shuffle

776 + </a>

777 + </li>

778 +

779 +

780 +

781 </ul>

782 </nav>

783 </div>

backend/site/index.html

+47 -20

@@ -198,8 +198,8 @@

198

199

200 <li class="md-tabs__item">

201 - <a href="alerts/" class="md-tabs__link">

202 - Alerts

201 + <a href="wazuhindexer/" class="md-tabs__link">

202 + Wazuh-Indexer

203 </a>

204 </li>

205

@@ -210,8 +210,8 @@

210

211

212 <li class="md-tabs__item">

213 - <a href="artifacts/" class="md-tabs__link">

214 - Artifacts

213 + <a href="dfiriris/" class="md-tabs__link">

214 + Dfir-Iris

215 </a>

216 </li>

217

@@ -222,8 +222,8 @@

222

223

224 <li class="md-tabs__item">

225 - <a href="cases/" class="md-tabs__link">

226 - Cases

225 + <a href="graylog/" class="md-tabs__link">

226 + Graylog

227 </a>

228 </li>

229

@@ -234,8 +234,8 @@

234

235

236 <li class="md-tabs__item">

237 - <a href="graylog/" class="md-tabs__link">

238 - Graylog

237 + <a href="wazuhmanager/" class="md-tabs__link">

238 + Wazuh-Manager

239 </a>

240 </li>

241

@@ -246,8 +246,20 @@

246

247

248 <li class="md-tabs__item">

249 - <a href="wazuhmanager/" class="md-tabs__link">

250 - Wazuh-Manager

249 + <a href="velociraptor/" class="md-tabs__link">

250 + Velociraptor

251 + </a>

252 + </li>

253 +

254 +

255 +

256 +

257 +

258 +

259 +

260 + <li class="md-tabs__item">

261 + <a href="shuffle/" class="md-tabs__link">

262 + Shuffle

263 </a>

264 </li>

265

@@ -451,8 +463,8 @@

463

464

465 <li class="md-nav__item">

454 - <a href="alerts/" class="md-nav__link">

455 - Alerts

466 + <a href="wazuhindexer/" class="md-nav__link">

467 + Wazuh-Indexer

468 </a>

469 </li>

470

@@ -466,8 +478,8 @@

478

479

480 <li class="md-nav__item">

469 - <a href="artifacts/" class="md-nav__link">

470 - Artifacts

481 + <a href="dfiriris/" class="md-nav__link">

482 + Dfir-Iris

483 </a>

484 </li>

485

@@ -481,8 +493,8 @@

493

494

495 <li class="md-nav__item">

484 - <a href="cases/" class="md-nav__link">

485 - Cases

496 + <a href="graylog/" class="md-nav__link">

497 + Graylog

498 </a>

499 </li>

500

@@ -496,8 +508,8 @@

508

509

510 <li class="md-nav__item">

499 - <a href="graylog/" class="md-nav__link">

500 - Graylog

511 + <a href="wazuhmanager/" class="md-nav__link">

512 + Wazuh-Manager

513 </a>

514 </li>

515

@@ -511,8 +523,23 @@

523

524

525 <li class="md-nav__item">

514 - <a href="wazuhmanager/" class="md-nav__link">

515 - Wazuh-Manager

526 + <a href="velociraptor/" class="md-nav__link">

527 + Velociraptor

528 + </a>

529 + </li>

530 +

531 +

532 +

533 +

534 +

535 +

536 +

537 +

538 +

539 +

540 + <li class="md-nav__item">

541 + <a href="shuffle/" class="md-nav__link">

542 + Shuffle

543 </a>

544 </li>

545

backend/site/mkdocs.yml deleted

-61

@@ -1,61 +0,0 @@

1 -site_name: SOCFortress CoPilot

2 -theme:

3 - name: material

4 - features:

5 - - navigation.tabs

6 - - navigation.sections

7 - - toc.integrate

8 - - navigation.top

9 - - search.suggest

10 - - search.highlight

11 - - content.tabs.link

12 - - content.code.annotation

13 - - content.code.copy

14 -

15 - language: en

16 - palette:

17 - - scheme: default

18 - toggle:

19 - icon: material/toggle-switch-off-outline

20 - name: Switch to dark mode

21 - primary: teal

22 - accent: purple

23 - - scheme: slate

24 - toggle:

25 - icon: material/toggle-switch

26 - name: Switch to light mode

27 - primary: teal

28 - accent: lime

29 -

30 -plugins:

31 - - mkdocstrings:

32 - - autorefs

33 -

34 -nav:

35 - - Home: index.md

36 - - Connectors: connectors.md

37 - - Agents: agents.md

38 - - Alerts: alerts.md

39 - - Artifacts: artifacts.md

40 - - Cases: cases.md

41 - - Graylog: graylog.md

42 -

43 -markdown_extensions:

44 - - pymdownx.highlight:

45 - anchor_linenums: true

46 - - pymdownx.inlinehilite

47 - - pymdownx.snippets

48 - - admonition

49 - - pymdownx.arithmatex:

50 - generic: true

51 - - footnotes

52 - - pymdownx.details

53 - - pymdownx.superfences

54 - - pymdownx.mark

55 - - attr_list

56 - - pymdownx.emoji:

57 - emoji_index: !!python/name:materialx.emoji.twemoji

58 - emoji_generator: !!python/name:materialx.emoji.to_svg

59 -

60 -copyright: |

backend/site/objects.inv

Binary files a/backend/site/objects.inv and b/backend/site/objects.inv differ

backend/site/shuffle/index.html new

+2047

@@ -0,0 +1,2047 @@

1 +

2 +<!doctype html>

3 +<html lang="en" class="no-js">

4 + <head>

5 +

6 + <meta charset="utf-8">

7 + <meta name="viewport" content="width=device-width,initial-scale=1">

8 +

9 +

10 +

11 +

12 + <link rel="prev" href="../velociraptor/">

13 +

14 +

15 + <link rel="icon" href="../assets/images/favicon.png">

16 + <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18">

17 +

18 +

19 +

20 + <title>Shuffle - SOCFortress CoPilot</title>

21 +

22 +

23 +

24 + <link rel="stylesheet" href="../assets/stylesheets/main.26e3688c.min.css">

25 +

26 +

27 + <link rel="stylesheet" href="../assets/stylesheets/palette.ecc896b0.min.css">

28 +

29 +

30 +

31 +

32 +

33 +

34 +

35 +

36 +

37 + <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>

38 + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">

39 + <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>

40 +

41 +

42 +

43 + <link rel="stylesheet" href="../assets/_mkdocstrings.css">

44 +

45 + <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>

46 +

47 +

48 +

49 +

50 +

51 +

52 + </head>

53 +

54 +

55 +

56 +

57 +

58 +

59 +

60 +

61 +

62 + <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="purple">

63 +

64 +

65 +

66 + <script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>

67 +

68 + <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">

69 + <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">

70 + <label class="md-overlay" for="__drawer"></label>

71 + <div data-md-component="skip">

72 +

73 +

74 + <a href="#shuffle-overview" class="md-skip">

75 + Skip to content

76 + </a>

77 +

78 + </div>

79 + <div data-md-component="announce">

80 +

81 + </div>

82 +

83 +

84 +

85 +

86 +<header class="md-header" data-md-component="header">

87 + <nav class="md-header__inner md-grid" aria-label="Header">

88 + <a href=".." title="SOCFortress CoPilot" class="md-header__button md-logo" aria-label="SOCFortress CoPilot" data-md-component="logo">

89 +

90 +

91 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

92 +

93 + </a>

94 + <label class="md-header__button md-icon" for="__drawer">

95 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>

96 + </label>

97 + <div class="md-header__title" data-md-component="header-title">

98 + <div class="md-header__ellipsis">

99 + <div class="md-header__topic">

100 +

101 + SOCFortress CoPilot

102 +

103 + </div>

104 + <div class="md-header__topic" data-md-component="header-topic">

105 +

106 +

107 + Shuffle

108 +

109 +

110 + </div>

111 + </div>

112 + </div>

113 +

114 +

115 + <form class="md-header__option" data-md-component="palette">

116 +

117 +

118 +

119 +

120 + <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="purple" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">

121 +

122 + <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>

123 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6zm0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4zM7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z"/></svg>

124 + </label>

125 +

126 +

127 +

128 +

129 +

130 + <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="teal" data-md-color-accent="lime" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">

131 +

132 + <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>

133 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3Z"/></svg>

134 + </label>

135 +

136 +

137 + </form>

138 +

139 +

140 +

141 +

142 +

143 + </nav>

144 +

145 +</header>

146 +

147 + <div class="md-container" data-md-component="container">

148 +

149 +

150 +

151 +

152 +

153 +<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">

154 + <div class="md-grid">

155 + <ul class="md-tabs__list">

156 +

157 +

158 +

159 +

160 +

161 +

162 + <li class="md-tabs__item">

163 + <a href=".." class="md-tabs__link">

164 + Home

165 + </a>

166 + </li>

167 +

168 +

169 +

170 +

171 +

172 +

173 +

174 + <li class="md-tabs__item">

175 + <a href="../connectors/" class="md-tabs__link">

176 + Connectors

177 + </a>

178 + </li>

179 +

180 +

181 +

182 +

183 +

184 +

185 +

186 + <li class="md-tabs__item">

187 + <a href="../agents/" class="md-tabs__link">

188 + Agents

189 + </a>

190 + </li>

191 +

192 +

193 +

194 +

195 +

196 +

197 +

198 + <li class="md-tabs__item">

199 + <a href="../wazuhindexer/" class="md-tabs__link">

200 + Wazuh-Indexer

201 + </a>

202 + </li>

203 +

204 +

205 +

206 +

207 +

208 +

209 +

210 + <li class="md-tabs__item">

211 + <a href="../dfiriris/" class="md-tabs__link">

212 + Dfir-Iris

213 + </a>

214 + </li>

215 +

216 +

217 +

218 +

219 +

220 +

221 +

222 + <li class="md-tabs__item">

223 + <a href="../graylog/" class="md-tabs__link">

224 + Graylog

225 + </a>

226 + </li>

227 +

228 +

229 +

230 +

231 +

232 +

233 +

234 + <li class="md-tabs__item">

235 + <a href="../wazuhmanager/" class="md-tabs__link">

236 + Wazuh-Manager

237 + </a>

238 + </li>

239 +

240 +

241 +

242 +

243 +

244 +

245 +

246 + <li class="md-tabs__item">

247 + <a href="../velociraptor/" class="md-tabs__link">

248 + Velociraptor

249 + </a>

250 + </li>

251 +

252 +

253 +

254 +

255 +

256 +

257 +

258 +

259 +

260 + <li class="md-tabs__item">

261 + <a href="./" class="md-tabs__link md-tabs__link--active">

262 + Shuffle

263 + </a>

264 + </li>

265 +

266 +

267 + </ul>

268 + </div>

269 +</nav>

270 +

271 +

272 +

273 + <main class="md-main" data-md-component="main">

274 + <div class="md-main__inner md-grid">

275 +

276 +

277 +

278 + <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >

279 + <div class="md-sidebar__scrollwrap">

280 + <div class="md-sidebar__inner">

281 +

282 +

283 +

284 +

285 +

286 +

287 +

288 +<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">

289 + <label class="md-nav__title" for="__drawer">

290 + <a href=".." title="SOCFortress CoPilot" class="md-nav__button md-logo" aria-label="SOCFortress CoPilot" data-md-component="logo">

291 +

292 +

293 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>

294 +

295 + </a>

296 + SOCFortress CoPilot

297 + </label>

298 +

299 + <ul class="md-nav__list" data-md-scrollfix>

300 +

301 +

302 +

303 +

304 +

305 +

306 +

307 +

308 + <li class="md-nav__item">

309 + <a href=".." class="md-nav__link">

310 + Home

311 + </a>

312 + </li>

313 +

314 +

315 +

316 +

317 +

318 +

319 +

320 +

321 +

322 +

323 + <li class="md-nav__item">

324 + <a href="../connectors/" class="md-nav__link">

325 + Connectors

326 + </a>

327 + </li>

328 +

329 +

330 +

331 +

332 +

333 +

334 +

335 +

336 +

337 +

338 + <li class="md-nav__item">

339 + <a href="../agents/" class="md-nav__link">

340 + Agents

341 + </a>

342 + </li>

343 +

344 +

345 +

346 +

347 +

348 +

349 +

350 +

351 +

352 +

353 + <li class="md-nav__item">

354 + <a href="../wazuhindexer/" class="md-nav__link">

355 + Wazuh-Indexer

356 + </a>

357 + </li>

358 +

359 +

360 +

361 +

362 +

363 +

364 +

365 +

366 +

367 +

368 + <li class="md-nav__item">

369 + <a href="../dfiriris/" class="md-nav__link">

370 + Dfir-Iris

371 + </a>

372 + </li>

373 +

374 +

375 +

376 +

377 +

378 +

379 +

380 +

381 +

382 +

383 + <li class="md-nav__item">

384 + <a href="../graylog/" class="md-nav__link">

385 + Graylog

386 + </a>

387 + </li>

388 +

389 +

390 +

391 +

392 +

393 +

394 +

395 +

396 +

397 +

398 + <li class="md-nav__item">

399 + <a href="../wazuhmanager/" class="md-nav__link">

400 + Wazuh-Manager

401 + </a>

402 + </li>

403 +

404 +

405 +

406 +

407 +

408 +

409 +

410 +

411 +

412 +

413 + <li class="md-nav__item">

414 + <a href="../velociraptor/" class="md-nav__link">

415 + Velociraptor

416 + </a>

417 + </li>

418 +

419 +

420 +

421 +

422 +

423 +

424 +

425 +

426 +

427 +

428 +

429 +

430 + <li class="md-nav__item md-nav__item--active">

431 +

432 + <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">

433 +

434 +

435 +

436 + <label class="md-nav__link md-nav__link--active" for="__toc">

437 + Shuffle

438 +

439 + </label>

440 +

441 + <a href="./" class="md-nav__link md-nav__link--active">

442 + Shuffle

443 + </a>

444 +

445 +

446 +

447 +<nav class="md-nav md-nav--secondary" aria-label="Table of contents">

448 +

449 +

450 +

451 +

452 + <label class="md-nav__title" for="__toc">

453 +

454 + Table of contents

455 + </label>

456 + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

457 +

458 + <li class="md-nav__item">

459 + <a href="#shuffle-overview" class="md-nav__link">

460 + Shuffle Overview

461 + </a>

462 +

463 + <nav class="md-nav" aria-label="Shuffle Overview">

464 + <ul class="md-nav__list">

465 +

466 + <li class="md-nav__item">

467 + <a href="#shuffle-routes" class="md-nav__link">

468 + Shuffle Routes

469 + </a>

470 +

471 +</li>

472 +

473 + </ul>

474 + </nav>

475 +

476 +</li>

477 +

478 + <li class="md-nav__item">

479 + <a href="#app.routes.shuffle" class="md-nav__link">

480 + app.routes.shuffle

481 + </a>

482 +

483 +</li>

484 +

485 + <li class="md-nav__item">

486 + <a href="#app.routes.shuffle.get_workflow_executions" class="md-nav__link">

487 + get_workflow_executions()

488 + </a>

489 +

490 +</li>

491 +

492 + <li class="md-nav__item">

493 + <a href="#app.routes.shuffle.get_workflows" class="md-nav__link">

494 + get_workflows()

495 + </a>

496 +

497 +</li>

498 +

499 + <li class="md-nav__item">

500 + <a href="#app.routes.shuffle.get_workflows_executions" class="md-nav__link">

501 + get_workflows_executions()

502 + </a>

503 +

504 + <nav class="md-nav" aria-label="get_workflows_executions()">

505 + <ul class="md-nav__list">

506 +

507 + <li class="md-nav__item">

508 + <a href="#workflows-services" class="md-nav__link">

509 + Workflows Services

510 + </a>

511 +

512 +</li>

513 +

514 + </ul>

515 + </nav>

516 +

517 +</li>

518 +

519 + <li class="md-nav__item">

520 + <a href="#app.services.Shuffle.workflows" class="md-nav__link">

521 + app.services.Shuffle.workflows

522 + </a>

523 +

524 +</li>

525 +

526 + <li class="md-nav__item">

527 + <a href="#app.services.Shuffle.workflows.WorkflowsService" class="md-nav__link">

528 + WorkflowsService

529 + </a>

530 +

531 + <nav class="md-nav" aria-label="WorkflowsService">

532 + <ul class="md-nav__list">

533 +

534 + <li class="md-nav__item">

535 + <a href="#app.services.Shuffle.workflows.WorkflowsService.collect_workflow_details" class="md-nav__link">

536 + collect_workflow_details()

537 + </a>

538 +

539 +</li>

540 +

541 + <li class="md-nav__item">

542 + <a href="#app.services.Shuffle.workflows.WorkflowsService.collect_workflow_executions_status" class="md-nav__link">

543 + collect_workflow_executions_status()

544 + </a>

545 +

546 +</li>

547 +

548 + <li class="md-nav__item">

549 + <a href="#app.services.Shuffle.workflows.WorkflowsService.collect_workflows" class="md-nav__link">

550 + collect_workflows()

551 + </a>

552 +

553 +</li>

554 +

555 + <li class="md-nav__item">

556 + <a href="#universal-services" class="md-nav__link">

557 + Universal Services

558 + </a>

559 +

560 +</li>

561 +

562 + </ul>

563 + </nav>

564 +

565 +</li>

566 +

567 + <li class="md-nav__item">

568 + <a href="#app.services.Shuffle.universal" class="md-nav__link">

569 + app.services.Shuffle.universal

570 + </a>

571 +

572 +</li>

573 +

574 + <li class="md-nav__item">

575 + <a href="#app.services.Shuffle.universal.UniversalService" class="md-nav__link">

576 + UniversalService

577 + </a>

578 +

579 + <nav class="md-nav" aria-label="UniversalService">

580 + <ul class="md-nav__list">

581 +

582 + <li class="md-nav__item">

583 + <a href="#app.services.Shuffle.universal.UniversalService.collect_shuffle_details" class="md-nav__link">

584 + collect_shuffle_details()

585 + </a>

586 +

587 +</li>

588 +

589 + </ul>

590 + </nav>

591 +

592 +</li>

593 +

594 + </ul>

595 +

596 +</nav>

597 +

598 + </li>

599 +

600 +

601 +

602 + </ul>

603 +</nav>

604 + </div>

605 + </div>

606 + </div>

607 +

608 +

609 +

610 +

611 + <div class="md-content" data-md-component="content">

612 + <article class="md-content__inner md-typeset">

613 +

614 +

615 +

616 +

617 + <h1>Shuffle</h1>

618 +

619 +<h2 id="shuffle-overview">Shuffle Overview</h2>

620 +<h3 id="shuffle-routes">Shuffle Routes</h3>

621 +

622 +

623 +<div class="doc doc-object doc-module">

624 +

625 +

626 +<a id="app.routes.shuffle"></a>

627 + <div class="doc doc-contents first">

628 +

629 +

630 +

631 + <div class="doc doc-children">

632 +

633 +

634 +

635 +

636 +

637 +

638 +

639 +

640 +

641 +<div class="doc doc-object doc-function">

642 +

643 +

644 +

645 +<h2 id="app.routes.shuffle.get_workflow_executions" class="doc doc-heading">

646 +<code class="highlight language-python">get_workflow_executions(workflow_id)</code>

647 +

648 +</h2>

649 +

650 +

651 + <div class="doc doc-contents ">

652 +

653 + Endpoint to list execution status of a specified Shuffle workflow.

654 +This endpoint retrieves the status of the most recent execution for a specific workflow in Shuffle.

655 +

656 + Parameters:

657 + <table>

658 + <thead>

659 + <tr>

660 + <th>Name</th>

661 + <th>Type</th>

662 + <th>Description</th>

663 + <th>Default</th>

664 + </tr>

665 + </thead>

666 + <tbody>

667 + <tr>

668 + <td><code>workflow_id</code></td>

669 + <td>

670 + <code>str</code>

671 + </td>

672 + <td>

673 + <div class="doc-md-description">

674 + The ID of the workflow to retrieve the execution status for.

675 + </div>

676 + </td>

677 + <td>

678 + required

679 + </td>

680 + </tr>

681 + </tbody>

682 + </table>

683 +

684 + Returns:

685 + <table>

686 + <thead>

687 + <tr>

688 +<th>Name</th> <th>Type</th>

689 + <th>Description</th>

690 + </tr>

691 + </thead>

692 + <tbody>

693 + <tr>

694 +<td><code>jsonify</code></td> <td>

695 + <code>jsonify</code>

696 + </td>

697 + <td>

698 + <div class="doc-md-description">

699 + A JSON response containing the last execution status of the specified workflow.

700 + </div>

701 + </td>

702 + </tr>

703 + </tbody>

704 + </table>

705 +

706 + <details class="quote">

707 + <summary>Source code in <code>app\routes\shuffle.py</code></summary>

708 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-52">52</a>

709 +<a href="#__codelineno-0-53">53</a>

710 +<a href="#__codelineno-0-54">54</a>

711 +<a href="#__codelineno-0-55">55</a>

712 +<a href="#__codelineno-0-56">56</a>

713 +<a href="#__codelineno-0-57">57</a>

714 +<a href="#__codelineno-0-58">58</a>

715 +<a href="#__codelineno-0-59">59</a>

716 +<a href="#__codelineno-0-60">60</a>

717 +<a href="#__codelineno-0-61">61</a>

718 +<a href="#__codelineno-0-62">62</a>

719 +<a href="#__codelineno-0-63">63</a>

720 +<a href="#__codelineno-0-64">64</a>

721 +<a href="#__codelineno-0-65">65</a>

722 +<a href="#__codelineno-0-66">66</a>

723 +<a href="#__codelineno-0-67">67</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-52" name="__codelineno-0-52"></a>@bp.route("/shuffle/workflows/executions/<workflow_id>", methods=["GET"])

724 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a>def get_workflow_executions(workflow_id: str) -> jsonify:

725 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> """

726 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> Endpoint to list execution status of a specified Shuffle workflow.

727 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a>

728 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> This endpoint retrieves the status of the most recent execution for a specific workflow in Shuffle.

729 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a>

730 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> Args:

731 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> workflow_id (str): The ID of the workflow to retrieve the execution status for.

732 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a>

733 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> Returns:

734 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> jsonify: A JSON response containing the last execution status of the specified workflow.

735 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> """

736 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> service = WorkflowsService()

737 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> workflow_details = service.collect_workflow_executions_status(workflow_id)

738 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> return workflow_details

739 +</code></pre></div></td></tr></table></div>

740 + </details>

741 + </div>

742 +

743 +</div>

744 +

745 +<div class="doc doc-object doc-function">

746 +

747 +

748 +

749 +<h2 id="app.routes.shuffle.get_workflows" class="doc doc-heading">

750 +<code class="highlight language-python">get_workflows()</code>

751 +

752 +</h2>

753 +

754 +

755 + <div class="doc doc-contents ">

756 +

757 + Endpoint to list all available Shuffle workflows.

758 +

759 + Returns:

760 + <table>

761 + <thead>

762 + <tr>

763 +<th>Name</th> <th>Type</th>

764 + <th>Description</th>

765 + </tr>

766 + </thead>

767 + <tbody>

768 + <tr>

769 +<td><code>jsonify</code></td> <td>

770 + <code>jsonify</code>

771 + </td>

772 + <td>

773 + <div class="doc-md-description">

774 + A JSON response containing the list of all configured Workflows in Shuffle.

775 + </div>

776 + </td>

777 + </tr>

778 + </tbody>

779 + </table>

780 +

781 + <details class="quote">

782 + <summary>Source code in <code>app\routes\shuffle.py</code></summary>

783 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-17">17</a>

784 +<a href="#__codelineno-0-18">18</a>

785 +<a href="#__codelineno-0-19">19</a>

786 +<a href="#__codelineno-0-20">20</a>

787 +<a href="#__codelineno-0-21">21</a>

788 +<a href="#__codelineno-0-22">22</a>

789 +<a href="#__codelineno-0-23">23</a>

790 +<a href="#__codelineno-0-24">24</a>

791 +<a href="#__codelineno-0-25">25</a>

792 +<a href="#__codelineno-0-26">26</a>

793 +<a href="#__codelineno-0-27">27</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-17" name="__codelineno-0-17"></a>@bp.route("/shuffle/workflows", methods=["GET"])

794 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a>def get_workflows() -> jsonify:

795 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> """

796 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> Endpoint to list all available Shuffle workflows.

797 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a>

798 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> Returns:

799 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> jsonify: A JSON response containing the list of all configured Workflows in Shuffle.

800 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> """

801 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> service = WorkflowsService()

802 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> workflows = service.collect_workflows()

803 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> return workflows

804 +</code></pre></div></td></tr></table></div>

805 + </details>

806 + </div>

807 +

808 +</div>

809 +

810 +<div class="doc doc-object doc-function">

811 +

812 +

813 +

814 +<h2 id="app.routes.shuffle.get_workflows_executions" class="doc doc-heading">

815 +<code class="highlight language-python">get_workflows_executions()</code>

816 +

817 +</h2>

818 +

819 +

820 + <div class="doc doc-contents ">

821 +

822 + Endpoint to list all available Shuffle workflow execution status.

823 +This endpoint retrieves the status of the most recent execution for each workflow in Shuffle.

824 +

825 + Returns:

826 + <table>

827 + <thead>

828 + <tr>

829 +<th>Name</th> <th>Type</th>

830 + <th>Description</th>

831 + </tr>

832 + </thead>

833 + <tbody>

834 + <tr>

835 +<td><code>jsonify</code></td> <td>

836 + <code>jsonify</code>

837 + </td>

838 + <td>

839 + <div class="doc-md-description">

840 + A JSON response containing the list of all configured workflows and their last execution status.

841 + </div>

842 + </td>

843 + </tr>

844 + </tbody>

845 + </table>

846 +

847 + <details class="quote">

848 + <summary>Source code in <code>app\routes\shuffle.py</code></summary>

849 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-30">30</a>

850 +<a href="#__codelineno-0-31">31</a>

851 +<a href="#__codelineno-0-32">32</a>

852 +<a href="#__codelineno-0-33">33</a>

853 +<a href="#__codelineno-0-34">34</a>

854 +<a href="#__codelineno-0-35">35</a>

855 +<a href="#__codelineno-0-36">36</a>

856 +<a href="#__codelineno-0-37">37</a>

857 +<a href="#__codelineno-0-38">38</a>

858 +<a href="#__codelineno-0-39">39</a>

859 +<a href="#__codelineno-0-40">40</a>

860 +<a href="#__codelineno-0-41">41</a>

861 +<a href="#__codelineno-0-42">42</a>

862 +<a href="#__codelineno-0-43">43</a>

863 +<a href="#__codelineno-0-44">44</a>

864 +<a href="#__codelineno-0-45">45</a>

865 +<a href="#__codelineno-0-46">46</a>

866 +<a href="#__codelineno-0-47">47</a>

867 +<a href="#__codelineno-0-48">48</a>

868 +<a href="#__codelineno-0-49">49</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-30" name="__codelineno-0-30"></a>@bp.route("/shuffle/workflows/executions", methods=["GET"])

869 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a>def get_workflows_executions() -> jsonify:

870 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> """

871 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> Endpoint to list all available Shuffle workflow execution status.

872 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a>

873 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> This endpoint retrieves the status of the most recent execution for each workflow in Shuffle.

874 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a>

875 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> Returns:

876 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> jsonify: A JSON response containing the list of all configured workflows and their last execution status.

877 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> """

878 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> service = WorkflowsService()

879 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> workflow_details = service.collect_workflow_details()

880 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> if "workflows" not in workflow_details:

881 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> message = "No workflows found"

882 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> return jsonify({"message": message, "success": False}), 500

883 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> for workflow in workflow_details["workflows"]:

884 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> workflow["status"] = service.collect_workflow_executions_status(

885 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> workflow["workflow_id"],

886 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> )

887 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> return workflow_details

888 +</code></pre></div></td></tr></table></div>

889 + </details>

890 + </div>

891 +

892 +</div>

893 +

894 +

895 +

896 + </div>

897 +

898 + </div>

899 +

900 +</div>

901 +<h3 id="workflows-services">Workflows Services</h3>

902 +

903 +

904 +<div class="doc doc-object doc-module">

905 +

906 +

907 +<a id="app.services.Shuffle.workflows"></a>

908 + <div class="doc doc-contents first">

909 +

910 +

911 +

912 + <div class="doc doc-children">

913 +

914 +

915 +

916 +

917 +

918 +

919 +

920 +

921 +<div class="doc doc-object doc-class">

922 +

923 +

924 +

925 +<h2 id="app.services.Shuffle.workflows.WorkflowsService" class="doc doc-heading">

926 + <code>WorkflowsService</code>

927 +

928 +

929 +</h2>

930 +

931 +

932 + <div class="doc doc-contents ">

933 +

934 +

935 + A service class that encapsulates the logic for retrieving workflow information from Shuffle.

936 +

937 + Attributes:

938 + <table>

939 + <thead>

940 + <tr>

941 + <th>Name</th>

942 + <th>Type</th>

943 + <th>Description</th>

944 + </tr>

945 + </thead>

946 + <tbody>

947 + <tr>

948 + <td><code>connector_url</code></td>

949 + <td>

950 + <code>str</code>

951 + </td>

952 + <td>

953 + <div class="doc-md-description">

954 + The URL of the Shuffle instance.

955 + </div>

956 + </td>

957 + </tr>

958 + <tr>

959 + <td><code>connector_api_key</code></td>

960 + <td>

961 + <code>str</code>

962 + </td>

963 + <td>

964 + <div class="doc-md-description">

965 + The API key used for the Shuffle instance.

966 + </div>

967 + </td>

968 + </tr>

969 + <tr>

970 + <td><code>session</code></td>

971 + <td>

972 + <code>requests.Session</code>

973 + </td>

974 + <td>

975 + <div class="doc-md-description">

976 + A requests session for making HTTP requests.

977 + </div>

978 + </td>

979 + </tr>

980 + </tbody>

981 + </table>

982 +

983 +<details class="methods" open>

984 + <summary>Methods</summary>

985 + _collect_shuffle_details: Collects the details of the Shuffle connector.

986 +_are_details_collected: Checks whether the details for the Shuffle connector were successfully collected.

987 +_send_request: Sends a GET request to a provided URL.

988 +collect_workflows: Collects the workflows from Shuffle.

989 +_handle_request_error: Handles any errors that occur during a request.

990 +_collect_workflows: Collects the workflows from Shuffle.

991 +collect_workflow_details: Collects the workflow ID and workflow name from Shuffle.

992 +_collect_workflow_details: Collects the workflow ID and workflow name from Shuffle.

993 +collect_workflow_executions_status: Collects the execution status of a Shuffle Workflow by its ID.

994 +_collect_workflow_executions_status: Collects the execution status of a Shuffle Workflow by its ID.

995 +</details>

996 +

997 + <details class="quote">

998 + <summary>Source code in <code>app\services\Shuffle\workflows.py</code></summary>

999 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-9"> 9</a>

1000 +<a href="#__codelineno-0-10"> 10</a>

1001 +<a href="#__codelineno-0-11"> 11</a>

1002 +<a href="#__codelineno-0-12"> 12</a>

1003 +<a href="#__codelineno-0-13"> 13</a>

1004 +<a href="#__codelineno-0-14"> 14</a>

1005 +<a href="#__codelineno-0-15"> 15</a>

1006 +<a href="#__codelineno-0-16"> 16</a>

1007 +<a href="#__codelineno-0-17"> 17</a>

1008 +<a href="#__codelineno-0-18"> 18</a>

1009 +<a href="#__codelineno-0-19"> 19</a>

1010 +<a href="#__codelineno-0-20"> 20</a>

1011 +<a href="#__codelineno-0-21"> 21</a>

1012 +<a href="#__codelineno-0-22"> 22</a>

1013 +<a href="#__codelineno-0-23"> 23</a>

1014 +<a href="#__codelineno-0-24"> 24</a>

1015 +<a href="#__codelineno-0-25"> 25</a>

1016 +<a href="#__codelineno-0-26"> 26</a>

1017 +<a href="#__codelineno-0-27"> 27</a>

1018 +<a href="#__codelineno-0-28"> 28</a>

1019 +<a href="#__codelineno-0-29"> 29</a>

1020 +<a href="#__codelineno-0-30"> 30</a>

1021 +<a href="#__codelineno-0-31"> 31</a>

1022 +<a href="#__codelineno-0-32"> 32</a>

1023 +<a href="#__codelineno-0-33"> 33</a>

1024 +<a href="#__codelineno-0-34"> 34</a>

1025 +<a href="#__codelineno-0-35"> 35</a>

1026 +<a href="#__codelineno-0-36"> 36</a>

1027 +<a href="#__codelineno-0-37"> 37</a>

1028 +<a href="#__codelineno-0-38"> 38</a>

1029 +<a href="#__codelineno-0-39"> 39</a>

1030 +<a href="#__codelineno-0-40"> 40</a>

1031 +<a href="#__codelineno-0-41"> 41</a>

1032 +<a href="#__codelineno-0-42"> 42</a>

1033 +<a href="#__codelineno-0-43"> 43</a>

1034 +<a href="#__codelineno-0-44"> 44</a>

1035 +<a href="#__codelineno-0-45"> 45</a>

1036 +<a href="#__codelineno-0-46"> 46</a>

1037 +<a href="#__codelineno-0-47"> 47</a>

1038 +<a href="#__codelineno-0-48"> 48</a>

1039 +<a href="#__codelineno-0-49"> 49</a>

1040 +<a href="#__codelineno-0-50"> 50</a>

1041 +<a href="#__codelineno-0-51"> 51</a>

1042 +<a href="#__codelineno-0-52"> 52</a>

1043 +<a href="#__codelineno-0-53"> 53</a>

1044 +<a href="#__codelineno-0-54"> 54</a>

1045 +<a href="#__codelineno-0-55"> 55</a>

1046 +<a href="#__codelineno-0-56"> 56</a>

1047 +<a href="#__codelineno-0-57"> 57</a>

1048 +<a href="#__codelineno-0-58"> 58</a>

1049 +<a href="#__codelineno-0-59"> 59</a>

1050 +<a href="#__codelineno-0-60"> 60</a>

1051 +<a href="#__codelineno-0-61"> 61</a>

1052 +<a href="#__codelineno-0-62"> 62</a>

1053 +<a href="#__codelineno-0-63"> 63</a>

1054 +<a href="#__codelineno-0-64"> 64</a>

1055 +<a href="#__codelineno-0-65"> 65</a>

1056 +<a href="#__codelineno-0-66"> 66</a>

1057 +<a href="#__codelineno-0-67"> 67</a>

1058 +<a href="#__codelineno-0-68"> 68</a>

1059 +<a href="#__codelineno-0-69"> 69</a>

1060 +<a href="#__codelineno-0-70"> 70</a>

1061 +<a href="#__codelineno-0-71"> 71</a>

1062 +<a href="#__codelineno-0-72"> 72</a>

1063 +<a href="#__codelineno-0-73"> 73</a>

1064 +<a href="#__codelineno-0-74"> 74</a>

1065 +<a href="#__codelineno-0-75"> 75</a>

1066 +<a href="#__codelineno-0-76"> 76</a>

1067 +<a href="#__codelineno-0-77"> 77</a>

1068 +<a href="#__codelineno-0-78"> 78</a>

1069 +<a href="#__codelineno-0-79"> 79</a>

1070 +<a href="#__codelineno-0-80"> 80</a>

1071 +<a href="#__codelineno-0-81"> 81</a>

1072 +<a href="#__codelineno-0-82"> 82</a>

1073 +<a href="#__codelineno-0-83"> 83</a>

1074 +<a href="#__codelineno-0-84"> 84</a>

1075 +<a href="#__codelineno-0-85"> 85</a>

1076 +<a href="#__codelineno-0-86"> 86</a>

1077 +<a href="#__codelineno-0-87"> 87</a>

1078 +<a href="#__codelineno-0-88"> 88</a>

1079 +<a href="#__codelineno-0-89"> 89</a>

1080 +<a href="#__codelineno-0-90"> 90</a>

1081 +<a href="#__codelineno-0-91"> 91</a>

1082 +<a href="#__codelineno-0-92"> 92</a>

1083 +<a href="#__codelineno-0-93"> 93</a>

1084 +<a href="#__codelineno-0-94"> 94</a>

1085 +<a href="#__codelineno-0-95"> 95</a>

1086 +<a href="#__codelineno-0-96"> 96</a>

1087 +<a href="#__codelineno-0-97"> 97</a>

1088 +<a href="#__codelineno-0-98"> 98</a>

1089 +<a href="#__codelineno-0-99"> 99</a>

1090 +<a href="#__codelineno-0-100">100</a>

1091 +<a href="#__codelineno-0-101">101</a>

1092 +<a href="#__codelineno-0-102">102</a>

1093 +<a href="#__codelineno-0-103">103</a>

1094 +<a href="#__codelineno-0-104">104</a>

1095 +<a href="#__codelineno-0-105">105</a>

1096 +<a href="#__codelineno-0-106">106</a>

1097 +<a href="#__codelineno-0-107">107</a>

1098 +<a href="#__codelineno-0-108">108</a>

1099 +<a href="#__codelineno-0-109">109</a>

1100 +<a href="#__codelineno-0-110">110</a>

1101 +<a href="#__codelineno-0-111">111</a>

1102 +<a href="#__codelineno-0-112">112</a>

1103 +<a href="#__codelineno-0-113">113</a>

1104 +<a href="#__codelineno-0-114">114</a>

1105 +<a href="#__codelineno-0-115">115</a>

1106 +<a href="#__codelineno-0-116">116</a>

1107 +<a href="#__codelineno-0-117">117</a>

1108 +<a href="#__codelineno-0-118">118</a>

1109 +<a href="#__codelineno-0-119">119</a>

1110 +<a href="#__codelineno-0-120">120</a>

1111 +<a href="#__codelineno-0-121">121</a>

1112 +<a href="#__codelineno-0-122">122</a>

1113 +<a href="#__codelineno-0-123">123</a>

1114 +<a href="#__codelineno-0-124">124</a>

1115 +<a href="#__codelineno-0-125">125</a>

1116 +<a href="#__codelineno-0-126">126</a>

1117 +<a href="#__codelineno-0-127">127</a>

1118 +<a href="#__codelineno-0-128">128</a>

1119 +<a href="#__codelineno-0-129">129</a>

1120 +<a href="#__codelineno-0-130">130</a>

1121 +<a href="#__codelineno-0-131">131</a>

1122 +<a href="#__codelineno-0-132">132</a>

1123 +<a href="#__codelineno-0-133">133</a>

1124 +<a href="#__codelineno-0-134">134</a>

1125 +<a href="#__codelineno-0-135">135</a>

1126 +<a href="#__codelineno-0-136">136</a>

1127 +<a href="#__codelineno-0-137">137</a>

1128 +<a href="#__codelineno-0-138">138</a>

1129 +<a href="#__codelineno-0-139">139</a>

1130 +<a href="#__codelineno-0-140">140</a>

1131 +<a href="#__codelineno-0-141">141</a>

1132 +<a href="#__codelineno-0-142">142</a>

1133 +<a href="#__codelineno-0-143">143</a>

1134 +<a href="#__codelineno-0-144">144</a>

1135 +<a href="#__codelineno-0-145">145</a>

1136 +<a href="#__codelineno-0-146">146</a>

1137 +<a href="#__codelineno-0-147">147</a>

1138 +<a href="#__codelineno-0-148">148</a>

1139 +<a href="#__codelineno-0-149">149</a>

1140 +<a href="#__codelineno-0-150">150</a>

1141 +<a href="#__codelineno-0-151">151</a>

1142 +<a href="#__codelineno-0-152">152</a>

1143 +<a href="#__codelineno-0-153">153</a>

1144 +<a href="#__codelineno-0-154">154</a>

1145 +<a href="#__codelineno-0-155">155</a>

1146 +<a href="#__codelineno-0-156">156</a>

1147 +<a href="#__codelineno-0-157">157</a>

1148 +<a href="#__codelineno-0-158">158</a>

1149 +<a href="#__codelineno-0-159">159</a>

1150 +<a href="#__codelineno-0-160">160</a>

1151 +<a href="#__codelineno-0-161">161</a>

1152 +<a href="#__codelineno-0-162">162</a>

1153 +<a href="#__codelineno-0-163">163</a>

1154 +<a href="#__codelineno-0-164">164</a>

1155 +<a href="#__codelineno-0-165">165</a>

1156 +<a href="#__codelineno-0-166">166</a>

1157 +<a href="#__codelineno-0-167">167</a>

1158 +<a href="#__codelineno-0-168">168</a>

1159 +<a href="#__codelineno-0-169">169</a>

1160 +<a href="#__codelineno-0-170">170</a>

1161 +<a href="#__codelineno-0-171">171</a>

1162 +<a href="#__codelineno-0-172">172</a>

1163 +<a href="#__codelineno-0-173">173</a>

1164 +<a href="#__codelineno-0-174">174</a>

1165 +<a href="#__codelineno-0-175">175</a>

1166 +<a href="#__codelineno-0-176">176</a>

1167 +<a href="#__codelineno-0-177">177</a>

1168 +<a href="#__codelineno-0-178">178</a>

1169 +<a href="#__codelineno-0-179">179</a>

1170 +<a href="#__codelineno-0-180">180</a>

1171 +<a href="#__codelineno-0-181">181</a>

1172 +<a href="#__codelineno-0-182">182</a>

1173 +<a href="#__codelineno-0-183">183</a>

1174 +<a href="#__codelineno-0-184">184</a>

1175 +<a href="#__codelineno-0-185">185</a>

1176 +<a href="#__codelineno-0-186">186</a>

1177 +<a href="#__codelineno-0-187">187</a>

1178 +<a href="#__codelineno-0-188">188</a>

1179 +<a href="#__codelineno-0-189">189</a>

1180 +<a href="#__codelineno-0-190">190</a>

1181 +<a href="#__codelineno-0-191">191</a>

1182 +<a href="#__codelineno-0-192">192</a>

1183 +<a href="#__codelineno-0-193">193</a>

1184 +<a href="#__codelineno-0-194">194</a>

1185 +<a href="#__codelineno-0-195">195</a>

1186 +<a href="#__codelineno-0-196">196</a>

1187 +<a href="#__codelineno-0-197">197</a>

1188 +<a href="#__codelineno-0-198">198</a>

1189 +<a href="#__codelineno-0-199">199</a>

1190 +<a href="#__codelineno-0-200">200</a>

1191 +<a href="#__codelineno-0-201">201</a>

1192 +<a href="#__codelineno-0-202">202</a>

1193 +<a href="#__codelineno-0-203">203</a>

1194 +<a href="#__codelineno-0-204">204</a>

1195 +<a href="#__codelineno-0-205">205</a>

1196 +<a href="#__codelineno-0-206">206</a>

1197 +<a href="#__codelineno-0-207">207</a>

1198 +<a href="#__codelineno-0-208">208</a>

1199 +<a href="#__codelineno-0-209">209</a>

1200 +<a href="#__codelineno-0-210">210</a>

1201 +<a href="#__codelineno-0-211">211</a>

1202 +<a href="#__codelineno-0-212">212</a>

1203 +<a href="#__codelineno-0-213">213</a>

1204 +<a href="#__codelineno-0-214">214</a>

1205 +<a href="#__codelineno-0-215">215</a>

1206 +<a href="#__codelineno-0-216">216</a>

1207 +<a href="#__codelineno-0-217">217</a>

1208 +<a href="#__codelineno-0-218">218</a>

1209 +<a href="#__codelineno-0-219">219</a>

1210 +<a href="#__codelineno-0-220">220</a>

1211 +<a href="#__codelineno-0-221">221</a>

1212 +<a href="#__codelineno-0-222">222</a>

1213 +<a href="#__codelineno-0-223">223</a>

1214 +<a href="#__codelineno-0-224">224</a>

1215 +<a href="#__codelineno-0-225">225</a>

1216 +<a href="#__codelineno-0-226">226</a>

1217 +<a href="#__codelineno-0-227">227</a>

1218 +<a href="#__codelineno-0-228">228</a>

1219 +<a href="#__codelineno-0-229">229</a>

1220 +<a href="#__codelineno-0-230">230</a>

1221 +<a href="#__codelineno-0-231">231</a>

1222 +<a href="#__codelineno-0-232">232</a>

1223 +<a href="#__codelineno-0-233">233</a>

1224 +<a href="#__codelineno-0-234">234</a>

1225 +<a href="#__codelineno-0-235">235</a>

1226 +<a href="#__codelineno-0-236">236</a>

1227 +<a href="#__codelineno-0-237">237</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-9" name="__codelineno-0-9"></a>class WorkflowsService:

1228 +<a id="__codelineno-0-10" name="__codelineno-0-10"></a> """

1229 +<a id="__codelineno-0-11" name="__codelineno-0-11"></a> A service class that encapsulates the logic for retrieving workflow information from Shuffle.

1230 +<a id="__codelineno-0-12" name="__codelineno-0-12"></a>

1231 +<a id="__codelineno-0-13" name="__codelineno-0-13"></a> Attributes:

1232 +<a id="__codelineno-0-14" name="__codelineno-0-14"></a> connector_url (str): The URL of the Shuffle instance.

1233 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a> connector_api_key (str): The API key used for the Shuffle instance.

1234 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> session (requests.Session): A requests session for making HTTP requests.

1235 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a>

1236 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> Methods:

1237 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> _collect_shuffle_details: Collects the details of the Shuffle connector.

1238 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> _are_details_collected: Checks whether the details for the Shuffle connector were successfully collected.

1239 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> _send_request: Sends a GET request to a provided URL.

1240 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> collect_workflows: Collects the workflows from Shuffle.

1241 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> _handle_request_error: Handles any errors that occur during a request.

1242 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> _collect_workflows: Collects the workflows from Shuffle.

1243 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> collect_workflow_details: Collects the workflow ID and workflow name from Shuffle.

1244 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> _collect_workflow_details: Collects the workflow ID and workflow name from Shuffle.

1245 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> collect_workflow_executions_status: Collects the execution status of a Shuffle Workflow by its ID.

1246 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> _collect_workflow_executions_status: Collects the execution status of a Shuffle Workflow by its ID.

1247 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> """

1248 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a>

1249 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> def __init__(self):

1250 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> self._collect_shuffle_details()

1251 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> self.session = requests.Session()

1252 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> self.session.headers.update(

1253 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> {"Authorization": f"Bearer {self.connector_api_key}"},

1254 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> )

1255 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a>

1256 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> def _collect_shuffle_details(self):

1257 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> """

1258 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> Collects the details of the Shuffle connector.

1259 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a>

1260 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> The details are collected from a universal service which pulls connector details from a database.

1261 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a>

1262 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> Returns:

1263 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> tuple: A tuple containing the connection URL and API key of the Shuffle connector.

1264 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> """

1265 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> (

1266 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> self.connector_url,

1267 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> self.connector_api_key,

1268 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> ) = UniversalService().collect_shuffle_details("Shuffle")

1269 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a>

1270 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> def _are_details_collected(self) -> bool:

1271 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> """

1272 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> Checks whether the details for the Shuffle connector were successfully collected.

1273 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a>

1274 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> Returns:

1275 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> bool: True if all details were collected, False otherwise.

1276 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> """

1277 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> return all([self.connector_url, self.connector_api_key])

1278 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a>

1279 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> def _send_request(self, url: str):

1280 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> """

1281 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> Sends a GET request to a provided URL.

1282 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a>

1283 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Args:

1284 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> url (str): The URL to send the GET request to.

1285 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a>

1286 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> Returns:

1287 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> requests.Response: The response from the GET request.

1288 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> """

1289 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> return self.session.get(

1290 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> url,

1291 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> verify=False,

1292 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> )

1293 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a>

1294 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> def collect_workflows(self) -> Dict[str, object]:

1295 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> """

1296 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> Collects the workflows from Shuffle.

1297 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a>

1298 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> Returns:

1299 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> dict: A dictionary containing the success status, a message, and potentially the workflows.

1300 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> """

1301 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> if not self._are_details_collected():

1302 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> return {

1303 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> "message": "Failed to collect Shuffle details",

1304 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> "success": False,

1305 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> }

1306 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a>

1307 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> workflows = self._collect_workflows()

1308 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> if not workflows["success"]:

1309 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> return workflows

1310 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a>

1311 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a> return {

1312 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> "message": "Successfully collected workflows",

1313 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> "success": True,

1314 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> "workflows": workflows["workflows"],

1315 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> }

1316 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a>

1317 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a> def _handle_request_error(self, err: Exception) -> Dict[str, object]:

1318 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> """

1319 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> Handles any errors that occur during a request.

1320 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a>

1321 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> Args:

1322 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a> err (Exception): The exception that occurred.

1323 +<a id="__codelineno-0-105" name="__codelineno-0-105"></a>

1324 +<a id="__codelineno-0-106" name="__codelineno-0-106"></a> Returns:

1325 +<a id="__codelineno-0-107" name="__codelineno-0-107"></a> dict: A dictionary containing the success status and an error message.

1326 +<a id="__codelineno-0-108" name="__codelineno-0-108"></a> """

1327 +<a id="__codelineno-0-109" name="__codelineno-0-109"></a> logger.error(f"Failed to collect workflows from Shuffle: {err}")

1328 +<a id="__codelineno-0-110" name="__codelineno-0-110"></a> return {

1329 +<a id="__codelineno-0-111" name="__codelineno-0-111"></a> "message": "Failed to collect workflows from Shuffle",

1330 +<a id="__codelineno-0-112" name="__codelineno-0-112"></a> "success": False,

1331 +<a id="__codelineno-0-113" name="__codelineno-0-113"></a> }

1332 +<a id="__codelineno-0-114" name="__codelineno-0-114"></a>

1333 +<a id="__codelineno-0-115" name="__codelineno-0-115"></a> def _collect_workflows(self) -> Dict[str, object]:

1334 +<a id="__codelineno-0-116" name="__codelineno-0-116"></a> """

1335 +<a id="__codelineno-0-117" name="__codelineno-0-117"></a> Collects the workflows from Shuffle.

1336 +<a id="__codelineno-0-118" name="__codelineno-0-118"></a>

1337 +<a id="__codelineno-0-119" name="__codelineno-0-119"></a> Returns:

1338 +<a id="__codelineno-0-120" name="__codelineno-0-120"></a> dict: A dictionary containing the success status, a message, and potentially the workflows.

1339 +<a id="__codelineno-0-121" name="__codelineno-0-121"></a> """

1340 +<a id="__codelineno-0-122" name="__codelineno-0-122"></a> try:

1341 +<a id="__codelineno-0-123" name="__codelineno-0-123"></a> response = self._send_request(f"{self.connector_url}/api/v1/workflows")

1342 +<a id="__codelineno-0-124" name="__codelineno-0-124"></a> response.raise_for_status()

1343 +<a id="__codelineno-0-125" name="__codelineno-0-125"></a> except requests.exceptions.HTTPError as err:

1344 +<a id="__codelineno-0-126" name="__codelineno-0-126"></a> return self._handle_request_error(err)

1345 +<a id="__codelineno-0-127" name="__codelineno-0-127"></a>

1346 +<a id="__codelineno-0-128" name="__codelineno-0-128"></a> return {

1347 +<a id="__codelineno-0-129" name="__codelineno-0-129"></a> "message": "Successfully collected workflows from Shuffle",

1348 +<a id="__codelineno-0-130" name="__codelineno-0-130"></a> "success": True,

1349 +<a id="__codelineno-0-131" name="__codelineno-0-131"></a> "workflows": response.json(),

1350 +<a id="__codelineno-0-132" name="__codelineno-0-132"></a> }

1351 +<a id="__codelineno-0-133" name="__codelineno-0-133"></a>

1352 +<a id="__codelineno-0-134" name="__codelineno-0-134"></a> def collect_workflow_details(self) -> Dict[str, object]:

1353 +<a id="__codelineno-0-135" name="__codelineno-0-135"></a> """

1354 +<a id="__codelineno-0-136" name="__codelineno-0-136"></a> Collects the workflow ID and workflow name from Shuffle.

1355 +<a id="__codelineno-0-137" name="__codelineno-0-137"></a>

1356 +<a id="__codelineno-0-138" name="__codelineno-0-138"></a> Returns:

1357 +<a id="__codelineno-0-139" name="__codelineno-0-139"></a> dict: A dictionary containing the success status, a message, and potentially the workflow IDs.

1358 +<a id="__codelineno-0-140" name="__codelineno-0-140"></a> """

1359 +<a id="__codelineno-0-141" name="__codelineno-0-141"></a> if not self._are_details_collected():

1360 +<a id="__codelineno-0-142" name="__codelineno-0-142"></a> return {

1361 +<a id="__codelineno-0-143" name="__codelineno-0-143"></a> "message": "Failed to collect Shuffle details",

1362 +<a id="__codelineno-0-144" name="__codelineno-0-144"></a> "success": False,

1363 +<a id="__codelineno-0-145" name="__codelineno-0-145"></a> }

1364 +<a id="__codelineno-0-146" name="__codelineno-0-146"></a>

1365 +<a id="__codelineno-0-147" name="__codelineno-0-147"></a> workflows = self._collect_workflow_details()

1366 +<a id="__codelineno-0-148" name="__codelineno-0-148"></a> if not workflows["success"]:

1367 +<a id="__codelineno-0-149" name="__codelineno-0-149"></a> return workflows

1368 +<a id="__codelineno-0-150" name="__codelineno-0-150"></a>

1369 +<a id="__codelineno-0-151" name="__codelineno-0-151"></a> return {

1370 +<a id="__codelineno-0-152" name="__codelineno-0-152"></a> "message": "Successfully collected workflow details",

1371 +<a id="__codelineno-0-153" name="__codelineno-0-153"></a> "success": True,

1372 +<a id="__codelineno-0-154" name="__codelineno-0-154"></a> "workflows": workflows["workflows"],

1373 +<a id="__codelineno-0-155" name="__codelineno-0-155"></a> }

1374 +<a id="__codelineno-0-156" name="__codelineno-0-156"></a>

1375 +<a id="__codelineno-0-157" name="__codelineno-0-157"></a> def _collect_workflow_details(self) -> Dict[str, object]:

1376 +<a id="__codelineno-0-158" name="__codelineno-0-158"></a> """

1377 +<a id="__codelineno-0-159" name="__codelineno-0-159"></a> Collects the workflow ID and workflow name from Shuffle.

1378 +<a id="__codelineno-0-160" name="__codelineno-0-160"></a>

1379 +<a id="__codelineno-0-161" name="__codelineno-0-161"></a> Returns:

1380 +<a id="__codelineno-0-162" name="__codelineno-0-162"></a> dict: A dictionary containing the success status, a message, and potentially the workflow IDs.

1381 +<a id="__codelineno-0-163" name="__codelineno-0-163"></a> """

1382 +<a id="__codelineno-0-164" name="__codelineno-0-164"></a> try:

1383 +<a id="__codelineno-0-165" name="__codelineno-0-165"></a> response = self._send_request(f"{self.connector_url}/api/v1/workflows")

1384 +<a id="__codelineno-0-166" name="__codelineno-0-166"></a> response.raise_for_status()

1385 +<a id="__codelineno-0-167" name="__codelineno-0-167"></a> except requests.exceptions.HTTPError as err:

1386 +<a id="__codelineno-0-168" name="__codelineno-0-168"></a> return self._handle_request_error(err)

1387 +<a id="__codelineno-0-169" name="__codelineno-0-169"></a>

1388 +<a id="__codelineno-0-170" name="__codelineno-0-170"></a> workflows = response.json()

1389 +<a id="__codelineno-0-171" name="__codelineno-0-171"></a> workflow_details = []

1390 +<a id="__codelineno-0-172" name="__codelineno-0-172"></a> for workflow in workflows:

1391 +<a id="__codelineno-0-173" name="__codelineno-0-173"></a> workflow_details.append(

1392 +<a id="__codelineno-0-174" name="__codelineno-0-174"></a> {"workflow_id": workflow["id"], "workflow_name": workflow["name"]},

1393 +<a id="__codelineno-0-175" name="__codelineno-0-175"></a> )

1394 +<a id="__codelineno-0-176" name="__codelineno-0-176"></a>

1395 +<a id="__codelineno-0-177" name="__codelineno-0-177"></a> return {

1396 +<a id="__codelineno-0-178" name="__codelineno-0-178"></a> "message": "Successfully collected workflow details from Shuffle",

1397 +<a id="__codelineno-0-179" name="__codelineno-0-179"></a> "success": True,

1398 +<a id="__codelineno-0-180" name="__codelineno-0-180"></a> "workflows": workflow_details,

1399 +<a id="__codelineno-0-181" name="__codelineno-0-181"></a> }

1400 +<a id="__codelineno-0-182" name="__codelineno-0-182"></a>

1401 +<a id="__codelineno-0-183" name="__codelineno-0-183"></a> def collect_workflow_executions_status(self, workflow_id: str) -> Dict[str, object]:

1402 +<a id="__codelineno-0-184" name="__codelineno-0-184"></a> """

1403 +<a id="__codelineno-0-185" name="__codelineno-0-185"></a> Collects the execution status of a Shuffle Workflow by its ID.

1404 +<a id="__codelineno-0-186" name="__codelineno-0-186"></a>

1405 +<a id="__codelineno-0-187" name="__codelineno-0-187"></a> Returns:

1406 +<a id="__codelineno-0-188" name="__codelineno-0-188"></a> dict: A dictionary containing the success status, a message, and potentially the workflow execution status.

1407 +<a id="__codelineno-0-189" name="__codelineno-0-189"></a> """

1408 +<a id="__codelineno-0-190" name="__codelineno-0-190"></a> if not self._are_details_collected():

1409 +<a id="__codelineno-0-191" name="__codelineno-0-191"></a> return {

1410 +<a id="__codelineno-0-192" name="__codelineno-0-192"></a> "message": "Failed to collect Shuffle details",

1411 +<a id="__codelineno-0-193" name="__codelineno-0-193"></a> "success": False,

1412 +<a id="__codelineno-0-194" name="__codelineno-0-194"></a> }

1413 +<a id="__codelineno-0-195" name="__codelineno-0-195"></a>

1414 +<a id="__codelineno-0-196" name="__codelineno-0-196"></a> executions = self._collect_workflow_executions_status(workflow_id)

1415 +<a id="__codelineno-0-197" name="__codelineno-0-197"></a> if not executions["success"]:

1416 +<a id="__codelineno-0-198" name="__codelineno-0-198"></a> return executions

1417 +<a id="__codelineno-0-199" name="__codelineno-0-199"></a>

1418 +<a id="__codelineno-0-200" name="__codelineno-0-200"></a> return {

1419 +<a id="__codelineno-0-201" name="__codelineno-0-201"></a> "message": "Successfully collected workflow executions",

1420 +<a id="__codelineno-0-202" name="__codelineno-0-202"></a> "success": True,

1421 +<a id="__codelineno-0-203" name="__codelineno-0-203"></a> "executions": executions["executions"],

1422 +<a id="__codelineno-0-204" name="__codelineno-0-204"></a> }

1423 +<a id="__codelineno-0-205" name="__codelineno-0-205"></a>

1424 +<a id="__codelineno-0-206" name="__codelineno-0-206"></a> def _collect_workflow_executions_status(

1425 +<a id="__codelineno-0-207" name="__codelineno-0-207"></a> self,

1426 +<a id="__codelineno-0-208" name="__codelineno-0-208"></a> workflow_id: str,

1427 +<a id="__codelineno-0-209" name="__codelineno-0-209"></a> ) -> Dict[str, object]:

1428 +<a id="__codelineno-0-210" name="__codelineno-0-210"></a> """

1429 +<a id="__codelineno-0-211" name="__codelineno-0-211"></a> Collects the execution status of a Shuffle Workflow by its ID.

1430 +<a id="__codelineno-0-212" name="__codelineno-0-212"></a>

1431 +<a id="__codelineno-0-213" name="__codelineno-0-213"></a> Returns:

1432 +<a id="__codelineno-0-214" name="__codelineno-0-214"></a> dict: A dictionary containing the success status, a message, and potentially the workflow execution status.

1433 +<a id="__codelineno-0-215" name="__codelineno-0-215"></a> """

1434 +<a id="__codelineno-0-216" name="__codelineno-0-216"></a> try:

1435 +<a id="__codelineno-0-217" name="__codelineno-0-217"></a> response = self._send_request(

1436 +<a id="__codelineno-0-218" name="__codelineno-0-218"></a> f"{self.connector_url}/api/v1/workflows/{workflow_id}/executions",

1437 +<a id="__codelineno-0-219" name="__codelineno-0-219"></a> )

1438 +<a id="__codelineno-0-220" name="__codelineno-0-220"></a> response.raise_for_status()

1439 +<a id="__codelineno-0-221" name="__codelineno-0-221"></a> except requests.exceptions.HTTPError as err:

1440 +<a id="__codelineno-0-222" name="__codelineno-0-222"></a> return self._handle_request_error(err)

1441 +<a id="__codelineno-0-223" name="__codelineno-0-223"></a>

1442 +<a id="__codelineno-0-224" name="__codelineno-0-224"></a> executions = response.json()

1443 +<a id="__codelineno-0-225" name="__codelineno-0-225"></a> if executions:

1444 +<a id="__codelineno-0-226" name="__codelineno-0-226"></a> status = executions[0]["status"]

1445 +<a id="__codelineno-0-227" name="__codelineno-0-227"></a> if status is None:

1446 +<a id="__codelineno-0-228" name="__codelineno-0-228"></a> status = "Never Ran"

1447 +<a id="__codelineno-0-229" name="__codelineno-0-229"></a> else:

1448 +<a id="__codelineno-0-230" name="__codelineno-0-230"></a> logger.info(f"No Workflow Executions found from {self.connector_url}")

1449 +<a id="__codelineno-0-231" name="__codelineno-0-231"></a> status = None

1450 +<a id="__codelineno-0-232" name="__codelineno-0-232"></a>

1451 +<a id="__codelineno-0-233" name="__codelineno-0-233"></a> return {

1452 +<a id="__codelineno-0-234" name="__codelineno-0-234"></a> "message": "Successfully collected workflow executions from Shuffle",

1453 +<a id="__codelineno-0-235" name="__codelineno-0-235"></a> "success": True,

1454 +<a id="__codelineno-0-236" name="__codelineno-0-236"></a> "executions": status,

1455 +<a id="__codelineno-0-237" name="__codelineno-0-237"></a> }

1456 +</code></pre></div></td></tr></table></div>

1457 + </details>

1458 +

1459 +

1460 +

1461 + <div class="doc doc-children">

1462 +

1463 +

1464 +

1465 +

1466 +

1467 +

1468 +

1469 +

1470 +

1471 +<div class="doc doc-object doc-function">

1472 +

1473 +

1474 +

1475 +<h3 id="app.services.Shuffle.workflows.WorkflowsService.collect_workflow_details" class="doc doc-heading">

1476 +<code class="highlight language-python">collect_workflow_details()</code>

1477 +

1478 +</h3>

1479 +

1480 +

1481 + <div class="doc doc-contents ">

1482 +

1483 + Collects the workflow ID and workflow name from Shuffle.

1484 +

1485 + Returns:

1486 + <table>

1487 + <thead>

1488 + <tr>

1489 +<th>Name</th> <th>Type</th>

1490 + <th>Description</th>

1491 + </tr>

1492 + </thead>

1493 + <tbody>

1494 + <tr>

1495 +<td><code>dict</code></td> <td>

1496 + <code>Dict[str, object]</code>

1497 + </td>

1498 + <td>

1499 + <div class="doc-md-description">

1500 + A dictionary containing the success status, a message, and potentially the workflow IDs.

1501 + </div>

1502 + </td>

1503 + </tr>

1504 + </tbody>

1505 + </table>

1506 +

1507 + <details class="quote">

1508 + <summary>Source code in <code>app\services\Shuffle\workflows.py</code></summary>

1509 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-134">134</a>

1510 +<a href="#__codelineno-0-135">135</a>

1511 +<a href="#__codelineno-0-136">136</a>

1512 +<a href="#__codelineno-0-137">137</a>

1513 +<a href="#__codelineno-0-138">138</a>

1514 +<a href="#__codelineno-0-139">139</a>

1515 +<a href="#__codelineno-0-140">140</a>

1516 +<a href="#__codelineno-0-141">141</a>

1517 +<a href="#__codelineno-0-142">142</a>

1518 +<a href="#__codelineno-0-143">143</a>

1519 +<a href="#__codelineno-0-144">144</a>

1520 +<a href="#__codelineno-0-145">145</a>

1521 +<a href="#__codelineno-0-146">146</a>

1522 +<a href="#__codelineno-0-147">147</a>

1523 +<a href="#__codelineno-0-148">148</a>

1524 +<a href="#__codelineno-0-149">149</a>

1525 +<a href="#__codelineno-0-150">150</a>

1526 +<a href="#__codelineno-0-151">151</a>

1527 +<a href="#__codelineno-0-152">152</a>

1528 +<a href="#__codelineno-0-153">153</a>

1529 +<a href="#__codelineno-0-154">154</a>

1530 +<a href="#__codelineno-0-155">155</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-134" name="__codelineno-0-134"></a>def collect_workflow_details(self) -> Dict[str, object]:

1531 +<a id="__codelineno-0-135" name="__codelineno-0-135"></a> """

1532 +<a id="__codelineno-0-136" name="__codelineno-0-136"></a> Collects the workflow ID and workflow name from Shuffle.

1533 +<a id="__codelineno-0-137" name="__codelineno-0-137"></a>

1534 +<a id="__codelineno-0-138" name="__codelineno-0-138"></a> Returns:

1535 +<a id="__codelineno-0-139" name="__codelineno-0-139"></a> dict: A dictionary containing the success status, a message, and potentially the workflow IDs.

1536 +<a id="__codelineno-0-140" name="__codelineno-0-140"></a> """

1537 +<a id="__codelineno-0-141" name="__codelineno-0-141"></a> if not self._are_details_collected():

1538 +<a id="__codelineno-0-142" name="__codelineno-0-142"></a> return {

1539 +<a id="__codelineno-0-143" name="__codelineno-0-143"></a> "message": "Failed to collect Shuffle details",

1540 +<a id="__codelineno-0-144" name="__codelineno-0-144"></a> "success": False,

1541 +<a id="__codelineno-0-145" name="__codelineno-0-145"></a> }

1542 +<a id="__codelineno-0-146" name="__codelineno-0-146"></a>

1543 +<a id="__codelineno-0-147" name="__codelineno-0-147"></a> workflows = self._collect_workflow_details()

1544 +<a id="__codelineno-0-148" name="__codelineno-0-148"></a> if not workflows["success"]:

1545 +<a id="__codelineno-0-149" name="__codelineno-0-149"></a> return workflows

1546 +<a id="__codelineno-0-150" name="__codelineno-0-150"></a>

1547 +<a id="__codelineno-0-151" name="__codelineno-0-151"></a> return {

1548 +<a id="__codelineno-0-152" name="__codelineno-0-152"></a> "message": "Successfully collected workflow details",

1549 +<a id="__codelineno-0-153" name="__codelineno-0-153"></a> "success": True,

1550 +<a id="__codelineno-0-154" name="__codelineno-0-154"></a> "workflows": workflows["workflows"],

1551 +<a id="__codelineno-0-155" name="__codelineno-0-155"></a> }

1552 +</code></pre></div></td></tr></table></div>

1553 + </details>

1554 + </div>

1555 +

1556 +</div>

1557 +

1558 +<div class="doc doc-object doc-function">

1559 +

1560 +

1561 +

1562 +<h3 id="app.services.Shuffle.workflows.WorkflowsService.collect_workflow_executions_status" class="doc doc-heading">

1563 +<code class="highlight language-python">collect_workflow_executions_status(workflow_id)</code>

1564 +

1565 +</h3>

1566 +

1567 +

1568 + <div class="doc doc-contents ">

1569 +

1570 + Collects the execution status of a Shuffle Workflow by its ID.

1571 +

1572 + Returns:

1573 + <table>

1574 + <thead>

1575 + <tr>

1576 +<th>Name</th> <th>Type</th>

1577 + <th>Description</th>

1578 + </tr>

1579 + </thead>

1580 + <tbody>

1581 + <tr>

1582 +<td><code>dict</code></td> <td>

1583 + <code>Dict[str, object]</code>

1584 + </td>

1585 + <td>

1586 + <div class="doc-md-description">

1587 + A dictionary containing the success status, a message, and potentially the workflow execution status.

1588 + </div>

1589 + </td>

1590 + </tr>

1591 + </tbody>

1592 + </table>

1593 +

1594 + <details class="quote">

1595 + <summary>Source code in <code>app\services\Shuffle\workflows.py</code></summary>

1596 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-183">183</a>

1597 +<a href="#__codelineno-0-184">184</a>

1598 +<a href="#__codelineno-0-185">185</a>

1599 +<a href="#__codelineno-0-186">186</a>

1600 +<a href="#__codelineno-0-187">187</a>

1601 +<a href="#__codelineno-0-188">188</a>

1602 +<a href="#__codelineno-0-189">189</a>

1603 +<a href="#__codelineno-0-190">190</a>

1604 +<a href="#__codelineno-0-191">191</a>

1605 +<a href="#__codelineno-0-192">192</a>

1606 +<a href="#__codelineno-0-193">193</a>

1607 +<a href="#__codelineno-0-194">194</a>

1608 +<a href="#__codelineno-0-195">195</a>

1609 +<a href="#__codelineno-0-196">196</a>

1610 +<a href="#__codelineno-0-197">197</a>

1611 +<a href="#__codelineno-0-198">198</a>

1612 +<a href="#__codelineno-0-199">199</a>

1613 +<a href="#__codelineno-0-200">200</a>

1614 +<a href="#__codelineno-0-201">201</a>

1615 +<a href="#__codelineno-0-202">202</a>

1616 +<a href="#__codelineno-0-203">203</a>

1617 +<a href="#__codelineno-0-204">204</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-183" name="__codelineno-0-183"></a>def collect_workflow_executions_status(self, workflow_id: str) -> Dict[str, object]:

1618 +<a id="__codelineno-0-184" name="__codelineno-0-184"></a> """

1619 +<a id="__codelineno-0-185" name="__codelineno-0-185"></a> Collects the execution status of a Shuffle Workflow by its ID.

1620 +<a id="__codelineno-0-186" name="__codelineno-0-186"></a>

1621 +<a id="__codelineno-0-187" name="__codelineno-0-187"></a> Returns:

1622 +<a id="__codelineno-0-188" name="__codelineno-0-188"></a> dict: A dictionary containing the success status, a message, and potentially the workflow execution status.

1623 +<a id="__codelineno-0-189" name="__codelineno-0-189"></a> """

1624 +<a id="__codelineno-0-190" name="__codelineno-0-190"></a> if not self._are_details_collected():

1625 +<a id="__codelineno-0-191" name="__codelineno-0-191"></a> return {

1626 +<a id="__codelineno-0-192" name="__codelineno-0-192"></a> "message": "Failed to collect Shuffle details",

1627 +<a id="__codelineno-0-193" name="__codelineno-0-193"></a> "success": False,

1628 +<a id="__codelineno-0-194" name="__codelineno-0-194"></a> }

1629 +<a id="__codelineno-0-195" name="__codelineno-0-195"></a>

1630 +<a id="__codelineno-0-196" name="__codelineno-0-196"></a> executions = self._collect_workflow_executions_status(workflow_id)

1631 +<a id="__codelineno-0-197" name="__codelineno-0-197"></a> if not executions["success"]:

1632 +<a id="__codelineno-0-198" name="__codelineno-0-198"></a> return executions

1633 +<a id="__codelineno-0-199" name="__codelineno-0-199"></a>

1634 +<a id="__codelineno-0-200" name="__codelineno-0-200"></a> return {

1635 +<a id="__codelineno-0-201" name="__codelineno-0-201"></a> "message": "Successfully collected workflow executions",

1636 +<a id="__codelineno-0-202" name="__codelineno-0-202"></a> "success": True,

1637 +<a id="__codelineno-0-203" name="__codelineno-0-203"></a> "executions": executions["executions"],

1638 +<a id="__codelineno-0-204" name="__codelineno-0-204"></a> }

1639 +</code></pre></div></td></tr></table></div>

1640 + </details>

1641 + </div>

1642 +

1643 +</div>

1644 +

1645 +<div class="doc doc-object doc-function">

1646 +

1647 +

1648 +

1649 +<h3 id="app.services.Shuffle.workflows.WorkflowsService.collect_workflows" class="doc doc-heading">

1650 +<code class="highlight language-python">collect_workflows()</code>

1651 +

1652 +</h3>

1653 +

1654 +

1655 + <div class="doc doc-contents ">

1656 +

1657 + Collects the workflows from Shuffle.

1658 +

1659 + Returns:

1660 + <table>

1661 + <thead>

1662 + <tr>

1663 +<th>Name</th> <th>Type</th>

1664 + <th>Description</th>

1665 + </tr>

1666 + </thead>

1667 + <tbody>

1668 + <tr>

1669 +<td><code>dict</code></td> <td>

1670 + <code>Dict[str, object]</code>

1671 + </td>

1672 + <td>

1673 + <div class="doc-md-description">

1674 + A dictionary containing the success status, a message, and potentially the workflows.

1675 + </div>

1676 + </td>

1677 + </tr>

1678 + </tbody>

1679 + </table>

1680 +

1681 + <details class="quote">

1682 + <summary>Source code in <code>app\services\Shuffle\workflows.py</code></summary>

1683 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-76">76</a>

1684 +<a href="#__codelineno-0-77">77</a>

1685 +<a href="#__codelineno-0-78">78</a>

1686 +<a href="#__codelineno-0-79">79</a>

1687 +<a href="#__codelineno-0-80">80</a>

1688 +<a href="#__codelineno-0-81">81</a>

1689 +<a href="#__codelineno-0-82">82</a>

1690 +<a href="#__codelineno-0-83">83</a>

1691 +<a href="#__codelineno-0-84">84</a>

1692 +<a href="#__codelineno-0-85">85</a>

1693 +<a href="#__codelineno-0-86">86</a>

1694 +<a href="#__codelineno-0-87">87</a>

1695 +<a href="#__codelineno-0-88">88</a>

1696 +<a href="#__codelineno-0-89">89</a>

1697 +<a href="#__codelineno-0-90">90</a>

1698 +<a href="#__codelineno-0-91">91</a>

1699 +<a href="#__codelineno-0-92">92</a>

1700 +<a href="#__codelineno-0-93">93</a>

1701 +<a href="#__codelineno-0-94">94</a>

1702 +<a href="#__codelineno-0-95">95</a>

1703 +<a href="#__codelineno-0-96">96</a>

1704 +<a href="#__codelineno-0-97">97</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-76" name="__codelineno-0-76"></a>def collect_workflows(self) -> Dict[str, object]:

1705 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> """

1706 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> Collects the workflows from Shuffle.

1707 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a>

1708 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> Returns:

1709 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> dict: A dictionary containing the success status, a message, and potentially the workflows.

1710 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> """

1711 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> if not self._are_details_collected():

1712 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> return {

1713 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> "message": "Failed to collect Shuffle details",

1714 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> "success": False,

1715 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> }

1716 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a>

1717 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> workflows = self._collect_workflows()

1718 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> if not workflows["success"]:

1719 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> return workflows

1720 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a>

1721 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a> return {

1722 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> "message": "Successfully collected workflows",

1723 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> "success": True,

1724 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> "workflows": workflows["workflows"],

1725 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> }

1726 +</code></pre></div></td></tr></table></div>

1727 + </details>

1728 + </div>

1729 +

1730 +</div>

1731 +

1732 +

1733 +

1734 + </div>

1735 +

1736 + </div>

1737 +

1738 +</div>

1739 +

1740 +

1741 +

1742 +

1743 + </div>

1744 +

1745 + </div>

1746 +

1747 +</div>

1748 +<h3 id="universal-services">Universal Services</h3>

1749 +

1750 +

1751 +<div class="doc doc-object doc-module">

1752 +

1753 +

1754 +<a id="app.services.Shuffle.universal"></a>

1755 + <div class="doc doc-contents first">

1756 +

1757 +

1758 +

1759 + <div class="doc doc-children">

1760 +

1761 +

1762 +

1763 +

1764 +

1765 +

1766 +

1767 +

1768 +<div class="doc doc-object doc-class">

1769 +

1770 +

1771 +

1772 +<h2 id="app.services.Shuffle.universal.UniversalService" class="doc doc-heading">

1773 + <code>UniversalService</code>

1774 +

1775 +

1776 +</h2>

1777 +

1778 +

1779 + <div class="doc doc-contents ">

1780 +

1781 +

1782 + A service class that encapsulates the logic for polling messages from Shuffle.

1783 +

1784 +

1785 + <details class="quote">

1786 + <summary>Source code in <code>app\services\Shuffle\universal.py</code></summary>

1787 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-17">17</a>

1788 +<a href="#__codelineno-0-18">18</a>

1789 +<a href="#__codelineno-0-19">19</a>

1790 +<a href="#__codelineno-0-20">20</a>

1791 +<a href="#__codelineno-0-21">21</a>

1792 +<a href="#__codelineno-0-22">22</a>

1793 +<a href="#__codelineno-0-23">23</a>

1794 +<a href="#__codelineno-0-24">24</a>

1795 +<a href="#__codelineno-0-25">25</a>

1796 +<a href="#__codelineno-0-26">26</a>

1797 +<a href="#__codelineno-0-27">27</a>

1798 +<a href="#__codelineno-0-28">28</a>

1799 +<a href="#__codelineno-0-29">29</a>

1800 +<a href="#__codelineno-0-30">30</a>

1801 +<a href="#__codelineno-0-31">31</a>

1802 +<a href="#__codelineno-0-32">32</a>

1803 +<a href="#__codelineno-0-33">33</a>

1804 +<a href="#__codelineno-0-34">34</a>

1805 +<a href="#__codelineno-0-35">35</a>

1806 +<a href="#__codelineno-0-36">36</a>

1807 +<a href="#__codelineno-0-37">37</a>

1808 +<a href="#__codelineno-0-38">38</a>

1809 +<a href="#__codelineno-0-39">39</a>

1810 +<a href="#__codelineno-0-40">40</a>

1811 +<a href="#__codelineno-0-41">41</a>

1812 +<a href="#__codelineno-0-42">42</a>

1813 +<a href="#__codelineno-0-43">43</a>

1814 +<a href="#__codelineno-0-44">44</a>

1815 +<a href="#__codelineno-0-45">45</a>

1816 +<a href="#__codelineno-0-46">46</a>

1817 +<a href="#__codelineno-0-47">47</a>

1818 +<a href="#__codelineno-0-48">48</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-17" name="__codelineno-0-17"></a>class UniversalService:

1819 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> """

1820 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> A service class that encapsulates the logic for polling messages from Shuffle.

1821 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> """

1822 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a>

1823 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> def __init__(self) -> None:

1824 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> self.collect_shuffle_details("Shuffle")

1825 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> (

1826 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> self.connector_url,

1827 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> self.connector_api_key,

1828 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> ) = self.collect_shuffle_details("Shuffle")

1829 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a>

1830 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> def collect_shuffle_details(self, connector_name: str):

1831 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> """

1832 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> Collects the details of the Shuffle connector.

1833 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a>

1834 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> Args:

1835 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> connector_name (str): The name of the Shuffle connector.

1836 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a>

1837 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> Returns:

1838 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> tuple: A tuple containing the connection URL, and api key.

1839 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> """

1840 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> connector_instance = connector_factory.create(connector_name, connector_name)

1841 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> connection_successful = connector_instance.verify_connection()

1842 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> if connection_successful:

1843 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> connection_details = Connector.get_connector_info_from_db(connector_name)

1844 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> return (

1845 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> connection_details.get("connector_url"),

1846 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> connection_details.get("connector_api_key"),

1847 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> )

1848 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> else:

1849 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> return None, None

1850 +</code></pre></div></td></tr></table></div>

1851 + </details>

1852 +

1853 +

1854 +

1855 + <div class="doc doc-children">

1856 +

1857 +

1858 +

1859 +

1860 +

1861 +

1862 +

1863 +

1864 +

1865 +<div class="doc doc-object doc-function">

1866 +

1867 +

1868 +

1869 +<h3 id="app.services.Shuffle.universal.UniversalService.collect_shuffle_details" class="doc doc-heading">

1870 +<code class="highlight language-python">collect_shuffle_details(connector_name)</code>

1871 +

1872 +</h3>

1873 +

1874 +

1875 + <div class="doc doc-contents ">

1876 +

1877 + Collects the details of the Shuffle connector.

1878 +

1879 + Parameters:

1880 + <table>

1881 + <thead>

1882 + <tr>

1883 + <th>Name</th>

1884 + <th>Type</th>

1885 + <th>Description</th>

1886 + <th>Default</th>

1887 + </tr>

1888 + </thead>

1889 + <tbody>

1890 + <tr>

1891 + <td><code>connector_name</code></td>

1892 + <td>

1893 + <code>str</code>

1894 + </td>

1895 + <td>

1896 + <div class="doc-md-description">

1897 + The name of the Shuffle connector.

1898 + </div>

1899 + </td>

1900 + <td>

1901 + required

1902 + </td>

1903 + </tr>

1904 + </tbody>

1905 + </table>

1906 +

1907 + Returns:

1908 + <table>

1909 + <thead>

1910 + <tr>

1911 +<th>Name</th> <th>Type</th>

1912 + <th>Description</th>

1913 + </tr>

1914 + </thead>

1915 + <tbody>

1916 + <tr>

1917 +<td><code>tuple</code></td> <td>

1918 + </td>

1919 + <td>

1920 + <div class="doc-md-description">

1921 + A tuple containing the connection URL, and api key.

1922 + </div>

1923 + </td>

1924 + </tr>

1925 + </tbody>

1926 + </table>

1927 +

1928 + <details class="quote">

1929 + <summary>Source code in <code>app\services\Shuffle\universal.py</code></summary>

1930 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-29">29</a>

1931 +<a href="#__codelineno-0-30">30</a>

1932 +<a href="#__codelineno-0-31">31</a>

1933 +<a href="#__codelineno-0-32">32</a>

1934 +<a href="#__codelineno-0-33">33</a>

1935 +<a href="#__codelineno-0-34">34</a>

1936 +<a href="#__codelineno-0-35">35</a>

1937 +<a href="#__codelineno-0-36">36</a>

1938 +<a href="#__codelineno-0-37">37</a>

1939 +<a href="#__codelineno-0-38">38</a>

1940 +<a href="#__codelineno-0-39">39</a>

1941 +<a href="#__codelineno-0-40">40</a>

1942 +<a href="#__codelineno-0-41">41</a>

1943 +<a href="#__codelineno-0-42">42</a>

1944 +<a href="#__codelineno-0-43">43</a>

1945 +<a href="#__codelineno-0-44">44</a>

1946 +<a href="#__codelineno-0-45">45</a>

1947 +<a href="#__codelineno-0-46">46</a>

1948 +<a href="#__codelineno-0-47">47</a>

1949 +<a href="#__codelineno-0-48">48</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-29" name="__codelineno-0-29"></a>def collect_shuffle_details(self, connector_name: str):

1950 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> """

1951 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> Collects the details of the Shuffle connector.

1952 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a>

1953 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> Args:

1954 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> connector_name (str): The name of the Shuffle connector.

1955 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a>

1956 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> Returns:

1957 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> tuple: A tuple containing the connection URL, and api key.

1958 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> """

1959 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> connector_instance = connector_factory.create(connector_name, connector_name)

1960 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> connection_successful = connector_instance.verify_connection()

1961 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> if connection_successful:

1962 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> connection_details = Connector.get_connector_info_from_db(connector_name)

1963 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> return (

1964 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> connection_details.get("connector_url"),

1965 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> connection_details.get("connector_api_key"),

1966 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> )

1967 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> else:

1968 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> return None, None

1969 +</code></pre></div></td></tr></table></div>

1970 + </details>

1971 + </div>

1972 +

1973 +</div>

1974 +

1975 +

1976 +

1977 + </div>

1978 +

1979 + </div>

1980 +

1981 +</div>

1982 +

1983 +

1984 +

1985 +

1986 + </div>

1987 +

1988 + </div>

1989 +

1990 +</div>

1991 +

1992 +

1993 +

1994 +

1995 +

1996 +

1997 + </article>

1998 + </div>

1999 +

2000 +

2001 + <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>

2002 +

2003 + </div>

2004 +

2005 + <button type="button" class="md-top md-icon" data-md-component="top" hidden>

2006 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg>

2007 + Back to top

2008 + </button>

2009 +

2010 + </main>

2011 +

2012 + <footer class="md-footer">

2013 +

2014 + <div class="md-footer-meta md-typeset">

2015 + <div class="md-footer-meta__inner md-grid">

2016 + <div class="md-copyright">

2017 +

2018 + <div class="md-copyright__highlight">

2020 +

2021 + </div>

2022 +

2023 +

2024 + Made with

2025 + <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">

2026 + Material for MkDocs

2027 + </a>

2028 +

2029 +</div>

2030 +

2031 + </div>

2032 + </div>

2033 +</footer>

2034 +

2035 + </div>

2036 + <div class="md-dialog" data-md-component="dialog">

2037 + <div class="md-dialog__inner md-typeset"></div>

2038 + </div>

2039 +

2040 + <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.sections", "toc.integrate", "navigation.top", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy"], "search": "../assets/javascripts/workers/search.74e28a9f.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>

2041 +

2042 +

2043 + <script src="../assets/javascripts/bundle.220ee61c.min.js"></script>

2044 +

2045 +

2046 + </body>

2047 +</html>

\ No newline at end of file

backend/site/sitemap.xml.gz

Binary files a/backend/site/sitemap.xml.gz and b/backend/site/sitemap.xml.gz differ

backend/site/velociraptor/index.html renamed

+84 -57

@@ -9,17 +9,17 @@

12 - <link rel="prev" href="../alerts/">

12 + <link rel="prev" href="../wazuhmanager/">

15 - <link rel="next" href="../cases/">

15 + <link rel="next" href="../shuffle/">

17 <link rel="icon" href="../assets/images/favicon.png">

18 <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18">

22 - <title>Artifacts - SOCFortress CoPilot</title>

22 + <title>Velociraptor - SOCFortress CoPilot</title>

@@ -73,7 +73,7 @@

73 <div data-md-component="skip">

76 - <a href="#artifacts-overview" class="md-skip">

76 + <a href="#velociraptor-overview" class="md-skip">

77 Skip to content

78 </a>

@@ -106,7 +106,7 @@

106 <div class="md-header__topic" data-md-component="header-topic">

107

108

109 - Artifacts

109 + Velociraptor

110

111

112 </div>

@@ -198,8 +198,8 @@

198

199

200 <li class="md-tabs__item">

201 - <a href="../alerts/" class="md-tabs__link">

202 - Alerts

201 + <a href="../wazuhindexer/" class="md-tabs__link">

202 + Wazuh-Indexer

203 </a>

204 </li>

205

@@ -207,13 +207,23 @@

207

208

209

210 -

210 +

211 +

212 + <li class="md-tabs__item">

213 + <a href="../dfiriris/" class="md-tabs__link">

214 + Dfir-Iris

215 + </a>

216 + </li>

217 +

218 +

219 +

220 +

221

222

223

224 <li class="md-tabs__item">

215 - <a href="./" class="md-tabs__link md-tabs__link--active">

216 - Artifacts

225 + <a href="../graylog/" class="md-tabs__link">

226 + Graylog

227 </a>

228 </li>

229

@@ -224,8 +234,8 @@

234

235

236 <li class="md-tabs__item">

227 - <a href="../cases/" class="md-tabs__link">

228 - Cases

237 + <a href="../wazuhmanager/" class="md-tabs__link">

238 + Wazuh-Manager

239 </a>

240 </li>

241

@@ -233,11 +243,13 @@

243

244

245

246 +

247 +

248

249

250 <li class="md-tabs__item">

239 - <a href="../graylog/" class="md-tabs__link">

240 - Graylog

251 + <a href="./" class="md-tabs__link md-tabs__link--active">

252 + Velociraptor

253 </a>

254 </li>

255

@@ -248,8 +260,8 @@

260

261

262 <li class="md-tabs__item">

251 - <a href="../wazuhmanager/" class="md-tabs__link">

252 - Wazuh-Manager

263 + <a href="../shuffle/" class="md-tabs__link">

264 + Shuffle

265 </a>

266 </li>

267

@@ -341,8 +353,53 @@

353

354

355 <li class="md-nav__item">

344 - <a href="../alerts/" class="md-nav__link">

345 - Alerts

356 + <a href="../wazuhindexer/" class="md-nav__link">

357 + Wazuh-Indexer

358 + </a>

359 + </li>

360 +

361 +

362 +

363 +

364 +

365 +

366 +

367 +

368 +

369 +

370 + <li class="md-nav__item">

371 + <a href="../dfiriris/" class="md-nav__link">

372 + Dfir-Iris

373 + </a>

374 + </li>

375 +

376 +

377 +

378 +

379 +

380 +

381 +

382 +

383 +

384 +

385 + <li class="md-nav__item">

386 + <a href="../graylog/" class="md-nav__link">

387 + Graylog

388 + </a>

389 + </li>

390 +

391 +

392 +

393 +

394 +

395 +

396 +

397 +

398 +

399 +

400 + <li class="md-nav__item">

401 + <a href="../wazuhmanager/" class="md-nav__link">

402 + Wazuh-Manager

403 </a>

404 </li>

405

@@ -364,12 +421,12 @@

421

422

423 <label class="md-nav__link md-nav__link--active" for="__toc">

367 - Artifacts

424 + Velociraptor

425

426 </label>

427

428 <a href="./" class="md-nav__link md-nav__link--active">

372 - Artifacts

429 + Velociraptor

430 </a>

431

432

@@ -386,11 +443,11 @@

443 <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

444

445 <li class="md-nav__item">

389 - <a href="#artifacts-overview" class="md-nav__link">

390 - Artifacts Overview

446 + <a href="#velociraptor-overview" class="md-nav__link">

447 + Velociraptor Overview

448 </a>

449

393 - <nav class="md-nav" aria-label="Artifacts Overview">

450 + <nav class="md-nav" aria-label="Velociraptor Overview">

451 <ul class="md-nav__list">

452

453 <li class="md-nav__item">

@@ -599,38 +656,8 @@

656

657

658 <li class="md-nav__item">

602 - <a href="../cases/" class="md-nav__link">

603 - Cases

604 - </a>

605 - </li>

606 -

607 -

608 -

609 -

610 -

611 -

612 -

613 -

614 -

615 -

616 - <li class="md-nav__item">

617 - <a href="../graylog/" class="md-nav__link">

618 - Graylog

619 - </a>

620 - </li>

621 -

622 -

623 -

624 -

625 -

626 -

627 -

628 -

629 -

630 -

631 - <li class="md-nav__item">

632 - <a href="../wazuhmanager/" class="md-nav__link">

633 - Wazuh-Manager

659 + <a href="../shuffle/" class="md-nav__link">

660 + Shuffle

661 </a>

662 </li>

663

@@ -651,9 +678,9 @@

678

679

680

654 - <h1>Artifacts</h1>

681 + <h1>Velociraptor</h1>

682

656 -<h2 id="artifacts-overview">Artifacts Overview</h2>

683 +<h2 id="velociraptor-overview">Velociraptor Overview</h2>

684 <h3 id="artifacts-model">Artifacts Model</h3>

685

686

backend/site/wazuhindexer/index.html new

+3568

@@ -0,0 +1,3568 @@

1 +

2 +<!doctype html>

3 +<html lang="en" class="no-js">

4 + <head>

5 +

6 + <meta charset="utf-8">

7 + <meta name="viewport" content="width=device-width,initial-scale=1">

8 +

9 +

10 +

11 +

12 + <link rel="prev" href="../agents/">

13 +

14 +

15 + <link rel="next" href="../dfiriris/">

16 +

17 + <link rel="icon" href="../assets/images/favicon.png">

18 + <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18">

19 +

20 +

21 +

22 + <title>Wazuh-Indexer - SOCFortress CoPilot</title>

23 +

24 +

25 +

26 + <link rel="stylesheet" href="../assets/stylesheets/main.26e3688c.min.css">

27 +

28 +

29 + <link rel="stylesheet" href="../assets/stylesheets/palette.ecc896b0.min.css">

30 +

31 +

32 +

33 +

34 +

35 +

36 +

37 +

38 +

39 + <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>

40 + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">

41 + <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>

42 +

43 +

44 +

45 + <link rel="stylesheet" href="../assets/_mkdocstrings.css">

46 +

48 +

49 +

50 +

51 +

52 +

53 +

54 + </head>

55 +

56 +

57 +

58 +

59 +

60 +

61 +

62 +

63 +

64 + <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="purple">

65 +

66 +

67 +

69 +

70 + <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">

71 + <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">

72 + <label class="md-overlay" for="__drawer"></label>

73 + <div data-md-component="skip">

74 +

75 +

76 + <a href="#wazuh-indexer-overview" class="md-skip">

77 + Skip to content

78 + </a>

79 +

80 + </div>

81 + <div data-md-component="announce">

82 +

83 + </div>

84 +

85 +

86 +

87 +

88 +<header class="md-header" data-md-component="header">

89 + <nav class="md-header__inner md-grid" aria-label="Header">

90 + <a href=".." title="SOCFortress CoPilot" class="md-header__button md-logo" aria-label="SOCFortress CoPilot" data-md-component="logo">

91 +

92 +

94 +

95 + </a>

96 + <label class="md-header__button md-icon" for="__drawer">

97 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>

98 + </label>

99 + <div class="md-header__title" data-md-component="header-title">

100 + <div class="md-header__ellipsis">

101 + <div class="md-header__topic">

102 +

103 + SOCFortress CoPilot

104 +

105 + </div>

106 + <div class="md-header__topic" data-md-component="header-topic">

107 +

108 +

109 + Wazuh-Indexer

110 +

111 +

112 + </div>

113 + </div>

114 + </div>

115 +

116 +

117 + <form class="md-header__option" data-md-component="palette">

118 +

119 +

120 +

121 +

123 +

124 + <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>

126 + </label>

127 +

128 +

129 +

130 +

131 +

133 +

134 + <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>

136 + </label>

137 +

138 +

139 + </form>

140 +

141 +

142 +

143 +

144 +

145 + </nav>

146 +

147 +</header>

148 +

149 + <div class="md-container" data-md-component="container">

150 +

151 +

152 +

153 +

154 +

155 +<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">

156 + <div class="md-grid">

157 + <ul class="md-tabs__list">

158 +

159 +

160 +

161 +

162 +

163 +

164 + <li class="md-tabs__item">

165 + <a href=".." class="md-tabs__link">

166 + Home

167 + </a>

168 + </li>

169 +

170 +

171 +

172 +

173 +

174 +

175 +

176 + <li class="md-tabs__item">

177 + <a href="../connectors/" class="md-tabs__link">

178 + Connectors

179 + </a>

180 + </li>

181 +

182 +

183 +

184 +

185 +

186 +

187 +

188 + <li class="md-tabs__item">

189 + <a href="../agents/" class="md-tabs__link">

190 + Agents

191 + </a>

192 + </li>

193 +

194 +

195 +

196 +

197 +

198 +

199 +

200 +

201 +

202 + <li class="md-tabs__item">

203 + <a href="./" class="md-tabs__link md-tabs__link--active">

204 + Wazuh-Indexer

205 + </a>

206 + </li>

207 +

208 +

209 +

210 +

211 +

212 +

213 +

214 + <li class="md-tabs__item">

215 + <a href="../dfiriris/" class="md-tabs__link">

216 + Dfir-Iris

217 + </a>

218 + </li>

219 +

220 +

221 +

222 +

223 +

224 +

225 +

226 + <li class="md-tabs__item">

227 + <a href="../graylog/" class="md-tabs__link">

228 + Graylog

229 + </a>

230 + </li>

231 +

232 +

233 +

234 +

235 +

236 +

237 +

238 + <li class="md-tabs__item">

239 + <a href="../wazuhmanager/" class="md-tabs__link">

240 + Wazuh-Manager

241 + </a>

242 + </li>

243 +

244 +

245 +

246 +

247 +

248 +

249 +

250 + <li class="md-tabs__item">

251 + <a href="../velociraptor/" class="md-tabs__link">

252 + Velociraptor

253 + </a>

254 + </li>

255 +

256 +

257 +

258 +

259 +

260 +

261 +

262 + <li class="md-tabs__item">

263 + <a href="../shuffle/" class="md-tabs__link">

264 + Shuffle

265 + </a>

266 + </li>

267 +

268 +

269 + </ul>

270 + </div>

271 +</nav>

272 +

273 +

274 +

275 + <main class="md-main" data-md-component="main">

276 + <div class="md-main__inner md-grid">

277 +

278 +

279 +

280 + <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >

281 + <div class="md-sidebar__scrollwrap">

282 + <div class="md-sidebar__inner">

283 +

284 +

285 +

286 +

287 +

288 +

289 +

290 +<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">

291 + <label class="md-nav__title" for="__drawer">

292 + <a href=".." title="SOCFortress CoPilot" class="md-nav__button md-logo" aria-label="SOCFortress CoPilot" data-md-component="logo">

293 +

294 +

296 +

297 + </a>

298 + SOCFortress CoPilot

299 + </label>

300 +

301 + <ul class="md-nav__list" data-md-scrollfix>

302 +

303 +

304 +

305 +

306 +

307 +

308 +

309 +

310 + <li class="md-nav__item">

311 + <a href=".." class="md-nav__link">

312 + Home

313 + </a>

314 + </li>

315 +

316 +

317 +

318 +

319 +

320 +

321 +

322 +

323 +

324 +

325 + <li class="md-nav__item">

326 + <a href="../connectors/" class="md-nav__link">

327 + Connectors

328 + </a>

329 + </li>

330 +

331 +

332 +

333 +

334 +

335 +

336 +

337 +

338 +

339 +

340 + <li class="md-nav__item">

341 + <a href="../agents/" class="md-nav__link">

342 + Agents

343 + </a>

344 + </li>

345 +

346 +

347 +

348 +

349 +

350 +

351 +

352 +

353 +

354 +

355 +

356 +

357 + <li class="md-nav__item md-nav__item--active">

358 +

359 + <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">

360 +

361 +

362 +

363 + <label class="md-nav__link md-nav__link--active" for="__toc">

364 + Wazuh-Indexer

365 +

366 + </label>

367 +

368 + <a href="./" class="md-nav__link md-nav__link--active">

369 + Wazuh-Indexer

370 + </a>

371 +

372 +

373 +

374 +<nav class="md-nav md-nav--secondary" aria-label="Table of contents">

375 +

376 +

377 +

378 +

379 + <label class="md-nav__title" for="__toc">

380 +

381 + Table of contents

382 + </label>

383 + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

384 +

385 + <li class="md-nav__item">

386 + <a href="#wazuh-indexer-overview" class="md-nav__link">

387 + Wazuh-Indexer Overview

388 + </a>

389 +

390 + <nav class="md-nav" aria-label="Wazuh-Indexer Overview">

391 + <ul class="md-nav__list">

392 +

393 + <li class="md-nav__item">

394 + <a href="#alert-routes" class="md-nav__link">

395 + Alert Routes

396 + </a>

397 +

398 +</li>

399 +

400 + </ul>

401 + </nav>

402 +

403 +</li>

404 +

405 + <li class="md-nav__item">

406 + <a href="#app.routes.alerts" class="md-nav__link">

407 + app.routes.alerts

408 + </a>

409 +

410 +</li>

411 +

412 + <li class="md-nav__item">

413 + <a href="#app.routes.alerts.get_alerts" class="md-nav__link">

414 + get_alerts()

415 + </a>

416 +

417 + <nav class="md-nav" aria-label="get_alerts()">

418 + <ul class="md-nav__list">

419 +

420 + <li class="md-nav__item">

421 + <a href="#wazuh-indexer-routes" class="md-nav__link">

422 + Wazuh-Indexer Routes

423 + </a>

424 +

425 +</li>

426 +

427 + </ul>

428 + </nav>

429 +

430 +</li>

431 +

432 + <li class="md-nav__item">

433 + <a href="#app.routes.wazuhindexer" class="md-nav__link">

434 + app.routes.wazuhindexer

435 + </a>

436 +

437 +</li>

438 +

439 + <li class="md-nav__item">

440 + <a href="#app.routes.wazuhindexer.get_cluster_health" class="md-nav__link">

441 + get_cluster_health()

442 + </a>

443 +

444 +</li>

445 +

446 + <li class="md-nav__item">

447 + <a href="#app.routes.wazuhindexer.get_indices_summary" class="md-nav__link">

448 + get_indices_summary()

449 + </a>

450 +

451 +</li>

452 +

453 + <li class="md-nav__item">

454 + <a href="#app.routes.wazuhindexer.get_node_allocation" class="md-nav__link">

455 + get_node_allocation()

456 + </a>

457 +

458 +</li>

459 +

460 + <li class="md-nav__item">

461 + <a href="#app.routes.wazuhindexer.get_shards" class="md-nav__link">

462 + get_shards()

463 + </a>

464 +

465 + <nav class="md-nav" aria-label="get_shards()">

466 + <ul class="md-nav__list">

467 +

468 + <li class="md-nav__item">

469 + <a href="#alert-services" class="md-nav__link">

470 + Alert Services

471 + </a>

472 +

473 +</li>

474 +

475 + </ul>

476 + </nav>

477 +

478 +</li>

479 +

480 + <li class="md-nav__item">

481 + <a href="#app.services.WazuhIndexer.alerts" class="md-nav__link">

482 + app.services.WazuhIndexer.alerts

483 + </a>

484 +

485 +</li>

486 +

487 + <li class="md-nav__item">

488 + <a href="#app.services.WazuhIndexer.alerts.AlertsService" class="md-nav__link">

489 + AlertsService

490 + </a>

491 +

492 + <nav class="md-nav" aria-label="AlertsService">

493 + <ul class="md-nav__list">

494 +

495 + <li class="md-nav__item">

496 + <a href="#app.services.WazuhIndexer.alerts.AlertsService.__init__" class="md-nav__link">

497 + __init__()

498 + </a>

499 +

500 +</li>

501 +

502 + <li class="md-nav__item">

503 + <a href="#app.services.WazuhIndexer.alerts.AlertsService.collect_alerts" class="md-nav__link">

504 + collect_alerts()

505 + </a>

506 +

507 +</li>

508 +

509 + <li class="md-nav__item">

510 + <a href="#app.services.WazuhIndexer.alerts.AlertsService.is_index_skipped" class="md-nav__link">

511 + is_index_skipped()

512 + </a>

513 +

514 +</li>

515 +

516 + <li class="md-nav__item">

517 + <a href="#cluster-services" class="md-nav__link">

518 + Cluster Services

519 + </a>

520 +

521 +</li>

522 +

523 + </ul>

524 + </nav>

525 +

526 +</li>

527 +

528 + <li class="md-nav__item">

529 + <a href="#app.services.WazuhIndexer.cluster" class="md-nav__link">

530 + app.services.WazuhIndexer.cluster

531 + </a>

532 +

533 +</li>

534 +

535 + <li class="md-nav__item">

536 + <a href="#app.services.WazuhIndexer.cluster.ClusterService" class="md-nav__link">

537 + ClusterService

538 + </a>

539 +

540 + <nav class="md-nav" aria-label="ClusterService">

541 + <ul class="md-nav__list">

542 +

543 + <li class="md-nav__item">

544 + <a href="#app.services.WazuhIndexer.cluster.ClusterService.__init__" class="md-nav__link">

545 + __init__()

546 + </a>

547 +

548 +</li>

549 +

550 + <li class="md-nav__item">

551 + <a href="#app.services.WazuhIndexer.cluster.ClusterService.collect_cluster_health" class="md-nav__link">

552 + collect_cluster_health()

553 + </a>

554 +

555 +</li>

556 +

557 + <li class="md-nav__item">

558 + <a href="#app.services.WazuhIndexer.cluster.ClusterService.collect_node_allocation" class="md-nav__link">

559 + collect_node_allocation()

560 + </a>

561 +

562 +</li>

563 +

564 + <li class="md-nav__item">

565 + <a href="#app.services.WazuhIndexer.cluster.ClusterService.collect_shards" class="md-nav__link">

566 + collect_shards()

567 + </a>

568 +

569 +</li>

570 +

571 + <li class="md-nav__item">

572 + <a href="#index-services" class="md-nav__link">

573 + Index Services

574 + </a>

575 +

576 +</li>

577 +

578 + </ul>

579 + </nav>

580 +

581 +</li>

582 +

583 + <li class="md-nav__item">

584 + <a href="#app.services.WazuhIndexer.index" class="md-nav__link">

585 + app.services.WazuhIndexer.index

586 + </a>

587 +

588 +</li>

589 +

590 + <li class="md-nav__item">

591 + <a href="#app.services.WazuhIndexer.index.IndexService" class="md-nav__link">

592 + IndexService

593 + </a>

594 +

595 + <nav class="md-nav" aria-label="IndexService">

596 + <ul class="md-nav__list">

597 +

598 + <li class="md-nav__item">

599 + <a href="#app.services.WazuhIndexer.index.IndexService.__init__" class="md-nav__link">

600 + __init__()

601 + </a>

602 +

603 +</li>

604 +

605 + <li class="md-nav__item">

606 + <a href="#app.services.WazuhIndexer.index.IndexService.collect_indices_summary" class="md-nav__link">

607 + collect_indices_summary()

608 + </a>

609 +

610 +</li>

611 +

612 + <li class="md-nav__item">

613 + <a href="#universal-services" class="md-nav__link">

614 + Universal Services

615 + </a>

616 +

617 +</li>

618 +

619 + </ul>

620 + </nav>

621 +

622 +</li>

623 +

624 + <li class="md-nav__item">

625 + <a href="#app.services.WazuhIndexer.universal" class="md-nav__link">

626 + app.services.WazuhIndexer.universal

627 + </a>

628 +

629 +</li>

630 +

631 + <li class="md-nav__item">

632 + <a href="#app.services.WazuhIndexer.universal.UniversalService" class="md-nav__link">

633 + UniversalService

634 + </a>

635 +

636 + <nav class="md-nav" aria-label="UniversalService">

637 + <ul class="md-nav__list">

638 +

639 + <li class="md-nav__item">

640 + <a href="#app.services.WazuhIndexer.universal.UniversalService.collect_indices" class="md-nav__link">

641 + collect_indices()

642 + </a>

643 +

644 +</li>

645 +

646 + <li class="md-nav__item">

647 + <a href="#app.services.WazuhIndexer.universal.UniversalService.collect_wazuhindexer_details" class="md-nav__link">

648 + collect_wazuhindexer_details()

649 + </a>

650 +

651 +</li>

652 +

653 + </ul>

654 + </nav>

655 +

656 +</li>

657 +

658 + </ul>

659 +

660 +</nav>

661 +

662 + </li>

663 +

664 +

665 +

666 +

667 +

668 +

669 +

670 +

671 +

672 +

673 + <li class="md-nav__item">

674 + <a href="../dfiriris/" class="md-nav__link">

675 + Dfir-Iris

676 + </a>

677 + </li>

678 +

679 +

680 +

681 +

682 +

683 +

684 +

685 +

686 +

687 +

688 + <li class="md-nav__item">

689 + <a href="../graylog/" class="md-nav__link">

690 + Graylog

691 + </a>

692 + </li>

693 +

694 +

695 +

696 +

697 +

698 +

699 +

700 +

701 +

702 +

703 + <li class="md-nav__item">

704 + <a href="../wazuhmanager/" class="md-nav__link">

705 + Wazuh-Manager

706 + </a>

707 + </li>

708 +

709 +

710 +

711 +

712 +

713 +

714 +

715 +

716 +

717 +

718 + <li class="md-nav__item">

719 + <a href="../velociraptor/" class="md-nav__link">

720 + Velociraptor

721 + </a>

722 + </li>

723 +

724 +

725 +

726 +

727 +

728 +

729 +

730 +

731 +

732 +

733 + <li class="md-nav__item">

734 + <a href="../shuffle/" class="md-nav__link">

735 + Shuffle

736 + </a>

737 + </li>

738 +

739 +

740 +

741 + </ul>

742 +</nav>

743 + </div>

744 + </div>

745 + </div>

746 +

747 +

748 +

749 +

750 + <div class="md-content" data-md-component="content">

751 + <article class="md-content__inner md-typeset">

752 +

753 +

754 +

755 +

756 + <h1>Wazuh-Indexer</h1>

757 +

758 +<h2 id="wazuh-indexer-overview">Wazuh-Indexer Overview</h2>

759 +<h3 id="alert-routes">Alert Routes</h3>

760 +

761 +

762 +<div class="doc doc-object doc-module">

763 +

764 +

765 +<a id="app.routes.alerts"></a>

766 + <div class="doc doc-contents first">

767 +

768 +

769 +

770 + <div class="doc doc-children">

771 +

772 +

773 +

774 +

775 +

776 +

777 +

778 +

779 +

780 +<div class="doc doc-object doc-function">

781 +

782 +

783 +

784 +<h2 id="app.routes.alerts.get_alerts" class="doc doc-heading">

785 +<code class="highlight language-python">get_alerts()</code>

786 +

787 +</h2>

788 +

789 +

790 + <div class="doc doc-contents ">

791 +

792 + Retrieves all alerts from the AlertsService.

793 +This endpoint retrieves all available alerts from the AlertsService. It does this by creating an instance of

794 +the AlertsService class and calling its <code>collect_alerts</code> method. The result is a list of all alerts currently

795 +available.

796 +

797 + Returns:

798 + <table>

799 + <thead>

800 + <tr>

801 +<th>Name</th> <th>Type</th>

802 + <th>Description</th>

803 + </tr>

804 + </thead>

805 + <tbody>

806 + <tr>

807 +<td><code>jsonify</code></td> <td>

808 + <code>jsonify</code>

809 + </td>

810 + <td>

811 + <div class="doc-md-description">

812 + A JSON response containing a list of alerts. Each item in the list is a dictionary representing an alert,

813 + </div>

814 + </td>

815 + </tr>

816 + <tr>

817 +<td></td> <td>

818 + <code>jsonify</code>

819 + </td>

820 + <td>

821 + <div class="doc-md-description">

822 + containing all its associated data.

823 + </div>

824 + </td>

825 + </tr>

826 + </tbody>

827 + </table>

828 +

829 + <details class="quote">

830 + <summary>Source code in <code>app\routes\alerts.py</code></summary>

831 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-9"> 9</a>

832 +<a href="#__codelineno-0-10">10</a>

833 +<a href="#__codelineno-0-11">11</a>

834 +<a href="#__codelineno-0-12">12</a>

835 +<a href="#__codelineno-0-13">13</a>

836 +<a href="#__codelineno-0-14">14</a>

837 +<a href="#__codelineno-0-15">15</a>

838 +<a href="#__codelineno-0-16">16</a>

839 +<a href="#__codelineno-0-17">17</a>

840 +<a href="#__codelineno-0-18">18</a>

841 +<a href="#__codelineno-0-19">19</a>

842 +<a href="#__codelineno-0-20">20</a>

843 +<a href="#__codelineno-0-21">21</a>

844 +<a href="#__codelineno-0-22">22</a>

845 +<a href="#__codelineno-0-23">23</a>

846 +<a href="#__codelineno-0-24">24</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-9" name="__codelineno-0-9"></a>@bp.route("/alerts", methods=["GET"])

847 +<a id="__codelineno-0-10" name="__codelineno-0-10"></a>def get_alerts() -> jsonify:

848 +<a id="__codelineno-0-11" name="__codelineno-0-11"></a> """

849 +<a id="__codelineno-0-12" name="__codelineno-0-12"></a> Retrieves all alerts from the AlertsService.

850 +<a id="__codelineno-0-13" name="__codelineno-0-13"></a>

851 +<a id="__codelineno-0-14" name="__codelineno-0-14"></a> This endpoint retrieves all available alerts from the AlertsService. It does this by creating an instance of

852 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a> the AlertsService class and calling its `collect_alerts` method. The result is a list of all alerts currently

853 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> available.

854 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a>

855 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> Returns:

856 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> jsonify: A JSON response containing a list of alerts. Each item in the list is a dictionary representing an alert,

857 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> containing all its associated data.

858 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> """

859 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> service = AlertsService()

860 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> alerts = service.collect_alerts()

861 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> return jsonify(alerts)

862 +</code></pre></div></td></tr></table></div>

863 + </details>

864 + </div>

865 +

866 +</div>

867 +

868 +

869 +

870 + </div>

871 +

872 + </div>

873 +

874 +</div>

875 +<h3 id="wazuh-indexer-routes">Wazuh-Indexer Routes</h3>

876 +

877 +

878 +<div class="doc doc-object doc-module">

879 +

880 +

881 +<a id="app.routes.wazuhindexer"></a>

882 + <div class="doc doc-contents first">

883 +

884 +

885 +

886 + <div class="doc doc-children">

887 +

888 +

889 +

890 +

891 +

892 +

893 +

894 +

895 +

896 +<div class="doc doc-object doc-function">

897 +

898 +

899 +

900 +<h2 id="app.routes.wazuhindexer.get_cluster_health" class="doc doc-heading">

901 +<code class="highlight language-python">get_cluster_health()</code>

902 +

903 +</h2>

904 +

905 +

906 + <div class="doc doc-contents ">

907 +

908 + HTTP GET endpoint to collect Wazuh-Indexer cluster health information.

909 +

910 + Returns:

911 + <table>

912 + <thead>

913 + <tr>

914 +<th>Name</th> <th>Type</th>

915 + <th>Description</th>

916 + </tr>

917 + </thead>

918 + <tbody>

919 + <tr>

920 +<td><code>json</code></td> <td>

921 + </td>

922 + <td>

923 + <div class="doc-md-description">

924 + A JSON response containing health information for the Wazuh-Indexer cluster.

925 + </div>

926 + </td>

927 + </tr>

928 + </tbody>

929 + </table>

930 +

931 + <details class="quote">

932 + <summary>Source code in <code>app\routes\wazuhindexer.py</code></summary>

933 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-49">49</a>

934 +<a href="#__codelineno-0-50">50</a>

935 +<a href="#__codelineno-0-51">51</a>

936 +<a href="#__codelineno-0-52">52</a>

937 +<a href="#__codelineno-0-53">53</a>

938 +<a href="#__codelineno-0-54">54</a>

939 +<a href="#__codelineno-0-55">55</a>

940 +<a href="#__codelineno-0-56">56</a>

941 +<a href="#__codelineno-0-57">57</a>

942 +<a href="#__codelineno-0-58">58</a>

943 +<a href="#__codelineno-0-59">59</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-49" name="__codelineno-0-49"></a>@bp.route("/wazuh_indexer/health", methods=["GET"])

944 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a>def get_cluster_health():

945 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> """

946 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> HTTP GET endpoint to collect Wazuh-Indexer cluster health information.

947 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a>

948 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> Returns:

949 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> json: A JSON response containing health information for the Wazuh-Indexer cluster.

950 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> """

951 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> service = ClusterService()

952 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> indices = service.collect_cluster_health()

953 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> return indices

954 +</code></pre></div></td></tr></table></div>

955 + </details>

956 + </div>

957 +

958 +</div>

959 +

960 +<div class="doc doc-object doc-function">

961 +

962 +

963 +

964 +<h2 id="app.routes.wazuhindexer.get_indices_summary" class="doc doc-heading">

965 +<code class="highlight language-python">get_indices_summary()</code>

966 +

967 +</h2>

968 +

969 +

970 + <div class="doc doc-contents ">

971 +

972 + HTTP GET endpoint to list all available indices and collect relevant information for each.

973 +This includes:

974 +- Index name

975 +- Index health status

976 +- Document count in the index

977 +- Size of the index

978 +- Number of replicas for the index

979 +

980 + Returns:

981 + <table>

982 + <thead>

983 + <tr>

984 +<th>Name</th> <th>Type</th>

985 + <th>Description</th>

986 + </tr>

987 + </thead>

988 + <tbody>

989 + <tr>

990 +<td><code>json</code></td> <td>

991 + </td>

992 + <td>

993 + <div class="doc-md-description">

994 + A JSON response containing a list of all available indices along with their respective details.

995 + </div>

996 + </td>

997 + </tr>

998 + </tbody>

999 + </table>

1000 +

1001 + <details class="quote">

1002 + <summary>Source code in <code>app\routes\wazuhindexer.py</code></summary>

1003 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-9"> 9</a>

1004 +<a href="#__codelineno-0-10">10</a>

1005 +<a href="#__codelineno-0-11">11</a>

1006 +<a href="#__codelineno-0-12">12</a>

1007 +<a href="#__codelineno-0-13">13</a>

1008 +<a href="#__codelineno-0-14">14</a>

1009 +<a href="#__codelineno-0-15">15</a>

1010 +<a href="#__codelineno-0-16">16</a>

1011 +<a href="#__codelineno-0-17">17</a>

1012 +<a href="#__codelineno-0-18">18</a>

1013 +<a href="#__codelineno-0-19">19</a>

1014 +<a href="#__codelineno-0-20">20</a>

1015 +<a href="#__codelineno-0-21">21</a>

1016 +<a href="#__codelineno-0-22">22</a>

1017 +<a href="#__codelineno-0-23">23</a>

1018 +<a href="#__codelineno-0-24">24</a>

1019 +<a href="#__codelineno-0-25">25</a>

1020 +<a href="#__codelineno-0-26">26</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-9" name="__codelineno-0-9"></a>@bp.route("/wazuh_indexer/indices", methods=["GET"])

1021 +<a id="__codelineno-0-10" name="__codelineno-0-10"></a>def get_indices_summary():

1022 +<a id="__codelineno-0-11" name="__codelineno-0-11"></a> """

1023 +<a id="__codelineno-0-12" name="__codelineno-0-12"></a> HTTP GET endpoint to list all available indices and collect relevant information for each.

1024 +<a id="__codelineno-0-13" name="__codelineno-0-13"></a>

1025 +<a id="__codelineno-0-14" name="__codelineno-0-14"></a> This includes:

1026 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a> - Index name

1027 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> - Index health status

1028 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> - Document count in the index

1029 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> - Size of the index

1030 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> - Number of replicas for the index

1031 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a>

1032 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> Returns:

1033 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> json: A JSON response containing a list of all available indices along with their respective details.

1034 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> """

1035 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> service = IndexService()

1036 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> indices = service.collect_indices_summary()

1037 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> return indices

1038 +</code></pre></div></td></tr></table></div>

1039 + </details>

1040 + </div>

1041 +

1042 +</div>

1043 +

1044 +<div class="doc doc-object doc-function">

1045 +

1046 +

1047 +

1048 +<h2 id="app.routes.wazuhindexer.get_node_allocation" class="doc doc-heading">

1049 +<code class="highlight language-python">get_node_allocation()</code>

1050 +

1051 +</h2>

1052 +

1053 +

1054 + <div class="doc doc-contents ">

1055 +

1056 + HTTP GET endpoint to list all available indices allocation.

1057 +This includes:

1058 +- Disk space used by the index

1059 +- Available disk space

1060 +- Total disk space

1061 +- Disk usage percentage

1062 +- Node on which the index resides

1063 +

1064 + Returns:

1065 + <table>

1066 + <thead>

1067 + <tr>

1068 +<th>Name</th> <th>Type</th>

1069 + <th>Description</th>

1070 + </tr>

1071 + </thead>

1072 + <tbody>

1073 + <tr>

1074 +<td><code>json</code></td> <td>

1075 + </td>

1076 + <td>

1077 + <div class="doc-md-description">

1078 + A JSON response containing a list of all available indices along with their respective allocation details.

1079 + </div>

1080 + </td>

1081 + </tr>

1082 + </tbody>

1083 + </table>

1084 +

1085 + <details class="quote">

1086 + <summary>Source code in <code>app\routes\wazuhindexer.py</code></summary>

1087 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-29">29</a>

1088 +<a href="#__codelineno-0-30">30</a>

1089 +<a href="#__codelineno-0-31">31</a>

1090 +<a href="#__codelineno-0-32">32</a>

1091 +<a href="#__codelineno-0-33">33</a>

1092 +<a href="#__codelineno-0-34">34</a>

1093 +<a href="#__codelineno-0-35">35</a>

1094 +<a href="#__codelineno-0-36">36</a>

1095 +<a href="#__codelineno-0-37">37</a>

1096 +<a href="#__codelineno-0-38">38</a>

1097 +<a href="#__codelineno-0-39">39</a>

1098 +<a href="#__codelineno-0-40">40</a>

1099 +<a href="#__codelineno-0-41">41</a>

1100 +<a href="#__codelineno-0-42">42</a>

1101 +<a href="#__codelineno-0-43">43</a>

1102 +<a href="#__codelineno-0-44">44</a>

1103 +<a href="#__codelineno-0-45">45</a>

1104 +<a href="#__codelineno-0-46">46</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-29" name="__codelineno-0-29"></a>@bp.route("/wazuh_indexer/allocation", methods=["GET"])

1105 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a>def get_node_allocation():

1106 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> """

1107 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> HTTP GET endpoint to list all available indices allocation.

1108 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a>

1109 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> This includes:

1110 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> - Disk space used by the index

1111 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> - Available disk space

1112 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> - Total disk space

1113 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> - Disk usage percentage

1114 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> - Node on which the index resides

1115 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a>

1116 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> Returns:

1117 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> json: A JSON response containing a list of all available indices along with their respective allocation details.

1118 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> """

1119 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> service = ClusterService()

1120 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> indices = service.collect_node_allocation()

1121 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> return indices

1122 +</code></pre></div></td></tr></table></div>

1123 + </details>

1124 + </div>

1125 +

1126 +</div>

1127 +

1128 +<div class="doc doc-object doc-function">

1129 +

1130 +

1131 +

1132 +<h2 id="app.routes.wazuhindexer.get_shards" class="doc doc-heading">

1133 +<code class="highlight language-python">get_shards()</code>

1134 +

1135 +</h2>

1136 +

1137 +

1138 + <div class="doc doc-contents ">

1139 +

1140 + HTTP GET endpoint to collect information about Wazuh-Indexer shards.

1141 +

1142 + Returns:

1143 + <table>

1144 + <thead>

1145 + <tr>

1146 +<th>Name</th> <th>Type</th>

1147 + <th>Description</th>

1148 + </tr>

1149 + </thead>

1150 + <tbody>

1151 + <tr>

1152 +<td><code>json</code></td> <td>

1153 + </td>

1154 + <td>

1155 + <div class="doc-md-description">

1156 + A JSON response containing information about the shards in the Wazuh-Indexer.

1157 + </div>

1158 + </td>

1159 + </tr>

1160 + </tbody>

1161 + </table>

1162 +

1163 + <details class="quote">

1164 + <summary>Source code in <code>app\routes\wazuhindexer.py</code></summary>

1165 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-62">62</a>

1166 +<a href="#__codelineno-0-63">63</a>

1167 +<a href="#__codelineno-0-64">64</a>

1168 +<a href="#__codelineno-0-65">65</a>

1169 +<a href="#__codelineno-0-66">66</a>

1170 +<a href="#__codelineno-0-67">67</a>

1171 +<a href="#__codelineno-0-68">68</a>

1172 +<a href="#__codelineno-0-69">69</a>

1173 +<a href="#__codelineno-0-70">70</a>

1174 +<a href="#__codelineno-0-71">71</a>

1175 +<a href="#__codelineno-0-72">72</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-62" name="__codelineno-0-62"></a>@bp.route("/wazuh_indexer/shards", methods=["GET"])

1176 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a>def get_shards():

1177 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> """

1178 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> HTTP GET endpoint to collect information about Wazuh-Indexer shards.

1179 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a>

1180 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> Returns:

1181 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> json: A JSON response containing information about the shards in the Wazuh-Indexer.

1182 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> """

1183 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> service = ClusterService()

1184 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> indices = service.collect_shards()

1185 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> return indices

1186 +</code></pre></div></td></tr></table></div>

1187 + </details>

1188 + </div>

1189 +

1190 +</div>

1191 +

1192 +

1193 +

1194 + </div>

1195 +

1196 + </div>

1197 +

1198 +</div>

1199 +<h3 id="alert-services">Alert Services</h3>

1200 +

1201 +

1202 +<div class="doc doc-object doc-module">

1203 +

1204 +

1205 +<a id="app.services.WazuhIndexer.alerts"></a>

1206 + <div class="doc doc-contents first">

1207 +

1208 +

1209 +

1210 + <div class="doc doc-children">

1211 +

1212 +

1213 +

1214 +

1215 +

1216 +

1217 +

1218 +

1219 +<div class="doc doc-object doc-class">

1220 +

1221 +

1222 +

1223 +<h2 id="app.services.WazuhIndexer.alerts.AlertsService" class="doc doc-heading">

1224 + <code>AlertsService</code>

1225 +

1226 +

1227 +</h2>

1228 +

1229 +

1230 + <div class="doc doc-contents ">

1231 +

1232 +

1233 + A service class that encapsulates the logic for pulling alerts from the Wazuh-Indexer.

1234 +

1235 + Attributes:

1236 + <table>

1237 + <thead>

1238 + <tr>

1239 + <th>Name</th>

1240 + <th>Type</th>

1241 + <th>Description</th>

1242 + </tr>

1243 + </thead>

1244 + <tbody>

1245 + <tr>

1246 + <td><code>connector_url</code></td>

1247 + <td>

1248 + <code>str</code>

1249 + </td>

1250 + <td>

1251 + <div class="doc-md-description">

1252 + The url to the Wazuh-Indexer.

1253 + </div>

1254 + </td>

1255 + </tr>

1256 + <tr>

1257 + <td><code>connector_username</code></td>

1258 + <td>

1259 + <code>str</code>

1260 + </td>

1261 + <td>

1262 + <div class="doc-md-description">

1263 + The username for the Wazuh-Indexer.

1264 + </div>

1265 + </td>

1266 + </tr>

1267 + <tr>

1268 + <td><code>connector_password</code></td>

1269 + <td>

1270 + <code>str</code>

1271 + </td>

1272 + <td>

1273 + <div class="doc-md-description">

1274 + The password for the Wazuh-Indexer.

1275 + </div>

1276 + </td>

1277 + </tr>

1278 + <tr>

1279 + <td><code>es</code></td>

1280 + <td>

1281 + <code>Elasticsearch</code>

1282 + </td>

1283 + <td>

1284 + <div class="doc-md-description">

1285 + The Elasticsearch client.

1286 + </div>

1287 + </td>

1288 + </tr>

1289 + </tbody>

1290 + </table>

1291 +

1292 +

1293 + <details class="quote">

1294 + <summary>Source code in <code>app\services\WazuhIndexer\alerts.py</code></summary>

1295 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-9"> 9</a>

1296 +<a href="#__codelineno-0-10"> 10</a>

1297 +<a href="#__codelineno-0-11"> 11</a>

1298 +<a href="#__codelineno-0-12"> 12</a>

1299 +<a href="#__codelineno-0-13"> 13</a>

1300 +<a href="#__codelineno-0-14"> 14</a>

1301 +<a href="#__codelineno-0-15"> 15</a>

1302 +<a href="#__codelineno-0-16"> 16</a>

1303 +<a href="#__codelineno-0-17"> 17</a>

1304 +<a href="#__codelineno-0-18"> 18</a>

1305 +<a href="#__codelineno-0-19"> 19</a>

1306 +<a href="#__codelineno-0-20"> 20</a>

1307 +<a href="#__codelineno-0-21"> 21</a>

1308 +<a href="#__codelineno-0-22"> 22</a>

1309 +<a href="#__codelineno-0-23"> 23</a>

1310 +<a href="#__codelineno-0-24"> 24</a>

1311 +<a href="#__codelineno-0-25"> 25</a>

1312 +<a href="#__codelineno-0-26"> 26</a>

1313 +<a href="#__codelineno-0-27"> 27</a>

1314 +<a href="#__codelineno-0-28"> 28</a>

1315 +<a href="#__codelineno-0-29"> 29</a>

1316 +<a href="#__codelineno-0-30"> 30</a>

1317 +<a href="#__codelineno-0-31"> 31</a>

1318 +<a href="#__codelineno-0-32"> 32</a>

1319 +<a href="#__codelineno-0-33"> 33</a>

1320 +<a href="#__codelineno-0-34"> 34</a>

1321 +<a href="#__codelineno-0-35"> 35</a>

1322 +<a href="#__codelineno-0-36"> 36</a>

1323 +<a href="#__codelineno-0-37"> 37</a>

1324 +<a href="#__codelineno-0-38"> 38</a>

1325 +<a href="#__codelineno-0-39"> 39</a>

1326 +<a href="#__codelineno-0-40"> 40</a>

1327 +<a href="#__codelineno-0-41"> 41</a>

1328 +<a href="#__codelineno-0-42"> 42</a>

1329 +<a href="#__codelineno-0-43"> 43</a>

1330 +<a href="#__codelineno-0-44"> 44</a>

1331 +<a href="#__codelineno-0-45"> 45</a>

1332 +<a href="#__codelineno-0-46"> 46</a>

1333 +<a href="#__codelineno-0-47"> 47</a>

1334 +<a href="#__codelineno-0-48"> 48</a>

1335 +<a href="#__codelineno-0-49"> 49</a>

1336 +<a href="#__codelineno-0-50"> 50</a>

1337 +<a href="#__codelineno-0-51"> 51</a>

1338 +<a href="#__codelineno-0-52"> 52</a>

1339 +<a href="#__codelineno-0-53"> 53</a>

1340 +<a href="#__codelineno-0-54"> 54</a>

1341 +<a href="#__codelineno-0-55"> 55</a>

1342 +<a href="#__codelineno-0-56"> 56</a>

1343 +<a href="#__codelineno-0-57"> 57</a>

1344 +<a href="#__codelineno-0-58"> 58</a>

1345 +<a href="#__codelineno-0-59"> 59</a>

1346 +<a href="#__codelineno-0-60"> 60</a>

1347 +<a href="#__codelineno-0-61"> 61</a>

1348 +<a href="#__codelineno-0-62"> 62</a>

1349 +<a href="#__codelineno-0-63"> 63</a>

1350 +<a href="#__codelineno-0-64"> 64</a>

1351 +<a href="#__codelineno-0-65"> 65</a>

1352 +<a href="#__codelineno-0-66"> 66</a>

1353 +<a href="#__codelineno-0-67"> 67</a>

1354 +<a href="#__codelineno-0-68"> 68</a>

1355 +<a href="#__codelineno-0-69"> 69</a>

1356 +<a href="#__codelineno-0-70"> 70</a>

1357 +<a href="#__codelineno-0-71"> 71</a>

1358 +<a href="#__codelineno-0-72"> 72</a>

1359 +<a href="#__codelineno-0-73"> 73</a>

1360 +<a href="#__codelineno-0-74"> 74</a>

1361 +<a href="#__codelineno-0-75"> 75</a>

1362 +<a href="#__codelineno-0-76"> 76</a>

1363 +<a href="#__codelineno-0-77"> 77</a>

1364 +<a href="#__codelineno-0-78"> 78</a>

1365 +<a href="#__codelineno-0-79"> 79</a>

1366 +<a href="#__codelineno-0-80"> 80</a>

1367 +<a href="#__codelineno-0-81"> 81</a>

1368 +<a href="#__codelineno-0-82"> 82</a>

1369 +<a href="#__codelineno-0-83"> 83</a>

1370 +<a href="#__codelineno-0-84"> 84</a>

1371 +<a href="#__codelineno-0-85"> 85</a>

1372 +<a href="#__codelineno-0-86"> 86</a>

1373 +<a href="#__codelineno-0-87"> 87</a>

1374 +<a href="#__codelineno-0-88"> 88</a>

1375 +<a href="#__codelineno-0-89"> 89</a>

1376 +<a href="#__codelineno-0-90"> 90</a>

1377 +<a href="#__codelineno-0-91"> 91</a>

1378 +<a href="#__codelineno-0-92"> 92</a>

1379 +<a href="#__codelineno-0-93"> 93</a>

1380 +<a href="#__codelineno-0-94"> 94</a>

1381 +<a href="#__codelineno-0-95"> 95</a>

1382 +<a href="#__codelineno-0-96"> 96</a>

1383 +<a href="#__codelineno-0-97"> 97</a>

1384 +<a href="#__codelineno-0-98"> 98</a>

1385 +<a href="#__codelineno-0-99"> 99</a>

1386 +<a href="#__codelineno-0-100">100</a>

1387 +<a href="#__codelineno-0-101">101</a>

1388 +<a href="#__codelineno-0-102">102</a>

1389 +<a href="#__codelineno-0-103">103</a>

1390 +<a href="#__codelineno-0-104">104</a>

1391 +<a href="#__codelineno-0-105">105</a>

1392 +<a href="#__codelineno-0-106">106</a>

1393 +<a href="#__codelineno-0-107">107</a>

1394 +<a href="#__codelineno-0-108">108</a>

1395 +<a href="#__codelineno-0-109">109</a>

1396 +<a href="#__codelineno-0-110">110</a>

1397 +<a href="#__codelineno-0-111">111</a>

1398 +<a href="#__codelineno-0-112">112</a>

1399 +<a href="#__codelineno-0-113">113</a>

1400 +<a href="#__codelineno-0-114">114</a>

1401 +<a href="#__codelineno-0-115">115</a>

1402 +<a href="#__codelineno-0-116">116</a>

1403 +<a href="#__codelineno-0-117">117</a>

1404 +<a href="#__codelineno-0-118">118</a>

1405 +<a href="#__codelineno-0-119">119</a>

1406 +<a href="#__codelineno-0-120">120</a>

1407 +<a href="#__codelineno-0-121">121</a>

1408 +<a href="#__codelineno-0-122">122</a>

1409 +<a href="#__codelineno-0-123">123</a>

1410 +<a href="#__codelineno-0-124">124</a>

1411 +<a href="#__codelineno-0-125">125</a>

1412 +<a href="#__codelineno-0-126">126</a>

1413 +<a href="#__codelineno-0-127">127</a>

1414 +<a href="#__codelineno-0-128">128</a>

1415 +<a href="#__codelineno-0-129">129</a>

1416 +<a href="#__codelineno-0-130">130</a>

1417 +<a href="#__codelineno-0-131">131</a>

1418 +<a href="#__codelineno-0-132">132</a>

1419 +<a href="#__codelineno-0-133">133</a>

1420 +<a href="#__codelineno-0-134">134</a>

1421 +<a href="#__codelineno-0-135">135</a>

1422 +<a href="#__codelineno-0-136">136</a>

1423 +<a href="#__codelineno-0-137">137</a>

1424 +<a href="#__codelineno-0-138">138</a>

1425 +<a href="#__codelineno-0-139">139</a>

1426 +<a href="#__codelineno-0-140">140</a>

1427 +<a href="#__codelineno-0-141">141</a>

1428 +<a href="#__codelineno-0-142">142</a>

1429 +<a href="#__codelineno-0-143">143</a>

1430 +<a href="#__codelineno-0-144">144</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-9" name="__codelineno-0-9"></a>class AlertsService:

1431 +<a id="__codelineno-0-10" name="__codelineno-0-10"></a> """

1432 +<a id="__codelineno-0-11" name="__codelineno-0-11"></a> A service class that encapsulates the logic for pulling alerts from the Wazuh-Indexer.

1433 +<a id="__codelineno-0-12" name="__codelineno-0-12"></a>

1434 +<a id="__codelineno-0-13" name="__codelineno-0-13"></a> Attributes:

1435 +<a id="__codelineno-0-14" name="__codelineno-0-14"></a> connector_url (str): The url to the Wazuh-Indexer.

1436 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a> connector_username (str): The username for the Wazuh-Indexer.

1437 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> connector_password (str): The password for the Wazuh-Indexer.

1438 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> es (Elasticsearch): The Elasticsearch client.

1439 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> """

1440 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a>

1441 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> SKIP_INDEX_NAMES: Dict[str, bool] = {

1442 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> "wazuh-statistics": True,

1443 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> "wazuh-monitoring": True,

1444 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> }

1445 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a>

1446 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> def __init__(self):

1447 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> """

1448 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> Initializes the service by collecting Wazuh-Indexer details and creating an Elasticsearch client.

1449 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> """

1450 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> (

1451 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> self.connector_url,

1452 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> self.connector_username,

1453 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> self.connector_password,

1454 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> ) = UniversalService().collect_wazuhindexer_details("Wazuh-Indexer")

1455 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> self.es = Elasticsearch(

1456 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> [self.connector_url],

1457 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> http_auth=(self.connector_username, self.connector_password),

1458 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> verify_certs=False,

1459 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> timeout=15,

1460 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> max_retries=10,

1461 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> retry_on_timeout=False,

1462 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> )

1463 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a>

1464 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> def is_index_skipped(self, index_name: str) -> bool:

1465 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> """

1466 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> Checks whether the given index name should be skipped.

1467 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a>

1468 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> Args:

1469 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> index_name (str): The name of the index.

1470 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a>

1471 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> Returns:

1472 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> bool: True if the index should be skipped, False otherwise.

1473 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> """

1474 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> for skipped in self.SKIP_INDEX_NAMES:

1475 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> if index_name.startswith(skipped):

1476 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> return True

1477 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> return False

1478 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a>

1479 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> def collect_alerts(self) -> Dict[str, object]:

1480 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> """

1481 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> Collects the alerts from the Wazuh-Indexer where the index name starts with "wazuh_"

1482 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> and is not in the SKIP_INDEX_NAMES list.

1483 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> Returns the 10 previous alerts based on the `timestamp_utc` field.

1484 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a>

1485 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> Returns:

1486 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Dict[str, object]: A dictionary containing success status and alerts or an error message.

1487 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> """

1488 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> if not all(

1489 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> [self.connector_url, self.connector_username, self.connector_password],

1490 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> ):

1491 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> return {

1492 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> "message": "Failed to collect Wazuh-Indexer details",

1493 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> "success": False,

1494 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> }

1495 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a>

1496 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> indices_list = UniversalService().collect_indices()

1497 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> if not indices_list["success"]:

1498 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> return {"message": "Failed to collect indices", "success": False}

1499 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a>

1500 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> alerts_summary = []

1501 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> for index_name in indices_list["indices_list"]:

1502 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> if not index_name.startswith("wazuh_") or self.is_index_skipped(index_name):

1503 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> continue

1504 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a>

1505 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> alerts = self._collect_alerts(index_name)

1506 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> if alerts["success"] and len(alerts["alerts"]) > 0:

1507 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> alerts_summary.append(

1508 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> {

1509 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> "index_name": index_name,

1510 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> "total_alerts": len(alerts["alerts"]),

1511 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> "last_10_alerts": alerts["alerts"],

1512 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> },

1513 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> )

1514 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a>

1515 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> return {

1516 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> "message": "Successfully collected alerts",

1517 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> "success": True,

1518 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> "alerts_summary": alerts_summary,

1519 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> }

1520 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a>

1521 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> def _collect_alerts(self, index_name: str) -> Dict[str, object]:

1522 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> """

1523 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> Elasticsearch query to get the 10 most recent alerts where the `rule_level` is 12 or higher or the

1524 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> `syslog_level` field is `ALERT` and return the results in descending order by the `timestamp_utc` field.

1525 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a>

1526 +<a id="__codelineno-0-105" name="__codelineno-0-105"></a> Args:

1527 +<a id="__codelineno-0-106" name="__codelineno-0-106"></a> index_name (str): The name of the index to query.

1528 +<a id="__codelineno-0-107" name="__codelineno-0-107"></a>

1529 +<a id="__codelineno-0-108" name="__codelineno-0-108"></a> Returns:

1530 +<a id="__codelineno-0-109" name="__codelineno-0-109"></a> Dict[str, object]: A dictionary containing success status and alerts or an error message.

1531 +<a id="__codelineno-0-110" name="__codelineno-0-110"></a> """

1532 +<a id="__codelineno-0-111" name="__codelineno-0-111"></a> logger.info(f"Collecting alerts from {index_name}")

1533 +<a id="__codelineno-0-112" name="__codelineno-0-112"></a> query = self._build_query()

1534 +<a id="__codelineno-0-113" name="__codelineno-0-113"></a> try:

1535 +<a id="__codelineno-0-114" name="__codelineno-0-114"></a> alerts = self.es.search(index=index_name, body=query, size=10)

1536 +<a id="__codelineno-0-115" name="__codelineno-0-115"></a> alerts_list = [alert for alert in alerts["hits"]["hits"]]

1537 +<a id="__codelineno-0-116" name="__codelineno-0-116"></a> return {

1538 +<a id="__codelineno-0-117" name="__codelineno-0-117"></a> "message": "Successfully collected alerts",

1539 +<a id="__codelineno-0-118" name="__codelineno-0-118"></a> "success": True,

1540 +<a id="__codelineno-0-119" name="__codelineno-0-119"></a> "alerts": alerts_list,

1541 +<a id="__codelineno-0-120" name="__codelineno-0-120"></a> }

1542 +<a id="__codelineno-0-121" name="__codelineno-0-121"></a> except Exception as e:

1543 +<a id="__codelineno-0-122" name="__codelineno-0-122"></a> logger.error(f"Failed to collect alerts: {e}")

1544 +<a id="__codelineno-0-123" name="__codelineno-0-123"></a> return {"message": "Failed to collect alerts", "success": False}

1545 +<a id="__codelineno-0-124" name="__codelineno-0-124"></a>

1546 +<a id="__codelineno-0-125" name="__codelineno-0-125"></a> @staticmethod

1547 +<a id="__codelineno-0-126" name="__codelineno-0-126"></a> def _build_query() -> Dict[str, object]:

1548 +<a id="__codelineno-0-127" name="__codelineno-0-127"></a> """

1549 +<a id="__codelineno-0-128" name="__codelineno-0-128"></a> Builds the Elasticsearch query to get the 10 most recent alerts where the `rule_level` is 12 or higher or

1550 +<a id="__codelineno-0-129" name="__codelineno-0-129"></a> the `syslog_level` field is `ALERT`.

1551 +<a id="__codelineno-0-130" name="__codelineno-0-130"></a>

1552 +<a id="__codelineno-0-131" name="__codelineno-0-131"></a> Returns:

1553 +<a id="__codelineno-0-132" name="__codelineno-0-132"></a> Dict[str, object]: A dictionary representing the Elasticsearch query.

1554 +<a id="__codelineno-0-133" name="__codelineno-0-133"></a> """

1555 +<a id="__codelineno-0-134" name="__codelineno-0-134"></a> return {

1556 +<a id="__codelineno-0-135" name="__codelineno-0-135"></a> "query": {

1557 +<a id="__codelineno-0-136" name="__codelineno-0-136"></a> "bool": {

1558 +<a id="__codelineno-0-137" name="__codelineno-0-137"></a> "should": [

1559 +<a id="__codelineno-0-138" name="__codelineno-0-138"></a> {"range": {"rule_level": {"gte": 12}}},

1560 +<a id="__codelineno-0-139" name="__codelineno-0-139"></a> {"match": {"syslog_level": "ALERT"}},

1561 +<a id="__codelineno-0-140" name="__codelineno-0-140"></a> ],

1562 +<a id="__codelineno-0-141" name="__codelineno-0-141"></a> },

1563 +<a id="__codelineno-0-142" name="__codelineno-0-142"></a> },

1564 +<a id="__codelineno-0-143" name="__codelineno-0-143"></a> "sort": [{"timestamp_utc": {"order": "desc"}}],

1565 +<a id="__codelineno-0-144" name="__codelineno-0-144"></a> }

1566 +</code></pre></div></td></tr></table></div>

1567 + </details>

1568 +

1569 +

1570 +

1571 + <div class="doc doc-children">

1572 +

1573 +

1574 +

1575 +

1576 +

1577 +

1578 +

1579 +

1580 +

1581 +<div class="doc doc-object doc-function">

1582 +

1583 +

1584 +

1585 +<h3 id="app.services.WazuhIndexer.alerts.AlertsService.__init__" class="doc doc-heading">

1586 +<code class="highlight language-python">__init__()</code>

1587 +

1588 +</h3>

1589 +

1590 +

1591 + <div class="doc doc-contents ">

1592 +

1593 + Initializes the service by collecting Wazuh-Indexer details and creating an Elasticsearch client.

1594 +

1595 + <details class="quote">

1596 + <summary>Source code in <code>app\services\WazuhIndexer\alerts.py</code></summary>

1597 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-25">25</a>

1598 +<a href="#__codelineno-0-26">26</a>

1599 +<a href="#__codelineno-0-27">27</a>

1600 +<a href="#__codelineno-0-28">28</a>

1601 +<a href="#__codelineno-0-29">29</a>

1602 +<a href="#__codelineno-0-30">30</a>

1603 +<a href="#__codelineno-0-31">31</a>

1604 +<a href="#__codelineno-0-32">32</a>

1605 +<a href="#__codelineno-0-33">33</a>

1606 +<a href="#__codelineno-0-34">34</a>

1607 +<a href="#__codelineno-0-35">35</a>

1608 +<a href="#__codelineno-0-36">36</a>

1609 +<a href="#__codelineno-0-37">37</a>

1610 +<a href="#__codelineno-0-38">38</a>

1611 +<a href="#__codelineno-0-39">39</a>

1612 +<a href="#__codelineno-0-40">40</a>

1613 +<a href="#__codelineno-0-41">41</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-25" name="__codelineno-0-25"></a>def __init__(self):

1614 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> """

1615 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> Initializes the service by collecting Wazuh-Indexer details and creating an Elasticsearch client.

1616 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> """

1617 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> (

1618 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> self.connector_url,

1619 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> self.connector_username,

1620 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> self.connector_password,

1621 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> ) = UniversalService().collect_wazuhindexer_details("Wazuh-Indexer")

1622 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> self.es = Elasticsearch(

1623 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> [self.connector_url],

1624 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> http_auth=(self.connector_username, self.connector_password),

1625 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> verify_certs=False,

1626 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> timeout=15,

1627 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> max_retries=10,

1628 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> retry_on_timeout=False,

1629 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> )

1630 +</code></pre></div></td></tr></table></div>

1631 + </details>

1632 + </div>

1633 +

1634 +</div>

1635 +

1636 +<div class="doc doc-object doc-function">

1637 +

1638 +

1639 +

1640 +<h3 id="app.services.WazuhIndexer.alerts.AlertsService.collect_alerts" class="doc doc-heading">

1641 +<code class="highlight language-python">collect_alerts()</code>

1642 +

1643 +</h3>

1644 +

1645 +

1646 + <div class="doc doc-contents ">

1647 +

1648 + Collects the alerts from the Wazuh-Indexer where the index name starts with "wazuh_"

1649 +and is not in the SKIP_INDEX_NAMES list.

1650 +Returns the 10 previous alerts based on the <code>timestamp_utc</code> field.

1651 +

1652 + Returns:

1653 + <table>

1654 + <thead>

1655 + <tr>

1656 + <th>Type</th>

1657 + <th>Description</th>

1658 + </tr>

1659 + </thead>

1660 + <tbody>

1661 + <tr>

1662 + <td>

1663 + <code>Dict[str, object]</code>

1664 + </td>

1665 + <td>

1666 + <div class="doc-md-description">

1667 + Dict[str, object]: A dictionary containing success status and alerts or an error message.

1668 + </div>

1669 + </td>

1670 + </tr>

1671 + </tbody>

1672 + </table>

1673 +

1674 + <details class="quote">

1675 + <summary>Source code in <code>app\services\WazuhIndexer\alerts.py</code></summary>

1676 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-58">58</a>

1677 +<a href="#__codelineno-0-59">59</a>

1678 +<a href="#__codelineno-0-60">60</a>

1679 +<a href="#__codelineno-0-61">61</a>

1680 +<a href="#__codelineno-0-62">62</a>

1681 +<a href="#__codelineno-0-63">63</a>

1682 +<a href="#__codelineno-0-64">64</a>

1683 +<a href="#__codelineno-0-65">65</a>

1684 +<a href="#__codelineno-0-66">66</a>

1685 +<a href="#__codelineno-0-67">67</a>

1686 +<a href="#__codelineno-0-68">68</a>

1687 +<a href="#__codelineno-0-69">69</a>

1688 +<a href="#__codelineno-0-70">70</a>

1689 +<a href="#__codelineno-0-71">71</a>

1690 +<a href="#__codelineno-0-72">72</a>

1691 +<a href="#__codelineno-0-73">73</a>

1692 +<a href="#__codelineno-0-74">74</a>

1693 +<a href="#__codelineno-0-75">75</a>

1694 +<a href="#__codelineno-0-76">76</a>

1695 +<a href="#__codelineno-0-77">77</a>

1696 +<a href="#__codelineno-0-78">78</a>

1697 +<a href="#__codelineno-0-79">79</a>

1698 +<a href="#__codelineno-0-80">80</a>

1699 +<a href="#__codelineno-0-81">81</a>

1700 +<a href="#__codelineno-0-82">82</a>

1701 +<a href="#__codelineno-0-83">83</a>

1702 +<a href="#__codelineno-0-84">84</a>

1703 +<a href="#__codelineno-0-85">85</a>

1704 +<a href="#__codelineno-0-86">86</a>

1705 +<a href="#__codelineno-0-87">87</a>

1706 +<a href="#__codelineno-0-88">88</a>

1707 +<a href="#__codelineno-0-89">89</a>

1708 +<a href="#__codelineno-0-90">90</a>

1709 +<a href="#__codelineno-0-91">91</a>

1710 +<a href="#__codelineno-0-92">92</a>

1711 +<a href="#__codelineno-0-93">93</a>

1712 +<a href="#__codelineno-0-94">94</a>

1713 +<a href="#__codelineno-0-95">95</a>

1714 +<a href="#__codelineno-0-96">96</a>

1715 +<a href="#__codelineno-0-97">97</a>

1716 +<a href="#__codelineno-0-98">98</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-58" name="__codelineno-0-58"></a>def collect_alerts(self) -> Dict[str, object]:

1717 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> """

1718 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> Collects the alerts from the Wazuh-Indexer where the index name starts with "wazuh_"

1719 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> and is not in the SKIP_INDEX_NAMES list.

1720 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> Returns the 10 previous alerts based on the `timestamp_utc` field.

1721 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a>

1722 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> Returns:

1723 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Dict[str, object]: A dictionary containing success status and alerts or an error message.

1724 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> """

1725 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> if not all(

1726 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> [self.connector_url, self.connector_username, self.connector_password],

1727 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> ):

1728 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> return {

1729 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> "message": "Failed to collect Wazuh-Indexer details",

1730 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> "success": False,

1731 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> }

1732 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a>

1733 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> indices_list = UniversalService().collect_indices()

1734 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> if not indices_list["success"]:

1735 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> return {"message": "Failed to collect indices", "success": False}

1736 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a>

1737 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> alerts_summary = []

1738 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> for index_name in indices_list["indices_list"]:

1739 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> if not index_name.startswith("wazuh_") or self.is_index_skipped(index_name):

1740 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> continue

1741 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a>

1742 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> alerts = self._collect_alerts(index_name)

1743 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> if alerts["success"] and len(alerts["alerts"]) > 0:

1744 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> alerts_summary.append(

1745 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> {

1746 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> "index_name": index_name,

1747 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> "total_alerts": len(alerts["alerts"]),

1748 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> "last_10_alerts": alerts["alerts"],

1749 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> },

1750 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> )

1751 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a>

1752 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> return {

1753 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> "message": "Successfully collected alerts",

1754 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> "success": True,

1755 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> "alerts_summary": alerts_summary,

1756 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> }

1757 +</code></pre></div></td></tr></table></div>

1758 + </details>

1759 + </div>

1760 +

1761 +</div>

1762 +

1763 +<div class="doc doc-object doc-function">

1764 +

1765 +

1766 +

1767 +<h3 id="app.services.WazuhIndexer.alerts.AlertsService.is_index_skipped" class="doc doc-heading">

1768 +<code class="highlight language-python">is_index_skipped(index_name)</code>

1769 +

1770 +</h3>

1771 +

1772 +

1773 + <div class="doc doc-contents ">

1774 +

1775 + Checks whether the given index name should be skipped.

1776 +

1777 + Parameters:

1778 + <table>

1779 + <thead>

1780 + <tr>

1781 + <th>Name</th>

1782 + <th>Type</th>

1783 + <th>Description</th>

1784 + <th>Default</th>

1785 + </tr>

1786 + </thead>

1787 + <tbody>

1788 + <tr>

1789 + <td><code>index_name</code></td>

1790 + <td>

1791 + <code>str</code>

1792 + </td>

1793 + <td>

1794 + <div class="doc-md-description">

1795 + The name of the index.

1796 + </div>

1797 + </td>

1798 + <td>

1799 + required

1800 + </td>

1801 + </tr>

1802 + </tbody>

1803 + </table>

1804 +

1805 + Returns:

1806 + <table>

1807 + <thead>

1808 + <tr>

1809 +<th>Name</th> <th>Type</th>

1810 + <th>Description</th>

1811 + </tr>

1812 + </thead>

1813 + <tbody>

1814 + <tr>

1815 +<td><code>bool</code></td> <td>

1816 + <code>bool</code>

1817 + </td>

1818 + <td>

1819 + <div class="doc-md-description">

1820 + True if the index should be skipped, False otherwise.

1821 + </div>

1822 + </td>

1823 + </tr>

1824 + </tbody>

1825 + </table>

1826 +

1827 + <details class="quote">

1828 + <summary>Source code in <code>app\services\WazuhIndexer\alerts.py</code></summary>

1829 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-43">43</a>

1830 +<a href="#__codelineno-0-44">44</a>

1831 +<a href="#__codelineno-0-45">45</a>

1832 +<a href="#__codelineno-0-46">46</a>

1833 +<a href="#__codelineno-0-47">47</a>

1834 +<a href="#__codelineno-0-48">48</a>

1835 +<a href="#__codelineno-0-49">49</a>

1836 +<a href="#__codelineno-0-50">50</a>

1837 +<a href="#__codelineno-0-51">51</a>

1838 +<a href="#__codelineno-0-52">52</a>

1839 +<a href="#__codelineno-0-53">53</a>

1840 +<a href="#__codelineno-0-54">54</a>

1841 +<a href="#__codelineno-0-55">55</a>

1842 +<a href="#__codelineno-0-56">56</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-43" name="__codelineno-0-43"></a>def is_index_skipped(self, index_name: str) -> bool:

1843 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> """

1844 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> Checks whether the given index name should be skipped.

1845 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a>

1846 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> Args:

1847 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> index_name (str): The name of the index.

1848 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a>

1849 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> Returns:

1850 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> bool: True if the index should be skipped, False otherwise.

1851 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> """

1852 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> for skipped in self.SKIP_INDEX_NAMES:

1853 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> if index_name.startswith(skipped):

1854 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> return True

1855 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> return False

1856 +</code></pre></div></td></tr></table></div>

1857 + </details>

1858 + </div>

1859 +

1860 +</div>

1861 +

1862 +

1863 +

1864 + </div>

1865 +

1866 + </div>

1867 +

1868 +</div>

1869 +

1870 +

1871 +

1872 +

1873 + </div>

1874 +

1875 + </div>

1876 +

1877 +</div><h3 id="cluster-services">Cluster Services</h3>

1878 +

1879 +

1880 +<div class="doc doc-object doc-module">

1881 +

1882 +

1883 +<a id="app.services.WazuhIndexer.cluster"></a>

1884 + <div class="doc doc-contents first">

1885 +

1886 +

1887 +

1888 + <div class="doc doc-children">

1889 +

1890 +

1891 +

1892 +

1893 +

1894 +

1895 +

1896 +

1897 +<div class="doc doc-object doc-class">

1898 +

1899 +

1900 +

1901 +<h2 id="app.services.WazuhIndexer.cluster.ClusterService" class="doc doc-heading">

1902 + <code>ClusterService</code>

1903 +

1904 +

1905 +</h2>

1906 +

1907 +

1908 + <div class="doc doc-contents ">

1909 +

1910 +

1911 + A service class that encapsulates the logic for pulling indices from the Wazuh-Indexer.

1912 +

1913 +

1914 + <details class="quote">

1915 + <summary>Source code in <code>app\services\WazuhIndexer\cluster.py</code></summary>

1916 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-10"> 10</a>

1917 +<a href="#__codelineno-0-11"> 11</a>

1918 +<a href="#__codelineno-0-12"> 12</a>

1919 +<a href="#__codelineno-0-13"> 13</a>

1920 +<a href="#__codelineno-0-14"> 14</a>

1921 +<a href="#__codelineno-0-15"> 15</a>

1922 +<a href="#__codelineno-0-16"> 16</a>

1923 +<a href="#__codelineno-0-17"> 17</a>

1924 +<a href="#__codelineno-0-18"> 18</a>

1925 +<a href="#__codelineno-0-19"> 19</a>

1926 +<a href="#__codelineno-0-20"> 20</a>

1927 +<a href="#__codelineno-0-21"> 21</a>

1928 +<a href="#__codelineno-0-22"> 22</a>

1929 +<a href="#__codelineno-0-23"> 23</a>

1930 +<a href="#__codelineno-0-24"> 24</a>

1931 +<a href="#__codelineno-0-25"> 25</a>

1932 +<a href="#__codelineno-0-26"> 26</a>

1933 +<a href="#__codelineno-0-27"> 27</a>

1934 +<a href="#__codelineno-0-28"> 28</a>

1935 +<a href="#__codelineno-0-29"> 29</a>

1936 +<a href="#__codelineno-0-30"> 30</a>

1937 +<a href="#__codelineno-0-31"> 31</a>

1938 +<a href="#__codelineno-0-32"> 32</a>

1939 +<a href="#__codelineno-0-33"> 33</a>

1940 +<a href="#__codelineno-0-34"> 34</a>

1941 +<a href="#__codelineno-0-35"> 35</a>

1942 +<a href="#__codelineno-0-36"> 36</a>

1943 +<a href="#__codelineno-0-37"> 37</a>

1944 +<a href="#__codelineno-0-38"> 38</a>

1945 +<a href="#__codelineno-0-39"> 39</a>

1946 +<a href="#__codelineno-0-40"> 40</a>

1947 +<a href="#__codelineno-0-41"> 41</a>

1948 +<a href="#__codelineno-0-42"> 42</a>

1949 +<a href="#__codelineno-0-43"> 43</a>

1950 +<a href="#__codelineno-0-44"> 44</a>

1951 +<a href="#__codelineno-0-45"> 45</a>

1952 +<a href="#__codelineno-0-46"> 46</a>

1953 +<a href="#__codelineno-0-47"> 47</a>

1954 +<a href="#__codelineno-0-48"> 48</a>

1955 +<a href="#__codelineno-0-49"> 49</a>

1956 +<a href="#__codelineno-0-50"> 50</a>

1957 +<a href="#__codelineno-0-51"> 51</a>

1958 +<a href="#__codelineno-0-52"> 52</a>

1959 +<a href="#__codelineno-0-53"> 53</a>

1960 +<a href="#__codelineno-0-54"> 54</a>

1961 +<a href="#__codelineno-0-55"> 55</a>

1962 +<a href="#__codelineno-0-56"> 56</a>

1963 +<a href="#__codelineno-0-57"> 57</a>

1964 +<a href="#__codelineno-0-58"> 58</a>

1965 +<a href="#__codelineno-0-59"> 59</a>

1966 +<a href="#__codelineno-0-60"> 60</a>

1967 +<a href="#__codelineno-0-61"> 61</a>

1968 +<a href="#__codelineno-0-62"> 62</a>

1969 +<a href="#__codelineno-0-63"> 63</a>

1970 +<a href="#__codelineno-0-64"> 64</a>

1971 +<a href="#__codelineno-0-65"> 65</a>

1972 +<a href="#__codelineno-0-66"> 66</a>

1973 +<a href="#__codelineno-0-67"> 67</a>

1974 +<a href="#__codelineno-0-68"> 68</a>

1975 +<a href="#__codelineno-0-69"> 69</a>

1976 +<a href="#__codelineno-0-70"> 70</a>

1977 +<a href="#__codelineno-0-71"> 71</a>

1978 +<a href="#__codelineno-0-72"> 72</a>

1979 +<a href="#__codelineno-0-73"> 73</a>

1980 +<a href="#__codelineno-0-74"> 74</a>

1981 +<a href="#__codelineno-0-75"> 75</a>

1982 +<a href="#__codelineno-0-76"> 76</a>

1983 +<a href="#__codelineno-0-77"> 77</a>

1984 +<a href="#__codelineno-0-78"> 78</a>

1985 +<a href="#__codelineno-0-79"> 79</a>

1986 +<a href="#__codelineno-0-80"> 80</a>

1987 +<a href="#__codelineno-0-81"> 81</a>

1988 +<a href="#__codelineno-0-82"> 82</a>

1989 +<a href="#__codelineno-0-83"> 83</a>

1990 +<a href="#__codelineno-0-84"> 84</a>

1991 +<a href="#__codelineno-0-85"> 85</a>

1992 +<a href="#__codelineno-0-86"> 86</a>

1993 +<a href="#__codelineno-0-87"> 87</a>

1994 +<a href="#__codelineno-0-88"> 88</a>

1995 +<a href="#__codelineno-0-89"> 89</a>

1996 +<a href="#__codelineno-0-90"> 90</a>

1997 +<a href="#__codelineno-0-91"> 91</a>

1998 +<a href="#__codelineno-0-92"> 92</a>

1999 +<a href="#__codelineno-0-93"> 93</a>

2000 +<a href="#__codelineno-0-94"> 94</a>

2001 +<a href="#__codelineno-0-95"> 95</a>

2002 +<a href="#__codelineno-0-96"> 96</a>

2003 +<a href="#__codelineno-0-97"> 97</a>

2004 +<a href="#__codelineno-0-98"> 98</a>

2005 +<a href="#__codelineno-0-99"> 99</a>

2006 +<a href="#__codelineno-0-100">100</a>

2007 +<a href="#__codelineno-0-101">101</a>

2008 +<a href="#__codelineno-0-102">102</a>

2009 +<a href="#__codelineno-0-103">103</a>

2010 +<a href="#__codelineno-0-104">104</a>

2011 +<a href="#__codelineno-0-105">105</a>

2012 +<a href="#__codelineno-0-106">106</a>

2013 +<a href="#__codelineno-0-107">107</a>

2014 +<a href="#__codelineno-0-108">108</a>

2015 +<a href="#__codelineno-0-109">109</a>

2016 +<a href="#__codelineno-0-110">110</a>

2017 +<a href="#__codelineno-0-111">111</a>

2018 +<a href="#__codelineno-0-112">112</a>

2019 +<a href="#__codelineno-0-113">113</a>

2020 +<a href="#__codelineno-0-114">114</a>

2021 +<a href="#__codelineno-0-115">115</a>

2022 +<a href="#__codelineno-0-116">116</a>

2023 +<a href="#__codelineno-0-117">117</a>

2024 +<a href="#__codelineno-0-118">118</a>

2025 +<a href="#__codelineno-0-119">119</a>

2026 +<a href="#__codelineno-0-120">120</a>

2027 +<a href="#__codelineno-0-121">121</a>

2028 +<a href="#__codelineno-0-122">122</a>

2029 +<a href="#__codelineno-0-123">123</a>

2030 +<a href="#__codelineno-0-124">124</a>

2031 +<a href="#__codelineno-0-125">125</a>

2032 +<a href="#__codelineno-0-126">126</a>

2033 +<a href="#__codelineno-0-127">127</a>

2034 +<a href="#__codelineno-0-128">128</a>

2035 +<a href="#__codelineno-0-129">129</a>

2036 +<a href="#__codelineno-0-130">130</a>

2037 +<a href="#__codelineno-0-131">131</a>

2038 +<a href="#__codelineno-0-132">132</a>

2039 +<a href="#__codelineno-0-133">133</a>

2040 +<a href="#__codelineno-0-134">134</a>

2041 +<a href="#__codelineno-0-135">135</a>

2042 +<a href="#__codelineno-0-136">136</a>

2043 +<a href="#__codelineno-0-137">137</a>

2044 +<a href="#__codelineno-0-138">138</a>

2045 +<a href="#__codelineno-0-139">139</a>

2046 +<a href="#__codelineno-0-140">140</a>

2047 +<a href="#__codelineno-0-141">141</a>

2048 +<a href="#__codelineno-0-142">142</a>

2049 +<a href="#__codelineno-0-143">143</a>

2050 +<a href="#__codelineno-0-144">144</a>

2051 +<a href="#__codelineno-0-145">145</a>

2052 +<a href="#__codelineno-0-146">146</a>

2053 +<a href="#__codelineno-0-147">147</a>

2054 +<a href="#__codelineno-0-148">148</a>

2055 +<a href="#__codelineno-0-149">149</a>

2056 +<a href="#__codelineno-0-150">150</a>

2057 +<a href="#__codelineno-0-151">151</a>

2058 +<a href="#__codelineno-0-152">152</a>

2059 +<a href="#__codelineno-0-153">153</a>

2060 +<a href="#__codelineno-0-154">154</a>

2061 +<a href="#__codelineno-0-155">155</a>

2062 +<a href="#__codelineno-0-156">156</a>

2063 +<a href="#__codelineno-0-157">157</a>

2064 +<a href="#__codelineno-0-158">158</a>

2065 +<a href="#__codelineno-0-159">159</a>

2066 +<a href="#__codelineno-0-160">160</a>

2067 +<a href="#__codelineno-0-161">161</a>

2068 +<a href="#__codelineno-0-162">162</a>

2069 +<a href="#__codelineno-0-163">163</a>

2070 +<a href="#__codelineno-0-164">164</a>

2071 +<a href="#__codelineno-0-165">165</a>

2072 +<a href="#__codelineno-0-166">166</a>

2073 +<a href="#__codelineno-0-167">167</a>

2074 +<a href="#__codelineno-0-168">168</a>

2075 +<a href="#__codelineno-0-169">169</a>

2076 +<a href="#__codelineno-0-170">170</a>

2077 +<a href="#__codelineno-0-171">171</a>

2078 +<a href="#__codelineno-0-172">172</a>

2079 +<a href="#__codelineno-0-173">173</a>

2080 +<a href="#__codelineno-0-174">174</a>

2081 +<a href="#__codelineno-0-175">175</a>

2082 +<a href="#__codelineno-0-176">176</a>

2083 +<a href="#__codelineno-0-177">177</a>

2084 +<a href="#__codelineno-0-178">178</a>

2085 +<a href="#__codelineno-0-179">179</a>

2086 +<a href="#__codelineno-0-180">180</a>

2087 +<a href="#__codelineno-0-181">181</a>

2088 +<a href="#__codelineno-0-182">182</a>

2089 +<a href="#__codelineno-0-183">183</a>

2090 +<a href="#__codelineno-0-184">184</a>

2091 +<a href="#__codelineno-0-185">185</a>

2092 +<a href="#__codelineno-0-186">186</a>

2093 +<a href="#__codelineno-0-187">187</a>

2094 +<a href="#__codelineno-0-188">188</a>

2095 +<a href="#__codelineno-0-189">189</a>

2096 +<a href="#__codelineno-0-190">190</a>

2097 +<a href="#__codelineno-0-191">191</a>

2098 +<a href="#__codelineno-0-192">192</a>

2099 +<a href="#__codelineno-0-193">193</a>

2100 +<a href="#__codelineno-0-194">194</a>

2101 +<a href="#__codelineno-0-195">195</a>

2102 +<a href="#__codelineno-0-196">196</a>

2103 +<a href="#__codelineno-0-197">197</a>

2104 +<a href="#__codelineno-0-198">198</a>

2105 +<a href="#__codelineno-0-199">199</a>

2106 +<a href="#__codelineno-0-200">200</a>

2107 +<a href="#__codelineno-0-201">201</a>

2108 +<a href="#__codelineno-0-202">202</a>

2109 +<a href="#__codelineno-0-203">203</a>

2110 +<a href="#__codelineno-0-204">204</a>

2111 +<a href="#__codelineno-0-205">205</a>

2112 +<a href="#__codelineno-0-206">206</a>

2113 +<a href="#__codelineno-0-207">207</a>

2114 +<a href="#__codelineno-0-208">208</a>

2115 +<a href="#__codelineno-0-209">209</a>

2116 +<a href="#__codelineno-0-210">210</a>

2117 +<a href="#__codelineno-0-211">211</a>

2118 +<a href="#__codelineno-0-212">212</a>

2119 +<a href="#__codelineno-0-213">213</a>

2120 +<a href="#__codelineno-0-214">214</a>

2121 +<a href="#__codelineno-0-215">215</a>

2122 +<a href="#__codelineno-0-216">216</a>

2123 +<a href="#__codelineno-0-217">217</a>

2124 +<a href="#__codelineno-0-218">218</a>

2125 +<a href="#__codelineno-0-219">219</a>

2126 +<a href="#__codelineno-0-220">220</a>

2127 +<a href="#__codelineno-0-221">221</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-10" name="__codelineno-0-10"></a>class ClusterService:

2128 +<a id="__codelineno-0-11" name="__codelineno-0-11"></a> """

2129 +<a id="__codelineno-0-12" name="__codelineno-0-12"></a> A service class that encapsulates the logic for pulling indices from the Wazuh-Indexer.

2130 +<a id="__codelineno-0-13" name="__codelineno-0-13"></a> """

2131 +<a id="__codelineno-0-14" name="__codelineno-0-14"></a>

2132 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a> def __init__(self):

2133 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> """

2134 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> Initialize the ClusterService with the details of the Wazuh-Indexer and initialize the Elasticsearch client.

2135 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> """

2136 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> self._collect_wazuhindexer_details()

2137 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> self._initialize_es_client()

2138 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a>

2139 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> def _collect_wazuhindexer_details(self):

2140 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> """

2141 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> Collect details of the Wazuh-Indexer. These details include the connector URL, username, and password.

2142 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> """

2143 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> (

2144 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> self.connector_url,

2145 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> self.connector_username,

2146 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> self.connector_password,

2147 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> ) = UniversalService().collect_wazuhindexer_details("Wazuh-Indexer")

2148 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a>

2149 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> def _initialize_es_client(self):

2150 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> """

2151 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> Initialize the Elasticsearch client with the details of the Wazuh-Indexer.

2152 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> """

2153 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> self.es = Elasticsearch(

2154 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> [self.connector_url],

2155 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> http_auth=(self.connector_username, self.connector_password),

2156 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> verify_certs=False,

2157 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> timeout=15,

2158 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> max_retries=10,

2159 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> retry_on_timeout=False,

2160 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> )

2161 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a>

2162 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> def _are_details_collected(self) -> bool:

2163 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> """

2164 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> Check whether the details of the Wazuh-Indexer have been collected.

2165 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a>

2166 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> Returns:

2167 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> bool: True if all details have been collected, False otherwise.

2168 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> """

2169 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> return all(

2170 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> [self.connector_url, self.connector_username, self.connector_password],

2171 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> )

2172 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a>

2173 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> def collect_node_allocation(self) -> Dict[str, object]:

2174 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> """

2175 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> Collect node allocation details from the Wazuh-Indexer's Elasticsearch cluster.

2176 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a>

2177 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> Returns:

2178 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> dict: A dictionary containing success status, a message, and potentially the node allocation details.

2179 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> """

2180 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> if not self._are_details_collected():

2181 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> return {

2182 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> "message": "Failed to collect Wazuh-Indexer details",

2183 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> "success": False,

2184 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> }

2185 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a>

2186 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> index_summary = self._collect_node_allocation()

2187 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> if not index_summary["success"]:

2188 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> return index_summary

2189 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a>

2190 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> return {

2191 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> "message": "Successfully collected node allocation",

2192 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> "success": True,

2193 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> "node_allocation": index_summary["node_allocation"],

2194 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> }

2195 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a>

2196 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> def _collect_node_allocation(self) -> Dict[str, object]:

2197 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> """

2198 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> Collect node allocation details from the Wazuh-Indexer's Elasticsearch cluster.

2199 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a>

2200 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> Returns:

2201 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> dict: A dictionary containing success status, a message, and potentially the node allocation details.

2202 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> """

2203 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> try:

2204 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> node_allocation = self.es.cat.allocation(format="json")

2205 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> node_allocation_list = self._format_node_allocation(node_allocation)

2206 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> return {

2207 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> "message": "Successfully collected node allocation",

2208 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> "success": True,

2209 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> "node_allocation": node_allocation_list,

2210 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a> }

2211 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> except Exception as e:

2212 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> logger.error(f"Failed to collect node allocation: {e}")

2213 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> return {"message": "Failed to collect node allocation", "success": False}

2214 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a>

2215 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> def _format_node_allocation(self, node_allocation):

2216 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a> """

2217 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> Format the node allocation details into a list of dictionaries. Each dictionary contains disk used, disk available, total disk, disk usage percentage, and node name.

2218 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a>

2219 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> Args:

2220 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> node_allocation: Node allocation details from Elasticsearch.

2221 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a>

2222 +<a id="__codelineno-0-105" name="__codelineno-0-105"></a> Returns:

2223 +<a id="__codelineno-0-106" name="__codelineno-0-106"></a> list: A list of dictionaries containing formatted node allocation details.

2224 +<a id="__codelineno-0-107" name="__codelineno-0-107"></a> """

2225 +<a id="__codelineno-0-108" name="__codelineno-0-108"></a> return [

2226 +<a id="__codelineno-0-109" name="__codelineno-0-109"></a> {

2227 +<a id="__codelineno-0-110" name="__codelineno-0-110"></a> "disk_used": node["disk.used"],

2228 +<a id="__codelineno-0-111" name="__codelineno-0-111"></a> "disk_available": node["disk.avail"],

2229 +<a id="__codelineno-0-112" name="__codelineno-0-112"></a> "disk_total": node["disk.total"],

2230 +<a id="__codelineno-0-113" name="__codelineno-0-113"></a> "disk_percent": node["disk.percent"],

2231 +<a id="__codelineno-0-114" name="__codelineno-0-114"></a> "node": node["node"],

2232 +<a id="__codelineno-0-115" name="__codelineno-0-115"></a> }

2233 +<a id="__codelineno-0-116" name="__codelineno-0-116"></a> for node in node_allocation

2234 +<a id="__codelineno-0-117" name="__codelineno-0-117"></a> ]

2235 +<a id="__codelineno-0-118" name="__codelineno-0-118"></a>

2236 +<a id="__codelineno-0-119" name="__codelineno-0-119"></a> def collect_cluster_health(self) -> Dict[str, object]:

2237 +<a id="__codelineno-0-120" name="__codelineno-0-120"></a> """

2238 +<a id="__codelineno-0-121" name="__codelineno-0-121"></a> Collect health details of the Elasticsearch cluster from the Wazuh-Indexer.

2239 +<a id="__codelineno-0-122" name="__codelineno-0-122"></a>

2240 +<a id="__codelineno-0-123" name="__codelineno-0-123"></a> Returns:

2241 +<a id="__codelineno-0-124" name="__codelineno-0-124"></a> dict: A dictionary containing success status, a message, and potentially the cluster health details.

2242 +<a id="__codelineno-0-125" name="__codelineno-0-125"></a> """

2243 +<a id="__codelineno-0-126" name="__codelineno-0-126"></a> if not self._are_details_collected():

2244 +<a id="__codelineno-0-127" name="__codelineno-0-127"></a> return {

2245 +<a id="__codelineno-0-128" name="__codelineno-0-128"></a> "message": "Failed to collect Wazuh-Indexer details",

2246 +<a id="__codelineno-0-129" name="__codelineno-0-129"></a> "success": False,

2247 +<a id="__codelineno-0-130" name="__codelineno-0-130"></a> }

2248 +<a id="__codelineno-0-131" name="__codelineno-0-131"></a>

2249 +<a id="__codelineno-0-132" name="__codelineno-0-132"></a> index_summary = self._collect_cluster_health()

2250 +<a id="__codelineno-0-133" name="__codelineno-0-133"></a> if not index_summary["success"]:

2251 +<a id="__codelineno-0-134" name="__codelineno-0-134"></a> return index_summary

2252 +<a id="__codelineno-0-135" name="__codelineno-0-135"></a>

2253 +<a id="__codelineno-0-136" name="__codelineno-0-136"></a> return {

2254 +<a id="__codelineno-0-137" name="__codelineno-0-137"></a> "message": "Successfully collected cluster health",

2255 +<a id="__codelineno-0-138" name="__codelineno-0-138"></a> "success": True,

2256 +<a id="__codelineno-0-139" name="__codelineno-0-139"></a> "cluster_health": index_summary["cluster_health"],

2257 +<a id="__codelineno-0-140" name="__codelineno-0-140"></a> }

2258 +<a id="__codelineno-0-141" name="__codelineno-0-141"></a>

2259 +<a id="__codelineno-0-142" name="__codelineno-0-142"></a> def _collect_cluster_health(self) -> Dict[str, object]:

2260 +<a id="__codelineno-0-143" name="__codelineno-0-143"></a> """

2261 +<a id="__codelineno-0-144" name="__codelineno-0-144"></a> Collect health details of the Elasticsearch cluster from the Wazuh-Indexer.

2262 +<a id="__codelineno-0-145" name="__codelineno-0-145"></a>

2263 +<a id="__codelineno-0-146" name="__codelineno-0-146"></a> Returns:

2264 +<a id="__codelineno-0-147" name="__codelineno-0-147"></a> dict: A dictionary containing success status, a message, and potentially the cluster health details.

2265 +<a id="__codelineno-0-148" name="__codelineno-0-148"></a> """

2266 +<a id="__codelineno-0-149" name="__codelineno-0-149"></a> try:

2267 +<a id="__codelineno-0-150" name="__codelineno-0-150"></a> cluster_health = self.es.cluster.health()

2268 +<a id="__codelineno-0-151" name="__codelineno-0-151"></a> return {

2269 +<a id="__codelineno-0-152" name="__codelineno-0-152"></a> "message": "Successfully collected cluster health",

2270 +<a id="__codelineno-0-153" name="__codelineno-0-153"></a> "success": True,

2271 +<a id="__codelineno-0-154" name="__codelineno-0-154"></a> "cluster_health": cluster_health,

2272 +<a id="__codelineno-0-155" name="__codelineno-0-155"></a> }

2273 +<a id="__codelineno-0-156" name="__codelineno-0-156"></a> except Exception as e:

2274 +<a id="__codelineno-0-157" name="__codelineno-0-157"></a> logger.error(f"Failed to collect cluster health: {e}")

2275 +<a id="__codelineno-0-158" name="__codelineno-0-158"></a> return {"message": "Failed to collect cluster health", "success": False}

2276 +<a id="__codelineno-0-159" name="__codelineno-0-159"></a>

2277 +<a id="__codelineno-0-160" name="__codelineno-0-160"></a> def collect_shards(self) -> Dict[str, object]:

2278 +<a id="__codelineno-0-161" name="__codelineno-0-161"></a> """

2279 +<a id="__codelineno-0-162" name="__codelineno-0-162"></a> Collect shard details from the Wazuh-Indexer's Elasticsearch cluster.

2280 +<a id="__codelineno-0-163" name="__codelineno-0-163"></a>

2281 +<a id="__codelineno-0-164" name="__codelineno-0-164"></a> Returns:

2282 +<a id="__codelineno-0-165" name="__codelineno-0-165"></a> dict: A dictionary containing success status, a message, and potentially the shard details.

2283 +<a id="__codelineno-0-166" name="__codelineno-0-166"></a> """

2284 +<a id="__codelineno-0-167" name="__codelineno-0-167"></a> if not self._are_details_collected():

2285 +<a id="__codelineno-0-168" name="__codelineno-0-168"></a> return {

2286 +<a id="__codelineno-0-169" name="__codelineno-0-169"></a> "message": "Failed to collect Wazuh-Indexer details",

2287 +<a id="__codelineno-0-170" name="__codelineno-0-170"></a> "success": False,

2288 +<a id="__codelineno-0-171" name="__codelineno-0-171"></a> }

2289 +<a id="__codelineno-0-172" name="__codelineno-0-172"></a>

2290 +<a id="__codelineno-0-173" name="__codelineno-0-173"></a> index_summary = self._collect_shards()

2291 +<a id="__codelineno-0-174" name="__codelineno-0-174"></a> if not index_summary["success"]:

2292 +<a id="__codelineno-0-175" name="__codelineno-0-175"></a> return index_summary

2293 +<a id="__codelineno-0-176" name="__codelineno-0-176"></a>

2294 +<a id="__codelineno-0-177" name="__codelineno-0-177"></a> return {

2295 +<a id="__codelineno-0-178" name="__codelineno-0-178"></a> "message": "Successfully collected shards",

2296 +<a id="__codelineno-0-179" name="__codelineno-0-179"></a> "success": True,

2297 +<a id="__codelineno-0-180" name="__codelineno-0-180"></a> "shards": index_summary["shards"],

2298 +<a id="__codelineno-0-181" name="__codelineno-0-181"></a> }

2299 +<a id="__codelineno-0-182" name="__codelineno-0-182"></a>

2300 +<a id="__codelineno-0-183" name="__codelineno-0-183"></a> def _collect_shards(self) -> Dict[str, object]:

2301 +<a id="__codelineno-0-184" name="__codelineno-0-184"></a> """

2302 +<a id="__codelineno-0-185" name="__codelineno-0-185"></a> Collect shard details from the Wazuh-Indexer's Elasticsearch cluster.

2303 +<a id="__codelineno-0-186" name="__codelineno-0-186"></a>

2304 +<a id="__codelineno-0-187" name="__codelineno-0-187"></a> Returns:

2305 +<a id="__codelineno-0-188" name="__codelineno-0-188"></a> dict: A dictionary containing success status, a message, and potentially the shard details.

2306 +<a id="__codelineno-0-189" name="__codelineno-0-189"></a> """

2307 +<a id="__codelineno-0-190" name="__codelineno-0-190"></a> try:

2308 +<a id="__codelineno-0-191" name="__codelineno-0-191"></a> shards = self.es.cat.shards(format="json")

2309 +<a id="__codelineno-0-192" name="__codelineno-0-192"></a> shards_list = self._format_shards(shards)

2310 +<a id="__codelineno-0-193" name="__codelineno-0-193"></a> return {

2311 +<a id="__codelineno-0-194" name="__codelineno-0-194"></a> "message": "Successfully collected shards",

2312 +<a id="__codelineno-0-195" name="__codelineno-0-195"></a> "success": True,

2313 +<a id="__codelineno-0-196" name="__codelineno-0-196"></a> "shards": shards_list,

2314 +<a id="__codelineno-0-197" name="__codelineno-0-197"></a> }

2315 +<a id="__codelineno-0-198" name="__codelineno-0-198"></a> except Exception as e:

2316 +<a id="__codelineno-0-199" name="__codelineno-0-199"></a> logger.error(f"Failed to collect shards: {e}")

2317 +<a id="__codelineno-0-200" name="__codelineno-0-200"></a> return {"message": "Failed to collect shards", "success": False}

2318 +<a id="__codelineno-0-201" name="__codelineno-0-201"></a>

2319 +<a id="__codelineno-0-202" name="__codelineno-0-202"></a> def _format_shards(self, shards):

2320 +<a id="__codelineno-0-203" name="__codelineno-0-203"></a> """

2321 +<a id="__codelineno-0-204" name="__codelineno-0-204"></a> Format the shard details into a list of dictionaries. Each dictionary contains index name, shard number, shard state, shard size, and node name.

2322 +<a id="__codelineno-0-205" name="__codelineno-0-205"></a>

2323 +<a id="__codelineno-0-206" name="__codelineno-0-206"></a> Args:

2324 +<a id="__codelineno-0-207" name="__codelineno-0-207"></a> shards: Shard details from Elasticsearch.

2325 +<a id="__codelineno-0-208" name="__codelineno-0-208"></a>

2326 +<a id="__codelineno-0-209" name="__codelineno-0-209"></a> Returns:

2327 +<a id="__codelineno-0-210" name="__codelineno-0-210"></a> list: A list of dictionaries containing formatted shard details.

2328 +<a id="__codelineno-0-211" name="__codelineno-0-211"></a> """

2329 +<a id="__codelineno-0-212" name="__codelineno-0-212"></a> return [

2330 +<a id="__codelineno-0-213" name="__codelineno-0-213"></a> {

2331 +<a id="__codelineno-0-214" name="__codelineno-0-214"></a> "index": shard["index"],

2332 +<a id="__codelineno-0-215" name="__codelineno-0-215"></a> "shard": shard["shard"],

2333 +<a id="__codelineno-0-216" name="__codelineno-0-216"></a> "state": shard["state"],

2334 +<a id="__codelineno-0-217" name="__codelineno-0-217"></a> "size": shard["store"],

2335 +<a id="__codelineno-0-218" name="__codelineno-0-218"></a> "node": shard["node"],

2336 +<a id="__codelineno-0-219" name="__codelineno-0-219"></a> }

2337 +<a id="__codelineno-0-220" name="__codelineno-0-220"></a> for shard in shards

2338 +<a id="__codelineno-0-221" name="__codelineno-0-221"></a> ]

2339 +</code></pre></div></td></tr></table></div>

2340 + </details>

2341 +

2342 +

2343 +

2344 + <div class="doc doc-children">

2345 +

2346 +

2347 +

2348 +

2349 +

2350 +

2351 +

2352 +

2353 +

2354 +<div class="doc doc-object doc-function">

2355 +

2356 +

2357 +

2358 +<h3 id="app.services.WazuhIndexer.cluster.ClusterService.__init__" class="doc doc-heading">

2359 +<code class="highlight language-python">__init__()</code>

2360 +

2361 +</h3>

2362 +

2363 +

2364 + <div class="doc doc-contents ">

2365 +

2366 + Initialize the ClusterService with the details of the Wazuh-Indexer and initialize the Elasticsearch client.

2367 +

2368 + <details class="quote">

2369 + <summary>Source code in <code>app\services\WazuhIndexer\cluster.py</code></summary>

2370 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-15">15</a>

2371 +<a href="#__codelineno-0-16">16</a>

2372 +<a href="#__codelineno-0-17">17</a>

2373 +<a href="#__codelineno-0-18">18</a>

2374 +<a href="#__codelineno-0-19">19</a>

2375 +<a href="#__codelineno-0-20">20</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-15" name="__codelineno-0-15"></a>def __init__(self):

2376 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> """

2377 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> Initialize the ClusterService with the details of the Wazuh-Indexer and initialize the Elasticsearch client.

2378 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> """

2379 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> self._collect_wazuhindexer_details()

2380 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> self._initialize_es_client()

2381 +</code></pre></div></td></tr></table></div>

2382 + </details>

2383 + </div>

2384 +

2385 +</div>

2386 +

2387 +<div class="doc doc-object doc-function">

2388 +

2389 +

2390 +

2391 +<h3 id="app.services.WazuhIndexer.cluster.ClusterService.collect_cluster_health" class="doc doc-heading">

2392 +<code class="highlight language-python">collect_cluster_health()</code>

2393 +

2394 +</h3>

2395 +

2396 +

2397 + <div class="doc doc-contents ">

2398 +

2399 + Collect health details of the Elasticsearch cluster from the Wazuh-Indexer.

2400 +

2401 + Returns:

2402 + <table>

2403 + <thead>

2404 + <tr>

2405 +<th>Name</th> <th>Type</th>

2406 + <th>Description</th>

2407 + </tr>

2408 + </thead>

2409 + <tbody>

2410 + <tr>

2411 +<td><code>dict</code></td> <td>

2412 + <code>Dict[str, object]</code>

2413 + </td>

2414 + <td>

2415 + <div class="doc-md-description">

2416 + A dictionary containing success status, a message, and potentially the cluster health details.

2417 + </div>

2418 + </td>

2419 + </tr>

2420 + </tbody>

2421 + </table>

2422 +

2423 + <details class="quote">

2424 + <summary>Source code in <code>app\services\WazuhIndexer\cluster.py</code></summary>

2425 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-119">119</a>

2426 +<a href="#__codelineno-0-120">120</a>

2427 +<a href="#__codelineno-0-121">121</a>

2428 +<a href="#__codelineno-0-122">122</a>

2429 +<a href="#__codelineno-0-123">123</a>

2430 +<a href="#__codelineno-0-124">124</a>

2431 +<a href="#__codelineno-0-125">125</a>

2432 +<a href="#__codelineno-0-126">126</a>

2433 +<a href="#__codelineno-0-127">127</a>

2434 +<a href="#__codelineno-0-128">128</a>

2435 +<a href="#__codelineno-0-129">129</a>

2436 +<a href="#__codelineno-0-130">130</a>

2437 +<a href="#__codelineno-0-131">131</a>

2438 +<a href="#__codelineno-0-132">132</a>

2439 +<a href="#__codelineno-0-133">133</a>

2440 +<a href="#__codelineno-0-134">134</a>

2441 +<a href="#__codelineno-0-135">135</a>

2442 +<a href="#__codelineno-0-136">136</a>

2443 +<a href="#__codelineno-0-137">137</a>

2444 +<a href="#__codelineno-0-138">138</a>

2445 +<a href="#__codelineno-0-139">139</a>

2446 +<a href="#__codelineno-0-140">140</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-119" name="__codelineno-0-119"></a>def collect_cluster_health(self) -> Dict[str, object]:

2447 +<a id="__codelineno-0-120" name="__codelineno-0-120"></a> """

2448 +<a id="__codelineno-0-121" name="__codelineno-0-121"></a> Collect health details of the Elasticsearch cluster from the Wazuh-Indexer.

2449 +<a id="__codelineno-0-122" name="__codelineno-0-122"></a>

2450 +<a id="__codelineno-0-123" name="__codelineno-0-123"></a> Returns:

2451 +<a id="__codelineno-0-124" name="__codelineno-0-124"></a> dict: A dictionary containing success status, a message, and potentially the cluster health details.

2452 +<a id="__codelineno-0-125" name="__codelineno-0-125"></a> """

2453 +<a id="__codelineno-0-126" name="__codelineno-0-126"></a> if not self._are_details_collected():

2454 +<a id="__codelineno-0-127" name="__codelineno-0-127"></a> return {

2455 +<a id="__codelineno-0-128" name="__codelineno-0-128"></a> "message": "Failed to collect Wazuh-Indexer details",

2456 +<a id="__codelineno-0-129" name="__codelineno-0-129"></a> "success": False,

2457 +<a id="__codelineno-0-130" name="__codelineno-0-130"></a> }

2458 +<a id="__codelineno-0-131" name="__codelineno-0-131"></a>

2459 +<a id="__codelineno-0-132" name="__codelineno-0-132"></a> index_summary = self._collect_cluster_health()

2460 +<a id="__codelineno-0-133" name="__codelineno-0-133"></a> if not index_summary["success"]:

2461 +<a id="__codelineno-0-134" name="__codelineno-0-134"></a> return index_summary

2462 +<a id="__codelineno-0-135" name="__codelineno-0-135"></a>

2463 +<a id="__codelineno-0-136" name="__codelineno-0-136"></a> return {

2464 +<a id="__codelineno-0-137" name="__codelineno-0-137"></a> "message": "Successfully collected cluster health",

2465 +<a id="__codelineno-0-138" name="__codelineno-0-138"></a> "success": True,

2466 +<a id="__codelineno-0-139" name="__codelineno-0-139"></a> "cluster_health": index_summary["cluster_health"],

2467 +<a id="__codelineno-0-140" name="__codelineno-0-140"></a> }

2468 +</code></pre></div></td></tr></table></div>

2469 + </details>

2470 + </div>

2471 +

2472 +</div>

2473 +

2474 +<div class="doc doc-object doc-function">

2475 +

2476 +

2477 +

2478 +<h3 id="app.services.WazuhIndexer.cluster.ClusterService.collect_node_allocation" class="doc doc-heading">

2479 +<code class="highlight language-python">collect_node_allocation()</code>

2480 +

2481 +</h3>

2482 +

2483 +

2484 + <div class="doc doc-contents ">

2485 +

2486 + Collect node allocation details from the Wazuh-Indexer's Elasticsearch cluster.

2487 +

2488 + Returns:

2489 + <table>

2490 + <thead>

2491 + <tr>

2492 +<th>Name</th> <th>Type</th>

2493 + <th>Description</th>

2494 + </tr>

2495 + </thead>

2496 + <tbody>

2497 + <tr>

2498 +<td><code>dict</code></td> <td>

2499 + <code>Dict[str, object]</code>

2500 + </td>

2501 + <td>

2502 + <div class="doc-md-description">

2503 + A dictionary containing success status, a message, and potentially the node allocation details.

2504 + </div>

2505 + </td>

2506 + </tr>

2507 + </tbody>

2508 + </table>

2509 +

2510 + <details class="quote">

2511 + <summary>Source code in <code>app\services\WazuhIndexer\cluster.py</code></summary>

2512 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-56">56</a>

2513 +<a href="#__codelineno-0-57">57</a>

2514 +<a href="#__codelineno-0-58">58</a>

2515 +<a href="#__codelineno-0-59">59</a>

2516 +<a href="#__codelineno-0-60">60</a>

2517 +<a href="#__codelineno-0-61">61</a>

2518 +<a href="#__codelineno-0-62">62</a>

2519 +<a href="#__codelineno-0-63">63</a>

2520 +<a href="#__codelineno-0-64">64</a>

2521 +<a href="#__codelineno-0-65">65</a>

2522 +<a href="#__codelineno-0-66">66</a>

2523 +<a href="#__codelineno-0-67">67</a>

2524 +<a href="#__codelineno-0-68">68</a>

2525 +<a href="#__codelineno-0-69">69</a>

2526 +<a href="#__codelineno-0-70">70</a>

2527 +<a href="#__codelineno-0-71">71</a>

2528 +<a href="#__codelineno-0-72">72</a>

2529 +<a href="#__codelineno-0-73">73</a>

2530 +<a href="#__codelineno-0-74">74</a>

2531 +<a href="#__codelineno-0-75">75</a>

2532 +<a href="#__codelineno-0-76">76</a>

2533 +<a href="#__codelineno-0-77">77</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-56" name="__codelineno-0-56"></a>def collect_node_allocation(self) -> Dict[str, object]:

2534 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> """

2535 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> Collect node allocation details from the Wazuh-Indexer's Elasticsearch cluster.

2536 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a>

2537 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> Returns:

2538 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> dict: A dictionary containing success status, a message, and potentially the node allocation details.

2539 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> """

2540 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> if not self._are_details_collected():

2541 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> return {

2542 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> "message": "Failed to collect Wazuh-Indexer details",

2543 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> "success": False,

2544 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> }

2545 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a>

2546 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> index_summary = self._collect_node_allocation()

2547 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> if not index_summary["success"]:

2548 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> return index_summary

2549 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a>

2550 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> return {

2551 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> "message": "Successfully collected node allocation",

2552 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> "success": True,

2553 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> "node_allocation": index_summary["node_allocation"],

2554 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> }

2555 +</code></pre></div></td></tr></table></div>

2556 + </details>

2557 + </div>

2558 +

2559 +</div>

2560 +

2561 +<div class="doc doc-object doc-function">

2562 +

2563 +

2564 +

2565 +<h3 id="app.services.WazuhIndexer.cluster.ClusterService.collect_shards" class="doc doc-heading">

2566 +<code class="highlight language-python">collect_shards()</code>

2567 +

2568 +</h3>

2569 +

2570 +

2571 + <div class="doc doc-contents ">

2572 +

2573 + Collect shard details from the Wazuh-Indexer's Elasticsearch cluster.

2574 +

2575 + Returns:

2576 + <table>

2577 + <thead>

2578 + <tr>

2579 +<th>Name</th> <th>Type</th>

2580 + <th>Description</th>

2581 + </tr>

2582 + </thead>

2583 + <tbody>

2584 + <tr>

2585 +<td><code>dict</code></td> <td>

2586 + <code>Dict[str, object]</code>

2587 + </td>

2588 + <td>

2589 + <div class="doc-md-description">

2590 + A dictionary containing success status, a message, and potentially the shard details.

2591 + </div>

2592 + </td>

2593 + </tr>

2594 + </tbody>

2595 + </table>

2596 +

2597 + <details class="quote">

2598 + <summary>Source code in <code>app\services\WazuhIndexer\cluster.py</code></summary>

2599 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-160">160</a>

2600 +<a href="#__codelineno-0-161">161</a>

2601 +<a href="#__codelineno-0-162">162</a>

2602 +<a href="#__codelineno-0-163">163</a>

2603 +<a href="#__codelineno-0-164">164</a>

2604 +<a href="#__codelineno-0-165">165</a>

2605 +<a href="#__codelineno-0-166">166</a>

2606 +<a href="#__codelineno-0-167">167</a>

2607 +<a href="#__codelineno-0-168">168</a>

2608 +<a href="#__codelineno-0-169">169</a>

2609 +<a href="#__codelineno-0-170">170</a>

2610 +<a href="#__codelineno-0-171">171</a>

2611 +<a href="#__codelineno-0-172">172</a>

2612 +<a href="#__codelineno-0-173">173</a>

2613 +<a href="#__codelineno-0-174">174</a>

2614 +<a href="#__codelineno-0-175">175</a>

2615 +<a href="#__codelineno-0-176">176</a>

2616 +<a href="#__codelineno-0-177">177</a>

2617 +<a href="#__codelineno-0-178">178</a>

2618 +<a href="#__codelineno-0-179">179</a>

2619 +<a href="#__codelineno-0-180">180</a>

2620 +<a href="#__codelineno-0-181">181</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-160" name="__codelineno-0-160"></a>def collect_shards(self) -> Dict[str, object]:

2621 +<a id="__codelineno-0-161" name="__codelineno-0-161"></a> """

2622 +<a id="__codelineno-0-162" name="__codelineno-0-162"></a> Collect shard details from the Wazuh-Indexer's Elasticsearch cluster.

2623 +<a id="__codelineno-0-163" name="__codelineno-0-163"></a>

2624 +<a id="__codelineno-0-164" name="__codelineno-0-164"></a> Returns:

2625 +<a id="__codelineno-0-165" name="__codelineno-0-165"></a> dict: A dictionary containing success status, a message, and potentially the shard details.

2626 +<a id="__codelineno-0-166" name="__codelineno-0-166"></a> """

2627 +<a id="__codelineno-0-167" name="__codelineno-0-167"></a> if not self._are_details_collected():

2628 +<a id="__codelineno-0-168" name="__codelineno-0-168"></a> return {

2629 +<a id="__codelineno-0-169" name="__codelineno-0-169"></a> "message": "Failed to collect Wazuh-Indexer details",

2630 +<a id="__codelineno-0-170" name="__codelineno-0-170"></a> "success": False,

2631 +<a id="__codelineno-0-171" name="__codelineno-0-171"></a> }

2632 +<a id="__codelineno-0-172" name="__codelineno-0-172"></a>

2633 +<a id="__codelineno-0-173" name="__codelineno-0-173"></a> index_summary = self._collect_shards()

2634 +<a id="__codelineno-0-174" name="__codelineno-0-174"></a> if not index_summary["success"]:

2635 +<a id="__codelineno-0-175" name="__codelineno-0-175"></a> return index_summary

2636 +<a id="__codelineno-0-176" name="__codelineno-0-176"></a>

2637 +<a id="__codelineno-0-177" name="__codelineno-0-177"></a> return {

2638 +<a id="__codelineno-0-178" name="__codelineno-0-178"></a> "message": "Successfully collected shards",

2639 +<a id="__codelineno-0-179" name="__codelineno-0-179"></a> "success": True,

2640 +<a id="__codelineno-0-180" name="__codelineno-0-180"></a> "shards": index_summary["shards"],

2641 +<a id="__codelineno-0-181" name="__codelineno-0-181"></a> }

2642 +</code></pre></div></td></tr></table></div>

2643 + </details>

2644 + </div>

2645 +

2646 +</div>

2647 +

2648 +

2649 +

2650 + </div>

2651 +

2652 + </div>

2653 +

2654 +</div>

2655 +

2656 +

2657 +

2658 +

2659 + </div>

2660 +

2661 + </div>

2662 +

2663 +</div><h3 id="index-services">Index Services</h3>

2664 +

2665 +

2666 +<div class="doc doc-object doc-module">

2667 +

2668 +

2669 +<a id="app.services.WazuhIndexer.index"></a>

2670 + <div class="doc doc-contents first">

2671 +

2672 +

2673 +

2674 + <div class="doc doc-children">

2675 +

2676 +

2677 +

2678 +

2679 +

2680 +

2681 +

2682 +

2683 +<div class="doc doc-object doc-class">

2684 +

2685 +

2686 +

2687 +<h2 id="app.services.WazuhIndexer.index.IndexService" class="doc doc-heading">

2688 + <code>IndexService</code>

2689 +

2690 +

2691 +</h2>

2692 +

2693 +

2694 + <div class="doc doc-contents ">

2695 +

2696 +

2697 + A service class that encapsulates the logic for pulling indices from the Wazuh-Indexer.

2698 +

2699 +

2700 + <details class="quote">

2701 + <summary>Source code in <code>app\services\WazuhIndexer\index.py</code></summary>

2702 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-10"> 10</a>

2703 +<a href="#__codelineno-0-11"> 11</a>

2704 +<a href="#__codelineno-0-12"> 12</a>

2705 +<a href="#__codelineno-0-13"> 13</a>

2706 +<a href="#__codelineno-0-14"> 14</a>

2707 +<a href="#__codelineno-0-15"> 15</a>

2708 +<a href="#__codelineno-0-16"> 16</a>

2709 +<a href="#__codelineno-0-17"> 17</a>

2710 +<a href="#__codelineno-0-18"> 18</a>

2711 +<a href="#__codelineno-0-19"> 19</a>

2712 +<a href="#__codelineno-0-20"> 20</a>

2713 +<a href="#__codelineno-0-21"> 21</a>

2714 +<a href="#__codelineno-0-22"> 22</a>

2715 +<a href="#__codelineno-0-23"> 23</a>

2716 +<a href="#__codelineno-0-24"> 24</a>

2717 +<a href="#__codelineno-0-25"> 25</a>

2718 +<a href="#__codelineno-0-26"> 26</a>

2719 +<a href="#__codelineno-0-27"> 27</a>

2720 +<a href="#__codelineno-0-28"> 28</a>

2721 +<a href="#__codelineno-0-29"> 29</a>

2722 +<a href="#__codelineno-0-30"> 30</a>

2723 +<a href="#__codelineno-0-31"> 31</a>

2724 +<a href="#__codelineno-0-32"> 32</a>

2725 +<a href="#__codelineno-0-33"> 33</a>

2726 +<a href="#__codelineno-0-34"> 34</a>

2727 +<a href="#__codelineno-0-35"> 35</a>

2728 +<a href="#__codelineno-0-36"> 36</a>

2729 +<a href="#__codelineno-0-37"> 37</a>

2730 +<a href="#__codelineno-0-38"> 38</a>

2731 +<a href="#__codelineno-0-39"> 39</a>

2732 +<a href="#__codelineno-0-40"> 40</a>

2733 +<a href="#__codelineno-0-41"> 41</a>

2734 +<a href="#__codelineno-0-42"> 42</a>

2735 +<a href="#__codelineno-0-43"> 43</a>

2736 +<a href="#__codelineno-0-44"> 44</a>

2737 +<a href="#__codelineno-0-45"> 45</a>

2738 +<a href="#__codelineno-0-46"> 46</a>

2739 +<a href="#__codelineno-0-47"> 47</a>

2740 +<a href="#__codelineno-0-48"> 48</a>

2741 +<a href="#__codelineno-0-49"> 49</a>

2742 +<a href="#__codelineno-0-50"> 50</a>

2743 +<a href="#__codelineno-0-51"> 51</a>

2744 +<a href="#__codelineno-0-52"> 52</a>

2745 +<a href="#__codelineno-0-53"> 53</a>

2746 +<a href="#__codelineno-0-54"> 54</a>

2747 +<a href="#__codelineno-0-55"> 55</a>

2748 +<a href="#__codelineno-0-56"> 56</a>

2749 +<a href="#__codelineno-0-57"> 57</a>

2750 +<a href="#__codelineno-0-58"> 58</a>

2751 +<a href="#__codelineno-0-59"> 59</a>

2752 +<a href="#__codelineno-0-60"> 60</a>

2753 +<a href="#__codelineno-0-61"> 61</a>

2754 +<a href="#__codelineno-0-62"> 62</a>

2755 +<a href="#__codelineno-0-63"> 63</a>

2756 +<a href="#__codelineno-0-64"> 64</a>

2757 +<a href="#__codelineno-0-65"> 65</a>

2758 +<a href="#__codelineno-0-66"> 66</a>

2759 +<a href="#__codelineno-0-67"> 67</a>

2760 +<a href="#__codelineno-0-68"> 68</a>

2761 +<a href="#__codelineno-0-69"> 69</a>

2762 +<a href="#__codelineno-0-70"> 70</a>

2763 +<a href="#__codelineno-0-71"> 71</a>

2764 +<a href="#__codelineno-0-72"> 72</a>

2765 +<a href="#__codelineno-0-73"> 73</a>

2766 +<a href="#__codelineno-0-74"> 74</a>

2767 +<a href="#__codelineno-0-75"> 75</a>

2768 +<a href="#__codelineno-0-76"> 76</a>

2769 +<a href="#__codelineno-0-77"> 77</a>

2770 +<a href="#__codelineno-0-78"> 78</a>

2771 +<a href="#__codelineno-0-79"> 79</a>

2772 +<a href="#__codelineno-0-80"> 80</a>

2773 +<a href="#__codelineno-0-81"> 81</a>

2774 +<a href="#__codelineno-0-82"> 82</a>

2775 +<a href="#__codelineno-0-83"> 83</a>

2776 +<a href="#__codelineno-0-84"> 84</a>

2777 +<a href="#__codelineno-0-85"> 85</a>

2778 +<a href="#__codelineno-0-86"> 86</a>

2779 +<a href="#__codelineno-0-87"> 87</a>

2780 +<a href="#__codelineno-0-88"> 88</a>

2781 +<a href="#__codelineno-0-89"> 89</a>

2782 +<a href="#__codelineno-0-90"> 90</a>

2783 +<a href="#__codelineno-0-91"> 91</a>

2784 +<a href="#__codelineno-0-92"> 92</a>

2785 +<a href="#__codelineno-0-93"> 93</a>

2786 +<a href="#__codelineno-0-94"> 94</a>

2787 +<a href="#__codelineno-0-95"> 95</a>

2788 +<a href="#__codelineno-0-96"> 96</a>

2789 +<a href="#__codelineno-0-97"> 97</a>

2790 +<a href="#__codelineno-0-98"> 98</a>

2791 +<a href="#__codelineno-0-99"> 99</a>

2792 +<a href="#__codelineno-0-100">100</a>

2793 +<a href="#__codelineno-0-101">101</a>

2794 +<a href="#__codelineno-0-102">102</a>

2795 +<a href="#__codelineno-0-103">103</a>

2796 +<a href="#__codelineno-0-104">104</a>

2797 +<a href="#__codelineno-0-105">105</a>

2798 +<a href="#__codelineno-0-106">106</a>

2799 +<a href="#__codelineno-0-107">107</a>

2800 +<a href="#__codelineno-0-108">108</a>

2801 +<a href="#__codelineno-0-109">109</a>

2802 +<a href="#__codelineno-0-110">110</a>

2803 +<a href="#__codelineno-0-111">111</a>

2804 +<a href="#__codelineno-0-112">112</a>

2805 +<a href="#__codelineno-0-113">113</a>

2806 +<a href="#__codelineno-0-114">114</a>

2807 +<a href="#__codelineno-0-115">115</a>

2808 +<a href="#__codelineno-0-116">116</a>

2809 +<a href="#__codelineno-0-117">117</a>

2810 +<a href="#__codelineno-0-118">118</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-10" name="__codelineno-0-10"></a>class IndexService:

2811 +<a id="__codelineno-0-11" name="__codelineno-0-11"></a> """

2812 +<a id="__codelineno-0-12" name="__codelineno-0-12"></a> A service class that encapsulates the logic for pulling indices from the Wazuh-Indexer.

2813 +<a id="__codelineno-0-13" name="__codelineno-0-13"></a> """

2814 +<a id="__codelineno-0-14" name="__codelineno-0-14"></a>

2815 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a> def __init__(self):

2816 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> """

2817 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> Initialize the IndexService with the details of the Wazuh-Indexer and initialize the Elasticsearch client.

2818 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> """

2819 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> self._collect_wazuhindexer_details()

2820 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> self._initialize_es_client()

2821 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a>

2822 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> def _collect_wazuhindexer_details(self):

2823 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> """

2824 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> Collect details of the Wazuh-Indexer. These details include the connector URL, username, and password.

2825 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> """

2826 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> (

2827 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> self.connector_url,

2828 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> self.connector_username,

2829 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> self.connector_password,

2830 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> ) = UniversalService().collect_wazuhindexer_details("Wazuh-Indexer")

2831 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a>

2832 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> def _initialize_es_client(self):

2833 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> """

2834 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> Initialize the Elasticsearch client with the details of the Wazuh-Indexer.

2835 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> """

2836 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> self.es = Elasticsearch(

2837 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> [self.connector_url],

2838 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> http_auth=(self.connector_username, self.connector_password),

2839 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> verify_certs=False,

2840 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> timeout=15,

2841 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> max_retries=10,

2842 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> retry_on_timeout=False,

2843 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> )

2844 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a>

2845 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> def _are_details_collected(self) -> bool:

2846 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> """

2847 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> Check whether the details of the Wazuh-Indexer have been collected.

2848 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a>

2849 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> Returns:

2850 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> bool: True if all details have been collected, False otherwise.

2851 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> """

2852 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> return all(

2853 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> [self.connector_url, self.connector_username, self.connector_password],

2854 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> )

2855 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a>

2856 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> def collect_indices_summary(self) -> Dict[str, object]:

2857 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> """

2858 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> Collect summary information for each index from the Wazuh-Indexer's Elasticsearch cluster.

2859 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a>

2860 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> Returns:

2861 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> dict: A dictionary containing success status, a message, and potentially the indices summary.

2862 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> """

2863 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> if not self._are_details_collected():

2864 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> return {

2865 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> "message": "Failed to collect Wazuh-Indexer details",

2866 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> "success": False,

2867 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> }

2868 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a>

2869 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> index_summary = self._collect_indices()

2870 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> if not index_summary["success"]:

2871 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> return index_summary

2872 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a>

2873 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> summary = self._format_indices_summary(index_summary["indices"])

2874 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a>

2875 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> return {

2876 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> "message": "Successfully collected indices summary",

2877 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> "success": True,

2878 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> "indices": summary,

2879 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> }

2880 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a>

2881 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> def _format_indices_summary(self, indices: Dict[str, object]) -> Dict[str, object]:

2882 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> """

2883 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> Format the indices summary into a list of dictionaries. Each dictionary contains index name, health status, document count, store size, and replica count.

2884 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a>

2885 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> Args:

2886 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> indices (dict): Indices summary from Elasticsearch.

2887 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a>

2888 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> Returns:

2889 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> list: A list of dictionaries containing formatted indices summary.

2890 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> """

2891 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> return [

2892 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> {

2893 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a> "index": index["index"],

2894 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> "health": index["health"],

2895 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> "docs_count": index["docs.count"],

2896 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> "store_size": index["store.size"],

2897 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> "replica_count": index["rep"],

2898 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> }

2899 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a> for index in indices

2900 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> ]

2901 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a>

2902 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> def _collect_indices(self) -> Dict[str, object]:

2903 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> """

2904 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a> Collect indices from the Wazuh-Indexer's Elasticsearch cluster.

2905 +<a id="__codelineno-0-105" name="__codelineno-0-105"></a>

2906 +<a id="__codelineno-0-106" name="__codelineno-0-106"></a> Returns:

2907 +<a id="__codelineno-0-107" name="__codelineno-0-107"></a> dict: A dictionary containing success status, a message, and potentially the indices.

2908 +<a id="__codelineno-0-108" name="__codelineno-0-108"></a> """

2909 +<a id="__codelineno-0-109" name="__codelineno-0-109"></a> try:

2910 +<a id="__codelineno-0-110" name="__codelineno-0-110"></a> indices = self.es.cat.indices(format="json")

2911 +<a id="__codelineno-0-111" name="__codelineno-0-111"></a> return {

2912 +<a id="__codelineno-0-112" name="__codelineno-0-112"></a> "message": "Successfully collected indices",

2913 +<a id="__codelineno-0-113" name="__codelineno-0-113"></a> "success": True,

2914 +<a id="__codelineno-0-114" name="__codelineno-0-114"></a> "indices": indices,

2915 +<a id="__codelineno-0-115" name="__codelineno-0-115"></a> }

2916 +<a id="__codelineno-0-116" name="__codelineno-0-116"></a> except Exception as e:

2917 +<a id="__codelineno-0-117" name="__codelineno-0-117"></a> logger.error(e)

2918 +<a id="__codelineno-0-118" name="__codelineno-0-118"></a> return {"message": "Failed to collect indices", "success": False}

2919 +</code></pre></div></td></tr></table></div>

2920 + </details>

2921 +

2922 +

2923 +

2924 + <div class="doc doc-children">

2925 +

2926 +

2927 +

2928 +

2929 +

2930 +

2931 +

2932 +

2933 +

2934 +<div class="doc doc-object doc-function">

2935 +

2936 +

2937 +

2938 +<h3 id="app.services.WazuhIndexer.index.IndexService.__init__" class="doc doc-heading">

2939 +<code class="highlight language-python">__init__()</code>

2940 +

2941 +</h3>

2942 +

2943 +

2944 + <div class="doc doc-contents ">

2945 +

2946 + Initialize the IndexService with the details of the Wazuh-Indexer and initialize the Elasticsearch client.

2947 +

2948 + <details class="quote">

2949 + <summary>Source code in <code>app\services\WazuhIndexer\index.py</code></summary>

2950 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-15">15</a>

2951 +<a href="#__codelineno-0-16">16</a>

2952 +<a href="#__codelineno-0-17">17</a>

2953 +<a href="#__codelineno-0-18">18</a>

2954 +<a href="#__codelineno-0-19">19</a>

2955 +<a href="#__codelineno-0-20">20</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-15" name="__codelineno-0-15"></a>def __init__(self):

2956 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> """

2957 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> Initialize the IndexService with the details of the Wazuh-Indexer and initialize the Elasticsearch client.

2958 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> """

2959 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> self._collect_wazuhindexer_details()

2960 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> self._initialize_es_client()

2961 +</code></pre></div></td></tr></table></div>

2962 + </details>

2963 + </div>

2964 +

2965 +</div>

2966 +

2967 +<div class="doc doc-object doc-function">

2968 +

2969 +

2970 +

2971 +<h3 id="app.services.WazuhIndexer.index.IndexService.collect_indices_summary" class="doc doc-heading">

2972 +<code class="highlight language-python">collect_indices_summary()</code>

2973 +

2974 +</h3>

2975 +

2976 +

2977 + <div class="doc doc-contents ">

2978 +

2979 + Collect summary information for each index from the Wazuh-Indexer's Elasticsearch cluster.

2980 +

2981 + Returns:

2982 + <table>

2983 + <thead>

2984 + <tr>

2985 +<th>Name</th> <th>Type</th>

2986 + <th>Description</th>

2987 + </tr>

2988 + </thead>

2989 + <tbody>

2990 + <tr>

2991 +<td><code>dict</code></td> <td>

2992 + <code>Dict[str, object]</code>

2993 + </td>

2994 + <td>

2995 + <div class="doc-md-description">

2996 + A dictionary containing success status, a message, and potentially the indices summary.

2997 + </div>

2998 + </td>

2999 + </tr>

3000 + </tbody>

3001 + </table>

3002 +

3003 + <details class="quote">

3004 + <summary>Source code in <code>app\services\WazuhIndexer\index.py</code></summary>

3005 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-56">56</a>

3006 +<a href="#__codelineno-0-57">57</a>

3007 +<a href="#__codelineno-0-58">58</a>

3008 +<a href="#__codelineno-0-59">59</a>

3009 +<a href="#__codelineno-0-60">60</a>

3010 +<a href="#__codelineno-0-61">61</a>

3011 +<a href="#__codelineno-0-62">62</a>

3012 +<a href="#__codelineno-0-63">63</a>

3013 +<a href="#__codelineno-0-64">64</a>

3014 +<a href="#__codelineno-0-65">65</a>

3015 +<a href="#__codelineno-0-66">66</a>

3016 +<a href="#__codelineno-0-67">67</a>

3017 +<a href="#__codelineno-0-68">68</a>

3018 +<a href="#__codelineno-0-69">69</a>

3019 +<a href="#__codelineno-0-70">70</a>

3020 +<a href="#__codelineno-0-71">71</a>

3021 +<a href="#__codelineno-0-72">72</a>

3022 +<a href="#__codelineno-0-73">73</a>

3023 +<a href="#__codelineno-0-74">74</a>

3024 +<a href="#__codelineno-0-75">75</a>

3025 +<a href="#__codelineno-0-76">76</a>

3026 +<a href="#__codelineno-0-77">77</a>

3027 +<a href="#__codelineno-0-78">78</a>

3028 +<a href="#__codelineno-0-79">79</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-56" name="__codelineno-0-56"></a>def collect_indices_summary(self) -> Dict[str, object]:

3029 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> """

3030 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> Collect summary information for each index from the Wazuh-Indexer's Elasticsearch cluster.

3031 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a>

3032 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> Returns:

3033 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> dict: A dictionary containing success status, a message, and potentially the indices summary.

3034 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> """

3035 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> if not self._are_details_collected():

3036 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> return {

3037 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> "message": "Failed to collect Wazuh-Indexer details",

3038 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> "success": False,

3039 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> }

3040 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a>

3041 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> index_summary = self._collect_indices()

3042 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> if not index_summary["success"]:

3043 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> return index_summary

3044 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a>

3045 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> summary = self._format_indices_summary(index_summary["indices"])

3046 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a>

3047 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> return {

3048 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> "message": "Successfully collected indices summary",

3049 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> "success": True,

3050 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> "indices": summary,

3051 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> }

3052 +</code></pre></div></td></tr></table></div>

3053 + </details>

3054 + </div>

3055 +

3056 +</div>

3057 +

3058 +

3059 +

3060 + </div>

3061 +

3062 + </div>

3063 +

3064 +</div>

3065 +

3066 +

3067 +

3068 +

3069 + </div>

3070 +

3071 + </div>

3072 +

3073 +</div><h3 id="universal-services">Universal Services</h3>

3074 +

3075 +

3076 +<div class="doc doc-object doc-module">

3077 +

3078 +

3079 +<a id="app.services.WazuhIndexer.universal"></a>

3080 + <div class="doc doc-contents first">

3081 +

3082 +

3083 +

3084 + <div class="doc doc-children">

3085 +

3086 +

3087 +

3088 +

3089 +

3090 +

3091 +

3092 +

3093 +<div class="doc doc-object doc-class">

3094 +

3095 +

3096 +

3097 +<h2 id="app.services.WazuhIndexer.universal.UniversalService" class="doc doc-heading">

3098 + <code>UniversalService</code>

3099 +

3100 +

3101 +</h2>

3102 +

3103 +

3104 + <div class="doc doc-contents ">

3105 +

3106 +

3107 + A service class that encapsulates the logic for polling messages from the Wazuh-Indexer.

3108 +

3109 +

3110 + <details class="quote">

3111 + <summary>Source code in <code>app\services\WazuhIndexer\universal.py</code></summary>

3112 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-20"> 20</a>

3113 +<a href="#__codelineno-0-21"> 21</a>

3114 +<a href="#__codelineno-0-22"> 22</a>

3115 +<a href="#__codelineno-0-23"> 23</a>

3116 +<a href="#__codelineno-0-24"> 24</a>

3117 +<a href="#__codelineno-0-25"> 25</a>

3118 +<a href="#__codelineno-0-26"> 26</a>

3119 +<a href="#__codelineno-0-27"> 27</a>

3120 +<a href="#__codelineno-0-28"> 28</a>

3121 +<a href="#__codelineno-0-29"> 29</a>

3122 +<a href="#__codelineno-0-30"> 30</a>

3123 +<a href="#__codelineno-0-31"> 31</a>

3124 +<a href="#__codelineno-0-32"> 32</a>

3125 +<a href="#__codelineno-0-33"> 33</a>

3126 +<a href="#__codelineno-0-34"> 34</a>

3127 +<a href="#__codelineno-0-35"> 35</a>

3128 +<a href="#__codelineno-0-36"> 36</a>

3129 +<a href="#__codelineno-0-37"> 37</a>

3130 +<a href="#__codelineno-0-38"> 38</a>

3131 +<a href="#__codelineno-0-39"> 39</a>

3132 +<a href="#__codelineno-0-40"> 40</a>

3133 +<a href="#__codelineno-0-41"> 41</a>

3134 +<a href="#__codelineno-0-42"> 42</a>

3135 +<a href="#__codelineno-0-43"> 43</a>

3136 +<a href="#__codelineno-0-44"> 44</a>

3137 +<a href="#__codelineno-0-45"> 45</a>

3138 +<a href="#__codelineno-0-46"> 46</a>

3139 +<a href="#__codelineno-0-47"> 47</a>

3140 +<a href="#__codelineno-0-48"> 48</a>

3141 +<a href="#__codelineno-0-49"> 49</a>

3142 +<a href="#__codelineno-0-50"> 50</a>

3143 +<a href="#__codelineno-0-51"> 51</a>

3144 +<a href="#__codelineno-0-52"> 52</a>

3145 +<a href="#__codelineno-0-53"> 53</a>

3146 +<a href="#__codelineno-0-54"> 54</a>

3147 +<a href="#__codelineno-0-55"> 55</a>

3148 +<a href="#__codelineno-0-56"> 56</a>

3149 +<a href="#__codelineno-0-57"> 57</a>

3150 +<a href="#__codelineno-0-58"> 58</a>

3151 +<a href="#__codelineno-0-59"> 59</a>

3152 +<a href="#__codelineno-0-60"> 60</a>

3153 +<a href="#__codelineno-0-61"> 61</a>

3154 +<a href="#__codelineno-0-62"> 62</a>

3155 +<a href="#__codelineno-0-63"> 63</a>

3156 +<a href="#__codelineno-0-64"> 64</a>

3157 +<a href="#__codelineno-0-65"> 65</a>

3158 +<a href="#__codelineno-0-66"> 66</a>

3159 +<a href="#__codelineno-0-67"> 67</a>

3160 +<a href="#__codelineno-0-68"> 68</a>

3161 +<a href="#__codelineno-0-69"> 69</a>

3162 +<a href="#__codelineno-0-70"> 70</a>

3163 +<a href="#__codelineno-0-71"> 71</a>

3164 +<a href="#__codelineno-0-72"> 72</a>

3165 +<a href="#__codelineno-0-73"> 73</a>

3166 +<a href="#__codelineno-0-74"> 74</a>

3167 +<a href="#__codelineno-0-75"> 75</a>

3168 +<a href="#__codelineno-0-76"> 76</a>

3169 +<a href="#__codelineno-0-77"> 77</a>

3170 +<a href="#__codelineno-0-78"> 78</a>

3171 +<a href="#__codelineno-0-79"> 79</a>

3172 +<a href="#__codelineno-0-80"> 80</a>

3173 +<a href="#__codelineno-0-81"> 81</a>

3174 +<a href="#__codelineno-0-82"> 82</a>

3175 +<a href="#__codelineno-0-83"> 83</a>

3176 +<a href="#__codelineno-0-84"> 84</a>

3177 +<a href="#__codelineno-0-85"> 85</a>

3178 +<a href="#__codelineno-0-86"> 86</a>

3179 +<a href="#__codelineno-0-87"> 87</a>

3180 +<a href="#__codelineno-0-88"> 88</a>

3181 +<a href="#__codelineno-0-89"> 89</a>

3182 +<a href="#__codelineno-0-90"> 90</a>

3183 +<a href="#__codelineno-0-91"> 91</a>

3184 +<a href="#__codelineno-0-92"> 92</a>

3185 +<a href="#__codelineno-0-93"> 93</a>

3186 +<a href="#__codelineno-0-94"> 94</a>

3187 +<a href="#__codelineno-0-95"> 95</a>

3188 +<a href="#__codelineno-0-96"> 96</a>

3189 +<a href="#__codelineno-0-97"> 97</a>

3190 +<a href="#__codelineno-0-98"> 98</a>

3191 +<a href="#__codelineno-0-99"> 99</a>

3192 +<a href="#__codelineno-0-100">100</a>

3193 +<a href="#__codelineno-0-101">101</a>

3194 +<a href="#__codelineno-0-102">102</a>

3195 +<a href="#__codelineno-0-103">103</a>

3196 +<a href="#__codelineno-0-104">104</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-20" name="__codelineno-0-20"></a>class UniversalService:

3197 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> """

3198 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> A service class that encapsulates the logic for polling messages from the Wazuh-Indexer.

3199 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> """

3200 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a>

3201 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> def __init__(self) -> None:

3202 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> self.collect_wazuhindexer_details("Wazuh-Indexer")

3203 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> (

3204 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> self.connector_url,

3205 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> self.connector_username,

3206 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> self.connector_password,

3207 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> ) = self.collect_wazuhindexer_details("Wazuh-Indexer")

3208 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> self.es = Elasticsearch(

3209 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> [self.connector_url],

3210 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> http_auth=(self.connector_username, self.connector_password),

3211 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> verify_certs=False,

3212 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> timeout=15,

3213 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> max_retries=10,

3214 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> retry_on_timeout=False,

3215 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> )

3216 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a>

3217 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> def collect_wazuhindexer_details(self, connector_name: str):

3218 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> """

3219 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> Collects the details of the Wazuh-Indexer connector.

3220 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a>

3221 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> Args:

3222 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> connector_name (str): The name of the Wazuh-Indexer connector.

3223 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a>

3224 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> Returns:

3225 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> tuple: A tuple containing the connection URL, username, and password.

3226 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> """

3227 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> connector_instance = connector_factory.create(connector_name, connector_name)

3228 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> connection_successful = connector_instance.verify_connection()

3229 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> if connection_successful:

3230 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> connection_details = Connector.get_connector_info_from_db(connector_name)

3231 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> return (

3232 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> connection_details.get("connector_url"),

3233 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> connection_details.get("connector_username"),

3234 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> connection_details.get("connector_password"),

3235 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> )

3236 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> else:

3237 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> return None, None, None

3238 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a>

3239 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> def collect_indices(self):

3240 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> """

3241 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Collects the indices from the Wazuh-Indexer.

3242 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a>

3243 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> Returns:

3244 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> list: A list containing the indices.

3245 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> """

3246 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> if (

3247 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> self.connector_url is None

3248 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> or self.connector_username is None

3249 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> or self.connector_password is None

3250 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> ):

3251 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> return {

3252 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> "message": "Failed to collect Wazuh-Indexer details",

3253 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> "success": False,

3254 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> }

3255 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a>

3256 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> indices = self._collect_indices()

3257 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a>

3258 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> if indices["success"]:

3259 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> return indices

3260 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a>

3261 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> return {"message": "Failed to collect indices", "success": False}

3262 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a>

3263 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> def _collect_indices(self) -> Dict[str, object]:

3264 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> """

3265 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> Wazuh-Indexer query to retrievce all indices.

3266 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a>

3267 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> Returns:

3268 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> Dict[str, object]: _description_

3269 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a> """

3270 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> try:

3271 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> indices_dict = self.es.indices.get_alias("*")

3272 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> indices_list = list(indices_dict.keys())

3273 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> return {

3274 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> "message": "Successfully collected indices",

3275 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a> "success": True,

3276 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> "indices_list": indices_list,

3277 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> }

3278 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> except Exception as e:

3279 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> logger.error(f"Failed to collect indices: {e}")

3280 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a> return {"message": "Failed to collect indices", "success": False}

3281 +</code></pre></div></td></tr></table></div>

3282 + </details>

3283 +

3284 +

3285 +

3286 + <div class="doc doc-children">

3287 +

3288 +

3289 +

3290 +

3291 +

3292 +

3293 +

3294 +

3295 +

3296 +<div class="doc doc-object doc-function">

3297 +

3298 +

3299 +

3300 +<h3 id="app.services.WazuhIndexer.universal.UniversalService.collect_indices" class="doc doc-heading">

3301 +<code class="highlight language-python">collect_indices()</code>

3302 +

3303 +</h3>

3304 +

3305 +

3306 + <div class="doc doc-contents ">

3307 +

3308 + Collects the indices from the Wazuh-Indexer.

3309 +

3310 + Returns:

3311 + <table>

3312 + <thead>

3313 + <tr>

3314 +<th>Name</th> <th>Type</th>

3315 + <th>Description</th>

3316 + </tr>

3317 + </thead>

3318 + <tbody>

3319 + <tr>

3320 +<td><code>list</code></td> <td>

3321 + </td>

3322 + <td>

3323 + <div class="doc-md-description">

3324 + A list containing the indices.

3325 + </div>

3326 + </td>

3327 + </tr>

3328 + </tbody>

3329 + </table>

3330 +

3331 + <details class="quote">

3332 + <summary>Source code in <code>app\services\WazuhIndexer\universal.py</code></summary>

3333 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-63">63</a>

3334 +<a href="#__codelineno-0-64">64</a>

3335 +<a href="#__codelineno-0-65">65</a>

3336 +<a href="#__codelineno-0-66">66</a>

3337 +<a href="#__codelineno-0-67">67</a>

3338 +<a href="#__codelineno-0-68">68</a>

3339 +<a href="#__codelineno-0-69">69</a>

3340 +<a href="#__codelineno-0-70">70</a>

3341 +<a href="#__codelineno-0-71">71</a>

3342 +<a href="#__codelineno-0-72">72</a>

3343 +<a href="#__codelineno-0-73">73</a>

3344 +<a href="#__codelineno-0-74">74</a>

3345 +<a href="#__codelineno-0-75">75</a>

3346 +<a href="#__codelineno-0-76">76</a>

3347 +<a href="#__codelineno-0-77">77</a>

3348 +<a href="#__codelineno-0-78">78</a>

3349 +<a href="#__codelineno-0-79">79</a>

3350 +<a href="#__codelineno-0-80">80</a>

3351 +<a href="#__codelineno-0-81">81</a>

3352 +<a href="#__codelineno-0-82">82</a>

3353 +<a href="#__codelineno-0-83">83</a>

3354 +<a href="#__codelineno-0-84">84</a>

3355 +<a href="#__codelineno-0-85">85</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-63" name="__codelineno-0-63"></a>def collect_indices(self):

3356 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> """

3357 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> Collects the indices from the Wazuh-Indexer.

3358 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a>

3359 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> Returns:

3360 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> list: A list containing the indices.

3361 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> """

3362 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> if (

3363 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> self.connector_url is None

3364 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> or self.connector_username is None

3365 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> or self.connector_password is None

3366 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> ):

3367 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> return {

3368 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> "message": "Failed to collect Wazuh-Indexer details",

3369 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> "success": False,

3370 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> }

3371 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a>

3372 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> indices = self._collect_indices()

3373 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a>

3374 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> if indices["success"]:

3375 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> return indices

3376 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a>

3377 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> return {"message": "Failed to collect indices", "success": False}

3378 +</code></pre></div></td></tr></table></div>

3379 + </details>

3380 + </div>

3381 +

3382 +</div>

3383 +

3384 +<div class="doc doc-object doc-function">

3385 +

3386 +

3387 +

3388 +<h3 id="app.services.WazuhIndexer.universal.UniversalService.collect_wazuhindexer_details" class="doc doc-heading">

3389 +<code class="highlight language-python">collect_wazuhindexer_details(connector_name)</code>

3390 +

3391 +</h3>

3392 +

3393 +

3394 + <div class="doc doc-contents ">

3395 +

3396 + Collects the details of the Wazuh-Indexer connector.

3397 +

3398 + Parameters:

3399 + <table>

3400 + <thead>

3401 + <tr>

3402 + <th>Name</th>

3403 + <th>Type</th>

3404 + <th>Description</th>

3405 + <th>Default</th>

3406 + </tr>

3407 + </thead>

3408 + <tbody>

3409 + <tr>

3410 + <td><code>connector_name</code></td>

3411 + <td>

3412 + <code>str</code>

3413 + </td>

3414 + <td>

3415 + <div class="doc-md-description">

3416 + The name of the Wazuh-Indexer connector.

3417 + </div>

3418 + </td>

3419 + <td>

3420 + required

3421 + </td>

3422 + </tr>

3423 + </tbody>

3424 + </table>

3425 +

3426 + Returns:

3427 + <table>

3428 + <thead>

3429 + <tr>

3430 +<th>Name</th> <th>Type</th>

3431 + <th>Description</th>

3432 + </tr>

3433 + </thead>

3434 + <tbody>

3435 + <tr>

3436 +<td><code>tuple</code></td> <td>

3437 + </td>

3438 + <td>

3439 + <div class="doc-md-description">

3440 + A tuple containing the connection URL, username, and password.

3441 + </div>

3442 + </td>

3443 + </tr>

3444 + </tbody>

3445 + </table>

3446 +

3447 + <details class="quote">

3448 + <summary>Source code in <code>app\services\WazuhIndexer\universal.py</code></summary>

3449 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-41">41</a>

3450 +<a href="#__codelineno-0-42">42</a>

3451 +<a href="#__codelineno-0-43">43</a>

3452 +<a href="#__codelineno-0-44">44</a>

3453 +<a href="#__codelineno-0-45">45</a>

3454 +<a href="#__codelineno-0-46">46</a>

3455 +<a href="#__codelineno-0-47">47</a>

3456 +<a href="#__codelineno-0-48">48</a>

3457 +<a href="#__codelineno-0-49">49</a>

3458 +<a href="#__codelineno-0-50">50</a>

3459 +<a href="#__codelineno-0-51">51</a>

3460 +<a href="#__codelineno-0-52">52</a>

3461 +<a href="#__codelineno-0-53">53</a>

3462 +<a href="#__codelineno-0-54">54</a>

3463 +<a href="#__codelineno-0-55">55</a>

3464 +<a href="#__codelineno-0-56">56</a>

3465 +<a href="#__codelineno-0-57">57</a>

3466 +<a href="#__codelineno-0-58">58</a>

3467 +<a href="#__codelineno-0-59">59</a>

3468 +<a href="#__codelineno-0-60">60</a>

3469 +<a href="#__codelineno-0-61">61</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-41" name="__codelineno-0-41"></a>def collect_wazuhindexer_details(self, connector_name: str):

3470 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> """

3471 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> Collects the details of the Wazuh-Indexer connector.

3472 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a>

3473 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> Args:

3474 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> connector_name (str): The name of the Wazuh-Indexer connector.

3475 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a>

3476 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> Returns:

3477 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> tuple: A tuple containing the connection URL, username, and password.

3478 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> """

3479 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> connector_instance = connector_factory.create(connector_name, connector_name)

3480 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> connection_successful = connector_instance.verify_connection()

3481 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> if connection_successful:

3482 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> connection_details = Connector.get_connector_info_from_db(connector_name)

3483 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> return (

3484 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> connection_details.get("connector_url"),

3485 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> connection_details.get("connector_username"),

3486 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> connection_details.get("connector_password"),

3487 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> )

3488 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> else:

3489 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> return None, None, None

3490 +</code></pre></div></td></tr></table></div>

3491 + </details>

3492 + </div>

3493 +

3494 +</div>

3495 +

3496 +

3497 +

3498 + </div>

3499 +

3500 + </div>

3501 +

3502 +</div>

3503 +

3504 +

3505 +

3506 +

3507 + </div>

3508 +

3509 + </div>

3510 +

3511 +</div>

3512 +

3513 +

3514 +

3515 +

3516 +

3517 +

3518 + </article>

3519 + </div>

3520 +

3521 +

3522 + <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>

3523 +

3524 + </div>

3525 +

3526 + <button type="button" class="md-top md-icon" data-md-component="top" hidden>

3527 + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg>

3528 + Back to top

3529 + </button>

3530 +

3531 + </main>

3532 +

3533 + <footer class="md-footer">

3534 +

3535 + <div class="md-footer-meta md-typeset">

3536 + <div class="md-footer-meta__inner md-grid">

3537 + <div class="md-copyright">

3538 +

3539 + <div class="md-copyright__highlight">

3541 +

3542 + </div>

3543 +

3544 +

3545 + Made with

3546 + <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">

3547 + Material for MkDocs

3548 + </a>

3549 +

3550 +</div>

3551 +

3552 + </div>

3553 + </div>

3554 +</footer>

3555 +

3556 + </div>

3557 + <div class="md-dialog" data-md-component="dialog">

3558 + <div class="md-dialog__inner md-typeset"></div>

3559 + </div>

3560 +

3561 + <script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.sections", "toc.integrate", "navigation.top", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy"], "search": "../assets/javascripts/workers/search.74e28a9f.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>

3562 +

3563 +

3564 + <script src="../assets/javascripts/bundle.220ee61c.min.js"></script>

3565 +

3566 +

3567 + </body>

3568 +</html>

\ No newline at end of file

backend/site/wazuhmanager/index.html

+6596 -895

@@ -12,6 +12,8 @@

12 <link rel="prev" href="../graylog/">

15 + <link rel="next" href="../velociraptor/">

16 +

17 <link rel="icon" href="../assets/images/favicon.png">

18 <meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.18">

@@ -196,8 +198,8 @@

198

199

200 <li class="md-tabs__item">

199 - <a href="../alerts/" class="md-tabs__link">

200 - Alerts

201 + <a href="../wazuhindexer/" class="md-tabs__link">

202 + Wazuh-Indexer

203 </a>

204 </li>

205

@@ -208,8 +210,8 @@

210

211

212 <li class="md-tabs__item">

211 - <a href="../artifacts/" class="md-tabs__link">

212 - Artifacts

213 + <a href="../dfiriris/" class="md-tabs__link">

214 + Dfir-Iris

215 </a>

216 </li>

217

@@ -220,8 +222,8 @@

222

223

224 <li class="md-tabs__item">

223 - <a href="../cases/" class="md-tabs__link">

224 - Cases

225 + <a href="../graylog/" class="md-tabs__link">

226 + Graylog

227 </a>

228 </li>

229

@@ -229,11 +231,13 @@

231

232

233

234 +

235 +

236

237

238 <li class="md-tabs__item">

235 - <a href="../graylog/" class="md-tabs__link">

236 - Graylog

239 + <a href="./" class="md-tabs__link md-tabs__link--active">

240 + Wazuh-Manager

241 </a>

242 </li>

243

@@ -241,13 +245,23 @@

245

246

247

244 -

248 +

249 +

250 + <li class="md-tabs__item">

251 + <a href="../velociraptor/" class="md-tabs__link">

252 + Velociraptor

253 + </a>

254 + </li>

255 +

256 +

257 +

258 +

259

260

261

262 <li class="md-tabs__item">

249 - <a href="./" class="md-tabs__link md-tabs__link--active">

250 - Wazuh-Manager

263 + <a href="../shuffle/" class="md-tabs__link">

264 + Shuffle

265 </a>

266 </li>

267

@@ -339,23 +353,8 @@

353

354

355 <li class="md-nav__item">

342 - <a href="../alerts/" class="md-nav__link">

343 - Alerts

344 - </a>

345 - </li>

346 -

347 -

348 -

349 -

350 -

351 -

352 -

353 -

354 -

355 -

356 - <li class="md-nav__item">

357 - <a href="../artifacts/" class="md-nav__link">

358 - Artifacts

356 + <a href="../wazuhindexer/" class="md-nav__link">

357 + Wazuh-Indexer

358 </a>

359 </li>

360

@@ -369,8 +368,8 @@

368

369

370 <li class="md-nav__item">

372 - <a href="../cases/" class="md-nav__link">

373 - Cases

371 + <a href="../dfiriris/" class="md-nav__link">

372 + Dfir-Iris

373 </a>

374 </li>

375

@@ -618,233 +617,5229 @@

617

618 </li>

619

621 - </ul>

620 + <li class="md-nav__item">

621 + <a href="#app.services.WazuhManager.agent" class="md-nav__link">

622 + app.services.WazuhManager.agent

623 + </a>

624

623 -</nav>

625 +</li>

626

625 - </li>

626 -

627 -

628 -

629 - </ul>

630 -</nav>

631 - </div>

632 - </div>

633 - </div>

634 -

635 -

636 -

637 -

638 - <div class="md-content" data-md-component="content">

639 - <article class="md-content__inner md-typeset">

640 -

641 -

642 -

643 -

644 - <h1>Wazuh-Manager</h1>

645 -

646 -<h2 id="wazuh-manager-overview">Wazuh-Manager Overview</h2>

647 -<h3 id="wazuh-manager-model">Wazuh-Manager Model</h3>

648 -

649 -

650 -<div class="doc doc-object doc-module">

651 -

652 -

653 -<a id="app.models.rules"></a>

654 - <div class="doc doc-contents first">

655 -

627 + <li class="md-nav__item">

628 + <a href="#app.services.WazuhManager.agent.WazuhHttpRequests" class="md-nav__link">

629 + WazuhHttpRequests

630 + </a>

631

657 -

658 - <div class="doc doc-children">

659 -

660 -

661 -

662 -

663 -

664 -

665 -

666 -

667 -<div class="doc doc-object doc-class">

668 -

669 -

670 -

671 -<h2 id="app.models.rules.DisabledRules" class="doc doc-heading">

672 - <code>DisabledRules</code>

673 -

674 -

675 -</h2>

676 -

677 -

678 - <div class="doc doc-contents ">

679 -

680 - Bases: <code>db.Model</code>

681 -

632 + <nav class="md-nav" aria-label="WazuhHttpRequests">

633 + <ul class="md-nav__list">

634 +

635 + <li class="md-nav__item">

636 + <a href="#app.services.WazuhManager.agent.WazuhHttpRequests.__init__" class="md-nav__link">

637 + __init__()

638 + </a>

639

683 - Class for disabled rules which stores the rule ID, previous configuration, new configuration, reason for

684 -disabling, date disabled, and the length of time the rule will be disabled for.

685 -This class inherits from SQLAlchemy's Model class.

686 -:ivar id: Unique integer ID of the rule.

687 -:ivar rule_id: ID of the rule.

688 -:ivar previous_level: Previous level configuration of the rule.

689 -:ivar new_level: New level configuration of the rule.

690 -:ivar reason_for_disabling: Reason for disabling the rule.

691 -:ivar date_disabled: Date when the rule was disabled.

692 -:ivar length_of_time: Length of time the rule will be disabled for.

693 -

694 -

695 - <details class="quote">

696 - <summary>Source code in <code>app\models\rules.py</code></summary>

697 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-13">13</a>

698 -<a href="#__codelineno-0-14">14</a>

699 -<a href="#__codelineno-0-15">15</a>

700 -<a href="#__codelineno-0-16">16</a>

701 -<a href="#__codelineno-0-17">17</a>

702 -<a href="#__codelineno-0-18">18</a>

703 -<a href="#__codelineno-0-19">19</a>

704 -<a href="#__codelineno-0-20">20</a>

705 -<a href="#__codelineno-0-21">21</a>

706 -<a href="#__codelineno-0-22">22</a>

707 -<a href="#__codelineno-0-23">23</a>

708 -<a href="#__codelineno-0-24">24</a>

709 -<a href="#__codelineno-0-25">25</a>

710 -<a href="#__codelineno-0-26">26</a>

711 -<a href="#__codelineno-0-27">27</a>

712 -<a href="#__codelineno-0-28">28</a>

713 -<a href="#__codelineno-0-29">29</a>

714 -<a href="#__codelineno-0-30">30</a>

715 -<a href="#__codelineno-0-31">31</a>

716 -<a href="#__codelineno-0-32">32</a>

717 -<a href="#__codelineno-0-33">33</a>

718 -<a href="#__codelineno-0-34">34</a>

719 -<a href="#__codelineno-0-35">35</a>

720 -<a href="#__codelineno-0-36">36</a>

721 -<a href="#__codelineno-0-37">37</a>

722 -<a href="#__codelineno-0-38">38</a>

723 -<a href="#__codelineno-0-39">39</a>

724 -<a href="#__codelineno-0-40">40</a>

725 -<a href="#__codelineno-0-41">41</a>

726 -<a href="#__codelineno-0-42">42</a>

727 -<a href="#__codelineno-0-43">43</a>

728 -<a href="#__codelineno-0-44">44</a>

729 -<a href="#__codelineno-0-45">45</a>

730 -<a href="#__codelineno-0-46">46</a>

731 -<a href="#__codelineno-0-47">47</a>

732 -<a href="#__codelineno-0-48">48</a>

733 -<a href="#__codelineno-0-49">49</a>

734 -<a href="#__codelineno-0-50">50</a>

735 -<a href="#__codelineno-0-51">51</a>

736 -<a href="#__codelineno-0-52">52</a>

737 -<a href="#__codelineno-0-53">53</a>

738 -<a href="#__codelineno-0-54">54</a>

739 -<a href="#__codelineno-0-55">55</a>

740 -<a href="#__codelineno-0-56">56</a>

741 -<a href="#__codelineno-0-57">57</a>

742 -<a href="#__codelineno-0-58">58</a>

743 -<a href="#__codelineno-0-59">59</a>

744 -<a href="#__codelineno-0-60">60</a>

745 -<a href="#__codelineno-0-61">61</a>

746 -<a href="#__codelineno-0-62">62</a>

747 -<a href="#__codelineno-0-63">63</a>

748 -<a href="#__codelineno-0-64">64</a>

749 -<a href="#__codelineno-0-65">65</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-13" name="__codelineno-0-13"></a>class DisabledRules(db.Model):

750 -<a id="__codelineno-0-14" name="__codelineno-0-14"></a> """

751 -<a id="__codelineno-0-15" name="__codelineno-0-15"></a> Class for disabled rules which stores the rule ID, previous configuration, new configuration, reason for

752 -<a id="__codelineno-0-16" name="__codelineno-0-16"></a> disabling, date disabled, and the length of time the rule will be disabled for.

753 -<a id="__codelineno-0-17" name="__codelineno-0-17"></a> This class inherits from SQLAlchemy's Model class.

754 -<a id="__codelineno-0-18" name="__codelineno-0-18"></a>

755 -<a id="__codelineno-0-19" name="__codelineno-0-19"></a> :ivar id: Unique integer ID of the rule.

756 -<a id="__codelineno-0-20" name="__codelineno-0-20"></a> :ivar rule_id: ID of the rule.

757 -<a id="__codelineno-0-21" name="__codelineno-0-21"></a> :ivar previous_level: Previous level configuration of the rule.

758 -<a id="__codelineno-0-22" name="__codelineno-0-22"></a> :ivar new_level: New level configuration of the rule.

759 -<a id="__codelineno-0-23" name="__codelineno-0-23"></a> :ivar reason_for_disabling: Reason for disabling the rule.

760 -<a id="__codelineno-0-24" name="__codelineno-0-24"></a> :ivar date_disabled: Date when the rule was disabled.

761 -<a id="__codelineno-0-25" name="__codelineno-0-25"></a> :ivar length_of_time: Length of time the rule will be disabled for.

762 -<a id="__codelineno-0-26" name="__codelineno-0-26"></a> """

763 -<a id="__codelineno-0-27" name="__codelineno-0-27"></a>

764 -<a id="__codelineno-0-28" name="__codelineno-0-28"></a> id: Column[Integer] = db.Column(db.Integer, primary_key=True)

765 -<a id="__codelineno-0-29" name="__codelineno-0-29"></a> rule_id: Column[String] = db.Column(db.String(100))

766 -<a id="__codelineno-0-30" name="__codelineno-0-30"></a> previous_level: Column[String] = db.Column(db.String(1000))

767 -<a id="__codelineno-0-31" name="__codelineno-0-31"></a> new_level: Column[String] = db.Column(db.String(1000))

768 -<a id="__codelineno-0-32" name="__codelineno-0-32"></a> reason_for_disabling: Column[String] = db.Column(db.String(100))

769 -<a id="__codelineno-0-33" name="__codelineno-0-33"></a> date_disabled: Column[DateTime] = db.Column(db.DateTime, default=datetime.utcnow)

770 -<a id="__codelineno-0-34" name="__codelineno-0-34"></a> length_of_time: Column[Integer] = db.Column(db.Integer)

771 -<a id="__codelineno-0-35" name="__codelineno-0-35"></a>

772 -<a id="__codelineno-0-36" name="__codelineno-0-36"></a> def __init__(

773 -<a id="__codelineno-0-37" name="__codelineno-0-37"></a> self,

774 -<a id="__codelineno-0-38" name="__codelineno-0-38"></a> rule_id: str,

775 -<a id="__codelineno-0-39" name="__codelineno-0-39"></a> previous_level: str,

776 -<a id="__codelineno-0-40" name="__codelineno-0-40"></a> new_level: str,

777 -<a id="__codelineno-0-41" name="__codelineno-0-41"></a> reason_for_disabling: str,

778 -<a id="__codelineno-0-42" name="__codelineno-0-42"></a> length_of_time: int,

779 -<a id="__codelineno-0-43" name="__codelineno-0-43"></a> ):

780 -<a id="__codelineno-0-44" name="__codelineno-0-44"></a> """

781 -<a id="__codelineno-0-45" name="__codelineno-0-45"></a> Initialize a new instance of the DisabledRules class.

782 -<a id="__codelineno-0-46" name="__codelineno-0-46"></a>

783 -<a id="__codelineno-0-47" name="__codelineno-0-47"></a> :param rule_id: The ID of the rule.

784 -<a id="__codelineno-0-48" name="__codelineno-0-48"></a> :param previous_level: The previous level configuration of the rule.

785 -<a id="__codelineno-0-49" name="__codelineno-0-49"></a> :param new_level: The new level configuration of the rule.

786 -<a id="__codelineno-0-50" name="__codelineno-0-50"></a> :param reason_for_disabling: The reason for disabling the rule.

787 -<a id="__codelineno-0-51" name="__codelineno-0-51"></a> :param length_of_time: The length of time the rule will be disabled for.

788 -<a id="__codelineno-0-52" name="__codelineno-0-52"></a> """

789 -<a id="__codelineno-0-53" name="__codelineno-0-53"></a> self.rule_id = rule_id

790 -<a id="__codelineno-0-54" name="__codelineno-0-54"></a> self.previous_level = previous_level

791 -<a id="__codelineno-0-55" name="__codelineno-0-55"></a> self.new_level = new_level

792 -<a id="__codelineno-0-56" name="__codelineno-0-56"></a> self.reason_for_disabling = reason_for_disabling

793 -<a id="__codelineno-0-57" name="__codelineno-0-57"></a> self.length_of_time = length_of_time

794 -<a id="__codelineno-0-58" name="__codelineno-0-58"></a>

795 -<a id="__codelineno-0-59" name="__codelineno-0-59"></a> def __repr__(self) -> str:

796 -<a id="__codelineno-0-60" name="__codelineno-0-60"></a> """

797 -<a id="__codelineno-0-61" name="__codelineno-0-61"></a> Returns a string representation of the DisabledRules instance.

798 -<a id="__codelineno-0-62" name="__codelineno-0-62"></a>

799 -<a id="__codelineno-0-63" name="__codelineno-0-63"></a> :return: A string representation of the rule ID.

800 -<a id="__codelineno-0-64" name="__codelineno-0-64"></a> """

801 -<a id="__codelineno-0-65" name="__codelineno-0-65"></a> return f"<DisabledRules {self.rule_id}>"

802 -</code></pre></div></td></tr></table></div>

803 - </details>

804 -

640 +</li>

641 +

642 + <li class="md-nav__item">

643 + <a href="#app.services.WazuhManager.agent.WazuhHttpRequests.delete_request" class="md-nav__link">

644 + delete_request()

645 + </a>

646

806 -

807 - <div class="doc doc-children">

808 -

809 -

810 -

811 -

812 -

813 -

814 -

815 -

816 -

817 -<div class="doc doc-object doc-function">

818 -

819 -

820 -

821 -<h3 id="app.models.rules.DisabledRules.__init__" class="doc doc-heading">

822 -<code class="highlight language-python">__init__(rule_id, previous_level, new_level, reason_for_disabling, length_of_time)</code>

823 -

824 -</h3>

825 -

826 -

827 - <div class="doc doc-contents ">

647 +</li>

648 +

649 + </ul>

650 + </nav>

651

829 - Initialize a new instance of the DisabledRules class.

830 -:param rule_id: The ID of the rule.

652 +</li>

653 +

654 + <li class="md-nav__item">

655 + <a href="#app.services.WazuhManager.agent.WazuhManagerAgentService" class="md-nav__link">

656 + WazuhManagerAgentService

657 + </a>

658 +

659 + <nav class="md-nav" aria-label="WazuhManagerAgentService">

660 + <ul class="md-nav__list">

661 +

662 + <li class="md-nav__item">

663 + <a href="#app.services.WazuhManager.agent.WazuhManagerAgentService.__init__" class="md-nav__link">

664 + __init__()

665 + </a>

666 +

667 +</li>

668 +

669 + <li class="md-nav__item">

670 + <a href="#app.services.WazuhManager.agent.WazuhManagerAgentService.collect_agents" class="md-nav__link">

671 + collect_agents()

672 + </a>

673 +

674 +</li>

675 +

676 + <li class="md-nav__item">

677 + <a href="#app.services.WazuhManager.agent.WazuhManagerAgentService.delete_agent" class="md-nav__link">

678 + delete_agent()

679 + </a>

680 +

681 +</li>

682 +

683 + </ul>

684 + </nav>

685 +

686 +</li>

687 +

688 + <li class="md-nav__item">

689 + <a href="#app.services.WazuhManager.disabled_rule" class="md-nav__link">

690 + app.services.WazuhManager.disabled_rule

691 + </a>

692 +

693 +</li>

694 +

695 + <li class="md-nav__item">

696 + <a href="#app.services.WazuhManager.disabled_rule.DisableRuleService" class="md-nav__link">

697 + DisableRuleService

698 + </a>

699 +

700 + <nav class="md-nav" aria-label="DisableRuleService">

701 + <ul class="md-nav__list">

702 +

703 + <li class="md-nav__item">

704 + <a href="#app.services.WazuhManager.disabled_rule.DisableRuleService.__init__" class="md-nav__link">

705 + __init__()

706 + </a>

707 +

708 +</li>

709 +

710 + <li class="md-nav__item">

711 + <a href="#app.services.WazuhManager.disabled_rule.DisableRuleService.disable_rule" class="md-nav__link">

712 + disable_rule()

713 + </a>

714 +

715 +</li>

716 +

717 + </ul>

718 + </nav>

719 +

720 +</li>

721 +

722 + <li class="md-nav__item">

723 + <a href="#app.services.WazuhManager.disabled_rule.WazuhHttpRequests" class="md-nav__link">

724 + WazuhHttpRequests

725 + </a>

726 +

727 + <nav class="md-nav" aria-label="WazuhHttpRequests">

728 + <ul class="md-nav__list">

729 +

730 + <li class="md-nav__item">

731 + <a href="#app.services.WazuhManager.disabled_rule.WazuhHttpRequests.__init__" class="md-nav__link">

732 + __init__()

733 + </a>

734 +

735 +</li>

736 +

737 + <li class="md-nav__item">

738 + <a href="#app.services.WazuhManager.disabled_rule.WazuhHttpRequests.get_request" class="md-nav__link">

739 + get_request()

740 + </a>

741 +

742 +</li>

743 +

744 + <li class="md-nav__item">

745 + <a href="#app.services.WazuhManager.disabled_rule.WazuhHttpRequests.put_request" class="md-nav__link">

746 + put_request()

747 + </a>

748 +

749 +</li>

750 +

751 + </ul>

752 + </nav>

753 +

754 +</li>

755 +

756 + <li class="md-nav__item">

757 + <a href="#app.services.WazuhManager.enabled_rule" class="md-nav__link">

758 + app.services.WazuhManager.enabled_rule

759 + </a>

760 +

761 +</li>

762 +

763 + <li class="md-nav__item">

764 + <a href="#app.services.WazuhManager.enabled_rule.EnableRuleService" class="md-nav__link">

765 + EnableRuleService

766 + </a>

767 +

768 + <nav class="md-nav" aria-label="EnableRuleService">

769 + <ul class="md-nav__list">

770 +

771 + <li class="md-nav__item">

772 + <a href="#app.services.WazuhManager.enabled_rule.EnableRuleService.__init__" class="md-nav__link">

773 + __init__()

774 + </a>

775 +

776 +</li>

777 +

778 + <li class="md-nav__item">

779 + <a href="#app.services.WazuhManager.enabled_rule.EnableRuleService.enable_rule" class="md-nav__link">

780 + enable_rule()

781 + </a>

782 +

783 +</li>

784 +

785 + </ul>

786 + </nav>

787 +

788 +</li>

789 +

790 + <li class="md-nav__item">

791 + <a href="#app.services.WazuhManager.enabled_rule.WazuhHttpRequests" class="md-nav__link">

792 + WazuhHttpRequests

793 + </a>

794 +

795 + <nav class="md-nav" aria-label="WazuhHttpRequests">

796 + <ul class="md-nav__list">

797 +

798 + <li class="md-nav__item">

799 + <a href="#app.services.WazuhManager.enabled_rule.WazuhHttpRequests.__init__" class="md-nav__link">

800 + __init__()

801 + </a>

802 +

803 +</li>

804 +

805 + <li class="md-nav__item">

806 + <a href="#app.services.WazuhManager.enabled_rule.WazuhHttpRequests.get_request" class="md-nav__link">

807 + get_request()

808 + </a>

809 +

810 +</li>

811 +

812 + <li class="md-nav__item">

813 + <a href="#app.services.WazuhManager.enabled_rule.WazuhHttpRequests.put_request" class="md-nav__link">

814 + put_request()

815 + </a>

816 +

817 +</li>

818 +

819 + </ul>

820 + </nav>

821 +

822 +</li>

823 +

824 + <li class="md-nav__item">

825 + <a href="#app.services.WazuhManager.universal" class="md-nav__link">

826 + app.services.WazuhManager.universal

827 + </a>

828 +

829 +</li>

830 +

831 + <li class="md-nav__item">

832 + <a href="#app.services.WazuhManager.universal.UniversalService" class="md-nav__link">

833 + UniversalService

834 + </a>

835 +

836 + <nav class="md-nav" aria-label="UniversalService">

837 + <ul class="md-nav__list">

838 +

839 + <li class="md-nav__item">

840 + <a href="#app.services.WazuhManager.universal.UniversalService.__init__" class="md-nav__link">

841 + __init__()

842 + </a>

843 +

844 +</li>

845 +

846 + <li class="md-nav__item">

847 + <a href="#app.services.WazuhManager.universal.UniversalService.collect_wazuhmanager_details" class="md-nav__link">

848 + collect_wazuhmanager_details()

849 + </a>

850 +

851 +</li>

852 +

853 + <li class="md-nav__item">

854 + <a href="#app.services.WazuhManager.universal.UniversalService.get_auth_token" class="md-nav__link">

855 + get_auth_token()

856 + </a>

857 +

858 +</li>

859 +

860 + <li class="md-nav__item">

861 + <a href="#app.services.WazuhManager.universal.UniversalService.restart_service" class="md-nav__link">

862 + restart_service()

863 + </a>

864 +

865 +</li>

866 +

867 + </ul>

868 + </nav>

869 +

870 +</li>

871 +

872 + <li class="md-nav__item">

873 + <a href="#app.services.WazuhManager.vulnerability" class="md-nav__link">

874 + app.services.WazuhManager.vulnerability

875 + </a>

876 +

877 +</li>

878 +

879 + <li class="md-nav__item">

880 + <a href="#app.services.WazuhManager.vulnerability.VulnerabilityService" class="md-nav__link">

881 + VulnerabilityService

882 + </a>

883 +

884 + <nav class="md-nav" aria-label="VulnerabilityService">

885 + <ul class="md-nav__list">

886 +

887 + <li class="md-nav__item">

888 + <a href="#app.services.WazuhManager.vulnerability.VulnerabilityService.__init__" class="md-nav__link">

889 + __init__()

890 + </a>

891 +

892 +</li>

893 +

894 + <li class="md-nav__item">

895 + <a href="#app.services.WazuhManager.vulnerability.VulnerabilityService.agent_vulnerabilities" class="md-nav__link">

896 + agent_vulnerabilities()

897 + </a>

898 +

899 +</li>

900 +

901 + </ul>

902 + </nav>

903 +

904 +</li>

905 +

906 + <li class="md-nav__item">

907 + <a href="#app.services.WazuhManager.vulnerability.WazuhHttpRequests" class="md-nav__link">

908 + WazuhHttpRequests

909 + </a>

910 +

911 + <nav class="md-nav" aria-label="WazuhHttpRequests">

912 + <ul class="md-nav__list">

913 +

914 + <li class="md-nav__item">

915 + <a href="#app.services.WazuhManager.vulnerability.WazuhHttpRequests.__init__" class="md-nav__link">

916 + __init__()

917 + </a>

918 +

919 +</li>

920 +

921 + <li class="md-nav__item">

922 + <a href="#app.services.WazuhManager.vulnerability.WazuhHttpRequests.get_request" class="md-nav__link">

923 + get_request()

924 + </a>

925 +

926 +</li>

927 +

928 + </ul>

929 + </nav>

930 +

931 +</li>

932 +

933 + </ul>

934 +

935 +</nav>

936 +

937 + </li>

938 +

939 +

940 +

941 +

942 +

943 +

944 +

945 +

946 +

947 +

948 + <li class="md-nav__item">

949 + <a href="../velociraptor/" class="md-nav__link">

950 + Velociraptor

951 + </a>

952 + </li>

953 +

954 +

955 +

956 +

957 +

958 +

959 +

960 +

961 +

962 +

963 + <li class="md-nav__item">

964 + <a href="../shuffle/" class="md-nav__link">

965 + Shuffle

966 + </a>

967 + </li>

968 +

969 +

970 +

971 + </ul>

972 +</nav>

973 + </div>

974 + </div>

975 + </div>

976 +

977 +

978 +

979 +

980 + <div class="md-content" data-md-component="content">

981 + <article class="md-content__inner md-typeset">

982 +

983 +

984 +

985 +

986 + <h1>Wazuh-Manager</h1>

987 +

988 +<h2 id="wazuh-manager-overview">Wazuh-Manager Overview</h2>

989 +<h3 id="wazuh-manager-model">Wazuh-Manager Model</h3>

990 +

991 +

992 +<div class="doc doc-object doc-module">

993 +

994 +

995 +<a id="app.models.rules"></a>

996 + <div class="doc doc-contents first">

997 +

998 +

999 +

1000 + <div class="doc doc-children">

1001 +

1002 +

1003 +

1004 +

1005 +

1006 +

1007 +

1008 +

1009 +<div class="doc doc-object doc-class">

1010 +

1011 +

1012 +

1013 +<h2 id="app.models.rules.DisabledRules" class="doc doc-heading">

1014 + <code>DisabledRules</code>

1015 +

1016 +

1017 +</h2>

1018 +

1019 +

1020 + <div class="doc doc-contents ">

1021 +

1022 + Bases: <code>db.Model</code>

1023 +

1024 +

1025 + Class for disabled rules which stores the rule ID, previous configuration, new configuration, reason for

1026 +disabling, date disabled, and the length of time the rule will be disabled for.

1027 +This class inherits from SQLAlchemy's Model class.

1028 +:ivar id: Unique integer ID of the rule.

1029 +:ivar rule_id: ID of the rule.

1030 +:ivar previous_level: Previous level configuration of the rule.

1031 +:ivar new_level: New level configuration of the rule.

1032 +:ivar reason_for_disabling: Reason for disabling the rule.

1033 +:ivar date_disabled: Date when the rule was disabled.

1034 +:ivar length_of_time: Length of time the rule will be disabled for.

1035 +

1036 +

1037 + <details class="quote">

1038 + <summary>Source code in <code>app\models\rules.py</code></summary>

1039 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-13">13</a>

1040 +<a href="#__codelineno-0-14">14</a>

1041 +<a href="#__codelineno-0-15">15</a>

1042 +<a href="#__codelineno-0-16">16</a>

1043 +<a href="#__codelineno-0-17">17</a>

1044 +<a href="#__codelineno-0-18">18</a>

1045 +<a href="#__codelineno-0-19">19</a>

1046 +<a href="#__codelineno-0-20">20</a>

1047 +<a href="#__codelineno-0-21">21</a>

1048 +<a href="#__codelineno-0-22">22</a>

1049 +<a href="#__codelineno-0-23">23</a>

1050 +<a href="#__codelineno-0-24">24</a>

1051 +<a href="#__codelineno-0-25">25</a>

1052 +<a href="#__codelineno-0-26">26</a>

1053 +<a href="#__codelineno-0-27">27</a>

1054 +<a href="#__codelineno-0-28">28</a>

1055 +<a href="#__codelineno-0-29">29</a>

1056 +<a href="#__codelineno-0-30">30</a>

1057 +<a href="#__codelineno-0-31">31</a>

1058 +<a href="#__codelineno-0-32">32</a>

1059 +<a href="#__codelineno-0-33">33</a>

1060 +<a href="#__codelineno-0-34">34</a>

1061 +<a href="#__codelineno-0-35">35</a>

1062 +<a href="#__codelineno-0-36">36</a>

1063 +<a href="#__codelineno-0-37">37</a>

1064 +<a href="#__codelineno-0-38">38</a>

1065 +<a href="#__codelineno-0-39">39</a>

1066 +<a href="#__codelineno-0-40">40</a>

1067 +<a href="#__codelineno-0-41">41</a>

1068 +<a href="#__codelineno-0-42">42</a>

1069 +<a href="#__codelineno-0-43">43</a>

1070 +<a href="#__codelineno-0-44">44</a>

1071 +<a href="#__codelineno-0-45">45</a>

1072 +<a href="#__codelineno-0-46">46</a>

1073 +<a href="#__codelineno-0-47">47</a>

1074 +<a href="#__codelineno-0-48">48</a>

1075 +<a href="#__codelineno-0-49">49</a>

1076 +<a href="#__codelineno-0-50">50</a>

1077 +<a href="#__codelineno-0-51">51</a>

1078 +<a href="#__codelineno-0-52">52</a>

1079 +<a href="#__codelineno-0-53">53</a>

1080 +<a href="#__codelineno-0-54">54</a>

1081 +<a href="#__codelineno-0-55">55</a>

1082 +<a href="#__codelineno-0-56">56</a>

1083 +<a href="#__codelineno-0-57">57</a>

1084 +<a href="#__codelineno-0-58">58</a>

1085 +<a href="#__codelineno-0-59">59</a>

1086 +<a href="#__codelineno-0-60">60</a>

1087 +<a href="#__codelineno-0-61">61</a>

1088 +<a href="#__codelineno-0-62">62</a>

1089 +<a href="#__codelineno-0-63">63</a>

1090 +<a href="#__codelineno-0-64">64</a>

1091 +<a href="#__codelineno-0-65">65</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-13" name="__codelineno-0-13"></a>class DisabledRules(db.Model):

1092 +<a id="__codelineno-0-14" name="__codelineno-0-14"></a> """

1093 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a> Class for disabled rules which stores the rule ID, previous configuration, new configuration, reason for

1094 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> disabling, date disabled, and the length of time the rule will be disabled for.

1095 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> This class inherits from SQLAlchemy's Model class.

1096 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a>

1097 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a> :ivar id: Unique integer ID of the rule.

1098 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> :ivar rule_id: ID of the rule.

1099 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> :ivar previous_level: Previous level configuration of the rule.

1100 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> :ivar new_level: New level configuration of the rule.

1101 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> :ivar reason_for_disabling: Reason for disabling the rule.

1102 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> :ivar date_disabled: Date when the rule was disabled.

1103 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> :ivar length_of_time: Length of time the rule will be disabled for.

1104 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> """

1105 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a>

1106 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> id: Column[Integer] = db.Column(db.Integer, primary_key=True)

1107 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> rule_id: Column[String] = db.Column(db.String(100))

1108 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> previous_level: Column[String] = db.Column(db.String(1000))

1109 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> new_level: Column[String] = db.Column(db.String(1000))

1110 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> reason_for_disabling: Column[String] = db.Column(db.String(100))

1111 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> date_disabled: Column[DateTime] = db.Column(db.DateTime, default=datetime.utcnow)

1112 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> length_of_time: Column[Integer] = db.Column(db.Integer)

1113 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a>

1114 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> def __init__(

1115 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> self,

1116 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> rule_id: str,

1117 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> previous_level: str,

1118 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> new_level: str,

1119 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> reason_for_disabling: str,

1120 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> length_of_time: int,

1121 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> ):

1122 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> """

1123 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> Initialize a new instance of the DisabledRules class.

1124 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a>

1125 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> :param rule_id: The ID of the rule.

1126 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> :param previous_level: The previous level configuration of the rule.

1127 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> :param new_level: The new level configuration of the rule.

1128 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> :param reason_for_disabling: The reason for disabling the rule.

1129 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> :param length_of_time: The length of time the rule will be disabled for.

1130 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> """

1131 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> self.rule_id = rule_id

1132 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> self.previous_level = previous_level

1133 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> self.new_level = new_level

1134 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> self.reason_for_disabling = reason_for_disabling

1135 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> self.length_of_time = length_of_time

1136 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a>

1137 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> def __repr__(self) -> str:

1138 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> """

1139 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> Returns a string representation of the DisabledRules instance.

1140 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a>

1141 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> :return: A string representation of the rule ID.

1142 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> """

1143 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> return f"<DisabledRules {self.rule_id}>"

1144 +</code></pre></div></td></tr></table></div>

1145 + </details>

1146 +

1147 +

1148 +

1149 + <div class="doc doc-children">

1150 +

1151 +

1152 +

1153 +

1154 +

1155 +

1156 +

1157 +

1158 +

1159 +<div class="doc doc-object doc-function">

1160 +

1161 +

1162 +

1163 +<h3 id="app.models.rules.DisabledRules.__init__" class="doc doc-heading">

1164 +<code class="highlight language-python">__init__(rule_id, previous_level, new_level, reason_for_disabling, length_of_time)</code>

1165 +

1166 +</h3>

1167 +

1168 +

1169 + <div class="doc doc-contents ">

1170 +

1171 + Initialize a new instance of the DisabledRules class.

1172 +:param rule_id: The ID of the rule.

1173 :param previous_level: The previous level configuration of the rule.

1174 :param new_level: The new level configuration of the rule.

1175 :param reason_for_disabling: The reason for disabling the rule.

1176 :param length_of_time: The length of time the rule will be disabled for.

1177

1178 <details class="quote">

837 - <summary>Source code in <code>app\models\rules.py</code></summary>

838 - <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-36">36</a>

1179 + <summary>Source code in <code>app\models\rules.py</code></summary>

1180 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-36">36</a>

1181 +<a href="#__codelineno-0-37">37</a>

1182 +<a href="#__codelineno-0-38">38</a>

1183 +<a href="#__codelineno-0-39">39</a>

1184 +<a href="#__codelineno-0-40">40</a>

1185 +<a href="#__codelineno-0-41">41</a>

1186 +<a href="#__codelineno-0-42">42</a>

1187 +<a href="#__codelineno-0-43">43</a>

1188 +<a href="#__codelineno-0-44">44</a>

1189 +<a href="#__codelineno-0-45">45</a>

1190 +<a href="#__codelineno-0-46">46</a>

1191 +<a href="#__codelineno-0-47">47</a>

1192 +<a href="#__codelineno-0-48">48</a>

1193 +<a href="#__codelineno-0-49">49</a>

1194 +<a href="#__codelineno-0-50">50</a>

1195 +<a href="#__codelineno-0-51">51</a>

1196 +<a href="#__codelineno-0-52">52</a>

1197 +<a href="#__codelineno-0-53">53</a>

1198 +<a href="#__codelineno-0-54">54</a>

1199 +<a href="#__codelineno-0-55">55</a>

1200 +<a href="#__codelineno-0-56">56</a>

1201 +<a href="#__codelineno-0-57">57</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-36" name="__codelineno-0-36"></a>def __init__(

1202 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> self,

1203 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> rule_id: str,

1204 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> previous_level: str,

1205 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> new_level: str,

1206 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> reason_for_disabling: str,

1207 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> length_of_time: int,

1208 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a>):

1209 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> """

1210 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> Initialize a new instance of the DisabledRules class.

1211 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a>

1212 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> :param rule_id: The ID of the rule.

1213 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> :param previous_level: The previous level configuration of the rule.

1214 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> :param new_level: The new level configuration of the rule.

1215 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> :param reason_for_disabling: The reason for disabling the rule.

1216 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> :param length_of_time: The length of time the rule will be disabled for.

1217 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> """

1218 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> self.rule_id = rule_id

1219 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> self.previous_level = previous_level

1220 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> self.new_level = new_level

1221 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> self.reason_for_disabling = reason_for_disabling

1222 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> self.length_of_time = length_of_time

1223 +</code></pre></div></td></tr></table></div>

1224 + </details>

1225 + </div>

1226 +

1227 +</div>

1228 +

1229 +<div class="doc doc-object doc-function">

1230 +

1231 +

1232 +

1233 +<h3 id="app.models.rules.DisabledRules.__repr__" class="doc doc-heading">

1234 +<code class="highlight language-python">__repr__()</code>

1235 +

1236 +</h3>

1237 +

1238 +

1239 + <div class="doc doc-contents ">

1240 +

1241 + Returns a string representation of the DisabledRules instance.

1242 +:return: A string representation of the rule ID.

1243 +

1244 + <details class="quote">

1245 + <summary>Source code in <code>app\models\rules.py</code></summary>

1246 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-59">59</a>

1247 +<a href="#__codelineno-0-60">60</a>

1248 +<a href="#__codelineno-0-61">61</a>

1249 +<a href="#__codelineno-0-62">62</a>

1250 +<a href="#__codelineno-0-63">63</a>

1251 +<a href="#__codelineno-0-64">64</a>

1252 +<a href="#__codelineno-0-65">65</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-59" name="__codelineno-0-59"></a>def __repr__(self) -> str:

1253 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> """

1254 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> Returns a string representation of the DisabledRules instance.

1255 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a>

1256 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> :return: A string representation of the rule ID.

1257 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> """

1258 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> return f"<DisabledRules {self.rule_id}>"

1259 +</code></pre></div></td></tr></table></div>

1260 + </details>

1261 + </div>

1262 +

1263 +</div>

1264 +

1265 +

1266 +

1267 + </div>

1268 +

1269 + </div>

1270 +

1271 +</div>

1272 +

1273 +<div class="doc doc-object doc-class">

1274 +

1275 +

1276 +

1277 +<h2 id="app.models.rules.DisabledRulesSchema" class="doc doc-heading">

1278 + <code>DisabledRulesSchema</code>

1279 +

1280 +

1281 +</h2>

1282 +

1283 +

1284 + <div class="doc doc-contents ">

1285 +

1286 + Bases: <code>ma.Schema</code>

1287 +

1288 +

1289 + Schema for serializing and deserializing instances of the DisabledRules class.

1290 +

1291 +

1292 + <details class="quote">

1293 + <summary>Source code in <code>app\models\rules.py</code></summary>

1294 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-68">68</a>

1295 +<a href="#__codelineno-0-69">69</a>

1296 +<a href="#__codelineno-0-70">70</a>

1297 +<a href="#__codelineno-0-71">71</a>

1298 +<a href="#__codelineno-0-72">72</a>

1299 +<a href="#__codelineno-0-73">73</a>

1300 +<a href="#__codelineno-0-74">74</a>

1301 +<a href="#__codelineno-0-75">75</a>

1302 +<a href="#__codelineno-0-76">76</a>

1303 +<a href="#__codelineno-0-77">77</a>

1304 +<a href="#__codelineno-0-78">78</a>

1305 +<a href="#__codelineno-0-79">79</a>

1306 +<a href="#__codelineno-0-80">80</a>

1307 +<a href="#__codelineno-0-81">81</a>

1308 +<a href="#__codelineno-0-82">82</a>

1309 +<a href="#__codelineno-0-83">83</a>

1310 +<a href="#__codelineno-0-84">84</a>

1311 +<a href="#__codelineno-0-85">85</a>

1312 +<a href="#__codelineno-0-86">86</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-68" name="__codelineno-0-68"></a>class DisabledRulesSchema(ma.Schema):

1313 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> """

1314 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> Schema for serializing and deserializing instances of the DisabledRules class.

1315 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> """

1316 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a>

1317 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> class Meta:

1318 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> """

1319 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> Meta class defines the fields to be serialized/deserialized.

1320 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> """

1321 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a>

1322 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> fields: tuple = (

1323 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> "id",

1324 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> "rule_id",

1325 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> "previous_level",

1326 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> "new_level",

1327 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> "reason_for_disabling",

1328 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> "date_disabled",

1329 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> "length_of_time",

1330 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> )

1331 +</code></pre></div></td></tr></table></div>

1332 + </details>

1333 +

1334 +

1335 +

1336 + <div class="doc doc-children">

1337 +

1338 +

1339 +

1340 +

1341 +

1342 +

1343 +

1344 +

1345 +<div class="doc doc-object doc-class">

1346 +

1347 +

1348 +

1349 +<h3 id="app.models.rules.DisabledRulesSchema.Meta" class="doc doc-heading">

1350 + <code>Meta</code>

1351 +

1352 +

1353 +</h3>

1354 +

1355 +

1356 + <div class="doc doc-contents ">

1357 +

1358 +

1359 + Meta class defines the fields to be serialized/deserialized.

1360 +

1361 +

1362 + <details class="quote">

1363 + <summary>Source code in <code>app\models\rules.py</code></summary>

1364 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-73">73</a>

1365 +<a href="#__codelineno-0-74">74</a>

1366 +<a href="#__codelineno-0-75">75</a>

1367 +<a href="#__codelineno-0-76">76</a>

1368 +<a href="#__codelineno-0-77">77</a>

1369 +<a href="#__codelineno-0-78">78</a>

1370 +<a href="#__codelineno-0-79">79</a>

1371 +<a href="#__codelineno-0-80">80</a>

1372 +<a href="#__codelineno-0-81">81</a>

1373 +<a href="#__codelineno-0-82">82</a>

1374 +<a href="#__codelineno-0-83">83</a>

1375 +<a href="#__codelineno-0-84">84</a>

1376 +<a href="#__codelineno-0-85">85</a>

1377 +<a href="#__codelineno-0-86">86</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-73" name="__codelineno-0-73"></a>class Meta:

1378 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> """

1379 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> Meta class defines the fields to be serialized/deserialized.

1380 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> """

1381 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a>

1382 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> fields: tuple = (

1383 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> "id",

1384 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> "rule_id",

1385 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> "previous_level",

1386 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> "new_level",

1387 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> "reason_for_disabling",

1388 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> "date_disabled",

1389 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> "length_of_time",

1390 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> )

1391 +</code></pre></div></td></tr></table></div>

1392 + </details>

1393 +

1394 +

1395 +

1396 + <div class="doc doc-children">

1397 +

1398 +

1399 +

1400 +

1401 +

1402 +

1403 +

1404 +

1405 +

1406 +

1407 +

1408 + </div>

1409 +

1410 + </div>

1411 +

1412 +</div>

1413 +

1414 +

1415 +

1416 +

1417 + </div>

1418 +

1419 + </div>

1420 +

1421 +</div>

1422 +

1423 +

1424 +

1425 +

1426 + </div>

1427 +

1428 + </div>

1429 +

1430 +</div>

1431 +

1432 +<div class="doc doc-object doc-module">

1433 +

1434 +

1435 +<a id="app.models.agents"></a>

1436 + <div class="doc doc-contents first">

1437 +

1438 +

1439 +

1440 + <div class="doc doc-children">

1441 +

1442 +

1443 +

1444 +

1445 +

1446 +

1447 +

1448 +

1449 +<div class="doc doc-object doc-class">

1450 +

1451 +

1452 +

1453 +<h2 id="app.models.agents.AgentMetadata" class="doc doc-heading">

1454 + <code>AgentMetadata</code>

1455 +

1456 +

1457 +</h2>

1458 +

1459 +

1460 + <div class="doc doc-contents ">

1461 +

1462 + Bases: <code>db.Model</code>

1463 +

1464 +

1465 + Class for agent metadata which stores the agent ID, IP address, hostname, OS, last seen timestamp,

1466 +and boolean for critical asset. This class inherits from SQLAlchemy's Model class.

1467 +

1468 +

1469 + <details class="quote">

1470 + <summary>Source code in <code>app\models\agents.py</code></summary>

1471 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-14">14</a>

1472 +<a href="#__codelineno-0-15">15</a>

1473 +<a href="#__codelineno-0-16">16</a>

1474 +<a href="#__codelineno-0-17">17</a>

1475 +<a href="#__codelineno-0-18">18</a>

1476 +<a href="#__codelineno-0-19">19</a>

1477 +<a href="#__codelineno-0-20">20</a>

1478 +<a href="#__codelineno-0-21">21</a>

1479 +<a href="#__codelineno-0-22">22</a>

1480 +<a href="#__codelineno-0-23">23</a>

1481 +<a href="#__codelineno-0-24">24</a>

1482 +<a href="#__codelineno-0-25">25</a>

1483 +<a href="#__codelineno-0-26">26</a>

1484 +<a href="#__codelineno-0-27">27</a>

1485 +<a href="#__codelineno-0-28">28</a>

1486 +<a href="#__codelineno-0-29">29</a>

1487 +<a href="#__codelineno-0-30">30</a>

1488 +<a href="#__codelineno-0-31">31</a>

1489 +<a href="#__codelineno-0-32">32</a>

1490 +<a href="#__codelineno-0-33">33</a>

1491 +<a href="#__codelineno-0-34">34</a>

1492 +<a href="#__codelineno-0-35">35</a>

1493 +<a href="#__codelineno-0-36">36</a>

1494 +<a href="#__codelineno-0-37">37</a>

1495 +<a href="#__codelineno-0-38">38</a>

1496 +<a href="#__codelineno-0-39">39</a>

1497 +<a href="#__codelineno-0-40">40</a>

1498 +<a href="#__codelineno-0-41">41</a>

1499 +<a href="#__codelineno-0-42">42</a>

1500 +<a href="#__codelineno-0-43">43</a>

1501 +<a href="#__codelineno-0-44">44</a>

1502 +<a href="#__codelineno-0-45">45</a>

1503 +<a href="#__codelineno-0-46">46</a>

1504 +<a href="#__codelineno-0-47">47</a>

1505 +<a href="#__codelineno-0-48">48</a>

1506 +<a href="#__codelineno-0-49">49</a>

1507 +<a href="#__codelineno-0-50">50</a>

1508 +<a href="#__codelineno-0-51">51</a>

1509 +<a href="#__codelineno-0-52">52</a>

1510 +<a href="#__codelineno-0-53">53</a>

1511 +<a href="#__codelineno-0-54">54</a>

1512 +<a href="#__codelineno-0-55">55</a>

1513 +<a href="#__codelineno-0-56">56</a>

1514 +<a href="#__codelineno-0-57">57</a>

1515 +<a href="#__codelineno-0-58">58</a>

1516 +<a href="#__codelineno-0-59">59</a>

1517 +<a href="#__codelineno-0-60">60</a>

1518 +<a href="#__codelineno-0-61">61</a>

1519 +<a href="#__codelineno-0-62">62</a>

1520 +<a href="#__codelineno-0-63">63</a>

1521 +<a href="#__codelineno-0-64">64</a>

1522 +<a href="#__codelineno-0-65">65</a>

1523 +<a href="#__codelineno-0-66">66</a>

1524 +<a href="#__codelineno-0-67">67</a>

1525 +<a href="#__codelineno-0-68">68</a>

1526 +<a href="#__codelineno-0-69">69</a>

1527 +<a href="#__codelineno-0-70">70</a>

1528 +<a href="#__codelineno-0-71">71</a>

1529 +<a href="#__codelineno-0-72">72</a>

1530 +<a href="#__codelineno-0-73">73</a>

1531 +<a href="#__codelineno-0-74">74</a>

1532 +<a href="#__codelineno-0-75">75</a>

1533 +<a href="#__codelineno-0-76">76</a>

1534 +<a href="#__codelineno-0-77">77</a>

1535 +<a href="#__codelineno-0-78">78</a>

1536 +<a href="#__codelineno-0-79">79</a>

1537 +<a href="#__codelineno-0-80">80</a>

1538 +<a href="#__codelineno-0-81">81</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-14" name="__codelineno-0-14"></a>class AgentMetadata(db.Model):

1539 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a> """

1540 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> Class for agent metadata which stores the agent ID, IP address, hostname, OS, last seen timestamp,

1541 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> and boolean for critical asset. This class inherits from SQLAlchemy's Model class.

1542 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> """

1543 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a>

1544 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> id: Column[Integer] = db.Column(db.Integer, primary_key=True)

1545 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> agent_id: Column[String] = db.Column(db.String(100))

1546 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> ip_address: Column[String] = db.Column(db.String(100))

1547 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> os: Column[String] = db.Column(db.String(100))

1548 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> hostname: Column[String] = db.Column(db.String(100))

1549 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> critical_asset: Column[Boolean] = db.Column(db.Boolean, default=False)

1550 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> last_seen: Column[DateTime] = db.Column(db.DateTime)

1551 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a>

1552 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> def __init__(

1553 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> self,

1554 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> agent_id: str,

1555 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> ip_address: str,

1556 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> os: str,

1557 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> hostname: str,

1558 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> critical_asset: bool,

1559 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> last_seen: datetime,

1560 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> ):

1561 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> """

1562 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> Initialize a new instance of the AgentMetadata class.

1563 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a>

1564 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> :param agent_id: Unique ID for the agent.

1565 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> :param ip_address: IP address of the agent.

1566 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> :param os: Operating system of the agent.

1567 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> :param hostname: Hostname of the agent.

1568 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> :param critical_asset: Boolean value indicating if the agent is a critical asset.

1569 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> :param last_seen: Timestamp of when the agent was last seen.

1570 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> """

1571 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> self.agent_id = agent_id

1572 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> self.ip_address = ip_address

1573 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> self.os = os

1574 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> self.hostname = hostname

1575 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> self.critical_asset = critical_asset

1576 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> self.last_seen = last_seen

1577 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a>

1578 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> def __repr__(self) -> str:

1579 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> """

1580 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> Returns a string representation of the AgentMetadata instance.

1581 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a>

1582 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> :return: A string representation of the agent ID.

1583 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> """

1584 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> return f"<AgentMetadata {self.agent_id}>"

1585 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a>

1586 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> def mark_as_critical(self):

1587 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> """

1588 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> Marks the agent as a critical asset.

1589 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> """

1590 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> self.critical_asset = True

1591 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> db.session.commit()

1592 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a>

1593 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> def mark_as_non_critical(self):

1594 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> """

1595 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> Marks the agent as a non-critical asset.

1596 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> """

1597 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> self.critical_asset = False

1598 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> db.session.commit()

1599 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a>

1600 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> def commit_wazuh_agent_to_db(self):

1601 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> """

1602 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> Commits the agent to the database.

1603 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> """

1604 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> db.session.add(self)

1605 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> db.session.commit()

1606 +</code></pre></div></td></tr></table></div>

1607 + </details>

1608 +

1609 +

1610 +

1611 + <div class="doc doc-children">

1612 +

1613 +

1614 +

1615 +

1616 +

1617 +

1618 +

1619 +

1620 +

1621 +<div class="doc doc-object doc-function">

1622 +

1623 +

1624 +

1625 +<h3 id="app.models.agents.AgentMetadata.__init__" class="doc doc-heading">

1626 +<code class="highlight language-python">__init__(agent_id, ip_address, os, hostname, critical_asset, last_seen)</code>

1627 +

1628 +</h3>

1629 +

1630 +

1631 + <div class="doc doc-contents ">

1632 +

1633 + Initialize a new instance of the AgentMetadata class.

1634 +:param agent_id: Unique ID for the agent.

1635 +:param ip_address: IP address of the agent.

1636 +:param os: Operating system of the agent.

1637 +:param hostname: Hostname of the agent.

1638 +:param critical_asset: Boolean value indicating if the agent is a critical asset.

1639 +:param last_seen: Timestamp of when the agent was last seen.

1640 +

1641 + <details class="quote">

1642 + <summary>Source code in <code>app\models\agents.py</code></summary>

1643 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-28">28</a>

1644 +<a href="#__codelineno-0-29">29</a>

1645 +<a href="#__codelineno-0-30">30</a>

1646 +<a href="#__codelineno-0-31">31</a>

1647 +<a href="#__codelineno-0-32">32</a>

1648 +<a href="#__codelineno-0-33">33</a>

1649 +<a href="#__codelineno-0-34">34</a>

1650 +<a href="#__codelineno-0-35">35</a>

1651 +<a href="#__codelineno-0-36">36</a>

1652 +<a href="#__codelineno-0-37">37</a>

1653 +<a href="#__codelineno-0-38">38</a>

1654 +<a href="#__codelineno-0-39">39</a>

1655 +<a href="#__codelineno-0-40">40</a>

1656 +<a href="#__codelineno-0-41">41</a>

1657 +<a href="#__codelineno-0-42">42</a>

1658 +<a href="#__codelineno-0-43">43</a>

1659 +<a href="#__codelineno-0-44">44</a>

1660 +<a href="#__codelineno-0-45">45</a>

1661 +<a href="#__codelineno-0-46">46</a>

1662 +<a href="#__codelineno-0-47">47</a>

1663 +<a href="#__codelineno-0-48">48</a>

1664 +<a href="#__codelineno-0-49">49</a>

1665 +<a href="#__codelineno-0-50">50</a>

1666 +<a href="#__codelineno-0-51">51</a>

1667 +<a href="#__codelineno-0-52">52</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-28" name="__codelineno-0-28"></a>def __init__(

1668 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> self,

1669 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> agent_id: str,

1670 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a> ip_address: str,

1671 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> os: str,

1672 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> hostname: str,

1673 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> critical_asset: bool,

1674 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> last_seen: datetime,

1675 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a>):

1676 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> """

1677 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> Initialize a new instance of the AgentMetadata class.

1678 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a>

1679 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> :param agent_id: Unique ID for the agent.

1680 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> :param ip_address: IP address of the agent.

1681 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> :param os: Operating system of the agent.

1682 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a> :param hostname: Hostname of the agent.

1683 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> :param critical_asset: Boolean value indicating if the agent is a critical asset.

1684 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> :param last_seen: Timestamp of when the agent was last seen.

1685 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> """

1686 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> self.agent_id = agent_id

1687 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> self.ip_address = ip_address

1688 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> self.os = os

1689 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> self.hostname = hostname

1690 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> self.critical_asset = critical_asset

1691 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> self.last_seen = last_seen

1692 +</code></pre></div></td></tr></table></div>

1693 + </details>

1694 + </div>

1695 +

1696 +</div>

1697 +

1698 +<div class="doc doc-object doc-function">

1699 +

1700 +

1701 +

1702 +<h3 id="app.models.agents.AgentMetadata.__repr__" class="doc doc-heading">

1703 +<code class="highlight language-python">__repr__()</code>

1704 +

1705 +</h3>

1706 +

1707 +

1708 + <div class="doc doc-contents ">

1709 +

1710 + Returns a string representation of the AgentMetadata instance.

1711 +:return: A string representation of the agent ID.

1712 +

1713 + <details class="quote">

1714 + <summary>Source code in <code>app\models\agents.py</code></summary>

1715 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-54">54</a>

1716 +<a href="#__codelineno-0-55">55</a>

1717 +<a href="#__codelineno-0-56">56</a>

1718 +<a href="#__codelineno-0-57">57</a>

1719 +<a href="#__codelineno-0-58">58</a>

1720 +<a href="#__codelineno-0-59">59</a>

1721 +<a href="#__codelineno-0-60">60</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-54" name="__codelineno-0-54"></a>def __repr__(self) -> str:

1722 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> """

1723 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> Returns a string representation of the AgentMetadata instance.

1724 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a>

1725 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> :return: A string representation of the agent ID.

1726 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> """

1727 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> return f"<AgentMetadata {self.agent_id}>"

1728 +</code></pre></div></td></tr></table></div>

1729 + </details>

1730 + </div>

1731 +

1732 +</div>

1733 +

1734 +<div class="doc doc-object doc-function">

1735 +

1736 +

1737 +

1738 +<h3 id="app.models.agents.AgentMetadata.commit_wazuh_agent_to_db" class="doc doc-heading">

1739 +<code class="highlight language-python">commit_wazuh_agent_to_db()</code>

1740 +

1741 +</h3>

1742 +

1743 +

1744 + <div class="doc doc-contents ">

1745 +

1746 + Commits the agent to the database.

1747 +

1748 + <details class="quote">

1749 + <summary>Source code in <code>app\models\agents.py</code></summary>

1750 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-76">76</a>

1751 +<a href="#__codelineno-0-77">77</a>

1752 +<a href="#__codelineno-0-78">78</a>

1753 +<a href="#__codelineno-0-79">79</a>

1754 +<a href="#__codelineno-0-80">80</a>

1755 +<a href="#__codelineno-0-81">81</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-76" name="__codelineno-0-76"></a>def commit_wazuh_agent_to_db(self):

1756 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> """

1757 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> Commits the agent to the database.

1758 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> """

1759 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> db.session.add(self)

1760 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> db.session.commit()

1761 +</code></pre></div></td></tr></table></div>

1762 + </details>

1763 + </div>

1764 +

1765 +</div>

1766 +

1767 +<div class="doc doc-object doc-function">

1768 +

1769 +

1770 +

1771 +<h3 id="app.models.agents.AgentMetadata.mark_as_critical" class="doc doc-heading">

1772 +<code class="highlight language-python">mark_as_critical()</code>

1773 +

1774 +</h3>

1775 +

1776 +

1777 + <div class="doc doc-contents ">

1778 +

1779 + Marks the agent as a critical asset.

1780 +

1781 + <details class="quote">

1782 + <summary>Source code in <code>app\models\agents.py</code></summary>

1783 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-62">62</a>

1784 +<a href="#__codelineno-0-63">63</a>

1785 +<a href="#__codelineno-0-64">64</a>

1786 +<a href="#__codelineno-0-65">65</a>

1787 +<a href="#__codelineno-0-66">66</a>

1788 +<a href="#__codelineno-0-67">67</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-62" name="__codelineno-0-62"></a>def mark_as_critical(self):

1789 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> """

1790 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> Marks the agent as a critical asset.

1791 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> """

1792 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> self.critical_asset = True

1793 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> db.session.commit()

1794 +</code></pre></div></td></tr></table></div>

1795 + </details>

1796 + </div>

1797 +

1798 +</div>

1799 +

1800 +<div class="doc doc-object doc-function">

1801 +

1802 +

1803 +

1804 +<h3 id="app.models.agents.AgentMetadata.mark_as_non_critical" class="doc doc-heading">

1805 +<code class="highlight language-python">mark_as_non_critical()</code>

1806 +

1807 +</h3>

1808 +

1809 +

1810 + <div class="doc doc-contents ">

1811 +

1812 + Marks the agent as a non-critical asset.

1813 +

1814 + <details class="quote">

1815 + <summary>Source code in <code>app\models\agents.py</code></summary>

1816 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-69">69</a>

1817 +<a href="#__codelineno-0-70">70</a>

1818 +<a href="#__codelineno-0-71">71</a>

1819 +<a href="#__codelineno-0-72">72</a>

1820 +<a href="#__codelineno-0-73">73</a>

1821 +<a href="#__codelineno-0-74">74</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-69" name="__codelineno-0-69"></a>def mark_as_non_critical(self):

1822 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> """

1823 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> Marks the agent as a non-critical asset.

1824 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> """

1825 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> self.critical_asset = False

1826 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> db.session.commit()

1827 +</code></pre></div></td></tr></table></div>

1828 + </details>

1829 + </div>

1830 +

1831 +</div>

1832 +

1833 +

1834 +

1835 + </div>

1836 +

1837 + </div>

1838 +

1839 +</div>

1840 +

1841 +<div class="doc doc-object doc-class">

1842 +

1843 +

1844 +

1845 +<h2 id="app.models.agents.AgentMetadataSchema" class="doc doc-heading">

1846 + <code>AgentMetadataSchema</code>

1847 +

1848 +

1849 +</h2>

1850 +

1851 +

1852 + <div class="doc doc-contents ">

1853 +

1854 + Bases: <code>ma.Schema</code>

1855 +

1856 +

1857 + Schema for serializing and deserializing instances of the AgentMetadata class.

1858 +

1859 +

1860 + <details class="quote">

1861 + <summary>Source code in <code>app\models\agents.py</code></summary>

1862 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-84"> 84</a>

1863 +<a href="#__codelineno-0-85"> 85</a>

1864 +<a href="#__codelineno-0-86"> 86</a>

1865 +<a href="#__codelineno-0-87"> 87</a>

1866 +<a href="#__codelineno-0-88"> 88</a>

1867 +<a href="#__codelineno-0-89"> 89</a>

1868 +<a href="#__codelineno-0-90"> 90</a>

1869 +<a href="#__codelineno-0-91"> 91</a>

1870 +<a href="#__codelineno-0-92"> 92</a>

1871 +<a href="#__codelineno-0-93"> 93</a>

1872 +<a href="#__codelineno-0-94"> 94</a>

1873 +<a href="#__codelineno-0-95"> 95</a>

1874 +<a href="#__codelineno-0-96"> 96</a>

1875 +<a href="#__codelineno-0-97"> 97</a>

1876 +<a href="#__codelineno-0-98"> 98</a>

1877 +<a href="#__codelineno-0-99"> 99</a>

1878 +<a href="#__codelineno-0-100">100</a>

1879 +<a href="#__codelineno-0-101">101</a>

1880 +<a href="#__codelineno-0-102">102</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-84" name="__codelineno-0-84"></a>class AgentMetadataSchema(ma.Schema):

1881 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> """

1882 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> Schema for serializing and deserializing instances of the AgentMetadata class.

1883 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> """

1884 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a>

1885 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> class Meta:

1886 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> """

1887 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> Meta class defines the fields to be serialized/deserialized.

1888 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> """

1889 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a>

1890 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> fields: tuple = (

1891 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> "id",

1892 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> "agent_id",

1893 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> "ip_address",

1894 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> "os",

1895 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a> "hostname",

1896 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> "critical_asset",

1897 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> "last_seen",

1898 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> )

1899 +</code></pre></div></td></tr></table></div>

1900 + </details>

1901 +

1902 +

1903 +

1904 + <div class="doc doc-children">

1905 +

1906 +

1907 +

1908 +

1909 +

1910 +

1911 +

1912 +

1913 +<div class="doc doc-object doc-class">

1914 +

1915 +

1916 +

1917 +<h3 id="app.models.agents.AgentMetadataSchema.Meta" class="doc doc-heading">

1918 + <code>Meta</code>

1919 +

1920 +

1921 +</h3>

1922 +

1923 +

1924 + <div class="doc doc-contents ">

1925 +

1926 +

1927 + Meta class defines the fields to be serialized/deserialized.

1928 +

1929 +

1930 + <details class="quote">

1931 + <summary>Source code in <code>app\models\agents.py</code></summary>

1932 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-89"> 89</a>

1933 +<a href="#__codelineno-0-90"> 90</a>

1934 +<a href="#__codelineno-0-91"> 91</a>

1935 +<a href="#__codelineno-0-92"> 92</a>

1936 +<a href="#__codelineno-0-93"> 93</a>

1937 +<a href="#__codelineno-0-94"> 94</a>

1938 +<a href="#__codelineno-0-95"> 95</a>

1939 +<a href="#__codelineno-0-96"> 96</a>

1940 +<a href="#__codelineno-0-97"> 97</a>

1941 +<a href="#__codelineno-0-98"> 98</a>

1942 +<a href="#__codelineno-0-99"> 99</a>

1943 +<a href="#__codelineno-0-100">100</a>

1944 +<a href="#__codelineno-0-101">101</a>

1945 +<a href="#__codelineno-0-102">102</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-89" name="__codelineno-0-89"></a>class Meta:

1946 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> """

1947 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> Meta class defines the fields to be serialized/deserialized.

1948 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> """

1949 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a>

1950 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> fields: tuple = (

1951 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> "id",

1952 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> "agent_id",

1953 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> "ip_address",

1954 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> "os",

1955 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a> "hostname",

1956 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> "critical_asset",

1957 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> "last_seen",

1958 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> )

1959 +</code></pre></div></td></tr></table></div>

1960 + </details>

1961 +

1962 +

1963 +

1964 + <div class="doc doc-children">

1965 +

1966 +

1967 +

1968 +

1969 +

1970 +

1971 +

1972 +

1973 +

1974 +

1975 +

1976 + </div>

1977 +

1978 + </div>

1979 +

1980 +</div>

1981 +

1982 +

1983 +

1984 +

1985 + </div>

1986 +

1987 + </div>

1988 +

1989 +</div>

1990 +

1991 +

1992 +

1993 +

1994 + </div>

1995 +

1996 + </div>

1997 +

1998 +</div>

1999 +<h3 id="wazuh-manager-routes">Wazuh-Manager Routes</h3>

2000 +

2001 +

2002 +<div class="doc doc-object doc-function">

2003 +

2004 +

2005 +<a id="app.routes.agents.sync_agents"></a>

2006 + <div class="doc doc-contents first">

2007 +

2008 + Endpoint to synchronize all agents.

2009 +

2010 + Returns:

2011 + <table>

2012 + <thead>

2013 + <tr>

2014 +<th>Name</th> <th>Type</th>

2015 + <th>Description</th>

2016 + </tr>

2017 + </thead>

2018 + <tbody>

2019 + <tr>

2020 +<td><code>json</code></td> <td>

2021 + <code>Any</code>

2022 + </td>

2023 + <td>

2024 + <div class="doc-md-description">

2025 + A JSON response containing the updated information of all synchronized agents.

2026 + </div>

2027 + </td>

2028 + </tr>

2029 + </tbody>

2030 + </table>

2031 +

2032 + <details class="quote">

2033 + <summary>Source code in <code>app\routes\agents.py</code></summary>

2034 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-69">69</a>

2035 +<a href="#__codelineno-0-70">70</a>

2036 +<a href="#__codelineno-0-71">71</a>

2037 +<a href="#__codelineno-0-72">72</a>

2038 +<a href="#__codelineno-0-73">73</a>

2039 +<a href="#__codelineno-0-74">74</a>

2040 +<a href="#__codelineno-0-75">75</a>

2041 +<a href="#__codelineno-0-76">76</a>

2042 +<a href="#__codelineno-0-77">77</a>

2043 +<a href="#__codelineno-0-78">78</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-69" name="__codelineno-0-69"></a>@bp.route("/agents/sync", methods=["POST"])

2044 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a>def sync_agents() -> Any:

2045 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> """

2046 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> Endpoint to synchronize all agents.

2047 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> Returns:

2048 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> json: A JSON response containing the updated information of all synchronized agents.

2049 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a> """

2050 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> service = AgentSyncService()

2051 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> result = service.sync_agents()

2052 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> return jsonify(result)

2053 +</code></pre></div></td></tr></table></div>

2054 + </details>

2055 + </div>

2056 +

2057 +</div>

2058 +

2059 +<div class="doc doc-object doc-function">

2060 +

2061 +

2062 +<a id="app.routes.agents.delete_agent"></a>

2063 + <div class="doc doc-contents first">

2064 +

2065 + Endpoint to delete an agent.

2066 +

2067 + Parameters:

2068 + <table>

2069 + <thead>

2070 + <tr>

2071 + <th>Name</th>

2072 + <th>Type</th>

2073 + <th>Description</th>

2074 + <th>Default</th>

2075 + </tr>

2076 + </thead>

2077 + <tbody>

2078 + <tr>

2079 + <td><code>agent_id</code></td>

2080 + <td>

2081 + <code>str</code>

2082 + </td>

2083 + <td>

2084 + <div class="doc-md-description">

2085 + The ID of the agent to be deleted.

2086 + </div>

2087 + </td>

2088 + <td>

2089 + required

2090 + </td>

2091 + </tr>

2092 + </tbody>

2093 + </table>

2094 +

2095 + Returns:

2096 + <table>

2097 + <thead>

2098 + <tr>

2099 +<th>Name</th> <th>Type</th>

2100 + <th>Description</th>

2101 + </tr>

2102 + </thead>

2103 + <tbody>

2104 + <tr>

2105 +<td><code>json</code></td> <td>

2106 + <code>Any</code>

2107 + </td>

2108 + <td>

2109 + <div class="doc-md-description">

2110 + A JSON response indicating whether the deletion was successful.

2111 + </div>

2112 + </td>

2113 + </tr>

2114 + </tbody>

2115 + </table>

2116 +

2117 + <details class="quote">

2118 + <summary>Source code in <code>app\routes\agents.py</code></summary>

2119 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-81">81</a>

2120 +<a href="#__codelineno-0-82">82</a>

2121 +<a href="#__codelineno-0-83">83</a>

2122 +<a href="#__codelineno-0-84">84</a>

2123 +<a href="#__codelineno-0-85">85</a>

2124 +<a href="#__codelineno-0-86">86</a>

2125 +<a href="#__codelineno-0-87">87</a>

2126 +<a href="#__codelineno-0-88">88</a>

2127 +<a href="#__codelineno-0-89">89</a>

2128 +<a href="#__codelineno-0-90">90</a>

2129 +<a href="#__codelineno-0-91">91</a>

2130 +<a href="#__codelineno-0-92">92</a>

2131 +<a href="#__codelineno-0-93">93</a>

2132 +<a href="#__codelineno-0-94">94</a>

2133 +<a href="#__codelineno-0-95">95</a>

2134 +<a href="#__codelineno-0-96">96</a>

2135 +<a href="#__codelineno-0-97">97</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-81" name="__codelineno-0-81"></a>@bp.route("/agents/<agent_id>/delete", methods=["POST"])

2136 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a>def delete_agent(agent_id: str) -> Any:

2137 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> """

2138 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> Endpoint to delete an agent.

2139 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> Args:

2140 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> agent_id (str): The ID of the agent to be deleted.

2141 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> Returns:

2142 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> json: A JSON response indicating whether the deletion was successful.

2143 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a> """

2144 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> service = AgentService()

2145 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> result = service.delete_agent_db(agent_id=agent_id)

2146 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a>

2147 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a> universal_service = UniversalService()

2148 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> agent_service = WazuhManagerAgentService(universal_service)

2149 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> agent_service.delete_agent(agent_id=agent_id)

2150 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a>

2151 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> return result

2152 +</code></pre></div></td></tr></table></div>

2153 + </details>

2154 + </div>

2155 +

2156 +</div>

2157 +

2158 +<div class="doc doc-object doc-function">

2159 +

2160 +

2161 +<a id="app.routes.agents.get_agent_vulnerabilities"></a>

2162 + <div class="doc doc-contents first">

2163 +

2164 + Endpoint to get the vulnerabilities of a specific agent.

2165 +

2166 + Parameters:

2167 + <table>

2168 + <thead>

2169 + <tr>

2170 + <th>Name</th>

2171 + <th>Type</th>

2172 + <th>Description</th>

2173 + <th>Default</th>

2174 + </tr>

2175 + </thead>

2176 + <tbody>

2177 + <tr>

2178 + <td><code>agent_id</code></td>

2179 + <td>

2180 + <code>str</code>

2181 + </td>

2182 + <td>

2183 + <div class="doc-md-description">

2184 + The ID of the agent whose vulnerabilities are to be fetched.

2185 + </div>

2186 + </td>

2187 + <td>

2188 + required

2189 + </td>

2190 + </tr>

2191 + </tbody>

2192 + </table>

2193 +

2194 + Returns:

2195 + <table>

2196 + <thead>

2197 + <tr>

2198 +<th>Name</th> <th>Type</th>

2199 + <th>Description</th>

2200 + </tr>

2201 + </thead>

2202 + <tbody>

2203 + <tr>

2204 +<td><code>json</code></td> <td>

2205 + <code>Any</code>

2206 + </td>

2207 + <td>

2208 + <div class="doc-md-description">

2209 + A JSON response containing the vulnerabilities of the agent.

2210 + </div>

2211 + </td>

2212 + </tr>

2213 + </tbody>

2214 + </table>

2215 +

2216 + <details class="quote">

2217 + <summary>Source code in <code>app\routes\agents.py</code></summary>

2218 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-100">100</a>

2219 +<a href="#__codelineno-0-101">101</a>

2220 +<a href="#__codelineno-0-102">102</a>

2221 +<a href="#__codelineno-0-103">103</a>

2222 +<a href="#__codelineno-0-104">104</a>

2223 +<a href="#__codelineno-0-105">105</a>

2224 +<a href="#__codelineno-0-106">106</a>

2225 +<a href="#__codelineno-0-107">107</a>

2226 +<a href="#__codelineno-0-108">108</a>

2227 +<a href="#__codelineno-0-109">109</a>

2228 +<a href="#__codelineno-0-110">110</a>

2229 +<a href="#__codelineno-0-111">111</a>

2230 +<a href="#__codelineno-0-112">112</a>

2231 +<a href="#__codelineno-0-113">113</a>

2232 +<a href="#__codelineno-0-114">114</a>

2233 +<a href="#__codelineno-0-115">115</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-100" name="__codelineno-0-100"></a>@bp.route("/agents/<agent_id>/vulnerabilities", methods=["GET"])

2234 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a>def get_agent_vulnerabilities(agent_id: str) -> Any:

2235 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> """

2236 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> Endpoint to get the vulnerabilities of a specific agent.

2237 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a> Args:

2238 +<a id="__codelineno-0-105" name="__codelineno-0-105"></a> agent_id (str): The ID of the agent whose vulnerabilities are to be fetched.

2239 +<a id="__codelineno-0-106" name="__codelineno-0-106"></a> Returns:

2240 +<a id="__codelineno-0-107" name="__codelineno-0-107"></a> json: A JSON response containing the vulnerabilities of the agent.

2241 +<a id="__codelineno-0-108" name="__codelineno-0-108"></a> """

2242 +<a id="__codelineno-0-109" name="__codelineno-0-109"></a> universal_service = UniversalService()

2243 +<a id="__codelineno-0-110" name="__codelineno-0-110"></a> vulnerability_service = VulnerabilityService(universal_service)

2244 +<a id="__codelineno-0-111" name="__codelineno-0-111"></a>

2245 +<a id="__codelineno-0-112" name="__codelineno-0-112"></a> agent_vulnerabilities = vulnerability_service.agent_vulnerabilities(

2246 +<a id="__codelineno-0-113" name="__codelineno-0-113"></a> agent_id=agent_id,

2247 +<a id="__codelineno-0-114" name="__codelineno-0-114"></a> )

2248 +<a id="__codelineno-0-115" name="__codelineno-0-115"></a> return agent_vulnerabilities

2249 +</code></pre></div></td></tr></table></div>

2250 + </details>

2251 + </div>

2252 +

2253 +</div>

2254 +<h3 id="wazuh-manager-services">Wazuh-Manager Services</h3>

2255 +

2256 +

2257 +<div class="doc doc-object doc-module">

2258 +

2259 +

2260 +<a id="app.services.WazuhManager.agent"></a>

2261 + <div class="doc doc-contents first">

2262 +

2263 +

2264 +

2265 + <div class="doc doc-children">

2266 +

2267 +

2268 +

2269 +

2270 +

2271 +

2272 +

2273 +

2274 +<div class="doc doc-object doc-class">

2275 +

2276 +

2277 +

2278 +<h2 id="app.services.WazuhManager.agent.WazuhHttpRequests" class="doc doc-heading">

2279 + <code>WazuhHttpRequests</code>

2280 +

2281 +

2282 +</h2>

2283 +

2284 +

2285 + <div class="doc doc-contents ">

2286 +

2287 +

2288 + A class to handle HTTP requests to the Wazuh API.

2289 +This class is initialized with the URL for the Wazuh connector and an authentication token.

2290 +It provides a method to make HTTP DELETE requests to the specified Wazuh API endpoint.

2291 +

2292 +

2293 + <details class="quote">

2294 + <summary>Source code in <code>app\services\WazuhManager\agent.py</code></summary>

2295 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-12">12</a>

2296 +<a href="#__codelineno-0-13">13</a>

2297 +<a href="#__codelineno-0-14">14</a>

2298 +<a href="#__codelineno-0-15">15</a>

2299 +<a href="#__codelineno-0-16">16</a>

2300 +<a href="#__codelineno-0-17">17</a>

2301 +<a href="#__codelineno-0-18">18</a>

2302 +<a href="#__codelineno-0-19">19</a>

2303 +<a href="#__codelineno-0-20">20</a>

2304 +<a href="#__codelineno-0-21">21</a>

2305 +<a href="#__codelineno-0-22">22</a>

2306 +<a href="#__codelineno-0-23">23</a>

2307 +<a href="#__codelineno-0-24">24</a>

2308 +<a href="#__codelineno-0-25">25</a>

2309 +<a href="#__codelineno-0-26">26</a>

2310 +<a href="#__codelineno-0-27">27</a>

2311 +<a href="#__codelineno-0-28">28</a>

2312 +<a href="#__codelineno-0-29">29</a>

2313 +<a href="#__codelineno-0-30">30</a>

2314 +<a href="#__codelineno-0-31">31</a>

2315 +<a href="#__codelineno-0-32">32</a>

2316 +<a href="#__codelineno-0-33">33</a>

2317 +<a href="#__codelineno-0-34">34</a>

2318 +<a href="#__codelineno-0-35">35</a>

2319 +<a href="#__codelineno-0-36">36</a>

2320 +<a href="#__codelineno-0-37">37</a>

2321 +<a href="#__codelineno-0-38">38</a>

2322 +<a href="#__codelineno-0-39">39</a>

2323 +<a href="#__codelineno-0-40">40</a>

2324 +<a href="#__codelineno-0-41">41</a>

2325 +<a href="#__codelineno-0-42">42</a>

2326 +<a href="#__codelineno-0-43">43</a>

2327 +<a href="#__codelineno-0-44">44</a>

2328 +<a href="#__codelineno-0-45">45</a>

2329 +<a href="#__codelineno-0-46">46</a>

2330 +<a href="#__codelineno-0-47">47</a>

2331 +<a href="#__codelineno-0-48">48</a>

2332 +<a href="#__codelineno-0-49">49</a>

2333 +<a href="#__codelineno-0-50">50</a>

2334 +<a href="#__codelineno-0-51">51</a>

2335 +<a href="#__codelineno-0-52">52</a>

2336 +<a href="#__codelineno-0-53">53</a>

2337 +<a href="#__codelineno-0-54">54</a>

2338 +<a href="#__codelineno-0-55">55</a>

2339 +<a href="#__codelineno-0-56">56</a>

2340 +<a href="#__codelineno-0-57">57</a>

2341 +<a href="#__codelineno-0-58">58</a>

2342 +<a href="#__codelineno-0-59">59</a>

2343 +<a href="#__codelineno-0-60">60</a>

2344 +<a href="#__codelineno-0-61">61</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-12" name="__codelineno-0-12"></a>class WazuhHttpRequests:

2345 +<a id="__codelineno-0-13" name="__codelineno-0-13"></a> """

2346 +<a id="__codelineno-0-14" name="__codelineno-0-14"></a> A class to handle HTTP requests to the Wazuh API.

2347 +<a id="__codelineno-0-15" name="__codelineno-0-15"></a>

2348 +<a id="__codelineno-0-16" name="__codelineno-0-16"></a> This class is initialized with the URL for the Wazuh connector and an authentication token.

2349 +<a id="__codelineno-0-17" name="__codelineno-0-17"></a> It provides a method to make HTTP DELETE requests to the specified Wazuh API endpoint.

2350 +<a id="__codelineno-0-18" name="__codelineno-0-18"></a> """

2351 +<a id="__codelineno-0-19" name="__codelineno-0-19"></a>

2352 +<a id="__codelineno-0-20" name="__codelineno-0-20"></a> def __init__(self, connector_url: str, wazuh_auth_token: str) -> None:

2353 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> """

2354 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> Initializes a WazuhHttpRequests instance.

2355 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a>

2356 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> Args:

2357 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> connector_url (str): The URL for the Wazuh connector.

2358 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> wazuh_auth_token (str): The Wazuh API authentication token.

2359 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> """

2360 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> self.connector_url = connector_url

2361 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> self.wazuh_auth_token = wazuh_auth_token

2362 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> self.headers = {"Authorization": f"Bearer {wazuh_auth_token}"}

2363 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a>

2364 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> def delete_request(

2365 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> self,

2366 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> endpoint: str,

2367 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> params: Optional[Dict[str, str]] = None,

2368 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> ) -> Dict[str, bool]:

2369 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> """

2370 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> Makes an HTTP DELETE request to a specified Wazuh API endpoint.

2371 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a>

2372 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> Args:

2373 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> endpoint (str): The endpoint to make a DELETE request to.

2374 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> params (Optional[Dict[str, str]]): Any parameters to pass in the DELETE request.

2375 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a>

2376 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> Returns:

2377 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> Dict[str, bool]: A dictionary indicating the success of the operation. If the request was successful,

2378 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> `{"agentDeleted": True}` is returned. If it failed, `{"agentDeleted": False}` is returned.

2379 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> """

2380 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> try:

2381 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> response = requests.delete(

2382 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> f"{self.connector_url}/{endpoint}",

2383 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> headers=self.headers,

2384 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> params=params,

2385 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> verify=False,

2386 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> )

2387 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> response.raise_for_status()

2388 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> logger.info(f"Successfully deleted {endpoint}")

2389 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> return {"agentDeleted": True}

2390 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a>

2391 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> except Exception as e:

2392 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> logger.error(f"Failed to delete {endpoint}: {e}")

2393 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> return {"agentDeleted": False}

2394 +</code></pre></div></td></tr></table></div>

2395 + </details>

2396 +

2397 +

2398 +

2399 + <div class="doc doc-children">

2400 +

2401 +

2402 +

2403 +

2404 +

2405 +

2406 +

2407 +

2408 +

2409 +<div class="doc doc-object doc-function">

2410 +

2411 +

2412 +

2413 +<h3 id="app.services.WazuhManager.agent.WazuhHttpRequests.__init__" class="doc doc-heading">

2414 +<code class="highlight language-python">__init__(connector_url, wazuh_auth_token)</code>

2415 +

2416 +</h3>

2417 +

2418 +

2419 + <div class="doc doc-contents ">

2420 +

2421 + Initializes a WazuhHttpRequests instance.

2422 +

2423 + Parameters:

2424 + <table>

2425 + <thead>

2426 + <tr>

2427 + <th>Name</th>

2428 + <th>Type</th>

2429 + <th>Description</th>

2430 + <th>Default</th>

2431 + </tr>

2432 + </thead>

2433 + <tbody>

2434 + <tr>

2435 + <td><code>connector_url</code></td>

2436 + <td>

2437 + <code>str</code>

2438 + </td>

2439 + <td>

2440 + <div class="doc-md-description">

2441 + The URL for the Wazuh connector.

2442 + </div>

2443 + </td>

2444 + <td>

2445 + required

2446 + </td>

2447 + </tr>

2448 + <tr>

2449 + <td><code>wazuh_auth_token</code></td>

2450 + <td>

2451 + <code>str</code>

2452 + </td>

2453 + <td>

2454 + <div class="doc-md-description">

2455 + The Wazuh API authentication token.

2456 + </div>

2457 + </td>

2458 + <td>

2459 + required

2460 + </td>

2461 + </tr>

2462 + </tbody>

2463 + </table>

2464 +

2465 + <details class="quote">

2466 + <summary>Source code in <code>app\services\WazuhManager\agent.py</code></summary>

2467 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-20">20</a>

2468 +<a href="#__codelineno-0-21">21</a>

2469 +<a href="#__codelineno-0-22">22</a>

2470 +<a href="#__codelineno-0-23">23</a>

2471 +<a href="#__codelineno-0-24">24</a>

2472 +<a href="#__codelineno-0-25">25</a>

2473 +<a href="#__codelineno-0-26">26</a>

2474 +<a href="#__codelineno-0-27">27</a>

2475 +<a href="#__codelineno-0-28">28</a>

2476 +<a href="#__codelineno-0-29">29</a>

2477 +<a href="#__codelineno-0-30">30</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-20" name="__codelineno-0-20"></a>def __init__(self, connector_url: str, wazuh_auth_token: str) -> None:

2478 +<a id="__codelineno-0-21" name="__codelineno-0-21"></a> """

2479 +<a id="__codelineno-0-22" name="__codelineno-0-22"></a> Initializes a WazuhHttpRequests instance.

2480 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a>

2481 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> Args:

2482 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a> connector_url (str): The URL for the Wazuh connector.

2483 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> wazuh_auth_token (str): The Wazuh API authentication token.

2484 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> """

2485 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> self.connector_url = connector_url

2486 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> self.wazuh_auth_token = wazuh_auth_token

2487 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> self.headers = {"Authorization": f"Bearer {wazuh_auth_token}"}

2488 +</code></pre></div></td></tr></table></div>

2489 + </details>

2490 + </div>

2491 +

2492 +</div>

2493 +

2494 +<div class="doc doc-object doc-function">

2495 +

2496 +

2497 +

2498 +<h3 id="app.services.WazuhManager.agent.WazuhHttpRequests.delete_request" class="doc doc-heading">

2499 +<code class="highlight language-python">delete_request(endpoint, params=None)</code>

2500 +

2501 +</h3>

2502 +

2503 +

2504 + <div class="doc doc-contents ">

2505 +

2506 + Makes an HTTP DELETE request to a specified Wazuh API endpoint.

2507 +

2508 + Parameters:

2509 + <table>

2510 + <thead>

2511 + <tr>

2512 + <th>Name</th>

2513 + <th>Type</th>

2514 + <th>Description</th>

2515 + <th>Default</th>

2516 + </tr>

2517 + </thead>

2518 + <tbody>

2519 + <tr>

2520 + <td><code>endpoint</code></td>

2521 + <td>

2522 + <code>str</code>

2523 + </td>

2524 + <td>

2525 + <div class="doc-md-description">

2526 + The endpoint to make a DELETE request to.

2527 + </div>

2528 + </td>

2529 + <td>

2530 + required

2531 + </td>

2532 + </tr>

2533 + <tr>

2534 + <td><code>params</code></td>

2535 + <td>

2536 + <code>Optional[Dict[str, str]]</code>

2537 + </td>

2538 + <td>

2539 + <div class="doc-md-description">

2540 + Any parameters to pass in the DELETE request.

2541 + </div>

2542 + </td>

2543 + <td>

2544 + <code>None</code>

2545 + </td>

2546 + </tr>

2547 + </tbody>

2548 + </table>

2549 +

2550 + Returns:

2551 + <table>

2552 + <thead>

2553 + <tr>

2554 + <th>Type</th>

2555 + <th>Description</th>

2556 + </tr>

2557 + </thead>

2558 + <tbody>

2559 + <tr>

2560 + <td>

2561 + <code>Dict[str, bool]</code>

2562 + </td>

2563 + <td>

2564 + <div class="doc-md-description">

2565 + Dict[str, bool]: A dictionary indicating the success of the operation. If the request was successful,

2566 + <code>{"agentDeleted": True}</code> is returned. If it failed, <code>{"agentDeleted": False}</code> is returned.

2567 + </div>

2568 + </td>

2569 + </tr>

2570 + </tbody>

2571 + </table>

2572 +

2573 + <details class="quote">

2574 + <summary>Source code in <code>app\services\WazuhManager\agent.py</code></summary>

2575 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-32">32</a>

2576 +<a href="#__codelineno-0-33">33</a>

2577 +<a href="#__codelineno-0-34">34</a>

2578 +<a href="#__codelineno-0-35">35</a>

2579 +<a href="#__codelineno-0-36">36</a>

2580 +<a href="#__codelineno-0-37">37</a>

2581 +<a href="#__codelineno-0-38">38</a>

2582 +<a href="#__codelineno-0-39">39</a>

2583 +<a href="#__codelineno-0-40">40</a>

2584 +<a href="#__codelineno-0-41">41</a>

2585 +<a href="#__codelineno-0-42">42</a>

2586 +<a href="#__codelineno-0-43">43</a>

2587 +<a href="#__codelineno-0-44">44</a>

2588 +<a href="#__codelineno-0-45">45</a>

2589 +<a href="#__codelineno-0-46">46</a>

2590 +<a href="#__codelineno-0-47">47</a>

2591 +<a href="#__codelineno-0-48">48</a>

2592 +<a href="#__codelineno-0-49">49</a>

2593 +<a href="#__codelineno-0-50">50</a>

2594 +<a href="#__codelineno-0-51">51</a>

2595 +<a href="#__codelineno-0-52">52</a>

2596 +<a href="#__codelineno-0-53">53</a>

2597 +<a href="#__codelineno-0-54">54</a>

2598 +<a href="#__codelineno-0-55">55</a>

2599 +<a href="#__codelineno-0-56">56</a>

2600 +<a href="#__codelineno-0-57">57</a>

2601 +<a href="#__codelineno-0-58">58</a>

2602 +<a href="#__codelineno-0-59">59</a>

2603 +<a href="#__codelineno-0-60">60</a>

2604 +<a href="#__codelineno-0-61">61</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-32" name="__codelineno-0-32"></a>def delete_request(

2605 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> self,

2606 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> endpoint: str,

2607 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a> params: Optional[Dict[str, str]] = None,

2608 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a>) -> Dict[str, bool]:

2609 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> """

2610 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> Makes an HTTP DELETE request to a specified Wazuh API endpoint.

2611 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a>

2612 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> Args:

2613 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> endpoint (str): The endpoint to make a DELETE request to.

2614 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> params (Optional[Dict[str, str]]): Any parameters to pass in the DELETE request.

2615 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a>

2616 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> Returns:

2617 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> Dict[str, bool]: A dictionary indicating the success of the operation. If the request was successful,

2618 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> `{"agentDeleted": True}` is returned. If it failed, `{"agentDeleted": False}` is returned.

2619 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> """

2620 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> try:

2621 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> response = requests.delete(

2622 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> f"{self.connector_url}/{endpoint}",

2623 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a> headers=self.headers,

2624 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> params=params,

2625 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> verify=False,

2626 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> )

2627 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a> response.raise_for_status()

2628 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> logger.info(f"Successfully deleted {endpoint}")

2629 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> return {"agentDeleted": True}

2630 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a>

2631 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> except Exception as e:

2632 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> logger.error(f"Failed to delete {endpoint}: {e}")

2633 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> return {"agentDeleted": False}

2634 +</code></pre></div></td></tr></table></div>

2635 + </details>

2636 + </div>

2637 +

2638 +</div>

2639 +

2640 +

2641 +

2642 + </div>

2643 +

2644 + </div>

2645 +

2646 +</div>

2647 +

2648 +<div class="doc doc-object doc-class">

2649 +

2650 +

2651 +

2652 +<h2 id="app.services.WazuhManager.agent.WazuhManagerAgentService" class="doc doc-heading">

2653 + <code>WazuhManagerAgentService</code>

2654 +

2655 +

2656 +</h2>

2657 +

2658 +

2659 + <div class="doc doc-contents ">

2660 +

2661 +

2662 + A service class that encapsulates the logic for handling agent-related operations in the Wazuh Manager.

2663 +This class uses the UniversalService to get authentication tokens and URLs, and WazuhHttpRequests to make HTTP requests.

2664 +It provides methods to collect all agents from Wazuh Manager and to delete a specific agent.

2665 +

2666 +

2667 + <details class="quote">

2668 + <summary>Source code in <code>app\services\WazuhManager\agent.py</code></summary>

2669 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-64"> 64</a>

2670 +<a href="#__codelineno-0-65"> 65</a>

2671 +<a href="#__codelineno-0-66"> 66</a>

2672 +<a href="#__codelineno-0-67"> 67</a>

2673 +<a href="#__codelineno-0-68"> 68</a>

2674 +<a href="#__codelineno-0-69"> 69</a>

2675 +<a href="#__codelineno-0-70"> 70</a>

2676 +<a href="#__codelineno-0-71"> 71</a>

2677 +<a href="#__codelineno-0-72"> 72</a>

2678 +<a href="#__codelineno-0-73"> 73</a>

2679 +<a href="#__codelineno-0-74"> 74</a>

2680 +<a href="#__codelineno-0-75"> 75</a>

2681 +<a href="#__codelineno-0-76"> 76</a>

2682 +<a href="#__codelineno-0-77"> 77</a>

2683 +<a href="#__codelineno-0-78"> 78</a>

2684 +<a href="#__codelineno-0-79"> 79</a>

2685 +<a href="#__codelineno-0-80"> 80</a>

2686 +<a href="#__codelineno-0-81"> 81</a>

2687 +<a href="#__codelineno-0-82"> 82</a>

2688 +<a href="#__codelineno-0-83"> 83</a>

2689 +<a href="#__codelineno-0-84"> 84</a>

2690 +<a href="#__codelineno-0-85"> 85</a>

2691 +<a href="#__codelineno-0-86"> 86</a>

2692 +<a href="#__codelineno-0-87"> 87</a>

2693 +<a href="#__codelineno-0-88"> 88</a>

2694 +<a href="#__codelineno-0-89"> 89</a>

2695 +<a href="#__codelineno-0-90"> 90</a>

2696 +<a href="#__codelineno-0-91"> 91</a>

2697 +<a href="#__codelineno-0-92"> 92</a>

2698 +<a href="#__codelineno-0-93"> 93</a>

2699 +<a href="#__codelineno-0-94"> 94</a>

2700 +<a href="#__codelineno-0-95"> 95</a>

2701 +<a href="#__codelineno-0-96"> 96</a>

2702 +<a href="#__codelineno-0-97"> 97</a>

2703 +<a href="#__codelineno-0-98"> 98</a>

2704 +<a href="#__codelineno-0-99"> 99</a>

2705 +<a href="#__codelineno-0-100">100</a>

2706 +<a href="#__codelineno-0-101">101</a>

2707 +<a href="#__codelineno-0-102">102</a>

2708 +<a href="#__codelineno-0-103">103</a>

2709 +<a href="#__codelineno-0-104">104</a>

2710 +<a href="#__codelineno-0-105">105</a>

2711 +<a href="#__codelineno-0-106">106</a>

2712 +<a href="#__codelineno-0-107">107</a>

2713 +<a href="#__codelineno-0-108">108</a>

2714 +<a href="#__codelineno-0-109">109</a>

2715 +<a href="#__codelineno-0-110">110</a>

2716 +<a href="#__codelineno-0-111">111</a>

2717 +<a href="#__codelineno-0-112">112</a>

2718 +<a href="#__codelineno-0-113">113</a>

2719 +<a href="#__codelineno-0-114">114</a>

2720 +<a href="#__codelineno-0-115">115</a>

2721 +<a href="#__codelineno-0-116">116</a>

2722 +<a href="#__codelineno-0-117">117</a>

2723 +<a href="#__codelineno-0-118">118</a>

2724 +<a href="#__codelineno-0-119">119</a>

2725 +<a href="#__codelineno-0-120">120</a>

2726 +<a href="#__codelineno-0-121">121</a>

2727 +<a href="#__codelineno-0-122">122</a>

2728 +<a href="#__codelineno-0-123">123</a>

2729 +<a href="#__codelineno-0-124">124</a>

2730 +<a href="#__codelineno-0-125">125</a>

2731 +<a href="#__codelineno-0-126">126</a>

2732 +<a href="#__codelineno-0-127">127</a>

2733 +<a href="#__codelineno-0-128">128</a>

2734 +<a href="#__codelineno-0-129">129</a>

2735 +<a href="#__codelineno-0-130">130</a>

2736 +<a href="#__codelineno-0-131">131</a>

2737 +<a href="#__codelineno-0-132">132</a>

2738 +<a href="#__codelineno-0-133">133</a>

2739 +<a href="#__codelineno-0-134">134</a>

2740 +<a href="#__codelineno-0-135">135</a>

2741 +<a href="#__codelineno-0-136">136</a>

2742 +<a href="#__codelineno-0-137">137</a>

2743 +<a href="#__codelineno-0-138">138</a>

2744 +<a href="#__codelineno-0-139">139</a>

2745 +<a href="#__codelineno-0-140">140</a>

2746 +<a href="#__codelineno-0-141">141</a>

2747 +<a href="#__codelineno-0-142">142</a>

2748 +<a href="#__codelineno-0-143">143</a>

2749 +<a href="#__codelineno-0-144">144</a>

2750 +<a href="#__codelineno-0-145">145</a>

2751 +<a href="#__codelineno-0-146">146</a>

2752 +<a href="#__codelineno-0-147">147</a>

2753 +<a href="#__codelineno-0-148">148</a>

2754 +<a href="#__codelineno-0-149">149</a>

2755 +<a href="#__codelineno-0-150">150</a>

2756 +<a href="#__codelineno-0-151">151</a>

2757 +<a href="#__codelineno-0-152">152</a>

2758 +<a href="#__codelineno-0-153">153</a>

2759 +<a href="#__codelineno-0-154">154</a>

2760 +<a href="#__codelineno-0-155">155</a>

2761 +<a href="#__codelineno-0-156">156</a>

2762 +<a href="#__codelineno-0-157">157</a>

2763 +<a href="#__codelineno-0-158">158</a>

2764 +<a href="#__codelineno-0-159">159</a>

2765 +<a href="#__codelineno-0-160">160</a>

2766 +<a href="#__codelineno-0-161">161</a>

2767 +<a href="#__codelineno-0-162">162</a>

2768 +<a href="#__codelineno-0-163">163</a>

2769 +<a href="#__codelineno-0-164">164</a>

2770 +<a href="#__codelineno-0-165">165</a>

2771 +<a href="#__codelineno-0-166">166</a>

2772 +<a href="#__codelineno-0-167">167</a>

2773 +<a href="#__codelineno-0-168">168</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-64" name="__codelineno-0-64"></a>class WazuhManagerAgentService:

2774 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> """

2775 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> A service class that encapsulates the logic for handling agent-related operations in the Wazuh Manager.

2776 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a>

2777 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a> This class uses the UniversalService to get authentication tokens and URLs, and WazuhHttpRequests to make HTTP requests.

2778 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> It provides methods to collect all agents from Wazuh Manager and to delete a specific agent.

2779 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> """

2780 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a>

2781 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> def __init__(self, universal_service: UniversalService) -> None:

2782 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> """

2783 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> Initializes a WazuhManagerAgentService instance.

2784 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a>

2785 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> Args:

2786 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> universal_service (UniversalService): An instance of UniversalService.

2787 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> """

2788 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> self.universal_service = universal_service

2789 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> self.auth_token = universal_service.get_auth_token()

2790 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> self.wazuh_http_requests = WazuhHttpRequests(

2791 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> self.universal_service.connector_url,

2792 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> self.auth_token,

2793 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> )

2794 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a>

2795 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> def collect_agents(self) -> Optional[List[Dict[str, str]]]:

2796 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> """

2797 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> Collects all agents from the Wazuh Manager.

2798 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a>

2799 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> Returns:

2800 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> Optional[List[Dict[str, str]]]: A list of dictionaries where each dictionary contains data about an agent.

2801 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> If the operation fails, it returns None.

2802 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a> """

2803 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> logger.info("Collecting Wazuh Agents")

2804 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> try:

2805 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> agent_data = self._get_agent_data()

2806 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> if agent_data is None:

2807 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> return None

2808 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a>

2809 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> wazuh_agents_list = self._build_agent_list(agent_data)

2810 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> return wazuh_agents_list

2811 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> except Exception as e:

2812 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> logger.error(f"Failed to collect Wazuh Agents: {e}")

2813 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a> return None

2814 +<a id="__codelineno-0-105" name="__codelineno-0-105"></a>

2815 +<a id="__codelineno-0-106" name="__codelineno-0-106"></a> def _get_agent_data(self) -> Optional[Dict[str, Any]]:

2816 +<a id="__codelineno-0-107" name="__codelineno-0-107"></a> """

2817 +<a id="__codelineno-0-108" name="__codelineno-0-108"></a> Retrieves agent data from the Wazuh Manager.

2818 +<a id="__codelineno-0-109" name="__codelineno-0-109"></a>

2819 +<a id="__codelineno-0-110" name="__codelineno-0-110"></a> Returns:

2820 +<a id="__codelineno-0-111" name="__codelineno-0-111"></a> Optional[Dict[str, Any]]: A dictionary containing data about agents. If the operation fails, it returns None.

2821 +<a id="__codelineno-0-112" name="__codelineno-0-112"></a> """

2822 +<a id="__codelineno-0-113" name="__codelineno-0-113"></a> headers = {"Authorization": f"Bearer {self.auth_token}"}

2823 +<a id="__codelineno-0-114" name="__codelineno-0-114"></a> limit = 1000

2824 +<a id="__codelineno-0-115" name="__codelineno-0-115"></a> response = requests.get(

2825 +<a id="__codelineno-0-116" name="__codelineno-0-116"></a> f"{self.universal_service.connector_url}/agents?limit={limit}",

2826 +<a id="__codelineno-0-117" name="__codelineno-0-117"></a> headers=headers,

2827 +<a id="__codelineno-0-118" name="__codelineno-0-118"></a> verify=False,

2828 +<a id="__codelineno-0-119" name="__codelineno-0-119"></a> )

2829 +<a id="__codelineno-0-120" name="__codelineno-0-120"></a> if response.status_code == 200:

2830 +<a id="__codelineno-0-121" name="__codelineno-0-121"></a> return response.json()["data"]["affected_items"]

2831 +<a id="__codelineno-0-122" name="__codelineno-0-122"></a> else:

2832 +<a id="__codelineno-0-123" name="__codelineno-0-123"></a> return None

2833 +<a id="__codelineno-0-124" name="__codelineno-0-124"></a>

2834 +<a id="__codelineno-0-125" name="__codelineno-0-125"></a> def _build_agent_list(self, agent_data: Dict[str, Any]) -> List[Dict[str, str]]:

2835 +<a id="__codelineno-0-126" name="__codelineno-0-126"></a> """

2836 +<a id="__codelineno-0-127" name="__codelineno-0-127"></a> Builds a list of dictionaries with agent data.

2837 +<a id="__codelineno-0-128" name="__codelineno-0-128"></a>

2838 +<a id="__codelineno-0-129" name="__codelineno-0-129"></a> Args:

2839 +<a id="__codelineno-0-130" name="__codelineno-0-130"></a> agent_data (Dict[str, Any]): The raw agent data.

2840 +<a id="__codelineno-0-131" name="__codelineno-0-131"></a>

2841 +<a id="__codelineno-0-132" name="__codelineno-0-132"></a> Returns:

2842 +<a id="__codelineno-0-133" name="__codelineno-0-133"></a> List[Dict[str, str]]: A list of dictionaries where each dictionary contains data about an agent.

2843 +<a id="__codelineno-0-134" name="__codelineno-0-134"></a> """

2844 +<a id="__codelineno-0-135" name="__codelineno-0-135"></a> wazuh_agents_list = []

2845 +<a id="__codelineno-0-136" name="__codelineno-0-136"></a> for agent in agent_data:

2846 +<a id="__codelineno-0-137" name="__codelineno-0-137"></a> os_name = agent.get("os", {}).get("name", "Unknown")

2847 +<a id="__codelineno-0-138" name="__codelineno-0-138"></a> last_keep_alive = agent.get("lastKeepAlive", "Unknown")

2848 +<a id="__codelineno-0-139" name="__codelineno-0-139"></a> wazuh_agents_list.append(

2849 +<a id="__codelineno-0-140" name="__codelineno-0-140"></a> {

2850 +<a id="__codelineno-0-141" name="__codelineno-0-141"></a> "agent_id": agent["id"],

2851 +<a id="__codelineno-0-142" name="__codelineno-0-142"></a> "agent_name": agent["name"],

2852 +<a id="__codelineno-0-143" name="__codelineno-0-143"></a> "agent_ip": agent["ip"],

2853 +<a id="__codelineno-0-144" name="__codelineno-0-144"></a> "agent_os": os_name,

2854 +<a id="__codelineno-0-145" name="__codelineno-0-145"></a> "agent_last_seen": last_keep_alive,

2855 +<a id="__codelineno-0-146" name="__codelineno-0-146"></a> },

2856 +<a id="__codelineno-0-147" name="__codelineno-0-147"></a> )

2857 +<a id="__codelineno-0-148" name="__codelineno-0-148"></a> logger.info(f"Collected Wazuh Agent: {agent['name']}")

2858 +<a id="__codelineno-0-149" name="__codelineno-0-149"></a> return wazuh_agents_list

2859 +<a id="__codelineno-0-150" name="__codelineno-0-150"></a>

2860 +<a id="__codelineno-0-151" name="__codelineno-0-151"></a> def delete_agent(self, agent_id: str) -> Dict[str, bool]:

2861 +<a id="__codelineno-0-152" name="__codelineno-0-152"></a> """

2862 +<a id="__codelineno-0-153" name="__codelineno-0-153"></a> Deletes an agent from the Wazuh Manager.

2863 +<a id="__codelineno-0-154" name="__codelineno-0-154"></a>

2864 +<a id="__codelineno-0-155" name="__codelineno-0-155"></a> Args:

2865 +<a id="__codelineno-0-156" name="__codelineno-0-156"></a> agent_id (str): The id of the agent to be deleted.

2866 +<a id="__codelineno-0-157" name="__codelineno-0-157"></a>

2867 +<a id="__codelineno-0-158" name="__codelineno-0-158"></a> Returns:

2868 +<a id="__codelineno-0-159" name="__codelineno-0-159"></a> Dict[str, bool]: A dictionary indicating the success of the operation. If the operation was successful,

2869 +<a id="__codelineno-0-160" name="__codelineno-0-160"></a> `{"agentDeleted": True}` is returned. If it failed, `{"agentDeleted": False}` is returned.

2870 +<a id="__codelineno-0-161" name="__codelineno-0-161"></a> """

2871 +<a id="__codelineno-0-162" name="__codelineno-0-162"></a> params = {

2872 +<a id="__codelineno-0-163" name="__codelineno-0-163"></a> "purge": True,

2873 +<a id="__codelineno-0-164" name="__codelineno-0-164"></a> "agents_list": [agent_id],

2874 +<a id="__codelineno-0-165" name="__codelineno-0-165"></a> "status": "all",

2875 +<a id="__codelineno-0-166" name="__codelineno-0-166"></a> "older_than": "0s",

2876 +<a id="__codelineno-0-167" name="__codelineno-0-167"></a> }

2877 +<a id="__codelineno-0-168" name="__codelineno-0-168"></a> return self.wazuh_http_requests.delete_request("agents", params)

2878 +</code></pre></div></td></tr></table></div>

2879 + </details>

2880 +

2881 +

2882 +

2883 + <div class="doc doc-children">

2884 +

2885 +

2886 +

2887 +

2888 +

2889 +

2890 +

2891 +

2892 +

2893 +<div class="doc doc-object doc-function">

2894 +

2895 +

2896 +

2897 +<h3 id="app.services.WazuhManager.agent.WazuhManagerAgentService.__init__" class="doc doc-heading">

2898 +<code class="highlight language-python">__init__(universal_service)</code>

2899 +

2900 +</h3>

2901 +

2902 +

2903 + <div class="doc doc-contents ">

2904 +

2905 + Initializes a WazuhManagerAgentService instance.

2906 +

2907 + Parameters:

2908 + <table>

2909 + <thead>

2910 + <tr>

2911 + <th>Name</th>

2912 + <th>Type</th>

2913 + <th>Description</th>

2914 + <th>Default</th>

2915 + </tr>

2916 + </thead>

2917 + <tbody>

2918 + <tr>

2919 + <td><code>universal_service</code></td>

2920 + <td>

2921 + <code><a class="autorefs autorefs-internal" title="app.services.WazuhManager.universal.UniversalService" href="#app.services.WazuhManager.universal.UniversalService">UniversalService</a></code>

2922 + </td>

2923 + <td>

2924 + <div class="doc-md-description">

2925 + An instance of UniversalService.

2926 + </div>

2927 + </td>

2928 + <td>

2929 + required

2930 + </td>

2931 + </tr>

2932 + </tbody>

2933 + </table>

2934 +

2935 + <details class="quote">

2936 + <summary>Source code in <code>app\services\WazuhManager\agent.py</code></summary>

2937 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-72">72</a>

2938 +<a href="#__codelineno-0-73">73</a>

2939 +<a href="#__codelineno-0-74">74</a>

2940 +<a href="#__codelineno-0-75">75</a>

2941 +<a href="#__codelineno-0-76">76</a>

2942 +<a href="#__codelineno-0-77">77</a>

2943 +<a href="#__codelineno-0-78">78</a>

2944 +<a href="#__codelineno-0-79">79</a>

2945 +<a href="#__codelineno-0-80">80</a>

2946 +<a href="#__codelineno-0-81">81</a>

2947 +<a href="#__codelineno-0-82">82</a>

2948 +<a href="#__codelineno-0-83">83</a>

2949 +<a href="#__codelineno-0-84">84</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-72" name="__codelineno-0-72"></a>def __init__(self, universal_service: UniversalService) -> None:

2950 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> """

2951 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> Initializes a WazuhManagerAgentService instance.

2952 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a>

2953 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> Args:

2954 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> universal_service (UniversalService): An instance of UniversalService.

2955 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> """

2956 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> self.universal_service = universal_service

2957 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> self.auth_token = universal_service.get_auth_token()

2958 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> self.wazuh_http_requests = WazuhHttpRequests(

2959 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> self.universal_service.connector_url,

2960 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> self.auth_token,

2961 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a> )

2962 +</code></pre></div></td></tr></table></div>

2963 + </details>

2964 + </div>

2965 +

2966 +</div>

2967 +

2968 +<div class="doc doc-object doc-function">

2969 +

2970 +

2971 +

2972 +<h3 id="app.services.WazuhManager.agent.WazuhManagerAgentService.collect_agents" class="doc doc-heading">

2973 +<code class="highlight language-python">collect_agents()</code>

2974 +

2975 +</h3>

2976 +

2977 +

2978 + <div class="doc doc-contents ">

2979 +

2980 + Collects all agents from the Wazuh Manager.

2981 +

2982 + Returns:

2983 + <table>

2984 + <thead>

2985 + <tr>

2986 + <th>Type</th>

2987 + <th>Description</th>

2988 + </tr>

2989 + </thead>

2990 + <tbody>

2991 + <tr>

2992 + <td>

2993 + <code>Optional[List[Dict[str, str]]]</code>

2994 + </td>

2995 + <td>

2996 + <div class="doc-md-description">

2997 + Optional[List[Dict[str, str]]]: A list of dictionaries where each dictionary contains data about an agent.

2998 + If the operation fails, it returns None.

2999 + </div>

3000 + </td>

3001 + </tr>

3002 + </tbody>

3003 + </table>

3004 +

3005 + <details class="quote">

3006 + <summary>Source code in <code>app\services\WazuhManager\agent.py</code></summary>

3007 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-86"> 86</a>

3008 +<a href="#__codelineno-0-87"> 87</a>

3009 +<a href="#__codelineno-0-88"> 88</a>

3010 +<a href="#__codelineno-0-89"> 89</a>

3011 +<a href="#__codelineno-0-90"> 90</a>

3012 +<a href="#__codelineno-0-91"> 91</a>

3013 +<a href="#__codelineno-0-92"> 92</a>

3014 +<a href="#__codelineno-0-93"> 93</a>

3015 +<a href="#__codelineno-0-94"> 94</a>

3016 +<a href="#__codelineno-0-95"> 95</a>

3017 +<a href="#__codelineno-0-96"> 96</a>

3018 +<a href="#__codelineno-0-97"> 97</a>

3019 +<a href="#__codelineno-0-98"> 98</a>

3020 +<a href="#__codelineno-0-99"> 99</a>

3021 +<a href="#__codelineno-0-100">100</a>

3022 +<a href="#__codelineno-0-101">101</a>

3023 +<a href="#__codelineno-0-102">102</a>

3024 +<a href="#__codelineno-0-103">103</a>

3025 +<a href="#__codelineno-0-104">104</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-86" name="__codelineno-0-86"></a>def collect_agents(self) -> Optional[List[Dict[str, str]]]:

3026 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> """

3027 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> Collects all agents from the Wazuh Manager.

3028 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a>

3029 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> Returns:

3030 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> Optional[List[Dict[str, str]]]: A list of dictionaries where each dictionary contains data about an agent.

3031 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> If the operation fails, it returns None.

3032 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a> """

3033 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> logger.info("Collecting Wazuh Agents")

3034 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> try:

3035 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a> agent_data = self._get_agent_data()

3036 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> if agent_data is None:

3037 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> return None

3038 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a>

3039 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> wazuh_agents_list = self._build_agent_list(agent_data)

3040 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> return wazuh_agents_list

3041 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> except Exception as e:

3042 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> logger.error(f"Failed to collect Wazuh Agents: {e}")

3043 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a> return None

3044 +</code></pre></div></td></tr></table></div>

3045 + </details>

3046 + </div>

3047 +

3048 +</div>

3049 +

3050 +<div class="doc doc-object doc-function">

3051 +

3052 +

3053 +

3054 +<h3 id="app.services.WazuhManager.agent.WazuhManagerAgentService.delete_agent" class="doc doc-heading">

3055 +<code class="highlight language-python">delete_agent(agent_id)</code>

3056 +

3057 +</h3>

3058 +

3059 +

3060 + <div class="doc doc-contents ">

3061 +

3062 + Deletes an agent from the Wazuh Manager.

3063 +

3064 + Parameters:

3065 + <table>

3066 + <thead>

3067 + <tr>

3068 + <th>Name</th>

3069 + <th>Type</th>

3070 + <th>Description</th>

3071 + <th>Default</th>

3072 + </tr>

3073 + </thead>

3074 + <tbody>

3075 + <tr>

3076 + <td><code>agent_id</code></td>

3077 + <td>

3078 + <code>str</code>

3079 + </td>

3080 + <td>

3081 + <div class="doc-md-description">

3082 + The id of the agent to be deleted.

3083 + </div>

3084 + </td>

3085 + <td>

3086 + required

3087 + </td>

3088 + </tr>

3089 + </tbody>

3090 + </table>

3091 +

3092 + Returns:

3093 + <table>

3094 + <thead>

3095 + <tr>

3096 + <th>Type</th>

3097 + <th>Description</th>

3098 + </tr>

3099 + </thead>

3100 + <tbody>

3101 + <tr>

3102 + <td>

3103 + <code>Dict[str, bool]</code>

3104 + </td>

3105 + <td>

3106 + <div class="doc-md-description">

3107 + Dict[str, bool]: A dictionary indicating the success of the operation. If the operation was successful,

3108 + <code>{"agentDeleted": True}</code> is returned. If it failed, <code>{"agentDeleted": False}</code> is returned.

3109 + </div>

3110 + </td>

3111 + </tr>

3112 + </tbody>

3113 + </table>

3114 +

3115 + <details class="quote">

3116 + <summary>Source code in <code>app\services\WazuhManager\agent.py</code></summary>

3117 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-151">151</a>

3118 +<a href="#__codelineno-0-152">152</a>

3119 +<a href="#__codelineno-0-153">153</a>

3120 +<a href="#__codelineno-0-154">154</a>

3121 +<a href="#__codelineno-0-155">155</a>

3122 +<a href="#__codelineno-0-156">156</a>

3123 +<a href="#__codelineno-0-157">157</a>

3124 +<a href="#__codelineno-0-158">158</a>

3125 +<a href="#__codelineno-0-159">159</a>

3126 +<a href="#__codelineno-0-160">160</a>

3127 +<a href="#__codelineno-0-161">161</a>

3128 +<a href="#__codelineno-0-162">162</a>

3129 +<a href="#__codelineno-0-163">163</a>

3130 +<a href="#__codelineno-0-164">164</a>

3131 +<a href="#__codelineno-0-165">165</a>

3132 +<a href="#__codelineno-0-166">166</a>

3133 +<a href="#__codelineno-0-167">167</a>

3134 +<a href="#__codelineno-0-168">168</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-151" name="__codelineno-0-151"></a>def delete_agent(self, agent_id: str) -> Dict[str, bool]:

3135 +<a id="__codelineno-0-152" name="__codelineno-0-152"></a> """

3136 +<a id="__codelineno-0-153" name="__codelineno-0-153"></a> Deletes an agent from the Wazuh Manager.

3137 +<a id="__codelineno-0-154" name="__codelineno-0-154"></a>

3138 +<a id="__codelineno-0-155" name="__codelineno-0-155"></a> Args:

3139 +<a id="__codelineno-0-156" name="__codelineno-0-156"></a> agent_id (str): The id of the agent to be deleted.

3140 +<a id="__codelineno-0-157" name="__codelineno-0-157"></a>

3141 +<a id="__codelineno-0-158" name="__codelineno-0-158"></a> Returns:

3142 +<a id="__codelineno-0-159" name="__codelineno-0-159"></a> Dict[str, bool]: A dictionary indicating the success of the operation. If the operation was successful,

3143 +<a id="__codelineno-0-160" name="__codelineno-0-160"></a> `{"agentDeleted": True}` is returned. If it failed, `{"agentDeleted": False}` is returned.

3144 +<a id="__codelineno-0-161" name="__codelineno-0-161"></a> """

3145 +<a id="__codelineno-0-162" name="__codelineno-0-162"></a> params = {

3146 +<a id="__codelineno-0-163" name="__codelineno-0-163"></a> "purge": True,

3147 +<a id="__codelineno-0-164" name="__codelineno-0-164"></a> "agents_list": [agent_id],

3148 +<a id="__codelineno-0-165" name="__codelineno-0-165"></a> "status": "all",

3149 +<a id="__codelineno-0-166" name="__codelineno-0-166"></a> "older_than": "0s",

3150 +<a id="__codelineno-0-167" name="__codelineno-0-167"></a> }

3151 +<a id="__codelineno-0-168" name="__codelineno-0-168"></a> return self.wazuh_http_requests.delete_request("agents", params)

3152 +</code></pre></div></td></tr></table></div>

3153 + </details>

3154 + </div>

3155 +

3156 +</div>

3157 +

3158 +

3159 +

3160 + </div>

3161 +

3162 + </div>

3163 +

3164 +</div>

3165 +

3166 +

3167 +

3168 +

3169 + </div>

3170 +

3171 + </div>

3172 +

3173 +</div>

3174 +

3175 +<div class="doc doc-object doc-module">

3176 +

3177 +

3178 +<a id="app.services.WazuhManager.disabled_rule"></a>

3179 + <div class="doc doc-contents first">

3180 +

3181 +

3182 +

3183 + <div class="doc doc-children">

3184 +

3185 +

3186 +

3187 +

3188 +

3189 +

3190 +

3191 +

3192 +<div class="doc doc-object doc-class">

3193 +

3194 +

3195 +

3196 +<h2 id="app.services.WazuhManager.disabled_rule.DisableRuleService" class="doc doc-heading">

3197 + <code>DisableRuleService</code>

3198 +

3199 +

3200 +</h2>

3201 +

3202 +

3203 + <div class="doc doc-contents ">

3204 +

3205 +

3206 + This class handles rule disabling related operations in Wazuh Manager.

3207 +

3208 + Attributes:

3209 + <table>

3210 + <thead>

3211 + <tr>

3212 + <th>Name</th>

3213 + <th>Type</th>

3214 + <th>Description</th>

3215 + </tr>

3216 + </thead>

3217 + <tbody>

3218 + <tr>

3219 + <td><code>universal_service</code></td>

3220 + <td>

3221 + <code><a class="autorefs autorefs-internal" title="app.services.WazuhManager.universal.UniversalService" href="#app.services.WazuhManager.universal.UniversalService">UniversalService</a></code>

3222 + </td>

3223 + <td>

3224 + <div class="doc-md-description">

3225 + An instance of UniversalService.

3226 + </div>

3227 + </td>

3228 + </tr>

3229 + <tr>

3230 + <td><code>auth_token</code></td>

3231 + <td>

3232 + <code>str</code>

3233 + </td>

3234 + <td>

3235 + <div class="doc-md-description">

3236 + The Wazuh API authentication token.

3237 + </div>

3238 + </td>

3239 + </tr>

3240 + <tr>

3241 + <td><code>wazuh_http_requests</code></td>

3242 + <td>

3243 + <code><a class="autorefs autorefs-internal" title="app.services.WazuhManager.disabled_rule.WazuhHttpRequests" href="#app.services.WazuhManager.disabled_rule.WazuhHttpRequests">WazuhHttpRequests</a></code>

3244 + </td>

3245 + <td>

3246 + <div class="doc-md-description">

3247 + An instance of WazuhHttpRequests.

3248 + </div>

3249 + </td>

3250 + </tr>

3251 + </tbody>

3252 + </table>

3253 +

3254 +

3255 + <details class="quote">

3256 + <summary>Source code in <code>app\services\WazuhManager\disabled_rule.py</code></summary>

3257 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-112">112</a>

3258 +<a href="#__codelineno-0-113">113</a>

3259 +<a href="#__codelineno-0-114">114</a>

3260 +<a href="#__codelineno-0-115">115</a>

3261 +<a href="#__codelineno-0-116">116</a>

3262 +<a href="#__codelineno-0-117">117</a>

3263 +<a href="#__codelineno-0-118">118</a>

3264 +<a href="#__codelineno-0-119">119</a>

3265 +<a href="#__codelineno-0-120">120</a>

3266 +<a href="#__codelineno-0-121">121</a>

3267 +<a href="#__codelineno-0-122">122</a>

3268 +<a href="#__codelineno-0-123">123</a>

3269 +<a href="#__codelineno-0-124">124</a>

3270 +<a href="#__codelineno-0-125">125</a>

3271 +<a href="#__codelineno-0-126">126</a>

3272 +<a href="#__codelineno-0-127">127</a>

3273 +<a href="#__codelineno-0-128">128</a>

3274 +<a href="#__codelineno-0-129">129</a>

3275 +<a href="#__codelineno-0-130">130</a>

3276 +<a href="#__codelineno-0-131">131</a>

3277 +<a href="#__codelineno-0-132">132</a>

3278 +<a href="#__codelineno-0-133">133</a>

3279 +<a href="#__codelineno-0-134">134</a>

3280 +<a href="#__codelineno-0-135">135</a>

3281 +<a href="#__codelineno-0-136">136</a>

3282 +<a href="#__codelineno-0-137">137</a>

3283 +<a href="#__codelineno-0-138">138</a>

3284 +<a href="#__codelineno-0-139">139</a>

3285 +<a href="#__codelineno-0-140">140</a>

3286 +<a href="#__codelineno-0-141">141</a>

3287 +<a href="#__codelineno-0-142">142</a>

3288 +<a href="#__codelineno-0-143">143</a>

3289 +<a href="#__codelineno-0-144">144</a>

3290 +<a href="#__codelineno-0-145">145</a>

3291 +<a href="#__codelineno-0-146">146</a>

3292 +<a href="#__codelineno-0-147">147</a>

3293 +<a href="#__codelineno-0-148">148</a>

3294 +<a href="#__codelineno-0-149">149</a>

3295 +<a href="#__codelineno-0-150">150</a>

3296 +<a href="#__codelineno-0-151">151</a>

3297 +<a href="#__codelineno-0-152">152</a>

3298 +<a href="#__codelineno-0-153">153</a>

3299 +<a href="#__codelineno-0-154">154</a>

3300 +<a href="#__codelineno-0-155">155</a>

3301 +<a href="#__codelineno-0-156">156</a>

3302 +<a href="#__codelineno-0-157">157</a>

3303 +<a href="#__codelineno-0-158">158</a>

3304 +<a href="#__codelineno-0-159">159</a>

3305 +<a href="#__codelineno-0-160">160</a>

3306 +<a href="#__codelineno-0-161">161</a>

3307 +<a href="#__codelineno-0-162">162</a>

3308 +<a href="#__codelineno-0-163">163</a>

3309 +<a href="#__codelineno-0-164">164</a>

3310 +<a href="#__codelineno-0-165">165</a>

3311 +<a href="#__codelineno-0-166">166</a>

3312 +<a href="#__codelineno-0-167">167</a>

3313 +<a href="#__codelineno-0-168">168</a>

3314 +<a href="#__codelineno-0-169">169</a>

3315 +<a href="#__codelineno-0-170">170</a>

3316 +<a href="#__codelineno-0-171">171</a>

3317 +<a href="#__codelineno-0-172">172</a>

3318 +<a href="#__codelineno-0-173">173</a>

3319 +<a href="#__codelineno-0-174">174</a>

3320 +<a href="#__codelineno-0-175">175</a>

3321 +<a href="#__codelineno-0-176">176</a>

3322 +<a href="#__codelineno-0-177">177</a>

3323 +<a href="#__codelineno-0-178">178</a>

3324 +<a href="#__codelineno-0-179">179</a>

3325 +<a href="#__codelineno-0-180">180</a>

3326 +<a href="#__codelineno-0-181">181</a>

3327 +<a href="#__codelineno-0-182">182</a>

3328 +<a href="#__codelineno-0-183">183</a>

3329 +<a href="#__codelineno-0-184">184</a>

3330 +<a href="#__codelineno-0-185">185</a>

3331 +<a href="#__codelineno-0-186">186</a>

3332 +<a href="#__codelineno-0-187">187</a>

3333 +<a href="#__codelineno-0-188">188</a>

3334 +<a href="#__codelineno-0-189">189</a>

3335 +<a href="#__codelineno-0-190">190</a>

3336 +<a href="#__codelineno-0-191">191</a>

3337 +<a href="#__codelineno-0-192">192</a>

3338 +<a href="#__codelineno-0-193">193</a>

3339 +<a href="#__codelineno-0-194">194</a>

3340 +<a href="#__codelineno-0-195">195</a>

3341 +<a href="#__codelineno-0-196">196</a>

3342 +<a href="#__codelineno-0-197">197</a>

3343 +<a href="#__codelineno-0-198">198</a>

3344 +<a href="#__codelineno-0-199">199</a>

3345 +<a href="#__codelineno-0-200">200</a>

3346 +<a href="#__codelineno-0-201">201</a>

3347 +<a href="#__codelineno-0-202">202</a>

3348 +<a href="#__codelineno-0-203">203</a>

3349 +<a href="#__codelineno-0-204">204</a>

3350 +<a href="#__codelineno-0-205">205</a>

3351 +<a href="#__codelineno-0-206">206</a>

3352 +<a href="#__codelineno-0-207">207</a>

3353 +<a href="#__codelineno-0-208">208</a>

3354 +<a href="#__codelineno-0-209">209</a>

3355 +<a href="#__codelineno-0-210">210</a>

3356 +<a href="#__codelineno-0-211">211</a>

3357 +<a href="#__codelineno-0-212">212</a>

3358 +<a href="#__codelineno-0-213">213</a>

3359 +<a href="#__codelineno-0-214">214</a>

3360 +<a href="#__codelineno-0-215">215</a>

3361 +<a href="#__codelineno-0-216">216</a>

3362 +<a href="#__codelineno-0-217">217</a>

3363 +<a href="#__codelineno-0-218">218</a>

3364 +<a href="#__codelineno-0-219">219</a>

3365 +<a href="#__codelineno-0-220">220</a>

3366 +<a href="#__codelineno-0-221">221</a>

3367 +<a href="#__codelineno-0-222">222</a>

3368 +<a href="#__codelineno-0-223">223</a>

3369 +<a href="#__codelineno-0-224">224</a>

3370 +<a href="#__codelineno-0-225">225</a>

3371 +<a href="#__codelineno-0-226">226</a>

3372 +<a href="#__codelineno-0-227">227</a>

3373 +<a href="#__codelineno-0-228">228</a>

3374 +<a href="#__codelineno-0-229">229</a>

3375 +<a href="#__codelineno-0-230">230</a>

3376 +<a href="#__codelineno-0-231">231</a>

3377 +<a href="#__codelineno-0-232">232</a>

3378 +<a href="#__codelineno-0-233">233</a>

3379 +<a href="#__codelineno-0-234">234</a>

3380 +<a href="#__codelineno-0-235">235</a>

3381 +<a href="#__codelineno-0-236">236</a>

3382 +<a href="#__codelineno-0-237">237</a>

3383 +<a href="#__codelineno-0-238">238</a>

3384 +<a href="#__codelineno-0-239">239</a>

3385 +<a href="#__codelineno-0-240">240</a>

3386 +<a href="#__codelineno-0-241">241</a>

3387 +<a href="#__codelineno-0-242">242</a>

3388 +<a href="#__codelineno-0-243">243</a>

3389 +<a href="#__codelineno-0-244">244</a>

3390 +<a href="#__codelineno-0-245">245</a>

3391 +<a href="#__codelineno-0-246">246</a>

3392 +<a href="#__codelineno-0-247">247</a>

3393 +<a href="#__codelineno-0-248">248</a>

3394 +<a href="#__codelineno-0-249">249</a>

3395 +<a href="#__codelineno-0-250">250</a>

3396 +<a href="#__codelineno-0-251">251</a>

3397 +<a href="#__codelineno-0-252">252</a>

3398 +<a href="#__codelineno-0-253">253</a>

3399 +<a href="#__codelineno-0-254">254</a>

3400 +<a href="#__codelineno-0-255">255</a>

3401 +<a href="#__codelineno-0-256">256</a>

3402 +<a href="#__codelineno-0-257">257</a>

3403 +<a href="#__codelineno-0-258">258</a>

3404 +<a href="#__codelineno-0-259">259</a>

3405 +<a href="#__codelineno-0-260">260</a>

3406 +<a href="#__codelineno-0-261">261</a>

3407 +<a href="#__codelineno-0-262">262</a>

3408 +<a href="#__codelineno-0-263">263</a>

3409 +<a href="#__codelineno-0-264">264</a>

3410 +<a href="#__codelineno-0-265">265</a>

3411 +<a href="#__codelineno-0-266">266</a>

3412 +<a href="#__codelineno-0-267">267</a>

3413 +<a href="#__codelineno-0-268">268</a>

3414 +<a href="#__codelineno-0-269">269</a>

3415 +<a href="#__codelineno-0-270">270</a>

3416 +<a href="#__codelineno-0-271">271</a>

3417 +<a href="#__codelineno-0-272">272</a>

3418 +<a href="#__codelineno-0-273">273</a>

3419 +<a href="#__codelineno-0-274">274</a>

3420 +<a href="#__codelineno-0-275">275</a>

3421 +<a href="#__codelineno-0-276">276</a>

3422 +<a href="#__codelineno-0-277">277</a>

3423 +<a href="#__codelineno-0-278">278</a>

3424 +<a href="#__codelineno-0-279">279</a>

3425 +<a href="#__codelineno-0-280">280</a>

3426 +<a href="#__codelineno-0-281">281</a>

3427 +<a href="#__codelineno-0-282">282</a>

3428 +<a href="#__codelineno-0-283">283</a>

3429 +<a href="#__codelineno-0-284">284</a>

3430 +<a href="#__codelineno-0-285">285</a>

3431 +<a href="#__codelineno-0-286">286</a>

3432 +<a href="#__codelineno-0-287">287</a>

3433 +<a href="#__codelineno-0-288">288</a>

3434 +<a href="#__codelineno-0-289">289</a>

3435 +<a href="#__codelineno-0-290">290</a>

3436 +<a href="#__codelineno-0-291">291</a>

3437 +<a href="#__codelineno-0-292">292</a>

3438 +<a href="#__codelineno-0-293">293</a>

3439 +<a href="#__codelineno-0-294">294</a>

3440 +<a href="#__codelineno-0-295">295</a>

3441 +<a href="#__codelineno-0-296">296</a>

3442 +<a href="#__codelineno-0-297">297</a>

3443 +<a href="#__codelineno-0-298">298</a>

3444 +<a href="#__codelineno-0-299">299</a>

3445 +<a href="#__codelineno-0-300">300</a>

3446 +<a href="#__codelineno-0-301">301</a>

3447 +<a href="#__codelineno-0-302">302</a>

3448 +<a href="#__codelineno-0-303">303</a>

3449 +<a href="#__codelineno-0-304">304</a>

3450 +<a href="#__codelineno-0-305">305</a>

3451 +<a href="#__codelineno-0-306">306</a>

3452 +<a href="#__codelineno-0-307">307</a>

3453 +<a href="#__codelineno-0-308">308</a>

3454 +<a href="#__codelineno-0-309">309</a>

3455 +<a href="#__codelineno-0-310">310</a>

3456 +<a href="#__codelineno-0-311">311</a>

3457 +<a href="#__codelineno-0-312">312</a>

3458 +<a href="#__codelineno-0-313">313</a>

3459 +<a href="#__codelineno-0-314">314</a>

3460 +<a href="#__codelineno-0-315">315</a>

3461 +<a href="#__codelineno-0-316">316</a>

3462 +<a href="#__codelineno-0-317">317</a>

3463 +<a href="#__codelineno-0-318">318</a>

3464 +<a href="#__codelineno-0-319">319</a>

3465 +<a href="#__codelineno-0-320">320</a>

3466 +<a href="#__codelineno-0-321">321</a>

3467 +<a href="#__codelineno-0-322">322</a>

3468 +<a href="#__codelineno-0-323">323</a>

3469 +<a href="#__codelineno-0-324">324</a>

3470 +<a href="#__codelineno-0-325">325</a>

3471 +<a href="#__codelineno-0-326">326</a>

3472 +<a href="#__codelineno-0-327">327</a>

3473 +<a href="#__codelineno-0-328">328</a>

3474 +<a href="#__codelineno-0-329">329</a>

3475 +<a href="#__codelineno-0-330">330</a>

3476 +<a href="#__codelineno-0-331">331</a>

3477 +<a href="#__codelineno-0-332">332</a>

3478 +<a href="#__codelineno-0-333">333</a>

3479 +<a href="#__codelineno-0-334">334</a>

3480 +<a href="#__codelineno-0-335">335</a>

3481 +<a href="#__codelineno-0-336">336</a>

3482 +<a href="#__codelineno-0-337">337</a>

3483 +<a href="#__codelineno-0-338">338</a>

3484 +<a href="#__codelineno-0-339">339</a>

3485 +<a href="#__codelineno-0-340">340</a>

3486 +<a href="#__codelineno-0-341">341</a>

3487 +<a href="#__codelineno-0-342">342</a>

3488 +<a href="#__codelineno-0-343">343</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-112" name="__codelineno-0-112"></a>class DisableRuleService:

3489 +<a id="__codelineno-0-113" name="__codelineno-0-113"></a> """

3490 +<a id="__codelineno-0-114" name="__codelineno-0-114"></a> This class handles rule disabling related operations in Wazuh Manager.

3491 +<a id="__codelineno-0-115" name="__codelineno-0-115"></a>

3492 +<a id="__codelineno-0-116" name="__codelineno-0-116"></a> Attributes:

3493 +<a id="__codelineno-0-117" name="__codelineno-0-117"></a> universal_service (UniversalService): An instance of UniversalService.

3494 +<a id="__codelineno-0-118" name="__codelineno-0-118"></a> auth_token (str): The Wazuh API authentication token.

3495 +<a id="__codelineno-0-119" name="__codelineno-0-119"></a> wazuh_http_requests (WazuhHttpRequests): An instance of WazuhHttpRequests.

3496 +<a id="__codelineno-0-120" name="__codelineno-0-120"></a> """

3497 +<a id="__codelineno-0-121" name="__codelineno-0-121"></a>

3498 +<a id="__codelineno-0-122" name="__codelineno-0-122"></a> def __init__(self, universal_service: UniversalService) -> None:

3499 +<a id="__codelineno-0-123" name="__codelineno-0-123"></a> """

3500 +<a id="__codelineno-0-124" name="__codelineno-0-124"></a> Initialize a DisableRuleService instance.

3501 +<a id="__codelineno-0-125" name="__codelineno-0-125"></a>

3502 +<a id="__codelineno-0-126" name="__codelineno-0-126"></a> Args:

3503 +<a id="__codelineno-0-127" name="__codelineno-0-127"></a> universal_service (UniversalService): The UniversalService instance to use.

3504 +<a id="__codelineno-0-128" name="__codelineno-0-128"></a> """

3505 +<a id="__codelineno-0-129" name="__codelineno-0-129"></a> self.universal_service = universal_service

3506 +<a id="__codelineno-0-130" name="__codelineno-0-130"></a> self.auth_token = universal_service.get_auth_token()

3507 +<a id="__codelineno-0-131" name="__codelineno-0-131"></a> self.wazuh_http_requests = WazuhHttpRequests(

3508 +<a id="__codelineno-0-132" name="__codelineno-0-132"></a> self.universal_service.connector_url,

3509 +<a id="__codelineno-0-133" name="__codelineno-0-133"></a> self.auth_token,

3510 +<a id="__codelineno-0-134" name="__codelineno-0-134"></a> )

3511 +<a id="__codelineno-0-135" name="__codelineno-0-135"></a>

3512 +<a id="__codelineno-0-136" name="__codelineno-0-136"></a> def disable_rule(

3513 +<a id="__codelineno-0-137" name="__codelineno-0-137"></a> self,

3514 +<a id="__codelineno-0-138" name="__codelineno-0-138"></a> request: Dict[str, Union[str, int]],

3515 +<a id="__codelineno-0-139" name="__codelineno-0-139"></a> ) -> Dict[str, Union[str, bool]]:

3516 +<a id="__codelineno-0-140" name="__codelineno-0-140"></a> """

3517 +<a id="__codelineno-0-141" name="__codelineno-0-141"></a> Disable a rule in Wazuh Manager.

3518 +<a id="__codelineno-0-142" name="__codelineno-0-142"></a>

3519 +<a id="__codelineno-0-143" name="__codelineno-0-143"></a> Args:

3520 +<a id="__codelineno-0-144" name="__codelineno-0-144"></a> request (Dict[str, Union[str, int]]): The request to disable a rule. It should contain 'rule_id', 'reason', and 'length_of_time'.

3521 +<a id="__codelineno-0-145" name="__codelineno-0-145"></a>

3522 +<a id="__codelineno-0-146" name="__codelineno-0-146"></a> Returns:

3523 +<a id="__codelineno-0-147" name="__codelineno-0-147"></a> Dict[str, Union[str, bool]]: A dictionary indicating the success or failure of the operation.

3524 +<a id="__codelineno-0-148" name="__codelineno-0-148"></a> """

3525 +<a id="__codelineno-0-149" name="__codelineno-0-149"></a> try:

3526 +<a id="__codelineno-0-150" name="__codelineno-0-150"></a> self._validate_request(request)

3527 +<a id="__codelineno-0-151" name="__codelineno-0-151"></a> rule_id = request["rule_id"]

3528 +<a id="__codelineno-0-152" name="__codelineno-0-152"></a> filename = self._fetch_filename(rule_id)

3529 +<a id="__codelineno-0-153" name="__codelineno-0-153"></a> file_content = self._fetch_file_content(filename)

3530 +<a id="__codelineno-0-154" name="__codelineno-0-154"></a> previous_level, updated_file_content = self._set_level_1(

3531 +<a id="__codelineno-0-155" name="__codelineno-0-155"></a> file_content,

3532 +<a id="__codelineno-0-156" name="__codelineno-0-156"></a> rule_id,

3533 +<a id="__codelineno-0-157" name="__codelineno-0-157"></a> )

3534 +<a id="__codelineno-0-158" name="__codelineno-0-158"></a> xml_content = self._convert_to_xml(updated_file_content)

3535 +<a id="__codelineno-0-159" name="__codelineno-0-159"></a> self._store_disabled_rule_info(

3536 +<a id="__codelineno-0-160" name="__codelineno-0-160"></a> rule_id,

3537 +<a id="__codelineno-0-161" name="__codelineno-0-161"></a> previous_level,

3538 +<a id="__codelineno-0-162" name="__codelineno-0-162"></a> request["reason"],

3539 +<a id="__codelineno-0-163" name="__codelineno-0-163"></a> request["length_of_time"],

3540 +<a id="__codelineno-0-164" name="__codelineno-0-164"></a> )

3541 +<a id="__codelineno-0-165" name="__codelineno-0-165"></a> self._upload_updated_rule(filename, xml_content)

3542 +<a id="__codelineno-0-166" name="__codelineno-0-166"></a> UniversalService().restart_service()

3543 +<a id="__codelineno-0-167" name="__codelineno-0-167"></a> return {

3544 +<a id="__codelineno-0-168" name="__codelineno-0-168"></a> "message": f"Rule {rule_id} successfully disabled in file {filename}.",

3545 +<a id="__codelineno-0-169" name="__codelineno-0-169"></a> "success": True,

3546 +<a id="__codelineno-0-170" name="__codelineno-0-170"></a> }

3547 +<a id="__codelineno-0-171" name="__codelineno-0-171"></a>

3548 +<a id="__codelineno-0-172" name="__codelineno-0-172"></a> except Exception as e:

3549 +<a id="__codelineno-0-173" name="__codelineno-0-173"></a> logger.error(str(e))

3550 +<a id="__codelineno-0-174" name="__codelineno-0-174"></a> return {"message": str(e), "success": False}

3551 +<a id="__codelineno-0-175" name="__codelineno-0-175"></a>

3552 +<a id="__codelineno-0-176" name="__codelineno-0-176"></a> def _validate_request(self, request: Dict[str, Union[str, int]]) -> None:

3553 +<a id="__codelineno-0-177" name="__codelineno-0-177"></a> """

3554 +<a id="__codelineno-0-178" name="__codelineno-0-178"></a> Validate the request to disable a rule.

3555 +<a id="__codelineno-0-179" name="__codelineno-0-179"></a>

3556 +<a id="__codelineno-0-180" name="__codelineno-0-180"></a> Args:

3557 +<a id="__codelineno-0-181" name="__codelineno-0-181"></a> request (Dict[str, Union[str, int]]): The request to disable a rule.

3558 +<a id="__codelineno-0-182" name="__codelineno-0-182"></a>

3559 +<a id="__codelineno-0-183" name="__codelineno-0-183"></a> Raises:

3560 +<a id="__codelineno-0-184" name="__codelineno-0-184"></a> ValueError: If any of the required fields ('rule_id', 'reason', 'length_of_time') are missing in the request.

3561 +<a id="__codelineno-0-185" name="__codelineno-0-185"></a> """

3562 +<a id="__codelineno-0-186" name="__codelineno-0-186"></a> logger.info(f"Validating disable rule request: {request}")

3563 +<a id="__codelineno-0-187" name="__codelineno-0-187"></a> if "rule_id" not in request:

3564 +<a id="__codelineno-0-188" name="__codelineno-0-188"></a> raise ValueError("Request missing rule_id")

3565 +<a id="__codelineno-0-189" name="__codelineno-0-189"></a> if "reason" not in request:

3566 +<a id="__codelineno-0-190" name="__codelineno-0-190"></a> raise ValueError("Request missing reason")

3567 +<a id="__codelineno-0-191" name="__codelineno-0-191"></a> if "length_of_time" not in request:

3568 +<a id="__codelineno-0-192" name="__codelineno-0-192"></a> raise ValueError("Request missing length_of_time")

3569 +<a id="__codelineno-0-193" name="__codelineno-0-193"></a> request["length_of_time"] = int(request["length_of_time"])

3570 +<a id="__codelineno-0-194" name="__codelineno-0-194"></a>

3571 +<a id="__codelineno-0-195" name="__codelineno-0-195"></a> def _fetch_filename(self, rule_id: str) -> str:

3572 +<a id="__codelineno-0-196" name="__codelineno-0-196"></a> """

3573 +<a id="__codelineno-0-197" name="__codelineno-0-197"></a> Fetch the filename from the Wazuh-Manager that contains the rule to be disabled.

3574 +<a id="__codelineno-0-198" name="__codelineno-0-198"></a>

3575 +<a id="__codelineno-0-199" name="__codelineno-0-199"></a> Args:

3576 +<a id="__codelineno-0-200" name="__codelineno-0-200"></a> rule_id (str): The id of the rule to be disabled.

3577 +<a id="__codelineno-0-201" name="__codelineno-0-201"></a>

3578 +<a id="__codelineno-0-202" name="__codelineno-0-202"></a> Returns:

3579 +<a id="__codelineno-0-203" name="__codelineno-0-203"></a> str: The filename that contains the rule.

3580 +<a id="__codelineno-0-204" name="__codelineno-0-204"></a>

3581 +<a id="__codelineno-0-205" name="__codelineno-0-205"></a> Raises:

3582 +<a id="__codelineno-0-206" name="__codelineno-0-206"></a> ValueError: If the filename could not be fetched successfully.

3583 +<a id="__codelineno-0-207" name="__codelineno-0-207"></a> """

3584 +<a id="__codelineno-0-208" name="__codelineno-0-208"></a> filename_data = self.wazuh_http_requests.get_request(

3585 +<a id="__codelineno-0-209" name="__codelineno-0-209"></a> "rules",

3586 +<a id="__codelineno-0-210" name="__codelineno-0-210"></a> {"rule_ids": rule_id},

3587 +<a id="__codelineno-0-211" name="__codelineno-0-211"></a> )

3588 +<a id="__codelineno-0-212" name="__codelineno-0-212"></a> if not filename_data["success"]:

3589 +<a id="__codelineno-0-213" name="__codelineno-0-213"></a> raise ValueError(filename_data["message"])

3590 +<a id="__codelineno-0-214" name="__codelineno-0-214"></a> return filename_data["data"]["data"]["affected_items"][0]["filename"]

3591 +<a id="__codelineno-0-215" name="__codelineno-0-215"></a>

3592 +<a id="__codelineno-0-216" name="__codelineno-0-216"></a> def _fetch_file_content(

3593 +<a id="__codelineno-0-217" name="__codelineno-0-217"></a> self,

3594 +<a id="__codelineno-0-218" name="__codelineno-0-218"></a> filename: str,

3595 +<a id="__codelineno-0-219" name="__codelineno-0-219"></a> ) -> Union[Dict[str, str], List[Dict[str, str]]]:

3596 +<a id="__codelineno-0-220" name="__codelineno-0-220"></a> """

3597 +<a id="__codelineno-0-221" name="__codelineno-0-221"></a> Fetch the content of the file that contains the rule to be disabled.

3598 +<a id="__codelineno-0-222" name="__codelineno-0-222"></a>

3599 +<a id="__codelineno-0-223" name="__codelineno-0-223"></a> Args:

3600 +<a id="__codelineno-0-224" name="__codelineno-0-224"></a> filename (str): The filename that contains the rule.

3601 +<a id="__codelineno-0-225" name="__codelineno-0-225"></a>

3602 +<a id="__codelineno-0-226" name="__codelineno-0-226"></a> Returns:

3603 +<a id="__codelineno-0-227" name="__codelineno-0-227"></a> Union[Dict[str, str], List[Dict[str, str]]]: The content of the file.

3604 +<a id="__codelineno-0-228" name="__codelineno-0-228"></a>

3605 +<a id="__codelineno-0-229" name="__codelineno-0-229"></a> Raises:

3606 +<a id="__codelineno-0-230" name="__codelineno-0-230"></a> ValueError: If the file content could not be fetched successfully.

3607 +<a id="__codelineno-0-231" name="__codelineno-0-231"></a> """

3608 +<a id="__codelineno-0-232" name="__codelineno-0-232"></a> file_content_data = self.wazuh_http_requests.get_request(

3609 +<a id="__codelineno-0-233" name="__codelineno-0-233"></a> f"rules/files/{filename}",

3610 +<a id="__codelineno-0-234" name="__codelineno-0-234"></a> )

3611 +<a id="__codelineno-0-235" name="__codelineno-0-235"></a> if not file_content_data["success"]:

3612 +<a id="__codelineno-0-236" name="__codelineno-0-236"></a> raise ValueError(file_content_data["message"])

3613 +<a id="__codelineno-0-237" name="__codelineno-0-237"></a> return file_content_data["data"]["data"]["affected_items"][0]["group"]

3614 +<a id="__codelineno-0-238" name="__codelineno-0-238"></a>

3615 +<a id="__codelineno-0-239" name="__codelineno-0-239"></a> def _set_level_1(

3616 +<a id="__codelineno-0-240" name="__codelineno-0-240"></a> self,

3617 +<a id="__codelineno-0-241" name="__codelineno-0-241"></a> file_content: Union[Dict[str, str], List[Dict[str, str]]],

3618 +<a id="__codelineno-0-242" name="__codelineno-0-242"></a> rule_id: str,

3619 +<a id="__codelineno-0-243" name="__codelineno-0-243"></a> ) -> Tuple[str, Union[Dict[str, str], List[Dict[str, str]]]]:

3620 +<a id="__codelineno-0-244" name="__codelineno-0-244"></a> """

3621 +<a id="__codelineno-0-245" name="__codelineno-0-245"></a> Set the level of the rule to 1.

3622 +<a id="__codelineno-0-246" name="__codelineno-0-246"></a>

3623 +<a id="__codelineno-0-247" name="__codelineno-0-247"></a> Args:

3624 +<a id="__codelineno-0-248" name="__codelineno-0-248"></a> file_content (Union[Dict[str, str], List[Dict[str, str]]]): The content of the file that contains the rule.

3625 +<a id="__codelineno-0-249" name="__codelineno-0-249"></a> rule_id (str): The id of the rule to be disabled.

3626 +<a id="__codelineno-0-250" name="__codelineno-0-250"></a>

3627 +<a id="__codelineno-0-251" name="__codelineno-0-251"></a> Returns:

3628 +<a id="__codelineno-0-252" name="__codelineno-0-252"></a> Tuple[str, Union[Dict[str, str], List[Dict[str, str]]]]: A tuple containing the previous level of the rule and the updated file content.

3629 +<a id="__codelineno-0-253" name="__codelineno-0-253"></a> """

3630 +<a id="__codelineno-0-254" name="__codelineno-0-254"></a> logger.info(

3631 +<a id="__codelineno-0-255" name="__codelineno-0-255"></a> f"Setting rule {rule_id} level to 1 for file_content: {file_content}",

3632 +<a id="__codelineno-0-256" name="__codelineno-0-256"></a> )

3633 +<a id="__codelineno-0-257" name="__codelineno-0-257"></a> previous_level = None

3634 +<a id="__codelineno-0-258" name="__codelineno-0-258"></a> if isinstance(file_content, dict):

3635 +<a id="__codelineno-0-259" name="__codelineno-0-259"></a> file_content = [file_content]

3636 +<a id="__codelineno-0-260" name="__codelineno-0-260"></a> for group_block in file_content:

3637 +<a id="__codelineno-0-261" name="__codelineno-0-261"></a> rule_block = group_block.get("rule", None)

3638 +<a id="__codelineno-0-262" name="__codelineno-0-262"></a> if not rule_block:

3639 +<a id="__codelineno-0-263" name="__codelineno-0-263"></a> continue

3640 +<a id="__codelineno-0-264" name="__codelineno-0-264"></a> if isinstance(rule_block, dict):

3641 +<a id="__codelineno-0-265" name="__codelineno-0-265"></a> rule_block = [rule_block]

3642 +<a id="__codelineno-0-266" name="__codelineno-0-266"></a> for rule in rule_block:

3643 +<a id="__codelineno-0-267" name="__codelineno-0-267"></a> if rule["@id"] == rule_id:

3644 +<a id="__codelineno-0-268" name="__codelineno-0-268"></a> previous_level = rule["@level"]

3645 +<a id="__codelineno-0-269" name="__codelineno-0-269"></a> rule["@level"] = "1"

3646 +<a id="__codelineno-0-270" name="__codelineno-0-270"></a> break

3647 +<a id="__codelineno-0-271" name="__codelineno-0-271"></a> return previous_level, file_content

3648 +<a id="__codelineno-0-272" name="__codelineno-0-272"></a>

3649 +<a id="__codelineno-0-273" name="__codelineno-0-273"></a> def _convert_to_xml(

3650 +<a id="__codelineno-0-274" name="__codelineno-0-274"></a> self,

3651 +<a id="__codelineno-0-275" name="__codelineno-0-275"></a> updated_file_content: Union[Dict[str, str], List[Dict[str, str]]],

3652 +<a id="__codelineno-0-276" name="__codelineno-0-276"></a> ) -> str:

3653 +<a id="__codelineno-0-277" name="__codelineno-0-277"></a> """

3654 +<a id="__codelineno-0-278" name="__codelineno-0-278"></a> Convert the updated file content to XML format.

3655 +<a id="__codelineno-0-279" name="__codelineno-0-279"></a>

3656 +<a id="__codelineno-0-280" name="__codelineno-0-280"></a> Args:

3657 +<a id="__codelineno-0-281" name="__codelineno-0-281"></a> updated_file_content (Union[Dict[str, str], List[Dict[str, str]]]): The updated file content.

3658 +<a id="__codelineno-0-282" name="__codelineno-0-282"></a>

3659 +<a id="__codelineno-0-283" name="__codelineno-0-283"></a> Returns:

3660 +<a id="__codelineno-0-284" name="__codelineno-0-284"></a> str: The updated file content in XML format.

3661 +<a id="__codelineno-0-285" name="__codelineno-0-285"></a> """

3662 +<a id="__codelineno-0-286" name="__codelineno-0-286"></a> logger.info(f"Received updated_file_content: {updated_file_content}")

3663 +<a id="__codelineno-0-287" name="__codelineno-0-287"></a> xml_content_list = []

3664 +<a id="__codelineno-0-288" name="__codelineno-0-288"></a> for group in updated_file_content:

3665 +<a id="__codelineno-0-289" name="__codelineno-0-289"></a> xml_dict = {"group": group}

3666 +<a id="__codelineno-0-290" name="__codelineno-0-290"></a> xml_content = xmltodict.unparse(xml_dict, pretty=True)

3667 +<a id="__codelineno-0-291" name="__codelineno-0-291"></a> xml_content = xml_content.replace(

3668 +<a id="__codelineno-0-292" name="__codelineno-0-292"></a> '<?xml version="1.0" encoding="utf-8"?>',

3669 +<a id="__codelineno-0-293" name="__codelineno-0-293"></a> "",

3670 +<a id="__codelineno-0-294" name="__codelineno-0-294"></a> )

3671 +<a id="__codelineno-0-295" name="__codelineno-0-295"></a> xml_content_list.append(xml_content)

3672 +<a id="__codelineno-0-296" name="__codelineno-0-296"></a> xml_content = "\n".join(xml_content_list)

3673 +<a id="__codelineno-0-297" name="__codelineno-0-297"></a> xml_content = xml_content.strip()

3674 +<a id="__codelineno-0-298" name="__codelineno-0-298"></a> return xml_content

3675 +<a id="__codelineno-0-299" name="__codelineno-0-299"></a>

3676 +<a id="__codelineno-0-300" name="__codelineno-0-300"></a> def _store_disabled_rule_info(

3677 +<a id="__codelineno-0-301" name="__codelineno-0-301"></a> self,

3678 +<a id="__codelineno-0-302" name="__codelineno-0-302"></a> rule_id: str,

3679 +<a id="__codelineno-0-303" name="__codelineno-0-303"></a> previous_level: str,

3680 +<a id="__codelineno-0-304" name="__codelineno-0-304"></a> reason: str,

3681 +<a id="__codelineno-0-305" name="__codelineno-0-305"></a> length_of_time: str,

3682 +<a id="__codelineno-0-306" name="__codelineno-0-306"></a> ) -> None:

3683 +<a id="__codelineno-0-307" name="__codelineno-0-307"></a> """

3684 +<a id="__codelineno-0-308" name="__codelineno-0-308"></a> Store information about the disabled rule in the database.

3685 +<a id="__codelineno-0-309" name="__codelineno-0-309"></a>

3686 +<a id="__codelineno-0-310" name="__codelineno-0-310"></a> Args:

3687 +<a id="__codelineno-0-311" name="__codelineno-0-311"></a> rule_id (str): The id of the rule.

3688 +<a id="__codelineno-0-312" name="__codelineno-0-312"></a> previous_level (str): The previous level of the rule before it was disabled.

3689 +<a id="__codelineno-0-313" name="__codelineno-0-313"></a> reason (str): The reason for disabling the rule.

3690 +<a id="__codelineno-0-314" name="__codelineno-0-314"></a> length_of_time (str): The length of time for which the rule will be disabled.

3691 +<a id="__codelineno-0-315" name="__codelineno-0-315"></a> """

3692 +<a id="__codelineno-0-316" name="__codelineno-0-316"></a> disabled_rule = DisabledRules(

3693 +<a id="__codelineno-0-317" name="__codelineno-0-317"></a> rule_id=rule_id,

3694 +<a id="__codelineno-0-318" name="__codelineno-0-318"></a> previous_level=previous_level,

3695 +<a id="__codelineno-0-319" name="__codelineno-0-319"></a> new_level="1",

3696 +<a id="__codelineno-0-320" name="__codelineno-0-320"></a> reason_for_disabling=reason,

3697 +<a id="__codelineno-0-321" name="__codelineno-0-321"></a> length_of_time=length_of_time,

3698 +<a id="__codelineno-0-322" name="__codelineno-0-322"></a> )

3699 +<a id="__codelineno-0-323" name="__codelineno-0-323"></a> db.session.add(disabled_rule)

3700 +<a id="__codelineno-0-324" name="__codelineno-0-324"></a> db.session.commit()

3701 +<a id="__codelineno-0-325" name="__codelineno-0-325"></a>

3702 +<a id="__codelineno-0-326" name="__codelineno-0-326"></a> def _upload_updated_rule(self, filename: str, xml_content: str):

3703 +<a id="__codelineno-0-327" name="__codelineno-0-327"></a> """

3704 +<a id="__codelineno-0-328" name="__codelineno-0-328"></a> Upload the updated rule to the Wazuh Manager.

3705 +<a id="__codelineno-0-329" name="__codelineno-0-329"></a>

3706 +<a id="__codelineno-0-330" name="__codelineno-0-330"></a> Args:

3707 +<a id="__codelineno-0-331" name="__codelineno-0-331"></a> filename (str): The filename that contains the rule.

3708 +<a id="__codelineno-0-332" name="__codelineno-0-332"></a> xml_content (str): The updated rule in XML format.

3709 +<a id="__codelineno-0-333" name="__codelineno-0-333"></a>

3710 +<a id="__codelineno-0-334" name="__codelineno-0-334"></a> Raises:

3711 +<a id="__codelineno-0-335" name="__codelineno-0-335"></a> ValueError: If the updated rule could not be uploaded successfully.

3712 +<a id="__codelineno-0-336" name="__codelineno-0-336"></a> """

3713 +<a id="__codelineno-0-337" name="__codelineno-0-337"></a> response = self.wazuh_http_requests.put_request(

3714 +<a id="__codelineno-0-338" name="__codelineno-0-338"></a> f"rules/files/{filename}",

3715 +<a id="__codelineno-0-339" name="__codelineno-0-339"></a> xml_content,

3716 +<a id="__codelineno-0-340" name="__codelineno-0-340"></a> {"overwrite": "true"},

3717 +<a id="__codelineno-0-341" name="__codelineno-0-341"></a> )

3718 +<a id="__codelineno-0-342" name="__codelineno-0-342"></a> if not response["success"]:

3719 +<a id="__codelineno-0-343" name="__codelineno-0-343"></a> raise ValueError(response["message"])

3720 +</code></pre></div></td></tr></table></div>

3721 + </details>

3722 +

3723 +

3724 +

3725 + <div class="doc doc-children">

3726 +

3727 +

3728 +

3729 +

3730 +

3731 +

3732 +

3733 +

3734 +

3735 +<div class="doc doc-object doc-function">

3736 +

3737 +

3738 +

3739 +<h3 id="app.services.WazuhManager.disabled_rule.DisableRuleService.__init__" class="doc doc-heading">

3740 +<code class="highlight language-python">__init__(universal_service)</code>

3741 +

3742 +</h3>

3743 +

3744 +

3745 + <div class="doc doc-contents ">

3746 +

3747 + Initialize a DisableRuleService instance.

3748 +

3749 + Parameters:

3750 + <table>

3751 + <thead>

3752 + <tr>

3753 + <th>Name</th>

3754 + <th>Type</th>

3755 + <th>Description</th>

3756 + <th>Default</th>

3757 + </tr>

3758 + </thead>

3759 + <tbody>

3760 + <tr>

3761 + <td><code>universal_service</code></td>

3762 + <td>

3763 + <code><a class="autorefs autorefs-internal" title="app.services.WazuhManager.universal.UniversalService" href="#app.services.WazuhManager.universal.UniversalService">UniversalService</a></code>

3764 + </td>

3765 + <td>

3766 + <div class="doc-md-description">

3767 + The UniversalService instance to use.

3768 + </div>

3769 + </td>

3770 + <td>

3771 + required

3772 + </td>

3773 + </tr>

3774 + </tbody>

3775 + </table>

3776 +

3777 + <details class="quote">

3778 + <summary>Source code in <code>app\services\WazuhManager\disabled_rule.py</code></summary>

3779 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-122">122</a>

3780 +<a href="#__codelineno-0-123">123</a>

3781 +<a href="#__codelineno-0-124">124</a>

3782 +<a href="#__codelineno-0-125">125</a>

3783 +<a href="#__codelineno-0-126">126</a>

3784 +<a href="#__codelineno-0-127">127</a>

3785 +<a href="#__codelineno-0-128">128</a>

3786 +<a href="#__codelineno-0-129">129</a>

3787 +<a href="#__codelineno-0-130">130</a>

3788 +<a href="#__codelineno-0-131">131</a>

3789 +<a href="#__codelineno-0-132">132</a>

3790 +<a href="#__codelineno-0-133">133</a>

3791 +<a href="#__codelineno-0-134">134</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-122" name="__codelineno-0-122"></a>def __init__(self, universal_service: UniversalService) -> None:

3792 +<a id="__codelineno-0-123" name="__codelineno-0-123"></a> """

3793 +<a id="__codelineno-0-124" name="__codelineno-0-124"></a> Initialize a DisableRuleService instance.

3794 +<a id="__codelineno-0-125" name="__codelineno-0-125"></a>

3795 +<a id="__codelineno-0-126" name="__codelineno-0-126"></a> Args:

3796 +<a id="__codelineno-0-127" name="__codelineno-0-127"></a> universal_service (UniversalService): The UniversalService instance to use.

3797 +<a id="__codelineno-0-128" name="__codelineno-0-128"></a> """

3798 +<a id="__codelineno-0-129" name="__codelineno-0-129"></a> self.universal_service = universal_service

3799 +<a id="__codelineno-0-130" name="__codelineno-0-130"></a> self.auth_token = universal_service.get_auth_token()

3800 +<a id="__codelineno-0-131" name="__codelineno-0-131"></a> self.wazuh_http_requests = WazuhHttpRequests(

3801 +<a id="__codelineno-0-132" name="__codelineno-0-132"></a> self.universal_service.connector_url,

3802 +<a id="__codelineno-0-133" name="__codelineno-0-133"></a> self.auth_token,

3803 +<a id="__codelineno-0-134" name="__codelineno-0-134"></a> )

3804 +</code></pre></div></td></tr></table></div>

3805 + </details>

3806 + </div>

3807 +

3808 +</div>

3809 +

3810 +<div class="doc doc-object doc-function">

3811 +

3812 +

3813 +

3814 +<h3 id="app.services.WazuhManager.disabled_rule.DisableRuleService.disable_rule" class="doc doc-heading">

3815 +<code class="highlight language-python">disable_rule(request)</code>

3816 +

3817 +</h3>

3818 +

3819 +

3820 + <div class="doc doc-contents ">

3821 +

3822 + Disable a rule in Wazuh Manager.

3823 +

3824 + Parameters:

3825 + <table>

3826 + <thead>

3827 + <tr>

3828 + <th>Name</th>

3829 + <th>Type</th>

3830 + <th>Description</th>

3831 + <th>Default</th>

3832 + </tr>

3833 + </thead>

3834 + <tbody>

3835 + <tr>

3836 + <td><code>request</code></td>

3837 + <td>

3838 + <code>Dict[str, Union[str, int]]</code>

3839 + </td>

3840 + <td>

3841 + <div class="doc-md-description">

3842 + The request to disable a rule. It should contain 'rule_id', 'reason', and 'length_of_time'.

3843 + </div>

3844 + </td>

3845 + <td>

3846 + required

3847 + </td>

3848 + </tr>

3849 + </tbody>

3850 + </table>

3851 +

3852 + Returns:

3853 + <table>

3854 + <thead>

3855 + <tr>

3856 + <th>Type</th>

3857 + <th>Description</th>

3858 + </tr>

3859 + </thead>

3860 + <tbody>

3861 + <tr>

3862 + <td>

3863 + <code>Dict[str, Union[str, bool]]</code>

3864 + </td>

3865 + <td>

3866 + <div class="doc-md-description">

3867 + Dict[str, Union[str, bool]]: A dictionary indicating the success or failure of the operation.

3868 + </div>

3869 + </td>

3870 + </tr>

3871 + </tbody>

3872 + </table>

3873 +

3874 + <details class="quote">

3875 + <summary>Source code in <code>app\services\WazuhManager\disabled_rule.py</code></summary>

3876 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-136">136</a>

3877 +<a href="#__codelineno-0-137">137</a>

3878 +<a href="#__codelineno-0-138">138</a>

3879 +<a href="#__codelineno-0-139">139</a>

3880 +<a href="#__codelineno-0-140">140</a>

3881 +<a href="#__codelineno-0-141">141</a>

3882 +<a href="#__codelineno-0-142">142</a>

3883 +<a href="#__codelineno-0-143">143</a>

3884 +<a href="#__codelineno-0-144">144</a>

3885 +<a href="#__codelineno-0-145">145</a>

3886 +<a href="#__codelineno-0-146">146</a>

3887 +<a href="#__codelineno-0-147">147</a>

3888 +<a href="#__codelineno-0-148">148</a>

3889 +<a href="#__codelineno-0-149">149</a>

3890 +<a href="#__codelineno-0-150">150</a>

3891 +<a href="#__codelineno-0-151">151</a>

3892 +<a href="#__codelineno-0-152">152</a>

3893 +<a href="#__codelineno-0-153">153</a>

3894 +<a href="#__codelineno-0-154">154</a>

3895 +<a href="#__codelineno-0-155">155</a>

3896 +<a href="#__codelineno-0-156">156</a>

3897 +<a href="#__codelineno-0-157">157</a>

3898 +<a href="#__codelineno-0-158">158</a>

3899 +<a href="#__codelineno-0-159">159</a>

3900 +<a href="#__codelineno-0-160">160</a>

3901 +<a href="#__codelineno-0-161">161</a>

3902 +<a href="#__codelineno-0-162">162</a>

3903 +<a href="#__codelineno-0-163">163</a>

3904 +<a href="#__codelineno-0-164">164</a>

3905 +<a href="#__codelineno-0-165">165</a>

3906 +<a href="#__codelineno-0-166">166</a>

3907 +<a href="#__codelineno-0-167">167</a>

3908 +<a href="#__codelineno-0-168">168</a>

3909 +<a href="#__codelineno-0-169">169</a>

3910 +<a href="#__codelineno-0-170">170</a>

3911 +<a href="#__codelineno-0-171">171</a>

3912 +<a href="#__codelineno-0-172">172</a>

3913 +<a href="#__codelineno-0-173">173</a>

3914 +<a href="#__codelineno-0-174">174</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-136" name="__codelineno-0-136"></a>def disable_rule(

3915 +<a id="__codelineno-0-137" name="__codelineno-0-137"></a> self,

3916 +<a id="__codelineno-0-138" name="__codelineno-0-138"></a> request: Dict[str, Union[str, int]],

3917 +<a id="__codelineno-0-139" name="__codelineno-0-139"></a>) -> Dict[str, Union[str, bool]]:

3918 +<a id="__codelineno-0-140" name="__codelineno-0-140"></a> """

3919 +<a id="__codelineno-0-141" name="__codelineno-0-141"></a> Disable a rule in Wazuh Manager.

3920 +<a id="__codelineno-0-142" name="__codelineno-0-142"></a>

3921 +<a id="__codelineno-0-143" name="__codelineno-0-143"></a> Args:

3922 +<a id="__codelineno-0-144" name="__codelineno-0-144"></a> request (Dict[str, Union[str, int]]): The request to disable a rule. It should contain 'rule_id', 'reason', and 'length_of_time'.

3923 +<a id="__codelineno-0-145" name="__codelineno-0-145"></a>

3924 +<a id="__codelineno-0-146" name="__codelineno-0-146"></a> Returns:

3925 +<a id="__codelineno-0-147" name="__codelineno-0-147"></a> Dict[str, Union[str, bool]]: A dictionary indicating the success or failure of the operation.

3926 +<a id="__codelineno-0-148" name="__codelineno-0-148"></a> """

3927 +<a id="__codelineno-0-149" name="__codelineno-0-149"></a> try:

3928 +<a id="__codelineno-0-150" name="__codelineno-0-150"></a> self._validate_request(request)

3929 +<a id="__codelineno-0-151" name="__codelineno-0-151"></a> rule_id = request["rule_id"]

3930 +<a id="__codelineno-0-152" name="__codelineno-0-152"></a> filename = self._fetch_filename(rule_id)

3931 +<a id="__codelineno-0-153" name="__codelineno-0-153"></a> file_content = self._fetch_file_content(filename)

3932 +<a id="__codelineno-0-154" name="__codelineno-0-154"></a> previous_level, updated_file_content = self._set_level_1(

3933 +<a id="__codelineno-0-155" name="__codelineno-0-155"></a> file_content,

3934 +<a id="__codelineno-0-156" name="__codelineno-0-156"></a> rule_id,

3935 +<a id="__codelineno-0-157" name="__codelineno-0-157"></a> )

3936 +<a id="__codelineno-0-158" name="__codelineno-0-158"></a> xml_content = self._convert_to_xml(updated_file_content)

3937 +<a id="__codelineno-0-159" name="__codelineno-0-159"></a> self._store_disabled_rule_info(

3938 +<a id="__codelineno-0-160" name="__codelineno-0-160"></a> rule_id,

3939 +<a id="__codelineno-0-161" name="__codelineno-0-161"></a> previous_level,

3940 +<a id="__codelineno-0-162" name="__codelineno-0-162"></a> request["reason"],

3941 +<a id="__codelineno-0-163" name="__codelineno-0-163"></a> request["length_of_time"],

3942 +<a id="__codelineno-0-164" name="__codelineno-0-164"></a> )

3943 +<a id="__codelineno-0-165" name="__codelineno-0-165"></a> self._upload_updated_rule(filename, xml_content)

3944 +<a id="__codelineno-0-166" name="__codelineno-0-166"></a> UniversalService().restart_service()

3945 +<a id="__codelineno-0-167" name="__codelineno-0-167"></a> return {

3946 +<a id="__codelineno-0-168" name="__codelineno-0-168"></a> "message": f"Rule {rule_id} successfully disabled in file {filename}.",

3947 +<a id="__codelineno-0-169" name="__codelineno-0-169"></a> "success": True,

3948 +<a id="__codelineno-0-170" name="__codelineno-0-170"></a> }

3949 +<a id="__codelineno-0-171" name="__codelineno-0-171"></a>

3950 +<a id="__codelineno-0-172" name="__codelineno-0-172"></a> except Exception as e:

3951 +<a id="__codelineno-0-173" name="__codelineno-0-173"></a> logger.error(str(e))

3952 +<a id="__codelineno-0-174" name="__codelineno-0-174"></a> return {"message": str(e), "success": False}

3953 +</code></pre></div></td></tr></table></div>

3954 + </details>

3955 + </div>

3956 +

3957 +</div>

3958 +

3959 +

3960 +

3961 + </div>

3962 +

3963 + </div>

3964 +

3965 +</div>

3966 +

3967 +<div class="doc doc-object doc-class">

3968 +

3969 +

3970 +

3971 +<h2 id="app.services.WazuhManager.disabled_rule.WazuhHttpRequests" class="doc doc-heading">

3972 + <code>WazuhHttpRequests</code>

3973 +

3974 +

3975 +</h2>

3976 +

3977 +

3978 + <div class="doc doc-contents ">

3979 +

3980 +

3981 + This class helps to send HTTP requests to the Wazuh API.

3982 +

3983 + Attributes:

3984 + <table>

3985 + <thead>

3986 + <tr>

3987 + <th>Name</th>

3988 + <th>Type</th>

3989 + <th>Description</th>

3990 + </tr>

3991 + </thead>

3992 + <tbody>

3993 + <tr>

3994 + <td><code>connector_url</code></td>

3995 + <td>

3996 + <code>str</code>

3997 + </td>

3998 + <td>

3999 + <div class="doc-md-description">

4000 + The URL of the Wazuh Manager.

4001 + </div>

4002 + </td>

4003 + </tr>

4004 + <tr>

4005 + <td><code>wazuh_auth_token</code></td>

4006 + <td>

4007 + <code>str</code>

4008 + </td>

4009 + <td>

4010 + <div class="doc-md-description">

4011 + The Wazuh API authentication token.

4012 + </div>

4013 + </td>

4014 + </tr>

4015 + <tr>

4016 + <td><code>headers</code></td>

4017 + <td>

4018 + <code>Dict[str, str]</code>

4019 + </td>

4020 + <td>

4021 + <div class="doc-md-description">

4022 + The headers for HTTP requests.

4023 + </div>

4024 + </td>

4025 + </tr>

4026 + </tbody>

4027 + </table>

4028 +

4029 +

4030 + <details class="quote">

4031 + <summary>Source code in <code>app\services\WazuhManager\disabled_rule.py</code></summary>

4032 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-22"> 22</a>

4033 +<a href="#__codelineno-0-23"> 23</a>

4034 +<a href="#__codelineno-0-24"> 24</a>

4035 +<a href="#__codelineno-0-25"> 25</a>

4036 +<a href="#__codelineno-0-26"> 26</a>

4037 +<a href="#__codelineno-0-27"> 27</a>

4038 +<a href="#__codelineno-0-28"> 28</a>

4039 +<a href="#__codelineno-0-29"> 29</a>

4040 +<a href="#__codelineno-0-30"> 30</a>

4041 +<a href="#__codelineno-0-31"> 31</a>

4042 +<a href="#__codelineno-0-32"> 32</a>

4043 +<a href="#__codelineno-0-33"> 33</a>

4044 +<a href="#__codelineno-0-34"> 34</a>

4045 +<a href="#__codelineno-0-35"> 35</a>

4046 +<a href="#__codelineno-0-36"> 36</a>

4047 +<a href="#__codelineno-0-37"> 37</a>

4048 +<a href="#__codelineno-0-38"> 38</a>

4049 +<a href="#__codelineno-0-39"> 39</a>

4050 +<a href="#__codelineno-0-40"> 40</a>

4051 +<a href="#__codelineno-0-41"> 41</a>

4052 +<a href="#__codelineno-0-42"> 42</a>

4053 +<a href="#__codelineno-0-43"> 43</a>

4054 +<a href="#__codelineno-0-44"> 44</a>

4055 +<a href="#__codelineno-0-45"> 45</a>

4056 +<a href="#__codelineno-0-46"> 46</a>

4057 +<a href="#__codelineno-0-47"> 47</a>

4058 +<a href="#__codelineno-0-48"> 48</a>

4059 +<a href="#__codelineno-0-49"> 49</a>

4060 +<a href="#__codelineno-0-50"> 50</a>

4061 +<a href="#__codelineno-0-51"> 51</a>

4062 +<a href="#__codelineno-0-52"> 52</a>

4063 +<a href="#__codelineno-0-53"> 53</a>

4064 +<a href="#__codelineno-0-54"> 54</a>

4065 +<a href="#__codelineno-0-55"> 55</a>

4066 +<a href="#__codelineno-0-56"> 56</a>

4067 +<a href="#__codelineno-0-57"> 57</a>

4068 +<a href="#__codelineno-0-58"> 58</a>

4069 +<a href="#__codelineno-0-59"> 59</a>

4070 +<a href="#__codelineno-0-60"> 60</a>

4071 +<a href="#__codelineno-0-61"> 61</a>

4072 +<a href="#__codelineno-0-62"> 62</a>

4073 +<a href="#__codelineno-0-63"> 63</a>

4074 +<a href="#__codelineno-0-64"> 64</a>

4075 +<a href="#__codelineno-0-65"> 65</a>

4076 +<a href="#__codelineno-0-66"> 66</a>

4077 +<a href="#__codelineno-0-67"> 67</a>

4078 +<a href="#__codelineno-0-68"> 68</a>

4079 +<a href="#__codelineno-0-69"> 69</a>

4080 +<a href="#__codelineno-0-70"> 70</a>

4081 +<a href="#__codelineno-0-71"> 71</a>

4082 +<a href="#__codelineno-0-72"> 72</a>

4083 +<a href="#__codelineno-0-73"> 73</a>

4084 +<a href="#__codelineno-0-74"> 74</a>

4085 +<a href="#__codelineno-0-75"> 75</a>

4086 +<a href="#__codelineno-0-76"> 76</a>

4087 +<a href="#__codelineno-0-77"> 77</a>

4088 +<a href="#__codelineno-0-78"> 78</a>

4089 +<a href="#__codelineno-0-79"> 79</a>

4090 +<a href="#__codelineno-0-80"> 80</a>

4091 +<a href="#__codelineno-0-81"> 81</a>

4092 +<a href="#__codelineno-0-82"> 82</a>

4093 +<a href="#__codelineno-0-83"> 83</a>

4094 +<a href="#__codelineno-0-84"> 84</a>

4095 +<a href="#__codelineno-0-85"> 85</a>

4096 +<a href="#__codelineno-0-86"> 86</a>

4097 +<a href="#__codelineno-0-87"> 87</a>

4098 +<a href="#__codelineno-0-88"> 88</a>

4099 +<a href="#__codelineno-0-89"> 89</a>

4100 +<a href="#__codelineno-0-90"> 90</a>

4101 +<a href="#__codelineno-0-91"> 91</a>

4102 +<a href="#__codelineno-0-92"> 92</a>

4103 +<a href="#__codelineno-0-93"> 93</a>

4104 +<a href="#__codelineno-0-94"> 94</a>

4105 +<a href="#__codelineno-0-95"> 95</a>

4106 +<a href="#__codelineno-0-96"> 96</a>

4107 +<a href="#__codelineno-0-97"> 97</a>

4108 +<a href="#__codelineno-0-98"> 98</a>

4109 +<a href="#__codelineno-0-99"> 99</a>

4110 +<a href="#__codelineno-0-100">100</a>

4111 +<a href="#__codelineno-0-101">101</a>

4112 +<a href="#__codelineno-0-102">102</a>

4113 +<a href="#__codelineno-0-103">103</a>

4114 +<a href="#__codelineno-0-104">104</a>

4115 +<a href="#__codelineno-0-105">105</a>

4116 +<a href="#__codelineno-0-106">106</a>

4117 +<a href="#__codelineno-0-107">107</a>

4118 +<a href="#__codelineno-0-108">108</a>

4119 +<a href="#__codelineno-0-109">109</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-22" name="__codelineno-0-22"></a>class WazuhHttpRequests:

4120 +<a id="__codelineno-0-23" name="__codelineno-0-23"></a> """

4121 +<a id="__codelineno-0-24" name="__codelineno-0-24"></a> This class helps to send HTTP requests to the Wazuh API.

4122 +<a id="__codelineno-0-25" name="__codelineno-0-25"></a>

4123 +<a id="__codelineno-0-26" name="__codelineno-0-26"></a> Attributes:

4124 +<a id="__codelineno-0-27" name="__codelineno-0-27"></a> connector_url (str): The URL of the Wazuh Manager.

4125 +<a id="__codelineno-0-28" name="__codelineno-0-28"></a> wazuh_auth_token (str): The Wazuh API authentication token.

4126 +<a id="__codelineno-0-29" name="__codelineno-0-29"></a> headers (Dict[str, str]): The headers for HTTP requests.

4127 +<a id="__codelineno-0-30" name="__codelineno-0-30"></a> """

4128 +<a id="__codelineno-0-31" name="__codelineno-0-31"></a>

4129 +<a id="__codelineno-0-32" name="__codelineno-0-32"></a> def __init__(self, connector_url: str, wazuh_auth_token: str) -> None:

4130 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> """

4131 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> Initialize a WazuhHttpRequests instance.

4132 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a>

4133 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> Args:

4134 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> connector_url (str): The URL of the Wazuh Manager.

4135 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> wazuh_auth_token (str): The Wazuh API authentication token.

4136 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> """

4137 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> self.connector_url = connector_url

4138 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> self.wazuh_auth_token = wazuh_auth_token

4139 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> self.headers = {"Authorization": f"Bearer {wazuh_auth_token}"}

4140 +<a id="__codelineno-0-43" name="__codelineno-0-43"></a>

4141 +<a id="__codelineno-0-44" name="__codelineno-0-44"></a> def get_request(

4142 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> self,

4143 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> endpoint: str,

4144 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> params: Optional[Dict[str, str]] = None,

4145 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a> ) -> Dict[str, Union[str, bool]]:

4146 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> """

4147 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> Send a GET request to the specified endpoint.

4148 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a>

4149 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> Args:

4150 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> endpoint (str): The endpoint to send the GET request to.

4151 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> params (Optional[Dict[str, str]]): Additional parameters to include in the request.

4152 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a>

4153 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> Returns:

4154 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> Dict[str, Union[str, bool]]: The response from the endpoint. It contains the data from the response or an error message.

4155 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> """

4156 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> try:

4157 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> response = requests.get(

4158 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> f"{self.connector_url}/{endpoint}",

4159 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> headers=self.headers,

4160 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> params=params,

4161 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> verify=False,

4162 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> )

4163 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> response.raise_for_status()

4164 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> return {"data": response.json(), "success": True}

4165 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a>

4166 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> except Exception as e:

4167 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> logger.error(f"GET request to {endpoint} failed: {e}")

4168 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> return {

4169 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> "message": f"GET request to {endpoint} failed: {e}",

4170 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> "success": False,

4171 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> }

4172 +<a id="__codelineno-0-75" name="__codelineno-0-75"></a>

4173 +<a id="__codelineno-0-76" name="__codelineno-0-76"></a> def put_request(

4174 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> self,

4175 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> endpoint: str,

4176 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> data: str,

4177 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> params: Optional[Dict[str, str]] = None,

4178 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a> ) -> Dict[str, bool]:

4179 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> """

4180 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> Send a PUT request to the specified endpoint.

4181 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a>

4182 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> Args:

4183 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> endpoint (str): The endpoint to send the PUT request to.

4184 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> data (str): The data to be updated in the PUT request.

4185 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> params (Optional[Dict[str, str]]): Additional parameters to include in the request.

4186 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a>

4187 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> Returns:

4188 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> Dict[str, bool]: A dictionary indicating the success or failure of the operation.

4189 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> """

4190 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a> try:

4191 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> headers = self.headers.copy()

4192 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> headers.update({"Content-Type": "application/octet-stream"})

4193 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a>

4194 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> response = requests.put(

4195 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> f"{self.connector_url}/{endpoint}",

4196 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a> headers=headers,

4197 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> params=params,

4198 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> data=data,

4199 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> verify=False,

4200 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> )

4201 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a> response.raise_for_status()

4202 +<a id="__codelineno-0-105" name="__codelineno-0-105"></a> return {"message": f"Successfully updated {endpoint}", "success": True}

4203 +<a id="__codelineno-0-106" name="__codelineno-0-106"></a>

4204 +<a id="__codelineno-0-107" name="__codelineno-0-107"></a> except Exception as e:

4205 +<a id="__codelineno-0-108" name="__codelineno-0-108"></a> logger.error(f"Failed to update {endpoint}: {e}")

4206 +<a id="__codelineno-0-109" name="__codelineno-0-109"></a> return {"message": f"Failed to update {endpoint}: {e}", "success": False}

4207 +</code></pre></div></td></tr></table></div>

4208 + </details>

4209 +

4210 +

4211 +

4212 + <div class="doc doc-children">

4213 +

4214 +

4215 +

4216 +

4217 +

4218 +

4219 +

4220 +

4221 +

4222 +<div class="doc doc-object doc-function">

4223 +

4224 +

4225 +

4226 +<h3 id="app.services.WazuhManager.disabled_rule.WazuhHttpRequests.__init__" class="doc doc-heading">

4227 +<code class="highlight language-python">__init__(connector_url, wazuh_auth_token)</code>

4228 +

4229 +</h3>

4230 +

4231 +

4232 + <div class="doc doc-contents ">

4233 +

4234 + Initialize a WazuhHttpRequests instance.

4235 +

4236 + Parameters:

4237 + <table>

4238 + <thead>

4239 + <tr>

4240 + <th>Name</th>

4241 + <th>Type</th>

4242 + <th>Description</th>

4243 + <th>Default</th>

4244 + </tr>

4245 + </thead>

4246 + <tbody>

4247 + <tr>

4248 + <td><code>connector_url</code></td>

4249 + <td>

4250 + <code>str</code>

4251 + </td>

4252 + <td>

4253 + <div class="doc-md-description">

4254 + The URL of the Wazuh Manager.

4255 + </div>

4256 + </td>

4257 + <td>

4258 + required

4259 + </td>

4260 + </tr>

4261 + <tr>

4262 + <td><code>wazuh_auth_token</code></td>

4263 + <td>

4264 + <code>str</code>

4265 + </td>

4266 + <td>

4267 + <div class="doc-md-description">

4268 + The Wazuh API authentication token.

4269 + </div>

4270 + </td>

4271 + <td>

4272 + required

4273 + </td>

4274 + </tr>

4275 + </tbody>

4276 + </table>

4277 +

4278 + <details class="quote">

4279 + <summary>Source code in <code>app\services\WazuhManager\disabled_rule.py</code></summary>

4280 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-32">32</a>

4281 +<a href="#__codelineno-0-33">33</a>

4282 +<a href="#__codelineno-0-34">34</a>

4283 +<a href="#__codelineno-0-35">35</a>

4284 +<a href="#__codelineno-0-36">36</a>

4285 +<a href="#__codelineno-0-37">37</a>

4286 +<a href="#__codelineno-0-38">38</a>

4287 +<a href="#__codelineno-0-39">39</a>

4288 +<a href="#__codelineno-0-40">40</a>

4289 +<a href="#__codelineno-0-41">41</a>

4290 +<a href="#__codelineno-0-42">42</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-32" name="__codelineno-0-32"></a>def __init__(self, connector_url: str, wazuh_auth_token: str) -> None:

4291 +<a id="__codelineno-0-33" name="__codelineno-0-33"></a> """

4292 +<a id="__codelineno-0-34" name="__codelineno-0-34"></a> Initialize a WazuhHttpRequests instance.

4293 +<a id="__codelineno-0-35" name="__codelineno-0-35"></a>

4294 +<a id="__codelineno-0-36" name="__codelineno-0-36"></a> Args:

4295 +<a id="__codelineno-0-37" name="__codelineno-0-37"></a> connector_url (str): The URL of the Wazuh Manager.

4296 +<a id="__codelineno-0-38" name="__codelineno-0-38"></a> wazuh_auth_token (str): The Wazuh API authentication token.

4297 +<a id="__codelineno-0-39" name="__codelineno-0-39"></a> """

4298 +<a id="__codelineno-0-40" name="__codelineno-0-40"></a> self.connector_url = connector_url

4299 +<a id="__codelineno-0-41" name="__codelineno-0-41"></a> self.wazuh_auth_token = wazuh_auth_token

4300 +<a id="__codelineno-0-42" name="__codelineno-0-42"></a> self.headers = {"Authorization": f"Bearer {wazuh_auth_token}"}

4301 +</code></pre></div></td></tr></table></div>

4302 + </details>

4303 + </div>

4304 +

4305 +</div>

4306 +

4307 +<div class="doc doc-object doc-function">

4308 +

4309 +

4310 +

4311 +<h3 id="app.services.WazuhManager.disabled_rule.WazuhHttpRequests.get_request" class="doc doc-heading">

4312 +<code class="highlight language-python">get_request(endpoint, params=None)</code>

4313 +

4314 +</h3>

4315 +

4316 +

4317 + <div class="doc doc-contents ">

4318 +

4319 + Send a GET request to the specified endpoint.

4320 +

4321 + Parameters:

4322 + <table>

4323 + <thead>

4324 + <tr>

4325 + <th>Name</th>

4326 + <th>Type</th>

4327 + <th>Description</th>

4328 + <th>Default</th>

4329 + </tr>

4330 + </thead>

4331 + <tbody>

4332 + <tr>

4333 + <td><code>endpoint</code></td>

4334 + <td>

4335 + <code>str</code>

4336 + </td>

4337 + <td>

4338 + <div class="doc-md-description">

4339 + The endpoint to send the GET request to.

4340 + </div>

4341 + </td>

4342 + <td>

4343 + required

4344 + </td>

4345 + </tr>

4346 + <tr>

4347 + <td><code>params</code></td>

4348 + <td>

4349 + <code>Optional[Dict[str, str]]</code>

4350 + </td>

4351 + <td>

4352 + <div class="doc-md-description">

4353 + Additional parameters to include in the request.

4354 + </div>

4355 + </td>

4356 + <td>

4357 + <code>None</code>

4358 + </td>

4359 + </tr>

4360 + </tbody>

4361 + </table>

4362 +

4363 + Returns:

4364 + <table>

4365 + <thead>

4366 + <tr>

4367 + <th>Type</th>

4368 + <th>Description</th>

4369 + </tr>

4370 + </thead>

4371 + <tbody>

4372 + <tr>

4373 + <td>

4374 + <code>Dict[str, Union[str, bool]]</code>

4375 + </td>

4376 + <td>

4377 + <div class="doc-md-description">

4378 + Dict[str, Union[str, bool]]: The response from the endpoint. It contains the data from the response or an error message.

4379 + </div>

4380 + </td>

4381 + </tr>

4382 + </tbody>

4383 + </table>

4384 +

4385 + <details class="quote">

4386 + <summary>Source code in <code>app\services\WazuhManager\disabled_rule.py</code></summary>

4387 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-44">44</a>

4388 +<a href="#__codelineno-0-45">45</a>

4389 +<a href="#__codelineno-0-46">46</a>

4390 +<a href="#__codelineno-0-47">47</a>

4391 +<a href="#__codelineno-0-48">48</a>

4392 +<a href="#__codelineno-0-49">49</a>

4393 +<a href="#__codelineno-0-50">50</a>

4394 +<a href="#__codelineno-0-51">51</a>

4395 +<a href="#__codelineno-0-52">52</a>

4396 +<a href="#__codelineno-0-53">53</a>

4397 +<a href="#__codelineno-0-54">54</a>

4398 +<a href="#__codelineno-0-55">55</a>

4399 +<a href="#__codelineno-0-56">56</a>

4400 +<a href="#__codelineno-0-57">57</a>

4401 +<a href="#__codelineno-0-58">58</a>

4402 +<a href="#__codelineno-0-59">59</a>

4403 +<a href="#__codelineno-0-60">60</a>

4404 +<a href="#__codelineno-0-61">61</a>

4405 +<a href="#__codelineno-0-62">62</a>

4406 +<a href="#__codelineno-0-63">63</a>

4407 +<a href="#__codelineno-0-64">64</a>

4408 +<a href="#__codelineno-0-65">65</a>

4409 +<a href="#__codelineno-0-66">66</a>

4410 +<a href="#__codelineno-0-67">67</a>

4411 +<a href="#__codelineno-0-68">68</a>

4412 +<a href="#__codelineno-0-69">69</a>

4413 +<a href="#__codelineno-0-70">70</a>

4414 +<a href="#__codelineno-0-71">71</a>

4415 +<a href="#__codelineno-0-72">72</a>

4416 +<a href="#__codelineno-0-73">73</a>

4417 +<a href="#__codelineno-0-74">74</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-44" name="__codelineno-0-44"></a>def get_request(

4418 +<a id="__codelineno-0-45" name="__codelineno-0-45"></a> self,

4419 +<a id="__codelineno-0-46" name="__codelineno-0-46"></a> endpoint: str,

4420 +<a id="__codelineno-0-47" name="__codelineno-0-47"></a> params: Optional[Dict[str, str]] = None,

4421 +<a id="__codelineno-0-48" name="__codelineno-0-48"></a>) -> Dict[str, Union[str, bool]]:

4422 +<a id="__codelineno-0-49" name="__codelineno-0-49"></a> """

4423 +<a id="__codelineno-0-50" name="__codelineno-0-50"></a> Send a GET request to the specified endpoint.

4424 +<a id="__codelineno-0-51" name="__codelineno-0-51"></a>

4425 +<a id="__codelineno-0-52" name="__codelineno-0-52"></a> Args:

4426 +<a id="__codelineno-0-53" name="__codelineno-0-53"></a> endpoint (str): The endpoint to send the GET request to.

4427 +<a id="__codelineno-0-54" name="__codelineno-0-54"></a> params (Optional[Dict[str, str]]): Additional parameters to include in the request.

4428 +<a id="__codelineno-0-55" name="__codelineno-0-55"></a>

4429 +<a id="__codelineno-0-56" name="__codelineno-0-56"></a> Returns:

4430 +<a id="__codelineno-0-57" name="__codelineno-0-57"></a> Dict[str, Union[str, bool]]: The response from the endpoint. It contains the data from the response or an error message.

4431 +<a id="__codelineno-0-58" name="__codelineno-0-58"></a> """

4432 +<a id="__codelineno-0-59" name="__codelineno-0-59"></a> try:

4433 +<a id="__codelineno-0-60" name="__codelineno-0-60"></a> response = requests.get(

4434 +<a id="__codelineno-0-61" name="__codelineno-0-61"></a> f"{self.connector_url}/{endpoint}",

4435 +<a id="__codelineno-0-62" name="__codelineno-0-62"></a> headers=self.headers,

4436 +<a id="__codelineno-0-63" name="__codelineno-0-63"></a> params=params,

4437 +<a id="__codelineno-0-64" name="__codelineno-0-64"></a> verify=False,

4438 +<a id="__codelineno-0-65" name="__codelineno-0-65"></a> )

4439 +<a id="__codelineno-0-66" name="__codelineno-0-66"></a> response.raise_for_status()

4440 +<a id="__codelineno-0-67" name="__codelineno-0-67"></a> return {"data": response.json(), "success": True}

4441 +<a id="__codelineno-0-68" name="__codelineno-0-68"></a>

4442 +<a id="__codelineno-0-69" name="__codelineno-0-69"></a> except Exception as e:

4443 +<a id="__codelineno-0-70" name="__codelineno-0-70"></a> logger.error(f"GET request to {endpoint} failed: {e}")

4444 +<a id="__codelineno-0-71" name="__codelineno-0-71"></a> return {

4445 +<a id="__codelineno-0-72" name="__codelineno-0-72"></a> "message": f"GET request to {endpoint} failed: {e}",

4446 +<a id="__codelineno-0-73" name="__codelineno-0-73"></a> "success": False,

4447 +<a id="__codelineno-0-74" name="__codelineno-0-74"></a> }

4448 +</code></pre></div></td></tr></table></div>

4449 + </details>

4450 + </div>

4451 +

4452 +</div>

4453 +

4454 +<div class="doc doc-object doc-function">

4455 +

4456 +

4457 +

4458 +<h3 id="app.services.WazuhManager.disabled_rule.WazuhHttpRequests.put_request" class="doc doc-heading">

4459 +<code class="highlight language-python">put_request(endpoint, data, params=None)</code>

4460 +

4461 +</h3>

4462 +

4463 +

4464 + <div class="doc doc-contents ">

4465 +

4466 + Send a PUT request to the specified endpoint.

4467 +

4468 + Parameters:

4469 + <table>

4470 + <thead>

4471 + <tr>

4472 + <th>Name</th>

4473 + <th>Type</th>

4474 + <th>Description</th>

4475 + <th>Default</th>

4476 + </tr>

4477 + </thead>

4478 + <tbody>

4479 + <tr>

4480 + <td><code>endpoint</code></td>

4481 + <td>

4482 + <code>str</code>

4483 + </td>

4484 + <td>

4485 + <div class="doc-md-description">

4486 + The endpoint to send the PUT request to.

4487 + </div>

4488 + </td>

4489 + <td>

4490 + required

4491 + </td>

4492 + </tr>

4493 + <tr>

4494 + <td><code>data</code></td>

4495 + <td>

4496 + <code>str</code>

4497 + </td>

4498 + <td>

4499 + <div class="doc-md-description">

4500 + The data to be updated in the PUT request.

4501 + </div>

4502 + </td>

4503 + <td>

4504 + required

4505 + </td>

4506 + </tr>

4507 + <tr>

4508 + <td><code>params</code></td>

4509 + <td>

4510 + <code>Optional[Dict[str, str]]</code>

4511 + </td>

4512 + <td>

4513 + <div class="doc-md-description">

4514 + Additional parameters to include in the request.

4515 + </div>

4516 + </td>

4517 + <td>

4518 + <code>None</code>

4519 + </td>

4520 + </tr>

4521 + </tbody>

4522 + </table>

4523 +

4524 + Returns:

4525 + <table>

4526 + <thead>

4527 + <tr>

4528 + <th>Type</th>

4529 + <th>Description</th>

4530 + </tr>

4531 + </thead>

4532 + <tbody>

4533 + <tr>

4534 + <td>

4535 + <code>Dict[str, bool]</code>

4536 + </td>

4537 + <td>

4538 + <div class="doc-md-description">

4539 + Dict[str, bool]: A dictionary indicating the success or failure of the operation.

4540 + </div>

4541 + </td>

4542 + </tr>

4543 + </tbody>

4544 + </table>

4545 +

4546 + <details class="quote">

4547 + <summary>Source code in <code>app\services\WazuhManager\disabled_rule.py</code></summary>

4548 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-76"> 76</a>

4549 +<a href="#__codelineno-0-77"> 77</a>

4550 +<a href="#__codelineno-0-78"> 78</a>

4551 +<a href="#__codelineno-0-79"> 79</a>

4552 +<a href="#__codelineno-0-80"> 80</a>

4553 +<a href="#__codelineno-0-81"> 81</a>

4554 +<a href="#__codelineno-0-82"> 82</a>

4555 +<a href="#__codelineno-0-83"> 83</a>

4556 +<a href="#__codelineno-0-84"> 84</a>

4557 +<a href="#__codelineno-0-85"> 85</a>

4558 +<a href="#__codelineno-0-86"> 86</a>

4559 +<a href="#__codelineno-0-87"> 87</a>

4560 +<a href="#__codelineno-0-88"> 88</a>

4561 +<a href="#__codelineno-0-89"> 89</a>

4562 +<a href="#__codelineno-0-90"> 90</a>

4563 +<a href="#__codelineno-0-91"> 91</a>

4564 +<a href="#__codelineno-0-92"> 92</a>

4565 +<a href="#__codelineno-0-93"> 93</a>

4566 +<a href="#__codelineno-0-94"> 94</a>

4567 +<a href="#__codelineno-0-95"> 95</a>

4568 +<a href="#__codelineno-0-96"> 96</a>

4569 +<a href="#__codelineno-0-97"> 97</a>

4570 +<a href="#__codelineno-0-98"> 98</a>

4571 +<a href="#__codelineno-0-99"> 99</a>

4572 +<a href="#__codelineno-0-100">100</a>

4573 +<a href="#__codelineno-0-101">101</a>

4574 +<a href="#__codelineno-0-102">102</a>

4575 +<a href="#__codelineno-0-103">103</a>

4576 +<a href="#__codelineno-0-104">104</a>

4577 +<a href="#__codelineno-0-105">105</a>

4578 +<a href="#__codelineno-0-106">106</a>

4579 +<a href="#__codelineno-0-107">107</a>

4580 +<a href="#__codelineno-0-108">108</a>

4581 +<a href="#__codelineno-0-109">109</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-76" name="__codelineno-0-76"></a>def put_request(

4582 +<a id="__codelineno-0-77" name="__codelineno-0-77"></a> self,

4583 +<a id="__codelineno-0-78" name="__codelineno-0-78"></a> endpoint: str,

4584 +<a id="__codelineno-0-79" name="__codelineno-0-79"></a> data: str,

4585 +<a id="__codelineno-0-80" name="__codelineno-0-80"></a> params: Optional[Dict[str, str]] = None,

4586 +<a id="__codelineno-0-81" name="__codelineno-0-81"></a>) -> Dict[str, bool]:

4587 +<a id="__codelineno-0-82" name="__codelineno-0-82"></a> """

4588 +<a id="__codelineno-0-83" name="__codelineno-0-83"></a> Send a PUT request to the specified endpoint.

4589 +<a id="__codelineno-0-84" name="__codelineno-0-84"></a>

4590 +<a id="__codelineno-0-85" name="__codelineno-0-85"></a> Args:

4591 +<a id="__codelineno-0-86" name="__codelineno-0-86"></a> endpoint (str): The endpoint to send the PUT request to.

4592 +<a id="__codelineno-0-87" name="__codelineno-0-87"></a> data (str): The data to be updated in the PUT request.

4593 +<a id="__codelineno-0-88" name="__codelineno-0-88"></a> params (Optional[Dict[str, str]]): Additional parameters to include in the request.

4594 +<a id="__codelineno-0-89" name="__codelineno-0-89"></a>

4595 +<a id="__codelineno-0-90" name="__codelineno-0-90"></a> Returns:

4596 +<a id="__codelineno-0-91" name="__codelineno-0-91"></a> Dict[str, bool]: A dictionary indicating the success or failure of the operation.

4597 +<a id="__codelineno-0-92" name="__codelineno-0-92"></a> """

4598 +<a id="__codelineno-0-93" name="__codelineno-0-93"></a> try:

4599 +<a id="__codelineno-0-94" name="__codelineno-0-94"></a> headers = self.headers.copy()

4600 +<a id="__codelineno-0-95" name="__codelineno-0-95"></a> headers.update({"Content-Type": "application/octet-stream"})

4601 +<a id="__codelineno-0-96" name="__codelineno-0-96"></a>

4602 +<a id="__codelineno-0-97" name="__codelineno-0-97"></a> response = requests.put(

4603 +<a id="__codelineno-0-98" name="__codelineno-0-98"></a> f"{self.connector_url}/{endpoint}",

4604 +<a id="__codelineno-0-99" name="__codelineno-0-99"></a> headers=headers,

4605 +<a id="__codelineno-0-100" name="__codelineno-0-100"></a> params=params,

4606 +<a id="__codelineno-0-101" name="__codelineno-0-101"></a> data=data,

4607 +<a id="__codelineno-0-102" name="__codelineno-0-102"></a> verify=False,

4608 +<a id="__codelineno-0-103" name="__codelineno-0-103"></a> )

4609 +<a id="__codelineno-0-104" name="__codelineno-0-104"></a> response.raise_for_status()

4610 +<a id="__codelineno-0-105" name="__codelineno-0-105"></a> return {"message": f"Successfully updated {endpoint}", "success": True}

4611 +<a id="__codelineno-0-106" name="__codelineno-0-106"></a>

4612 +<a id="__codelineno-0-107" name="__codelineno-0-107"></a> except Exception as e:

4613 +<a id="__codelineno-0-108" name="__codelineno-0-108"></a> logger.error(f"Failed to update {endpoint}: {e}")

4614 +<a id="__codelineno-0-109" name="__codelineno-0-109"></a> return {"message": f"Failed to update {endpoint}: {e}", "success": False}

4615 +</code></pre></div></td></tr></table></div>

4616 + </details>

4617 + </div>

4618 +

4619 +</div>

4620 +

4621 +

4622 +

4623 + </div>

4624 +

4625 + </div>

4626 +

4627 +</div>

4628 +

4629 +

4630 +

4631 +

4632 + </div>

4633 +

4634 + </div>

4635 +

4636 +</div>

4637 +

4638 +<div class="doc doc-object doc-module">

4639 +

4640 +

4641 +<a id="app.services.WazuhManager.enabled_rule"></a>

4642 + <div class="doc doc-contents first">

4643 +

4644 +

4645 +

4646 + <div class="doc doc-children">

4647 +

4648 +

4649 +

4650 +

4651 +

4652 +

4653 +

4654 +

4655 +<div class="doc doc-object doc-class">

4656 +

4657 +

4658 +

4659 +<h2 id="app.services.WazuhManager.enabled_rule.EnableRuleService" class="doc doc-heading">

4660 + <code>EnableRuleService</code>

4661 +

4662 +

4663 +</h2>

4664 +

4665 +

4666 + <div class="doc doc-contents ">

4667 +

4668 +

4669 + A service class to manage rule enabling operations in Wazuh Manager.

4670 +

4671 + Attributes:

4672 + <table>

4673 + <thead>

4674 + <tr>

4675 + <th>Name</th>

4676 + <th>Type</th>

4677 + <th>Description</th>

4678 + </tr>

4679 + </thead>

4680 + <tbody>

4681 + <tr>

4682 + <td><code>universal_service</code></td>

4683 + <td>

4684 + <code><a class="autorefs autorefs-internal" title="app.services.WazuhManager.universal.UniversalService" href="#app.services.WazuhManager.universal.UniversalService">UniversalService</a></code>

4685 + </td>

4686 + <td>

4687 + <div class="doc-md-description">

4688 + An instance of the UniversalService.

4689 + </div>

4690 + </td>

4691 + </tr>

4692 + <tr>

4693 + <td><code>auth_token</code></td>

4694 + <td>

4695 + <code>str</code>

4696 + </td>

4697 + <td>

4698 + <div class="doc-md-description">

4699 + The Wazuh API authentication token.

4700 + </div>

4701 + </td>

4702 + </tr>

4703 + <tr>

4704 + <td><code>wazuh_http_requests</code></td>

4705 + <td>

4706 + <code><a class="autorefs autorefs-internal" title="app.services.WazuhManager.enabled_rule.WazuhHttpRequests" href="#app.services.WazuhManager.enabled_rule.WazuhHttpRequests">WazuhHttpRequests</a></code>

4707 + </td>

4708 + <td>

4709 + <div class="doc-md-description">

4710 + An instance of WazuhHttpRequests.

4711 + </div>

4712 + </td>

4713 + </tr>

4714 + </tbody>

4715 + </table>

4716 +

4717 +

4718 + <details class="quote">

4719 + <summary>Source code in <code>app\services\WazuhManager\enabled_rule.py</code></summary>

4720 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-115">115</a>

4721 +<a href="#__codelineno-0-116">116</a>

4722 +<a href="#__codelineno-0-117">117</a>

4723 +<a href="#__codelineno-0-118">118</a>

4724 +<a href="#__codelineno-0-119">119</a>

4725 +<a href="#__codelineno-0-120">120</a>

4726 +<a href="#__codelineno-0-121">121</a>

4727 +<a href="#__codelineno-0-122">122</a>

4728 +<a href="#__codelineno-0-123">123</a>

4729 +<a href="#__codelineno-0-124">124</a>

4730 +<a href="#__codelineno-0-125">125</a>

4731 +<a href="#__codelineno-0-126">126</a>

4732 +<a href="#__codelineno-0-127">127</a>

4733 +<a href="#__codelineno-0-128">128</a>

4734 +<a href="#__codelineno-0-129">129</a>

4735 +<a href="#__codelineno-0-130">130</a>

4736 +<a href="#__codelineno-0-131">131</a>

4737 +<a href="#__codelineno-0-132">132</a>

4738 +<a href="#__codelineno-0-133">133</a>

4739 +<a href="#__codelineno-0-134">134</a>

4740 +<a href="#__codelineno-0-135">135</a>

4741 +<a href="#__codelineno-0-136">136</a>

4742 +<a href="#__codelineno-0-137">137</a>

4743 +<a href="#__codelineno-0-138">138</a>

4744 +<a href="#__codelineno-0-139">139</a>

4745 +<a href="#__codelineno-0-140">140</a>

4746 +<a href="#__codelineno-0-141">141</a>

4747 +<a href="#__codelineno-0-142">142</a>

4748 +<a href="#__codelineno-0-143">143</a>

4749 +<a href="#__codelineno-0-144">144</a>

4750 +<a href="#__codelineno-0-145">145</a>

4751 +<a href="#__codelineno-0-146">146</a>

4752 +<a href="#__codelineno-0-147">147</a>

4753 +<a href="#__codelineno-0-148">148</a>

4754 +<a href="#__codelineno-0-149">149</a>

4755 +<a href="#__codelineno-0-150">150</a>

4756 +<a href="#__codelineno-0-151">151</a>

4757 +<a href="#__codelineno-0-152">152</a>

4758 +<a href="#__codelineno-0-153">153</a>

4759 +<a href="#__codelineno-0-154">154</a>

4760 +<a href="#__codelineno-0-155">155</a>

4761 +<a href="#__codelineno-0-156">156</a>

4762 +<a href="#__codelineno-0-157">157</a>

4763 +<a href="#__codelineno-0-158">158</a>

4764 +<a href="#__codelineno-0-159">159</a>

4765 +<a href="#__codelineno-0-160">160</a>

4766 +<a href="#__codelineno-0-161">161</a>

4767 +<a href="#__codelineno-0-162">162</a>

4768 +<a href="#__codelineno-0-163">163</a>

4769 +<a href="#__codelineno-0-164">164</a>

4770 +<a href="#__codelineno-0-165">165</a>

4771 +<a href="#__codelineno-0-166">166</a>

4772 +<a href="#__codelineno-0-167">167</a>

4773 +<a href="#__codelineno-0-168">168</a>

4774 +<a href="#__codelineno-0-169">169</a>

4775 +<a href="#__codelineno-0-170">170</a>

4776 +<a href="#__codelineno-0-171">171</a>

4777 +<a href="#__codelineno-0-172">172</a>

4778 +<a href="#__codelineno-0-173">173</a>

4779 +<a href="#__codelineno-0-174">174</a>

4780 +<a href="#__codelineno-0-175">175</a>

4781 +<a href="#__codelineno-0-176">176</a>

4782 +<a href="#__codelineno-0-177">177</a>

4783 +<a href="#__codelineno-0-178">178</a>

4784 +<a href="#__codelineno-0-179">179</a>

4785 +<a href="#__codelineno-0-180">180</a>

4786 +<a href="#__codelineno-0-181">181</a>

4787 +<a href="#__codelineno-0-182">182</a>

4788 +<a href="#__codelineno-0-183">183</a>

4789 +<a href="#__codelineno-0-184">184</a>

4790 +<a href="#__codelineno-0-185">185</a>

4791 +<a href="#__codelineno-0-186">186</a>

4792 +<a href="#__codelineno-0-187">187</a>

4793 +<a href="#__codelineno-0-188">188</a>

4794 +<a href="#__codelineno-0-189">189</a>

4795 +<a href="#__codelineno-0-190">190</a>

4796 +<a href="#__codelineno-0-191">191</a>

4797 +<a href="#__codelineno-0-192">192</a>

4798 +<a href="#__codelineno-0-193">193</a>

4799 +<a href="#__codelineno-0-194">194</a>

4800 +<a href="#__codelineno-0-195">195</a>

4801 +<a href="#__codelineno-0-196">196</a>

4802 +<a href="#__codelineno-0-197">197</a>

4803 +<a href="#__codelineno-0-198">198</a>

4804 +<a href="#__codelineno-0-199">199</a>

4805 +<a href="#__codelineno-0-200">200</a>

4806 +<a href="#__codelineno-0-201">201</a>

4807 +<a href="#__codelineno-0-202">202</a>

4808 +<a href="#__codelineno-0-203">203</a>

4809 +<a href="#__codelineno-0-204">204</a>

4810 +<a href="#__codelineno-0-205">205</a>

4811 +<a href="#__codelineno-0-206">206</a>

4812 +<a href="#__codelineno-0-207">207</a>

4813 +<a href="#__codelineno-0-208">208</a>

4814 +<a href="#__codelineno-0-209">209</a>

4815 +<a href="#__codelineno-0-210">210</a>

4816 +<a href="#__codelineno-0-211">211</a>

4817 +<a href="#__codelineno-0-212">212</a>

4818 +<a href="#__codelineno-0-213">213</a>

4819 +<a href="#__codelineno-0-214">214</a>

4820 +<a href="#__codelineno-0-215">215</a>

4821 +<a href="#__codelineno-0-216">216</a>

4822 +<a href="#__codelineno-0-217">217</a>

4823 +<a href="#__codelineno-0-218">218</a>

4824 +<a href="#__codelineno-0-219">219</a>

4825 +<a href="#__codelineno-0-220">220</a>

4826 +<a href="#__codelineno-0-221">221</a>

4827 +<a href="#__codelineno-0-222">222</a>

4828 +<a href="#__codelineno-0-223">223</a>

4829 +<a href="#__codelineno-0-224">224</a>

4830 +<a href="#__codelineno-0-225">225</a>

4831 +<a href="#__codelineno-0-226">226</a>

4832 +<a href="#__codelineno-0-227">227</a>

4833 +<a href="#__codelineno-0-228">228</a>

4834 +<a href="#__codelineno-0-229">229</a>

4835 +<a href="#__codelineno-0-230">230</a>

4836 +<a href="#__codelineno-0-231">231</a>

4837 +<a href="#__codelineno-0-232">232</a>

4838 +<a href="#__codelineno-0-233">233</a>

4839 +<a href="#__codelineno-0-234">234</a>

4840 +<a href="#__codelineno-0-235">235</a>

4841 +<a href="#__codelineno-0-236">236</a>

4842 +<a href="#__codelineno-0-237">237</a>

4843 +<a href="#__codelineno-0-238">238</a>

4844 +<a href="#__codelineno-0-239">239</a>

4845 +<a href="#__codelineno-0-240">240</a>

4846 +<a href="#__codelineno-0-241">241</a>

4847 +<a href="#__codelineno-0-242">242</a>

4848 +<a href="#__codelineno-0-243">243</a>

4849 +<a href="#__codelineno-0-244">244</a>

4850 +<a href="#__codelineno-0-245">245</a>

4851 +<a href="#__codelineno-0-246">246</a>

4852 +<a href="#__codelineno-0-247">247</a>

4853 +<a href="#__codelineno-0-248">248</a>

4854 +<a href="#__codelineno-0-249">249</a>

4855 +<a href="#__codelineno-0-250">250</a>

4856 +<a href="#__codelineno-0-251">251</a>

4857 +<a href="#__codelineno-0-252">252</a>

4858 +<a href="#__codelineno-0-253">253</a>

4859 +<a href="#__codelineno-0-254">254</a>

4860 +<a href="#__codelineno-0-255">255</a>

4861 +<a href="#__codelineno-0-256">256</a>

4862 +<a href="#__codelineno-0-257">257</a>

4863 +<a href="#__codelineno-0-258">258</a>

4864 +<a href="#__codelineno-0-259">259</a>

4865 +<a href="#__codelineno-0-260">260</a>

4866 +<a href="#__codelineno-0-261">261</a>

4867 +<a href="#__codelineno-0-262">262</a>

4868 +<a href="#__codelineno-0-263">263</a>

4869 +<a href="#__codelineno-0-264">264</a>

4870 +<a href="#__codelineno-0-265">265</a>

4871 +<a href="#__codelineno-0-266">266</a>

4872 +<a href="#__codelineno-0-267">267</a>

4873 +<a href="#__codelineno-0-268">268</a>

4874 +<a href="#__codelineno-0-269">269</a>

4875 +<a href="#__codelineno-0-270">270</a>

4876 +<a href="#__codelineno-0-271">271</a>

4877 +<a href="#__codelineno-0-272">272</a>

4878 +<a href="#__codelineno-0-273">273</a>

4879 +<a href="#__codelineno-0-274">274</a>

4880 +<a href="#__codelineno-0-275">275</a>

4881 +<a href="#__codelineno-0-276">276</a>

4882 +<a href="#__codelineno-0-277">277</a>

4883 +<a href="#__codelineno-0-278">278</a>

4884 +<a href="#__codelineno-0-279">279</a>

4885 +<a href="#__codelineno-0-280">280</a>

4886 +<a href="#__codelineno-0-281">281</a>

4887 +<a href="#__codelineno-0-282">282</a>

4888 +<a href="#__codelineno-0-283">283</a>

4889 +<a href="#__codelineno-0-284">284</a>

4890 +<a href="#__codelineno-0-285">285</a>

4891 +<a href="#__codelineno-0-286">286</a>

4892 +<a href="#__codelineno-0-287">287</a>

4893 +<a href="#__codelineno-0-288">288</a>

4894 +<a href="#__codelineno-0-289">289</a>

4895 +<a href="#__codelineno-0-290">290</a>

4896 +<a href="#__codelineno-0-291">291</a>

4897 +<a href="#__codelineno-0-292">292</a>

4898 +<a href="#__codelineno-0-293">293</a>

4899 +<a href="#__codelineno-0-294">294</a>

4900 +<a href="#__codelineno-0-295">295</a>

4901 +<a href="#__codelineno-0-296">296</a>

4902 +<a href="#__codelineno-0-297">297</a>

4903 +<a href="#__codelineno-0-298">298</a>

4904 +<a href="#__codelineno-0-299">299</a>

4905 +<a href="#__codelineno-0-300">300</a>

4906 +<a href="#__codelineno-0-301">301</a>

4907 +<a href="#__codelineno-0-302">302</a>

4908 +<a href="#__codelineno-0-303">303</a>

4909 +<a href="#__codelineno-0-304">304</a>

4910 +<a href="#__codelineno-0-305">305</a>

4911 +<a href="#__codelineno-0-306">306</a>

4912 +<a href="#__codelineno-0-307">307</a>

4913 +<a href="#__codelineno-0-308">308</a>

4914 +<a href="#__codelineno-0-309">309</a>

4915 +<a href="#__codelineno-0-310">310</a>

4916 +<a href="#__codelineno-0-311">311</a>

4917 +<a href="#__codelineno-0-312">312</a>

4918 +<a href="#__codelineno-0-313">313</a>

4919 +<a href="#__codelineno-0-314">314</a>

4920 +<a href="#__codelineno-0-315">315</a>

4921 +<a href="#__codelineno-0-316">316</a>

4922 +<a href="#__codelineno-0-317">317</a>

4923 +<a href="#__codelineno-0-318">318</a>

4924 +<a href="#__codelineno-0-319">319</a>

4925 +<a href="#__codelineno-0-320">320</a>

4926 +<a href="#__codelineno-0-321">321</a>

4927 +<a href="#__codelineno-0-322">322</a>

4928 +<a href="#__codelineno-0-323">323</a>

4929 +<a href="#__codelineno-0-324">324</a>

4930 +<a href="#__codelineno-0-325">325</a>

4931 +<a href="#__codelineno-0-326">326</a>

4932 +<a href="#__codelineno-0-327">327</a>

4933 +<a href="#__codelineno-0-328">328</a>

4934 +<a href="#__codelineno-0-329">329</a>

4935 +<a href="#__codelineno-0-330">330</a>

4936 +<a href="#__codelineno-0-331">331</a>

4937 +<a href="#__codelineno-0-332">332</a>

4938 +<a href="#__codelineno-0-333">333</a>

4939 +<a href="#__codelineno-0-334">334</a>

4940 +<a href="#__codelineno-0-335">335</a>

4941 +<a href="#__codelineno-0-336">336</a>

4942 +<a href="#__codelineno-0-337">337</a>

4943 +<a href="#__codelineno-0-338">338</a>

4944 +<a href="#__codelineno-0-339">339</a>

4945 +<a href="#__codelineno-0-340">340</a>

4946 +<a href="#__codelineno-0-341">341</a>

4947 +<a href="#__codelineno-0-342">342</a>

4948 +<a href="#__codelineno-0-343">343</a>

4949 +<a href="#__codelineno-0-344">344</a>

4950 +<a href="#__codelineno-0-345">345</a>

4951 +<a href="#__codelineno-0-346">346</a>

4952 +<a href="#__codelineno-0-347">347</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-115" name="__codelineno-0-115"></a>class EnableRuleService:

4953 +<a id="__codelineno-0-116" name="__codelineno-0-116"></a> """

4954 +<a id="__codelineno-0-117" name="__codelineno-0-117"></a> A service class to manage rule enabling operations in Wazuh Manager.

4955 +<a id="__codelineno-0-118" name="__codelineno-0-118"></a>

4956 +<a id="__codelineno-0-119" name="__codelineno-0-119"></a> Attributes:

4957 +<a id="__codelineno-0-120" name="__codelineno-0-120"></a> universal_service (UniversalService): An instance of the UniversalService.

4958 +<a id="__codelineno-0-121" name="__codelineno-0-121"></a> auth_token (str): The Wazuh API authentication token.

4959 +<a id="__codelineno-0-122" name="__codelineno-0-122"></a> wazuh_http_requests (WazuhHttpRequests): An instance of WazuhHttpRequests.

4960 +<a id="__codelineno-0-123" name="__codelineno-0-123"></a> """

4961 +<a id="__codelineno-0-124" name="__codelineno-0-124"></a>

4962 +<a id="__codelineno-0-125" name="__codelineno-0-125"></a> def __init__(self, universal_service: UniversalService) -> None:

4963 +<a id="__codelineno-0-126" name="__codelineno-0-126"></a> """

4964 +<a id="__codelineno-0-127" name="__codelineno-0-127"></a> Initialize an EnableRuleService instance.

4965 +<a id="__codelineno-0-128" name="__codelineno-0-128"></a>

4966 +<a id="__codelineno-0-129" name="__codelineno-0-129"></a> Args:

4967 +<a id="__codelineno-0-130" name="__codelineno-0-130"></a> universal_service (UniversalService): An instance of the UniversalService.

4968 +<a id="__codelineno-0-131" name="__codelineno-0-131"></a> """

4969 +<a id="__codelineno-0-132" name="__codelineno-0-132"></a> self.universal_service = universal_service

4970 +<a id="__codelineno-0-133" name="__codelineno-0-133"></a> self.auth_token = universal_service.get_auth_token()

4971 +<a id="__codelineno-0-134" name="__codelineno-0-134"></a> self.wazuh_http_requests = WazuhHttpRequests(

4972 +<a id="__codelineno-0-135" name="__codelineno-0-135"></a> self.universal_service.connector_url,

4973 +<a id="__codelineno-0-136" name="__codelineno-0-136"></a> self.auth_token,

4974 +<a id="__codelineno-0-137" name="__codelineno-0-137"></a> )

4975 +<a id="__codelineno-0-138" name="__codelineno-0-138"></a>

4976 +<a id="__codelineno-0-139" name="__codelineno-0-139"></a> def enable_rule(self, request: Dict[str, str]) -> Dict[str, Union[str, bool]]:

4977 +<a id="__codelineno-0-140" name="__codelineno-0-140"></a> """

4978 +<a id="__codelineno-0-141" name="__codelineno-0-141"></a> Enable a rule in Wazuh Manager.

4979 +<a id="__codelineno-0-142" name="__codelineno-0-142"></a>

4980 +<a id="__codelineno-0-143" name="__codelineno-0-143"></a> Args:

4981 +<a id="__codelineno-0-144" name="__codelineno-0-144"></a> request (Dict[str, str]): A request to enable a rule.

4982 +<a id="__codelineno-0-145" name="__codelineno-0-145"></a>

4983 +<a id="__codelineno-0-146" name="__codelineno-0-146"></a> Returns:

4984 +<a id="__codelineno-0-147" name="__codelineno-0-147"></a> Dict[str, Union[str, bool]]: A dictionary indicating the success of the operation.

4985 +<a id="__codelineno-0-148" name="__codelineno-0-148"></a> """

4986 +<a id="__codelineno-0-149" name="__codelineno-0-149"></a> try:

4987 +<a id="__codelineno-0-150" name="__codelineno-0-150"></a> self._validate_request(request)

4988 +<a id="__codelineno-0-151" name="__codelineno-0-151"></a> rule_id = request["rule_id"]

4989 +<a id="__codelineno-0-152" name="__codelineno-0-152"></a> filename = self._fetch_filename(rule_id)

4990 +<a id="__codelineno-0-153" name="__codelineno-0-153"></a> logger.info(f"Getting file content of {filename}")

4991 +<a id="__codelineno-0-154" name="__codelineno-0-154"></a> file_content = self._fetch_file_content(filename)

4992 +<a id="__codelineno-0-155" name="__codelineno-0-155"></a> previous_level = self._get_previous_level(rule_id)

4993 +<a id="__codelineno-0-156" name="__codelineno-0-156"></a> updated_file_content = self._set_level_previous(

4994 +<a id="__codelineno-0-157" name="__codelineno-0-157"></a> file_content,

4995 +<a id="__codelineno-0-158" name="__codelineno-0-158"></a> rule_id,

4996 +<a id="__codelineno-0-159" name="__codelineno-0-159"></a> previous_level,

4997 +<a id="__codelineno-0-160" name="__codelineno-0-160"></a> )

4998 +<a id="__codelineno-0-161" name="__codelineno-0-161"></a> xml_content = self._json_to_xml(updated_file_content)

4999 +<a id="__codelineno-0-162" name="__codelineno-0-162"></a> self._delete_rule_from_db(rule_id)

5000 +<a id="__codelineno-0-163" name="__codelineno-0-163"></a> self._put_updated_rule(filename, xml_content)

5001 +<a id="__codelineno-0-164" name="__codelineno-0-164"></a> UniversalService().restart_service()

5002 +<a id="__codelineno-0-165" name="__codelineno-0-165"></a> return {

5003 +<a id="__codelineno-0-166" name="__codelineno-0-166"></a> "message": f"Rule {rule_id} successfully enabled in file {filename}.",

5004 +<a id="__codelineno-0-167" name="__codelineno-0-167"></a> "success": True,

5005 +<a id="__codelineno-0-168" name="__codelineno-0-168"></a> }

5006 +<a id="__codelineno-0-169" name="__codelineno-0-169"></a> except Exception as e:

5007 +<a id="__codelineno-0-170" name="__codelineno-0-170"></a> return {"message": str(e), "success": False}

5008 +<a id="__codelineno-0-171" name="__codelineno-0-171"></a>

5009 +<a id="__codelineno-0-172" name="__codelineno-0-172"></a> def _validate_request(self, request: Dict[str, str]) -> str:

5010 +<a id="__codelineno-0-173" name="__codelineno-0-173"></a> """

5011 +<a id="__codelineno-0-174" name="__codelineno-0-174"></a> Validate a request to enable a rule.

5012 +<a id="__codelineno-0-175" name="__codelineno-0-175"></a>

5013 +<a id="__codelineno-0-176" name="__codelineno-0-176"></a> Args:

5014 +<a id="__codelineno-0-177" name="__codelineno-0-177"></a> request (Dict[str, str]): A request to enable a rule.

5015 +<a id="__codelineno-0-178" name="__codelineno-0-178"></a>

5016 +<a id="__codelineno-0-179" name="__codelineno-0-179"></a> Raises:

5017 +<a id="__codelineno-0-180" name="__codelineno-0-180"></a> ValueError: If 'rule_id' is not in the request.

5018 +<a id="__codelineno-0-181" name="__codelineno-0-181"></a>

5019 +<a id="__codelineno-0-182" name="__codelineno-0-182"></a> Returns:

5020 +<a id="__codelineno-0-183" name="__codelineno-0-183"></a> str: The rule id from the request.

5021 +<a id="__codelineno-0-184" name="__codelineno-0-184"></a> """

5022 +<a id="__codelineno-0-185" name="__codelineno-0-185"></a> logger.info(f"Validating enable rule request: {request}")

5023 +<a id="__codelineno-0-186" name="__codelineno-0-186"></a> if "rule_id" not in request:

5024 +<a id="__codelineno-0-187" name="__codelineno-0-187"></a> raise ValueError("Request missing rule_id")

5025 +<a id="__codelineno-0-188" name="__codelineno-0-188"></a> return request["rule_id"]

5026 +<a id="__codelineno-0-189" name="__codelineno-0-189"></a>

5027 +<a id="__codelineno-0-190" name="__codelineno-0-190"></a> def _fetch_filename(self, rule_id: str) -> str:

5028 +<a id="__codelineno-0-191" name="__codelineno-0-191"></a> """

5029 +<a id="__codelineno-0-192" name="__codelineno-0-192"></a> Fetch the filename containing the rule to be enabled.

5030 +<a id="__codelineno-0-193" name="__codelineno-0-193"></a>

5031 +<a id="__codelineno-0-194" name="__codelineno-0-194"></a> Args:

5032 +<a id="__codelineno-0-195" name="__codelineno-0-195"></a> rule_id (str): The id of the rule to be enabled.

5033 +<a id="__codelineno-0-196" name="__codelineno-0-196"></a>

5034 +<a id="__codelineno-0-197" name="__codelineno-0-197"></a> Raises:

5035 +<a id="__codelineno-0-198" name="__codelineno-0-198"></a> ValueError: If the filename could not be fetched.

5036 +<a id="__codelineno-0-199" name="__codelineno-0-199"></a>

5037 +<a id="__codelineno-0-200" name="__codelineno-0-200"></a> Returns:

5038 +<a id="__codelineno-0-201" name="__codelineno-0-201"></a> str: The filename containing the rule.

5039 +<a id="__codelineno-0-202" name="__codelineno-0-202"></a> """

5040 +<a id="__codelineno-0-203" name="__codelineno-0-203"></a> filename_data = self.wazuh_http_requests.get_request(

5041 +<a id="__codelineno-0-204" name="__codelineno-0-204"></a> "rules",

5042 +<a id="__codelineno-0-205" name="__codelineno-0-205"></a> {"rule_ids": rule_id},

5043 +<a id="__codelineno-0-206" name="__codelineno-0-206"></a> )

5044 +<a id="__codelineno-0-207" name="__codelineno-0-207"></a> if not filename_data["success"]:

5045 +<a id="__codelineno-0-208" name="__codelineno-0-208"></a> raise ValueError(filename_data["message"])

5046 +<a id="__codelineno-0-209" name="__codelineno-0-209"></a> return filename_data["data"]["data"]["affected_items"][0]["filename"]

5047 +<a id="__codelineno-0-210" name="__codelineno-0-210"></a>

5048 +<a id="__codelineno-0-211" name="__codelineno-0-211"></a> def _fetch_file_content(self, filename: str) -> Any:

5049 +<a id="__codelineno-0-212" name="__codelineno-0-212"></a> """

5050 +<a id="__codelineno-0-213" name="__codelineno-0-213"></a> Fetch the content of the file containing the rule to be enabled.

5051 +<a id="__codelineno-0-214" name="__codelineno-0-214"></a>

5052 +<a id="__codelineno-0-215" name="__codelineno-0-215"></a> Args:

5053 +<a id="__codelineno-0-216" name="__codelineno-0-216"></a> filename (str): The filename containing the rule to be enabled.

5054 +<a id="__codelineno-0-217" name="__codelineno-0-217"></a>

5055 +<a id="__codelineno-0-218" name="__codelineno-0-218"></a> Raises:

5056 +<a id="__codelineno-0-219" name="__codelineno-0-219"></a> ValueError: If the file content could not be fetched.

5057 +<a id="__codelineno-0-220" name="__codelineno-0-220"></a>

5058 +<a id="__codelineno-0-221" name="__codelineno-0-221"></a> Returns:

5059 +<a id="__codelineno-0-222" name="__codelineno-0-222"></a> Any: The content of the file.

5060 +<a id="__codelineno-0-223" name="__codelineno-0-223"></a> """

5061 +<a id="__codelineno-0-224" name="__codelineno-0-224"></a> file_content_data = self.wazuh_http_requests.get_request(

5062 +<a id="__codelineno-0-225" name="__codelineno-0-225"></a> f"rules/files/{filename}",

5063 +<a id="__codelineno-0-226" name="__codelineno-0-226"></a> )

5064 +<a id="__codelineno-0-227" name="__codelineno-0-227"></a> if not file_content_data["success"]:

5065 +<a id="__codelineno-0-228" name="__codelineno-0-228"></a> raise ValueError(file_content_data["message"])

5066 +<a id="__codelineno-0-229" name="__codelineno-0-229"></a> return file_content_data["data"]["data"]["affected_items"][0]["group"]

5067 +<a id="__codelineno-0-230" name="__codelineno-0-230"></a>

5068 +<a id="__codelineno-0-231" name="__codelineno-0-231"></a> def _get_previous_level(self, rule_id: str) -> str:

5069 +<a id="__codelineno-0-232" name="__codelineno-0-232"></a> """

5070 +<a id="__codelineno-0-233" name="__codelineno-0-233"></a> Fetch the previous level of a rule from the `disabled_rules` table.

5071 +<a id="__codelineno-0-234" name="__codelineno-0-234"></a>

5072 +<a id="__codelineno-0-235" name="__codelineno-0-235"></a> Args:

5073 +<a id="__codelineno-0-236" name="__codelineno-0-236"></a> rule_id (str): The id of the rule.

5074 +<a id="__codelineno-0-237" name="__codelineno-0-237"></a>

5075 +<a id="__codelineno-0-238" name="__codelineno-0-238"></a> Raises:

5076 +<a id="__codelineno-0-239" name="__codelineno-0-239"></a> ValueError: If the rule was not previously disabled.

5077 +<a id="__codelineno-0-240" name="__codelineno-0-240"></a>

5078 +<a id="__codelineno-0-241" name="__codelineno-0-241"></a> Returns:

5079 +<a id="__codelineno-0-242" name="__codelineno-0-242"></a> str: The previous level of the rule.

5080 +<a id="__codelineno-0-243" name="__codelineno-0-243"></a> """

5081 +<a id="__codelineno-0-244" name="__codelineno-0-244"></a> disabled_rule = DisabledRules.query.filter_by(rule_id=rule_id).first()

5082 +<a id="__codelineno-0-245" name="__codelineno-0-245"></a> if not disabled_rule:

5083 +<a id="__codelineno-0-246" name="__codelineno-0-246"></a> raise ValueError(f"Rule {rule_id} is not disabled.")

5084 +<a id="__codelineno-0-247" name="__codelineno-0-247"></a> return disabled_rule.previous_level

5085 +<a id="__codelineno-0-248" name="__codelineno-0-248"></a>

5086 +<a id="__codelineno-0-249" name="__codelineno-0-249"></a> def _set_level_previous(

5087 +<a id="__codelineno-0-250" name="__codelineno-0-250"></a> self,

5088 +<a id="__codelineno-0-251" name="__codelineno-0-251"></a> file_content: Any,

5089 +<a id="__codelineno-0-252" name="__codelineno-0-252"></a> rule_id: str,

5090 +<a id="__codelineno-0-253" name="__codelineno-0-253"></a> previous_level: str,

5091 +<a id="__codelineno-0-254" name="__codelineno-0-254"></a> ) -> Any:

5092 +<a id="__codelineno-0-255" name="__codelineno-0-255"></a> """

5093 +<a id="__codelineno-0-256" name="__codelineno-0-256"></a> Set the level of a rule to its previous level in the file content.

5094 +<a id="__codelineno-0-257" name="__codelineno-0-257"></a>

5095 +<a id="__codelineno-0-258" name="__codelineno-0-258"></a> Args:

5096 +<a id="__codelineno-0-259" name="__codelineno-0-259"></a> file_content (Any): The content of the file containing the rule.

5097 +<a id="__codelineno-0-260" name="__codelineno-0-260"></a> rule_id (str): The id of the rule.

5098 +<a id="__codelineno-0-261" name="__codelineno-0-261"></a> previous_level (str): The previous level of the rule.

5099 +<a id="__codelineno-0-262" name="__codelineno-0-262"></a>

5100 +<a id="__codelineno-0-263" name="__codelineno-0-263"></a> Returns:

5101 +<a id="__codelineno-0-264" name="__codelineno-0-264"></a> Any: The updated file content with the level of the rule set to the previous level.

5102 +<a id="__codelineno-0-265" name="__codelineno-0-265"></a> """

5103 +<a id="__codelineno-0-266" name="__codelineno-0-266"></a> logger.info(

5104 +<a id="__codelineno-0-267" name="__codelineno-0-267"></a> f"Setting rule {rule_id} level to {previous_level} for file_content: {file_content}",

5105 +<a id="__codelineno-0-268" name="__codelineno-0-268"></a> )

5106 +<a id="__codelineno-0-269" name="__codelineno-0-269"></a> # If 'file_content' is a dictionary (representing a single group), make it a list of one group

5107 +<a id="__codelineno-0-270" name="__codelineno-0-270"></a> if isinstance(file_content, dict):

5108 +<a id="__codelineno-0-271" name="__codelineno-0-271"></a> file_content = [file_content]

5109 +<a id="__codelineno-0-272" name="__codelineno-0-272"></a>

5110 +<a id="__codelineno-0-273" name="__codelineno-0-273"></a> for group_block in file_content:

5111 +<a id="__codelineno-0-274" name="__codelineno-0-274"></a> rule_block = group_block.get("rule", None)

5112 +<a id="__codelineno-0-275" name="__codelineno-0-275"></a> if not rule_block:

5113 +<a id="__codelineno-0-276" name="__codelineno-0-276"></a> continue

5114 +<a id="__codelineno-0-277" name="__codelineno-0-277"></a> if isinstance(rule_block, dict):

5115 +<a id="__codelineno-0-278" name="__codelineno-0-278"></a> rule_block = [rule_block]

5116 +<a id="__codelineno-0-279" name="__codelineno-0-279"></a>

5117 +<a id="__codelineno-0-280" name="__codelineno-0-280"></a> for rule in rule_block:

5118 +<a id="__codelineno-0-281" name="__codelineno-0-281"></a> if rule["@id"] == rule_id:

5119 +<a id="__codelineno-0-282" name="__codelineno-0-282"></a> # Set the rule level to the previous level.

5120 +<a id="__codelineno-0-283" name="__codelineno-0-283"></a> rule["@level"] = previous_level

5121 +<a id="__codelineno-0-284" name="__codelineno-0-284"></a> break

5122 +<a id="__codelineno-0-285" name="__codelineno-0-285"></a>

5123 +<a id="__codelineno-0-286" name="__codelineno-0-286"></a> return file_content

5124 +<a id="__codelineno-0-287" name="__codelineno-0-287"></a>

5125 +<a id="__codelineno-0-288" name="__codelineno-0-288"></a> def _json_to_xml(self, file_content: Any) -> str:

5126 +<a id="__codelineno-0-289" name="__codelineno-0-289"></a> """

5127 +<a id="__codelineno-0-290" name="__codelineno-0-290"></a> Convert file content from JSON to XML format.

5128 +<a id="__codelineno-0-291" name="__codelineno-0-291"></a>

5129 +<a id="__codelineno-0-292" name="__codelineno-0-292"></a> Args:

5130 +<a id="__codelineno-0-293" name="__codelineno-0-293"></a> file_content (Any): The content of the file containing the rule.

5131 +<a id="__codelineno-0-294" name="__codelineno-0-294"></a>

5132 +<a id="__codelineno-0-295" name="__codelineno-0-295"></a> Returns:

5133 +<a id="__codelineno-0-296" name="__codelineno-0-296"></a> str: The file content in XML format.

5134 +<a id="__codelineno-0-297" name="__codelineno-0-297"></a> """

5135 +<a id="__codelineno-0-298" name="__codelineno-0-298"></a> logger.info(f"Converting file_content to XML: {file_content}")

5136 +<a id="__codelineno-0-299" name="__codelineno-0-299"></a>

5137 +<a id="__codelineno-0-300" name="__codelineno-0-300"></a> xml_content_list = []

5138 +<a id="__codelineno-0-301" name="__codelineno-0-301"></a> for group in file_content:

5139 +<a id="__codelineno-0-302" name="__codelineno-0-302"></a> xml_dict = {"group": group}

5140 +<a id="__codelineno-0-303" name="__codelineno-0-303"></a> xml_content = xmltodict.unparse(xml_dict, pretty=True)

5141 +<a id="__codelineno-0-304" name="__codelineno-0-304"></a> # Remove the `<?xml version="1.0" encoding="utf-8"?>` from the

5142 +<a id="__codelineno-0-305" name="__codelineno-0-305"></a> # beginning of the XML string.

5143 +<a id="__codelineno-0-306" name="__codelineno-0-306"></a> xml_content = xml_content.replace(

5144 +<a id="__codelineno-0-307" name="__codelineno-0-307"></a> '<?xml version="1.0" encoding="utf-8"?>',

5145 +<a id="__codelineno-0-308" name="__codelineno-0-308"></a> "",

5146 +<a id="__codelineno-0-309" name="__codelineno-0-309"></a> )

5147 +<a id="__codelineno-0-310" name="__codelineno-0-310"></a> xml_content_list.append(xml_content)

5148 +<a id="__codelineno-0-311" name="__codelineno-0-311"></a>

5149 +<a id="__codelineno-0-312" name="__codelineno-0-312"></a> # Concatenate all XML strings

5150 +<a id="__codelineno-0-313" name="__codelineno-0-313"></a> xml_content = "\n".join(xml_content_list)

5151 +<a id="__codelineno-0-314" name="__codelineno-0-314"></a> # Remove top and bottom line breaks

5152 +<a id="__codelineno-0-315" name="__codelineno-0-315"></a> xml_content = xml_content.strip()

5153 +<a id="__codelineno-0-316" name="__codelineno-0-316"></a>

5154 +<a id="__codelineno-0-317" name="__codelineno-0-317"></a> return xml_content

5155 +<a id="__codelineno-0-318" name="__codelineno-0-318"></a>

5156 +<a id="__codelineno-0-319" name="__codelineno-0-319"></a> def _delete_rule_from_db(self, rule_id: str):

5157 +<a id="__codelineno-0-320" name="__codelineno-0-320"></a> """

5158 +<a id="__codelineno-0-321" name="__codelineno-0-321"></a> Delete a rule from the `disabled_rules` table.

5159 +<a id="__codelineno-0-322" name="__codelineno-0-322"></a>

5160 +<a id="__codelineno-0-323" name="__codelineno-0-323"></a> Args:

5161 +<a id="__codelineno-0-324" name="__codelineno-0-324"></a> rule_id (str): The id of the rule to be deleted.

5162 +<a id="__codelineno-0-325" name="__codelineno-0-325"></a> """

5163 +<a id="__codelineno-0-326" name="__codelineno-0-326"></a> disabled_rule = DisabledRules.query.filter_by(rule_id=rule_id).first()

5164 +<a id="__codelineno-0-327" name="__codelineno-0-327"></a> db.session.delete(disabled_rule)

5165 +<a id="__codelineno-0-328" name="__codelineno-0-328"></a> db.session.commit()

5166 +<a id="__codelineno-0-329" name="__codelineno-0-329"></a>

5167 +<a id="__codelineno-0-330" name="__codelineno-0-330"></a> def _put_updated_rule(self, filename: str, xml_content: str):

5168 +<a id="__codelineno-0-331" name="__codelineno-0-331"></a> """

5169 +<a id="__codelineno-0-332" name="__codelineno-0-332"></a> Upload the updated rule to the Wazuh Manager.

5170 +<a id="__codelineno-0-333" name="__codelineno-0-333"></a>

5171 +<a id="__codelineno-0-334" name="__codelineno-0-334"></a> Args:

5172 +<a id="__codelineno-0-335" name="__codelineno-0-335"></a> filename (str): The filename containing the rule.

5173 +<a id="__codelineno-0-336" name="__codelineno-0-336"></a> xml_content (str): The updated rule in XML format.

5174 +<a id="__codelineno-0-337" name="__codelineno-0-337"></a>

5175 +<a id="__codelineno-0-338" name="__codelineno-0-338"></a> Raises:

5176 +<a id="__codelineno-0-339" name="__codelineno-0-339"></a> RuntimeError: If the PUT operation fails.

5177 +<a id="__codelineno-0-340" name="__codelineno-0-340"></a> """

5178 +<a id="__codelineno-0-341" name="__codelineno-0-341"></a> response = self.wazuh_http_requests.put_request(

5179 +<a id="__codelineno-0-342" name="__codelineno-0-342"></a> f"rules/files/{filename}",

5180 +<a id="__codelineno-0-343" name="__codelineno-0-343"></a> xml_content,

5181 +<a id="__codelineno-0-344" name="__codelineno-0-344"></a> params={"overwrite": "true"},

5182 +<a id="__codelineno-0-345" name="__codelineno-0-345"></a> )

5183 +<a id="__codelineno-0-346" name="__codelineno-0-346"></a> if not response["success"]:

5184 +<a id="__codelineno-0-347" name="__codelineno-0-347"></a> raise RuntimeError(f"Could not PUT rule {filename}")

5185 +</code></pre></div></td></tr></table></div>

5186 + </details>

5187 +

5188 +

5189 +

5190 + <div class="doc doc-children">

5191 +

5192 +

5193 +

5194 +

5195 +

5196 +

5197 +

5198 +

5199 +

5200 +<div class="doc doc-object doc-function">

5201 +

5202 +

5203 +

5204 +<h3 id="app.services.WazuhManager.enabled_rule.EnableRuleService.__init__" class="doc doc-heading">

5205 +<code class="highlight language-python">__init__(universal_service)</code>

5206 +

5207 +</h3>

5208 +

5209 +

5210 + <div class="doc doc-contents ">

5211 +

5212 + Initialize an EnableRuleService instance.

5213 +

5214 + Parameters:

5215 + <table>

5216 + <thead>

5217 + <tr>

5218 + <th>Name</th>

5219 + <th>Type</th>

5220 + <th>Description</th>

5221 + <th>Default</th>

5222 + </tr>

5223 + </thead>

5224 + <tbody>

5225 + <tr>

5226 + <td><code>universal_service</code></td>

5227 + <td>

5228 + <code><a class="autorefs autorefs-internal" title="app.services.WazuhManager.universal.UniversalService" href="#app.services.WazuhManager.universal.UniversalService">UniversalService</a></code>

5229 + </td>

5230 + <td>

5231 + <div class="doc-md-description">

5232 + An instance of the UniversalService.

5233 + </div>

5234 + </td>

5235 + <td>

5236 + required

5237 + </td>

5238 + </tr>

5239 + </tbody>

5240 + </table>

5241 +

5242 + <details class="quote">

5243 + <summary>Source code in <code>app\services\WazuhManager\enabled_rule.py</code></summary>

5244 + <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><a href="#__codelineno-0-125">125</a>

5245 +<a href="#__codelineno-0-126">126</a>

5246 +<a href="#__codelineno-0-127">127</a>

5247 +<a href="#__codelineno-0-128">128</a>

5248 +<a href="#__codelineno-0-129">129</a>

5249 +<a href="#__codelineno-0-130">130</a>

5250 +<a href="#__codelineno-0-131">131</a>

5251 +<a href="#__codelineno-0-132">132</a>

5252 +<a href="#__codelineno-0-133">133</a>

5253 +<a href="#__codelineno-0-134">134</a>

5254 +<a href="#__codelineno-0-135">135</a>

5255 +<a href="#__codelineno-0-136">136</a>

5256 +<a href="#__codelineno-0-137">137</a></pre></div></td><td class="code"><div><pre><code><a id="__codelineno-0-125" name="__codelineno-0-125"></a>def __init__(self, universal_service: UniversalService) -> None:

5257 +<a id="__codelineno-0-126" name="__codelineno-0-126"></a> """

5258 +<a id="__codelineno-0-127" name="__codelineno-0-127"></a> Initialize an EnableRuleService instance.

5259 +<a id="__codelineno-0-128" name="__codelineno-0-128"></a>

5260 +<a id="__codelineno-0-129" name="__codelineno-0-129"></a> Args:

5261 +<a id="__codelineno-0-130" name="__codelineno-0-130"></a> universal_service (UniversalService): An instance of the UniversalService.

5262 +<a id="__codelineno-0-131" name="__codelineno-0-131"></a> """

5263 +<a id="__codelineno-0-132" name="__codelineno-0-132"></a> self.universal_service = universal_service

5264 +<a id="__codelineno-0-133" name="__codelineno-0-133"></a> self.auth_token = universal_service.get_auth_token()

5265 +<a id="__codelineno-0-134" name="__codelineno-0-134"></a> self.wazuh_http_requests = WazuhHttpRequests(

5266 +<a id="__codelineno-0-135" name="__codelineno-0-135"></a> self.universal_service.connector_url,

5267 +<a id="__codelineno-0-136" name="__codelineno-0-136"></a> self.auth_token,

5268 +<a id="__codelineno-0-137" name="__codelineno-0-137"></a> )

5269 +</code></pre></div></td></tr></table></div>

5270 + </details>

5271 + </div>

5272 +

5273 +</div>

5274 +

5275 +<div class="doc doc-object doc-function">

5276 +

5277 +

5278 +

5279 +<h3 id="app.services.WazuhManager.enabled_rule.EnableRuleService.enable_rule" class="doc doc-heading">

5280 +<code class="highlight language-python">enable_rule(request)</code>

5281 +

5282 +</h3>

5283 +

5284 +

5285 + <div class="doc doc-contents ">

5286 +

5287 + Enable a rule in Wazuh Manager.

This file is too large to show in full.