├── src ├── admin │ ├── README.md │ ├── qualvosec_admin.conf │ ├── example.log │ └── qualvosec_admin ├── server │ ├── qualvosec_server.conf │ ├── patch.yaml │ └── qualvosec_server └── client │ ├── qualvosec.conf │ └── qualvosec ├── packaging ├── admin │ ├── rpm_changelog.txt │ ├── deb_changelog.txt │ ├── packaging.sh │ └── CMakeLists.txt ├── server │ ├── rpm_changelog.txt │ ├── postinst │ ├── README.md │ ├── deb_changelog.txt │ ├── packaging.sh │ ├── CMakeLists.txt │ ├── CMakeLists.txt_arm64 │ └── CMakeLists.txt_riscv64 └── client │ ├── postinst │ ├── README.md │ ├── rpm_changelog.txt │ ├── deb_changelog.txt │ ├── packaging.sh │ ├── CMakeLists.txt │ ├── CMakeLists.txt_arm64 │ └── CMakeLists.txt_riscv64 ├── systemd ├── client │ └── qualvosec.service └── server │ └── qualvosec_server.service ├── sudoers.d └── qualvosec ├── README.md └── LICENSE /src/admin/README.md: -------------------------------------------------------------------------------- 1 | # WIP! 2 | Admin utility is still work in progress! 3 | -------------------------------------------------------------------------------- /src/admin/qualvosec_admin.conf: -------------------------------------------------------------------------------- 1 | [general] 2 | server: https://patching.gyptazy.int 3 | log_file_path: example.log -------------------------------------------------------------------------------- /packaging/admin/rpm_changelog.txt: -------------------------------------------------------------------------------- 1 | * Fri Mar 08 2024 Florian Paul Azim Hoberg 2 | - Initial release of qualvosec_admin. 3 | -------------------------------------------------------------------------------- /src/server/qualvosec_server.conf: -------------------------------------------------------------------------------- 1 | [general] 2 | port: 8037 3 | listener: 127.0.0.1 4 | log_level: CRITICAL 5 | log_handler: SystemdHandler() 6 | -------------------------------------------------------------------------------- /packaging/server/rpm_changelog.txt: -------------------------------------------------------------------------------- 1 | * Wed Mar 16 2024 Florian Paul Azim Hoberg 2 | - * Initial beta version of QualvoSec server. 3 | -------------------------------------------------------------------------------- /packaging/client/postinst: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | useradd -m qualvosec 3 | chown qualvosec:qualvosec /etc/qualvosec/qualvosec.conf 4 | systemctl daemon-reload 5 | -------------------------------------------------------------------------------- /packaging/server/postinst: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | useradd -m qualvosec 3 | chown qualvosec:qualvosec /etc/qualvosec/qualvosec_server.conf 4 | systemctl daemon-reload 5 | -------------------------------------------------------------------------------- /systemd/client/qualvosec.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=QualvoSec Service 3 | 4 | [Service] 5 | ExecStart=/usr/sbin/qualvosec -c /etc/qualvosec/qualvosec.conf 6 | User=qualvosec 7 | -------------------------------------------------------------------------------- /packaging/client/README.md: -------------------------------------------------------------------------------- 1 | ## Build packages 2 | For building packages, simly run the following commands: 3 | 4 | mkdir build 5 | cd build 6 | cmake .. 7 | cpack -G RPM . 8 | cpack -G DEB . 9 | -------------------------------------------------------------------------------- /packaging/server/README.md: -------------------------------------------------------------------------------- 1 | ## Build packages 2 | For building packages, simly run the following commands: 3 | 4 | mkdir build 5 | cd build 6 | cmake .. 7 | cpack -G RPM . 8 | cpack -G DEB . 9 | -------------------------------------------------------------------------------- /systemd/server/qualvosec_server.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=QualvoSec Server Service 3 | 4 | [Service] 5 | ExecStart=/usr/sbin/qualvosec_server -c /etc/qualvosec/qualvosec_server.conf 6 | User=qualvosec 7 | -------------------------------------------------------------------------------- /packaging/admin/deb_changelog.txt: -------------------------------------------------------------------------------- 1 | qualvosec (1.0.2) unstable; urgency=low 2 | 3 | * Initial release of qualvosec_admin. 4 | 5 | -- Florian Paul Azim Hoberg Fri, 08 Mar 2024 23:36:41 -0200 6 | -------------------------------------------------------------------------------- /src/client/qualvosec.conf: -------------------------------------------------------------------------------- 1 | [general] 2 | server: https://patching.gyptazy.int 3 | monitoring: enable 4 | monitoring_port: 8037 5 | monitoring_listener: 127.0.0.1 6 | log_level: CRITICAL 7 | log_handler: SystemdHandler() 8 | -------------------------------------------------------------------------------- /packaging/server/deb_changelog.txt: -------------------------------------------------------------------------------- 1 | qualvosec (0.0.9) unstable; urgency=low 2 | 3 | * Initial beta version of QualvoSec server. 4 | 5 | -- Florian Paul Azim Hoberg Sat, 16 Mar 2024 05:38:41 -0200 6 | -------------------------------------------------------------------------------- /packaging/admin/packaging.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | mkdir packages 4 | mkdir build 5 | cd build 6 | cmake .. 7 | cpack -G DEB . 8 | cpack -G RPM . 9 | cp *.deb ../packages 10 | cp *.rpm ../packages 11 | cd .. 12 | rm -rf build 13 | 14 | echo "Packages created. Packages can be found in directory: packages" 15 | -------------------------------------------------------------------------------- /packaging/client/rpm_changelog.txt: -------------------------------------------------------------------------------- 1 | * Wed Mar 07 2024 Florian Paul Azim Hoberg 2 | - * Added custom user agent including FQDN of the client system. 3 | 4 | * Wed Mar 06 2024 Florian Paul Azim Hoberg 5 | - Added http health endpoint as a monitoring interface. 6 | 7 | * Wed Mar 06 2024 Florian Paul Azim Hoberg 8 | - Initial release of QualvoSec. 9 | -------------------------------------------------------------------------------- /sudoers.d/qualvosec: -------------------------------------------------------------------------------- 1 | qualvosec ALL=(root) NOPASSWD: /usr/sbin/qualvosec 2 | qualvosec ALL=(root) NOPASSWD: /usr/sbin/reboot 3 | qualvosec ALL=(root) NOPASSWD: /usr/bin/apt-get -y install 4 | qualvosec ALL=(root) NOPASSWD: /usr/bin/apt-get -y upgrade 5 | qualvosec ALL=(root) NOPASSWD: /usr/bin/apt-mark hold 6 | qualvosec ALL=(root) NOPASSWD: /usr/bin/yum -y upgrade 7 | qualvosec ALL=(root) NOPASSWD: /usr/bin/yum versionlock add 8 | qualvosec ALL=(root) NOPASSWD: /usr/bin/pkg upgrade -yq 9 | qualvosec ALL=(root) NOPASSWD: /usr/bin/pkg lock 10 | -------------------------------------------------------------------------------- /packaging/client/deb_changelog.txt: -------------------------------------------------------------------------------- 1 | qualvosec (1.0.2) unstable; urgency=low 2 | 3 | * Added custom user agent including FQDN of the client system. 4 | 5 | -- Florian Paul Azim Hoberg Thu, 07 Mar 2024 05:38:41 -0200 6 | 7 | qualvosec (1.0.1) unstable; urgency=low 8 | 9 | * Added http health endpoint as a monitoring interface. 10 | 11 | -- Florian Paul Azim Hoberg Wed, 06 Mar 2024 08:12:14 -0200 12 | 13 | qualvosec (1.0.0) unstable; urgency=low 14 | 15 | * Initial release of QualvoSec. 16 | 17 | -- Florian Paul Azim Hoberg Wed, 06 Mar 2024 01:32:12 -0200 18 | -------------------------------------------------------------------------------- /src/admin/example.log: -------------------------------------------------------------------------------- 1 | 192.168.0.14 - - [07/Mar/2024:03:05:02 +0100] "GET /patch.yaml HTTP/1.1" 200 1281 "-" "QualvoSec 1.0.2 srv01.gyptazy.ch" 2 | 192.168.0.12 - - [07/Mar/2024:03:05:03 +0100] "GET /patch.yaml HTTP/1.1" 200 1281 "-" "QualvoSec 1.0.2 srv02.gyptazy.ch" 3 | 192.168.0.23 - - [07/Mar/2024:03:05:03 +0100] "GET /patch.yaml HTTP/1.1" 200 1281 "-" "QualvoSec 1.0.2 srv03.gyptazy.ch" 4 | 192.168.0.11 - - [07/Mar/2024:03:05:03 +0100] "GET /patch.yaml HTTP/1.1" 200 1281 "-" "QualvoSec 1.0.2 srv04.gyptazy.ch" 5 | 192.168.0.13 - - [07/Mar/2024:03:05:03 +0100] "GET /patch.yaml HTTP/1.1" 200 1281 "-" "QualvoSec 1.0.2 srv05.gyptazy.ch" 6 | 192.168.0.25 - - [07/Mar/2024:03:05:03 +0100] "GET /patch.yaml HTTP/1.1" 200 1281 "-" "QualvoSec 1.0.2 srv06.gyptazy.ch" 7 | -------------------------------------------------------------------------------- /packaging/client/packaging.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | cp CMakeLists.txt CMakeLists.txt.bak 4 | 5 | mkdir packages 6 | mkdir build 7 | cd build 8 | cmake .. 9 | cpack -G DEB . 10 | cpack -G RPM . 11 | cp *.deb ../packages 12 | cp *.rpm ../packages 13 | cd .. 14 | rm -rf build 15 | 16 | cp CMakeLists.txt_arm64 CMakeLists.txt 17 | mkdir build 18 | cd build 19 | cmake .. 20 | cpack -G DEB . 21 | cpack -G RPM . 22 | cp *.deb ../packages 23 | cp *.rpm ../packages 24 | cd .. 25 | rm -rf build 26 | 27 | cp CMakeLists.txt_riscv64 CMakeLists.txt 28 | mkdir build 29 | cd build 30 | cmake .. 31 | cpack -G DEB . 32 | cpack -G RPM . 33 | cp *.deb ../packages 34 | cp *.rpm ../packages 35 | cd .. 36 | rm -rf build 37 | 38 | cp CMakeLists.txt.bak CMakeLists.txt 39 | echo "Packages created. Packages can be found in directory: packages" 40 | -------------------------------------------------------------------------------- /packaging/server/packaging.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | cp CMakeLists.txt CMakeLists.txt.bak 4 | 5 | mkdir packages 6 | mkdir build 7 | cd build 8 | cmake .. 9 | cpack -G DEB . 10 | cpack -G RPM . 11 | cp *.deb ../packages 12 | cp *.rpm ../packages 13 | cd .. 14 | rm -rf build 15 | 16 | cp CMakeLists.txt_arm64 CMakeLists.txt 17 | mkdir build 18 | cd build 19 | cmake .. 20 | cpack -G DEB . 21 | cpack -G RPM . 22 | cp *.deb ../packages 23 | cp *.rpm ../packages 24 | cd .. 25 | rm -rf build 26 | 27 | cp CMakeLists.txt_riscv64 CMakeLists.txt 28 | mkdir build 29 | cd build 30 | cmake .. 31 | cpack -G DEB . 32 | cpack -G RPM . 33 | cp *.deb ../packages 34 | cp *.rpm ../packages 35 | cd .. 36 | rm -rf build 37 | 38 | cp CMakeLists.txt.bak CMakeLists.txt 39 | echo "Packages created. Packages can be found in directory: packages" 40 | -------------------------------------------------------------------------------- /src/server/patch.yaml: -------------------------------------------------------------------------------- 1 | hypervisor01.gyptazy.ch: 2 | patch: true 3 | reboot: true 4 | weekday: 1 5 | hour: 23 6 | minute: 30 7 | packages_whitelist 8 | - nginx 9 | - tzdata 10 | packages_blacklist: 11 | - vim 12 | group_membership: 13 | - gyptazy_prod 14 | # hypervisor02.gyptazy.ch: # Defines the remote FQDN of the client system. 15 | # patch: true # Defines to patch the system in general. 16 | # reboot: true # Defines to reboot the system after installing the updates. 17 | # weekday: 2 # Weekday where the patches should be installed (Starting with 0 for Monday). 18 | # hour: 3 # Hours where the patches should be installed. 19 | # minute: 15 # Minute where the patches should be installed. 20 | # packages_whitelist: # Optional: Defines to update only specific packages (pkg given as list). 21 | # - nginx # Optional: Upgrades nginx package. 22 | # - tzdata # Optional: Upgrades tzdata package. 23 | # packages_blacklist: # Optional: Defines packages to exclude from upgrades. 24 | # - vim # Optional: Excludes vim from being updates. 25 | # group_membership: # Optional: Group membership (e.g. project-, customer-, patch cycle based) 26 | # - gyptazy_prod # Optional: Name of the group (multiple elements possible) -------------------------------------------------------------------------------- /packaging/admin/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.16) 2 | project(QualvoSec-Admin VERSION 1.0.2) 3 | 4 | install(PROGRAMS ../../src/admin/qualvosec_admin DESTINATION /sbin) 5 | install(FILES ../../src/admin/qualvosec_admin.conf DESTINATION /etc/qualvosec) 6 | 7 | # General 8 | set(CPACK_PACKAGE_NAME "qualvosec_admin") 9 | set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/../../LICENSE") 10 | set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/../../README.md") 11 | set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Florian Paul Azim Hoberg ") 12 | set(CPACK_PACKAGE_CONTACT "Florian Paul Azim Hoberg = 3.2.0, python3-pyyaml") 25 | 26 | # DEB packaging 27 | set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT) 28 | set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "amd64") 29 | set(CPACK_DEBIAN_PACKAGE_SUMMARY "qualvosec_admin - A minimal security patch management tool.") 30 | set(CPACK_DEBIAN_PACKAGE_DESCRIPTION "qualvosec_admin - A minimal security patch management tool.") 31 | set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/deb_changelog.txt") 32 | set(CPACK_DEBIAN_PACKAGE_DEPENDS "python3-yaml") 33 | set(CPACK_DEBIAN_PACKAGE_LICENSE "GPL 3.0") 34 | 35 | 36 | # Install 37 | set(CPACK_PACKAGING_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}) 38 | include(CPack) 39 | -------------------------------------------------------------------------------- /packaging/server/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.16) 2 | project(QualvoSecServer VERSION 1.0.2) 3 | 4 | install(PROGRAMS ../../src/server/qualvosec_server DESTINATION /sbin) 5 | install(FILES ../../src/server/qualvosec_server.conf DESTINATION /etc/qualvosec) 6 | install(FILES ../../systemd/server/qualvosec_server.service DESTINATION /etc/systemd/system) 7 | 8 | # General 9 | set(CPACK_PACKAGE_NAME "qualvosec-server") 10 | set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/../../LICENSE") 11 | set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/../../README.md") 12 | set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Florian Paul Azim Hoberg ") 13 | set(CPACK_PACKAGE_CONTACT "Florian Paul Azim Hoberg = 3.2.0, python3-pyyaml, sudo") 26 | 27 | # DEB packaging 28 | set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT) 29 | set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "amd64") 30 | set(CPACK_DEBIAN_PACKAGE_SUMMARY "qualvosec server - A minimal security patch management tool.") 31 | set(CPACK_DEBIAN_PACKAGE_DESCRIPTION "qualvosec server - A minimal security patch management tool.") 32 | set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/deb_changelog.txt") 33 | set(CPACK_DEBIAN_PACKAGE_DEPENDS "python3-yaml, sudo") 34 | set(CPACK_DEBIAN_PACKAGE_LICENSE "GPL 3.0") 35 | 36 | 37 | # Install 38 | set(CPACK_PACKAGING_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}) 39 | set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/postinst") 40 | set(CPACK_RPM_POST_INSTALL_SCRIPT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/postinst") 41 | include(CPack) 42 | -------------------------------------------------------------------------------- /packaging/client/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.16) 2 | project(QualvoSec VERSION 1.0.2) 3 | 4 | install(PROGRAMS ../../src/client/qualvosec DESTINATION /sbin) 5 | install(FILES ../../src/client/qualvosec.conf DESTINATION /etc/qualvosec) 6 | install(FILES ../../sudoers.d/qualvosec DESTINATION /etc/sudoers.d) 7 | install(FILES ../../systemd/client/qualvosec.service DESTINATION /etc/systemd/system) 8 | 9 | # General 10 | set(CPACK_PACKAGE_NAME "qualvosec") 11 | set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/../../LICENSE") 12 | set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/../../README.md") 13 | set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Florian Paul Azim Hoberg ") 14 | set(CPACK_PACKAGE_CONTACT "Florian Paul Azim Hoberg = 3.2.0, python3-pyyaml, sudo") 27 | 28 | # DEB packaging 29 | set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT) 30 | set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "amd64") 31 | set(CPACK_DEBIAN_PACKAGE_SUMMARY "qualvosec - A minimal security patch management tool.") 32 | set(CPACK_DEBIAN_PACKAGE_DESCRIPTION "qualvosec - A minimal security patch management tool.") 33 | set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/deb_changelog.txt") 34 | set(CPACK_DEBIAN_PACKAGE_DEPENDS "python3-yaml, sudo") 35 | set(CPACK_DEBIAN_PACKAGE_LICENSE "GPL 3.0") 36 | 37 | 38 | # Install 39 | set(CPACK_PACKAGING_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}) 40 | set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/postinst") 41 | set(CPACK_RPM_POST_INSTALL_SCRIPT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/postinst") 42 | include(CPack) 43 | -------------------------------------------------------------------------------- /packaging/client/CMakeLists.txt_arm64: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.16) 2 | project(QualvoSec VERSION 1.0.2) 3 | 4 | install(PROGRAMS ../src/client/qualvosec DESTINATION /sbin) 5 | install(FILES ../src/client/qualvosec.conf DESTINATION /etc/qualvosec) 6 | install(FILES ../sudoers.d/qualvosec DESTINATION /etc/sudoers.d) 7 | install(FILES ../systemd/qualvosec.service DESTINATION /etc/systemd/system) 8 | 9 | # General 10 | set(CPACK_PACKAGE_NAME "qualvosec") 11 | set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/../../LICENSE") 12 | set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/../../README.md") 13 | set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Florian Paul Azim Hoberg ") 14 | set(CPACK_PACKAGE_CONTACT "Florian Paul Azim Hoberg = 3.2.0, python3-pyyaml, sudo") 28 | 29 | # DEB packaging 30 | set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT) 31 | set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "arm64") 32 | set(CPACK_DEBIAN_PACKAGE_SUMMARY "qualvosec - A minimal security patch management tool.") 33 | set(CPACK_DEBIAN_PACKAGE_DESCRIPTION "qualvosec - A minimal security patch management tool.") 34 | set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/deb_changelog.txt") 35 | set(CPACK_DEBIAN_PACKAGE_DEPENDS "python3-yaml, sudo") 36 | set(CPACK_DEBIAN_PACKAGE_LICENSE "GPL 3.0") 37 | 38 | 39 | # Install 40 | set(CPACK_PACKAGING_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}) 41 | set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/postinst") 42 | set(CPACK_RPM_POST_INSTALL_SCRIPT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/postinst") 43 | include(CPack) 44 | -------------------------------------------------------------------------------- /packaging/server/CMakeLists.txt_arm64: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.16) 2 | project(QualvoSec VERSION 1.0.2) 3 | 4 | install(PROGRAMS ../src/client/qualvosec DESTINATION /sbin) 5 | install(FILES ../src/client/qualvosec.conf DESTINATION /etc/qualvosec) 6 | install(FILES ../sudoers.d/qualvosec DESTINATION /etc/sudoers.d) 7 | install(FILES ../systemd/qualvosec.service DESTINATION /etc/systemd/system) 8 | 9 | # General 10 | set(CPACK_PACKAGE_NAME "qualvosec") 11 | set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/../../LICENSE") 12 | set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/../../README.md") 13 | set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Florian Paul Azim Hoberg ") 14 | set(CPACK_PACKAGE_CONTACT "Florian Paul Azim Hoberg = 3.2.0, python3-pyyaml, sudo") 28 | 29 | # DEB packaging 30 | set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT) 31 | set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "arm64") 32 | set(CPACK_DEBIAN_PACKAGE_SUMMARY "qualvosec - A minimal security patch management tool.") 33 | set(CPACK_DEBIAN_PACKAGE_DESCRIPTION "qualvosec - A minimal security patch management tool.") 34 | set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/deb_changelog.txt") 35 | set(CPACK_DEBIAN_PACKAGE_DEPENDS "python3-yaml, sudo") 36 | set(CPACK_DEBIAN_PACKAGE_LICENSE "GPL 3.0") 37 | 38 | 39 | # Install 40 | set(CPACK_PACKAGING_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}) 41 | set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/postinst") 42 | set(CPACK_RPM_POST_INSTALL_SCRIPT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/postinst") 43 | include(CPack) 44 | -------------------------------------------------------------------------------- /packaging/client/CMakeLists.txt_riscv64: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.16) 2 | project(QualvoSec VERSION 1.0.2) 3 | 4 | install(PROGRAMS ../src/client/qualvosec DESTINATION /sbin) 5 | install(FILES ../src/client/qualvosec.conf DESTINATION /etc/qualvosec) 6 | install(FILES ../sudoers.d/qualvosec DESTINATION /etc/sudoers.d) 7 | install(FILES ../systemd/qualvosec.service DESTINATION /etc/systemd/system) 8 | 9 | # General 10 | set(CPACK_PACKAGE_NAME "qualvosec") 11 | set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/../../LICENSE") 12 | set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/../../README.md") 13 | set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Florian Paul Azim Hoberg ") 14 | set(CPACK_PACKAGE_CONTACT "Florian Paul Azim Hoberg = 3.2.0, python3-pyyaml, sudo") 28 | 29 | # DEB packaging 30 | set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT) 31 | set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "riscv64") 32 | set(CPACK_DEBIAN_PACKAGE_SUMMARY "qualvosec - A minimal security patch management tool.") 33 | set(CPACK_DEBIAN_PACKAGE_DESCRIPTION "qualvosec - A minimal security patch management tool.") 34 | set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/deb_changelog.txt") 35 | set(CPACK_DEBIAN_PACKAGE_DEPENDS "python3-yaml, sudo") 36 | set(CPACK_DEBIAN_PACKAGE_LICENSE "GPL 3.0") 37 | 38 | 39 | # Install 40 | set(CPACK_PACKAGING_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}) 41 | set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/postinst") 42 | set(CPACK_RPM_POST_INSTALL_SCRIPT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/postinst") 43 | include(CPack) 44 | -------------------------------------------------------------------------------- /packaging/server/CMakeLists.txt_riscv64: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.16) 2 | project(QualvoSec VERSION 1.0.2) 3 | 4 | install(PROGRAMS ../src/client/qualvosec DESTINATION /sbin) 5 | install(FILES ../src/client/qualvosec.conf DESTINATION /etc/qualvosec) 6 | install(FILES ../sudoers.d/qualvosec DESTINATION /etc/sudoers.d) 7 | install(FILES ../systemd/qualvosec.service DESTINATION /etc/systemd/system) 8 | 9 | # General 10 | set(CPACK_PACKAGE_NAME "qualvosec") 11 | set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/../../LICENSE") 12 | set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/../../README.md") 13 | set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Florian Paul Azim Hoberg ") 14 | set(CPACK_PACKAGE_CONTACT "Florian Paul Azim Hoberg = 3.2.0, python3-pyyaml, sudo") 28 | 29 | # DEB packaging 30 | set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT) 31 | set(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "riscv64") 32 | set(CPACK_DEBIAN_PACKAGE_SUMMARY "qualvosec - A minimal security patch management tool.") 33 | set(CPACK_DEBIAN_PACKAGE_DESCRIPTION "qualvosec - A minimal security patch management tool.") 34 | set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/deb_changelog.txt") 35 | set(CPACK_DEBIAN_PACKAGE_DEPENDS "python3-yaml, sudo") 36 | set(CPACK_DEBIAN_PACKAGE_LICENSE "GPL 3.0") 37 | 38 | 39 | # Install 40 | set(CPACK_PACKAGING_INSTALL_PREFIX ${CMAKE_INSTALL_PREFIX}) 41 | set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/postinst") 42 | set(CPACK_RPM_POST_INSTALL_SCRIPT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/postinst") 43 | include(CPack) 44 | -------------------------------------------------------------------------------- /src/server/qualvosec_server: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # QualvoSec Server 4 | # QualvoSec is a minimalistic security patch management tool for unattended 5 | # upgrades on Linux and BSD based systems that are obtaining their packages 6 | # from a distribution based repository. 7 | # Copyright (C) 2023 Florian Paul Azim Hoberg @gyptazy 8 | # 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | 22 | import argparse 23 | import configparser 24 | import logging 25 | try: 26 | from http.server import HTTPServer, BaseHTTPRequestHandler 27 | except ImportError as error: 28 | logging.critical('QualvoSec: Can not start monitoring endpoint. Missing Python module: http') 29 | sys.exit(2) 30 | import os 31 | import shutil 32 | import sys 33 | try: 34 | import yaml 35 | except ImportError as error: 36 | logging.critical('QualvoSec: Can not start QualvoSec. Missing Python module: yaml') 37 | sys.exit(2) 38 | 39 | 40 | # Constants 41 | __appname__ = "QualvoSec Server" 42 | __version__ = "0.0.9" 43 | __author__ = "Florian Paul Azim Hoberg @gyptazy" 44 | 45 | 46 | ## Classes 47 | # Logging class 48 | class SystemdHandler(logging.Handler): 49 | """ Class to handle logging options. """ 50 | PREFIX = { 51 | logging.CRITICAL: "<2> " + __appname__ + ": ", 52 | logging.ERROR: "<3> " + __appname__ + ": ", 53 | logging.WARNING: "<4> " + __appname__ + ": ", 54 | logging.INFO: "<6> " + __appname__ + ": ", 55 | logging.DEBUG: "<7> " + __appname__ + ": ", 56 | logging.NOTSET: "<7 " + __appname__ + ": ", 57 | } 58 | 59 | def __init__(self, stream=sys.stdout): 60 | self.stream = stream 61 | logging.Handler.__init__(self) 62 | 63 | def emit(self, record): 64 | try: 65 | msg = self.PREFIX[record.levelno] + self.format(record) + "\n" 66 | self.stream.write(msg) 67 | self.stream.flush() 68 | except Exception: 69 | self.handleError(record) 70 | 71 | # Webserver Class 72 | class WebserverHandler(BaseHTTPRequestHandler): 73 | """ Class of QualvoSec's webserver. """ 74 | def do_GET(self): 75 | if self.path == '/health': 76 | self._get_http_health() 77 | 78 | if self.path == '/patch.yaml': 79 | self._get_patch_manifest() 80 | 81 | def _get_http_health(self): 82 | """ Evaluate QualvoSec's server current health status. """ 83 | self.send_response(200) 84 | self.send_header('Content-type', 'text/html') 85 | self.send_header(__appname__, __version__) 86 | self.end_headers() 87 | health_status = True 88 | self.wfile.write(f'healthy: {health_status}'.encode('utf-8')) 89 | 90 | def _get_patch_manifest(self, manifest='patch.yaml'): 91 | """ Return QualvoSec's patch manifest """ 92 | with open(manifest, 'rb') as f: 93 | self.send_response(200) 94 | self.send_header(__appname__, __version__) 95 | self.send_header("Content-Type", 'application/octet-stream') 96 | self.send_header("Content-Disposition", 'attachment; filename="{}"'.format(os.path.basename(manifest))) 97 | fs = os.fstat(f.fileno()) 98 | self.send_header("Content-Length", str(fs.st_size)) 99 | self.end_headers() 100 | shutil.copyfileobj(f, self.wfile) 101 | 102 | 103 | ## Fuctions 104 | def initialize_args(): 105 | """ Initialize given arguments for QualvoSec. """ 106 | argparser = argparse.ArgumentParser(description='QualvoSec') 107 | argparser.add_argument('-c', '--config', type=str, help='Path to config file.') 108 | return argparser.parse_args() 109 | 110 | 111 | def initialize_config_path(app_args): 112 | """ Initialize path to config file. """ 113 | config_path = app_args.config 114 | if app_args.config is None: 115 | # Try to fallback on distribution default path. 116 | config_path = '/etc/qualvosec/qualvosec_server.conf' 117 | return config_path 118 | 119 | def initialize_config_options(config_path): 120 | """ Read configuration from given config file for QualvoSec. """ 121 | try: 122 | config = configparser.ConfigParser() 123 | config.read(config_path) 124 | listener = config['general'].get('listener', '127.0.0.1') 125 | port = config['general'].get('port', 8037) 126 | log_level = config['general'].get('log_level', 'CRITICAL') 127 | log_handler = config['general'].get('log_handler', 'SystemdHandler()') 128 | except configparser.NoSectionError: 129 | logging.critical('Error parsing config file: Section not found.') 130 | sys.exit(2) 131 | except configparser.ParsingError: 132 | logging.critical('Error parsing config file: Impossible to parse file.') 133 | sys.exit(2) 134 | except KeyError: 135 | logging.critical('Error parsing config file: Key/Value not found.') 136 | sys.exit(2) 137 | return listener, port, log_level, log_handler 138 | 139 | 140 | def initialize_logger(log_level='CRITICAL', log_handler=('SystemdHandler()')): 141 | """ Initialize desired logging handler. """ 142 | root_logger = logging.getLogger() 143 | root_logger.setLevel(log_level) 144 | root_logger.addHandler(SystemdHandler()) 145 | logging.info(f'Info: Logger initialized.') 146 | 147 | 148 | def run_http_server(listener='127.0.0.1', port=8037): 149 | """ Initialize QualvoSec's webserver. """ 150 | logging.info(f'Info: Initializing QualvoSec server on port tcp/{port}.') 151 | httpd = HTTPServer((listener, int(port)), WebserverHandler) 152 | httpd.serve_forever() 153 | 154 | 155 | def main(): 156 | """ Run QualvoSec - A minimalistic security patch management tool. """ 157 | global port 158 | global listener 159 | app_args = initialize_args() 160 | config_path = initialize_config_path(app_args) 161 | listener, port, log_level, log_handler = initialize_config_options(config_path) 162 | initialize_logger(log_level, log_handler) 163 | run_http_server() 164 | 165 | 166 | if __name__ == "__main__": 167 | main() -------------------------------------------------------------------------------- /src/admin/qualvosec_admin: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # QualvoSec-admin 4 | # QualvoSec is a minimalistic security patch management tool for unattended 5 | # upgrades on Linux and BSD based systems that are obtaining their packages 6 | # from a distribution based repository. 7 | # Copyright (C) 2023 Florian Paul Azim Hoberg @gyptazy 8 | # 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | 22 | import argparse 23 | import configparser 24 | import datetime 25 | import dateutil.parser 26 | import sys 27 | import urllib 28 | try: 29 | import yaml 30 | except ImportError as error: 31 | print('QualvoSec: Can not start QualvoSec Admin. Missing Python module: yaml') 32 | sys.exit(2) 33 | from urllib.request import urlretrieve 34 | 35 | 36 | # Constants 37 | __appname__ = "QualvoSec-Admin" 38 | __version__ = "1.0.2" 39 | __author__ = "Florian Paul Azim Hoberg @gyptazy" 40 | 41 | 42 | ## Functions 43 | def initialize_args(): 44 | """ Initialize given arguments for QualvoSec. """ 45 | argparser = argparse.ArgumentParser(description='QualvoSec_admin') 46 | argparser.add_argument('option', nargs='?', default=True, help='Use [add|remove|list] to manage client systems.') 47 | argparser.add_argument('-c', '--config', type=str, help='Path to config file.') 48 | return argparser.parse_args() 49 | 50 | 51 | def initialize_config_path(app_args): 52 | """ Initialize path to config file. """ 53 | config_path = app_args.config 54 | if app_args.config is None: 55 | # Try to fallback on distribution default path. 56 | config_path = '/etc/qualvosec/qualvosec_admin.conf' 57 | return config_path 58 | 59 | 60 | def initialize_config_options(config_path): 61 | """ Read configuration from given config file for QualvoSec. """ 62 | try: 63 | config = configparser.ConfigParser() 64 | config.read(config_path) 65 | server = config['general']['server'] 66 | log_file_path = config['general']['log_file_path'] 67 | except configparser.NoSectionError: 68 | print('Error parsing config file: Section not found.') 69 | sys.exit(2) 70 | except configparser.ParsingError: 71 | print('Error parsing config file: Impossible to parse file.') 72 | sys.exit(2) 73 | except KeyError: 74 | print('Error parsing config file: Key/Value not found.') 75 | sys.exit(2) 76 | return server, log_file_path 77 | 78 | 79 | def read_file(log_file_path): 80 | """ Read lines of a given file. """ 81 | with open(log_file_path) as f: 82 | return f.readlines() 83 | 84 | 85 | def fetch_qualvosec_manifest(server): 86 | """ Fetch the QualvoSec manifest from the remote server. """ 87 | # Customize urllib opener. 88 | opener = urllib.request.build_opener() 89 | opener.addheaders = [('User-agent', f'{__appname__} {__version__}')] 90 | 91 | # Grab the initial QualvoSec manifest file once. 92 | try: 93 | return urlretrieve(f'{server}/patch.yaml') 94 | except urllib.error.URLError: 95 | print(f'Error while fetching the manifest from {server}.') 96 | sys.exit(2) 97 | 98 | 99 | def read_qualvosec_manifest(qualvosec_manifest_path): 100 | """ Read the QualvoSec patch manifest. """ 101 | with open(qualvosec_manifest_path, 'r') as test: 102 | qualvosec_manifest = yaml.safe_load(test) 103 | return qualvosec_manifest 104 | 105 | 106 | def print_table(system_overview): 107 | """ Print a pretty table output from a Python dict. """ 108 | print('{:<40} {:<20} {:<10} {:<10} {:<10} {:<10}'.format('System (FQDN)','Last Seen','Alive', 'Reboot', 'Patch', 'Patch Date')) 109 | print('_' * 110) 110 | for system in system_overview: 111 | print("{:<40} {:<20} {:<10} {:<10} {:<10} {:<10}".format(system, system_overview[system]['last_seen'], system_overview[system]['alive'], system_overview[system]['reboot'], system_overview[system]['patch'], system_overview[system]['patch_date'])) 112 | 113 | 114 | def get_dayname_by_int(day_as_integer): 115 | """ Get a weekday name by an integer. """ 116 | weekdays = {0:'Mon', 1:'Tue', 2:'Wed', 3:'Thur', 4:'Fri', 5:'Sat', 6:'Sun', 7:'!WRONG WEEKDAY!'} 117 | return weekdays[day_as_integer] 118 | 119 | 120 | def create_overview(file_content, qualvosec_manifest): 121 | """ """ 122 | system_overview = {} 123 | # Parse content from remote patch config file and 124 | # create initial overview of systems that should be 125 | # present for security patch management according 126 | # to the given server config file. 127 | for system in qualvosec_manifest: 128 | system_overview[system] = {} 129 | system_overview[system]['last_seen'] = 'never' 130 | system_overview[system]['alive'] = False 131 | system_overview[system]['reboot'] = qualvosec_manifest[system]['reboot'] 132 | system_overview[system]['patch'] = qualvosec_manifest[system]['patch'] 133 | day_name = get_dayname_by_int(qualvosec_manifest[system]['weekday']) 134 | system_overview[system]['patch_date'] = f'{day_name}, {str(qualvosec_manifest[system]["hour"])}:{str(qualvosec_manifest[system]["minute"])}' 135 | 136 | # Parse content from log file and extend/update 137 | # the overview by the given metadata from the 138 | # server's log file. 139 | for line in file_content: 140 | last_seen = line.split(' ')[3].replace('[','').split(':') 141 | system = line.split(' ')[13].replace('"\n', '') 142 | if system_overview.get(system): 143 | # Overwrite last seen to get latest available date 144 | insertion_date = dateutil.parser.parse(last_seen[0]) 145 | date_today_7_days_before = datetime.datetime.today() - datetime.timedelta(days=7) 146 | older_than_7_days = insertion_date < date_today_7_days_before 147 | 148 | # Flag the system as alive 149 | if older_than_7_days: 150 | alive = False 151 | else: 152 | alive = True 153 | 154 | # Place values in overview 155 | system_overview[system]['last_seen'] = last_seen[0] 156 | system_overview[system]['alive'] = alive 157 | 158 | print_table(system_overview) 159 | 160 | 161 | def add_system(qualvosec_manifest): 162 | """ Add new system to manifest. """ 163 | print('WIP: Not yet integrated.') 164 | 165 | 166 | def remove_system(qualvosec_manifest): 167 | """ Remove system from manifest. """ 168 | print('WIP: Not yet integrated.') 169 | 170 | 171 | def main(): 172 | """ Run QualvoSec Admin - A minimalistic security patch management tool. """ 173 | app_args = initialize_args() 174 | config_path = initialize_config_path(app_args) 175 | server, log_file_path = initialize_config_options(config_path) 176 | file_content = read_file(log_file_path) 177 | qualvosec_manifest_path = fetch_qualvosec_manifest(server) 178 | qualvosec_manifest = read_qualvosec_manifest(qualvosec_manifest_path[0]) 179 | 180 | # Create list output of client systems 181 | if app_args.option == 'list': 182 | create_overview(file_content, qualvosec_manifest) 183 | 184 | # Add client system 185 | elif app_args.option == 'add': 186 | add_system(qualvosec_manifest) 187 | 188 | # Remove client system 189 | elif app_args.option == 'remove': 190 | remove_system(qualvosec_manifest) 191 | 192 | # Print user error 193 | else: 194 | print('No valid option selected.') 195 | 196 | 197 | if __name__ == '__main__': 198 | main() 199 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # QualvoSec 2 | 3 |
4 | 5 |

