Git-Mirrors/qusal
1
0
Fork 0
mirror of https://github.com/ben-grande/qusal.git synced 2024-10-01 02:35:49 -04:00
Code Issues Packages Projects Releases Wiki Activity

refactor: distinct whonix formulas

Browse Source 
Separating the Gateway and the Workstation formula makes it easier to
use the clone-template macro as well as only run the necessary states.
This commit is contained in:
Ben Grande 2024-02-07 11:27:36 +01:00
parent f27db69e3a
commit 7331b1938e
29 changed files with 385 additions and 241 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
salt/whonix-gateway/README.md Normal file
View File

@ -0,0 +1,37 @@
# whonix-gateway
Whonix Gateway Template in Qubes OS.
## Table of Contents
* [Description](#description)
* [Installation](#installation)
* [Usage](#usage)
## Description
Creates the Whonix Gateway templates as well as a Disposable Template based on
it.
## Installation
- Top:
```sh
qubesctl top.enable whonix-gateway
qubesctl --targets=whonix-gateway-17 state.apply
qubesctl top.disable whonix-gateway
qubesctl state.apply whonix-gateway.appmenus
```
- State:
<!-- pkg:begin:post-install -->
```sh
qubesctl state.apply whonix-gateway.create
qubesctl --skip-dom0 --targets=whonix-gateway-17 state.apply whonix-gateway.install
qubesctl state.apply whonix-gateway.appmenus
```
<!-- pkg:end:post-install -->
## Usage
AppVMs and StandaloneVMs can be based on this template.

2
salt/whonix/appmenus.sls → salt/whonix-gateway/appmenus.sls
View File

@ -7,4 +7,4 @@ SPDX-License-Identifier: AGPL-3.0-or-later
{%- import slsdotpath ~ "/template.jinja" as template -%}
{% from 'utils/macros/sync-appmenus.sls' import sync_appmenus -%}
{{ sync_appmenus('dvm-' ~ template.whonix_workstation_clean_template) }}
{{ sync_appmenus('sys-whonix') }}

10
salt/whonix-gateway/appmenus.top Normal file
View File

@ -0,0 +1,10 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
base:
'dom0':
- match: nodegroup
- whonix-gateway.appmenus

12
salt/whonix-gateway/clone.sls Normal file
View File

@ -0,0 +1,12 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
{%- import slsdotpath ~ "/template.jinja" as template -%}
"{{ template.template }}-installed":
qvm.template_installed:
- name: {{ template.template }}
- fromrepo: {{ template.repo }}

2
salt/whonix/appmenus.top → salt/whonix-gateway/clone.top
View File

@ -7,4 +7,4 @@ SPDX-License-Identifier: AGPL-3.0-or-later
base:
'dom0':
- match: nodegroup
- whonix.appmenus
- whonix-gateway.clone

59
salt/whonix-gateway/create.sls Normal file
View File

@ -0,0 +1,59 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
{%- from "qvm/template.jinja" import load -%}
{%- import slsdotpath ~ "/template.jinja" as template -%}
include:
- .clone
{% load_yaml as defaults -%}
name: {{ template.template }}
force: True
require:
- sls: {{ slsdotpath }}.clone
prefs:
- audiovm: ""
- default_dispvm: ""
- vcpus: 1
- memory: 300
- maxmem: 600
- include_in_backups: False
features:
- enable:
- whonix-gw
tags:
- add:
- whonix-updatevm
{%- endload %}
{{ load(defaults) }}
{% load_yaml as defaults -%}
name: sys-whonix
force: True
require:
- sls: {{ slsdotpath }}.clone
- qvm: {{ template.template }}
present:
- template: {{ template.template }}
- label: black
prefs:
- template: {{ template.template }}
- label: black
- audiovm: ""
- default_dispvm: ""
- vcpus: 1
- memory: 300
- maxmem: 500
- provides-network: True
- include_in_backups: False
- autostart: False
tags:
- add:
- anon-gateway
{%- endload %}
{{ load(defaults) }}

10
salt/whonix-gateway/create.top Normal file
View File

@ -0,0 +1,10 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
base:
'dom0':
- match: nodegroup
- whonix-gateway.create

12
salt/whonix-gateway/init.top Normal file
View File

@ -0,0 +1,12 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
base:
'dom0':
- match: nodegroup
- whonix-gateway.create
'whonix-gateway-17':
- whonix-gateway.install

0
salt/whonix/install.sls → salt/whonix-gateway/install.sls
View File

10
salt/whonix-gateway/install.top Normal file
View File

@ -0,0 +1,10 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
base:
'whonix-gateway-17':
- match: list
- whonix-gateway.install

10
salt/whonix-gateway/template.jinja Normal file
View File

@ -0,0 +1,10 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
{% set version = salt['pillar.get']('qvm:whonix:version', '17') -%}
{% set repo = salt['pillar.get']('qvm:whonix:repo', 'qubes-templates-community') -%}
{% set template = 'whonix-gateway-' ~ version -%}
{% set clean_template = 'whonix-gateway' -%}

37
salt/whonix-workstation/README.md Normal file
View File

@ -0,0 +1,37 @@
# whonix-workstation
Whonix Workstation Template in Qubes OS.
## Table of Contents
* [Description](#description)
* [Installation](#installation)
* [Usage](#usage)
## Description
Creates the Whonix Workstation templates as well as a Disposable Template
based on it.
## Installation
- Top:
```sh
qubesctl top.enable whonix-workstation
qubesctl --targets=whonix-workstation-17 state.apply
qubesctl top.disable whonix-workstation
qubesctl state.apply whonix-workstation.appmenus
```
- State:
<!-- pkg:begin:post-install -->
```sh
qubesctl state.apply whonix-workstation.create
qubesctl --skip-dom0 --targets=whonix-workstation-17 state.apply whonix-workstation.install
qubesctl state.apply whonix-workstation.appmenus
```
<!-- pkg:end:post-install -->
## Usage
AppVMs and StandaloneVMs can be based on this template.

10
salt/whonix-workstation/appmenus.sls Normal file
View File

@ -0,0 +1,10 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
{%- import slsdotpath ~ "/template.jinja" as template -%}
{% from 'utils/macros/sync-appmenus.sls' import sync_appmenus -%}
{{ sync_appmenus('dvm-' ~ template.clean_template) }}

10
salt/whonix-workstation/appmenus.top Normal file
View File

@ -0,0 +1,10 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
base:
'dom0':
- match: nodegroup
- whonix-workstation.appmenus

12
salt/whonix-workstation/clone.sls Normal file
View File

@ -0,0 +1,12 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
{%- import slsdotpath ~ "/template.jinja" as template -%}
"{{ template.template }}-installed":
qvm.template_installed:
- name: {{ template.template }}
- fromrepo: {{ template.repo }}

10
salt/whonix-workstation/clone.top Normal file
View File

@ -0,0 +1,10 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
base:
'dom0':
- match: nodegroup
- whonix-workstation.clone

96
salt/whonix-workstation/create.sls Normal file
View File

@ -0,0 +1,96 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
{%- from "qvm/template.jinja" import load -%}
{%- import slsdotpath ~ "/template.jinja" as template -%}
include:
- .clone
- whonix-gateway.create
{% load_yaml as defaults -%}
name: {{ template.template }}
force: True
require:
- sls: {{ slsdotpath }}.clone
prefs:
- audiovm: ""
- vcpus: 1
- memory: 300
- maxmem: 1500
- include_in_backups: False
features:
- enable:
- whonix-ws
tags:
- add:
- whonix-updatevm
{%- endload %}
{{ load(defaults) }}
{% load_yaml as defaults -%}
name: dvm-{{ template.clean_template }}
force: True
require:
- sls: whonix-gateway.create
present:
- template: {{ template.template }}
- label: red
prefs:
- template: {{ template.template }}
- label: red
- netvm: sys-whonix
- audiovm: ""
- default_dispvm: dvm-{{ template.clean_template }}
- vcpus: 1
- memory: 300
- maxmem: 1500
- template_for_dispvms: True
- include_in_backups: False
- autostart: False
features:
- enable:
- appmenus-dispvm
tags:
- add:
- anon-vm
{%- endload %}
{{ load(defaults) }}
{% load_yaml as defaults -%}
name: anon-whonix
force: True
require:
- sls: {{ slsdotpath }}.clone
- sls: whonix-gateway.create
present:
- template: {{ template.template }}
- label: red
prefs:
- template: {{ template.template }}
- label: red
- netvm: sys-whonix
- audiovm: ""
- default_dispvm: dvm-{{ template.clean_template }}
- vcpus: 1
- memory: 300
- maxmem: 1500
- include_in_backups: False
- autostart: False
tags:
- add:
- anon-vm
{%- endload %}
{{ load(defaults) }}
"{{ template.template }}-default_dispvm":
qvm.vm:
- require:
- qvm: dvm-{{ template.clean_template }}
- name: {{ template.template }}
- prefs:
- default_dispvm: dvm-{{ template.clean_template }}

10
salt/whonix-workstation/create.top Normal file
View File

@ -0,0 +1,10 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
base:
'dom0':
- match: nodegroup
- whonix-workstation.create

12
salt/whonix-workstation/init.top Normal file
View File

@ -0,0 +1,12 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
base:
'dom0':
- match: nodegroup
- whonix-workstation.create
'whonix-workstation-17':
- whonix-workstation.install

11
salt/whonix/clone.top → salt/whonix-workstation/install.sls
View File

@ -4,7 +4,10 @@ SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
base:
'dom0':
- match: nodegroup
- whonix.clone
{% if grains['nodename'] != 'dom0' -%}
"{{ slsdotpath }}-updated":
pkg.uptodate:
- refresh: True
{% endif %}

9
salt/whonix-workstation/install.top Normal file
View File

@ -0,0 +1,9 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
base:
'whonix-workstation-17':
- whonix-workstation.install

10
salt/whonix-workstation/template.jinja Normal file
View File

@ -0,0 +1,10 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
{% set version = salt['pillar.get']('qvm:whonix:version', '17') -%}
{% set repo = salt['pillar.get']('qvm:whonix:repo', 'qubes-templates-community') -%}
{% set template = 'whonix-workstation-' ~ version -%}
{% set clean_template = 'whonix-workstation' -%}

37
salt/whonix/README.md
View File

@ -1,37 +0,0 @@
# whonix
Whonix Template in Qubes OS.
## Table of Contents
* [Description](#description)
* [Installation](#installation)
* [Usage](#usage)
## Description
Creates the Whonix Gateway and Workstation templates as well as a Disposable
Template based on it.
## Installation
- Top:
```sh
qubesctl top.enable whonix
qubesctl --targets=whonix-workstation-17,whonix-gateway-17 state.apply
qubesctl top.disable whonix
qubesctl state.apply whonix.appmenus
```
- State:
<!-- pkg:begin:post-install -->
```sh
qubesctl state.apply whonix.create
qubesctl --skip-dom0 --targets=whonix-workstation-17,whonix-gateway-17 state.apply whonix.install
qubesctl state.apply whonix.appmenus
```
<!-- pkg:end:post-install -->
## Usage
AppVMs and StandaloneVMs can be based on this template.

17
salt/whonix/clone.sls
View File

@ -1,17 +0,0 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
{%- import slsdotpath ~ "/template.jinja" as whonix -%}
"{{ whonix.whonix_gateway_template }}-installed":
qvm.template_installed:
- name: {{ whonix.whonix_gateway_template }}
- fromrepo: {{ whonix.whonix_repo }}
"{{ whonix.whonix_workstation_template }}-installed":
qvm.template_installed:
- name: {{ whonix.whonix_workstation_template }}
- fromrepo: {{ whonix.whonix_repo }}

136
salt/whonix/create.sls
View File

@ -1,136 +0,0 @@
{#
SPDX-FileCopyrightText: 2023 - 2024 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
{%- from "qvm/template.jinja" import load -%}
{%- import slsdotpath ~ "/template.jinja" as template -%}
include:
- .clone
{% load_yaml as defaults -%}
name: {{ template.whonix_workstation_template }}
force: True
require:
- sls: {{ slsdotpath }}.clone
prefs:
- audiovm: ""
- vcpus: 1
- memory: 300
- maxmem: 1500
- include_in_backups: False
tags:
- add:
- whonix-updatevm
features:
- enable:
- whonix-ws
{%- endload %}
{{ load(defaults) }}
{% load_yaml as defaults -%}
name: {{ template.whonix_gateway_template }}
force: True
require:
- sls: {{ slsdotpath }}.clone
prefs:
- audiovm: ""
- vcpus: 1
- memory: 300
- maxmem: 600
- include_in_backups: False
tags:
- add:
- whonix-updatevm
features:
- enable:
- whonix-gw
{%- endload %}
{{ load(defaults) }}
{% load_yaml as defaults -%}
name: dvm-{{ template.whonix_workstation_clean_template }}
force: True
require:
- qvm: sys-{{ slsdotpath }}
- qvm: anon-{{ slsdotpath }}
present:
- template: {{ template.whonix_workstation_template }}
- label: red
prefs:
- template: {{ template.whonix_workstation_template }}
- label: red
- netvm: sys-{{ slsdotpath }}
- audiovm: ""
- default_dispvm: dvm-{{ template.whonix_workstation_clean_template }}
- vcpus: 1
- memory: 300
- maxmem: 1500
- template_for_dispvms: True
- include_in_backups: False
- autostart: False
features:
- enable:
- appmenus-dispvm
tags:
- add:
- anon-vm
{%- endload %}
{{ load(defaults) }}
{% load_yaml as defaults -%}
name: sys-{{ slsdotpath }}
force: True
require:
- sls: {{ slsdotpath }}.clone
- qvm: {{ template.whonix_gateway_template }}
present:
- template: {{ template.whonix_gateway_template }}
- label: black
prefs:
- template: {{ template.whonix_gateway_template }}
- label: black
- audiovm: ""
- default_dispvm: dvm-{{ template.whonix_workstation_clean_template }}
- vcpus: 1
- memory: 300
- maxmem: 500
- provides-network: True
- include_in_backups: False
- autostart: False
tags:
- add:
- anon-gateway
{%- endload %}
{{ load(defaults) }}
{% load_yaml as defaults -%}
name: anon-{{ slsdotpath }}
force: True
require:
- sls: {{ slsdotpath }}.clone
- qvm: sys-{{ slsdotpath }}
- qvm: {{ template.whonix_workstation_template }}
present:
- template: {{ template.whonix_workstation_template }}
- label: red
prefs:
- template: {{ template.whonix_workstation_template }}
- label: red
- netvm: sys-{{ slsdotpath }}
- audiovm: ""
- default_dispvm: dvm-{{ template.whonix_workstation_clean_template }}
- vcpus: 1
- memory: 300
- maxmem: 1500
- include_in_backups: False
- autostart: False
tags:
- add:
- anon-vm
{%- endload %}
{{ load(defaults) }}

10
salt/whonix/create.top
View File

@ -1,10 +0,0 @@
{#
SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
base:
'dom0':
- match: nodegroup
- whonix.create

13
salt/whonix/init.top
View File

@ -1,13 +0,0 @@
{#
SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
base:
'dom0':
- match: nodegroup
- whonix.create
'whonix-workstation-17,whonix-gateway-17':
- match: list
- whonix.install

10
salt/whonix/install.top
View File

@ -1,10 +0,0 @@
{#
SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
base:
'whonix-workstation-17,whonix-gateway-17':
- match: list
- whonix.install

12
salt/whonix/template.jinja
View File

@ -1,12 +0,0 @@
{#
SPDX-FileCopyrightText: 2023 Benjamin Grande M. S. <ben.grande.b@gmail.com>
SPDX-License-Identifier: AGPL-3.0-or-later
#}
{% set whonix_version = salt['pillar.get']('qvm:whonix:version', '17') -%}
{% set whonix_repo = salt['pillar.get']('qvm:whonix:repo', 'qubes-templates-community') -%}
{% set whonix_workstation_template = 'whonix-workstation-' ~ whonix_version -%}
{% set whonix_gateway_template = 'whonix-gateway-' ~ whonix_version -%}
{% set whonix_workstation_clean_template = 'whonix-workstation' -%}
{% set whonix_gateway_clean_template = 'whonix-gateway' -%}