Saml2User::getTenant() - Code Metrics - Inspection of "[3.x] New major release" - 24Slides/laravel-saml2 - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#88)

by Artem

created 2024-04-13 17:29 UTC

Saml2User::getTenant() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	2
rs	10

<?php

namespace Slides\Saml2;

use OneLogin\Saml2\Auth as OneLoginAuth;
use Slides\Saml2\Contracts\IdentityProvidable;

class Saml2User
{
    /**
     * OneLogin authentication handler.
     *
     * @var OneLoginAuth
     */
    protected $auth;

    /**
     * The tenant user belongs to.
     *
     * @var IdentityProvidable
     */
    protected $idp;

    /**
     * Saml2User constructor.
     *
     * @param OneLoginAuth $auth
     * @param IdentityProvidable $idp
     */
    public function __construct(OneLoginAuth $auth, IdentityProvidable $idp)
    {
        $this->auth = $auth;
        $this->idp = $idp;
    }

    /**
     * Get the user ID retrieved from assertion processed this request.
     *
     * @return string
     */
    public function getUserId()
    {
        return $this->auth->getNameId();
    }

    /**
     * Get the attributes retrieved from assertion processed this request
     *
     * @return array
     */
    public function getAttributes()
    {
        return $this->auth->getAttributes();
    }

    /**
     * Returns the requested SAML attribute
     *
     * @param string $name The requested attribute of the user.
     *
     * @return array|null Requested SAML attribute ($name).
     */
    public function getAttribute($name)
    {
        return $this->auth->getAttribute($name);
    }

    /**
     * The attributes retrieved from assertion processed this request.
     *
     * @return array
     */
    public function getAttributesWithFriendlyName()
    {
        return $this->auth->getAttributesWithFriendlyName();
    }

    /**
     * The SAML assertion processed this request.
     *
     * @return string
     */
    public function getRawSamlAssertion()
    {
        return app('request')->input('SAMLResponse'); //just this request
        return /** @scrutinizer ignore-call */ app('request')->input('SAMLResponse'); //just this request
    }

    /**
     * Get the intended URL.
     *
     * @return mixed
     */
    public function getIntendedUrl()
    {
        $relayState = app('request')->input('RelayState');
        $relayState = /** @scrutinizer ignore-call */ app('request')->input('RelayState');

        $url = app('Illuminate\Contracts\Routing\UrlGenerator');

        if ($relayState && $url->full() != $relayState) {
            return $relayState;
        }

        return null;
    }

    /**
     * Parses a SAML property and adds this property to this user or returns the value.
     *
     * @param string $samlAttribute
     * @param string $propertyName
     *
     * @return array|null
     */
    public function parseUserAttribute($samlAttribute = null, $propertyName = null)
    {
        if (empty($samlAttribute)) {
            return null;
        }

        if (empty($propertyName)) {
            return $this->getAttribute($samlAttribute);
        }

        return $this->{$propertyName} = $this->getAttribute($samlAttribute);
    }

    /**
     * Parse the SAML attributes and add them to this user.
     *
     * @param array $attributes Array of properties which need to be parsed, like ['email' => 'urn:oid:0.9.2342.19200300.100.1.3']
     *
     * @return void
     */
    public function parseAttributes($attributes = [])
    {
        foreach ($attributes as $propertyName => $samlAttribute) {
            $this->parseUserAttribute($samlAttribute, $propertyName);
        }
    }

    /**
     * Get user's session index.
     *
     * @return null|string
     */
    public function getSessionIndex(): ?string
    {
        return $this->auth->getSessionIndex();
    }

    /**
     * Get user's name ID.
     *
     * @return string
     */
    public function getNameId(): string
    {
        return $this->auth->getNameId();
    }

    /**
     * Set a tenant
     *
     * @param IdentityProvidable $idp
     *
     * @return void
     */
    public function setIdp(IdentityProvidable $idp)
    {
        $this->idp = $idp;
    }

    /**
     * Get a resolved tenant.
     *
     * @return IdentityProvidable|null
     */
    public function getIdp()
    {
        return $this->idp;
    }
}


24Slides / laravel-saml2

Pull Request — master (#88)

Saml2User::getTenant() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like