Add files via upload

Dockerfile

@@ -0,0 +1,42 @@
+# Build and run with docker_run.sh
+# e.g., ./docker_run.sh -q example.com
+#
+# Thank you to Ilya Glotov (https://github.com/andripwn) for help with
+# this minimal alpine image
+
+FROM python:3-alpine
+
+ENV SSDEEP_VERSION="release-2.14.1" \
+    BUILD_DEPS="build-base \
+                automake \
+                autoconf \
+                libtool"
+
+ADD requirements.txt .
+RUN apk --update --no-cache add $BUILD_DEPS \
+                                git \
+                                libffi-dev \
+    && git clone --depth=1 --branch=$SSDEEP_VERSION https://github.com/ssdeep-project/ssdeep.git \
+    && cd ssdeep \
+    && autoreconf -i \
+    && ./configure \
+    && make \
+    && make install \
+    && cd / \
+    && rm -rf /ssdeep \
+    \
+    && pip3 install -r requirements.txt \
+    \
+    && apk del $BUILD_DEPS \
+    \
+    && adduser -D pwngit
+
+VOLUME ["/pwngit/logs", "/pwngit/states"]
+
+WORKDIR /pwngit
+USER pwngit
+
+ADD checks /pwngit/checks
+ADD pwngit.py .
+ENTRYPOINT ["python3", "pwngit.py"]
+CMD [ "-h" ]

LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -1,2 +1,109 @@
-# PwnGIT
+<p align="center">
+  <img src="logo.png" width=350/>
+</p>
+
+#
+
+
+![License](https://img.shields.io/badge/license-LGPLv3%2B-lightgrey.svg)
+![Python version](https://img.shields.io/badge/python-3.x-blue.svg)
+
+## Description
+
 PwnGIT is a semi-automated, feedback-driven tool to empower users to rapidly search through troves of public data on GitHub for sensitive secrets.
+
+<p align="center">
+  <img src="example_usage.png" width=80%/>
+</p>
+
+### How it Works
+
+During search sessions, users will provide feedback to PwnGIT about search results to ignore, and PwnGIT prunes the set of results. Users can blacklist files by filename, repository name, username, or a fuzzy match of the file contents.
+
+Blacklists generated from previous sessions can be saved and reused against similar queries (e.g.,
+`example.com` v.s. `subdomain.example.com` v.s. `Example Org`). Sessions can also be paused and resumed at any time.
+
+## Install Instructions
+
+### Manual Instructions
+
+[1] Install the `ssdeep` dependency for fuzzy hashing.
+
+Ubuntu/Debian (or equivalent for your distro):
+```sh
+apt-get install libfuzzy-dev ssdeep
+```
+
+or, for Mac OSX:
+```sh
+brew install ssdeep
+```
+For Windows or *nix distributions without the `ssdeep` package, please see the [ssdeep installation instructions](https://ssdeep-project.github.io/ssdeep/index.html).
+
+[2] After installing `ssdeep`, install the Python dependencies using `pip`:
+```
+pip3 install -r requirements.txt
+```
+
+### Docker Instructions
+
+Run `pwngit-docker.sh` to build the PwnGIT docker image (if it doesn't already exist) and execute the dockerized version of the PwnGIT tool.
+
+On invocation, `pwngit-docker.sh` will create and mount `logs` and `states` directories from the host's current working directory. If this `pwngit-docker.sh` is executed from the PwnGIT project directory it will update the docker container with changes to `pwngit.py` or `checks/`:
+
+```sh
+./pwngit-docker.sh -q example.com
+```
+
+(See `pwngit-docker.sh` for specific docker commands)
+## Usage
+
+GitHub requires a token for rate-limiting purposes. Create a [GitHub API token](https://github.com/settings/tokens) with **no permissions/no scope**. This will be equivalent to public GitHub access, but it will allow access to use the GitHub Search API. Set this token at the top of `pwngit.py` as shown below:
+```sh
+ACCESS_TOKEN = "<NO-PERMISSION-GITHUB-TOKEN-HERE>"
+```
+
+(Alternatively, this token can be set as the `GITHUB_ACCESS_TOKEN` environment variable)
+
+After adding the token, you are ready to go:
+```sh
+# Default RegEx list and logfile location (/logs/<query>.log) are used when no others are specified.
+
+# Query for the string "example.com" using default GitHub search behavior (i.e., tokenization). 
+# This will find com.example (e.g., Java) or example.com (Website)
+./pwngit.py -q example.com
+
+# Query self-hosted GitHub instance
+./pwngit.py -q example.com -u https://git.example.com
+
+# Query for the exact string "example.com". See Query Syntax in the next section for more details.
+./pwngit.py -q '"example.com"'
+
+# Query through GitHub gists
+./pwngit.py --gist -q CompanyName
+
+# Using GitHub advanced search syntax
+./pwngit.py -q "org:github cats"
+
+# Custom RegEx List and custom log files location
+./pwngit.py -q example.com -f checks/default.list -o example1.log
+
+# Recovery from existing session
+./pwngit.py -q example.com -r example.com.state
+
+# Using an existing session (w/blacklists) for a new query
+./pwngit.py -q "Example Org" -r example.com.state
+```
+### Query Syntax
+
+PwnGIT queries are fed directly into the GitHub code search API, so check out [GitHub's documentation](https://help.github.com/en/articles/searching-code) for more advanced query syntax.
+
+### UI Commands
+* **Ignore similar [c]ontent:** Blacklists a fuzzy hash of the file contents to ignore
+future results that are similar to the selected file
+* **Ignore [r]epo/[u]ser/[f]ilename:** Ignores future results by blacklisting selected strings
+* **Search [/(mykeyword)]:** Provides a custom regex expression with a capture group to searches on-the-fly (e.g., `/(secretToken)`)
+* **[a]dd to Log:** Add RegEx matches to log file, including all on-the-fly search results from search command
+* **Next[\<Enter\>], [b]ack:** Advances through search results, or returns to previous results
+* **[s]ave state:** Saves the blacklists and progress in the search results from the session
+* **[q]uit:** Quit