howler-api 4.1.0.dev1631__tar.gz → 4.1.0.dev1643__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (241) hide show
  1. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/PKG-INFO +1 -1
  2. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/hit.py +3 -2
  3. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/utils/permission_helper.py +16 -6
  4. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/event.py +1 -21
  5. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/howler_data.py +1 -29
  6. howler_api-4.1.0.dev1643/howler/odm/models/log.py +31 -0
  7. howler_api-4.1.0.dev1643/howler/odm/models/permission_request.py +12 -0
  8. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/case_service.py +30 -4
  9. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/hit_service.py +5 -4
  10. howler_api-4.1.0.dev1643/howler/services/permission_service.py +152 -0
  11. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/pyproject.toml +1 -1
  12. howler_api-4.1.0.dev1631/howler/odm/models/permission_request.py +0 -17
  13. howler_api-4.1.0.dev1631/howler/services/permission_service.py +0 -150
  14. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/README.md +0 -0
  15. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/__init__.py +0 -0
  16. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/actions/__init__.py +0 -0
  17. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/actions/add_label.py +0 -0
  18. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/actions/add_to_bundle.py +0 -0
  19. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/actions/add_to_case.py +0 -0
  20. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/actions/change_field.py +0 -0
  21. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/actions/demote.py +0 -0
  22. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/actions/example_plugin.py +0 -0
  23. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/actions/prioritization.py +0 -0
  24. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/actions/promote.py +0 -0
  25. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/actions/remove_from_bundle.py +0 -0
  26. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/actions/remove_label.py +0 -0
  27. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/actions/transition.py +0 -0
  28. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/__init__.py +0 -0
  29. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/base.py +0 -0
  30. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/socket.py +0 -0
  31. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/__init__.py +0 -0
  32. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/action.py +0 -0
  33. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/analytic.py +0 -0
  34. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/auth.py +0 -0
  35. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/clue.py +0 -0
  36. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/configs.py +0 -0
  37. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/dossier.py +0 -0
  38. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/help.py +0 -0
  39. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/notebook.py +0 -0
  40. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/overview.py +0 -0
  41. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/search.py +0 -0
  42. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/template.py +0 -0
  43. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/tool.py +0 -0
  44. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/user.py +0 -0
  45. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/utils/__init__.py +0 -0
  46. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/utils/etag.py +0 -0
  47. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/utils/params.py +0 -0
  48. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v1/view.py +0 -0
  49. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v2/__init__.py +0 -0
  50. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v2/case.py +0 -0
  51. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v2/fuzzy.py +0 -0
  52. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v2/ingest.py +0 -0
  53. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/api/v2/search.py +0 -0
  54. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/app.py +0 -0
  55. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/common/README.md +0 -0
  56. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/common/__init__.py +0 -0
  57. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/common/classification.py +0 -0
  58. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/common/classification.yml +0 -0
  59. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/common/exceptions.py +0 -0
  60. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/common/loader.py +0 -0
  61. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/common/logging/__init__.py +0 -0
  62. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/common/logging/audit.py +0 -0
  63. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/common/logging/format.py +0 -0
  64. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/common/net.py +0 -0
  65. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/common/net_static.py +0 -0
  66. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/common/random_user.py +0 -0
  67. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/common/swagger.py +0 -0
  68. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/config.py +0 -0
  69. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/cronjobs/__init__.py +0 -0
  70. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/cronjobs/action_queue_worker.py +0 -0
  71. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/cronjobs/correlation.py +0 -0
  72. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/cronjobs/retention.py +0 -0
  73. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/cronjobs/view_cleanup.py +0 -0
  74. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/README.md +0 -0
  75. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/__init__.py +0 -0
  76. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/bulk.py +0 -0
  77. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/collection.py +0 -0
  78. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/constants.py +0 -0
  79. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/exceptions.py +0 -0
  80. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/howler_store.py +0 -0
  81. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/migrations/__init__.py +0 -0
  82. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/migrations/action_owner.py +0 -0
  83. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/migrations/base.py +0 -0
  84. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/migrations/fix_process.py +0 -0
  85. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/migrations/runner.py +0 -0
  86. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/operations.py +0 -0
  87. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/schemas.py +0 -0
  88. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/store.py +0 -0
  89. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/support/__init__.py +0 -0
  90. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/support/build.py +0 -0
  91. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/support/schemas.py +0 -0
  92. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/types.py +0 -0
  93. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/datastore/utils.py +0 -0
  94. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/error.py +0 -0
  95. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/external/README.md +0 -0
  96. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/external/__init__.py +0 -0
  97. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/external/check_duplicates.py +0 -0
  98. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/external/generate_mitre.py +0 -0
  99. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/external/generate_sigma_rules.py +0 -0
  100. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/external/generate_tlds.py +0 -0
  101. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/external/reindex_data.py +0 -0
  102. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/external/run_migrations.py +0 -0
  103. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/external/wipe_databases.py +0 -0
  104. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/gunicorn_config.py +0 -0
  105. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/healthz.py +0 -0
  106. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/helper/__init__.py +0 -0
  107. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/helper/azure.py +0 -0
  108. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/helper/discover.py +0 -0
  109. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/helper/hit.py +0 -0
  110. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/helper/oauth.py +0 -0
  111. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/helper/search.py +0 -0
  112. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/helper/workflow.py +0 -0
  113. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/helper/ws.py +0 -0
  114. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/README.md +0 -0
  115. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/__init__.py +0 -0
  116. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/base.py +0 -0
  117. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/charter.txt +0 -0
  118. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/constants.py +0 -0
  119. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/helper.py +0 -0
  120. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/howler_enum.py +0 -0
  121. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/mixins.py +0 -0
  122. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/__init__.py +0 -0
  123. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/action.py +0 -0
  124. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/analytic.py +0 -0
  125. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/assemblyline.py +0 -0
  126. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/aws.py +0 -0
  127. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/azure.py +0 -0
  128. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/case.py +0 -0
  129. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/cbs.py +0 -0
  130. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/clue.py +0 -0
  131. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/config.py +0 -0
  132. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/dossier.py +0 -0
  133. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/__init__.py +0 -0
  134. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/agent.py +0 -0
  135. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/autonomous_system.py +0 -0
  136. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/client.py +0 -0
  137. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/cloud.py +0 -0
  138. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/code_signature.py +0 -0
  139. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/container.py +0 -0
  140. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/dns.py +0 -0
  141. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/egress.py +0 -0
  142. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/elf.py +0 -0
  143. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/email.py +0 -0
  144. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/error.py +0 -0
  145. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/event.py +0 -0
  146. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/faas.py +0 -0
  147. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/file.py +0 -0
  148. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/geo.py +0 -0
  149. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/group.py +0 -0
  150. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/hash.py +0 -0
  151. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/host.py +0 -0
  152. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/http.py +0 -0
  153. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/ingress.py +0 -0
  154. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/interface.py +0 -0
  155. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/network.py +0 -0
  156. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/observer.py +0 -0
  157. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/organization.py +0 -0
  158. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/os.py +0 -0
  159. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/pe.py +0 -0
  160. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/process.py +0 -0
  161. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/registry.py +0 -0
  162. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/related.py +0 -0
  163. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/rule.py +0 -0
  164. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/server.py +0 -0
  165. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/threat.py +0 -0
  166. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/tls.py +0 -0
  167. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/url.py +0 -0
  168. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/user.py +0 -0
  169. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/user_agent.py +0 -0
  170. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ecs/vulnerability.py +0 -0
  171. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/gcp.py +0 -0
  172. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/hit.py +0 -0
  173. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/lead.py +0 -0
  174. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/localized_label.py +0 -0
  175. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/migration.py +0 -0
  176. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/overview.py +0 -0
  177. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/ownership.py +0 -0
  178. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/pivot.py +0 -0
  179. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/record.py +0 -0
  180. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/template.py +0 -0
  181. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/user.py +0 -0
  182. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/models/view.py +0 -0
  183. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/random_data.py +0 -0
  184. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/odm/randomizer.py +0 -0
  185. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/patched.py +0 -0
  186. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/plugins/__init__.py +0 -0
  187. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/plugins/config.py +0 -0
  188. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/__init__.py +0 -0
  189. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/datatypes/README.md +0 -0
  190. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/datatypes/__init__.py +0 -0
  191. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/datatypes/counters.py +0 -0
  192. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/datatypes/events.py +0 -0
  193. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/datatypes/hash.py +0 -0
  194. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/datatypes/lock.py +0 -0
  195. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/datatypes/queues/__init__.py +0 -0
  196. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/datatypes/queues/comms.py +0 -0
  197. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/datatypes/queues/multi.py +0 -0
  198. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/datatypes/queues/named.py +0 -0
  199. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/datatypes/queues/priority.py +0 -0
  200. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/datatypes/set.py +0 -0
  201. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/remote/datatypes/user_quota_tracker.py +0 -0
  202. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/security/__init__.py +0 -0
  203. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/security/login.py +0 -0
  204. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/security/socket.py +0 -0
  205. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/security/utils.py +0 -0
  206. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/__init__.py +0 -0
  207. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/action_service.py +0 -0
  208. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/analytic_service.py +0 -0
  209. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/auth_service.py +0 -0
  210. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/bundle_compat_service.py +0 -0
  211. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/comms_service.py +0 -0
  212. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/config_service.py +0 -0
  213. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/correlation_service.py +0 -0
  214. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/docs_service.py +0 -0
  215. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/dossier_service.py +0 -0
  216. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/event_service.py +0 -0
  217. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/fuzzy_service.py +0 -0
  218. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/jwt_service.py +0 -0
  219. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/lucene_service.py +0 -0
  220. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/notebook_service.py +0 -0
  221. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/overview_service.py +0 -0
  222. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/search_service.py +0 -0
  223. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/template_service.py +0 -0
  224. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/user_service.py +0 -0
  225. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/services/viewer_service.py +0 -0
  226. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/telemetry.py +0 -0
  227. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/__init__.py +0 -0
  228. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/annotations.py +0 -0
  229. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/chunk.py +0 -0
  230. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/compat.py +0 -0
  231. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/constants.py +0 -0
  232. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/dict_utils.py +0 -0
  233. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/indexes.py +0 -0
  234. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/isotime.py +0 -0
  235. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/list_utils.py +0 -0
  236. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/lucene.py +0 -0
  237. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/net_utils.py +0 -0
  238. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/path.py +0 -0
  239. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/socket_utils.py +0 -0
  240. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/str_utils.py +0 -0
  241. {howler_api-4.1.0.dev1631 → howler_api-4.1.0.dev1643}/howler/utils/uid.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: howler-api
