FIX Update to be PHP 7.2+ compatible

This involves updating the composer.json to use a newer version of the saml processing dependency, so that it no longer relies on the now removed mcrypt library that was deprecated with PHP 7.0 This also involved a minor update to convert the classes used to their new namespaces (but appear to have an otherwise unchanged public API).
silverstripe · Aug 29, 2019 · d41d27e · d41d27e
1 parent 0739855
commit d41d27e
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 27 deletions.
diff --git a/composer.json b/composer.json
@@ -16,9 +16,8 @@
         }
     ],
     "require": {
-        "php": "<7.2.0",
-        "silverstripe/framework": "^4.0",
-        "onelogin/php-saml": "~2.10"
+        "silverstripe/framework": "^4",
+        "onelogin/php-saml": "^3"
     },
     "require-dev": {
         "phpunit/phpunit": "^5.7",

diff --git a/src/RealMeService.php b/src/RealMeService.php
@@ -6,10 +6,10 @@
 use DOMNodeList;
 use Exception as BaseException;
 use InvalidArgumentException;
-use OneLogin_Saml2_Auth;
-use OneLogin_Saml2_Error;
-use OneLogin_Saml2_Response;
-use OneLogin_Saml2_Utils;
+use OneLogin\Saml2\Auth;
+use OneLogin\Saml2\Error;
+use OneLogin\Saml2\Response;
+use OneLogin\Saml2\Utils;
 use Psr\Log\LoggerInterface;
 use SilverStripe\Control\Controller;
 use SilverStripe\Control\Director;
@@ -289,7 +289,7 @@ class RealMeService implements TemplateGlobalProvider
     private static $metadata_contact_support_surname = null;
 
     /**
-     * @var OneLogin_Saml2_Auth|null Set by {@link getAuth()}, which creates an instance of OneLogin_Saml2_Auth to check
+     * @var Auth|null Set by {@link getAuth()}, which creates an instance of Auth to check
      * authentication against
      */
     private $auth = null;
@@ -416,7 +416,7 @@ public static function currentRealMeUser()
      * @param HTTPRequest $request
      * @param string $backUrl
      * @return bool|null true if the user is correctly authenticated, false if there was an error with login
-     * @throws OneLogin_Saml2_Error
+     * @throws Error
      */
     public function enforceLogin(HTTPRequest $request, $backUrl = null)
     {
@@ -479,8 +479,8 @@ private function processSamlErrors(array $errors)
         // The error message returned by onelogin/php-saml is the top-level error, but we want the actual error
         $request = Controller::curr()->getRequest();
         if ($request->isPOST() && $request->postVar("SAMLResponse")) {
-            $response = new OneLogin_Saml2_Response($this->getAuth()->getSettings(), $request->postVar("SAMLResponse"));
-            $internalError = OneLogin_Saml2_Utils::query(
+            $response = new Response($this->getAuth()->getSettings(), $request->postVar("SAMLResponse"));
+            $internalError = Utils::query(
                 $response->document,
                 "/samlp:Response/samlp:Status/samlp:StatusCode/samlp:StatusCode/@Value"
             );
@@ -516,7 +516,7 @@ public function isAuthenticated()
     /**
      * Returns a {@link RealMeUser} object if one can be built from the RealMe session data.
      *
-     * @throws OneLogin_Saml2_Error Passes on the SAML error if it's not indicating a lack of SAML response data
+     * @throws Error Passes on the SAML error if it's not indicating a lack of SAML response data
      * @throws RealMeException If identity information exists but couldn't be decoded, or doesn't exist
      * @return User|null
      */
@@ -571,10 +571,10 @@ public function getAuthData()
                 'Attributes' => $attributes,
                 'FederatedIdentity' => $federatedIdentity,
             ]);
-        } catch (OneLogin_Saml2_Error $e) {
+        } catch (Error $e) {
             // If the Exception code indicates there wasn't a response, we ignore it as it simply means the visitor
             // isn't authenticated yet. Otherwise, we re-throw the Exception
-            if ($e->getCode() === OneLogin_Saml2_Error::SAML_RESPONSE_NOT_FOUND) {
+            if ($e->getCode() === Error::SAML_RESPONSE_NOT_FOUND) {
                 return null;
             } else {
                 throw $e;
@@ -864,9 +864,9 @@ private function getRequestedAuthnContext()
     }
 
     /**
-     * Returns the internal {@link OneLogin_Saml2_Auth} object against which visitors are authenticated.
+     * Returns the internal {@link Auth} object against which visitors are authenticated.
      *
-     * @return OneLogin_Saml2_Auth
+     * @return Auth
      */
     public function getAuth(HTTPRequest $request = null)
     {
@@ -882,8 +882,8 @@ public function getAuth(HTTPRequest $request = null)
         }
 
         // Ensure onelogin is using the correct host, protocol and port incase a proxy is involved
-        OneLogin_Saml2_Utils::setSelfHost($request->getHeader('Host'));
-        OneLogin_Saml2_Utils::setSelfProtocol($request->getScheme());
+        Utils::setSelfHost($request->getHeader('Host'));
+        Utils::setSelfProtocol($request->getScheme());
 
         $port = null;
         if (isset($_SERVER['HTTP_X_FORWARDED_PORT'])) {
@@ -893,7 +893,7 @@ public function getAuth(HTTPRequest $request = null)
         }
 
         if ($port) {
-            OneLogin_Saml2_Utils::setSelfPort($port);
+            Utils::setSelfPort($port);
         }
 
         $settings = [
@@ -938,7 +938,7 @@ public function getAuth(HTTPRequest $request = null)
             ]
         ];
 
-        $this->auth = new OneLogin_Saml2_Auth($settings);
+        $this->auth = new Auth($settings);
         return $this->auth;
     }
 
@@ -1035,19 +1035,19 @@ private function getMetadataAssertionServiceDomainForEnvironment($env)
     }
 
     /**
-     * @param OneLogin_Saml2_Auth $auth
+     * @param Auth $auth
      * @return string|null null if there's no FLT, or a string if there is one
      */
