diff --git a/Gemfile.lock b/Gemfile.lock index 4df45b1..39dd49e 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -2,7 +2,7 @@ GEM remote: https://rubygems.org/ specs: bcrypt_pbkdf (1.1.0) - bigdecimal (3.1.7) + bigdecimal (3.1.8) builder (3.2.4) chef-utils (18.4.12) concurrent-ruby @@ -40,14 +40,15 @@ GEM multi_json (1.15.0) net-scp (4.0.0) net-ssh (>= 2.6.5, < 8.0.0) - net-ssh (7.2.1) + net-ssh (7.2.3) net-ssh-gateway (2.0.0) net-ssh (>= 4.0.0) nori (2.7.0) bigdecimal pastel (0.8.0) tty-color (~> 0.5) - rexml (3.2.6) + rexml (3.2.8) + strscan (>= 3.0.9) rubyntlm (0.6.3) rubyzip (2.3.2) strings (0.2.1) @@ -55,6 +56,7 @@ GEM unicode-display_width (>= 1.5, < 3.0) unicode_utils (~> 1.4) strings-ansi (0.2.0) + strscan (3.1.0) test-kitchen (3.6.0) bcrypt_pbkdf (~> 1.0) chef-utils (>= 16.4.35) diff --git a/docs/backup.md b/docs/backup.md index c66a6ce..0165ef6 100644 --- a/docs/backup.md +++ b/docs/backup.md @@ -254,7 +254,10 @@ borg list beta-backup:/chemin | less # mensuelle des 6 derniers mois. # `-n` pour simuler la suppression et voir les sauvegardes qui vont être # supprimées. -borg prune --keep-within 3m -m 6 --list --stats -n beta-backup:/chemin +borg prune --keep-within 3m -m 6 --list --stats --progress -n beta-backup:/chemin +# Enlever l'éventuel --append-only dans .ssh/authorized_keys +borg compact --progress beta-backup:/chemin # pour vraiment libérer l'espace +# Remettre l'éventuel --append-only dans .ssh/authorized_keys ``` diff --git a/docs/install.md b/docs/install.md index 744c5c2..58572d7 100644 --- a/docs/install.md +++ b/docs/install.md @@ -2,14 +2,14 @@ ## Version simple, rapide et efficace -```shell +```sh make install source venv/bin/activate ``` ## Version détaillée -```shell +```sh # Création de l'environnement virtuel python3 -m venv venv # Activation de l'environnement @@ -24,16 +24,32 @@ pre-commit install ``` -## Pour exécuter localement kitchen +## Ruby -Pour exécuter localement ce qui est exécuté par GitHub Actions: -```shell +Surtout utile pour lancer localement ce qui est exécuté par GitHub Actions. + + +### Installation + +```sh sudo apt install bundler bundle config set --local path 'vendor/bundle' bundle install ``` + +### Exécuter localement kitchen + Pour lancer les tests: -```shell +```sh LANG=C.UTF-8 bundle exec kitchen test ``` +Il y a un bug qui fait échouer les tests si la langue du système n'est pas l'anglais, d'où la variable d'environnement `LANG`. + + +### Mettre à jour les dépendances + +```sh +bundle update +``` +Cela modifie le fichier `Gemfile.lock`, qu'il faut committer. diff --git a/group_vars/all/vars.yml b/group_vars/all/vars.yml index a67e6ee..15d028c 100644 --- a/group_vars/all/vars.yml +++ b/group_vars/all/vars.yml @@ -9,3 +9,7 @@ zmarkdown_dir: "{{ appdir }}/zmd" zds_antispam_dir: /opt/zds-antispam logdir: /var/log/zds appuser: zds +latex_template_version: c285c1c1a60807b732472b036ecb204ac2cb48f3 +pass_manager_user: vaultwarden +pass_manager_dir: /opt/vaultwarden +pass_manager_port: 8081 diff --git a/group_vars/production/vars.yml b/group_vars/production/vars.yml index 1f31a63..805de8f 100644 --- a/group_vars/production/vars.yml +++ b/group_vars/production/vars.yml @@ -10,3 +10,7 @@ certificate: munin_certificate: cert: /etc/letsencrypt/live/munin.zestedesavoir.com/fullchain.pem key: /etc/letsencrypt/live/munin.zestedesavoir.com/privkey.pem +pass_manager_host: "vault-ro.{{ http_host }}" +pass_manager_certificate: + cert: "/etc/letsencrypt/live/{{ pass_manager_host }}/fullchain.pem" + key: "/etc/letsencrypt/live/{{ pass_manager_host }}/privkey.pem" diff --git a/playbook.yml b/playbook.yml index 65a42bc..9ea7d3d 100644 --- a/playbook.yml +++ b/playbook.yml @@ -22,3 +22,6 @@ when: env == "beta" - role: munin tags: bootstrap + # - role: vaultwarden # not used in practice + # tags: bootstrap + # when: (env == "prod") or (env == "vagrant") diff --git a/roles/backup/files/prod/backups.sh b/roles/backup/files/prod/backups.sh index 8a86c2f..6b2d6c2 100644 --- a/roles/backup/files/prod/backups.sh +++ b/roles/backup/files/prod/backups.sh @@ -4,9 +4,10 @@ set -eu readonly BORG126=/usr/local/bin/borg1.2.6 readonly BORG1117=/usr/local/bin/borg -BACKUP_DATE=`date '+%Y%m%d-%H%M'` -DATA_SAVED_DIR=/opt/zds/data -DB_SAVED_DIR=/var/backups/mysql +readonly BORG_OPTIONS="--list --verbose --filter AME --show-rc --compression zstd,6 --exclude-caches --info" # --stats +readonly BACKUP_DATE=`date '+%Y%m%d-%H%M'` +readonly DATA_SAVED_DIR=/opt/zds/data +readonly DB_SAVED_DIR=/var/backups/mysql db_local_backup() { @@ -46,29 +47,22 @@ db_local_backup() backup2beta2023() { echo "Backup data to the 2023 beta server..." - $BORG126 create \ - --verbose \ - --filter AME \ - --list \ - --stats \ - --show-rc \ - --compression zstd,6 \ - --exclude-caches \ + date + $BORG126 create $BORG_OPTIONS \ beta-backup-2023:/opt/sauvegarde/data::$BACKUP_DATE \ $DATA_SAVED_DIR + rc_data=$? + date echo "Backup database to the 2023 beta server..." - $BORG126 create \ - --verbose \ - --filter AME \ - --list \ - --stats \ - --show-rc \ - --compression zstd,6 \ - --exclude-caches \ - --info \ + date + $BORG126 create $BORG_OPTIONS \ beta-backup-2023:/opt/sauvegarde/db::$BACKUP_DATE \ $DB_SAVED_DIR + rc_db=$? + date + + return $((rc_data+rc_db)) } @@ -132,3 +126,6 @@ fi echo "End of script ($(date))" # Big separator in log between executions of the script: echo "#######################################################################################################################" +echo +echo +echo diff --git a/roles/backup/templates/beta/cleaning.sh.j2 b/roles/backup/templates/beta/cleaning.sh.j2 index 4f958c1..a19a790 100644 --- a/roles/backup/templates/beta/cleaning.sh.j2 +++ b/roles/backup/templates/beta/cleaning.sh.j2 @@ -2,13 +2,16 @@ set -e -echo "Starting script ($(date))" readonly DATA_DB_RULES="--keep-within 30d -w 6 -m 3" readonly BORG_BINARY=/usr/local/bin/borg1.2.6 readonly BORG_PRUNE="$BORG_BINARY prune --list --stats" readonly BORG_COMPACT="$BORG_BINARY compact --verbose" + +echo "##########################################################################" +echo "Starting script ($(date))" + echo "** data ** ($(date))" sudo -u zds-prod $BORG_PRUNE $DATA_DB_RULES /opt/sauvegarde/data/ sudo -u zds-prod $BORG_COMPACT /opt/sauvegarde/data/ @@ -25,3 +28,7 @@ curl -s -m 10 --retry 5 {{ secrets.healthcheck_urls.backup_cleaning }} echo # to make a newline after the "OK" written by curl echo "End of script ($(date))" +echo "##########################################################################" +echo +echo +echo diff --git a/roles/latex/tasks/main.yml b/roles/latex/tasks/main.yml index 765f16c..f3423cb 100644 --- a/roles/latex/tasks/main.yml +++ b/roles/latex/tasks/main.yml @@ -21,12 +21,13 @@ tags: - bootstrap -- name: clone the template # noqa latest[git] +- name: clone the template become: true become_user: "{{ appuser }}" ansible.builtin.git: repo: https://github.com/zestedesavoir/latex-template/ dest: "{{ workdir }}/texmf/tex/generic/latex-template" + version: "{{ latex_template_version }}" notify: run texhash tags: - bootstrap diff --git a/roles/vaultwarden/tasks/main.yml b/roles/vaultwarden/tasks/main.yml new file mode 100644 index 0000000..79bb112 --- /dev/null +++ b/roles/vaultwarden/tasks/main.yml @@ -0,0 +1,37 @@ +--- +- name: should have a user named {{ pass_manager_user }} + ansible.builtin.user: + name: "{{ pass_manager_user }}" + shell: /bin/false + home: "{{ pass_manager_dir }}" + comment: Vaultwarden + +- name: create the needed directories + ansible.builtin.file: + path: "{{ item }}" + state: directory + owner: "{{ pass_manager_user }}" + group: "{{ pass_manager_user }}" + mode: "0750" + with_items: + - "{{ pass_manager_dir }}" + - "{{ pass_manager_dir }}/data" + +- name: create environment file + ansible.builtin.template: + src: templates/vaultwarden.env.j2 + dest: "{{ pass_manager_dir }}/vaultwarden.env" + mode: "0640" + +- name: create service file + ansible.builtin.template: + src: templates/vaultwarden.service.j2 + dest: /etc/systemd/system/vaultwarden.service + mode: u=rw,g=r,o=r + +- name: start service + ansible.builtin.systemd: + state: started + name: vaultwarden.service + enabled: true + daemon_reload: true diff --git a/roles/vaultwarden/templates/vaultwarden.env.j2 b/roles/vaultwarden/templates/vaultwarden.env.j2 new file mode 100644 index 0000000..61991f1 --- /dev/null +++ b/roles/vaultwarden/templates/vaultwarden.env.j2 @@ -0,0 +1,550 @@ +# The original file comes from the root of the sources of vaultwarden, the file +# is named .env.template + + +# shellcheck disable=SC2034,SC2148 +## Vaultwarden Configuration File +## Uncomment any of the following lines to change the defaults +## +## Be aware that most of these settings will be overridden if they were changed +## in the admin interface. Those overrides are stored within DATA_FOLDER/config.json . +## +## By default, Vaultwarden expects for this file to be named ".env" and located +## in the current working directory. If this is not the case, the environment +## variable ENV_FILE can be set to the location of this file prior to starting +## Vaultwarden. + +#################### +### Data folders ### +#################### + +## Main data folder +DATA_FOLDER={{ pass_manager_dir }}/data + +## Individual folders, these override %DATA_FOLDER% +# RSA_KEY_FILENAME=data/rsa_key +# ICON_CACHE_FOLDER=data/icon_cache +# ATTACHMENTS_FOLDER=data/attachments +# SENDS_FOLDER=data/sends +# TMP_FOLDER=data/tmp + +## Templates data folder, by default uses embedded templates +## Check source code to see the format +# TEMPLATES_FOLDER=data/templates +## Automatically reload the templates for every request, slow, use only for development +# RELOAD_TEMPLATES=false + +## Web vault settings +WEB_VAULT_FOLDER={{ pass_manager_dir }}/web-vault/ +# WEB_VAULT_ENABLED=true + +######################### +### Database settings ### +######################### + +## Database URL +## When using SQLite, this is the path to the DB file, default to %DATA_FOLDER%/db.sqlite3 +# DATABASE_URL=data/db.sqlite3 +## When using MySQL, specify an appropriate connection URI. +## Details: https://docs.diesel.rs/2.1.x/diesel/mysql/struct.MysqlConnection.html +# DATABASE_URL=mysql://user:password@host[:port]/database_name +## When using PostgreSQL, specify an appropriate connection URI (recommended) +## or keyword/value connection string. +## Details: +## - https://docs.diesel.rs/2.1.x/diesel/pg/struct.PgConnection.html +## - https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING +# DATABASE_URL=postgresql://user:password@host[:port]/database_name + +## Enable WAL for the DB +## Set to false to avoid enabling WAL during startup. +## Note that if the DB already has WAL enabled, you will also need to disable WAL in the DB, +## this setting only prevents Vaultwarden from automatically enabling it on start. +## Please read project wiki page about this setting first before changing the value as it can +## cause performance degradation or might render the service unable to start. +# ENABLE_DB_WAL=true + +## Database connection retries +## Number of times to retry the database connection during startup, with 1 second delay between each retry, set to 0 to retry indefinitely +# DB_CONNECTION_RETRIES=15 + +## Database timeout +## Timeout when acquiring database connection +# DATABASE_TIMEOUT=30 + +## Database max connections +## Define the size of the connection pool used for connecting to the database. +# DATABASE_MAX_CONNS=10 + +## Database connection initialization +## Allows SQL statements to be run whenever a new database connection is created. +## This is mainly useful for connection-scoped pragmas. +## If empty, a database-specific default is used: +## - SQLite: "PRAGMA busy_timeout = 5000; PRAGMA synchronous = NORMAL;" +## - MySQL: "" +## - PostgreSQL: "" +# DATABASE_CONN_INIT="" + +################# +### WebSocket ### +################# + +## Enable websocket notifications +# ENABLE_WEBSOCKET=true + +########################## +### Push notifications ### +########################## + +## Enables push notifications (requires key and id from https://bitwarden.com/host) +## If you choose "European Union" Data Region, uncomment PUSH_RELAY_URI and PUSH_IDENTITY_URI then replace .com by .eu +## Details about mobile client push notification: +## - https://github.com/dani-garcia/vaultwarden/wiki/Enabling-Mobile-Client-push-notification +# PUSH_ENABLED=false +# PUSH_INSTALLATION_ID=CHANGEME +# PUSH_INSTALLATION_KEY=CHANGEME +## Don't change this unless you know what you're doing. +# PUSH_RELAY_URI=https://push.bitwarden.com +# PUSH_IDENTITY_URI=https://identity.bitwarden.com + +##################### +### Schedule jobs ### +##################### + +## Job scheduler settings +## +## Job schedules use a cron-like syntax (as parsed by https://crates.io/crates/cron), +## and are always in terms of UTC time (regardless of your local time zone settings). +## +## The schedule format is a bit different from crontab as crontab does not contains seconds. +## You can test the the format here: https://crontab.guru, but remove the first digit! +## SEC MIN HOUR DAY OF MONTH MONTH DAY OF WEEK +## "0 30 9,12,15 1,15 May-Aug Mon,Wed,Fri" +## "0 30 * * * * " +## "0 30 1 * * * " +## +## How often (in ms) the job scheduler thread checks for jobs that need running. +## Set to 0 to globally disable scheduled jobs. +# JOB_POLL_INTERVAL_MS=30000 +## +## Cron schedule of the job that checks for Sends past their deletion date. +## Defaults to hourly (5 minutes after the hour). Set blank to disable this job. +# SEND_PURGE_SCHEDULE="0 5 * * * *" +## +## Cron schedule of the job that checks for trashed items to delete permanently. +## Defaults to daily (5 minutes after midnight). Set blank to disable this job. +# TRASH_PURGE_SCHEDULE="0 5 0 * * *" +## +## Cron schedule of the job that checks for incomplete 2FA logins. +## Defaults to once every minute. Set blank to disable this job. +# INCOMPLETE_2FA_SCHEDULE="30 * * * * *" +## +## Cron schedule of the job that sends expiration reminders to emergency access grantors. +## Defaults to hourly (3 minutes after the hour). Set blank to disable this job. +# EMERGENCY_NOTIFICATION_REMINDER_SCHEDULE="0 3 * * * *" +## +## Cron schedule of the job that grants emergency access requests that have met the required wait time. +## Defaults to hourly (7 minutes after the hour). Set blank to disable this job. +# EMERGENCY_REQUEST_TIMEOUT_SCHEDULE="0 7 * * * *" +## +## Cron schedule of the job that cleans old events from the event table. +## Defaults to daily. Set blank to disable this job. Also without EVENTS_DAYS_RETAIN set, this job will not start. +# EVENT_CLEANUP_SCHEDULE="0 10 0 * * *" +## Number of days to retain events stored in the database. +## If unset (the default), events are kept indefinitely and the scheduled job is disabled! +# EVENTS_DAYS_RETAIN= +## +## Cron schedule of the job that cleans old auth requests from the auth request. +## Defaults to every minute. Set blank to disable this job. +# AUTH_REQUEST_PURGE_SCHEDULE="30 * * * * *" + +######################## +### General settings ### +######################## + +## Domain settings +## The domain must match the address from where you access the server +## It's recommended to configure this value, otherwise certain functionality might not work, +## like attachment downloads, email links and U2F. +## For U2F to work, the server must use HTTPS, you can use Let's Encrypt for free certs +## To use HTTPS, the recommended way is to put Vaultwarden behind a reverse proxy +## Details: +## - https://github.com/dani-garcia/vaultwarden/wiki/Enabling-HTTPS +## - https://github.com/dani-garcia/vaultwarden/wiki/Proxy-examples +## For development +# DOMAIN=http://localhost +## For public server +# DOMAIN=https://vw.domain.tld +## For public server (URL with port number) +# DOMAIN=https://vw.domain.tld:8443 +## For public server (URL with path) +# DOMAIN=https://domain.tld/vw +{% if enable_https and pass_manager_certificate is defined %} +DOMAIN=https://{{ pass_manager_host }} +{% elif env == "vagrant" %} +DOMAIN=http://localhost/vault +{% endif %} + + +## Controls whether users are allowed to create Bitwarden Sends. +## This setting applies globally to all users. +## To control this on a per-org basis instead, use the "Disable Send" org policy. +SENDS_ALLOWED=false + +## HIBP Api Key +## HaveIBeenPwned API Key, request it here: https://haveibeenpwned.com/API/Key +# HIBP_API_KEY= + +## Per-organization attachment storage limit (KB) +## Max kilobytes of attachment storage allowed per organization. +## When this limit is reached, organization members will not be allowed to upload further attachments for ciphers owned by that organization. +# ORG_ATTACHMENT_LIMIT= +## Per-user attachment storage limit (KB) +## Max kilobytes of attachment storage allowed per user. +## When this limit is reached, the user will not be allowed to upload further attachments. +# USER_ATTACHMENT_LIMIT= +## Per-user send storage limit (KB) +## Max kilobytes of send storage allowed per user. +## When this limit is reached, the user will not be allowed to upload further sends. +# USER_SEND_LIMIT= + +## Number of days to wait before auto-deleting a trashed item. +## If unset (the default), trashed items are not auto-deleted. +## This setting applies globally, so make sure to inform all users of any changes to this setting. +# TRASH_AUTO_DELETE_DAYS= + +## Number of minutes to wait before a 2FA-enabled login is considered incomplete, +## resulting in an email notification. An incomplete 2FA login is one where the correct +## master password was provided but the required 2FA step was not completed, which +## potentially indicates a master password compromise. Set to 0 to disable this check. +## This setting applies globally to all users. +# INCOMPLETE_2FA_TIME_LIMIT=3 + +## Disable icon downloading +## Set to true to disable icon downloading in the internal icon service. +## This still serves existing icons from $ICON_CACHE_FOLDER, without generating any external +## network requests. $ICON_CACHE_TTL must also be set to 0; otherwise, the existing icons +## will be deleted eventually, but won't be downloaded again. +# DISABLE_ICON_DOWNLOAD=false + +## Controls if new users can register +SIGNUPS_ALLOWED=false + +## Controls if new users need to verify their email address upon registration +## Note that setting this option to true prevents logins until the email address has been verified! +## The welcome email will include a verification link, and login attempts will periodically +## trigger another verification email to be sent. +# SIGNUPS_VERIFY=false + +## If SIGNUPS_VERIFY is set to true, this limits how many seconds after the last time +## an email verification link has been sent another verification email will be sent +# SIGNUPS_VERIFY_RESEND_TIME=3600 + +## If SIGNUPS_VERIFY is set to true, this limits how many times an email verification +## email will be re-sent upon an attempted login. +# SIGNUPS_VERIFY_RESEND_LIMIT=6 + +## Controls if new users from a list of comma-separated domains can register +## even if SIGNUPS_ALLOWED is set to false +# SIGNUPS_DOMAINS_WHITELIST=example.com,example.net,example.org + +## Controls whether event logging is enabled for organizations +## This setting applies to organizations. +## Disabled by default. Also check the EVENT_CLEANUP_SCHEDULE and EVENTS_DAYS_RETAIN settings. +ORG_EVENTS_ENABLED=true + +## Controls which users can create new orgs. +## Blank or 'all' means all users can create orgs (this is the default): +# ORG_CREATION_USERS= +## 'none' means no users can create orgs: +# ORG_CREATION_USERS=none +## A comma-separated list means only those users can create orgs: +# ORG_CREATION_USERS=admin1@example.com,admin2@example.com + +## Invitations org admins to invite users, even when signups are disabled +# INVITATIONS_ALLOWED=true +## Name shown in the invitation emails that don't come from a specific organization +INVITATION_ORG_NAME=Vaultwarden de Zeste de Savoir + +## The number of hours after which an organization invite token, emergency access invite token, +## email verification token and deletion request token will expire (must be at least 1) +# INVITATION_EXPIRATION_HOURS=120 + +## Controls whether users can enable emergency access to their accounts. +## This setting applies globally to all users. +# EMERGENCY_ACCESS_ALLOWED=true + +## Controls whether users can change their email. +## This setting applies globally to all users +# EMAIL_CHANGE_ALLOWED=true + +## Number of server-side passwords hashing iterations for the password hash. +## The default for new users. If changed, it will be updated during login for existing users. +# PASSWORD_ITERATIONS=600000 + +## Controls whether users can set password hints. This setting applies globally to all users. +PASSWORD_HINTS_ALLOWED=false + +## Controls whether a password hint should be shown directly in the web page if +## SMTP service is not configured. Not recommended for publicly-accessible instances +## as this provides unauthenticated access to potentially sensitive data. +# SHOW_PASSWORD_HINT=false + +######################### +### Advanced settings ### +######################### + +## Client IP Header, used to identify the IP of the client, defaults to "X-Real-IP" +## Set to the string "none" (without quotes), to disable any headers and just use the remote IP +# IP_HEADER=X-Real-IP + +## Icon service +## The predefined icon services are: internal, bitwarden, duckduckgo, google. +## To specify a custom icon service, set a URL template with exactly one instance of `{}`, +## which is replaced with the domain. For example: `https://icon.example.com/domain/{}`. +## +## `internal` refers to Vaultwarden's built-in icon fetching implementation. +## If an external service is set, an icon request to Vaultwarden will return an HTTP +## redirect to the corresponding icon at the external service. An external service may +## be useful if your Vaultwarden instance has no external network connectivity, or if +## you are concerned that someone may probe your instance to try to detect whether icons +## for certain sites have been cached. +# ICON_SERVICE=internal + +## Icon redirect code +## The HTTP status code to use for redirects to an external icon service. +## The supported codes are 301 (legacy permanent), 302 (legacy temporary), 307 (temporary), and 308 (permanent). +## Temporary redirects are useful while testing different icon services, but once a service +## has been decided on, consider using permanent redirects for cacheability. The legacy codes +## are currently better supported by the Bitwarden clients. +# ICON_REDIRECT_CODE=302 + +## Cache time-to-live for successfully obtained icons, in seconds (0 is "forever") +## Default: 2592000 (30 days) +# ICON_CACHE_TTL=2592000 +## Cache time-to-live for icons which weren't available, in seconds (0 is "forever") +## Default: 2592000 (3 days) +# ICON_CACHE_NEGTTL=259200 + +## Icon download timeout +## Configure the timeout value when downloading the favicons. +## The default is 10 seconds, but this could be to low on slower network connections +# ICON_DOWNLOAD_TIMEOUT=10 + +## Icon blacklist Regex +## Any domains or IPs that match this regex won't be fetched by the icon service. +## Useful to hide other servers in the local network. Check the WIKI for more details +## NOTE: Always enclose this regex withing single quotes! +# ICON_BLACKLIST_REGEX='^(192\.168\.0\.[0-9]+|192\.168\.1\.[0-9]+)$' + +## Any IP which is not defined as a global IP will be blacklisted. +## Useful to secure your internal environment: See https://en.wikipedia.org/wiki/Reserved_IP_addresses for a list of IPs which it will block +# ICON_BLACKLIST_NON_GLOBAL_IPS=true + +## Client Settings +## Enable experimental feature flags for clients. +## This is a comma-separated list of flags, e.g. "flag1,flag2,flag3". +## +## The following flags are available: +## - "autofill-overlay": Add an overlay menu to form fields for quick access to credentials. +## - "autofill-v2": Use the new autofill implementation. +## - "browser-fileless-import": Directly import credentials from other providers without a file. +## - "fido2-vault-credentials": Enable the use of FIDO2 security keys as second factor. +# EXPERIMENTAL_CLIENT_FEATURE_FLAGS=fido2-vault-credentials + +## Require new device emails. When a user logs in an email is required to be sent. +## If sending the email fails the login attempt will fail!! +# REQUIRE_DEVICE_EMAIL=false + +## Enable extended logging, which shows timestamps and targets in the logs +# EXTENDED_LOGGING=true + +## Timestamp format used in extended logging. +## Format specifiers: https://docs.rs/chrono/latest/chrono/format/strftime +# LOG_TIMESTAMP_FORMAT="%Y-%m-%d %H:%M:%S.%3f" + +## Logging to Syslog +## This requires extended logging +# USE_SYSLOG=false + +## Logging to file +# LOG_FILE=/path/to/log + +## Log level +## Change the verbosity of the log output +## Valid values are "trace", "debug", "info", "warn", "error" and "off" +## Setting it to "trace" or "debug" would also show logs for mounted +## routes and static file, websocket and alive requests +# LOG_LEVEL=info + +## Token for the admin interface, preferably an Argon2 PCH string +## Vaultwarden has a built-in generator by calling `vaultwarden hash` +## For details see: https://github.com/dani-garcia/vaultwarden/wiki/Enabling-admin-page#secure-the-admin_token +## If not set, the admin panel is disabled +## New Argon2 PHC string +## Note that for some environments, like docker-compose you need to escape all the dollar signs `$` with an extra dollar sign like `$$` +## Also, use single quotes (') instead of double quotes (") to enclose the string when needed +# ADMIN_TOKEN='$argon2id$v=19$m=65540,t=3,p=4$MmeKRnGK5RW5mJS7h3TOL89GrpLPXJPAtTK8FTqj9HM$DqsstvoSAETl9YhnsXbf43WeaUwJC6JhViIvuPoig78' +## Old plain text string (Will generate warnings in favor of Argon2) +# ADMIN_TOKEN=Vy2VyYTTsKPv8W5aEOWUbB/Bt3DEKePbHmI4m9VcemUMS2rEviDowNAFqYi1xjmp + +## Enable this to bypass the admin panel security. This option is only +## meant to be used with the use of a separate auth layer in front +# DISABLE_ADMIN_TOKEN=false + +## Number of seconds, on average, between admin login requests from the same IP address before rate limiting kicks in. +# ADMIN_RATELIMIT_SECONDS=300 +## Allow a burst of requests of up to this size, while maintaining the average indicated by `ADMIN_RATELIMIT_SECONDS`. +# ADMIN_RATELIMIT_MAX_BURST=3 + +## Set the lifetime of admin sessions to this value (in minutes). +# ADMIN_SESSION_LIFETIME=20 + +## Allowed iframe ancestors (Know the risks!) +## https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors +## Allows other domains to embed the web vault into an iframe, useful for embedding into secure intranets +## This adds the configured value to the 'Content-Security-Policy' headers 'frame-ancestors' value. +## Multiple values must be separated with a whitespace. +# ALLOWED_IFRAME_ANCESTORS= + +## Number of seconds, on average, between login requests from the same IP address before rate limiting kicks in. +# LOGIN_RATELIMIT_SECONDS=60 +## Allow a burst of requests of up to this size, while maintaining the average indicated by `LOGIN_RATELIMIT_SECONDS`. +## Note that this applies to both the login and the 2FA, so it's recommended to allow a burst size of at least 2. +# LOGIN_RATELIMIT_MAX_BURST=10 + +## BETA FEATURE: Groups +## Controls whether group support is enabled for organizations +## This setting applies to organizations. +## Disabled by default because this is a beta feature, it contains known issues! +## KNOW WHAT YOU ARE DOING! +ORG_GROUPS_ENABLED=true + +######################## +### MFA/2FA settings ### +######################## + +## Yubico (Yubikey) Settings +## Set your Client ID and Secret Key for Yubikey OTP +## You can generate it here: https://upgrade.yubico.com/getapikey/ +## You can optionally specify a custom OTP server +# YUBICO_CLIENT_ID=11111 +# YUBICO_SECRET_KEY=AAAAAAAAAAAAAAAAAAAAAAAA +# YUBICO_SERVER=http://yourdomain.com/wsapi/2.0/verify + +## Duo Settings +## You need to configure all options to enable global Duo support, otherwise users would need to configure it themselves +## Create an account and protect an application as mentioned in this link (only the first step, not the rest): +## https://help.bitwarden.com/article/setup-two-step-login-duo/#create-a-duo-security-account +## Then set the following options, based on the values obtained from the last step: +# DUO_IKEY= +# DUO_SKEY= +# DUO_HOST= +## After that, you should be able to follow the rest of the guide linked above, +## ignoring the fields that ask for the values that you already configured beforehand. + +## Email 2FA settings +## Email token size +## Number of digits in an email 2FA token (min: 6, max: 255). +## Note that the Bitwarden clients are hardcoded to mention 6 digit codes regardless of this setting! +# EMAIL_TOKEN_SIZE=6 +## +## Token expiration time +## Maximum time in seconds a token is valid. The time the user has to open email client and copy token. +# EMAIL_EXPIRATION_TIME=600 +## +## Maximum attempts before an email token is reset and a new email will need to be sent. +# EMAIL_ATTEMPTS_LIMIT=3 +## +## Setup email 2FA regardless of any organization policy +# EMAIL_2FA_ENFORCE_ON_VERIFIED_INVITE=false +## Automatically setup email 2FA as fallback provider when needed +# EMAIL_2FA_AUTO_FALLBACK=false + +## Other MFA/2FA settings +## Disable 2FA remember +## Enabling this would force the users to use a second factor to login every time. +## Note that the checkbox would still be present, but ignored. +# DISABLE_2FA_REMEMBER=false +## +## Authenticator Settings +## Disable authenticator time drifted codes to be valid. +## TOTP codes of the previous and next 30 seconds will be invalid +## +## According to the RFC6238 (https://tools.ietf.org/html/rfc6238), +## we allow by default the TOTP code which was valid one step back and one in the future. +## This can however allow attackers to be a bit more lucky with there attempts because there are 3 valid codes. +## You can disable this, so that only the current TOTP Code is allowed. +## Keep in mind that when a sever drifts out of time, valid codes could be marked as invalid. +## In any case, if a code has been used it can not be used again, also codes which predates it will be invalid. +# AUTHENTICATOR_DISABLE_TIME_DRIFT=false + +########################### +### SMTP Email settings ### +########################### + +## Mail specific settings, set SMTP_FROM and either SMTP_HOST or USE_SENDMAIL to enable the mail service. +## To make sure the email links are pointing to the correct host, set the DOMAIN variable. +## Note: if SMTP_USERNAME is specified, SMTP_PASSWORD is mandatory +# SMTP_HOST=smtp.domain.tld +# SMTP_FROM=vaultwarden@domain.tld +# SMTP_FROM_NAME=Vaultwarden +# SMTP_USERNAME=username +# SMTP_PASSWORD=password +# SMTP_TIMEOUT=15 + +## Choose the type of secure connection for SMTP. The default is "starttls". +## The available options are: +## - "starttls": The default port is 587. +## - "force_tls": The default port is 465. +## - "off": The default port is 25. +## Ports 587 (submission) and 25 (smtp) are standard without encryption and with encryption via STARTTLS (Explicit TLS). Port 465 (submissions) is used for encrypted submission (Implicit TLS). +# SMTP_SECURITY=starttls +# SMTP_PORT=587 + +# Whether to send mail via the `sendmail` command +# USE_SENDMAIL=false +# Which sendmail command to use. The one found in the $PATH is used if not specified. +# SENDMAIL_COMMAND="/path/to/sendmail" + +## Defaults for SSL is "Plain" and "Login" and nothing for Non-SSL connections. +## Possible values: ["Plain", "Login", "Xoauth2"]. +## Multiple options need to be separated by a comma ','. +# SMTP_AUTH_MECHANISM= + +## Server name sent during the SMTP HELO +## By default this value should be is on the machine's hostname, +## but might need to be changed in case it trips some anti-spam filters +# HELO_NAME= + +## Embed images as email attachments +# SMTP_EMBED_IMAGES=true + +## SMTP debugging +## When set to true this will output very detailed SMTP messages. +## WARNING: This could contain sensitive information like passwords and usernames! Only enable this during troubleshooting! +# SMTP_DEBUG=false + +## Accept Invalid Certificates +## DANGEROUS: This option introduces significant vulnerabilities to man-in-the-middle attacks! +## Only use this as a last resort if you are not able to use a valid certificate. +## If the Certificate is valid but the hostname doesn't match, please use SMTP_ACCEPT_INVALID_HOSTNAMES instead. +# SMTP_ACCEPT_INVALID_CERTS=false + +## Accept Invalid Hostnames +## DANGEROUS: This option introduces significant vulnerabilities to man-in-the-middle attacks! +## Only use this as a last resort if you are not able to use a valid certificate. +# SMTP_ACCEPT_INVALID_HOSTNAMES=false + +########################## +### Rocket settings ### +########################## + +## Rocket specific settings +## See https://rocket.rs/v0.5/guide/configuration/ for more details. +ROCKET_ADDRESS=127.0.0.1 +## The default port is 8000, unless running in a Docker container, in which case it is 80. +ROCKET_PORT={{ pass_manager_port }} +# ROCKET_TLS={certs="/path/to/certs.pem",key="/path/to/key.pem"} + + +# vim: syntax=dosini diff --git a/roles/vaultwarden/templates/vaultwarden.service.j2 b/roles/vaultwarden/templates/vaultwarden.service.j2 new file mode 100644 index 0000000..6defbb3 --- /dev/null +++ b/roles/vaultwarden/templates/vaultwarden.service.j2 @@ -0,0 +1,25 @@ +# Adapted from https://github.com/dani-garcia/vaultwarden/wiki/Setup-as-a-systemd-service + +[Unit] +Description=Vaultwarden +Documentation=https://github.com/dani-garcia/vaultwarden + +After=network.target + +[Service] +User={{ pass_manager_user }} +Group={{ pass_manager_user }} +EnvironmentFile={{ pass_manager_dir }}/vaultwarden.env +ExecStart={{ pass_manager_dir }}/vaultwarden +LimitNOFILE=1048576 +LimitNPROC=64 +PrivateTmp=true +PrivateDevices=true +ProtectHome=true +ProtectSystem=strict +RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6 AF_LOCAL AF_NETLINK +WorkingDirectory={{ pass_manager_dir }}/data +ReadWritePaths={{ pass_manager_dir }}/data + +[Install] +WantedBy=multi-user.target diff --git a/roles/web/tasks/main.yml b/roles/web/tasks/main.yml index 8845352..3ea8238 100644 --- a/roles/web/tasks/main.yml +++ b/roles/web/tasks/main.yml @@ -93,6 +93,22 @@ notify: reload nginx when: env != "vagrant" +- name: generate vaultwarden config file + ansible.builtin.template: + src: nginx/sites-available/vaultwarden.j2 + dest: /etc/nginx/sites-available/vaultwarden + mode: u=rw,g=r,o=r + notify: reload nginx + when: env == "prod" + +- name: enable vaultwarden site + ansible.builtin.file: + src: /etc/nginx/sites-available/vaultwarden + dest: /etc/nginx/sites-enabled/vaultwarden + state: link + notify: reload nginx + when: env == "prod" + - name: generate logrotate config file ansible.builtin.template: src: logrotate/zds-nginx.j2 diff --git a/roles/web/templates/logrotate/zds-nginx.j2 b/roles/web/templates/logrotate/zds-nginx.j2 index f2e4abf..329a925 100644 --- a/roles/web/templates/logrotate/zds-nginx.j2 +++ b/roles/web/templates/logrotate/zds-nginx.j2 @@ -1,10 +1,12 @@ {{ logdir }}/nginx*.log { + # pas de suppression avant que maxage ne soit atteint + rotate -1 daily missingok maxage 365 compress notifempty - create 640 nginx adm + create 640 www-data adm delaycompress sharedscripts postrotate diff --git a/roles/web/templates/nginx/sites-available/vaultwarden.j2 b/roles/web/templates/nginx/sites-available/vaultwarden.j2 new file mode 100644 index 0000000..e1cd11d --- /dev/null +++ b/roles/web/templates/nginx/sites-available/vaultwarden.j2 @@ -0,0 +1,76 @@ +# Adapted from https://github.com/dani-garcia/vaultwarden/wiki/Proxy-examples + +# The `upstream` directives ensure that you have a http/1.1 connection +# This enables the keepalive option and better performance +# +# Define the server IP and ports here. +upstream vaultwarden-default { + zone vaultwarden-default 64k; + server 127.0.0.1:{{ pass_manager_port }}; + keepalive 2; +} + +# Needed to support websocket connections +# See: https://nginx.org/en/docs/http/websocket.html +# Instead of "close" as stated in the above link we send an empty value. +# Else all keepalive connections will not work. +map $http_upgrade $connection_upgrade { + default upgrade; + '' ""; +} + +# Redirect HTTP to HTTPS +server { + listen 80; + listen [::]:80; + + server_name {{ pass_manager_host }}; + + error_log {{ logdir }}/nginx-vaultwarden-https-redirect-error.log; + access_log {{ logdir }}/nginx-vaultwarden-https-redirect-access.log; + + root /var/www/html; + + server_tokens off; + + location ~ /.well-known { + allow all; + } + + location / { + return 301 https://$server_name$request_uri; + } +} + +server { + listen 443 ssl http2; + listen [::]:443 ssl http2; + + server_name vaultwarden.example.tld; + + server_tokens off; + +{% if enable_https and pass_manager_certificate is defined %} + ssl_certificate {{ pass_manager_certificate.cert }}; + ssl_certificate_key {{ pass_manager_certificate.key }}; + include snippets/ssl.conf; +{% endif %} + + error_log {{ logdir }}/nginx-vaultwarden-error.log; + access_log {{ logdir }}/nginx-vaultwarden-access.log; + + add_header X-Robots-Tag "none" always; + + location / { + proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection $connection_upgrade; + + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + + proxy_pass http://vaultwarden-default; + } +} diff --git a/roles/web/templates/nginx/sites-available/zestedesavoir.j2 b/roles/web/templates/nginx/sites-available/zestedesavoir.j2 index 526fc84..236a619 100644 --- a/roles/web/templates/nginx/sites-available/zestedesavoir.j2 +++ b/roles/web/templates/nginx/sites-available/zestedesavoir.j2 @@ -10,6 +10,14 @@ map $http_user_agent $loggable { default 1; } +{% if env == "vagrant" %} +upstream vaultwarden-default { + zone vaultwarden-default 64k; + server 127.0.0.1:{{ pass_manager_port }}; + keepalive 2; +} +{% endif %} + server { listen 80 default_server; listen [::]:80 default_server; @@ -54,7 +62,7 @@ server { log_not_found off; } - # On Vagrant installations, 127.0.0.1 is already use to serve the website, so + # On Vagrant installations, 127.0.0.1 is already used to serve the website, so # we put here the /nginx_status end-point, instead of creating a 127.0.0.1 vhost. location /nginx_status { stub_status on; @@ -63,6 +71,17 @@ server { allow ::1; deny all; } + + # Serve also Vaultwarden in subfolder + location /vault/ { + proxy_http_version 1.1; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + + proxy_pass http://vaultwarden-default; + } {% endif %} root {{ webroot }};