Collaboration diagram for RobRichards\XMLSecLibs\XMLSecurityKey:

Public Member Functions
	__construct ($type, $params=null)

	getSymmetricKeySize ()
	Retrieve the key size for the symmetric encryption algorithm. More...

	generateSessionKey ()
	Generates a session key using the openssl-extension. More...

	loadKey ($key, $isFile=false, $isCert=false)
	Loads the given key, or - with isFile set true - the key from the keyfile. More...

	encryptData ($data)
	Encrypts the given data (string) using the regarding php-extension, depending on the library assigned to algorithm in the contructor. More...

	decryptData ($data)
	Decrypts the given data (string) using the regarding php-extension, depending on the library assigned to algorithm in the contructor. More...

	signData ($data)
	Signs the data (string) using the extension assigned to the type in the constructor. More...

	verifySignature ($data, $signature)
	Verifies the data (string) against the given signature using the extension assigned to the type in the constructor. More...

	getAlgorith ()

	getAlgorithm ()

	serializeKey ($parent)

	getX509Certificate ()
	Retrieve the X509 certificate this key represents. More...

	getX509Thumbprint ()
	Get the thumbprint of this X509 certificate. More...

Static Public Member Functions
static	getRawThumbprint ($cert)
	Get the raw thumbprint of a certificate. More...

static	makeAsnSegment ($type, $string)

static	convertRSA ($modulus, $exponent)
	Hint: Modulus and Exponent must already be base64 decoded. More...

static	fromEncryptedKeyElement (DOMElement $element)
	Create key from an EncryptedKey-element. More...

Data Fields
const	TRIPLEDES_CBC = 'http://www.w3.org/2001/04/xmlenc#tripledes-cbc'

const	AES128_CBC = 'http://www.w3.org/2001/04/xmlenc#aes128-cbc'

const	AES192_CBC = 'http://www.w3.org/2001/04/xmlenc#aes192-cbc'

const	AES256_CBC = 'http://www.w3.org/2001/04/xmlenc#aes256-cbc'

const	RSA_1_5 = 'http://www.w3.org/2001/04/xmlenc#rsa-1_5'

const	RSA_OAEP_MGF1P = 'http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p'

const	DSA_SHA1 = 'http://www.w3.org/2000/09/xmldsig#dsa-sha1'

const	RSA_SHA1 = 'http://www.w3.org/2000/09/xmldsig#rsa-sha1'

const	RSA_SHA256 = 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256'

const	RSA_SHA384 = 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha384'

const	RSA_SHA512 = 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha512'

const	HMAC_SHA1 = 'http://www.w3.org/2000/09/xmldsig#hmac-sha1'

	$type = 0

	$key = null

	$passphrase = ""

	$iv = null

	$name = null

	$keyChain = null

	$isEncrypted = false

	$encryptedCtx = null

	$guid = null

Private Member Functions
	padISO10126 ($data, $blockSize)
	ISO 10126 Padding. More...

	unpadISO10126 ($data)
	Remove ISO 10126 Padding. More...

	encryptSymmetric ($data)
	Encrypts the given data (string) using the openssl-extension. More...

	decryptSymmetric ($data)
	Decrypts the given data (string) using the openssl-extension. More...

	encryptPublic ($data)
	Encrypts the given public data (string) using the openssl-extension. More...

	decryptPublic ($data)
	Decrypts the given public data (string) using the openssl-extension. More...

	encryptPrivate ($data)
	Encrypts the given private data (string) using the openssl-extension. More...

	decryptPrivate ($data)
	Decrypts the given private data (string) using the openssl-extension. More...

	signOpenSSL ($data)
	Signs the given data (string) using the openssl-extension. More...

	verifyOpenSSL ($data, $signature)
	Verifies the given data (string) belonging to the given signature using the openssl-extension. More...

Private Attributes
	$cryptParams = array()

	$x509Certificate = null

	$X509Thumbprint = null

Detailed Description

xmlseclibs.php

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Robert Richards nor the names of his contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Author: Robert Richards rrich.nosp@m.ards.nosp@m.@cdat.nosp@m.azon.nosp@m.e.org

Copyright: 2007-2019 Robert Richards rrich.nosp@m.ards.nosp@m.@cdat.nosp@m.azon.nosp@m.e.org @license http://www.opensource.org/licenses/bsd-license.php BSD License

Definition at line 47 of file XMLSecurityKey.php.

Constructor & Destructor Documentation

◆ __construct()

RobRichards\XMLSecLibs\XMLSecurityKey::__construct	(	$type,
		$params = `null`
	)

Parameters

string	$type
null \| array	$params

Exceptions

Exception

