Skip to content

Commit

Permalink
Merge pull request #321 from v1s1t0r1sh3r3/dev
Browse files Browse the repository at this point in the history
Dev to master v10.0
  • Loading branch information
OscarAkaElvis authored Nov 3, 2019
2 parents 8292971 + 6aa3376 commit 15405d7
Show file tree
Hide file tree
Showing 23 changed files with 1,152 additions and 353 deletions.
3 changes: 3 additions & 0 deletions .airgeddonrc
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ AIRGEDDON_FORCE_IPTABLES=false
#Available values: mdk3, mdk4 - Define which mdk version is going to be used - Default value mdk4
AIRGEDDON_MDK_VERSION=mdk4

#Enabled true / Disabled false - Enable plugins system - Default value true
AIRGEDDON_PLUGINS_ENABLED=true

#Enabled true / Disabled false - Development mode for faster development skipping intro and all initial checks - Default value false
AIRGEDDON_DEVELOPMENT_MODE=false

Expand Down
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!--- Please, answer the questions to provide maximum of info -->
<!--- Please, consider to contact us on Discord or IRC before opening an issue. More info and Discord invitation link here: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Contact -->
<!--- Answer the questions to provide maximum of info -->
<!--- Filling this issue template is mandatory. Otherwise the issue can be directly closed -->
<!--- Write in English only -->
<!--- If additional info is required and requested by airgeddon's staff, you have 7 days to respond, otherwise the issue will be closed -->
Expand All @@ -10,7 +11,7 @@

#### What is your Linux O.S. and which version?

<!--- Insert answer here, e.g. Kali Linux 2017.1, Ubuntu 16.04.2 -->
<!--- Insert answer here, e.g. Kali Linux 2019.1, Ubuntu 18.04 -->

#### Which is the chipset of your wireless card?

Expand Down
5 changes: 3 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ about: Create a report to help us improve

---

<!--- Please, answer the questions to provide maximum of info -->
<!--- Please, consider to contact us on Discord or IRC before opening an issue. More info and Discord invitation link here: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Contact -->
<!--- Answer the questions to provide maximum of info -->
<!--- Filling this issue template is mandatory. Otherwise the issue can be directly closed -->
<!--- Write in English only -->
<!--- If additional info is required and requested by airgeddon's staff, you have 7 days to respond, otherwise the issue will be closed -->
Expand All @@ -16,7 +17,7 @@ about: Create a report to help us improve

#### What is your Linux O.S. and which version?

<!--- Insert answer here, e.g. Kali Linux 2017.1, Ubuntu 16.04.2 -->
<!--- Insert answer here, e.g. Kali Linux 2019.1, Ubuntu 18.04 -->

#### Which is the chipset of your wireless card?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ about: Suggest an idea for this project

---

<!--- Please, answer the questions to provide maximum of info -->
<!--- Please, consider to contact us on Discord or IRC before opening an issue. More info and Discord invitation link here: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Contact -->
<!--- Answer the questions to provide maximum of info -->
<!--- Filling this issue template is mandatory. Otherwise the issue can be directly closed -->
<!--- Write in English only -->
<!--- If additional info is required and requested by airgeddon's staff, you have 7 days to respond, otherwise the issue will be closed -->
Expand Down
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/general-question.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ about: Ask some general question

---

<!--- Please, answer the questions to provide maximum of info -->
<!--- Please, consider to contact us on Discord or IRC before opening an issue. More info and Discord invitation link here: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Contact -->
<!--- Answer the questions to provide maximum of info -->
<!--- Filling this issue template is mandatory. Otherwise the issue can be directly closed -->
<!--- Write in English only -->
<!--- If additional info is required and requested by airgeddon's staff, you have 7 days to respond, otherwise the issue will be closed -->
Expand Down
2 changes: 2 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
<!--- Please, before sending a pull request read the Git Workflow Policy on Contributing section of the project -->
<!--- If you have doubts about how to proceed, consider to contact us on Discord or IRC before doing the PR. More info and Discord invitation link here: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Contact -->
<!--- Pull requests to master are not allowed -->
<!--- Write in English only -->
<!--- If your pull request is about a plugin, don't do it! airgeddon is not storing plugins. Read this about what to do: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Plugins%20Hall%20of%20Fame -->
<!--- If the pull request is not matching the policy, it will be closed -->

