donglify

Name	donglify JSON
Version	20241004 JSON
	download
home_page	None
Summary	The ultimate Archlinux encryption USB dongiled setup.
upload_time	2024-10-04 19:31:02
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	MIT License Copyright (c) 2024 ayham Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords	archlinux donglify encryption linux luks security usb
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # donglify

The majority of Linux systems have a severe security threat. These installs are
susceptable to data theft if the install disk is stolen. ArchLinux offers LUKS
as an encryption method to protect the root & data partitions. Even then, the
majority of these installs omit the encryption of the `/boot` or `/efi`
partitions. This script helps automate the configuration of encrypted `/boot`.
And provides a solution in replacement of the `/efi` partition, which usually
can not be encrypted, by having it be present on a USB DONGLE.

## Installation

```sh
pipx install donglify
```

## Usage

To use donglify, you will need to install the initial configurations onto a
USB, which can be done as follows:

```sh
donglify init /dev/sd[a,b,c]
```

This command creates the following partitions on your USB.

- `/efi`, 512 MB, holds the EFI stub which the BIOS of a system to boot the
  USB.
- `/boot`, 2GB, holds the kernels of the donglified systems, AND the
  `dongle.ini` configuration file.
- `dongleisos`, size is set by the user, used to hold the ISOs which are
  available in the GRUB menu on USB boot, currently only `loopback.cfg` ISOs
  can be used.
- `donglepersist`, size is set by the user, an encrypted LUKS partition that
  can be used by the user to store personal data.

In order to enter the interactive donglify prompt:

```sh
donglify /dev/sd[a,b,c][2]
```

The argument should be the donglified USB `/boot` partition.

## Interactive Commands

donglify uses an interactive CLI interface to conduct its business. This is
currently the only support, future support for automated installs could be
added.

### cmd: add

Adds host system configuration to the donglified USB. This configuration is
automatically generation to the host system installed once established.

```sh
donglify> add
```

You will be prompted for configuration options.

