\OCP\Encryption\KeysIStorage

Interface IStorage

Summary

Methods
Constants
getUserKey()
getFileKey()
getSystemUserKey()
setUserKey()
setFileKey()
setSystemUserKey()
deleteUserKey()
deleteFileKey()
deleteAllFileKeys()
deleteSystemUserKey()
renameKeys()
copyKeys()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

getUserKey()

getUserKey(string  $uid, string  $keyId, string  $encryptionModuleId) : mixed

get user specific key

Parameters

string $uid

ID if the user for whom we want the key

string $keyId

id of the key

string $encryptionModuleId

Returns

mixed —

key

getFileKey()

getFileKey(string  $path, string  $keyId, string  $encryptionModuleId) : mixed

get file specific key

Parameters

string $path

path to file

string $keyId

id of the key

string $encryptionModuleId

Returns

mixed —

key

getSystemUserKey()

getSystemUserKey(string  $keyId, string  $encryptionModuleId) : mixed

get system-wide encryption keys not related to a specific user, e.g something like a key for public link shares

Parameters

string $keyId

id of the key

string $encryptionModuleId

Returns

mixed —

key

setUserKey()

setUserKey(string  $uid, string  $keyId, mixed  $key, string  $encryptionModuleId) 

set user specific key

Parameters

string $uid

ID if the user for whom we want the key

string $keyId

id of the key

mixed $key
string $encryptionModuleId

setFileKey()

setFileKey(string  $path, string  $keyId, mixed  $key, string  $encryptionModuleId) 

set file specific key

Parameters

string $path

path to file

string $keyId

id of the key

mixed $key
string $encryptionModuleId

setSystemUserKey()

setSystemUserKey(string  $keyId, mixed  $key, string  $encryptionModuleId) : mixed

set system-wide encryption keys not related to a specific user, e.g something like a key for public link shares

Parameters

string $keyId

id of the key

mixed $key
string $encryptionModuleId

Returns

mixed —

key

deleteUserKey()

deleteUserKey(string  $uid, string  $keyId, string  $encryptionModuleId) : boolean

delete user specific key

Parameters

string $uid

ID if the user for whom we want to delete the key

string $keyId

id of the key

string $encryptionModuleId

Returns

boolean —

False when the key could not be deleted

deleteFileKey()

deleteFileKey(string  $path, string  $keyId, string  $encryptionModuleId) : boolean

delete file specific key

Parameters

string $path

path to file

string $keyId

id of the key

string $encryptionModuleId

Returns

boolean —

False when the key could not be deleted

deleteAllFileKeys()

deleteAllFileKeys(string  $path) : boolean

delete all file keys for a given file

Parameters

string $path

to the file

Returns

boolean —

False when the keys could not be deleted

deleteSystemUserKey()

deleteSystemUserKey(string  $keyId, string  $encryptionModuleId) : boolean

delete system-wide encryption keys not related to a specific user, e.g something like a key for public link shares

Parameters

string $keyId

id of the key

string $encryptionModuleId

Returns

boolean —

False when the key could not be deleted

renameKeys()

renameKeys(string  $source, string  $target) : boolean

copy keys if a file was renamed

Parameters

string $source
string $target

Returns

boolean

copyKeys()

copyKeys(string  $source, string  $target) : boolean

move keys if a file was renamed

Parameters

string $source
string $target

Returns

boolean