Compare commits

..

1 commit

Author SHA1 Message Date
Alex Pyrgiotis
3091c47064
Update reference template for Qubes to Fedora 41
Closes #1078
2025-04-07 22:32:15 +03:00
15 changed files with 44 additions and 83 deletions

View file

@ -113,7 +113,7 @@ Install Poetry using `pipx`:
```sh ```sh
pipx install poetry pipx install poetry
pipx inject poetry pipx inject poetry poetry-plugin-export
``` ```
Clone this repository: Clone this repository:
@ -326,7 +326,7 @@ cd dangerzone
Install Python dependencies: Install Python dependencies:
```sh ```sh
python3 -m pip install poetry python3 -m pip install poetry poetry-plugin-export
poetry install poetry install
``` ```
@ -387,7 +387,7 @@ Install Microsoft Visual C++ 14.0 or greater. Get it with ["Microsoft C++ Build
Install [poetry](https://python-poetry.org/). Open PowerShell, and run: Install [poetry](https://python-poetry.org/). Open PowerShell, and run:
``` ```
python -m pip install poetry python -m pip install poetry poetry-plugin-export
``` ```
Install git from [here](https://git-scm.com/download/win), open a Windows terminal (`cmd.exe`) and clone this repository: Install git from [here](https://git-scm.com/download/win), open a Windows terminal (`cmd.exe`) and clone this repository:

View file

@ -22,7 +22,7 @@ fix: ## apply all the suggestions from ruff
ruff format ruff format
.PHONY: test .PHONY: test
test: ## Run the tests test:
# Make each GUI test run as a separate process, to avoid segfaults due to # Make each GUI test run as a separate process, to avoid segfaults due to
# shared state. # shared state.
# See more in https://github.com/freedomofpress/dangerzone/issues/493 # See more in https://github.com/freedomofpress/dangerzone/issues/493
@ -47,31 +47,27 @@ test-large: test-large-init ## Run large test set
python -m pytest --tb=no tests/test_large_set.py::TestLargeSet -v $(JUNIT_FLAGS) --junitxml=$(TEST_LARGE_RESULTS) python -m pytest --tb=no tests/test_large_set.py::TestLargeSet -v $(JUNIT_FLAGS) --junitxml=$(TEST_LARGE_RESULTS)
python $(TEST_LARGE_RESULTS)/report.py $(TEST_LARGE_RESULTS) python $(TEST_LARGE_RESULTS)/report.py $(TEST_LARGE_RESULTS)
Dockerfile: Dockerfile.env Dockerfile.in ## Regenerate the Dockerfile from its template Dockerfile: Dockerfile.env Dockerfile.in
poetry run jinja2 Dockerfile.in Dockerfile.env > Dockerfile poetry run jinja2 Dockerfile.in Dockerfile.env > Dockerfile
.PHONY: poetry-install
poetry-install: ## Install project dependencies
poetry install
.PHONY: build-clean .PHONY: build-clean
build-clean: build-clean:
poetry run doit clean doit clean
.PHONY: build-macos-intel .PHONY: build-macos-intel
build-macos-intel: build-clean poetry-install ## Build macOS intel package (.dmg) build-macos-intel: build-clean
poetry run doit -n 8 doit -n 8
.PHONY: build-macos-arm .PHONY: build-macos-arm
build-macos-arm: build-clean poetry-install ## Build macOS Apple Silicon package (.dmg) build-macos-arm: build-clean
poetry run doit -n 8 macos_build_dmg doit -n 8 macos_build_dmg
.PHONY: build-linux .PHONY: build-linux
build-linux: build-clean poetry-install ## Build linux packages (.rpm and .deb) build-linux: build-clean
poetry run doit -n 8 fedora_rpm debian_deb doit -n 8 fedora_rpm debian_deb
.PHONY: regenerate-reference-pdfs .PHONY: regenerate-reference-pdfs
regenerate-reference-pdfs: ## Regenerate the reference PDFs regenerate-reference-pdfs:
pytest tests/test_cli.py -k regenerate --generate-reference-pdfs pytest tests/test_cli.py -k regenerate --generate-reference-pdfs
# Makefile self-help borrowed from the securedrop-client project # Makefile self-help borrowed from the securedrop-client project
# Explaination of the below shell command should it ever break. # Explaination of the below shell command should it ever break.

View file

@ -123,7 +123,7 @@ Here is what you need to do:
# In case of a new Python installation or minor version upgrade, e.g., from # In case of a new Python installation or minor version upgrade, e.g., from
# 3.11 to 3.12, reinstall Poetry # 3.11 to 3.12, reinstall Poetry
python3 -m pip install poetry python3 -m pip install poetry poetry-plugin-export
# You can verify the correct Python version is used # You can verify the correct Python version is used
poetry debug info poetry debug info
@ -141,7 +141,7 @@ Here is what you need to do:
poetry env remove --all poetry env remove --all
# Install the dependencies # Install the dependencies
poetry sync poetry install --sync
``` ```
- [ ] Build the container image and the OCR language data - [ ] Build the container image and the OCR language data
@ -205,7 +205,7 @@ The Windows release is performed in a Windows 11 virtual machine (as opposed to
```bash ```bash
# In case of a new Python installation or minor version upgrade, e.g., from # In case of a new Python installation or minor version upgrade, e.g., from
# 3.11 to 3.12, reinstall Poetry # 3.11 to 3.12, reinstall Poetry
python3 -m pip install poetry python3 -m pip install poetry poetry-plugin-export
# You can verify the correct Python version is used # You can verify the correct Python version is used
poetry debug info poetry debug info
@ -223,7 +223,7 @@ The Windows release is performed in a Windows 11 virtual machine (as opposed to
poetry env remove --all poetry env remove --all
# Install the dependencies # Install the dependencies
poetry sync poetry install --sync
``` ```
- [ ] Copy the container image into the VM - [ ] Copy the container image into the VM

View file

@ -4,12 +4,6 @@ import sys
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
# Call freeze_support() to avoid passing unknown options to the subprocess.
# See https://github.com/freedomofpress/dangerzone/issues/873
import multiprocessing
multiprocessing.freeze_support()
try: try:
from . import vendor # type: ignore [attr-defined] from . import vendor # type: ignore [attr-defined]

View file

@ -52,11 +52,7 @@ def print_header(s: str) -> None:
@click.option( @click.option(
"--set-container-runtime", "--set-container-runtime",
required=False, required=False,
help=( help="The path to the container runtime you want to set in the settings",
"The name or full path of the container runtime you want Dangerzone to use."
" You can specify the value 'default' if you want to take back your choice, and"
" let Dangerzone use the default runtime for this OS"
),
) )
@click.version_option(version=get_version(), message="%(version)s") @click.version_option(version=get_version(), message="%(version)s")
@errors.handle_document_errors @errors.handle_document_errors
@ -73,16 +69,10 @@ def cli_main(
display_banner() display_banner()
if set_container_runtime: if set_container_runtime:
settings = Settings() settings = Settings()
if set_container_runtime == "default": container_runtime = settings.set_custom_runtime(
settings.unset_custom_runtime() set_container_runtime, autosave=True
click.echo( )
"Instructed Dangerzone to use the default container runtime for this OS" click.echo(f"Set the settings container_runtime to {container_runtime}")
)
else:
container_runtime = settings.set_custom_runtime(
set_container_runtime, autosave=True
)
click.echo(f"Set the settings container_runtime to {container_runtime}")
sys.exit(0) sys.exit(0)
elif not filenames: elif not filenames:
raise click.UsageError("Missing argument 'FILENAMES...'") raise click.UsageError("Missing argument 'FILENAMES...'")

View file

@ -3,6 +3,7 @@ import os
import platform import platform
import tempfile import tempfile
import typing import typing
from multiprocessing import freeze_support
from multiprocessing.pool import ThreadPool from multiprocessing.pool import ThreadPool
from pathlib import Path from pathlib import Path
from typing import List, Optional from typing import List, Optional
@ -227,9 +228,7 @@ class MainWindow(QtWidgets.QMainWindow):
if not is_version_valid: if not is_version_valid:
self.handle_docker_desktop_version_check(is_version_valid, version) self.handle_docker_desktop_version_check(is_version_valid, version)
except errors.UnsupportedContainerRuntime as e: except errors.UnsupportedContainerRuntime as e:
pass # It's caught later in the flow. pass # It's catched later in the flow.
except errors.NoContainerTechException as e:
pass # It's caught later in the flow.
self.show() self.show()
@ -1237,6 +1236,9 @@ class DocumentsListWidget(QtWidgets.QListWidget):
def start_conversion(self) -> None: def start_conversion(self) -> None:
if not self.thread_pool_initized: if not self.thread_pool_initized:
max_jobs = self.dangerzone.isolation_provider.get_max_parallel_conversions() max_jobs = self.dangerzone.isolation_provider.get_max_parallel_conversions()
# Call freeze_support() to avoid passing unknown options to the subprocess.
# See https://github.com/freedomofpress/dangerzone/issues/873
freeze_support()
self.thread_pool = ThreadPool(max_jobs) self.thread_pool = ThreadPool(max_jobs)
for doc in self.docs_list: for doc in self.docs_list:

View file

@ -56,14 +56,7 @@ class Container(IsolationProvider):
security_args = ["--log-driver", "none"] security_args = ["--log-driver", "none"]
security_args += ["--security-opt", "no-new-privileges"] security_args += ["--security-opt", "no-new-privileges"]
if container_utils.get_runtime_version() >= (4, 1): if container_utils.get_runtime_version() >= (4, 1):
# We perform a platform check to avoid the following Podman Desktop security_args += ["--userns", "nomap"]
# error on Windows:
#
# Error: nomap is only supported in rootless mode
#
# See also: https://github.com/freedomofpress/dangerzone/issues/1127
if platform.system() != "Windows":
security_args += ["--userns", "nomap"]
else: else:
security_args = ["--security-opt=no-new-privileges:true"] security_args = ["--security-opt=no-new-privileges:true"]
@ -74,15 +67,7 @@ class Container(IsolationProvider):
# [1] https://github.com/freedomofpress/dangerzone/issues/846 # [1] https://github.com/freedomofpress/dangerzone/issues/846
# [2] https://github.com/containers/common/blob/d3283f8401eeeb21f3c59a425b5461f069e199a7/pkg/seccomp/seccomp.json # [2] https://github.com/containers/common/blob/d3283f8401eeeb21f3c59a425b5461f069e199a7/pkg/seccomp/seccomp.json
seccomp_json_path = str(get_resource_path("seccomp.gvisor.json")) seccomp_json_path = str(get_resource_path("seccomp.gvisor.json"))
# We perform a platform check to avoid the following Podman Desktop security_args += ["--security-opt", f"seccomp={seccomp_json_path}"]
# error on Windows:
#
# Error: opening seccomp profile failed: open
# C:\[...]\dangerzone\share\seccomp.gvisor.json: no such file or directory
#
# See also: https://github.com/freedomofpress/dangerzone/issues/1127
if runtime.name == "podman" and platform.system() != "Windows":
security_args += ["--security-opt", f"seccomp={seccomp_json_path}"]
security_args += ["--cap-drop", "all"] security_args += ["--cap-drop", "all"]
security_args += ["--cap-add", "SYS_CHROOT"] security_args += ["--cap-add", "SYS_CHROOT"]

View file

@ -52,10 +52,6 @@ class Settings:
self.save() self.save()
return container_runtime return container_runtime
def unset_custom_runtime(self) -> None:
self.settings.pop("container_runtime")
self.save()
def get(self, key: str) -> Any: def get(self, key: str) -> Any:
return self.settings[key] return self.settings[key]

4
debian/changelog vendored
View file

@ -2,13 +2,13 @@ dangerzone (0.9.0) unstable; urgency=low
* Released Dangerzone 0.9.0 * Released Dangerzone 0.9.0
-- Freedom of the Press Foundation <info@freedom.press> Mon, 31 Mar 2025 15:57:18 +0300 -- Freedom of the Press Foundation <info@freedom.press> Mon, 31 March 2025 15:57:18 +0300
dangerzone (0.8.1) unstable; urgency=low dangerzone (0.8.1) unstable; urgency=low
* Released Dangerzone 0.8.1 * Released Dangerzone 0.8.1
-- Freedom of the Press Foundation <info@freedom.press> Tue, 22 Dec 2024 22:03:28 +0300 -- Freedom of the Press Foundation <info@freedom.press> Tue, 22 December 2024 22:03:28 +0300
dangerzone (0.8.0) unstable; urgency=low dangerzone (0.8.0) unstable; urgency=low

View file

@ -331,7 +331,7 @@ Install Poetry using `pipx`:
```sh ```sh
pipx install poetry pipx install poetry
pipx inject poetry pipx inject poetry poetry-plugin-export
``` ```
Clone this repository: Clone this repository:
@ -397,7 +397,7 @@ Install Microsoft Visual C++ 14.0 or greater. Get it with ["Microsoft C++ Build
Install [poetry](https://python-poetry.org/). Open PowerShell, and run: Install [poetry](https://python-poetry.org/). Open PowerShell, and run:
``` ```
python -m pip install poetry python -m pip install poetry poetry-plugin-export
``` ```
Install git from [here](https://git-scm.com/download/win), open a Windows terminal (`cmd.exe`) and clone this repository: Install git from [here](https://git-scm.com/download/win), open a Windows terminal (`cmd.exe`) and clone this repository:
@ -835,8 +835,8 @@ class QAWindows(QABase):
"Install Poetry and the project's dependencies", ref=REF_BUILD, auto=True "Install Poetry and the project's dependencies", ref=REF_BUILD, auto=True
) )
def install_poetry(self): def install_poetry(self):
self.run("python", "-m", "pip", "install", "poetry") self.run("python", "-m", "pip", "install", "poetry", "poetry-plugin-export")
self.run("poetry", "sync") self.run("poetry", "install", "--sync")
@QABase.task("Build Dangerzone container image", ref=REF_BUILD, auto=True) @QABase.task("Build Dangerzone container image", ref=REF_BUILD, auto=True)
def build_image(self): def build_image(self):

View file

@ -42,8 +42,7 @@ doit <task>
## Tips and tricks ## Tips and tricks
* You can run `doit list --all -s` to see the full list of tasks, their * You can run `doit list --all -s` to see the full list of tasks, their
dependencies, and whether they are up to date (U) or will run (R). Note that dependencies, and whether they are up to date.
certain small tasks are always configured to run.
* You can run `doit info <task>` to see which dependencies are missing. * You can run `doit info <task>` to see which dependencies are missing.
* You can pass the following environment variables to the script, in order to * You can pass the following environment variables to the script, in order to
affect some global parameters: affect some global parameters:

View file

@ -8,7 +8,8 @@ from doit.action import CmdAction
ARCH = "arm64" if platform.machine() == "arm64" else "i686" ARCH = "arm64" if platform.machine() == "arm64" else "i686"
VERSION = open("share/version.txt").read().strip() VERSION = open("share/version.txt").read().strip()
FEDORA_VERSIONS = ["40", "41", "42"] FEDORA_VERSIONS = ["40", "41"]
DEBIAN_VERSIONS = ["bullseye", "jammy", "mantic", "noble", "trixie"]
### Global parameters ### Global parameters
@ -43,6 +44,7 @@ def list_language_data():
tessdata_dir = Path("share") / "tessdata" tessdata_dir = Path("share") / "tessdata"
langs = json.loads(open(tessdata_dir.parent / "ocr-languages.json").read()).values() langs = json.loads(open(tessdata_dir.parent / "ocr-languages.json").read()).values()
targets = [tessdata_dir / f"{lang}.traineddata" for lang in langs] targets = [tessdata_dir / f"{lang}.traineddata" for lang in langs]
targets.append(tessdata_dir)
return targets return targets
@ -122,7 +124,7 @@ def build_deb(cwd):
def build_rpm(version, cwd, qubes=False): def build_rpm(version, cwd, qubes=False):
"""Build an .rpm package on the requested Fedora distro.""" """Build an .rpm package on the requested Fedora distro."""
return build_linux_pkg(distro="fedora", version=version, cwd=cwd, qubes=qubes) return build_linux_pkg(distro="Fedora", version=version, cwd=cwd, qubes=qubes)
### Tasks ### Tasks
@ -206,7 +208,7 @@ def task_build_image():
def task_poetry_install(): def task_poetry_install():
"""Setup the Poetry environment""" """Setup the Poetry environment"""
return {"actions": ["poetry sync"], "clean": ["poetry env remove --all"]} return {"actions": ["poetry install --sync"], "clean": ["poetry env remove --all"]}
def task_macos_build_dmg(): def task_macos_build_dmg():

View file

@ -5,7 +5,7 @@ import subprocess
import sys import sys
from pathlib import Path from pathlib import Path
BUILD_CONTEXT = "dangerzone" BUILD_CONTEXT = "dangerzone/"
IMAGE_NAME = "dangerzone.rocks/dangerzone" IMAGE_NAME = "dangerzone.rocks/dangerzone"
if platform.system() in ["Darwin", "Windows"]: if platform.system() in ["Darwin", "Windows"]:
CONTAINER_RUNTIME = "docker" CONTAINER_RUNTIME = "docker"
@ -122,8 +122,7 @@ def main():
subprocess.run( subprocess.run(
[ [
sys.executable, "./dev_scripts/repro-build.py",
str(Path("dev_scripts") / "repro-build.py"),
"build", "build",
"--runtime", "--runtime",
args.runtime, args.runtime,

View file

@ -51,8 +51,6 @@ def main():
if files == expected_files: if files == expected_files:
logger.info("Skipping tessdata download, language data already exists") logger.info("Skipping tessdata download, language data already exists")
return return
elif not files:
logger.info("Tesseract dir is empty, proceeding to download language data")
else: else:
logger.info(f"Found {tessdata_dir} but contents do not match") logger.info(f"Found {tessdata_dir} but contents do not match")
return 1 return 1

View file

@ -13,7 +13,7 @@ setup(
description="Dangerzone", description="Dangerzone",
options={ options={
"build_exe": { "build_exe": {
"packages": ["dangerzone", "dangerzone.gui", "pymupdf._wxcolors"], "packages": ["dangerzone", "dangerzone.gui"],
"excludes": ["test", "tkinter"], "excludes": ["test", "tkinter"],
"include_files": [("share", "share"), ("LICENSE", "LICENSE")], "include_files": [("share", "share"), ("LICENSE", "LICENSE")],
"include_msvcr": True, "include_msvcr": True,