Completed
Push — master ( 4077e5...f6e610 )
by
unknown
25s
created

SAMLController::checkForReplayAttack()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 28
Code Lines 17

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 17
nc 2
nop 2
dl 0
loc 28
rs 9.7
c 0
b 0
f 0
1
<?php
2
3
namespace SilverStripe\SAML\Control;
4
5
use Exception;
6
use function gmmktime;
7
use OneLogin\Saml2\Auth;
8
use OneLogin\Saml2\Constants;
9
use OneLogin\Saml2\Utils;
10
use OneLogin\Saml2\Error;
11
use Psr\Log\LoggerInterface;
12
use SilverStripe\Core\Config\Config;
13
use SilverStripe\ORM\ValidationResult;
14
use SilverStripe\SAML\Authenticators\SAMLAuthenticator;
15
use SilverStripe\SAML\Authenticators\SAMLLoginForm;
16
use SilverStripe\SAML\Helpers\SAMLHelper;
17
use SilverStripe\Control\Controller;
18
use SilverStripe\Control\Director;
19
use SilverStripe\Control\HTTPResponse;
20
use SilverStripe\Core\Injector\Injector;
21
use SilverStripe\SAML\Model\SAMLResponse;
22
use SilverStripe\SAML\Services\SAMLConfiguration;
23
use SilverStripe\Security\IdentityStore;
24
use SilverStripe\Security\Member;
25
use SilverStripe\Security\Security;
26
use function uniqid;
27
28
/**
29
 * Class SAMLController
30
 *
31
 * This controller handles serving metadata requests for the identity provider (IdP), as well as handling the creation
32
 * of new users and logging them into SilverStripe after being authenticated at the IdP.
33
 */
