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.

Sign up for GitHub

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

Updated README.MD #3

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

Updated README.MD #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# PySploit Framework
free exploit framework written use python language version 3.3
Free exploit framework written use python language version 3.3
<br><br>
<img src="http://webscan.esy.es/pysploit.png">

Expand All @@ -8,12 +8,12 @@ free exploit framework written use python language version 3.3
* Free and open source
* Organizer
* Easy to develop it
* Programmed using on of the most popular programming language
* Programmed using one of the most popular programming language
* Unlimited possibilities to create
* Durable updates

# Getting Started
the framework not need many steps to install and start using just follow the next steps
The framework does not need many steps to install and start using just follow the next steps

## Platform

Expand All @@ -25,40 +25,40 @@ the requirement is:
* bs4
* python-tools
* python3.x
### Installing Requirement
### Installing requirements
#### installing bs4

easily you can install the whole requirement from requirement.txt file by execute this command:
Easily, you can install the whole requirements from requirement.txt file by executing this command:
```
sudo python3-pip install -r requirements.txt
```
#### installing python-tools

in debian and her children the package names is python-examples and you can install it by the packages manager (apt) by ordered this command:
In Debian and her children the package names is python-examples and you can install it by the packages manager (apt) by this command:
```
sudo apt-get install python-examples
```
but in opensuse is called python-demo and in fedora/redhat is called python-tools > in both of them you can also use the packages manager to install the package
But in opensuse it is called python-demo and in fedora/redhat it is called python-tools > in both of them you can also use the packages manager to install the package.

#### installing python3
the most of linux distro has python preinstalled but if you have old version you can install it using your packages manager or from the official website https://www.python.org/downloads/
The most of linux distro has python preinstalled, but if you have the old version you can install it using your packages manager or from the official website https://www.python.org/downloads/

## Install on you computer
in 1.1 version we added installer to insatll the framework on your device so to start installing the tool go to tool directory and execute this command:
In 1.1 version we added installer to install the framework on your device. So to start installing the tool go to tool directory and execute this command:
```
sudo python3 PySploit.py -i
```
if the install done the tool will tell you.
now if you need unistall the tool you can execute this another command:
If the installation is done, then the tool will tell you.
Now, if you need to unistall the tool, you can execute this other command:
```
sudo python3 PySploit -un
```
> Note: you should execute the both command with root privilege
> Note: You should execute the both command with root privilege. I.E use "sudo" infront of your commands.

# Add your module
we designed this framework to be easy to create your module all what you need is define three dictionarys and two functions :)
you can read simple_sample.py file in samples directory for more informations
> to more info visit this topic https://github.com/ahmadnourallah/pysploit-framework/wiki/Add-your-module
We designed this framework to be easy for creating your module. All what you need is to define three dictionarys and two functions. :)
You can read simple_sample.py file in samples directory for more informations.
> For more info, visit this topic https://github.com/ahmadnourallah/pysploit-framework/wiki/Add-your-module

# Authors
### Ahmad Nourallah
Expand All @@ -71,8 +71,8 @@ you can read simple_sample.py file in samples directory for more informations
This project is licensed under the GPL-2.0 License - see the LICENSE file for details

# TODO
* add new modules
* make the code smarter
* attract the developers to using the framework
* create advanced payload (such as meterpreter in metasploit) help us in this task
> we always welcome the all pull requests
* Add new modules
* Make the code smarter
* Attract the developers to using the framework
* Create advanced payload (such as meterpreter in metasploit) help us in this task
> We always welcome all of the pull requests toward this framework.