Definition at line 110 of file XMLSecurityKey.php.

    {
        switch ($type) {
            case (self::TRIPLEDES_CBC):
                $this->cryptParams['library'] = 'openssl';
                $this->cryptParams['cipher'] = 'des-ede3-cbc';
                $this->cryptParams['type'] = 'symmetric';
                $this->cryptParams['method'] = 'http://www.w3.org/2001/04/xmlenc#tripledes-cbc';
                $this->cryptParams['keysize'] = 24;
                $this->cryptParams['blocksize'] = 8;
                break;
            case (self::AES128_CBC):
                $this->cryptParams['library'] = 'openssl';
                $this->cryptParams['cipher'] = 'aes-128-cbc';
                $this->cryptParams['type'] = 'symmetric';
                $this->cryptParams['method'] = 'http://www.w3.org/2001/04/xmlenc#aes128-cbc';
                $this->cryptParams['keysize'] = 16;
                $this->cryptParams['blocksize'] = 16;
                break;
            case (self::AES192_CBC):
                $this->cryptParams['library'] = 'openssl';
                $this->cryptParams['cipher'] = 'aes-192-cbc';
                $this->cryptParams['type'] = 'symmetric';
                $this->cryptParams['method'] = 'http://www.w3.org/2001/04/xmlenc#aes192-cbc';
                $this->cryptParams['keysize'] = 24;
                $this->cryptParams['blocksize'] = 16;
                break;
            case (self::AES256_CBC):
                $this->cryptParams['library'] = 'openssl';
                $this->cryptParams['cipher'] = 'aes-256-cbc';
                $this->cryptParams['type'] = 'symmetric';
                $this->cryptParams['method'] = 'http://www.w3.org/2001/04/xmlenc#aes256-cbc';
                $this->cryptParams['keysize'] = 32;
                $this->cryptParams['blocksize'] = 16;
                break;
            case (self::RSA_1_5):
                $this->cryptParams['library'] = 'openssl';
                $this->cryptParams['padding'] = OPENSSL_PKCS1_PADDING;
                $this->cryptParams['method'] = 'http://www.w3.org/2001/04/xmlenc#rsa-1_5';
                if (is_array($params) && ! empty($params['type'])) {
                    if ($params['type'] == 'public' || $params['type'] == 'private') {
                        $this->cryptParams['type'] = $params['type'];
                        break;
                    }
                }
                throw new Exception('Certificate "type" (private/public) must be passed via parameters');
            case (self::RSA_OAEP_MGF1P):
                $this->cryptParams['library'] = 'openssl';
                $this->cryptParams['padding'] = OPENSSL_PKCS1_OAEP_PADDING;
                $this->cryptParams['method'] = 'http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p';
                $this->cryptParams['hash'] = null;
                if (is_array($params) && ! empty($params['type'])) {
                    if ($params['type'] == 'public' || $params['type'] == 'private') {
                        $this->cryptParams['type'] = $params['type'];
                        break;
                    }
                }
                throw new Exception('Certificate "type" (private/public) must be passed via parameters');
            case (self::RSA_SHA1):
                $this->cryptParams['library'] = 'openssl';
                $this->cryptParams['method'] = 'http://www.w3.org/2000/09/xmldsig#rsa-sha1';
                $this->cryptParams['padding'] = OPENSSL_PKCS1_PADDING;
                if (is_array($params) && ! empty($params['type'])) {
                    if ($params['type'] == 'public' || $params['type'] == 'private') {
                        $this->cryptParams['type'] = $params['type'];
                        break;
                    }
                }
                throw new Exception('Certificate "type" (private/public) must be passed via parameters');
            case (self::RSA_SHA256):
                $this->cryptParams['library'] = 'openssl';
                $this->cryptParams['method'] = 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256';
                $this->cryptParams['padding'] = OPENSSL_PKCS1_PADDING;
                $this->cryptParams['digest'] = 'SHA256';
                if (is_array($params) && ! empty($params['type'])) {
                    if ($params['type'] == 'public' || $params['type'] == 'private') {
                        $this->cryptParams['type'] = $params['type'];
                        break;
                    }
                }
                throw new Exception('Certificate "type" (private/public) must be passed via parameters');
            case (self::RSA_SHA384):
                $this->cryptParams['library'] = 'openssl';
                $this->cryptParams['method'] = 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha384';
                $this->cryptParams['padding'] = OPENSSL_PKCS1_PADDING;
                $this->cryptParams['digest'] = 'SHA384';
                if (is_array($params) && ! empty($params['type'])) {
                    if ($params['type'] == 'public' || $params['type'] == 'private') {
                        $this->cryptParams['type'] = $params['type'];
                        break;
                    }
                }
                throw new Exception('Certificate "type" (private/public) must be passed via parameters');
            case (self::RSA_SHA512):
                $this->cryptParams['library'] = 'openssl';
                $this->cryptParams['method'] = 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha512';
                $this->cryptParams['padding'] = OPENSSL_PKCS1_PADDING;
                $this->cryptParams['digest'] = 'SHA512';
                if (is_array($params) && ! empty($params['type'])) {
                    if ($params['type'] == 'public' || $params['type'] == 'private') {
                        $this->cryptParams['type'] = $params['type'];
                        break;
                    }
                }
                throw new Exception('Certificate "type" (private/public) must be passed via parameters');
            case (self::HMAC_SHA1):
                $this->cryptParams['library'] = $type;
                $this->cryptParams['method'] = 'http://www.w3.org/2000/09/xmldsig#hmac-sha1';
                break;
            default:
                throw new Exception('Invalid Key Type');
        }
        $this->type = $type;
    }

