HMAC.php

<?php

declare(strict_types=1);

namespace SimpleSAML\XMLSecurity\Alg\Signature;

use SimpleSAML\XMLSecurity\Backend;
use SimpleSAML\XMLSecurity\Constants as C;
use SimpleSAML\XMLSecurity\Key\SymmetricKey;

/**
 * Class implementing the HMAC signature algorithm
 *
 * @package simplesamlphp/xml-security
 */
final class HMAC extends AbstractSigner implements SignatureAlgorithmInterface
{
    protected const string DEFAULT_BACKEND = Backend\HMAC::class;


    /**
     * HMAC constructor.
     *
     * @param \SimpleSAML\XMLSecurity\Key\SymmetricKey $key The symmetric key to use.
     * @param string $algId The identifier of this algorithm.
     */
    public function __construct(
        #[\SensitiveParameter]
        SymmetricKey $key,
        string $algId = C::SIG_HMAC_SHA256,
    ) {
        parent::__construct($key, $algId, C::$HMAC_DIGESTS[$algId]);
    }


    /**
     * @return string[]
     */
    public static function getSupportedAlgorithms(): array
    {
        return array_keys(C::$HMAC_DIGESTS);
    }
}