SAML2 PHP library from SimpleSAMLphp
DO NOT USE THIS LIBRARY UNLESS YOU ARE INTIMATELY FAMILIAR WITH THE SAML2 SPECIFICATION.
If you are not familiar with the SAML2 specification and are simply looking to connect your application using SAML2, you should probably use SimpleSAMLphp.
While this library is tagged as stable it is currently not very developer friendly and it's API is likely to change significantly in the future. It is however a starting point for collaboration between parties. So let us know what you would like to see in a PHP SAML2 library.
Note that the HTTP Artifact Binding and SOAP client do not work outside of SimpleSAMLphp.
- Install with Composer, run the following command in your project:
composer require simplesamlphp/saml2
Provide the required external dependencies by extending and implementing the
SAML2_Compat_AbstractContainerthen injecting it in the ContainerSingleton (see example below).
Make sure you've read the security section below
Use at will. Example:
// Use Composers autoloading require 'vendor/autoload.php'; // Implement the Container interface (out of scope for example) require 'container.php'; SAML2_Compat_ContainerSingleton::setContainer($container); // Set up an AuthnRequest $request = new SAML2_AuthnRequest(); $request->setId($container->generateId()); $request->setIssuer('https://sp.example.edu'); $request->setDestination('https://idp.example.edu'); // Send it off using the HTTP-Redirect binding $binding = new SAML2_HTTPRedirect(); $binding->send($request);
- Should you need to create a DOMDocument instance, use the
SAML2_DOMDocumentFactoryto create DOMDocuments from either a string (
SAML2_DOMDocumentFactory::fromString($theXmlAsString)), a file (
SAML2_DOMDocumentFactory::fromFile($pathToTheFile)) or just a new instance (
SAML2_DOMDocumentFactory::create()). This in order to protect yourself against the XXE Processing Vulnerability, as well as XML Entity Expansion attacks
This library is licensed under the LGPL license version 2.1. For more details see LICENSE.