RemoteStreamService::update() - Code Metrics - Inspection of "Circles 22" - nextcloud/circles - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#551)

by Maxence

created 2021-02-16 02:18 UTC

RemoteStreamService::update() A

↳ Parent: RemoteStreamService

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	15
rs	9.7666
c	0
b	0
f	0
cc	4
nc	4
nop	2

<?php

declare(strict_types=1);


/**
 * Circles - Bring cloud-users closer together.
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Maxence Lange <[email protected]>
 * @copyright 2021
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCA\Circles\Service;


use daita\MySmallPhpTools\ActivityPub\Nextcloud\nc21\NC21Signature;
use daita\MySmallPhpTools\Exceptions\RequestNetworkException;
use daita\MySmallPhpTools\Exceptions\SignatoryException;
use daita\MySmallPhpTools\Exceptions\SignatureException;
use daita\MySmallPhpTools\Exceptions\WellKnownLinkNotFoundException;
use daita\MySmallPhpTools\Model\Nextcloud\nc21\NC21Request;
use daita\MySmallPhpTools\Model\Nextcloud\nc21\NC21Signatory;
use daita\MySmallPhpTools\Model\Nextcloud\nc21\NC21SignedRequest;
use daita\MySmallPhpTools\Model\Request;
use daita\MySmallPhpTools\Model\SimpleDataStore;
use daita\MySmallPhpTools\Traits\Nextcloud\nc21\TNC21Deserialize;
use daita\MySmallPhpTools\Traits\Nextcloud\nc21\TNC21LocalSignatory;
use daita\MySmallPhpTools\Traits\Nextcloud\nc21\TNC21WellKnown;
use daita\MySmallPhpTools\Traits\TStringTools;
use JsonSerializable;
use OCA\Circles\AppInfo\Application;
use OCA\Circles\Db\RemoteRequest;
use OCA\Circles\Exceptions\RemoteAlreadyExistsException;
use OCA\Circles\Exceptions\RemoteInstanceException;
use OCA\Circles\Exceptions\RemoteNotFoundException;
use OCA\Circles\Exceptions\RemoteResourceNotFoundException;
use OCA\Circles\Exceptions\RemoteUidException;
use OCA\Circles\Exceptions\UnknownRemoteException;
use OCA\Circles\Model\Federated\RemoteInstance;
use OCP\AppFramework\Http;
use OCP\IURLGenerator;


/**
 * Class RemoteStreamService
 *
 * @package OCA\Circles\Service
 */
class RemoteStreamService extends NC21Signature {


	use TNC21Deserialize;
	use TNC21LocalSignatory;
	use TStringTools;
	use TNC21WellKnown;


	const UPDATE_DATA = 'data';
	const UPDATE_INSTANCE = 'instance';
	const UPDATE_HREF = 'href';


	/** @var IURLGenerator */
	private $urlGenerator;

	/** @var RemoteRequest */
	private $remoteRequest;

	/** @var ConfigService */
	private $configService;


	/**
	 * RemoteStreamService constructor.
	 *
	 * @param IURLGenerator $urlGenerator
	 * @param RemoteRequest $remoteRequest
	 * @param ConfigService $configService
	 */
	public function __construct(
		IURLGenerator $urlGenerator, RemoteRequest $remoteRequest, ConfigService $configService
	) {
		$this->setup('app', 'circles');

		$this->urlGenerator = $urlGenerator;
		$this->remoteRequest = $remoteRequest;
		$this->configService = $configService;
	}


	/**
	 * Returns the Signatory model for the Circles app.
	 * Can be signed with a confirmKey.
	 *
	 * @param bool $generate
	 * @param string $confirmKey
	 *
	 * @return RemoteInstance
	 * @throws SignatoryException
	 */
	public function getAppSignatory(bool $generate = true, string $confirmKey = ''): RemoteInstance {
		$app = new RemoteInstance($this->configService->getRemotePath());
		$this->fillSimpleSignatory($app, $generate);
		$app->setUidFromKey();

		if ($confirmKey !== '') {
			$app->setAuthSigned($this->signString($confirmKey, $app));
		}

		$app->setEvent($this->configService->getRemotePath('circles.Remote.event'));
		$app->setIncoming($this->configService->getRemotePath('circles.Remote.incoming'));
		$app->setTest($this->configService->getRemotePath('circles.Remote.test'));
		$app->setCircles($this->configService->getRemotePath('circles.Remote.circles'));
		$app->setCircle(
			urldecode(
				$this->configService->getRemotePath(
					'circles.Remote.circle',
					['circleId' => '{circleId}']
				)
			)
		);
		$app->setMembers(
			urldecode(
				$this->configService->getRemotePath(
					'circles.Remote.members',
					['circleId' => '{circleId}']
				)
			)
		);
		$app->setMember(
			urldecode(
				$this->configService->getRemotePath(
					'circles.Remote.member',
					['type' => '{type}', 'userId' => '{userId}']
				)
			)
		);

		$app->setOrigData($app->jsonSerialize());

		return $app;
	}


