lupaxa-dead-drop 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- lupaxa_dead_drop-0.1.0/.gitignore +25 -0
- lupaxa_dead_drop-0.1.0/LICENCE +21 -0
- lupaxa_dead_drop-0.1.0/PKG-INFO +140 -0
- lupaxa_dead_drop-0.1.0/README.md +66 -0
- lupaxa_dead_drop-0.1.0/docs/README.md +23 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/images/favicon.png +0 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/images/logo.png +0 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/images/the-lupaxa-project-social-card.png +0 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/javascript/header-active-nav.js +76 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/javascript/language-preference.js +1021 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/javascript/page-lifecycle.js +52 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/stylesheets/00-tokens.css +69 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/stylesheets/10-base.css +72 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/stylesheets/20-layout.css +23 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/stylesheets/30-navigation.css +230 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/stylesheets/40-components/buttons.css +78 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/stylesheets/40-components/footer.css +78 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/stylesheets/40-components/hero.css +110 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/stylesheets/40-components/tables.css +98 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/stylesheets/90-responsive.css +208 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/stylesheets/95-print.css +51 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/stylesheets/99-overrides.css +69 -0
- lupaxa_dead_drop-0.1.0/mkdocs/assets/stylesheets/hide-primary-sidebar.css +34 -0
- lupaxa_dead_drop-0.1.0/mkdocs/examples.md +61 -0
- lupaxa_dead_drop-0.1.0/mkdocs/getting-started.md +93 -0
- lupaxa_dead_drop-0.1.0/mkdocs/index.md +26 -0
- lupaxa_dead_drop-0.1.0/mkdocs/reference/analysis.md +52 -0
- lupaxa_dead_drop-0.1.0/mkdocs/reference/carriers.md +67 -0
- lupaxa_dead_drop-0.1.0/mkdocs/reference/distribution.md +47 -0
- lupaxa_dead_drop-0.1.0/mkdocs/reference/extensions.md +43 -0
- lupaxa_dead_drop-0.1.0/mkdocs/reference/formats.md +83 -0
- lupaxa_dead_drop-0.1.0/mkdocs/reference/payload-and-crypto.md +74 -0
- lupaxa_dead_drop-0.1.0/mkdocs/reference/security.md +48 -0
- lupaxa_dead_drop-0.1.0/mkdocs/reference/vault.md +76 -0
- lupaxa_dead_drop-0.1.0/mkdocs/usage.md +137 -0
- lupaxa_dead_drop-0.1.0/mkdocs.yml +170 -0
- lupaxa_dead_drop-0.1.0/pyproject.toml +159 -0
- lupaxa_dead_drop-0.1.0/samples/carrier.png +0 -0
- lupaxa_dead_drop-0.1.0/samples/private-archive.toml +26 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/__init__.py +1 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/__init__.py +5 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/__main__.py +6 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/automation.py +328 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/carriers/api.py +466 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/carriers/base.py +186 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/carriers/bmp.py +156 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/carriers/png.py +325 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/carriers/svg.py +95 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/carriers/text.py +218 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/carriers/wav.py +155 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/carriers/zipcar.py +100 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/cli/main.py +1335 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/coding/reedsolomon.py +105 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/config.py +259 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/crypto/aead.py +132 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/crypto/kdf.py +57 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/crypto/keys.py +106 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/crypto/shamir.py +179 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/errors.py +97 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/history.py +89 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/laboratory.py +353 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/limits.py +53 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/paths.py +42 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/payload/envelope.py +313 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/payload/package.py +217 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/placement.py +78 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/py.typed +0 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/redact.py +60 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/result.py +40 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/services/conceal.py +467 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/tui.py +70 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/vault/ops.py +268 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/vault/store.py +570 -0
- lupaxa_dead_drop-0.1.0/src/lupaxa/dead_drop/version.py +8 -0
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# OS
|
|
2
|
+
.DS_Store
|
|
3
|
+
|
|
4
|
+
# Cursor
|
|
5
|
+
.cursor/
|
|
6
|
+
.superpowers/
|
|
7
|
+
.worktrees/
|
|
8
|
+
cursor-docs
|
|
9
|
+
|
|
10
|
+
# Make
|
|
11
|
+
.makefiles/
|
|
12
|
+
|
|
13
|
+
# MkDocs
|
|
14
|
+
site/
|
|
15
|
+
|
|
16
|
+
# Python
|
|
17
|
+
.venv/
|
|
18
|
+
__pycache__/
|
|
19
|
+
.mypy_cache/
|
|
20
|
+
.ruff_cache/
|
|
21
|
+
.pytest_cache/
|
|
22
|
+
dist/
|
|
23
|
+
build/
|
|
24
|
+
*.egg-info/
|
|
25
|
+
.audit-env/
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) The Lupaxa Project
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: lupaxa-dead-drop
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Offline laboratory for concealing, encrypting, distributing, analysing, and recovering data in ordinary carrier files, including a carrier-backed encrypted filesystem.
|
|
5
|
+
Project-URL: Homepage, https://github.com/lupaxa-security-toolbox/dead-drop
|
|
6
|
+
Project-URL: Repository, https://github.com/lupaxa-security-toolbox/dead-drop
|
|
7
|
+
Project-URL: Issues, https://github.com/lupaxa-security-toolbox/dead-drop/issues
|
|
8
|
+
Author: The Lupaxa Project
|
|
9
|
+
License: MIT License
|
|
10
|
+
|
|
11
|
+
Copyright (c) The Lupaxa Project
|
|
12
|
+
|
|
13
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
14
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
15
|
+
in the Software without restriction, including without limitation the rights
|
|
16
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
17
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
18
|
+
furnished to do so, subject to the following conditions:
|
|
19
|
+
|
|
20
|
+
The above copyright notice and this permission notice shall be included in all
|
|
21
|
+
copies or substantial portions of the Software.
|
|
22
|
+
|
|
23
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
24
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
25
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
26
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
27
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
28
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
29
|
+
SOFTWARE.
|
|
30
|
+
License-File: LICENCE
|
|
31
|
+
Keywords: cli,cryptography,forensics,secret-sharing,steganography
|
|
32
|
+
Classifier: Development Status :: 3 - Alpha
|
|
33
|
+
Classifier: Environment :: Console
|
|
34
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
35
|
+
Classifier: Operating System :: MacOS
|
|
36
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
37
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
38
|
+
Classifier: Programming Language :: Python :: 3
|
|
39
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
40
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
41
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
42
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
43
|
+
Classifier: Topic :: Security
|
|
44
|
+
Classifier: Topic :: Security :: Cryptography
|
|
45
|
+
Classifier: Topic :: Utilities
|
|
46
|
+
Requires-Python: >=3.11
|
|
47
|
+
Requires-Dist: argon2-cffi>=23.1.0
|
|
48
|
+
Requires-Dist: cryptography>=43.0.0
|
|
49
|
+
Requires-Dist: defusedxml>=0.7.1
|
|
50
|
+
Requires-Dist: filelock>=3.13.0
|
|
51
|
+
Requires-Dist: jinja2>=3.1.0
|
|
52
|
+
Requires-Dist: numpy>=1.26.0
|
|
53
|
+
Requires-Dist: pillow>=10.4.0
|
|
54
|
+
Requires-Dist: platformdirs>=4.2.0
|
|
55
|
+
Requires-Dist: reedsolo>=1.7.0
|
|
56
|
+
Requires-Dist: rich>=13.7.0
|
|
57
|
+
Requires-Dist: textual>=1.0.0
|
|
58
|
+
Requires-Dist: typer>=0.12.0
|
|
59
|
+
Provides-Extra: dev
|
|
60
|
+
Requires-Dist: bump-my-version>=1.2.0; extra == 'dev'
|
|
61
|
+
Requires-Dist: hypothesis>=6.100; extra == 'dev'
|
|
62
|
+
Requires-Dist: mkdocs-material==9.7.7; extra == 'dev'
|
|
63
|
+
Requires-Dist: mkdocs==1.6.1; extra == 'dev'
|
|
64
|
+
Requires-Dist: mypy>=1.12.0; extra == 'dev'
|
|
65
|
+
Requires-Dist: pip-audit>=2.7.0; extra == 'dev'
|
|
66
|
+
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
|
|
67
|
+
Requires-Dist: pytest>=8.0; extra == 'dev'
|
|
68
|
+
Requires-Dist: ruff>=0.6.0; extra == 'dev'
|
|
69
|
+
Provides-Extra: test
|
|
70
|
+
Requires-Dist: hypothesis>=6.100; extra == 'test'
|
|
71
|
+
Requires-Dist: pytest-cov>=5.0; extra == 'test'
|
|
72
|
+
Requires-Dist: pytest>=8.0; extra == 'test'
|
|
73
|
+
Description-Content-Type: text/markdown
|
|
74
|
+
|
|
75
|
+
<p align="center">
|
|
76
|
+
<a href="https://github.com/lupaxa-security-toolbox">
|
|
77
|
+
<img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/security-toolbox/readme-logo.png" alt="Security Toolbox" />
|
|
78
|
+
</a>
|
|
79
|
+
</p>
|
|
80
|
+
|
|
81
|
+
<h1 align="center">Dead Drop</h1>
|
|
82
|
+
|
|
83
|
+
Dead Drop is an offline laboratory for concealing, encrypting, distributing, analysing, and recovering data in ordinary files. A carrier-backed encrypted filesystem is one of its central features.
|
|
84
|
+
|
|
85
|
+
Concealment, encryption, and redundancy are separate. Hiding bytes does not encrypt them. Encryption does not make a carrier look unchanged.
|
|
86
|
+
|
|
87
|
+
Erasure coding and secret sharing do not authenticate a payload. Each command reports which of those properties it used.
|
|
88
|
+
|
|
89
|
+
## Install
|
|
90
|
+
|
|
91
|
+
Python 3.11 or newer:
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
pip install lupaxa-dead-drop
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
From a checkout:
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
pip install -e ".[dev]"
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
The command is `dead-drop`. It does not use the network.
|
|
104
|
+
|
|
105
|
+
## Quick Start
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
dead-drop hide photo.png secret.txt --output concealed.png
|
|
109
|
+
dead-drop reveal concealed.png --output secret.txt
|
|
110
|
+
dead-drop plan archive.zip --carriers ./pictures --optimise balanced
|
|
111
|
+
dead-drop vault create ./carriers --name personal --encrypt --redundancy 3
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Passwords are prompted and are not accepted as command-line arguments. Add `--json` for a stable result envelope.
|
|
115
|
+
|
|
116
|
+
## What it Does
|
|
117
|
+
|
|
118
|
+
- Hides payloads in PNG, BMP, WAV, text, Markdown, SVG, and ZIP carriers.
|
|
119
|
+
- Encrypts payloads with AES-256-GCM or ChaCha20-Poly1305 and Argon2id passwords.
|
|
120
|
+
- Splits keys with Shamir sharing and spreads ciphertext with Reed-Solomon shards.
|
|
121
|
+
- Plans carrier use without modifying files, then runs the plan from a recipe.
|
|
122
|
+
- Analyses and visualises carriers without treating statistics as proof.
|
|
123
|
+
- Stress-tests transformations on temporary copies.
|
|
124
|
+
- Stores a transactional encrypted filesystem across a carrier collection.
|
|
125
|
+
- Builds reproducible steganography challenges.
|
|
126
|
+
|
|
127
|
+
## Documentation
|
|
128
|
+
|
|
129
|
+
The published guide is at <https://dead-drop.thelupaxaproject.org/>.
|
|
130
|
+
|
|
131
|
+
Site Markdown lives in `mkdocs/`.
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
python -m pip install -r requirements.txt
|
|
135
|
+
mkdocs serve
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
<a href="https://github.com/the-lupaxa-project">
|
|
139
|
+
<img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
|
|
140
|
+
</a>
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://github.com/lupaxa-security-toolbox">
|
|
3
|
+
<img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/security-toolbox/readme-logo.png" alt="Security Toolbox" />
|
|
4
|
+
</a>
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
<h1 align="center">Dead Drop</h1>
|
|
8
|
+
|
|
9
|
+
Dead Drop is an offline laboratory for concealing, encrypting, distributing, analysing, and recovering data in ordinary files. A carrier-backed encrypted filesystem is one of its central features.
|
|
10
|
+
|
|
11
|
+
Concealment, encryption, and redundancy are separate. Hiding bytes does not encrypt them. Encryption does not make a carrier look unchanged.
|
|
12
|
+
|
|
13
|
+
Erasure coding and secret sharing do not authenticate a payload. Each command reports which of those properties it used.
|
|
14
|
+
|
|
15
|
+
## Install
|
|
16
|
+
|
|
17
|
+
Python 3.11 or newer:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pip install lupaxa-dead-drop
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
From a checkout:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
pip install -e ".[dev]"
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
The command is `dead-drop`. It does not use the network.
|
|
30
|
+
|
|
31
|
+
## Quick Start
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
dead-drop hide photo.png secret.txt --output concealed.png
|
|
35
|
+
dead-drop reveal concealed.png --output secret.txt
|
|
36
|
+
dead-drop plan archive.zip --carriers ./pictures --optimise balanced
|
|
37
|
+
dead-drop vault create ./carriers --name personal --encrypt --redundancy 3
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Passwords are prompted and are not accepted as command-line arguments. Add `--json` for a stable result envelope.
|
|
41
|
+
|
|
42
|
+
## What it Does
|
|
43
|
+
|
|
44
|
+
- Hides payloads in PNG, BMP, WAV, text, Markdown, SVG, and ZIP carriers.
|
|
45
|
+
- Encrypts payloads with AES-256-GCM or ChaCha20-Poly1305 and Argon2id passwords.
|
|
46
|
+
- Splits keys with Shamir sharing and spreads ciphertext with Reed-Solomon shards.
|
|
47
|
+
- Plans carrier use without modifying files, then runs the plan from a recipe.
|
|
48
|
+
- Analyses and visualises carriers without treating statistics as proof.
|
|
49
|
+
- Stress-tests transformations on temporary copies.
|
|
50
|
+
- Stores a transactional encrypted filesystem across a carrier collection.
|
|
51
|
+
- Builds reproducible steganography challenges.
|
|
52
|
+
|
|
53
|
+
## Documentation
|
|
54
|
+
|
|
55
|
+
The published guide is at <https://dead-drop.thelupaxaproject.org/>.
|
|
56
|
+
|
|
57
|
+
Site Markdown lives in `mkdocs/`.
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
python -m pip install -r requirements.txt
|
|
61
|
+
mkdocs serve
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
<a href="https://github.com/the-lupaxa-project">
|
|
65
|
+
<img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
|
|
66
|
+
</a>
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="https://github.com/lupaxa-security-toolbox">
|
|
3
|
+
<img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/security-toolbox/readme-logo.png" alt="Organisation Logo" />
|
|
4
|
+
</a>
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
<h1 align="center">Core Documentation</h1>
|
|
8
|
+
|
|
9
|
+
The following documents define the standards that apply across **The Lupaxa Project**:
|
|
10
|
+
|
|
11
|
+
| Document | Purpose |
|
|
12
|
+
| :------------------------------------ | :---------------------------------------------------------------- |
|
|
13
|
+
| [Code of Conduct](CODE_OF_CONDUCT.md) | Expected behaviour and reporting procedures. |
|
|
14
|
+
| [How to Contribute](CONTRIBUTING.md) | Development workflow, coding standards, and contribution process. |
|
|
15
|
+
| [Governance](GOVERNANCE.md) | Project governance, roles, and decision-making. |
|
|
16
|
+
| [Maintainers](MAINTAINERS.md) | Maintainer responsibilities and expectations. |
|
|
17
|
+
| [Projects Overview](PROJECTS.md) | Overview of organisations, repositories, and project structure. |
|
|
18
|
+
| [Security Policy](SECURITY.md) | Responsible disclosure and secure development practices. |
|
|
19
|
+
| [Support Guide](SUPPORT.md) | How to obtain help and support. |
|
|
20
|
+
|
|
21
|
+
<a href="https://github.com/the-lupaxa-project">
|
|
22
|
+
<img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
|
|
23
|
+
</a>
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Keep the custom header navigation active state synchronised with
|
|
3
|
+
* MkDocs Material instant navigation.
|
|
4
|
+
*
|
|
5
|
+
* Top-level items may be section roots (e.g. /getting-started/) while the
|
|
6
|
+
* current page is a child (e.g. /getting-started/quick-start/). Those parents
|
|
7
|
+
* stay active via prefix matching. Home / site-root stays exact-match only so
|
|
8
|
+
* it does not light up on every nested page.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
(() => {
|
|
12
|
+
"use strict";
|
|
13
|
+
|
|
14
|
+
const { onDocumentReady, onInstantNavigation } =
|
|
15
|
+
window.LupaxaPageLifecycle;
|
|
16
|
+
|
|
17
|
+
const normalisePath = (value) => {
|
|
18
|
+
// Resolve relative hrefs (./, ..) against the current page, not origin.
|
|
19
|
+
const url = new URL(value, window.location.href);
|
|
20
|
+
|
|
21
|
+
const path = url.pathname
|
|
22
|
+
.replace(/\/index\.html$/, "/")
|
|
23
|
+
.replace(/\/+$/, "");
|
|
24
|
+
|
|
25
|
+
return path || "/";
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
const updateActiveNavigation = () => {
|
|
29
|
+
const currentPath = normalisePath(window.location.href);
|
|
30
|
+
const links = Array.from(
|
|
31
|
+
document.querySelectorAll(".lupaxa-header__nav-link"),
|
|
32
|
+
);
|
|
33
|
+
|
|
34
|
+
if (!links.length) {
|
|
35
|
+
return;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
// Home is the first top-level item (site convention).
|
|
39
|
+
const homePath = normalisePath(links[0].href);
|
|
40
|
+
|
|
41
|
+
links.forEach((link) => {
|
|
42
|
+
const item = link.closest(".lupaxa-header__nav-item");
|
|
43
|
+
|
|
44
|
+
if (!item) {
|
|
45
|
+
return;
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
const linkPath = normalisePath(link.href);
|
|
49
|
+
const isHome = linkPath === homePath;
|
|
50
|
+
const isActive = isHome
|
|
51
|
+
? currentPath === linkPath
|
|
52
|
+
: currentPath === linkPath ||
|
|
53
|
+
currentPath.startsWith(`${linkPath}/`);
|
|
54
|
+
|
|
55
|
+
item.classList.toggle(
|
|
56
|
+
"lupaxa-header__nav-item--active",
|
|
57
|
+
isActive,
|
|
58
|
+
);
|
|
59
|
+
|
|
60
|
+
if (isActive) {
|
|
61
|
+
link.setAttribute("aria-current", "page");
|
|
62
|
+
} else {
|
|
63
|
+
link.removeAttribute("aria-current");
|
|
64
|
+
}
|
|
65
|
+
});
|
|
66
|
+
};
|
|
67
|
+
|
|
68
|
+
const scheduleUpdate = () => {
|
|
69
|
+
requestAnimationFrame(updateActiveNavigation);
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
onDocumentReady(updateActiveNavigation);
|
|
73
|
+
onInstantNavigation(updateActiveNavigation);
|
|
74
|
+
|
|
75
|
+
window.addEventListener("popstate", scheduleUpdate);
|
|
76
|
+
})();
|