Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rocodes authored and legoktm committed Dec 14, 2023
1 parent 22e1157 commit c6f871c
Showing 1 changed file with 16 additions and 19 deletions.
35 changes: 16 additions & 19 deletions export/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,6 @@ Metadata contains three possible keys which may contain several possible values:
`device`
: specifies the method used for export, and can be either a device or a preflight check. See the Devices section below for possible values. It is a required key.

`encryption_method`
: used exclusively when exporting to USB storage. It is an optional key. Possible values are:
luks

`encryption_passphrase`
: used exclusively when exporting to USB storage. It is an optional key. It contains an arbitrary string that contains the disk encryption passphrase of the device.
Expand All @@ -72,7 +69,6 @@ Example archive metadata (`metadata.json`):
```
{
"device": "disk"
"encryption-method": "luks"
"encryption-key": "Your encryption passphrase goes here"
}
```
Expand All @@ -90,34 +86,34 @@ For all device types (described in detail below), the following standard error t

The supported device types for export are as follows, including the possible errors specific to that device type:

1. `usb-test` : Preflight check that probes for USB connected devices, that returns:
- `USB_CONNECTED` if a USB device is attached to the dedicated slot
- `USB_NOT_CONNECTED` if no USB is attached
- `USB_CHECK_ERROR` if an error occurred during pre-flight
1. `disk-test` : Preflight check that probes for USB connected devices, that returns:
- `DEVICE_WRITABLE` if a supported USB device is attached and unlocked
- `DEVICE_LOCKED` if a supported drive is inserted but locked (a LUKS drive, since locked Veracrypt detection is not supported)
- `NO_DEVICE_DETECTED`, `MULTI_DEVICE_DETECTED`: wrong number of inserted USB drives
- `INVALID_DEVICE_DETECTED`: Wrong number of partitions, unsupported encryption scheme, etc
- `UNKNOWN_DEVICE_DETECTED`: (Future use) this is what a locked drive that could be Veracrypt would return
- `DEVICE_ERROR`: A problem was encountered and device state cannot be reported.

2. `disk-test`: Preflight check that checks for LUKS-encrypted volume that returns:
- `USB_ENCRYPTED` if a LUKS volume is attached to sd-devices
- `USB_ENCRYPTION_NOT_SUPPORTED` if a LUKS volume is not attached or there was any other error
- `USB_DISK_ERROR`

3. `printer-test`: prints a test page that returns:
2. `printer-test`: prints a test page that returns:
- `ERROR_PRINTER_NOT_FOUND` if no printer is connected
- `ERROR_PRINTER_NOT_SUPPORTED` if the printer is not currently supported by the export script
- `ERROR_PRINTER_DRIVER_UNAVAILABLE` if the printer driver is not available
- `ERROR_PRINTER_INSTALL` If there is an error installing the printer
- `ERROR_PRINT` if there is an error printing

4. `printer`: sends files to printer that returns:
3. `printer`: sends files to printer that returns:
- `ERROR_PRINTER_NOT_FOUND` if no printer is connected
- `ERROR_PRINTER_NOT_SUPPORTED` if the printer is not currently supported by the export script
- `ERROR_PRINTER_DRIVER_UNAVAILABLE` if the printer driver is not available
- `ERROR_PRINTER_INSTALL` If there is an error installing the printer
- `ERROR_PRINT` if there is an error printing

5. `disk`: sends files to disk that returns:
- `USB_BAD_PASSPHRASE` if the luks decryption failed (likely due to bad passphrase)
- `ERROR_USB_MOUNT` if there was an error mounting the volume (after unlocking the luks volume)
- `ERROR_USB_WRITE` if there was an error writing to disk (e.g., no space left on device)
4. `disk`: sends files to disk that returns:
- `SUCCESS_EXPORT`: Successful
- `ERROR_CLEANUP`: Export was successful but files could not be cleaned up or drive was not properly unmounted
- `ERROR_UNLOCK_LUKS` if the luks decryption failed (likely due to bad passphrase)
- `ERROR_MOUNT` if there was an error mounting the volume (after unlocking the luks volume)
- `ERROR_WRITE` if there was an error writing to disk (e.g., no space left on device)

### Export Folder Structure

Expand All @@ -128,6 +124,7 @@ When exporting to a USB drive, the files will be placed on the drive as follows:
└── sd-export-20200116-003153
└── export_data
└── transcript.txt
└── secret_memo.pdf
```

Expand Down

0 comments on commit c6f871c

Please sign in to comment.