Inheritance diagram for SAML2\SignedElement:
Collaboration diagram for SAML2\SignedElement:
Public Member Functions | |
| validate (XMLSecurityKey $key) | |
| Validate this element against a public key. More... | |
| setCertificates (array $certificates) | |
| Set the certificates that should be included in the element. More... | |
| getCertificates () | |
| Retrieve the certificates that are included in the element (if any). More... | |
| getSignatureKey () | |
| Retrieve the private key we should use to sign the element. More... | |
| setSignatureKey (XMLSecurityKey $signatureKey=null) | |
| Set the private key we should use to sign the element. More... | |
Detailed Description
Definition at line 12 of file SignedElement.php.
Member Function Documentation
◆ getCertificates()
| SAML2\SignedElement::getCertificates | ( | ) |
Retrieve the certificates that are included in the element (if any).
- Returns
- array An array of certificates.
Implemented in SAML2\Assertion, SAML2\Message, and SAML2\SignedElementHelper.
Referenced by SAML2\Signature\FingerprintValidator\canValidate().
Here is the caller graph for this function:
◆ getSignatureKey()
| SAML2\SignedElement::getSignatureKey | ( | ) |
Retrieve the private key we should use to sign the element.
- Returns
- XMLSecurityKey|null The key, or NULL if no key is specified.
Implemented in SAML2\Assertion, SAML2\Message, and SAML2\SignedElementHelper.
◆ setCertificates()
| SAML2\SignedElement::setCertificates | ( | array | $certificates | ) |
Set the certificates that should be included in the element.
The certificates should be strings with the PEM encoded data.
- Parameters
-
array $certificates An array of certificates.
Implemented in SAML2\Assertion, SAML2\Message, and SAML2\SignedElementHelper.
◆ setSignatureKey()
| SAML2\SignedElement::setSignatureKey | ( | XMLSecurityKey | $signatureKey = null | ) |
Set the private key we should use to sign the element.
If the key is null, the message will be sent unsigned.
- Parameters
-
XMLSecurityKey | null $signatureKey
Implemented in SAML2\Assertion, SAML2\Message, and SAML2\SignedElementHelper.
◆ validate()
| SAML2\SignedElement::validate | ( | XMLSecurityKey | $key | ) |
Validate this element against a public key.
If no signature is present, false is returned. If a signature is present, but cannot be verified, an exception will be thrown.
- Parameters
-
XMLSecurityKey $key The key we should check against.
- Returns
- boolean true if successful, false if we don't have a signature that can be verified.
Implemented in SAML2\Assertion, SAML2\Message, and SAML2\SignedElementHelper.
Referenced by SAML2\Signature\AbstractChainedValidator\validateElementWithKeys().
Here is the caller graph for this function:
The documentation for this interface was generated from the following file:
- libs/composer/vendor/simplesamlphp/saml2/src/SAML2/SignedElement.php
