Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added More Command Examples for New Users in nettacker.py #849

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ARYAN03B
Copy link

@ARYAN03B ARYAN03B commented Jun 14, 2024

Fixes #740

Checklist

  • I have followed the Contributor Guidelines.
  • The code has been thoroughly tested in my local development environment with flake8 and pylint.
  • The code is Python 3 compatible.
  • The code follows the PEP8 styling guidelines with 4 spaces indentation.
  • This Pull Request relates to only one issue or only one feature
  • I have referenced the corresponding issue number in my commit message
  • I have added the relevant documentation.
  • My branch is up-to-date with the Upstream master branch.

Changes proposed in this pull request

In your Python code (nettacker.py), consider adding more command examples. This helps new users who may find it difficult to create the right commands when they use your code for the first time. It makes it easier for them to write the correct code.

Like that:-

nettacker -L en -v -o results.txt -i target.com -m ftp_brute,ssh_brute -u admin -P passwords.txt -g 21,22 --start-api --api-host 0.0.0.0 --api-port 5000

Fixes OWASP#740

Signed-off-by: ARYAN03B <115079796+ARYAN03B@users.noreply.github.com>
@securestep9 securestep9 self-assigned this Jul 29, 2024
@securestep9
Copy link
Collaborator

There is a major code refactoring ongoing right now with additional work done as part of Google Summer of Code 2024. We will include your suggestions once the new version of Nettacker with refactored codebase is released at the end of August

Copy link
Collaborator

@arkid15r arkid15r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this better fits -h menu section. @securestep9 what's you opinion on this?

load() # load and parse the ARGV
# Example commands to demonstrate OWASP Nettacker functionalities
example_commands = [
"-i target.com",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just FYI target.com is a real company web-site that may not appreciate to be a default example even in a pretty small audience penetration testing tool.

Copy link
Collaborator

@securestep9 securestep9 Sep 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arkid15r I will take care of this and add more info to --help and the new documentation. The examples in this PR are not 100% correct as they are using non-existing modules and switches, but I get the idea

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arkid15r I will take care of this and add more info to --help and the new documentation. The examples in this PR are not 1005 correct as they are using non-existing modules and switches, but I get the idea

Sounds good, thanks Sam!

@arkid15r arkid15r marked this pull request as draft September 10, 2024 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhancement: Provide More Command Examples for New Users
3 participants