ci: typo depth

.gitea/workflows/cd.yaml

@@ -0,0 +1,20 @@
+name: Continuous Delivery
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+
+jobs:
+  build_n_upload:
+    runs-on: self-hosted
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - run: make tarball
+      - run: rpmbuild -ba "$(make name).spec"
+      - run: make upload
+        env:
+          PKG_TOKEN: ${{ secrets.PKG_TOKEN }}

.gitea/workflows/ci.yaml

@@ -0,0 +1,18 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  lint_n_build:
+    runs-on: self-hosted
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+      - run: shellcheck files/sbin/certbot_renew
+      - run: make tarball
+      - run: rpmbuild -ba "$(make name).spec"

.gitignore

@@ -1,2 +1,3 @@
 *.swp
 *.env
+/.idea

Makefile

@@ -1,12 +1,21 @@
-NAME = $(shell basename $(PWD))
-VERSION = $(shell git describe | sed 's/-/./g')
-BRANCH = $(shell git branch --show-current)
+NAME = netoik-rp
+VERSION = $(shell git describe --abbrev=0)
+RELEASE = $(shell git rev-parse --short HEAD)
+ARCH = noarch
+OWNER = samuel
+SUMMARY = "Netoïk Reverse Proxy"
+LICENSE = "MIT"
+URL = "https://git.netoik.io/$(OWNER)/$(NAME)"
+SOURCE0 = "$(NAME)-$(VERSION)-$(RELEASE).tar.gz"
 
+RPM_RPMDIR = $(shell rpm --eval '%{_rpmdir}')
 RPM_SBINDIR = $(shell rpm --eval '%{_sbindir}')
 RPM_SOURCEDIR = $(shell rpm --eval '%{_sourcedir}')
 RPM_SYSCONFDIR = $(shell rpm --eval '%{_sysconfdir}')
 RPM_UNITDIR = $(shell rpm --eval '%{_unitdir}')
-RPM_TARBALL_PATH = $(RPM_SOURCEDIR)/$(NAME)-$(VERSION).tar.gz
+
+RPM_TARBALL_PATH = $(RPM_SOURCEDIR)/$(SOURCE0)
+RPM_BUILD_PATH = $(RPM_RPMDIR)/$(BUILD_ARCH)/$(NAME)-$(VERSION)-$(RELEASE).$(ARCH).rpm
 
 .PHONY: name
 name:
@@ -16,19 +25,52 @@ name:
 version:
 	@echo "$(VERSION)"
 
+.PHONY: release
+release:
+	@echo "$(RELEASE)"
+
+.PHONY: arch
+arch:
+	@echo "$(ARCH)"
+
+.PHONY: owner
+owner:
+	@echo "$(OWNER)"
+
+.PHONY: summary
+summary:
+	@echo "$(SUMMARY)"
+
+.PHONY: license
+license:
+	@echo "$(LICENSE)"
+
+.PHONY: url
+url:
+	@echo "$(URL)"
+
+.PHONY: source0
+source0:
+	@echo "$(SOURCE0)"
+
+.PHONY: install
+install:
+	install --directory $(DESTDIR)$(RPM_SYSCONFDIR)/nginx/conf.d $(DESTDIR)$(RPM_SYSCONFDIR)/certbot $(DESTDIR)$(RPM_UNITDIR) $(DESTDIR)$(RPM_SBINDIR)
+	install --target-directory=$(DESTDIR)$(RPM_SYSCONFDIR)/nginx/conf.d files/nginx/0_security.conf files/nginx/default.conf
+	install --mode=600 --target-directory=$(DESTDIR)$(RPM_SYSCONFDIR)/certbot files/certbot/ovh.ini
+	install --mode=644 --target-directory=$(DESTDIR)$(RPM_UNITDIR) files/systemd/certbot-renew.service files/systemd/certbot-renew.timer
+	install --mode=755 --target-directory=$(DESTDIR)$(RPM_SBINDIR) files/sbin/certbot_renew
+
 $(RPM_TARBALL_PATH): *
 	git archive --format=tar.gz \
 	            --output="$@" \
 	            --prefix="$(NAME)-$(VERSION)/" \
 	            --verbose \
-	            "$(BRANCH)"
+	            HEAD 
 
 .PHONY: tarball
 tarball: $(RPM_TARBALL_PATH)
 
-.PHONY: install
-install:
-	install --directory $(DESTDIR)$(RPM_SYSCONFDIR)/nginx/conf.d
-	install --target-directory=$(DESTDIR)$(RPM_SYSCONFDIR)/nginx/conf.d/ conf/security.conf
-	install --directory $(DESTDIR)$(RPM_SYSCONFDIR)/certbot
-	install --target-directory=$(DESTDIR)$(RPM_SYSCONFDIR)/certbot/ conf/ovh.ini.tpl
+.PHONY: upload
+upload:
+	curl --fail-with-body --upload-file "$(RPM_BUILD_PATH)" --user "$(OWNER):$(PKG_TOKEN)" https://git.netoik.io/api/packages/$(OWNER)/rpm/upload