	/**
	 * Reset the Signatory (and the Identity) for the Circles app.
	 */
	public function resetAppSignatory(): void {
		try {
			$app = $this->getAppSignatory();

			$this->removeSimpleSignatory($app);
		} catch (SignatoryException $e) {

		}
	}


	/**
	 * shortcut to requestRemoteInstance that return result if available, or exception.
	 *
	 * @param string $instance
	 * @param string $item
	 * @param int $type
	 * @param JsonSerializable|null $object
	 * @param array $params
	 *
	 * @return array
	 * @throws RemoteNotFoundException
	 * @throws RemoteResourceNotFoundException
	 * @throws RequestNetworkException
	 * @throws SignatoryException
	 * @throws UnknownRemoteException
	 * @throws RemoteInstanceException
	 */
	public function resultRequestRemoteInstance(
		string $instance,
		string $item,
		int $type = Request::TYPE_GET,
		?JsonSerializable $object = null,
		array $params = []
	): array {

		$signedRequest = $this->requestRemoteInstance($instance, $item, $type, $object, $params);
		if (!$signedRequest->getOutgoingRequest()->hasResult()) {
			throw new RequestNetworkException();
		}

		$result = $signedRequest->getOutgoingRequest()->getResult();
		if ($result->getStatusCode() !== Http::STATUS_OK) {
			throw new RemoteInstanceException();
		}

		return $result->getAsArray();
	}

	/**
	 * Send a request to a remote instance, based on:
	 * - instance: address as saved in database,
	 * - item: the item to request (incoming, event, ...)
	 * - type: GET, POST
	 * - data: Serializable to be send if needed
	 *
	 * @param string $instance
	 * @param string $item
	 * @param int $type
	 * @param JsonSerializable|null $object
	 * @param array $params
	 *
	 * @return NC21SignedRequest
	 * @throws RemoteNotFoundException
	 * @throws RemoteResourceNotFoundException
	 * @throws RequestNetworkException
	 * @throws SignatoryException
	 * @throws UnknownRemoteException
	 */
	public function requestRemoteInstance(
		string $instance,
		string $item,
		int $type = Request::TYPE_GET,
		?JsonSerializable $object = null,
		array $params = []
	): NC21SignedRequest {

		$request = new NC21Request('', $type);
		if ($this->configService->isLocalInstance($instance)) {
			$this->configService->configureRequest($request, 'circles.Remote.' . $item, $params);
		} else {
			$this->configService->configureRequest($request);
			$link = $this->getRemoteInstanceEntry($instance, $item, $params);
			$request->basedOnUrl($link);
		}

		// TODO: on local, if object is empty, request takes 10s. check on other configuration
		if (is_null($object) || empty(json_decode(json_encode($object), true))) {
			$object = new SimpleDataStore(['empty' => 1]);
		}

		if (!is_null($object)) {
			$request->setDataSerialize($object);
		}

		$app = $this->getAppSignatory();
//		$app->setAlgorithm(NC21Signatory::SHA512);
		$signedRequest = $this->signOutgoingRequest($request, $app);
		$this->doRequest($signedRequest->getOutgoingRequest(), false);

		return $signedRequest;
	}


	/**
	 * get the value of an entry from the Signatory of the RemoteInstance.
	 *
	 * @param string $instance
	 * @param string $item
	 * @param array $params
	 *
	 * @return string
	 * @throws RemoteNotFoundException
	 * @throws RemoteResourceNotFoundException
	 * @throws UnknownRemoteException
	 */
	private function getRemoteInstanceEntry(string $instance, string $item, array $params = []): string {
		$remote = $this->getCachedRemoteInstance($instance);

		$value = $this->get($item, $remote->getOrigData());
		if ($value === '') {
			throw new RemoteResourceNotFoundException();
		}

		return $this->feedStringWithParams($value, $params);
	}