#### Describe the purpose of the pull request
Expand Down
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
### 10.0
- Added plugins system
- Added example plugin: Missing dependencies auto-installation for some distros (Kali, Parrot, BlackArch)
- Improvements for Evil Twin on captive portal detection for newer devices
- Missing 5GHz channels added
- Github pull request template added and issue templates updated
- Fixed error on hex2ascii conversion for some WEP passwords

### 9.23
- Fixed error printing hints
- Fixed problem with default values on options file creation
Expand Down
48 changes: 32 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,27 @@ Please note we have a [Code of Conduct], please follow it in all your interactio

## Issue Creation Policy

1. Filling the issue template with *ALL* the requested info is mandatory. Otherwise the issue can be marked as "invalid" and closed immediately.
2. Issues must be opened in English.
3. If an issue is opened and more info is needed, `airgeddon` staff will request it. If there is no answer in 7 days or the OP is not collaborating, the issue will be closed.
4. If the issue is not related to airgeddon or the root cause is out of scope, it will be closed. `airgeddon` staff is not a helpdesk support service.
5. Try to be sure that your problem is related to airgeddon and that is not a driver issue. A good practice is always to try to perform the same operation without using `airgeddon` in order to see if the problem or the behavior can be reproduced. In that case, probably the issue should not be created.
6. Don't talk or mention references to other tools. If you want to talk about other similar tools you can do it on their pages/github. `airgeddon` issues are to talk about `airgeddon`.
1. Please, consider to contact us on [IRC] or [Discord] channel before opening an issue. More info at [Wiki Contact Section]
2. Filling the issue template with *ALL* the requested info is mandatory. Otherwise the issue can be marked as "invalid" and closed immediately.
3. Issues must be opened in English.
4. If an issue is opened and more info is needed, `airgeddon` staff will request it. If there is no answer in 7 days or the OP is not collaborating, the issue will be closed.
5. If the issue is not related to airgeddon or the root cause is out of scope, it will be closed. `airgeddon` staff is not a helpdesk support service.
6. Try to be sure that your problem is related to airgeddon and that is not a driver issue. A good practice is always to try to perform the same operation without using `airgeddon` in order to see if the problem or the behavior can be reproduced. In that case, probably the issue should not be created.
7. Don't talk or mention references to other tools. If you want to talk about other similar tools you can do it on their pages/github. `airgeddon` issues are to talk about `airgeddon`.

## Collaborating Translators

1. Ask ALWAYS before start a translation to add a new language ([[email protected]]). Contact to the development team in order to know what are you going to do. You'll be informed about how to proceed.
1. Ask ALWAYS before start a translation to add a new language (by mail at [[email protected]], by Twitter at [@OscarAkaElvis], by [IRC] or [Discord] channel). Contact to the development team in order to know what are you going to do. You'll be informed about how to proceed.
2. Once new language is approved or if you are going to update an existing one, update the date under shebang on every commit.
3. Translate the strings located in `language_strings.sh` and the existing phrases _language_strings_handling_messages function_ in `airgeddon.sh`.
4. If you want to create a pull request with a new language to be added, at least the 80% of the phrases must be translated and the rest must be done with at least _an automatic-translation_ system and marked with PoT (Pending of Translation) mark.
5. Remember that pull requests done over master branch will be rejected. Read the git workflow policy first.
6. After verification of and acceptation of the pull request, you can be added as a collaborator on the project to push directly on the repository instead of making pull requests.
7. Knowledge about `git` is mandatory (at least basic commands) to push directly into the project repository.

## Collaborating Developers
## Collaborating Developers and Plugins Development

#### For direct interaction with the repository (plugins development excluded):