References $params, and RobRichards\XMLSecLibs\XMLSecurityKey\$type.

Member Function Documentation

◆ convertRSA()

static RobRichards\XMLSecLibs\XMLSecurityKey::convertRSA	(	$modulus,
		$exponent
	)

static

Hint: Modulus and Exponent must already be base64 decoded.

Parameters

string	$modulus
string	$exponent

Returns: string

Definition at line 670 of file XMLSecurityKey.php.

    {
        /* make an ASN publicKeyInfo */
        $exponentEncoding = self::makeAsnSegment(0x02, $exponent);
        $modulusEncoding = self::makeAsnSegment(0x02, $modulus);
        $sequenceEncoding = self::makeAsnSegment(0x30, $modulusEncoding.$exponentEncoding);
        $bitstringEncoding = self::makeAsnSegment(0x03, $sequenceEncoding);
        $rsaAlgorithmIdentifier = pack("H*", "300D06092A864886F70D0101010500");
        $publicKeyInfo = self::makeAsnSegment(0x30, $rsaAlgorithmIdentifier.$bitstringEncoding);
 
        /* encode the publicKeyInfo in base64 and add PEM brackets */
        $publicKeyInfoBase64 = base64_encode($publicKeyInfo);
        $encoding = "-----BEGIN PUBLIC KEY-----\n";
        $offset = 0;
        while ($segment = substr($publicKeyInfoBase64, $offset, 64)) {
            $encoding = $encoding.$segment."\n";
            $offset += 64;
        }
        return $encoding."-----END PUBLIC KEY-----\n";
    }

References RobRichards\XMLSecLibs\XMLSecurityKey\makeAsnSegment().

Referenced by RobRichards\XMLSecLibs\XMLSecEnc\staticLocateKeyInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ decryptData()

RobRichards\XMLSecLibs\XMLSecurityKey::decryptData ( $data )

Decrypts the given data (string) using the regarding php-extension, depending on the library assigned to algorithm in the contructor.

Parameters

string $data

Returns: mixed|string

Definition at line 556 of file XMLSecurityKey.php.

    {
        if ($this->cryptParams['library'] === 'openssl') {
            switch ($this->cryptParams['type']) {
                case 'symmetric':
                    return $this->decryptSymmetric($data);
                case 'public':
                    return $this->decryptPublic($data);
                case 'private':
                    return $this->decryptPrivate($data);
            }
        }
    }

References $data, RobRichards\XMLSecLibs\XMLSecurityKey\decryptPrivate(), RobRichards\XMLSecLibs\XMLSecurityKey\decryptPublic(), and RobRichards\XMLSecLibs\XMLSecurityKey\decryptSymmetric().

Here is the call graph for this function:

◆ decryptPrivate()

RobRichards\XMLSecLibs\XMLSecurityKey::decryptPrivate ( $data )

private

Decrypts the given private data (string) using the openssl-extension.

Parameters

string $data

Returns: string

Exceptions

Exception

Definition at line 478 of file XMLSecurityKey.php.

    {
        if (! openssl_private_decrypt($data, $decrypted, $this->key, $this->cryptParams['padding'])) {
            throw new Exception('Failure decrypting Data (openssl private) - ' . openssl_error_string());
        }
        return $decrypted;
    }

References $data.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\decryptData().

Here is the caller graph for this function:

◆ decryptPublic()

RobRichards\XMLSecLibs\XMLSecurityKey::decryptPublic ( $data )

private

Decrypts the given public data (string) using the openssl-extension.

Parameters

string $data

Returns: string

Exceptions

Exception

Definition at line 448 of file XMLSecurityKey.php.

    {
        if (! openssl_public_decrypt($data, $decrypted, $this->key, $this->cryptParams['padding'])) {
            throw new Exception('Failure decrypting Data (openssl public) - ' . openssl_error_string());
        }
        return $decrypted;
    }

References $data.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\decryptData().

Here is the caller graph for this function:

◆ decryptSymmetric()

RobRichards\XMLSecLibs\XMLSecurityKey::decryptSymmetric ( $data )

private

Decrypts the given data (string) using the openssl-extension.

Parameters

string $data

Returns: string

