aboutsummaryrefslogtreecommitdiffstats
path: root/apps/dav/lib/DAV/PublicAuth.php
blob: c2b4ada173aaedd2b98b10320644ac006b36d41a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<?php

/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */
namespace OCA\DAV\DAV;

use Sabre\DAV\Auth\Backend\BackendInterface;
use Sabre\HTTP\RequestInterface;
use Sabre\HTTP\ResponseInterface;

class PublicAuth implements BackendInterface {

	/** @var string[] */
	private $publicURLs;

	public function __construct() {
		$this->publicURLs = [
			'public-calendars',
			'principals/system/public'
		];
	}

	/**
	 * When this method is called, the backend must check if authentication was
	 * successful.
	 *
	 * The returned value must be one of the following
	 *
	 * [true, "principals/username"]
	 * [false, "reason for failure"]
	 *
	 * If authentication was successful, it's expected that the authentication
	 * backend returns a so-called principal url.
	 *
	 * Examples of a principal url:
	 *
	 * principals/admin
	 * principals/user1
	 * principals/users/joe
	 * principals/uid/123457
	 *
	 * If you don't use WebDAV ACL (RFC3744) we recommend that you simply
	 * return a string such as:
	 *
	 * principals/users/[username]
	 *
	 * @param RequestInterface $request
	 * @param ResponseInterface $response
	 * @return array
	 */
	public function check(RequestInterface $request, ResponseInterface $response) {
		if ($this->isRequestPublic($request)) {
			return [true, 'principals/system/public'];
		}
		return [false, 'No public access to this resource.'];
	}

	/**
	 * @inheritdoc
	 */
	public function challenge(RequestInterface $request, ResponseInterface $response) {
	}

	/**
	 * @param RequestInterface $request
	 * @return bool
	 */
	private function isRequestPublic(RequestInterface $request) {
		$url = $request->getPath();
		$matchingUrls = array_filter($this->publicURLs, function ($publicUrl) use ($url) {
			return str_starts_with($url, $publicUrl);
		});
		return !empty($matchingUrls);
	}
}