1. First of all ask ALWAYS before performing a development. Ask to the developement team to set what is going to be
2. Tweak *"AIRGEDDON_DEVELOPMENT_MODE"* variable to "true" for faster development skipping intro and initial checks or change *"AIRGEDDON_DEBUG_MODE"* variable for verbosity.
Expand All @@ -39,30 +42,36 @@ Please note we have a [Code of Conduct], please follow it in all your interactio
- *X* is a major release with a new menu (e.g. WPS menu)
- *Y* is a minor release with a new feature for an existing menu or a new submenu for an existing feature
- *Z* is a minor release with new bug fixes, small modifications or code improvements
7. Update the date on `.sh` and `.db` files under shebang, if appropriate.
8. Split your commits into parts. Each part represents a unique change on files.
9. Direct push to [Master] is not allowed. Pull Requests to [Master] are not allowed. Should be done over [Dev] or any other branch. They require revision and approvement. Read the git workflow policy first.
10. All the development and coding must be in English.
7. Split your commits into parts. Each part represents a unique change on files.
8. Direct push to [Master] is not allowed. Pull Requests to [Master] are not allowed. Should be done over [Dev] or any other branch. They require revision and approvement. Read the git workflow policy first.
9. All the development and coding must be in English.

*Be sure to merge the latest from "upstream" before making a pull request!*

#### For plugins development:

1. Read carefully the [Wiki Plugins Development Section].
2. Plugins Pull Requests will be never accepted. Plugins MUST be external to this repository.
3. Develop your plugin following the guidelines and using the plugin template to keep the needed structure.
4. If you want to add your plugin to [Wiki Plugins Hall of Fame Section], follow the instructions explained there. Don't open an issue.

We also have a private Telegram group for *trusted collaborators* for more agile discussion about developments, improvements, etc.
To be added on it you must prove first you are a *trusted collaborator* with your contributions.
Anything ca be also discussed on the IRC channel. More info on [Wiki Contact Section]
Anything can be also discussed on public [IRC] or [Discord] channel. More info at [Wiki Contact Section].

## WPS PIN Database Collaborators

1. Send MAC of the BSSID and the default PIN to [[email protected]]. If you are going to push directly into the repository, keep reading the next points.
2. Add PINs ordered by the key in the associative array located in the `known_pins.db` file. (Keys are the first 6 BSSID digits).
3. Update the `pindb_checksum.txt` file with the calculated checksum of the database file using `md5sum` tool.
3. Update the `pindb_checksum.txt` file with the calculated checksum of the already modified database file using `md5sum` tool.
4. Update the date under shebang.

*PINs should be from devices that generate generic ones.*

## Beta Testers

1. Download the main version from the [Master] branch or the beta testing version from the development branch called [Dev]. Temporary branches may be existing for specific features that can also be tested.
2. Report any issues or bugs by mail [[email protected]] or submit issue requests [Here] reading first the Issue Creation Policy.
2. Report any issues or bugs by Twitter at [@OscarAkaElvis], mail [[email protected]], on [IRC] or [Discord] channel or submit Github issue requests [Here] reading first the Issue Creation Policy.

## Git Workflow Policy

Expand Down Expand Up @@ -158,10 +167,17 @@ If you enjoyed the script, feel free to donate. Support the project through Payp

<!-- Github -->
[Shellcheck]: https://github.com/koalaman/shellcheck "shellcheck.hs"
[Here]: https://github.com/v1s1t0r1sh3r3/airgeddon/issues/new
[Here]: https://github.com/v1s1t0r1sh3r3/airgeddon/issues/new/choose
[Master]: https://github.com/v1s1t0r1sh3r3/airgeddon/tree/master
[Dev]: https://github.com/v1s1t0r1sh3r3/airgeddon/tree/dev
[xtonousou]: https://github.com/xtonousou "xT"
[v1s1t0r]: https://github.com/v1s1t0r1sh3r3
[OscarAkaElvis]: https://github.com/OscarAkaElvis
[Wiki Contact Section]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Contact
[Wiki Plugins Development Section]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Plugins%20Development
[Wiki Plugins Hall of Fame Section]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Plugins%20Hall%20of%20Fame