-    private function retrieveFederatedLogonTag(OneLogin_Saml2_Auth $auth)
+    private function retrieveFederatedLogonTag(Auth $auth)
     {
         return null; // @todo
     }
 
     /**
-     * @param OneLogin_Saml2_Auth $auth
+     * @param Auth $auth
      * @return string|null null if there's not FIT, or a string if there is one
      */
-    private function retrieveFederatedIdentityTag(OneLogin_Saml2_Auth $auth)
+    private function retrieveFederatedIdentityTag(Auth $auth)
     {
         $fit = null;
         $attributes = $auth->getAttributes();
@@ -1060,11 +1060,11 @@ private function retrieveFederatedIdentityTag(OneLogin_Saml2_Auth $auth)
     }
 
     /**
-     * @param OneLogin_Saml2_Auth $auth
+     * @param Auth $auth
      * @return FederatedIdentity|null
      * @throws RealMeException
      */
-    private function retrieveFederatedIdentity(OneLogin_Saml2_Auth $auth)
+    private function retrieveFederatedIdentity(Auth $auth)
     {
         $federatedIdentity = null;
         $attributes = $auth->getAttributes();

diff --git a/tests/RealMeServiceTest.php b/tests/RealMeServiceTest.php
@@ -2,6 +2,7 @@
 
 namespace SilverStripe\RealMe\Tests;
 
+use OneLogin\Saml2\Auth;
 use SilverStripe\Control\NullHTTPRequest;
 use SilverStripe\Core\Config\Config;
 use SilverStripe\Core\Environment;
@@ -66,7 +67,7 @@ public function testGetCertificateContents()
     public function testGetAuth()
     {
         $auth = $this->service->getAuth(new NullHTTPRequest());
-        $this->assertTrue(get_class($auth) === 'OneLogin_Saml2_Auth');
+        $this->assertTrue(get_class($auth) === Auth::class);
 
         // Service Provider settings
         $spData = $auth->getSettings()->getSPData();