├── .github └── workflows │ ├── pythonpackage.yml │ └── pythonpublish.yml ├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── MANIFEST.in ├── README.md ├── docs ├── example.conf ├── logging.md └── rules.md ├── github_watchman ├── __about__.py ├── __init__.py ├── __main__.py ├── config.py ├── github_wrapper.py ├── logger.py └── rules │ ├── access_tokens.yaml │ ├── aws_api_tokens.yaml │ ├── azure_api_tokens.yaml │ ├── azure_service_account_files.yaml │ ├── bearer_tokens.yaml │ ├── client_secrets.yaml │ ├── gcp_service_account_files.yaml │ ├── google_api_tokens.yaml │ ├── interesting_files.yaml │ ├── misc_private_keys.yaml │ ├── passwords.yaml │ ├── pgp_private_keys.yaml │ ├── private_tokens.yaml │ ├── s3_config_files.yaml │ ├── slack_api_tokens.yaml │ └── slack_webhooks.yaml ├── setup.py └── tests └── test_rules.py /.github/workflows/pythonpackage.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a variety of Python versions 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions 3 | 4 | name: Python package 5 | 6 | on: 7 | push: 8 | branches: [ develop ] 9 | pull_request: 10 | branches: [ develop ] 11 | 12 | jobs: 13 | build-ubuntu: 14 | 15 | runs-on: ubuntu-latest 16 | strategy: 17 | matrix: 18 | python-version: [3.6, 3.7, 3.8] 19 | 20 | steps: 21 | - uses: actions/checkout@v2 22 | - name: Set up Python ${{ matrix.python-version }} 23 | uses: actions/setup-python@v2 24 | with: 25 | python-version: ${{ matrix.python-version }} 26 | - name: Install dependencies 27 | run: | 28 | python -m pip install --upgrade pip 29 | pip install flake8 30 | if [ -f requirements.txt ]; then pip install -r requirements.txt; fi 31 | - name: Lint with flake8 32 | run: | 33 | # stop the build if there are Python syntax errors or undefined names 34 | flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics 35 | # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide 36 | flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics 37 | - name: Test setup & install 38 | run: | 39 | pip install wheel setuptools requests colorama termcolor PyYAML 40 | python setup.py sdist bdist_wheel 41 | pip install dist/*.whl 42 | - name: Test rules 43 | run: | 44 | python3 -m unittest tests/test_rules.py 45 | - name: Test run 46 | run: | 47 | github-watchman --version 48 | github-watchman --help 49 | 50 | build-windows: 51 | 52 | runs-on: windows-latest 53 | strategy: 54 | matrix: 55 | python-version: [3.6, 3.7, 3.8] 56 | 57 | steps: 58 | - uses: actions/checkout@v2 59 | - name: Set up Python ${{ matrix.python-version }} 60 | uses: actions/setup-python@v2 61 | with: 62 | python-version: ${{ matrix.python-version }} 63 | - name: Install dependencies 64 | run: | 65 | python -m pip install --upgrade pip 66 | pip install wheel setuptools requests colorama termcolor 67 | - name: Test setup & install 68 | run: | 69 | python setup.py sdist bdist_wheel 70 | pip install --find-links=dist\ github-watchman 71 | - name: Test run 72 | run: | 73 | github-watchman --version 74 | github-watchman --help 75 | -------------------------------------------------------------------------------- /.github/workflows/pythonpublish.yml: -------------------------------------------------------------------------------- 1 | # This workflows will upload a Python Package using Twine when a release is created 2 | # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries 3 | 4 | name: Upload Python Package 5 | 6 | on: 7 | release: 8 | types: [published] 9 | 10 | jobs: 11 | deploy: 12 | 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v2 17 | - name: Set up Python 18 | uses: actions/setup-python@v2 19 | with: 20 | python-version: '3.x' 21 | - name: Install dependencies 22 | run: | 23 | python -m pip install --upgrade pip 24 | pip install setuptools wheel twine requests colorama termcolor PyYAML 25 | - name: Build and publish 26 | env: 27 | TWINE_USERNAME: ${{ '__token__' }} 28 | TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }} 29 | run: | 30 | python setup.py sdist bdist_wheel 31 | twine upload dist/* 32 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Editors 2 | .vscode/ 3 | .idea/ 4 | 5 | # Vagrant 6 | .vagrant/ 7 | 8 | # Mac/OSX 9 | .DS_Store 10 | 11 | # Windows 12 | Thumbs.db 13 | 14 | # Source for the following rules: https://raw.githubusercontent.com/github/gitignore/master/Python.gitignore 15 | # Byte-compiled / optimized / DLL files 16 | __pycache__/ 17 | *.py[cod] 18 | *$py.class 19 | 20 | # C extensions 21 | *.so 22 | 23 | # Distribution / packaging 24 | .Python 25 | build/ 26 | develop-eggs/ 27 | dist/ 28 | downloads/ 29 | eggs/ 30 | .eggs/ 31 | lib/ 32 | lib64/ 33 | parts/ 34 | sdist/ 35 | var/ 36 | wheels/ 37 | *.egg-info/ 38 | .installed.cfg 39 | *.egg 40 | MANIFEST 41 | 42 | # PyInstaller 43 | # Usually these files are written by a python script from a template 44 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 45 | *.manifest 46 | *.spec 47 | 48 | # Installer logs 49 | pip-log.txt 50 | pip-delete-this-directory.txt 51 | 52 | # Unit test / coverage reports 53 | htmlcov/ 54 | .tox/ 55 | .nox/ 56 | .coverage 57 | .coverage.* 58 | .cache 59 | nosetests.xml 60 | coverage.xml 61 | *.cover 62 | .hypothesis/ 63 | .pytest_cache/ 64 | 65 | # Translations 66 | *.mo 67 | *.pot 68 | 69 | # Django stuff: 70 | *.log 71 | local_settings.py 72 | db.sqlite3 73 | 74 | # Flask stuff: 75 | instance/ 76 | .webassets-cache 77 | 78 | # Scrapy stuff: 79 | .scrapy 80 | 81 | # Sphinx documentation 82 | docs/_build/ 83 | 84 | # PyBuilder 85 | target/ 86 | 87 | # Jupyter Notebook 88 | .ipynb_checkpoints 89 | 90 | # IPython 91 | profile_default/ 92 | ipython_config.py 93 | 94 | # pyenv 95 | .python-version 96 | 97 | # celery beat schedule file 98 | celerybeat-schedule 99 | 100 | # SageMath parsed files 101 | *.sage.py 102 | 103 | # Environments 104 | .env 105 | .venv 106 | env/ 107 | venv/ 108 | ENV/ 109 | env.bak/ 110 | venv.bak/ 111 | 112 | # Spyder project settings 113 | .spyderproject 114 | .spyproject 115 | 116 | # Rope project settings 117 | .ropeproject 118 | 119 | # mkdocs documentation 120 | /site 121 | 122 | # mypy 123 | .mypy_cache/ 124 | .dmypy.json 125 | dmypy.json 126 | 127 | # package related 128 | config/ 129 | *.txt 130 | *.csv 131 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 1.0.1 - 2020-11-x 2 | ### Fixed 3 | - Retry added for occasional Requests HTTPSConnectionPool error 4 | 5 | ## 1.0.0 - 2020-10-01 6 | Release -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include *.txt 2 | recursive-include github_watchman *.yaml *.yml 3 | recursive-exclude github_watchman test*.yaml test*.yml 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # GitHub Watchman 4 | ![Python 2.7 and 3 compatible](https://img.shields.io/pypi/pyversions/github-watchman) 5 | ![PyPI version](https://img.shields.io/pypi/v/github-watchman.svg) 6 | ![License: MIT](https://img.shields.io/pypi/l/github-watchman.svg) 7 | 8 | ## About GitHub Watchman 9 | 10 | GitHub Watchman is an application that uses the GitHub API to audit GitHub for sensitive data and credentials exposed internally. 11 | 12 | ### Features 13 | It searches GitHub for internally shared projects and looks at: 14 | - Code 15 | - Commits 16 | - Issues 17 | - Repositories 18 | 19 | For the following data: 20 | - GCP keys and service account files 21 | - AWS keys 22 | - Azure keys and service account files 23 | - Google API keys 24 | - Slack API tokens & webhooks 25 | - Private keys (SSH, PGP, any other misc private key) 26 | - Exposed tokens (Bearer tokens, access tokens, client_secret etc.) 27 | - S3 config files 28 | - Passwords in plaintext 29 | - and more 30 | 31 | #### Time based searching 32 | You can run GitHub Watchman to look for results going back as far as: 33 | - 24 hours 34 | - 7 days 35 | - 30 days 36 | - All time 37 | 38 | This means after one deep scan, you can schedule GitHub Watchman to run regularly and only return results from your chosen timeframe. 39 | 40 | ### Rules 41 | GitHub Watchman uses custom YAML rules to detect matches in GitHub. 42 | 43 | They follow this format: 44 | 45 | ```yaml 46 | --- 47 | filename: 48 | enabled: #[true|false] 49 | meta: 50 | name: 51 | author: 52 | date: 53 | description: #what the search should find# 54 | severity: #rating out of 100# 55 | scope: #what to search, any combination of the below# 56 | - code 57 | - commits 58 | - issues 59 | - repositories 60 | test_cases: 61 | match_cases: 62 | - #test case that should match the regex# 63 | fail_cases: 64 | - #test case that should not match the regex# 65 | strings: 66 | - #search query to use in GitHub# 67 | pattern: #Regex pattern to filter out false positives# 68 | ``` 69 | There are Python tests to ensure rules are formatted properly and that the Regex patterns work in the `tests` dir 70 | 71 | More information about rules, and how you can add your own, is in the file `docs/rules.md`. 72 | 73 | 74 | ### Logging 75 | 76 | GitHub Watchman gives the following logging options: 77 | - CSV 78 | - Log file 79 | - Stdout 80 | - TCP stream 81 | 82 | When using CSV logging, searches for rules are returned in separate CSV files, for all other methods of logging, results are output in JSON format, perfect for ingesting into a SIEM or other log analysis platform. 83 | 84 | For file and TCP stream logging, configuration options need to be passed via `.conf` file or environment variable. See the file `docs/logging.md` for instructions on how to set it up. 85 | 86 | If no logging option is given, GitHub Watchman defaults to CSV logging. 87 | 88 | ## Requirements 89 | 90 | ### GitHub versions 91 | GitHub Watchman uses the v3 API, and works with GitHub Enterprise Server versions that support the v3 API. 92 | 93 | GitHub Watchman also works with GitHub.com (Free, Pro and Team) using the API. 94 | 95 | ### GitHub personal access token 96 | To run GitHub Watchman, you will need a GitHub personal access token. 97 | 98 | You can create a personal access token in the GitHub GUI via Settings -> Developer settings -> Personal access tokens 99 | 100 | The token needs no specific scopes assigned, as it searches public repositories in the GitHub instance. 101 | 102 | **Note**: Personal access tokens act on behalf of the user who creates them, so I would suggest you create a token using a service account, otherwise the app will have access to your private repositories. 103 | 104 | ### GitHub URL 105 | 106 | You also need to provide the URL of your GitHub instance. 107 | 108 | #### Providing token & URL 109 | GitHub Watchman will first try to get the the GitHub token and URL from the environment variables `GITHUB_WATCHMAN_TOKEN` and `GITHUB_WATCHMAN_URL`, if this fails they will be taken from .conf file (see below). 110 | 111 | ### .conf file 112 | Configuration options can be passed in a file named `watchman.conf` which must be stored in your home directory. The file should follow the YAML format, and should look like below: 113 | ```yaml 114 | github_watchman: 115 | token: abc123 116 | url: https://github.example.com 117 | logging: 118 | file_logging: 119 | path: 120 | json_tcp: 121 | host: 122 | port: 123 | ``` 124 | GitHub Watchman will look for this file at runtime, and use the configuration options from here. If you are not using the advanced logging features, leave them blank. 125 | 126 | If you are having issues with your .conf file, run it through a YAML linter. 127 | 128 | An example file is in `docs/example.conf` 129 | 130 | **Note** If you use any other Watchman applications and already have a `watchman.conf` file, just append the conf data for GitHub Watchman to the existing file. 131 | 132 | ## Installation 133 | Install via pip 134 | 135 | `pip install github-watchman` 136 | 137 | Or via source 138 | 139 | ## Usage 140 | GitHub Watchman will be installed as a global command, use as follows: 141 | ``` 142 | usage: github-watchman [-h] --timeframe {d,w,m,a} --output 143 | {csv,file,stdout,stream} [--version] [--all] [--code] 144 | [--commits] [--issues] [--repositories] 145 | 146 | Monitoring GitHub for sensitive data shared publicly 147 | 148 | optional arguments: 149 | -h, --help show this help message and exit 150 | --version show program's version number and exit 151 | --all Find everything 152 | --code Search code 153 | --commits Search commits 154 | --issues Search issues 155 | --repositories Search merge requests 156 | 157 | required arguments: 158 | --timeframe {d,w,m,a} 159 | How far back to search: d = 24 hours w = 7 days, m = 160 | 30 days, a = all time 161 | --output {csv,file,stdout,stream} 162 | Where to send results 163 | 164 | 165 | ``` 166 | 167 | You can run GitHub Watchman to look for everything, and output to default CSV: 168 | 169 | `github-watchman --timeframe a --all` 170 | 171 | Or arguments can be grouped together to search more granularly. This will look for commits and milestones for the last 30 days, and output the results to a TCP stream: 172 | 173 | `github-watchman --timeframe m --commits --milestones --output stream` 174 | 175 | ## Other Watchman apps 176 | You may be interested in some of the other apps in the Watchman family: 177 | - [Slack Watchman](https://github.com/PaperMtn/slack-watchman) 178 | - [GitLab Watchman](https://github.com/PaperMtn/gitlab-watchman) 179 | 180 | ## License 181 | The source code for this project is released under the [GNU General Public Licence](https://www.gnu.org/licenses/licenses.html#GPL). This project is not associated with GitHub. 182 | -------------------------------------------------------------------------------- /docs/example.conf: -------------------------------------------------------------------------------- 1 | github_watchman: 2 | token: abc123 3 | url: https://api.github.com 4 | logging: 5 | file_logging: 6 | path: /var/log/ 7 | json_tcp: 8 | host: localhost 9 | port: 9020 10 | -------------------------------------------------------------------------------- /docs/logging.md: -------------------------------------------------------------------------------- 1 | # Logging 2 | GitHub Watchman gives the following logging options: 3 | - CSV 4 | - Log file 5 | - Stdout 6 | - TCP stream 7 | 8 | ## CSV logging 9 | CSV logging is the default logging option if no other output method is given at runtime. 10 | 11 | Results for each search are output as CSV files in your current working directory. 12 | 13 | ## JSON formatted logging 14 | All other logging options output their logs in JSON format. Here is an example: 15 | 16 | ```json 17 | {"localtime": "2020-01-01 00:00:00,000", "level": "NOTIFY", "source": "GitHub Watchman", "scope": "issues", "type": "Slack API Tokens", "severity": "70", "detection_data": {"issue_body": "...", "issue_id": 12345, "issue_title": "...", "issue_url": "https://westeros.github.com/lannister_docs/issues/12345", "matches": [{"fragment": "...", "object_type": "IssueComment", "object_url": "https://westeros.github.com/repositories/12345/issues/comments/12345"}], "repository_url": "https://westeros.github.com/repos/lannister_docs/lannister_slack_bot", "sha": null, "state": "open", "updated_at": "2020-09-27T01:47:23Z", "user_id": 12345, "user_login": "tlannister"}} 18 | ``` 19 | This should contain all of the information you require to ingest these logs into a SIEM, or other log analysis platform. 20 | 21 | 22 | ### File logging 23 | File logging saves JSON formatted logs to a file. 24 | 25 | The path where you want to output the file needs to be passed when running GitHub Watchman. This can be done via the .conf file: 26 | ```yaml 27 | github_watchman: 28 | token: abc123 29 | url: https://github.example.com 30 | logging: 31 | file_logging: 32 | path: /var/put_my_logs_here/ 33 | json_tcp: 34 | host: 35 | port: 36 | ``` 37 | Or by setting your log path in the environment variable: `GITHUB_WATCHMAN_LOG_PATH` 38 | 39 | If file logging is selected as the output option, but no path is give, GitHub Watchman defaults to the user's home directory. 40 | 41 | The filename will be `github_watchman.log` 42 | 43 | Note: GitHub Watchman does not handle the rotation of the file. You would need a solution such as logrotate for this. 44 | 45 | ### Stdout logging 46 | Stdout logging sends JSON formatted logs to Stdout, for you to capture however you want. 47 | 48 | ### TCP stream logging 49 | With this option, JSON formmatted logs are sent to a destination of your choosing via TCP 50 | 51 | You will need to pass GitHub Watchman a host and port to receive the logs, either via .conf file: 52 | 53 | ```yaml 54 | github_watchman: 55 | token: abc123 56 | url: https://github.example.com 57 | logging: 58 | file_logging: 59 | path: 60 | json_tcp: 61 | host: localhost 62 | port: 9020 63 | ``` 64 | Or by setting the environment variables `GITHUB_WATCHMAN_HOST` and `GITHUB_WATCHMAN_PORT` 65 | -------------------------------------------------------------------------------- /docs/rules.md: -------------------------------------------------------------------------------- 1 | # Rules 2 | GitHub Watchman uses rules to provide the search terms to query GitHub and Regex patterns to filter out true positives. 3 | 4 | They are written in YAML, and follow this format: 5 | ```yaml 6 | --- 7 | filename: 8 | enabled: #[true|false] 9 | meta: 10 | name: 11 | author: 12 | date: 13 | description: #what the search should find# 14 | severity: #rating out of 100# 15 | scope: #what to search, any combination of the below# 16 | - code 17 | - commits 18 | - issues 19 | - repositories 20 | test_cases: 21 | match_cases: 22 | - #test case that should match the regex# 23 | fail_cases: 24 | - #test case that should not match the regex# 25 | strings: 26 | - #search query to use in GitHub# 27 | pattern: #Regex pattern to filter out false positives# 28 | ``` 29 | 30 | Rules are stored in the directory watchman/rules, so you can see examples there. 31 | 32 | **Scope** 33 | This is where GitHub should look: 34 | - code 35 | - commits 36 | - issues 37 | - repositories 38 | 39 | You can search for any combination of these, with each on its own line 40 | 41 | **Test cases** 42 | These test cases are used to check that the regex pattern works. Each rule should have at least one match (pass) and one fail case. 43 | 44 | If you want to return all results found by a query, enter the value `blank` for both cases. 45 | 46 | ## Creating your own rules 47 | You can easily create your own rules for GitHub Watchman. The two most important parts are the search queries and the regex pattern. 48 | 49 | ### Search queries 50 | These are stored as the entries in the 'strings' section of the rule, and are the search terms used to query GitHub to find results. 51 | 52 | Multiple entries can be put under strings to find as many potential hits as you can. So if I wanted to find passwords, I might use both of these search terms: 53 | `- password` 54 | `- password is` 55 | 56 | #### Search terminology 57 | The GitHub API uses query string syntax for search queries. You can see the GitHub documentation [here](https://docs.github.com/en/free-pro-team@latest/rest/reference/search#constructing-a-search-query) 58 | 59 | An example where search qualifiers are used: 60 | `GitHub+Octocat+in:readme+user:defunkt` 61 | 62 | The Search API returns a maximum of 1000 results, so your search queries should be as specific as possible to catch all true positives. 63 | 64 | ### Regex pattern 65 | This pattern is used to filter results that are returned by the search query. 66 | 67 | If you want to return all results found by a query, enter the value `''` for the pattern. 68 | -------------------------------------------------------------------------------- /github_watchman/__about__.py: -------------------------------------------------------------------------------- 1 | # GitHub Watchman 2 | # Copyright (C) 2020 PaperMtn 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU General Public License 15 | # along with this program. If not, see . 16 | 17 | __all__ = [ 18 | '__title__', 19 | '__summary__', 20 | '__uri__', 21 | '__version__', 22 | '__author__', 23 | '__email__', 24 | '__license__', 25 | ] 26 | 27 | __title__ = 'GitHub Watchman' 28 | __summary__ = 'Monitoring GitHub for sensitive data shared publicly' 29 | __uri__ = 'https://github.com/PaperMtn/github-watchman' 30 | __version__ = '1.0.1' 31 | __author__ = 'PaperMtn' 32 | __email__ = 'papermtn@protonmail.com' 33 | __license__ = 'GPL-3.0' 34 | __copyright__ = '2020 {}'.format(__author__) 35 | -------------------------------------------------------------------------------- /github_watchman/__init__.py: -------------------------------------------------------------------------------- 1 | import builtins 2 | import argparse 3 | import os 4 | import yaml 5 | import time 6 | from pathlib import Path 7 | from datetime import date 8 | from colorama import init, deinit 9 | from termcolor import colored 10 | 11 | import github_watchman.github_wrapper as github 12 | import github_watchman.__about__ as a 13 | import github_watchman.config as cfg 14 | import github_watchman.logger as logger 15 | 16 | 17 | RULES_PATH = (Path(__file__).parent / 'rules').resolve() 18 | OUTPUT_LOGGER = '' 19 | 20 | 21 | def validate_conf(path): 22 | """Check the file watchman.conf exists""" 23 | 24 | if os.environ.get('GITHUB_WATCHMAN_TOKEN') and os.environ.get('GITHUB_WATCHMAN_URL'): 25 | return True 26 | if os.path.exists(path): 27 | with open(path) as yaml_file: 28 | return yaml.safe_load(yaml_file).get('github_watchman') 29 | 30 | 31 | def search(github_connection, rule, tf, scope): 32 | if isinstance(OUTPUT_LOGGER, logger.StdoutLogger): 33 | print = OUTPUT_LOGGER.log_info 34 | else: 35 | print = builtins.print 36 | try: 37 | if scope == 'code': 38 | print(colored('Searching for {} in {}'.format(rule.get('meta').get('name'), 39 | 'code'), 'yellow')) 40 | 41 | code = github.search_code(github_connection, OUTPUT_LOGGER, rule, tf) 42 | if code: 43 | if isinstance(OUTPUT_LOGGER, logger.CSVLogger): 44 | OUTPUT_LOGGER.write_csv('exposed_{}'.format(rule.get('filename').split('.')[0]), 45 | 'code', 46 | code) 47 | else: 48 | for log_data in code: 49 | OUTPUT_LOGGER.log_notification(log_data, 'code', rule.get('meta').get('name'), 50 | rule.get('meta').get('severity')) 51 | print('Results output to log') 52 | 53 | if scope == 'commits': 54 | print(colored('Searching for {} in {}'.format(rule.get('meta').get('name'), 55 | 'commits'), 'yellow')) 56 | 57 | commits = github.search_commits(github_connection, OUTPUT_LOGGER, rule, tf) 58 | if commits: 59 | if isinstance(OUTPUT_LOGGER, logger.CSVLogger): 60 | OUTPUT_LOGGER.write_csv('exposed_{}'.format(rule.get('filename').split('.')[0]), 61 | 'commits', 62 | commits) 63 | else: 64 | for log_data in commits: 65 | OUTPUT_LOGGER.log_notification(log_data, 'commits', rule.get('meta').get('name'), 66 | rule.get('meta').get('severity')) 67 | print('Results output to log') 68 | 69 | if scope == 'issues': 70 | print(colored('Searching for {} in {}'.format(rule.get('meta').get('name'), 71 | 'issues'), 'yellow')) 72 | 73 | issues = github.search_issues(github_connection, OUTPUT_LOGGER, rule, tf) 74 | if issues: 75 | if isinstance(OUTPUT_LOGGER, logger.CSVLogger): 76 | OUTPUT_LOGGER.write_csv('exposed_{}'.format(rule.get('filename').split('.')[0]), 77 | 'issues', 78 | issues) 79 | else: 80 | for log_data in issues: 81 | OUTPUT_LOGGER.log_notification(log_data, 'issues', rule.get('meta').get('name'), 82 | rule.get('meta').get('severity')) 83 | print('Results output to log') 84 | 85 | if scope == 'repositories': 86 | print(colored('Searching for {} in {}'.format(rule.get('meta').get('name'), 87 | 'repositories'), 'yellow')) 88 | 89 | repositories = github.search_repositories(github_connection, OUTPUT_LOGGER, rule, tf) 90 | if repositories: 91 | if isinstance(OUTPUT_LOGGER, logger.CSVLogger): 92 | OUTPUT_LOGGER.write_csv('exposed_{}'.format(rule.get('filename').split('.')[0]), 93 | 'repositories', 94 | repositories) 95 | else: 96 | for log_data in repositories: 97 | OUTPUT_LOGGER.log_notification(log_data, 'wiki_blobs', rule.get('meta').get('name'), 98 | rule.get('meta').get('severity')) 99 | print('Results output to log') 100 | except Exception as e: 101 | if isinstance(OUTPUT_LOGGER, logger.StdoutLogger): 102 | print = OUTPUT_LOGGER.log_critical 103 | else: 104 | print = builtins.print 105 | 106 | print(colored(e, 'red')) 107 | 108 | 109 | def load_rules(): 110 | rules = [] 111 | try: 112 | for file in os.scandir(RULES_PATH): 113 | if file.name.endswith('.yaml'): 114 | with open(file) as yaml_file: 115 | rule = yaml.safe_load(yaml_file) 116 | if rule.get('enabled'): 117 | rules.append(rule) 118 | return rules 119 | except Exception as e: 120 | if isinstance(OUTPUT_LOGGER, logger.StdoutLogger): 121 | print = OUTPUT_LOGGER.log_critical 122 | else: 123 | print = builtins.print 124 | 125 | print(colored(e, 'red')) 126 | 127 | 128 | def main(): 129 | global OUTPUT_LOGGER 130 | try: 131 | init() 132 | 133 | parser = argparse.ArgumentParser(description=a.__summary__) 134 | required = parser.add_argument_group('required arguments') 135 | required.add_argument('--timeframe', choices=['d', 'w', 'm', 'a'], dest='time', 136 | help='How far back to search: d = 24 hours w = 7 days, m = 30 days, a = all time', 137 | required=True) 138 | required.add_argument('--output', choices=['csv', 'file', 'stdout', 'stream'], dest='logging_type', 139 | help='Where to send results', required=True) 140 | parser.add_argument('--version', action='version', 141 | version='github-watchman {}'.format(a.__version__)) 142 | parser.add_argument('--all', dest='everything', action='store_true', 143 | help='Find everything') 144 | parser.add_argument('--code', dest='code', action='store_true', 145 | help='Search code') 146 | parser.add_argument('--commits', dest='commits', action='store_true', 147 | help='Search commits') 148 | parser.add_argument('--issues', dest='issues', action='store_true', 149 | help='Search issues') 150 | parser.add_argument('--repositories', dest='repositories', action='store_true', 151 | help='Search merge requests') 152 | 153 | args = parser.parse_args() 154 | tm = args.time 155 | everything = args.everything 156 | code = args.code 157 | commits = args.commits 158 | repositories = args.repositories 159 | issues = args.issues 160 | logging_type = args.logging_type 161 | 162 | if tm == 'd': 163 | tf = cfg.DAY_TIMEFRAME 164 | elif tm == 'w': 165 | tf = cfg.WEEK_TIMEFRAME 166 | elif tm == 'm': 167 | tf = cfg.MONTH_TIMEFRAME 168 | else: 169 | tf = cfg.ALL_TIME 170 | conf_path = '{}/watchman.conf'.format(os.path.expanduser('~')) 171 | 172 | if not validate_conf(conf_path): 173 | raise Exception( 174 | colored('GITHUB_WATCHMAN_TOKEN environment variable or watchman.conf file not detected. ' 175 | '\nEnsure environment variable is set or a valid file is located in your home ' 176 | 'directory: {} ', 'red') 177 | .format(os.path.expanduser('~'))) 178 | else: 179 | config = validate_conf(conf_path) 180 | connection = github.initiate_github_connection() 181 | 182 | if logging_type: 183 | if logging_type == 'file': 184 | if os.environ.get('GITHUB_WATCHMAN_LOG_PATH'): 185 | OUTPUT_LOGGER = logger.FileLogger(os.environ.get('GITHUB_WATCHMAN_LOG_PATH')) 186 | elif config.get('logging').get('file_logging').get('path') and \ 187 | os.path.exists(config.get('logging').get('file_logging').get('path')): 188 | OUTPUT_LOGGER = logger.FileLogger(log_path=config.get('logging').get('file_logging').get('path')) 189 | else: 190 | print('No config given, outputting github_watchman.log file to home path') 191 | OUTPUT_LOGGER = logger.FileLogger(log_path=os.path.expanduser('~')) 192 | elif logging_type == 'stdout': 193 | OUTPUT_LOGGER = logger.StdoutLogger() 194 | elif logging_type == 'stream': 195 | if os.environ.get('GITHUB_WATCHMAN_HOST') and os.environ.get('GITHUB_WATCHMAN_PORT'): 196 | OUTPUT_LOGGER = logger.SocketJSONLogger(os.environ.get('GITHUB_WATCHMAN_HOST'), 197 | os.environ.get('GITHUB_WATCHMAN_PORT')) 198 | elif config.get('logging').get('json_tcp').get('host') and \ 199 | config.get('logging').get('json_tcp').get('port'): 200 | OUTPUT_LOGGER = logger.SocketJSONLogger(config.get('logging').get('json_tcp').get('host'), 201 | config.get('logging').get('json_tcp').get('port')) 202 | else: 203 | raise Exception("JSON TCP stream selected with no config") 204 | else: 205 | OUTPUT_LOGGER = logger.CSVLogger() 206 | else: 207 | print('No logging option selected, defaulting to CSV') 208 | OUTPUT_LOGGER = logger.CSVLogger() 209 | 210 | now = int(time.time()) 211 | today = date.today().strftime('%Y-%m-%d') 212 | start_date = time.strftime('%Y-%m-%d', time.localtime(now - tf)) 213 | 214 | if not isinstance(OUTPUT_LOGGER, logger.StdoutLogger): 215 | print = builtins.print 216 | print(colored(''' 217 | ##### # # 218 | # # # ##### # # # # ##### 219 | # # # # # # # # # 220 | # #### # # ####### # # ##### 221 | # # # # # # # # # # 222 | # # # # # # # # # # 223 | ##### # # # # #### ##### 224 | 225 | # # 226 | # # # ## ##### #### # # # # ## # # 227 | # # # # # # # # # # ## ## # # ## # 228 | # # # # # # # ###### # ## # # # # # # 229 | # # # ###### # # # # # # ###### # # # 230 | # # # # # # # # # # # # # # # ## 231 | ## ## # # # #### # # # # # # # # 232 | ''', 'magenta')) 233 | print('Version: {}\n'.format(a.__version__)) 234 | print('Searching from {} to {}'.format(start_date, today)) 235 | print('Importing rules...') 236 | rules_list = load_rules() 237 | print('{} rules loaded'.format(len(rules_list))) 238 | else: 239 | OUTPUT_LOGGER.log_info('GitHub Watchman started execution') 240 | OUTPUT_LOGGER.log_info('Version: {}'.format(a.__version__)) 241 | OUTPUT_LOGGER.log_info('Importing rules...') 242 | rules_list = load_rules() 243 | OUTPUT_LOGGER.log_info('{} rules loaded'.format(len(rules_list))) 244 | print = OUTPUT_LOGGER.log_info 245 | 246 | if everything: 247 | print(colored('Getting everything...', 'magenta')) 248 | for rule in rules_list: 249 | if 'code' in rule.get('scope'): 250 | search(connection, rule, tf, 'code') 251 | if 'commits' in rule.get('scope'): 252 | search(connection, rule, tf, 'commits') 253 | if 'issues' in rule.get('scope'): 254 | search(connection, rule, tf, 'issues') 255 | if 'repositories' in rule.get('scope'): 256 | search(connection, rule, tf, 'repositories') 257 | else: 258 | if code: 259 | print(colored('Searching blobs', 'magenta')) 260 | for rule in rules_list: 261 | if 'code' in rule.get('scope'): 262 | search(connection, rule, tf, 'code') 263 | if commits: 264 | print(colored('Searching commits', 'magenta')) 265 | for rule in rules_list: 266 | if 'commits' in rule.get('scope'): 267 | search(connection, rule, tf, 'commits') 268 | if issues: 269 | print(colored('Searching issues', 'magenta')) 270 | for rule in rules_list: 271 | if 'issues' in rule.get('scope'): 272 | search(connection, rule, tf, 'issues') 273 | if repositories: 274 | print(colored('Searching repositories', 'magenta')) 275 | for rule in rules_list: 276 | if 'repositories' in rule.get('scope'): 277 | search(connection, rule, tf, 'repositories') 278 | 279 | print(colored('++++++Audit completed++++++', 'green')) 280 | 281 | deinit() 282 | 283 | except Exception as e: 284 | if isinstance(OUTPUT_LOGGER, logger.StdoutLogger): 285 | print = OUTPUT_LOGGER.log_critical 286 | else: 287 | print = builtins.print 288 | 289 | print(colored(e, 'red')) 290 | 291 | 292 | if __name__ == '__main__': 293 | main() 294 | -------------------------------------------------------------------------------- /github_watchman/__main__.py: -------------------------------------------------------------------------------- 1 | from github_watchman import main 2 | 3 | main() 4 | -------------------------------------------------------------------------------- /github_watchman/config.py: -------------------------------------------------------------------------------- 1 | import calendar 2 | import time 3 | 4 | # Epoch time for 24 hours 5 | DAY_TIMEFRAME = 86400 6 | # Epoch time for 30 days 7 | MONTH_TIMEFRAME = 2592000 8 | # Epoch time for 7 days 9 | WEEK_TIMEFRAME = 604800 10 | # Epoch time for a very long time 11 | ALL_TIME = calendar.timegm(time.gmtime()) + 1576800000 12 | -------------------------------------------------------------------------------- /github_watchman/github_wrapper.py: -------------------------------------------------------------------------------- 1 | import builtins 2 | import calendar 3 | import json 4 | import os 5 | import re 6 | import time 7 | import requests 8 | import yaml 9 | from requests.exceptions import HTTPError 10 | from requests.packages.urllib3.util import Retry 11 | from requests.adapters import HTTPAdapter 12 | 13 | import github_watchman.config as cfg 14 | import github_watchman.logger as logger 15 | 16 | 17 | class GitHubAPIClient(object): 18 | 19 | def __init__(self, token, base_url): 20 | self.token = token 21 | self.base_url = base_url.rstrip('\\') 22 | self.per_page = 100 23 | self.session = session = requests.session() 24 | session.mount(self.base_url, HTTPAdapter(max_retries=Retry(connect=3, backoff_factor=1))) 25 | session.headers.update({ 26 | 'Authorization': 'token {}'.format(self.token), 27 | 'Accept': 'application/vnd.github.v3.text-match+json' 28 | }) 29 | 30 | if 'https://api.github.com' not in base_url and 'api/v3' not in base_url: 31 | self.base_url = '/'.join((base_url.rstrip('/'), 'api/v3')) 32 | else: 33 | self.base_url = base_url.rstrip('/') 34 | 35 | def make_request(self, url, params=None, data=None, method='GET', verify_ssl=True): 36 | try: 37 | response = self.session.request(method, url, params=params, data=data, verify=verify_ssl) 38 | response.raise_for_status() 39 | 40 | return response 41 | 42 | except HTTPError as http_error: 43 | if response.status_code == 400: 44 | if response.json().get('message').get('error'): 45 | raise Exception(response.json().get('message').get('error')) 46 | else: 47 | raise http_error 48 | elif response.status_code == 502 or response.status_code == 500: 49 | print('Retrying...') 50 | time.sleep(30) 51 | response = self.session.request(method, url, params=params, data=data, verify=verify_ssl) 52 | response.raise_for_status() 53 | return response 54 | elif response.status_code == 403: 55 | if response.headers.get('Retry-After'): 56 | print('GitHub API abuse limit hit - retrying in {} seconds'.format( 57 | (response.headers.get('Retry-After')))) 58 | time.sleep(int(response.headers.get('Retry-After')) + 2) 59 | response = self.session.request(method, url, params=params, data=data, verify=verify_ssl) 60 | response.raise_for_status() 61 | return response 62 | elif int(response.headers.get('X-RateLimit-Remaining')) == 0: 63 | print('GitHub API rate limit reached - cooling off') 64 | time.sleep(int(response.headers.get('X-RateLimit-Reset')) - int(time.time()) + 5) 65 | response = self.session.request(method, url, params=params, data=data, verify=verify_ssl) 66 | response.raise_for_status() 67 | return response 68 | else: 69 | print(response.headers) 70 | else: 71 | raise http_error 72 | except Exception as e: 73 | print(e) 74 | 75 | def multipage_search(self, url, query, media_type=None): 76 | """Wrapper for GitHub API methods that use pagination""" 77 | 78 | if media_type is None: 79 | media_type = 'application/vnd.github.v3.text-match+json' 80 | 81 | results = [] 82 | params = { 83 | 'per_page': self.per_page, 84 | 'q': query, 85 | 'page': 1 86 | } 87 | self.session.headers.update({'Accept': media_type}) 88 | 89 | response = self.make_request('/'.join((self.base_url, url)), params=params) 90 | for value in response.json().get('items'): 91 | results.append(value) 92 | 93 | if response.links.get('last'): 94 | total_pages = response.links.get('last').get('url')[response.links.get('last').get('url').rindex('=') + 1:] 95 | for page in range(2, int(total_pages) + 1): 96 | time.sleep(2) 97 | params['page'] = str(page) 98 | response = self.make_request('/'.join((self.base_url, url)), params=params) 99 | for value in response.json().get('items'): 100 | results.append(value) 101 | 102 | return results 103 | 104 | def get_user(self): 105 | return self.make_request('/'.join((self.base_url, 'user'))).json() 106 | 107 | def get_repository(self, fullname): 108 | return self.make_request('/'.join((self.base_url, 'repos/{}'.format(fullname)))).json() 109 | 110 | 111 | def initiate_github_connection(): 112 | """Create a GitHub API client object""" 113 | 114 | try: 115 | token = os.environ['GITHUB_WATCHMAN_TOKEN'] 116 | except KeyError: 117 | with open('{}/watchman.conf'.format(os.path.expanduser('~'))) as yaml_file: 118 | config = yaml.safe_load(yaml_file) 119 | 120 | token = config.get('github_watchman').get('token') 121 | 122 | try: 123 | url = os.environ['GITHUB_WATCHMAN_URL'] 124 | except KeyError: 125 | with open('{}/watchman.conf'.format(os.path.expanduser('~'))) as yaml_file: 126 | config = yaml.safe_load(yaml_file) 127 | 128 | url = config.get('github_watchman').get('url') 129 | 130 | return GitHubAPIClient(token, url) 131 | 132 | 133 | def convert_time(timestamp): 134 | """Convert ISO 8601 timestamp to epoch """ 135 | 136 | pattern = '%Y-%m-%dT%H:%M:%SZ' 137 | return int(time.mktime(time.strptime(timestamp, pattern))) 138 | 139 | 140 | def deduplicate(input_list): 141 | """Removes duplicates where results are returned by multiple queries""" 142 | 143 | list_of_strings = [json.dumps(d, sort_keys=True) for d in input_list] 144 | list_of_strings = set(list_of_strings) 145 | return [json.loads(s) for s in list_of_strings] 146 | 147 | 148 | def search_code(github: GitHubAPIClient, log_handler, rule, timeframe=cfg.ALL_TIME): 149 | """Uses the Search API to get code fragments matching a search term. 150 | This is then filtered by regex to find true matches""" 151 | 152 | results = [] 153 | now = calendar.timegm(time.gmtime()) 154 | if isinstance(log_handler, logger.StdoutLogger): 155 | print = log_handler.log_info 156 | else: 157 | print = builtins.print 158 | 159 | for query in rule.get('strings'): 160 | code_list = github.multipage_search('search/code', query) 161 | if code_list: 162 | print('{} code fragments found matching: {}'.format(len(code_list), query.replace('"', ''))) 163 | if timeframe != cfg.ALL_TIME: 164 | for code in code_list: 165 | r = re.compile(rule.get('pattern')) 166 | repository = github.get_repository(code.get('repository').get('full_name')) 167 | if convert_time(repository.get('updated_at')) > (now - timeframe) and r.search(str(code.get('text_matches'))): 168 | match_list = [] 169 | for match in code.get('text_matches'): 170 | match_list.append({ 171 | 'object_url': match.get('object_url'), 172 | 'object_type': match.get('object_type'), 173 | 'fragment': match.get('fragment') 174 | }) 175 | 176 | results_dict = { 177 | 'file_name': code.get('name'), 178 | 'file_url': code.get('html_url'), 179 | 'sha': code.get('sha'), 180 | 'repository': { 181 | 'repository_id': code.get('repository').get('id'), 182 | 'repository_node_id': code.get('repository').get('node_id'), 183 | 'repository_name': code.get('repository').get('name'), 184 | 'repository_url': code.get('repository').get('html_url'), 185 | }, 186 | 'matches': match_list 187 | } 188 | 189 | results.append(results_dict) 190 | else: 191 | for code in code_list: 192 | r = re.compile(rule.get('pattern')) 193 | if r.search(str(code.get('text_matches'))): 194 | match_list = [] 195 | for match in code.get('text_matches'): 196 | match_list.append({ 197 | 'object_url': match.get('object_url'), 198 | 'object_type': match.get('object_type'), 199 | 'fragment': match.get('fragment') 200 | }) 201 | 202 | results_dict = { 203 | 'file_name': code.get('name'), 204 | 'file_url': code.get('html_url'), 205 | 'sha': code.get('sha'), 206 | 'repository': { 207 | 'repository_id': code.get('repository').get('id'), 208 | 'repository_node_id': code.get('repository').get('node_id'), 209 | 'repository_name': code.get('repository').get('name'), 210 | 'repository_url': code.get('repository').get('html_url'), 211 | }, 212 | 'matches': match_list 213 | } 214 | 215 | results.append(results_dict) 216 | else: 217 | print('No code fragments found matching: {}'.format(query.replace('"', ''))) 218 | if results: 219 | results = deduplicate(results) 220 | print('{} total matches found after filtering'.format(len(results))) 221 | return results 222 | else: 223 | print('No matches found after filtering') 224 | 225 | 226 | def search_commits(github: GitHubAPIClient, log_handler, rule, timeframe=cfg.ALL_TIME): 227 | """Uses the Search API to get commits matching a search term. 228 | This is then filtered by regex to find true matches""" 229 | 230 | results = [] 231 | now = calendar.timegm(time.gmtime()) 232 | if isinstance(log_handler, logger.StdoutLogger): 233 | print = log_handler.log_info 234 | else: 235 | print = builtins.print 236 | 237 | pattern = '%Y-%m-%dT%H:%M:%S.%f%z' 238 | 239 | for query in rule.get('strings'): 240 | commit_list = github.multipage_search('search/commits', query, 'application/vnd.github.cloak-preview.text-match+json') 241 | if commit_list: 242 | print('{} commits found matching: {}'.format(len(commit_list), query.replace('"', ''))) 243 | for commit in commit_list: 244 | r = re.compile(rule.get('pattern')) 245 | commit_time = int(time.mktime(time.strptime(commit.get('commit').get('committer').get('date'), pattern))) 246 | if commit_time > (now - timeframe) and r.search(str(commit.get('text_matches'))): 247 | match_list = [] 248 | for match in commit.get('text_matches'): 249 | match_list.append({ 250 | 'object_url': match.get('object_url'), 251 | 'object_type': match.get('object_type'), 252 | 'fragment': match.get('fragment') 253 | }) 254 | 255 | results_dict = { 256 | 'commit_url': commit.get('html_url'), 257 | 'sha': commit.get('sha'), 258 | 'comments_url': commit.get('comments_url'), 259 | 'committer_name': commit.get('committer').get('name'), 260 | 'committer_id': commit.get('committer').get('id'), 261 | 'committer_email': commit.get('committer').get('email'), 262 | 'committer_login': commit.get('committer').get('email'), 263 | 'commit_date': commit.get('commit').get('committer').get('date'), 264 | 'message': commit.get('message'), 265 | 'repository': { 266 | 'repository_id': commit.get('repository').get('id'), 267 | 'repository_node_id': commit.get('repository').get('node_id'), 268 | 'repository_name': commit.get('repository').get('name'), 269 | 'repository_url': commit.get('repository').get('html_url'), 270 | }, 271 | 'matches': match_list 272 | } 273 | 274 | results.append(results_dict) 275 | else: 276 | print('No commits found matching: {}'.format(query.replace('"', ''))) 277 | if results: 278 | results = deduplicate(results) 279 | print('{} total matches found after filtering'.format(len(results))) 280 | return results 281 | else: 282 | print('No matches found after filtering') 283 | 284 | 285 | def search_issues(github: GitHubAPIClient, log_handler, rule, timeframe=cfg.ALL_TIME): 286 | """Uses the Search API to get issues matching a search term. 287 | This is then filtered by regex to find true matches""" 288 | 289 | results = [] 290 | now = calendar.timegm(time.gmtime()) 291 | if isinstance(log_handler, logger.StdoutLogger): 292 | print = log_handler.log_info 293 | else: 294 | print = builtins.print 295 | 296 | for query in rule.get('strings'): 297 | issue_list = github.multipage_search('search/issues', query) 298 | if issue_list: 299 | print('{} issues found matching: {}'.format(len(issue_list), query.replace('"', ''))) 300 | for issue in issue_list: 301 | r = re.compile(rule.get('pattern')) 302 | if convert_time(issue.get('updated_at')) > (now - timeframe) and r.search(str(issue.get('text_matches'))): 303 | match_list = [] 304 | for match in issue.get('text_matches'): 305 | match_list.append({ 306 | 'object_url': match.get('object_url'), 307 | 'object_type': match.get('object_type'), 308 | 'fragment': match.get('fragment') 309 | }) 310 | 311 | results_dict = { 312 | 'issue_id': issue.get('id'), 313 | 'issue_title': issue.get('title'), 314 | 'issue_body': issue.get('body'), 315 | 'issue_url': issue.get('html_url'), 316 | 'sha': issue.get('sha'), 317 | 'user_login': issue.get('user').get('login'), 318 | 'user_id': issue.get('user').get('id'), 319 | 'state': issue.get('state'), 320 | 'updated_at': issue.get('updated_at'), 321 | 'repository_url': issue.get('repository_url'), 322 | 'matches': match_list 323 | } 324 | 325 | results.append(results_dict) 326 | else: 327 | print('No issues found matching: {}'.format(len(issue_list), query.replace('"', ''))) 328 | if results: 329 | results = deduplicate(results) 330 | print('{} total matches found after filtering'.format(len(results))) 331 | return results 332 | else: 333 | print('No matches found after filtering') 334 | 335 | 336 | def search_repositories(github: GitHubAPIClient, log_handler, rule, timeframe=cfg.ALL_TIME): 337 | """Uses the Search API to get repositories matching a search term. 338 | This is then filtered by regex to find true matches""" 339 | 340 | results = [] 341 | now = calendar.timegm(time.gmtime()) 342 | if isinstance(log_handler, logger.StdoutLogger): 343 | print = log_handler.log_info 344 | else: 345 | print = builtins.print 346 | 347 | for query in rule.get('strings'): 348 | repo_list = github.multipage_search('search/repositories', query) 349 | if repo_list: 350 | print('{} repositories found matching: {}'.format(len(repo_list), query.replace('"', ''))) 351 | for repo in repo_list: 352 | r = re.compile(rule.get('pattern')) 353 | if convert_time(repo.get('updated_at')) > (now - timeframe) and r.search(str(repo.get('text_matches'))): 354 | match_list = [] 355 | for match in repo.get('text_matches'): 356 | match_list.append({ 357 | 'object_url': match.get('object_url'), 358 | 'object_type': match.get('object_type'), 359 | 'fragment': match.get('fragment') 360 | }) 361 | 362 | results_dict = { 363 | 'repository_id': repo.get('id'), 364 | 'repository_name': repo.get('full_name'), 365 | 'repository_description': repo.get('description'), 366 | 'repository_url': repo.get('html_url'), 367 | 'updated_at': repo.get('updated_at'), 368 | 'owner_login': repo.get('owner').get('login'), 369 | 'owner_id': repo.get('owner').get('id'), 370 | 'issue_url': repo.get('html_url'), 371 | 'matches': match_list 372 | } 373 | 374 | results.append(results_dict) 375 | else: 376 | print('No repositories found matching: {}'.format(query.replace('"', ''))) 377 | if results: 378 | results = deduplicate(results) 379 | print('{} total matches found after filtering'.format(len(results))) 380 | return results 381 | else: 382 | print('No matches found after filtering') 383 | -------------------------------------------------------------------------------- /github_watchman/logger.py: -------------------------------------------------------------------------------- 1 | import json 2 | import os 3 | import csv 4 | import logging 5 | import socket 6 | import sys 7 | import logging.handlers 8 | from datetime import datetime 9 | from logging import Logger 10 | 11 | 12 | class CSVLogger(object): 13 | def __init__(self): 14 | self.base_out_path = os.getcwd() 15 | self.headers = { 16 | 'code': [ 17 | 'file_name', 18 | 'file_url', 19 | 'sha', 20 | 'repository_id', 21 | 'repository_node_id', 22 | 'repository_name', 23 | 'repository_url', 24 | 'matches', 25 | ], 26 | 'commits': [ 27 | 'commit_url', 28 | 'sha', 29 | 'comments_url', 30 | 'committer_name', 31 | 'committer_id', 32 | 'committer_email', 33 | 'committer_login', 34 | 'commit_date', 35 | 'message', 36 | 'repository_id', 37 | 'repository_node_id', 38 | 'repository_name', 39 | 'repository_url', 40 | 'matches' 41 | ], 42 | 'issues': [ 43 | 'issue_id', 44 | 'issue_title', 45 | 'issue_body', 46 | 'issue_url', 47 | 'sha', 48 | 'user_login', 49 | 'user_id', 50 | 'state', 51 | 'updated_at', 52 | 'repository_url', 53 | 'matches' 54 | ], 55 | 'repositories': [ 56 | 'repository_id', 57 | 'repository_name', 58 | 'repository_description', 59 | 'repository_url', 60 | 'updated_at', 61 | 'owner_login', 62 | 'owner_id', 63 | 'issue_url', 64 | 'matches' 65 | ] 66 | } 67 | 68 | def write_csv(self, filename, scope, input_list): 69 | """Writes input list to .csv. The headers and output path are passed as variables""" 70 | 71 | path = '{}/{}_{}.csv'.format(self.base_out_path, filename, scope) 72 | 73 | with open(path, mode='w+', encoding='utf-8') as csv_file: 74 | writer = csv.DictWriter(csv_file, fieldnames=self.headers.get(scope)) 75 | writer.writeheader() 76 | for data in input_list: 77 | writer.writerow(data) 78 | 79 | csv_file.close() 80 | print('CSV written: {}'.format(path)) 81 | 82 | 83 | class LoggingBase(Logger): 84 | def __init__(self, name='GitHub Watchman'): 85 | super().__init__(name) 86 | self.notify_format = logging.Formatter( 87 | '{"localtime": "%(asctime)s", "level": "NOTIFY", "source": "%(name)s", "scope": "%(scope)s",' 88 | ' "severity": "%(severity)s", "detection_type": "%(type)s", "detection_data": %(message)s}') 89 | self.info_format = logging.Formatter( 90 | '{"localtime": "%(asctime)s", "level": "%(levelname)s", "source": "%(name)s", "message":' 91 | ' "%(message)s"}') 92 | self.log_path = '' 93 | self.logger = logging.getLogger(self.name) 94 | self.logger.setLevel(logging.DEBUG) 95 | 96 | 97 | class FileLogger(LoggingBase): 98 | def __init__(self, log_path): 99 | LoggingBase.__init__(self) 100 | self.handler = logging.handlers.WatchedFileHandler(os.path.join(log_path, 'github_watchman.log')) 101 | self.logger.addHandler(self.handler) 102 | 103 | def log_notification(self, log_data, scope, detect_type, severity): 104 | self.handler.setFormatter(self.notify_format) 105 | self.logger.warning(json.dumps(log_data), extra={ 106 | 'scope': scope, 107 | 'type': detect_type, 108 | 'severity': severity 109 | }) 110 | 111 | def log_info(self, log_data): 112 | self.handler.setFormatter(self.info_format) 113 | self.logger.info(log_data) 114 | 115 | def log_critical(self, log_data): 116 | self.handler.setFormatter(self.info_format) 117 | self.logger.critical(log_data) 118 | 119 | 120 | class StdoutLogger(LoggingBase): 121 | def __init__(self): 122 | LoggingBase.__init__(self) 123 | self.handler = logging.StreamHandler(sys.stdout) 124 | self.logger.addHandler(self.handler) 125 | 126 | def log_notification(self, log_data, scope, detect_type, severity): 127 | self.handler.setFormatter(self.notify_format) 128 | self.logger.warning(json.dumps(log_data), extra={ 129 | 'scope': scope, 130 | 'type': detect_type, 131 | 'severity': severity 132 | }) 133 | 134 | def log_info(self, log_data): 135 | self.handler.setFormatter(self.info_format) 136 | self.logger.info(log_data) 137 | 138 | def log_critical(self, log_data): 139 | self.handler.setFormatter(self.info_format) 140 | self.logger.critical(log_data) 141 | 142 | 143 | class SocketJSONLogger(object): 144 | def __init__(self, host, port): 145 | self.host = host 146 | self.port = port 147 | self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 148 | try: 149 | self.sock.connect((self.host, self.port)) 150 | except socket.error as error: 151 | print(error) 152 | 153 | def send(self, data): 154 | try: 155 | self.sock.sendall(bytes(data, encoding="utf-8")) 156 | except Exception as e: 157 | print(e) 158 | 159 | def log_notification(self, log_data, scope, detect_type, severity): 160 | message = json.dumps({ 161 | 'localtime': datetime.now().strftime('%Y-%m-%d %H:%M:%S,%f'), 162 | 'level': 'NOTIFY', 163 | 'source': 'GitHub Watchman', 164 | 'scope': scope, 165 | 'severity': severity, 166 | 'detection_type': detect_type, 167 | 'detection_data': log_data 168 | }) + '\n' 169 | self.send(message) 170 | 171 | def log_info(self, log_data): 172 | message = json.dumps({ 173 | 'localtime': datetime.now().strftime('%Y-%m-%d %H:%M:%S,%f'), 174 | 'level': 'INFO', 175 | 'source': 'GitHub Watchman', 176 | 'message': log_data 177 | }) + '\n' 178 | self.send(message) 179 | 180 | def log_critical(self, log_data): 181 | message = json.dumps({ 182 | 'localtime': datetime.now().strftime('%Y-%m-%d %H:%M:%S,%f'), 183 | 'level': 'CRITICAL', 184 | 'source': 'GitHub Watchman', 185 | 'message': log_data 186 | }) + '\n' 187 | self.send(message) 188 | -------------------------------------------------------------------------------- /github_watchman/rules/access_tokens.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | filename: access_tokens.yaml 3 | enabled: true 4 | meta: 5 | name: Access Tokens 6 | author: PaperMtn 7 | date: '2020-08-14' 8 | description: Detects exposed access_tokens 9 | severity: '70' 10 | scope: 11 | - code 12 | - commits 13 | - issues 14 | - repositories 15 | test_cases: 16 | match_cases: 17 | - 'ACCESS_TOKEN: 123456789abcdefg123456789123456789' 18 | fail_cases: 19 | - 'ACCESS_TOKEN: $ACCESS_TOKEN' 20 | strings: 21 | - '"access_token:"' 22 | pattern: (?i)('|"){0,2}access_token('|"){0,2}:(\s*)('|"){0,2}([0-9a-zA-Z!@#$&()\/\-`_.+,"]{30,})('|"){0,2} -------------------------------------------------------------------------------- /github_watchman/rules/aws_api_tokens.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | filename: aws_api_tokens.yaml 3 | enabled: true 4 | meta: 5 | name: AWS API Tokens 6 | author: PaperMtn 7 | date: '2020-08-14' 8 | description: Detects exposed AWS API secret tokens 9 | severity: '90' 10 | scope: 11 | - code 12 | - commits 13 | - issues 14 | - repositories 15 | test_cases: 16 | match_cases: 17 | - AbCdEfGh1234567890AbAbAb+aAb1111111111+= 18 | fail_cases: 19 | - AbCdEfGh1234567890AbAbAb+aAb1111111111+=AAA 20 | strings: 21 | - ASIA 22 | - AKIA 23 | pattern: "(?ConnectionString in:file extension:rdp" 24 | - "private in:file extension:jks" 25 | - "password in:file extension:.psafe3" 26 | - "password in:file extension:agilekeychain" 27 | - "password in:file extension:keychain" 28 | - "private in:file extension:kwallet" 29 | - "private in:file extension:tblk" 30 | - "filename:otr.private_key" 31 | - "filename:secret_token.rb" 32 | - "filename:publish_over_ssh.BapSshPublisherPlugin.xml" 33 | - "filename:credentials.xml" 34 | - "filename:knife.rb" 35 | - "filename:filezilla.xml" 36 | - "filename:terraform.tfvars" 37 | - "private in:file extension:tfvars" 38 | - "user in:file extension:htpasswd" 39 | - "user in:file extension:trc" 40 | - "private in:file extension:ssh" 41 | - "filename:.chef/*.pem" 42 | pattern: '' 43 | -------------------------------------------------------------------------------- /github_watchman/rules/misc_private_keys.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | filename: misc_private_keys.yaml 3 | enabled: true 4 | meta: 5 | name: Miscelaneous Private Keys 6 | author: PaperMtn 7 | date: '2020-08-14' 8 | description: Detects miscelaneous private keys that arent covered in other rules 9 | severity: '70' 10 | scope: 11 | - code 12 | - commits 13 | - issues 14 | - repositories 15 | test_cases: 16 | match_cases: 17 | - '"private_key": "-----BEGIN PRIVATE KEY-----AABBCCDDEEFFGGHHIIJJKK=\n-----END 18 | PRIVATE KEY-----\n' 19 | fail_cases: 20 | - '"private_key": $PRIVATE_KEY_FILE' 21 | strings: 22 | - '"BEGIN DSA PRIVATE"' 23 | - '"BEGIN EC PRIVATE"' 24 | - private in:file extension:key 25 | pattern: "(?s)(-----BEGIN .+?-----)\\S{0,}" 26 | -------------------------------------------------------------------------------- /github_watchman/rules/passwords.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | filename: passwords.yaml 3 | enabled: true 4 | meta: 5 | name: Passwords 6 | author: PaperMtn 7 | date: '2020-08-14' 8 | description: Detects potentially exposed passwords in plaintext 9 | severity: '70' 10 | scope: 11 | - code 12 | - commits 13 | - issues 14 | - repositories 15 | test_cases: 16 | match_cases: 17 | - 'Password: WeakPassword123' 18 | - The password is WeakPassword123 19 | fail_cases: 20 | - You need a strong password 21 | strings: 22 | - 'password:' 23 | - password is 24 | - passwd 25 | pattern: (?i)(password\s*[`=:\"]+\s*[^\s]+|password is\s*[`=:\"]*\s*[^\s]+|pwd\s*[`=:\"]*\s*[^\s]+|passwd\s*[`=:\"]+\s*[^\s]+) 26 | -------------------------------------------------------------------------------- /github_watchman/rules/pgp_private_keys.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | filename: pgp_private_keys.yaml 3 | enabled: true 4 | meta: 5 | name: PGP Private Keys 6 | author: PaperMtn 7 | date: '2020-08-14' 8 | description: Detects exposed PGP private keys 9 | severity: '90' 10 | scope: 11 | - code 12 | - commits 13 | - issues 14 | - repositories 15 | test_cases: 16 | match_cases: 17 | - '"private_key": "-----BEGIN PRIVATE KEY-----AABBCCDDEEFFGGHHIIJJKK=\n-----END 18 | PRIVATE KEY-----\n' 19 | fail_cases: 20 | - '"private_key": $PRIVATE_KEY_FILE' 21 | strings: 22 | - '"BEGIN PGP PRIVATE KEY BLOCK"' 23 | pattern: (?s)(-----BEGIN .+?-----)\\S{0,} 24 | -------------------------------------------------------------------------------- /github_watchman/rules/private_tokens.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | filename: private_tokens.yaml 3 | enabled: true 4 | meta: 5 | name: Private Tokens 6 | author: PaperMtn 7 | date: '2020-08-14' 8 | description: Detects exposed private_tokens 9 | severity: '70' 10 | scope: 11 | - code 12 | - commits 13 | - issues 14 | - repositories 15 | test_cases: 16 | match_cases: 17 | - 'PRIVATE-TOKEN: ''123456789abcdefg123456789123456789''' 18 | fail_cases: 19 | - 'PRIVATE-TOKEN: $PRIVATE_TOKEN' 20 | strings: 21 | - '"''PRIVATE-TOKEN'': "' 22 | - '"PRIVATE-TOKEN: "' 23 | pattern: (?i)('|"){0,2}private(-|_)token('|"){0,2}:(\s*)('|"){0,2}([0-9a-zA-Z!@#$&()\/\-`_.+,"]{20,})('|"){0,2} 24 | -------------------------------------------------------------------------------- /github_watchman/rules/s3_config_files.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | filename: s3_config_files.yaml 3 | enabled: true 4 | meta: 5 | name: S3 Configuration Files 6 | author: PaperMtn 7 | date: '2020-08-14' 8 | description: Detects exposed S3 configuration files 9 | severity: '70' 10 | scope: 11 | - code 12 | test_cases: 13 | match_cases: 14 | - secret_key = 123456789abcdefg123456789123456789 15 | fail_cases: 16 | - secret_key = $S3_SECRET_KEY 17 | strings: 18 | - secret in:file extension:s3cfg 19 | - secret in:file extension:ini 20 | - filename:s3cmd.ini 21 | pattern: (?i)('|"){0,2}secret_key('|"){0,2} = ('|"){0,2}([0-9a-zA-Z!@#$&()\/\-`_.+,"]{20,})('|"){0,2} 22 | -------------------------------------------------------------------------------- /github_watchman/rules/slack_api_tokens.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | filename: slack_api_tokens.yaml 3 | enabled: true 4 | meta: 5 | name: Slack API Tokens 6 | author: PaperMtn 7 | date: '2020-08-14' 8 | description: Detects exposed Slack API tokens 9 | severity: '70' 10 | scope: 11 | - code 12 | - commits 13 | - issues 14 | - repositories 15 | test_cases: 16 | match_cases: 17 | - API_KEY = xoxb-11111111111-a1a1a1a1a1a1a1a1a1a1a1a1 18 | fail_cases: 19 | - API_KEY = xoxb_slack_key12 20 | strings: 21 | - xoxb 22 | - xoxa 23 | - xoxp 24 | - xoxr 25 | - xoxs 26 | pattern: xox[baprs]([0-9a-zA-Z-]{10,72}) 27 | -------------------------------------------------------------------------------- /github_watchman/rules/slack_webhooks.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | filename: slack_webhooks.yaml 3 | enabled: true 4 | meta: 5 | name: Slack Webhooks 6 | author: PaperMtns 7 | date: '2020-08-14' 8 | description: Detects exposed Slack webhooks 9 | severity: '70' 10 | scope: 11 | - code 12 | - commits 13 | - issues 14 | - repositories 15 | test_cases: 16 | match_cases: 17 | - https://hooks.slack.com/services/T01010101/Babababab/aabab1212abab1212abababa 18 | fail_cases: 19 | - https://hooks.slack.com/ 20 | - http://hooks.slack.com/ 21 | strings: 22 | - https://hooks.slack.com/ 23 | pattern: https://hooks.slack.com/services/T[a-zA-Z0-9_]{8}/B[a-zA-Z0-9_]{8}/[a-zA-Z0-9_]{24} 24 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | import github_watchman.__about__ as a 3 | from setuptools import setup 4 | 5 | with open(os.path.join(os.path.abspath(os.path.dirname(__file__)), 'README.md')) as f: 6 | README = f.read() 7 | 8 | setup( 9 | name='github-watchman', 10 | version=a.__version__, 11 | url=a.__uri__, 12 | license=a.__license__, 13 | classifiers=[ 14 | 'Intended Audience :: Information Technology', 15 | 'Topic :: Security', 16 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 17 | 'Programming Language :: Python :: 3', 18 | 'Programming Language :: Python :: 3.5', 19 | 'Programming Language :: Python :: 3.6', 20 | 'Programming Language :: Python :: 3.7', 21 | 'Programming Language :: Python :: 3.8', 22 | ], 23 | author=a.__author__, 24 | author_email=a.__email__, 25 | long_description=README, 26 | long_description_content_type='text/markdown', 27 | description=a.__summary__, 28 | install_requires=[ 29 | 'requests', 30 | 'colorama', 31 | 'termcolor', 32 | 'PyYAML', 33 | ], 34 | packages=['github_watchman'], 35 | include_package_data=True, 36 | package_data={ 37 | "": ["*.yml", "*.yaml"], 38 | }, 39 | entry_points={ 40 | 'console_scripts': ['github-watchman=github_watchman:main'] 41 | } 42 | ) 43 | -------------------------------------------------------------------------------- /tests/test_rules.py: -------------------------------------------------------------------------------- 1 | import yaml 2 | import os 3 | import unittest 4 | from pathlib import Path 5 | 6 | RULES_PATH = (Path(__file__).parents[1] / 'watchman/rules').resolve() 7 | 8 | 9 | def load_rules(): 10 | rules = [] 11 | for file in os.scandir(RULES_PATH): 12 | if file.name.endswith('.yaml'): 13 | with open(file) as yaml_file: 14 | rule = yaml.safe_load(yaml_file) 15 | if rule.get('enabled'): 16 | rules.append(rule) 17 | return rules 18 | 19 | 20 | def check_yaml(rule): 21 | try: 22 | yaml_rule = yaml.safe_load(rule) 23 | except: 24 | return False 25 | return True 26 | 27 | 28 | class TestEmail(unittest.TestCase): 29 | def test_rule_format(self): 30 | """Check rules are properly formed YAML ready to be ingested""" 31 | 32 | for file in os.scandir(RULES_PATH): 33 | if file.name.endswith('.yaml'): 34 | with open(file) as yaml_file: 35 | self.assertTrue(check_yaml(yaml_file.read()), msg='Malformed YAML: {}'.format(yaml_file.name)) 36 | 37 | def test_rule_matching_cases(self): 38 | """Test that the match case strings match the regex. Skip if the match case is 'blank'""" 39 | 40 | rules_list = load_rules() 41 | for rule in rules_list: 42 | for test_case in rule.get('test_cases').get('match_cases'): 43 | if not test_case == 'blank': 44 | self.assertRegex(test_case, rule.get('pattern'), msg='Regex does not detect given match case') 45 | 46 | def test_rule_failing_cases(self): 47 | """Test that the fail case strings don't match the regex. Skip if the fail case is 'blank'""" 48 | 49 | rules_list = load_rules() 50 | for rule in rules_list: 51 | for test_case in rule.get('test_cases').get('fail_cases'): 52 | if not test_case == 'blank': 53 | self.assertNotRegex(test_case, rule.get('pattern'), 54 | msg='Regex does detect given failure case, it should ' 55 | 'not') 56 | 57 | 58 | if __name__ == '__main__': 59 | unittest.main() 60 | --------------------------------------------------------------------------------