README.md

@@ -1,3 +1,88 @@
-# netoik-rp
+# Netoïk reverse proxy ![badge](https://git.netoik.io/samuel/netoik-rp/actions/workflows/ci.yaml/badge.svg)
 
-Netoïk reverse proxy
+Build an RPM package which will install several tools.
+
+- `Nginx` with:
+    - ssl settings
+    - security headers
+    - default site configuration
+
+
+- `Certbot` certificates with:
+    - ovh configuration to renew certs
+    - a command tool certbot_renew
+    - a systemctl certbot renew timer
+
+
+# Development
+
+A `Makefile` is integrated to let you run some basic commands.
+
+- To display some information about the project
+  ```shell
+  make name
+  make version
+  make release
+  make build_arch
+  ```
+
+- To build a tarball:
+  ```shell
+  make tarball 
+  ```
+  
+- To build a rpm package:
+  ```shell
+  rpmbuild -ba netoik-rp.spec
+  ```
+  
+- To upload rpm package to Gitea repository
+(env vars `GIT_PACKAGES_USERNAME` and `GIT_PACKAGES_TOKEN` needed):
+  ```shell
+  make upload
+  ```
+
+
+# CI / CD
+
+Two workflows are set up.
+
+- Continuous Integration:
+  - triggered by each push on branch `main`
+  - runs shellcheck on script `certbot_renew`
+  - builds tarball and rpm package to test everything is OK
+
+
+- Continuous Delivery:
+  - triggered by each tag pushed
+  - builds tarball
+  - builds and uploads rpm package to `Gitea` repository
+
+
+# Deployment
+
+Some commands to deploy the RPM package on server
+
+- To add Gitea repo to your repo list:
+  ```shell
+  dnf config-manager --add-repo https://git.netoik.io/api/packages/samuel/rpm.repo
+  dnf repolist | grep gitea-samuel
+  ```
+  
+- To show available versions:
+  ```shell
+  dnf --showduplicates netoik-rp
+  ```
+  
+- To install or upgrade:
+  ```shell
+  dnf --nogpgcheck install netoik-rp
+  dnf --nogpgcheck upgrade netoik-rp
+  ```
+
+
+# Security Notes
+
+For security reasons, act runners does not have sudo privileges and so there is:
+- **no** Continuous Deployment because act runners cannot use `dnf`
+- **no** GPG signing because act runners cannot use `gpg`

conf/ovh.ini

@@ -1,6 +0,0 @@
-# OVH API credentials used by Certbot
-# Name referenced in OVH: rasp.netoik.io
-dns_ovh_endpoint = $DNS_OVH_ENDPOINT
-dns_ovh_application_key = $DNS_OVH_APPLICATION_KEY
-dns_ovh_application_secret = $DNS_OVH_APPLICATION_SECRET
-dns_ovh_consumer_key = $DNS_OVH_CONSUMER_KEY

conf/security.conf

@@ -1,11 +0,0 @@
-# Configure ssl module
-# See: https://nginx.org/en/docs/http/ngx_http_ssl_module.html 
-include                   /etc/letsencrypt/options-ssl-nginx.conf;
-ssl_certificate           /etc/letsencrypt/live/netoik.io/fullchain.pem;
-ssl_certificate_key       /etc/letsencrypt/live/netoik.io/privkey.pem;
-ssl_dhparam               /etc/letsencrypt/ssl-dhparams.pem;
-
-# Configure headers
-# See: https://nginx.org/en/docs/http/ngx_http_headers_module.html
-add_header Strict-Transport-Security "max-age=31536000; includeSubDomains; preload;" always;
-

files/certbot/ovh.ini

@@ -0,0 +1,9 @@
+# OVH API credentials used by Certbot
+# To generate a new token, go to: https://www.ovh.com/auth/api/createToken
+
+dns_ovh_endpoint = "$OVH_ENDPOINT"
+dns_ovh_application_name = "$OVH_APPLICATION_NAME"
+dns_ovh_application_description = "$OVH_APPLICATION_DESCRIPTION"
+dns_ovh_application_key = "$OVH_APPLICATION_KEY"
+dns_ovh_application_secret = "$OVH_APPLICATION_SECRET"
+dns_ovh_consumer_key = "$OVH_CONSUMER_KEY"

files/nginx/0_security.conf

