feat: init
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed

This commit is contained in:
Aravinth Manivannan 2024-01-02 19:16:37 +05:30
commit 1770515e94
Signed by: realaravinth
GPG key ID: F8F50389936984FF
7 changed files with 394 additions and 0 deletions

3
.env_sample Normal file
View file

@ -0,0 +1,3 @@
export USERNAME=
export PASSWORD=
export INSTANCE_URL=

166
.gitignore vendored Normal file
View file

@ -0,0 +1,166 @@
/target
/Cargo.lock
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
tmp/
.env
html/
.env.local

45
.woodpecker.yml Normal file
View file

@ -0,0 +1,45 @@
steps:
postgres:
image: postgres
detach: true
environment:
- POSTGRES_PASSWORD=password
cache:
image: mcaptcha/cache:latest
detach: true
mcaptcha:
image: mcaptcha/mcaptcha:latest
detach: true
environment:
- DATABASE_URL=postgres://postgres:password@postgres:5432/postgres # set password at placeholder
- RUST_LOG=debug
- PORT=7000
- MCAPTCHA_server_IP=0.0.0.0
- MCAPTCHA_server_DOMAIN=mcaptcha
- MCAPTCHA_server_COOKIE_SECRET=4d08c163c0b9780e7462893fd8aed5102c2c509f
- MCAPTCHA_captcha_SALT=4d08c163c0b9780e7462893fd8aed5102c2c509f
- MCAPTCHA_redis_URL=redis://cache/
- MCAPTCHA_redis_POOL=4
- MCAPTCHA_allow_demo=true
test_setup:
image: python
environment:
- USERNAME=aaronsw
- PASSWORD=password
- INSTANCE_URL=http://mcaptcha:7000
commands:
- pip install virtualenv && virtualenv venv
- make env
- make test.env
test:
image: rust
environment:
- USERNAME=aaronsw
- PASSWORD=password
- INSTANCE_URL=http://mcaptcha:7000
commands:
- . .env.local && echo $TOKEN $SITEKY

25
Makefile Normal file
View file

@ -0,0 +1,25 @@
env:
./scripts/download-cli.sh download
. venv/bin/activate && pip install -r requirements.txt
. venv/bin/activate && pip install build
test.env:
$(eval SECRET = $(shell . ./venv/bin/activate && python ./scripts/create_captcha.py get_secret $(INSTANCE_URL) $(USERNAME) $(PASSWORD)))
$(eval SITEKEY = $(shell . ./venv/bin/activate && python ./scripts/create_captcha.py create_captcha $(INSTANCE_URL) $(USERNAME) $(PASSWORD)))
$(eval WIDGET_URL = $(shell . ./venv/bin/activate && python ./scripts/create_captcha.py widget_url $(INSTANCE_URL) $(SITEKEY)))
$(eval TOKEN = $(shell ./scripts/download-cli.sh gen_pow $(WIDGET_URL)))
@-rm .env.local
echo "export SECRET=$(SECRET)" > .env.local
echo "export SITEKEY=$(SITEKEY)" >> .env.local
echo "export WIDGET_URL=$(WIDGET_URL)" >> .env.local
echo "export TOKEN=$(TOKEN)" >> .env.local
test:
. env.local && . && \
SITEKEY=$(SITEKEY) SECRET=$(SECRET) \
INSTANCE_URL=$(INSTANCE_URL) \
TOKEN=$(TOKEN) pytest
lint:
black src/ scripts/

7
requirements.txt Normal file
View file

@ -0,0 +1,7 @@
certifi==2023.11.17
charset-normalizer==3.3.2
idna==3.6
iniconfig==2.0.0
pluggy==1.3.0
requests==2.31.0
urllib3==2.1.0

114
scripts/create_captcha.py Normal file
View file