Definition at line 414 of file XMLSecurityKey.php.

    {
        $iv_length = openssl_cipher_iv_length($this->cryptParams['cipher']);
        $this->iv = substr($data, 0, $iv_length);
        $data = substr($data, $iv_length);
        $decrypted = openssl_decrypt($data, $this->cryptParams['cipher'], $this->key, OPENSSL_RAW_DATA | OPENSSL_ZERO_PADDING, $this->iv);
        if (false === $decrypted) {
            throw new Exception('Failure decrypting Data (openssl symmetric) - ' . openssl_error_string());
        }
        return $this->unpadISO10126($decrypted);
    }

References $data, and RobRichards\XMLSecLibs\XMLSecurityKey\unpadISO10126().

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\decryptData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ encryptData()

RobRichards\XMLSecLibs\XMLSecurityKey::encryptData ( $data )

Encrypts the given data (string) using the regarding php-extension, depending on the library assigned to algorithm in the contructor.

Parameters

string $data

Returns: mixed|string

Definition at line 536 of file XMLSecurityKey.php.

    {
        if ($this->cryptParams['library'] === 'openssl') {
            switch ($this->cryptParams['type']) {
                case 'symmetric':
                    return $this->encryptSymmetric($data);
                case 'public':
                    return $this->encryptPublic($data);
                case 'private':
                    return $this->encryptPrivate($data);
            }
        }
    }

References $data, RobRichards\XMLSecLibs\XMLSecurityKey\encryptPrivate(), RobRichards\XMLSecLibs\XMLSecurityKey\encryptPublic(), and RobRichards\XMLSecLibs\XMLSecurityKey\encryptSymmetric().

Here is the call graph for this function:

◆ encryptPrivate()

RobRichards\XMLSecLibs\XMLSecurityKey::encryptPrivate ( $data )

private

Encrypts the given private data (string) using the openssl-extension.

Parameters

string $data

Returns: string

Exceptions

Exception

Definition at line 463 of file XMLSecurityKey.php.

    {
        if (! openssl_private_encrypt($data, $encrypted, $this->key, $this->cryptParams['padding'])) {
            throw new Exception('Failure encrypting Data (openssl private) - ' . openssl_error_string());
        }
        return $encrypted;
    }

References $data.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\encryptData().

Here is the caller graph for this function:

◆ encryptPublic()

RobRichards\XMLSecLibs\XMLSecurityKey::encryptPublic ( $data )

private

Encrypts the given public data (string) using the openssl-extension.

Parameters

string $data

Returns: string

Exceptions

Exception

Definition at line 433 of file XMLSecurityKey.php.

    {
        if (! openssl_public_encrypt($data, $encrypted, $this->key, $this->cryptParams['padding'])) {
            throw new Exception('Failure encrypting Data (openssl public) - ' . openssl_error_string());
        }
        return $encrypted;
    }

References $data.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\encryptData().

Here is the caller graph for this function:

◆ encryptSymmetric()

RobRichards\XMLSecLibs\XMLSecurityKey::encryptSymmetric ( $data )

private

Encrypts the given data (string) using the openssl-extension.

Parameters

string $data

Returns: string

Definition at line 397 of file XMLSecurityKey.php.

    {
        $this->iv = openssl_random_pseudo_bytes(openssl_cipher_iv_length($this->cryptParams['cipher']));
        $data = $this->padISO10126($data, $this->cryptParams['blocksize']);
        $encrypted = openssl_encrypt($data, $this->cryptParams['cipher'], $this->key, OPENSSL_RAW_DATA | OPENSSL_ZERO_PADDING, $this->iv);
        if (false === $encrypted) {
            throw new Exception('Failure encrypting Data (openssl symmetric) - ' . openssl_error_string());
        }
        return $this->iv . $encrypted;
    }

References $data, and RobRichards\XMLSecLibs\XMLSecurityKey\padISO10126().

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\encryptData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromEncryptedKeyElement()

static RobRichards\XMLSecLibs\XMLSecurityKey::fromEncryptedKeyElement ( DOMElement $element )

static

Create key from an EncryptedKey-element.

Parameters

DOMElement $element The EncryptedKey-element.

Exceptions

Exception

Returns: XMLSecurityKey The new key.

Definition at line 735 of file XMLSecurityKey.php.

    {
 
        $objenc = new XMLSecEnc();
        $objenc->setNode($element);
        if (! $objKey = $objenc->locateKey()) {
            throw new Exception("Unable to locate algorithm for this Encrypted Key");
        }
        $objKey->isEncrypted = true;
        $objKey->encryptedCtx = $objenc;
        XMLSecEnc::staticLocateKeyInfo($objKey, $element);
        return $objKey;
    }

References RobRichards\XMLSecLibs\XMLSecEnc\staticLocateKeyInfo().

Referenced by RobRichards\XMLSecLibs\XMLSecEnc\staticLocateKeyInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateSessionKey()