@@ -0,0 +1,30 @@
+# Configure secure access with letsencrypt
+ssl_certificate              /etc/letsencrypt/live/netoik.io/fullchain.pem;
+ssl_certificate_key          /etc/letsencrypt/live/netoik.io/privkey.pem;
+ssl_dhparam                  /etc/letsencrypt/ssl-dhparams.pem;
+
+# Add some ssl settings from Mozilla
+# see: https://ssl-config.mozilla.org
+ssl_protocols                TLSv1.3;
+ssl_ecdh_curve               X25519:prime256v1:secp384r1;
+ssl_prefer_server_ciphers    off;
+ssl_stapling                 on;
+ssl_stapling_verify          on;
+resolver                     127.0.0.1;
+
+# Add some basic security headers from OWASP
+# see: https://cheatsheetseries.owasp.org/cheatsheets/HTTP_Headers_Cheat_Sheet.html
+# And Nextcloud doc
+# see: https://docs.nextcloud.com/server/31/admin_manual/installation/harden_server.html
+add_header                   Strict-Transport-Security            "max-age=63072000; includeSubDomains; preload;"                                      always;
+add_header                   X-Frame-Options                      "sameorigin"                                                                         always;
+add_header                   X-XSS-Protection                     "1;mode=block"                                                                       always;
+add_header                   X-Content-Type-Options               "nosniff"                                                                            always;
+add_header                   X-Permitted-Cross-Domain-Policies    "none"                                                                               always;
+add_header                   Referrer-Policy                      "strict-origin-when-cross-origin"                                                    always;
+add_header                   Content-Security-Policy              "default-src 'self' 'unsafe-inline'; frame-ancestors 'self'; form-action 'self';"    always;
+add_header                   Cross-Origin-Opener-Policy           "same-origin"                                                                        always;
+add_header                   Cross-Origin-Resource-Policy         "same-site"                                                                          always;
+add_header                   Permissions-Policy                   "geolocation=(), camera=(), microphone=()"                                           always;
+add_header                   Server                               "webserver"                                                                          always;
+add_header                   X-Robots-Tag                         "noindex, nofollow"                                                                  always;

files/nginx/default.conf

@@ -0,0 +1,13 @@
+server {
+	listen 443 default_server;
+	server_name _;
+
+	return 404;
+}
+
+server {
+	listen 80 default_server;
+	server_name _;
+
+	return 301 https://$host$request_uri;    
+}

files/sbin/certbot_renew

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+sleep $((RANDOM % 3600));
+/opt/certbot/bin/pip install --upgrade certbot certbot-nginx certbot-dns-ovh
+certbot renew --cert-name netoik.io

files/systemd/certbot-renew.service

@@ -0,0 +1,5 @@
+[Unit]
+Description=Renew certbot certificates
+
+[Service]
+ExecStart=certbot_renew

files/systemd/certbot-renew.timer

@@ -0,0 +1,8 @@
+[Unit]
+Description=Daily renew certbot certificates
+
+[Timer]
+OnCalendar=Daily
+
+[Install]
+WantedBy=multi-user.target

netoik-rp.spec

@@ -2,15 +2,15 @@
 
 Name:           %(make name)
 Version:        %(make version)
-Release:        1%{?dist}
-Summary:        Netoik Reverse Proxy
-License:        MIT
-URL:            https://git.netoik.io/samuel/netoik-rp
+Release:        %(make release)
+Summary:        %(make summary)
+License:        %(make license)
+URL:            %(make url)
 
-Source0:        %{name}-%{version}.tar.gz
-Buildarch:      noarch
+Source0:        %(make source0)
+Buildarch:      %(make arch)
 BuildRequires:  make
-Requires:       nginx,python3,python-devel,augeas-devel,gcc
+Requires:       nginx python3 python-devel (augeas-devel or augeas-libs) gcc openssl
 
 %description
 Install the reverse proxy called nginx with a predefined configuration and with TLS certificates attached to netoik.io
@@ -22,39 +22,59 @@ Install the reverse proxy called nginx with a predefined configuration and with
 %make_install
 
 %post
-# On install
-if [ $1 == 1 ]; then
 # Replace secrets in ovh.ini
