├── .gitignore
├── phpunit.xml
├── psalm.xml
├── src
├── MultiFactorInterface.php
├── OTP
│ ├── OTPInterface.php
│ ├── HOTP.php
│ └── TOTP.php
├── OneTime.php
└── Vendor
│ └── GoogleAuth.php
├── .github
└── workflows
│ └── php.yml
├── test
├── fixtures
│ ├── 3532ed4f5457b06c9eb3b0c0d9bc2b7c4a5d0576519dc5abf4cfce1af2d216b70a6ffd7a0a12558897cb778973e8711cb16955c2a455ea111ad5d0b9d9f22bce.qrcode.txt
│ ├── 68aa8b264cdc6ddc8a667802dc5169c8ba56f2932452b41869739c57a086c57812c4d6eea5ad0dda8aaa06795c62c5b03773be106668c39953b8ae3e4ca87a06.qrcode.txt
│ ├── 9efd625902fbeedfda8c7f37d84b9e27eec0db1577363348a2d333bf3cc422444f644568c10c91c845675552b2b74cb865e0fb2fa1fcdbdd02e5a707af65cae5.qrcode.txt
│ └── 01af3168cf7dbe47c7da88e595f2c34357f9bc2b54314d7e3f65572daa7e30e97ca2ef7716edc7c30b1792b53e35a68834094e9da3c3d815058d54e26545389a.qrcode.txt
├── HOTPTest.php
├── GoogleAuthTest.php
└── TOTPTest.php
├── README.md
├── composer.json
└── LICENSE
/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 | /composer.lock
3 | .phpunit.result.cache
4 |
--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | test
5 |
6 |
7 |
8 |
--------------------------------------------------------------------------------
/psalm.xml:
--------------------------------------------------------------------------------
1 |
2 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/src/MultiFactorInterface.php:
--------------------------------------------------------------------------------
1 | validateCode($_POST['2facode'], time())) {
37 | // Login successful
38 | }
39 | }
40 | ```
41 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "paragonie/multi-factor",
3 | "description": "Vendor-agnostic two-factor authentication library",
4 | "keywords": [
5 | "TOTP",
6 | "HOTP",
7 | "two-factor",
8 | "two-factor authentication",
9 | "2FA",
10 | "TFA",
11 | "MFA",
12 | "multi-factor",
13 | "multi-factor authentication"
14 | ],
15 | "license": [
16 | "GPL-3.0+",
17 | "MIT",
18 | "proprietary"
19 | ],
20 | "type": "library",
21 | "authors": [
22 | {
23 | "name": "Paragon Initiative Enterprises",
24 | "email": "security@paragonie.com",
25 | "homepage": "https://paragonie.com",
26 | "role": "Developer"
27 | }
28 | ],
29 | "support": {
30 | "issues": "https://github.com/paragonie/multi_factor/issues",
31 | "email": "info@paragonie.com",
32 | "source": "https://github.com/paragonie/multi_factor"
33 | },
34 | "require": {
35 | "php": ">=7.2",
36 | "bacon/bacon-qr-code": "^2",
37 | "paragonie/constant_time_encoding": "^2",
38 | "paragonie/hidden-string": "^1"
39 | },
40 | "require-dev": {
41 | "phpunit/phpunit": "^8",
42 | "psalm/plugin-phpunit": "^0.15",
43 | "vimeo/psalm": "^4.4"
44 | },
45 | "autoload": {
46 | "psr-4": {
47 | "ParagonIE\\MultiFactor\\": "src/"
48 | }
49 | }
50 | }
51 |
--------------------------------------------------------------------------------
/test/fixtures/9efd625902fbeedfda8c7f37d84b9e27eec0db1577363348a2d333bf3cc422444f644568c10c91c845675552b2b74cb865e0fb2fa1fcdbdd02e5a707af65cae5.qrcode.txt:
--------------------------------------------------------------------------------
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 |
--------------------------------------------------------------------------------
/test/fixtures/01af3168cf7dbe47c7da88e595f2c34357f9bc2b54314d7e3f65572daa7e30e97ca2ef7716edc7c30b1792b53e35a68834094e9da3c3d815058d54e26545389a.qrcode.txt:
--------------------------------------------------------------------------------
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 |
--------------------------------------------------------------------------------
/src/OneTime.php:
--------------------------------------------------------------------------------
1 | secretKey = ($secretKey instanceof HiddenString) ? $secretKey : new HiddenString($secretKey);
39 | if (!$otp) {
40 | $otp = new TOTP();
41 | }
42 | $this->otp = $otp;
43 | }
44 |
45 | /**
46 | * Generate a TOTP code for 2FA
47 | *
48 | * @param int $counterValue
49 | * @return string
50 | */
51 | public function generateCode(int $counterValue = 0): string
52 | {
53 | return $this->otp->getCode(
54 | $this->secretKey,
55 | $counterValue
56 | );
57 | }
58 |
59 | /**
60 | * Validate a user-provided code
61 | *
62 | * @param string $code
63 | * @param int $counterValue
64 | * @return bool
65 | */
66 | public function validateCode(string $code, int $counterValue = 0): bool
67 | {
68 | $expected = $this->generateCode($counterValue);
69 | return \hash_equals($code, $expected);
70 | }
71 | }
72 |
--------------------------------------------------------------------------------
/test/HOTPTest.php:
--------------------------------------------------------------------------------
1 | assertSame('755224', $hotp->getCode($seed, 0));
24 | $this->assertSame('287082', $hotp->getCode($seed, 1));
25 | $this->assertSame('359152', $hotp->getCode($seed, 2));
26 | $this->assertSame('969429', $hotp->getCode($seed, 3));
27 | $this->assertSame('338314', $hotp->getCode($seed, 4));
28 | $this->assertSame('254676', $hotp->getCode($seed, 5));
29 | $this->assertSame('287922', $hotp->getCode($seed, 6));
30 | $this->assertSame('162583', $hotp->getCode($seed, 7));
31 | $this->assertSame('399871', $hotp->getCode($seed, 8));
32 | $this->assertSame('520489', $hotp->getCode($seed, 9));
33 | }
34 |
35 | /**
36 | * @dataProvider dataProviderFailureOfGetCode
37 | *
38 | * @psalm-param class-string<\Throwable> $expectedException
39 | */
40 | public function testFailureOfGetCode(
41 | int $length,
42 | string $expectedException,
43 | string $expectedExceptionMessage,
44 | string $sharedSecret,
45 | int $counterValue
46 | ): void {
47 | $hotp = new HOTP($length);
48 |
49 | $this->assertSame($length, $hotp->getLength());
50 |
51 | $this->expectException($expectedException);
52 | $this->expectExceptionMessage($expectedExceptionMessage);
53 |
54 | $hotp->getCode($sharedSecret, $counterValue);
55 | }
56 |
57 | /**
58 | * @psalm-return array, 2:string, 3:string, 4:int}>
59 | */
60 | public function dataProviderFailureOfGetCode(): array
61 | {
62 | $seed = Hex::decode(
63 | "3132333435363738393031323334353637383930"
64 | );
65 |
66 | return [
67 | [
68 | 0,
69 | \OutOfRangeException::class,
70 | 'Length must be between 1 and 10, as a consequence of RFC 6238.',
71 | $seed,
72 | 0,
73 | ],
74 | [
75 | 11,
76 | \OutOfRangeException::class,
77 | 'Length must be between 1 and 10, as a consequence of RFC 6238.',
78 | $seed,
79 | 0,
80 | ],
81 | ];
82 | }
83 | }
84 |
--------------------------------------------------------------------------------
/src/OTP/HOTP.php:
--------------------------------------------------------------------------------
1 | length = $length;
38 | $this->algo = $algo;
39 | }
40 |
41 | /**
42 | * Generate a HOTP secret in accordance with RFC 4226
43 | *
44 | * @ref https://tools.ietf.org/html/rfc4226
45 | * @param string|HiddenString $sharedSecret The key to use for determining the HOTP
46 | * @param int $counterValue Current time or HOTP counter
47 | * @return string
48 | * @throws \OutOfRangeException
49 | */
50 | public function getCode(
51 | $sharedSecret,
52 | int $counterValue
53 | ): string {
54 | if ($this->length < 1 || $this->length > 10) {
55 | throw new \OutOfRangeException(
56 | 'Length must be between 1 and 10, as a consequence of RFC 6238.'
57 | );
58 | }
59 | $msg = $this->getTValue($counterValue, true);
60 | $bytes = \hash_hmac($this->algo, $msg, is_string($sharedSecret) ? $sharedSecret : $sharedSecret->getString(), true);
61 |
62 | $byteLen = Binary::safeStrlen($bytes);
63 |
64 | // Per the RFC
65 | $offset = \unpack('C', $bytes[$byteLen - 1])[1];
66 | $offset &= 0x0f;
67 |
68 | $unpacked = \array_values(
69 | \unpack('C*', Binary::safeSubstr($bytes, $offset, 4))
70 | );
71 |
72 | $intValue = (
73 | (($unpacked[0] & 0x7f) << 24)
74 | | (($unpacked[1] & 0xff) << 16)
75 | | (($unpacked[2] & 0xff) << 8)
76 | | (($unpacked[3] & 0xff) )
77 | );
78 |
79 | $intValue %= 10 ** $this->length;
80 |
81 | return \str_pad(
82 | (string) $intValue,
83 | $this->length,
84 | '0',
85 | \STR_PAD_LEFT
86 | );
87 | }
88 |
89 | /**
90 | * @return int
91 | */
92 | public function getLength(): int
93 | {
94 | return $this->length;
95 | }
96 |
97 | /**
98 | * Get the binary T value
99 | *
100 | * @param int $unixTimestamp
101 | * @param bool $rawOutput
102 | * @return string
103 | */
104 | protected function getTValue(
105 | int $counter,
106 | bool $rawOutput = false
107 | ): string {
108 | $hex = \str_pad(
109 | \dechex($counter),
110 | 16,
111 | '0',
112 | STR_PAD_LEFT
113 | );
114 | if ($rawOutput) {
115 | return Hex::decode($hex);
116 | }
117 | return $hex;
118 | }
119 | }
120 |
--------------------------------------------------------------------------------
/src/Vendor/GoogleAuth.php:
--------------------------------------------------------------------------------
1 | makeQRCodeMessage($username, $issuer, $label, $initialCounter);
48 |
49 | $this->makeQRCodeWriteOrDefault($qrCodeWriter)->writeFile($message, $outFile);
50 | }
51 |
52 | public function getQRCode(
53 | Writer $qrCodeWriter = null,
54 | string $username = '',
55 | string $issuer = '',
56 | string $label = '',
57 | int $initialCounter = 0
58 | ): string {
59 | $message = $this->makeQRCodeMessage($username, $issuer, $label, $initialCounter);
60 |
61 | return $this->makeQRCodeWriteOrDefault($qrCodeWriter)->writeString($message);
62 | }
63 |
64 | public function makeQRCodeMessage(
65 | string $username = '',
66 | string $issuer = '',
67 | string $label = '',
68 | int $initialCounter = 0
69 | ): string {
70 | if ($this->otp instanceof TOTP) {
71 | $message = 'otpauth://totp/';
72 | } elseif ($this->otp instanceof HOTP) {
73 | $message = 'otpauth://hotp/';
74 | } else {
75 | throw new \Exception('Not implemented');
76 | }
77 | if ($label) {
78 | $message .= \urlencode(
79 | \str_replace(':', '', $label)
80 | );
81 | $message .= ':';
82 | }
83 | $message .= \urlencode($username);
84 | $args = [
85 | 'secret' => Base32::encode($this->secretKey->getString())
86 | ];
87 | if ($issuer) {
88 | $args['issuer'] = $issuer;
89 | }
90 | $args['digits'] = $this->otp->getLength();
91 | if ($this->otp instanceof TOTP) {
92 | $args['period'] = $this->otp->getTimeStep();
93 | } else {
94 | $args['counter'] = $initialCounter;
95 | }
96 | $message .= '?' . \http_build_query($args);
97 |
98 | return $message;
99 | }
100 |
101 | protected function makeQRCodeWriteOrDefault(Writer $qrCodeWriter = null) : Writer
102 | {
103 | // Sane default; You can dependency-inject a replacement:
104 | if (!$qrCodeWriter) {
105 | $renderer = new ImageRenderer(
106 | new RendererStyle($this->defaultQRCodeSize),
107 | new ImagickImageBackEnd()
108 | );
109 | $qrCodeWriter = new Writer($renderer);
110 | }
111 |
112 | return $qrCodeWriter;
113 | }
114 | }
115 |
--------------------------------------------------------------------------------
/src/OTP/TOTP.php:
--------------------------------------------------------------------------------
1 | timeZero = $timeZero;
52 | $this->timeStep = $timeStep;
53 | $this->length = $length;
54 | $this->algo = $algo;
55 | }
56 |
57 | /**
58 | * Generate a TOTP secret in accordance with RFC 6238
59 | *
60 | * @ref https://tools.ietf.org/html/rfc6238
61 | * @param string|HiddenString $sharedSecret The key to use for determining the TOTP
62 | * @param int $counterValue Current time or HOTP counter
63 | * @return string
64 | * @throws \OutOfRangeException
65 | */
66 | public function getCode(
67 | $sharedSecret,
68 | int $counterValue
69 | ): string {
70 | if ($this->length < 1 || $this->length > 10) {
71 | throw new \OutOfRangeException(
72 | 'Length must be between 1 and 10, as a consequence of RFC 6238.'
73 | );
74 | }
75 | $msg = $this->getTValue($counterValue, true);
76 | $bytes = \hash_hmac($this->algo, $msg, is_string($sharedSecret) ? $sharedSecret : $sharedSecret->getString(), true);
77 |
78 | $byteLen = Binary::safeStrlen($bytes);
79 |
80 | // Per the RFC
81 | $offset = \unpack('C', $bytes[$byteLen - 1])[1];
82 | $offset &= 0x0f;
83 |
84 | $unpacked = \array_values(
85 | \unpack('C*', Binary::safeSubstr($bytes, $offset, 4))
86 | );
87 |
88 | $intValue = (
89 | (($unpacked[0] & 0x7f) << 24)
90 | | (($unpacked[1] & 0xff) << 16)
91 | | (($unpacked[2] & 0xff) << 8)
92 | | (($unpacked[3] & 0xff) )
93 | );
94 |
95 | $intValue %= 10 ** $this->length;
96 |
97 | return \str_pad(
98 | (string) $intValue,
99 | $this->length,
100 | '0',
101 | \STR_PAD_LEFT
102 | );
103 | }
104 |
105 | /**
106 | * @return int
107 | */
108 | public function getLength(): int
109 | {
110 | return $this->length;
111 | }
112 |
113 | /**
114 | * @return int
115 | */
116 | public function getTimeStep(): int
117 | {
118 | return $this->timeStep;
119 | }
120 |
121 | /**
122 | * Get the binary T value
123 | *
124 | * @param int $unixTimestamp
125 | * @param bool $rawOutput
126 | * @return string
127 | */
128 | protected function getTValue(
129 | int $unixTimestamp,
130 | bool $rawOutput = false
131 | ): string {
132 | $value = \intdiv(
133 | $unixTimestamp - $this->timeZero,
134 | $this->timeStep !== 0
135 | ? $this->timeStep
136 | : 1
137 | );
138 | $hex = \str_pad(
139 | \dechex($value),
140 | 16,
141 | '0',
142 | STR_PAD_LEFT
143 | );
144 | if ($rawOutput) {
145 | return Hex::decode($hex);
146 | }
147 | return $hex;
148 | }
149 | }
150 |
--------------------------------------------------------------------------------
/test/GoogleAuthTest.php:
--------------------------------------------------------------------------------
1 |
16 | */
17 | public function dataProviderMakeQRCodeMessage() : Generator
18 | {
19 | $seed = Hex::decode(
20 | "3132333435363738393031323334353637383930"
21 | );
22 |
23 | // Seed for HMAC-SHA512 - 64 bytes
24 | $seed64 = Hex::decode(
25 | "3132333435363738393031323334353637383930" .
26 | "3132333435363738393031323334353637383930" .
27 | "3132333435363738393031323334353637383930" .
28 | "31323334"
29 | );
30 |
31 | $sha512 = new TOTP(0, 30, 8, 'sha512');
32 |
33 | $googleAuths = [
34 | HOTP::class => new GoogleAuth($seed, new HOTP()),
35 | TOTP::class => new GoogleAuth($seed64, $sha512),
36 | ];
37 |
38 | $writers = [
39 | null,
40 | new Writer(new PlainTextRenderer()),
41 | ];
42 |
43 | foreach ($writers as $writer) {
44 | yield [
45 | 'otpauth://totp/?secret=gezdgnbvgy3tqojqgezdgnbvgy3tqojqgezdgnbvgy3tqojqgezdgnbvgy3tqojqgezdgnbvgy3tqojqgezdgnbvgy3tqojqgezdgna%3D&digits=8&period=30',
46 | '',
47 | '',
48 | '',
49 | 0,
50 | $googleAuths[TOTP::class],
51 | $writer,
52 | ];
53 |
54 | yield [
55 | 'otpauth://hotp/?secret=gezdgnbvgy3tqojqgezdgnbvgy3tqojq&digits=6&counter=0',
56 | '',
57 | '',
58 | '',
59 | 0,
60 | $googleAuths[HOTP::class],
61 | $writer,
62 | ];
63 |
64 | yield [
65 | 'otpauth://totp/baz:foo%40example.com?secret=gezdgnbvgy3tqojqgezdgnbvgy3tqojqgezdgnbvgy3tqojqgezdgnbvgy3tqojqgezdgnbvgy3tqojqgezdgnbvgy3tqojqgezdgna%3D&issuer=bar&digits=8&period=30',
66 | 'foo@example.com',
67 | 'bar',
68 | 'baz',
69 | 1,
70 | $googleAuths[TOTP::class],
71 | $writer,
72 | ];
73 |
74 | yield [
75 | 'otpauth://hotp/baz:foo%40example.com?secret=gezdgnbvgy3tqojqgezdgnbvgy3tqojq&issuer=bar&digits=6&counter=1',
76 | 'foo@example.com',
77 | 'bar',
78 | 'baz',
79 | 1,
80 | $googleAuths[HOTP::class],
81 | $writer,
82 | ];
83 | }
84 | }
85 |
86 | /**
87 | * @dataProvider dataProviderMakeQRCodeMessage
88 | */
89 | public function testMakeQRCodeMessage(
90 | string $message,
91 | string $username,
92 | string $issuer,
93 | string $label,
94 | int $initialCounter,
95 | GoogleAuth $googleAuth,
96 | ?Writer $writer
97 | ): void {
98 | $this->assertSame(
99 | $message,
100 | $googleAuth->makeQRCodeMessage($username, $issuer, $label, $initialCounter)
101 | );
102 |
103 | if (!is_null($writer)) {
104 | $fixture = __DIR__ . '/fixtures/' . hash('sha512', $message) . '.qrcode.txt';
105 |
106 | if (is_file($fixture)) {
107 | $this->assertSame(
108 | file_get_contents($fixture),
109 | $googleAuth->getQRCode($writer, $username, $issuer, $label, $initialCounter)
110 | );
111 | } else {
112 | static::generateQrCodeFixture(
113 | $username,
114 | $issuer,
115 | $label,
116 | $initialCounter,
117 | $googleAuth,
118 | $writer
119 | );
120 | }
121 | }
122 | }
123 |
124 | protected static function generateQrCodeFixture(
125 | string $username,
126 | string $issuer,
127 | string $label,
128 | int $initialCounter,
129 | GoogleAuth $googleAuth,
130 | Writer $writer
131 | ): void {
132 | $message = $googleAuth->makeQRCodeMessage(
133 | $username,
134 | $issuer,
135 | $label,
136 | $initialCounter
137 | );
138 |
139 | $googleAuth->makeQRCode(
140 | $writer,
141 | (__DIR__ . '/fixtures/' . hash('sha512', $message) . '.qrcode.txt'),
142 | $username,
143 | $issuer,
144 | $label,
145 | $initialCounter
146 | );
147 | }
148 | }
149 |
--------------------------------------------------------------------------------
/test/TOTPTest.php:
--------------------------------------------------------------------------------
1 |
36 | */
37 | $testVectors = [
38 | [
39 | 'time' =>
40 | 59,
41 | 'outputs' => [
42 | 'sha1' =>
43 | '94287082',
44 | 'sha256' =>
45 | '46119246',
46 | 'sha512' =>
47 | '90693936'
48 | ]
49 | ], [
50 | 'time' =>
51 | 1111111109,
52 | 'outputs' => [
53 | 'sha1' =>
54 | '07081804',
55 | 'sha256' =>
56 | '68084774',
57 | 'sha512' =>
58 | '25091201'
59 | ]
60 | ], [
61 | 'time' =>
62 | 1111111111,
63 | 'outputs' => [
64 | 'sha1' =>
65 | '14050471',
66 | 'sha256' =>
67 | '67062674',
68 | 'sha512' =>
69 | '99943326'
70 | ]
71 | ], [
72 | 'time' =>
73 | 1234567890,
74 | 'outputs' => [
75 | 'sha1' =>
76 | '89005924',
77 | 'sha256' =>
78 | '91819424',
79 | 'sha512' =>
80 | '93441116'
81 | ]
82 | ], [
83 | 'time' =>
84 | 2000000000,
85 | 'outputs' => [
86 | 'sha1' =>
87 | '69279037',
88 | 'sha256' =>
89 | '90698825',
90 | 'sha512' =>
91 | '38618901'
92 | ]
93 | ]
94 | ];
95 | if (PHP_INT_SIZE > 4) {
96 | /**
97 | * @var int
98 | */
99 | $intFor64SystemOnly = 20000000000;
100 |
101 | // 64-bit systems only:
102 | $testVectors[] = [
103 | 'time' =>
104 | $intFor64SystemOnly,
105 | 'outputs' => [
106 | 'sha1' =>
107 | '65353130',
108 | 'sha256' =>
109 | '77737706',
110 | 'sha512' =>
111 | '47863826'
112 | ]
113 | ];
114 | }
115 |
116 | $sha1 = new TOTP(0, 30, 8, 'sha1');
117 | $sha256 = new TOTP(0, 30, 8, 'sha256');
118 | $sha512 = new TOTP(0, 30, 8, 'sha512');
119 |
120 | foreach ($testVectors as $test) {
121 | $this->assertSame(
122 | $test['outputs']['sha1'],
123 | $sha1->getCode($seed, $test['time']),
124 | (string) $test['time']
125 | );
126 |
127 | $this->assertSame(
128 | $test['outputs']['sha256'],
129 | $sha256->getCode($seed32, $test['time']),
130 | (string) $test['time']
131 | );
132 |
133 | $this->assertSame(
134 | $test['outputs']['sha512'],
135 | $sha512->getCode($seed64, $test['time']),
136 | (string) $test['time']
137 | );
138 |
139 | $oneTimeSha1 = new OneTime($seed, $sha1);
140 | $oneTimeSha256 = new OneTime($seed32, $sha256);
141 | $oneTimeSha512 = new OneTime($seed64, $sha512);
142 |
143 | $this->assertSame(
144 | $test['outputs']['sha1'],
145 | $oneTimeSha1->generateCode($test['time']),
146 | (string) $test['time']
147 | );
148 | $this->assertTrue(
149 | $oneTimeSha1->validateCode($test['outputs']['sha1'], $test['time'])
150 | );
151 |
152 | $this->assertSame(
153 | $test['outputs']['sha256'],
154 | $oneTimeSha256->generateCode($test['time']),
155 | (string) $test['time']
156 | );
157 | $this->assertTrue(
158 | $oneTimeSha256->validateCode($test['outputs']['sha256'], $test['time'])
159 | );
160 |
161 | $this->assertSame(
162 | $test['outputs']['sha512'],
163 | $oneTimeSha512->generateCode($test['time']),
164 | (string) $test['time']
165 | );
166 | $this->assertTrue(
167 | $oneTimeSha512->validateCode($test['outputs']['sha512'], $test['time'])
168 | );
169 | }
170 | }
171 |
172 | /**
173 | * @dataProvider dataProviderFailureOfGetCode
174 | *
175 | * @param array{0:int, 1:int, 2:int, 3:string} $constructorArgs
176 | *
177 | * @psalm-param class-string<\Throwable> $expectedException
178 | */
179 | public function testFailureOfGetCode(
180 | array $constructorArgs,
181 | string $expectedException,
182 | string $expectedExceptionMessage,
183 | string $sharedSecret,
184 | int $counterValue
185 | ): void {
186 | $totp = new TOTP(...$constructorArgs);
187 |
188 | $this->assertSame($constructorArgs[2], $totp->getLength());
189 | $this->assertSame($constructorArgs[1], $totp->getTimeStep());
190 |
191 | $this->expectException($expectedException);
192 | $this->expectExceptionMessage($expectedExceptionMessage);
193 |
194 | $totp->getCode($sharedSecret, $counterValue);
195 | }
196 |
197 | /**
198 | * @psalm-return Generator, 2:string, 3:string, 4:int}, mixed, void>
199 | */
200 | public function dataProviderFailureOfGetCode(): \Generator
201 | {
202 | $seed = Hex::decode(
203 | "3132333435363738393031323334353637383930"
204 | );
205 | $seed32 = Hex::decode(
206 | "3132333435363738393031323334353637383930" .
207 | "313233343536373839303132"
208 | );
209 | // Seed for HMAC-SHA512 - 64 bytes
210 | $seed64 = Hex::decode(
211 | "3132333435363738393031323334353637383930" .
212 | "3132333435363738393031323334353637383930" .
213 | "3132333435363738393031323334353637383930" .
214 | "31323334"
215 | );
216 |
217 | $sha1 = [0, 30, 8, 'sha1'];
218 | $sha256 = [0, 30, 8, 'sha256'];
219 | $sha512 = [0, 30, 8, 'sha512'];
220 |
221 | $times = [
222 | 59,
223 | 1111111109,
224 | 1111111111,
225 | 1234567890,
226 | 2000000000,
227 | ];
228 |
229 | if (PHP_INT_SIZE > 4) {
230 | $intFor64SystemOnly = 20000000000;
231 |
232 | $times[] = $intFor64SystemOnly;
233 | }
234 |
235 | $badLengthArgs = [
236 | 0,
237 | 11,
238 | ];
239 |
240 | foreach ($times as $time) {
241 | foreach ($badLengthArgs as $badLength) {
242 | $sha1[2] = $badLength;
243 | $sha256[2] = $badLength;
244 | $sha512[2] = $badLength;
245 |
246 | yield [
247 | $sha1,
248 | \OutOfRangeException::class,
249 | 'Length must be between 1 and 10, as a consequence of RFC 6238.',
250 | $seed,
251 | $time,
252 | ];
253 | yield [
254 | $sha256,
255 | \OutOfRangeException::class,
256 | 'Length must be between 1 and 10, as a consequence of RFC 6238.',
257 | $seed32,
258 | $time,
259 | ];
260 | yield [
261 | $sha512,
262 | \OutOfRangeException::class,
263 | 'Length must be between 1 and 10, as a consequence of RFC 6238.',
264 | $seed64,
265 | $time,
266 | ];
267 | }
268 | }
269 | }
270 | }
271 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | The MIT License (MIT)
2 |
3 | Copyright (c) 2016 Paragon Initiative Enterprises
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
23 | ###############################################################################
24 |
25 | GNU GENERAL PUBLIC LICENSE
26 | Version 3, 29 June 2007
27 |
28 | Copyright (C) 2007 Free Software Foundation, Inc.
29 | Everyone is permitted to copy and distribute verbatim copies
30 | of this license document, but changing it is not allowed.
31 |
32 | Preamble
33 |
34 | The GNU General Public License is a free, copyleft license for
35 | software and other kinds of works.
36 |
37 | The licenses for most software and other practical works are designed
38 | to take away your freedom to share and change the works. By contrast,
39 | the GNU General Public License is intended to guarantee your freedom to
40 | share and change all versions of a program--to make sure it remains free
41 | software for all its users. We, the Free Software Foundation, use the
42 | GNU General Public License for most of our software; it applies also to
43 | any other work released this way by its authors. You can apply it to
44 | your programs, too.
45 |
46 | When we speak of free software, we are referring to freedom, not
47 | price. Our General Public Licenses are designed to make sure that you
48 | have the freedom to distribute copies of free software (and charge for
49 | them if you wish), that you receive source code or can get it if you
50 | want it, that you can change the software or use pieces of it in new
51 | free programs, and that you know you can do these things.
52 |
53 | To protect your rights, we need to prevent others from denying you
54 | these rights or asking you to surrender the rights. Therefore, you have
55 | certain responsibilities if you distribute copies of the software, or if
56 | you modify it: responsibilities to respect the freedom of others.
57 |
58 | For example, if you distribute copies of such a program, whether
59 | gratis or for a fee, you must pass on to the recipients the same
60 | freedoms that you received. You must make sure that they, too, receive
61 | or can get the source code. And you must show them these terms so they
62 | know their rights.
63 |
64 | Developers that use the GNU GPL protect your rights with two steps:
65 | (1) assert copyright on the software, and (2) offer you this License
66 | giving you legal permission to copy, distribute and/or modify it.
67 |
68 | For the developers' and authors' protection, the GPL clearly explains
69 | that there is no warranty for this free software. For both users' and
70 | authors' sake, the GPL requires that modified versions be marked as
71 | changed, so that their problems will not be attributed erroneously to
72 | authors of previous versions.
73 |
74 | Some devices are designed to deny users access to install or run
75 | modified versions of the software inside them, although the manufacturer
76 | can do so. This is fundamentally incompatible with the aim of
77 | protecting users' freedom to change the software. The systematic
78 | pattern of such abuse occurs in the area of products for individuals to
79 | use, which is precisely where it is most unacceptable. Therefore, we
80 | have designed this version of the GPL to prohibit the practice for those
81 | products. If such problems arise substantially in other domains, we
82 | stand ready to extend this provision to those domains in future versions
83 | of the GPL, as needed to protect the freedom of users.
84 |
85 | Finally, every program is threatened constantly by software patents.
86 | States should not allow patents to restrict development and use of
87 | software on general-purpose computers, but in those that do, we wish to
88 | avoid the special danger that patents applied to a free program could
89 | make it effectively proprietary. To prevent this, the GPL assures that
90 | patents cannot be used to render the program non-free.
91 |
92 | The precise terms and conditions for copying, distribution and
93 | modification follow.
94 |
95 | TERMS AND CONDITIONS
96 |
97 | 0. Definitions.
98 |
99 | "This License" refers to version 3 of the GNU General Public License.
100 |
101 | "Copyright" also means copyright-like laws that apply to other kinds of
102 | works, such as semiconductor masks.
103 |
104 | "The Program" refers to any copyrightable work licensed under this
105 | License. Each licensee is addressed as "you". "Licensees" and
106 | "recipients" may be individuals or organizations.
107 |
108 | To "modify" a work means to copy from or adapt all or part of the work
109 | in a fashion requiring copyright permission, other than the making of an
110 | exact copy. The resulting work is called a "modified version" of the
111 | earlier work or a work "based on" the earlier work.
112 |
113 | A "covered work" means either the unmodified Program or a work based
114 | on the Program.
115 |
116 | To "propagate" a work means to do anything with it that, without
117 | permission, would make you directly or secondarily liable for
118 | infringement under applicable copyright law, except executing it on a
119 | computer or modifying a private copy. Propagation includes copying,
120 | distribution (with or without modification), making available to the
121 | public, and in some countries other activities as well.
122 |
123 | To "convey" a work means any kind of propagation that enables other
124 | parties to make or receive copies. Mere interaction with a user through
125 | a computer network, with no transfer of a copy, is not conveying.
126 |
127 | An interactive user interface displays "Appropriate Legal Notices"
128 | to the extent that it includes a convenient and prominently visible
129 | feature that (1) displays an appropriate copyright notice, and (2)
130 | tells the user that there is no warranty for the work (except to the
131 | extent that warranties are provided), that licensees may convey the
132 | work under this License, and how to view a copy of this License. If
133 | the interface presents a list of user commands or options, such as a
134 | menu, a prominent item in the list meets this criterion.
135 |
136 | 1. Source Code.
137 |
138 | The "source code" for a work means the preferred form of the work
139 | for making modifications to it. "Object code" means any non-source
140 | form of a work.
141 |
142 | A "Standard Interface" means an interface that either is an official
143 | standard defined by a recognized standards body, or, in the case of
144 | interfaces specified for a particular programming language, one that
145 | is widely used among developers working in that language.
146 |
147 | The "System Libraries" of an executable work include anything, other
148 | than the work as a whole, that (a) is included in the normal form of
149 | packaging a Major Component, but which is not part of that Major
150 | Component, and (b) serves only to enable use of the work with that
151 | Major Component, or to implement a Standard Interface for which an
152 | implementation is available to the public in source code form. A
153 | "Major Component", in this context, means a major essential component
154 | (kernel, window system, and so on) of the specific operating system
155 | (if any) on which the executable work runs, or a compiler used to
156 | produce the work, or an object code interpreter used to run it.
157 |
158 | The "Corresponding Source" for a work in object code form means all
159 | the source code needed to generate, install, and (for an executable
160 | work) run the object code and to modify the work, including scripts to
161 | control those activities. However, it does not include the work's
162 | System Libraries, or general-purpose tools or generally available free
163 | programs which are used unmodified in performing those activities but
164 | which are not part of the work. For example, Corresponding Source
165 | includes interface definition files associated with source files for
166 | the work, and the source code for shared libraries and dynamically
167 | linked subprograms that the work is specifically designed to require,
168 | such as by intimate data communication or control flow between those
169 | subprograms and other parts of the work.
170 |
171 | The Corresponding Source need not include anything that users
172 | can regenerate automatically from other parts of the Corresponding
173 | Source.
174 |
175 | The Corresponding Source for a work in source code form is that
176 | same work.
177 |
178 | 2. Basic Permissions.
179 |
180 | All rights granted under this License are granted for the term of
181 | copyright on the Program, and are irrevocable provided the stated
182 | conditions are met. This License explicitly affirms your unlimited
183 | permission to run the unmodified Program. The output from running a
184 | covered work is covered by this License only if the output, given its
185 | content, constitutes a covered work. This License acknowledges your
186 | rights of fair use or other equivalent, as provided by copyright law.
187 |
188 | You may make, run and propagate covered works that you do not
189 | convey, without conditions so long as your license otherwise remains
190 | in force. You may convey covered works to others for the sole purpose
191 | of having them make modifications exclusively for you, or provide you
192 | with facilities for running those works, provided that you comply with
193 | the terms of this License in conveying all material for which you do
194 | not control copyright. Those thus making or running the covered works
195 | for you must do so exclusively on your behalf, under your direction
196 | and control, on terms that prohibit them from making any copies of
197 | your copyrighted material outside their relationship with you.
198 |
199 | Conveying under any other circumstances is permitted solely under
200 | the conditions stated below. Sublicensing is not allowed; section 10
201 | makes it unnecessary.
202 |
203 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
204 |
205 | No covered work shall be deemed part of an effective technological
206 | measure under any applicable law fulfilling obligations under article
207 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
208 | similar laws prohibiting or restricting circumvention of such
209 | measures.
210 |
211 | When you convey a covered work, you waive any legal power to forbid
212 | circumvention of technological measures to the extent such circumvention
213 | is effected by exercising rights under this License with respect to
214 | the covered work, and you disclaim any intention to limit operation or
215 | modification of the work as a means of enforcing, against the work's
216 | users, your or third parties' legal rights to forbid circumvention of
217 | technological measures.
218 |
219 | 4. Conveying Verbatim Copies.
220 |
221 | You may convey verbatim copies of the Program's source code as you
222 | receive it, in any medium, provided that you conspicuously and
223 | appropriately publish on each copy an appropriate copyright notice;
224 | keep intact all notices stating that this License and any
225 | non-permissive terms added in accord with section 7 apply to the code;
226 | keep intact all notices of the absence of any warranty; and give all
227 | recipients a copy of this License along with the Program.
228 |
229 | You may charge any price or no price for each copy that you convey,
230 | and you may offer support or warranty protection for a fee.
231 |
232 | 5. Conveying Modified Source Versions.
233 |
234 | You may convey a work based on the Program, or the modifications to
235 | produce it from the Program, in the form of source code under the
236 | terms of section 4, provided that you also meet all of these conditions:
237 |
238 | a) The work must carry prominent notices stating that you modified
239 | it, and giving a relevant date.
240 |
241 | b) The work must carry prominent notices stating that it is
242 | released under this License and any conditions added under section
243 | 7. This requirement modifies the requirement in section 4 to
244 | "keep intact all notices".
245 |
246 | c) You must license the entire work, as a whole, under this
247 | License to anyone who comes into possession of a copy. This
248 | License will therefore apply, along with any applicable section 7
249 | additional terms, to the whole of the work, and all its parts,
250 | regardless of how they are packaged. This License gives no
251 | permission to license the work in any other way, but it does not
252 | invalidate such permission if you have separately received it.
253 |
254 | d) If the work has interactive user interfaces, each must display
255 | Appropriate Legal Notices; however, if the Program has interactive
256 | interfaces that do not display Appropriate Legal Notices, your
257 | work need not make them do so.
258 |
259 | A compilation of a covered work with other separate and independent
260 | works, which are not by their nature extensions of the covered work,
261 | and which are not combined with it such as to form a larger program,
262 | in or on a volume of a storage or distribution medium, is called an
263 | "aggregate" if the compilation and its resulting copyright are not
264 | used to limit the access or legal rights of the compilation's users
265 | beyond what the individual works permit. Inclusion of a covered work
266 | in an aggregate does not cause this License to apply to the other
267 | parts of the aggregate.
268 |
269 | 6. Conveying Non-Source Forms.
270 |
271 | You may convey a covered work in object code form under the terms
272 | of sections 4 and 5, provided that you also convey the
273 | machine-readable Corresponding Source under the terms of this License,
274 | in one of these ways:
275 |
276 | a) Convey the object code in, or embodied in, a physical product
277 | (including a physical distribution medium), accompanied by the
278 | Corresponding Source fixed on a durable physical medium
279 | customarily used for software interchange.
280 |
281 | b) Convey the object code in, or embodied in, a physical product
282 | (including a physical distribution medium), accompanied by a
283 | written offer, valid for at least three years and valid for as
284 | long as you offer spare parts or customer support for that product
285 | model, to give anyone who possesses the object code either (1) a
286 | copy of the Corresponding Source for all the software in the
287 | product that is covered by this License, on a durable physical
288 | medium customarily used for software interchange, for a price no
289 | more than your reasonable cost of physically performing this
290 | conveying of source, or (2) access to copy the
291 | Corresponding Source from a network server at no charge.
292 |
293 | c) Convey individual copies of the object code with a copy of the
294 | written offer to provide the Corresponding Source. This
295 | alternative is allowed only occasionally and noncommercially, and
296 | only if you received the object code with such an offer, in accord
297 | with subsection 6b.
298 |
299 | d) Convey the object code by offering access from a designated
300 | place (gratis or for a charge), and offer equivalent access to the
301 | Corresponding Source in the same way through the same place at no
302 | further charge. You need not require recipients to copy the
303 | Corresponding Source along with the object code. If the place to
304 | copy the object code is a network server, the Corresponding Source
305 | may be on a different server (operated by you or a third party)
306 | that supports equivalent copying facilities, provided you maintain
307 | clear directions next to the object code saying where to find the
308 | Corresponding Source. Regardless of what server hosts the
309 | Corresponding Source, you remain obligated to ensure that it is
310 | available for as long as needed to satisfy these requirements.
311 |
312 | e) Convey the object code using peer-to-peer transmission, provided
313 | you inform other peers where the object code and Corresponding
314 | Source of the work are being offered to the general public at no
315 | charge under subsection 6d.
316 |
317 | A separable portion of the object code, whose source code is excluded
318 | from the Corresponding Source as a System Library, need not be
319 | included in conveying the object code work.
320 |
321 | A "User Product" is either (1) a "consumer product", which means any
322 | tangible personal property which is normally used for personal, family,
323 | or household purposes, or (2) anything designed or sold for incorporation
324 | into a dwelling. In determining whether a product is a consumer product,
325 | doubtful cases shall be resolved in favor of coverage. For a particular
326 | product received by a particular user, "normally used" refers to a
327 | typical or common use of that class of product, regardless of the status
328 | of the particular user or of the way in which the particular user
329 | actually uses, or expects or is expected to use, the product. A product
330 | is a consumer product regardless of whether the product has substantial
331 | commercial, industrial or non-consumer uses, unless such uses represent
332 | the only significant mode of use of the product.
333 |
334 | "Installation Information" for a User Product means any methods,
335 | procedures, authorization keys, or other information required to install
336 | and execute modified versions of a covered work in that User Product from
337 | a modified version of its Corresponding Source. The information must
338 | suffice to ensure that the continued functioning of the modified object
339 | code is in no case prevented or interfered with solely because
340 | modification has been made.
341 |
342 | If you convey an object code work under this section in, or with, or
343 | specifically for use in, a User Product, and the conveying occurs as
344 | part of a transaction in which the right of possession and use of the
345 | User Product is transferred to the recipient in perpetuity or for a
346 | fixed term (regardless of how the transaction is characterized), the
347 | Corresponding Source conveyed under this section must be accompanied
348 | by the Installation Information. But this requirement does not apply
349 | if neither you nor any third party retains the ability to install
350 | modified object code on the User Product (for example, the work has
351 | been installed in ROM).
352 |
353 | The requirement to provide Installation Information does not include a
354 | requirement to continue to provide support service, warranty, or updates
355 | for a work that has been modified or installed by the recipient, or for
356 | the User Product in which it has been modified or installed. Access to a
357 | network may be denied when the modification itself materially and
358 | adversely affects the operation of the network or violates the rules and
359 | protocols for communication across the network.
360 |
361 | Corresponding Source conveyed, and Installation Information provided,
362 | in accord with this section must be in a format that is publicly
363 | documented (and with an implementation available to the public in
364 | source code form), and must require no special password or key for
365 | unpacking, reading or copying.
366 |
367 | 7. Additional Terms.
368 |
369 | "Additional permissions" are terms that supplement the terms of this
370 | License by making exceptions from one or more of its conditions.
371 | Additional permissions that are applicable to the entire Program shall
372 | be treated as though they were included in this License, to the extent
373 | that they are valid under applicable law. If additional permissions
374 | apply only to part of the Program, that part may be used separately
375 | under those permissions, but the entire Program remains governed by
376 | this License without regard to the additional permissions.
377 |
378 | When you convey a copy of a covered work, you may at your option
379 | remove any additional permissions from that copy, or from any part of
380 | it. (Additional permissions may be written to require their own
381 | removal in certain cases when you modify the work.) You may place
382 | additional permissions on material, added by you to a covered work,
383 | for which you have or can give appropriate copyright permission.
384 |
385 | Notwithstanding any other provision of this License, for material you
386 | add to a covered work, you may (if authorized by the copyright holders of
387 | that material) supplement the terms of this License with terms:
388 |
389 | a) Disclaiming warranty or limiting liability differently from the
390 | terms of sections 15 and 16 of this License; or
391 |
392 | b) Requiring preservation of specified reasonable legal notices or
393 | author attributions in that material or in the Appropriate Legal
394 | Notices displayed by works containing it; or
395 |
396 | c) Prohibiting misrepresentation of the origin of that material, or
397 | requiring that modified versions of such material be marked in
398 | reasonable ways as different from the original version; or
399 |
400 | d) Limiting the use for publicity purposes of names of licensors or
401 | authors of the material; or
402 |
403 | e) Declining to grant rights under trademark law for use of some
404 | trade names, trademarks, or service marks; or
405 |
406 | f) Requiring indemnification of licensors and authors of that
407 | material by anyone who conveys the material (or modified versions of
408 | it) with contractual assumptions of liability to the recipient, for
409 | any liability that these contractual assumptions directly impose on
410 | those licensors and authors.
411 |
412 | All other non-permissive additional terms are considered "further
413 | restrictions" within the meaning of section 10. If the Program as you
414 | received it, or any part of it, contains a notice stating that it is
415 | governed by this License along with a term that is a further
416 | restriction, you may remove that term. If a license document contains
417 | a further restriction but permits relicensing or conveying under this
418 | License, you may add to a covered work material governed by the terms
419 | of that license document, provided that the further restriction does
420 | not survive such relicensing or conveying.
421 |
422 | If you add terms to a covered work in accord with this section, you
423 | must place, in the relevant source files, a statement of the
424 | additional terms that apply to those files, or a notice indicating
425 | where to find the applicable terms.
426 |
427 | Additional terms, permissive or non-permissive, may be stated in the
428 | form of a separately written license, or stated as exceptions;
429 | the above requirements apply either way.
430 |
431 | 8. Termination.
432 |
433 | You may not propagate or modify a covered work except as expressly
434 | provided under this License. Any attempt otherwise to propagate or
435 | modify it is void, and will automatically terminate your rights under
436 | this License (including any patent licenses granted under the third
437 | paragraph of section 11).
438 |
439 | However, if you cease all violation of this License, then your
440 | license from a particular copyright holder is reinstated (a)
441 | provisionally, unless and until the copyright holder explicitly and
442 | finally terminates your license, and (b) permanently, if the copyright
443 | holder fails to notify you of the violation by some reasonable means
444 | prior to 60 days after the cessation.
445 |
446 | Moreover, your license from a particular copyright holder is
447 | reinstated permanently if the copyright holder notifies you of the
448 | violation by some reasonable means, this is the first time you have
449 | received notice of violation of this License (for any work) from that
450 | copyright holder, and you cure the violation prior to 30 days after
451 | your receipt of the notice.
452 |
453 | Termination of your rights under this section does not terminate the
454 | licenses of parties who have received copies or rights from you under
455 | this License. If your rights have been terminated and not permanently
456 | reinstated, you do not qualify to receive new licenses for the same
457 | material under section 10.
458 |
459 | 9. Acceptance Not Required for Having Copies.
460 |
461 | You are not required to accept this License in order to receive or
462 | run a copy of the Program. Ancillary propagation of a covered work
463 | occurring solely as a consequence of using peer-to-peer transmission
464 | to receive a copy likewise does not require acceptance. However,
465 | nothing other than this License grants you permission to propagate or
466 | modify any covered work. These actions infringe copyright if you do
467 | not accept this License. Therefore, by modifying or propagating a
468 | covered work, you indicate your acceptance of this License to do so.
469 |
470 | 10. Automatic Licensing of Downstream Recipients.
471 |
472 | Each time you convey a covered work, the recipient automatically
473 | receives a license from the original licensors, to run, modify and
474 | propagate that work, subject to this License. You are not responsible
475 | for enforcing compliance by third parties with this License.
476 |
477 | An "entity transaction" is a transaction transferring control of an
478 | organization, or substantially all assets of one, or subdividing an
479 | organization, or merging organizations. If propagation of a covered
480 | work results from an entity transaction, each party to that
481 | transaction who receives a copy of the work also receives whatever
482 | licenses to the work the party's predecessor in interest had or could
483 | give under the previous paragraph, plus a right to possession of the
484 | Corresponding Source of the work from the predecessor in interest, if
485 | the predecessor has it or can get it with reasonable efforts.
486 |
487 | You may not impose any further restrictions on the exercise of the
488 | rights granted or affirmed under this License. For example, you may
489 | not impose a license fee, royalty, or other charge for exercise of
490 | rights granted under this License, and you may not initiate litigation
491 | (including a cross-claim or counterclaim in a lawsuit) alleging that
492 | any patent claim is infringed by making, using, selling, offering for
493 | sale, or importing the Program or any portion of it.
494 |
495 | 11. Patents.
496 |
497 | A "contributor" is a copyright holder who authorizes use under this
498 | License of the Program or a work on which the Program is based. The
499 | work thus licensed is called the contributor's "contributor version".
500 |
501 | A contributor's "essential patent claims" are all patent claims
502 | owned or controlled by the contributor, whether already acquired or
503 | hereafter acquired, that would be infringed by some manner, permitted
504 | by this License, of making, using, or selling its contributor version,
505 | but do not include claims that would be infringed only as a
506 | consequence of further modification of the contributor version. For
507 | purposes of this definition, "control" includes the right to grant
508 | patent sublicenses in a manner consistent with the requirements of
509 | this License.
510 |
511 | Each contributor grants you a non-exclusive, worldwide, royalty-free
512 | patent license under the contributor's essential patent claims, to
513 | make, use, sell, offer for sale, import and otherwise run, modify and
514 | propagate the contents of its contributor version.
515 |
516 | In the following three paragraphs, a "patent license" is any express
517 | agreement or commitment, however denominated, not to enforce a patent
518 | (such as an express permission to practice a patent or covenant not to
519 | sue for patent infringement). To "grant" such a patent license to a
520 | party means to make such an agreement or commitment not to enforce a
521 | patent against the party.
522 |
523 | If you convey a covered work, knowingly relying on a patent license,
524 | and the Corresponding Source of the work is not available for anyone
525 | to copy, free of charge and under the terms of this License, through a
526 | publicly available network server or other readily accessible means,
527 | then you must either (1) cause the Corresponding Source to be so
528 | available, or (2) arrange to deprive yourself of the benefit of the
529 | patent license for this particular work, or (3) arrange, in a manner
530 | consistent with the requirements of this License, to extend the patent
531 | license to downstream recipients. "Knowingly relying" means you have
532 | actual knowledge that, but for the patent license, your conveying the
533 | covered work in a country, or your recipient's use of the covered work
534 | in a country, would infringe one or more identifiable patents in that
535 | country that you have reason to believe are valid.
536 |
537 | If, pursuant to or in connection with a single transaction or
538 | arrangement, you convey, or propagate by procuring conveyance of, a
539 | covered work, and grant a patent license to some of the parties
540 | receiving the covered work authorizing them to use, propagate, modify
541 | or convey a specific copy of the covered work, then the patent license
542 | you grant is automatically extended to all recipients of the covered
543 | work and works based on it.
544 |
545 | A patent license is "discriminatory" if it does not include within
546 | the scope of its coverage, prohibits the exercise of, or is
547 | conditioned on the non-exercise of one or more of the rights that are
548 | specifically granted under this License. You may not convey a covered
549 | work if you are a party to an arrangement with a third party that is
550 | in the business of distributing software, under which you make payment
551 | to the third party based on the extent of your activity of conveying
552 | the work, and under which the third party grants, to any of the
553 | parties who would receive the covered work from you, a discriminatory
554 | patent license (a) in connection with copies of the covered work
555 | conveyed by you (or copies made from those copies), or (b) primarily
556 | for and in connection with specific products or compilations that
557 | contain the covered work, unless you entered into that arrangement,
558 | or that patent license was granted, prior to 28 March 2007.
559 |
560 | Nothing in this License shall be construed as excluding or limiting
561 | any implied license or other defenses to infringement that may
562 | otherwise be available to you under applicable patent law.
563 |
564 | 12. No Surrender of Others' Freedom.
565 |
566 | If conditions are imposed on you (whether by court order, agreement or
567 | otherwise) that contradict the conditions of this License, they do not
568 | excuse you from the conditions of this License. If you cannot convey a
569 | covered work so as to satisfy simultaneously your obligations under this
570 | License and any other pertinent obligations, then as a consequence you may
571 | not convey it at all. For example, if you agree to terms that obligate you
572 | to collect a royalty for further conveying from those to whom you convey
573 | the Program, the only way you could satisfy both those terms and this
574 | License would be to refrain entirely from conveying the Program.
575 |
576 | 13. Use with the GNU Affero General Public License.
577 |
578 | Notwithstanding any other provision of this License, you have
579 | permission to link or combine any covered work with a work licensed
580 | under version 3 of the GNU Affero General Public License into a single
581 | combined work, and to convey the resulting work. The terms of this
582 | License will continue to apply to the part which is the covered work,
583 | but the special requirements of the GNU Affero General Public License,
584 | section 13, concerning interaction through a network will apply to the
585 | combination as such.
586 |
587 | 14. Revised Versions of this License.
588 |
589 | The Free Software Foundation may publish revised and/or new versions of
590 | the GNU General Public License from time to time. Such new versions will
591 | be similar in spirit to the present version, but may differ in detail to
592 | address new problems or concerns.
593 |
594 | Each version is given a distinguishing version number. If the
595 | Program specifies that a certain numbered version of the GNU General
596 | Public License "or any later version" applies to it, you have the
597 | option of following the terms and conditions either of that numbered
598 | version or of any later version published by the Free Software
599 | Foundation. If the Program does not specify a version number of the
600 | GNU General Public License, you may choose any version ever published
601 | by the Free Software Foundation.
602 |
603 | If the Program specifies that a proxy can decide which future
604 | versions of the GNU General Public License can be used, that proxy's
605 | public statement of acceptance of a version permanently authorizes you
606 | to choose that version for the Program.
607 |
608 | Later license versions may give you additional or different
609 | permissions. However, no additional obligations are imposed on any
610 | author or copyright holder as a result of your choosing to follow a
611 | later version.
612 |
613 | 15. Disclaimer of Warranty.
614 |
615 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
616 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
617 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
618 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
619 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
620 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
621 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
622 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
623 |
624 | 16. Limitation of Liability.
625 |
626 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
627 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
628 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
629 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
630 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
631 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
632 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
633 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
634 | SUCH DAMAGES.
635 |
636 | 17. Interpretation of Sections 15 and 16.
637 |
638 | If the disclaimer of warranty and limitation of liability provided
639 | above cannot be given local legal effect according to their terms,
640 | reviewing courts shall apply local law that most closely approximates
641 | an absolute waiver of all civil liability in connection with the
642 | Program, unless a warranty or assumption of liability accompanies a
643 | copy of the Program in return for a fee.
644 |
645 | END OF TERMS AND CONDITIONS
646 |
647 | How to Apply These Terms to Your New Programs
648 |
649 | If you develop a new program, and you want it to be of the greatest
650 | possible use to the public, the best way to achieve this is to make it
651 | free software which everyone can redistribute and change under these terms.
652 |
653 | To do so, attach the following notices to the program. It is safest
654 | to attach them to the start of each source file to most effectively
655 | state the exclusion of warranty; and each file should have at least
656 | the "copyright" line and a pointer to where the full notice is found.
657 |
658 | {one line to give the program's name and a brief idea of what it does.}
659 | Copyright (C) {year} {name of author}
660 |
661 | This program is free software: you can redistribute it and/or modify
662 | it under the terms of the GNU General Public License as published by
663 | the Free Software Foundation, either version 3 of the License, or
664 | (at your option) any later version.
665 |
666 | This program is distributed in the hope that it will be useful,
667 | but WITHOUT ANY WARRANTY; without even the implied warranty of
668 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
669 | GNU General Public License for more details.
670 |
671 | You should have received a copy of the GNU General Public License
672 | along with this program. If not, see .
673 |
674 | Also add information on how to contact you by electronic and paper mail.
675 |
676 | If the program does terminal interaction, make it output a short
677 | notice like this when it starts in an interactive mode:
678 |
679 | {project} Copyright (C) {year} {fullname}
680 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
681 | This is free software, and you are welcome to redistribute it
682 | under certain conditions; type `show c' for details.
683 |
684 | The hypothetical commands `show w' and `show c' should show the appropriate
685 | parts of the General Public License. Of course, your program's commands
686 | might be different; for a GUI interface, you would use an "about box".
687 |
688 | You should also get your employer (if you work as a programmer) or school,
689 | if any, to sign a "copyright disclaimer" for the program, if necessary.
690 | For more information on this, and how to apply and follow the GNU GPL, see
691 | .
692 |
693 | The GNU General Public License does not permit incorporating your program
694 | into proprietary programs. If your program is a subroutine library, you
695 | may consider it more useful to permit linking proprietary applications with
696 | the library. If this is what you want to do, use the GNU Lesser General
697 | Public License instead of this License. But first, please read
698 | .
699 |
--------------------------------------------------------------------------------