Skip to content

Latest commit

 

History

History
55 lines (49 loc) · 3.19 KB

README.md

File metadata and controls

55 lines (49 loc) · 3.19 KB
Raw

ldh-scanning-framework

Python scripts for scanning the LDH activity log, processing the results with a scanner to look for items of interest and post results back to an LDH notification log.

Instructions for use:

  • Copy ldh-config.json.dist to ldh-config.json
  • Place appropriate LDH access keys in ldh-config.json
  • Run main.py

Notes:

  • Default pagesize is 100 and is specified in ldh-config.json. The main script will continue to make requests for subsequent pages of results until all results are returned
  • Initial timestamp is set to 1667306718, which is the 1st November 2022. This can be changed in ldh-config.json
  • Once the process has run successfully, a status.json file will be created that stores the timestamp that the process last began to run. This is checked before the process is run again, so subsequent runs of the script will only look in the Activity Log for items that have been created since the last time the script was run
  • To force the process to start again from the beginning, simply delete status.json or remove the lastRun entry from the file.
  • status.json can also be used to store any other relevant state info that you wish to persist between job runs, simply add additional items to the status object before calling writeStatus()
  • By default, notifications are simply printed to the screen for debugging. To push notifications back to the LDH, uncomment the line response = ldh.pushNotification(notification) in the main loop.

Scanner class

This is a simple (parent) base class that lays out the structure and foundations of scanning JSON documents and building notification objects. Class inheritance should be used to build a child class that performs the specifics of the type of scanning you wish to perform, using your own implementations of the scanObject() and __buildNotification() functions.

The scanObject() function is called for each document. It is expected to return an array of notifications, built using the Scanner's private __buildNotification() function. __buildNotification() will need to be amended to build a notification with the appropriate structure. The scanObject() function loops through each key/value pair within the document. In its current form, it creates a separate notification for each matched key/value pair but this functionality may need to be changed depending on the type of scanning being done. For example, privacy scanning will likely scan through all key/value pairs and combine any positive results into a single notification that details these matches and includes an overall severity score.

Scanner's flattenObject() function will take a multidimensional nested object and flatten it, so it only has a single level of key/value pairs and can be iterated in a single loop without the need for recursion. This can (and should) be called from child object instances using super().flattenObject() iteration. The resulting object will have attribute names of the form attrib1/attrib2/attrib3 where the / character indicates multiple levels of nested data structure in the original scanned JSON document.

Currently, the Hate class shows an example of the class inheritance approach described above.