	/**
	 * get RemoteInstance with confirmed and known identity from database.
	 *
	 * @param string $instance
	 *
	 * @return RemoteInstance
	 * @throws RemoteNotFoundException
	 * @throws UnknownRemoteException
	 */
	public function getCachedRemoteInstance(string $instance): RemoteInstance {
		$remoteInstance = $this->remoteRequest->getFromInstance($instance);
		if ($remoteInstance->getType() === RemoteInstance::TYPE_UNKNOWN) {
			throw new UnknownRemoteException($instance . ' is set as \'unknown\' in database');
		}

		return $remoteInstance;
	}


	/**
	 * Add a remote instance, based on the address
	 *
	 * @param string $instance
	 *
	 * @return RemoteInstance
	 * @throws RequestNetworkException
	 * @throws SignatoryException
	 * @throws SignatureException
	 * @throws WellKnownLinkNotFoundException
	 */
	public function retrieveRemoteInstance(string $instance): RemoteInstance {
		$resource = $this->getResourceData($instance, Application::APP_SUBJECT, Application::APP_REL);

		$remoteInstance = $this->retrieveSignatory($resource->g('id'), true);
		$remoteInstance->setInstance($instance);

		return $remoteInstance;
	}


	/**
	 * retrieve Signatory.
	 *
	 * @param string $keyId
	 * @param bool $refresh
	 *
	 * @return RemoteInstance
	 * @throws SignatoryException
	 * @throws SignatureException
	 */
	public function retrieveSignatory(string $keyId, bool $refresh = true): RemoteInstance {
		if (!$refresh) {
			try {
				return $this->remoteRequest->getFromHref(NC21Signatory::removeFragment($keyId));
			} catch (RemoteNotFoundException $e) {
				throw new SignatoryException();
			}
		}

		$remoteInstance = new RemoteInstance($keyId);
		$confirm = $this->uuid();

		$this->downloadSignatory($remoteInstance, $keyId, ['auth' => $confirm]);
		$remoteInstance->setUidFromKey();

		$this->confirmAuth($remoteInstance, $confirm);

		return $remoteInstance;
	}


	/**
	 * Add a remote instance, based on the address
	 *
	 * @param string $instance
	 * @param string $type
	 * @param bool $overwrite
	 *
	 * @throws RequestNetworkException
	 * @throws SignatoryException
	 * @throws SignatureException
	 * @throws WellKnownLinkNotFoundException
	 * @throws RemoteAlreadyExistsException
	 * @throws RemoteUidException
	 */
	public function addRemoteInstance(
		string $instance, string $type = RemoteInstance::TYPE_EXTERNAL, bool $overwrite = false
	): void {
		if ($this->configService->isLocalInstance($instance)) {
			throw new RemoteAlreadyExistsException('instance is local');
		}

		$remoteInstance = $this->retrieveRemoteInstance($instance);
		$remoteInstance->setType($type);

		try {
			$known = $this->remoteRequest->searchDuplicate($remoteInstance);
			if ($overwrite) {
				$this->remoteRequest->deleteById($known);
			} else {
				throw new RemoteAlreadyExistsException('instance is already known');
			}
		} catch (RemoteNotFoundException $e) {

		}

		$this->remoteRequest->save($remoteInstance);
	}


	/**
	 * Confirm the Auth of a RemoteInstance, based on the result from a request
	 *
	 * @param RemoteInstance $remote
	 * @param string $auth
	 *
	 * @throws SignatureException
	 */
	private function confirmAuth(RemoteInstance $remote, string $auth): void {
		list($algo, $signed) = explode(':', $this->get('auth-signed', $remote->getOrigData()));
		try {
			if ($signed === null) {
				throw new SignatureException('invalid auth-signed');
			}
			$this->verifyString($auth, base64_decode($signed), $remote->getPublicKey(), $algo);
			$remote->setIdentityAuthed(true);
		} catch (SignatureException $e) {
			$this->e(
				$e,
				['auth' => $auth, 'signed' => $signed, 'signatory' => $remote, 'msg' => 'auth not confirmed']
			);
			throw new SignatureException('auth not confirmed');
		}
	}


