Base64Trait::validBase64() - Code Metrics - Inspection of "Make class extendable" - simplesamlphp/assert - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 098479...e4440e )

by Tim

created 2025-01-08 22:27 UTC

Base64Trait::validBase64() B

↳ Parent: Base64Trait

Complexity

Conditions	7
Paths	10

Size

Total Lines	21
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	15
c	1
b	0
f	0
dl	0
loc	21
rs	8.8333
cc	7
nc	10
nop	2

<?php

declare(strict_types=1);

namespace SimpleSAML\Assert;

use InvalidArgumentException;

use function base64_decode;
use function base64_encode;
use function filter_var;
use function sprintf;
use function strlen;

/**
 * @package simplesamlphp/assert
 */
trait Base64Trait
{
    /** @var string */
    private static string $base64_regex = '/^(?:[a-z0-9+\/]{4})*(?:[a-z0-9+\/]{2}==|[a-z0-9+\/]{3}=)?$/i';


    /***********************************************************************************
     *  NOTE:  Custom assertions may be added below this line.                         *
     *         They SHOULD be marked as `protected` to ensure the call is forced       *
     *          through __callStatic().                                                *
     *         Assertions marked `public` are called directly and will                 *
     *          not handle any custom exception passed to it.                          *
     ***********************************************************************************/


    /**
     * Note: This test is not bullet-proof but prevents a string containing illegal characters
     * from being passed and ensures the string roughly follows the correct format for a Base64 encoded string
     *
     * @param string $value
     * @param string $message
     */
    protected static function validBase64(string $value, string $message = ''): void
    {
        $result = true;

        if (filter_var($value, FILTER_VALIDATE_REGEXP, ['options' => ['regexp' => self::$base64_regex]]) === false) {
            $result = false;
        } elseif (strlen($value) % 4 !== 0) {
            $result = false;
        } else {
            $decoded = base64_decode($value, true);
            if (empty($decoded)) { // Invalid _or_ empty string
                $result = false;
            } elseif (base64_encode($decoded) !== $value) {
                $result = false;
            }
        }

        if ($result === false) {
            throw new InvalidArgumentException(sprintf(
                $message ?: '\'%s\' is not a valid Base64 encoded string',
                $value,
            ));
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\Assert;
6
7			use InvalidArgumentException;
8
9			use function base64_decode;
10			use function base64_encode;
11			use function filter_var;
12			use function sprintf;
13			use function strlen;
14
15			/**
16			* @package simplesamlphp/assert
17			*/
18			trait Base64Trait
19			{
20			/** @var string */
21			private static string $base64_regex = '/^(?:[a-z0-9+\/]{4})*(?:[a-z0-9+\/]{2}==\|[a-z0-9+\/]{3}=)?$/i';
22
23
24			/***********************************************************************************
25			* NOTE: Custom assertions may be added below this line. *
26			* They SHOULD be marked as `protected` to ensure the call is forced *
27			* through __callStatic(). *
28			* Assertions marked `public` are called directly and will *
29			* not handle any custom exception passed to it. *
30			***********************************************************************************/
31
32
33			/**
34			* Note: This test is not bullet-proof but prevents a string containing illegal characters
35			* from being passed and ensures the string roughly follows the correct format for a Base64 encoded string
36			*
37			* @param string $value
38			* @param string $message
39			*/
40			protected static function validBase64(string $value, string $message = ''): void
41			{
42			$result = true;
43
44			if (filter_var($value, FILTER_VALIDATE_REGEXP, ['options' => ['regexp' => self::$base64_regex]]) === false) {
45			$result = false;
46			} elseif (strlen($value) % 4 !== 0) {
47			$result = false;
48			} else {
49			$decoded = base64_decode($value, true);
50			if (empty($decoded)) { // Invalid _or_ empty string
51			$result = false;
52			} elseif (base64_encode($decoded) !== $value) {
53			$result = false;
54			}
55			}
56
57			if ($result === false) {
58			throw new InvalidArgumentException(sprintf(
59			$message ?: '\'%s\' is not a valid Base64 encoded string',
60			$value,
61			));
62			}
63			}
64			}
65

simplesamlphp / assert

Push — master ( 098479...e4440e )

Base64Trait::validBase64() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like