1	<?php
2
3	/**
4	* This program is free software; you can redistribute it and/or
5	* modify it under the terms of the GNU General Public License
6	* as published by the Free Software Foundation; under version 2
7	* of the License (non-upgradable).
8	*
9	* This program is distributed in the hope that it will be useful,
10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12	* GNU General Public License for more details.
13	*
14	* You should have received a copy of the GNU General Public License
15	* along with this program; if not, write to the Free Software
16	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17	*
18	* Copyright (c) 2020 (original work) (update and modification) Open Assessment Technologies SA
19	*                    (under the project TAO-PRODUCT)
20	*
21	*/
22
23	declare(strict_types=1);
24
25	namespace oat\tao\model\oauth\lockout\storage;
26
27	use Exception;
28
29	/**
30	* Describe how should be implemented storage of failed OAuth sessions
31	*
32	* Interface LockoutStorageInterface
33	* @package oat\tao\model\oauth\lockout\storage
34	*/
35	interface LockoutStorageInterface
36	{
37	public const OPTION_PERSISTENCE = 'persistence';
38
39	/**
40	* Saves the data into storage
41	*
42	* @param string $ip Client IP address
43	* @param int $ttl How long entry will be valid
44	*
45	* @throws Exception
46	*/
47	public function store(string $ip, int $ttl = 0): void;
48
49	/**
50	* Returns amount of failed attempts for requested IP
51	*
52	* @param string $ip Client IP Address
53	*
54	* @param int $timeout
55	* @return mixed
56	*/
57	public function getFailedAttempts(string $ip, int $timeout): int;
58	}