@ -0,0 +1,114 @@
# SPDX-FileCopyrightText: 2023 Aravinth Manivannan <realaravinth@batsense.net>
#
# SPDX-License-Identifier: Apache-2.0
# SPDX-License-Identifier: MIT
import sys
from urllib.parse import urlparse, urlunparse, urlencode, parse_qsl
from requests import Session
def clean_url(url):
parsed = urlparse(url)
return urlunparse((parsed.scheme, parsed.netloc, "", "", "", ""))
def set_path(url: str, path: str) -> str:
parsed = urlparse(url)
return urlunparse((parsed.scheme, parsed.netloc, path, "", "", ""))
def help():
print("Usage: create_captcha.py <option>")
print("OPTIONS:\ncreate_captcha <mcaptcha_instance_url> <username> <password>")
print("get_secret <mcaptcha_instance_url> <username> <password>")
print("widget_url <mcaptcha_instance_url> <sitekey>")
c = Session()
if len(sys.argv) < 1:
help()
exit(1)
option = sys.argv[1]
def login():
if len(sys.argv) < 4:
help()
exit(1)
instance_url = clean_url(sys.argv[2])
username = sys.argv[3]
password = sys.argv[4]
url = set_path(instance_url, "/api/v1/signin")
payload = {"login": username, password: password}
resp = c.post(url, json=payload)
assert resp.status_code == 200
def create_captcha():
instance_url = clean_url(sys.argv[2])
username = sys.argv[3]
password = sys.argv[4]
levels = [
{"difficulty_factor": 50, "visitor_threshold": 50},
{"difficulty_factor": 500, "visitor_threshold": 500},
]
payload = {
"levels": levels,
"duration": 30,
"description": "create_captcha_test_script",
"publish_benchmarks": False,
}
url = set_path(instance_url, "/api/v1/mcaptcha/create")
resp = c.post(url, json=payload, cookies=c.cookies.get_dict())
assert resp.status_code == 200
return resp.json()["key"]
def get_secret():
if len(sys.argv) < 3:
help()
exit(1)
instance_url = clean_url(sys.argv[2])
username = sys.argv[3]
password = sys.argv[4]
instance_url = clean_url(sys.argv[2])
sitekey = sys.argv[3]
url = set_path(instance_url, "/api/v1/account/secret/get")
resp = c.get(url, cookies=c.cookies.get_dict())
assert resp.status_code == 200
return resp.json()["secret"]
def widget_url():
if len(sys.argv) < 4:
help()
exit(1)
instance_url = set_path(clean_url(sys.argv[2]), "/widget")
sitekey = sys.argv[3]
query = urlencode({"sitekey": sitekey})
url = f"{instance_url}?{query}"
return url
if __name__ == "__main__":
if option == "create_captcha":
login()
print(create_captcha())
elif option == "get_secret":
login()
print(get_secret())
elif option == "widget_url":
print(widget_url())
else:
help()

34
scripts/download-cli.sh Executable file
View file

@ -0,0 +1,34 @@
#!/bin/bash
# SPDX-FileCopyrightText: 2023 Aravinth Manivannan <realaravinth@batsense.net>
#
# SPDX-License-Identifier: Apache-2.0
# SPDX-License-Identifier: MIT
readonly PROJECT_ROOT=$(pwd)
readonly SOURCE=https://dl.mcaptcha.org/mcaptcha/cli/0.3.0/x86_64-unknown-linux-gnu.tar.gz
readonly BIN_PATH=tmp/cli/mcaptcha-cli
readonly TARBALL=mcaptcha-cli.tar.gz
download() {
if [ ! -e $BIN_PATH ];
then
mkdir -p tmp/cli
cd tmp/cli/
wget $SOURCE --quiet --output-document=$TARBALL $SOURCE
tar -xvzf $TARBALL > /dev/null
rm $TARBALL
echo "[*] Downloaded mCaptcha CLI"
mv build/x86_64-unknown-linux-gnu/mcaptcha-cli .
rm -rf build/
cd $PROJECT_ROOT
fi
}
# 1: widget URI
gen_pow() {
$BIN_PATH widget-url $2 | cut -d ':' -f 2 | tr -d ' '
}
$1 $@