Issue #8

Author: m8sec

.gitignore

@@ -1,2 +1,30 @@
-*.pyc
-*.DS_Store
+impacket/*
+develop-eggs/
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+test.py
+
+# Byte-compiled
+__pycache__/
+*.py[cod]
+
+# macOS
+.DS_Store
+
+# PyCharm
+.idea
+venv/

README.md

@@ -1,50 +1,62 @@
 # enumdb
 Enumdb is a brute force and post exploitation tool for MySQL and MSSQL databases. When provided a list of usernames and/or passwords, it will cycle through each targeted host looking for valid credentials. By default, enumdb will use newly discovered credentials to search for sensitive information in the host's databases via keyword searches on the table or column names. This information can then be extracted and reported to a .csv or .xlsx output file. See the Usage and All Options sections for more detailed usage and examples.
 
-To make the tool more adaptable on larger environments, Threading has been added to expedite brute forcing and enumeration when targeting multiple servers. Additionally, enumdb will not generate a report by default allowing users to get a quick preview of the target database. To extract data, specify a report type in the command line arguments, with either: ```-r csv``` or ```-r xlsx```. The first 100 rows of each identified table or column will be selected in the output report. 
+To make the tool more adaptable on larger environments, Threading has been added to expedite brute forcing and enumeration when targeting multiple servers. Additionally, enumdb will *not* generate reports by default, allowing users to get a quick preview of the target database. To extract data, specify a report type in the command line arguments, with either: ```-r csv``` or ```-r xlsx```. The first 100 rows of each identified table or column will be extracted in the output report. 
 
-The number of rows captured in reports, blacklisted databases & tables, and keywords for table & column searches can be modified at: ```enumdb/config.py```.
+Rows captured, blacklisted databases & tables, and keywords searches can all be modified at: ```enumdb/config.py```.
 
 ## Installation
-Enumdb was designed and testing using Python3 on the Kali Linux operating system. However, backwards compatibility has recently been added for Python2.7.
+Enumdb was designed and tested using Python3 for Debian based Linux systems. However, the tool is also compatible with Python2.7, and on other Linux distributions.
 
-*Use the requirements file to install the necessary Python packages. If you still experience import issues, try the setup.sh file*
 ```bash
 git clone https://github.com/m8r0wn/enumdb
 cd enumdb
-pip3 install -r requirements.txt
+python3 setup.py install
 ``````
 
+If experiencing issues with the [MySQLdb](https://github.com/PyMySQL/mysqlclient-python), additional MySQL development resources may
+need to be installed:
+
+* Debian / Ubuntu: 
+```
+sudo apt-get install python3-dev default-libmysqlclient-dev build-essential
+```
+
+* Red Hat / CentOS: 
+```
+sudo yum install python3-devel mysql-devel
+```
+
 ## Usage
 * Connect to a MySQL database and search for data via key word in table name (no report)<br>
-`python3 enumdb.py -u root -p '' -t mysql 10.11.1.30`
+```enumdb -u root -p '' -t mysql 10.11.1.30```
 
 * Connect to a MSSQL database using a domain username and search for data via keyword in column name writing output to csv file:<br>
-`python3 enumdb.py -u 'domain\\user' -p Winter2018! -t mssql -columns -report csv 10.11.1.30`
+```enumdb -u 'domain\\user' -p Winter2018! -t mssql -columns -report csv 10.11.1.30```
 
 * Brute force multiple MySQL servers looking for default credentials, no data enumeration:<br>
-`python3 enumdb.py -u root -p '' -t mysql -brute 10.11.1.0-30`
+```enumdb -u root -p '' -t mysql -brute 10.11.1.0-30```
 
 * Brute force MSSQL sa account login. Once valid credentials are found, enumerate data by column name writing output to xlsx:<br>
-`python3 enumdb.py -u sa -P passwords.txt -t mssql -columns -report xlsx 192.168.10.10`
+```enumdb -u sa -P passwords.txt -t mssql -columns -report xlsx 192.168.10.10```
 
 * Brute force MSSQL sa account on a single server, no data enumeration:<br>
-`python3 enumdb.py -u sa -P passwords.txt -t mssql -brute 192.168.10.10`
+```enumdb -u sa -P passwords.txt -t mssql -brute 192.168.10.10```
 
 ![enumdb](https://user-images.githubusercontent.com/13889819/54823551-9ae80d00-4c7e-11e9-89e5-3140b793b6d7.gif)
 
 ## All Options
-      -h, --help                show help message and exit
-      -u USERS                  Single username
-      -U USERS                  Users.txt file
-      -p PASSWORDS              Single password
-      -P PASSWORDS              Password.txt file
-      -threads MAX_THREADS      Max threads (Default: 3)
-      -port PORT                Specify non-standard port
-      -r REPORT, -report REPORT Output Report: csv, xlsx (Default: None)
-      -t DBTYPE                 Database types currently supported: mssql, mysql
-      -c, -columns              Search for key words in column names (Default: table names)
-      -v                        Show failed login notices & keyword matches with Empty data sets
-      -brute                    Brute force only, do not enumerate
-
-
+```html
+  -u USERS                  Single username
+  -U USERS                  Users.txt file
+  -p PASSWORDS              Single password
+  -P PASSWORDS              Password.txt file
+  -threads MAX_THREADS      Max threads (Default: 3)
+  -port PORT                Specify non-standard port
+  -r REPORT, -report REPORT Output Report: csv, xlsx (Default: None)
+  -t {mysql,mssql}          Database type
+  -c, -columns              Search for key words in column names (Default: table names)
+  -v                        Show failed login notices & keyword matches with Empty data sets
+  -brute                    Brute force only, do not enumerate
+
+```

change_log.md

@@ -181,18 +181,18 @@ def main():
     version = '2.1.0'
     try:
         args = argparse.ArgumentParser(description=("""
-                           {0}   (v{1})
+                        enumdb   (v{0})
     --------------------------------------------------
 Brute force MySQL or MSSQL database logins. Once provided with valid
 credentials, enumdb will attempt to enumerate tables containing
 sensitive information such as: users, passwords, ssn, etc.
 
 Usage:
-    python3 {0} -u root -p Password1 -t mysql 10.11.1.30
-    python3 {0} -u root -p '' -t mysql -brute 10.0.0.0-50
-    python3 {0} -u 'domain\\user1' -P pass.txt -t mssql 192.168.1.7
+    enumdb -u root -p Password1 -t mysql 10.11.1.30
+    enumdb -u root -p '' -t mysql -brute 10.0.0.0-50
+    enumdb -u 'domain\\user1' -P pass.txt -t mssql 192.168.1.7
 
-** Having trouble with inputs? Use \'\' around username & password **""").format(argv[0], version), formatter_class=argparse.RawTextHelpFormatter, usage=argparse.SUPPRESS)
+** Having trouble with inputs? Use \'\' around username & password **""").format(version), formatter_class=argparse.RawTextHelpFormatter, usage=argparse.SUPPRESS)
 
         user = args.add_mutually_exclusive_group(required=True)
         user.add_argument('-u', dest='users', type=str, action='append', help='Single username')

enumdb/__init__.py

@@ -1,5 +1,4 @@
 openpyxl
 pymssql
-mysqlclient
 ipparser
-psycopg2
+mysqlclient

requirements.txt

@@ -0,0 +1,49 @@
+'''
+Some users have experienced issues with the MySQLdb package. As per
+the authors instructions, the MySQL development libraries may
+need to be installed manually:
+
+- Debian / Ubuntu : sudo apt-get install python3-dev default-libmysqlclient-dev build-essential
+- Red Hat / CentOS: sudo yum install python3-devel mysql-devel
+
+*** From my understanding, it is also because of this that enumdb ***
+*** does not run well in virtual environments such as pipenv      ***
+
+Resources:
+https://github.com/PyMySQL/mysqlclient-python
+https://stackoverflow.com/questions/7475223/mysql-config-not-found-when-installing-mysqldb-python-interface
+'''
+from setuptools import setup, find_packages
+
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+
+setup(
+    name='enumdb',
+    version='2.1.0',
+    author = 'm8r0wn',
+    author_email = '[email protected]',
+    description = 'Database brute force and post exploitation tool to extract sensitive data',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url='https://github.com/m8r0wn/enumdb',
+    license='GPLv3',
+    platforms = ["Unix"],
+    packages=find_packages(include=["enumdb", "enumdb.*"]),
+    install_requires=[
+                    'openpyxl',
+                    'pymssql',
+                    'mysqlclient',
+                    'ipparser>=0.3.5',
+    ],
+    classifiers = [
+                    "Environment :: Console",
+                    "Programming Language :: Python :: 3",
+                    "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
+                    "Operating System :: Unix",
+                    "Topic :: Security"
+    ],
+    entry_points= {
+                    'console_scripts': ['enumdb=enumdb:main']
+    }
+)