3
- Version: 4.1.0.dev1631
3
+ Version: 4.1.0.dev1643
4
4
  Summary: Howler - API server
5
5
  License: MIT
6
6
  Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs
@@ -27,7 +27,8 @@ from howler.datastore.exceptions import DataStoreException, VersionConflictExcep
27
27
  from howler.datastore.operations import OdmHelper, OdmUpdateOperation
28
28
  from howler.helper.workflow import WorkflowException
29
29
  from howler.odm.models.hit import Hit
30
- from howler.odm.models.howler_data import Comment, HitOperationType, HitStatusTransition
30
+ from howler.odm.models.howler_data import Comment, HitStatusTransition
31
+ from howler.odm.models.log import LogOperationType
31
32
  from howler.odm.models.user import User
32
33
  from howler.security.login import api_login
33
34
  from howler.security.utils import is_classification_accessible, validate_bulk_operation_targets
@@ -407,7 +408,7 @@ def update_hit(
407
408
  "explanation": f"Hit updated by {user.uname}\n\n" + "\n".join(explanation),
408
409
  "new_value": "N/A",
409
410
  "previous_value": "None",
410
- "type": HitOperationType.APPENDED,
411
+ "type": LogOperationType.APPENDED,
411
412
  "user": user.uname,
412
413
  },
