From 032d8854612664c1e1daa3bac7f01e6e4df00b56 Mon Sep 17 00:00:00 2001 From: Tim van Dijen Date: Fri, 24 May 2019 16:00:13 +0100 Subject: [PATCH 01/14] Initial import --- .codecov.yml | 11 ++++ .php_cs.dist | 15 +++++ .travis.yml | 35 +++++++++++ bin/check-syntax.sh | 15 +++++ composer.json | 42 +++++++++++++ default-disable | 3 + docs/authcrypt.md | 73 ++++++++++++++++++++++ lib/Auth/Source/Hash.php | 103 ++++++++++++++++++++++++++++++ lib/Auth/Source/Htpasswd.php | 118 +++++++++++++++++++++++++++++++++++ phpunit.xml | 19 ++++++ psalm.xml | 31 +++++++++ tests/bootstrap.php | 11 ++++ 12 files changed, 476 insertions(+) create mode 100644 .codecov.yml create mode 100644 .php_cs.dist create mode 100644 .travis.yml create mode 100755 bin/check-syntax.sh create mode 100644 composer.json create mode 100644 default-disable create mode 100644 docs/authcrypt.md create mode 100644 lib/Auth/Source/Hash.php create mode 100644 lib/Auth/Source/Htpasswd.php create mode 100644 phpunit.xml create mode 100644 psalm.xml create mode 100644 tests/bootstrap.php diff --git a/.codecov.yml b/.codecov.yml new file mode 100644 index 0000000..f7f39e1 --- /dev/null +++ b/.codecov.yml @@ -0,0 +1,11 @@ +coverage: + status: + project: yes + +comment: + layout: "diff" + behavior: once + require_changes: true + require_base: no + require_head: yes + branches: null diff --git a/.php_cs.dist b/.php_cs.dist new file mode 100644 index 0000000..e7d3146 --- /dev/null +++ b/.php_cs.dist @@ -0,0 +1,15 @@ +in([ + __DIR__ . '/lib', + __DIR__ . '/tests', + ]) +; +return PhpCsFixer\Config::create() + ->setRules([ + '@PSR2' => true, + '@PSR4' => true, + '@PSR5' => true, + ]) + ->setFinder($finder) +; diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..3c25028 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,35 @@ +sudo: required + +language: php + +php: + - 5.6 + - 7.0 + - 7.1 + - 7.2 + - 7.3 + +env: + - SIMPLESAMLPHP_VERSION=1.17.* + +matrix: + allow_failures: + - php: 7.3 + +before_script: + - composer require "simplesamlphp/simplesamlphp:${SIMPLESAMLPHP_VERSION}" --no-update + - composer update --no-interaction + - if [[ "$TRAVIS_PHP_VERSION" == "7.3" ]]; then composer require --dev vimeo/psalm:1.1.9; fi + +script: + - bin/check-syntax.sh + - if [[ "$TRAVIS_PHP_VERSION" == "5.6" ]]; then php vendor/phpunit/phpunit/phpunit; else php vendor/phpunit/phpunit/phpunit --no-coverage; fi + - if [[ "$TRAVIS_PHP_VERSION" == "7.3" ]]; then vendor/bin/psalm; fi + +after_success: + # Codecov, need to edit bash uploader for incorrect TRAVIS_PYTHON_VERSION environment variable matching, at least until codecov/codecov-bash#133 is resolved + - curl -s https://codecov.io/bash > .codecov + - sed -i -e 's/TRAVIS_.*_VERSION/^TRAVIS_.*_VERSION=/' .codecov + - chmod +x .codecov + - if [[ $TRAVIS_PHP_VERSION == "5.6" ]]; then ./.codecov -X gcov; fi +# - if [[ "$TRAVIS_PHP_VERSION" == "5.6" ]]; then bash <(curl -s https://codecov.io/bash); fi diff --git a/bin/check-syntax.sh b/bin/check-syntax.sh new file mode 100755 index 0000000..db6dc4b --- /dev/null +++ b/bin/check-syntax.sh @@ -0,0 +1,15 @@ +#!/usr/bin/env bash + +PHP='/usr/bin/env php' +RETURN=0 + +# check PHP files +for FILE in `find lib tests -name "*.php"`; do + $PHP -l $FILE > /dev/null 2>&1 + if [ $? -ne 0 ]; then + echo "Syntax check failed for ${FILE}" + RETURN=`expr ${RETURN} + 1` + fi +done + +exit $RETURN diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..4b4b11a --- /dev/null +++ b/composer.json @@ -0,0 +1,42 @@ +{ + "name": "simplesamlphp/simplesamlphp-module-authcrypt", + "description": "This module provides authentication against password hashes or .htpasswd files", + "type": "simplesamlphp-module", + "keywords": ["simplesamlphp", "authcrypt"], + "license": "LGPL-3.0-or-later", + "authors": [ + { + "name": "Olav Morken", + "email": "olavmrk@gmail.com" + } + ], + "config": { + "preferred-install": { + "simplesamlphp/simplesamlphp": "source", + "*": "dist" + } + }, + "autoload": { + "psr-4": { + "SimpleSAML\\Module\\authcrypt\\": "lib/" + } + }, + "autoload-dev": { + "psr-4": { + "SimpleSAML\\Test\\Utils\\": "vendor/simplesamlphp/simplesamlphp/tests/Utils" + } + }, + "require": { + "php": ">=5.6", + "simplesamlphp/composer-module-installer": "~1.1", + "webmozart/assert": "~1.4", + }, + "require-dev": { + "simplesamlphp/simplesamlphp": "^1.17", + "phpunit/phpunit": "~5.7" + }, + "support": { + "issues": "https://github.com/tvdijen/simplesamlphp-module-authcrypt/issues", + "source": "https://github.com/tvdijen/simplesamlphp-module-authcrypt" + } +} diff --git a/default-disable b/default-disable new file mode 100644 index 0000000..fa0bd82 --- /dev/null +++ b/default-disable @@ -0,0 +1,3 @@ +This file indicates that the default state of this module +is disabled. To enable, create a file named enable in the +same directory as this file. diff --git a/docs/authcrypt.md b/docs/authcrypt.md new file mode 100644 index 0000000..148b9eb --- /dev/null +++ b/docs/authcrypt.md @@ -0,0 +1,73 @@ +AuthCrypt +========= + +This module provides two methods for authentication: + +`authcrypt:Hash` +: Username & password authentication with hashed passwords. + +`authcrypt:Htpasswd` +: Username & password authentication against an `.htpasswd` file. + + +`authcrypt:Hash` +---------------- + +This is based on `exampleAuth:UserPass`, and adds support for hashed passwords. +Hashes can be generated with the included command line tool `bin/pwgen.sh`. +This tool will interactively ask for a password, a hashing algorithm , and whether or not you want to use a salt: + + [user@server simplesamlphp]$ bin/pwgen.php + Enter password: hackme + The following hashing algorithms are available: + md2 md4 md5 sha1 sha224 sha256 + sha384 sha512 ripemd128 ripemd160 ripemd256 ripemd320 + whirlpool tiger128,3 tiger160,3 tiger192,3 tiger128,4 tiger160,4 + tiger192,4 snefru snefru256 gost adler32 crc32 + crc32b salsa10 salsa20 haval128,3 haval160,3 haval192,3 + haval224,3 haval256,3 haval128,4 haval160,4 haval192,4 haval224,4 + haval256,4 haval128,5 haval160,5 haval192,5 haval224,5 haval256,5 + + Which one do you want? [sha256] + Do you want to use a salt? (yes/no) [yes] + + {SSHA256}y1mj3xsZ4/+LoQyPNVJzXUFfBcLHfwcHx1xxltxeQ1C5MeyEX/RxWA== + +Now create an authentication source in `config/authsources.php` and use the resulting string as the password: + + 'example-hashed' => array( + 'authCrypt:Hash', + 'student:{SSHA256}y1mj3xsZ4/+LoQyPNVJzXUFfBcLHfwcHx1xxltxeQ1C5MeyEX/RxWA==' => array( + 'uid' => array('student'), + 'eduPersonAffiliation' => array('member', 'student'), + ), + ), + +This example creates a user `student` with password `hackme`, and some attributes. + +### Compatibility ### +The generated hashes can also be used in `config.php` for the administrative password: + + 'auth.adminpassword' => '{SSHA256}y1mj3xsZ4/+LoQyPNVJzXUFfBcLHfwcHx1xxltxeQ1C5MeyEX/RxWA==', + +Instead of generating hashes, you can also use existing ones from OpenLDAP, provided that the `userPassword` attribute is stored as MD5, SMD5, SHA, or SSHA. + + +`authCrypt:Htpasswd` +-------------------- + +Authenticate users against an [`.htpasswd`](http://httpd.apache.org/docs/2.2/programs/htpasswd.html) file. It can be used for example when you migrate a web site from basic HTTP authentication to SimpleSAMLphp. + +The simple structure of the `.htpasswd` file does not allow for per-user attributes, but you can define some static attributes for all users. + +An example authentication source in `config/authsources.php` could look like this: + + 'htpasswd' => array( + 'authcrypt:Htpasswd', + 'htpasswd_file' => '/var/www/foo.edu/legacy_app/.htpasswd', + 'static_attributes' => array( + 'eduPersonAffiliation' => array('member', 'employee'), + 'Organization' => array('University of Foo'), + ), + ), + diff --git a/lib/Auth/Source/Hash.php b/lib/Auth/Source/Hash.php new file mode 100644 index 0000000..aa17adc --- /dev/null +++ b/lib/Auth/Source/Hash.php @@ -0,0 +1,103 @@ +:", + * while the value of each element is a new array with the attributes for each user. + */ + private $users; + + + /** + * Constructor for this authentication source. + * + * @param array $info Information about this authentication source. + * @param array $config Configuration. + * + * @throws Exception in case of a configuration error. + */ + public function __construct($info, $config) + { + assert(is_array($info)); + assert(is_array($config)); + + // Call the parent constructor first, as required by the interface + parent::__construct($info, $config); + + $this->users = []; + + // Validate and parse our configuration + foreach ($config as $userpass => $attributes) { + if (!is_string($userpass)) { + throw new \Exception('Invalid : for authentication source '. + $this->authId.': '.$userpass); + } + + $userpass = explode(':', $userpass, 2); + if (count($userpass) !== 2) { + throw new \Exception('Invalid : for authentication source '. + $this->authId.': '.$userpass[0]); + } + $username = $userpass[0]; + $passwordhash = $userpass[1]; + + try { + $attributes = \SimpleSAML\Utils\Attributes::normalizeAttributesArray($attributes); + } catch (\Exception $e) { + throw new \Exception('Invalid attributes for user '.$username. + ' in authentication source '.$this->authId.': '. + $e->getMessage()); + } + + $this->users[$username.':'.$passwordhash] = $attributes; + } + } + + + /** + * Attempt to log in using the given username and password. + * + * On a successful login, this function should return the users attributes. On failure, + * it should throw an exception. If the error was caused by the user entering the wrong + * username OR password, a \SimpleSAML\Error\Error('WRONGUSERPASS') should be thrown. + * + * The username is UTF-8 encoded, and the hash is base64 encoded. + * + * @param string $username The username the user wrote. + * @param string $password The password the user wrote. + * + * @return array Associative array with the users attributes. + * + * @throws \SimpleSAML\Error\Error if authentication fails. + */ + protected function login($username, $password) + { + assert(is_string($username)); + assert(is_string($password)); + + foreach ($this->users as $userpass => $attrs) { + $matches = explode(':', $userpass, 2); + if ($matches[0] === $username) { + if (\SimpleSAML\Utils\Crypto::pwValid($matches[1], $password)) { + return $attrs; + } else { + \SimpleSAML\Logger::debug('Incorrect password "'.$password.'" for user '.$username); + } + } + } + throw new \SimpleSAML\Error\Error('WRONGUSERPASS'); + } +} diff --git a/lib/Auth/Source/Htpasswd.php b/lib/Auth/Source/Htpasswd.php new file mode 100644 index 0000000..72a1fce --- /dev/null +++ b/lib/Auth/Source/Htpasswd.php @@ -0,0 +1,118 @@ +:". + * + * @var array + */ + private $users; + + /** + * An array containing static attributes for our users. + * + * @var array + */ + private $attributes = []; + + + /** + * Constructor for this authentication source. + * + * @param array $info Information about this authentication source. + * @param array $config Configuration. + * + * @throws Exception if the htpasswd file is not readable or the static_attributes array is invalid. + */ + public function __construct($info, $config) + { + assert(is_array($info)); + assert(is_array($config)); + + // Call the parent constructor first, as required by the interface + parent::__construct($info, $config); + + $this->users = []; + + if (!$htpasswd = file_get_contents($config['htpasswd_file'])) { + throw new \Exception('Could not read '.$config['htpasswd_file']); + } + + $this->users = explode("\n", trim($htpasswd)); + + try { + $this->attributes = \SimpleSAML\Utils\Attributes::normalizeAttributesArray($config['static_attributes']); + } catch (\Exception $e) { + throw new \Exception('Invalid static_attributes in authentication source '. + $this->authId.': '.$e->getMessage()); + } + } + + + /** + * Attempt to log in using the given username and password. + * + * On a successful login, this function should return the username as 'uid' attribute, + * and merged attributes from the configuration file. + * On failure, it should throw an exception. A \SimpleSAML\Error\Error('WRONGUSERPASS') + * should be thrown in case of a wrong username OR a wrong password, to prevent the + * enumeration of usernames. + * + * @param string $username The username the user wrote. + * @param string $password The password the user wrote. + * + * @return array Associative array with the users attributes. + * + * @throws \SimpleSAML\Error\Error if authentication fails. + */ + protected function login($username, $password) + { + assert(is_string($username)); + assert(is_string($password)); + + foreach ($this->users as $userpass) { + $matches = explode(':', $userpass, 2); + if ($matches[0] == $username) { + $crypted = $matches[1]; + + // This is about the only attribute we can add + $attributes = array_merge(['uid' => [$username]], $this->attributes); + + // Traditional crypt(3) + if (\SimpleSAML\Utils\Crypto::secureCompare($crypted, crypt($password, $crypted))) { + \SimpleSAML\Logger::debug('User '.$username.' authenticated successfully'); + \SimpleSAML\Logger::warning( + 'CRYPT authentication is insecure. Please consider using something else.' + ); + return $attributes; + } + + // Apache's custom MD5 + if (APR1_MD5::check($password, $crypted)) { + \SimpleSAML\Logger::debug('User '.$username.' authenticated successfully'); + return $attributes; + } + + // PASSWORD_BCRYPT + if (\SimpleSAML\Utils\Crypto::pwValid($crypted, $password)) { + \SimpleSAML\Logger::debug('User '.$username.' authenticated successfully'); + return $attributes; + } + throw new \SimpleSAML\Error\Error('WRONGUSERPASS'); + } + } + throw new \SimpleSAML\Error\Error('WRONGUSERPASS'); + } +} diff --git a/phpunit.xml b/phpunit.xml new file mode 100644 index 0000000..c0985fd --- /dev/null +++ b/phpunit.xml @@ -0,0 +1,19 @@ + + + + + tests/ + + + + + ./lib + + + + + + + + + diff --git a/psalm.xml b/psalm.xml new file mode 100644 index 0000000..e38c385 --- /dev/null +++ b/psalm.xml @@ -0,0 +1,31 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/bootstrap.php b/tests/bootstrap.php new file mode 100644 index 0000000..603b889 --- /dev/null +++ b/tests/bootstrap.php @@ -0,0 +1,11 @@ + Date: Fri, 24 May 2019 16:07:50 +0200 Subject: [PATCH 02/14] Fix syntax error --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 4b4b11a..e5e77a6 100644 --- a/composer.json +++ b/composer.json @@ -29,7 +29,7 @@ "require": { "php": ">=5.6", "simplesamlphp/composer-module-installer": "~1.1", - "webmozart/assert": "~1.4", + "webmozart/assert": "~1.4" }, "require-dev": { "simplesamlphp/simplesamlphp": "^1.17", From 71d813eea3835a567635f41157297d2f1ee90438 Mon Sep 17 00:00:00 2001 From: Tim van Dijen Date: Fri, 24 May 2019 16:17:09 +0200 Subject: [PATCH 03/14] Fix Psalm issues --- psalm.xml | 1 - 1 file changed, 1 deletion(-) diff --git a/psalm.xml b/psalm.xml index e38c385..5802afa 100644 --- a/psalm.xml +++ b/psalm.xml @@ -6,7 +6,6 @@ > - From 8d43cbcdfe127b7e30d5f5c14bb60afac5f6cd86 Mon Sep 17 00:00:00 2001 From: Tim van Dijen Date: Fri, 24 May 2019 16:27:24 +0200 Subject: [PATCH 04/14] Add use-statements --- lib/Auth/Source/Hash.php | 10 +++++++--- lib/Auth/Source/Htpasswd.php | 17 ++++++++++------- 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/lib/Auth/Source/Hash.php b/lib/Auth/Source/Hash.php index aa17adc..4d1ee95 100644 --- a/lib/Auth/Source/Hash.php +++ b/lib/Auth/Source/Hash.php @@ -2,6 +2,10 @@ namespace SimpleSAML\Module\authcrypt\Auth\Source; +use SimpleSAML\Logger; +use SimpleSAML\Utils\Attributes; +use SimpleSAML\Utils\Crypto; + /** * Authentication source for username & hashed password. * @@ -55,7 +59,7 @@ public function __construct($info, $config) $passwordhash = $userpass[1]; try { - $attributes = \SimpleSAML\Utils\Attributes::normalizeAttributesArray($attributes); + $attributes = Attributes::normalizeAttributesArray($attributes); } catch (\Exception $e) { throw new \Exception('Invalid attributes for user '.$username. ' in authentication source '.$this->authId.': '. @@ -91,10 +95,10 @@ protected function login($username, $password) foreach ($this->users as $userpass => $attrs) { $matches = explode(':', $userpass, 2); if ($matches[0] === $username) { - if (\SimpleSAML\Utils\Crypto::pwValid($matches[1], $password)) { + if (Crypto::pwValid($matches[1], $password)) { return $attrs; } else { - \SimpleSAML\Logger::debug('Incorrect password "'.$password.'" for user '.$username); + Logger::debug('Incorrect password "'.$password.'" for user '.$username); } } } diff --git a/lib/Auth/Source/Htpasswd.php b/lib/Auth/Source/Htpasswd.php index 72a1fce..fc05800 100644 --- a/lib/Auth/Source/Htpasswd.php +++ b/lib/Auth/Source/Htpasswd.php @@ -9,6 +9,9 @@ * @package SimpleSAMLphp */ +use SimpleSAML\Logger; +use SimpleSAML\Utils\Attributes; +use SimpleSAML\Utils\Crypto; use WhiteHat101\Crypt\APR1_MD5; class Htpasswd extends \SimpleSAML\Module\core\Auth\UserPassBase @@ -53,7 +56,7 @@ public function __construct($info, $config) $this->users = explode("\n", trim($htpasswd)); try { - $this->attributes = \SimpleSAML\Utils\Attributes::normalizeAttributesArray($config['static_attributes']); + $this->attributes = Attributes::normalizeAttributesArray($config['static_attributes']); } catch (\Exception $e) { throw new \Exception('Invalid static_attributes in authentication source '. $this->authId.': '.$e->getMessage()); @@ -91,9 +94,9 @@ protected function login($username, $password) $attributes = array_merge(['uid' => [$username]], $this->attributes); // Traditional crypt(3) - if (\SimpleSAML\Utils\Crypto::secureCompare($crypted, crypt($password, $crypted))) { - \SimpleSAML\Logger::debug('User '.$username.' authenticated successfully'); - \SimpleSAML\Logger::warning( + if (Crypto::secureCompare($crypted, crypt($password, $crypted))) { + Logger::debug('User '.$username.' authenticated successfully'); + Logger::warning( 'CRYPT authentication is insecure. Please consider using something else.' ); return $attributes; @@ -101,13 +104,13 @@ protected function login($username, $password) // Apache's custom MD5 if (APR1_MD5::check($password, $crypted)) { - \SimpleSAML\Logger::debug('User '.$username.' authenticated successfully'); + Logger::debug('User '.$username.' authenticated successfully'); return $attributes; } // PASSWORD_BCRYPT - if (\SimpleSAML\Utils\Crypto::pwValid($crypted, $password)) { - \SimpleSAML\Logger::debug('User '.$username.' authenticated successfully'); + if (Crypto::pwValid($crypted, $password)) { + Logger::debug('User '.$username.' authenticated successfully'); return $attributes; } throw new \SimpleSAML\Error\Error('WRONGUSERPASS'); From 295168622c02dca6908e4087c8625614c013202e Mon Sep 17 00:00:00 2001 From: Tim van Dijen Date: Tue, 28 May 2019 12:08:13 +0200 Subject: [PATCH 05/14] Update .travis.yml --- .travis.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.travis.yml b/.travis.yml index 3c25028..a090b62 100644 --- a/.travis.yml +++ b/.travis.yml @@ -12,10 +12,6 @@ php: env: - SIMPLESAMLPHP_VERSION=1.17.* -matrix: - allow_failures: - - php: 7.3 - before_script: - composer require "simplesamlphp/simplesamlphp:${SIMPLESAMLPHP_VERSION}" --no-update - composer update --no-interaction From c3d0c766abebabfd22629e78fb2e8499246732a9 Mon Sep 17 00:00:00 2001 From: Tim van Dijen Date: Tue, 28 May 2019 14:10:10 +0200 Subject: [PATCH 06/14] Update and rename default-disable to default-enable --- default-disable => default-enable | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename default-disable => default-enable (59%) diff --git a/default-disable b/default-enable similarity index 59% rename from default-disable rename to default-enable index fa0bd82..25615cb 100644 --- a/default-disable +++ b/default-enable @@ -1,3 +1,3 @@ This file indicates that the default state of this module -is disabled. To enable, create a file named enable in the +is enabled. To disable, create a file named disable in the same directory as this file. From f5f80229033c7ad132ceb3d5952e98fe6e08e962 Mon Sep 17 00:00:00 2001 From: Tim van Dijen Date: Tue, 3 Dec 2019 09:56:36 +0100 Subject: [PATCH 07/14] Update and rename default-enable to default-disable --- default-enable => default-disable | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename default-enable => default-disable (59%) diff --git a/default-enable b/default-disable similarity index 59% rename from default-enable rename to default-disable index 25615cb..fa0bd82 100644 --- a/default-enable +++ b/default-disable @@ -1,3 +1,3 @@ This file indicates that the default state of this module -is enabled. To disable, create a file named disable in the +is disabled. To enable, create a file named enable in the same directory as this file. From e853b73fb6155f8bb1cbd54a31f7ea56ee4a3643 Mon Sep 17 00:00:00 2001 From: Tim van Dijen Date: Tue, 25 Feb 2020 16:14:03 +0100 Subject: [PATCH 08/14] Rename .codecov.yml to codecov.yml --- .codecov.yml => codecov.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .codecov.yml => codecov.yml (100%) diff --git a/.codecov.yml b/codecov.yml similarity index 100% rename from .codecov.yml rename to codecov.yml From 8f0d29dc62b3d3b0bde57ab857b20fec873246fd Mon Sep 17 00:00:00 2001 From: Tim van Dijen Date: Fri, 20 Mar 2020 18:22:32 +0100 Subject: [PATCH 09/14] Add LICENSE --- LICENSE | 459 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 459 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a345e48 --- /dev/null +++ b/LICENSE @@ -0,0 +1,459 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + \ No newline at end of file From 7afaa16a6fa66f568c012024e7e379ef0f6c9217 Mon Sep 17 00:00:00 2001 From: Tim van Dijen Date: Sun, 22 Mar 2020 15:57:34 +0100 Subject: [PATCH 10/14] Fix license --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index e5e77a6..fc4b6ab 100644 --- a/composer.json +++ b/composer.json @@ -3,7 +3,7 @@ "description": "This module provides authentication against password hashes or .htpasswd files", "type": "simplesamlphp-module", "keywords": ["simplesamlphp", "authcrypt"], - "license": "LGPL-3.0-or-later", + "license": "LGPL-2.1-or-later", "authors": [ { "name": "Olav Morken", From 6d891e3291a93e6d81e6389d538d957a7bcb87e4 Mon Sep 17 00:00:00 2001 From: Tim van Dijen Date: Sun, 22 Mar 2020 17:02:15 +0100 Subject: [PATCH 11/14] Update composer.json --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index fc4b6ab..a58857f 100644 --- a/composer.json +++ b/composer.json @@ -29,7 +29,7 @@ "require": { "php": ">=5.6", "simplesamlphp/composer-module-installer": "~1.1", - "webmozart/assert": "~1.4" + "webmozart/assert": "~1.4 <1.7" }, "require-dev": { "simplesamlphp/simplesamlphp": "^1.17", From 2ad0f234b92ab0abe94e97fa3e1e04f9c743eb9d Mon Sep 17 00:00:00 2001 From: Tim van Dijen Date: Wed, 12 Aug 2020 23:30:50 +0200 Subject: [PATCH 12/14] Update composer.json --- composer.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/composer.json b/composer.json index a58857f..04693f8 100644 --- a/composer.json +++ b/composer.json @@ -29,7 +29,8 @@ "require": { "php": ">=5.6", "simplesamlphp/composer-module-installer": "~1.1", - "webmozart/assert": "~1.4 <1.7" + "webmozart/assert": "~1.4 <1.7", + "whitehat101/apr1-md5": "~1.0" }, "require-dev": { "simplesamlphp/simplesamlphp": "^1.17", From 9a2c1a761e2d94394a4f2d3499fd6f0853899530 Mon Sep 17 00:00:00 2001 From: Tim van Dijen Date: Fri, 8 Jan 2021 10:09:33 +0100 Subject: [PATCH 13/14] Remove version restriction --- composer.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 04693f8..ad05c24 100644 --- a/composer.json +++ b/composer.json @@ -29,7 +29,7 @@ "require": { "php": ">=5.6", "simplesamlphp/composer-module-installer": "~1.1", - "webmozart/assert": "~1.4 <1.7", + "webmozart/assert": "~1.4", "whitehat101/apr1-md5": "~1.0" }, "require-dev": { From 62555123e61b11463be3cd7adb708562023cff28 Mon Sep 17 00:00:00 2001 From: Tim van Dijen Date: Mon, 3 Jan 2022 21:50:47 +0100 Subject: [PATCH 14/14] Set allow-plugins tag --- composer.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/composer.json b/composer.json index ad05c24..c8c5aa8 100644 --- a/composer.json +++ b/composer.json @@ -14,6 +14,10 @@ "preferred-install": { "simplesamlphp/simplesamlphp": "source", "*": "dist" + }, + "allow-plugins": { + "composer/package-versions-deprecated": true, + "simplesamlphp/composer-module-installer": true } }, "autoload": {