RobRichards\XMLSecLibs\XMLSecurityKey::generateSessionKey ( )

Generates a session key using the openssl-extension.

In case of using DES3-CBC the key is checked for a proper parity bits set.

Returns: string

Exceptions

Exception

Definition at line 247 of file XMLSecurityKey.php.

    {
        if (!isset($this->cryptParams['keysize'])) {
            throw new Exception('Unknown key size for type "' . $this->type . '".');
        }
        $keysize = $this->cryptParams['keysize'];
        
        $key = openssl_random_pseudo_bytes($keysize);
        
        if ($this->type === self::TRIPLEDES_CBC) {
            /* Make sure that the generated key has the proper parity bits set.
             * Mcrypt doesn't care about the parity bits, but others may care.
            */
            for ($i = 0; $i < strlen($key); $i++) {
                $byte = ord($key[$i]) & 0xfe;
                $parity = 1;
                for ($j = 1; $j < 8; $j++) {
                    $parity ^= ($byte >> $j) & 1;
                }
                $byte |= $parity;
                $key[$i] = chr($byte);
            }
        }
        
        $this->key = $key;
        return $key;
    }

References $i, and RobRichards\XMLSecLibs\XMLSecurityKey\$key.

◆ getAlgorith()

RobRichards\XMLSecLibs\XMLSecurityKey::getAlgorith ( )

Deprecated:

See also: getAlgorithm()

Returns: mixed

Definition at line 618 of file XMLSecurityKey.php.

    {
        return $this->getAlgorithm();
    }

References RobRichards\XMLSecLibs\XMLSecurityKey\getAlgorithm().

Here is the call graph for this function:

◆ getAlgorithm()

RobRichards\XMLSecLibs\XMLSecurityKey::getAlgorithm ( )

Returns: mixed

Definition at line 626 of file XMLSecurityKey.php.

    {
        return $this->cryptParams['method'];
    }

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\getAlgorith().

Here is the caller graph for this function:

◆ getRawThumbprint()

static RobRichards\XMLSecLibs\XMLSecurityKey::getRawThumbprint ( $cert )

static

Get the raw thumbprint of a certificate.

Parameters

string $cert

Returns: null|string

Definition at line 281 of file XMLSecurityKey.php.

    {
 
        $arCert = explode("\n", $cert);
        $data = '';
        $inData = false;
 
        foreach ($arCert AS $curData) {
            if (! $inData) {
                if (strncmp($curData, '-----BEGIN CERTIFICATE', 22) == 0) {
                    $inData = true;
                }
            } else {
                if (strncmp($curData, '-----END CERTIFICATE', 20) == 0) {
                    break;
                }
                $data .= trim($curData);
            }
        }
 
        if (! empty($data)) {
            return strtolower(sha1(base64_decode($data)));
        }
 
        return null;
    }

References $data.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\loadKey().

Here is the caller graph for this function:

◆ getSymmetricKeySize()

RobRichards\XMLSecLibs\XMLSecurityKey::getSymmetricKeySize ( )

Retrieve the key size for the symmetric encryption algorithm.

If the key size is unknown, or this isn't a symmetric encryption algorithm, null is returned.

Returns: int|null The number of bytes in the key.

Definition at line 233 of file XMLSecurityKey.php.

    {
        if (! isset($this->cryptParams['keysize'])) {
            return null;
        }
        return $this->cryptParams['keysize'];
    }

◆ getX509Certificate()

RobRichards\XMLSecLibs\XMLSecurityKey::getX509Certificate ( )

Retrieve the X509 certificate this key represents.

Will return the X509 certificate in PEM-format if this key represents an X509 certificate.

Returns: string The X509 certificate or null if this key doesn't represent an X509-certificate.

Definition at line 707 of file XMLSecurityKey.php.

    {
        return $this->x509Certificate;
    }

References RobRichards\XMLSecLibs\XMLSecurityKey\$x509Certificate.

◆ getX509Thumbprint()

RobRichards\XMLSecLibs\XMLSecurityKey::getX509Thumbprint ( )

Get the thumbprint of this X509 certificate.

Returns: The thumbprint as a lowercase 40-character hexadecimal number, or null if this isn't a X509 certificate.

Returns: string Lowercase 40-character hexadecimal number of thumbprint

Definition at line 721 of file XMLSecurityKey.php.

    {
        return $this->X509Thumbprint;
    }

References RobRichards\XMLSecLibs\XMLSecurityKey\$X509Thumbprint.

◆ loadKey()

RobRichards\XMLSecLibs\XMLSecurityKey::loadKey	(	$key,
		$isFile = `false`,
		$isCert = `false`
	)

Loads the given key, or - with isFile set true - the key from the keyfile.

Parameters

string	$key
bool	$isFile
bool	$isCert

Exceptions

Exception

