| Top |  |  |  |  | 
| org.freedesktop.UDisks2.Encryptedorg.freedesktop.UDisks2.Encrypted — Block device containing encrypted data | 
Unlock (IN s passphrase, IN a{sv} options, OUT o cleartext_device); Lock (IN a{sv} options); ChangePassphrase (IN s passphrase, IN s new_passphrase, IN a{sv} options);
This interface is used for org.freedesktop.UDisks2.Block devices that contain encrypted data.
Unlock (IN  s     passphrase,
        IN  a{sv} options,
        OUT o     cleartext_device);
        Tries to unlock the encrypted device using passphrase.
        If the device in question is referenced in a system-wide
        configuration file (such as the /etc/crypttab file),
        then name, options and passphrase (if available) is used from that
        file after requesting additional authorization.
        If an empty passphrase should be used to unlock the device, it has to be
        passed using the keyfile_contents parameter. Empty string passed as
        passphrase means "Use the passphrase from the configuration file".
If the device is removed without being locked (e.g. the user yanking the device or pulling the media out) the cleartext device will be cleaned up.
| 
 | The passphrase to use. | 
| 
 | Options - known options (in addition to standard options) includes  | 
| 
 | An object path to the unlocked object implementing the org.freedesktop.UDisks2.Block interface. | 
Lock (IN  a{sv} options);
Locks the encrypted device.
| 
 | Options (currently unused except for standard options). | 
ChangePassphrase (IN  s     passphrase,
                  IN  s     new_passphrase,
                  IN  a{sv} options);
        Changes the passphrase to new_passphrase. An existing passphrase is required.
        If old_keyfile_contents or
        new_keyfile_contents are given, they take
        precedence over the corresponding passphrase parameters individually.
        If the device in question is referenced in a system-wide
        configuration file (such as the
        /etc/crypttab file) and this
        configuration references the passphrase, it is not
        automatically updated.
| 
 | The existing passphrase. | 
| 
 | The new passphrase to use. | 
| 
 | Options - known options (in addition to standard options) includes  | 
ChildConfiguration  readable   a(sa{sv})
Configuration items belonging to the
clear text device of this encrypted block device and its children. This is also valid when this block device is currently locked and there is no clear text device for it. It works via the 'track-parents' options of AddConfigurationItem(), which see.