aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Authentication/Token/IToken.php
blob: 4f232b83d4ed78f56ce17715050be972d4749d77 (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
<?php

declare(strict_types=1);
/**
 * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Authentication\Token;

use JsonSerializable;

/**
 * @since 28.0.0
 */
interface IToken extends JsonSerializable {
	/**
	 * @since 28.0.0
	 */
	public const TEMPORARY_TOKEN = 0;
	/**
	 * @since 28.0.0
	 */
	public const PERMANENT_TOKEN = 1;
	/**
	 * @since 28.0.0
	 */
	public const WIPE_TOKEN = 2;
	/**
	 * @since 28.0.0
	 */
	public const DO_NOT_REMEMBER = 0;
	/**
	 * @since 28.0.0
	 */
	public const REMEMBER = 1;

	/**
	 * Get the token ID
	 * @since 28.0.0
	 */
	public function getId(): int;

	/**
	 * Get the user UID
	 * @since 28.0.0
	 */
	public function getUID(): string;

	/**
	 * Get the login name used when generating the token
	 * @since 28.0.0
	 */
	public function getLoginName(): string;

	/**
	 * Get the (encrypted) login password
	 * @since 28.0.0
	 */
	public function getPassword(): ?string;

	/**
	 * Get the timestamp of the last password check
	 * @since 28.0.0
	 */
	public function getLastCheck(): int;

	/**
	 * Set the timestamp of the last password check
	 * @since 28.0.0
	 */
	public function setLastCheck(int $time): void;

	/**
	 * Get the authentication scope for this token
	 * @since 28.0.0
	 */
	public function getScope(): string;

	/**
	 * Get the authentication scope for this token
	 * @since 28.0.0
	 */
	public function getScopeAsArray(): array;

	/**
	 * Set the authentication scope for this token
	 * @since 28.0.0
	 */
	public function setScope(array $scope): void;

	/**
	 * Get the name of the token
	 * @since 28.0.0
	 */
	public function getName(): string;

	/**
	 * Get the remember state of the token
	 * @since 28.0.0
	 */
	public function getRemember(): int;

	/**
	 * Set the token
	 * @since 28.0.0
	 */
	public function setToken(string $token): void;

	/**
	 * Set the password
	 * @since 28.0.0
	 */
	public function setPassword(string $password): void;

	/**
	 * Set the expiration time of the token
	 * @since 28.0.0
	 */
	public function setExpires(?int $expires): void;
}