Definition at line 316 of file XMLSecurityKey.php.

    {
        if ($isFile) {
            $this->key = file_get_contents($key);
        } else {
            $this->key = $key;
        }
        if ($isCert) {
            $this->key = openssl_x509_read($this->key);
            openssl_x509_export($this->key, $str_cert);
            $this->x509Certificate = $str_cert;
            $this->key = $str_cert;
        } else {
            $this->x509Certificate = null;
        }
        if ($this->cryptParams['library'] == 'openssl') {
            switch ($this->cryptParams['type']) {
                case 'public':
                        if ($isCert) {
                            /* Load the thumbprint if this is an X509 certificate. */
                            $this->X509Thumbprint = self::getRawThumbprint($this->key);
                        }
                        $this->key = openssl_get_publickey($this->key);
                        if (! $this->key) {
                            throw new Exception('Unable to extract public key');
                        }
                        break;
 
                    case 'private':
                    $this->key = openssl_get_privatekey($this->key, $this->passphrase);
                    break;
 
                case'symmetric':
                    if (strlen($this->key) < $this->cryptParams['keysize']) {
                        throw new Exception('Key must contain at least 25 characters for this cipher');
                    }
                    break;
 
                default:
                    throw new Exception('Unknown type');
            }
        }
    }

References RobRichards\XMLSecLibs\XMLSecurityKey\$key, and RobRichards\XMLSecLibs\XMLSecurityKey\getRawThumbprint().

Here is the call graph for this function:

◆ makeAsnSegment()

static RobRichards\XMLSecLibs\XMLSecurityKey::makeAsnSegment	(	$type,
		$string
	)

static

Parameters

int	$type
string	$string

Returns: null|string

Definition at line 637 of file XMLSecurityKey.php.

    {
        switch ($type) {
            case 0x02:
                if (ord($string) > 0x7f)
                    $string = chr(0).$string;
                break;
            case 0x03:
                $string = chr(0).$string;
                break;
        }
 
        $length = strlen($string);
 
        if ($length < 128) {
            $output = sprintf("%c%c%s", $type, $length, $string);
        } else if ($length < 0x0100) {
            $output = sprintf("%c%c%c%s", $type, 0x81, $length, $string);
        } else if ($length < 0x010000) {
            $output = sprintf("%c%c%c%c%s", $type, 0x82, $length / 0x0100, $length % 0x0100, $string);
        } else {
            $output = null;
        }
        return $output;
    }

References $output, RobRichards\XMLSecLibs\XMLSecurityKey\$type, and sprintf.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\convertRSA().

Here is the caller graph for this function:

◆ padISO10126()

RobRichards\XMLSecLibs\XMLSecurityKey::padISO10126	(	$data,
		$blockSize
	)

private

ISO 10126 Padding.

Parameters

string	$data
integer	$blockSize

Exceptions

Exception

Returns: string

Definition at line 368 of file XMLSecurityKey.php.

    {
        if ($blockSize > 256) {
            throw new Exception('Block size higher than 256 not allowed');
        }
        $padChr = $blockSize - (strlen($data) % $blockSize);
        $pattern = chr($padChr);
        return $data . str_repeat($pattern, $padChr);
    }

References $data.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\encryptSymmetric().

Here is the caller graph for this function:

◆ serializeKey()

RobRichards\XMLSecLibs\XMLSecurityKey::serializeKey ( $parent )

Parameters

mixed $parent

Definition at line 694 of file XMLSecurityKey.php.

    {
 
    }

◆ signData()

RobRichards\XMLSecLibs\XMLSecurityKey::signData ( $data )

Signs the data (string) using the extension assigned to the type in the constructor.

Parameters

string $data

Returns: mixed|string

Definition at line 576 of file XMLSecurityKey.php.

    {
        switch ($this->cryptParams['library']) {
            case 'openssl':
                return $this->signOpenSSL($data);
            case (self::HMAC_SHA1):
                return hash_hmac("sha1", $data, $this->key, true);
        }
    }

References $data, and RobRichards\XMLSecLibs\XMLSecurityKey\signOpenSSL().

Here is the call graph for this function:

◆ signOpenSSL()

RobRichards\XMLSecLibs\XMLSecurityKey::signOpenSSL ( $data )

private

Signs the given data (string) using the openssl-extension.

Parameters

string $data

Returns: string

Exceptions

Exception

Definition at line 493 of file XMLSecurityKey.php.

    {
        $algo = OPENSSL_ALGO_SHA1;
        if (! empty($this->cryptParams['digest'])) {
            $algo = $this->cryptParams['digest'];
        }
        if (! openssl_sign($data, $signature, $this->key, $algo)) {
            throw new Exception('Failure Signing Data: ' . openssl_error_string() . ' - ' . $algo);
        }
        return $signature;
    }

References $algo, and $data.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\signData().

