blob: d7842293f8a464baa29953c88a055c2c7ea57e61 (
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
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Robin Appelman <robin@icewind.nl>
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OC\Authentication\Token;
use JsonSerializable;
interface IToken extends JsonSerializable {
public const TEMPORARY_TOKEN = 0;
public const PERMANENT_TOKEN = 1;
public const WIPE_TOKEN = 2;
public const DO_NOT_REMEMBER = 0;
public const REMEMBER = 1;
/**
* Get the token ID
*
* @return int
*/
public function getId(): int;
/**
* Get the user UID
*
* @return string
*/
public function getUID(): string;
/**
* Get the login name used when generating the token
*
* @return string
*/
public function getLoginName(): string;
/**
* Get the (encrypted) login password
*
* @return string|null
*/
public function getPassword();
/**
* Get the timestamp of the last password check
*
* @return int
*/
public function getLastCheck(): int;
/**
* Set the timestamp of the last password check
*
* @param int $time
*/
public function setLastCheck(int $time);
/**
* Get the authentication scope for this token
*
* @return string
*/
public function getScope(): string;
/**
* Get the authentication scope for this token
*
* @return array
*/
public function getScopeAsArray(): array;
/**
* Set the authentication scope for this token
*
* @param array $scope
*/
public function setScope($scope);
/**
* Get the name of the token
* @return string
*/
public function getName(): string;
/**
* Get the remember state of the token
*
* @return int
*/
public function getRemember(): int;
/**
* Get the token type
*
* @return int
* @psalm-return IToken::DO_NOT_REMEMBER|IToken::REMEMBER
*/
public function getType(): int;
/**
* Set the token
*
* @param string $token
*/
public function setToken(string $token);
/**
* Set the password
*
* @param string $password
*/
public function setPassword(string $password);
/**
* Set the expiration time of the token
*
* @param int|null $expires
*/
public function setExpires($expires);
}
|
