blob: 9a12e4015935929007ed432951e7b82482f32993 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
<?php
/**
* ownCloud - manage encryption modules
*
* @copyright (C) 2015 ownCloud, Inc.
*
* @author Bjoern Schiessle <schiessle@owncloud.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
namespace OCP\Encryption;
//
// TODO: move exceptions to OCP
//
use OC\Encryption\Exceptions\ModuleDoesNotExistsException;
use OC\Encryption\Exceptions\ModuleAlreadyExistsException;
/**
* This class provides access to files encryption apps.
*
*/
interface IManager {
/**
* Check if encryption is available (at least one encryption module needs to be enabled)
*
* @return bool true if enabled, false if not
*/
function isEnabled();
/**
* Registers an encryption module
*
* @param IEncryptionModule $module
* @throws ModuleAlreadyExistsException
*/
function registerEncryptionModule(IEncryptionModule $module);
/**
* Unregisters an encryption module
*
* @param IEncryptionModule $module
*/
function unregisterEncryptionModule(IEncryptionModule $module);
/**
* get a list of all encryption modules
*
* @return array
*/
function getEncryptionModules();
/**
* get a specific encryption module
*
* @param string $moduleId
* @return IEncryptionModule
* @throws ModuleDoesNotExistsException
*/
function getEncryptionModule($moduleId);
/**
* get default encryption module
*
* @return \OCP\Encryption\IEncryptionModule
* @throws Exceptions\ModuleDoesNotExistsException
*/
public function getDefaultEncryptionModule();
/**
* set default encryption module Id
*
* @param string $moduleId
* @return string
*/
public function setDefaultEncryptionModule($moduleId);
}
|