34
class SAMLController extends Controller
35
{
36
    /**
37
     * @var array
38
     */
39
    private static $allowed_actions = [
40
        'index',
41
        'acs',
42
        'metadata'
43
    ];
44
45
    public function index()
46
    {
47
        return $this->redirect('/');
48
    }
49
50
    /**
51
     * Assertion Consumer Service
52
     *
53
     * The user gets sent back here after authenticating with the IdP, off-site.
54
     * The earlier redirection to the IdP can be found in the SAMLAuthenticator::authenticate.
55
     *
56
     * After this handler completes, we end up with a rudimentary Member record (which will be created on-the-fly
57
     * if not existent), with the user already logged in. Login triggers memberLoggedIn hooks, which allows
58
     * LDAP side of this module to finish off loading Member data.
59
     *
60
     * @throws Error
61
     * @throws \Psr\Container\NotFoundExceptionInterface
62
     */
63
    public function acs()
64
    {
65
        /** @var Auth $auth */
66
        $auth = Injector::inst()->get(SAMLHelper::class)->getSAMLAuth();
67
        $caughtException = null;
68
69
        // Log both errors (reported by php-saml and thrown as exception) with a common ID for later tracking
70
        $uniqueErrorId = uniqid('SAML-');
71
72
        // Force php-saml module to use the current absolute base URL (e.g. https://www.example.com/saml). This avoids
73
        // errors that we otherwise get when having a multi-directory ACS URL like /saml/acs).
74
        // See https://github.com/onelogin/php-saml/issues/249
75
        Utils::setBaseURL(Controller::join_links($auth->getSettings()->getSPData()['entityId'], 'saml'));
76
77
        // Attempt to process the SAML response. If there are errors during this, log them and redirect to the generic
78
        // error page. Note: This does not necessarily include all SAML errors (e.g. we still need to confirm if the
79
        // user is authenticated after this block
80
        try {
81
            $auth->processResponse();
82
            $error = $auth->getLastErrorReason();
83
        } catch (Exception $e) {
84
            $caughtException = $e;
85
        }
86
87
        // If there was an issue with the SAML response, if it was missing or if the SAML response indicates that they
88
        // aren't authorised, then log the issue and provide a traceable error back to the user via the login form
89
        $hasError = $caughtException || !empty($error);
90
        if ($hasError || !$auth->isAuthenticated() || $this->checkForReplayAttack($auth, $uniqueErrorId)) {
91
            if ($caughtException instanceof Exception) {
92
                $this->getLogger()->error(sprintf(
93
                    '[%s] [code: %s] %s (%s:%s)',
94
                    $uniqueErrorId,
95
                    $e->getCode(),
0 ignored issues
show
Comprehensibility Best Practice introduced by
The variable $e does not seem to be defined for all execution paths leading up to this point.
Loading history...
96
                    $e->getMessage(),
97
                    $e->getFile(),
98
                    $e->getLine()
99
                ));
100
            }
101
102
            if (!empty($error)) {
103
                $this->getLogger()->error(sprintf('[%s] %s', $uniqueErrorId, $error));
104
            }
105
106
            $this->getForm()->sessionMessage(
107
                _t(
108
                    'SilverStripe\\SAML\\Control\\SAMLController.ERR_SAML_ACS_FAILURE',
109
                    'Unfortunately we couldn\'t log you in. If this continues, please contact your I.T. department'
110
                    . ' with the following reference: {ref}',
111
                    ['ref' => $uniqueErrorId]
112
                ),
113
                ValidationResult::TYPE_ERROR
114
            );
115
116
            // Redirect the user back to the login form to display the generic error message and reference
117
            $this->getRequest()->getSession()->save($this->getRequest());
118
            return $this->redirect('Security/login');
119
        }
120
121
        /**
122
         * If processing reaches here, then the user is authenticated - the rest of this method is just processing their
123
         * legitimate information and configuring their account.
124
         */
125
126
        // If we expect the NameID to be a binary version of the GUID (ADFS), check that it actually is
127
        // If we are configured not to expect a binary NameID, then we assume it is a direct GUID (Azure AD)
128
        if (Config::inst()->get(SAMLConfiguration::class, 'expect_binary_nameid')) {
129
            $decodedNameId = base64_decode($auth->getNameId());
130
            if (ctype_print($decodedNameId)) {
131
                $this->getForm()->sessionMessage('NameID from IdP is not a binary GUID.', ValidationResult::TYPE_ERROR);
132
                $this->getRequest()->getSession()->save($this->getRequest());
133
                return $this->getRedirect();
134
            }
135
136
            // transform the NameId to guid
137
            $helper = SAMLHelper::singleton();
138
            $guid = $helper->binToStrGuid($decodedNameId);
139
            if (!$helper->validGuid($guid)) {
140
                $errorMessage = "Not a valid GUID '{$guid}' recieved from server.";
141
                $this->getLogger()->error($errorMessage);
142
                $this->getForm()->sessionMessage($errorMessage, ValidationResult::TYPE_ERROR);
143
                $this->getRequest()->getSession()->save($this->getRequest());
144
                return $this->getRedirect();
145
            }
146
        } else {
147
            $guid = $auth->getNameId();
148
        }
149
150
        $attributes = $auth->getAttributes();
151
152
        $fieldToClaimMap = array_flip(Member::config()->claims_field_mappings);
153
154
        // Write a rudimentary member with basic fields on every login, so that we at least have something
155
        // if there is no further sync (e.g. via LDAP)
156
        $member = Member::get()->filter('GUID', $guid)->limit(1)->first();
157
        if (!($member && $member->exists()) && Config::inst()->get(SAMLConfiguration::class, 'allow_insecure_email_linking') && isset($fieldToClaimMap['Email'])) {
158
            // If there is no member found via GUID and we allow linking via email, search by email
159
            $member = Member::get()->filter('Email', $attributes[$fieldToClaimMap['Email']])->limit(1)->first();
160
161
            if (!($member && $member->exists())) {
162
                $member = new Member();
163
            }
164
165
            $member->GUID = $guid;
166
        } elseif (!($member && $member->exists())) {
167
            // If the member doesn't exist and we don't allow linking via email, then create a new member
168
            $member = new Member();
169
            $member->GUID = $guid;
170
        }
171
172
        foreach ($member->config()->claims_field_mappings as $claim => $field) {
173
            if (!isset($attributes[$claim][0])) {
174
                $this->getLogger()->warning(
175
                    sprintf(
176
                        'Claim rule \'%s\' configured in SAMLMemberExtension.claims_field_mappings, ' .
177
                                'but wasn\'t passed through. Please check IdP claim rules.',
178
                        $claim
179
                    )
180
                );
181
182
                continue;
183
            }
184
185
            $member->$field = $attributes[$claim][0];
186
        }
187
188
        $member->SAMLSessionIndex = $auth->getSessionIndex();
189
190
        // This will trigger LDAP update through LDAPMemberExtension::memberLoggedIn, if the LDAP module is installed.
191
        // The LDAP update will also write the Member record a second time, but the member *must* be written before
192
        // IdentityStore->logIn() is called, otherwise the identity store throws an exception.
193
        // Both SAML and LDAP identify Members by the same GUID field.
194
        $member->write();
195
196
        /** @var IdentityStore $identityStore */
197
        $identityStore = Injector::inst()->get(IdentityStore::class);
198
        $identityStore->logIn($member, false, $this->getRequest());
199
200
        return $this->getRedirect();
201
    }
202
203
    /**
204
     * Generate this SP's metadata. This is needed for intialising the SP-IdP relationship.
205
     * IdP is instructed to call us back here to establish the relationship. IdP may also be configured
206
     * to hit this endpoint periodically during normal operation, to check the SP availability.
207
     */
208
    public function metadata()
209
    {
210
        try {
211
            /** @var Auth $auth */
212
            $auth = Injector::inst()->get(SAMLHelper::class)->getSAMLAuth();
213
            $settings = $auth->getSettings();
214
            $metadata = $settings->getSPMetadata();
215
            $errors = $settings->validateMetadata($metadata);
216
            if (empty($errors)) {
217
                header('Content-Type: text/xml');
218
                echo $metadata;
219
            } else {
220
                throw new Error(
221
                    'Invalid SP metadata: ' . implode(', ', $errors),
222
                    Error::METADATA_SP_INVALID
223
                );
224
            }
225
        } catch (Exception $e) {
226
            $this->getLogger()->error($e->getMessage());
227
            echo $e->getMessage();
228
        }
229
    }
230
231
    /**
232
     * @return HTTPResponse
233
     */
234
    protected function getRedirect()
235
    {
236
        // Absolute redirection URLs may cause spoofing
237
        if ($this->getRequest()->getSession()->get('BackURL')
238
            && Director::is_site_url($this->getRequest()->getSession()->get('BackURL'))) {
239
            return $this->redirect($this->getRequest()->getSession()->get('BackURL'));
240
        }
241
242
        // Spoofing attack, redirect to homepage instead of spoofing url
243
        if ($this->getRequest()->getSession()->get('BackURL')
244
            && !Director::is_site_url($this->getRequest()->getSession()->get('BackURL'))) {
245
            return $this->redirect(Director::absoluteBaseURL());
246
        }
247
248
        // If a default login dest has been set, redirect to that.
249
        if (Security::config()->default_login_dest) {
250
            return $this->redirect(Director::absoluteBaseURL() . Security::config()->default_login_dest);
251
        }
252
253
        // fallback to redirect back to home page
254
        return $this->redirect(Director::absoluteBaseURL());
255
    }
256
257
    /**
258
     * If processing reaches here, then the user is authenticated but potentially not valid. We first need to confirm
259
     * that they are not an attacker performing a SAML replay attack (capturing the raw traffic from a compromised
260
     * device and then re-submitting the same SAML response).
261
     *
262
     * To combat this, we store SAML response IDs for the amount of time they're valid for (plus a configurable offset
263
     * to account for potential time skew), and if the ID has been seen before we log an error message and return true
264
     * (which indicates that this specific request is a replay attack).
265
     *
266
     * If no replay attack is detected, then the SAML response is logged so that future requests can be blocked.
267
     *
268
     * @param Auth $auth The Auth object that includes the processed response
269
     * @param string $uniqueErrorId The error code to use when logging error messages for this given error
270
     * @return bool true if this response is a replay attack, false if it's the first time we've seen the ID
271
     */
272
    protected function checkForReplayAttack(Auth $auth, $uniqueErrorId = '')
273
    {
274
        $responseId = $auth->getLastMessageId();
275
        $expiry = $auth->getLastAssertionNotOnOrAfter(); // Note: Expiry will always be stored and returned in UTC
276
277
        // Search for any SAMLResponse objects where the response ID is the same and the expiry is within the range
278
        $count = SAMLResponse::get()->filter(['ResponseID' => $responseId])->count();
279
280
        if ($count > 0) {
281
            // Response found, therefore this is a replay attack - log the error and return false so the user is denied
282
            $this->getLogger()->error(sprintf(
283
                '[%s] SAML replay attack detected! Response ID "%s", expires "%s", client IP "%s"',
284
                $uniqueErrorId,
285
                $responseId,
286
                $expiry,
287
                $this->getRequest()->getIP()
288
            ));
289
290
            return true;
291
        } else {
292
            // No attack detected, log the SAML response
293
            $response = new SAMLResponse([
294
                'ResponseID' => $responseId,
295
                'Expiry' => $expiry
296
            ]);
297
298
            $response->write();
299
            return false;
300
        }
301
    }
302
303
    /**
304
     * Get a logger
305
     *
306
     * @return LoggerInterface
307
     */
308
    public function getLogger()
309
    {
310
        return Injector::inst()->get(LoggerInterface::class);
311
    }
312
313
    /**
314
     * Gets the login form
315
     *
316
     * @return SAMLLoginForm
317
     */
318
    public function getForm()
319
    {
320
        return Injector::inst()->get(SAMLLoginForm::class, true, [$this, SAMLAuthenticator::class, 'LoginForm']);
321
    }
322
}
323