mushorg
GSoC 2021
Here is the short guide for upcoming GSoC 2021
Slack: gsoc-slack.honeynet.org Mentor: @afeena Backup mentor: @mzfr @glaslos
How do I start?
- Join our GSoC channel #2021-snare
- Follow the quick-start and run the code
- Play with the tool! Try different stuff/attacks/crawlers
- Found a bug? → Create an issue
- Go through existing issue to get the idea of the project problems and try to think about solution
- Do you know how to fix something? Great! → SUBMIT A PULL REQUEST
What should I know to successfully participate?
- Python3. You should really know it.
- Git. https://try.github.io/
- InfoSec: you can start with The Honeynet Project https://www.honeynet.org/papers/ or look up
- OWASP materials https://owasp.org/www-project-cheat-sheets/
- Network monitoring. Install Wireshark and explore
- Know the better materials for infosec? Comment!
How to write proposal/which tasks should I include?
Tasks
There are some tasks which we really want to be finished during this summer (list by priority). I expect that these tasks will take most of the time:
- Cloner improvements
- Regarding cloner: Ideally, it should be re-written completely, as a result, also storing and serving web-pages will be changed. So it’s a really big task, which should be decomposed properly. And it should have some pre-work done (research, etc). The current system doesn’t support websites with client-side rendering, so we should think about using headless-browser
- #215
- Upgrade the SNARE codebase to be compatible with the latest aiohttp version
Other tasks are optional and we are really open, so if you have some great features in mind - don't hesitate to add it
Proposal
- Use template from previous years https://docs.google.com/document/d/18abX5l4HN5v37QAh5SKgHtlXhhINKEte49hmqzwE2mM/edit?usp=sharing
- Time estimation is key: try to fairly estimate time for each task. Remember: it's better to be ahead of the schedule than behind.
- You can also lookup the GSoC submission results from previous years here https://github.com/mushorg/tanner/wiki
- If you want to get feedback, we kindly ask you to share your proposal with us as early as possible. Please understand that we will not be able to give you any feedback in a short time.
Is having a contribution in SNARE a prerequisite?
We don't have strong requirements on contribution, but it will help us to evaluate your application. Take it as a possibility to show your coding skills. Contributions are not only pull requests, but you can also submit a bug or review other student's pull requests :)
Final notes
Something is not covered? comment here! Or: ping us in slack channel (please try to ask in our channel, your questions might be interesting for other students)
