HMACOutputLengthTrait::validHMACOutputLength() - Code Metrics - Inspection of "Migrate to value types" - simplesamlphp/xml-security - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#60)

by Tim

created 2025-07-26 14:43 UTC

HMACOutputLengthTrait::validHMACOutputLength() A

↳ Parent: HMACOutputLengthTrait

Complexity

Conditions	4
Paths	3

Size

Total Lines	19
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	13
c	1
b	0
f	0
nc	3
nop	2
dl	0
loc	19
rs	9.8333

<?php

declare(strict_types=1);

namespace SimpleSAML\XMLSecurity\Assert;

use SimpleSAML\Assert\AssertionFailedException;
use SimpleSAML\XMLSchema\Exception\SchemaViolationException;
use SimpleSAML\XMLSecurity\Exception\ProtocolViolationException;

use function intval;

/**
 * @package simplesamlphp/xml-security
 */
trait HMACOutputLengthTrait
{
    /**
     * The HMAC algorithm (RFC2104 [HMAC]) takes the output (truncation) length in bits as a parameter;
     * this specification REQUIRES that the truncation length be a multiple of 8 (i.e. fall on a byte boundary)
     * because Base64 encoding operates on full bytes
     *
     * @var string
     */
    private static string $HMACOutputLength_regex = '/^([1-9]\d*)$/D';


    /**
     * @param string $value
     * @param string $message
     */
    protected static function validHMACOutputLength(string $value, string $message = ''): void
    {
        try {
            parent::regex(
                $value,
                self::$HMACOutputLength_regex,
                $message ?: '%s is not a valid ds:HMACOutputLengthType',
            );
        } catch (AssertionFailedException $e) {
            throw new SchemaViolationException($e->getMessage());
        }

        try {
            parent::true(
                intval($value) % 8 === 0,
                '%s is not devisible by 8 and therefore not a valid ds:HMACOutputLengthType',
            );
        } catch (AssertionFailedException $e) {
            throw new ProtocolViolationException($e->getMessage());
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\XMLSecurity\Assert;
6
7			use SimpleSAML\Assert\AssertionFailedException;
8			use SimpleSAML\XMLSchema\Exception\SchemaViolationException;
9			use SimpleSAML\XMLSecurity\Exception\ProtocolViolationException;
10
11			use function intval;
12
13			/**
14			* @package simplesamlphp/xml-security
15			*/
16			trait HMACOutputLengthTrait
17			{
18			/**
19			* The HMAC algorithm (RFC2104 [HMAC]) takes the output (truncation) length in bits as a parameter;
20			* this specification REQUIRES that the truncation length be a multiple of 8 (i.e. fall on a byte boundary)
21			* because Base64 encoding operates on full bytes
22			*
23			* @var string
24			*/
25			private static string $HMACOutputLength_regex = '/^([1-9]\d*)$/D';
26
27
28			/**
29			* @param string $value
30			* @param string $message
31			*/
32			protected static function validHMACOutputLength(string $value, string $message = ''): void
33			{
34			try {
35			parent::regex(
36			$value,
37			self::$HMACOutputLength_regex,
38			$message ?: '%s is not a valid ds:HMACOutputLengthType',
39			);
40			} catch (AssertionFailedException $e) {
41			throw new SchemaViolationException($e->getMessage());
42			}
43
44			try {
45			parent::true(
46			intval($value) % 8 === 0,
47			'%s is not devisible by 8 and therefore not a valid ds:HMACOutputLengthType',
48			);
49			} catch (AssertionFailedException $e) {
50			throw new ProtocolViolationException($e->getMessage());
51			}
52			}
53			}
54

simplesamlphp / xml-security

Pull Request — master (#60)

HMACOutputLengthTrait::validHMACOutputLength() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like