413
414
  silent=True,
@@ -31,10 +31,12 @@ def add_access_control_endpoints(api: Blueprint, odm: type[Ownership]):
31
31
  refresh => ('true' | 'false' | 'wait_for') Whether to refresh the datastore before returning.
32
32
 
33
33
  Data Block:
34
- {
35
- "privilege": "members", # The permission level: 'owner', 'admins', or 'members'
36
- "user_ids": ["username"] # The users receiving the permission
37
- }
34
+ [
35
+ {
36
+ "privilege": "members", # The permission level: 'owner', 'admins', or 'members'
37
+ "user_id": "username" # The user receiving the permission
38
+ }
39
+ ]
38
40
 
39
41
  Result Example:
40
42
  {
@@ -42,7 +44,7 @@ def add_access_control_endpoints(api: Blueprint, odm: type[Ownership]):
42
44
  }
43
45
  """
44
46
  try:
45
- result = permission_service.give_privilege(id, user, odm, refresh=kwargs.get("refresh"))
47
+ result = permission_service.give_privileges(id, user, odm, refresh=kwargs.get("refresh"))
46
48
  except VersionConflictException:
47
49
  return conflict(err="Someone has updated this item. Please try again")
48
50
  except ForbiddenException as e:
@@ -67,13 +69,21 @@ def add_access_control_endpoints(api: Blueprint, odm: type[Ownership]):
67
69
  Optional Arguments:
68
70
  refresh => ('true' | 'false' | 'wait_for') Whether to refresh the datastore before returning.
69
71
 
72
+ Data Block:
73
+ [
74
+ {
75
+ "privilege": "members", # The permission level: 'admins' or 'members'
76
+ "user_id": "username" # The user losing the permission
77
+ }
78
+ ]
79
+
70
80
  Result Example:
71
81
  {
72
82
  ...object # The updated action, dossier, or view
73
83
  }
74
84
  """
75
85
  try:
76
- result = permission_service.remove_privilege(id, user, odm, refresh=kwargs.get("refresh"))
86
+ result = permission_service.remove_privileges(id, user, odm, refresh=kwargs.get("refresh"))
77
87
  except VersionConflictException:
78
88
  return conflict(err="Someone has updated this item. Please try again")
79
89
  except ForbiddenException as e:
@@ -1,10 +1,10 @@
1
1
  # mypy: ignore-errors
2
2
 
3
3
  from howler import odm
4
- from howler.common.exceptions import HowlerValueError
5
4
  from howler.common.logging import get_logger
6
5
  from howler.odm.howler_enum import HowlerEnum
7
6
  from howler.odm.mixins import DatastoreMixin
7
+ from howler.odm.models.log import Log
8
8
  from howler.odm.models.record import Record
9
9
 
10
10
  logger = get_logger(__file__)
@@ -30,26 +30,6 @@ class Comment(odm.Model):
30
30
  )
31
31
 
32
32
 
