Completed
Push — master ( c08e86...5c28e4 )
by Joas
10s
created

PushController::savePushToken()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 16
Code Lines 12

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 6

Importance

Changes 2
Bugs 0 Features 0
Metric Value
c 2
b 0
f 0
dl 0
loc 16
ccs 0
cts 12
cp 0
rs 9.4285
cc 2
eloc 12
nc 2
nop 7
crap 6
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(string $pushTokenHash, string $devicePublicKey, string $proxyServer): DataResponse {
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
			strpos($devicePublicKey, '-----BEGIN PUBLIC KEY-----' . "\n") !== 0 ||
94 10
			((\strlen($devicePublicKey) !== 450 || strpos($devicePublicKey, "\n" . '-----END PUBLIC KEY-----') !== 425) &&
95 11
				(\strlen($devicePublicKey) !== 451 || strpos($devicePublicKey, "\n" . '-----END PUBLIC KEY-----' . "\n") !== 425))
96
			) {
97 3
			return new DataResponse(['message' => 'INVALID_DEVICE_KEY'], Http::STATUS_BAD_REQUEST);
98
		}
99
100
		if (
101 8
			!filter_var($proxyServer, FILTER_VALIDATE_URL) ||
102 5
			\strlen($proxyServer) > 256 ||
103 8
			!preg_match('/^(https\:\/\/|http\:\/\/localhost(\:\d{0,5})?\/)/', $proxyServer)
104
		) {
105 3
			return new DataResponse(['message' => 'INVALID_PROXY_SERVER'], Http::STATUS_BAD_REQUEST);
106
		}
107
108 5
		$tokenId = $this->session->get('token-id');
109
		try {
110 5
			$token = $this->tokenProvider->getTokenById($tokenId);
111 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...
112 3
			return new DataResponse(['message' => 'INVALID_SESSION_TOKEN'], Http::STATUS_BAD_REQUEST);
113
		}
114
115 2
		$key = $this->identityProof->getKey($user);
116
117 2
		$deviceIdentifier = json_encode([$user->getCloudId(), $token->getId()]);
118 2
		openssl_sign($deviceIdentifier, $signature, $key->getPrivate(), OPENSSL_ALGO_SHA512);
119 2
		$deviceIdentifier = base64_encode(hash('sha512', $deviceIdentifier, true));
120
121 2
		$appType = 'unknown';
122 2
		if ($this->request->isUserAgent([
123 2
				IRequest::USER_AGENT_TALK_ANDROID,
124
				IRequest::USER_AGENT_TALK_IOS,
125
			])) {
126
			$appType = 'talk';
127 2
		} else if ($this->request->isUserAgent([
128 2
				IRequest::USER_AGENT_CLIENT_ANDROID,
129
				IRequest::USER_AGENT_CLIENT_IOS,
130
			])) {
131
			$appType = 'nextcloud';
132
		}
133
134 2
		$created = $this->savePushToken($user, $token, $deviceIdentifier, $devicePublicKey, $pushTokenHash, $proxyServer, $appType);
135
136 2
		return new DataResponse([
137 2
			'publicKey' => $key->getPublic(),
138 2
			'deviceIdentifier' => $deviceIdentifier,
139 2
			'signature' => base64_encode($signature),
140 2
		], $created ? Http::STATUS_CREATED : Http::STATUS_OK);
141
	}
142
143
	/**
144
	 * @NoAdminRequired
145
	 *
146
	 * @return DataResponse
147
	 */
148 5
	public function removeDevice(): DataResponse {
149 5
		$user = $this->userSession->getUser();
150 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...
151 1
			return new DataResponse([], Http::STATUS_UNAUTHORIZED);
152
		}
153
154 4
		$tokenId = $this->session->get('token-id');
155
		try {
156 4
			$token = $this->tokenProvider->getTokenById($tokenId);
157 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...
158 2
			return new DataResponse(['message' => 'INVALID_SESSION_TOKEN'], Http::STATUS_BAD_REQUEST);
159
		}
160
161 2
		if ($this->deletePushToken($user, $token)) {
162 1
			return new DataResponse([], Http::STATUS_ACCEPTED);
163
		}
164
165 1
		return new DataResponse([], Http::STATUS_OK);
166
	}
167
168
	/**
169
	 * @param IUser $user
170
	 * @param IToken $token
171
	 * @param string $deviceIdentifier
172
	 * @param string $devicePublicKey
173
	 * @param string $pushTokenHash
174
	 * @param string $proxyServer
175
	 * @param string $appType
176
	 * @return bool If the hash was new to the database
177
	 */
