Skip to content

Commit

Permalink
Updating Docs for commit 441578c made on 2023-06-18T20:18:03+00:00 fr…
Browse files Browse the repository at this point in the history
…om refs/heads/dev
  • Loading branch information
maltfield committed Jul 28, 2024
0 parents commit bae411c
Show file tree
Hide file tree
Showing 2,172 changed files with 386,186 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs.buskill.in
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# GitHub Pages Cache

Nothing to see here. The contents of this branch are essentially a cache that's not intended to be viewed on github.com.

You can view the actual documentation as it's intended to be viewed at [https://docs.buskill.in/](https://docs.buskill.in/)

If you're looking to update our documentation, check the relevant development branch's ['docs' dir](https://github.com/BusKill/buskill-app/tree/dev/docs).
4 changes: 4 additions & 0 deletions buskill-app/en/dev/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 144bbf5888b15c90d6e50b2bd191503e
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file added buskill-app/en/dev/.doctrees/changelog.doctree
Binary file not shown.
Binary file added buskill-app/en/dev/.doctrees/contributing.doctree
Binary file not shown.
Binary file added buskill-app/en/dev/.doctrees/environment.pickle
Binary file not shown.
Binary file added buskill-app/en/dev/.doctrees/faq.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added buskill-app/en/dev/.doctrees/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added buskill-app/en/dev/.doctrees/license.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added buskill-app/en/dev/.doctrees/support.doctree
Binary file not shown.
Empty file added buskill-app/en/dev/.nojekyll
Empty file.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added buskill-app/en/dev/_images/buskill_assemble3.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added buskill-app/en/dev/_images/buskill_demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added buskill-app/en/dev/_images/buskill_download1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added buskill-app/en/dev/_images/buskill_download2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added buskill-app/en/dev/_images/buskill_open_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added buskill-app/en/dev/_images/buskill_settings_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added buskill-app/en/dev/_images/buskill_update_1.png
Binary file added buskill-app/en/dev/_images/buskill_usb_c_hub.jpg
67 changes: 67 additions & 0 deletions buskill-app/en/dev/_sources/attribution.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
.. _attribution:

Attribution
===========

Thank you to the following folks who have contributed to the BusKill project!
* `Michael Altfield <https://michaelaltfield.net>`_
* `cyberkryption <https://github.com/cyberkryption>`_
* `Steven Johnson <https://www.linkedin.com/in/sj2019/>`_
* `Jacob Neplokh <https://jacobneplokh.com/>`_
* `Melanie Allen <https://github.com/goldfishlaser>`_
* `François Marier <https://fmarier.org/>`_
* `samxplogs <https://www.youtube.com/@samxplogs>`_

This project would not have been possible without the following tools and services:
* `Python <https://www.python.org/>`_
* `Kivy <https://kivy.org/>`_
* `libusb <https://libusb.info/>`_
* `libusb1 <https://pypi.org/project/libusb1/>`_
* `python-gnupg <https://pypi.org/project/python-gnupg/>`_
* `AppImage <https://appimage.org/>`_
* `PyInstaller <https://www.pyinstaller.org/>`_
* `Vim <https://www.vim.org/>`_
* `Gimp <https://www.gimp.org/>`_
* `Kdenlive <https://kdenlive.org/en/>`_
* `Sphinx <https://www.sphinx-doc.org/en/master/>`_
* `Read The Docs <https://readthedocs.org/>`_
* `Roboto Font <https://fonts.google.com/specimen/Roboto#about>`_
* `Material Design Icons <https://github.com/google/material-design-icons>`_
* `Wordpress <https://wordpress.com/>`_
* `SiteOrigin <https://siteorigin.com/>`_
* `phpList <https://www.phplist.org/>`_
* `GNU Privacy Guard <https://gnupg.org/>`_
* `QubesOS <https://www.qubes-os.org/>`_
* `TAILS <https://tails.boum.org/install/index.en.html>`_
* `Debian <https://www.debian.org/>`_ `GNU <http://www.gnu.org/>`_/`Linux <https://www.kernel.org/>`_

Similar Projects
----------------

The reader may be interested to investigate the following similar projects:

* `USB Kill <https://github.com/hephaest0s/usbkill>`_
* `USB Death <https://github.com/trpt/usbdeath>`_
* `Silk Guardian <https://github.com/NateBrune/silk-guardian>`_
* `Day Tripper <https://github.com/dekuNukem/daytripper>`_
* `USBGuard <https://usbguard.github.io/>`_
* `suicideCrypt <https://github.com/MonolithInd/suicideCrypt>`_
* `panic_bcast <https://github.com/qnrq/panic_bcast>`_
* `Nuke My LUKS <https://github.com/juliocesarfort/nukemyluks>`_
* `luksAddNuke <http://lxer.com/module/newswire/view/103692/index.html>`_
* `cryptsetup-nuke-keys <https://gitlab.com/kalilinux/packages/cryptsetup-nuke-keys>`_
* `TAILS Memory Erasure <https://tails.boum.org/contribute/design/memory_erasure/>`_
* `TEDD (Transparent Emergency Data Destruction) <https://bitbucket.org/ausiv4/tedd/src/default/>`_
* `s53 <https://github.com/BrassHornCommunications/s53>`_
* `swatd <https://github.com/defuse/swatd>`_
* `Centry <https://github.com/0xPoly/Centry>`_
* `PanicKit <https://guardianproject.info/code/panickit/>`_ & `Ripple <https://guardianproject.info/apps/info.guardianproject.ripple/>`_
* `Duress <https://github.com/x13a/Duress>`_
* `Wasted <https://github.com/x13a/Wasted>`_
* `xxUSBSentinel <https://github.com/thereisnotime/xxUSBSentinel>`_
* `lockup <https://github.com/levlesec/lockup>`_
* `pam_duress <https://github.com/rafket/pam_duress>`_
* `pam_panic <https://github.com/pampanic/pam_panic>`_
* `pam_party <https://github.com/x13a/pam-party>`_
* `AirWatch <https://vandersecurity.com/airwatch>`_
* `swiftGuard <https://github.com/Lennolium/swiftGuard>`_
6 changes: 6 additions & 0 deletions buskill-app/en/dev/_sources/changelog.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _changelog:

Changelog
===========

.. literalinclude:: ../CHANGELOG
78 changes: 78 additions & 0 deletions buskill-app/en/dev/_sources/contributing.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
.. _contributing:

Contributing
================

Thank you for considering to help with the development of BusKill!

As an open-source project, we depend on the work of volunteers to stay alive, and your time helping to improve our project is very much appreciated :)

