├── vallumd.kdev4 ├── conf └── vallumd ├── init ├── vallumd.openrc ├── vallumd.upstart └── vallumd.service ├── .woodpecker ├── mosquitto.conf ├── entrypoint.sh.debug ├── release.yml ├── coding_style.yml ├── test_debug.yml ├── static_analysis.yml ├── Dockerfile.debug ├── build_debug.yml └── build.yml ├── .gitignore ├── src ├── inet.h ├── log.h ├── ipset.h ├── config.h.in ├── inet.c ├── mosquitto.h ├── ipset.c ├── main.c └── mosquitto.c ├── CMakeCPack.cmake ├── .github └── PULL_REQUEST_TEMPLATE ├── CMakeCPackOptions.cmake.in ├── pytest └── test_mqtt.tavern.yml ├── CMakeLists.txt ├── README.md ├── .clang-format └── COPYING /vallumd.kdev4: -------------------------------------------------------------------------------- 1 | [Project] 2 | Name=vallumd 3 | Manager=KDevCMakeManager 4 | VersionControl=kdevgit 5 | -------------------------------------------------------------------------------- /conf/vallumd: -------------------------------------------------------------------------------- 1 | # vallumd service configuration file 2 | 3 | VALLUMD_OPTIONS="-h 127.0.0.1 -p 1883 -t blacklist" 4 | -------------------------------------------------------------------------------- /init/vallumd.openrc: -------------------------------------------------------------------------------- 1 | #!/sbin/openrc-run 2 | 3 | description="vallumd" 4 | command="/usr/sbin/vallumd" 5 | 6 | command_background="yes" 7 | pidfile="/run/${SVCNAME}.pid" 8 | command_args="$VALLUMD_OPTIONS" 9 | -------------------------------------------------------------------------------- /.woodpecker/mosquitto.conf: -------------------------------------------------------------------------------- 1 | allow_anonymous true 2 | # log connection messages 3 | connection_messages true 4 | listener 1883 5 | log_dest stderr 6 | log_type debug 7 | log_type error 8 | log_type information 9 | log_type notice 10 | log_type warning 11 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .kdev4 2 | _CPack_Packages/ 3 | CMakeCache.txt 4 | CMakeCPackOptions.cmake 5 | CMakeFiles 6 | CMakeScripts 7 | CPackConfig.cmake 8 | CPackSourceConfig.cmake 9 | Makefile 10 | build/ 11 | cmake_install.cmake 12 | conffiles 13 | config.h 14 | install_manifest.txt 15 | vallumd 16 | -------------------------------------------------------------------------------- /.woodpecker/entrypoint.sh.debug: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | [ "$SVC" = "mosquitto" ] && /usr/sbin/mosquitto -c /etc/mosquitto/mosquitto.conf 4 | [ "$SVC" = "vallumd" ] && { 5 | ipset create test4 hash:ip family inet 6 | ipset create test6 hash:ip family inet6 7 | vallumd -h svc-mosquitto -t test4 -t test6 -t test/subtopic 8 | } 9 | -------------------------------------------------------------------------------- /src/inet.h: -------------------------------------------------------------------------------- 1 | /* SPDX-License-Identifier: GPL-3.0 */ 2 | /* 3 | * Copyright (C) 2017-2022 Stijn Tintel 4 | */ 5 | 6 | #ifndef INET_H_INCLUDED 7 | #define INET_H_INCLUDED 8 | 9 | extern int get_inet_family(const char *ipaddr); 10 | extern int ip_valid(const char *ipaddr); 11 | 12 | #endif /* INET_H_INCLUDED */ 13 | -------------------------------------------------------------------------------- /init/vallumd.upstart: -------------------------------------------------------------------------------- 1 | # vallumd 2 | 3 | author "Stijn Tintel " 4 | 5 | start on runlevel [2345] 6 | stop on runlevel [!2345] 7 | 8 | script 9 | test -f /etc/default/vallumd && . /etc/default/vallumd 10 | test -f /etc/sysconfig/vallumd && . /etc/sysconfig/vallumd 11 | 12 | exec /usr/sbin/vallumd $VALLUMD_OPTIONS 13 | end script 14 | -------------------------------------------------------------------------------- /src/log.h: -------------------------------------------------------------------------------- 1 | /* SPDX-License-Identifier: GPL-3.0 */ 2 | /* 3 | * Copyright (C) 2017-2021 Stijn Tintel 4 | */ 5 | 6 | #ifndef LOG_H_INCLUDED 7 | #define LOG_H_INCLUDED 8 | 9 | #include 10 | 11 | #define pr_err(fmt, ...) syslog(LOG_ERR, fmt, ##__VA_ARGS__) 12 | #define pr_info(fmt, ...) syslog(LOG_INFO, fmt, ##__VA_ARGS__) 13 | 14 | #endif /* LOG_H_INCLUDED */ 15 | -------------------------------------------------------------------------------- /init/vallumd.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=vallumd 3 | After=network.service 4 | 5 | [Service] 6 | EnvironmentFile=-/etc/conf.d/vallumd 7 | EnvironmentFile=-/etc/default/vallumd 8 | EnvironmentFile=-/etc/sysconfig/vallumd 9 | Type=simple 10 | ExecReload=/bin/kill -HUP $MAINPID 11 | ExecStart=/usr/sbin/vallumd $VALLUMD_OPTIONS 12 | Restart=always 13 | 14 | [Install] 15 | WantedBy=multi-user.target 16 | -------------------------------------------------------------------------------- /src/ipset.h: -------------------------------------------------------------------------------- 1 | /* SPDX-License-Identifier: GPL-3.0 */ 2 | /* 3 | * Copyright (C) 2017-2021 Stijn Tintel 4 | */ 5 | 6 | #ifndef IPSET_H_INCLUDED 7 | #define IPSET_H_INCLUDED 8 | 9 | #include 10 | 11 | extern int ipset_add(const char *set, const char *elem); 12 | extern int ipset_del(const char *set, const char *elem); 13 | 14 | #endif /* IPSET_H_INCLUDED */ 15 | -------------------------------------------------------------------------------- /.woodpecker/release.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # explicit clone with conditional 3 | clone: 4 | git: 5 | image: woodpeckerci/plugin-git 6 | when: 7 | event: tag 8 | 9 | steps: 10 | gitea_release: 11 | image: plugins/gitea-release 12 | settings: 13 | api_key: 14 | from_secret: gitea_password 15 | base_url: 16 | from_secret: gitea_url 17 | title: "vallumd ${CI_COMMIT_TAG}" 18 | when: 19 | event: tag 20 | -------------------------------------------------------------------------------- /.woodpecker/coding_style.yml: -------------------------------------------------------------------------------- 1 | variables: 2 | - &container_image 'alpine:3.22' 3 | 4 | clone: 5 | git: 6 | image: woodpeckerci/plugin-git 7 | settings: 8 | tags: true 9 | when: 10 | event: 11 | - manual 12 | - pull_request 13 | - push 14 | 15 | steps: 16 | clang_format: 17 | image: *container_image 18 | commands: 19 | - apk add --no-cache clang20-extra-tools 20 | - clang-format --Werror --dry-run src/*.c src/*.h 21 | when: 22 | event: 23 | - manual 24 | - pull_request 25 | - push 26 | 27 | -------------------------------------------------------------------------------- /src/config.h.in: -------------------------------------------------------------------------------- 1 | /* SPDX-License-Identifier: GPL-3.0 */ 2 | /* 3 | * Copyright (C) 2017-2021 Stijn Tintel 4 | */ 5 | 6 | #ifndef CONFIG_H_INCLUDED 7 | #define CONFIG_H_INCLUDED 8 | 9 | #define VERSION_MAJOR @VERSION_MAJOR@ 10 | #define VERSION_MINOR @VERSION_MINOR@ 11 | #define VERSION_PATCH @VERSION_PATCH@ 12 | #cmakedefine VERSION_TWEAK @VERSION_TWEAK@ 13 | 14 | #ifdef VERSION_TWEAK 15 | #define VERSION "@VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@-@VERSION_TWEAK@" 16 | #else 17 | #define VERSION "@VERSION_MAJOR@.@VERSION_MINOR@.@VERSION_PATCH@" 18 | #endif 19 | 20 | #endif /* CONFIG_H_INCLUDED */ 21 | -------------------------------------------------------------------------------- /src/inet.c: -------------------------------------------------------------------------------- 1 | /* SPDX-License-Identifier: GPL-3.0 */ 2 | /* 3 | * Copyright (C) 2017-2022 Stijn Tintel 4 | */ 5 | 6 | #include 7 | #include 8 | 9 | int get_inet_family(const char *ipaddr) 10 | { 11 | int family = 0; 12 | unsigned char dst[sizeof(struct in6_addr)]; 13 | unsigned int ret = 0; 14 | 15 | family = strchr(ipaddr, '.') ? AF_INET : AF_INET6; 16 | 17 | ret = inet_pton(family, ipaddr, dst); 18 | 19 | if (ret == 1) { 20 | return family; 21 | } 22 | 23 | return AF_UNSPEC; 24 | } 25 | 26 | int ip_valid(const char *ipaddr) 27 | { 28 | return get_inet_family(ipaddr) != AF_UNSPEC; 29 | } 30 | -------------------------------------------------------------------------------- /.woodpecker/test_debug.yml: -------------------------------------------------------------------------------- 1 | --- 2 | steps: 3 | test_debug: 4 | image: "${CI_REPO_URL##https://}-debug:latest" 5 | commands: 6 | # wait for service containers 7 | - sleep 5 8 | - py.test pytest/ 9 | when: 10 | event: 11 | - manual 12 | - pull_request 13 | - push 14 | 15 | services: 16 | svc-mosquitto: 17 | image: "${CI_REPO_URL##https://}-debug:latest" 18 | environment: 19 | SVC: mosquitto 20 | pull: true 21 | ports: ["1883"] 22 | 23 | svc-vallumd: 24 | image: "${CI_REPO_URL##https://}-debug:latest" 25 | environment: 26 | SVC: vallumd 27 | ports: ["12345"] 28 | pull: true 29 | 30 | depends_on: 31 | - build_debug 32 | -------------------------------------------------------------------------------- /.woodpecker/static_analysis.yml: -------------------------------------------------------------------------------- 1 | variables: 2 | - &container_image 'alpine:3.22' 3 | 4 | clone: 5 | git: 6 | image: woodpeckerci/plugin-git 7 | settings: 8 | tags: true 9 | when: 10 | event: 11 | - manual 12 | - pull_request 13 | - push 14 | 15 | steps: 16 | clang_tidy: 17 | image: *container_image 18 | commands: 19 | - apk add --no-cache clang20-extra-tools cmake git ipset-dev make mosquitto-dev openssl-dev 20 | - cmake . 21 | - clang-tidy -checks='bugprone-*,clang-analyzer-*,modernize-*,performance-*,readability-*' src/*.c -- -I /usr/include/ -I . -std=gnu99 22 | when: 23 | event: 24 | - manual 25 | - pull_request 26 | - push 27 | 28 | -------------------------------------------------------------------------------- /.woodpecker/Dockerfile.debug: -------------------------------------------------------------------------------- 1 | ARG container_image 2 | FROM $container_image 3 | 4 | ENV DEBIAN_FRONTEND=noninteractive 5 | 6 | COPY .woodpecker/entrypoint.sh.debug /entrypoint.sh 7 | COPY ./build/*.deb /tmp 8 | 9 | RUN mkdir /etc/apt.conf.d 10 | RUN printf 'Acquire::Retries "3";' > /etc/apt.conf.d/99retries 11 | RUN apt-get -yy update 12 | RUN apt-get -yy install --no-install-recommends \ 13 | /tmp/*.deb \ 14 | ipset \ 15 | mosquitto \ 16 | mosquitto-clients 17 | RUN pip3 install uv 18 | RUN uv pip install --system tavern[mqtt]==3.0.1 19 | 20 | # minimal config to run mosquitto broker 21 | COPY .woodpecker/mosquitto.conf /etc/mosquitto/conf.d/local.conf 22 | RUN mkdir /run/mosquitto 23 | RUN chown mosquitto /run/mosquitto 24 | 25 | ENTRYPOINT ["/entrypoint.sh"] 26 | -------------------------------------------------------------------------------- /src/mosquitto.h: -------------------------------------------------------------------------------- 1 | /* SPDX-License-Identifier: GPL-3.0 */ 2 | /* 3 | * Copyright (C) 2017-2021 Stijn Tintel 4 | */ 5 | 6 | #ifndef MOSQUITTO_H_INCLUDED 7 | #define MOSQUITTO_H_INCLUDED 8 | 9 | #define MQTT_WILL_QOS 2 10 | #define MQTT_WILL_RETAIN true 11 | #define MQTT_WILL_TOPIC "vallumd/will" 12 | 13 | #ifdef WITH_TLS 14 | #include 15 | #endif 16 | 17 | #include 18 | 19 | extern int init_mqtt(); 20 | 21 | struct mqtt_conn { 22 | char *host; 23 | char **topics; 24 | char *username; 25 | char *password; 26 | char cid[MOSQ_MQTT_ID_MAX_LENGTH]; 27 | int port; 28 | unsigned int ntopics; 29 | #ifdef WITH_TLS 30 | bool tls; 31 | char *cafile; 32 | #endif 33 | }; 34 | 35 | struct topic { 36 | char *action; 37 | char *name; 38 | }; 39 | 40 | extern struct mqtt_conn mqttconn; 41 | 42 | #endif /* MOSQUITTO_H_INCLUDED */ 43 | -------------------------------------------------------------------------------- /CMakeCPack.cmake: -------------------------------------------------------------------------------- 1 | # SPDX-License-Identifier: GPL-3.0 */ 2 | # Copyright (C) 2017-2021 Stijn Tintel 3 | 4 | # Packaging information 5 | set(CPACK_GENERATOR "DEB;RPM") 6 | set(CPACK_OUTPUT_FILE_PREFIX "build/") 7 | set(CPACK_PACKAGE_CONTACT "Stijn Tintel ") 8 | set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "vallumd") 9 | set(CPACK_PACKAGE_NAME "${PROJECT_NAME}") 10 | SET(CPACK_PACKAGE_VERSION_MAJOR "${VERSION_MAJOR}") 11 | SET(CPACK_PACKAGE_VERSION_MINOR "${VERSION_MINOR}") 12 | SET(CPACK_PACKAGE_VERSION_PATCH "${VERSION_PATCH}") 13 | SET(CPACK_PACKAGE_VERSION "${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}") 14 | set(CPACK_STRIP_FILES true) 15 | 16 | if(VERSION_TWEAK) 17 | set(CPACK_PACKAGE_VERSION "${CPACK_PACKAGE_VERSION}-${VERSION_TWEAK}") 18 | endif() 19 | 20 | configure_file("CMakeCPackOptions.cmake.in" "CMakeCPackOptions.cmake" @ONLY) 21 | set(CPACK_PROJECT_CONFIG_FILE "CMakeCPackOptions.cmake") 22 | 23 | include(CPack) 24 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE: -------------------------------------------------------------------------------- 1 | Before submitting your pull request, make sure to follow these rules: 2 | * Subject is prefixed with ": ". 3 | When in doubt, see "git log ". 4 | * Subject line is at most 50 chars. 5 | * No caps after subject prefix, except for acronyms or proper names. 6 | * Write in imperative form, keeps subject and body short. 7 | * If you can explain what the commit does in the subject, please do so. 8 | Example: "mosquitto: add username and password option" 9 | Says enough, no need for further explanation in commit message body. 10 | * Sign your commits: 11 | https://kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin 12 | * Author field should match the Signed-off-by line. 13 | 14 | In general: follow best practices. Examples: 15 | https://git-scm.com/book/ch5-2.html#Commit-Guidelines 16 | https://kernel.org/doc/html/latest/process/submitting-patches.html 17 | 18 | Please remove this message including the marker below before submitting. 19 | ------------------------------------------------------------------------------- 20 | Describe the PR. For small PRs this can be short. Detailed explanation should 21 | go in the commit messages when needed. For larger PRs with many commits, 22 | please summarize the changes and add some reasoning. 23 | -------------------------------------------------------------------------------- /.woodpecker/build_debug.yml: -------------------------------------------------------------------------------- 1 | --- 2 | variables: 3 | - &container_image 'python:3.14-slim-bookworm' 4 | 5 | clone: 6 | git: 7 | image: woodpeckerci/plugin-git 8 | settings: 9 | tags: true 10 | when: 11 | event: 12 | - manual 13 | - pull_request 14 | - push 15 | 16 | steps: 17 | build_debug_app: 18 | image: *container_image 19 | environment: 20 | DEBIAN_FRONTEND: noninteractive 21 | commands: 22 | - mkdir /etc/apt.conf.d 23 | - printf 'Acquire::Retries "3";' > /etc/apt.conf.d/99retries 24 | - apt-get update 25 | - apt-get -yy install --no-install-recommends build-essential cmake file git libipset-dev libmosquitto-dev libssl-dev pkg-config 26 | - cmake -DCMAKE_BUILD_TYPE=Debug 27 | - cpack -G DEB 28 | - apt -yy install ./build/*.deb 29 | when: 30 | event: 31 | - manual 32 | - pull_request 33 | - push 34 | 35 | 36 | build_debug_container: 37 | # preferably set version to avoid breakage due to random versions being used 38 | image: woodpeckerci/plugin-docker-buildx:6 39 | settings: 40 | auto_tag: true 41 | dockerfile: .woodpecker/Dockerfile.debug 42 | build_args: 43 | container_image: *container_image 44 | debug: true 45 | # avoid MTU issues when building in K8S 46 | mtu: 1450 47 | password: 48 | from_secret: gitea_password 49 | registry: "${CI_REPO_URL}" 50 | repo: "${CI_REPO_URL##https://}-debug" 51 | username: "{CI_REPO_OWNER}" 52 | when: 53 | event: 54 | - manual 55 | - pull_request 56 | - push 57 | 58 | depends_on: 59 | - coding_style 60 | - static_analysis 61 | -------------------------------------------------------------------------------- /CMakeCPackOptions.cmake.in: -------------------------------------------------------------------------------- 1 | # SPDX-License-Identifier: GPL-3.0 */ 2 | # Copyright (C) 2017-2021 Stijn Tintel 3 | 4 | execute_process(COMMAND uname -m OUTPUT_VARIABLE ARCHITECTURE) 5 | 6 | if(ARCHITECTURE MATCHES "x86_64") 7 | set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "amd64") 8 | set(CPACK_RPM_PACKAGE_ARCHITECTURE "x86_64") 9 | elseif(ARCHITECTURE MATCHES "i686") 10 | set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "i386") 11 | set(CPACK_RPM_PACKAGE_ARCHITECTURE "i686") 12 | elseif(ARCHITECTURE MATCHES "i586") 13 | set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "i386") 14 | set(CPACK_RPM_PACKAGE_ARCHITECTURE "i586") 15 | elseif(ARCHITECTURE MATCHES "i486") 16 | set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "i386") 17 | set(CPACK_RPM_PACKAGE_ARCHITECTURE "i486") 18 | elseif(ARCHITECTURE MATCHES "i386") 19 | set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "i386") 20 | set(CPACK_RPM_PACKAGE_ARCHITECTURE "i386") 21 | endif() 22 | 23 | if(CPACK_GENERATOR MATCHES "DEB") 24 | file(WRITE "${CPACK_PACKAGE_DIRECTORY}/conffiles" "/etc/default/vallumd\n") 25 | list(APPEND CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CPACK_PACKAGE_DIRECTORY}/conffiles") 26 | set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS 1) 27 | set(CPACK_DEBIAN_PACKAGE_VERSION "${CPACK_PACKAGE_VERSION}-1") 28 | set(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${CPACK_DEBIAN_PACKAGE_VERSION}_${CPACK_DEBIAN_PACKAGE_ARCHITECTURE}") 29 | elseif(CPACK_GENERATOR MATCHES "RPM") 30 | list(APPEND CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION "/etc/init") 31 | list(APPEND CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION "/etc/sysconfig") 32 | list(APPEND CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION "/usr/lib/systemd") 33 | list(APPEND CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION "/usr/lib/systemd/system") 34 | list(APPEND CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION "/usr/sbin") 35 | set(CPACK_RPM_PACKAGE_LICENSE "GPL-3.0") 36 | set(CPACK_RPM_PACKAGE_RELEASE "1") 37 | set(CPACK_RPM_PACKAGE_REQUIRES "ipset, mosquitto, openssl") 38 | set(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-${CPACK_RPM_PACKAGE_RELEASE}.${CPACK_RPM_PACKAGE_ARCHITECTURE}") 39 | endif() 40 | -------------------------------------------------------------------------------- /.woodpecker/build.yml: -------------------------------------------------------------------------------- 1 | --- 2 | clone: 3 | git: 4 | image: woodpeckerci/plugin-git 5 | settings: 6 | tags: true 7 | when: 8 | event: 9 | - manual 10 | - pull_request 11 | - push 12 | 13 | labels: 14 | location: sof.bg 15 | 16 | matrix: 17 | include: 18 | - distro: centos 19 | distro_version: 7 20 | flavour: rpm 21 | - distro: debian 22 | distro_version: 10 23 | flavour: deb 24 | - distro: debian 25 | distro_version: 11 26 | flavour: deb 27 | - distro: debian 28 | distro_version: 12 29 | flavour: deb 30 | - distro: debian 31 | distro_version: 13 32 | flavour: deb 33 | - distro: ubuntu 34 | distro_version: 18.04 35 | flavour: deb 36 | - distro: ubuntu 37 | distro_version: 20.04 38 | flavour: deb 39 | - distro: ubuntu 40 | distro_version: 22.04 41 | flavour: deb 42 | - distro: ubuntu 43 | distro_version: 24.04 44 | flavour: deb 45 | 46 | steps: 47 | build_deb: 48 | image: ${distro}:${distro_version} 49 | environment: 50 | DEBIAN_FRONTEND: noninteractive 51 | commands: 52 | - grep -q buster /etc/apt/sources.list && sed -i 's|^deb http://deb.debian.org|deb http://archive.debian.org|' /etc/apt/sources.list 53 | - mkdir /etc/apt.conf.d 54 | - printf 'Acquire::Retries "3";' > /etc/apt.conf.d/99retries 55 | - apt-get update 56 | - apt-get -yy --no-install-recommends install build-essential cmake file git libipset-dev libmosquitto-dev libssl-dev pkg-config 57 | - cmake . 58 | - cpack -G DEB 59 | - apt -yy install ./build/*.deb 60 | when: 61 | event: 62 | - manual 63 | - pull_request 64 | - push 65 | matrix: 66 | flavour: deb 67 | 68 | build_rpm: 69 | image: ${distro}:${distro_version} 70 | commands: 71 | - sed -i 's|^mirrorlist|#mirrorlist|' /etc/yum.repos.d/CentOS-Base.repo 72 | - sed -i 's|^#baseurl=http://mirror.centos.org|baseurl=http://vault.centos.org|' /etc/yum.repos.d/CentOS-Base.repo 73 | - yum -y install epel-release 74 | - yum -y install cmake3 ipset-devel make mosquitto-devel openssl-devel pkgconfig '@Development Tools' 75 | - cmake3 . 76 | - cpack3 -G RPM 77 | - yum -y localinstall ./build/*.rpm 78 | when: 79 | event: 80 | - manual 81 | - pull_request 82 | - push 83 | matrix: 84 | flavour: rpm 85 | 86 | depends_on: 87 | - test_debug 88 | -------------------------------------------------------------------------------- /pytest/test_mqtt.tavern.yml: -------------------------------------------------------------------------------- 1 | --- 2 | test_name: test vallumd via mqtt 3 | paho-mqtt: 4 | client: 5 | client_id: tavern-woodpecker-ci 6 | transport: tcp 7 | connect: 8 | host: svc-mosquitto 9 | 10 | stages: 11 | #16 - a83aaaf26b471df891fec04dab50aed24dbaf3c8 12 | - name: delete non-existent entry from empty IPv4 ipset 13 | mqtt_publish: 14 | topic: test4/del 15 | payload: 10.10.10.10 16 | mqtt_response: 17 | topic: vallumd/will 18 | payload: !anything 19 | timeout: 1 20 | unexpected: true 21 | 22 | - name: delete non-existent entry from empty IPv6 ipset 23 | mqtt_publish: 24 | topic: test6/del 25 | payload: fc00:6164:6b33:6300::1 26 | mqtt_response: 27 | topic: vallumd/will 28 | payload: !anything 29 | timeout: 1 30 | unexpected: true 31 | 32 | # correct attempts 33 | - name: add IPv4 IP to IPv4 ipset 34 | mqtt_publish: 35 | topic: test4/add 36 | payload: 10.10.10.10 37 | mqtt_response: 38 | topic: vallumd/will 39 | payload: !anything 40 | timeout: 1 41 | unexpected: true 42 | 43 | - name: delete IPv4 IP from IPv4 ipset 44 | mqtt_publish: 45 | topic: test4/del 46 | payload: 10.10.10.10 47 | mqtt_response: 48 | topic: vallumd/will 49 | payload: !anything 50 | timeout: 1 51 | unexpected: true 52 | 53 | - name: add IPv6 IP to IPv6 ipset 54 | mqtt_publish: 55 | topic: test6/add 56 | payload: fc00:6164:6b33:6300::1 57 | mqtt_response: 58 | topic: vallumd/will 59 | payload: !anything 60 | timeout: 1 61 | unexpected: true 62 | 63 | - name: delete IPv6 IP from IPv6 ipset 64 | mqtt_publish: 65 | topic: test6/del 66 | payload: fc00:6164:6b33:6300::1 67 | mqtt_response: 68 | topic: vallumd/will 69 | payload: !anything 70 | timeout: 1 71 | unexpected: true 72 | 73 | # incorrect attempts 74 | - name: add IPv6 IP to IPv4 ipset 75 | mqtt_publish: 76 | topic: test4/add 77 | payload: fc00:6164:6b33:6300::1 78 | mqtt_response: 79 | topic: vallumd/will 80 | payload: !anything 81 | timeout: 1 82 | unexpected: true 83 | 84 | - name: add IPv4 IP to IPv6 ipset 85 | mqtt_publish: 86 | topic: test6/add 87 | payload: 10.10.10.10 88 | mqtt_response: 89 | topic: vallumd/will 90 | payload: !anything 91 | timeout: 1 92 | unexpected: true 93 | 94 | #19 95 | - name: post to subtopic 96 | mqtt_publish: 97 | topic: test/subtopic 98 | payload: test 99 | mqtt_response: 100 | topic: vallumd/will 101 | payload: !anything 102 | timeout: 1 103 | unexpected: true 104 | -------------------------------------------------------------------------------- /src/ipset.c: -------------------------------------------------------------------------------- 1 | /* SPDX-License-Identifier: GPL-3.0 */ 2 | /* 3 | * Copyright (C) 2017-2022 Stijn Tintel 4 | */ 5 | 6 | #include 7 | #include 8 | #include 9 | #include 10 | 11 | #ifdef WITH_LIBIPSET_V6_COMPAT 12 | #include 13 | #else 14 | #include 15 | #endif 16 | 17 | #include "inet.h" 18 | #include "log.h" 19 | 20 | static int exit_error(int err, struct ipset_session *sess) 21 | { 22 | #ifdef WITH_LIBIPSET_V6_COMPAT 23 | pr_err("ipset: %s\n", ipset_session_error(sess)); 24 | #else 25 | pr_err("ipset: %s\n", ipset_session_report_msg(sess)); 26 | #endif 27 | ipset_session_fini(sess); 28 | 29 | return err; 30 | } 31 | 32 | static int ipset_do(int command, const char *set, const char *elem) 33 | { 34 | const struct ipset_type *type = NULL; 35 | enum ipset_cmd cmd = command; 36 | int family = 0; 37 | int ret = 0; 38 | struct ipset_session *sess; 39 | 40 | if (!ip_valid(elem)) { 41 | pr_err("ipset: %s is not a valid IP address", elem); 42 | return 1; 43 | } 44 | 45 | ipset_load_types(); 46 | 47 | #ifdef WITH_LIBIPSET_V6_COMPAT 48 | sess = ipset_session_init(printf); 49 | #else 50 | sess = ipset_session_init(NULL, NULL); 51 | #endif 52 | if (sess == NULL) { 53 | pr_err("ipset: failed to initialize session\n"); 54 | return 1; 55 | } 56 | 57 | if (cmd == IPSET_CMD_ADD) { 58 | #ifdef WITH_LIBIPSET_V6_COMPAT 59 | ret = ipset_envopt_parse(sess, IPSET_ENV_EXIST, NULL); 60 | if (ret < 0) { 61 | return exit_error(1, sess); 62 | } 63 | #else 64 | ipset_envopt_set(sess, IPSET_ENV_EXIST); 65 | #endif 66 | } 67 | 68 | ret = ipset_parse_setname(sess, IPSET_SETNAME, set); 69 | if (ret < 0) { 70 | return exit_error(1, sess); 71 | } 72 | 73 | type = ipset_type_get(sess, cmd); 74 | if (type == NULL) { 75 | return exit_error(1, sess); 76 | } 77 | 78 | family = ipset_data_family(ipset_session_data(sess)); 79 | if (family != get_inet_family(elem)) { 80 | pr_err("ipset: address %s does not match family of set %s", elem, set); 81 | return 1; 82 | } 83 | 84 | ret = ipset_parse_elem(sess, type->last_elem_optional, elem); 85 | if (ret < 0) { 86 | return exit_error(1, sess); 87 | } 88 | 89 | ret = ipset_cmd(sess, cmd, 0); 90 | if (ret < 0) { 91 | return exit_error(1, sess); 92 | } 93 | 94 | ipset_session_fini(sess); 95 | 96 | return 0; 97 | } 98 | 99 | int ipset_add(const char *set, const char *elem) 100 | { 101 | int ret = ipset_do(IPSET_CMD_ADD, set, elem); 102 | if (ret == 0) { 103 | pr_info("ipset: added %s to %s\n", elem, set); 104 | } 105 | 106 | return ret; 107 | } 108 | 109 | int ipset_del(const char *set, const char *elem) 110 | { 111 | int ret = ipset_do(IPSET_CMD_DEL, set, elem); 112 | if (ret == 0) { 113 | pr_info("ipset: deleted %s from %s\n", elem, set); 114 | } 115 | 116 | return ret; 117 | } 118 | -------------------------------------------------------------------------------- /src/main.c: -------------------------------------------------------------------------------- 1 | /* SPDX-License-Identifier: GPL-3.0 */ 2 | /* 3 | * Copyright (C) 2017-2021 Stijn Tintel 4 | */ 5 | 6 | #include 7 | #include 8 | #include 9 | #include 10 | #include 11 | 12 | #include "config.h" 13 | #include "log.h" 14 | #include "mosquitto.h" 15 | 16 | enum { 17 | default_mqtt_port = 1883 18 | }; 19 | 20 | struct mqtt_conn mqttconn = { 21 | .port = default_mqtt_port, 22 | .ntopics = 0, 23 | #ifdef WITH_TLS 24 | .tls = false, 25 | #endif 26 | }; 27 | 28 | static void print_usage(void) 29 | { 30 | printf("Usage: -h host [-p port] [-u username] [-P password] -t topic1 [-t topicN]\n"); 31 | printf(" -h: MQTT host to connect to\n"); 32 | printf(" -p: MQTT port to connect to (%d)\n", default_mqtt_port); 33 | printf(" -u: MQTT username\n"); 34 | printf(" -P: MQTT password\n"); 35 | printf(" -t: MQTT topic and IPset name\n"); 36 | printf(" -V: print version number and exit\n"); 37 | #ifdef WITH_TLS 38 | printf("TLS options:\n"); 39 | printf(" -c: path to CA file\n"); 40 | printf(" -T: use TLS\n"); 41 | #endif 42 | } 43 | 44 | int main(int argc, char **argv) 45 | { 46 | int opt = 0; 47 | unsigned int topic_idx = 0; 48 | 49 | openlog("vallumd", LOG_PID, LOG_DAEMON); 50 | 51 | while ((opt = getopt(argc, argv, "c:h:p:P:t:Tu:V")) != -1) { 52 | if (opt == 'V') { 53 | fprintf(stdout, "vallumd-%s\n", VERSION); 54 | return 0; 55 | } else if (opt == 't') { 56 | mqttconn.ntopics++; 57 | } 58 | } 59 | 60 | if (mqttconn.ntopics == 0) { 61 | print_usage(); 62 | return 1; 63 | } 64 | 65 | mqttconn.topics = (char **) malloc(mqttconn.ntopics * sizeof(*mqttconn.topics)); 66 | 67 | optind = 0; 68 | while ((opt = getopt(argc, argv, "c:h:p:P:t:Tu:V")) != -1) { 69 | switch (opt) { 70 | case 'h': 71 | mqttconn.host = optarg; 72 | break; 73 | case 'p': 74 | mqttconn.port = atoi(optarg); 75 | break; 76 | case 'P': 77 | mqttconn.password = optarg; 78 | break; 79 | case 't': 80 | mqttconn.topics[topic_idx] = strdup(optarg); 81 | topic_idx++; 82 | break; 83 | #ifdef WITH_TLS 84 | case 'c': 85 | mqttconn.cafile = optarg; 86 | break; 87 | case 'T': 88 | mqttconn.tls = true; 89 | break; 90 | #endif 91 | case 'u': 92 | mqttconn.username = optarg; 93 | break; 94 | default: 95 | print_usage(); 96 | return 1; 97 | } 98 | } 99 | 100 | if (mqttconn.host == NULL) { 101 | print_usage(); 102 | return 1; 103 | } 104 | 105 | #ifdef WITH_TLS 106 | if (mqttconn.tls) { 107 | if (mqttconn.cafile) { 108 | if (access(mqttconn.cafile, F_OK) == -1) { 109 | fprintf(stderr, "CA file %s does not exist.\n", mqttconn.cafile); 110 | return 1; 111 | } 112 | } else { 113 | fprintf(stderr, "TLS operation requires a CA file.\n"); 114 | return 1; 115 | } 116 | } 117 | #endif 118 | 119 | init_mqtt(); 120 | 121 | return 0; 122 | } 123 | -------------------------------------------------------------------------------- /src/mosquitto.c: -------------------------------------------------------------------------------- 1 | /* SPDX-License-Identifier: GPL-3.0 */ 2 | /* 3 | * Copyright (C) 2017-2021 Stijn Tintel 4 | */ 5 | 6 | #include 7 | #include 8 | #include 9 | #include 10 | 11 | #include "ipset.h" 12 | #include "log.h" 13 | #include "mosquitto.h" 14 | 15 | static const int mqtt_cid_hostname_len = 15; 16 | static const int mqtt_keepalive = 60; 17 | 18 | static struct topic parse_topic(char *topic) 19 | { 20 | struct topic parsed_topic; 21 | 22 | if (strchr(topic, '/') != NULL) { 23 | parsed_topic.action = strdup(strsep(&topic, "/")); 24 | parsed_topic.name = strdup(topic); 25 | } else { 26 | parsed_topic.action = strdup(topic); 27 | parsed_topic.name = strdup("add"); 28 | } 29 | 30 | return parsed_topic; 31 | } 32 | 33 | static int set_will(struct mosquitto *mosq) 34 | { 35 | size_t len = strlen(mqttconn.cid); 36 | return mosquitto_will_set(mosq, MQTT_WILL_TOPIC, (int) len, mqttconn.cid, MQTT_WILL_QOS, MQTT_WILL_RETAIN); 37 | } 38 | 39 | static void cb_con(struct mosquitto *mosq, void *userdata, int result) 40 | { 41 | unsigned int topic_idx = 0; 42 | 43 | (void) userdata; 44 | if (!result) { 45 | char *topic = NULL; 46 | pr_info("Connected to %s:%d using CID %s\n", mqttconn.host, mqttconn.port, mqttconn.cid); 47 | for (topic_idx = 0; topic_idx < mqttconn.ntopics; topic_idx++) { 48 | asprintf(&topic, "%s/#", mqttconn.topics[topic_idx]); 49 | if (mosquitto_subscribe(mosq, NULL, topic, 2) == MOSQ_ERR_SUCCESS) { 50 | pr_info("Subscribed to topic %s", topic); 51 | } 52 | free(topic); 53 | } 54 | } 55 | } 56 | 57 | static void cb_msg(struct mosquitto *mosq, void *userdata, const struct mosquitto_message *msg) 58 | { 59 | (void) mosq; 60 | (void) userdata; 61 | if (msg->payloadlen) { 62 | struct topic parsed_topic = parse_topic(msg->topic); 63 | if (strcmp(parsed_topic.action, "add") == 0) { 64 | ipset_add(parsed_topic.name, msg->payload); 65 | } else if (strcmp(parsed_topic.action, "del") == 0) { 66 | ipset_del(parsed_topic.name, msg->payload); 67 | } 68 | free(parsed_topic.action); 69 | free(parsed_topic.name); 70 | } 71 | } 72 | 73 | static void gen_cid(char *mqtt_cid) 74 | { 75 | char hostname[mqtt_cid_hostname_len + 1]; 76 | 77 | gethostname(hostname, mqtt_cid_hostname_len); 78 | snprintf(mqtt_cid, MOSQ_MQTT_ID_MAX_LENGTH, "%s-%d", hostname, getpid()); 79 | } 80 | 81 | int init_mqtt(void) 82 | { 83 | bool clean_session = true; 84 | int keepalive = mqtt_keepalive; 85 | int ret; 86 | struct mosquitto *mosq = NULL; 87 | 88 | gen_cid(&mqttconn.cid[0]); 89 | 90 | mosquitto_lib_init(); 91 | 92 | mosq = mosquitto_new(mqttconn.cid, clean_session, NULL); 93 | 94 | mosquitto_connect_callback_set(mosq, cb_con); 95 | mosquitto_message_callback_set(mosq, cb_msg); 96 | mosquitto_username_pw_set(mosq, mqttconn.username, mqttconn.password); 97 | 98 | #ifdef WITH_TLS 99 | if (mqttconn.tls) { 100 | mosquitto_tls_set(mosq, mqttconn.cafile, NULL, NULL, NULL, NULL); 101 | } 102 | #endif 103 | ret = set_will(mosq); 104 | if (ret) { 105 | pr_err("Failed to set LWT: %d\n", ret); 106 | } 107 | mosquitto_connect(mosq, mqttconn.host, mqttconn.port, keepalive); 108 | 109 | mosquitto_loop_forever(mosq, -1, 1); 110 | 111 | mosquitto_destroy(mosq); 112 | mosquitto_lib_cleanup(); 113 | return 0; 114 | } 115 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # SPDX-License-Identifier: GPL-3.0 */ 2 | # Copyright (C) 2017-2021 Stijn Tintel 3 | 4 | cmake_minimum_required(VERSION 3.10) 5 | 6 | project(vallumd C) 7 | 8 | set (VERSION_MAJOR 0) 9 | set (VERSION_MINOR 2) 10 | set (VERSION_PATCH 2) 11 | 12 | if (EXISTS .git/) 13 | execute_process(COMMAND git describe --tags --dirty 14 | OUTPUT_VARIABLE GIT_DESCRIBE 15 | OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET) 16 | execute_process(COMMAND git describe --abbrev=0 17 | OUTPUT_VARIABLE GIT_LAST_TAG 18 | OUTPUT_STRIP_TRAILING_WHITESPACE ERROR_QUIET) 19 | 20 | string(LENGTH "${GIT_DESCRIBE}" GIT_DESCRIBE_LEN) 21 | string(LENGTH "${GIT_LAST_TAG}" GIT_LAST_TAG_LEN) 22 | 23 | if (GIT_DESCRIBE_LEN EQUAL 0 OR GIT_LAST_TAG_LEN EQUAL 0) 24 | message(FATAL_ERROR "git describe output empty") 25 | endif () 26 | 27 | string(REGEX REPLACE "^${GIT_LAST_TAG}-" "" GIT_DESCRIBE_NOTAG "${GIT_DESCRIBE}") 28 | 29 | if (NOT "${GIT_DESCRIBE}" STREQUAL "${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}") 30 | if ("${GIT_LAST_TAG}" VERSION_LESS 31 | "${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}") 32 | string(REGEX REPLACE "^${GIT_LAST_TAG}-" 33 | "" VERSION_TWEAK "0-pre-${GIT_DESCRIBE_NOTAG}") 34 | else () 35 | string(REGEX REPLACE 36 | "^${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}-" 37 | "" VERSION_TWEAK "${GIT_DESCRIBE}") 38 | endif () 39 | endif () 40 | endif () 41 | 42 | configure_file ( 43 | "${PROJECT_SOURCE_DIR}/src/config.h.in" 44 | "${PROJECT_BINARY_DIR}/config.h" 45 | ) 46 | 47 | set(CMAKE_C_STANDARD 99) 48 | set(CMAKE_C_STANDARD_REQUIRED ON) 49 | 50 | set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Werror -Wextra") 51 | set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} --coverage -fsanitize=address -fsanitize=pointer-compare -fsanitize=pointer-subtract -fsanitize=leak -fsanitize=undefined") 52 | 53 | add_definitions(-D_GNU_SOURCE) 54 | 55 | include_directories("${PROJECT_BINARY_DIR}") 56 | 57 | find_package(PkgConfig REQUIRED) 58 | 59 | pkg_check_modules(LIBIPSET QUIET libipset) 60 | 61 | option (WITH_LIBIPSET_V6_COMPAT "Enable compatibility with libipset version 6" OFF) 62 | if ((LIBIPSET_FOUND AND LIBIPSET_VERSION VERSION_LESS 7) OR WITH_LIBIPSET_V6_COMPAT) 63 | add_definitions("-DWITH_LIBIPSET_V6_COMPAT") 64 | endif () 65 | 66 | option (WITH_TLS "Enable TLS support" ON) 67 | if (${WITH_TLS} STREQUAL ON) 68 | pkg_search_module(LIBSSL QUIET "libssl") 69 | if (LIBSSL_FOUND) 70 | add_definitions("-DWITH_TLS") 71 | list(APPEND ext_libs ssl) 72 | else () 73 | message(FATAL_ERROR "TLS enabled but LibreSSL or OpenSSL not found!") 74 | endif () 75 | endif () 76 | 77 | list(APPEND ext_libs ipset) 78 | list(APPEND ext_libs mosquitto) 79 | 80 | add_executable(vallumd src/main.c src/mosquitto.c src/ipset.c src/inet.c) 81 | target_link_libraries(vallumd ${ext_libs}) 82 | 83 | if (EXISTS "/etc/debian_version") 84 | install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/conf/${PROJECT_NAME}" 85 | DESTINATION "/etc/default") 86 | elseif (EXISTS "/etc/gentoo-release") 87 | install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/conf/${PROJECT_NAME}" 88 | DESTINATION "/etc/conf.d") 89 | elseif (EXISTS "/etc/redhat-release") 90 | install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/conf/${PROJECT_NAME}" 91 | DESTINATION "/etc/sysconfig") 92 | endif () 93 | 94 | pkg_search_module(OPENRC QUIET "openrc") 95 | if (OPENRC_FOUND) 96 | install(PROGRAMS "${CMAKE_CURRENT_SOURCE_DIR}/init/${PROJECT_NAME}.openrc" 97 | DESTINATION "/etc/init.d" RENAME "${PROJECT_NAME}") 98 | endif () 99 | pkg_search_module(SYSTEMD QUIET "systemd") 100 | if (SYSTEMD_FOUND) 101 | if ("${SYSTEMD_SYSTEM_UNIT_DIR}" STREQUAL "") 102 | execute_process(COMMAND ${PKG_CONFIG_EXECUTABLE} systemd 103 | --variable=systemdsystemunitdir 104 | OUTPUT_VARIABLE SYSTEMD_SYSTEM_UNIT_DIR 105 | OUTPUT_STRIP_TRAILING_WHITESPACE) 106 | endif() 107 | set(UNIT_DIR "${CMAKE_CURRENT_SOURCE_DIR}/init") 108 | install(FILES "${UNIT_DIR}/${PROJECT_NAME}.service" 109 | DESTINATION "${SYSTEMD_SYSTEM_UNIT_DIR}") 110 | endif () 111 | execute_process(COMMAND /sbin/init --version 112 | OUTPUT_VARIABLE INIT_VERSION ERROR_QUIET) 113 | if ("${INIT_VERSION}" MATCHES "upstart") 114 | install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/init/${PROJECT_NAME}.upstart" 115 | DESTINATION "/etc/init" RENAME "${PROJECT_NAME}.conf") 116 | endif () 117 | 118 | install(TARGETS vallumd RUNTIME DESTINATION sbin) 119 | 120 | include (CMakeCPack.cmake) 121 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | vallumd 2 | ======= 3 | 4 | This program allows you to centralize and distribute IP blacklists. 5 | 6 | If you maintain a server on the Internet, it's very likely you encountered 7 | one or more brute force attacks. Not a problem, just install fail2ban. Done. 8 | 9 | But if you're running multiple servers, each of them running their fail2ban 10 | instance, they'll all have different IP addresses in the ban list. Wouldn't 11 | it be nice to have a shared ban list across all your fail2ban instances? 12 | Or in case all your machines are behind a router or firewall you control 13 | yourself, wouldn't it be nice to drop malicious traffic at the edge of your 14 | network? 15 | 16 | That's exactly what vallumd helps to achieve. 17 | 18 | 19 | How it works 20 | ------------ 21 | 22 | Vallumd connects to an MQTT broker, reads messages containing IP addresses, 23 | and adds or deletes those IP addresses to or from an ipset. Simple as that. 24 | 25 | This means it is not useful on its own, but it makes vallumd very flexible. 26 | You can decide for yourself what kind of iptables rule you want to reference 27 | the ipset in. Integrating it with fail2ban is as simple as creating a new 28 | action that uses mosquitto_pub to send a message to your MQTT broker. 29 | And since there are MQTT libraries out there for most common languages, it 30 | shouldn't be too hard to integrate with your favorite IDS, IPS or Honeypot. 31 | 32 | 33 | Why the silly name 34 | ------------------ 35 | 36 | The name vallumd comes from the Latin word "vallum", which means wall. 37 | And that's what vallumd does: build a wall to protect your digital empire. 38 | 39 | 40 | Installation 41 | ------------ 42 | 43 | The nicest way to install any package, is by using your distribution's 44 | package management. However, since this project is very young, it has not been 45 | included in many distributions yet. 46 | 47 | ### CentOS/RedHat 48 | 49 | Make sure you have the EPEL repository enabled. 50 | 51 | 52 | #### CentOS 7 dependencies 53 | ``` 54 | sudo yum -y install cmake3 ipset-devel mosquitto-devel openssl-devel pkgconfig '@Development Tools' 55 | ``` 56 | 57 | #### Common 58 | You can now generate an RPM package with cpack: 59 | ``` 60 | git clone https://codeberg.org/stintel/vallumd.git 61 | cd vallumd 62 | cmake3 . 63 | cpack3 -G RPM 64 | 65 | sudo yum -y localinstall build/*.rpm 66 | ``` 67 | Build-tested on CentOS 7. 68 | 69 | ### Debian/Ubuntu 70 | 71 | You can generate a DEB package with cpack: 72 | ``` 73 | sudo apt-get -y install build-essential cmake file libipset-dev libmosquitto-dev libssl-dev pkg-config 74 | 75 | git clone https://codeberg.org/stintel/vallumd.git 76 | cd vallumd 77 | cmake . 78 | cpack -G DEB 79 | 80 | sudo dpkg -i build/*.deb 81 | ``` 82 | Build-tested on Debian 10, 11, 12, 13 and Ubuntu 18.04, 20.04, 22.04, 24.04. 83 | 84 | ### Gentoo 85 | You can find a live ebuild for vallumd in my [Gentoo overlay](https://github.com/stintel/gentoo-overlay) 86 | 87 | ### OpenWrt/LEDE 88 | 89 | If you're running an OpenWrt DD snapshot or LEDE, vallumd is available 90 | in the packages feed, and can be installed with opkg: 91 | ``` 92 | opkg update 93 | opkg install vallumd 94 | ``` 95 | 96 | ### Manual install 97 | Manual installation is very easy. 98 | Requirements: 99 | * cmake 100 | * libipset 101 | * libmosquitto 102 | * libssl 103 | 104 | Instructions: 105 | ``` 106 | git clone https://codeberg.org/stintel/vallumd.git 107 | cd vallumd 108 | cmake . 109 | make 110 | make install 111 | ``` 112 | 113 | 114 | Usage 115 | ----- 116 | 117 | To use vallumd, you need an MQTT broker, like [Mosquitto](https://mosquitto.org/). 118 | Depending on your setup, you can run it on the same host that runs vallumd, 119 | but that's no requirement. 120 | 121 | The next thing you need is an IPset. To give you full control over the type 122 | of IPset and its options, vallumd will not create the IPset itself. 123 | You can choose between these IPset types: 124 | * bitmap:ip 125 | * bitmap:net 126 | * hash:ip 127 | * hash:net 128 | 129 | IPset creation example: 130 | `ipset create blacklist hash:ip timeout 3600` 131 | 132 | Now you can start vallumd. The following command line options exist: 133 | ``` 134 | -h: MQTT host to connect to 135 | -p: MQTT port to connect to (1883) 136 | -u: MQTT username 137 | -P: MQTT password 138 | -t: MQTT topic and IPset name 139 | -V: print version number and exit 140 | -c: path to CA file 141 | -T: use TLS 142 | ``` 143 | The host and topic options are required, the others are optional (default 144 | value). It is possible to specify multiple topics. 145 | 146 | Starting vallumd: 147 | `vallumd -h 192.168.0.1 -t blacklist` 148 | 149 | This will listen for messages on the MQTT broker at 192.168.0.1, in the 150 | blacklist topic, and when a message is received, the IP address in the message 151 | will be added to or remove from the IPset named blacklist. 152 | 153 | So now we have everything in place to start adding IPs to the blacklist. 154 | All we have to do is configure our IDS, IPS or Honeypot to send malicious 155 | IP addresses to our MQTT broker. 156 | 157 | For fail2ban, this could be done with the Mosquitto client `mosquitto_pub`. 158 | Create a new action in `/etc/fail2ban/action.d/vallumd.conf`: 159 | ``` 160 | [Definition] 161 | actionban = mosquitto_pub -h 192.168.0.1 -q 2 -t blacklist/add -m 162 | actionunban = mosquitto_pub -h 192.168.0.1 -q 2 -t blacklist/del -m 163 | ``` 164 | And configure your fail2ban jails to use the vallumd action. 165 | 166 | 167 | Running as a service 168 | -------------------- 169 | 170 | The packages generated with CPack support OpenRC, Upstart and systemd. 171 | Service configuration files are where you would expect them in your distro: 172 | * CentOS/RedHat: /etc/sysconfig/vallumd 173 | * Debian/Ubuntu: /etc/default/vallumd 174 | * Gentoo: /etc/conf.d/vallumd 175 | * OpenWrt/LEDE: /etc/config/vallumd 176 | 177 | After editing the file relevant for your distribution, start the vallumd service 178 | just like you would start any other service on your system. 179 | 180 | 181 | Logging 182 | ------- 183 | Vallumd uses syslog(3) for logging. 184 | 185 | 186 | Get involved 187 | ------------ 188 | 189 | * Join the #vallumd IRC channel on irc.oftc.net 190 | -------------------------------------------------------------------------------- /.clang-format: -------------------------------------------------------------------------------- 1 | --- 2 | Language: Cpp 3 | # BasedOnStyle: Microsoft 4 | AccessModifierOffset: -2 5 | AlignAfterOpenBracket: Align 6 | AlignArrayOfStructures: Left 7 | AlignConsecutiveAssignments: 8 | Enabled: false 9 | AcrossEmptyLines: false 10 | AcrossComments: false 11 | AlignCompound: false 12 | PadOperators: true 13 | AlignConsecutiveBitFields: 14 | Enabled: false 15 | AcrossEmptyLines: false 16 | AcrossComments: false 17 | AlignCompound: false 18 | PadOperators: false 19 | AlignConsecutiveDeclarations: 20 | Enabled: false 21 | AcrossEmptyLines: false 22 | AcrossComments: false 23 | AlignCompound: false 24 | PadOperators: false 25 | AlignConsecutiveMacros: 26 | Enabled: true 27 | AcrossEmptyLines: false 28 | AcrossComments: false 29 | AlignCompound: false 30 | PadOperators: false 31 | AlignEscapedNewlines: Right 32 | AlignOperands: Align 33 | AlignTrailingComments: true 34 | AllowAllArgumentsOnNextLine: true 35 | AllowAllParametersOfDeclarationOnNextLine: true 36 | AllowShortEnumsOnASingleLine: false 37 | AllowShortBlocksOnASingleLine: Never 38 | AllowShortCaseLabelsOnASingleLine: false 39 | AllowShortFunctionsOnASingleLine: None 40 | AllowShortLambdasOnASingleLine: All 41 | AllowShortIfStatementsOnASingleLine: Never 42 | AllowShortLoopsOnASingleLine: false 43 | AlwaysBreakAfterDefinitionReturnType: None 44 | AlwaysBreakAfterReturnType: None 45 | AlwaysBreakBeforeMultilineStrings: false 46 | AlwaysBreakTemplateDeclarations: MultiLine 47 | AttributeMacros: 48 | - __capability 49 | BinPackArguments: true 50 | BinPackParameters: true 51 | BraceWrapping: 52 | AfterCaseLabel: false 53 | AfterClass: true 54 | AfterControlStatement: Never 55 | AfterEnum: false 56 | AfterFunction: true 57 | AfterNamespace: true 58 | AfterObjCDeclaration: false 59 | AfterStruct: false 60 | AfterUnion: false 61 | AfterExternBlock: true 62 | BeforeCatch: true 63 | BeforeElse: false 64 | BeforeLambdaBody: false 65 | BeforeWhile: false 66 | IndentBraces: false 67 | SplitEmptyFunction: true 68 | SplitEmptyRecord: true 69 | SplitEmptyNamespace: true 70 | BreakBeforeBinaryOperators: All 71 | BreakBeforeConceptDeclarations: Always 72 | BreakBeforeBraces: Custom 73 | BreakBeforeInheritanceComma: false 74 | BreakInheritanceList: BeforeColon 75 | BreakBeforeTernaryOperators: false 76 | BreakConstructorInitializersBeforeComma: false 77 | BreakConstructorInitializers: BeforeColon 78 | BreakAfterJavaFieldAnnotations: false 79 | BreakStringLiterals: true 80 | ColumnLimit: 120 81 | CommentPragmas: '^ IWYU pragma:' 82 | QualifierAlignment: Leave 83 | CompactNamespaces: false 84 | ConstructorInitializerIndentWidth: 4 85 | ContinuationIndentWidth: 4 86 | Cpp11BracedListStyle: true 87 | DeriveLineEnding: true 88 | DerivePointerAlignment: false 89 | DisableFormat: false 90 | EmptyLineAfterAccessModifier: Never 91 | EmptyLineBeforeAccessModifier: LogicalBlock 92 | ExperimentalAutoDetectBinPacking: false 93 | PackConstructorInitializers: BinPack 94 | ConstructorInitializerAllOnOneLineOrOnePerLine: false 95 | AllowAllConstructorInitializersOnNextLine: true 96 | FixNamespaceComments: true 97 | ForEachMacros: 98 | - foreach 99 | - Q_FOREACH 100 | - BOOST_FOREACH 101 | IfMacros: 102 | - KJ_IF_MAYBE 103 | IncludeBlocks: Preserve 104 | IncludeCategories: 105 | - Regex: '^"(llvm|llvm-c|clang|clang-c)/' 106 | Priority: 2 107 | SortPriority: 0 108 | CaseSensitive: false 109 | - Regex: '^(<|"(gtest|gmock|isl|json)/)' 110 | Priority: 3 111 | SortPriority: 0 112 | CaseSensitive: false 113 | - Regex: '.*' 114 | Priority: 1 115 | SortPriority: 0 116 | CaseSensitive: false 117 | IncludeIsMainRegex: '(Test)?$' 118 | IncludeIsMainSourceRegex: '' 119 | IndentAccessModifiers: false 120 | IndentCaseLabels: true 121 | IndentCaseBlocks: false 122 | IndentGotoLabels: false 123 | IndentPPDirectives: None 124 | IndentExternBlock: AfterExternBlock 125 | IndentRequiresClause: true 126 | IndentWidth: 4 127 | IndentWrappedFunctionNames: false 128 | InsertBraces: false 129 | InsertTrailingCommas: None 130 | JavaScriptQuotes: Leave 131 | JavaScriptWrapImports: true 132 | KeepEmptyLinesAtTheStartOfBlocks: true 133 | LambdaBodyIndentation: Signature 134 | MacroBlockBegin: '' 135 | MacroBlockEnd: '' 136 | MaxEmptyLinesToKeep: 1 137 | NamespaceIndentation: None 138 | ObjCBinPackProtocolList: Auto 139 | ObjCBlockIndentWidth: 2 140 | ObjCBreakBeforeNestedBlockParam: true 141 | ObjCSpaceAfterProperty: false 142 | ObjCSpaceBeforeProtocolList: true 143 | PenaltyBreakAssignment: 2 144 | PenaltyBreakBeforeFirstCallParameter: 19 145 | PenaltyBreakComment: 300 146 | PenaltyBreakFirstLessLess: 120 147 | PenaltyBreakOpenParenthesis: 0 148 | PenaltyBreakString: 1000 149 | PenaltyBreakTemplateDeclaration: 10 150 | PenaltyExcessCharacter: 1000000 151 | PenaltyReturnTypeOnItsOwnLine: 1000 152 | PenaltyIndentedWhitespace: 0 153 | PointerAlignment: Right 154 | PPIndentWidth: -1 155 | ReferenceAlignment: Pointer 156 | ReflowComments: true 157 | RemoveBracesLLVM: false 158 | RequiresClausePosition: OwnLine 159 | SeparateDefinitionBlocks: Leave 160 | ShortNamespaceLines: 1 161 | SortIncludes: CaseSensitive 162 | SortJavaStaticImport: Before 163 | SortUsingDeclarations: true 164 | SpaceAfterCStyleCast: true 165 | SpaceAfterLogicalNot: false 166 | SpaceAfterTemplateKeyword: true 167 | SpaceBeforeAssignmentOperators: true 168 | SpaceBeforeCaseColon: false 169 | SpaceBeforeCpp11BracedList: false 170 | SpaceBeforeCtorInitializerColon: true 171 | SpaceBeforeInheritanceColon: true 172 | SpaceBeforeParens: ControlStatements 173 | SpaceBeforeParensOptions: 174 | AfterControlStatements: true 175 | AfterForeachMacros: true 176 | AfterFunctionDefinitionName: false 177 | AfterFunctionDeclarationName: false 178 | AfterIfMacros: true 179 | AfterOverloadedOperator: false 180 | AfterRequiresInClause: false 181 | AfterRequiresInExpression: false 182 | BeforeNonEmptyParentheses: false 183 | SpaceAroundPointerQualifiers: Default 184 | SpaceBeforeRangeBasedForLoopColon: true 185 | SpaceInEmptyBlock: false 186 | SpaceInEmptyParentheses: false 187 | SpacesBeforeTrailingComments: 1 188 | SpacesInAngles: Never 189 | SpacesInConditionalStatement: false 190 | SpacesInContainerLiterals: true 191 | SpacesInCStyleCastParentheses: false 192 | SpacesInLineCommentPrefix: 193 | Minimum: 1 194 | Maximum: -1 195 | SpacesInParentheses: false 196 | SpacesInSquareBrackets: false 197 | SpaceBeforeSquareBrackets: false 198 | BitFieldColonSpacing: Both 199 | Standard: Latest 200 | StatementAttributeLikeMacros: 201 | - Q_EMIT 202 | StatementMacros: 203 | - Q_UNUSED 204 | - QT_REQUIRE_VERSION 205 | TabWidth: 4 206 | UseCRLF: false 207 | UseTab: Never 208 | WhitespaceSensitiveMacros: 209 | - STRINGIZE 210 | - PP_STRINGIZE 211 | - BOOST_PP_STRINGIZE 212 | - NS_SWIFT_NAME 213 | - CF_SWIFT_NAME 214 | ... 215 | 216 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | ------------------------------------------------------------------------------- 677 | Note: 678 | Individual files contain the following tag instead of the full license text. 679 | 680 | SPDX-License-Identifier: GPL-3.0 681 | --------------------------------------------------------------------------------