6 | 7 | 8 | ## Table of Content 9 | * Introduction 10 | * Features 11 | * General 12 | * Client 13 | * Config 14 | * Options 15 | * Server 16 | * Options 17 | * Weekday Definitions 18 | * Admin 19 | * Usage 20 | * Systemd 21 | * Manual 22 | * Parameters 23 | * Supported Systems 24 | * Dependencies 25 | * HowTos & References 26 | * Motivation 27 | * Packages 28 | * Misc 29 | * Bugs 30 | * Contributing 31 | * Author(s) 32 | 33 | ## Introduction 34 | `QualvoSec` is a minimalistic security patch management tools (security patch framework) for unattended upgrades on Linux and BSD based systems that are obtaining their packages from a distribution based repository. It is written in Python for minimal setups where solutions like Spacewalk or Landscape would be too bloated. QualvoSec supports Debian (e.g. Ubuntu, GardenLinux, etc.) and RedHat (CentOS, Fedora, RockyLinux, etc.) based Distributions but also BSD (e.g. FreeBSD, OpenBSD, macOS, etc.). 35 | 36 | ## Features 37 | * Not running as root 38 | * Only specific commands allowed by sudo 39 | * Clients pulling information from server 40 | * Server provides only a static manifest 41 | * Holding the patch windows of clients 42 | * No remote code executions 43 | * A potential compromised server could not be able to execute code on clients 44 | * Health monitoring endpoint on clients 45 | * Minimalistic design 46 | * Admin tool for creating, deleting and looking up of client patch windows 47 | * Fully written in Python3 48 | * Integrated packaging support by CMake 49 | * CMake/CPack created .deb and .rpm files 50 | * Support for Linux, BSD 51 | * Support for AMD64, ARM64 and RISC-V hardware architecture 52 | 53 | ## General 54 | QualvoSec is a software designed for efficient and automated security management of remote servers. This application operates by periodically inspecting a designated remote server manifest (a static YAML file) to extract information relevant to the local system's Fully Qualified Domain Name (FQDN). The manifest contains crucial details, including the specified date for patching corresponding systems and whether a system necessitates a reboot post-patch installation. 55 | 56 | With its proactive approach, QualvoSec ensures that systems are up-to-date with the latest patches, promoting robust security measures. The software streamlines the process by matching FQDNs, allowing for targeted actions based on the unique identity of each local system. By providing clear directives on patching timelines and reboot requirements, QualvoSec enhances overall system security and stability, minimizing vulnerabilities and potential risks associated with outdated software. 57 | 58 | ### Communication 59 | ![right:40% 80%](https://cdn.gyptazy.ch/images/QualvoSec-topology.jpg) 60 | 61 | ### Flowchart 62 | ![width:22cm height:13cm](https://cdn.gyptazy.ch/images/QualvoSec-flowchart.png) 63 | 64 | ### Client 65 | The client is required to gather additional information from a configuration file, which should include the specified details. By default, the client will search for a configuration file in /etc/qualvosec/qualvosec.conf. However, users have the flexibility to define a custom path for the configuration file by utilizing the -c argument with the client (refer to the usage chapter for more details). 66 | 67 | Upon initiation, the client will retrieve the patch manifest file from the server, and this file will be cached for a duration of 6 hours. If necessary, the cache can be invalidated by simply restarting the client. Each time the client is started, the file will be freshly acquired before being cached. Throughout runtime, the cache will be automatically cleared after 6 hours, allowing for any changes from the manifest to take effect. This approach is implemented to prevent excessive server requests, particularly when multiple clients may otherwise inundate the server with requests every minute. 68 | 69 | #### Config 70 | ``` 71 | [general] 72 | server: https://patching.gyptazy.int 73 | log_level: CRITICAL 74 | log_handler: SystemdHandler() 75 | ``` 76 | 77 | #### Options 78 | The following options can be set in the `qualvosec.conf` file: 79 | 80 | | Option | Type | Description | 81 | |------|:------:|:------:| 82 | | server | String | Defines the remote server instance hosting the manifest file. | 83 | | monitoring | Bool | Defines to activate the monitoring interface. | 84 | | monitoring_port | Integer | Defines the port of the monitoring interface (Default: 8037). | 85 | | monitoring_listener | String | Defines the listener address of the monitoring interface (Default: 127.0.0.1). | 86 | | log_level | String | Defines the log level (Default: CRITICAL). | 87 | | log_handler | String | Defines the log handler (Default: SystemdHandler). | 88 | 89 | #### Monitoring Interface 90 | To validate that the service is up and running a monitoring interface including a health endpoint can be activated (see also chapter Options). By default, the endpoint listens on tcp/8037 (can be adjusted) and can be checked with 91 | any http conform client (e.g. GypMon, Icinga2, etc.). 92 | 93 | Example: 94 | 95 | ``` 96 | $> curl localhost:8037/health 97 | healthy=true 98 | ``` 99 | 100 | Currently, the endpoint will only report the following states for type `healthy`: 101 | * true 102 | * false 103 | 104 | ### Server 105 | On the root path of the defined domain, a `patch.yaml` file (manifest) must be placed. This static file contains all further information of the clients that consume the file periodically. An example file is given below: 106 | 107 | ``` 108 | hypervisor01.gyptazy.ch: 109 | patch: true 110 | reboot: true 111 | weekday: 1 112 | hour: 23 113 | minute: 30 114 | packages_whitelist: 115 | - nginx 116 | - tzdata 117 | packages_whitelisted: 118 | - vim 119 | hypervisor02.gyptazy.ch: 120 | patch: true 121 | reboot: true 122 | weekday: 2 123 | hour: 3 124 | minute: 15 125 | group_membership: 126 | - gyptazy_prod 127 | - patch_cycle_monday 128 | ``` 129 | 130 | This example provides patch information for two systems where the key is equal to the client system that should be patched. In this example, the system with the fqdn `hypervisor01.gyptazy.ch` should be patched and also be rebooted in general. The patches should be integrated every Tuesday (1) at 11:30 PM. Given by the key `packages` (type: list), only the defined packages (whitelist) will be upgraded. 131 | 132 | #### Options 133 | The following options can be set in the `patch.yaml` file and will be interpreted by the corresponding client. 134 | 135 | | Option | Type | Description | 136 | |------|:------:|:------:| 137 | | patch | Bool | Defines if the system should be patched in general. It might be helpful to deactivate this on important dates. | 138 | | reboot | Bool | Defines if the system should be rebooted after the installation of patches. GLIBC, Kernel etc. may require this. | 139 | | weekday | Integer | Defines the weekday (starting on Mondays with 0). | 140 | | hour | Integer | Defines the hour to start the patching (to be defined in 24 hours syntax). | 141 | | minute | Integer | Defines the minute to start the patching. | 142 | | packages_whitelist | List | Defines specific packages to only update (Default: all) | 143 | | packages_blacklist | List | Defines specific packages to exclude from being updated (Default: none) | 144 | | group_membership | List | Defines a list of group memberships (e.g. customer, project, patch-cycles, etc.) (Default: none) | 145 | 146 | #### Weekday Definitions 147 | | Weekday | Config (Integer) | 148 | |------|:------:| 149 | | Monday | 0 | 150 | | Tuesday | 1 | 151 | | Wednesday | 2 | 152 | | Thursday | 3 | 153 | | Friday | 4 | 154 | | Saturday | 5 | 155 | | Sunday | 6 | 156 | 157 | ### Admin 158 | QualvoSec's admin utility offers a comprehensive solution for efficient system management. Users benefit from a centralized platform that provides a quick overview of connected systems and their patch statuses. The utility facilitates seamless system management by allowing users to add or remove systems with ease. This streamlined process ensures that the organization's security infrastructure remains up-to-date and aligned with operational requirements. 159 | 160 | #### Options 161 | The following options can be set in the `qualvosec_admin.conf` file: 162 | 163 | | Option | Type | Description | 164 | |------|:------:|:------:| 165 | | server | String | Defines the remote server instance hosting the manifest file. | 166 | | log_file_path | String | Defines path to the server's access log file. | 167 | 168 | #### Arguments 169 | | Args | Description | 170 | |------|:------:| 171 | | list | Lists all systems (providing an overview) | 172 | | add | Adds new system and/or patch cycle | 173 | | remove | Removes a system and/oe patch cycle | 174 | 175 | #### Example Output List 176 | Attached, you can find a sample outpout of the list command, showing the system overview: 177 | 178 | ``` 179 | System (FQDN) Last Seen Alive Reboot Patch Patch Date 180 | ______________________________________________________________________________________________________________ 181 | giro48.gyptazy.ch never 0 0 1 Fri, 3:15 182 | giro49.gyptazy.ch never 0 0 1 Tue, 3:15 183 | giro50.gyptazy.ch never 0 0 1 Fri, 3:15 184 | giro51.gyptazy.ch never 0 0 1 Tue, 3:15 185 | giro52.gyptazy.ch never 0 0 1 Fri, 3:15 186 | giro53.gyptazy.ch never 0 0 1 !WRONG WEEKDAY!, 1:15 187 | ``` 188 | 189 | 190 | ## Usage 191 | ### Systemd 192 | The easiest way, if supported by the underlying system, is to copy the sudo-droplet and the systemd-service file. Afterwards, the system can be started and orchestrated by systemd. 193 | 194 | ### Manual 195 | A manual installation is possible and also supports BSD based systems. QualvoSec relies on mainly two important files: 196 | * qualvosec (Python Executable) 197 | * qualvosec.conf (Config file) 198 | 199 | The executable must be able to read the config file. 200 | 201 | ### Parameters 202 | The following options and parameters are currently supported: 203 | 204 | | Option | Long Option | Description | Default | 205 | |------|:------:|------:|------:| 206 | | -c | --config | Path to a config file. | /etc/qualvosec/qualvosec.conf | 207 | 208 | ### Supported Systems 209 | The goal is to support as many platforms and systems as possible which only needs a small Python environment without any further custom imports. Therefore, this is supported to run on: 210 | * Linux (Debian, Ubuntu, Garden Linux, RedHat, CentOS, RockyLinux, etc.) 211 | * BSD (FreeBSD, NetBSD, OpenBSD) 212 | * macOS (OSX) 213 | 214 | ### Dependencies 215 | QualvoSec is fully written in Python and just needs the basic modules to run. Please make sure that you have in place: 216 | 217 | * Python 3 218 | * argparse 219 | * configparser 220 | * datetime 221 | * http 222 | * logging 223 | * os 224 | * socket 225 | * subprocess 226 | * sys 227 | * time 228 | * urllib 229 | * yaml 230 | 231 | 232 | When running on Linux systems with `systemd` you should also make sure to have `sudo` installed and to use the sudo-droplet. 233 | 234 | ## HowTos & References 235 | A collection of howtos and references of QualvoSec in the net. 236 | 237 | | Type | Description | Link | 238 | |------|:------:|:------:| 239 | | Announcement | Release announcement of QualvoSec | [Link](https://gyptazy.ch/blog/qualvosec-a-minimalistic-security-patch-management-tools-for-linux-and-bsd/) | 240 | | HowTo | Howto Install QualvoSec Security Patch Management on Debian and Ubuntu | [Link](https://gyptazy.ch/howtos/howto-install-qualvosec-security-patch-management-on-debian/) | 241 | 242 | ## Motivation 243 | The motivation behind developing a self-written security patch management software with a focus on minimalism and reduced dependencies stems from the need for a streamlined and efficient solution. Traditional patch management tools often come with unnecessary bloat and dependencies, leading to increased complexity and resource consumption. In response to this, the goal is to create a slim, lightweight alternative that prioritizes simplicity and effectiveness. 244 | 245 | The key motivation is to provide a centralized system for managing security patches across different systems. This centralization enables administrators to define specific patch dates for various systems, ensuring a coordinated and controlled approach to patch deployment. By avoiding unnecessary features and dependencies, the software aims to minimize the risk of vulnerabilities associated with unused or poorly maintained components. 246 | 247 | This approach not only enhances the software's performance but also reduces the attack surface, making it more resilient against potential security threats. The emphasis on simplicity and minimalism contributes to easier maintenance and faster response times when addressing emerging security concerns. 248 | 249 | In summary, the motivation behind creating this self-written security patch management software lies in the pursuit of efficiency, reduced complexity, and centralized control. By offering a slim, lightweight solution with minimal dependencies, the software aims to provide a more secure and manageable approach to handling security patches across diverse systems. 250 | 251 | ## Packages 252 | ### Sources 253 | All sources are available within this repository. Needed files can be just copied and manually be configured to the operator's needs. Next to this, you can also use a CMake script to re-package the sources for RPM and DEB based distributions. 254 | Script for packaging can be found in the directory `packaging`. Packages can be created by simply running `packaging.sh`. A new directory `packages` gets created including the final artifacts. 255 | 256 | ### Distribution Packages 257 | Packages for end-user can be found on https://cdn.gyptazy.ch/files/ for the following operating systems and architectures: 258 | 259 | | OS | Distribution | Architecture | File | 260 | |------|:------:|------:|------:| 261 | | Linux | Debian | amd64 | https://cdn.gyptazy.ch/files/amd64/debian/qualvosec/ | 262 | | Linux | Debian | arm64 | https://cdn.gyptazy.ch/files/amd64/debian/qualvosec/ | 263 | | Linux | Debian | riscv64 | https://cdn.gyptazy.ch/files/amd64/debian/qualvosec/ | 264 | | Linux | Ubuntu | amd64 | https://cdn.gyptazy.ch/files/amd64/ubuntu/qualvosec/ | 265 | | Linux | Ubuntu | arm64 | https://cdn.gyptazy.ch/files/amd64/ubuntu/qualvosec/ | 266 | | Linux | Ubuntu | riscv64 | https://cdn.gyptazy.ch/files/amd64/ubuntu/qualvosec/ | 267 | | Linux | RedHat | amd64 | https://cdn.gyptazy.ch/files/amd64/redhat/qualvosec/ | 268 | | Linux | RedHat | arm64 | https://cdn.gyptazy.ch/files/amd64/redhat/qualvosec/ | 269 | | Linux | RedHat | riscv64 | https://cdn.gyptazy.ch/files/amd64/redhat/qualvosec/ | 270 | | Linux | RockyLinux / CentOS | amd64 | https://cdn.gyptazy.ch/files/amd64/centos/qualvosec/ | 271 | | Linux | RockyLinux / CentOS | arm64 | https://cdn.gyptazy.ch/files/amd64/centos/qualvosec/ | 272 | | Linux | RockyLinux / CentOS | riscv64 | https://cdn.gyptazy.ch/files/amd64/centos/qualvosec/ | 273 | | BSD | FreeBSD | amd64 | https://cdn.gyptazy.ch/files/amd64/freebsd/qualvosec/ | 274 | | BSD | FreeBSD | arm64 | https://cdn.gyptazy.ch/files/amd64/freebsd/qualvosec/ | 275 | | BSD | FreeBSD | riscv64 | https://cdn.gyptazy.ch/files/amd64/freebsd/qualvosec/ | 276 | 277 | ## Misc 278 | ### Bugs 279 | Bugs can be reported via the GitHub issue tracker [here](https://github.com/gyptazy/QualvoSec/issues). You may also report bugs via email or deliver PRs to fix them on your own. Therefore, you might also see the contributing chapter. 280 | 281 | ### Contributing 282 | Feel free to add further documentation, to adjust already existing one or to contribute with code. Please take care about the style guide and naming conventions. 283 | 284 | ### Author(s) 285 | * Florian Paul Azim Hoberg @gyptazy 286 | -------------------------------------------------------------------------------- /src/client/qualvosec: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # QualvoSec 4 | # QualvoSec is a minimalistic security patch management tool for unattended 5 | # upgrades on Linux and BSD based systems that are obtaining their packages 6 | # from a distribution based repository. 7 | # Copyright (C) 2023 Florian Paul Azim Hoberg @gyptazy 8 | # 9 | # This program is free software: you can redistribute it and/or modify 10 | # it under the terms of the GNU General Public License as published by 11 | # the Free Software Foundation, either version 3 of the License, or 12 | # (at your option) any later version. 13 | # 14 | # This program is distributed in the hope that it will be useful, 15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 | # GNU General Public License for more details. 18 | # 19 | # You should have received a copy of the GNU General Public License 20 | # along with this program. If not, see . 21 | 22 | try: 23 | import apt 24 | api_apt = True 25 | except ImportError as error: 26 | api_apt = False 27 | import argparse 28 | import configparser 29 | import datetime 30 | import logging 31 | import os 32 | try: 33 | import pkg 34 | api_pkg = True 35 | except ImportError as error: 36 | api_pkg = False 37 | try: 38 | import rpm 39 | api_rpm = True 40 | except ImportError as error: 41 | api_rpm = False 42 | import socket 43 | import subprocess 44 | import sys 45 | import time 46 | import threading 47 | import urllib 48 | try: 49 | import yaml 50 | except ImportError as error: 51 | logging.critical('QualvoSec: Can not start QualvoSec. Missing Python module: yaml') 52 | sys.exit(2) 53 | from urllib.request import urlretrieve 54 | try: 55 | from http.server import HTTPServer, BaseHTTPRequestHandler 56 | except ImportError as error: 57 | logging.critical('QualvoSec: Can not start monitoring endpoint. Missing Python module: http') 58 | sys.exit(2) 59 | 60 | 61 | # Constants 62 | __appname__ = "QualvoSec" 63 | __version__ = "1.0.2" 64 | __author__ = "Florian Paul Azim Hoberg @gyptazy" 65 | 66 | 67 | ## Classes 68 | # Logging class 69 | class SystemdHandler(logging.Handler): 70 | """ Class to handle logging options. """ 71 | PREFIX = { 72 | logging.CRITICAL: "<2> " + __appname__ + ": ", 73 | logging.ERROR: "<3> " + __appname__ + ": ", 74 | logging.WARNING: "<4> " + __appname__ + ": ", 75 | logging.INFO: "<6> " + __appname__ + ": ", 76 | logging.DEBUG: "<7> " + __appname__ + ": ", 77 | logging.NOTSET: "<7 " + __appname__ + ": ", 78 | } 79 | 80 | def __init__(self, stream=sys.stdout): 81 | self.stream = stream 82 | logging.Handler.__init__(self) 83 | 84 | def emit(self, record): 85 | try: 86 | msg = self.PREFIX[record.levelno] + self.format(record) + "\n" 87 | self.stream.write(msg) 88 | self.stream.flush() 89 | except Exception: 90 | self.handleError(record) 91 | 92 | 93 | # Monitoring class 94 | class MonitoringHandler(BaseHTTPRequestHandler): 95 | """ Class to respond for monitoring requests on QualvoSec. """ 96 | def do_GET(self): 97 | self.send_response(200) 98 | self.send_header('Content-type', 'text/html') 99 | self.send_header(__appname__, __version__) 100 | self.end_headers() 101 | 102 | if self.path == '/health': 103 | http_content = self._get_http_health() 104 | self.wfile.write(f'healthy: {http_content}'.encode('utf-8')) 105 | 106 | elif self.path == '/get_package_list': 107 | system_os_pkg_mgr = _get_system_os_pkg_mgr('api') 108 | 109 | # Create package list for Debian based systems 110 | if system_os_pkg_mgr == '/bin/apt': 111 | if api_apt: 112 | http_content = self._get_package_list_debian() 113 | self.wfile.write(f'{http_content}'.encode('utf-8')) 114 | else: 115 | self.wfile.write(f'Error: Missing Python library "apt".'.encode('utf-8')) 116 | 117 | # Create package list for RedHat based systems 118 | elif system_os_pkg_mgr == '/bin/rpm': 119 | if api_rpm: 120 | http_content = self._get_package_list_redhat() 121 | self.wfile.write(f'{http_content}'.encode('utf-8')) 122 | else: 123 | self.wfile.write(f'Error: Missing Python library "rpm".'.encode('utf-8')) 124 | 125 | # Create package list for FreeBSD systems 126 | elif system_os_pkg_mgr == '/bin/pkg': 127 | if api_pkg: 128 | http_content = self._get_package_list_freebsd() 129 | self.wfile.write(f'{http_content}'.encode('utf-8')) 130 | else: 131 | self.wfile.write(f'Error: Missing Python library "pkg".'.encode('utf-8')) 132 | 133 | # Return error is we cannot support the OS and therefore are unable to obtain a pkg list. 134 | else: 135 | self.wfile.write(f'Error: No supported OS found to provide package list.'.encode('utf-8')) 136 | 137 | # Return error message on unknown endpoints. 138 | else: 139 | self.wfile.write(f'Error: Not a supported endpoint requested.'.encode('utf-8')) 140 | 141 | 142 | def _get_http_health(self): 143 | """ Evaluate QualvoSec's current health status. """ 144 | health_status = True 145 | return health_status 146 | 147 | def _get_package_list_debian(self): 148 | """ Get the systems local package list on a Debian based system. """ 149 | cache = apt.Cache() 150 | installed_packages = {} 151 | for pkg in cache: 152 | if cache[pkg].is_installed: 153 | installed_packages[pkg.name] = pkg.installed.version 154 | return installed_packages 155 | 156 | def _get_package_list_redhat(self): 157 | """ Get the systems local package list on a RedHat based system. """ 158 | ts = rpm.TransactionSet() 159 | mi = ts.dbMatch() 160 | installed_packages = {} 161 | for h in mi: 162 | name = h['name'] 163 | version = h['version'] 164 | release = h['release'] 165 | epoch = h['epoch'] 166 | pkg_version = f"{epoch}:{version}-{release}" 167 | installed_packages[name] = pkg_version 168 | return installed_packages 169 | 170 | def _get_package_list_freebsd(self): 171 | """ Get the systems local package list on a FreeBSD system. """ 172 | installed_packages = {} 173 | db = pkg.PkgDb() 174 | for pkg_name in db: 175 | pkg_info = db[pkg_name] 176 | installed_packages[pkg_name] = pkg_info.version 177 | return installed_packages 178 | 179 | 180 | ## Functions 181 | def initialize_args(): 182 | """ Initialize given arguments for QualvoSec. """ 183 | argparser = argparse.ArgumentParser(description='QualvoSec') 184 | argparser.add_argument('-c', '--config', type=str, help='Path to config file.') 185 | return argparser.parse_args() 186 | 187 | 188 | def initialize_config_path(app_args): 189 | """ Initialize path to config file. """ 190 | config_path = app_args.config 191 | if app_args.config is None: 192 | # Try to fallback on distribution default path. 193 | config_path = '/etc/qualvosec/qualvosec.conf' 194 | return config_path 195 | 196 | 197 | def initialize_config_options(config_path): 198 | """ Read configuration from given config file for QualvoSec. """ 199 | try: 200 | config = configparser.ConfigParser() 201 | config.read(config_path) 202 | server = config['general']['server'] 203 | monitoring = config['general'].get('monitoring', False) 204 | monitoring_port = config['general'].get('monitoring_port', 8037) 205 | monitoring_listener = config['general'].get('monitoring_listener', '127.0.0.1') 206 | log_level = config['general'].get('log_level', 'CRITICAL') 207 | log_handler = config['general'].get('log_handler', 'SystemdHandler()') 208 | except configparser.NoSectionError: 209 | logging.critical('Error parsing config file: Section not found.') 210 | sys.exit(2) 211 | except configparser.ParsingError: 212 | logging.critical('Error parsing config file: Impossible to parse file.') 213 | sys.exit(2) 214 | except KeyError: 215 | logging.critical('Error parsing config file: Key/Value not found.') 216 | sys.exit(2) 217 | return server, log_level, log_handler, monitoring, monitoring_port, monitoring_listener 218 | 219 | 220 | def initialize_logger(log_level, log_handler): 221 | """ Initialize desired logging handler. """ 222 | root_logger = logging.getLogger() 223 | root_logger.setLevel(log_level) 224 | root_logger.addHandler(SystemdHandler()) 225 | logging.info(f'Info: Logger initialized.') 226 | 227 | 228 | def initialize_monitoring(): 229 | """ Initialize monitoring status endpoint. """ 230 | logging.info(f'Info: Initializing monitoring endpoint on port tcp/{monitoring_port}.') 231 | httpd = HTTPServer((monitoring_listener, int(monitoring_port)), MonitoringHandler) 232 | httpd.serve_forever() 233 | 234 | 235 | def fetch_qualvosec_manifest(server, qualvosec_manifest_path, system_fqdn): 236 | """ Fetch the QualvoSec manifest from the remote server. """ 237 | # Customize urllib opener. 238 | opener = urllib.request.build_opener() 239 | opener.addheaders = [('User-agent', f'{__appname__} {__version__} {system_fqdn}')] 240 | 241 | # Grab the initial QualvoSec manifest file once. 242 | urllib.request.install_opener(opener) 243 | if qualvosec_manifest_path is None: 244 | logging.info(f'Info: Trying to fetch manifest from {server}.') 245 | try: 246 | return urlretrieve(f'{server}/patch.yaml') 247 | except urllib.error.URLError: 248 | logging.critical(f'Error while fetching the manifest from {server}.') 249 | sys.exit(2) 250 | # Validate the file age for caching. Cache it during the runtime 251 | # and update the content every 6 hours. 252 | else: 253 | manifest_file_age = _get_file_age_time(qualvosec_manifest_path[0]) 254 | if int(manifest_file_age) > 360: 255 | logging.info(f'Info: Trying to fetch manifest from {server}.') 256 | try: 257 | return urlretrieve(f'{server}/patch.yaml') 258 | except urllib.error.URLError: 259 | logging.critical(f'Error while fetching the manifest from {server}.') 260 | sys.exit(2) 261 | else: 262 | logging.info(f'Info: Cached manifest from {server} used.') 263 | return qualvosec_manifest_path 264 | 265 | 266 | def read_qualvosec_manifest(qualvosec_manifest_path): 267 | """ Read the QualvoSec patch manifest. """ 268 | logging.info(f'Info: Reading manifest file from {qualvosec_manifest_path}') 269 | with open(qualvosec_manifest_path, 'r') as test: 270 | qualvosec_manifest = yaml.safe_load(test) 271 | return qualvosec_manifest 272 | 273 | 274 | def get_system_fqdn(): 275 | """ Get the system's local fqdn. """ 276 | logging.info(f'Info: Getting system fqdn.') 277 | return socket.getfqdn() 278 | 279 | 280 | def _get_file_age_time(file_name): 281 | """ Get the file age time of a given file. """ 282 | logging.info(f'Info: Getting file age time.') 283 | return time.time() - os.path.getmtime(file_name) 284 | 285 | 286 | def _get_time_information_now(): 287 | """ Get the current local time information. """ 288 | logging.info(f'Info: Getting current time information.') 289 | return datetime.datetime.now().weekday(), datetime.datetime.now().hour, datetime.datetime.now().minute 290 | 291 | 292 | def _get_time_information_patch(system_fqdn, qualvosec_manifest): 293 | """ Get the time information from QualvoSec manifest. """ 294 | logging.info(f'Info: Getting manifest time information.') 295 | return qualvosec_manifest[system_fqdn]['weekday'], qualvosec_manifest[system_fqdn]['hour'], qualvosec_manifest[system_fqdn]['minute'] 296 | 297 | 298 | def _get_system_os_pkg_mgr(system_fqdn): 299 | """ Get the system's operating system package manager. """ 300 | system_os = None 301 | system_os_debian = '/bin/apt' 302 | system_os_redhat = '/bin/rpm' 303 | system_os_freebsd = '/usr/sbin/pkg' 304 | supported_system_os = [system_os_debian, system_os_redhat, system_os_freebsd] 305 | 306 | for supported_os in supported_system_os: 307 | if os.path.exists(supported_os): 308 | system_os = supported_os 309 | 310 | if system_os is None: 311 | logging.critical(f'Error: The Operating System for {system_fqdn} could not be evaluated.') 312 | sys.exit(2) 313 | 314 | logging.info(f'Info: The Operating System for {system_fqdn} got evaluated and will use {system_os} for security patching.') 315 | return system_os 316 | 317 | 318 | def _validate_systems_patch_window(qualvosec_times, system_fqdn): 319 | """ Validate if the system is in the patch window. """ 320 | execute_patching = True 321 | for time_now, time_patch in qualvosec_times.items(): 322 | if time_now != time_patch: 323 | execute_patching = False 324 | 325 | if not execute_patching: 326 | logging.info(f'Info: The system {system_fqdn} has not yet reached the security patch window.') 327 | else: 328 | logging.info(f'Info: The system {system_fqdn} has reached the security patch window and will be patched.') 329 | return execute_patching 330 | 331 | 332 | def _execute_patch_system(system_os_pkg_mgmr, system_fqdn, system_packages_whitelist, system_packages_blacklist): 333 | """ Execute patching the system. """ 334 | if system_os_pkg_mgmr == '/bin/apt': 335 | logging.info(f'Info: Using apt-get for patching.') 336 | os.environ['DEBIAN_FRONTEND'] = 'noninteractive' 337 | 338 | # Hold packages back from being upgraded if requested. 339 | if system_packages_blacklist: 340 | _execute_package_blacklisting(system_os_pkg_mgmr, system_fqdn, system_packages_blacklist) 341 | 342 | # Upgrade only specific packages if requested or upgrade all available ones. 343 | if system_packages_whitelist: 344 | process = subprocess.Popen(['sudo', 'apt-get', '-y', 'install', system_packages_whitelist], stderr=subprocess.PIPE, stdout=subprocess.PIPE) 345 | else: 346 | process = subprocess.Popen(['sudo', 'apt-get', '-y', 'upgrade'], stderr=subprocess.PIPE, stdout=subprocess.PIPE) 347 | 348 | elif system_os_pkg_mgmr == '/bin/rpm': 349 | logging.info(f'Info: Using yum for patching.') 350 | process = subprocess.Popen(['sudo', 'yum', '-y', 'upgrade', system_packages_whitelist], stderr=subprocess.PIPE, stdout=subprocess.PIPE) 351 | 352 | elif system_os_pkg_mgmr == '/bin/pkg': 353 | logging.info(f'Info: Using pkg for patching.') 354 | process = subprocess.Popen(['sudo', 'pkg', 'upgrade', '-yq', system_packages_whitelist], stderr=subprocess.PIPE, stdout=subprocess.PIPE) 355 | 356 | process_output, process_error = process.communicate() 357 | exit_code = process.wait() 358 | 359 | if exit_code != 0: 360 | logging.critical(f'Error The system {system_fqdn} could not be patched.') 361 | logging.critical(f'Log: {process_error}') 362 | sys.exit(2) 363 | else: 364 | logging.critical(f'Info: The system {system_fqdn} got successfully patched.') 365 | logging.info(f'Log: {process_output}') 366 | 367 | 368 | def _validate_system_reboot(system_fqdn, qualvosec_manifest): 369 | """ Validate if system should be rebooted after security patching by QualvoSec. """ 370 | logging.info(f'Info: Validating for reboot of system {system_fqdn}.') 371 | if qualvosec_manifest[system_fqdn].get('reboot'): 372 | logging.info(f'Info: System {system_fqdn} will be rebooted.') 373 | return True 374 | else: 375 | logging.info(f'Info: System {system_fqdn} will not be rebooted.') 376 | return False 377 | 378 | 379 | def _get_system_packages_whitelist(system_fqdn, qualvosec_manifest): 380 | """ Get a list of packages that should only be updated by QualvoSec. """ 381 | logging.info(f'Info: Validating for specific packages to update on system {system_fqdn}.') 382 | packages = qualvosec_manifest[system_fqdn].get('packages_whitelist', False) 383 | 384 | # Check if (a) specific package(s) are defined. 385 | if packages: 386 | logging.info(f'Info: System {system_fqdn} will only update the the following packages: {" ".join(packages)}') 387 | return " ".join(packages) 388 | else: 389 | logging.info(f'Info: System {system_fqdn} will update all available packages.') 390 | return False 391 | 392 | 393 | def _get_system_packages_blacklist(system_fqdn, qualvosec_manifest): 394 | """ Get a list of packages that should be excluded from being updated by QualvoSec. """ 395 | logging.info(f'Info: Validating for specific packages to exclude from being updated on system {system_fqdn}.') 396 | packages = qualvosec_manifest[system_fqdn].get('packages_blacklist', False) 397 | 398 | # Check if (a) specific package(s) are defined. 399 | if packages: 400 | logging.info(f'Info: System {system_fqdn} will not upgrade the the following packages: {" ".join(packages)}') 401 | return " ".join(packages) 402 | else: 403 | logging.info(f'Info: No packages found to exclude from being upgraded.') 404 | return False 405 | 406 | 407 | def _execute_reboot_system(system_fqdn): 408 | """ Reboot the system after security patching by QualvoSec. """ 409 | process = subprocess.Popen(['sudo', 'reboot'], stderr=subprocess.PIPE, stdout=subprocess.PIPE) 410 | process_output, process_error = process.communicate() 411 | exit_code = process.wait() 412 | if exit_code != 0: 413 | logging.critical(f'Error The system {system_fqdn} could not be rebooted.') 414 | logging.critical(f'Log: {process_error}') 415 | sys.exit(2) 416 | else: 417 | logging.critical(f'Info: The system {system_fqdn} will be rebooted now.') 418 | logging.info(f'Log: {process_output}') 419 | 420 | 421 | def _execute_package_blacklisting(system_os_pkg_mgmr, system_fqdn, system_packages_blacklist): 422 | """ Block packages from being upgraded in a distro specific way. """ 423 | if system_os_pkg_mgmr == '/bin/apt': 424 | logging.info(f'Info: Using Debian specific way to hold packages back from being updated on system {system_fqdn}.') 425 | process = subprocess.Popen(['sudo', 'apt-mark', 'hold', system_packages_blacklist], stderr=subprocess.PIPE, stdout=subprocess.PIPE) 426 | 427 | elif system_os_pkg_mgmr == '/bin/rpm': 428 | logging.info(f'Info: Using RedHat specific way to hold packages back from being updated on system {system_fqdn}.') 429 | process = subprocess.Popen(['sudo', 'yum', 'versionlock', 'add', system_packages_blacklist], stderr=subprocess.PIPE, stdout=subprocess.PIPE) 430 | 431 | elif system_os_pkg_mgmr == '/bin/pkg': 432 | logging.info(f'Info: Using FreeBSD specific way to hold packages back from being updated on system {system_fqdn}.') 433 | process = subprocess.Popen(['sudo', 'pkg', 'lock', system_packages_blacklist], stderr=subprocess.PIPE, stdout=subprocess.PIPE) 434 | 435 | process_output, process_error = process.communicate() 436 | exit_code = process.wait() 437 | 438 | if exit_code != 0: 439 | logging.critical(f'Error: System {system_fqdn} could not hold back the following packages from being update: {system_packages_blacklist}') 440 | logging.critical(f'Log: {process_error}') 441 | sys.exit(2) 442 | else: 443 | logging.critical(f'Info: System {system_fqdn} holds back the following packages from being update: {system_packages_blacklist}') 444 | logging.info(f'Log: {process_output}') 445 | 446 | 447 | 448 | def patch_system(system_fqdn, qualvosec_manifest): 449 | """ Run the basic patch routine to integrate security fixes by QualvoSec. """ 450 | # Validate that the system is present in the manifest. 451 | if not qualvosec_manifest.get(system_fqdn): 452 | logging.critical(f'Error: The system {system_fqdn} could not be found in the QualvoSec manifest.') 453 | sys.exit(2) 454 | 455 | # Validate that the system should be patched. 456 | if not qualvosec_manifest[system_fqdn].get('patch'): 457 | logging.warning(f'Warning: The system {system_fqdn} is not activated for security patching.') 458 | sys.exit(1) 459 | 460 | # Compare time slots for a matching time window. 461 | qualvosec_times = {} 462 | weekday_now, hour_now, minute_now = _get_time_information_now() 463 | weekday_patch, hour_patch, minute_patch = _get_time_information_patch(system_fqdn, qualvosec_manifest) 464 | 465 | qualvosec_times[weekday_now] = weekday_patch 466 | qualvosec_times[hour_now] = hour_patch 467 | qualvosec_times[minute_now] = minute_patch 468 | 469 | # Check for patch window. 470 | execute_patching = _validate_systems_patch_window(qualvosec_times, system_fqdn) 471 | logging.info(f'Info: The system {system_fqdn} is in state execute_patching: {execute_patching}') 472 | 473 | # Check for specific packages to upgrade or to exclude from being upgraded. 474 | system_packages_whitelist = _get_system_packages_whitelist(system_fqdn, qualvosec_manifest) 475 | system_packages_blacklist = _get_system_packages_blacklist(system_fqdn, qualvosec_manifest) 476 | 477 | # Execute patching. 478 | if execute_patching: 479 | system_os_pkg_mgmr = _get_system_os_pkg_mgr(system_fqdn) 480 | _execute_patch_system(system_os_pkg_mgmr, system_fqdn, system_packages_whitelist, system_packages_blacklist) 481 | system_reboot_state = _validate_system_reboot(system_fqdn, qualvosec_manifest) 482 | if system_reboot_state: 483 | _execute_reboot_system(system_fqdn) 484 | 485 | 486 | def main(): 487 | """ Run QualvoSec - A minimalistic security patch management tool. """ 488 | qualvosec_manifest_path = None 489 | global monitoring_port 490 | global monitoring_listener 491 | app_args = initialize_args() 492 | config_path = initialize_config_path(app_args) 493 | server, log_level, log_handler, monitoring, monitoring_port, monitoring_listener = initialize_config_options(config_path) 494 | initialize_logger(log_level, log_handler) 495 | if monitoring: 496 | threading.Thread(target=initialize_monitoring, name="monitoring").start() 497 | 498 | while True: 499 | system_fqdn = get_system_fqdn() 500 | qualvosec_manifest_path = fetch_qualvosec_manifest(server, qualvosec_manifest_path, system_fqdn) 501 | qualvosec_manifest = read_qualvosec_manifest(qualvosec_manifest_path[0]) 502 | patch_system(system_fqdn, qualvosec_manifest) 503 | # Recheck after 50 seconds 504 | time.sleep(float(50)) 505 | 506 | 507 | if __name__ == '__main__': 508 | main() 509 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------