.. _wishlist:

Wish List
---------

Below is a list of items on our TODO list. If you'd like to help us tackle these tasks, please `contact us <https://buskill.in/contact/>`_ as there may be someone already working on a given task that you may be able to collaborate with.

Please be aware that any contributions you make will be made open-source. See :ref:`license` for more info.

.. _wishlist_software:

Software
^^^^^^^^

Here's some items on our wish list that you can help contribute to:

#. Translating our app and this documentation to another language
#. Testing our app on many :ref:`supported_platforms`
#. Writing new auxillary triggers, such as

a. A self-destruct trigger for `Veracrypt <https://github.com/BusKill/veracrypt-self-destruct>`_
b. A self-destruct trigger for `BitLocker <https://en.wikipedia.org/wiki/BitLocker>`_
c. A self-destruct trigger for `FileVault <https://en.wikipedia.org/wiki/FileVault>`_

#. `Fix PyInstaller <https://github.com/pyinstaller/pyinstaller/issues/4972>`_ to support `reproducible builds <https://github.com/BusKill/buskill-app/issues/3>`_ on MacOS and Windows

#. Port BusKill to Android

#. Port BusKill to iOS

#. Update appimagetool to `include squashfs-tools v4.4 <https://github.com/AppImage/AppImageKit/issues/929>`_

#. Create a video extension in sphinx that has a `graceful fallback on PDF <https://github.com/brechtm/rinohtype/issues/172>`_ and `printing to paper <https://stackoverflow.com/questions/62682412/video-fall-back-when-printing-to-paper-with-read-the-docs>`_

