Compare commits
No commits in common. "main" and "v0.1" have entirely different histories.
26 changed files with 508 additions and 787 deletions
|
@ -1,38 +0,0 @@
|
|||
---
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "v*"
|
||||
|
||||
jobs:
|
||||
|
||||
build_wheel:
|
||||
runs-on: docker
|
||||
steps:
|
||||
- uses: https://code.forgejo.org/actions/checkout@v4
|
||||
- name: Build Python wheel
|
||||
run: |
|
||||
apt update; apt install -y python3-pip
|
||||
pip3 install --break-system-packages -e .[test]
|
||||
python3 setup.py egg_info bdist_wheel
|
||||
- uses: https://git.kabelsalat.ch/s3lph/forgejo-action-wheel-package-upload@v3
|
||||
with:
|
||||
username: ${{ secrets.API_USERNAME }}
|
||||
password: ${{ secrets.API_PASSWORD }}
|
||||
|
||||
build_debian:
|
||||
runs-on: docker
|
||||
steps:
|
||||
- uses: https://code.forgejo.org/actions/checkout@v4
|
||||
- uses: https://git.kabelsalat.ch/s3lph/forgejo-action-python-debian-package@v5
|
||||
with:
|
||||
python_module: multischleuder
|
||||
package_name: multischleuder
|
||||
package_root: package/debian/multischleuder
|
||||
package_output_path: package/debian
|
||||
- uses: https://git.kabelsalat.ch/s3lph/forgejo-action-debian-package-upload@v2
|
||||
with:
|
||||
username: ${{ secrets.API_USERNAME }}
|
||||
password: ${{ secrets.API_PASSWORD }}
|
||||
deb: "package/debian/*.deb"
|
|
@ -1,77 +0,0 @@
|
|||
---
|
||||
|
||||
on: push
|
||||
|
||||
jobs:
|
||||
|
||||
test:
|
||||
runs-on: docker
|
||||
steps:
|
||||
- uses: https://code.forgejo.org/actions/checkout@v4
|
||||
- name: Unit Tests
|
||||
run: |
|
||||
apt update; apt install -y python3-pip
|
||||
pip3 install --break-system-packages -e .[test]
|
||||
python3 -m coverage run --rcfile=setup.cfg -m unittest discover multischleuder
|
||||
python3 -m coverage combine
|
||||
python3 -m coverage report --rcfile=setup.cfg
|
||||
|
||||
codestyle:
|
||||
runs-on: docker
|
||||
steps:
|
||||
- uses: https://code.forgejo.org/actions/checkout@v4
|
||||
- name: Code Style
|
||||
run: |
|
||||
apt update; apt install -y python3-pip
|
||||
pip3 install --break-system-packages -e .[test]
|
||||
pycodestyle multischleuder
|
||||
|
||||
mypy:
|
||||
runs-on: docker
|
||||
steps:
|
||||
- uses: https://code.forgejo.org/actions/checkout@v4
|
||||
- name: Static Type Checks
|
||||
run: |
|
||||
apt update; apt install -y python3-pip
|
||||
pip3 install --break-system-packages -e .[test]
|
||||
pip3 install --break-system-packages types-PyYAML types-python-dateutil
|
||||
mypy multischleuder
|
||||
|
||||
schleuder:
|
||||
runs-on: docker
|
||||
steps:
|
||||
- uses: https://code.forgejo.org/actions/checkout@v4
|
||||
- name: Integration Test against schleuder
|
||||
run: |
|
||||
echo "postfix postfix/mailname string example.org" | debconf-set-selections
|
||||
echo "postfix postfix/main_mailer_type string 'Local only'" | debconf-set-selections
|
||||
apt update; apt install --yes python3-pip schleuder schleuder-cli postfix patch
|
||||
pip3 install --break-system-packages -e .[test]
|
||||
/usr/lib/postfix/configure-instance.sh -
|
||||
echo "virtual_alias_maps = static:root" >> /etc/postfix/main.cf
|
||||
/usr/sbin/postmulti -i - -p start
|
||||
schleuder-cli lists list || true
|
||||
export CERT_FPR=$(schleuder cert fingerprint | cut -d' ' -f4)
|
||||
echo " - '00000000000000000000000000000000'" >> /etc/schleuder/schleuder.yml
|
||||
cat > ~/.schleuder-cli/schleuder-cli.yml <<EOF
|
||||
host: localhost
|
||||
port: 4443
|
||||
tls_fingerprint: ${CERT_FPR}
|
||||
api_key: '00000000000000000000000000000000'
|
||||
EOF
|
||||
/usr/bin/schleuder-api-daemon &
|
||||
sleep 5 # wait for daemons to start
|
||||
export API_DAEMON_PID=$!
|
||||
test/prepare-schleuder.sh
|
||||
pip3 install --break-system-packages -e .
|
||||
python3 -c 'import os; print(os.listdir(".")); print(); print(os.listdir("test/"))'
|
||||
python3 -m coverage run --rcfile=setup.cfg -m multischleuder --config test/multischleuder.yml --verbose
|
||||
# Run a second time - should be idempotent and not trigger any new mails
|
||||
python3 -m coverage run --rcfile=setup.cfg -m multischleuder --config test/multischleuder.yml --verbose
|
||||
python3 -m coverage combine
|
||||
python3 -m coverage report --rcfile=setup.cfg
|
||||
sleep 5 # wait for mail delivery
|
||||
test/report.py
|
||||
kill -9 ${API_DAEMON_PID} || true
|
||||
/usr/sbin/postmulti -i - -p stop
|
||||
sleep 5 # wait for daemons to terminate
|
142
.gitlab-ci.yml
Normal file
142
.gitlab-ci.yml
Normal file
|
@ -0,0 +1,142 @@
|
|||
---
|
||||
image: python:3.9-bullseye
|
||||
|
||||
stages:
|
||||
- test
|
||||
- coverage
|
||||
- build
|
||||
- deploy
|
||||
|
||||
|
||||
|
||||
before_script:
|
||||
- pip3 install coverage pycodestyle mypy aiosmtpd deepdiff
|
||||
- export MULTISCHLEUDER_VERSION=$(python -c 'import multischleuder; print(multischleuder.__version__)')
|
||||
|
||||
|
||||
|
||||
test:
|
||||
stage: test
|
||||
script:
|
||||
- pip3 install -e .
|
||||
- python3 -m coverage run --rcfile=setup.cfg -m unittest discover multischleuder
|
||||
artifacts:
|
||||
paths:
|
||||
- ".coverage*"
|
||||
|
||||
codestyle:
|
||||
stage: test
|
||||
script:
|
||||
- pip3 install -e .
|
||||
- pycodestyle multischleuder
|
||||
|
||||
mypy:
|
||||
stage: test
|
||||
script:
|
||||
- pip3 install -e .
|
||||
- mypy --install-types --non-interactive multischleuder
|
||||
- mypy multischleuder
|
||||
|
||||
schleuder:
|
||||
stage: test
|
||||
script:
|
||||
- debconf-set-selections <<<"postfix postfix/mailname string example.org"
|
||||
- debconf-set-selections <<<"postfix postfix/main_mailer_type string 'Local only'"
|
||||
- apt update; apt install --yes schleuder schleuder-cli postfix
|
||||
- /usr/lib/postfix/configure-instance.sh -
|
||||
- echo "virtual_alias_maps = static:root" >> /etc/postfix/main.cf
|
||||
- /usr/sbin/postmulti -i - -p start
|
||||
- schleuder-cli lists list || true
|
||||
- export CERT_FPR=$(schleuder cert fingerprint | cut -d' ' -f4)
|
||||
- echo " - '00000000000000000000000000000000'" >> /etc/schleuder/schleuder.yml
|
||||
- |
|
||||
cat > ~/.schleuder-cli/schleuder-cli.yml <<EOF
|
||||
host: localhost
|
||||
port: 4443
|
||||
tls_fingerprint: ${CERT_FPR}
|
||||
api_key: '00000000000000000000000000000000'
|
||||
EOF
|
||||
- /usr/bin/schleuder-api-daemon &
|
||||
- sleep 5 # wait for daemons to start
|
||||
- export API_DAEMON_PID=$!
|
||||
- test/prepare-schleuder.sh
|
||||
- pip3 install -e .
|
||||
- python3 -c 'import os; print(os.listdir(".")); print(); print(os.listdir("test/"))'
|
||||
- python3 -m coverage run --rcfile=setup.cfg -m multischleuder --config test/multischleuder.yml --verbose
|
||||
# Run a second time - should be idempotent and not trigger any new mails
|
||||
- python3 -m coverage run --rcfile=setup.cfg -m multischleuder --config test/multischleuder.yml --verbose
|
||||
- sleep 5 # wait for mail delivery
|
||||
- test/report.py
|
||||
- kill -9 ${API_DAEMON_PID} || true
|
||||
- /usr/sbin/postmulti -i - -p stop
|
||||
- sleep 5 # wait for daemons to terminate
|
||||
artifacts:
|
||||
paths:
|
||||
- ".coverage*"
|
||||
|
||||
|
||||
|
||||
coverage:
|
||||
stage: coverage
|
||||
script:
|
||||
- python3 -m coverage combine
|
||||
- python3 -m coverage report --rcfile=setup.cfg
|
||||
|
||||
|
||||
|
||||
build_wheel:
|
||||
stage: build
|
||||
script:
|
||||
- python3 setup.py egg_info bdist_wheel
|
||||
- cd dist
|
||||
- sha256sum *.whl > SHA256SUMS
|
||||
artifacts:
|
||||
paths:
|
||||
- "dist/*.whl"
|
||||
- dist/SHA256SUMS
|
||||
only:
|
||||
- tags
|
||||
|
||||
build_debian:
|
||||
stage: build
|
||||
script:
|
||||
- apt update && apt install --yes lintian rsync sudo
|
||||
- echo -n > package/debian/multischleuder/usr/share/doc/multischleuder/changelog
|
||||
- |
|
||||
for version in "$(cat CHANGELOG.md | grep '<!-- BEGIN CHANGES' | cut -d ' ' -f 4)"; do
|
||||
echo "multischleuder (${version}-1); urgency=medium\n" >> package/debian/multischleuder/usr/share/doc/multischleuder/changelog
|
||||
cat CHANGELOG.md | grep -A 1000 "<"'!'"-- BEGIN CHANGES ${version} -->" | grep -B 1000 "<"'!'"-- END CHANGES ${version} -->" | tail -n +2 | head -n -1 | sed -re 's/^-/ */g' >> package/debian/multischleuder/usr/share/doc/multischleuder/changelog
|
||||
echo "\n -- ${PACKAGE_AUTHOR} $(date -R)\n" >> package/debian/multischleuder/usr/share/doc/multischleuder/changelog
|
||||
done
|
||||
- gzip -9n package/debian/multischleuder/usr/share/doc/multischleuder/changelog
|
||||
- python3 setup.py egg_info install --root=package/debian/multischleuder/ --prefix=/usr --optimize=1
|
||||
- cd package/debian
|
||||
- sed -re "s/__MULTISCHLEUDER_VERSION__/${MULTISCHLEUDER_VERSION}/g" -i multischleuder/DEBIAN/control
|
||||
- mkdir -p multischleuder/usr/lib/python3/dist-packages/
|
||||
- rsync -a multischleuder/usr/lib/python3.9/site-packages/ multischleuder/usr/lib/python3/dist-packages/
|
||||
- rm -rf multischleuder/usr/lib/python3.9/site-packages
|
||||
- find multischleuder/usr/lib/python3/dist-packages -name __pycache__ -exec rm -r {} \; 2>/dev/null || true
|
||||
- find multischleuder/usr/lib/python3/dist-packages -name '*.pyc' -exec rm {} \;
|
||||
- find multischleuder/usr/lib/python3/dist-packages -name '*.pyo' -exec rm {} \;
|
||||
- sed -re 's$#!/usr/local/bin/python3$#!/usr/bin/python3$' -i multischleuder/usr/bin/multischleuder
|
||||
- find multischleuder -type f -exec chmod 0644 {} \;
|
||||
- find multischleuder -type d -exec chmod 755 {} \;
|
||||
- chmod +x multischleuder/usr/bin/multischleuder multischleuder/DEBIAN/postinst multischleuder/DEBIAN/prerm multischleuder/DEBIAN/postrm
|
||||
- dpkg-deb --build multischleuder
|
||||
- mv multischleuder.deb "multischleuder_${MULTISCHLEUDER_VERSION}-1_all.deb"
|
||||
- sudo -u nobody lintian "multischleuder_${MULTISCHLEUDER_VERSION}-1_all.deb"
|
||||
- sha256sum *.deb > SHA256SUMS
|
||||
artifacts:
|
||||
paths:
|
||||
- "package/debian/*.deb"
|
||||
- package/debian/SHA256SUMS
|
||||
only:
|
||||
- tags
|
||||
|
||||
|
||||
release:
|
||||
stage: deploy
|
||||
script:
|
||||
- python3 package/release.py
|
||||
only:
|
||||
- tags
|
126
CHANGELOG.md
126
CHANGELOG.md
|
@ -1,128 +1,4 @@
|
|||
# MultiSchleuder Changelog
|
||||
|
||||
<!-- BEGIN RELEASE v0.1.9 -->
|
||||
## Version 0.1.9
|
||||
|
||||
Maintenance Release
|
||||
|
||||
### Changes
|
||||
|
||||
<!-- BEGIN CHANGES 0.1.9 -->
|
||||
- Migrate from Woodpecker to Forgejo Actions
|
||||
<!-- END CHANGES 0.1.9 -->
|
||||
|
||||
<!-- END RELEASE v0.1.9 -->
|
||||
|
||||
<!-- BEGIN RELEASE v0.1.8 -->
|
||||
## Version 0.1.8
|
||||
|
||||
Maintenance Release
|
||||
|
||||
### Changes
|
||||
|
||||
<!-- BEGIN CHANGES 0.1.8 -->
|
||||
- Migrate from Gitlab-CI to Woodpecker
|
||||
<!-- END CHANGES 0.1.8 -->
|
||||
|
||||
<!-- END RELEASE v0.1.8 -->
|
||||
|
||||
<!-- BEGIN RELEASE v0.1.7 -->
|
||||
## Version 0.1.7
|
||||
|
||||
Bugfix Release
|
||||
|
||||
### Changes
|
||||
|
||||
<!-- BEGIN CHANGES 0.1.7 -->
|
||||
- Remove and re-import keys whose expiry date has been changed
|
||||
- Don't report keys as changed if they appear to differ, but are treated as identical by GnuPG.
|
||||
<!-- END CHANGES 0.1.7 -->
|
||||
|
||||
<!-- END RELEASE v0.1.7 -->
|
||||
|
||||
<!-- BEGIN RELEASE v0.1.6 -->
|
||||
## Version 0.1.6
|
||||
|
||||
Bugfix Release
|
||||
|
||||
### Changes
|
||||
|
||||
<!-- BEGIN CHANGES 0.1.6 -->
|
||||
- Better error handling for wrongfully configured keys
|
||||
<!-- END CHANGES 0.1.6 -->
|
||||
|
||||
<!-- END RELEASE v0.1.6 -->
|
||||
|
||||
<!-- BEGIN RELEASE v0.1.5 -->
|
||||
## Version 0.1.5
|
||||
|
||||
Reporting changes
|
||||
|
||||
### Changes
|
||||
|
||||
<!-- BEGIN CHANGES 0.1.5 -->
|
||||
- Admin reports show the source sublist for each new subscriber
|
||||
- Add static code analysis CI jobs
|
||||
<!-- END CHANGES 0.1.5 -->
|
||||
|
||||
<!-- END RELEASE v0.1.5 -->
|
||||
|
||||
<!-- BEGIN RELEASE v0.1.4 -->
|
||||
## Version 0.1.4
|
||||
|
||||
Better error handling
|
||||
|
||||
### Changes
|
||||
|
||||
<!-- BEGIN CHANGES 0.1.4 -->
|
||||
- Processing failure in one list won't affect other lists
|
||||
- Admin reports are never sent unencrypted
|
||||
<!-- END CHANGES 0.1.4 -->
|
||||
|
||||
<!-- END RELEASE v0.1.4 -->
|
||||
|
||||
<!-- BEGIN RELEASE v0.1.3 -->
|
||||
## Version 0.1.3
|
||||
|
||||
Bugfixes and small improvements in reporting
|
||||
|
||||
### Changes
|
||||
|
||||
<!-- BEGIN CHANGES 0.1.3 -->
|
||||
- RFC 3156 compliance: Don't base64-encode encrypted reports
|
||||
- Include conflicts in admin reports
|
||||
- Fix: user conflict message emails were sent multiple times to chosen email
|
||||
<!-- END CHANGES 0.1.3 -->
|
||||
|
||||
<!-- END RELEASE v0.1.3 -->
|
||||
|
||||
<!-- BEGIN RELEASE v0.1.2 -->
|
||||
## Version 0.1.2
|
||||
|
||||
Documentation & Bugfix release
|
||||
|
||||
### Changes
|
||||
|
||||
<!-- BEGIN CHANGES 0.1.2 -->
|
||||
- Commented config file
|
||||
- Fix a typo in the Debian systemd service
|
||||
<!-- END CHANGES 0.1.2 -->
|
||||
|
||||
<!-- END RELEASE v0.1.2 -->
|
||||
|
||||
<!-- BEGIN RELEASE v0.1.1 -->
|
||||
## Version 0.1.1
|
||||
|
||||
Bugfix release
|
||||
|
||||
### Changes
|
||||
|
||||
<!-- BEGIN CHANGES 0.1.1 -->
|
||||
- Fix logging (almost nothing was logged)
|
||||
- Fix a typo in the Debian systemd timer
|
||||
<!-- END CHANGES 0.1.1 -->
|
||||
|
||||
<!-- END RELEASE v0.1.1 -->
|
||||
# EasyWKS Changelog
|
||||
|
||||
<!-- BEGIN RELEASE v0.1 -->
|
||||
## Version 0.1
|
||||
|
|
184
README.md
184
README.md
|
@ -1,183 +1,7 @@
|
|||
# MultiSchleuder
|
||||
|
||||
Automatically and periodically merge subscribers and keys of multiple [Schleuder][schleuder] lists into one.
|
||||
[![pipeline status](https://gitlab.com/s3lph/multischleuder/badges/main/pipeline.svg)](https://gitlab.com/s3lph/multischleuder/-/commits/main)
|
||||
[![coverage report](https://gitlab.com/s3lph/multischleuder/badges/main/coverage.svg)](https://gitlab.com/s3lph/multischleuder/-/commits/main)
|
||||
[![latest release](https://gitlab.com/s3lph/multischleuder/-/badges/release.svg)](https://gitlab.com/s3lph/multischleuder/-/releases)
|
||||
|
||||
## Dependencies
|
||||
|
||||
* **python-dateutil**, because where would we be without it?
|
||||
* **PGPy**: For sending encrypted messages
|
||||
* **PyYAML**: For parsing the config file
|
||||
|
||||
## Installation
|
||||
|
||||
You can find Debian packages and Python wheels over at [Packages][packages].
|
||||
|
||||
## Configuration
|
||||
|
||||
In the Debian package, the config file lives at `/etc/multischleuder/multischleuder.yml`
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
||||
# Configure this to talk to your schleuder-api-daemon.
|
||||
api:
|
||||
url: "https://localhost:4443"
|
||||
token: "130a8c095d14fa51e73727e9d8ef5db3a3bf0cae7d995c1f"
|
||||
cafile: /etc/multischleuder/schleuder-ca.pem
|
||||
|
||||
lists:
|
||||
|
||||
# The Schleuder list to manage. Must exist
|
||||
- target: global@schleuder.example.org
|
||||
unmanaged:
|
||||
# Adresses to ignore everywhere. Usually you want to
|
||||
# put the admins of your target Schleuder here, in order
|
||||
# to prevent them from becoming unsubscribed.
|
||||
- admin@example.org
|
||||
banned:
|
||||
# If for some reason, you need to ban a subscriber from the
|
||||
# target list only, put them here
|
||||
- banned@example.org
|
||||
sources:
|
||||
# The Schleuder lists to take subscribers and keys from.
|
||||
# They must already exist.
|
||||
- east@schleuder.example.org
|
||||
- west@schleuder.example.org
|
||||
- north@schleuder.example.org
|
||||
- south@schleuder.example.org
|
||||
# When sending mails, use this as the sender address. If absent,
|
||||
# the -owner address is used.
|
||||
from: global-owner@schleuder.example.org
|
||||
# Whether to notify subscribers of key or email address conflicts.
|
||||
send_conflict_messages: yes
|
||||
# Whether to notify the target Schleuder's admins about changes.
|
||||
send_admin_reports: yes
|
||||
|
||||
# Hook this up to your MTA,
|
||||
smtp:
|
||||
hostname: localhost # default: localhost
|
||||
port: 10025 # default: 25
|
||||
tls: PLAIN # PLAIN|STARTTLS|SMTPS; default: PLAIN
|
||||
username: admin # optional
|
||||
password: password # optional
|
||||
|
||||
conflict:
|
||||
# How often to notify users about conflicts
|
||||
interval: 604800 # 1 week
|
||||
# The file where Schleuder memorizes when it has last sent messages for
|
||||
# which conflicts
|
||||
statefile: /var/lib/multischleuder/conflict.json
|
||||
# The template used when sending mails to a subscriber involved in a key conflict
|
||||
# (multiple keys used by the same subscriber). You can use the following fields:
|
||||
# {subscriber}: Email address of the affected subscriber
|
||||
# {schleuder}: Name (email) of the target Schleuder
|
||||
# {chosen}: The key that was chosen to subscribe to the target Schleuder
|
||||
# {affected}: A list of "fingerprint: source schleuder" candidates involved
|
||||
# in the conflict.
|
||||
key_template: |
|
||||
Hi {subscriber},
|
||||
|
||||
While compiling the subscriber list of {schleuder}, your
|
||||
address {subscriber} was subscribed on multiple sub-lists with
|
||||
different PGP keys. There may be something fishy or malicious going on,
|
||||
or this may simply have been a mistake by you or a list admin.
|
||||
|
||||
You have only been subscribed to {schleuder} using the key you
|
||||
have been subscribed with for the *longest* time:
|
||||
|
||||
{chosen}
|
||||
|
||||
Please review the following keys and talk to the admins of the
|
||||
corresponding sub-lists to resolve this issue:
|
||||
|
||||
Fingerprint Sub-List
|
||||
----------- --------
|
||||
{affected}
|
||||
|
||||
For your convenience, this message has been encrypted with *all* of the
|
||||
above keys. If you have any questions, or do not understand this
|
||||
message, please refer to your local Schleuder admin, or reply to this
|
||||
message.
|
||||
|
||||
Regards
|
||||
MultiSchleuder {schleuder}
|
||||
# The template used when sending mails to subscribers involved in a user conflict
|
||||
# (multiple subscribers using the same key). You can use the following fields:
|
||||
# {subscriber}: Email address of the subscriber addressed in this email
|
||||
# {fingerprint}: Fingerprint of the key used multiple times
|
||||
# {schleuder}: Name (email) of the target Schleuder
|
||||
# {chosen}: The email that was chosen to subscribe to the target Schleuder
|
||||
# {affected}: A list of "email address: source schleuder" candidates involved
|
||||
# in the conflict.
|
||||
user_template: |
|
||||
Hi {subscriber},
|
||||
|
||||
While compiling the subscriber list of {schleuder}, your
|
||||
key {fingerprint} was used by subscribers on multiple sub-lists with
|
||||
different email adresses. There may be something fishy or malicious
|
||||
going on, or this may simply have been a mistake by you or a list admin.
|
||||
|
||||
You have only been subscribed to {schleuder} using the address you
|
||||
have been subscribed with for the *longest* time:
|
||||
|
||||
{chosen}
|
||||
|
||||
Please review the following adresses and talk to the admins of the
|
||||
corresponding sub-lists to resolve this issue:
|
||||
|
||||
Adress Sub-List
|
||||
------ --------
|
||||
{affected}
|
||||
|
||||
For your convenience, this message has been sent to *all* of the above
|
||||
adresses. If you have any questions, or do not understand this
|
||||
message, please refer to your local Schleuder admin, or reply to this
|
||||
message.
|
||||
|
||||
Regards
|
||||
MultiSchleuder {schleuder}
|
||||
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
multischleuder --config path/to/multischleuder.yml
|
||||
```
|
||||
|
||||
Multischleuder also comes with a **dry-run mode**:
|
||||
|
||||
```
|
||||
multischleuder --config path/to/multischleuder.yml --dry-run
|
||||
```
|
||||
|
||||
And to increase the log level:
|
||||
|
||||
```
|
||||
multischleuder --config path/to/multischleuder.yml --verbose
|
||||
```
|
||||
|
||||
|
||||
## Conflict Resolution
|
||||
|
||||
Schleuder is quite restrictive when it comes to mapping subscriptions to keys and vice versa:
|
||||
|
||||
- A key (identified by its fingerprint) can only be used by one subscriber, even if the key has multiple uids.
|
||||
- A subscriber can only be subscribed using a single key, even if multiple keys with the same uid are in the keyring.
|
||||
|
||||
This can lead to conflicts when merging multiple lists, because these properties don't necessarily hold up for the union of all sublist subscribers and keys.
|
||||
|
||||
MultiSchleuder resolves conflicts in a simple, but primitive manner:
|
||||
|
||||
1. First it checks whether two or more subscribers are using the same key. If so, the oldest subscription wins, the other subscribers are not subscribed to the target list.
|
||||
1. Then it checks whether a subscriber has more than one key. If so, the key used by the oldest subscription wins.
|
||||
|
||||
This is by no means a perfect solution.
|
||||
It does however yield consistent results.
|
||||
In both cases, if configured to do so, MultiSchleuder will send a notification message to all subscribers involved in a conflict, encrypting it with all keys involved in the conflict.
|
||||
If one or more keys are - for whatever reason - unusable, the message will not be encrypted.
|
||||
This is a deliberate decision, since the amount of metadata possibly leaked from such a message is fairly small, and we consider it worth taking this risk, given that the other possibility would be to not notify a subscriber when something potentially malicious is going on.
|
||||
|
||||
|
||||
[schleuder]: https://schleuder.org/
|
||||
[packages]: https://git.kabelsalat.ch/s3lph/multischleuder/packages
|
||||
**Work In Progress** - Please do not yet use in production, this project has not yet seen sufficient testing.
|
58
multischleuder.yml
Normal file
58
multischleuder.yml
Normal file
|
@ -0,0 +1,58 @@
|
|||
---
|
||||
|
||||
api:
|
||||
url: "https://localhost:4443"
|
||||
token: 24125f2fe0ebc2fd853cf2e02f7599b3fa7f71a4c8e1519b
|
||||
#cafile: /etc/schleuder/schleuder-certificate.pem
|
||||
cafile: ca.pem
|
||||
|
||||
lists:
|
||||
|
||||
- target: test@schleuder.example.org
|
||||
unmanaged:
|
||||
- admin@example.org
|
||||
banned:
|
||||
- banned@example.org
|
||||
sources:
|
||||
- test-basel@schleuder.example.org
|
||||
- test-bern@schleuder.example.org
|
||||
- test-zurich@schleuder.example.org
|
||||
from: test-owner@schleuder.example.org
|
||||
|
||||
smtp:
|
||||
hostname: localhost
|
||||
port: 8025
|
||||
|
||||
conflict:
|
||||
interval: 604800 # 1 week
|
||||
statefile: /var/lib/multischleuder/conflict.json
|
||||
template: |
|
||||
Hi {subscriber},
|
||||
|
||||
While compiling the subscriber list of {schleuder}, your
|
||||
address {subscriber} was subscribed on multiple sub-lists with
|
||||
different PGP keys. There may be something fishy or malicious going on,
|
||||
or this may simply have been a mistake by you or a list admin.
|
||||
|
||||
You have only been subscribed to {schleuder} using the key you
|
||||
have been subscribed with for the *longest* time:
|
||||
|
||||
{chosen}
|
||||
|
||||
Please review the following keys and talk to the admins of the
|
||||
corresponding sub-lists to resolve this issue:
|
||||
|
||||
Fingerprint Sub-List
|
||||
----------- --------
|
||||
{affected}
|
||||
|
||||
For your convenience, this message has been encrypted with *all* of the
|
||||
above keys. If you have any questions, or do not understand this
|
||||
message, please refer to your local Schleuder admin, or reply to this
|
||||
message.
|
||||
|
||||
Note that this automated message is unsigned, since MultiSchleuder does
|
||||
not have access to Schleuder private keys.
|
||||
|
||||
Regards
|
||||
MultiSchleuder {schleuder}
|
|
@ -1,2 +1,2 @@
|
|||
|
||||
__version__ = '0.1.9'
|
||||
__version__ = '0.1'
|
||||
|
|
|
@ -3,10 +3,8 @@ from typing import List, Optional
|
|||
|
||||
import base64
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
import ssl
|
||||
import urllib.error
|
||||
import urllib.request
|
||||
|
||||
from multischleuder.types import SchleuderKey, SchleuderList, SchleuderSubscriber
|
||||
|
@ -51,7 +49,7 @@ class SchleuderApi:
|
|||
context = None
|
||||
# Perform the actual request
|
||||
req = urllib.request.Request(url, data=payload, method=method, headers=self._headers)
|
||||
resp = urllib.request.urlopen(req, context=context) # nosec B310 baseurl is trusted
|
||||
resp = urllib.request.urlopen(req, context=context)
|
||||
respdata: str = resp.read().decode()
|
||||
if len(respdata) > 0:
|
||||
return json.loads(respdata)
|
||||
|
@ -131,12 +129,8 @@ class SchleuderApi:
|
|||
|
||||
# Key Management
|
||||
|
||||
def get_key(self, fpr: str, schleuder: SchleuderList) -> Optional[SchleuderKey]:
|
||||
try:
|
||||
key = self.__request('keys/{}.json', list_id=schleuder.id, fmt=[fpr])
|
||||
except urllib.error.HTTPError as e:
|
||||
logging.exception(e)
|
||||
return None
|
||||
def get_key(self, fpr: str, schleuder: SchleuderList) -> SchleuderKey:
|
||||
key = self.__request('keys/{}.json', list_id=schleuder.id, fmt=[fpr])
|
||||
return SchleuderKey.from_api(schleuder.id, **key)
|
||||
|
||||
def post_key(self, key: SchleuderKey, schleuder: SchleuderList):
|
||||
|
|
|
@ -1,6 +1,11 @@
|
|||
|
||||
from typing import Dict, List, Optional, Tuple
|
||||
|
||||
import email.mime.base
|
||||
import email.mime.application
|
||||
import email.mime.multipart
|
||||
import email.mime.text
|
||||
import email.utils
|
||||
import hashlib
|
||||
import json
|
||||
import logging
|
||||
|
@ -23,6 +28,7 @@ class KeyConflictResolution:
|
|||
self._key_template: str = key_template
|
||||
self._user_template: str = user_template
|
||||
self._dry_run: bool = False
|
||||
self._logger: logging.Logger = logging.getLogger()
|
||||
|
||||
def dry_run(self):
|
||||
self._dry_run = True
|
||||
|
@ -31,7 +37,8 @@ class KeyConflictResolution:
|
|||
target: str,
|
||||
mail_from: str,
|
||||
subscriptions: List[SchleuderSubscriber],
|
||||
sourcemap: Dict[int, str]) -> Tuple[List[SchleuderSubscriber], List[Optional[Message]]]:
|
||||
sources: List[SchleuderList]) -> Tuple[List[SchleuderSubscriber], List[Optional[Message]]]:
|
||||
sourcemap: Dict[int, str] = {s.id: s.name for s in sources}
|
||||
conflicts: List[Optional[Message]] = []
|
||||
|
||||
# First check for keys that are being used by more than one subscriber
|
||||
|
@ -77,11 +84,10 @@ class KeyConflictResolution:
|
|||
# Conflict Resolution: Choose the OLDEST subscription with a key, but notify using ALL keys
|
||||
earliest: SchleuderSubscriber = min(notnull, key=lambda x: x.created_at)
|
||||
assert earliest.key is not None # Make mypy happy; it can't know that earliest.key can't be None
|
||||
logging.debug(f'Key Conflict for {earliest.email} in lists, chose {earliest.key.fingerprint}:')
|
||||
self._logger.debug(f'Key Conflict for {earliest.email} in lists, chose {earliest.key.fingerprint}:')
|
||||
for s in subscriptions:
|
||||
fpr = 'no key' if s.key is None else s.key.fingerprint
|
||||
sschleuder = sourcemap.get(s.schleuder, 'unknown')
|
||||
logging.debug(f' {sschleuder}: {fpr}')
|
||||
self._logger.debug(f' - {s.schleuder}: {fpr}')
|
||||
# Generate a SHA1 digest that only changes when the subscription list changes
|
||||
digest = self._make_key_digest(earliest, subscriptions)
|
||||
msg: Optional[Message] = None
|
||||
|
@ -115,10 +121,9 @@ class KeyConflictResolution:
|
|||
# Conflict Resolution: Choose the OLDEST subscription with a key, but notify using ALL recipients
|
||||
earliest: SchleuderSubscriber = min(notnull, key=lambda x: x.created_at)
|
||||
assert earliest.key is not None # Make mypy happy; it can't know that earliest.key can't be None
|
||||
logging.debug(f'User Conflict for {earliest.key.fingerprint} in lists, chose {earliest.email}:')
|
||||
self._logger.debug(f'User Conflict for {earliest.key.fingerprint} in lists, chose {earliest.email}:')
|
||||
for s in subscriptions:
|
||||
sschleuder = sourcemap.get(s.schleuder, 'unknown')
|
||||
logging.debug(f' {sschleuder}: {s.email}')
|
||||
self._logger.debug(f' - {s.schleuder}: {s.email}')
|
||||
# Generate a SHA1 digest that only changes when the subscription list changes
|
||||
digest = self._make_user_digest(earliest, subscriptions)
|
||||
msgs: Optional[List[Message]] = None
|
||||
|
@ -150,7 +155,7 @@ class KeyConflictResolution:
|
|||
try:
|
||||
state = json.load(f)
|
||||
except BaseException:
|
||||
logging.exception('Cannot read statefile. Not sending any messages!')
|
||||
self._logger.exception('Cannot read statefile. Not sending any messages!')
|
||||
return False
|
||||
# Remove all state entries older than conflict_interval
|
||||
state = {k: v for k, v in state.items() if now-v < self._interval}
|
||||
|
@ -166,14 +171,14 @@ class KeyConflictResolution:
|
|||
json.dump(state, f)
|
||||
return send
|
||||
except BaseException:
|
||||
logging.exception('Cannot open or write statefile. Not sending any messages!')
|
||||
self._logger.exception('Cannot open or write statefile. Not sending any messages!')
|
||||
return False
|
||||
|
||||
def _make_key_digest(self, chosen: SchleuderSubscriber, candidates: List[SchleuderSubscriber]) -> str:
|
||||
# Sort so the hash stays the same if the set of subscriptions is the same.
|
||||
# There is no guarantee that the subs are in any specific order.
|
||||
subs: List[SchleuderSubscriber] = sorted(candidates, key=lambda x: x.schleuder)
|
||||
h = hashlib.new('sha1') # nosec B324
|
||||
h = hashlib.new('sha1')
|
||||
# Include the chosen email an source sub-list
|
||||
h.update(struct.pack('!sd',
|
||||
chosen.email.encode(),
|
||||
|
@ -190,7 +195,7 @@ class KeyConflictResolution:
|
|||
# Sort so the hash stays the same if the set of subscriptions is the same.
|
||||
# There is no guarantee that the subs are in any specific order.
|
||||
subs: List[SchleuderSubscriber] = sorted(candidates, key=lambda x: x.schleuder)
|
||||
h = hashlib.new('sha1') # nosec B324
|
||||
h = hashlib.new('sha1')
|
||||
assert chosen.key is not None # Make mypy happy; it can't know that chosen.key can't be None
|
||||
# Include the chosen email an source sub-list
|
||||
h.update(struct.pack('!ssd',
|
||||
|
|
|
@ -69,13 +69,11 @@ def main():
|
|||
ap.add_argument('--verbose', '-v', action='store_true', default=False)
|
||||
ap.add_argument('--version', action='version', version=__version__)
|
||||
ns = ap.parse_args(sys.argv[1:])
|
||||
level: str = logging.DEBUG if ns.verbose else logging.INFO
|
||||
logging.basicConfig(style='{', format='{asctime:s} [{levelname:^8s}] {message:}', level=level)
|
||||
logging.debug('Verbose logging enabled')
|
||||
if ns.verbose:
|
||||
logger = logging.getLogger()
|
||||
logger.setLevel('DEBUG')
|
||||
logger.debug('Verbose logging enabled')
|
||||
lists, smtp = parse_config(ns)
|
||||
for lst in lists:
|
||||
try:
|
||||
lst.process(ns.dry_run)
|
||||
except BaseException:
|
||||
logging.exception(f'An error occurred while processing {lst._target}')
|
||||
lst.process(ns.dry_run)
|
||||
smtp.send_messages(Reporter.get_messages())
|
||||
|
|
|
@ -28,11 +28,11 @@ class MultiList:
|
|||
self._api: SchleuderApi = api
|
||||
self._kcr: KeyConflictResolution = kcr
|
||||
self._reporter: Reporter = reporter
|
||||
self._logger: logging.Logger = logging.getLogger()
|
||||
|
||||
def process(self, dry_run: bool = False):
|
||||
logging.info(f'Processing: {self._target} {"DRY RUN" if dry_run else ""}')
|
||||
self._logger.info(f'Processing: {self._target} {"DRY RUN" if dry_run else ""}')
|
||||
target_list, sources = self._lists_by_name()
|
||||
sourcemap: Dict[int, str] = {s.id: s.name for s in sources}
|
||||
target_admins = self._api.get_list_admins(target_list)
|
||||
# Get current subs, except for unmanaged adresses
|
||||
current_subs: Set[SchleuderSubscriber] = set()
|
||||
|
@ -54,7 +54,7 @@ class MultiList:
|
|||
continue
|
||||
all_subs.append(s)
|
||||
# ... which is taken care of by the key conflict resolution routine
|
||||
resolved, conflicts = self._kcr.resolve(self._target, self._mail_from, all_subs, sourcemap)
|
||||
resolved, conflicts = self._kcr.resolve(self._target, self._mail_from, all_subs, sources)
|
||||
self._reporter.add_messages(conflicts)
|
||||
intended_subs: Set[SchleuderSubscriber] = set(resolved)
|
||||
intended_keys: Set[SchleuderKey] = {s.key for s in intended_subs if s.key is not None}
|
||||
|
@ -63,63 +63,33 @@ class MultiList:
|
|||
to_unsubscribe = current_subs.difference(intended_subs)
|
||||
to_remove = current_keys.difference(intended_keys)
|
||||
to_add = intended_keys.difference(current_keys)
|
||||
# Already present keys that are being updated have to be removed and re-imported for convergence
|
||||
to_pre_remove = {k for k in to_add if k.fingerprint in {o.fingerprint for o in to_remove}}
|
||||
to_remove = {k for k in to_remove if k.fingerprint not in {o.fingerprint for o in to_pre_remove}}
|
||||
to_update = {s for s in intended_subs if s in current_subs and s.key in to_add}
|
||||
# Perform the actual list modifications in an order which avoids race conditions
|
||||
for key in to_pre_remove:
|
||||
self._api.delete_key(key, target_list)
|
||||
logging.info(f'Pre-removed key: {key}')
|
||||
for key in to_add:
|
||||
self._api.post_key(key, target_list)
|
||||
logging.info(f'Added key: {key}')
|
||||
self._logger.info(f'Added key: {key}')
|
||||
for sub in to_subscribe:
|
||||
self._api.subscribe(sub, target_list)
|
||||
logging.info(f'Subscribed user: {sub}')
|
||||
self._logger.info(f'Subscribed user: {sub}')
|
||||
for sub in to_update:
|
||||
self._api.update_fingerprint(sub, target_list)
|
||||
logging.info(f'Updated key: {sub}')
|
||||
self._logger.info(f'Updated key: {sub}')
|
||||
for sub in to_unsubscribe:
|
||||
self._api.unsubscribe(sub, target_list)
|
||||
logging.info(f'Unsubscribed user: {sub}')
|
||||
self._logger.info(f'Unsubscribed user: {sub}')
|
||||
for key in to_remove:
|
||||
self._api.delete_key(key, target_list)
|
||||
logging.info(f'Removed key: {key}')
|
||||
|
||||
# Workaround for quirky gpg behaviour where some key signatures are exported from a sublist, but dropped on
|
||||
# import into the target list, leading to a situation where the same key is imported over and over again.
|
||||
new_subs = set()
|
||||
# Get the new list of subscribers
|
||||
for s in self._api.get_subscribers(target_list):
|
||||
if s.email in self._unmanaged or s.email == self._target:
|
||||
continue
|
||||
if s.key is None or s.key.fingerprint == target_list.fingerprint:
|
||||
continue
|
||||
new_subs.add(s)
|
||||
# Compare the key blobs to the ones present before this run
|
||||
old_keys = {s.key.blob for s in current_subs if s.key is not None}
|
||||
unchanged_subs = {s for s in new_subs if s.key is not None and s.key.blob in old_keys}
|
||||
unchanged_fprs = {s.key.fingerprint for s in unchanged_subs if s.key is not None}
|
||||
# Remove the unchanged keys from the changesets so that they are not included in the admin report
|
||||
to_subscribe = {s for s in to_subscribe if s not in unchanged_subs}
|
||||
to_update = {s for s in to_update if s not in unchanged_subs}
|
||||
# need to compare by fpr because == includes the (potentially different) blob
|
||||
to_add = {k for k in to_add if k.fingerprint not in unchanged_fprs}
|
||||
self._logger.info(f'Removed key: {key}')
|
||||
|
||||
if len(to_add) + len(to_subscribe) + len(to_unsubscribe) + len(to_remove) == 0:
|
||||
logging.info(f'No changes for {self._target}')
|
||||
self._logger.info(f'No changes for {self._target}')
|
||||
else:
|
||||
for admin in target_admins:
|
||||
try:
|
||||
report = AdminReport(self._target, admin.email, self._mail_from,
|
||||
admin.key.blob if admin.key is not None else None,
|
||||
to_subscribe, to_unsubscribe, to_update, to_add, to_remove,
|
||||
conflicts, sourcemap)
|
||||
self._reporter.add_message(report)
|
||||
except BaseException:
|
||||
logging.exception(f'Encryption to {admin.email} failed, not sending report')
|
||||
logging.info(f'Finished processing: {self._target}')
|
||||
report = AdminReport(self._target, admin.email, self._mail_from,
|
||||
admin.key.blob if admin.key is not None else None,
|
||||
to_subscribe, to_unsubscribe, to_update, to_add, to_remove)
|
||||
self._reporter.add_message(report)
|
||||
self._logger.info(f'Finished processing: {self._target}')
|
||||
|
||||
def _lists_by_name(self) -> Tuple[SchleuderList, List[SchleuderList]]:
|
||||
lists = self._api.get_lists()
|
||||
|
|
|
@ -2,7 +2,6 @@
|
|||
from typing import Dict, List, Optional, Set
|
||||
|
||||
import abc
|
||||
import email.encoders
|
||||
import email.mime.base
|
||||
import email.mime.application
|
||||
import email.mime.multipart
|
||||
|
@ -27,29 +26,23 @@ class Message(abc.ABC):
|
|||
mail_from: str,
|
||||
mail_to: str,
|
||||
content: str,
|
||||
encrypt_to: List[str],
|
||||
encrypt_may_fail: bool = False):
|
||||
encrypt_to: List[str]):
|
||||
self._schleuder: str = schleuder
|
||||
self._from: str = mail_from
|
||||
self._to: str = mail_to
|
||||
self._keys: List[str] = encrypt_to
|
||||
self._mime: email.mime.base.MIMEBase = self._make_mime(content, encrypt_may_fail)
|
||||
self._mime: email.mime.base.MIMEBase = self._make_mime(content)
|
||||
|
||||
@property
|
||||
def mime(self) -> email.mime.base.MIMEBase:
|
||||
return self._mime
|
||||
|
||||
def _make_mime(self, content: str, encrypt_may_fail: bool) -> email.mime.base.MIMEBase:
|
||||
def _make_mime(self, content: str) -> email.mime.base.MIMEBase:
|
||||
# Encrypt to all keys, if possible. Fall back to unencrypted otherwise
|
||||
try:
|
||||
self._mime = self._encrypt_message(content)
|
||||
except Exception as e:
|
||||
if encrypt_may_fail:
|
||||
logging.exception('Encryption failed; falling back to unencrypted message')
|
||||
self._mime = email.mime.text.MIMEText(content, _subtype='plain', _charset='utf-8')
|
||||
else:
|
||||
logging.exception('Encryption failed; Not sending this message')
|
||||
raise e
|
||||
except Exception:
|
||||
self._mime = email.mime.text.MIMEText(content, _subtype='plain', _charset='utf-8')
|
||||
# Set all the email headers
|
||||
self._mime['From'] = self._from
|
||||
self._mime['Reply-To'] = self._from
|
||||
|
@ -76,21 +69,15 @@ class Message(abc.ABC):
|
|||
del sessionkey
|
||||
# Build the MIME message
|
||||
# First the small "version" part ...
|
||||
mp1 = email.mime.application.MIMEApplication('Version: 1',
|
||||
_subtype='pgp-encrypted',
|
||||
_encoder=email.encoders.encode_noop)
|
||||
mp1 = email.mime.application.MIMEApplication('Version: 1', _subtype='pgp-encrypted')
|
||||
mp1['Content-Description'] = 'PGP/MIME version identification'
|
||||
mp1['Content-Disposition'] = 'attachment'
|
||||
# ... then the actual encrypted payload ...
|
||||
mp2 = email.mime.application.MIMEApplication(str(pgp),
|
||||
_subtype='octet-stream',
|
||||
_encoder=email.encoders.encode_noop,
|
||||
name='encrypted.asc')
|
||||
mp2 = email.mime.application.MIMEApplication(str(pgp), _subtype='octet-stream', name='encrypted.asc')
|
||||
mp2['Content-Description'] = 'OpenPGP encrypted message'
|
||||
mp2['Content-Disposition'] = 'inline; filename="message.asc"'
|
||||
# ... and finally the root multipart container
|
||||
mp0 = email.mime.multipart.MIMEMultipart(_subtype='encrypted',
|
||||
protocol='application/pgp-encrypted')
|
||||
mp0 = email.mime.multipart.MIMEMultipart(_subtype='encrypted', protocol='application/pgp-encrypted')
|
||||
mp0.attach(mp1)
|
||||
mp0.attach(mp2)
|
||||
return mp0
|
||||
|
@ -123,28 +110,16 @@ class KeyConflictMessage(Message):
|
|||
self._chosen: SchleuderSubscriber = chosen
|
||||
self._affected: List[SchleuderSubscriber] = affected
|
||||
self._template: str = template
|
||||
self._sourcemap: Dict[int, str] = sourcemap
|
||||
super().__init__(
|
||||
schleuder=schleuder,
|
||||
mail_from=mail_from,
|
||||
mail_to=chosen.email,
|
||||
content=content,
|
||||
encrypt_to=[s.key.blob for s in affected if s.key is not None],
|
||||
encrypt_may_fail=True # Permit unencrypted fallback so the user gets notified of the conflict anyway
|
||||
encrypt_to=[s.key.blob for s in affected if s.key is not None]
|
||||
)
|
||||
self.mime['Subject'] = f'MultiSchleuder {self._schleuder} - Key Conflict'
|
||||
self.mime['X-MultiSchleuder-Digest'] = digest
|
||||
|
||||
@property
|
||||
def report_str(self) -> str:
|
||||
fpr = 'no key' if self._chosen.key is None else self._chosen.key.fingerprint
|
||||
s = f'{self._chosen.email} -> {fpr}\n'
|
||||
for a in self._affected:
|
||||
fpr = 'no key' if a.key is None else a.key.fingerprint
|
||||
aschleuder: str = self._sourcemap.get(a.schleuder, 'unknown')
|
||||
s += f'- {fpr} ({aschleuder})\n'
|
||||
return s
|
||||
|
||||
|
||||
class UserConflictMessage(Message):
|
||||
|
||||
|
@ -174,27 +149,16 @@ class UserConflictMessage(Message):
|
|||
self._chosen: SchleuderSubscriber = chosen
|
||||
self._affected: List[SchleuderSubscriber] = affected
|
||||
self._template: str = template
|
||||
self._sourcemap: Dict[int, str] = sourcemap
|
||||
super().__init__(
|
||||
schleuder=schleuder,
|
||||
mail_from=mail_from,
|
||||
mail_to=subscriber,
|
||||
mail_to=chosen.email,
|
||||
content=content,
|
||||
encrypt_to=[chosen.key.blob],
|
||||
encrypt_may_fail=True # Permit unencrypted fallback so the user gets notified of the conflict anyway
|
||||
encrypt_to=[chosen.key.blob]
|
||||
)
|
||||
self.mime['Subject'] = f'MultiSchleuder {self._schleuder} - Subscriber Conflict'
|
||||
self.mime['X-MultiSchleuder-Digest'] = digest
|
||||
|
||||
@property
|
||||
def report_str(self) -> str:
|
||||
assert self._chosen.key is not None
|
||||
s = f'{self._chosen.key.fingerprint} -> {self._chosen.email}\n'
|
||||
for a in self._affected:
|
||||
aschleuder: str = self._sourcemap.get(a.schleuder, 'unknown')
|
||||
s += f'- {a.email} ({aschleuder})\n'
|
||||
return s
|
||||
|
||||
|
||||
class AdminReport(Message):
|
||||
|
||||
|
@ -207,25 +171,10 @@ class AdminReport(Message):
|
|||
unsubscribed: Set[SchleuderSubscriber],
|
||||
updated: Set[SchleuderSubscriber],
|
||||
added: Set[SchleuderKey],
|
||||
removed: Set[SchleuderKey],
|
||||
conflicts: List[Optional[Message]],
|
||||
sourcemap: Dict[int, str]):
|
||||
if len(subscribed) == 0 and len(unsubscribed) == 0 and len(removed) == 0 \
|
||||
and len(added) == 0 and len(updated) == 0 and len(conflicts) == 0:
|
||||
removed: Set[SchleuderKey]):
|
||||
if len(subscribed) == 0 and len(unsubscribed) == 0 and \
|
||||
len(removed) == 0 and len(added) == 0 and len(updated) == 0:
|
||||
raise ValueError('No changes, not creating admin report')
|
||||
key_conflicts: List[KeyConflictMessage] =\
|
||||
[m for m in conflicts if m is not None and isinstance(m, KeyConflictMessage)]
|
||||
_user_conflicts: Dict[str, UserConflictMessage] = {}
|
||||
# Make sure the user conflicts are unique
|
||||
for m in conflicts:
|
||||
if m is None or not isinstance(m, UserConflictMessage):
|
||||
continue
|
||||
assert m._chosen.key is not None
|
||||
fpr = m._chosen.key.fingerprint
|
||||
if fpr not in _user_conflicts:
|
||||
_user_conflicts[fpr] = m
|
||||
user_conflicts: List[UserConflictMessage] = list(_user_conflicts.values())
|
||||
# Assemble the content
|
||||
content = f'''
|
||||
== Admin Report for MultiSchleuder {schleuder} ==
|
||||
'''
|
||||
|
@ -234,14 +183,15 @@ class AdminReport(Message):
|
|||
>>> Subscribed:
|
||||
'''
|
||||
for s in subscribed:
|
||||
sschleuder: str = sourcemap.get(s.schleuder, 'unknown')
|
||||
content += f'{s.email} ({sschleuder})\n'
|
||||
fpr = 'no key' if s.key is None else s.key.fingerprint
|
||||
content += f'{s.email} ({fpr})\n'
|
||||
if len(unsubscribed) > 0:
|
||||
content += '''
|
||||
>>> Unsubscribed:
|
||||
'''
|
||||
for s in unsubscribed:
|
||||
content += f'{s.email}\n'
|
||||
fpr = 'no key' if s.key is None else s.key.fingerprint
|
||||
content += f'{s.email} ({fpr})\n'
|
||||
if len(updated) > 0:
|
||||
content += '''
|
||||
>>> Subscriber keys changed:
|
||||
|
@ -261,19 +211,6 @@ class AdminReport(Message):
|
|||
'''
|
||||
for k in removed:
|
||||
content += f'{k.fingerprint} ({k.email})\n'
|
||||
if len(key_conflicts) > 0:
|
||||
content += '''
|
||||
>>> Keys conflicts:
|
||||
'''
|
||||
for c in key_conflicts:
|
||||
content += f'{c.report_str}\n'
|
||||
if len(user_conflicts) > 0:
|
||||
content += '''
|
||||
>>> User conflicts:
|
||||
'''
|
||||
for u in user_conflicts:
|
||||
content += f'{u.report_str}\n'
|
||||
|
||||
super().__init__(
|
||||
schleuder=schleuder,
|
||||
mail_from=mail_from,
|
||||
|
@ -287,6 +224,7 @@ class AdminReport(Message):
|
|||
class Reporter:
|
||||
|
||||
_messages: List['Message'] = []
|
||||
_logger: logging.Logger = logging.getLogger()
|
||||
|
||||
def __init__(self,
|
||||
send_conflict_messages: bool,
|
||||
|
|
|
@ -42,6 +42,7 @@ class SmtpClient:
|
|||
self._password: Optional[str] = password
|
||||
self._smtp: Optional[smtplib.SMTP] = None
|
||||
self._dry_run: bool = False
|
||||
self._logger = logging.getLogger()
|
||||
|
||||
@staticmethod
|
||||
def parse(config: Dict[str, Any]) -> 'SmtpClient':
|
||||
|
@ -62,7 +63,7 @@ class SmtpClient:
|
|||
with self as smtp:
|
||||
for m in messages:
|
||||
msg = m.mime
|
||||
logging.debug(f'MIME Message:\n{str(msg)}')
|
||||
self._logger.debug(f'MIME Message:\n{str(msg)}')
|
||||
self._send_message(msg)
|
||||
|
||||
def _send_message(self, msg: email.message.Message):
|
||||
|
@ -70,7 +71,7 @@ class SmtpClient:
|
|||
raise RuntimeError('SMTP connection is not established')
|
||||
if not self._dry_run:
|
||||
self._smtp.send_message(msg)
|
||||
logging.debug(f'Sent email message.')
|
||||
self._logger.debug(f'Sent email message.')
|
||||
|
||||
def __enter__(self):
|
||||
# TLS from the start requires a different class
|
||||
|
@ -83,7 +84,7 @@ class SmtpClient:
|
|||
# Only sign in if both username and password are provided
|
||||
if self._username is not None and self._password is not None:
|
||||
smtp.login(self._username, self._password)
|
||||
logging.debug(f'SMTP connection to {str(self)} established')
|
||||
self._logger.debug(f'SMTP connection to {str(self)} established')
|
||||
return smtp
|
||||
|
||||
def __exit__(self, exc_type, exc_val, exc_tb):
|
||||
|
@ -91,7 +92,7 @@ class SmtpClient:
|
|||
raise RuntimeError('SMTP connection is not established')
|
||||
self._smtp.quit()
|
||||
ret = self._smtp.__exit__(exc_type, exc_val, exc_tb)
|
||||
logging.debug(f'SMTP connection to {str(self)} closed')
|
||||
self._logger.debug(f'SMTP connection to {str(self)} closed')
|
||||
self._smtp = None
|
||||
return ret
|
||||
|
||||
|
|
|
@ -1,6 +1,5 @@
|
|||
|
||||
import unittest
|
||||
import urllib.error
|
||||
from datetime import datetime
|
||||
from unittest.mock import patch, MagicMock
|
||||
|
||||
|
@ -112,7 +111,7 @@ _KEY_RESPONSE = '''
|
|||
|
||||
class TestSchleuderApi(unittest.TestCase):
|
||||
|
||||
def _mock_api(self, mock, nokey=False, error=None):
|
||||
def _mock_api(self, mock, nokey=False):
|
||||
m = MagicMock()
|
||||
m.getcode.return_value = 200
|
||||
|
||||
|
@ -134,14 +133,8 @@ class TestSchleuderApi(unittest.TestCase):
|
|||
m.read = read
|
||||
m.__enter__.return_value = m
|
||||
mock.return_value = m
|
||||
api = SchleuderApi('https://localhost:4443',
|
||||
'86cf2676d065dc902548e563ab22b57868ed2eb6')
|
||||
if error is not None:
|
||||
def __request(*args, **kwargs):
|
||||
raise error
|
||||
api._SchleuderApi__request = __request
|
||||
|
||||
return api
|
||||
return SchleuderApi('https://localhost:4443',
|
||||
'86cf2676d065dc902548e563ab22b57868ed2eb6')
|
||||
|
||||
@patch('urllib.request.urlopen')
|
||||
def test_get_lists(self, mock):
|
||||
|
@ -289,13 +282,6 @@ class TestSchleuderApi(unittest.TestCase):
|
|||
self.assertEqual(42, key.schleuder)
|
||||
self.assertIn('-----BEGIN PGP PUBLIC KEY BLOCK-----', key.blob)
|
||||
|
||||
@patch('urllib.request.urlopen')
|
||||
def test_get_key_404(self, mock):
|
||||
url = 'https://localhost:4443/keys/ADB9BC679FF53CC8EF66FAC39348FDAB7A7663FA.json?list_id=42'
|
||||
api = self._mock_api(mock, error=urllib.error.HTTPError(url=url, code=404, msg='Not Found', hdrs={}, fp=None))
|
||||
key = api.get_key('ADB9BC679FF53CC8EF66FAC39348FDAB7A7663FA', SchleuderList(42, '', ''))
|
||||
self.assertIsNone(key)
|
||||
|
||||
@patch('urllib.request.urlopen')
|
||||
def test_post_key(self, mock):
|
||||
api = self._mock_api(mock)
|
||||
|
|
|
@ -123,7 +123,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
contents.seek(io.SEEK_END) # Opened with 'a+'
|
||||
with patch('builtins.open', mock_open(read_data=_CONFLICT_STATE_NONE)) as mock_statefile:
|
||||
mock_statefile().__enter__.return_value = contents
|
||||
resolved, messages = kcr.resolve('', '', [], {})
|
||||
resolved, messages = kcr.resolve('', '', [], [])
|
||||
self.assertEqual(0, len(resolved))
|
||||
self.assertEqual(0, len(messages))
|
||||
|
||||
|
@ -133,7 +133,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
date1 = datetime(2022, 4, 15, 5, 23, 42, 0, tzinfo=tzutc())
|
||||
sub1 = SchleuderSubscriber(3, 'foo@example.org', key1, sch1.id, date1)
|
||||
kcr = KeyConflictResolution(3600, '/tmp/state.json', _KEY_TEMPLATE, _USER_TEMPLATE)
|
||||
resolved, messages = kcr.resolve('', '', [sub1], {42: sch1})
|
||||
resolved, messages = kcr.resolve('', '', [sub1], [sch1])
|
||||
self.assertEqual(1, len(resolved))
|
||||
self.assertEqual(sub1, resolved[0])
|
||||
self.assertEqual(0, len(messages))
|
||||
|
@ -159,7 +159,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1, sub2],
|
||||
sourcemap={42: sch1, 23: sch2})
|
||||
sources=[sch1, sch2])
|
||||
|
||||
self.assertEqual(1, len(resolved))
|
||||
self.assertEqual('2FBBC0DF97FDBF1E4B704EEDE39EF4FAC420BEB6', resolved[0].key.fingerprint)
|
||||
|
@ -187,7 +187,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1, sub2],
|
||||
sourcemap={42: sch1, 23: sch2})
|
||||
sources=[sch1, sch2])
|
||||
|
||||
self.assertEqual(1, len(resolved))
|
||||
self.assertEqual('135AFA0FB3FF584828911208B7913308392972A4', resolved[0].key.fingerprint)
|
||||
|
@ -225,7 +225,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1, sub2],
|
||||
sourcemap={42: sch1, 23: sch2})
|
||||
sources=[sch1, sch2])
|
||||
|
||||
self.assertEqual(1, len(resolved))
|
||||
self.assertEqual('2FBBC0DF97FDBF1E4B704EEDE39EF4FAC420BEB6', resolved[0].key.fingerprint)
|
||||
|
@ -246,7 +246,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1],
|
||||
sourcemap={42: sch1})
|
||||
sources=[sch1])
|
||||
self.assertEqual(0, len(resolved))
|
||||
self.assertEqual(0, len(messages))
|
||||
|
||||
|
@ -271,7 +271,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1, sub2],
|
||||
sourcemap={42: sch1, 23: sch2})
|
||||
sources=[sch1, sch2])
|
||||
|
||||
self.assertEqual(1, len(resolved))
|
||||
self.assertEqual('bar@example.org', resolved[0].email)
|
||||
|
@ -324,7 +324,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1, sub2, sub3],
|
||||
sourcemap={42: sch1, 23: sch2})
|
||||
sources=[sch1, sch2])
|
||||
|
||||
self.assertEqual(2, len(resolved))
|
||||
foo, bar = resolved
|
||||
|
@ -376,7 +376,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1, sub2],
|
||||
sourcemap={42: sch1, 23: sch2})
|
||||
sources=[sch1, sch2])
|
||||
self.assertEqual(0, len(msgs))
|
||||
|
||||
def test_send_messages_brokenstate(self):
|
||||
|
@ -399,7 +399,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1, sub2],
|
||||
sourcemap={42: sch1, 23: sch2})
|
||||
sources=[sch1, sch2])
|
||||
self.assertEqual(0, len(msgs))
|
||||
|
||||
def test_send_messages_emptystate(self):
|
||||
|
@ -421,7 +421,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1, sub2],
|
||||
sourcemap={42: sch1, 23: sch2})
|
||||
sources=[sch1, sch2])
|
||||
self.assertEqual(1, len(msgs))
|
||||
|
||||
now = datetime.utcnow().timestamp()
|
||||
|
@ -452,7 +452,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1, sub2],
|
||||
sourcemap={42: sch1, 23: sch2})
|
||||
sources=[sch1, sch2])
|
||||
self.assertEqual(1, len(msgs))
|
||||
|
||||
now = datetime.utcnow().timestamp()
|
||||
|
@ -483,7 +483,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1, sub2],
|
||||
sourcemap={42: sch1, 23: sch2})
|
||||
sources=[sch1, sch2])
|
||||
self.assertEqual(1, len(messages))
|
||||
msg = messages[0]
|
||||
|
||||
|
@ -515,7 +515,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1, sub2],
|
||||
sourcemap={42: sch1, 23: sch2})
|
||||
sources=[sch1, sch2])
|
||||
self.assertEqual(0, len(messages))
|
||||
|
||||
now = datetime.utcnow().timestamp()
|
||||
|
@ -549,7 +549,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1, sub2],
|
||||
sourcemap={42: sch1, 23: sch2})
|
||||
sources=[sch1, sch2])
|
||||
self.assertEqual(1, len(messages))
|
||||
|
||||
now = datetime.utcnow().timestamp()
|
||||
|
@ -582,7 +582,7 @@ class TestKeyConflictResolution(unittest.TestCase):
|
|||
target='test@schleuder.example.org',
|
||||
mail_from='test-owner@schleuder.example.org',
|
||||
subscriptions=[sub1, sub2, sub3],
|
||||
sourcemap={42: sch1, 23: sch2, 7: sch1})
|
||||
sources=[sch1, sch2, sch3])
|
||||
self.assertEqual(1, len(messages))
|
||||
msg = messages[0].mime
|
||||
pgp = pgpy.PGPMessage.from_blob(msg.get_payload()[1].get_payload(decode=True))
|
||||
|
|
|
@ -9,7 +9,6 @@ from dateutil.tz import tzutc
|
|||
|
||||
from multischleuder.processor import MultiList
|
||||
from multischleuder.reporting import Message
|
||||
from multischleuder.test.test_conflict import _PRIVKEY_1
|
||||
from multischleuder.types import SchleuderKey, SchleuderList, SchleuderSubscriber
|
||||
|
||||
|
||||
|
@ -39,7 +38,7 @@ def _list_lists():
|
|||
|
||||
def _get_key(fpr: str, schleuder: SchleuderList):
|
||||
key1 = SchleuderKey('966842467B3254143F994D5E5C408C012D216471',
|
||||
'admin@example.org', str(_PRIVKEY_1.pubkey), schleuder.id)
|
||||
'admin@example.org', 'BEGIN PGP 2D216471', schleuder.id)
|
||||
key2 = SchleuderKey('6449FFB6EE68187962FA013B5CA2F4F51791BAF6',
|
||||
'ada.lovelace@example.org', 'BEGIN PGP 1791BAF6', schleuder.id)
|
||||
key3 = SchleuderKey('414D3960D34730F63C74D5190EBC5A16716DEC79',
|
||||
|
@ -73,7 +72,7 @@ def _get_admins(schleuder: SchleuderList):
|
|||
if schleuder.id != 2:
|
||||
return []
|
||||
key = SchleuderKey('966842467B3254143F994D5E5C408C012D216471',
|
||||
'admin@example.org', str(_PRIVKEY_1.pubkey), schleuder.id)
|
||||
'admin@example.org', 'BEGIN PGP 2D216471', schleuder.id)
|
||||
date = datetime(2022, 4, 15, 5, 23, 42, 0, tzinfo=tzutc())
|
||||
admin = SchleuderSubscriber(0, 'admin@example.org', key, schleuder.id, date)
|
||||
return [admin]
|
||||
|
@ -81,7 +80,7 @@ def _get_admins(schleuder: SchleuderList):
|
|||
|
||||
def _get_subs(schleuder: SchleuderList):
|
||||
key1 = SchleuderKey('966842467B3254143F994D5E5C408C012D216471',
|
||||
'admin@example.org', str(_PRIVKEY_1.pubkey), schleuder.id)
|
||||
'admin@example.org', 'BEGIN PGP 2D216471', schleuder.id)
|
||||
key2 = SchleuderKey('6449FFB6EE68187962FA013B5CA2F4F51791BAF6',
|
||||
'ada.lovelace@example.org', 'BEGIN PGP 1791BAF6', schleuder.id)
|
||||
key3 = SchleuderKey('414D3960D34730F63C74D5190EBC5A16716DEC79',
|
||||
|
|
|
@ -3,27 +3,11 @@ import unittest
|
|||
|
||||
from datetime import datetime
|
||||
|
||||
import pgpy.errors # type: ignore
|
||||
|
||||
from multischleuder.reporting import KeyConflictMessage, AdminReport, Reporter, UserConflictMessage
|
||||
from multischleuder.types import SchleuderKey, SchleuderList, SchleuderSubscriber
|
||||
from multischleuder.test.test_conflict import _PRIVKEY_1
|
||||
|
||||
|
||||
BROKENKEY = '''
|
||||
-----BEGIN PGP PUBLIC KEY BLOCK-----
|
||||
|
||||
mDMEYmcMbxYJKwYBBAHaRw8BAQdAKUohRdnuTSldKwawfLdwwUvOJjz/pHx3fXS2
|
||||
v2dUQx+0SU11bHRpc2NobGV1ZGVyIEJyb2tlbiBBZG1pbiBLZXkgKFRFU1QgS0VZ
|
||||
IERPIE5PVCBVU0UpIDxhZG1pbkBleGFtcGxlLm9yZz6IkAQTFggAOBYhBGtuFOnz
|
||||
PJOCOdfv6OuAwhfh1Uj8BQJiZwxvAhsBBQsJCAcCBhUKCQgLAgQWAgMBAh4BAheA
|
||||
AAoJEOuAwhfh1Uj8PnkBAM6PfYUZbvvYEkSdwzmZXDwhPRsSA0bhjL5aVwIeCCdp
|
||||
AQDeImNI6czSLVAuwObKv8FnpmbFi3HxTNzakp44DoD8Aw==
|
||||
=JtdI
|
||||
-----END PGP PUBLIC KEY BLOCK-----
|
||||
'''
|
||||
|
||||
|
||||
def one_of_each_kind():
|
||||
sub = SchleuderSubscriber(1, 'foo@example.org', None, 1, datetime.utcnow())
|
||||
key = SchleuderKey(_PRIVKEY_1.fingerprint.replace(' ', ''), 'foo@example.org', str(_PRIVKEY_1.pubkey), 1)
|
||||
|
@ -40,14 +24,12 @@ def one_of_each_kind():
|
|||
schleuder='test@example.org',
|
||||
mail_to='admin@example.org',
|
||||
mail_from='test-owner@example.org',
|
||||
encrypt_to=str(_PRIVKEY_1.pubkey),
|
||||
encrypt_to=None,
|
||||
subscribed={},
|
||||
unsubscribed={sub},
|
||||
updated={},
|
||||
added={},
|
||||
removed={},
|
||||
conflicts=[],
|
||||
sourcemap={1: 'test@example.org'})
|
||||
removed={})
|
||||
msg3 = UserConflictMessage(
|
||||
schleuder='test@example.org',
|
||||
subscriber='bar@example.org',
|
||||
|
@ -111,19 +93,3 @@ class TestReporting(unittest.TestCase):
|
|||
r.add_messages([None])
|
||||
self.assertEqual(0, len(Reporter.get_messages()))
|
||||
Reporter.clear_messages()
|
||||
|
||||
def test_admin_report_nokey(self):
|
||||
sub = SchleuderSubscriber(1, 'foo@example.org', None, 1, datetime.utcnow())
|
||||
with self.assertRaises(pgpy.errors.PGPError):
|
||||
AdminReport(
|
||||
schleuder='test@example.org',
|
||||
mail_to='admin@example.org',
|
||||
mail_from='test-owner@example.org',
|
||||
encrypt_to=BROKENKEY,
|
||||
subscribed={sub},
|
||||
unsubscribed={},
|
||||
updated={},
|
||||
added={},
|
||||
removed={},
|
||||
conflicts=[],
|
||||
sourcemap={1: 'test@example.org'})
|
||||
|
|
|
@ -187,9 +187,7 @@ class TestSmtpClient(unittest.TestCase):
|
|||
unsubscribed={sub},
|
||||
updated={},
|
||||
added={},
|
||||
removed={},
|
||||
conflicts=[],
|
||||
sourcemap={1: 'foo@example.org'})
|
||||
removed={})
|
||||
client.send_messages([msg1, msg2])
|
||||
ctrl.stop()
|
||||
self.assertTrue(ctrl.handler.connected)
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
Package: multischleuder
|
||||
Version: __VERSION__
|
||||
Maintainer: s3lph <s3lph@kabelsalat.ch>
|
||||
Version: __MULTISCHLEUDER_VERSION__
|
||||
Maintainer: s3lph <1375407-s3lph@users.noreply.gitlab.com>
|
||||
Section: web
|
||||
Priority: optional
|
||||
Architecture: all
|
||||
|
|
|
@ -1,60 +1,31 @@
|
|||
---
|
||||
|
||||
# Configure this to talk to your schleuder-api-daemon.
|
||||
api:
|
||||
url: "https://localhost:4443"
|
||||
token: "130a8c095d14fa51e73727e9d8ef5db3a3bf0cae7d995c1f"
|
||||
token: "putAschleuderApiTokenHere"
|
||||
cafile: /etc/multischleuder/schleuder-ca.pem
|
||||
|
||||
lists: []
|
||||
|
||||
# # The Schleuder list to manage. Must exist
|
||||
# - target: global@schleuder.example.org
|
||||
# unmanaged:
|
||||
# # Adresses to ignore everywhere. Usually you want to
|
||||
# # put the admins of your target Schleuder here, in order
|
||||
# # to prevent them from becoming unsubscribed.
|
||||
# - admin@example.org
|
||||
# banned:
|
||||
# # If for some reason, you need to ban a subscriber from the
|
||||
# # target list only, put them here
|
||||
# - banned@example.org
|
||||
# sources:
|
||||
# # The Schleuder lists to take subscribers and keys from.
|
||||
# # They must already exist.
|
||||
# - east@schleuder.example.org
|
||||
# - west@schleuder.example.org
|
||||
# - north@schleuder.example.org
|
||||
# - south@schleuder.example.org
|
||||
# # When sending mails, use this as the sender address. If absent,
|
||||
# # the -owner address is used.
|
||||
# from: global-owner@schleuder.example.org
|
||||
# # Whether to notify subscribers of key or email address conflicts.
|
||||
# send_conflict_messages: yes
|
||||
# # Whether to notify the target Schleuder's admins about changes.
|
||||
# send_admin_reports: yes
|
||||
#- target: global@schleuder.example.org
|
||||
# unmanaged:
|
||||
# - admin@example.org
|
||||
# banned:
|
||||
# - banned@example.org
|
||||
# sources:
|
||||
# - east@schleuder.example.org
|
||||
# - west@schleuder.example.org
|
||||
# - north@schleuder.example.org
|
||||
# - south@schleuder.example.org
|
||||
# from: global-owner@schleuder.example.org
|
||||
|
||||
# Hook this up to your MTA,
|
||||
smtp:
|
||||
hostname: localhost # default: localhost
|
||||
port: 10025 # default: 25
|
||||
tls: PLAIN # PLAIN|STARTTLS|SMTPS; default: PLAIN
|
||||
username: admin # optional
|
||||
password: password # optional
|
||||
hostname: localhost
|
||||
port: 8025
|
||||
|
||||
conflict:
|
||||
# How often to notify users about conflicts
|
||||
interval: 604800 # 1 week
|
||||
# The file where Schleuder memorizes when it has last sent messages for
|
||||
# which conflicts
|
||||
statefile: /var/lib/multischleuder/conflict.json
|
||||
# The template used when sending mails to a subscriber involved in a key conflict
|
||||
# (multiple keys used by the same subscriber). You can use the following fields:
|
||||
# {subscriber}: Email address of the affected subscriber
|
||||
# {schleuder}: Name (email) of the target Schleuder
|
||||
# {chosen}: The key that was chosen to subscribe to the target Schleuder
|
||||
# {affected}: A list of "fingerprint: source schleuder" candidates involved
|
||||
# in the conflict.
|
||||
key_template: |
|
||||
Hi {subscriber},
|
||||
|
||||
|
@ -82,14 +53,6 @@ conflict:
|
|||
|
||||
Regards
|
||||
MultiSchleuder {schleuder}
|
||||
# The template used when sending mails to subscribers involved in a user conflict
|
||||
# (multiple subscribers using the same key). You can use the following fields:
|
||||
# {subscriber}: Email address of the subscriber addressed in this email
|
||||
# {fingerprint}: Fingerprint of the key used multiple times
|
||||
# {schleuder}: Name (email) of the target Schleuder
|
||||
# {chosen}: The email that was chosen to subscribe to the target Schleuder
|
||||
# {affected}: A list of "email address: source schleuder" candidates involved
|
||||
# in the conflict.
|
||||
user_template: |
|
||||
Hi {subscriber},
|
||||
|
||||
|
|
|
@ -3,7 +3,7 @@ Description=Multischleuder Sync Job
|
|||
|
||||
[Service]
|
||||
Type=oneshot
|
||||
ExecStart=/usr/bin/multischleuder --config=/etc/multischleuder/multischleuder.yml
|
||||
ExecStart=/usr/bin/multischleuder --config=/etc/multischleuder/multischleuder.yaml
|
||||
User=multischleuder
|
||||
Group=multischleuder
|
||||
WorkingDirectory=/var/lib/multischleuder
|
||||
|
|
|
@ -5,5 +5,5 @@ Description=Multischleuder Sync Job
|
|||
OnCalendar=hourly
|
||||
Persistent=true
|
||||
|
||||
[Install]
|
||||
[Install]e
|
||||
WantedBy=timers.target
|
183
package/release.py
Executable file
183
package/release.py
Executable file
|
@ -0,0 +1,183 @@
|
|||
|
||||
from typing import Any, Dict, List, Optional, Tuple
|
||||
|
||||
import os
|
||||
import sys
|
||||
import json
|
||||
import urllib.request
|
||||
import http.client
|
||||
from urllib.error import HTTPError
|
||||
|
||||
|
||||
def parse_changelog(tag: str) -> Optional[str]:
|
||||
release_changelog: str = ''
|
||||
with open('CHANGELOG.md', 'r') as f:
|
||||
in_target: bool = False
|
||||
done: bool = False
|
||||
for line in f.readlines():
|
||||
if in_target:
|
||||
if f'<!-- END RELEASE {tag} -->' in line:
|
||||
done = True
|
||||
break
|
||||
release_changelog += line
|
||||
elif f'<!-- BEGIN RELEASE {tag} -->' in line:
|
||||
in_target = True
|
||||
continue
|
||||
if not done:
|
||||
return None
|
||||
return release_changelog
|
||||
|
||||
|
||||
def fetch_job_ids(project_id: str, pipeline_id: str, api_token: str) -> Dict[str, str]:
|
||||
url: str = f'https://gitlab.com/api/v4/projects/{project_id}/pipelines/{pipeline_id}/jobs'
|
||||
headers: Dict[str, str] = {
|
||||
'Private-Token': api_token,
|
||||
'User-Agent': 'curl/7.70.0'
|
||||
}
|
||||
req = urllib.request.Request(url, headers=headers)
|
||||
try:
|
||||
resp: http.client.HTTPResponse = urllib.request.urlopen(req)
|
||||
except HTTPError as e:
|
||||
print(e.read().decode())
|
||||
sys.exit(1)
|
||||
resp_data: bytes = resp.read()
|
||||
joblist: List[Dict[str, Any]] = json.loads(resp_data.decode())
|
||||
|
||||
jobidmap: Dict[str, str] = {}
|
||||
for job in joblist:
|
||||
name: str = job['name']
|
||||
job_id: str = job['id']
|
||||
jobidmap[name] = job_id
|
||||
return jobidmap
|
||||
|
||||
|
||||
def fetch_single_shafile(url: str, api_token: str) -> str:
|
||||
headers: Dict[str, str] = {
|
||||
'User-Agent': 'curl/7.70.0',
|
||||
'Private-Token': api_token
|
||||
}
|
||||
req = urllib.request.Request(url, headers=headers)
|
||||
try:
|
||||
resp: http.client.HTTPResponse = urllib.request.urlopen(req)
|
||||
except HTTPError as e:
|
||||
print(e.read().decode())
|
||||
sys.exit(1)
|
||||
resp_data: bytes = resp.readline()
|
||||
shafile: str = resp_data.decode()
|
||||
filename: str = shafile.strip().split(' ')[-1].strip()
|
||||
return filename
|
||||
|
||||
|
||||
def fetch_wheel_url(base_url: str, project_id: str, job_ids: Dict[str, str], api_token: str) -> Optional[Tuple[str, str]]:
|
||||
mybase: str = f'{base_url}/jobs/{job_ids["build_wheel"]}/artifacts/raw'
|
||||
wheel_sha_url: str = f'https://gitlab.com/api/v4/projects/{project_id}/jobs/{job_ids["build_wheel"]}'\
|
||||
'/artifacts/dist/SHA256SUMS'
|
||||
wheel_filename: str = fetch_single_shafile(wheel_sha_url, api_token)
|
||||
wheel_url: str = f'{mybase}/dist/{wheel_filename}'
|
||||
return wheel_url, wheel_sha_url
|
||||
|
||||
|
||||
def fetch_debian_url(base_url: str, project_id: str, job_ids: Dict[str, str], api_token: str) -> Optional[Tuple[str, str]]:
|
||||
mybase: str = f'{base_url}/jobs/{job_ids["build_debian"]}/artifacts/raw'
|
||||
debian_sha_url: str = f'https://gitlab.com/api/v4/projects/{project_id}/jobs/{job_ids["build_debian"]}'\
|
||||
'/artifacts/package/debian/SHA256SUMS'
|
||||
debian_filename: str = fetch_single_shafile(debian_sha_url, api_token)
|
||||
debian_url: str = f'{mybase}/package/debian/{debian_filename}'
|
||||
return debian_url, debian_sha_url
|
||||
|
||||
|
||||
def main():
|
||||
api_token: Optional[str] = os.getenv('GITLAB_API_TOKEN')
|
||||
release_tag: Optional[str] = os.getenv('CI_COMMIT_TAG')
|
||||
project_name: Optional[str] = os.getenv('CI_PROJECT_PATH')
|
||||
project_id: Optional[str] = os.getenv('CI_PROJECT_ID')
|
||||
pipeline_id: Optional[str] = os.getenv('CI_PIPELINE_ID')
|
||||
if api_token is None:
|
||||
print('GITLAB_API_TOKEN is not set.', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
if release_tag is None:
|
||||
print('CI_COMMIT_TAG is not set.', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
if project_name is None:
|
||||
print('CI_PROJECT_PATH is not set.', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
if project_id is None:
|
||||
print('CI_PROJECT_ID is not set.', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
if pipeline_id is None:
|
||||
print('CI_PIPELINE_ID is not set.', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
changelog: Optional[str] = parse_changelog(release_tag)
|
||||
if changelog is None:
|
||||
print('Changelog could not be parsed.', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
job_ids: Dict[str, str] = fetch_job_ids(project_id, pipeline_id, api_token)
|
||||
|
||||
base_url: str = f'https://gitlab.com/{project_name}/-'
|
||||
|
||||
wheel_url, wheel_sha_url = fetch_wheel_url(base_url, project_id, job_ids, api_token)
|
||||
debian_url, debian_sha_url = fetch_debian_url(base_url, project_id, job_ids, api_token)
|
||||
|
||||
augmented_changelog = f'''{changelog.strip()}
|
||||
|
||||
### Download
|
||||
|
||||
- [Python Wheel]({wheel_url}) ([sha256]({wheel_sha_url}))
|
||||
- [Debian Package]({debian_url}) ([sha256]({debian_sha_url}))'''
|
||||
# Docker currently not working
|
||||
# - Docker image: registry.gitlab.com/{project_name}:{release_tag}
|
||||
|
||||
post_body: str = json.dumps({
|
||||
'tag_name': release_tag,
|
||||
'description': augmented_changelog,
|
||||
'assets': {
|
||||
'links': [
|
||||
{
|
||||
'name': 'Python Wheel',
|
||||
'url': wheel_url,
|
||||
'link_type': 'package'
|
||||
},
|
||||
{
|
||||
'name': 'Debian Package',
|
||||
'url': debian_url,
|
||||
'link_type': 'package'
|
||||
}
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
gitlab_release_api_url: str = \
|
||||
f'https://gitlab.com/api/v4/projects/{project_id}/releases'
|
||||
headers: Dict[str, str] = {
|
||||
'Private-Token': api_token,
|
||||
'Content-Type': 'application/json; charset=utf-8',
|
||||
'User-Agent': 'curl/7.70.0'
|
||||
}
|
||||
|
||||
request = urllib.request.Request(
|
||||
gitlab_release_api_url,
|
||||
post_body.encode('utf-8'),
|
||||
headers=headers,
|
||||
method='POST'
|
||||
)
|
||||
try:
|
||||
response: http.client.HTTPResponse = urllib.request.urlopen(request)
|
||||
except HTTPError as e:
|
||||
print(e.read().decode())
|
||||
sys.exit(1)
|
||||
response_bytes: bytes = response.read()
|
||||
response_str: str = response_bytes.decode()
|
||||
response_data: Dict[str, Any] = json.loads(response_str)
|
||||
|
||||
if response_data['tag_name'] != release_tag:
|
||||
print('Something went wrong...', file=sys.stderr)
|
||||
print(response_str, file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
print(response_data['description'])
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
14
setup.py
14
setup.py
|
@ -7,27 +7,17 @@ setup(
|
|||
name='multischleuder',
|
||||
version=__version__,
|
||||
author='s3lph',
|
||||
author_email='s3lph@kabelsalat.ch',
|
||||
author_email='1375407-s3lph@users.noreply.gitlab.com',
|
||||
description='Merge subscribers and keys of multiple Schleuder lists into one',
|
||||
license='MIT',
|
||||
keywords='schleuder,pgp',
|
||||
url='https://git.kabelsalat.ch/s3lph/multischleuder',
|
||||
url='https://gitlab.com/s3lph/multischleuder',
|
||||
packages=find_packages(exclude=['*.test']),
|
||||
install_requires=[
|
||||
'python-dateutil',
|
||||
'PyYAML',
|
||||
'PGPy',
|
||||
],
|
||||
extras_require={
|
||||
'test': [
|
||||
'aiosmtpd',
|
||||
'coverage',
|
||||
'pycodestyle',
|
||||
'mypy',
|
||||
'deepdiff',
|
||||
'twine'
|
||||
]
|
||||
},
|
||||
entry_points={
|
||||
'console_scripts': [
|
||||
'multischleuder = multischleuder.main:main'
|
||||
|
|
|
@ -44,7 +44,6 @@ gen_key andy.example@example.org
|
|||
mv /tmp/andy.example@example.org.asc /tmp/andy.example@example.org.1.asc
|
||||
gen_key aaron.example@example.org aaron.example@example.net
|
||||
gen_key amy.example@example.org
|
||||
gen_key alice.example@example.org alice.example@example.net
|
||||
|
||||
install -m 0700 -d /tmp/gpg
|
||||
export GNUPGHOME=/tmp/gpg
|
||||
|
@ -76,7 +75,6 @@ schleuder-cli subscriptions new test-north@schleuder.example.org arno.example@ex
|
|||
subscribe test-east@schleuder.example.org anna.example@example.org # key should be updated
|
||||
subscribe test-east@schleuder.example.org anotherspammer@example.org # should not be subscribed
|
||||
subscribe test-east@schleuder.example.org aaron.example@example.org # should remain as-is
|
||||
subscribe test-east@schleuder.example.org alice.example@example.net # should be subscriped despite conflict
|
||||
|
||||
subscribe test-south@schleuder.example.org andy.example@example.org # should be subscribed despite key conflict
|
||||
subscribe test-south@schleuder.example.org amy.example@example.org # should be subscribed - conflict but same key
|
||||
|
@ -86,7 +84,6 @@ sleep 5 # to get different subscription dates
|
|||
schleuder-cli subscriptions new test-west@schleuder.example.org andy.example@example.org /tmp/andy.example@example.org.1.asc
|
||||
# should not be subscribed
|
||||
subscribe test-west@schleuder.example.org amy.example@example.org # should be subscribed - conflict but same key
|
||||
subscribe test-west@schleuder.example.org alice.example@example.org # should not be subscriped - key used by other UID
|
||||
|
||||
schleuder-cli subscriptions new test2-global@schleuder.example.org arno.example@example.org
|
||||
# should be unsubscribed - no key
|
||||
|
|
|
@ -38,7 +38,6 @@ expected_subscribers = subscribermap([
|
|||
'aaron.example@example.org',
|
||||
'admin@example.org',
|
||||
'alex.example@example.org',
|
||||
'alice.example@example.net',
|
||||
'amy.example@example.org',
|
||||
'andy.example@example.org',
|
||||
'anna.example@example.org',
|
||||
|
@ -63,7 +62,6 @@ expected_keys = keymap([
|
|||
'aaron.example@example.org',
|
||||
'admin@example.org',
|
||||
'alex.example@example.org',
|
||||
'alice.example@example.org', # schleuder returns the primary UID
|
||||
'amy.example@example.org',
|
||||
'andy.example@example.org',
|
||||
'anna.example@example.org',
|
||||
|
@ -86,23 +84,20 @@ if len(keysdiff) > 0:
|
|||
# Test mbox
|
||||
|
||||
mbox = mailbox.mbox('/var/spool/mail/root')
|
||||
if len(mbox) != 4:
|
||||
print(f'Expected 4 messages in mbox, got {len(mbox)}')
|
||||
if len(mbox) != 2:
|
||||
print(f'Expected 2 messages in mbox, got {len(mbox)}')
|
||||
exit(1)
|
||||
messages = []
|
||||
for i in range(4):
|
||||
messages.append(mbox.popitem()[1])
|
||||
_, msg1 = mbox.popitem()
|
||||
_, msg2 = mbox.popitem()
|
||||
mbox.close()
|
||||
if 'X-MultiSchleuder-Digest' not in msg1:
|
||||
msg1, msg2 = msg2, msg1
|
||||
|
||||
msg1 = [m for m in messages if m['To'] == 'andy.example@example.org'][0]
|
||||
msg2 = [m for m in messages if m['To'] == 'admin@example.org'][0]
|
||||
msg3 = [m for m in messages if m['To'] == 'alice.example@example.org'][0]
|
||||
msg4 = [m for m in messages if m['To'] == 'alice.example@example.net'][0]
|
||||
|
||||
if 'X-MultiSchleuder-Digest' not in msg1:
|
||||
print(f'Key conflict message should have a X-MultiSchleuder-Digest header, missing')
|
||||
exit(1)
|
||||
digest1 = msg1['X-MultiSchleuder-Digest'].strip()
|
||||
digest = msg1['X-MultiSchleuder-Digest'].strip()
|
||||
if msg1['From'] != 'test-global-owner@schleuder.example.org':
|
||||
print(f'Expected "From: test-global-owner@schleuder.example.org", got {msg1["From"]}')
|
||||
exit(1)
|
||||
|
@ -132,74 +127,27 @@ if msg2['Precedence'] != 'list':
|
|||
print(f'Expected "Precedence: list", got {msg2["Precedence"]}')
|
||||
exit(1)
|
||||
|
||||
if 'X-MultiSchleuder-Digest' not in msg3:
|
||||
print(f'User conflict message should have a X-MultiSchleuder-Digest header, missing')
|
||||
exit(1)
|
||||
digest3 = msg3['X-MultiSchleuder-Digest'].strip()
|
||||
if msg3['From'] != 'test-global-owner@schleuder.example.org':
|
||||
print(f'Expected "From: test-global-owner@schleuder.example.org", got {msg3["From"]}')
|
||||
exit(1)
|
||||
if msg3['To'] != 'alice.example@example.org':
|
||||
print(f'Expected "To: alice.example@example.org", got {msg3["To"]}')
|
||||
exit(1)
|
||||
if msg3['Auto-Submitted'] != 'auto-generated':
|
||||
print(f'Expected "Auto-Submitted: auto-generated", got {msg3["Auto-Submitted"]}')
|
||||
exit(1)
|
||||
if msg3['Precedence'] != 'list':
|
||||
print(f'Expected "Precedence: list", got {msg3["Precedence"]}')
|
||||
exit(1)
|
||||
|
||||
if 'X-MultiSchleuder-Digest' not in msg4:
|
||||
print(f'User conflict message should have a X-MultiSchleuder-Digest header, missing')
|
||||
exit(1)
|
||||
digest4 = msg4['X-MultiSchleuder-Digest'].strip()
|
||||
if msg4['From'] != 'test-global-owner@schleuder.example.org':
|
||||
print(f'Expected "From: test-global-owner@schleuder.example.org", got {msg4["From"]}')
|
||||
exit(1)
|
||||
if msg4['To'] != 'alice.example@example.net':
|
||||
print(f'Expected "To: alice.example@example.net", got {msg4["To"]}')
|
||||
exit(1)
|
||||
if msg4['Auto-Submitted'] != 'auto-generated':
|
||||
print(f'Expected "Auto-Submitted: auto-generated", got {msg4["Auto-Submitted"]}')
|
||||
exit(1)
|
||||
if msg4['Precedence'] != 'list':
|
||||
print(f'Expected "Precedence: list", got {msg4["Precedence"]}')
|
||||
exit(1)
|
||||
|
||||
if digest3 != digest4:
|
||||
print(f'User conflict messages should have the same digest, got: "{digest3}" vs "{digest4}"')
|
||||
exit(1)
|
||||
|
||||
gpg1 = subprocess.Popen(['/usr/bin/gpg', '-d'],
|
||||
stdin=subprocess.PIPE,
|
||||
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||||
gpg1o, _ = gpg1.communicate(msg1.get_payload()[1].get_payload(decode=True))
|
||||
print(f'\nKey conflict message (decrypted):\n{gpg1o.decode()}')
|
||||
print(f'Key conflict message (decrypted):\n{gpg1o.decode()}')
|
||||
gpg2 = subprocess.Popen(['/usr/bin/gpg', '-d'],
|
||||
stdin=subprocess.PIPE,
|
||||
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||||
gpg2o, _ = gpg2.communicate(msg2.get_payload()[1].get_payload(decode=True))
|
||||
print(f'\nAdmin report message (decrypted):\n{gpg2o.decode()}')
|
||||
gpg3 = subprocess.Popen(['/usr/bin/gpg', '-d'],
|
||||
stdin=subprocess.PIPE,
|
||||
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||||
gpg3o, _ = gpg3.communicate(msg3.get_payload()[1].get_payload(decode=True))
|
||||
print(f'\nUser conflict message (decrypted):\n{gpg3o.decode()}')
|
||||
print(f'Admin report message (decrypted):\n{gpg2o.decode()}')
|
||||
|
||||
# Test conflict statefile
|
||||
|
||||
with open('/tmp/conflict.json', 'r') as f:
|
||||
conflict = json.load(f)
|
||||
if len(conflict) != 2:
|
||||
if len(conflict) != 1:
|
||||
print('Expected 1 entry in conflict statefile, got:')
|
||||
print(json.dumps(conflict))
|
||||
exit(1)
|
||||
if digest1 not in conflict:
|
||||
print(f'Expected key "{digest1}" in conflict statefile, got:')
|
||||
print(json.dumps(conflict))
|
||||
exit(1)
|
||||
if digest3 not in conflict:
|
||||
print(f'Expected key "{digest3}" in conflict statefile, got:')
|
||||
if digest not in conflict:
|
||||
print(f'Expected key "{digest}" in conflict statefile, got:')
|
||||
print(json.dumps(conflict))
|
||||
exit(1)
|
||||
|
||||
|
|
Loading…
Reference in a new issue