aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/Security/Bruteforce/Backend/MemoryCacheBackend.php
blob: 32571c72fae12d55d1ddc4c387fd3740f7fd0322 (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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OC\Security\Bruteforce\Backend;

use OCP\AppFramework\Utility\ITimeFactory;
use OCP\ICache;
use OCP\ICacheFactory;

class MemoryCacheBackend implements IBackend {
	private ICache $cache;

	public function __construct(
		ICacheFactory $cacheFactory,
		private ITimeFactory $timeFactory,
	) {
		$this->cache = $cacheFactory->createDistributed(__CLASS__);
	}

	private function hash(
		null|string|array $data,
	): ?string {
		if ($data === null) {
			return null;
		}
		if (!is_string($data)) {
			$data = json_encode($data);
		}
		return hash('sha1', $data);
	}

	private function getExistingAttempts(string $identifier): array {
		$cachedAttempts = $this->cache->get($identifier);
		if ($cachedAttempts === null) {
			return [];
		}

		$cachedAttempts = json_decode($cachedAttempts, true);
		if (\is_array($cachedAttempts)) {
			return $cachedAttempts;
		}

		return [];
	}

	/**
	 * {@inheritDoc}
	 */
	public function getAttempts(
		string $ipSubnet,
		int $maxAgeTimestamp,
		?string $action = null,
		?array $metadata = null,
	): int {
		$identifier = $this->hash($ipSubnet);
		$actionHash = $this->hash($action);
		$metadataHash = $this->hash($metadata);
		$existingAttempts = $this->getExistingAttempts($identifier);

		$count = 0;
		foreach ($existingAttempts as $info) {
			[$occurredTime, $attemptAction, $attemptMetadata] = explode('#', $info, 3);
			if ($action === null || $attemptAction === $actionHash) {
				if ($metadata === null || $attemptMetadata === $metadataHash) {
					if ($occurredTime > $maxAgeTimestamp) {
						$count++;
					}
				}
			}
		}

		return $count;
	}

	/**
	 * {@inheritDoc}
	 */
	public function resetAttempts(
		string $ipSubnet,
		?string $action = null,
		?array $metadata = null,
	): void {
		$identifier = $this->hash($ipSubnet);
		if ($action === null) {
			$this->cache->remove($identifier);
		} else {
			$actionHash = $this->hash($action);
			$metadataHash = $this->hash($metadata);
			$existingAttempts = $this->getExistingAttempts($identifier);
			$maxAgeTimestamp = $this->timeFactory->getTime() - 12 * 3600;

			foreach ($existingAttempts as $key => $info) {
				[$occurredTime, $attemptAction, $attemptMetadata] = explode('#', $info, 3);
				if ($attemptAction === $actionHash) {
					if ($metadata === null || $attemptMetadata === $metadataHash) {
						unset($existingAttempts[$key]);
					} elseif ($occurredTime < $maxAgeTimestamp) {
						unset($existingAttempts[$key]);
					}
				}
			}

			if (!empty($existingAttempts)) {
				$this->cache->set($identifier, json_encode($existingAttempts), 12 * 3600);
			} else {
				$this->cache->remove($identifier);
			}
		}
	}

	/**
	 * {@inheritDoc}
	 */
	public function registerAttempt(
		string $ip,
		string $ipSubnet,
		int $timestamp,
		string $action,
		array $metadata = [],
	): void {
		$identifier = $this->hash($ipSubnet);
		$existingAttempts = $this->getExistingAttempts($identifier);
		$maxAgeTimestamp = $this->timeFactory->getTime() - 12 * 3600;

		// Unset all attempts that are already expired
		foreach ($existingAttempts as $key => $info) {
			[$occurredTime,] = explode('#', $info, 3);
			if ($occurredTime < $maxAgeTimestamp) {
				unset($existingAttempts[$key]);
			}
		}
		$existingAttempts = array_values($existingAttempts);

		// Store the new attempt
		$existingAttempts[] = $timestamp . '#' . $this->hash($action) . '#' .  $this->hash($metadata);

		$this->cache->set($identifier, json_encode($existingAttempts), 12 * 3600);
	}
}