mozilla / mig

Distributed & real time digital forensics at the speed of the cloud
http://mig.mozilla.org/
Mozilla Public License 2.0
1.21k stars 235 forks source link

Design a REST API to facilitate action dispatching and documentation retrieval #442

Closed arcrose closed 6 years ago

arcrose commented 6 years ago

The beginning of the development of our client daemon will start with the design of a REST API that supports the following use cases:

  1. [x] Retrieve daemon API documentation
  2. [x] Retrieve agent module documentation
  3. [x] Create an action, specifying the module to run and any required configuration
  4. [x] Dispatch a newly-created action to the MIG API
  5. [x] Retrieve information detailing the status of dispatched actions

Before the above can be completed, we will also need to:

  1. [x] Specify each module's configuration as a JSON structure
  2. [x] Design a JSON structure to describe agents to target
vbmade2000 commented 6 years ago

@zsck Are you working this ? If not I want to work on this issue.

arcrose commented 6 years ago

Hey @vbmade2000 I am working on this in the client-daemon branch. I'd love to welcome your help on this, though! Would you be willing to have a read through some of the documentation I've put together so far and offer feedback? I'd really like to make sure that the module configuration types I've specified are accurate and useful. Any improvements would be greatly appreciated!

vbmade2000 commented 6 years ago

@zsck Ok. I'll surely check documentation and get back to you if I would have any suggestion etc.