<!-- Other -->
[@OscarAkaElvis]: https://twitter.com/OscarAkaElvis
[Discord]: https://discord.gg/sQ9dgt9
[IRC]: https://webchat.freenode.net/
9 changes: 7 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ RUN \
aircrack-ng \
xterm \
iproute2 \
pciutils
pciutils \
procps

#Install airgeddon internal tools
RUN \
Expand Down Expand Up @@ -148,7 +149,7 @@ RUN \
apt autoclean && \
apt autoremove -y

#Clean files
#Clean and remove useless files
RUN rm -rf /opt/airgeddon/imgs > /dev/null 2>&1 && \
rm -rf /opt/airgeddon/.github > /dev/null 2>&1 && \
rm -rf /opt/airgeddon/.editorconfig > /dev/null 2>&1 && \
Expand All @@ -159,11 +160,15 @@ RUN rm -rf /opt/airgeddon/imgs > /dev/null 2>&1 && \
rm -rf /opt/airgeddon/binaries > /dev/null 2>&1 && \
rm -rf /opt/hashcat2.0 > /dev/null 2>&1 && \
rm -rf /opt/bettercap1.6.2 > /dev/null 2>&1 && \
rm -rf /opt/airgeddon/plugins/* > /dev/null 2>&1 && \
rm -rf /tmp/* > /dev/null 2>&1 && \
rm -rf /var/lib/apt/lists/* > /dev/null 2>&1

#Expose BeEF control panel port
EXPOSE 3000

#Create volume for plugins
VOLUME /opt/airgeddon/plugins

#Start command (launching airgeddon)
CMD ["/bin/bash", "-c", "/opt/airgeddon/airgeddon.sh"]
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ All the needed info about how to "install | use | enjoy" `airgeddon` is present


- *IV. Project & Development*
- [Plugins system]
- [Plugins development]
- [Plugins Hall of Fame]
- [Supported Languages]
- [Contributing & Code of Conduct]
- [Changelog]
Expand Down Expand Up @@ -82,6 +85,9 @@ All the needed info about how to "install | use | enjoy" `airgeddon` is present
[Mac OSX]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Docker%20Mac%20OSX
[Windows]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Docker%20Windows
[Other Sources]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Other%20Sources
[Plugins system]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Plugins%20System
[Plugins development]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Plugins%20Development
[Plugins Hall of Fame]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Plugins%20Hall%20of%20Fame
[Supported Languages]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Supported%20Languages
[Contributing & Code of Conduct]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Contributing-&-Code-of-Conduct
[Changelog]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Changelog
Expand All @@ -90,7 +96,7 @@ All the needed info about how to "install | use | enjoy" `airgeddon` is present
[Hat Tip To]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Hat%20Tip%20To
[Inspiration]: https://github.com/v1s1t0r1sh3r3/airgeddon/wiki/Inspiration

[Version-shield]: https://img.shields.io/badge/version-9.23-blue.svg?style=flat-square&colorA=273133&colorB=0093ee "Latest version"
[Version-shield]: https://img.shields.io/badge/version-10.0-blue.svg?style=flat-square&colorA=273133&colorB=0093ee "Latest version"
[Bash4.2-shield]: https://img.shields.io/badge/bash-4.2%2B-blue.svg?style=flat-square&colorA=273133&colorB=00db00 "Bash 4.2 or later"
[License-shield]: https://img.shields.io/badge/license-GPL%20v3%2B-blue.svg?style=flat-square&colorA=273133&colorB=bd0000 "GPL v3+"
[Docker-shield]: https://img.shields.io/docker/automated/v1s1t0r1sh3r3/airgeddon.svg?style=flat-square&colorA=273133&colorB=f9ff5a "Docker rules!"
Expand Down
Loading

0 comments on commit 15405d7

Please sign in to comment.