Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/simevo/spid-symfony3-example

Example Symfony3 project based on spid-symfony-bundle
https://github.com/simevo/spid-symfony3-example

php spid symfony symfony3

Last synced: about 1 month ago
JSON representation

Example Symfony3 project based on spid-symfony-bundle

Host: GitHub
URL: https://github.com/simevo/spid-symfony3-example
Owner: simevo
License: bsd-3-clause
Created: 2018-08-29T09:39:27.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2018-10-12T13:23:46.000Z (about 6 years ago)
Last Synced: 2024-09-30T16:02:19.350Z (about 2 months ago)
Topics: php, spid, symfony, symfony3
Language: PHP
Size: 836 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

[![Join the #spid-perl channel](https://img.shields.io/badge/Slack%20channel-%23spid--perl-blue.svg?logo=slack)](https://developersitalia.slack.com/messages/C7ESTMQDQ)

[![Get invited](https://slack.developers.italia.it/badge.svg)](https://slack.developers.italia.it/)

[![SPID on forum.italia.it](https://img.shields.io/badge/Forum-SPID-blue.svg)](https://forum.italia.it/c/spid)

[![Build Status](https://travis-ci.com/simevo/spid-symfony3-example.svg?branch=master)](https://travis-ci.com/simevo/spid-symfony3-example)

# spid-symfony3-example

Example Symfony3 project based on [spid-symfony-bundle](https://github.com/italia/spid-symfony-bundle) to demonstrate how to integrate SPID login.

[SPID](https://www.spid.gov.it/) is the Italian digital identity system, which enables citizens to access all public services with a single set of credentials.

The project [was initially created](https://symfony.com/doc/3.4/setup.html) with:

```sh

php symfony.phar new spid-symfony3-example 3.4

```

## Getting Started

Tested on: amd64 Debian 9.5 (stretch, current stable) with PHP 7.0.

Supports PHP 7.0, 7.1 and 7.2.

### Prerequisites

```

sudo apt install composer make openssl php-curl php-zip php-xml phpunit php-cli

```

### Configuring and Installing

Before using this package, you must:

1. Configure your application in the `app/config/parameters.yml` file (you can use `app/config/parameters.yml.dist` as a template)

2. Configure SPID in the `spid_symfony` key in the `app/config/config.yml` file, you should at least adapt the base url (used in the `sp_entityid`, `sp_singlelogoutservice` and `sp_assertionconsumerservice` keys) to your needs

3. Install PHP dependencies with composer

4. Download and verify the Identity Provider (IdP) metadata files; it is advised to place them in a separate [idp_metadata/](example/idp_metadata/) directory. A convenience tool is provided for this purpose: [bin/download_idp_metadata.php](bin/download_idp_metadata.php).

5. Generate key and certificate for the Service Provider (SP).

The last three steps can be performed in an unattended fashion with:

```sh

composer install

mkdir -p example/idp_metadata

make -f ./vendor/italia/spid-php-lib/Makefile

./vendor/italia/spid-php-lib/bin/download_idp_metadata.php ./example/idp_metadata

```

**NOTE**: during testing, it is highly adviced to use the test Identity Provider [spid-testenv2](https://github.com/italia/spid-testenv2).

### Demo

  1. Execute the `php bin/console server:start` command

  2. Visit http://localhost:8000/metadata to get the SP (Service Provider) metadata, then copy these over to the IdP and register the SP

  3. Browse to the http://localhost:8000/reserved, you should see: `Authentication Required`

  4. Visit http://localhost:8000/ and click `login`

  5. Browse to the http://localhost:8000/reserved, you should see: `Really reserved stuff here !`

This screencast shows what you should see if all goes well:

![img](images/screencast.gif)

## Troubleshooting

It is advised to install a browser plugin to trace SAML messages:

- Firefox:

  - [SAML-tracer by Olav Morken, Jaime Perez](https://addons.mozilla.org/en-US/firefox/addon/saml-tracer/)

  - [SAML Message Decoder by Magnus Suther](https://addons.mozilla.org/en-US/firefox/addon/saml-message-decoder-extension/)

- Chrome/Chromium:

  - [SAML Message Decoder by Magnus Suther](https://chrome.google.com/webstore/detail/saml-message-decoder/mpabchoaimgbdbbjjieoaeiibojelbhm)

  - [SAML Chrome Panel by MLai](https://chrome.google.com/webstore/detail/saml-chrome-panel/paijfdbeoenhembfhkhllainmocckace)

  - [SAML DevTools extension by stefan.rasmusson.as](https://chrome.google.com/webstore/detail/saml-devtools-extension/jndllhgbinhiiddokbeoeepbppdnhhio)

In addition, you can use the [SAML Developer Tools](https://www.samltool.com/online_tools.php) provided by onelogin to understand what is going on

## Testing

### Unit tests

Launch unit tests with PHPunit:

```

./vendor/bin/phpunit --stderr --testdox tests

```

### Linting

This project complies with the [PSR-2: Coding Style Guide](https://www.php-fig.org/psr/psr-2/).

Lint the code with:

```

./vendor/bin/phpcs --standard=PSR2 xxx.php

```

## Contributing

For your contributions please use the [git-flow workflow](https://danielkummer.github.io/git-flow-cheatsheet/).

## See also

* [SPID page](https://developers.italia.it/it/spid) on Developers Italia

## Authors

Andrea Manzi (Comune di Firenze) and Paolo Greppi (simevo s.r.l.)

## License

Copyright (c) 2018, The respective authors

License: BSD 3-Clause, see [LICENSE](LICENSE) file.