mirror of
https://github.com/nextcloud/server.git
synced 2026-06-21 06:29:50 -04:00
309 lines
13 KiB
PHP
309 lines
13 KiB
PHP
<?php
|
||
|
||
/**
|
||
* SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
|
||
* SPDX-License-Identifier: AGPL-3.0-or-later
|
||
*/
|
||
namespace OCA\CloudFederationAPI\Controller;
|
||
|
||
use OCA\CloudFederationAPI\Config;
|
||
use OCA\CloudFederationAPI\ResponseDefinitions;
|
||
use OCP\AppFramework\Controller;
|
||
use OCP\AppFramework\Http;
|
||
use OCP\AppFramework\Http\Attribute\BruteForceProtection;
|
||
use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
|
||
use OCP\AppFramework\Http\Attribute\OpenAPI;
|
||
use OCP\AppFramework\Http\Attribute\PublicPage;
|
||
use OCP\AppFramework\Http\JSONResponse;
|
||
use OCP\Federation\Exceptions\ActionNotSupportedException;
|
||
use OCP\Federation\Exceptions\AuthenticationFailedException;
|
||
use OCP\Federation\Exceptions\BadRequestException;
|
||
use OCP\Federation\Exceptions\ProviderCouldNotAddShareException;
|
||
use OCP\Federation\Exceptions\ProviderDoesNotExistsException;
|
||
use OCP\Federation\ICloudFederationFactory;
|
||
use OCP\Federation\ICloudFederationProviderManager;
|
||
use OCP\Federation\ICloudIdManager;
|
||
use OCP\IGroupManager;
|
||
use OCP\IRequest;
|
||
use OCP\IURLGenerator;
|
||
use OCP\IUserManager;
|
||
use OCP\Share\Exceptions\ShareNotFound;
|
||
use Psr\Log\LoggerInterface;
|
||
|
||
/**
|
||
* Open-Cloud-Mesh-API
|
||
*
|
||
* @package OCA\CloudFederationAPI\Controller
|
||
*
|
||
* @psalm-import-type CloudFederationAPIAddShare from ResponseDefinitions
|
||
* @psalm-import-type CloudFederationAPIValidationError from ResponseDefinitions
|
||
* @psalm-import-type CloudFederationAPIError from ResponseDefinitions
|
||
*/
|
||
#[OpenAPI(scope: OpenAPI::SCOPE_FEDERATION)]
|
||
class RequestHandlerController extends Controller {
|
||
public function __construct(
|
||
string $appName,
|
||
IRequest $request,
|
||
private LoggerInterface $logger,
|
||
private IUserManager $userManager,
|
||
private IGroupManager $groupManager,
|
||
private IURLGenerator $urlGenerator,
|
||
private ICloudFederationProviderManager $cloudFederationProviderManager,
|
||
private Config $config,
|
||
private ICloudFederationFactory $factory,
|
||
private ICloudIdManager $cloudIdManager
|
||
) {
|
||
parent::__construct($appName, $request);
|
||
}
|
||
|
||
/**
|
||
* Add share
|
||
*
|
||
* @param string $shareWith The user who the share will be shared with
|
||
* @param string $name The resource name (e.g. document.odt)
|
||
* @param string|null $description Share description
|
||
* @param string $providerId Resource UID on the provider side
|
||
* @param string $owner Provider specific UID of the user who owns the resource
|
||
* @param string|null $ownerDisplayName Display name of the user who shared the item
|
||
* @param string|null $sharedBy Provider specific UID of the user who shared the resource
|
||
* @param string|null $sharedByDisplayName Display name of the user who shared the resource
|
||
* @param array{name: string[], options: array<string, mixed>} $protocol e,.g. ['name' => 'webdav', 'options' => ['username' => 'john', 'permissions' => 31]]
|
||
* @param string $shareType 'group' or 'user' share
|
||
* @param string $resourceType 'file', 'calendar',...
|
||
*
|
||
* @return JSONResponse<Http::STATUS_CREATED, CloudFederationAPIAddShare, array{}>|JSONResponse<Http::STATUS_BAD_REQUEST, CloudFederationAPIValidationError, array{}>|JSONResponse<Http::STATUS_NOT_IMPLEMENTED, CloudFederationAPIError, array{}>
|
||
* 201: The notification was successfully received. The display name of the recipient might be returned in the body
|
||
* 400: Bad request due to invalid parameters, e.g. when `shareWith` is not found or required properties are missing
|
||
* 501: Share type or the resource type is not supported
|
||
*/
|
||
#[PublicPage]
|
||
#[NoCSRFRequired]
|
||
#[BruteForceProtection(action: 'receiveFederatedShare')]
|
||
public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
|
||
// check if all required parameters are set
|
||
if ($shareWith === null ||
|
||
$name === null ||
|
||
$providerId === null ||
|
||
$owner === null ||
|
||
$resourceType === null ||
|
||
$shareType === null ||
|
||
!is_array($protocol) ||
|
||
!isset($protocol['name']) ||
|
||
!isset($protocol['options']) ||
|
||
!is_array($protocol['options']) ||
|
||
!isset($protocol['options']['sharedSecret'])
|
||
) {
|
||
return new JSONResponse(
|
||
[
|
||
'message' => 'Missing arguments',
|
||
'validationErrors' => [],
|
||
],
|
||
Http::STATUS_BAD_REQUEST
|
||
);
|
||
}
|
||
|
||
$supportedShareTypes = $this->config->getSupportedShareTypes($resourceType);
|
||
if (!in_array($shareType, $supportedShareTypes)) {
|
||
return new JSONResponse(
|
||
['message' => 'Share type "' . $shareType . '" not implemented'],
|
||
Http::STATUS_NOT_IMPLEMENTED
|
||
);
|
||
}
|
||
|
||
$cloudId = $this->cloudIdManager->resolveCloudId($shareWith);
|
||
$shareWith = $cloudId->getUser();
|
||
|
||
if ($shareType === 'user') {
|
||
$shareWith = $this->mapUid($shareWith);
|
||
|
||
if (!$this->userManager->userExists($shareWith)) {
|
||
$response = new JSONResponse(
|
||
[
|
||
'message' => 'User "' . $shareWith . '" does not exists at ' . $this->urlGenerator->getBaseUrl(),
|
||
'validationErrors' => [],
|
||
],
|
||
Http::STATUS_BAD_REQUEST
|
||
);
|
||
$response->throttle();
|
||
return $response;
|
||
}
|
||
}
|
||
|
||
if ($shareType === 'group') {
|
||
if (!$this->groupManager->groupExists($shareWith)) {
|
||
$response = new JSONResponse(
|
||
[
|
||
'message' => 'Group "' . $shareWith . '" does not exists at ' . $this->urlGenerator->getBaseUrl(),
|
||
'validationErrors' => [],
|
||
],
|
||
Http::STATUS_BAD_REQUEST
|
||
);
|
||
$response->throttle();
|
||
return $response;
|
||
}
|
||
}
|
||
|
||
// if no explicit display name is given, we use the uid as display name
|
||
$ownerDisplayName = $ownerDisplayName === null ? $owner : $ownerDisplayName;
|
||
$sharedByDisplayName = $sharedByDisplayName === null ? $sharedBy : $sharedByDisplayName;
|
||
|
||
// sharedBy* parameter is optional, if nothing is set we assume that it is the same user as the owner
|
||
if ($sharedBy === null) {
|
||
$sharedBy = $owner;
|
||
$sharedByDisplayName = $ownerDisplayName;
|
||
}
|
||
|
||
$ownerDomain = str_contains($owner, '@') ? substr(strrchr($owner, '@'), 1) : null;
|
||
$sharedByDomain = str_contains($sharedBy, '@') ? substr(strrchr($sharedBy, '@'), 1) : null;
|
||
$domainsToCheck = array_unique(array_filter([$ownerDomain, $sharedByDomain]));
|
||
if (count($domainsToCheck) !== 0) {
|
||
$spoofChecker = new \Spoofchecker();
|
||
foreach ($domainsToCheck as $domain) {
|
||
// detect suspicious chars (e.g. "pаypаl" spelled with Cyrillic "а" characters)
|
||
// see https://www.php.net/manual/en/spoofchecker.issuspicious.php
|
||
if ($spoofChecker->isSuspicious($domain)) {
|
||
$response = new JSONResponse(
|
||
[
|
||
'message' => 'Suspicious domain detected on owner or sharedBy field',
|
||
'validationErrors' => [],
|
||
],
|
||
Http::STATUS_BAD_REQUEST
|
||
);
|
||
$response->throttle();
|
||
return $response;
|
||
}
|
||
}
|
||
}
|
||
|
||
try {
|
||
$provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
|
||
$share = $this->factory->getCloudFederationShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, '', $shareType, $resourceType);
|
||
$share->setProtocol($protocol);
|
||
$provider->shareReceived($share);
|
||
} catch (ProviderDoesNotExistsException|ProviderCouldNotAddShareException $e) {
|
||
return new JSONResponse(
|
||
['message' => $e->getMessage()],
|
||
Http::STATUS_NOT_IMPLEMENTED
|
||
);
|
||
} catch (\Exception $e) {
|
||
$this->logger->error($e->getMessage(), ['exception' => $e]);
|
||
return new JSONResponse(
|
||
[
|
||
'message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl(),
|
||
'validationErrors' => [],
|
||
],
|
||
Http::STATUS_BAD_REQUEST
|
||
);
|
||
}
|
||
|
||
$responseData = ['recipientDisplayName' => ''];
|
||
if ($shareType === 'user') {
|
||
$user = $this->userManager->get($shareWith);
|
||
if ($user) {
|
||
$responseData = [
|
||
'recipientDisplayName' => $user->getDisplayName(),
|
||
'recipientUserId' => $user->getUID(),
|
||
];
|
||
}
|
||
}
|
||
|
||
return new JSONResponse($responseData, Http::STATUS_CREATED);
|
||
}
|
||
|
||
/**
|
||
* Send a notification about an existing share
|
||
*
|
||
* @param string $notificationType Notification type, e.g. SHARE_ACCEPTED
|
||
* @param string $resourceType calendar, file, contact,...
|
||
* @param string|null $providerId ID of the share
|
||
* @param array<string, mixed>|null $notification The actual payload of the notification
|
||
*
|
||
* @return JSONResponse<Http::STATUS_CREATED, array<string, mixed>, array{}>|JSONResponse<Http::STATUS_BAD_REQUEST, CloudFederationAPIValidationError, array{}>|JSONResponse<Http::STATUS_FORBIDDEN|Http::STATUS_NOT_IMPLEMENTED, CloudFederationAPIError, array{}>
|
||
* 201: The notification was successfully received
|
||
* 400: Bad request due to invalid parameters, e.g. when `type` is invalid or missing
|
||
* 403: Getting resource is not allowed
|
||
* 501: The resource type is not supported
|
||
*/
|
||
#[NoCSRFRequired]
|
||
#[PublicPage]
|
||
#[BruteForceProtection(action: 'receiveFederatedShareNotification')]
|
||
public function receiveNotification($notificationType, $resourceType, $providerId, ?array $notification) {
|
||
// check if all required parameters are set
|
||
if ($notificationType === null ||
|
||
$resourceType === null ||
|
||
$providerId === null ||
|
||
!is_array($notification)
|
||
) {
|
||
return new JSONResponse(
|
||
[
|
||
'message' => 'Missing arguments',
|
||
'validationErrors' => [],
|
||
],
|
||
Http::STATUS_BAD_REQUEST
|
||
);
|
||
}
|
||
|
||
try {
|
||
$provider = $this->cloudFederationProviderManager->getCloudFederationProvider($resourceType);
|
||
$result = $provider->notificationReceived($notificationType, $providerId, $notification);
|
||
} catch (ProviderDoesNotExistsException $e) {
|
||
return new JSONResponse(
|
||
[
|
||
'message' => $e->getMessage(),
|
||
'validationErrors' => [],
|
||
],
|
||
Http::STATUS_BAD_REQUEST
|
||
);
|
||
} catch (ShareNotFound $e) {
|
||
$response = new JSONResponse(
|
||
[
|
||
'message' => $e->getMessage(),
|
||
'validationErrors' => [],
|
||
],
|
||
Http::STATUS_BAD_REQUEST
|
||
);
|
||
$response->throttle();
|
||
return $response;
|
||
} catch (ActionNotSupportedException $e) {
|
||
return new JSONResponse(
|
||
['message' => $e->getMessage()],
|
||
Http::STATUS_NOT_IMPLEMENTED
|
||
);
|
||
} catch (BadRequestException $e) {
|
||
return new JSONResponse($e->getReturnMessage(), Http::STATUS_BAD_REQUEST);
|
||
} catch (AuthenticationFailedException $e) {
|
||
$response = new JSONResponse(['message' => 'RESOURCE_NOT_FOUND'], Http::STATUS_FORBIDDEN);
|
||
$response->throttle();
|
||
return $response;
|
||
} catch (\Exception $e) {
|
||
return new JSONResponse(
|
||
[
|
||
'message' => 'Internal error at ' . $this->urlGenerator->getBaseUrl(),
|
||
'validationErrors' => [],
|
||
],
|
||
Http::STATUS_BAD_REQUEST
|
||
);
|
||
}
|
||
|
||
return new JSONResponse($result, Http::STATUS_CREATED);
|
||
}
|
||
|
||
/**
|
||
* map login name to internal LDAP UID if a LDAP backend is in use
|
||
*
|
||
* @param string $uid
|
||
* @return string mixed
|
||
*/
|
||
private function mapUid($uid) {
|
||
// FIXME this should be a method in the user management instead
|
||
$this->logger->debug('shareWith before, ' . $uid, ['app' => $this->appName]);
|
||
\OCP\Util::emitHook(
|
||
'\OCA\Files_Sharing\API\Server2Server',
|
||
'preLoginNameUsedAsUserName',
|
||
['uid' => &$uid]
|
||
);
|
||
$this->logger->debug('shareWith after, ' . $uid, ['app' => $this->appName]);
|
||
|
||
return $uid;
|
||
}
|
||
}
|