Skip to content

Commit

Permalink
Update some infos in README and updated year
Browse files Browse the repository at this point in the history
  • Loading branch information
fabiang committed Apr 22, 2022
1 parent 6e9e4bf commit 4ac9473
Show file tree
Hide file tree
Showing 33 changed files with 46 additions and 50 deletions.
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Modified BSD License

Copyright (c) 2002-2003 Richard Heyes,
2014 Jaussoin Timothée,
2014-2021 Fabian Grutschus
2014-2022 Fabian Grutschus
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
Expand Down
32 changes: 14 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

The PHP SASL Authentification Library.

[![PHP Version Require](http://poser.pugx.org/fabiang/sasl/require/php)](https://packagist.org/packages/fabiang/sasl)
[![Latest Stable Version](https://poser.pugx.org/fabiang/sasl/v/stable.svg)](https://packagist.org/packages/fabiang/sasl)
[![Total Downloads](https://poser.pugx.org/fabiang/sasl/downloads.svg)](https://packagist.org/packages/fabiang/sasl)
[![License](https://poser.pugx.org/fabiang/sasl/license.svg)](https://packagist.org/packages/fabiang/sasl)
Expand All @@ -26,7 +27,7 @@ The easiest way to install fabiang/sasl is by using Composer:

```
curl -sS https://getcomposer.org/installer | php
php composer.phar require fabiang/sasl
composer require fabiang/sasl
```

## Usage
Expand Down Expand Up @@ -75,27 +76,22 @@ List of options required by authentication mechanisms.
For mechanisms that are challenge-based you'll need to call `createResponse()`
again and send the returned value to the server.

| Mechanism | Authcid | Secret | Authzid | Service | Hostname | Challenge |
| --------- | ------- | ------ | -------- | ------- | -------- | --------- |
| Anonymous | yes | no | no | no | no | no |
| CramMD5 | yes | yes | no | no | no | yes |
| DigestMD5 | yes | yes | optional | yes | yes | yes |
| External | no | no | yes | no | no | no |
| Login | yes | yes | no | no | no | no |
| Plain | yes | yes | optional | no | no | no |
| SCRAM-* | yes | yes | optional | no | no | yes |
| Mechanism | Authcid | Secret | Authzid | Service | Hostname | Challenge |
| ---------- | ------- | ------ | -------- | ------- | -------- | --------- |
| Anonymous | yes | no | no | no | no | no |
| Cram-MD5 | yes | yes | no | no | no | yes |
| Digest-MD5 | yes | yes | optional | yes | yes | yes |
| External | no | no | yes | no | no | no |
| Login | yes | yes | no | no | no | no |
| Plain | yes | yes | optional | no | no | no |
| SCRAM-* | yes | yes | optional | no | no | yes |

## Unit tests

If you like this library and you want to contribute, make sure the unit tests
and integration tests are running. Composer will help you to install the right
version of PHPUnit and Behat.
and integration tests are running.

```
composer install --dev
```

After that run the unit tests:
Run the unit tests:

```
./vendor/bin/phpunit
Expand Down Expand Up @@ -132,7 +128,7 @@ After some minutes you'll have the runnig server instances inside of a virtual m
Now you can run the integration tests:

```
./vendor/bin/behat -c tests/behat.yml.dist
./vendor/bin/behat
```

## License
Expand Down
2 changes: 1 addition & 1 deletion phpunit.xml.dist
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Authentication/AbstractAuthentication.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Authentication/Anonymous.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Authentication/AuthenticationInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Authentication/ChallengeAuthenticationInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Authentication/CramMD5.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Authentication/DigestMD5.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Authentication/External.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Authentication/Login.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Authentication/Plain.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Authentication/SCRAM.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Authentication/VerificationInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Exception/ExceptionInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Exception/InvalidArgumentException.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Exception/RuntimeException.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Options.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion src/Sasl.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/features/bootstrap/AbstractContext.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/features/bootstrap/Pop3Context.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/features/bootstrap/XmppContext.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/provisioner/install_dovecot.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Sasl library.
#
# Copyright (c) 2002-2003 Richard Heyes,
# 2014-2021 Fabian Grutschus
# 2014-2022 Fabian Grutschus
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/provisioner/install_ejabberd.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Sasl library.
#
# Copyright (c) 2002-2003 Richard Heyes,
# 2014-2021 Fabian Grutschus
# 2014-2022 Fabian Grutschus
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/src/Authentication/AnonymousTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/src/Authentication/CramMD5Test.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/src/Authentication/DigestMD5Test.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/src/Authentication/ExternalTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/src/Authentication/LoginTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/src/Authentication/PlainTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/src/Authentication/SCRAMTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/src/OptionsTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down
2 changes: 1 addition & 1 deletion tests/src/SaslTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Sasl library.
*
* Copyright (c) 2002-2003 Richard Heyes,
* 2014-2021 Fabian Grutschus
* 2014-2022 Fabian Grutschus
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down

0 comments on commit 4ac9473

Please sign in to comment.