33
- @odm.model(index=True, store=True, description="Log definition.")
34
- class Log(odm.Model):
35
- timestamp = odm.Date(description="Timestamp at which the Log event took place.")
36
- key = odm.Optional(odm.Keyword(description="The key whose value changed."))
37
- explanation = odm.Optional(odm.Text(description="A manual description of the changes made."))
38
- new_value = odm.Optional(odm.Keyword(description="The value the key is changing to."))
39
- previous_value = odm.Optional(odm.Keyword(description="The value the key is changing from."))
40
- user = odm.Keyword(description="User ID who created the log event.")
41
-
42
- def __init__(self, data: dict = None, *args, **kwargs):
43
- if "explanation" not in data:
44
- required_keys = {"key", "new_value", "previous_value"}
45
- if required_keys.intersection(set(data.keys())) != required_keys:
46
- raise HowlerValueError(
47
- f"If no explanation provided, you must provide the following values: {','.join(required_keys)}"
48
- )
49
-
50
- super().__init__(data, *args, **kwargs)
51
-
52
-
53
33
  DEFAULT_LABELS = {"assignments": [], "generic": []}
54
34
 
55
35
 
@@ -3,10 +3,10 @@ from datetime import datetime
3
3
  from typing import Optional
4
4
 
5
5
  from howler import odm
6
- from howler.common.exceptions import HowlerValueError
7
6
  from howler.odm.constants import Status
8
7
  from howler.odm.howler_enum import HowlerEnum
9
8
  from howler.odm.models.lead import Lead
9
+ from howler.odm.models.log import Log
10
10
 
11
11
 
12
12
  class Scrutiny(str, HowlerEnum):
@@ -31,12 +31,6 @@ class HitStatusTransition(str, HowlerEnum):
31
31
  DEMOTE = "demote"
32
32
 
33
33
 
34
- class HitOperationType(str, HowlerEnum):
35
- APPENDED = "appended"
36
- REMOVED = "removed"
37
- SET = "set"
38
-
39
-
40
34
  class Escalation(str, HowlerEnum):
41
35
  MISS = "miss"
42
36
  HIT = "hit"
@@ -107,28 +101,6 @@ class Comment(odm.Model):
107
101
  )
108
102
 
109
103
 
110
- @odm.model(index=True, store=True, description="Log definition.")
111
- class Log(odm.Model):
112
- timestamp = odm.Date(description="Timestamp at which the Log event took place.")
113
- key = odm.Optional(odm.Keyword(description="The key whose value changed."))
114
- explanation = odm.Optional(odm.Text(description="A manual description of the changes made."))
115
- previous_version = odm.Optional(odm.Keyword(description="The version this action was applied to."))
116
- new_value = odm.Optional(odm.Keyword(description="The value the key is changing to."))
117
- type = odm.Optional(odm.Enum(values=HitOperationType, description="The operation performed on the value."))
118
- previous_value = odm.Optional(odm.Keyword(description="The value the key is changing from."))
119
- user = odm.Keyword(description="User ID who created the log event.")
120
-
121
- def __init__(self, data: dict = None, *args, **kwargs):
122
- if "explanation" not in data:
123
- required_keys = {"key", "new_value", "type", "previous_value"}
124
- if required_keys.intersection(set(data.keys())) != required_keys:
125
- raise HowlerValueError(
126
- f"If no explanation provided, you must provide the following values: {','.join(required_keys)}"
127
- )
128
-
129
- super().__init__(data, *args, **kwargs)
130
-
131
-
132
104
  @odm.model(index=True, store=True, description="Hit outline header.")
133
105
  class Header(odm.Model):
134
106
  threat: str | None = odm.Optional(odm.Keyword(description="The IP of the threat."))
@@ -0,0 +1,31 @@
1
+ from howler import odm
2
+ from howler.common.exceptions import HowlerValueError
3
+ from howler.odm.howler_enum import HowlerEnum
4
+
5
+
6
+ class LogOperationType(str, HowlerEnum):
7
+ APPENDED = "appended"
8
+ REMOVED = "removed"
9
+ SET = "set"
10
+
11
+
12
+ @odm.model(index=True, store=True, description="Log definition.") # noqa: F821
13
+ class Log(odm.Model):
14
+ timestamp = odm.Date(description="Timestamp at which the Log event took place.")
15
+ key = odm.Optional(odm.Keyword(description="The key whose value changed."))
16
+ explanation = odm.Optional(odm.Text(description="A manual description of the changes made."))
17
+ previous_version = odm.Optional(odm.Keyword(description="The version this action was applied to."))
18
+ new_value = odm.Optional(odm.Keyword(description="The value the key is changing to."))
19
+ type = odm.Optional(odm.Enum(values=LogOperationType, description="The operation performed on the value."))
20
+ previous_value = odm.Optional(odm.Keyword(description="The value the key is changing from."))
21
+ user = odm.Keyword(description="User ID who created the log event.")
22
+
23
+ def __init__(self, data: dict = None, *args, **kwargs):
24
+ if "explanation" not in data:
25
+ required_keys = {"key", "new_value", "previous_value"}
26
+ if required_keys.intersection(set(data.keys())) != required_keys:
27
+ raise HowlerValueError(
28
+ f"If no explanation provided, you must provide the following values: {','.join(required_keys)}"
29
+ )
30
+
31
+ super().__init__(data, *args, **kwargs)
@@ -0,0 +1,12 @@
1
+ from typing import Literal
2
+
3
+ from howler import odm
4
+
5
+
6
+ @odm.model(index=False, store=False, description="A permission entry for ownership permission updates")
7
+ class PermissionRequest(odm.Model):
8
+ privilege: Literal["admins", "members", "owner"] = odm.Enum(
9
+ values=["admins", "members", "owner"],
10
+ description="The permission level to update",
11
+ )
12
+ user_id: str = odm.Keyword(description="The user ID to grant or revoke for the selected privilege.")
@@ -26,6 +26,7 @@ from howler.odm.models.case import Case, CaseItem, CaseItemTypes, CaseLog, CaseR
26
26
  from howler.odm.models.ecs.related import Related