#. Create a `spreadsheet extension in sphinx <https://stackoverflow.com/questions/62682095/how-to-add-a-spreadsheet-in-read-the-docs>`_ that converts LibreOffice Calc documents (with formulas in them) into csv format (using ``localc``) at build-time for creating `BOM <https://en.wikipedia.org/wiki/Bill_of_materials>`_ tables in reST documents.

#. Create a sphinx `part library <https://wiki.opensourceecology.org/wiki/Hydraulic_Fitting_Library>`_ extension that does for .stl and `FreeCAD <https://www.freecadweb.org/>`_ files what `autodoc <https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html>`_ does `for .py files <https://medium.com/@eikonomega/getting-started-with-sphinx-autodoc-part-1-2cebbbca5365#011c>`_.

.. _wishlist_hardware:

Hardware
^^^^^^^^

#. Open-source USB magnetic disconnect (`.stl <https://en.wikipedia.org/wiki/3D_printing>`_ file, `BOM <https://en.wikipedia.org/wiki/Bill_of_materials>`_ w/ link to USB components/magnets/`pogo <https://en.wikipedia.org/wiki/Pogo_pin>`_ connector, build instructions, etc)

#. A simple-as-possible open-source USB peripheral that can send `USB hotplug events <http://libusb.sourceforge.net/api-1.0/group__libusb__hotplug.html#ga00e0c69ddf1fb1b6774dc918192e8dc7>`_ but doesn't have the ability to send data to the machine, including a low-tech guide to `verify the integrity <https://www.bunniestudios.com/blog/?p=5706>`_ of the device.

.. _donate:

Donate
------

Running the BusKill project has many fees, including

#. Server & domain infrastructure fees
#. Code Signing Keys fees
#. Developer account fees (ie: Apple)

If you have more money than free time, you can also help BusKill by making a donation. We accept Bitcoin and Monero.

::

BTC 1DXyJpmu2KQMw2v4QJVzzjZo6f87BBndu6

XMR 4B5ra5N1SN4d7BqDtkxAE5G5kGNz5mA5oCob41RzzoduM1uPAcr7QmNLzXtci5HvtkNXC7SowkxMjUUCXF2hm57MMS4jwkx

You can also make a one-time or recurring monthly donation via fiat (eg credit card) on our `Open Collective page <https://opencollective.com/buskill>`_.

Donations of any amount are **greatly** appreciated. Thank you!
107 changes: 107 additions & 0 deletions buskill-app/en/dev/_sources/faq.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
.. _faq:

Frequently Asked Questions
==========================

.. _faq_triggers:

Q: What is BusKill?
-------------------

BusKill is the world's first laptop `kill cord <https://en.wikipedia.org/wiki/Kill_cord>`_. It's a hardware `Dead Man's Switch <https://en.wikipedia.org/wiki/Dead_man%27s_switch>`_ that can trigger your laptop to lock, shutdown, or self-destruct if your machine is physically separated from you.

For a more detailed explanation on what BusKill is and who it's designed for, see :ref:`what`

.. _faq_buy:

Q: Where can I **buy** a BusKill cable?
---------------------------------------

You can `purchase a BusKill cable <https://buskill.in/buy>`_ from our website.

Q: What actions can I trigger with BusKill?
-------------------------------------------

Anything scriptable! Currently the BusKill App supports locking your screen and shutting down your computer.

.. _faq_selfdestruct:

Q: Self-destruct?!? Will this brick my computer?
------------------------------------------------

No. Advanced users can add triggers that wipe RAM and encryption keys. This self-destruct sequence will make all of the data previously stored on a machine with Full Disk Encryption permanently useless. Note that this "self-destruct" sequence destroys the data only, not the hardware.

**This self-destruct trigger is not included in BusKill by default.** So for most users, the worst that can happen is your machine powers off. No data loss. No fried hardware.

.. _faq_false_positives:

Q: What about false-positives?
--------------------------------------------------------------------------------------------
BusKill's breakaway connector uses strong magnets that decreases the risk of false-positives.

