Skip to content

Latest commit

 

History

History
147 lines (88 loc) · 6.15 KB

CONTRIBUTING.md

File metadata and controls

147 lines (88 loc) · 6.15 KB
Raw

Contributing to EasyEASM

Thank you for your interest in contributing to EasyEASM! We welcome contributions from the community to help improve and grow this project. Before you get started, please read and follow the guidelines outlined in this document.

Table of Contents

How to Contribute

If you would like to contribute to EasyEASM, here are some ways you can help:

  • Reporting Bugs
  • Requesting (and developing!) Features
  • Code Contributions

Help Wanted

Here are some features and improvements to enhance EasyEASM.

    • Custom scan profiles
    • Allow users to define custom scan profiles with specific configurations, such as different wordlists, thread counts, or scan types, and select them at runtime.

  • Interactive mode

    • Develop an interactive mode with a menu-driven interface that guides users through scan configuration and execution.

  • Rate limiting and throttling

    • Implement rate limiting and request throttling to avoid excessive traffic to target domains and prevent getting blocked or banned.

  • Result export formats

    • Support for exporting scan results in various formats, such as JSON, XML, or HTML, for easier analysis and reporting.

  • Error handling and logging

    • Improve error handling to gracefully handle failures and provide more informative error messages. Implement comprehensive logging to keep track of scan activities.

  • Integration with Security Information and Event Management (SIEM) systems

    • Allow the program to integrate with SIEM systems, making it easier to correlate scan data with other security events.

  • Graphical user interface (GUI)

    • Create a graphical user interface (GUI) for the program to make it more accessible to users who prefer a visual interface over the command line.

  • Scheduled scans

    • Add the ability to schedule scans to run at specific intervals, ensuring continuous monitoring of subdomains.

  • Credential testing

    • Include the option to perform credential testing against discovered subdomains to check for unauthorized access.

  • Subdomain tagging and categorization

    • Allow users to tag and categorize discovered subdomains for better organization and analysis.

  • Integration with vulnerability scanners

    • Enable integration with vulnerability scanning tools to automatically identify and assess vulnerabilities on discovered subdomains.

  • Multithreading and parallelism

    • Optimize the program to utilize multithreading and parallelism effectively, improving scan performance.

  • Support for Internationalized Domain Names (IDNs)

    • Extend the program to handle internationalized domain names, allowing for scanning of domains with non-ASCII characters.

  • Integration with external threat intelligence feeds

    • Integrate with external threat intelligence feeds to enrich subdomain information and identify potential threats.

  • Advanced reporting and visualization

    • Provide advanced reporting and visualization features, including graphs, charts, and statistics on scan results.

  • Auto-updating

    • Implement an auto-updating mechanism to keep the program and its dependencies up to date.

  • User profiles and authentication

    • Allow users to create profiles with authentication credentials for accessing protected subdomains.

  • Distributed scanning

    • Enable distributed scanning across multiple machines for larger-scale subdomain discovery.

  • Scripting and automation

    • Provide a scripting interface (e.g., via APIs) for programmatic control and automation of scans.

  • Cross-platform support

    • Ensure the program is compatible with different operating systems, specifically Windows.

Reporting Bugs

If you encounter a bug or problem with EasyEASM, please follow these steps:

  1. Check if the bug has already been reported in the Issues section.

  2. If it's a new issue, create a detailed bug report by opening a new issue.

  3. Include information about your environment, steps to reproduce the bug, and any relevant error messages.

Requesting Features

If you have a feature request, please follow these steps:

  1. Check if the feature has already been requested in the Issues section.

  2. If it's a new request, create a detailed feature request by opening a new issue.

  3. Describe the feature you'd like to see and explain why it would be valuable.

Code Contributions

If you want to contribute code to EasyEASM, please follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone your fork to your local development environment.

  3. Create a new branch for your feature or bug fix.

  4. Make your changes, following the code style and guidelines mentioned below.

  5. Test your changes thoroughly.

  6. Create a pull request to the main branch of this repository, explaining the purpose and details of your changes.

Issue and Pull Request Process

  • All contributions are welcome, but please be patient as we review and provide feedback on your submissions.

  • Pull requests will be reviewed, and we may request changes or suggest improvements.

  • Before your pull request is merged, make sure all tests pass, and there are no merge conflicts.

License

By contributing to EasyEASM, you agree that your contributions will be licensed under the License of this project.

Thank you for helping to improve EasyEASM!