178
	protected function savePushToken(IUser $user, IToken $token, string $deviceIdentifier, string $devicePublicKey, string $pushTokenHash, string $proxyServer, string $appType): bool {
179
		$query = $this->db->getQueryBuilder();
180
		$query->select('*')
181
			->from('notifications_pushtokens')
182
			->where($query->expr()->eq('uid', $query->createNamedParameter($user->getUID())))
183
			->andWhere($query->expr()->eq('token', $query->createNamedParameter($token->getId())));
184
		$result = $query->execute();
185
		$row = $result->fetch();
186
		$result->closeCursor();
187
188
		if (!$row) {
189
			return $this->insertPushToken($user, $token, $deviceIdentifier, $devicePublicKey, $pushTokenHash, $proxyServer, $appType);
190
		}
191
192
		return $this->updatePushToken($user, $token, $devicePublicKey, $pushTokenHash, $proxyServer, $appType);
193
	}
194
195
	/**
196
	 * @param IUser $user
197
	 * @param IToken $token
198
	 * @param string $deviceIdentifier
199
	 * @param string $devicePublicKey
200
	 * @param string $pushTokenHash
201
	 * @param string $proxyServer
202
	 * @param string $appType
203
	 * @return bool If the entry was created
204
	 */
205
	protected function insertPushToken(IUser $user, IToken $token, string $deviceIdentifier, string $devicePublicKey, string $pushTokenHash, string $proxyServer, string $appType): bool {
206
		$devicePublicKeyHash = hash('sha512', $devicePublicKey);
207
208
		$query = $this->db->getQueryBuilder();
209
		$query->insert('notifications_pushtokens')
210
			->values([
211
				'uid' => $query->createNamedParameter($user->getUID()),
212
				'token' => $query->createNamedParameter($token->getId(), IQueryBuilder::PARAM_INT),
213
				'deviceidentifier' => $query->createNamedParameter($deviceIdentifier),
214
				'devicepublickey' => $query->createNamedParameter($devicePublicKey),
215
				'devicepublickeyhash' => $query->createNamedParameter($devicePublicKeyHash),
216
				'pushtokenhash' => $query->createNamedParameter($pushTokenHash),
217
				'proxyserver' => $query->createNamedParameter($proxyServer),
218
				'apptype' => $query->createNamedParameter($appType),
219
			]);
220
		return $query->execute() > 0;
221
	}
222
223
	/**
224
	 * @param IUser $user
225
	 * @param IToken $token
226
	 * @param string $devicePublicKey
227
	 * @param string $pushTokenHash
228
	 * @param string $proxyServer
229
	 * @param string $appType
230
	 * @return bool If the entry was updated
231
	 */
232
	protected function updatePushToken(IUser $user, IToken $token, string $devicePublicKey, string $pushTokenHash, string $proxyServer, string $appType): bool {
233
		$devicePublicKeyHash = hash('sha512', $devicePublicKey);
234
235
		$query = $this->db->getQueryBuilder();
236
		$query->update('notifications_pushtokens')
237
			->set('devicepublickey', $query->createNamedParameter($devicePublicKey))
238
			->set('devicepublickeyhash', $query->createNamedParameter($devicePublicKeyHash))
239
			->set('pushtokenhash', $query->createNamedParameter($pushTokenHash))
240
			->set('proxyserver', $query->createNamedParameter($proxyServer))
241
			->set('apptype', $query->createNamedParameter($appType))
242
			->where($query->expr()->eq('uid', $query->createNamedParameter($user->getUID())))
243
			->andWhere($query->expr()->eq('token', $query->createNamedParameter($token->getId(), IQueryBuilder::PARAM_INT)));
244
245
		return $query->execute() !== 0;
246
	}
247
248
	/**
249
	 * @param IUser $user
250
	 * @param IToken $token
251
	 * @return bool If the entry was deleted
252
	 */
253
	protected function deletePushToken(IUser $user, IToken $token): bool {
254
		$query = $this->db->getQueryBuilder();
255
		$query->delete('notifications_pushtokens')
256
			->where($query->expr()->eq('uid', $query->createNamedParameter($user->getUID())))
257
			->andWhere($query->expr()->eq('token', $query->createNamedParameter($token->getId(), IQueryBuilder::PARAM_INT)));
258
259
		return $query->execute() !== 0;
260
	}
261
}
262