That said, it *is* designed to breakaway, so if you accidentally trigger BusKill (by, say, standing up to get a cup of coffee without disarming BusKill), then the worst that can happen (if you're using the BusKill app without manually adding ``auxilary triggers``) is that your computer will shutdown.

Here's some tips to avoid false-positives:

#. When using BusKill, work on a sturdy table with a comfortable chair.
#. Avoid moving your laptop after arming BusKill in the app.
#. The first few days, limit yourself to just the ``lock screen`` trigger to avoid loosing your work as you get used to disarming BusKill before taking toilet breaks.

See also :ref:`faq_bluetooth`

.. _faq_interdiction:

Q: What about interdiction?
--------------------------------------------------------------------------------------------

Unfettered physical access can defeat most security, and installation of malicious software or hardware implants is a real risk for shipping.

We don't consider hologram stickers or tamper-evident tape/crisps/glitter to be sufficient solutions to supply-chain security. Rather, the solution to these attacks is to build open-source, disassembleable, and easily inspectable hardware whose integrity can be validated without damaging the device and without sophisticated technology.

Fortunately, the requirements for BusKill's hardware components are simple, making integrity verification relatively easy.

If you'd like to help BusKill make our open-source cable more resistant to interdiction attacks, please `contact us <https://buskill.in/contact/>`_ about designing :ref:`verifiable hardware components <wishlist_hardware>`.

.. _faq_clone:

Q: Could an attacker clone my BusKill drive and quickly insert it before stealing my laptop?
--------------------------------------------------------------------------------------------
No. Even if an exact replica was inserted, BusKill will still be triggered if it's disconnected.

.. _faq_2fa:

Q: But I'm using 2FA and my OS has FDE with AES 256 and a 20-word passphrase.
-----------------------------------------------------------------------------

That's good! But it won't protect you if a thief snatch-and-runs with your laptop *after* you've authenticated.

The only way to defend against this sort of attack is by using a Dead Man Switch to detect that you've been replaced at the helm, such as BusKill.

.. _faq_bluetooth:

Q: But bluetooth...
-------------------

Using a radio-based Dead Man Switch introduces complexity, delays, and an increased vector of attack. BusKill is a simple hardware kill cord and is therefore more secure than any wireless solution.

.. _faq_follow:


Q: How can I get updates about BusKill?
---------------------------------------

You can `signup for our BusKill email newsletter <https://www.buskill.in/#newsletter>`_ or follow us on any of the following social media profiles:

* Twitter `@BusKillin <https://twitter.com/buskillin>`_
* Facebook `@BusKill.in <https://www.facebook.com/BusKill.in/>`_
* Mastodon `[email protected] <https://mastodon.social/@BusKillin>`_
* GitHub `BusKill <https://github.com/BusKill>`_
* YouTube `BusKill <https://www.youtube.com/channel/UC5Njxb027m2OmrocrH33oew/about>`_

.. _faq_support:

Q: My questions isn't listed. Where can I get support?
------------------------------------------------------

Please see :ref:`support`

46 changes: 46 additions & 0 deletions buskill-app/en/dev/_sources/hardware_dev/assembly.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
.. _hardware_assembly:

Assembly of components
======================

This section will describe how to assemble the hardware BusKill cable prior to using it.

For information on how to use the BusKill cable, see :ref:`hardware_usr`

.. image:: /images/buskill_assemble3.gif
:alt: image shows the assembly of the BusKill cable
:align: center

Step 1: Attach carabiner to USB drive
-------------------------------------

First, connect the carabiner (clip) to the USB drive.

.. figure:: /images/buskill_cable_assembly1.jpg
:alt: image of carabiner being connected to USB drive
:align: center

Step 1: Attach Carabiner to USB drive

Step 2: Plug USB drive into cable
---------------------------------

Next, plug the USB drive into the female end of the USB extension cable.

.. figure:: /images/buskill_cable_assembly2.jpg
:alt: image of USB drive being plugged-into USB extension cable
:align: center

Step 2: Plug-in the USB drive into the USB extension cable

Step 3: Plug USB cable into magnetic breakaway
----------------------------------------------

Finally, plug the the male end of the USB extension cable into the USB magnetic breakaway adapter.

.. figure:: /images/buskill_cable_assembly3.jpg
:alt: image of USB cable being plugged-into magnetic breakaway
:align: center

Step 2: Plug-in the USB extension cable into the magnetic breakaway

Loading

0 comments on commit bae411c

Please sign in to comment.