https://github.com/simplesamlphp/simplesamlphp-module-autotest

This module provides an interface to do automatic testing of authentication sources.
https://github.com/simplesamlphp/simplesamlphp-module-autotest

Last synced: 9 months ago
JSON representation

This module provides an interface to do automatic testing of authentication sources.

• Host: GitHub
• URL: https://github.com/simplesamlphp/simplesamlphp-module-autotest
• Owner: simplesamlphp
• License: lgpl-2.1
• Created: 2015-08-07T13:54:50.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2025-04-14T19:57:34.000Z (9 months ago)
• Last Synced: 2025-04-14T20:41:30.658Z (9 months ago)
• Language: PHP
• Size: 107 KB
• Stars: 2
• Watchers: 9
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Autotest module

![Build Status](https://github.com/simplesamlphp/simplesamlphp-module-autotest/actions/workflows/php.yml/badge.svg)

[![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)

This module provides an interface to do automatic testing of

authentication sources.

## 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

```

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`.

## 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.

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**: You still have to parse the login pages to extract the

          parameters in the login form.