Skip to content

Commit

Permalink
fix: make federation address book sync work with allow_local_remote_s…
Browse files Browse the repository at this point in the history
…ervers = false

Client.preventLocalAddress expects an absolute URL, which means the base_uri option cannot be used.

Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>
  • Loading branch information
kesselb authored and backportbot[bot] committed Oct 1, 2024
1 parent da8ef3c commit 4d6dd65
Show file tree
Hide file tree
Showing 2 changed files with 91 additions and 10 deletions.
46 changes: 36 additions & 10 deletions apps/dav/lib/CardDAV/SyncService.php
Original file line number Diff line number Diff line change
Expand Up @@ -130,25 +130,54 @@ public function ensureSystemAddressBookExists(string $principal, string $uri, ar
}, $this->dbConnection);
}

private function prepareUri(string $host, string $path): string {
/*
* The trailing slash is important for merging the uris together.
*
* $host is stored in oc_trusted_servers.url and usually without a trailing slash.
*
* Example for a report request
*
* $host = 'https://server.internal/cloud'
* $path = 'remote.php/dav/addressbooks/system/system/system'
*
* Without the trailing slash, the webroot is missing:
* https://server.internal/remote.php/dav/addressbooks/system/system/system
*
* Example for a download request
*
* $host = 'https://server.internal/cloud'
* $path = '/cloud/remote.php/dav/addressbooks/system/system/system/Database:alice.vcf'
*
* The response from the remote usually contains the webroot already and must be normalized to:
* https://server.internal/cloud/remote.php/dav/addressbooks/system/system/system/Database:alice.vcf
*/
$host = rtrim($host, '/') . '/';

$uri = \GuzzleHttp\Psr7\UriResolver::resolve(
\GuzzleHttp\Psr7\Utils::uriFor($host),
\GuzzleHttp\Psr7\Utils::uriFor($path)
);

return (string)$uri;
}

/**
* @throws ClientExceptionInterface
*/
protected function requestSyncReport(string $url, string $userName, string $addressBookUrl, string $sharedSecret, ?string $syncToken): array {
$client = $this->clientService->newClient();

// the trailing slash is important for merging base_uri and uri
$url = rtrim($url, '/') . '/';
$uri = $this->prepareUri($url, $addressBookUrl);

$options = [
'auth' => [$userName, $sharedSecret],
'base_uri' => $url,
'body' => $this->buildSyncCollectionRequestBody($syncToken),
'headers' => ['Content-Type' => 'application/xml']
];

$response = $client->request(
'REPORT',
$addressBookUrl,
$uri,
$options
);

Expand All @@ -160,17 +189,14 @@ protected function requestSyncReport(string $url, string $userName, string $addr

protected function download(string $url, string $userName, string $sharedSecret, string $resourcePath): string {
$client = $this->clientService->newClient();

// the trailing slash is important for merging base_uri and uri
$url = rtrim($url, '/') . '/';
$uri = $this->prepareUri($url, $resourcePath);

$options = [
'auth' => [$userName, $sharedSecret],
'base_uri' => $url,
];

$response = $client->get(
$resourcePath,
$uri,
$options
);

Expand Down
55 changes: 55 additions & 0 deletions apps/dav/tests/unit/CardDAV/SyncServiceTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -446,4 +446,59 @@ public function testDeleteAddressbookWhenAccessRevoked(): void {
[]
);
}

/**
* @dataProvider providerUseAbsoluteUriReport
*/
public function testUseAbsoluteUriReport(string $host, string $expected): void {
$body = '<?xml version="1.0"?>
<d:multistatus xmlns:d="DAV:" xmlns:s="http://sabredav.org/ns" xmlns:card="urn:ietf:params:xml:ns:carddav" xmlns:oc="http://owncloud.org/ns">
<d:sync-token>http://sabre.io/ns/sync/1</d:sync-token>
</d:multistatus>';

$requestResponse = new Response(new PsrResponse(
207,
['Content-Type' => 'application/xml; charset=utf-8', 'Content-Length' => strlen($body)],
$body
));

$this->client
->method('request')
->with(
'REPORT',
$this->callback(function ($uri) use ($expected) {
$this->assertEquals($expected, $uri);
return true;
}),
$this->callback(function ($options) {
$this->assertIsArray($options);
return true;
}),
)
->willReturn($requestResponse);

$this->service->syncRemoteAddressBook(
$host,
'system',
'remote.php/dav/addressbooks/system/system/system',
'1234567890',
null,
'1',
'principals/system/system',
[]
);
}

public function providerUseAbsoluteUriReport(): array {
return [
['https://server.internal', 'https://server.internal/remote.php/dav/addressbooks/system/system/system'],
['https://server.internal/', 'https://server.internal/remote.php/dav/addressbooks/system/system/system'],
['https://server.internal/nextcloud', 'https://server.internal/nextcloud/remote.php/dav/addressbooks/system/system/system'],
['https://server.internal/nextcloud/', 'https://server.internal/nextcloud/remote.php/dav/addressbooks/system/system/system'],
['https://server.internal:8080', 'https://server.internal:8080/remote.php/dav/addressbooks/system/system/system'],
['https://server.internal:8080/', 'https://server.internal:8080/remote.php/dav/addressbooks/system/system/system'],
['https://server.internal:8080/nextcloud', 'https://server.internal:8080/nextcloud/remote.php/dav/addressbooks/system/system/system'],
['https://server.internal:8080/nextcloud/', 'https://server.internal:8080/nextcloud/remote.php/dav/addressbooks/system/system/system'],
];
}
}

0 comments on commit 4d6dd65

Please sign in to comment.