summaryrefslogtreecommitdiff
path: root/app/Core/Security/PostAuthenticationProviderInterface.php
blob: 3f628bb0f4be645a7e1a785f84250d607c34c7ef (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
<?php

namespace Kanboard\Core\Security;

/**
 * Post Authentication Provider Interface
 *
 * @package  security
 * @author   Frederic Guillot
 */
interface PostAuthenticationProviderInterface extends AuthenticationProviderInterface
{
    /**
     * Called only one time before to prompt the user for pin code
     *
     * @access public
     */
    public function beforeCode();

    /**
     * Set user pin-code
     *
     * @access public
     * @param  string $code
     */
    public function setCode($code);

    /**
     * Generate secret if necessary
     *
     * @access public
     * @return string
     */
    public function generateSecret();

    /**
     * Set secret token (fetched from user profile)
     *
     * @access public
     * @param  string  $secret
     */
    public function setSecret($secret);

    /**
     * Get secret token (will be saved in user profile)
     *
     * @access public
     * @return string
     */
    public function getSecret();

    /**
     * Get QR code url (empty if no QR can be provided)
     *
     * @access public
     * @param  string $label
     * @return string
     */
    public function getQrCodeUrl($label);

    /**
     * Get key url (empty if no url can be provided)
     *
     * @access public
     * @param  string $label
     * @return string
     */
    public function getKeyUrl($label);
}