Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
26 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,48 @@ | ||
# Autotest module | ||
|
||
![Build Status](https://github.com/simplesamlphp/simplesamlphp-module-autotest/workflows/CI/badge.svg?branch=master) | ||
[![Coverage Status](https://codecov.io/gh/simplesamlphp/simplesamlphp-module-autotest/branch/master/graph/badge.svg)](https://codecov.io/gh/simplesamlphp/simplesamlphp-module-autotest) | ||
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/simplesamlphp/simplesamlphp-module-autotest/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/simplesamlphp/simplesamlphp-module-autotest/?branch=master) | ||
[![Type Coverage](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-autotest/coverage.svg)](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-autotest) | ||
[![Psalm Level](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-autotest/level.svg)](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-autotest) | ||
|
||
Autotest module | ||
=============== | ||
|
||
This module provides an interface to do automatic testing of authentication sources. | ||
This module provides an interface to do automatic testing of | ||
authentication sources. | ||
|
||
Installation | ||
------------ | ||
## Installation | ||
|
||
Once you have installed SimpleSAMLphp, installing this module is very simple. Just execute the following | ||
command in the root of your SimpleSAMLphp installation: | ||
Once you have installed SimpleSAMLphp, installing this module is very simple. | ||
Just execute the following command in the root of your SimpleSAMLphp | ||
installation: | ||
|
||
```bash | ||
vendor/bin/composer require simplesamlphp/simplesamlphp-module-autotest:dev-master | ||
``` | ||
composer.phar require simplesamlphp/simplesamlphp-module-autotest:dev-master | ||
``` | ||
|
||
where `dev-master` instructs Composer to install the `master` branch from the Git repository. See the | ||
[releases](https://github.com/simplesamlphp/simplesamlphp-module-autotest/releases) available if you | ||
want to use a stable version of the module. | ||
where `dev-master` instructs Composer to install the `master` branch from the | ||
Git repository. See the [releases](releases) available if you want to use | ||
a stable version of the module. | ||
|
||
[releases]: https://github.com/simplesamlphp/simplesamlphp-module-autotest/releases | ||
|
||
The module is disabled by default. If you want to enable the module once installed, you just have to add it to the `module.enable` array in your `config.php`. | ||
The module is disabled by default. If you want to enable the module once installed, | ||
you just have to add it to the `module.enable` array in your `config.php`. | ||
|
||
Usage | ||
----- | ||
## Usage | ||
|
||
This module provides three web pages: | ||
|
||
- `SIMPLESAMLPHP_ROOT/module.php/autotest/login` | ||
- `SIMPLESAMLPHP_ROOT/module.php/autotest/logout` | ||
- `SIMPLESAMLPHP_ROOT/module.php/autotest/attributes` | ||
|
||
All the web pages have a mandatory parameter 'SourceID', which is the name of the authentication source. | ||
All the web pages have a mandatory parameter 'SourceID', which is the name of | ||
the authentication source. | ||
|
||
On success, the web pages print a single line with "OK". The attributes page will also list all the attributes of the | ||
user. On error they set the HTTP status code to 500 Internal Server Error, print a line with "ERROR" and then any | ||
information about the error. | ||
On success, the web pages print a single line with "OK". The attributes page | ||
will also list all the attributes of the user. On error they set the HTTP | ||
status code to 500 Internal Server Error, print a line with "ERROR" and then | ||
any information about the error. | ||
|
||
Note that you still have to parse the login pages to extract the parameters in the login form. | ||
**Note**: You still have to parse the login pages to extract the | ||
parameters in the login form. |