├── composer.json ├── phpunit.xml ├── .github └── workflows │ └── php.yml ├── src └── Wowemu │ └── SRP │ ├── HostClient.php │ ├── UserClient.php │ └── Client.php ├── tests ├── UserClientTest.php └── SRPClientIntegrationTest.php ├── README.md └── LICENSE /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "laizerox/php-wowemu-auth", 3 | "type": "library", 4 | "description": "Wowemu compliant SRP6 auth implementation", 5 | "license": "GPL-3.0-or-later", 6 | "authors": [ 7 | { 8 | "name": "Laizerox", 9 | "email": "dpetmanson@gmail.com" 10 | } 11 | ], 12 | "autoload": { 13 | "psr-4": { 14 | "Laizerox\\": "src/" 15 | } 16 | }, 17 | "require": { 18 | "php": "^7.1", 19 | "phpseclib/phpseclib": "^2.0", 20 | "ext-bcmath": "*" 21 | }, 22 | "require-dev": { 23 | "phpunit/phpunit": "^7.5" 24 | }, 25 | "scripts": { 26 | "test": "phpunit" 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /phpunit.xml: -------------------------------------------------------------------------------- 1 | 2 | 11 | 12 | 13 | ./tests 14 | 15 | 16 | 17 | 18 | src 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /.github/workflows/php.yml: -------------------------------------------------------------------------------- 1 | name: PHP Composer 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | 9 | jobs: 10 | test: 11 | runs-on: ${{ matrix.operating-system }} 12 | strategy: 13 | matrix: 14 | operating-system: [ubuntu-latest, windows-latest, macOS-latest] 15 | php-versions: ['7.1', '7.2', '7.3', '7.4'] 16 | name: Test with PHP ${{ matrix.php-versions }} on ${{ matrix.operating-system }} 17 | steps: 18 | - name: Checkout 19 | uses: actions/checkout@v2 20 | 21 | - name: Install PHP 22 | uses: shivammathur/setup-php@v2 23 | with: 24 | php-version: ${{ matrix.php-versions }} 25 | 26 | - name: Check PHP Version 27 | run: php -v 28 | 29 | - name: Validate composer.json 30 | run: composer validate 31 | 32 | - name: Install dependencies 33 | run: composer install --prefer-dist --no-progress --no-suggest 34 | 35 | - name: Run test suite 36 | run: composer run-script test 37 | 38 | -------------------------------------------------------------------------------- /src/Wowemu/SRP/HostClient.php: -------------------------------------------------------------------------------- 1 | 5 | * 6 | * For the full copyright and license information, please view the LICENSE 7 | * file that was distributed with this source code. 8 | */ 9 | 10 | namespace Laizerox\Wowemu\SRP; 11 | 12 | use Exception; 13 | use phpseclib\Math\BigInteger; 14 | 15 | class HostClient extends Client 16 | { 17 | /** 18 | * @var BigInteger User's verifier 19 | */ 20 | private $verifier; 21 | 22 | /** 23 | * HostClient constructor. 24 | * 25 | * @param string $identity 26 | * @param string $salt 27 | * @param string $verifier 28 | * @param string $clientPublicEphemeralValue 29 | * @param array|null $options 30 | */ 31 | public function __construct( 32 | string $identity, 33 | string $salt, 34 | string $verifier, 35 | string $clientPublicEphemeralValue, 36 | array $options = null 37 | ) { 38 | $this->clientPublicEphemeralValue = new BigInteger($clientPublicEphemeralValue, 16); 39 | $this->verifier = new BigInteger($verifier, 16); 40 | 41 | parent::__construct($identity, $salt, $options); 42 | } 43 | 44 | /** 45 | * Returns hex of public ephemeral value 46 | * 47 | * @return string 48 | * @throws Exception 49 | */ 50 | public function getPublicEphemeralValue(): string 51 | { 52 | $this->hostPublicEphemeralValue = $this->generateEphemeralValues(); 53 | 54 | return $this->hostPublicEphemeralValue->toHex(); 55 | } 56 | 57 | /** 58 | * 59 | */ 60 | public function calculateSessionKey(): void 61 | { 62 | // Random scrambling parameter 63 | $u = $this->computeRandomScramblingParameter(); 64 | $avu = $this->clientPublicEphemeralValue->multiply($this->verifier->powMod($u, $this->N)); 65 | 66 | // Session key 67 | $this->sessionKey = $avu->powMod($this->secretEphemeralValue, $this->N); 68 | 69 | // Strong session key 70 | $this->strongSessionKey = sha1($this->sessionKey->toHex()); 71 | } 72 | 73 | /** 74 | * @param BigInteger $b Host's secret ephemeral value 75 | * 76 | * @return BigInteger Host's public ephemeral value 77 | */ 78 | public function computePublicEphemeralValue(BigInteger $b): BigInteger 79 | { 80 | return $this->multiplier->multiply($this->verifier)->add($this->g->powMod($b, $this->N))->modPow( 81 | new BigInteger(1), 82 | $this->N 83 | ); 84 | } 85 | 86 | public function validateClientSessionKeyProof(string $proof): bool 87 | { 88 | return $this->computeClientSessionKeyProof() === $proof; 89 | } 90 | } 91 | -------------------------------------------------------------------------------- /tests/UserClientTest.php: -------------------------------------------------------------------------------- 1 | 4 | * 5 | * For the full copyright and license information, please view the LICENSE 6 | * file that was distributed with this source code. 7 | */ 8 | 9 | namespace Tests; 10 | 11 | use Exception; 12 | use Laizerox\Wowemu\SRP\UserClient; 13 | use PHPUnit\Framework\TestCase; 14 | use RuntimeException; 15 | 16 | class UserClientTest extends TestCase 17 | { 18 | public function dataProvider(): array 19 | { 20 | return [ 21 | [ 22 | 'admin', 23 | 'admin', 24 | '12ee32e201835ebc6a00c7056f08e18651633ab9cec6cfd5a1bdda413747c74c', 25 | '2b25415d6fd90435b9506f64c15e0670bef49a9905d62f21eb573dc4ff2bbaf0', 26 | ], 27 | [ 28 | 'player', 29 | 'player', 30 | '50b39832882cc3174f4b566d377775ecc33af5f21fa71bcac58290595101d4e9', 31 | '59f9d68f247ff723c46677847e042923184307f652c297726da2868670c607bf', 32 | ], 33 | ]; 34 | } 35 | 36 | /** 37 | * @param $username 38 | * @param $password 39 | * @param $expectedSalt 40 | * @param $expectedVerifier 41 | * 42 | * @throws Exception 43 | * @dataProvider dataProvider 44 | */ 45 | public function testNewAccountGeneration($username, $password, $expectedSalt, $expectedVerifier): void 46 | { 47 | // Create a client mock for this test case (equivalent of new UserClient($username) 48 | $client = $this->getMockBuilder(UserClient::class) 49 | ->setConstructorArgs([$username]) 50 | ->setMethods(['getRandomNumber']) 51 | ->getMock(); 52 | 53 | $client->method('getRandomNumber')->willReturn($expectedSalt); 54 | 55 | $salt = $client->generateSalt(); 56 | $verifier = $client->generateVerifier($password); 57 | 58 | $this->assertEquals($expectedSalt, $salt); 59 | $this->assertEquals($expectedVerifier, $verifier); 60 | } 61 | 62 | /** 63 | * @param $username 64 | * @param $password 65 | * @param $salt 66 | * @param $expectedVerifier 67 | * 68 | * @throws Exception 69 | * @dataProvider dataProvider 70 | */ 71 | public function testGenerateVerifierAgainstExistingData($username, $password, $salt, $expectedVerifier): void 72 | { 73 | $client = new UserClient($username, $salt); 74 | 75 | $this->assertEquals($expectedVerifier, $client->generateVerifier($password)); 76 | } 77 | 78 | /** 79 | * @throws Exception 80 | */ 81 | public function testGenerateVerifierWithEmptyUsername(): void 82 | { 83 | $this->expectException(RuntimeException::class); 84 | 85 | $client = new UserClient(''); 86 | $client->generateVerifier(''); 87 | } 88 | 89 | /** 90 | * @throws Exception 91 | */ 92 | public function testGenerateVerifierWithEmptySalt(): void 93 | { 94 | $this->expectException(RuntimeException::class); 95 | 96 | $client = new UserClient('admin'); 97 | $client->generateVerifier('admin'); 98 | } 99 | } 100 | -------------------------------------------------------------------------------- /tests/SRPClientIntegrationTest.php: -------------------------------------------------------------------------------- 1 | 4 | * 5 | * For the full copyright and license information, please view the LICENSE 6 | * file that was distributed with this source code. 7 | */ 8 | 9 | namespace Tests; 10 | 11 | use Exception; 12 | use Laizerox\Wowemu\SRP\HostClient; 13 | use Laizerox\Wowemu\SRP\UserClient; 14 | use PHPUnit\Framework\TestCase; 15 | 16 | class SRPClientIntegrationTest extends TestCase 17 | { 18 | public function dataProvider(): array 19 | { 20 | return [ 21 | [ 22 | // Client known values 23 | [ 24 | 'username' => 'admin', 25 | 'password' => 'admin', 26 | ], 27 | // Host known values 28 | [ 29 | 'salt' => '12ee32e201835ebc6a00c7056f08e18651633ab9cec6cfd5a1bdda413747c74c', 30 | 'verifier' => '2b25415d6fd90435b9506f64c15e0670bef49a9905d62f21eb573dc4ff2bbaf0', 31 | ], 32 | ], 33 | [ 34 | // Client known values 35 | [ 36 | 'username' => 'player', 37 | 'password' => 'player', 38 | ], 39 | // Host known values 40 | [ 41 | 'salt' => '50b39832882cc3174f4b566d377775ecc33af5f21fa71bcac58290595101d4e9', 42 | 'verifier' => '59f9d68f247ff723c46677847e042923184307f652c297726da2868670c607bf', 43 | ], 44 | ], 45 | ]; 46 | } 47 | 48 | /** 49 | * @param array $client 50 | * @param array $host 51 | * 52 | * @dataProvider dataProvider 53 | * @throws Exception 54 | */ 55 | public function testClientHostIntegration(array $client, array $host): void 56 | { 57 | $srpUserClient = new UserClient($client['username']); 58 | 59 | // 1. Client should generate public ephemeral value A and send username I to host 60 | $A = $srpUserClient->getPublicEphemeralValue(); 61 | 62 | // 2. Host receives username I and public ephemeral value A. 63 | $srpHostClient = new HostClient($client['username'], $host['salt'], $host['verifier'], $A); 64 | $B = $srpHostClient->getPublicEphemeralValue(); 65 | 66 | // 3. Client calculates its own session key 67 | $srpUserClient->setSalt($host['salt']); 68 | $srpUserClient->setHostPublicEphemeralValue($B); 69 | $srpUserClient->calculateSessionKey($srpUserClient->computePrivateKey($client['password'])); 70 | 71 | // 4. Client sends proof of its session key to host 72 | $userSessionProof = $srpUserClient->computeClientSessionKeyProof(); 73 | 74 | // 5. Host calculates its own session key 75 | $srpHostClient->calculateSessionKey(); 76 | 77 | // 6. Host compares clients proof against its own equivalent client calculated proof 78 | $this->assertTrue($srpHostClient->validateClientSessionKeyProof($userSessionProof)); 79 | 80 | // 7. Host computes & sends proof of its session key to client 81 | $hostSessionProof = $srpHostClient->computeHostSessionKeyProof( 82 | $srpHostClient->computeClientSessionKeyProof() 83 | ); 84 | 85 | // 8. Client compares hosts proof against its own equivalent host calculated proof 86 | $this->assertTrue($srpUserClient->validateHostSessionKeyProof($userSessionProof, $hostSessionProof)); 87 | 88 | // 9. In theory if both proofs match session keys should be same 89 | $this->assertEquals($srpHostClient->getSessionKey(), $srpUserClient->getSessionKey()); 90 | $this->assertEquals($srpHostClient->getStrongSessionKey(), $srpUserClient->getStrongSessionKey()); 91 | } 92 | } 93 | -------------------------------------------------------------------------------- /src/Wowemu/SRP/UserClient.php: -------------------------------------------------------------------------------- 1 | 5 | * 6 | * For the full copyright and license information, please view the LICENSE 7 | * file that was distributed with this source code. 8 | */ 9 | 10 | namespace Laizerox\Wowemu\SRP; 11 | 12 | use Exception; 13 | use phpseclib\Math\BigInteger; 14 | use RuntimeException; 15 | 16 | class UserClient extends Client 17 | { 18 | /** 19 | * Returns hex of public ephemeral value 20 | * 21 | * @return string 22 | * @throws Exception 23 | */ 24 | public function getPublicEphemeralValue(): string 25 | { 26 | $this->clientPublicEphemeralValue = $this->generateEphemeralValues(); 27 | 28 | return $this->clientPublicEphemeralValue->toHex(); 29 | } 30 | 31 | /** 32 | * @param string $value 33 | */ 34 | public function setHostPublicEphemeralValue(string $value): void 35 | { 36 | $this->hostPublicEphemeralValue = new BigInteger($value, 16); 37 | } 38 | 39 | /** 40 | * Generate verifier using username, password and existing salt 41 | * 42 | * @param string $p User's password in plaintext 43 | * 44 | * @return string 45 | * @throws Exception 46 | */ 47 | public function generateVerifier(string $p): string 48 | { 49 | $privateKey = $this->computePrivateKey($p); 50 | $verifier = $this->computeVerifier($privateKey); 51 | 52 | return $verifier->toHex(); 53 | } 54 | 55 | /** 56 | * Computes private key using salt and identity which is derived from username and password 57 | * 58 | * @param string $p User's password in plaintext 59 | * 60 | * @return BigInteger 61 | */ 62 | public function computePrivateKey(string $p): BigInteger 63 | { 64 | if (empty($this->salt)) { 65 | throw new RuntimeException('Received empty salt.'); 66 | } 67 | 68 | if (empty($this->username)) { 69 | throw new RuntimeException('Received empty username.'); 70 | } 71 | 72 | $salt = $this->reverseHex($this->salt); 73 | $salt = hex2bin($salt); 74 | $identity = hash('sha1', strtoupper($this->username . ':' . $p), true); 75 | 76 | $sha = sha1($salt . $identity); 77 | $sha = $this->reverseHex($sha); 78 | 79 | return new BigInteger($sha, 16); 80 | } 81 | 82 | /** 83 | * Generates random salt using 32 random bytes 84 | * 85 | * @return string 86 | * @throws Exception 87 | */ 88 | public function generateSalt(): string 89 | { 90 | return $this->salt = $this->getRandomNumber(32); 91 | } 92 | 93 | /** 94 | * @param BigInteger $a User's secret ephemeral value 95 | * 96 | * @return BigInteger User's public ephemeral value 97 | */ 98 | public function computePublicEphemeralValue(BigInteger $a): BigInteger 99 | { 100 | return $this->g->powMod($a, $this->N); 101 | } 102 | 103 | /** 104 | * @param BigInteger $x Computed private key using identity and salt 105 | */ 106 | public function calculateSessionKey(BigInteger $x): void 107 | { 108 | // Random scrambling parameter 109 | $u = $this->computeRandomScramblingParameter(); 110 | $v = $this->computeVerifier($x); 111 | 112 | $kv = $this->multiplier->multiply($v); 113 | $aux = $this->secretEphemeralValue->add($u->multiply($x)); 114 | 115 | // Session key 116 | $this->sessionKey = $this->hostPublicEphemeralValue->subtract($kv)->modPow($aux, $this->N); 117 | 118 | // Strong session key 119 | $this->strongSessionKey = sha1($this->sessionKey->toHex()); 120 | } 121 | 122 | public function validateHostSessionKeyProof(string $M, $proof): bool 123 | { 124 | return $this->computeHostSessionKeyProof($M) === $proof; 125 | } 126 | 127 | /** 128 | * Reverses input hex 129 | * 130 | * @param string $string Hex string to reverse 131 | * 132 | * @return string 133 | */ 134 | private function reverseHex(string $string): string 135 | { 136 | for ($i = 0, $length = strlen($string); $i < $length; $i += 2) { 137 | $bytes[] = substr($string, $i, 2); 138 | } 139 | 140 | return implode(array_reverse($bytes ?? [])); 141 | } 142 | 143 | /** 144 | * Computes verifier using private key 145 | * 146 | * @param BigInteger $x Computed private key using identity and salt 147 | * 148 | * @return BigInteger 149 | */ 150 | private function computeVerifier(BigInteger $x): BigInteger 151 | { 152 | return $this->g->modPow($x, $this->N); 153 | } 154 | } 155 | -------------------------------------------------------------------------------- /src/Wowemu/SRP/Client.php: -------------------------------------------------------------------------------- 1 | 5 | * 6 | * For the full copyright and license information, please view the LICENSE 7 | * file that was distributed with this source code. 8 | */ 9 | 10 | namespace Laizerox\Wowemu\SRP; 11 | 12 | use Exception; 13 | use phpseclib\Math\BigInteger; 14 | 15 | abstract class Client 16 | { 17 | /** 18 | * @var BigInteger Local public ephemeral value 19 | */ 20 | protected $clientPublicEphemeralValue; 21 | 22 | /** 23 | * @var BigInteger A generator modulo N 24 | */ 25 | protected $g; 26 | 27 | /** 28 | * @var BigInteger Remote public ephemeral value 29 | */ 30 | protected $hostPublicEphemeralValue; 31 | 32 | /** 33 | * @var BigInteger Multiplier parameter (K) 34 | */ 35 | protected $multiplier; 36 | 37 | /** 38 | * @var BigInteger A large safe prime 39 | */ 40 | protected $N; 41 | 42 | /** 43 | * @var string User's salt 44 | */ 45 | protected $salt; 46 | 47 | /** 48 | * @var BigInteger Local secret ephemeral value 49 | */ 50 | protected $secretEphemeralValue; 51 | 52 | /** 53 | * @var BigInteger Computed session key 54 | */ 55 | protected $sessionKey; 56 | 57 | /** 58 | * @var string Hashed session key 59 | */ 60 | protected $strongSessionKey; 61 | 62 | /** 63 | * @var string User's username (I) 64 | */ 65 | protected $username; 66 | 67 | /** 68 | * SRP Client constructor. 69 | * 70 | * @param string $identity User's identity (username) 71 | * @param string|null $salt User's salt 72 | * @param array|null $options Various options for SRP Client 73 | */ 74 | public function __construct(string $identity, string $salt = null, array $options = null) 75 | { 76 | $this->g = new BigInteger($options['g'] ?? '07', 16); 77 | $this->multiplier = new BigInteger('03', 16); 78 | $this->N = new BigInteger( 79 | $options['N'] ?? '894B645E89E1535BBDAD5B8B290650530801B18EBFBF5E8FAB3C82872A3E9BB7', 80 | 16 81 | ); 82 | $this->salt = $salt; 83 | $this->username = $identity; 84 | } 85 | 86 | /** 87 | * Sets user's salt 88 | * 89 | * @param string $salt 90 | */ 91 | public function setSalt(string $salt): void 92 | { 93 | $this->salt = $salt; 94 | } 95 | 96 | /** 97 | * @return string 98 | */ 99 | public function getSessionKey(): string 100 | { 101 | return $this->sessionKey->toHex(); 102 | } 103 | 104 | /** 105 | * @return string 106 | */ 107 | public function getStrongSessionKey(): string 108 | { 109 | return $this->strongSessionKey; 110 | } 111 | 112 | /** 113 | * @return BigInteger Random scrambling parameter 114 | */ 115 | public function computeRandomScramblingParameter(): BigInteger 116 | { 117 | $hash = sha1($this->clientPublicEphemeralValue->toHex() . $this->hostPublicEphemeralValue->toHex()); 118 | 119 | return new BigInteger($hash, 16); 120 | } 121 | 122 | /** 123 | * @return string 124 | */ 125 | public function computeClientSessionKeyProof(): string 126 | { 127 | $A = $this->clientPublicEphemeralValue->toHex(); 128 | $B = $this->hostPublicEphemeralValue->toHex(); 129 | $I = sha1($this->username); 130 | $K = $this->strongSessionKey; 131 | $Ng = sha1($this->N->toHex()) ^ sha1($this->g->toHex()); 132 | $s = $this->salt; 133 | 134 | return sha1($Ng . $I . $s . $A . $B . $K); 135 | } 136 | 137 | /** 138 | * @param string $M User's calculated proof of session 139 | * 140 | * @return string 141 | */ 142 | public function computeHostSessionKeyProof(string $M): string 143 | { 144 | return sha1($this->clientPublicEphemeralValue->toHex() . $M . $this->strongSessionKey); 145 | } 146 | 147 | /** 148 | * Returns hex of public ephemeral value 149 | * 150 | * @return string 151 | */ 152 | abstract public function getPublicEphemeralValue(): string; 153 | 154 | /** 155 | * @return BigInteger 156 | * @throws Exception 157 | */ 158 | public function generateSecretEphemeralValue(): BigInteger 159 | { 160 | return new BigInteger($this->getRandomNumber(16), 16); 161 | } 162 | 163 | /** 164 | * @param BigInteger $value Secret ephemeral value 165 | * 166 | * @return BigInteger Public ephemeral value 167 | */ 168 | abstract public function computePublicEphemeralValue(BigInteger $value): BigInteger; 169 | 170 | /** 171 | * Generates both private and public ephemeral values but returns only public value 172 | * 173 | * @return BigInteger 174 | * @throws Exception 175 | */ 176 | protected function generateEphemeralValues(): BigInteger 177 | { 178 | $public = null; 179 | 180 | while (!$public || bcmod($public, $this->N) === 0) { 181 | $secret = $this->generateSecretEphemeralValue(); 182 | $public = $this->computePublicEphemeralValue($secret); 183 | } 184 | 185 | $this->secretEphemeralValue = $secret ?? null; 186 | 187 | return $public; 188 | } 189 | 190 | /** 191 | * Generate hex string of defined length of random bytes 192 | * 193 | * @param int $length 194 | * 195 | * @return string 196 | * @throws Exception 197 | */ 198 | protected function getRandomNumber(int $length): string 199 | { 200 | return bin2hex(random_bytes($length)); 201 | } 202 | } 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # php-wowemu-auth 2 | 3 | ## Requirements 4 | 5 | * PHP 7.1+ 6 | * Web server (ex. Apache or Nginx) 7 | * CMaNGOS instance 8 | 9 | ## Installation 10 | 11 | You can install the libary via composer: 12 | 13 | ``` bash 14 | composer require laizerox/php-wowemu-auth 15 | ``` 16 | 17 | ## Usage 18 | 19 | ### Register 20 | 21 | First you'll want to use Composer's `autoloader`. Place this at the top of your script. 22 | 23 | ``` php 24 | require_once __DIR__ . '/vendor/autoload.php'; 25 | use Laizerox\Wowemu\SRP\UserClient; 26 | ``` 27 | 28 | Next you'll need to create the verifier and salt values using the username and password which your user submitted on your registration form. 29 | 30 | ``` php 31 | $client = new UserClient($username); 32 | $salt = $client->generateSalt(); 33 | $verifier = $client->generateVerifier($password); 34 | ``` 35 | 36 | Once that is generated you'll just insert those values into the database to the `v` and `s` fields. 37 | 38 | ### Login 39 | 40 | First you'll want to use Composer's `autoloader`. Place this at the top of your script. 41 | 42 | ``` php 43 | require_once __DIR__ . '/vendor/autoload.php'; 44 | use Laizerox\Wowemu\SRP\UserClient; 45 | ``` 46 | 47 | Next you'll need to generate your "verifier". Think of this as the hashed version of the password your user put into the password field of you login form. 48 | 49 | ``` php 50 | $client = new UserClient($username, $saltFromDatabase); 51 | $verifier = strtoupper($client->generateVerifier($password)); 52 | ``` 53 | 54 | Next you'll want to compare that value with the value stored in your CMaNGOS `realmd.account` table. You can see below for more of an example. 55 | 56 | ## Examples 57 | 58 | ### Register 59 | 60 | This example goes over how a user can register via a web form. 61 | 62 | ``` php 63 | generateSalt(); 93 | $verifier = $client->generateVerifier($password); 94 | 95 | /* Insert the data into the CMaNGOS database. */ 96 | mysqli_query($db, "INSERT INTO account (username, v, s, gmlevel, email, joindate, last_ip, expansion) VALUES ('$username', '$verifier', '$salt', '$gmLevel', '$email', '$joinDate', '$ip', '$expansion')"); 97 | 98 | /* Do some stuff to let the user know it was a successful or unsuccessful attempt. */ 99 | } 100 | 101 | ?> 102 | ``` 103 | 104 | Now you'll obviously want to do some error checking and validation, but we'll leave that up to you. 105 | 106 | ``` html 107 |
108 | 109 | 110 | 111 | 112 | 113 | 114 |
115 | ``` 116 | 117 | The above is a very basic HTML form for user registrations. 118 | 119 | ### Login 120 | 121 | ``` php 122 | query($query)->fetch_object(); 136 | } 137 | 138 | /* If the form has been submitted. */ 139 | if (isset($_POST['login'])) { 140 | $username = $_POST['username']; 141 | $password = $_POST['password']; 142 | 143 | /* Get the salt and verifier from realmd.account for the user. */ 144 | $query = "SELECT s,v FROM account WHERE username='$username'"; 145 | $result = getMySQLResult($query); 146 | $saltFromDatabase = $result->s; 147 | $verifierFromDatabase = strtoupper($result->v); 148 | 149 | /* Setup your client and verifier values. */ 150 | $client = new UserClient($username, $saltFromDatabase); 151 | $verifier = strtoupper($client->generateVerifier($password)); 152 | 153 | /* Compare $verifierFromDatabase and $verifier. */ 154 | if ($verifierFromDatabase === $verifier) { 155 | /* Do your login stuff here, like setting cookies/sessions... */ 156 | } 157 | else { 158 | /* Do whatever you wanna do when the login has failed, send a failure message, redirect them to another page, etc... */ 159 | } 160 | 161 | ?> 162 | ``` 163 | 164 | Again, you'll want to add in your own error checking and validation but this should get you started. 165 | 166 | ``` html 167 |
168 | 169 | 170 | 171 | 172 | 173 |
174 | ``` 175 | 176 | The above is a very basic HTML form for user logins. 177 | 178 | If you find any defects when using the library please open a new issue in this repository. If you need further assistance we can try assising you in the `#offtopic` channel of [the CMaNGOS Discord server](https://discord.gg/Dgzerzb). 179 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------