27
27
  from howler.odm.models.event import Event
28
28
  from howler.odm.models.hit import Hit
29
+ from howler.odm.models.log import Log
29
30
  from howler.odm.models.user import User
30
31
  from howler.security.utils import is_classification_accessible
31
32
  from howler.services import comms_service, event_service, hit_service
@@ -788,7 +789,7 @@ def remove_case_items( # noqa: C901
788
789
  case.items = [item for item in case.items if item.id not in ids_to_remove]
789
790
 
790
791
  for backing_obj, backing_obj_version in backing_objs:
791
- remove_backreference(backing_obj, case.case_id)
792
+ remove_backreference(backing_obj, case.case_id, user=user)
792
793
  backing_obj.save(version=backing_obj_version)
793
794
 
794
795
  recompute_case_metadata(case)
@@ -845,7 +846,7 @@ def append_hit(
845
846
 
846
847
  case.items.append(item)
847
848
 
848
- add_backreference(hit, case.case_id)
849
+ add_backreference(hit, case.case_id, user=user)
849
850
  hit.save(version=hit_version)
850
851
 
851
852
  recompute_case_metadata(case)
@@ -889,7 +890,7 @@ def append_event(
889
890
 
890
891
  case.items.append(item)
891
892
 
892
- add_backreference(event, case.case_id)
893
+ add_backreference(event, case.case_id, user=user)
893
894
  event.save(version=event_version)
894
895
 
895
896
  recompute_case_metadata(case)
@@ -996,7 +997,11 @@ def recompute_case_metadata(case: Case) -> None: # noqa: C901
996
997
  case.indicators = sorted(indicators)
997
998
 
998
999
 
999
- def add_backreference(backing_obj: Hit | Event | None, case_id: str) -> bool:
1000
+ def add_backreference(
1001
+ backing_obj: Hit | Event | None,
1002
+ case_id: str,
1003
+ user: User | None = None,
1004
+ ) -> bool:
1000
1005
  """Add a back-reference from a hit or event to a case, in memory only.
1001
1006
 
1002
1007
  Records the case ID in the backing object's ``howler.related`` list so
@@ -1023,12 +1028,23 @@ def add_backreference(backing_obj: Hit | Event | None, case_id: str) -> bool:
1023
1028
  return False
1024
1029
 
1025
1030
  backing_obj.howler.related.append(case_id)
1031
+ backing_obj.howler.log.append(
1032
+ Log(
1033
+ {
1034
+ "timestamp": "NOW",
1035
+ "explanation": f"Added to case {case_id}",
1036
+ "user": user.uname if user else "system",
1037
+ }
1038
+ )
1039
+ )
1040
+
1026
1041
  return True
1027
1042
 
1028
1043
 
1029
1044
  def remove_backreference(
1030
1045
  backing_obj: Hit | Event | None,
1031
1046
  case_id: str,
1047
+ user: User | None = None,
1032
1048
  ):
1033
1049
  """Remove a back-reference from a hit or event to a case, in memory only.
1034
1050
 
@@ -1052,6 +1068,16 @@ def remove_backreference(
1052
1068
  if case_id in backing_obj.howler.related:
1053
1069
  backing_obj.howler.related.remove(case_id)
1054
1070
 
1071
+ backing_obj.howler.log.append(
1072
+ Log(
1073
+ {
1074
+ "timestamp": "NOW",
1075
+ "explanation": f"Removed from case {case_id}",
1076
+ "user": user.uname if user else "system",
1077
+ }
1078
+ )
1079
+ )
1080
+
1055
1081
 
1056
1082
  def rename_case_item(
1057
1083
  case: str | Case | None,
@@ -29,7 +29,8 @@ from howler.helper.hit import (
29
29
  from howler.helper.workflow import Transition, Workflow
30
30
  from howler.odm.models.ecs.event import ECSEvent
31
31
  from howler.odm.models.hit import Hit
32
- from howler.odm.models.howler_data import HitOperationType, HitStatusTransition, Log, Status
32
+ from howler.odm.models.howler_data import HitStatusTransition, Status
33
+ from howler.odm.models.log import Log, LogOperationType
33
34
  from howler.odm.models.user import User
34
35
  from howler.security.utils import is_classification_accessible
35
36
  from howler.services import action_service, analytic_service, dossier_service, overview_service, template_service
@@ -625,16 +626,16 @@ def _update_hit(
625
626
 
626
627
  if is_list:
627
628
  operation_type = (
628
- HitOperationType.APPENDED
629
+ LogOperationType.APPENDED
629
630
  if operation.operation
630
631
  in (
631
632
  ESCollection.UPDATE_APPEND,
632
633
  ESCollection.UPDATE_APPEND_IF_MISSING,
633
634
  )
634
- else HitOperationType.REMOVED
635
+ else LogOperationType.REMOVED
635
636
  )
636
637
  else:
637
- operation_type = HitOperationType.SET
638
+ operation_type = LogOperationType.SET
638
639
 
639
640
  logger.debug("%s - %s - %s -> %s", hit_id, operation.key, previous_value, operation.value)
640
641
  final_operations.append(operation)
@@ -0,0 +1,152 @@
1
+ from collections.abc import Sequence
2
+ from typing import TYPE_CHECKING, Any, Literal, Protocol, cast
3
+
4
+ from flask import request
5
+
6
+ from howler.common.exceptions import ForbiddenException, HowlerTypeError, InvalidDataException
7
+ from howler.common.loader import datastore
8
+ from howler.odm.models.ownership import Ownership
9
+ from howler.odm.models.permission_request import PermissionRequest
10
+ from howler.odm.models.user import User
11
+
12
+ if TYPE_CHECKING:
13
+ from howler.datastore.collection import ESCollection
14
+
15
+
16
+ class _VisibilityItem(Protocol):
17
+ @property
18
+ def owner(self) -> str: ...
19
+
20
+ @property
21
+ def type(self) -> str: ...
22
+
23
+ @property
24
+ def admins(self) -> Sequence[str]: ...
25
+
26
+ @property
27
+ def members(self) -> Sequence[str]: ...
28
+
29
+
30
+ def _is_allowed_to_change(level_requested: str, user: User, existing_item: Ownership) -> bool:
31
+ if "admin" in user.type:
32
+ return True
33
+
34
+ if user.uname not in existing_item.admins and user.uname != existing_item.owner:
35
+ return False
36
+
37
+ return level_requested != "owner" or user.uname == existing_item.owner
38
+
39
+
40
+ def _build_permissions_request() -> list[PermissionRequest]:
41
+ payload = cast(list[dict[str, Any]], request.json)
42
+ if not isinstance(payload, list):
43
+ raise InvalidDataException("Request body must be a JSON array.")
44
+ if not payload:
45
+ raise InvalidDataException("Request body must contain at least one permission.")
46
+
47
+ try:
48
+ permission_requests = [PermissionRequest(entry) for entry in payload]
49
+ except (TypeError, ValueError, HowlerTypeError) as e:
50
+ raise InvalidDataException(message=str(e))
51
+
52
+ user_ids = [permission_request.user_id for permission_request in permission_requests]
53
+ if any(not user_id for user_id in user_ids):
54
+ raise InvalidDataException("user_id must contain a user.")
55
+ if len(user_ids) != len(set(user_ids)):
56
+ raise InvalidDataException("Each user can only be included once per request.")
57
+
58
+ return permission_requests
59
+
60
+
61
+ def give_privileges(
62
+ id: str,
63
+ user: User,
64
+ object_type: type[Ownership],
65
+ refresh: Literal["true", "false", "wait_for"] | None = None,
66
+ ) -> dict[str, Any]:
67
+ """Grant privileges to users on an ownership object."""
68
+ permission_requests = _build_permissions_request()
69
+
70
+ storage = datastore()
71
+ index_name = object_type.__name__.lower()
72
+ collection: "ESCollection[Ownership]" = storage[index_name]
73
+
74
+ result, version = collection.get(id, as_obj=True, version=True)
75
+ if not result:
76
+ raise InvalidDataException(message=f"{index_name.capitalize()} {id} does not exist")
77
+
78
+ owner_requests = [
79
+ permission_request for permission_request in permission_requests if permission_request.privilege == "owner"
80
+ ]
81
+ if len(owner_requests) > 1:
82
+ raise InvalidDataException("Only one owner can be set per request.")
83
+
84
+ for permission_request in permission_requests:
85
+ user_id = permission_request.user_id
86
+ if not _is_allowed_to_change(permission_request.privilege, user, result):
87
+ raise ForbiddenException("The user requesting the change is not allowed to make the change.")
88
+
89
+ if not storage.user.exists(user_id):
90
+ raise InvalidDataException(message=f"User {user_id} does not exist")
91
+
92
+ if permission_request.privilege != "owner" and user_id in result[permission_request.privilege]:
93
+ raise InvalidDataException(message=f"User {user_id} already has permission {permission_request.privilege}")
94
+
95
+ # Apply all changes only after the complete request has been validated.
96
+ for permission_request in permission_requests:
97
+ user_id = permission_request.user_id
98
+ if permission_request.privilege == "owner":
99
+ result.owner = user_id
100
+
101
+ for privilege in ("admins", "members"):
102
+ current_members = cast(list[str], result[privilege])
103
+ current_members[:] = [member_id for member_id in current_members if member_id != user_id]
104
+ else:
105
+ current_members = cast(list[str], result[permission_request.privilege])
106
+ other_privilege = "members" if permission_request.privilege == "admins" else "admins"
107
+ other_members = cast(list[str], result[other_privilege])
108
+
109
+ # Switching between non-owner privileges removes the previous privilege.
110
+ other_members[:] = [member_id for member_id in other_members if member_id != user_id]
111
+ current_members.append(user_id)
112
+
113
+ collection.save(id, result, version=version, refresh=refresh)
114
+ return result.as_primitives()
115
+
116
+
117
+ def remove_privileges( # noqa: C901
118
+ id: str,
119
+ user: User,
120
+ object_type: type[Ownership],
121
+ refresh: Literal["true", "false", "wait_for"] | None = None,
122
+ ) -> dict[str, Any]:
123
+ """Revoke privileges from users on an ownership object."""
124
+ permission_requests = _build_permissions_request()
125
+
126
+ storage = datastore()
127
+ index_name = object_type.__name__.lower()
128
+ collection: "ESCollection[Ownership]" = storage[index_name]
129
+
130
+ result, version = collection.get(id, as_obj=True, version=True)
131
+ if not result:
132
+ raise InvalidDataException(message=f"{index_name.capitalize()} {id} does not exist")
133
+
134
+ for permission_request in permission_requests:
135
+ if not _is_allowed_to_change(permission_request.privilege, user, result):
136
+ raise ForbiddenException("The user requesting the change is not allowed to make the change.")
137
+
138
+ if permission_request.privilege == "owner":
139
+ raise InvalidDataException(message="You cannot remove the owner privilege. Only transfer is allowed.")
140
+
141
+ user_id = permission_request.user_id
142
+ current_members = result.admins if permission_request.privilege == "admins" else result.members
143
+ if user_id not in current_members:
144
+ raise InvalidDataException(
145
+ message=f"The user '{user_id}' does not have the '{permission_request.privilege}' privilege."
146
+ )
147
+
148
+ for permission_request in permission_requests:
149
+ cast(list[str], result[permission_request.privilege]).remove(permission_request.user_id)
150
+
151
+ collection.save(id, result, version=version, refresh=refresh)
152
+ return result.as_primitives()
@@ -244,7 +244,7 @@ suppress-none-returning = true
244
244
  [tool.poetry]
245
245
  package-mode = true
246
246
  name = "howler-api"
247
- version = "4.1.0.dev1631"
247
+ version = "4.1.0.dev1643"
248
248
  description = "Howler - API server"
249
249
  authors = [
250
250
  "Canadian Centre for Cyber Security <howler@cyber.gc.ca>",
@@ -1,17 +0,0 @@
1
- from typing import Literal
2
-
3
- from howler import odm
4
-
5
-
6
- @odm.model(index=False, store=False, description="Request payload for ownership permission updates")
7
- class PermissionRequest(odm.Model):
8
- privilege: Literal["admins", "members", "owner"] = odm.Enum(
9
- values=["admins", "members", "owner"],
10
- description="The permission level to update",
11
- )
12
- user_ids: list[str] = odm.List(
13
- odm.Keyword(),
14
- description="The list of user IDs to grant or revoke for the selected privilege.",
15
- default=[],
16
- optional=False,
17
- )
@@ -1,150 +0,0 @@
1
- from collections.abc import Sequence
2
- from typing import TYPE_CHECKING, Any, Literal, Protocol, cast
3
-
4
- from flask import request
5
-
6
- from howler.common.exceptions import ForbiddenException, HowlerTypeError, InvalidDataException
7
- from howler.common.loader import datastore
8
- from howler.odm.models.ownership import Ownership
9
- from howler.odm.models.permission_request import PermissionRequest
10
- from howler.odm.models.user import User
11
-
12
- if TYPE_CHECKING:
13
- from howler.datastore.collection import ESCollection
14
-
15
-
16
- class _VisibilityItem(Protocol):
17
- @property
18
- def owner(self) -> str: ...
19
-
20
- @property
21
- def type(self) -> str: ...
22
-
23
- @property
24
- def admins(self) -> Sequence[str]: ...
25
-
26
- @property
27
- def members(self) -> Sequence[str]: ...
28
-
29
-
30
- def _is_allowed_to_change(level_requested: str, user: User, existing_item: Ownership) -> bool:
31
- if "admin" in user.type:
32
- return True
33
-
34
- if user.uname not in existing_item.admins and user.uname != existing_item.owner:
35
- return False
36
-
37
- return level_requested != "owner" or user.uname == existing_item.owner
38
-
39
-
40
- def _build_permissions_request() -> PermissionRequest:
41
- payload = cast(dict[str, Any], request.json)
42
- if not isinstance(payload, dict):
43
- raise InvalidDataException("Request body must be a JSON object.")
44
-
45
- try:
46
- permission_request = PermissionRequest(payload)
47
- except (ValueError, HowlerTypeError) as e:
48
- raise InvalidDataException(message=str(e))
49
-
50
- if not permission_request.user_ids:
51
- raise InvalidDataException("user_ids must contain at least one user.")
52
-
53
- return permission_request
54
-
55
-
56
- def give_privilege(
57
- id: str,
58
- user: User,
59
- object_type: type[Ownership],
60
- refresh: Literal["true", "false", "wait_for"] | None = None,
61
- ) -> dict[str, Any]:
62
- """Grant a privilege to one or more users on an ownership object."""
63
- permission_request = _build_permissions_request()
64
- user_ids = list(dict.fromkeys(permission_request.user_ids))
65
-
66
- storage = datastore()
67
- index_name = object_type.__name__.lower()
68
- collection: "ESCollection[Ownership]" = storage[index_name]
69
-
70
- result, version = collection.get(id, as_obj=True, version=True)
71
- if not result:
72
- raise InvalidDataException(message=f"{index_name.capitalize()} {id} does not exist")
73
-
74
- if not _is_allowed_to_change(permission_request.privilege, user, result):
75
- raise ForbiddenException("The user requesting the change is not allowed to make the change.")
76
-
77
- if permission_request.privilege == "owner" and len(user_ids) != 1:
78
- raise InvalidDataException("When setting the owner, user_ids must be a single entry long.")
79
-
80
- errors: list[str] = []
81
- for user_id in user_ids:
82
- if not storage.user.exists(user_id):
83
- errors.append(f"User {user_id} does not exist")
84
- continue
85
-
86
- if permission_request.privilege != "owner" and user_id in result[permission_request.privilege]:
87
- errors.append(f"User {user_id} already has permission {permission_request.privilege}")
88
-
89
- if errors:
90
- raise InvalidDataException(message=f"Failed to grant privileges for some users: {'; '.join(errors)}")
91
-
92
- if permission_request.privilege == "owner":
93
- new_owner = user_ids[0]
94
- result.owner = new_owner
95
-
96
- # Ownership supersedes any non-owner privilege held by the new owner.
97
- for privilege in ("admins", "members"):
98
- current_members = cast(list[str], result[privilege])
99
- current_members[:] = [user_id for user_id in current_members if user_id != new_owner]
100
- else:
101
- current_members = cast(list[str], result[permission_request.privilege])
102
- other_privilege = "members" if permission_request.privilege == "admins" else "admins"
103
- other_members = cast(list[str], result[other_privilege])
104
-
105
- # Switching between non-owner privileges removes the previous privilege.
106
- other_members[:] = [user_id for user_id in other_members if user_id not in user_ids]
107
- current_members.extend(user_ids)
108
-
109
- collection.save(id, result, version=version, refresh=refresh)
110
- return result.as_primitives()
111
-
112
-
113
- def remove_privilege( # noqa: C901
114
- id: str,
115
- user: User,
116
- object_type: type[Ownership],
117
- refresh: Literal["true", "false", "wait_for"] | None = None,
118
- ) -> dict[str, Any]:
119
- """Revoke a privilege from one or more users on an ownership object."""
120
- permission_request = _build_permissions_request()
121
- user_ids = list(dict.fromkeys(permission_request.user_ids))
122
-
123
- storage = datastore()
124
- index_name = object_type.__name__.lower()
125
- collection: "ESCollection[Ownership]" = storage[index_name]
126
-
127
- result, version = collection.get(id, as_obj=True, version=True)
128
- if not result:
129
- raise InvalidDataException(message=f"{index_name.capitalize()} {id} does not exist")
130
-
131
- if not _is_allowed_to_change(permission_request.privilege, user, result):
132
- raise ForbiddenException("The user requesting the change is not allowed to make the change.")
133
-
134
- if permission_request.privilege == "owner":
135
- raise InvalidDataException(message="You cannot remove the owner privilege. Only transfer is allowed.")
136
-
137
- errors: list[str] = []
138
- current_members = result.admins if permission_request.privilege == "admins" else result.members
139
- for user_id in user_ids:
140
- if user_id not in current_members:
141
- errors.append(f"The user '{user_id}' does not have the '{permission_request.privilege}' privilege.")
142
-
143
- if errors:
144
- raise InvalidDataException(message=f"Failed to revoke privileges for some users: {'; '.join(errors)}")
145
-
146
- for user_id in user_ids:
147
- cast(list[str], result[permission_request.privilege]).remove(user_id)
148
-
149
- collection.save(id, result, version=version, refresh=refresh)
150
- return result.as_primitives()