Here is the caller graph for this function:

◆ unpadISO10126()

RobRichards\XMLSecLibs\XMLSecurityKey::unpadISO10126 ( $data )

private

Remove ISO 10126 Padding.

Parameters

string $data

Returns: string

Definition at line 384 of file XMLSecurityKey.php.

    {
        $padChr = substr($data, -1);
        $padLen = ord($padChr);
        return substr($data, 0, -$padLen);
    }

References $data.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\decryptSymmetric().

Here is the caller graph for this function:

◆ verifyOpenSSL()

RobRichards\XMLSecLibs\XMLSecurityKey::verifyOpenSSL	(	$data,
		$signature
	)

private

Verifies the given data (string) belonging to the given signature using the openssl-extension.

Returns: 1 on succesful signature verification, 0 when signature verification failed, -1 if an error occurred during processing.

NOTE: be very careful when checking the return value, because in PHP, -1 will be cast to True when in boolean context. So always check the return value in a strictly typed way, e.g. "$obj->verify(...) === 1".

Parameters

string	$data
string	$signature

Returns: int

Definition at line 521 of file XMLSecurityKey.php.

    {
        $algo = OPENSSL_ALGO_SHA1;
        if (! empty($this->cryptParams['digest'])) {
            $algo = $this->cryptParams['digest'];
        }
        return openssl_verify($data, $signature, $this->key, $algo);
    }

References $algo, and $data.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\verifySignature().

Here is the caller graph for this function:

◆ verifySignature()

RobRichards\XMLSecLibs\XMLSecurityKey::verifySignature	(	$data,
		$signature
	)

Verifies the data (string) against the given signature using the extension assigned to the type in the constructor.

Returns in case of openSSL: 1 on succesful signature verification, 0 when signature verification failed, -1 if an error occurred during processing.

NOTE: be very careful when checking the return value, because in PHP, -1 will be cast to True when in boolean context. So always check the return value in a strictly typed way, e.g. "$obj->verify(...) === 1".

Parameters

string	$data
string	$signature

Returns: bool|int

Definition at line 602 of file XMLSecurityKey.php.

    {
        switch ($this->cryptParams['library']) {
            case 'openssl':
                return $this->verifyOpenSSL($data, $signature);
            case (self::HMAC_SHA1):
                $expectedSignature = hash_hmac("sha1", $data, $this->key, true);
                return strcmp($signature, $expectedSignature) == 0;
        }
    }

References $data, and RobRichards\XMLSecLibs\XMLSecurityKey\verifyOpenSSL().

Here is the call graph for this function:

Field Documentation

◆ $cryptParams

RobRichards\XMLSecLibs\XMLSecurityKey::$cryptParams = array()

private

Definition at line 63 of file XMLSecurityKey.php.

◆ $encryptedCtx

RobRichards\XMLSecLibs\XMLSecurityKey::$encryptedCtx = null

Definition at line 87 of file XMLSecurityKey.php.

◆ $guid

RobRichards\XMLSecLibs\XMLSecurityKey::$guid = null

Definition at line 90 of file XMLSecurityKey.php.

◆ $isEncrypted

RobRichards\XMLSecLibs\XMLSecurityKey::$isEncrypted = false

Definition at line 84 of file XMLSecurityKey.php.

◆ $iv

RobRichards\XMLSecLibs\XMLSecurityKey::$iv = null

Definition at line 75 of file XMLSecurityKey.php.

◆ $key

RobRichards\XMLSecLibs\XMLSecurityKey::$key = null

Definition at line 69 of file XMLSecurityKey.php.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\generateSessionKey(), and RobRichards\XMLSecLibs\XMLSecurityKey\loadKey().

◆ $keyChain

RobRichards\XMLSecLibs\XMLSecurityKey::$keyChain = null

Definition at line 81 of file XMLSecurityKey.php.

◆ $name

RobRichards\XMLSecLibs\XMLSecurityKey::$name = null

Definition at line 78 of file XMLSecurityKey.php.

◆ $passphrase

RobRichards\XMLSecLibs\XMLSecurityKey::$passphrase = ""

Definition at line 72 of file XMLSecurityKey.php.

◆ $type

RobRichards\XMLSecLibs\XMLSecurityKey::$type = 0

Definition at line 66 of file XMLSecurityKey.php.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\__construct(), and RobRichards\XMLSecLibs\XMLSecurityKey\makeAsnSegment().

◆ $x509Certificate

RobRichards\XMLSecLibs\XMLSecurityKey::$x509Certificate = null

private

Definition at line 97 of file XMLSecurityKey.php.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\getX509Certificate().

◆ $X509Thumbprint

RobRichards\XMLSecLibs\XMLSecurityKey::$X509Thumbprint = null

private

Definition at line 103 of file XMLSecurityKey.php.

Referenced by RobRichards\XMLSecLibs\XMLSecurityKey\getX509Thumbprint().

