An open API service indexing awesome lists of open source software.

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

A module to debug encoding and decoding of SAML message for both the HTTP-redirect and HTTP-POST bindings.
https://github.com/simplesamlphp/simplesamlphp-module-saml2debug

Last synced: 9 months ago
JSON representation

A module to debug encoding and decoding of SAML message for both the HTTP-redirect and HTTP-POST bindings.

Awesome Lists containing this project

README

          

# SAML 2.0 debugger module

![Build Status](https://github.com/simplesamlphp/simplesamlphp-module-saml2debug/actions/workflows/php.yml/badge.svg)
[![Coverage Status](https://codecov.io/gh/simplesamlphp/simplesamlphp-module-saml2debug/branch/master/graph/badge.svg)](https://codecov.io/gh/simplesamlphp/simplesamlphp-module-saml2debug)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/simplesamlphp/simplesamlphp-module-saml2debug/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/simplesamlphp/simplesamlphp-module-saml2debug/?branch=master)
[![Type Coverage](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-saml2debug/coverage.svg)](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-saml2debug)
[![Psalm Level](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-saml2debug/level.svg)](https://shepherd.dev/github/simplesamlphp/simplesamlphp-module-saml2debug)

This module allows you to debug SAML 2.0 messages by decoding or encoding them according to the binding they are using,
supporting both the HTTP-Redirect and HTTP-POST bindings.

## Installation

Once you have installed SimpleSAMLphp, installing this module is very simple. Just execute the following
command in the root of your SimpleSAMLphp installation:

```shell
composer.phar require simplesamlphp/simplesamlphp-module-saml2debug: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-saml2debug/releases) available if you
want to use a stable version of the module.

## Configuration

Next thing you need to do is to enable the module:

in `config.php`, search for the `module.enable` key and set `saml2debug` to true:

```php
'module.enable' => [ 'saml2debug' => true, … ],
```

## Usage

Once installed, you can use the module by going to the *configuration* tab in the web interface of SimpleSAMLphp. You will
see a link there to the debugger, allowing you to encode and decode SAML 2.0 messages, selecting the binding to use.