Merge pull request #59 from danmichaelo/fix-doc

Minor documentation improvements, remove unused config options
aacotroneo · Jan 11, 2017 · 93d1fc4 · 93d1fc4
2 parents b491d6d + d567dd0
commit 93d1fc4
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 30 deletions.
diff --git a/src/Aacotroneo/Saml2/Http/Controllers/Saml2Controller.php b/src/Aacotroneo/Saml2/Http/Controllers/Saml2Controller.php
@@ -36,7 +36,7 @@ public function metadata()
 
     /**
      * Process an incoming saml2 assertion request.
-     * Fires 'saml2.loginRequestReceived' event if a valid user is Found
+     * Fires 'Saml2LoginEvent' event if a valid user is Found
      */
     public function acs()
     {

diff --git a/src/config/.gitkeep b/src/config/.gitkeep
diff --git a/src/config/saml2_settings.php b/src/config/saml2_settings.php
@@ -4,11 +4,19 @@
 $idp_host = 'http://localhost:8000/simplesaml';
 
 return $settings = array(
-    /*****
-     * Cosmetic settings - controller routes
-     **/
-    'useRoutes' => true, //include library routes and controllers
 
+    /**
+     * If 'useRoutes' is set to true, the package defines five new routes:
+     *
+     *    Method | URI                      | Name
+     *    -------|--------------------------|------------------
+     *    POST   | {routesPrefix}/acs       | saml_acs
+     *    GET    | {routesPrefix}/login     | saml_login
+     *    GET    | {routesPrefix}/logout    | saml_logout
+     *    GET    | {routesPrefix}/metadata  | saml_metadata
+     *    GET    | {routesPrefix}/sls       | saml_sls
+     */
+    'useRoutes' => true,
 
     'routesPrefix' => '/saml2',
 
@@ -71,28 +79,25 @@
         'x509cert' => '',
         'privateKey' => '',
 
-        //LARAVEL - You don't need to change anything else on the sp
-        // Identifier of the SP entity  (must be a URI)
-        'entityId' => '', //LARAVEL: This would be set to saml_metadata route
+        // Identifier (URI) of the SP entity.
+        // Leave blank to use the 'saml_metadata' route.
+        'entityId' => '',
+
         // Specifies info about where and how the <AuthnResponse> message MUST be
         // returned to the requester, in this case our SP.
         'assertionConsumerService' => array(
-            // URL Location where the <Response> from the IdP will be returned
-            'url' => '', //LARAVEL: This would be set to saml_acs route
-            // SAML protocol binding to be used when returning the <Response>
-            // message.  Onelogin Toolkit supports for this endpoint the
-            // HTTP-Redirect binding only
-            'binding' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST',
+            // URL Location where the <Response> from the IdP will be returned,
+            // using HTTP-POST binding.
+            // Leave blank to use the 'saml_acs' route
+            'url' => '',
         ),
         // Specifies info about where and how the <Logout Response> message MUST be
         // returned to the requester, in this case our SP.
         'singleLogoutService' => array(
-            // URL Location where the <Response> from the IdP will be returned
-            'url' => '', //LARAVEL: This would be set to saml_sls route
-            // SAML protocol binding to be used when returning the <Response>
-            // message.  Onelogin Toolkit supports for this endpoint the
-            // HTTP-Redirect binding only
-            'binding' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect',
+            // URL Location where the <Response> from the IdP will be returned,
+            // using HTTP-Redirect binding.
+            // Leave blank to use the 'saml_sls' route
+            'url' => '',
         ),
     ),
 
@@ -102,21 +107,15 @@
         'entityId' => $idp_host . '/saml2/idp/metadata.php',
         // SSO endpoint info of the IdP. (Authentication Request protocol)
         'singleSignOnService' => array(
-            // URL Target of the IdP where the SP will send the Authentication Request Message
+            // URL Target of the IdP where the SP will send the Authentication Request Message,
+            // using HTTP-Redirect binding.
             'url' => $idp_host . '/saml2/idp/SSOService.php',
-            // SAML protocol binding to be used when returning the <Response>
-            // message.  Onelogin Toolkit supports for this endpoint the
-            // HTTP-POST binding only
-            'binding' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect',
         ),
         // SLO endpoint info of the IdP.
         'singleLogoutService' => array(
-            // URL Location of the IdP where the SP will send the SLO Request
+            // URL Location of the IdP where the SP will send the SLO Request,
+            // using HTTP-Redirect binding.
             'url' => $idp_host . '/saml2/idp/SingleLogoutService.php',
-            // SAML protocol binding to be used when returning the <Response>
-            // message.  Onelogin Toolkit supports for this endpoint the
-            // HTTP-Redirect binding only
-            'binding' => 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect',
         ),
         // Public x509 certificate of the IdP
         'x509cert' => 'MIID/TCCAuWgAwIBAgIJAI4R3WyjjmB1MA0GCSqGSIb3DQEBCwUAMIGUMQswCQYDVQQGEwJBUjEVMBMGA1UECAwMQnVlbm9zIEFpcmVzMRUwEwYDVQQHDAxCdWVub3MgQWlyZXMxDDAKBgNVBAoMA1NJVTERMA8GA1UECwwIU2lzdGVtYXMxFDASBgNVBAMMC09yZy5TaXUuQ29tMSAwHgYJKoZIhvcNAQkBFhFhZG1pbmlAc2l1LmVkdS5hcjAeFw0xNDEyMDExNDM2MjVaFw0yNDExMzAxNDM2MjVaMIGUMQswCQYDVQQGEwJBUjEVMBMGA1UECAwMQnVlbm9zIEFpcmVzMRUwEwYDVQQHDAxCdWVub3MgQWlyZXMxDDAKBgNVBAoMA1NJVTERMA8GA1UECwwIU2lzdGVtYXMxFDASBgNVBAMMC09yZy5TaXUuQ29tMSAwHgYJKoZIhvcNAQkBFhFhZG1pbmlAc2l1LmVkdS5hcjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMbzW/EpEv+qqZzfT1Buwjg9nnNNVrxkCfuR9fQiQw2tSouS5X37W5h7RmchRt54wsm046PDKtbSz1NpZT2GkmHN37yALW2lY7MyVUC7itv9vDAUsFr0EfKIdCKgxCKjrzkZ5ImbNvjxf7eA77PPGJnQ/UwXY7W+cvLkirp0K5uWpDk+nac5W0JXOCFR1BpPUJRbz2jFIEHyChRt7nsJZH6ejzNqK9lABEC76htNy1Ll/D3tUoPaqo8VlKW3N3MZE0DB9O7g65DmZIIlFqkaMH3ALd8adodJtOvqfDU/A6SxuwMfwDYPjoucykGDu1etRZ7dF2gd+W+1Pn7yizPT1q8CAwEAAaNQME4wHQYDVR0OBBYEFPsn8tUHN8XXf23ig5Qro3beP8BuMB8GA1UdIwQYMBaAFPsn8tUHN8XXf23ig5Qro3beP8BuMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAGu60odWFiK+DkQekozGnlpNBQz5lQ/bwmOWdktnQj6HYXu43e7sh9oZWArLYHEOyMUekKQAxOK51vbTHzzw66BZU91/nqvaOBfkJyZKGfluHbD0/hfOl/D5kONqI9kyTu4wkLQcYGyuIi75CJs15uA03FSuULQdY/Liv+czS/XYDyvtSLnu43VuAQWN321PQNhuGueIaLJANb2C5qq5ilTBUw6PxY9Z+vtMjAjTJGKEkE/tQs7CvzLPKXX3KTD9lIILmX5yUC3dLgjVKi1KGDqNApYGOMtjr5eoxPQrqDBmyx3flcy0dQTdLXud3UjWVW3N0PYgJtw5yBsS74QTGD4=',