IStorage
Interface IStorage
Tags
Table of Contents
- backupUserKeys() : bool
- backup keys of a given encryption module
- copyKeys() : bool
- move keys if a file was renamed
- deleteAllFileKeys() : bool
- delete all file keys for a given file
- deleteFileKey() : bool
- delete file specific key
- deleteSystemUserKey() : bool
- delete system-wide encryption keys not related to a specific user, e.g something like a key for public link shares
- deleteUserKey() : bool
- delete user specific key
- getFileKey() : mixed
- get file specific key
- getSystemUserKey() : mixed
- get system-wide encryption keys not related to a specific user, e.g something like a key for public link shares
- getUserKey() : mixed
- get user specific key
- renameKeys() : bool
- copy keys if a file was renamed
- setFileKey() : mixed
- set file specific key
- setSystemUserKey() : mixed
- set system-wide encryption keys not related to a specific user, e.g something like a key for public link shares
- setUserKey() : mixed
- set user specific key
Methods
backupUserKeys()
backup keys of a given encryption module
public
backupUserKeys(string $encryptionModuleId, string $purpose, string $uid) : bool
Parameters
- $encryptionModuleId : string
- $purpose : string
- $uid : string
Tags
Return values
bool —copyKeys()
move keys if a file was renamed
public
copyKeys(string $source, string $target) : bool
Parameters
- $source : string
- $target : string
Tags
Return values
bool —deleteAllFileKeys()
delete all file keys for a given file
public
deleteAllFileKeys(string $path) : bool
Parameters
- $path : string
-
to the file
Tags
Return values
bool —False when the keys could not be deleted
deleteFileKey()
delete file specific key
public
deleteFileKey(string $path, string $keyId, string $encryptionModuleId) : bool
Parameters
- $path : string
-
path to file
- $keyId : string
-
id of the key
- $encryptionModuleId : string
Tags
Return values
bool —False when the key could not be deleted
deleteSystemUserKey()
delete system-wide encryption keys not related to a specific user, e.g something like a key for public link shares
public
deleteSystemUserKey(string $keyId, string $encryptionModuleId) : bool
Parameters
- $keyId : string
-
id of the key
- $encryptionModuleId : string
Tags
Return values
bool —False when the key could not be deleted
deleteUserKey()
delete user specific key
public
deleteUserKey(string $uid, string $keyId, string $encryptionModuleId) : bool
Parameters
- $uid : string
-
ID if the user for whom we want to delete the key
- $keyId : string
-
id of the key
- $encryptionModuleId : string
Tags
Return values
bool —False when the key could not be deleted
getFileKey()
get file specific key
public
getFileKey(string $path, string $keyId, string $encryptionModuleId) : mixed
Parameters
- $path : string
-
path to file
- $keyId : string
-
id of the key
- $encryptionModuleId : string
Tags
Return values
mixed —key
getSystemUserKey()
get system-wide encryption keys not related to a specific user, e.g something like a key for public link shares
public
getSystemUserKey(string $keyId, string $encryptionModuleId) : mixed
Parameters
- $keyId : string
-
id of the key
- $encryptionModuleId : string
Tags
Return values
mixed —key
getUserKey()
get user specific key
public
getUserKey(string $uid, string $keyId, string $encryptionModuleId) : mixed
Parameters
- $uid : string
-
ID if the user for whom we want the key
- $keyId : string
-
id of the key
- $encryptionModuleId : string
Tags
Return values
mixed —key
renameKeys()
copy keys if a file was renamed
public
renameKeys(string $source, string $target) : bool
Parameters
- $source : string
- $target : string
Tags
Return values
bool —setFileKey()
set file specific key
public
setFileKey(string $path, string $keyId, mixed $key, string $encryptionModuleId) : mixed
Parameters
- $path : string
-
path to file
- $keyId : string
-
id of the key
- $key : mixed
- $encryptionModuleId : string
Tags
Return values
mixed —setSystemUserKey()
set system-wide encryption keys not related to a specific user, e.g something like a key for public link shares
public
setSystemUserKey(string $keyId, mixed $key, string $encryptionModuleId) : mixed
Parameters
- $keyId : string
-
id of the key
- $key : mixed
- $encryptionModuleId : string
Tags
Return values
mixed —key
setUserKey()
set user specific key
public
setUserKey(string $uid, string $keyId, mixed $key, string $encryptionModuleId) : mixed
Parameters
- $uid : string
-
ID if the user for whom we want the key
- $keyId : string
-
id of the key
- $key : mixed
- $encryptionModuleId : string