VerificationResult::wasOtpInvalid()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
nc 1
nop 0
1
<?php
2
3
/**
4
 * Copyright 2014 SURFnet bv
5
 *
6
 * Licensed under the Apache License, Version 2.0 (the "License");
7
 * you may not use this file except in compliance with the License.
8
 * You may obtain a copy of the License at
9
 *
10
 *     http://www.apache.org/licenses/LICENSE-2.0
11
 *
12
 * Unless required by applicable law or agreed to in writing, software
13
 * distributed under the License is distributed on an "AS IS" BASIS,
14
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
 * See the License for the specific language governing permissions and
16
 * limitations under the License.
17
 */
18
19
namespace Surfnet\StepupRa\RaBundle\Service\YubikeySecondFactor;
20
21
use Surfnet\StepupBundle\Value\YubikeyPublicId;
22
use Surfnet\StepupRa\RaBundle\Exception\DomainException;
23
24
class VerificationResult
25
{
26
    const RESULT_PUBLIC_ID_MATCHED = 0;
27
    const RESULT_PUBLIC_ID_DID_NOT_MATCH = 1;
28
    const RESULT_OTP_VERIFICATION_FAILED = 2;
29
    const RESULT_OTP_INVALID = 3;
30
31
    /**
32
     * @var \Surfnet\StepupBundle\Value\YubikeyPublicId|null
33
     */
34
    private $publicId;
35
36
    /**
37
     * @var int One of the RESULT constants.
38
     */
39
    private $result;
40
41
    /**
42
     * @param int $result
43
     * @param YubikeyPublicId|null $publicId
44
     */
45
    public function __construct($result, YubikeyPublicId $publicId = null)
46
    {
47
        $acceptableResults = [
48
            self::RESULT_PUBLIC_ID_MATCHED,
49
            self::RESULT_PUBLIC_ID_DID_NOT_MATCH,
50
            self::RESULT_OTP_VERIFICATION_FAILED,
51
            self::RESULT_OTP_INVALID,
52
        ];
53
54
        if (!in_array($result, $acceptableResults)) {
55
            throw new DomainException('Public ID verification result is not one of the RESULT constants.');
56
        }
57
58
        $this->result = $result;
59
        $this->publicId = $publicId;
60
    }
61
62
    public function didPublicIdMatch()
63
    {
64
        return $this->result === self::RESULT_PUBLIC_ID_MATCHED && $this->publicId !== null;
65
    }
66
67
    public function wasOtpInvalid()
68
    {
69
        return $this->result === self::RESULT_OTP_INVALID;
70
    }
71
72
    public function didOtpVerificationFail()
73
    {
74
        return $this->result === self::RESULT_OTP_VERIFICATION_FAILED;
75
    }
76
77
    /**
78
     * @return YubikeyPublicId|null
79
     */
80
    public function getPublicId()
81
    {
82
        return $this->publicId;
83
    }
84
}
85