diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..ceca094 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,5 @@ +.DS_Store +.idea +.git +.dockerignore +README.md \ No newline at end of file diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..11809a4 --- /dev/null +++ b/.env.example @@ -0,0 +1,129 @@ +# Default values are optimized for production to avoid having to configure +# much in production. +# +# However it should be easy to get going in development too. If you see an +# uncommented option that means it's either mandatory to set it or it's being +# overwritten in development to make your life easier. + +# Rather than use the directory name, let's control the name of the project. +export COMPOSE_PROJECT_NAME=leaktopus + +# In development avoid writing out bytecode to __pycache__ directories. +#PYTHONDONTWRITEBYTECODE= +export PYTHONDONTWRITEBYTECODE=true + +# You should generate a random string of 99+ characters for this value in prod. +# You can generate secure secrets by running: ./run flask secrets +export SECRET_KEY=insecure_key_for_dev + +# Which environment is running? These should be "development" or "production". +#export FLASK_ENV=production +export FLASK_ENV=development +#export NODE_ENV=production +export NODE_ENV=development + +# In development with Docker Desktop / Linux the default value should work. +# If you have Docker running in a custom VM, put the VM's IP here instead. +# +# In production you'll want to set this to your domain name or whatever you +# plan to access in your browser, such as example.com. +#export SERVER_NAME=localhost:8000 + +# The bind port for gunicorn. +# +# Be warned that if you change this value you'll need to change 8000 in both +# your Dockerfile and in a few spots in docker-compose.yml due to the nature of +# how this value can be set (Docker Compose doesn't support nested ENV vars). +#export PORT=8000 + +# How many workers and threads should your app use? WEB_CONCURRENCY defaults +# to the server's CPU count * 2. That is a good starting point. In development +# it's a good idea to use 1 to avoid race conditions when debugging. +#export WEB_CONCURRENCY= +export WEB_CONCURRENCY=1 +#export PYTHON_MAX_THREADS=1 + +# Do you want code reloading to work with the gunicorn app server? +#export WEB_RELOAD=false +export WEB_RELOAD=true + +# Should the Webpack watcher use polling? Not all Docker hosts support inotify. +# If you find your assets aren't updating in development then set this to true. +#export WEBPACK_WATCHER_POLL=false + +## What mail server should you connect to? +#export MAIL_SERVER=smtp.gmail.com +#export MAIL_PORT=587 +#export MAIL_USE_TLS=true +#export MAIL_USE_SSL=false +export MAIL_USERNAME= +export MAIL_PASSWORD= +#export MAIL_DEFAULT_SENDER=contact@local.host + +## Connection string to Redis. This will be used to connect directly to Redis +# and for Celery. You can always split your Redis servers up later if needed. +#export REDIS_URL=redis://redis:6379/0 + +# You can choose between DEBUG, INFO, WARNING, ERROR, CRITICAL or FATAL. +# DEBUG tends to get noisy but it could be useful for troubleshooting. +#export CELERY_LOG_LEVEL=info + +# Should Docker restart your containers if they go down in unexpected ways? +#export DOCKER_RESTART_POLICY=unless-stopped +export DOCKER_RESTART_POLICY=no + +# What healthcheck test command do you want to run? In development, having it +# curl your web server will result in a lot of log spam, so setting it to +# /bin/true is an easy way to make the healthcheck do basically nothing. +#export DOCKER_WEB_HEALTHCHECK_TEST=curl localhost:8000/up +export DOCKER_WEB_HEALTHCHECK_TEST=/bin/true + +# What ip:port should be published back to the Docker host for the app server? +# If you're using Docker Toolbox or a custom VM you can't use 127.0.0.1. This +# is being overwritten in dev to be compatible with more dev environments. +# +# If you have a port conflict because something else is using 8000 then you +# can either stop that process or change this 8000 to be something else. +# +# Use the default in production to avoid having gunicorn directly accessible to +# the internet since it'll very likely be behind nginx or a load balancer. +#export DOCKER_WEB_PORT_FORWARD=127.0.0.1:8000 +export DOCKER_WEB_PORT_FORWARD=8000 + +# What volume path should be used? In development we want to volume mount +# everything so we can develop our code without rebuilding our Docker images. +#export DOCKER_WEB_VOLUME=./public:/app/public +export DOCKER_WEB_VOLUME=.:/app + +# What CPU and memory constraints will be added to your services? When left at +# 0, they will happily use as much as needed. +#export DOCKER_REDIS_CPUS=0 +#export DOCKER_REDIS_MEMORY=0 +#export DOCKER_WEB_CPUS=0 +#export DOCKER_WEB_MEMORY=0 +#export DOCKER_WORKER_CPUS=0 +#export DOCKER_WORKER_MEMORY=0 + +# GitPython Variables +export GIT_PYTHON_REFRESH=quiet + +export ELK_VERSION=7.17.4 + +export GITHUB_ACCESS_TOKEN=[GITHUB_ACCESS_TOKEN] +export ES_INDEXING_ENABLED=1 +export ES_HOST=elasticsearch +export ES_PORT=9200 +export ES_USER=elastic +export ES_PASS=changeme +export CLONES_DIR=/data/ + +# Cron Interval in seconds, default of 15 minutes. +export CRON_INTERVAL=900 +# Teams webhook +#export TEAMS_WEBHOOK_URL=https://company-name.webhook.office.com/webhookb2/token + +# HTTPS enabled flag +export HTTPS_ENABLED=0 + +# Frontend environment variables +export LEAKTOPUS_API_URL=http://localhost:8000/ diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b03a02c --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +.idea +.DS_Store +.env +app/*.pem +docker-compose.override.yml +venv +*.sqlite diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..631d168 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# Contribution guidelines + +## Development Environment Setup +If you wish to contribute to Leaktopus or run it in development mode, please follow this section. + +### Customized Docker compose for development +The dev version of docker-compose shares the volumes with the host machine for easy debugging and development. +```bash +docker-compose -f docker-compose.dev.yml -f docker-compose.override.yml up +``` + +### Without Docker (Manual) +#### Prerequisites + - Python > 3.7 + - Pip + - Node > 17.x +#### Backend +```bash +cd leaktopus_backend + +# Required for using our .env file. +pip install python-dotenv + +# Install all the dependencies. +pip install -r requirements.txt + +# Run the application locally. +FLASK_APP="`pwd`/leaktopus/app.py" FLASK_DEBUG=1 flask run -p 8000 + +# To debug celery worker add these lines to the setting.py file. +import dotenv +dotenv.load_dotenv('./.env') +``` + +#### Frontend +```bash +cd leaktopus_frontend + +npm install +npm run serve +``` +--- + +## Development/Monitoring Services +In addition to the services mentioned on the README.md file, +the following services can be used for development and advanced monitoring purposes: + +| Service | Port | Documentation | +| ------------- | ------------- | ------------- | +| Flower | 5555 | https://flower.readthedocs.io/en/latest/ | +| Redis Commander | 8081 | https://github.com/joeferner/redis-commander | + +_See docker-compose.override.example.yml for deployment examples._ \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..9c8f3ea --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..40e8cac --- /dev/null +++ b/README.md @@ -0,0 +1,122 @@ +
ID | +Search Query | +Status | +Created At | +Completed At | +Actions | + + +
---|---|---|---|---|---|
{{ scan.scan_id }} | +{{ scan.search_query }} | +{{ scan.status_human }} | +{{ scan.created_at }} | +{{ scan.completed_at }} | ++ + + | +
ID | +Pattern | +Actions | + + +
---|---|---|
{{ ignore.id }} | +{{ ignore.pattern }} | ++ + | +