◆ AES128_CBC

const RobRichards\XMLSecLibs\XMLSecurityKey::AES128_CBC = 'http://www.w3.org/2001/04/xmlenc#aes128-cbc'

Definition at line 50 of file XMLSecurityKey.php.

Referenced by SAML2\Certificate\PrivateKeyLoader\loadDecryptionKeys().

◆ AES192_CBC

const RobRichards\XMLSecLibs\XMLSecurityKey::AES192_CBC = 'http://www.w3.org/2001/04/xmlenc#aes192-cbc'

Definition at line 51 of file XMLSecurityKey.php.

◆ AES256_CBC

const RobRichards\XMLSecLibs\XMLSecurityKey::AES256_CBC = 'http://www.w3.org/2001/04/xmlenc#aes256-cbc'

Definition at line 52 of file XMLSecurityKey.php.

◆ DSA_SHA1

const RobRichards\XMLSecLibs\XMLSecurityKey::DSA_SHA1 = 'http://www.w3.org/2000/09/xmldsig#dsa-sha1'

Definition at line 55 of file XMLSecurityKey.php.

◆ HMAC_SHA1

const RobRichards\XMLSecLibs\XMLSecurityKey::HMAC_SHA1 = 'http://www.w3.org/2000/09/xmldsig#hmac-sha1'

Definition at line 60 of file XMLSecurityKey.php.

◆ RSA_1_5

const RobRichards\XMLSecLibs\XMLSecurityKey::RSA_1_5 = 'http://www.w3.org/2001/04/xmlenc#rsa-1_5'

Definition at line 53 of file XMLSecurityKey.php.

Referenced by SAML2\Certificate\PrivateKeyLoader\convertPrivateKeyToRsaKey(), and SAML2\Configuration\ServiceProvider\getBlacklistedAlgorithms().

◆ RSA_OAEP_MGF1P

const RobRichards\XMLSecLibs\XMLSecurityKey::RSA_OAEP_MGF1P = 'http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p'

Definition at line 54 of file XMLSecurityKey.php.

◆ RSA_SHA1

const RobRichards\XMLSecLibs\XMLSecurityKey::RSA_SHA1 = 'http://www.w3.org/2000/09/xmldsig#rsa-sha1'

Definition at line 56 of file XMLSecurityKey.php.

Referenced by SimpleSAML\XML\Signer\loadPrivateKeyArray(), and SAML2\Signature\AbstractChainedValidator\validateElementWithKeys().

◆ RSA_SHA256

const RobRichards\XMLSecLibs\XMLSecurityKey::RSA_SHA256 = 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256'

Definition at line 57 of file XMLSecurityKey.php.

◆ RSA_SHA384

const RobRichards\XMLSecLibs\XMLSecurityKey::RSA_SHA384 = 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha384'

Definition at line 58 of file XMLSecurityKey.php.

◆ RSA_SHA512

const RobRichards\XMLSecLibs\XMLSecurityKey::RSA_SHA512 = 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha512'

Definition at line 59 of file XMLSecurityKey.php.

◆ TRIPLEDES_CBC

const RobRichards\XMLSecLibs\XMLSecurityKey::TRIPLEDES_CBC = 'http://www.w3.org/2001/04/xmlenc#tripledes-cbc'

Definition at line 49 of file XMLSecurityKey.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/robrichards/xmlseclibs/src/XMLSecurityKey.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ convertRSA()

◆ decryptData()

◆ decryptPrivate()

◆ decryptPublic()

◆ decryptSymmetric()

◆ encryptData()

◆ encryptPrivate()

◆ encryptPublic()

◆ encryptSymmetric()

◆ fromEncryptedKeyElement()

◆ generateSessionKey()

◆ getAlgorith()

◆ getAlgorithm()

◆ getRawThumbprint()

◆ getSymmetricKeySize()

◆ getX509Certificate()

◆ getX509Thumbprint()

◆ loadKey()

◆ makeAsnSegment()

◆ padISO10126()

◆ serializeKey()

◆ signData()

◆ signOpenSSL()

◆ unpadISO10126()

◆ verifyOpenSSL()

◆ verifySignature()

Field Documentation

◆ $cryptParams

◆ $encryptedCtx

◆ $guid

◆ $isEncrypted

◆ $iv

◆ $key

◆ $keyChain

◆ $name

◆ $passphrase

◆ $type

◆ $x509Certificate

◆ $X509Thumbprint

◆ AES128_CBC

◆ AES192_CBC

◆ AES256_CBC

◆ DSA_SHA1

◆ HMAC_SHA1

◆ RSA_1_5

◆ RSA_OAEP_MGF1P

◆ RSA_SHA1

◆ RSA_SHA256

◆ RSA_SHA384

◆ RSA_SHA512

◆ TRIPLEDES_CBC