| John Wedig | 2098dab | 2021-09-14 13:56:28 -0700 | [diff] [blame^] | 1 | description: > |
| 2 | D-bus interface to manage an encrypted storage device. |
| 3 | |
| 4 | methods: |
| 5 | - name: Format |
| 6 | description: > |
| 7 | Format the encrypted device and create an ext4 filesystem. |
| 8 | parameters: |
| 9 | - name: Password |
| 10 | type: array[byte] |
| 11 | description: > |
| 12 | Array of bytes to use as the LUKS password. |
| 13 | errors: |
| 14 | - self.Error.EncryptionError |
| 15 | - self.Error.FilesystemError |
| 16 | |
| 17 | - name: Erase |
| 18 | description: > |
| 19 | Erase the contents of the device. |
| 20 | parameters: |
| 21 | - name: Password |
| 22 | type: array[byte] |
| 23 | description: > |
| 24 | Array of bytes to use as the LUKS password. |
| 25 | - name: EraseType |
| 26 | type: enum[self.EraseMethod] |
| 27 | description: > |
| 28 | Describes what type of erase is done. |
| 29 | errors: |
| 30 | - self.Error.EncryptionError |
| 31 | - self.Error.EraseError |
| 32 | - self.Error.FilesystemError |
| 33 | |
| 34 | - name: Lock |
| 35 | description: > |
| 36 | Unmount the filesystem, lock the device, and remove sensitive data |
| 37 | (e.g. volume key) from memory. |
| 38 | parameters: |
| 39 | - name: Password |
| 40 | type: array[byte] |
| 41 | description: > |
| 42 | Array of bytes to use as the LUKS password. |
| 43 | errors: |
| 44 | - self.Error.EncryptionError |
| 45 | - self.Error.FilesystemError |
| 46 | |
| 47 | - name: Unlock |
| 48 | description: > |
| 49 | Activate the device and mount the filesystem. |
| 50 | parameters: |
| 51 | - name: Password |
| 52 | type: array[byte] |
| 53 | description: > |
| 54 | Array of bytes to use as the LUKS password. |
| 55 | errors: |
| 56 | - self.Error.EncryptionError |
| 57 | - self.Error.FilesystemError |
| 58 | |
| 59 | - name: ChangePassword |
| 60 | description: > |
| 61 | Change the password that unlocks the storage device. |
| 62 | parameters: |
| 63 | - name: OldPassword |
| 64 | type: array[byte] |
| 65 | description: > |
| 66 | Array of bytes for the old LUKS password. |
| 67 | - name: NewPassword |
| 68 | type: array[byte] |
| 69 | description: > |
| 70 | Array of bytes to use as the LUKS password. |
| 71 | errors: |
| 72 | - self.Error.EncryptionError |
| 73 | |
| 74 | properties: |
| 75 | - name: Locked |
| 76 | type: boolean |
| 77 | default: false |
| 78 | description: > |
| 79 | Indicates whether the device is locked. |
| 80 | |
| 81 | enumerations: |
| 82 | - name: EraseMethod |
| 83 | description: > |
| 84 | Indicates which erase method/step is being requested. |
| 85 | values: |
| 86 | - name: CryptoErase |
| 87 | description: > |
| 88 | Destroys the encryption key slots, preventing decyrption. |
| 89 | - name: VerifyGeometry |
| 90 | description: > |
| 91 | Confirms a set percent of the disk is accessible. |
| 92 | - name: LogicalOverWrite |
| 93 | description: > |
| 94 | Overwrites the disk with a reproducible incompressible pattern. |
| 95 | - name: LogicalVerify |
| 96 | description: > |
| 97 | Verifies a reproducible pattern has been written to the disk. |
| 98 | - name: VendorSanitize |
| 99 | description: > |
| 100 | Uses the sanitization provided by the device firmware. |
| 101 | - name: ZeroOverWrite |
| 102 | description: > |
| 103 | Writes zeros over the whole disk. |
| 104 | - name: ZeroVerify |
| 105 | description: > |
| 106 | Verifies the the entire disk has been zeroed. |
| 107 | - name: SecuredLocked |
| 108 | description: > |
| 109 | Locks the disk to prevent data being written to it. |
| 110 | |