@@ -24,10 +24,10 @@ |
||
24 | 24 | |
25 | 25 | |
26 | 26 | interface IHook { |
27 | - /** |
|
28 | - * Connects Hooks |
|
29 | - * |
|
30 | - * @return null |
|
31 | - */ |
|
32 | - public function addHooks(); |
|
27 | + /** |
|
28 | + * Connects Hooks |
|
29 | + * |
|
30 | + * @return null |
|
31 | + */ |
|
32 | + public function addHooks(); |
|
33 | 33 | } |
@@ -38,90 +38,90 @@ |
||
38 | 38 | |
39 | 39 | class Admin implements ISettings { |
40 | 40 | |
41 | - /** @var IL10N */ |
|
42 | - private $l; |
|
43 | - |
|
44 | - /** @var ILogger */ |
|
45 | - private $logger; |
|
46 | - |
|
47 | - /** @var IUserSession */ |
|
48 | - private $userSession; |
|
49 | - |
|
50 | - /** @var IConfig */ |
|
51 | - private $config; |
|
52 | - |
|
53 | - /** @var IUserManager */ |
|
54 | - private $userManager; |
|
55 | - |
|
56 | - /** @var ISession */ |
|
57 | - private $session; |
|
58 | - |
|
59 | - public function __construct( |
|
60 | - IL10N $l, |
|
61 | - ILogger $logger, |
|
62 | - IUserSession $userSession, |
|
63 | - IConfig $config, |
|
64 | - IUserManager $userManager, |
|
65 | - ISession $session |
|
66 | - ) { |
|
67 | - $this->l = $l; |
|
68 | - $this->logger = $logger; |
|
69 | - $this->userSession = $userSession; |
|
70 | - $this->config = $config; |
|
71 | - $this->userManager = $userManager; |
|
72 | - $this->session = $session; |
|
73 | - } |
|
74 | - |
|
75 | - /** |
|
76 | - * @return TemplateResponse |
|
77 | - */ |
|
78 | - public function getForm() { |
|
79 | - $crypt = new Crypt( |
|
80 | - $this->logger, |
|
81 | - $this->userSession, |
|
82 | - $this->config, |
|
83 | - $this->l); |
|
84 | - |
|
85 | - $util = new Util( |
|
86 | - new View(), |
|
87 | - $crypt, |
|
88 | - $this->logger, |
|
89 | - $this->userSession, |
|
90 | - $this->config, |
|
91 | - $this->userManager); |
|
92 | - |
|
93 | - // Check if an adminRecovery account is enabled for recovering files after lost pwd |
|
94 | - $recoveryAdminEnabled = $this->config->getAppValue('encryption', 'recoveryAdminEnabled', '0'); |
|
95 | - $session = new Session($this->session); |
|
96 | - |
|
97 | - $encryptHomeStorage = $util->shouldEncryptHomeStorage(); |
|
98 | - |
|
99 | - $parameters = [ |
|
100 | - 'recoveryEnabled' => $recoveryAdminEnabled, |
|
101 | - 'initStatus' => $session->getStatus(), |
|
102 | - 'encryptHomeStorage' => $encryptHomeStorage, |
|
103 | - 'masterKeyEnabled' => $util->isMasterKeyEnabled(), |
|
104 | - ]; |
|
105 | - |
|
106 | - return new TemplateResponse('encryption', 'settings-admin', $parameters, ''); |
|
107 | - } |
|
108 | - |
|
109 | - /** |
|
110 | - * @return string the section ID, e.g. 'sharing' |
|
111 | - */ |
|
112 | - public function getSection() { |
|
113 | - return 'encryption'; |
|
114 | - } |
|
115 | - |
|
116 | - /** |
|
117 | - * @return int whether the form should be rather on the top or bottom of |
|
118 | - * the admin section. The forms are arranged in ascending order of the |
|
119 | - * priority values. It is required to return a value between 0 and 100. |
|
120 | - * |
|
121 | - * E.g.: 70 |
|
122 | - */ |
|
123 | - public function getPriority() { |
|
124 | - return 5; |
|
125 | - } |
|
41 | + /** @var IL10N */ |
|
42 | + private $l; |
|
43 | + |
|
44 | + /** @var ILogger */ |
|
45 | + private $logger; |
|
46 | + |
|
47 | + /** @var IUserSession */ |
|
48 | + private $userSession; |
|
49 | + |
|
50 | + /** @var IConfig */ |
|
51 | + private $config; |
|
52 | + |
|
53 | + /** @var IUserManager */ |
|
54 | + private $userManager; |
|
55 | + |
|
56 | + /** @var ISession */ |
|
57 | + private $session; |
|
58 | + |
|
59 | + public function __construct( |
|
60 | + IL10N $l, |
|
61 | + ILogger $logger, |
|
62 | + IUserSession $userSession, |
|
63 | + IConfig $config, |
|
64 | + IUserManager $userManager, |
|
65 | + ISession $session |
|
66 | + ) { |
|
67 | + $this->l = $l; |
|
68 | + $this->logger = $logger; |
|
69 | + $this->userSession = $userSession; |
|
70 | + $this->config = $config; |
|
71 | + $this->userManager = $userManager; |
|
72 | + $this->session = $session; |
|
73 | + } |
|
74 | + |
|
75 | + /** |
|
76 | + * @return TemplateResponse |
|
77 | + */ |
|
78 | + public function getForm() { |
|
79 | + $crypt = new Crypt( |
|
80 | + $this->logger, |
|
81 | + $this->userSession, |
|
82 | + $this->config, |
|
83 | + $this->l); |
|
84 | + |
|
85 | + $util = new Util( |
|
86 | + new View(), |
|
87 | + $crypt, |
|
88 | + $this->logger, |
|
89 | + $this->userSession, |
|
90 | + $this->config, |
|
91 | + $this->userManager); |
|
92 | + |
|
93 | + // Check if an adminRecovery account is enabled for recovering files after lost pwd |
|
94 | + $recoveryAdminEnabled = $this->config->getAppValue('encryption', 'recoveryAdminEnabled', '0'); |
|
95 | + $session = new Session($this->session); |
|
96 | + |
|
97 | + $encryptHomeStorage = $util->shouldEncryptHomeStorage(); |
|
98 | + |
|
99 | + $parameters = [ |
|
100 | + 'recoveryEnabled' => $recoveryAdminEnabled, |
|
101 | + 'initStatus' => $session->getStatus(), |
|
102 | + 'encryptHomeStorage' => $encryptHomeStorage, |
|
103 | + 'masterKeyEnabled' => $util->isMasterKeyEnabled(), |
|
104 | + ]; |
|
105 | + |
|
106 | + return new TemplateResponse('encryption', 'settings-admin', $parameters, ''); |
|
107 | + } |
|
108 | + |
|
109 | + /** |
|
110 | + * @return string the section ID, e.g. 'sharing' |
|
111 | + */ |
|
112 | + public function getSection() { |
|
113 | + return 'encryption'; |
|
114 | + } |
|
115 | + |
|
116 | + /** |
|
117 | + * @return int whether the form should be rather on the top or bottom of |
|
118 | + * the admin section. The forms are arranged in ascending order of the |
|
119 | + * priority values. It is required to return a value between 0 and 100. |
|
120 | + * |
|
121 | + * E.g.: 70 |
|
122 | + */ |
|
123 | + public function getPriority() { |
|
124 | + return 5; |
|
125 | + } |
|
126 | 126 | |
127 | 127 | } |
@@ -29,159 +29,159 @@ |
||
29 | 29 | |
30 | 30 | class Session { |
31 | 31 | |
32 | - /** @var ISession */ |
|
33 | - protected $session; |
|
34 | - |
|
35 | - const NOT_INITIALIZED = '0'; |
|
36 | - const INIT_EXECUTED = '1'; |
|
37 | - const INIT_SUCCESSFUL = '2'; |
|
38 | - const RUN_MIGRATION = '3'; |
|
39 | - |
|
40 | - /** |
|
41 | - * @param ISession $session |
|
42 | - */ |
|
43 | - public function __construct(ISession $session) { |
|
44 | - $this->session = $session; |
|
45 | - } |
|
46 | - |
|
47 | - /** |
|
48 | - * Sets status of encryption app |
|
49 | - * |
|
50 | - * @param string $status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED |
|
51 | - */ |
|
52 | - public function setStatus($status) { |
|
53 | - $this->session->set('encryptionInitialized', $status); |
|
54 | - } |
|
55 | - |
|
56 | - /** |
|
57 | - * Gets status if we already tried to initialize the encryption app |
|
58 | - * |
|
59 | - * @return string init status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED |
|
60 | - */ |
|
61 | - public function getStatus() { |
|
62 | - $status = $this->session->get('encryptionInitialized'); |
|
63 | - if (is_null($status)) { |
|
64 | - $status = self::NOT_INITIALIZED; |
|
65 | - } |
|
66 | - |
|
67 | - return $status; |
|
68 | - } |
|
69 | - |
|
70 | - /** |
|
71 | - * check if encryption was initialized successfully |
|
72 | - * |
|
73 | - * @return bool |
|
74 | - */ |
|
75 | - public function isReady() { |
|
76 | - $status = $this->getStatus(); |
|
77 | - return $status === self::INIT_SUCCESSFUL; |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * Gets user or public share private key from session |
|
82 | - * |
|
83 | - * @return string $privateKey The user's plaintext private key |
|
84 | - * @throws Exceptions\PrivateKeyMissingException |
|
85 | - */ |
|
86 | - public function getPrivateKey() { |
|
87 | - $key = $this->session->get('privateKey'); |
|
88 | - if (is_null($key)) { |
|
89 | - throw new Exceptions\PrivateKeyMissingException('please try to log-out and log-in again', 0); |
|
90 | - } |
|
91 | - return $key; |
|
92 | - } |
|
93 | - |
|
94 | - /** |
|
95 | - * check if private key is set |
|
96 | - * |
|
97 | - * @return boolean |
|
98 | - */ |
|
99 | - public function isPrivateKeySet() { |
|
100 | - $key = $this->session->get('privateKey'); |
|
101 | - if (is_null($key)) { |
|
102 | - return false; |
|
103 | - } |
|
104 | - |
|
105 | - return true; |
|
106 | - } |
|
107 | - |
|
108 | - /** |
|
109 | - * Sets user private key to session |
|
110 | - * |
|
111 | - * @param string $key users private key |
|
112 | - * |
|
113 | - * @note this should only be set on login |
|
114 | - */ |
|
115 | - public function setPrivateKey($key) { |
|
116 | - $this->session->set('privateKey', $key); |
|
117 | - } |
|
118 | - |
|
119 | - /** |
|
120 | - * store data needed for the decrypt all operation in the session |
|
121 | - * |
|
122 | - * @param string $user |
|
123 | - * @param string $key |
|
124 | - */ |
|
125 | - public function prepareDecryptAll($user, $key) { |
|
126 | - $this->session->set('decryptAll', true); |
|
127 | - $this->session->set('decryptAllKey', $key); |
|
128 | - $this->session->set('decryptAllUid', $user); |
|
129 | - } |
|
130 | - |
|
131 | - /** |
|
132 | - * check if we are in decrypt all mode |
|
133 | - * |
|
134 | - * @return bool |
|
135 | - */ |
|
136 | - public function decryptAllModeActivated() { |
|
137 | - $decryptAll = $this->session->get('decryptAll'); |
|
138 | - return ($decryptAll === true); |
|
139 | - } |
|
140 | - |
|
141 | - /** |
|
142 | - * get uid used for decrypt all operation |
|
143 | - * |
|
144 | - * @return string |
|
145 | - * @throws \Exception |
|
146 | - */ |
|
147 | - public function getDecryptAllUid() { |
|
148 | - $uid = $this->session->get('decryptAllUid'); |
|
149 | - if (is_null($uid) && $this->decryptAllModeActivated()) { |
|
150 | - throw new \Exception('No uid found while in decrypt all mode'); |
|
151 | - } elseif (is_null($uid)) { |
|
152 | - throw new \Exception('Please activate decrypt all mode first'); |
|
153 | - } |
|
154 | - |
|
155 | - return $uid; |
|
156 | - } |
|
157 | - |
|
158 | - /** |
|
159 | - * get private key for decrypt all operation |
|
160 | - * |
|
161 | - * @return string |
|
162 | - * @throws PrivateKeyMissingException |
|
163 | - */ |
|
164 | - public function getDecryptAllKey() { |
|
165 | - $privateKey = $this->session->get('decryptAllKey'); |
|
166 | - if (is_null($privateKey) && $this->decryptAllModeActivated()) { |
|
167 | - throw new PrivateKeyMissingException('No private key found while in decrypt all mode'); |
|
168 | - } elseif (is_null($privateKey)) { |
|
169 | - throw new PrivateKeyMissingException('Please activate decrypt all mode first'); |
|
170 | - } |
|
171 | - |
|
172 | - return $privateKey; |
|
173 | - } |
|
174 | - |
|
175 | - /** |
|
176 | - * remove keys from session |
|
177 | - */ |
|
178 | - public function clear() { |
|
179 | - $this->session->remove('publicSharePrivateKey'); |
|
180 | - $this->session->remove('privateKey'); |
|
181 | - $this->session->remove('encryptionInitialized'); |
|
182 | - $this->session->remove('decryptAll'); |
|
183 | - $this->session->remove('decryptAllKey'); |
|
184 | - $this->session->remove('decryptAllUid'); |
|
185 | - } |
|
32 | + /** @var ISession */ |
|
33 | + protected $session; |
|
34 | + |
|
35 | + const NOT_INITIALIZED = '0'; |
|
36 | + const INIT_EXECUTED = '1'; |
|
37 | + const INIT_SUCCESSFUL = '2'; |
|
38 | + const RUN_MIGRATION = '3'; |
|
39 | + |
|
40 | + /** |
|
41 | + * @param ISession $session |
|
42 | + */ |
|
43 | + public function __construct(ISession $session) { |
|
44 | + $this->session = $session; |
|
45 | + } |
|
46 | + |
|
47 | + /** |
|
48 | + * Sets status of encryption app |
|
49 | + * |
|
50 | + * @param string $status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED |
|
51 | + */ |
|
52 | + public function setStatus($status) { |
|
53 | + $this->session->set('encryptionInitialized', $status); |
|
54 | + } |
|
55 | + |
|
56 | + /** |
|
57 | + * Gets status if we already tried to initialize the encryption app |
|
58 | + * |
|
59 | + * @return string init status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED |
|
60 | + */ |
|
61 | + public function getStatus() { |
|
62 | + $status = $this->session->get('encryptionInitialized'); |
|
63 | + if (is_null($status)) { |
|
64 | + $status = self::NOT_INITIALIZED; |
|
65 | + } |
|
66 | + |
|
67 | + return $status; |
|
68 | + } |
|
69 | + |
|
70 | + /** |
|
71 | + * check if encryption was initialized successfully |
|
72 | + * |
|
73 | + * @return bool |
|
74 | + */ |
|
75 | + public function isReady() { |
|
76 | + $status = $this->getStatus(); |
|
77 | + return $status === self::INIT_SUCCESSFUL; |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * Gets user or public share private key from session |
|
82 | + * |
|
83 | + * @return string $privateKey The user's plaintext private key |
|
84 | + * @throws Exceptions\PrivateKeyMissingException |
|
85 | + */ |
|
86 | + public function getPrivateKey() { |
|
87 | + $key = $this->session->get('privateKey'); |
|
88 | + if (is_null($key)) { |
|
89 | + throw new Exceptions\PrivateKeyMissingException('please try to log-out and log-in again', 0); |
|
90 | + } |
|
91 | + return $key; |
|
92 | + } |
|
93 | + |
|
94 | + /** |
|
95 | + * check if private key is set |
|
96 | + * |
|
97 | + * @return boolean |
|
98 | + */ |
|
99 | + public function isPrivateKeySet() { |
|
100 | + $key = $this->session->get('privateKey'); |
|
101 | + if (is_null($key)) { |
|
102 | + return false; |
|
103 | + } |
|
104 | + |
|
105 | + return true; |
|
106 | + } |
|
107 | + |
|
108 | + /** |
|
109 | + * Sets user private key to session |
|
110 | + * |
|
111 | + * @param string $key users private key |
|
112 | + * |
|
113 | + * @note this should only be set on login |
|
114 | + */ |
|
115 | + public function setPrivateKey($key) { |
|
116 | + $this->session->set('privateKey', $key); |
|
117 | + } |
|
118 | + |
|
119 | + /** |
|
120 | + * store data needed for the decrypt all operation in the session |
|
121 | + * |
|
122 | + * @param string $user |
|
123 | + * @param string $key |
|
124 | + */ |
|
125 | + public function prepareDecryptAll($user, $key) { |
|
126 | + $this->session->set('decryptAll', true); |
|
127 | + $this->session->set('decryptAllKey', $key); |
|
128 | + $this->session->set('decryptAllUid', $user); |
|
129 | + } |
|
130 | + |
|
131 | + /** |
|
132 | + * check if we are in decrypt all mode |
|
133 | + * |
|
134 | + * @return bool |
|
135 | + */ |
|
136 | + public function decryptAllModeActivated() { |
|
137 | + $decryptAll = $this->session->get('decryptAll'); |
|
138 | + return ($decryptAll === true); |
|
139 | + } |
|
140 | + |
|
141 | + /** |
|
142 | + * get uid used for decrypt all operation |
|
143 | + * |
|
144 | + * @return string |
|
145 | + * @throws \Exception |
|
146 | + */ |
|
147 | + public function getDecryptAllUid() { |
|
148 | + $uid = $this->session->get('decryptAllUid'); |
|
149 | + if (is_null($uid) && $this->decryptAllModeActivated()) { |
|
150 | + throw new \Exception('No uid found while in decrypt all mode'); |
|
151 | + } elseif (is_null($uid)) { |
|
152 | + throw new \Exception('Please activate decrypt all mode first'); |
|
153 | + } |
|
154 | + |
|
155 | + return $uid; |
|
156 | + } |
|
157 | + |
|
158 | + /** |
|
159 | + * get private key for decrypt all operation |
|
160 | + * |
|
161 | + * @return string |
|
162 | + * @throws PrivateKeyMissingException |
|
163 | + */ |
|
164 | + public function getDecryptAllKey() { |
|
165 | + $privateKey = $this->session->get('decryptAllKey'); |
|
166 | + if (is_null($privateKey) && $this->decryptAllModeActivated()) { |
|
167 | + throw new PrivateKeyMissingException('No private key found while in decrypt all mode'); |
|
168 | + } elseif (is_null($privateKey)) { |
|
169 | + throw new PrivateKeyMissingException('Please activate decrypt all mode first'); |
|
170 | + } |
|
171 | + |
|
172 | + return $privateKey; |
|
173 | + } |
|
174 | + |
|
175 | + /** |
|
176 | + * remove keys from session |
|
177 | + */ |
|
178 | + public function clear() { |
|
179 | + $this->session->remove('publicSharePrivateKey'); |
|
180 | + $this->session->remove('privateKey'); |
|
181 | + $this->session->remove('encryptionInitialized'); |
|
182 | + $this->session->remove('decryptAll'); |
|
183 | + $this->session->remove('decryptAllKey'); |
|
184 | + $this->session->remove('decryptAllUid'); |
|
185 | + } |
|
186 | 186 | |
187 | 187 | } |
@@ -43,530 +43,530 @@ |
||
43 | 43 | |
44 | 44 | class Encryption implements IEncryptionModule { |
45 | 45 | |
46 | - const ID = 'OC_DEFAULT_MODULE'; |
|
47 | - const DISPLAY_NAME = 'Default encryption module'; |
|
48 | - |
|
49 | - /** |
|
50 | - * @var Crypt |
|
51 | - */ |
|
52 | - private $crypt; |
|
53 | - |
|
54 | - /** @var string */ |
|
55 | - private $cipher; |
|
56 | - |
|
57 | - /** @var string */ |
|
58 | - private $path; |
|
59 | - |
|
60 | - /** @var string */ |
|
61 | - private $user; |
|
62 | - |
|
63 | - /** @var string */ |
|
64 | - private $fileKey; |
|
65 | - |
|
66 | - /** @var string */ |
|
67 | - private $writeCache; |
|
68 | - |
|
69 | - /** @var KeyManager */ |
|
70 | - private $keyManager; |
|
71 | - |
|
72 | - /** @var array */ |
|
73 | - private $accessList; |
|
74 | - |
|
75 | - /** @var boolean */ |
|
76 | - private $isWriteOperation; |
|
77 | - |
|
78 | - /** @var Util */ |
|
79 | - private $util; |
|
80 | - |
|
81 | - /** @var Session */ |
|
82 | - private $session; |
|
83 | - |
|
84 | - /** @var ILogger */ |
|
85 | - private $logger; |
|
86 | - |
|
87 | - /** @var IL10N */ |
|
88 | - private $l; |
|
89 | - |
|
90 | - /** @var EncryptAll */ |
|
91 | - private $encryptAll; |
|
92 | - |
|
93 | - /** @var bool */ |
|
94 | - private $useMasterPassword; |
|
95 | - |
|
96 | - /** @var DecryptAll */ |
|
97 | - private $decryptAll; |
|
98 | - |
|
99 | - /** @var int unencrypted block size if block contains signature */ |
|
100 | - private $unencryptedBlockSizeSigned = 6072; |
|
101 | - |
|
102 | - /** @var int unencrypted block size */ |
|
103 | - private $unencryptedBlockSize = 6126; |
|
104 | - |
|
105 | - /** @var int Current version of the file */ |
|
106 | - private $version = 0; |
|
107 | - |
|
108 | - /** @var array remember encryption signature version */ |
|
109 | - private static $rememberVersion = []; |
|
110 | - |
|
111 | - |
|
112 | - /** |
|
113 | - * |
|
114 | - * @param Crypt $crypt |
|
115 | - * @param KeyManager $keyManager |
|
116 | - * @param Util $util |
|
117 | - * @param Session $session |
|
118 | - * @param EncryptAll $encryptAll |
|
119 | - * @param DecryptAll $decryptAll |
|
120 | - * @param ILogger $logger |
|
121 | - * @param IL10N $il10n |
|
122 | - */ |
|
123 | - public function __construct(Crypt $crypt, |
|
124 | - KeyManager $keyManager, |
|
125 | - Util $util, |
|
126 | - Session $session, |
|
127 | - EncryptAll $encryptAll, |
|
128 | - DecryptAll $decryptAll, |
|
129 | - ILogger $logger, |
|
130 | - IL10N $il10n) { |
|
131 | - $this->crypt = $crypt; |
|
132 | - $this->keyManager = $keyManager; |
|
133 | - $this->util = $util; |
|
134 | - $this->session = $session; |
|
135 | - $this->encryptAll = $encryptAll; |
|
136 | - $this->decryptAll = $decryptAll; |
|
137 | - $this->logger = $logger; |
|
138 | - $this->l = $il10n; |
|
139 | - $this->useMasterPassword = $util->isMasterKeyEnabled(); |
|
140 | - } |
|
141 | - |
|
142 | - /** |
|
143 | - * @return string defining the technical unique id |
|
144 | - */ |
|
145 | - public function getId() { |
|
146 | - return self::ID; |
|
147 | - } |
|
148 | - |
|
149 | - /** |
|
150 | - * In comparison to getKey() this function returns a human readable (maybe translated) name |
|
151 | - * |
|
152 | - * @return string |
|
153 | - */ |
|
154 | - public function getDisplayName() { |
|
155 | - return self::DISPLAY_NAME; |
|
156 | - } |
|
157 | - |
|
158 | - /** |
|
159 | - * start receiving chunks from a file. This is the place where you can |
|
160 | - * perform some initial step before starting encrypting/decrypting the |
|
161 | - * chunks |
|
162 | - * |
|
163 | - * @param string $path to the file |
|
164 | - * @param string $user who read/write the file |
|
165 | - * @param string $mode php stream open mode |
|
166 | - * @param array $header contains the header data read from the file |
|
167 | - * @param array $accessList who has access to the file contains the key 'users' and 'public' |
|
168 | - * |
|
169 | - * @return array $header contain data as key-value pairs which should be |
|
170 | - * written to the header, in case of a write operation |
|
171 | - * or if no additional data is needed return a empty array |
|
172 | - */ |
|
173 | - public function begin($path, $user, $mode, array $header, array $accessList) { |
|
174 | - $this->path = $this->getPathToRealFile($path); |
|
175 | - $this->accessList = $accessList; |
|
176 | - $this->user = $user; |
|
177 | - $this->isWriteOperation = false; |
|
178 | - $this->writeCache = ''; |
|
179 | - |
|
180 | - if($this->session->isReady() === false) { |
|
181 | - // if the master key is enabled we can initialize encryption |
|
182 | - // with a empty password and user name |
|
183 | - if ($this->util->isMasterKeyEnabled()) { |
|
184 | - $this->keyManager->init('', ''); |
|
185 | - } |
|
186 | - } |
|
187 | - |
|
188 | - if ($this->session->decryptAllModeActivated()) { |
|
189 | - $encryptedFileKey = $this->keyManager->getEncryptedFileKey($this->path); |
|
190 | - $shareKey = $this->keyManager->getShareKey($this->path, $this->session->getDecryptAllUid()); |
|
191 | - $this->fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey, |
|
192 | - $shareKey, |
|
193 | - $this->session->getDecryptAllKey()); |
|
194 | - } else { |
|
195 | - $this->fileKey = $this->keyManager->getFileKey($this->path, $this->user); |
|
196 | - } |
|
197 | - |
|
198 | - // always use the version from the original file, also part files |
|
199 | - // need to have a correct version number if they get moved over to the |
|
200 | - // final location |
|
201 | - $this->version = (int)$this->keyManager->getVersion($this->stripPartFileExtension($path), new View()); |
|
202 | - |
|
203 | - if ( |
|
204 | - $mode === 'w' |
|
205 | - || $mode === 'w+' |
|
206 | - || $mode === 'wb' |
|
207 | - || $mode === 'wb+' |
|
208 | - ) { |
|
209 | - $this->isWriteOperation = true; |
|
210 | - if (empty($this->fileKey)) { |
|
211 | - $this->fileKey = $this->crypt->generateFileKey(); |
|
212 | - } |
|
213 | - } else { |
|
214 | - // if we read a part file we need to increase the version by 1 |
|
215 | - // because the version number was also increased by writing |
|
216 | - // the part file |
|
217 | - if(Scanner::isPartialFile($path)) { |
|
218 | - $this->version = $this->version + 1; |
|
219 | - } |
|
220 | - } |
|
221 | - |
|
222 | - if ($this->isWriteOperation) { |
|
223 | - $this->cipher = $this->crypt->getCipher(); |
|
224 | - } elseif (isset($header['cipher'])) { |
|
225 | - $this->cipher = $header['cipher']; |
|
226 | - } else { |
|
227 | - // if we read a file without a header we fall-back to the legacy cipher |
|
228 | - // which was used in <=oC6 |
|
229 | - $this->cipher = $this->crypt->getLegacyCipher(); |
|
230 | - } |
|
231 | - |
|
232 | - return array('cipher' => $this->cipher, 'signed' => 'true'); |
|
233 | - } |
|
234 | - |
|
235 | - /** |
|
236 | - * last chunk received. This is the place where you can perform some final |
|
237 | - * operation and return some remaining data if something is left in your |
|
238 | - * buffer. |
|
239 | - * |
|
240 | - * @param string $path to the file |
|
241 | - * @param int $position |
|
242 | - * @return string remained data which should be written to the file in case |
|
243 | - * of a write operation |
|
244 | - * @throws PublicKeyMissingException |
|
245 | - * @throws \Exception |
|
246 | - * @throws \OCA\Encryption\Exceptions\MultiKeyEncryptException |
|
247 | - */ |
|
248 | - public function end($path, $position = 0) { |
|
249 | - $result = ''; |
|
250 | - if ($this->isWriteOperation) { |
|
251 | - $this->keyManager->setVersion($path, $this->version + 1, new View()); |
|
252 | - // in case of a part file we remember the new signature versions |
|
253 | - // the version will be set later on update. |
|
254 | - // This way we make sure that other apps listening to the pre-hooks |
|
255 | - // still get the old version which should be the correct value for them |
|
256 | - if (Scanner::isPartialFile($path)) { |
|
257 | - self::$rememberVersion[$this->stripPartFileExtension($path)] = $this->version + 1; |
|
258 | - } |
|
259 | - if (!empty($this->writeCache)) { |
|
260 | - $result = $this->crypt->symmetricEncryptFileContent($this->writeCache, $this->fileKey, $this->version + 1, $position); |
|
261 | - $this->writeCache = ''; |
|
262 | - } |
|
263 | - $publicKeys = array(); |
|
264 | - if ($this->useMasterPassword === true) { |
|
265 | - $publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey(); |
|
266 | - } else { |
|
267 | - foreach ($this->accessList['users'] as $uid) { |
|
268 | - try { |
|
269 | - $publicKeys[$uid] = $this->keyManager->getPublicKey($uid); |
|
270 | - } catch (PublicKeyMissingException $e) { |
|
271 | - $this->logger->warning( |
|
272 | - 'no public key found for user "{uid}", user will not be able to read the file', |
|
273 | - ['app' => 'encryption', 'uid' => $uid] |
|
274 | - ); |
|
275 | - // if the public key of the owner is missing we should fail |
|
276 | - if ($uid === $this->user) { |
|
277 | - throw $e; |
|
278 | - } |
|
279 | - } |
|
280 | - } |
|
281 | - } |
|
282 | - |
|
283 | - $publicKeys = $this->keyManager->addSystemKeys($this->accessList, $publicKeys, $this->user); |
|
284 | - $encryptedKeyfiles = $this->crypt->multiKeyEncrypt($this->fileKey, $publicKeys); |
|
285 | - $this->keyManager->setAllFileKeys($this->path, $encryptedKeyfiles); |
|
286 | - } |
|
287 | - return $result; |
|
288 | - } |
|
289 | - |
|
290 | - /** |
|
291 | - * encrypt data |
|
292 | - * |
|
293 | - * @param string $data you want to encrypt |
|
294 | - * @param int $position |
|
295 | - * @return string encrypted data |
|
296 | - */ |
|
297 | - public function encrypt($data, $position = 0) { |
|
298 | - // If extra data is left over from the last round, make sure it |
|
299 | - // is integrated into the next block |
|
300 | - if ($this->writeCache) { |
|
301 | - |
|
302 | - // Concat writeCache to start of $data |
|
303 | - $data = $this->writeCache . $data; |
|
304 | - |
|
305 | - // Clear the write cache, ready for reuse - it has been |
|
306 | - // flushed and its old contents processed |
|
307 | - $this->writeCache = ''; |
|
308 | - |
|
309 | - } |
|
310 | - |
|
311 | - $encrypted = ''; |
|
312 | - // While there still remains some data to be processed & written |
|
313 | - while (strlen($data) > 0) { |
|
314 | - |
|
315 | - // Remaining length for this iteration, not of the |
|
316 | - // entire file (may be greater than 8192 bytes) |
|
317 | - $remainingLength = strlen($data); |
|
318 | - |
|
319 | - // If data remaining to be written is less than the |
|
320 | - // size of 1 6126 byte block |
|
321 | - if ($remainingLength < $this->unencryptedBlockSizeSigned) { |
|
322 | - |
|
323 | - // Set writeCache to contents of $data |
|
324 | - // The writeCache will be carried over to the |
|
325 | - // next write round, and added to the start of |
|
326 | - // $data to ensure that written blocks are |
|
327 | - // always the correct length. If there is still |
|
328 | - // data in writeCache after the writing round |
|
329 | - // has finished, then the data will be written |
|
330 | - // to disk by $this->flush(). |
|
331 | - $this->writeCache = $data; |
|
332 | - |
|
333 | - // Clear $data ready for next round |
|
334 | - $data = ''; |
|
335 | - |
|
336 | - } else { |
|
337 | - |
|
338 | - // Read the chunk from the start of $data |
|
339 | - $chunk = substr($data, 0, $this->unencryptedBlockSizeSigned); |
|
340 | - |
|
341 | - $encrypted .= $this->crypt->symmetricEncryptFileContent($chunk, $this->fileKey, $this->version + 1, $position); |
|
342 | - |
|
343 | - // Remove the chunk we just processed from |
|
344 | - // $data, leaving only unprocessed data in $data |
|
345 | - // var, for handling on the next round |
|
346 | - $data = substr($data, $this->unencryptedBlockSizeSigned); |
|
347 | - |
|
348 | - } |
|
349 | - |
|
350 | - } |
|
351 | - |
|
352 | - return $encrypted; |
|
353 | - } |
|
354 | - |
|
355 | - /** |
|
356 | - * decrypt data |
|
357 | - * |
|
358 | - * @param string $data you want to decrypt |
|
359 | - * @param int $position |
|
360 | - * @return string decrypted data |
|
361 | - * @throws DecryptionFailedException |
|
362 | - */ |
|
363 | - public function decrypt($data, $position = 0) { |
|
364 | - if (empty($this->fileKey)) { |
|
365 | - $msg = 'Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.'; |
|
366 | - $hint = $this->l->t('Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.'); |
|
367 | - $this->logger->error($msg); |
|
368 | - |
|
369 | - throw new DecryptionFailedException($msg, $hint); |
|
370 | - } |
|
371 | - |
|
372 | - return $this->crypt->symmetricDecryptFileContent($data, $this->fileKey, $this->cipher, $this->version, $position); |
|
373 | - } |
|
374 | - |
|
375 | - /** |
|
376 | - * update encrypted file, e.g. give additional users access to the file |
|
377 | - * |
|
378 | - * @param string $path path to the file which should be updated |
|
379 | - * @param string $uid of the user who performs the operation |
|
380 | - * @param array $accessList who has access to the file contains the key 'users' and 'public' |
|
381 | - * @return boolean |
|
382 | - */ |
|
383 | - public function update($path, $uid, array $accessList) { |
|
384 | - |
|
385 | - if (empty($accessList)) { |
|
386 | - if (isset(self::$rememberVersion[$path])) { |
|
387 | - $this->keyManager->setVersion($path, self::$rememberVersion[$path], new View()); |
|
388 | - unset(self::$rememberVersion[$path]); |
|
389 | - } |
|
390 | - return; |
|
391 | - } |
|
392 | - |
|
393 | - $fileKey = $this->keyManager->getFileKey($path, $uid); |
|
394 | - |
|
395 | - if (!empty($fileKey)) { |
|
396 | - |
|
397 | - $publicKeys = array(); |
|
398 | - if ($this->useMasterPassword === true) { |
|
399 | - $publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey(); |
|
400 | - } else { |
|
401 | - foreach ($accessList['users'] as $user) { |
|
402 | - try { |
|
403 | - $publicKeys[$user] = $this->keyManager->getPublicKey($user); |
|
404 | - } catch (PublicKeyMissingException $e) { |
|
405 | - $this->logger->warning('Could not encrypt file for ' . $user . ': ' . $e->getMessage()); |
|
406 | - } |
|
407 | - } |
|
408 | - } |
|
409 | - |
|
410 | - $publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $uid); |
|
411 | - |
|
412 | - $encryptedFileKey = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys); |
|
413 | - |
|
414 | - $this->keyManager->deleteAllFileKeys($path); |
|
415 | - |
|
416 | - $this->keyManager->setAllFileKeys($path, $encryptedFileKey); |
|
417 | - |
|
418 | - } else { |
|
419 | - $this->logger->debug('no file key found, we assume that the file "{file}" is not encrypted', |
|
420 | - array('file' => $path, 'app' => 'encryption')); |
|
421 | - |
|
422 | - return false; |
|
423 | - } |
|
424 | - |
|
425 | - return true; |
|
426 | - } |
|
427 | - |
|
428 | - /** |
|
429 | - * should the file be encrypted or not |
|
430 | - * |
|
431 | - * @param string $path |
|
432 | - * @return boolean |
|
433 | - */ |
|
434 | - public function shouldEncrypt($path) { |
|
435 | - if ($this->util->shouldEncryptHomeStorage() === false) { |
|
436 | - $storage = $this->util->getStorage($path); |
|
437 | - if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) { |
|
438 | - return false; |
|
439 | - } |
|
440 | - } |
|
441 | - $parts = explode('/', $path); |
|
442 | - if (count($parts) < 4) { |
|
443 | - return false; |
|
444 | - } |
|
445 | - |
|
446 | - if ($parts[2] == 'files') { |
|
447 | - return true; |
|
448 | - } |
|
449 | - if ($parts[2] == 'files_versions') { |
|
450 | - return true; |
|
451 | - } |
|
452 | - if ($parts[2] == 'files_trashbin') { |
|
453 | - return true; |
|
454 | - } |
|
455 | - |
|
456 | - return false; |
|
457 | - } |
|
458 | - |
|
459 | - /** |
|
460 | - * get size of the unencrypted payload per block. |
|
461 | - * ownCloud read/write files with a block size of 8192 byte |
|
462 | - * |
|
463 | - * @param bool $signed |
|
464 | - * @return int |
|
465 | - */ |
|
466 | - public function getUnencryptedBlockSize($signed = false) { |
|
467 | - if ($signed === false) { |
|
468 | - return $this->unencryptedBlockSize; |
|
469 | - } |
|
470 | - |
|
471 | - return $this->unencryptedBlockSizeSigned; |
|
472 | - } |
|
473 | - |
|
474 | - /** |
|
475 | - * check if the encryption module is able to read the file, |
|
476 | - * e.g. if all encryption keys exists |
|
477 | - * |
|
478 | - * @param string $path |
|
479 | - * @param string $uid user for whom we want to check if he can read the file |
|
480 | - * @return bool |
|
481 | - * @throws DecryptionFailedException |
|
482 | - */ |
|
483 | - public function isReadable($path, $uid) { |
|
484 | - $fileKey = $this->keyManager->getFileKey($path, $uid); |
|
485 | - if (empty($fileKey)) { |
|
486 | - $owner = $this->util->getOwner($path); |
|
487 | - if ($owner !== $uid) { |
|
488 | - // if it is a shared file we throw a exception with a useful |
|
489 | - // error message because in this case it means that the file was |
|
490 | - // shared with the user at a point where the user didn't had a |
|
491 | - // valid private/public key |
|
492 | - $msg = 'Encryption module "' . $this->getDisplayName() . |
|
493 | - '" is not able to read ' . $path; |
|
494 | - $hint = $this->l->t('Can not read this file, probably this is a shared file. Please ask the file owner to reshare the file with you.'); |
|
495 | - $this->logger->warning($msg); |
|
496 | - throw new DecryptionFailedException($msg, $hint); |
|
497 | - } |
|
498 | - return false; |
|
499 | - } |
|
500 | - |
|
501 | - return true; |
|
502 | - } |
|
503 | - |
|
504 | - /** |
|
505 | - * Initial encryption of all files |
|
506 | - * |
|
507 | - * @param InputInterface $input |
|
508 | - * @param OutputInterface $output write some status information to the terminal during encryption |
|
509 | - */ |
|
510 | - public function encryptAll(InputInterface $input, OutputInterface $output) { |
|
511 | - $this->encryptAll->encryptAll($input, $output); |
|
512 | - } |
|
513 | - |
|
514 | - /** |
|
515 | - * prepare module to perform decrypt all operation |
|
516 | - * |
|
517 | - * @param InputInterface $input |
|
518 | - * @param OutputInterface $output |
|
519 | - * @param string $user |
|
520 | - * @return bool |
|
521 | - */ |
|
522 | - public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '') { |
|
523 | - return $this->decryptAll->prepare($input, $output, $user); |
|
524 | - } |
|
525 | - |
|
526 | - |
|
527 | - /** |
|
528 | - * @param string $path |
|
529 | - * @return string |
|
530 | - */ |
|
531 | - protected function getPathToRealFile($path) { |
|
532 | - $realPath = $path; |
|
533 | - $parts = explode('/', $path); |
|
534 | - if ($parts[2] === 'files_versions') { |
|
535 | - $realPath = '/' . $parts[1] . '/files/' . implode('/', array_slice($parts, 3)); |
|
536 | - $length = strrpos($realPath, '.'); |
|
537 | - $realPath = substr($realPath, 0, $length); |
|
538 | - } |
|
539 | - |
|
540 | - return $realPath; |
|
541 | - } |
|
542 | - |
|
543 | - /** |
|
544 | - * remove .part file extension and the ocTransferId from the file to get the |
|
545 | - * original file name |
|
546 | - * |
|
547 | - * @param string $path |
|
548 | - * @return string |
|
549 | - */ |
|
550 | - protected function stripPartFileExtension($path) { |
|
551 | - if (pathinfo($path, PATHINFO_EXTENSION) === 'part') { |
|
552 | - $pos = strrpos($path, '.', -6); |
|
553 | - $path = substr($path, 0, $pos); |
|
554 | - } |
|
555 | - |
|
556 | - return $path; |
|
557 | - } |
|
558 | - |
|
559 | - /** |
|
560 | - * Check if the module is ready to be used by that specific user. |
|
561 | - * In case a module is not ready - because e.g. key pairs have not been generated |
|
562 | - * upon login this method can return false before any operation starts and might |
|
563 | - * cause issues during operations. |
|
564 | - * |
|
565 | - * @param string $user |
|
566 | - * @return boolean |
|
567 | - * @since 9.1.0 |
|
568 | - */ |
|
569 | - public function isReadyForUser($user) { |
|
570 | - return $this->keyManager->userHasKeys($user); |
|
571 | - } |
|
46 | + const ID = 'OC_DEFAULT_MODULE'; |
|
47 | + const DISPLAY_NAME = 'Default encryption module'; |
|
48 | + |
|
49 | + /** |
|
50 | + * @var Crypt |
|
51 | + */ |
|
52 | + private $crypt; |
|
53 | + |
|
54 | + /** @var string */ |
|
55 | + private $cipher; |
|
56 | + |
|
57 | + /** @var string */ |
|
58 | + private $path; |
|
59 | + |
|
60 | + /** @var string */ |
|
61 | + private $user; |
|
62 | + |
|
63 | + /** @var string */ |
|
64 | + private $fileKey; |
|
65 | + |
|
66 | + /** @var string */ |
|
67 | + private $writeCache; |
|
68 | + |
|
69 | + /** @var KeyManager */ |
|
70 | + private $keyManager; |
|
71 | + |
|
72 | + /** @var array */ |
|
73 | + private $accessList; |
|
74 | + |
|
75 | + /** @var boolean */ |
|
76 | + private $isWriteOperation; |
|
77 | + |
|
78 | + /** @var Util */ |
|
79 | + private $util; |
|
80 | + |
|
81 | + /** @var Session */ |
|
82 | + private $session; |
|
83 | + |
|
84 | + /** @var ILogger */ |
|
85 | + private $logger; |
|
86 | + |
|
87 | + /** @var IL10N */ |
|
88 | + private $l; |
|
89 | + |
|
90 | + /** @var EncryptAll */ |
|
91 | + private $encryptAll; |
|
92 | + |
|
93 | + /** @var bool */ |
|
94 | + private $useMasterPassword; |
|
95 | + |
|
96 | + /** @var DecryptAll */ |
|
97 | + private $decryptAll; |
|
98 | + |
|
99 | + /** @var int unencrypted block size if block contains signature */ |
|
100 | + private $unencryptedBlockSizeSigned = 6072; |
|
101 | + |
|
102 | + /** @var int unencrypted block size */ |
|
103 | + private $unencryptedBlockSize = 6126; |
|
104 | + |
|
105 | + /** @var int Current version of the file */ |
|
106 | + private $version = 0; |
|
107 | + |
|
108 | + /** @var array remember encryption signature version */ |
|
109 | + private static $rememberVersion = []; |
|
110 | + |
|
111 | + |
|
112 | + /** |
|
113 | + * |
|
114 | + * @param Crypt $crypt |
|
115 | + * @param KeyManager $keyManager |
|
116 | + * @param Util $util |
|
117 | + * @param Session $session |
|
118 | + * @param EncryptAll $encryptAll |
|
119 | + * @param DecryptAll $decryptAll |
|
120 | + * @param ILogger $logger |
|
121 | + * @param IL10N $il10n |
|
122 | + */ |
|
123 | + public function __construct(Crypt $crypt, |
|
124 | + KeyManager $keyManager, |
|
125 | + Util $util, |
|
126 | + Session $session, |
|
127 | + EncryptAll $encryptAll, |
|
128 | + DecryptAll $decryptAll, |
|
129 | + ILogger $logger, |
|
130 | + IL10N $il10n) { |
|
131 | + $this->crypt = $crypt; |
|
132 | + $this->keyManager = $keyManager; |
|
133 | + $this->util = $util; |
|
134 | + $this->session = $session; |
|
135 | + $this->encryptAll = $encryptAll; |
|
136 | + $this->decryptAll = $decryptAll; |
|
137 | + $this->logger = $logger; |
|
138 | + $this->l = $il10n; |
|
139 | + $this->useMasterPassword = $util->isMasterKeyEnabled(); |
|
140 | + } |
|
141 | + |
|
142 | + /** |
|
143 | + * @return string defining the technical unique id |
|
144 | + */ |
|
145 | + public function getId() { |
|
146 | + return self::ID; |
|
147 | + } |
|
148 | + |
|
149 | + /** |
|
150 | + * In comparison to getKey() this function returns a human readable (maybe translated) name |
|
151 | + * |
|
152 | + * @return string |
|
153 | + */ |
|
154 | + public function getDisplayName() { |
|
155 | + return self::DISPLAY_NAME; |
|
156 | + } |
|
157 | + |
|
158 | + /** |
|
159 | + * start receiving chunks from a file. This is the place where you can |
|
160 | + * perform some initial step before starting encrypting/decrypting the |
|
161 | + * chunks |
|
162 | + * |
|
163 | + * @param string $path to the file |
|
164 | + * @param string $user who read/write the file |
|
165 | + * @param string $mode php stream open mode |
|
166 | + * @param array $header contains the header data read from the file |
|
167 | + * @param array $accessList who has access to the file contains the key 'users' and 'public' |
|
168 | + * |
|
169 | + * @return array $header contain data as key-value pairs which should be |
|
170 | + * written to the header, in case of a write operation |
|
171 | + * or if no additional data is needed return a empty array |
|
172 | + */ |
|
173 | + public function begin($path, $user, $mode, array $header, array $accessList) { |
|
174 | + $this->path = $this->getPathToRealFile($path); |
|
175 | + $this->accessList = $accessList; |
|
176 | + $this->user = $user; |
|
177 | + $this->isWriteOperation = false; |
|
178 | + $this->writeCache = ''; |
|
179 | + |
|
180 | + if($this->session->isReady() === false) { |
|
181 | + // if the master key is enabled we can initialize encryption |
|
182 | + // with a empty password and user name |
|
183 | + if ($this->util->isMasterKeyEnabled()) { |
|
184 | + $this->keyManager->init('', ''); |
|
185 | + } |
|
186 | + } |
|
187 | + |
|
188 | + if ($this->session->decryptAllModeActivated()) { |
|
189 | + $encryptedFileKey = $this->keyManager->getEncryptedFileKey($this->path); |
|
190 | + $shareKey = $this->keyManager->getShareKey($this->path, $this->session->getDecryptAllUid()); |
|
191 | + $this->fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey, |
|
192 | + $shareKey, |
|
193 | + $this->session->getDecryptAllKey()); |
|
194 | + } else { |
|
195 | + $this->fileKey = $this->keyManager->getFileKey($this->path, $this->user); |
|
196 | + } |
|
197 | + |
|
198 | + // always use the version from the original file, also part files |
|
199 | + // need to have a correct version number if they get moved over to the |
|
200 | + // final location |
|
201 | + $this->version = (int)$this->keyManager->getVersion($this->stripPartFileExtension($path), new View()); |
|
202 | + |
|
203 | + if ( |
|
204 | + $mode === 'w' |
|
205 | + || $mode === 'w+' |
|
206 | + || $mode === 'wb' |
|
207 | + || $mode === 'wb+' |
|
208 | + ) { |
|
209 | + $this->isWriteOperation = true; |
|
210 | + if (empty($this->fileKey)) { |
|
211 | + $this->fileKey = $this->crypt->generateFileKey(); |
|
212 | + } |
|
213 | + } else { |
|
214 | + // if we read a part file we need to increase the version by 1 |
|
215 | + // because the version number was also increased by writing |
|
216 | + // the part file |
|
217 | + if(Scanner::isPartialFile($path)) { |
|
218 | + $this->version = $this->version + 1; |
|
219 | + } |
|
220 | + } |
|
221 | + |
|
222 | + if ($this->isWriteOperation) { |
|
223 | + $this->cipher = $this->crypt->getCipher(); |
|
224 | + } elseif (isset($header['cipher'])) { |
|
225 | + $this->cipher = $header['cipher']; |
|
226 | + } else { |
|
227 | + // if we read a file without a header we fall-back to the legacy cipher |
|
228 | + // which was used in <=oC6 |
|
229 | + $this->cipher = $this->crypt->getLegacyCipher(); |
|
230 | + } |
|
231 | + |
|
232 | + return array('cipher' => $this->cipher, 'signed' => 'true'); |
|
233 | + } |
|
234 | + |
|
235 | + /** |
|
236 | + * last chunk received. This is the place where you can perform some final |
|
237 | + * operation and return some remaining data if something is left in your |
|
238 | + * buffer. |
|
239 | + * |
|
240 | + * @param string $path to the file |
|
241 | + * @param int $position |
|
242 | + * @return string remained data which should be written to the file in case |
|
243 | + * of a write operation |
|
244 | + * @throws PublicKeyMissingException |
|
245 | + * @throws \Exception |
|
246 | + * @throws \OCA\Encryption\Exceptions\MultiKeyEncryptException |
|
247 | + */ |
|
248 | + public function end($path, $position = 0) { |
|
249 | + $result = ''; |
|
250 | + if ($this->isWriteOperation) { |
|
251 | + $this->keyManager->setVersion($path, $this->version + 1, new View()); |
|
252 | + // in case of a part file we remember the new signature versions |
|
253 | + // the version will be set later on update. |
|
254 | + // This way we make sure that other apps listening to the pre-hooks |
|
255 | + // still get the old version which should be the correct value for them |
|
256 | + if (Scanner::isPartialFile($path)) { |
|
257 | + self::$rememberVersion[$this->stripPartFileExtension($path)] = $this->version + 1; |
|
258 | + } |
|
259 | + if (!empty($this->writeCache)) { |
|
260 | + $result = $this->crypt->symmetricEncryptFileContent($this->writeCache, $this->fileKey, $this->version + 1, $position); |
|
261 | + $this->writeCache = ''; |
|
262 | + } |
|
263 | + $publicKeys = array(); |
|
264 | + if ($this->useMasterPassword === true) { |
|
265 | + $publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey(); |
|
266 | + } else { |
|
267 | + foreach ($this->accessList['users'] as $uid) { |
|
268 | + try { |
|
269 | + $publicKeys[$uid] = $this->keyManager->getPublicKey($uid); |
|
270 | + } catch (PublicKeyMissingException $e) { |
|
271 | + $this->logger->warning( |
|
272 | + 'no public key found for user "{uid}", user will not be able to read the file', |
|
273 | + ['app' => 'encryption', 'uid' => $uid] |
|
274 | + ); |
|
275 | + // if the public key of the owner is missing we should fail |
|
276 | + if ($uid === $this->user) { |
|
277 | + throw $e; |
|
278 | + } |
|
279 | + } |
|
280 | + } |
|
281 | + } |
|
282 | + |
|
283 | + $publicKeys = $this->keyManager->addSystemKeys($this->accessList, $publicKeys, $this->user); |
|
284 | + $encryptedKeyfiles = $this->crypt->multiKeyEncrypt($this->fileKey, $publicKeys); |
|
285 | + $this->keyManager->setAllFileKeys($this->path, $encryptedKeyfiles); |
|
286 | + } |
|
287 | + return $result; |
|
288 | + } |
|
289 | + |
|
290 | + /** |
|
291 | + * encrypt data |
|
292 | + * |
|
293 | + * @param string $data you want to encrypt |
|
294 | + * @param int $position |
|
295 | + * @return string encrypted data |
|
296 | + */ |
|
297 | + public function encrypt($data, $position = 0) { |
|
298 | + // If extra data is left over from the last round, make sure it |
|
299 | + // is integrated into the next block |
|
300 | + if ($this->writeCache) { |
|
301 | + |
|
302 | + // Concat writeCache to start of $data |
|
303 | + $data = $this->writeCache . $data; |
|
304 | + |
|
305 | + // Clear the write cache, ready for reuse - it has been |
|
306 | + // flushed and its old contents processed |
|
307 | + $this->writeCache = ''; |
|
308 | + |
|
309 | + } |
|
310 | + |
|
311 | + $encrypted = ''; |
|
312 | + // While there still remains some data to be processed & written |
|
313 | + while (strlen($data) > 0) { |
|
314 | + |
|
315 | + // Remaining length for this iteration, not of the |
|
316 | + // entire file (may be greater than 8192 bytes) |
|
317 | + $remainingLength = strlen($data); |
|
318 | + |
|
319 | + // If data remaining to be written is less than the |
|
320 | + // size of 1 6126 byte block |
|
321 | + if ($remainingLength < $this->unencryptedBlockSizeSigned) { |
|
322 | + |
|
323 | + // Set writeCache to contents of $data |
|
324 | + // The writeCache will be carried over to the |
|
325 | + // next write round, and added to the start of |
|
326 | + // $data to ensure that written blocks are |
|
327 | + // always the correct length. If there is still |
|
328 | + // data in writeCache after the writing round |
|
329 | + // has finished, then the data will be written |
|
330 | + // to disk by $this->flush(). |
|
331 | + $this->writeCache = $data; |
|
332 | + |
|
333 | + // Clear $data ready for next round |
|
334 | + $data = ''; |
|
335 | + |
|
336 | + } else { |
|
337 | + |
|
338 | + // Read the chunk from the start of $data |
|
339 | + $chunk = substr($data, 0, $this->unencryptedBlockSizeSigned); |
|
340 | + |
|
341 | + $encrypted .= $this->crypt->symmetricEncryptFileContent($chunk, $this->fileKey, $this->version + 1, $position); |
|
342 | + |
|
343 | + // Remove the chunk we just processed from |
|
344 | + // $data, leaving only unprocessed data in $data |
|
345 | + // var, for handling on the next round |
|
346 | + $data = substr($data, $this->unencryptedBlockSizeSigned); |
|
347 | + |
|
348 | + } |
|
349 | + |
|
350 | + } |
|
351 | + |
|
352 | + return $encrypted; |
|
353 | + } |
|
354 | + |
|
355 | + /** |
|
356 | + * decrypt data |
|
357 | + * |
|
358 | + * @param string $data you want to decrypt |
|
359 | + * @param int $position |
|
360 | + * @return string decrypted data |
|
361 | + * @throws DecryptionFailedException |
|
362 | + */ |
|
363 | + public function decrypt($data, $position = 0) { |
|
364 | + if (empty($this->fileKey)) { |
|
365 | + $msg = 'Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.'; |
|
366 | + $hint = $this->l->t('Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.'); |
|
367 | + $this->logger->error($msg); |
|
368 | + |
|
369 | + throw new DecryptionFailedException($msg, $hint); |
|
370 | + } |
|
371 | + |
|
372 | + return $this->crypt->symmetricDecryptFileContent($data, $this->fileKey, $this->cipher, $this->version, $position); |
|
373 | + } |
|
374 | + |
|
375 | + /** |
|
376 | + * update encrypted file, e.g. give additional users access to the file |
|
377 | + * |
|
378 | + * @param string $path path to the file which should be updated |
|
379 | + * @param string $uid of the user who performs the operation |
|
380 | + * @param array $accessList who has access to the file contains the key 'users' and 'public' |
|
381 | + * @return boolean |
|
382 | + */ |
|
383 | + public function update($path, $uid, array $accessList) { |
|
384 | + |
|
385 | + if (empty($accessList)) { |
|
386 | + if (isset(self::$rememberVersion[$path])) { |
|
387 | + $this->keyManager->setVersion($path, self::$rememberVersion[$path], new View()); |
|
388 | + unset(self::$rememberVersion[$path]); |
|
389 | + } |
|
390 | + return; |
|
391 | + } |
|
392 | + |
|
393 | + $fileKey = $this->keyManager->getFileKey($path, $uid); |
|
394 | + |
|
395 | + if (!empty($fileKey)) { |
|
396 | + |
|
397 | + $publicKeys = array(); |
|
398 | + if ($this->useMasterPassword === true) { |
|
399 | + $publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey(); |
|
400 | + } else { |
|
401 | + foreach ($accessList['users'] as $user) { |
|
402 | + try { |
|
403 | + $publicKeys[$user] = $this->keyManager->getPublicKey($user); |
|
404 | + } catch (PublicKeyMissingException $e) { |
|
405 | + $this->logger->warning('Could not encrypt file for ' . $user . ': ' . $e->getMessage()); |
|
406 | + } |
|
407 | + } |
|
408 | + } |
|
409 | + |
|
410 | + $publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $uid); |
|
411 | + |
|
412 | + $encryptedFileKey = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys); |
|
413 | + |
|
414 | + $this->keyManager->deleteAllFileKeys($path); |
|
415 | + |
|
416 | + $this->keyManager->setAllFileKeys($path, $encryptedFileKey); |
|
417 | + |
|
418 | + } else { |
|
419 | + $this->logger->debug('no file key found, we assume that the file "{file}" is not encrypted', |
|
420 | + array('file' => $path, 'app' => 'encryption')); |
|
421 | + |
|
422 | + return false; |
|
423 | + } |
|
424 | + |
|
425 | + return true; |
|
426 | + } |
|
427 | + |
|
428 | + /** |
|
429 | + * should the file be encrypted or not |
|
430 | + * |
|
431 | + * @param string $path |
|
432 | + * @return boolean |
|
433 | + */ |
|
434 | + public function shouldEncrypt($path) { |
|
435 | + if ($this->util->shouldEncryptHomeStorage() === false) { |
|
436 | + $storage = $this->util->getStorage($path); |
|
437 | + if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) { |
|
438 | + return false; |
|
439 | + } |
|
440 | + } |
|
441 | + $parts = explode('/', $path); |
|
442 | + if (count($parts) < 4) { |
|
443 | + return false; |
|
444 | + } |
|
445 | + |
|
446 | + if ($parts[2] == 'files') { |
|
447 | + return true; |
|
448 | + } |
|
449 | + if ($parts[2] == 'files_versions') { |
|
450 | + return true; |
|
451 | + } |
|
452 | + if ($parts[2] == 'files_trashbin') { |
|
453 | + return true; |
|
454 | + } |
|
455 | + |
|
456 | + return false; |
|
457 | + } |
|
458 | + |
|
459 | + /** |
|
460 | + * get size of the unencrypted payload per block. |
|
461 | + * ownCloud read/write files with a block size of 8192 byte |
|
462 | + * |
|
463 | + * @param bool $signed |
|
464 | + * @return int |
|
465 | + */ |
|
466 | + public function getUnencryptedBlockSize($signed = false) { |
|
467 | + if ($signed === false) { |
|
468 | + return $this->unencryptedBlockSize; |
|
469 | + } |
|
470 | + |
|
471 | + return $this->unencryptedBlockSizeSigned; |
|
472 | + } |
|
473 | + |
|
474 | + /** |
|
475 | + * check if the encryption module is able to read the file, |
|
476 | + * e.g. if all encryption keys exists |
|
477 | + * |
|
478 | + * @param string $path |
|
479 | + * @param string $uid user for whom we want to check if he can read the file |
|
480 | + * @return bool |
|
481 | + * @throws DecryptionFailedException |
|
482 | + */ |
|
483 | + public function isReadable($path, $uid) { |
|
484 | + $fileKey = $this->keyManager->getFileKey($path, $uid); |
|
485 | + if (empty($fileKey)) { |
|
486 | + $owner = $this->util->getOwner($path); |
|
487 | + if ($owner !== $uid) { |
|
488 | + // if it is a shared file we throw a exception with a useful |
|
489 | + // error message because in this case it means that the file was |
|
490 | + // shared with the user at a point where the user didn't had a |
|
491 | + // valid private/public key |
|
492 | + $msg = 'Encryption module "' . $this->getDisplayName() . |
|
493 | + '" is not able to read ' . $path; |
|
494 | + $hint = $this->l->t('Can not read this file, probably this is a shared file. Please ask the file owner to reshare the file with you.'); |
|
495 | + $this->logger->warning($msg); |
|
496 | + throw new DecryptionFailedException($msg, $hint); |
|
497 | + } |
|
498 | + return false; |
|
499 | + } |
|
500 | + |
|
501 | + return true; |
|
502 | + } |
|
503 | + |
|
504 | + /** |
|
505 | + * Initial encryption of all files |
|
506 | + * |
|
507 | + * @param InputInterface $input |
|
508 | + * @param OutputInterface $output write some status information to the terminal during encryption |
|
509 | + */ |
|
510 | + public function encryptAll(InputInterface $input, OutputInterface $output) { |
|
511 | + $this->encryptAll->encryptAll($input, $output); |
|
512 | + } |
|
513 | + |
|
514 | + /** |
|
515 | + * prepare module to perform decrypt all operation |
|
516 | + * |
|
517 | + * @param InputInterface $input |
|
518 | + * @param OutputInterface $output |
|
519 | + * @param string $user |
|
520 | + * @return bool |
|
521 | + */ |
|
522 | + public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '') { |
|
523 | + return $this->decryptAll->prepare($input, $output, $user); |
|
524 | + } |
|
525 | + |
|
526 | + |
|
527 | + /** |
|
528 | + * @param string $path |
|
529 | + * @return string |
|
530 | + */ |
|
531 | + protected function getPathToRealFile($path) { |
|
532 | + $realPath = $path; |
|
533 | + $parts = explode('/', $path); |
|
534 | + if ($parts[2] === 'files_versions') { |
|
535 | + $realPath = '/' . $parts[1] . '/files/' . implode('/', array_slice($parts, 3)); |
|
536 | + $length = strrpos($realPath, '.'); |
|
537 | + $realPath = substr($realPath, 0, $length); |
|
538 | + } |
|
539 | + |
|
540 | + return $realPath; |
|
541 | + } |
|
542 | + |
|
543 | + /** |
|
544 | + * remove .part file extension and the ocTransferId from the file to get the |
|
545 | + * original file name |
|
546 | + * |
|
547 | + * @param string $path |
|
548 | + * @return string |
|
549 | + */ |
|
550 | + protected function stripPartFileExtension($path) { |
|
551 | + if (pathinfo($path, PATHINFO_EXTENSION) === 'part') { |
|
552 | + $pos = strrpos($path, '.', -6); |
|
553 | + $path = substr($path, 0, $pos); |
|
554 | + } |
|
555 | + |
|
556 | + return $path; |
|
557 | + } |
|
558 | + |
|
559 | + /** |
|
560 | + * Check if the module is ready to be used by that specific user. |
|
561 | + * In case a module is not ready - because e.g. key pairs have not been generated |
|
562 | + * upon login this method can return false before any operation starts and might |
|
563 | + * cause issues during operations. |
|
564 | + * |
|
565 | + * @param string $user |
|
566 | + * @return boolean |
|
567 | + * @since 9.1.0 |
|
568 | + */ |
|
569 | + public function isReadyForUser($user) { |
|
570 | + return $this->keyManager->userHasKeys($user); |
|
571 | + } |
|
572 | 572 | } |
@@ -45,431 +45,431 @@ |
||
45 | 45 | |
46 | 46 | class EncryptAll { |
47 | 47 | |
48 | - /** @var Setup */ |
|
49 | - protected $userSetup; |
|
50 | - |
|
51 | - /** @var IUserManager */ |
|
52 | - protected $userManager; |
|
53 | - |
|
54 | - /** @var View */ |
|
55 | - protected $rootView; |
|
56 | - |
|
57 | - /** @var KeyManager */ |
|
58 | - protected $keyManager; |
|
59 | - |
|
60 | - /** @var Util */ |
|
61 | - protected $util; |
|
62 | - |
|
63 | - /** @var array */ |
|
64 | - protected $userPasswords; |
|
65 | - |
|
66 | - /** @var IConfig */ |
|
67 | - protected $config; |
|
68 | - |
|
69 | - /** @var IMailer */ |
|
70 | - protected $mailer; |
|
71 | - |
|
72 | - /** @var IL10N */ |
|
73 | - protected $l; |
|
74 | - |
|
75 | - /** @var QuestionHelper */ |
|
76 | - protected $questionHelper; |
|
77 | - |
|
78 | - /** @var OutputInterface */ |
|
79 | - protected $output; |
|
80 | - |
|
81 | - /** @var InputInterface */ |
|
82 | - protected $input; |
|
83 | - |
|
84 | - /** @var ISecureRandom */ |
|
85 | - protected $secureRandom; |
|
86 | - |
|
87 | - /** |
|
88 | - * @param Setup $userSetup |
|
89 | - * @param IUserManager $userManager |
|
90 | - * @param View $rootView |
|
91 | - * @param KeyManager $keyManager |
|
92 | - * @param Util $util |
|
93 | - * @param IConfig $config |
|
94 | - * @param IMailer $mailer |
|
95 | - * @param IL10N $l |
|
96 | - * @param QuestionHelper $questionHelper |
|
97 | - * @param ISecureRandom $secureRandom |
|
98 | - */ |
|
99 | - public function __construct( |
|
100 | - Setup $userSetup, |
|
101 | - IUserManager $userManager, |
|
102 | - View $rootView, |
|
103 | - KeyManager $keyManager, |
|
104 | - Util $util, |
|
105 | - IConfig $config, |
|
106 | - IMailer $mailer, |
|
107 | - IL10N $l, |
|
108 | - QuestionHelper $questionHelper, |
|
109 | - ISecureRandom $secureRandom |
|
110 | - ) { |
|
111 | - $this->userSetup = $userSetup; |
|
112 | - $this->userManager = $userManager; |
|
113 | - $this->rootView = $rootView; |
|
114 | - $this->keyManager = $keyManager; |
|
115 | - $this->util = $util; |
|
116 | - $this->config = $config; |
|
117 | - $this->mailer = $mailer; |
|
118 | - $this->l = $l; |
|
119 | - $this->questionHelper = $questionHelper; |
|
120 | - $this->secureRandom = $secureRandom; |
|
121 | - // store one time passwords for the users |
|
122 | - $this->userPasswords = array(); |
|
123 | - } |
|
124 | - |
|
125 | - /** |
|
126 | - * start to encrypt all files |
|
127 | - * |
|
128 | - * @param InputInterface $input |
|
129 | - * @param OutputInterface $output |
|
130 | - */ |
|
131 | - public function encryptAll(InputInterface $input, OutputInterface $output) { |
|
132 | - |
|
133 | - $this->input = $input; |
|
134 | - $this->output = $output; |
|
135 | - |
|
136 | - $headline = 'Encrypt all files with the ' . Encryption::DISPLAY_NAME; |
|
137 | - $this->output->writeln("\n"); |
|
138 | - $this->output->writeln($headline); |
|
139 | - $this->output->writeln(str_pad('', strlen($headline), '=')); |
|
140 | - $this->output->writeln("\n"); |
|
141 | - |
|
142 | - if ($this->util->isMasterKeyEnabled()) { |
|
143 | - $this->output->writeln('Use master key to encrypt all files.'); |
|
144 | - $this->keyManager->validateMasterKey(); |
|
145 | - } else { |
|
146 | - //create private/public keys for each user and store the private key password |
|
147 | - $this->output->writeln('Create key-pair for every user'); |
|
148 | - $this->output->writeln('------------------------------'); |
|
149 | - $this->output->writeln(''); |
|
150 | - $this->output->writeln('This module will encrypt all files in the users files folder initially.'); |
|
151 | - $this->output->writeln('Already existing versions and files in the trash bin will not be encrypted.'); |
|
152 | - $this->output->writeln(''); |
|
153 | - $this->createKeyPairs(); |
|
154 | - } |
|
155 | - |
|
156 | - //setup users file system and encrypt all files one by one (take should encrypt setting of storage into account) |
|
157 | - $this->output->writeln("\n"); |
|
158 | - $this->output->writeln('Start to encrypt users files'); |
|
159 | - $this->output->writeln('----------------------------'); |
|
160 | - $this->output->writeln(''); |
|
161 | - $this->encryptAllUsersFiles(); |
|
162 | - if ($this->util->isMasterKeyEnabled() === false) { |
|
163 | - //send-out or display password list and write it to a file |
|
164 | - $this->output->writeln("\n"); |
|
165 | - $this->output->writeln('Generated encryption key passwords'); |
|
166 | - $this->output->writeln('----------------------------------'); |
|
167 | - $this->output->writeln(''); |
|
168 | - $this->outputPasswords(); |
|
169 | - } |
|
170 | - $this->output->writeln("\n"); |
|
171 | - } |
|
172 | - |
|
173 | - /** |
|
174 | - * create key-pair for every user |
|
175 | - */ |
|
176 | - protected function createKeyPairs() { |
|
177 | - $this->output->writeln("\n"); |
|
178 | - $progress = new ProgressBar($this->output); |
|
179 | - $progress->setFormat(" %message% \n [%bar%]"); |
|
180 | - $progress->start(); |
|
181 | - |
|
182 | - foreach($this->userManager->getBackends() as $backend) { |
|
183 | - $limit = 500; |
|
184 | - $offset = 0; |
|
185 | - do { |
|
186 | - $users = $backend->getUsers('', $limit, $offset); |
|
187 | - foreach ($users as $user) { |
|
188 | - if ($this->keyManager->userHasKeys($user) === false) { |
|
189 | - $progress->setMessage('Create key-pair for ' . $user); |
|
190 | - $progress->advance(); |
|
191 | - $this->setupUserFS($user); |
|
192 | - $password = $this->generateOneTimePassword($user); |
|
193 | - $this->userSetup->setupUser($user, $password); |
|
194 | - } else { |
|
195 | - // users which already have a key-pair will be stored with a |
|
196 | - // empty password and filtered out later |
|
197 | - $this->userPasswords[$user] = ''; |
|
198 | - } |
|
199 | - } |
|
200 | - $offset += $limit; |
|
201 | - } while(count($users) >= $limit); |
|
202 | - } |
|
203 | - |
|
204 | - $progress->setMessage('Key-pair created for all users'); |
|
205 | - $progress->finish(); |
|
206 | - } |
|
207 | - |
|
208 | - /** |
|
209 | - * iterate over all user and encrypt their files |
|
210 | - */ |
|
211 | - protected function encryptAllUsersFiles() { |
|
212 | - $this->output->writeln("\n"); |
|
213 | - $progress = new ProgressBar($this->output); |
|
214 | - $progress->setFormat(" %message% \n [%bar%]"); |
|
215 | - $progress->start(); |
|
216 | - $numberOfUsers = count($this->userPasswords); |
|
217 | - $userNo = 1; |
|
218 | - if ($this->util->isMasterKeyEnabled()) { |
|
219 | - $this->encryptAllUserFilesWithMasterKey($progress); |
|
220 | - } else { |
|
221 | - foreach ($this->userPasswords as $uid => $password) { |
|
222 | - $userCount = "$uid ($userNo of $numberOfUsers)"; |
|
223 | - $this->encryptUsersFiles($uid, $progress, $userCount); |
|
224 | - $userNo++; |
|
225 | - } |
|
226 | - } |
|
227 | - $progress->setMessage("all files encrypted"); |
|
228 | - $progress->finish(); |
|
229 | - |
|
230 | - } |
|
231 | - |
|
232 | - /** |
|
233 | - * encrypt all user files with the master key |
|
234 | - * |
|
235 | - * @param ProgressBar $progress |
|
236 | - */ |
|
237 | - protected function encryptAllUserFilesWithMasterKey(ProgressBar $progress) { |
|
238 | - $userNo = 1; |
|
239 | - foreach($this->userManager->getBackends() as $backend) { |
|
240 | - $limit = 500; |
|
241 | - $offset = 0; |
|
242 | - do { |
|
243 | - $users = $backend->getUsers('', $limit, $offset); |
|
244 | - foreach ($users as $user) { |
|
245 | - $userCount = "$user ($userNo)"; |
|
246 | - $this->encryptUsersFiles($user, $progress, $userCount); |
|
247 | - $userNo++; |
|
248 | - } |
|
249 | - $offset += $limit; |
|
250 | - } while(count($users) >= $limit); |
|
251 | - } |
|
252 | - } |
|
253 | - |
|
254 | - /** |
|
255 | - * encrypt files from the given user |
|
256 | - * |
|
257 | - * @param string $uid |
|
258 | - * @param ProgressBar $progress |
|
259 | - * @param string $userCount |
|
260 | - */ |
|
261 | - protected function encryptUsersFiles($uid, ProgressBar $progress, $userCount) { |
|
262 | - |
|
263 | - $this->setupUserFS($uid); |
|
264 | - $directories = array(); |
|
265 | - $directories[] = '/' . $uid . '/files'; |
|
266 | - |
|
267 | - while($root = array_pop($directories)) { |
|
268 | - $content = $this->rootView->getDirectoryContent($root); |
|
269 | - foreach ($content as $file) { |
|
270 | - $path = $root . '/' . $file['name']; |
|
271 | - if ($this->rootView->is_dir($path)) { |
|
272 | - $directories[] = $path; |
|
273 | - continue; |
|
274 | - } else { |
|
275 | - $progress->setMessage("encrypt files for user $userCount: $path"); |
|
276 | - $progress->advance(); |
|
277 | - if($this->encryptFile($path) === false) { |
|
278 | - $progress->setMessage("encrypt files for user $userCount: $path (already encrypted)"); |
|
279 | - $progress->advance(); |
|
280 | - } |
|
281 | - } |
|
282 | - } |
|
283 | - } |
|
284 | - } |
|
285 | - |
|
286 | - /** |
|
287 | - * encrypt file |
|
288 | - * |
|
289 | - * @param string $path |
|
290 | - * @return bool |
|
291 | - */ |
|
292 | - protected function encryptFile($path) { |
|
293 | - |
|
294 | - $source = $path; |
|
295 | - $target = $path . '.encrypted.' . time(); |
|
296 | - |
|
297 | - try { |
|
298 | - $this->rootView->copy($source, $target); |
|
299 | - $this->rootView->rename($target, $source); |
|
300 | - } catch (DecryptionFailedException $e) { |
|
301 | - if ($this->rootView->file_exists($target)) { |
|
302 | - $this->rootView->unlink($target); |
|
303 | - } |
|
304 | - return false; |
|
305 | - } |
|
306 | - |
|
307 | - return true; |
|
308 | - } |
|
309 | - |
|
310 | - /** |
|
311 | - * output one-time encryption passwords |
|
312 | - */ |
|
313 | - protected function outputPasswords() { |
|
314 | - $table = new Table($this->output); |
|
315 | - $table->setHeaders(array('Username', 'Private key password')); |
|
316 | - |
|
317 | - //create rows |
|
318 | - $newPasswords = array(); |
|
319 | - $unchangedPasswords = array(); |
|
320 | - foreach ($this->userPasswords as $uid => $password) { |
|
321 | - if (empty($password)) { |
|
322 | - $unchangedPasswords[] = $uid; |
|
323 | - } else { |
|
324 | - $newPasswords[] = [$uid, $password]; |
|
325 | - } |
|
326 | - } |
|
327 | - |
|
328 | - if (empty($newPasswords)) { |
|
329 | - $this->output->writeln("\nAll users already had a key-pair, no further action needed.\n"); |
|
330 | - return; |
|
331 | - } |
|
332 | - |
|
333 | - $table->setRows($newPasswords); |
|
334 | - $table->render(); |
|
335 | - |
|
336 | - if (!empty($unchangedPasswords)) { |
|
337 | - $this->output->writeln("\nThe following users already had a key-pair which was reused without setting a new password:\n"); |
|
338 | - foreach ($unchangedPasswords as $uid) { |
|
339 | - $this->output->writeln(" $uid"); |
|
340 | - } |
|
341 | - } |
|
342 | - |
|
343 | - $this->writePasswordsToFile($newPasswords); |
|
344 | - |
|
345 | - $this->output->writeln(''); |
|
346 | - $question = new ConfirmationQuestion('Do you want to send the passwords directly to the users by mail? (y/n) ', false); |
|
347 | - if ($this->questionHelper->ask($this->input, $this->output, $question)) { |
|
348 | - $this->sendPasswordsByMail(); |
|
349 | - } |
|
350 | - } |
|
351 | - |
|
352 | - /** |
|
353 | - * write one-time encryption passwords to a csv file |
|
354 | - * |
|
355 | - * @param array $passwords |
|
356 | - */ |
|
357 | - protected function writePasswordsToFile(array $passwords) { |
|
358 | - $fp = $this->rootView->fopen('oneTimeEncryptionPasswords.csv', 'w'); |
|
359 | - foreach ($passwords as $pwd) { |
|
360 | - fputcsv($fp, $pwd); |
|
361 | - } |
|
362 | - fclose($fp); |
|
363 | - $this->output->writeln("\n"); |
|
364 | - $this->output->writeln('A list of all newly created passwords was written to data/oneTimeEncryptionPasswords.csv'); |
|
365 | - $this->output->writeln(''); |
|
366 | - $this->output->writeln('Each of these users need to login to the web interface, go to the'); |
|
367 | - $this->output->writeln('personal settings section "basic encryption module" and'); |
|
368 | - $this->output->writeln('update the private key password to match the login password again by'); |
|
369 | - $this->output->writeln('entering the one-time password into the "old log-in password" field'); |
|
370 | - $this->output->writeln('and their current login password'); |
|
371 | - } |
|
372 | - |
|
373 | - /** |
|
374 | - * setup user file system |
|
375 | - * |
|
376 | - * @param string $uid |
|
377 | - */ |
|
378 | - protected function setupUserFS($uid) { |
|
379 | - \OC_Util::tearDownFS(); |
|
380 | - \OC_Util::setupFS($uid); |
|
381 | - } |
|
382 | - |
|
383 | - /** |
|
384 | - * generate one time password for the user and store it in a array |
|
385 | - * |
|
386 | - * @param string $uid |
|
387 | - * @return string password |
|
388 | - */ |
|
389 | - protected function generateOneTimePassword($uid) { |
|
390 | - $password = $this->secureRandom->generate(8); |
|
391 | - $this->userPasswords[$uid] = $password; |
|
392 | - return $password; |
|
393 | - } |
|
394 | - |
|
395 | - /** |
|
396 | - * send encryption key passwords to the users by mail |
|
397 | - */ |
|
398 | - protected function sendPasswordsByMail() { |
|
399 | - $noMail = []; |
|
400 | - |
|
401 | - $this->output->writeln(''); |
|
402 | - $progress = new ProgressBar($this->output, count($this->userPasswords)); |
|
403 | - $progress->start(); |
|
404 | - |
|
405 | - foreach ($this->userPasswords as $uid => $password) { |
|
406 | - $progress->advance(); |
|
407 | - if (!empty($password)) { |
|
408 | - $recipient = $this->userManager->get($uid); |
|
409 | - $recipientDisplayName = $recipient->getDisplayName(); |
|
410 | - $to = $recipient->getEMailAddress(); |
|
411 | - |
|
412 | - if ($to === '') { |
|
413 | - $noMail[] = $uid; |
|
414 | - continue; |
|
415 | - } |
|
416 | - |
|
417 | - $subject = (string)$this->l->t('one-time password for server-side-encryption'); |
|
418 | - list($htmlBody, $textBody) = $this->createMailBody($password); |
|
419 | - |
|
420 | - // send it out now |
|
421 | - try { |
|
422 | - $message = $this->mailer->createMessage(); |
|
423 | - $message->setSubject($subject); |
|
424 | - $message->setTo([$to => $recipientDisplayName]); |
|
425 | - $message->setHtmlBody($htmlBody); |
|
426 | - $message->setPlainBody($textBody); |
|
427 | - $message->setFrom([ |
|
428 | - \OCP\Util::getDefaultEmailAddress('admin-noreply') |
|
429 | - ]); |
|
430 | - |
|
431 | - $this->mailer->send($message); |
|
432 | - } catch (\Exception $e) { |
|
433 | - $noMail[] = $uid; |
|
434 | - } |
|
435 | - } |
|
436 | - } |
|
437 | - |
|
438 | - $progress->finish(); |
|
439 | - |
|
440 | - if (empty($noMail)) { |
|
441 | - $this->output->writeln("\n\nPassword successfully send to all users"); |
|
442 | - } else { |
|
443 | - $table = new Table($this->output); |
|
444 | - $table->setHeaders(array('Username', 'Private key password')); |
|
445 | - $this->output->writeln("\n\nCould not send password to following users:\n"); |
|
446 | - $rows = []; |
|
447 | - foreach ($noMail as $uid) { |
|
448 | - $rows[] = [$uid, $this->userPasswords[$uid]]; |
|
449 | - } |
|
450 | - $table->setRows($rows); |
|
451 | - $table->render(); |
|
452 | - } |
|
453 | - |
|
454 | - } |
|
455 | - |
|
456 | - /** |
|
457 | - * create mail body for plain text and html mail |
|
458 | - * |
|
459 | - * @param string $password one-time encryption password |
|
460 | - * @return array an array of the html mail body and the plain text mail body |
|
461 | - */ |
|
462 | - protected function createMailBody($password) { |
|
463 | - |
|
464 | - $html = new \OC_Template("encryption", "mail", ""); |
|
465 | - $html->assign ('password', $password); |
|
466 | - $htmlMail = $html->fetchPage(); |
|
467 | - |
|
468 | - $plainText = new \OC_Template("encryption", "altmail", ""); |
|
469 | - $plainText->assign ('password', $password); |
|
470 | - $plainTextMail = $plainText->fetchPage(); |
|
471 | - |
|
472 | - return [$htmlMail, $plainTextMail]; |
|
473 | - } |
|
48 | + /** @var Setup */ |
|
49 | + protected $userSetup; |
|
50 | + |
|
51 | + /** @var IUserManager */ |
|
52 | + protected $userManager; |
|
53 | + |
|
54 | + /** @var View */ |
|
55 | + protected $rootView; |
|
56 | + |
|
57 | + /** @var KeyManager */ |
|
58 | + protected $keyManager; |
|
59 | + |
|
60 | + /** @var Util */ |
|
61 | + protected $util; |
|
62 | + |
|
63 | + /** @var array */ |
|
64 | + protected $userPasswords; |
|
65 | + |
|
66 | + /** @var IConfig */ |
|
67 | + protected $config; |
|
68 | + |
|
69 | + /** @var IMailer */ |
|
70 | + protected $mailer; |
|
71 | + |
|
72 | + /** @var IL10N */ |
|
73 | + protected $l; |
|
74 | + |
|
75 | + /** @var QuestionHelper */ |
|
76 | + protected $questionHelper; |
|
77 | + |
|
78 | + /** @var OutputInterface */ |
|
79 | + protected $output; |
|
80 | + |
|
81 | + /** @var InputInterface */ |
|
82 | + protected $input; |
|
83 | + |
|
84 | + /** @var ISecureRandom */ |
|
85 | + protected $secureRandom; |
|
86 | + |
|
87 | + /** |
|
88 | + * @param Setup $userSetup |
|
89 | + * @param IUserManager $userManager |
|
90 | + * @param View $rootView |
|
91 | + * @param KeyManager $keyManager |
|
92 | + * @param Util $util |
|
93 | + * @param IConfig $config |
|
94 | + * @param IMailer $mailer |
|
95 | + * @param IL10N $l |
|
96 | + * @param QuestionHelper $questionHelper |
|
97 | + * @param ISecureRandom $secureRandom |
|
98 | + */ |
|
99 | + public function __construct( |
|
100 | + Setup $userSetup, |
|
101 | + IUserManager $userManager, |
|
102 | + View $rootView, |
|
103 | + KeyManager $keyManager, |
|
104 | + Util $util, |
|
105 | + IConfig $config, |
|
106 | + IMailer $mailer, |
|
107 | + IL10N $l, |
|
108 | + QuestionHelper $questionHelper, |
|
109 | + ISecureRandom $secureRandom |
|
110 | + ) { |
|
111 | + $this->userSetup = $userSetup; |
|
112 | + $this->userManager = $userManager; |
|
113 | + $this->rootView = $rootView; |
|
114 | + $this->keyManager = $keyManager; |
|
115 | + $this->util = $util; |
|
116 | + $this->config = $config; |
|
117 | + $this->mailer = $mailer; |
|
118 | + $this->l = $l; |
|
119 | + $this->questionHelper = $questionHelper; |
|
120 | + $this->secureRandom = $secureRandom; |
|
121 | + // store one time passwords for the users |
|
122 | + $this->userPasswords = array(); |
|
123 | + } |
|
124 | + |
|
125 | + /** |
|
126 | + * start to encrypt all files |
|
127 | + * |
|
128 | + * @param InputInterface $input |
|
129 | + * @param OutputInterface $output |
|
130 | + */ |
|
131 | + public function encryptAll(InputInterface $input, OutputInterface $output) { |
|
132 | + |
|
133 | + $this->input = $input; |
|
134 | + $this->output = $output; |
|
135 | + |
|
136 | + $headline = 'Encrypt all files with the ' . Encryption::DISPLAY_NAME; |
|
137 | + $this->output->writeln("\n"); |
|
138 | + $this->output->writeln($headline); |
|
139 | + $this->output->writeln(str_pad('', strlen($headline), '=')); |
|
140 | + $this->output->writeln("\n"); |
|
141 | + |
|
142 | + if ($this->util->isMasterKeyEnabled()) { |
|
143 | + $this->output->writeln('Use master key to encrypt all files.'); |
|
144 | + $this->keyManager->validateMasterKey(); |
|
145 | + } else { |
|
146 | + //create private/public keys for each user and store the private key password |
|
147 | + $this->output->writeln('Create key-pair for every user'); |
|
148 | + $this->output->writeln('------------------------------'); |
|
149 | + $this->output->writeln(''); |
|
150 | + $this->output->writeln('This module will encrypt all files in the users files folder initially.'); |
|
151 | + $this->output->writeln('Already existing versions and files in the trash bin will not be encrypted.'); |
|
152 | + $this->output->writeln(''); |
|
153 | + $this->createKeyPairs(); |
|
154 | + } |
|
155 | + |
|
156 | + //setup users file system and encrypt all files one by one (take should encrypt setting of storage into account) |
|
157 | + $this->output->writeln("\n"); |
|
158 | + $this->output->writeln('Start to encrypt users files'); |
|
159 | + $this->output->writeln('----------------------------'); |
|
160 | + $this->output->writeln(''); |
|
161 | + $this->encryptAllUsersFiles(); |
|
162 | + if ($this->util->isMasterKeyEnabled() === false) { |
|
163 | + //send-out or display password list and write it to a file |
|
164 | + $this->output->writeln("\n"); |
|
165 | + $this->output->writeln('Generated encryption key passwords'); |
|
166 | + $this->output->writeln('----------------------------------'); |
|
167 | + $this->output->writeln(''); |
|
168 | + $this->outputPasswords(); |
|
169 | + } |
|
170 | + $this->output->writeln("\n"); |
|
171 | + } |
|
172 | + |
|
173 | + /** |
|
174 | + * create key-pair for every user |
|
175 | + */ |
|
176 | + protected function createKeyPairs() { |
|
177 | + $this->output->writeln("\n"); |
|
178 | + $progress = new ProgressBar($this->output); |
|
179 | + $progress->setFormat(" %message% \n [%bar%]"); |
|
180 | + $progress->start(); |
|
181 | + |
|
182 | + foreach($this->userManager->getBackends() as $backend) { |
|
183 | + $limit = 500; |
|
184 | + $offset = 0; |
|
185 | + do { |
|
186 | + $users = $backend->getUsers('', $limit, $offset); |
|
187 | + foreach ($users as $user) { |
|
188 | + if ($this->keyManager->userHasKeys($user) === false) { |
|
189 | + $progress->setMessage('Create key-pair for ' . $user); |
|
190 | + $progress->advance(); |
|
191 | + $this->setupUserFS($user); |
|
192 | + $password = $this->generateOneTimePassword($user); |
|
193 | + $this->userSetup->setupUser($user, $password); |
|
194 | + } else { |
|
195 | + // users which already have a key-pair will be stored with a |
|
196 | + // empty password and filtered out later |
|
197 | + $this->userPasswords[$user] = ''; |
|
198 | + } |
|
199 | + } |
|
200 | + $offset += $limit; |
|
201 | + } while(count($users) >= $limit); |
|
202 | + } |
|
203 | + |
|
204 | + $progress->setMessage('Key-pair created for all users'); |
|
205 | + $progress->finish(); |
|
206 | + } |
|
207 | + |
|
208 | + /** |
|
209 | + * iterate over all user and encrypt their files |
|
210 | + */ |
|
211 | + protected function encryptAllUsersFiles() { |
|
212 | + $this->output->writeln("\n"); |
|
213 | + $progress = new ProgressBar($this->output); |
|
214 | + $progress->setFormat(" %message% \n [%bar%]"); |
|
215 | + $progress->start(); |
|
216 | + $numberOfUsers = count($this->userPasswords); |
|
217 | + $userNo = 1; |
|
218 | + if ($this->util->isMasterKeyEnabled()) { |
|
219 | + $this->encryptAllUserFilesWithMasterKey($progress); |
|
220 | + } else { |
|
221 | + foreach ($this->userPasswords as $uid => $password) { |
|
222 | + $userCount = "$uid ($userNo of $numberOfUsers)"; |
|
223 | + $this->encryptUsersFiles($uid, $progress, $userCount); |
|
224 | + $userNo++; |
|
225 | + } |
|
226 | + } |
|
227 | + $progress->setMessage("all files encrypted"); |
|
228 | + $progress->finish(); |
|
229 | + |
|
230 | + } |
|
231 | + |
|
232 | + /** |
|
233 | + * encrypt all user files with the master key |
|
234 | + * |
|
235 | + * @param ProgressBar $progress |
|
236 | + */ |
|
237 | + protected function encryptAllUserFilesWithMasterKey(ProgressBar $progress) { |
|
238 | + $userNo = 1; |
|
239 | + foreach($this->userManager->getBackends() as $backend) { |
|
240 | + $limit = 500; |
|
241 | + $offset = 0; |
|
242 | + do { |
|
243 | + $users = $backend->getUsers('', $limit, $offset); |
|
244 | + foreach ($users as $user) { |
|
245 | + $userCount = "$user ($userNo)"; |
|
246 | + $this->encryptUsersFiles($user, $progress, $userCount); |
|
247 | + $userNo++; |
|
248 | + } |
|
249 | + $offset += $limit; |
|
250 | + } while(count($users) >= $limit); |
|
251 | + } |
|
252 | + } |
|
253 | + |
|
254 | + /** |
|
255 | + * encrypt files from the given user |
|
256 | + * |
|
257 | + * @param string $uid |
|
258 | + * @param ProgressBar $progress |
|
259 | + * @param string $userCount |
|
260 | + */ |
|
261 | + protected function encryptUsersFiles($uid, ProgressBar $progress, $userCount) { |
|
262 | + |
|
263 | + $this->setupUserFS($uid); |
|
264 | + $directories = array(); |
|
265 | + $directories[] = '/' . $uid . '/files'; |
|
266 | + |
|
267 | + while($root = array_pop($directories)) { |
|
268 | + $content = $this->rootView->getDirectoryContent($root); |
|
269 | + foreach ($content as $file) { |
|
270 | + $path = $root . '/' . $file['name']; |
|
271 | + if ($this->rootView->is_dir($path)) { |
|
272 | + $directories[] = $path; |
|
273 | + continue; |
|
274 | + } else { |
|
275 | + $progress->setMessage("encrypt files for user $userCount: $path"); |
|
276 | + $progress->advance(); |
|
277 | + if($this->encryptFile($path) === false) { |
|
278 | + $progress->setMessage("encrypt files for user $userCount: $path (already encrypted)"); |
|
279 | + $progress->advance(); |
|
280 | + } |
|
281 | + } |
|
282 | + } |
|
283 | + } |
|
284 | + } |
|
285 | + |
|
286 | + /** |
|
287 | + * encrypt file |
|
288 | + * |
|
289 | + * @param string $path |
|
290 | + * @return bool |
|
291 | + */ |
|
292 | + protected function encryptFile($path) { |
|
293 | + |
|
294 | + $source = $path; |
|
295 | + $target = $path . '.encrypted.' . time(); |
|
296 | + |
|
297 | + try { |
|
298 | + $this->rootView->copy($source, $target); |
|
299 | + $this->rootView->rename($target, $source); |
|
300 | + } catch (DecryptionFailedException $e) { |
|
301 | + if ($this->rootView->file_exists($target)) { |
|
302 | + $this->rootView->unlink($target); |
|
303 | + } |
|
304 | + return false; |
|
305 | + } |
|
306 | + |
|
307 | + return true; |
|
308 | + } |
|
309 | + |
|
310 | + /** |
|
311 | + * output one-time encryption passwords |
|
312 | + */ |
|
313 | + protected function outputPasswords() { |
|
314 | + $table = new Table($this->output); |
|
315 | + $table->setHeaders(array('Username', 'Private key password')); |
|
316 | + |
|
317 | + //create rows |
|
318 | + $newPasswords = array(); |
|
319 | + $unchangedPasswords = array(); |
|
320 | + foreach ($this->userPasswords as $uid => $password) { |
|
321 | + if (empty($password)) { |
|
322 | + $unchangedPasswords[] = $uid; |
|
323 | + } else { |
|
324 | + $newPasswords[] = [$uid, $password]; |
|
325 | + } |
|
326 | + } |
|
327 | + |
|
328 | + if (empty($newPasswords)) { |
|
329 | + $this->output->writeln("\nAll users already had a key-pair, no further action needed.\n"); |
|
330 | + return; |
|
331 | + } |
|
332 | + |
|
333 | + $table->setRows($newPasswords); |
|
334 | + $table->render(); |
|
335 | + |
|
336 | + if (!empty($unchangedPasswords)) { |
|
337 | + $this->output->writeln("\nThe following users already had a key-pair which was reused without setting a new password:\n"); |
|
338 | + foreach ($unchangedPasswords as $uid) { |
|
339 | + $this->output->writeln(" $uid"); |
|
340 | + } |
|
341 | + } |
|
342 | + |
|
343 | + $this->writePasswordsToFile($newPasswords); |
|
344 | + |
|
345 | + $this->output->writeln(''); |
|
346 | + $question = new ConfirmationQuestion('Do you want to send the passwords directly to the users by mail? (y/n) ', false); |
|
347 | + if ($this->questionHelper->ask($this->input, $this->output, $question)) { |
|
348 | + $this->sendPasswordsByMail(); |
|
349 | + } |
|
350 | + } |
|
351 | + |
|
352 | + /** |
|
353 | + * write one-time encryption passwords to a csv file |
|
354 | + * |
|
355 | + * @param array $passwords |
|
356 | + */ |
|
357 | + protected function writePasswordsToFile(array $passwords) { |
|
358 | + $fp = $this->rootView->fopen('oneTimeEncryptionPasswords.csv', 'w'); |
|
359 | + foreach ($passwords as $pwd) { |
|
360 | + fputcsv($fp, $pwd); |
|
361 | + } |
|
362 | + fclose($fp); |
|
363 | + $this->output->writeln("\n"); |
|
364 | + $this->output->writeln('A list of all newly created passwords was written to data/oneTimeEncryptionPasswords.csv'); |
|
365 | + $this->output->writeln(''); |
|
366 | + $this->output->writeln('Each of these users need to login to the web interface, go to the'); |
|
367 | + $this->output->writeln('personal settings section "basic encryption module" and'); |
|
368 | + $this->output->writeln('update the private key password to match the login password again by'); |
|
369 | + $this->output->writeln('entering the one-time password into the "old log-in password" field'); |
|
370 | + $this->output->writeln('and their current login password'); |
|
371 | + } |
|
372 | + |
|
373 | + /** |
|
374 | + * setup user file system |
|
375 | + * |
|
376 | + * @param string $uid |
|
377 | + */ |
|
378 | + protected function setupUserFS($uid) { |
|
379 | + \OC_Util::tearDownFS(); |
|
380 | + \OC_Util::setupFS($uid); |
|
381 | + } |
|
382 | + |
|
383 | + /** |
|
384 | + * generate one time password for the user and store it in a array |
|
385 | + * |
|
386 | + * @param string $uid |
|
387 | + * @return string password |
|
388 | + */ |
|
389 | + protected function generateOneTimePassword($uid) { |
|
390 | + $password = $this->secureRandom->generate(8); |
|
391 | + $this->userPasswords[$uid] = $password; |
|
392 | + return $password; |
|
393 | + } |
|
394 | + |
|
395 | + /** |
|
396 | + * send encryption key passwords to the users by mail |
|
397 | + */ |
|
398 | + protected function sendPasswordsByMail() { |
|
399 | + $noMail = []; |
|
400 | + |
|
401 | + $this->output->writeln(''); |
|
402 | + $progress = new ProgressBar($this->output, count($this->userPasswords)); |
|
403 | + $progress->start(); |
|
404 | + |
|
405 | + foreach ($this->userPasswords as $uid => $password) { |
|
406 | + $progress->advance(); |
|
407 | + if (!empty($password)) { |
|
408 | + $recipient = $this->userManager->get($uid); |
|
409 | + $recipientDisplayName = $recipient->getDisplayName(); |
|
410 | + $to = $recipient->getEMailAddress(); |
|
411 | + |
|
412 | + if ($to === '') { |
|
413 | + $noMail[] = $uid; |
|
414 | + continue; |
|
415 | + } |
|
416 | + |
|
417 | + $subject = (string)$this->l->t('one-time password for server-side-encryption'); |
|
418 | + list($htmlBody, $textBody) = $this->createMailBody($password); |
|
419 | + |
|
420 | + // send it out now |
|
421 | + try { |
|
422 | + $message = $this->mailer->createMessage(); |
|
423 | + $message->setSubject($subject); |
|
424 | + $message->setTo([$to => $recipientDisplayName]); |
|
425 | + $message->setHtmlBody($htmlBody); |
|
426 | + $message->setPlainBody($textBody); |
|
427 | + $message->setFrom([ |
|
428 | + \OCP\Util::getDefaultEmailAddress('admin-noreply') |
|
429 | + ]); |
|
430 | + |
|
431 | + $this->mailer->send($message); |
|
432 | + } catch (\Exception $e) { |
|
433 | + $noMail[] = $uid; |
|
434 | + } |
|
435 | + } |
|
436 | + } |
|
437 | + |
|
438 | + $progress->finish(); |
|
439 | + |
|
440 | + if (empty($noMail)) { |
|
441 | + $this->output->writeln("\n\nPassword successfully send to all users"); |
|
442 | + } else { |
|
443 | + $table = new Table($this->output); |
|
444 | + $table->setHeaders(array('Username', 'Private key password')); |
|
445 | + $this->output->writeln("\n\nCould not send password to following users:\n"); |
|
446 | + $rows = []; |
|
447 | + foreach ($noMail as $uid) { |
|
448 | + $rows[] = [$uid, $this->userPasswords[$uid]]; |
|
449 | + } |
|
450 | + $table->setRows($rows); |
|
451 | + $table->render(); |
|
452 | + } |
|
453 | + |
|
454 | + } |
|
455 | + |
|
456 | + /** |
|
457 | + * create mail body for plain text and html mail |
|
458 | + * |
|
459 | + * @param string $password one-time encryption password |
|
460 | + * @return array an array of the html mail body and the plain text mail body |
|
461 | + */ |
|
462 | + protected function createMailBody($password) { |
|
463 | + |
|
464 | + $html = new \OC_Template("encryption", "mail", ""); |
|
465 | + $html->assign ('password', $password); |
|
466 | + $htmlMail = $html->fetchPage(); |
|
467 | + |
|
468 | + $plainText = new \OC_Template("encryption", "altmail", ""); |
|
469 | + $plainText->assign ('password', $password); |
|
470 | + $plainTextMail = $plainText->fetchPage(); |
|
471 | + |
|
472 | + return [$htmlMail, $plainTextMail]; |
|
473 | + } |
|
474 | 474 | |
475 | 475 | } |
@@ -35,127 +35,127 @@ |
||
35 | 35 | |
36 | 36 | class DecryptAll { |
37 | 37 | |
38 | - /** @var Util */ |
|
39 | - protected $util; |
|
40 | - |
|
41 | - /** @var QuestionHelper */ |
|
42 | - protected $questionHelper; |
|
43 | - |
|
44 | - /** @var Crypt */ |
|
45 | - protected $crypt; |
|
46 | - |
|
47 | - /** @var KeyManager */ |
|
48 | - protected $keyManager; |
|
49 | - |
|
50 | - /** @var Session */ |
|
51 | - protected $session; |
|
52 | - |
|
53 | - /** |
|
54 | - * @param Util $util |
|
55 | - * @param KeyManager $keyManager |
|
56 | - * @param Crypt $crypt |
|
57 | - * @param Session $session |
|
58 | - * @param QuestionHelper $questionHelper |
|
59 | - */ |
|
60 | - public function __construct( |
|
61 | - Util $util, |
|
62 | - KeyManager $keyManager, |
|
63 | - Crypt $crypt, |
|
64 | - Session $session, |
|
65 | - QuestionHelper $questionHelper |
|
66 | - ) { |
|
67 | - $this->util = $util; |
|
68 | - $this->keyManager = $keyManager; |
|
69 | - $this->crypt = $crypt; |
|
70 | - $this->session = $session; |
|
71 | - $this->questionHelper = $questionHelper; |
|
72 | - } |
|
73 | - |
|
74 | - /** |
|
75 | - * prepare encryption module to decrypt all files |
|
76 | - * |
|
77 | - * @param InputInterface $input |
|
78 | - * @param OutputInterface $output |
|
79 | - * @param $user |
|
80 | - * @return bool |
|
81 | - */ |
|
82 | - public function prepare(InputInterface $input, OutputInterface $output, $user) { |
|
83 | - |
|
84 | - $question = new Question('Please enter the recovery key password: '); |
|
85 | - |
|
86 | - if($this->util->isMasterKeyEnabled()) { |
|
87 | - $output->writeln('Use master key to decrypt all files'); |
|
88 | - $user = $this->keyManager->getMasterKeyId(); |
|
89 | - $password =$this->keyManager->getMasterKeyPassword(); |
|
90 | - } else { |
|
91 | - $recoveryKeyId = $this->keyManager->getRecoveryKeyId(); |
|
92 | - if (!empty($user)) { |
|
93 | - $output->writeln('You can only decrypt the users files if you know'); |
|
94 | - $output->writeln('the users password or if he activated the recovery key.'); |
|
95 | - $output->writeln(''); |
|
96 | - $questionUseLoginPassword = new ConfirmationQuestion( |
|
97 | - 'Do you want to use the users login password to decrypt all files? (y/n) ', |
|
98 | - false |
|
99 | - ); |
|
100 | - $useLoginPassword = $this->questionHelper->ask($input, $output, $questionUseLoginPassword); |
|
101 | - if ($useLoginPassword) { |
|
102 | - $question = new Question('Please enter the user\'s login password: '); |
|
103 | - } else if ($this->util->isRecoveryEnabledForUser($user) === false) { |
|
104 | - $output->writeln('No recovery key available for user ' . $user); |
|
105 | - return false; |
|
106 | - } else { |
|
107 | - $user = $recoveryKeyId; |
|
108 | - } |
|
109 | - } else { |
|
110 | - $output->writeln('You can only decrypt the files of all users if the'); |
|
111 | - $output->writeln('recovery key is enabled by the admin and activated by the users.'); |
|
112 | - $output->writeln(''); |
|
113 | - $user = $recoveryKeyId; |
|
114 | - } |
|
115 | - |
|
116 | - $question->setHidden(true); |
|
117 | - $question->setHiddenFallback(false); |
|
118 | - $password = $this->questionHelper->ask($input, $output, $question); |
|
119 | - } |
|
120 | - |
|
121 | - $privateKey = $this->getPrivateKey($user, $password); |
|
122 | - if ($privateKey !== false) { |
|
123 | - $this->updateSession($user, $privateKey); |
|
124 | - return true; |
|
125 | - } else { |
|
126 | - $output->writeln('Could not decrypt private key, maybe you entered the wrong password?'); |
|
127 | - } |
|
128 | - |
|
129 | - |
|
130 | - return false; |
|
131 | - } |
|
132 | - |
|
133 | - /** |
|
134 | - * get the private key which will be used to decrypt all files |
|
135 | - * |
|
136 | - * @param string $user |
|
137 | - * @param string $password |
|
138 | - * @return bool|string |
|
139 | - * @throws \OCA\Encryption\Exceptions\PrivateKeyMissingException |
|
140 | - */ |
|
141 | - protected function getPrivateKey($user, $password) { |
|
142 | - $recoveryKeyId = $this->keyManager->getRecoveryKeyId(); |
|
143 | - $masterKeyId = $this->keyManager->getMasterKeyId(); |
|
144 | - if ($user === $recoveryKeyId) { |
|
145 | - $recoveryKey = $this->keyManager->getSystemPrivateKey($recoveryKeyId); |
|
146 | - $privateKey = $this->crypt->decryptPrivateKey($recoveryKey, $password); |
|
147 | - } elseif ($user === $masterKeyId) { |
|
148 | - $masterKey = $this->keyManager->getSystemPrivateKey($masterKeyId); |
|
149 | - $privateKey = $this->crypt->decryptPrivateKey($masterKey, $password, $masterKeyId); |
|
150 | - } else { |
|
151 | - $userKey = $this->keyManager->getPrivateKey($user); |
|
152 | - $privateKey = $this->crypt->decryptPrivateKey($userKey, $password, $user); |
|
153 | - } |
|
154 | - |
|
155 | - return $privateKey; |
|
156 | - } |
|
157 | - |
|
158 | - protected function updateSession($user, $privateKey) { |
|
159 | - $this->session->prepareDecryptAll($user, $privateKey); |
|
160 | - } |
|
38 | + /** @var Util */ |
|
39 | + protected $util; |
|
40 | + |
|
41 | + /** @var QuestionHelper */ |
|
42 | + protected $questionHelper; |
|
43 | + |
|
44 | + /** @var Crypt */ |
|
45 | + protected $crypt; |
|
46 | + |
|
47 | + /** @var KeyManager */ |
|
48 | + protected $keyManager; |
|
49 | + |
|
50 | + /** @var Session */ |
|
51 | + protected $session; |
|
52 | + |
|
53 | + /** |
|
54 | + * @param Util $util |
|
55 | + * @param KeyManager $keyManager |
|
56 | + * @param Crypt $crypt |
|
57 | + * @param Session $session |
|
58 | + * @param QuestionHelper $questionHelper |
|
59 | + */ |
|
60 | + public function __construct( |
|
61 | + Util $util, |
|
62 | + KeyManager $keyManager, |
|
63 | + Crypt $crypt, |
|
64 | + Session $session, |
|
65 | + QuestionHelper $questionHelper |
|
66 | + ) { |
|
67 | + $this->util = $util; |
|
68 | + $this->keyManager = $keyManager; |
|
69 | + $this->crypt = $crypt; |
|
70 | + $this->session = $session; |
|
71 | + $this->questionHelper = $questionHelper; |
|
72 | + } |
|
73 | + |
|
74 | + /** |
|
75 | + * prepare encryption module to decrypt all files |
|
76 | + * |
|
77 | + * @param InputInterface $input |
|
78 | + * @param OutputInterface $output |
|
79 | + * @param $user |
|
80 | + * @return bool |
|
81 | + */ |
|
82 | + public function prepare(InputInterface $input, OutputInterface $output, $user) { |
|
83 | + |
|
84 | + $question = new Question('Please enter the recovery key password: '); |
|
85 | + |
|
86 | + if($this->util->isMasterKeyEnabled()) { |
|
87 | + $output->writeln('Use master key to decrypt all files'); |
|
88 | + $user = $this->keyManager->getMasterKeyId(); |
|
89 | + $password =$this->keyManager->getMasterKeyPassword(); |
|
90 | + } else { |
|
91 | + $recoveryKeyId = $this->keyManager->getRecoveryKeyId(); |
|
92 | + if (!empty($user)) { |
|
93 | + $output->writeln('You can only decrypt the users files if you know'); |
|
94 | + $output->writeln('the users password or if he activated the recovery key.'); |
|
95 | + $output->writeln(''); |
|
96 | + $questionUseLoginPassword = new ConfirmationQuestion( |
|
97 | + 'Do you want to use the users login password to decrypt all files? (y/n) ', |
|
98 | + false |
|
99 | + ); |
|
100 | + $useLoginPassword = $this->questionHelper->ask($input, $output, $questionUseLoginPassword); |
|
101 | + if ($useLoginPassword) { |
|
102 | + $question = new Question('Please enter the user\'s login password: '); |
|
103 | + } else if ($this->util->isRecoveryEnabledForUser($user) === false) { |
|
104 | + $output->writeln('No recovery key available for user ' . $user); |
|
105 | + return false; |
|
106 | + } else { |
|
107 | + $user = $recoveryKeyId; |
|
108 | + } |
|
109 | + } else { |
|
110 | + $output->writeln('You can only decrypt the files of all users if the'); |
|
111 | + $output->writeln('recovery key is enabled by the admin and activated by the users.'); |
|
112 | + $output->writeln(''); |
|
113 | + $user = $recoveryKeyId; |
|
114 | + } |
|
115 | + |
|
116 | + $question->setHidden(true); |
|
117 | + $question->setHiddenFallback(false); |
|
118 | + $password = $this->questionHelper->ask($input, $output, $question); |
|
119 | + } |
|
120 | + |
|
121 | + $privateKey = $this->getPrivateKey($user, $password); |
|
122 | + if ($privateKey !== false) { |
|
123 | + $this->updateSession($user, $privateKey); |
|
124 | + return true; |
|
125 | + } else { |
|
126 | + $output->writeln('Could not decrypt private key, maybe you entered the wrong password?'); |
|
127 | + } |
|
128 | + |
|
129 | + |
|
130 | + return false; |
|
131 | + } |
|
132 | + |
|
133 | + /** |
|
134 | + * get the private key which will be used to decrypt all files |
|
135 | + * |
|
136 | + * @param string $user |
|
137 | + * @param string $password |
|
138 | + * @return bool|string |
|
139 | + * @throws \OCA\Encryption\Exceptions\PrivateKeyMissingException |
|
140 | + */ |
|
141 | + protected function getPrivateKey($user, $password) { |
|
142 | + $recoveryKeyId = $this->keyManager->getRecoveryKeyId(); |
|
143 | + $masterKeyId = $this->keyManager->getMasterKeyId(); |
|
144 | + if ($user === $recoveryKeyId) { |
|
145 | + $recoveryKey = $this->keyManager->getSystemPrivateKey($recoveryKeyId); |
|
146 | + $privateKey = $this->crypt->decryptPrivateKey($recoveryKey, $password); |
|
147 | + } elseif ($user === $masterKeyId) { |
|
148 | + $masterKey = $this->keyManager->getSystemPrivateKey($masterKeyId); |
|
149 | + $privateKey = $this->crypt->decryptPrivateKey($masterKey, $password, $masterKeyId); |
|
150 | + } else { |
|
151 | + $userKey = $this->keyManager->getPrivateKey($user); |
|
152 | + $privateKey = $this->crypt->decryptPrivateKey($userKey, $password, $user); |
|
153 | + } |
|
154 | + |
|
155 | + return $privateKey; |
|
156 | + } |
|
157 | + |
|
158 | + protected function updateSession($user, $privateKey) { |
|
159 | + $this->session->prepareDecryptAll($user, $privateKey); |
|
160 | + } |
|
161 | 161 | } |
@@ -28,38 +28,38 @@ |
||
28 | 28 | |
29 | 29 | class HookManager { |
30 | 30 | |
31 | - private $hookInstances = []; |
|
31 | + private $hookInstances = []; |
|
32 | 32 | |
33 | - /** |
|
34 | - * @param array|IHook $instances |
|
35 | - * - This accepts either a single instance of IHook or an array of instances of IHook |
|
36 | - * @return bool |
|
37 | - */ |
|
38 | - public function registerHook($instances) { |
|
39 | - if (is_array($instances)) { |
|
40 | - foreach ($instances as $instance) { |
|
41 | - if (!$instance instanceof IHook) { |
|
42 | - return false; |
|
43 | - } |
|
44 | - $this->hookInstances[] = $instance; |
|
45 | - } |
|
33 | + /** |
|
34 | + * @param array|IHook $instances |
|
35 | + * - This accepts either a single instance of IHook or an array of instances of IHook |
|
36 | + * @return bool |
|
37 | + */ |
|
38 | + public function registerHook($instances) { |
|
39 | + if (is_array($instances)) { |
|
40 | + foreach ($instances as $instance) { |
|
41 | + if (!$instance instanceof IHook) { |
|
42 | + return false; |
|
43 | + } |
|
44 | + $this->hookInstances[] = $instance; |
|
45 | + } |
|
46 | 46 | |
47 | - } elseif ($instances instanceof IHook) { |
|
48 | - $this->hookInstances[] = $instances; |
|
49 | - } |
|
50 | - return true; |
|
51 | - } |
|
47 | + } elseif ($instances instanceof IHook) { |
|
48 | + $this->hookInstances[] = $instances; |
|
49 | + } |
|
50 | + return true; |
|
51 | + } |
|
52 | 52 | |
53 | - public function fireHooks() { |
|
54 | - foreach ($this->hookInstances as $instance) { |
|
55 | - /** |
|
56 | - * Fire off the add hooks method of each instance stored in cache |
|
57 | - * |
|
58 | - * @var $instance IHook |
|
59 | - */ |
|
60 | - $instance->addHooks(); |
|
61 | - } |
|
53 | + public function fireHooks() { |
|
54 | + foreach ($this->hookInstances as $instance) { |
|
55 | + /** |
|
56 | + * Fire off the add hooks method of each instance stored in cache |
|
57 | + * |
|
58 | + * @var $instance IHook |
|
59 | + */ |
|
60 | + $instance->addHooks(); |
|
61 | + } |
|
62 | 62 | |
63 | - } |
|
63 | + } |
|
64 | 64 | |
65 | 65 | } |
@@ -26,36 +26,36 @@ |
||
26 | 26 | |
27 | 27 | (new Application())->registerRoutes($this, array('routes' => array( |
28 | 28 | |
29 | - [ |
|
30 | - 'name' => 'Recovery#adminRecovery', |
|
31 | - 'url' => '/ajax/adminRecovery', |
|
32 | - 'verb' => 'POST' |
|
33 | - ], |
|
34 | - [ |
|
35 | - 'name' => 'Settings#updatePrivateKeyPassword', |
|
36 | - 'url' => '/ajax/updatePrivateKeyPassword', |
|
37 | - 'verb' => 'POST' |
|
38 | - ], |
|
39 | - [ |
|
40 | - 'name' => 'Settings#setEncryptHomeStorage', |
|
41 | - 'url' => '/ajax/setEncryptHomeStorage', |
|
42 | - 'verb' => 'POST' |
|
43 | - ], |
|
44 | - [ |
|
45 | - 'name' => 'Recovery#changeRecoveryPassword', |
|
46 | - 'url' => '/ajax/changeRecoveryPassword', |
|
47 | - 'verb' => 'POST' |
|
48 | - ], |
|
49 | - [ |
|
50 | - 'name' => 'Recovery#userSetRecovery', |
|
51 | - 'url' => '/ajax/userSetRecovery', |
|
52 | - 'verb' => 'POST' |
|
53 | - ], |
|
54 | - [ |
|
55 | - 'name' => 'Status#getStatus', |
|
56 | - 'url' => '/ajax/getStatus', |
|
57 | - 'verb' => 'GET' |
|
58 | - ] |
|
29 | + [ |
|
30 | + 'name' => 'Recovery#adminRecovery', |
|
31 | + 'url' => '/ajax/adminRecovery', |
|
32 | + 'verb' => 'POST' |
|
33 | + ], |
|
34 | + [ |
|
35 | + 'name' => 'Settings#updatePrivateKeyPassword', |
|
36 | + 'url' => '/ajax/updatePrivateKeyPassword', |
|
37 | + 'verb' => 'POST' |
|
38 | + ], |
|
39 | + [ |
|
40 | + 'name' => 'Settings#setEncryptHomeStorage', |
|
41 | + 'url' => '/ajax/setEncryptHomeStorage', |
|
42 | + 'verb' => 'POST' |
|
43 | + ], |
|
44 | + [ |
|
45 | + 'name' => 'Recovery#changeRecoveryPassword', |
|
46 | + 'url' => '/ajax/changeRecoveryPassword', |
|
47 | + 'verb' => 'POST' |
|
48 | + ], |
|
49 | + [ |
|
50 | + 'name' => 'Recovery#userSetRecovery', |
|
51 | + 'url' => '/ajax/userSetRecovery', |
|
52 | + 'verb' => 'POST' |
|
53 | + ], |
|
54 | + [ |
|
55 | + 'name' => 'Status#getStatus', |
|
56 | + 'url' => '/ajax/getStatus', |
|
57 | + 'verb' => 'GET' |
|
58 | + ] |
|
59 | 59 | |
60 | 60 | |
61 | 61 | ))); |
@@ -29,7 +29,7 @@ |
||
29 | 29 | |
30 | 30 | $app = new Application([], $encryptionSystemReady); |
31 | 31 | if ($encryptionSystemReady) { |
32 | - $app->registerEncryptionModule(); |
|
33 | - $app->registerHooks(); |
|
34 | - $app->registerSettings(); |
|
32 | + $app->registerEncryptionModule(); |
|
33 | + $app->registerHooks(); |
|
34 | + $app->registerSettings(); |
|
35 | 35 | } |