You will need to add unlock root LUKS entry in
[/etc/crypttab.initramfs](https://wiki.archlinux.org/title/dm-crypt/System_configuration#crypto),
otherwise the initial ramdisk won't ask to unlock your root partition on your
added system. There you can also tell it about your keyfile location if you
choose to do so.

```sh
[~] $ sudo cat /etc/crypttab.initramfs 
cryptssd UUID=<your UUID here> /boot/crypto_keyfile.bin
crypthdd UUID=<your UUID here> /boot/crypto_keyfile.bin
```

### cmd: mount

```sh
donglify> mount
```

Mounts all donglified USB except for `donglepersist`.

### cmd: unmount

```sh
donglify> unmount
```

Unmounts all partitions that `mount` mounted.

### cmd: list

```sh
donglify> list
```

Lists all installed systems on the USB.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "donglify",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "ayham-1 <me@ayham.xyz>",
    "keywords": "archlinux, donglify, encryption, linux, luks, security, usb",
    "author": null,
    "author_email": "ayham-1 <me@ayham.xyz>",
    "download_url": "https://files.pythonhosted.org/packages/c0/c0/1ba6e56355857b148b7740b3bd47dee97389c5cada989513c7e5ac49f915/donglify-20241004.tar.gz",
    "platform": null,
    "description": "# donglify\n\nThe majority of Linux systems have a severe security threat. These installs are\nsusceptable to data theft if the install disk is stolen. ArchLinux offers LUKS\nas an encryption method to protect the root & data partitions. Even then, the\nmajority of these installs omit the encryption of the `/boot` or `/efi`\npartitions. This script helps automate the configuration of encrypted `/boot`.\nAnd provides a solution in replacement of the `/efi` partition, which usually\ncan not be encrypted, by having it be present on a USB DONGLE.\n\n## Installation\n\n```sh\npipx install donglify\n```\n\n## Usage\n\nTo use donglify, you will need to install the initial configurations onto a\nUSB, which can be done as follows:\n\n```sh\ndonglify init /dev/sd[a,b,c]\n```\n\nThis command creates the following partitions on your USB.\n\n- `/efi`, 512 MB, holds the EFI stub which the BIOS of a system to boot the\n  USB.\n- `/boot`, 2GB, holds the kernels of the donglified systems, AND the\n  `dongle.ini` configuration file.\n- `dongleisos`, size is set by the user, used to hold the ISOs which are\n  available in the GRUB menu on USB boot, currently only `loopback.cfg` ISOs\n  can be used.\n- `donglepersist`, size is set by the user, an encrypted LUKS partition that\n  can be used by the user to store personal data.\n\nIn order to enter the interactive donglify prompt:\n\n```sh\ndonglify /dev/sd[a,b,c][2]\n```\n\nThe argument should be the donglified USB `/boot` partition.\n\n## Interactive Commands\n\ndonglify uses an interactive CLI interface to conduct its business. This is\ncurrently the only support, future support for automated installs could be\nadded.\n\n### cmd: add\n\nAdds host system configuration to the donglified USB. This configuration is\nautomatically generation to the host system installed once established.\n\n```sh\ndonglify> add\n```\n\nYou will be prompted for configuration options.\n\nYou will need to add unlock root LUKS entry in\n[/etc/crypttab.initramfs](https://wiki.archlinux.org/title/dm-crypt/System_configuration#crypto),\notherwise the initial ramdisk won't ask to unlock your root partition on your\nadded system. There you can also tell it about your keyfile location if you\nchoose to do so.\n\n```sh\n[~] $ sudo cat /etc/crypttab.initramfs \ncryptssd UUID=<your UUID here> /boot/crypto_keyfile.bin\ncrypthdd UUID=<your UUID here> /boot/crypto_keyfile.bin\n```\n\n### cmd: mount\n\n```sh\ndonglify> mount\n```\n\nMounts all donglified USB except for `donglepersist`.\n\n### cmd: unmount\n\n```sh\ndonglify> unmount\n```\n\nUnmounts all partitions that `mount` mounted.\n\n### cmd: list\n\n```sh\ndonglify> list\n```\n\nLists all installed systems on the USB.\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2024 ayham  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "The ultimate Archlinux encryption USB dongiled setup.",
    "version": "20241004",
    "project_urls": {
        "Homepage": "https://github.com/ayham-1/donglify"
    },
    "split_keywords": [
        "archlinux",
        " donglify",
        " encryption",
        " linux",
        " luks",
        " security",
        " usb"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b9570f2e6047a10b585a9922c0be98eec0940554ee788293a03cb8d2f46433e8",
                "md5": "aa1b2b927c6d030e2c610ef2230551a6",
                "sha256": "7694dac0950b4f38a9e502a67744c77f6bacbdf65e09c779c5bed0471ffb5fb1"
            },
            "downloads": -1,
            "filename": "donglify-20241004-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "aa1b2b927c6d030e2c610ef2230551a6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 1141191,
            "upload_time": "2024-10-04T19:31:00",
            "upload_time_iso_8601": "2024-10-04T19:31:00.937697Z",
            "url": "https://files.pythonhosted.org/packages/b9/57/0f2e6047a10b585a9922c0be98eec0940554ee788293a03cb8d2f46433e8/donglify-20241004-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c0c01ba6e56355857b148b7740b3bd47dee97389c5cada989513c7e5ac49f915",
                "md5": "5d0987ed5f03d20ff4fb2c1455c769f6",
                "sha256": "b7b05b0fa2ac8760c1f8f26aa5ecf358297c4c616298c9a4c5533d1c18cefef4"
            },
            "downloads": -1,
            "filename": "donglify-20241004.tar.gz",
            "has_sig": false,
            "md5_digest": "5d0987ed5f03d20ff4fb2c1455c769f6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 1134021,
            "upload_time": "2024-10-04T19:31:02",
            "upload_time_iso_8601": "2024-10-04T19:31:02.358765Z",
            "url": "https://files.pythonhosted.org/packages/c0/c0/1ba6e56355857b148b7740b3bd47dee97389c5cada989513c7e5ac49f915/donglify-20241004.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-04 19:31:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ayham-1",
    "github_project": "donglify",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "donglify"
}