-  %{_bindir}/env envsubst < %{_sysconfdir}/certbot/ovh.ini.tpl > %{_sysconfdir}/certbot/ovh.ini
-  %{_bindir}/env chmod 600 %{_sysconfdir}/certbot/ovh.ini
-
-  # Create virutal env with certbot cli
-  %{_bindir}/env python3 -m venv /opt/certbot
-  /opt/certbot/bin/pip install --upgrade pip certbot certbot-dns-ovh
-	%{_bindir}/env ln --symbolic --force --target-directory %{_sbindir} /opt/certbot/bin/certbot
-  %{_bindir}/env certbot certonly --non-interactive	--agree-tos --email samuel.campos@netoik.io --dns-ovh --dns-ovh-credentials "%{_sysconfdir}/certbot/ovh.ini" -d "*.netoik.io" -d "*.samuel-campos.fr"
-  %{_bindir}/env printf "\nAutomatic certbot renew\n0 12 * * * root sleep $((RANDOM % 3600)) && certbot renew -q\n" >> %{_sysconfdir}/crontab
-
-  # Stop nginx to be sure changes are taken in account
-  %{_bindir}/env systemctl stop nginx
+envsubst < %{_sysconfdir}/certbot/ovh.ini > %{_sysconfdir}/certbot/.ovh.ini.new
+if cmp --silent %{_sysconfdir}/certbot/.ovh.ini.new %{_sysconfdir}/certbot/ovh.ini; then
+	rm %{_sysconfdir}/certbot/.ovh.ini.new
+else
+	mv %{_sysconfdir}/certbot/.ovh.ini.new %{_sysconfdir}/certbot/ovh.ini
+	chmod 600 %{_sysconfdir}/certbot/ovh.ini
 fi
-%{_bindir}/env systemctl enable nginx
-%{_bindir}/env systemctl start nginx
+
+# Create virtualenv with certot
+if [ ! -d "/opt/certbot" ]; then
+	python3 -m venv /opt/certbot
+	/opt/certbot/bin/pip install --upgrade pip certbot certbot-nginx certbot-dns-ovh
+	ln --symbolic --force --target-directory %{_sbindir} /opt/certbot/bin/certbot
+fi
+
+# Create certbot certificates
+if ! certbot certificates --cert-name netoik.io | grep --quiet netoik.io; then
+	certbot certonly --cert-name netoik.io --non-interactive --agree-tos --email samuel.campos@netoik.io --dns-ovh --dns-ovh-credentials %{_sysconfdir}/certbot/ovh.ini -d *.netoik.io -d *.samuel-campos.fr
+fi
+
+# Create ssl dh params if not already exists
+if [ ! -f "%{_sysconfdir}/letsencrypt/ssl-dhparams.pem" ]; then
+	openssl dhparam -out %{_sysconfdir}/letsencrypt/ssl-dhparams.pem 2048
+fi
+
+# Restart services
+systemctl daemon-reload
+systemctl reenable --now nginx.service certbot-renew.timer
 
 %postun
-# On uninstall
+# Remove folders after uninstall
 if [ $1 == 0 ]; then
-  %{_bindir}/env rm --recursive --force /opt/certbot
-  %{_bindir}/env rm --recursive --force %{_sysconfdir}/certbot
+  /opt/certbot/bin/certbot delete --cert-name netoik.io --non-interactive
+	rm --recursive --force /opt/certbot
+  rm --recursive --force %{_sysconfdir}/certbot
 fi
 
 %files
-%attr(644, root, root) %config %{_sysconfdir}/nginx/conf.d/security.conf
+%attr(644, root, root) %{_sysconfdir}/nginx/conf.d/0_security.conf
+%attr(644, root, root) %{_sysconfdir}/nginx/conf.d/default.conf
+
 %attr(755, root, root) %dir %{_sysconfdir}/certbot
-%attr(600, root, root) %config %ghost %{_sysconfdir}/certbot/ovh.ini
-%attr(644, root, root) %{_sysconfdir}/certbot/ovh.ini.tpl
-%attr(755, root, root) %dir %ghost /opt/certbot
-%attr(755, root, root) %{_sbindir}/certbot
+%attr(600, root, root) %{_sysconfdir}/certbot/ovh.ini
+
+%attr(644, root, root) %{_unitdir}/certbot-renew.timer
+%attr(644, root, root) %{_unitdir}/certbot-renew.service
+
+%attr(755, root, root) %{_sbindir}/certbot_renew
+
+%ghost %attr(755, root, root) %dir /opt/certbot
+%ghost %attr(755, root, root) %{_sbindir}/certbot
+%ghost %attr(644, root, root) %{_sysconfdir}/letsencrypt/ssl-dhparams.pem
 
 %changelog
 %autochangelog

services/netoik-rp.service

@@ -1,14 +0,0 @@
-[Service]
-Type=forking
-PIDFile=/run/netoik-rp.pid
-ExecStartPre=/usr/bin/env rm -f /run/netoik-rp.pid
-ExecStartPre=/usr/bin/env nginx -t -c /etc/netoik-rp/netoik-rp.conf
-ExecStart=/usr/bin/env nginx -c /etc/netoik-rp/netoik-rp.conf
-ExecReload=/usr/bin/env nginx -s reload -c /etc/netoik-rp/netoik-rp.conf
-KillSignal=SIGQUIT
-TimeoutStopSec=5
-KillMode=mixed
-PrivateTmp=true
-
-[Install]
-WantedBy=multi-user.target