search

cuckoosandbox / community

Repository of modules and signatures contributed by the community
324 stars 175 forks source link

How to commit a cuckoo machinery module. #435

Open rajksbth opened 6 years ago

rajksbth commented 6 years ago

I have created one cuckoo machinery module for openstack and want to contribute it in community. There is one machinery module directory in community repo but where i should keep the conf file for that machinery module.

doomedraven commented 6 years ago

https://github.com/cuckoosandbox/cuckoo/blob/master/cuckoo/common/config.py

rajksbth commented 6 years ago

Thanks @doomedraven but the link you have provided is cuckoo repository and i want to contribute it in community repo. Another thing is that we need to keep one more file in $CWD/conf/ directory. There are three files.

  1. machinery module.
  2. conf file.
  3. machinery conf file that should be located in $CWD/conf dir.

How to commit it in community repo.

doomedraven commented 6 years ago

that doesn't work in that way, that goes to that config.py will generate updated correct config in $CWD/conf/

RicoVZ commented 6 years ago

Hey @rajksbth

Great to see you are contributing! :smile:

What @doomedraven says is correct. The configs are generated on CWD creation. For this, the templates stored in here are used: https://github.com/cuckoosandbox/cuckoo/tree/master/cuckoo/private/cwd/conf

https://github.com/cuckoosandbox/cuckoo/blob/master/cuckoo/private/cwd/conf/virtualbox.conf

These templates are filled with values from config.py, such as Virtualbox here: https://github.com/cuckoosandbox/cuckoo/blob/master/cuckoo/common/config.py#L262

You can create a new one in that folder for your machinery module. Then, if you want to share the module with the community, it is best to make a PR on the Cuckoo repository.