	/**
	 * TODO: confirm if method is really needed
	 *
	 * @param RemoteInstance $remote
	 * @param RemoteInstance|null $stored
	 *
	 * @throws RemoteNotFoundException
	 * @throws RemoteUidException
	 */
	public function confirmValidRemote(RemoteInstance $remote, ?RemoteInstance &$stored = null): void {
		try {
			$stored = $this->remoteRequest->getFromHref($remote->getId());
		} catch (RemoteNotFoundException $e) {
			if ($remote->getInstance() === '') {
				throw new RemoteNotFoundException();
			}

			$stored = $this->remoteRequest->getFromInstance($remote->getInstance());
		}

		if ($stored->getUid() !== $remote->getUid(true)) {
			throw new RemoteUidException();
		}
	}


	/**
	 * TODO: check if this method is not useless
	 *
	 * @param RemoteInstance $remote
	 * @param string $update
	 *
	 * @throws RemoteUidException
	 */
	public function update(RemoteInstance $remote, string $update = self::UPDATE_DATA): void {
		switch ($update) {
			case self::UPDATE_DATA:
				$this->remoteRequest->update($remote);
				break;

			case self::UPDATE_HREF:
				$this->remoteRequest->updateHref($remote);
				break;

			case self::UPDATE_INSTANCE:
				$this->remoteRequest->updateInstance($remote);
				break;
		}
	}

}



