Skip to content

Commit

Permalink
Merge pull request #46133 from nextcloud/bugfix/noid/fix-missing-prot…
Browse files Browse the repository at this point in the history
…ocol-on-remotes

fix(federation): Fix missing protocol on CloudID remote
  • Loading branch information
nickvergessen authored Jun 27, 2024
2 parents 1b49c86 + 280d70a commit 00aa8f5
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 21 deletions.
5 changes: 5 additions & 0 deletions apps/federatedfilesharing/tests/AddressHandlerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,11 @@ public function dataTestSplitUserRemote() {
foreach ($protocols as $protocol) {
$baseUrl = $user . '@' . $protocol . $remote;

if ($protocol === '') {
// https:// protocol is expected in the final result
$protocol = 'https://';
}

$testCases[] = [$baseUrl, $user, $protocol . $remote];
$testCases[] = [$baseUrl . '/', $user, $protocol . $remote];
$testCases[] = [$baseUrl . '/index.php', $user, $protocol . $remote];
Expand Down
2 changes: 1 addition & 1 deletion lib/private/Collaboration/Collaborators/RemotePlugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ public function search($search, $limit, $offset, ISearchResult $searchResult): b
public function splitUserRemote(string $address): array {
try {
$cloudId = $this->cloudIdManager->resolveCloudId($address);
return [$cloudId->getUser(), $cloudId->getRemote()];
return [$cloudId->getUser(), $this->cloudIdManager->removeProtocolFromUrl($cloudId->getRemote(), true)];
} catch (\InvalidArgumentException $e) {
throw new \InvalidArgumentException('Invalid Federated Cloud ID', 0, $e);
}
Expand Down
16 changes: 13 additions & 3 deletions lib/private/Federation/CloudIdManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public function resolveCloudId(string $cloudId): ICloudId {
}

// Find the first character that is not allowed in user names
$id = $this->fixRemoteURL($cloudId);
$id = $this->stripShareLinkFragments($cloudId);
$posSlash = strpos($id, '/');
$posColon = strpos($id, ':');

Expand All @@ -107,6 +107,7 @@ public function resolveCloudId(string $cloudId): ICloudId {
$this->userManager->validateUserId($user);

if (!empty($user) && !empty($remote)) {
$remote = $this->ensureDefaultProtocol($remote);
return new CloudId($id, $user, $remote, $this->getDisplayNameFromContact($id));
}
}
Expand Down Expand Up @@ -152,8 +153,9 @@ public function getCloudId(string $user, ?string $remote): ICloudId {
// note that for remote id's we don't strip the protocol for the remote we use to construct the CloudId
// this way if a user has an explicit non-https cloud id this will be preserved
// we do still use the version without protocol for looking up the display name
$remote = $this->fixRemoteURL($remote);
$remote = $this->stripShareLinkFragments($remote);
$host = $this->removeProtocolFromUrl($remote);
$remote = $this->ensureDefaultProtocol($remote);

$key = $user . '@' . ($isLocal ? 'local' : $host);
$cached = $this->cache[$key] ?? $this->memCache->get($key);
Expand Down Expand Up @@ -198,6 +200,14 @@ public function removeProtocolFromUrl(string $url, bool $httpsOnly = false): str
return $url;
}

protected function ensureDefaultProtocol(string $remote): string {
if (!str_contains($remote, '://')) {
$remote = 'https://' . $remote;
}

return $remote;
}

/**
* Strips away a potential file names and trailing slashes:
* - http://localhost
Expand All @@ -210,7 +220,7 @@ public function removeProtocolFromUrl(string $url, bool $httpsOnly = false): str
* @param string $remote
* @return string
*/
protected function fixRemoteURL(string $remote): string {
protected function stripShareLinkFragments(string $remote): string {
$remote = str_replace('\\', '/', $remote);
if ($fileNamePosition = strpos($remote, '/index.php')) {
$remote = substr($remote, 0, $fileNamePosition);
Expand Down
4 changes: 3 additions & 1 deletion lib/public/Federation/ICloudIdManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,11 @@ public function isValidCloudId(string $cloudId): bool;
* remove scheme/protocol from an url
*
* @param string $url
* @param bool $httpsOnly
*
* @return string
* @since 28.0.0
* @since 30.0.0 - Optional parameter $httpsOnly was added
*/
public function removeProtocolFromUrl(string $url): string;
public function removeProtocolFromUrl(string $url, bool $httpsOnly = false): string;
}
5 changes: 5 additions & 0 deletions tests/lib/Collaboration/Collaborators/RemotePluginTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,11 @@ public function dataTestSplitUserRemote() {
foreach ($protocols as $protocol) {
$baseUrl = $user . '@' . $protocol . $remote;

if ($protocol === 'https://') {
// https:// protocol is not expected in the final result
$protocol = '';
}

$testCases[] = [$baseUrl, $user, $protocol . $remote];
$testCases[] = [$baseUrl . '/', $user, $protocol . $remote];
$testCases[] = [$baseUrl . '/index.php', $user, $protocol . $remote];
Expand Down
24 changes: 8 additions & 16 deletions tests/lib/Federation/CloudIdManagerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ protected function setUp(): void {
);
}

public function cloudIdProvider() {
public function cloudIdProvider(): array {
return [
['test@example.com', 'test', 'example.com', 'test@example.com'],
['test@example.com/cloud', 'test', 'example.com/cloud', 'test@example.com/cloud'],
Expand All @@ -60,12 +60,8 @@ public function cloudIdProvider() {

/**
* @dataProvider cloudIdProvider
*
* @param string $cloudId
* @param string $user
* @param string $remote
*/
public function testResolveCloudId($cloudId, $user, $remote, $cleanId) {
public function testResolveCloudId(string $cloudId, string $user, string $noProtocolRemote, string $cleanId): void {
$displayName = 'Ample Ex';

$this->contactsManager->expects($this->any())
Expand All @@ -81,12 +77,12 @@ public function testResolveCloudId($cloudId, $user, $remote, $cleanId) {
$cloudId = $this->cloudIdManager->resolveCloudId($cloudId);

$this->assertEquals($user, $cloudId->getUser());
$this->assertEquals($remote, $cloudId->getRemote());
$this->assertEquals('https://' . $noProtocolRemote, $cloudId->getRemote());
$this->assertEquals($cleanId, $cloudId->getId());
$this->assertEquals($displayName . '@' . $remote, $cloudId->getDisplayId());
$this->assertEquals($displayName . '@' . $noProtocolRemote, $cloudId->getDisplayId());
}

public function invalidCloudIdProvider() {
public function invalidCloudIdProvider(): array {
return [
['example.com'],
['test:foo@example.com'],
Expand All @@ -100,7 +96,7 @@ public function invalidCloudIdProvider() {
* @param string $cloudId
*
*/
public function testInvalidCloudId($cloudId) {
public function testInvalidCloudId(string $cloudId): void {
$this->expectException(\InvalidArgumentException::class);

$this->contactsManager->expects($this->never())
Expand All @@ -111,10 +107,10 @@ public function testInvalidCloudId($cloudId) {

public function getCloudIdProvider(): array {
return [
['test', 'example.com', 'test@example.com'],
['test', 'example.com', 'test@example.com', null, 'https://example.com', 'https://example.com'],
['test', 'http://example.com', 'test@http://example.com', 'test@example.com'],
['test', null, 'test@http://example.com', 'test@example.com', 'http://example.com', 'http://example.com'],
['test@example.com', 'example.com', 'test@example.com@example.com'],
['test@example.com', 'example.com', 'test@example.com@example.com', null, 'https://example.com', 'https://example.com'],
['test@example.com', 'https://example.com', 'test@example.com@example.com'],
['test@example.com', null, 'test@example.com@example.com', null, 'https://example.com', 'https://example.com'],
['test@example.com', 'https://example.com/index.php/s/shareToken', 'test@example.com@example.com', null, 'https://example.com', 'https://example.com'],
Expand All @@ -123,10 +119,6 @@ public function getCloudIdProvider(): array {

/**
* @dataProvider getCloudIdProvider
*
* @param string $user
* @param null|string $remote
* @param string $id
*/
public function testGetCloudId(string $user, ?string $remote, string $id, ?string $searchCloudId = null, ?string $localHost = 'https://example.com', ?string $expectedRemoteId = null): void {
if ($remote !== null) {
Expand Down

0 comments on commit 00aa8f5

Please sign in to comment.