-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
65 changed files
with
5,179 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
tests/_data/* filter=lfs diff=lfs merge=lfs -text |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
name: Dissect CI | ||
on: | ||
push: | ||
branches: | ||
- main | ||
tags: | ||
- '*' | ||
pull_request: | ||
workflow_dispatch: | ||
|
||
jobs: | ||
ci: | ||
uses: fox-it/dissect-workflow-templates/.github/workflows/dissect-ci-template.yml@main | ||
secrets: inherit | ||
|
||
publish: | ||
if: ${{ github.ref_name == 'main' || github.ref_type == 'tag' }} | ||
needs: [ci] | ||
runs-on: ubuntu-latest | ||
environment: dissect_publish | ||
permissions: | ||
id-token: write | ||
steps: | ||
- uses: actions/download-artifact@v4 | ||
with: | ||
name: packages | ||
path: dist/ | ||
# According to the documentation, it automatically looks inside the `dist/` folder for packages. | ||
- name: Publish package distributions to Pypi | ||
uses: pypa/gh-action-pypi-publish@release/v1 | ||
|
||
trigger-tests: | ||
needs: [publish] | ||
uses: fox-it/dissect-workflow-templates/.github/workflows/dissect-ci-demand-test-template.yml@main | ||
secrets: inherit | ||
with: | ||
on-demand-test: 'dissect.target' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
coverage.xml | ||
.coverage | ||
dist/ | ||
.eggs/ | ||
*.egg-info/ | ||
*.pyc | ||
__pycache__/ | ||
.pytest_cache/ | ||
tests/docs/api | ||
tests/docs/build | ||
.tox/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
Dissect is released as open source by Fox-IT (https://www.fox-it.com) part of NCC Group Plc (https://www.nccgroup.com) | ||
|
||
Developed by the Dissect Team ([email protected]) and made available at https://github.com/fox-it/dissect.fve | ||
|
||
License terms: AGPL3 (https://www.gnu.org/licenses/agpl-3.0.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
exclude .gitignore | ||
recursive-exclude .github/ * |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# dissect.fve | ||
|
||
A Dissect module implementing parsers for full volume encryption implementations, currently Linux Unified Key Setup (LUKS1 and LUKS2) and Microsoft's Bitlocker Disk Encryption. | ||
For more information, please see [the documentation](https://docs.dissect.tools/en/latest/projects/dissect.fve/index.html). | ||
|
||
## Requirements | ||
|
||
This project is part of the Dissect framework and requires Python. | ||
|
||
Information on the supported Python versions can be found in the Getting Started section of [the documentation](https://docs.dissect.tools/en/latest/index.html#getting-started). | ||
|
||
## Installation | ||
|
||
`dissect.fve` is available on [PyPI](https://pypi.org/project/dissect.fve/). | ||
|
||
```bash | ||
pip install dissect.fve | ||
``` | ||
|
||
This module is also automatically installed if you install the `dissect` package. | ||
|
||
## Build and test instructions | ||
|
||
This project uses `tox` to build source and wheel distributions. Run the following command from the root folder to build | ||
these: | ||
|
||
```bash | ||
tox -e build | ||
``` | ||
|
||
The build artifacts can be found in the `dist/` directory. | ||
|
||
`tox` is also used to run linting and unit tests in a self-contained environment. To run both linting and unit tests | ||
using the default installed Python version, run: | ||
|
||
```bash | ||
tox | ||
``` | ||
|
||
For a more elaborate explanation on how to build and test the project, please see [the | ||
documentation](https://docs.dissect.tools/en/latest/contributing/tooling.html). | ||
|
||
## Contributing | ||
|
||
The Dissect project encourages any contribution to the codebase. To make your contribution fit into the project, please | ||
refer to [the development guide](https://docs.dissect.tools/en/latest/contributing/developing.html). | ||
|
||
## Copyright and license | ||
|
||
Dissect is released as open source by Fox-IT (<https://www.fox-it.com>) part of NCC Group Plc | ||
(<https://www.nccgroup.com>). | ||
|
||
Developed by the Dissect Team (<[email protected]>) and made available at <https://github.com/fox-it/dissect>. | ||
|
||
License terms: AGPL3 (<https://www.gnu.org/licenses/agpl-3.0.html>). For more information, see the LICENSE file. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
from dissect.fve.exceptions import Error | ||
|
||
__all__ = [ | ||
"Error", | ||
] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
from dissect.fve.bde.bde import BDE, is_bde_volume | ||
|
||
__all__ = [ | ||
"BDE", | ||
"is_bde_volume", | ||
] |
Oops, something went wrong.