PHPackages ingeneo/onelogin-php-saml - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Authentication & Authorization](/categories/authentication) 4. / 5. ingeneo/onelogin-php-saml ActiveLibrary[Authentication & Authorization](/categories/authentication) ingeneo/onelogin-php-saml ========================= OneLogin PHP SAML Toolkit 3.3.3(6y ago)0171MITPHPPHP >=5.4 Since Jun 5Pushed 6y agoCompare [ Source](https://github.com/MaryeinyLosadaRomero/php-saml)[ Packagist](https://packagist.org/packages/ingeneo/onelogin-php-saml)[ Docs](https://developers.onelogin.com/saml/php)[ RSS](/packages/ingeneo-onelogin-php-saml/feed)WikiDiscussions master Synced today READMEChangelog (2)Dependencies (7)Versions (51)Used By (1) OneLogin's SAML PHP Toolkit =========================== [](#onelogins-saml-php-toolkit) [![Build Status](https://camo.githubusercontent.com/e4ebdaa292e3f6a42439b7c500922fb7d011db500bfedd8d7049c193dad4c125/68747470733a2f2f6170692e7472617669732d63692e6f72672f6f6e656c6f67696e2f7068702d73616d6c2e706e673f6272616e63683d6d6173746572)](http://travis-ci.org/onelogin/php-saml) [![Coverage Status](https://camo.githubusercontent.com/59dff5179be7de8d8ab79adadd1d288edb247c21c499c090bab5895eee1ced80/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6f6e656c6f67696e2f7068702d73616d6c2f62616467652e706e67)](https://coveralls.io/r/onelogin/php-saml) [![License](https://camo.githubusercontent.com/60096986c5ca8b0c33cb85822de1d690b8e34516d010a8bef1919000beb82b71/68747470733a2f2f706f7365722e707567782e6f72672f6f6e656c6f67696e2f7068702d73616d6c2f6c6963656e73652e706e67)](https://packagist.org/packages/onelogin/php-saml) Add SAML support to your PHP software using this library. Forget those complicated libraries and use this open source library provided and supported by OneLogin Inc. **The 3.X branch is compatible with PHP > 7.1, so if you are using that PHP version, use it and not the 2.X or the master branch** Warning ------- [](#warning) Version 2.17.0 sets strict mode active by default Update php-saml to 2.15.0, this version includes a security patch related to XEE attacks php-saml is not affected by [201803-01](https://simplesamlphp.org/security/201803-01) Update php-saml to 2.10.4, this version includes a security patch related to [signature validations on LogoutRequests/LogoutResponses](https://github.com/onelogin/php-saml/commit/949359f5cad5e1d085c4e5447d9aa8f49a6e82a1) Update php-saml to 2.10.0, this version includes a security patch that contains extra validations that will prevent signature wrapping attacks. [CVE-2016-1000253](https://github.com/distributedweaknessfiling/DWF-Database-Artifacts/blob/ab8ae6e845eb506fbeb10a7e4ccb379f0b4222ca/DWF/2016/1000253/CVE-2016-1000253.json) php-saml < v2.10.0 is vulnerable and allows signature wrapping! Security Guidelines ------------------- [](#security-guidelines) If you believe you have discovered a security vulnerability in this toolkit, please report it at with a description. We follow responsible disclosure guidelines, and will work with you to quickly find a resolution. Why add SAML support to my software? ------------------------------------ [](#why-add-saml-support-to-my-software) SAML is an XML-based standard for web browser single sign-on and is defined by the OASIS Security Services Technical Committee. The standard has been around since 2002, but lately it is becoming popular due its advantages: - **Usability** - One-click access from portals or intranets, deep linking, password elimination and automatically renewing sessions make life easier for the user. - **Security** - Based on strong digital signatures for authentication and integrity, SAML is a secure single sign-on protocol that the largest and most security conscious enterprises in the world rely on. - **Speed** - SAML is fast. One browser redirect is all it takes to securely sign a user into an application. - **Phishing Prevention** - If you don’t have a password for an app, you can’t be tricked into entering it on a fake login page. - **IT Friendly** - SAML simplifies life for IT because it centralizes authentication, provides greater visibility and makes directory integration easier. - **Opportunity** - B2B cloud vendor should support SAML to facilitate the integration of their product. General description ------------------- [](#general-description) OneLogin's SAML PHP toolkit let you build a SP (Service Provider) over your PHP application and connect it to any IdP (Identity Provider). Supports: - SSO and SLO (SP-Initiated and IdP-Initiated). - Assertion and nameId encryption. - Assertion signature. - Message signature: AuthNRequest, LogoutRequest, LogoutResponses. - Enable an Assertion Consumer Service endpoint. - Enable a Single Logout Service endpoint. - Publish the SP metadata (which can be signed). Key features: - **saml2int** - Implements the SAML 2.0 Web Browser SSO Profile. - **Session-less** - Forget those common conflicts between the SP and the final app, the toolkit delegate session in the final app. - **Easy to use** - Programmer will be allowed to code high-level and low-level programming, 2 easy to use APIs are available. - **Tested** - Thoroughly tested. - **Popular** - OneLogin's customers use it. Many PHP SAML plugins uses it. Integrate your PHP toolkit at OneLogin using this guide: Installation ------------ [](#installation) ### Dependencies [](#dependencies) - `php >= 5.3.3` and some core extensions like `php-xml`, `php-date`, `php-zlib`. - `openssl`. Install the openssl library. It handles x509 certificates. - `mcrypt`. Install that library and its php driver if you're going to handle encrypted data (`nameID`, `assertions`). - `gettext`. Install that library and its php driver. It handles translations. - `curl`. Install that library and its php driver if you plan to use the IdP Metadata parser. Since [PHP 5.3 is officially unsupported](http://php.net/eol.php) we recommend you to use a newer PHP version. ### Code [](#code) #### Option 1. Download from github [](#option-1-download-from-github) The toolkit is hosted on github. You can download it from: - Latest release: - Master repo: Copy the core of the library inside the php application. (each application has its structure so take your time to locate the PHP SAML toolkit in the best place). See the "Guide to add SAML support to my app" to know how. #### Option 2. Composer [](#option-2-composer) The toolkit supports [composer](https://getcomposer.org/). You can find the `onelogin/php-saml` package at In order to import the saml toolkit to your current php project, execute ``` composer require onelogin/php-saml ``` After installation has completed you will find at the `vendor/` folder a new folder named `onelogin` and inside the `php-saml`. Make sure you are including the autoloader provided by composer. It can be found at `vendor/autoload.php`. **Important** In this option, the x509 certs must be stored at `vendor/onelogin/php-saml/certs`and settings file stored at `vendor/onelogin/php-saml`. Your settings are at risk of being deleted when updating packages using `composer update` or similar commands. So it is **highly** recommended that instead of using settings files, you pass the settings as an array directly to the constructor (explained later in this document). If you do not use this approach your settings are at risk of being deleted when updating packages using `composer update` or similar commands. Compatibility ------------- [](#compatibility) This 2.0 version has a new library. The toolkit is still compatible. The old code that you used in order to add SAML support will continue working with minor changes. You only need to load the files of the `lib/Saml` folder. (notice that the `compatibility.php` file do that). The old-demo folder contains code from an old app that uses the old version of the toolkit (v.1). Take a look. Sometimes the names of the classes of the old code could be a bit different and if that is your case you must change them for `OneLogin_Saml_Settings`, `OneLogin_Saml_Response`, `OneLogin_Saml_AuthRequest` or `OneLogin_Saml_Metadata`. We recommend that you migrate the old code to the new one to be able to use the new features that the new library Saml2 carries. Namespaces ---------- [](#namespaces) If you are using the library with a framework like Symfony that contains namespaces, remember that calls to the class must be done by adding a backslash (`\`) to the start, for example to use the static method getSelfURLNoQuery use: ``` \OneLogin_Saml2_Utils::getSelfURLNoQuery() ``` Security warning ---------------- [](#security-warning) In production, the `strict` parameter **MUST** be set as `"true"` and the `signatureAlgorithm` and `digestAlgorithm` under `security` must be set to something other than SHA1 (see ). Otherwise your environment is not secure and will be exposed to attacks. In production also we highly recommended to register on the settings the IdP certificate instead of using the fingerprint method. The fingerprint, is a hash, so at the end is open to a collision attack that can end on a signature validation bypass. Other SAML toolkits deprecated that mechanism, we maintain it for compatibility and also to be used on test environment. Getting started --------------- [](#getting-started) ### Knowing the toolkit [](#knowing-the-toolkit) The new OneLogin SAML Toolkit contains different folders (`certs`, `endpoints`, `extlib`, `lib`, `demo`, etc.) and some files. Let's start describing the folders: #### `certs/` [](#certs) SAML requires a x509 cert to sign and encrypt elements like `NameID`, `Message`, `Assertion`, `Metadata`. If our environment requires sign or encrypt support, this folder may contain the x509 cert and the private key that the SP will use: - `sp.crt` - The public cert of the SP - `sp.key` - The private key of the SP Or also we can provide those data in the setting file at the `$settings['sp']['x509cert']`and the `$settings['sp']['privateKey']`. Sometimes we could need a signature on the metadata published by the SP, in this case we could use the x509 cert previously mentioned or use a new x509 cert: `metadata.crt` and `metadata.key`. Use `sp_new.crt` if you are in a key rollover process and you want to publish that x509 certificate on Service Provider metadata. #### `extlib/` [](#extlib) This folder contains the 3rd party libraries that the toolkit uses. At the moment only uses the `xmlseclibs` (author Robert Richards, BSD Licensed) which handle the sign and the encryption of xml elements. #### `lib/` [](#lib) This folder contains the heart of the toolkit, the libraries: - `Saml` folder contains a modified version of the toolkit v.1 and allows the old code to keep working. (This library is provided to maintain backward compatibility). - `Saml2` folder contains the new version of the classes and methods that are described in a later section. #### `doc/` [](#doc) This folder contains the API documentation of the toolkit. #### `endpoints/` [](#endpoints) The toolkit has three endpoints: - `metadata.php` - Where the metadata of the SP is published. - `acs.php` - Assertion Consumer Service. Processes the SAML Responses. - `sls.php` - Single Logout Service. Processes Logout Requests and Logout Responses. You can use the files provided by the toolkit or create your own endpoints files when adding SAML support to your applications. Take in mind that those endpoints files uses the setting file of the toolkit's base folder. #### `locale/` [](#locale) Locale folder contains some translations: `en_US` and `es_ES` as a proof of concept. Currently there are no translations but we will eventually localize the messages and support multiple languages. #### Other important files [](#other-important-files) - `settings_example.php` - A template to be used in order to create a settings.php file which contains the basic configuration info of the toolkit. - `advanced_settings_example.php` - A template to be used in order to create a advanced\_settings.php file which contains extra configuration info related to the security, the contact person, and the organization associated to the SP. - `_toolkit_loader.php` - This file load the toolkit libraries (The SAML2 lib). - `compatibility` - Import that file to make compatible your old code with the new toolkit (loads the SAML library). #### Miscellaneous [](#miscellaneous) - `tests/` - Contains the unit test of the toolkit. - `demo1/` - Contains an example of a simple PHP app with SAML support. Read the `Readme.txt` inside for more info. - `demo2/` - Contains another example. - `demo-old/` - Contains an example that uses the code of the older version of the the toolkit to demonstrate the backwards compatibility. ### How it works [](#how-it-works) #### Settings [](#settings) First of all we need to configure the toolkit. The SP's info, the IdP's info, and in some cases, configure advanced security issues like signatures and encryption. There are two ways to provide the settings information: - Use a `settings.php` file that we should locate at the base folder of the toolkit. - Use an array with the setting data and provide it directly to the constructor of the class. There is a template file, `settings_example.php`, so you can make a copy of this file, rename and edit it. ```