Completed
Push — master ( a17a40...c08e86 )
by Joas
03:00 queued 10s
created

PushController::updatePushToken()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 15
Code Lines 12

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 3
Bugs 0 Features 0
Metric Value
c 3
b 0
f 0
dl 0
loc 15
ccs 0
cts 12
cp 0
rs 9.4285
cc 1
eloc 12
nc 1
nop 6
crap 2
1
<?php
2
/**
3
 * @copyright Copyright (c) 2017 Joas Schilling <[email protected]>
4
 *
5
 * @license GNU AGPL version 3 or any later version
6
 *
7
 * This program is free software: you can redistribute it and/or modify
8
 * it under the terms of the GNU Affero General Public License as
9
 * published by the Free Software Foundation, either version 3 of the
10
 * License, or (at your option) any later version.
11
 *
12
 * This program is distributed in the hope that it will be useful,
13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15
 * GNU Affero General Public License for more details.
16
 *
17
 * You should have received a copy of the GNU Affero General Public License
18
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19
 *
20
 */
21
22
namespace OCA\Notifications\Controller;
23
24
use OC\Authentication\Exceptions\InvalidTokenException;
25
use OC\Authentication\Token\IProvider;
26
use OC\Authentication\Token\IToken;
27
use OC\Security\IdentityProof\Manager;
28
use OCP\AppFramework\Http;
29
use OCP\AppFramework\Http\DataResponse;
30
use OCP\AppFramework\OCSController;
31
use OCP\DB\QueryBuilder\IQueryBuilder;
32
use OCP\IDBConnection;
33
use OCP\IRequest;
34
use OCP\ISession;
35
use OCP\IUser;
36
use OCP\IUserSession;
37
38
class PushController extends OCSController {
39
40
	/** @var IDBConnection */
41
	private $db;
42
43
	/** @var ISession */
44
	private $session;
45
46
	/** @var IUserSession */
47
	private $userSession;
48
49
	/** @var IProvider */
50
	private $tokenProvider;
51
52
	/** @var Manager */
53
	private $identityProof;
54
55
	/**
56
	 * @param string $appName
57
	 * @param IRequest $request
58
	 * @param IDBConnection $db
59
	 * @param ISession $session
60
	 * @param IUserSession $userSession
61
	 * @param IProvider $tokenProvider
62
	 * @param Manager $identityProof
63
	 */
64 22
	public function __construct($appName, IRequest $request, IDBConnection $db, ISession $session, IUserSession $userSession, IProvider $tokenProvider, Manager $identityProof) {
65 22
		parent::__construct($appName, $request);
66
67 22
		$this->db = $db;
68 22
		$this->session = $session;
69 22
		$this->userSession = $userSession;
70 22
		$this->tokenProvider = $tokenProvider;
71 22
		$this->identityProof = $identityProof;
72 22
	}
73
74
	/**
75
	 * @NoAdminRequired
76
	 *
77
	 * @param string $pushTokenHash
78
	 * @param string $devicePublicKey
79
	 * @param string $proxyServer
80
	 * @return DataResponse
81
	 */
82 15
	public function registerDevice($pushTokenHash, $devicePublicKey, $proxyServer) {
83 15
		$user = $this->userSession->getUser();
84 15
		if (!$user instanceof IUser) {
0 ignored issues
show
Bug introduced by
The class OCP\IUser does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
85 1
			return new DataResponse([], Http::STATUS_UNAUTHORIZED);
86
		}
87
88 14
		if (!preg_match('/^([a-f0-9]{128})$/', $pushTokenHash)) {
89 3
			return new DataResponse(['message' => 'INVALID_PUSHTOKEN_HASH'], Http::STATUS_BAD_REQUEST);
90
		}
91
92
		if (
93 11
			((strlen($devicePublicKey) !== 450 || strpos($devicePublicKey, "\n" . '-----END PUBLIC KEY-----') !== 425) &&
94 4
				(strlen($devicePublicKey) !== 451 || strpos($devicePublicKey, "\n" . '-----END PUBLIC KEY-----' . "\n") !== 425)) ||
95 11
			strpos($devicePublicKey, '-----BEGIN PUBLIC KEY-----' . "\n") !== 0) {
96 3
			return new DataResponse(['message' => 'INVALID_DEVICE_KEY'], Http::STATUS_BAD_REQUEST);
97
		}
98
99
		if (
100 8
			!filter_var($proxyServer, FILTER_VALIDATE_URL) ||
101 5
			strlen($proxyServer) > 256 ||
102 8
			!preg_match('/^(https\:\/\/|http\:\/\/localhost(\:[0-9]{0,5})?\/)/', $proxyServer)
103
		) {
104 3
			return new DataResponse(['message' => 'INVALID_PROXY_SERVER'], Http::STATUS_BAD_REQUEST);
105
		}
106
107 5
		$tokenId = $this->session->get('token-id');
108
		try {
109 5
			$token = $this->tokenProvider->getTokenById($tokenId);
110 3
		} catch (InvalidTokenException $e) {
0 ignored issues
show
Bug introduced by
The class OC\Authentication\Exceptions\InvalidTokenException does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
111 3
			return new DataResponse(['message' => 'INVALID_SESSION_TOKEN'], Http::STATUS_BAD_REQUEST);
112
		}
113
114 2
		$key = $this->identityProof->getKey($user);
115
116 2
		$deviceIdentifier = json_encode([$user->getCloudId(), $token->getId()]);
117 2
		openssl_sign($deviceIdentifier, $signature, $key->getPrivate(), OPENSSL_ALGO_SHA512);
118 2
		$deviceIdentifier = base64_encode(hash('sha512', $deviceIdentifier, true));
119
120 2
		$appType = 'unknown';
121 2
		if ($this->request->isUserAgent([
122 2
				IRequest::USER_AGENT_TALK_ANDROID,
123 2
				IRequest::USER_AGENT_TALK_IOS,
124
			])) {
125
			$appType = 'talk';
126 2
		} else if ($this->request->isUserAgent([
127 2
				IRequest::USER_AGENT_CLIENT_ANDROID,
128 2
				IRequest::USER_AGENT_CLIENT_IOS,
129
			])) {
130
			$appType = 'nextcloud';
131
		}
132
133 2
		$created = $this->savePushToken($user, $token, $deviceIdentifier, $devicePublicKey, $pushTokenHash, $proxyServer, $appType);
134
135 2
		return new DataResponse([
136 2
			'publicKey' => $key->getPublic(),
137 2
			'deviceIdentifier' => $deviceIdentifier,
138 2
			'signature' => base64_encode($signature),
139 2
		], $created ? Http::STATUS_CREATED : Http::STATUS_OK);
140
	}
141
142
	/**
143
	 * @NoAdminRequired
144
	 *
145
	 * @return DataResponse
146
	 */
147 5
	public function removeDevice() {
148 5
		$user = $this->userSession->getUser();
149 5
		if (!$user instanceof IUser) {
0 ignored issues
show
Bug introduced by
The class OCP\IUser does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
150 1
			return new DataResponse([], Http::STATUS_UNAUTHORIZED);
151
		}
152
153 4
		$tokenId = $this->session->get('token-id');
154
		try {
155 4
			$token = $this->tokenProvider->getTokenById($tokenId);
156 2
		} catch (InvalidTokenException $e) {
0 ignored issues
show
Bug introduced by
The class OC\Authentication\Exceptions\InvalidTokenException does not exist. Did you forget a USE statement, or did you not list all dependencies?

Scrutinizer analyzes your composer.json/composer.lock file if available to determine the classes, and functions that are defined by your dependencies.

It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis.

Loading history...
157 2
			return new DataResponse(['message' => 'INVALID_SESSION_TOKEN'], Http::STATUS_BAD_REQUEST);
158
		}
159
160 2
		if ($this->deletePushToken($user, $token)) {
161 1
			return new DataResponse([], Http::STATUS_ACCEPTED);
162
		}
163
164 1
		return new DataResponse([], Http::STATUS_OK);
165
	}
166
167
	/**
168
	 * @param IUser $user
169
	 * @param IToken $token
170
	 * @param string $deviceIdentifier
171
	 * @param string $devicePublicKey
172
	 * @param string $pushTokenHash
173
	 * @param string $proxyServer
174
	 * @param string $appType
175
	 * @return bool If the hash was new to the database
176
	 */
177
	protected function savePushToken(IUser $user, IToken $token, $deviceIdentifier, $devicePublicKey, $pushTokenHash, $proxyServer, $appType) {
178
		$query = $this->db->getQueryBuilder();
179
		$query->select('*')
180
			->from('notifications_pushtokens')
181
			->where($query->expr()->eq('uid', $query->createNamedParameter($user->getUID())))
182
			->andWhere($query->expr()->eq('token', $query->createNamedParameter($token->getId())));
183
		$result = $query->execute();
184
		$row = $result->fetch();
185
		$result->closeCursor();
186
187
		if (!$row) {
188
			return $this->insertPushToken($user, $token, $deviceIdentifier, $devicePublicKey, $pushTokenHash, $proxyServer, $appType);
189
		}
190
191
		return $this->updatePushToken($user, $token, $devicePublicKey, $pushTokenHash, $proxyServer, $appType);
192
	}
193
194
	/**
195
	 * @param IUser $user
196
	 * @param IToken $token
197
	 * @param string $deviceIdentifier
198
	 * @param string $devicePublicKey
199
	 * @param string $pushTokenHash
200
	 * @param string $proxyServer
201
	 * @param string $appType
202
	 * @return bool If the entry was created
203
	 */
204
	protected function insertPushToken(IUser $user, IToken $token, $deviceIdentifier, $devicePublicKey, $pushTokenHash, $proxyServer, $appType) {
205
		$devicePublicKeyHash = hash('sha512', $devicePublicKey);
206
207
		$query = $this->db->getQueryBuilder();
208
		$query->insert('notifications_pushtokens')
209
			->values([
210
				'uid' => $query->createNamedParameter($user->getUID()),
211
				'token' => $query->createNamedParameter($token->getId(), IQueryBuilder::PARAM_INT),
212
				'deviceidentifier' => $query->createNamedParameter($deviceIdentifier),
213
				'devicepublickey' => $query->createNamedParameter($devicePublicKey),
214
				'devicepublickeyhash' => $query->createNamedParameter($devicePublicKeyHash),
215
				'pushtokenhash' => $query->createNamedParameter($pushTokenHash),
216
				'proxyserver' => $query->createNamedParameter($proxyServer),
217
				'apptype' => $query->createNamedParameter($appType),
218
			]);
219
		return $query->execute() > 0;
220
	}
221
222
	/**
223
	 * @param IUser $user
224
	 * @param IToken $token
225
	 * @param string $devicePublicKey
226
	 * @param string $pushTokenHash
227
	 * @param string $proxyServer
228
	 * @param string $appType
229
	 * @return bool If the entry was updated
230
	 */
231
	protected function updatePushToken(IUser $user, IToken $token, $devicePublicKey, $pushTokenHash, $proxyServer, $appType) {
232
		$devicePublicKeyHash = hash('sha512', $devicePublicKey);
233
234
		$query = $this->db->getQueryBuilder();
235
		$query->update('notifications_pushtokens')
236
			->set('devicepublickey', $query->createNamedParameter($devicePublicKey))
237
			->set('devicepublickeyhash', $query->createNamedParameter($devicePublicKeyHash))
238
			->set('pushtokenhash', $query->createNamedParameter($pushTokenHash))
239
			->set('proxyserver', $query->createNamedParameter($proxyServer))
240
			->set('apptype', $query->createNamedParameter($appType))
241
			->where($query->expr()->eq('uid', $query->createNamedParameter($user->getUID())))
242
			->andWhere($query->expr()->eq('token', $query->createNamedParameter($token->getId(), IQueryBuilder::PARAM_INT)));
243
244
		return $query->execute() !== 0;
245
	}
246
247
	/**
248
	 * @param IUser $user
249
	 * @param IToken $token
250
	 * @return bool If the entry was deleted
251
	 */
252
	protected function deletePushToken(IUser $user, IToken $token) {
253
		$query = $this->db->getQueryBuilder();
254
		$query->delete('notifications_pushtokens')
255
			->where($query->expr()->eq('uid', $query->createNamedParameter($user->getUID())))
256
			->andWhere($query->expr()->eq('token', $query->createNamedParameter($token->getId(), IQueryBuilder::PARAM_INT)));
257
258
		return $query->execute() !== 0;
259
	}
260
}
261