SAML2\DOMDocumentFactory Class Reference

Collaboration diagram for SAML2\DOMDocumentFactory:

Static Public Member Functions
static	fromString ($xml)
static	fromFile ($file)
static	create ()

Private Member Functions
	__construct ()

Detailed Description

Definition at line 9 of file DOMDocumentFactory.php.

Constructor & Destructor Documentation

__construct()

SAML2\DOMDocumentFactory::__construct ( )

private

Definition at line 11 of file DOMDocumentFactory.php.

    {
    }

Member Function Documentation

create()

static SAML2\DOMDocumentFactory::create ( )

static

Returns

\DOMDocument

Definition at line 100 of file DOMDocumentFactory.php.

    {
        return new \DOMDocument();
    }

Referenced by SAML2\XML\saml\AttributeValue\__construct(), SAML2\XML\saml\BaseIDType\__toString(), SimpleSAML\Bindings\Shib13\Artifact\extractResponse(), SAML2\XML\saml\BaseIDType\toXML(), and SAML2\XML\saml\Issuer\toXML().

Here is the caller graph for this function:

fromFile()

static SAML2\DOMDocumentFactory::fromFile (   $file )

static

Parameters

$file

Returns

\DOMDocument

Definition at line 66 of file DOMDocumentFactory.php.

    {
        if (!is_string($file)) {
            throw InvalidArgumentException::invalidType('string', $file);
        }
 
        if (!is_file($file)) {
            throw new InvalidArgumentException(sprintf('Path "%s" is not a file', $file));
        }
 
        if (!is_readable($file)) {
            throw new InvalidArgumentException(sprintf('File "%s" is not readable', $file));
        }
 
        // libxml_disable_entity_loader(true) disables \DOMDocument::load() method
        // so we need to read the content and use \DOMDocument::loadXML()
        $xml = file_get_contents($file);
        if ($xml === false) {
            throw new RuntimeException(sprintf(
                'Contents of readable file "%s" could not be gotten',
                $file
            ));
        }
 
        if (trim($xml) === '') {
            throw new RuntimeException(sprintf('File "%s" does not have content', $file));
        }
 
        return static::fromString($xml);
    }

References $file, $xml, and sprintf.

fromString()

static SAML2\DOMDocumentFactory::fromString (   $xml )

static

Parameters

string

$xml

Returns

\DOMDocument

Definition at line 20 of file DOMDocumentFactory.php.

    {
        if (!is_string($xml) || trim($xml) === '') {
            throw InvalidArgumentException::invalidType('non-empty string', $xml);
        }
 
        $entityLoader   = libxml_disable_entity_loader(true);
        $internalErrors = libxml_use_internal_errors(true);
        libxml_clear_errors();
 
        $domDocument = self::create();
        $options     = LIBXML_DTDLOAD | LIBXML_DTDATTR | LIBXML_NONET;
        if (defined(LIBXML_COMPACT)) {
            $options |= LIBXML_COMPACT;
        }
 
        $loaded = $domDocument->loadXML($xml, $options);
 
        libxml_use_internal_errors($internalErrors);
        libxml_disable_entity_loader($entityLoader);
 
        if (!$loaded) {
            $error = libxml_get_last_error();
            libxml_clear_errors();
 
            throw new UnparseableXmlException($error);
        }
 
        libxml_clear_errors();
 
        foreach ($domDocument->childNodes as $child) {
            if ($child->nodeType === XML_DOCUMENT_TYPE_NODE) {
                throw new RuntimeException(
                    'Dangerous XML detected, DOCTYPE nodes are not allowed in the XML body'
                );
            }
        }
 
        return $domDocument;
    }

References $error, $options, $xml, and defined.

Referenced by sspmod_adfs_XMLSecurityDSig\__construct(), sspmod_cas_Auth_Source_CAS\casServiceValidate(), sspmod_saml_IdP_SAML2\encodeAttributes(), SimpleSAML\Bindings\Shib13\Artifact\extractResponse(), SimpleSAML\Utils\XML\formatXMLString(), sspmod_metarefresh_MetaLoader\loadXML(), SimpleSAML_Metadata_SAMLParser\parseDescriptorsFile(), SimpleSAML_Metadata_SAMLParser\parseDescriptorsString(), SimpleSAML_Metadata_SAMLParser\parseFile(), SimpleSAML_Metadata_SAMLParser\parseString(), SimpleSAML\Bindings\Shib13\HTTPPost\sendResponse(), SimpleSAML\XML\Shib13\AuthnResponse\setXML(), SimpleSAML_Metadata_Signer\sign(), sspmod_adfs_IdP_ADFS\signResponse(), SAML2\XML\Chunk\unserialize(), and SAML2\XML\saml\AttributeValue\unserialize().

Here is the caller graph for this function:

---

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

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/DOMDocumentFactory.php