1			<?php
2
3			declare(strict_types=1);
4
5
6			/**
7			* Circles - Bring cloud-users closer together.
8			*
9			* This file is licensed under the Affero General Public License version 3 or
10			* later. See the COPYING file.
11			*
12			* @author Maxence Lange <[email protected]>
13			* @copyright 2021
14			* @license GNU AGPL version 3 or any later version
15			*
16			* This program is free software: you can redistribute it and/or modify
17			* it under the terms of the GNU Affero General Public License as
18			* published by the Free Software Foundation, either version 3 of the
19			* License, or (at your option) any later version.
20			*
21			* This program is distributed in the hope that it will be useful,
22			* but WITHOUT ANY WARRANTY; without even the implied warranty of
23			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24			* GNU Affero General Public License for more details.
25			*
26			* You should have received a copy of the GNU Affero General Public License
27			* along with this program. If not, see <http://www.gnu.org/licenses/>.
28			*
29			*/
30
31			namespace OCA\Circles\Service;
32
33
34			use daita\MySmallPhpTools\ActivityPub\Nextcloud\nc21\NC21Signature;
35			use daita\MySmallPhpTools\Exceptions\RequestNetworkException;
36			use daita\MySmallPhpTools\Exceptions\SignatoryException;
37			use daita\MySmallPhpTools\Exceptions\SignatureException;
38			use daita\MySmallPhpTools\Exceptions\WellKnownLinkNotFoundException;
39			use daita\MySmallPhpTools\Model\Nextcloud\nc21\NC21Request;
40			use daita\MySmallPhpTools\Model\Nextcloud\nc21\NC21Signatory;
41			use daita\MySmallPhpTools\Model\Nextcloud\nc21\NC21SignedRequest;
42			use daita\MySmallPhpTools\Model\Request;
43			use daita\MySmallPhpTools\Model\SimpleDataStore;
44			use daita\MySmallPhpTools\Traits\Nextcloud\nc21\TNC21Deserialize;
45			use daita\MySmallPhpTools\Traits\Nextcloud\nc21\TNC21LocalSignatory;
46			use daita\MySmallPhpTools\Traits\Nextcloud\nc21\TNC21WellKnown;
47			use daita\MySmallPhpTools\Traits\TStringTools;
48			use JsonSerializable;
49			use OCA\Circles\AppInfo\Application;
50			use OCA\Circles\Db\RemoteRequest;
51			use OCA\Circles\Exceptions\RemoteAlreadyExistsException;
52			use OCA\Circles\Exceptions\RemoteInstanceException;
53			use OCA\Circles\Exceptions\RemoteNotFoundException;
54			use OCA\Circles\Exceptions\RemoteResourceNotFoundException;
55			use OCA\Circles\Exceptions\RemoteUidException;
56			use OCA\Circles\Exceptions\UnknownRemoteException;
57			use OCA\Circles\Model\Federated\RemoteInstance;
58			use OCP\AppFramework\Http;
59			use OCP\IURLGenerator;
60
61
62			/**
63			* Class RemoteStreamService
64			*
65			* @package OCA\Circles\Service
66			*/
67			class RemoteStreamService extends NC21Signature {
68
69
70			use TNC21Deserialize;
71			use TNC21LocalSignatory;
72			use TStringTools;
73			use TNC21WellKnown;
74
75
76			const UPDATE_DATA = 'data';
77			const UPDATE_INSTANCE = 'instance';
78			const UPDATE_HREF = 'href';
79
80
81			/** @var IURLGenerator */
82			private $urlGenerator;
83
84			/** @var RemoteRequest */
85			private $remoteRequest;
86
87			/** @var ConfigService */
88			private $configService;
89
90
91			/**
92			* RemoteStreamService constructor.
93			*
94			* @param IURLGenerator $urlGenerator
95			* @param RemoteRequest $remoteRequest
96			* @param ConfigService $configService
97			*/
98			public function __construct(
99			IURLGenerator $urlGenerator, RemoteRequest $remoteRequest, ConfigService $configService
100			) {
101			$this->setup('app', 'circles');
102
103			$this->urlGenerator = $urlGenerator;
104			$this->remoteRequest = $remoteRequest;
105			$this->configService = $configService;
106			}
107
108
109			/**
110			* Returns the Signatory model for the Circles app.
111			* Can be signed with a confirmKey.
112			*
113			* @param bool $generate
114			* @param string $confirmKey
115			*
116			* @return RemoteInstance
117			* @throws SignatoryException
118			*/
119			public function getAppSignatory(bool $generate = true, string $confirmKey = ''): RemoteInstance {
120			$app = new RemoteInstance($this->configService->getRemotePath());
121			$this->fillSimpleSignatory($app, $generate);
122			$app->setUidFromKey();
123
124			if ($confirmKey !== '') {
125			$app->setAuthSigned($this->signString($confirmKey, $app));
126			}
127
128			$app->setEvent($this->configService->getRemotePath('circles.Remote.event'));
129			$app->setIncoming($this->configService->getRemotePath('circles.Remote.incoming'));
130			$app->setTest($this->configService->getRemotePath('circles.Remote.test'));
131			$app->setCircles($this->configService->getRemotePath('circles.Remote.circles'));
132			$app->setCircle(
133			urldecode(
134			$this->configService->getRemotePath(
135			'circles.Remote.circle',
136			['circleId' => '{circleId}']
137			)
138			)
139			);
140			$app->setMembers(
141			urldecode(
142			$this->configService->getRemotePath(
143			'circles.Remote.members',
144			['circleId' => '{circleId}']
145			)
146			)
147			);
148			$app->setMember(
149			urldecode(
150			$this->configService->getRemotePath(
151			'circles.Remote.member',
152			['type' => '{type}', 'userId' => '{userId}']
153			)
154			)
155			);
156
157			$app->setOrigData($app->jsonSerialize());
158
159			return $app;
160			}
161
162
163			/**
164			* Reset the Signatory (and the Identity) for the Circles app.
165			*/
166			public function resetAppSignatory(): void {
167			try {
168			$app = $this->getAppSignatory();
169
170			$this->removeSimpleSignatory($app);
171			} catch (SignatoryException $e) {
			0 ignored issues – show Coding Style Comprehensibility introduced 2021-01-13 22:58 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
172			}
173			}
174
175
176			/**
177			* shortcut to requestRemoteInstance that return result if available, or exception.
178			*
179			* @param string $instance
180			* @param string $item
181			* @param int $type
182			* @param JsonSerializable\|null $object
183			* @param array $params
184			*
185			* @return array
186			* @throws RemoteNotFoundException
187			* @throws RemoteResourceNotFoundException
188			* @throws RequestNetworkException
189			* @throws SignatoryException
190			* @throws UnknownRemoteException
191			* @throws RemoteInstanceException
192			*/
193			public function resultRequestRemoteInstance(
194			string $instance,
195			string $item,
196			int $type = Request::TYPE_GET,
197			?JsonSerializable $object = null,
198			array $params = []
199			): array {
200
201			$signedRequest = $this->requestRemoteInstance($instance, $item, $type, $object, $params);
202			if (!$signedRequest->getOutgoingRequest()->hasResult()) {
203			throw new RequestNetworkException();
204			}
205
206			$result = $signedRequest->getOutgoingRequest()->getResult();
207			if ($result->getStatusCode() !== Http::STATUS_OK) {
208			throw new RemoteInstanceException();
209			}
210
211			return $result->getAsArray();
212			}
213
214			/**
215			* Send a request to a remote instance, based on:
216			* - instance: address as saved in database,
217			* - item: the item to request (incoming, event, ...)
218			* - type: GET, POST
219			* - data: Serializable to be send if needed
220			*
221			* @param string $instance
222			* @param string $item
223			* @param int $type
224			* @param JsonSerializable\|null $object
225			* @param array $params
226			*
227			* @return NC21SignedRequest
228			* @throws RemoteNotFoundException
229			* @throws RemoteResourceNotFoundException
230			* @throws RequestNetworkException
231			* @throws SignatoryException
232			* @throws UnknownRemoteException
233			*/
234			public function requestRemoteInstance(
235			string $instance,
236			string $item,
237			int $type = Request::TYPE_GET,
238			?JsonSerializable $object = null,
239			array $params = []
240			): NC21SignedRequest {
241
242			$request = new NC21Request('', $type);
243			if ($this->configService->isLocalInstance($instance)) {
244			$this->configService->configureRequest($request, 'circles.Remote.' . $item, $params);
245			} else {
246			$this->configService->configureRequest($request);
247			$link = $this->getRemoteInstanceEntry($instance, $item, $params);
248			$request->basedOnUrl($link);
249			}
250
251			// TODO: on local, if object is empty, request takes 10s. check on other configuration
252			if (is_null($object) \|\| empty(json_decode(json_encode($object), true))) {
253			$object = new SimpleDataStore(['empty' => 1]);
254			}
255
256			if (!is_null($object)) {
257			$request->setDataSerialize($object);
258			}
259
260			$app = $this->getAppSignatory();
261			// $app->setAlgorithm(NC21Signatory::SHA512);
262			$signedRequest = $this->signOutgoingRequest($request, $app);
263			$this->doRequest($signedRequest->getOutgoingRequest(), false);
264
265			return $signedRequest;
266			}
267
268
269			/**
270			* get the value of an entry from the Signatory of the RemoteInstance.
271			*
272			* @param string $instance
273			* @param string $item
274			* @param array $params
275			*
276			* @return string
277			* @throws RemoteNotFoundException
278			* @throws RemoteResourceNotFoundException
279			* @throws UnknownRemoteException
280			*/
281			private function getRemoteInstanceEntry(string $instance, string $item, array $params = []): string {
282			$remote = $this->getCachedRemoteInstance($instance);
283
284			$value = $this->get($item, $remote->getOrigData());
285			if ($value === '') {
286			throw new RemoteResourceNotFoundException();
287			}
288
289			return $this->feedStringWithParams($value, $params);
290			}
291
292
293			/**
294			* get RemoteInstance with confirmed and known identity from database.
295			*
296			* @param string $instance
297			*
298			* @return RemoteInstance
299			* @throws RemoteNotFoundException
300			* @throws UnknownRemoteException
301			*/
302			public function getCachedRemoteInstance(string $instance): RemoteInstance {
303			$remoteInstance = $this->remoteRequest->getFromInstance($instance);
304			if ($remoteInstance->getType() === RemoteInstance::TYPE_UNKNOWN) {
305			throw new UnknownRemoteException($instance . ' is set as \'unknown\' in database');
306			}
307
308			return $remoteInstance;
309			}
310
311
312			/**
313			* Add a remote instance, based on the address
314			*
315			* @param string $instance
316			*
317			* @return RemoteInstance
318			* @throws RequestNetworkException
319			* @throws SignatoryException
320			* @throws SignatureException
321			* @throws WellKnownLinkNotFoundException
322			*/
323			public function retrieveRemoteInstance(string $instance): RemoteInstance {
324			$resource = $this->getResourceData($instance, Application::APP_SUBJECT, Application::APP_REL);
325
326			$remoteInstance = $this->retrieveSignatory($resource->g('id'), true);
327			$remoteInstance->setInstance($instance);
328
329			return $remoteInstance;
330			}
331
332
333			/**
334			* retrieve Signatory.
335			*
336			* @param string $keyId
337			* @param bool $refresh
338			*
339			* @return RemoteInstance
340			* @throws SignatoryException
341			* @throws SignatureException
342			*/
343			public function retrieveSignatory(string $keyId, bool $refresh = true): RemoteInstance {
344			if (!$refresh) {
345			try {
346			return $this->remoteRequest->getFromHref(NC21Signatory::removeFragment($keyId));
347			} catch (RemoteNotFoundException $e) {
348			throw new SignatoryException();
349			}
350			}
351
352			$remoteInstance = new RemoteInstance($keyId);
353			$confirm = $this->uuid();
354
355			$this->downloadSignatory($remoteInstance, $keyId, ['auth' => $confirm]);
356			$remoteInstance->setUidFromKey();
357
358			$this->confirmAuth($remoteInstance, $confirm);
359
360			return $remoteInstance;
361			}
362
363
364			/**
365			* Add a remote instance, based on the address
366			*
367			* @param string $instance
368			* @param string $type
369			* @param bool $overwrite
370			*
371			* @throws RequestNetworkException
372			* @throws SignatoryException
373			* @throws SignatureException
374			* @throws WellKnownLinkNotFoundException
375			* @throws RemoteAlreadyExistsException
376			* @throws RemoteUidException
377			*/
378			public function addRemoteInstance(
379			string $instance, string $type = RemoteInstance::TYPE_EXTERNAL, bool $overwrite = false
380			): void {
381			if ($this->configService->isLocalInstance($instance)) {
382			throw new RemoteAlreadyExistsException('instance is local');
383			}
384
385			$remoteInstance = $this->retrieveRemoteInstance($instance);
386			$remoteInstance->setType($type);
387
388			try {
389			$known = $this->remoteRequest->searchDuplicate($remoteInstance);
390			if ($overwrite) {
391			$this->remoteRequest->deleteById($known);
392			} else {
393			throw new RemoteAlreadyExistsException('instance is already known');
394			}
395			} catch (RemoteNotFoundException $e) {
			0 ignored issues – show Coding Style Comprehensibility introduced 2021-02-13 14:08 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
396			}
397
398			$this->remoteRequest->save($remoteInstance);
399			}
400
401
402			/**
403			* Confirm the Auth of a RemoteInstance, based on the result from a request
404			*
405			* @param RemoteInstance $remote
406			* @param string $auth
407			*
408			* @throws SignatureException
409			*/
410			private function confirmAuth(RemoteInstance $remote, string $auth): void {
411			list($algo, $signed) = explode(':', $this->get('auth-signed', $remote->getOrigData()));
412			try {
413			if ($signed === null) {
414			throw new SignatureException('invalid auth-signed');
415			}
416			$this->verifyString($auth, base64_decode($signed), $remote->getPublicKey(), $algo);
417			$remote->setIdentityAuthed(true);
418			} catch (SignatureException $e) {
419			$this->e(
420			$e,
421			['auth' => $auth, 'signed' => $signed, 'signatory' => $remote, 'msg' => 'auth not confirmed']
422			);
423			throw new SignatureException('auth not confirmed');
424			}
425			}
426
427
428			/**
429			* TODO: confirm if method is really needed
430			*
431			* @param RemoteInstance $remote
432			* @param RemoteInstance\|null $stored
433			*
434			* @throws RemoteNotFoundException
435			* @throws RemoteUidException
436			*/
437			public function confirmValidRemote(RemoteInstance $remote, ?RemoteInstance &$stored = null): void {
438			try {
439			$stored = $this->remoteRequest->getFromHref($remote->getId());
440			} catch (RemoteNotFoundException $e) {
441			if ($remote->getInstance() === '') {
442			throw new RemoteNotFoundException();
443			}
444
445			$stored = $this->remoteRequest->getFromInstance($remote->getInstance());
446			}
447
448			if ($stored->getUid() !== $remote->getUid(true)) {
449			throw new RemoteUidException();
450			}
451			}
452
453
454			/**
455			* TODO: check if this method is not useless
456			*
457			* @param RemoteInstance $remote
458			* @param string $update
459			*
460			* @throws RemoteUidException
461			*/
462			public function update(RemoteInstance $remote, string $update = self::UPDATE_DATA): void {
463			switch ($update) {
464			case self::UPDATE_DATA:
465			$this->remoteRequest->update($remote);
466			break;
467
468			case self::UPDATE_HREF:
469			$this->remoteRequest->updateHref($remote);
470			break;
471
472			case self::UPDATE_INSTANCE:
473			$this->remoteRequest->updateInstance($remote);
474			break;
475			}
476			}
477
478			}
479
480

nextcloud / circles

Pull Request — master (#551)

RemoteStreamService::update() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like