PHP Класс SAML2\AuthnRequest

Наследование: extends Request
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( DOMElement $xml = null ) Constructor for SAML 2 authentication request messages.
decryptNameId ( XMLSecurityKey $key, array $blacklist = [] ) Decrypt the NameId of the subject in the assertion.
encryptNameId ( XMLSecurityKey $key ) Encrypt the NameID in the AuthnRequest.
getAssertionConsumerServiceIndex ( ) : integer | null Retrieve the value of the AssertionConsumerServiceIndex attribute.
getAssertionConsumerServiceURL ( ) : string | null Retrieve the value of the AssertionConsumerServiceURL attribute.
getAttributeConsumingServiceIndex ( ) : integer | null Retrieve the value of the AttributeConsumingServiceIndex attribute.
getForceAuthn ( ) : boolean Retrieve the value of the ForceAuthn attribute.
getIDPList ( ) : array This function retrieves the list of providerIDs from this authentication request.
getIsPassive ( ) : boolean Retrieve the value of the IsPassive attribute.
getNameId ( ) : array | null Retrieve the NameId of the subject in the assertion.
getNameIdPolicy ( ) : array Retrieve the NameIdPolicy.
getProtocolBinding ( ) : string | null Retrieve the value of the ProtocolBinding attribute.
getProviderName ( ) : string Retrieve the value of the ProviderName attribute.
getProxyCount ( ) : integer
getRequestedAuthnContext ( ) : array | null Retrieve the RequestedAuthnContext.
getRequesterID ( ) : array
getSubjectConfirmation ( ) : SAML2\XML\saml\SubjectConfirmation[] Retrieve the SubjectConfirmation elements we have in our Subject element.
setAssertionConsumerServiceIndex ( integer | null $assertionConsumerServiceIndex ) Set the value of the AssertionConsumerServiceIndex attribute.
setAssertionConsumerServiceURL ( string | null $assertionConsumerServiceURL ) Set the value of the AssertionConsumerServiceURL attribute.
setAttributeConsumingServiceIndex ( integer | null $attributeConsumingServiceIndex ) Set the value of the AttributeConsumingServiceIndex attribute.
setForceAuthn ( boolean $forceAuthn ) Set the value of the ForceAuthn attribute.
setIDPList ( $IDPList ) This function sets the scoping for the request.
setIsPassive ( boolean $isPassive ) Set the value of the IsPassive attribute.
setNameId ( array | null $nameId ) Set the NameId of the subject in the assertion.
setNameIdPolicy ( array $nameIdPolicy ) Set the NameIDPolicy.
setProtocolBinding ( string $protocolBinding ) Set the value of the ProtocolBinding attribute.
setProviderName ( string $ProviderName ) Set the value of the ProviderName attribute.
setProxyCount ( integer $ProxyCount )
setRequestedAuthnContext ( array | null $requestedAuthnContext ) Set the RequestedAuthnContext.
setRequesterID ( array $RequesterID )
setSubjectConfirmation ( array $subjectConfirmation ) Set the SubjectConfirmation elements that should be included in the assertion.
toUnsignedXML ( ) : DOMElement Convert this authentication request to an XML element.

Защищенные методы

Метод Описание
parseNameIdPolicy ( DOMElement $xml )
parseRequestedAuthnContext ( DOMElement $xml )
parseScoping ( DOMElement $xml )

Приватные методы

Метод Описание
addSubject ( DOMElement $root ) Add a Subject-node to the assertion.
parseSubject ( DOMElement $xml )

Описание методов

__construct() публичный Метод

Constructor for SAML 2 authentication request messages.
public __construct ( DOMElement $xml = null )
$xml DOMElement The input message.

decryptNameId() публичный Метод

Decrypt the NameId of the subject in the assertion.
public decryptNameId ( XMLSecurityKey $key, array $blacklist = [] )
$key RobRichards\XMLSecLibs\XMLSecurityKey The decryption key.
$blacklist array Blacklisted decryption algorithms.

encryptNameId() публичный Метод

Encrypt the NameID in the AuthnRequest.
public encryptNameId ( XMLSecurityKey $key )
$key RobRichards\XMLSecLibs\XMLSecurityKey The encryption key.

getAssertionConsumerServiceIndex() публичный Метод

Retrieve the value of the AssertionConsumerServiceIndex attribute.
public getAssertionConsumerServiceIndex ( ) : integer | null
Результат integer | null The AssertionConsumerServiceIndex attribute.

getAssertionConsumerServiceURL() публичный Метод

Retrieve the value of the AssertionConsumerServiceURL attribute.
public getAssertionConsumerServiceURL ( ) : string | null
Результат string | null The AssertionConsumerServiceURL attribute.

getAttributeConsumingServiceIndex() публичный Метод

Retrieve the value of the AttributeConsumingServiceIndex attribute.
public getAttributeConsumingServiceIndex ( ) : integer | null
Результат integer | null The AttributeConsumingServiceIndex attribute.

getForceAuthn() публичный Метод

Retrieve the value of the ForceAuthn attribute.
public getForceAuthn ( ) : boolean
Результат boolean The ForceAuthn attribute.

getIDPList() публичный Метод

Currently we only support a list of ipd ientity id's.
public getIDPList ( ) : array
Результат array List of idp EntityIDs from the request

getIsPassive() публичный Метод

Retrieve the value of the IsPassive attribute.
public getIsPassive ( ) : boolean
Результат boolean The IsPassive attribute.

getNameId() публичный Метод

The returned NameId is in the format used by \SAML2\Utils::addNameId().
См. также: SAML2\Utils::addNameId()
public getNameId ( ) : array | null
Результат array | null The name identifier of the assertion.

getNameIdPolicy() публичный Метод

Retrieve the NameIdPolicy.
См. также: SAML2\AuthnRequest::setNameIdPolicy()
public getNameIdPolicy ( ) : array
Результат array The NameIdPolicy.

getProtocolBinding() публичный Метод

Retrieve the value of the ProtocolBinding attribute.
public getProtocolBinding ( ) : string | null
Результат string | null The ProtocolBinding attribute.

getProviderName() публичный Метод

Retrieve the value of the ProviderName attribute.
public getProviderName ( ) : string
Результат string The ProviderName attribute.

getProxyCount() публичный Метод

public getProxyCount ( ) : integer
Результат integer

getRequestedAuthnContext() публичный Метод

Retrieve the RequestedAuthnContext.
public getRequestedAuthnContext ( ) : array | null
Результат array | null The RequestedAuthnContext.

getRequesterID() публичный Метод

public getRequesterID ( ) : array
Результат array

getSubjectConfirmation() публичный Метод

Retrieve the SubjectConfirmation elements we have in our Subject element.
public getSubjectConfirmation ( ) : SAML2\XML\saml\SubjectConfirmation[]
Результат SAML2\XML\saml\SubjectConfirmation[]

parseNameIdPolicy() защищенный Метод

protected parseNameIdPolicy ( DOMElement $xml )
$xml DOMElement

parseRequestedAuthnContext() защищенный Метод

protected parseRequestedAuthnContext ( DOMElement $xml )
$xml DOMElement

parseScoping() защищенный Метод

protected parseScoping ( DOMElement $xml )
$xml DOMElement

setAssertionConsumerServiceIndex() публичный Метод

Set the value of the AssertionConsumerServiceIndex attribute.
public setAssertionConsumerServiceIndex ( integer | null $assertionConsumerServiceIndex )
$assertionConsumerServiceIndex integer | null The AssertionConsumerServiceIndex attribute.

setAssertionConsumerServiceURL() публичный Метод

Set the value of the AssertionConsumerServiceURL attribute.
public setAssertionConsumerServiceURL ( string | null $assertionConsumerServiceURL )
$assertionConsumerServiceURL string | null The AssertionConsumerServiceURL attribute.

setAttributeConsumingServiceIndex() публичный Метод

Set the value of the AttributeConsumingServiceIndex attribute.
public setAttributeConsumingServiceIndex ( integer | null $attributeConsumingServiceIndex )
$attributeConsumingServiceIndex integer | null The AttributeConsumingServiceIndex attribute.

setForceAuthn() публичный Метод

Set the value of the ForceAuthn attribute.
public setForceAuthn ( boolean $forceAuthn )
$forceAuthn boolean The ForceAuthn attribute.

setIDPList() публичный Метод

See Core 3.4.1.2 for the definition of scoping. Currently we support an IDPList of idpEntries. Each idpEntries consists of an array, containing keys (mapped to attributes) and corresponding values. Allowed attributes: Loc, Name, ProviderID. For backward compatibility, an idpEntries can also be a string instead of an array, where each string is mapped to the value of attribute ProviderID.
public setIDPList ( $IDPList )

setIsPassive() публичный Метод

Set the value of the IsPassive attribute.
public setIsPassive ( boolean $isPassive )
$isPassive boolean The IsPassive attribute.

setNameId() публичный Метод

The NameId must be in the format accepted by \SAML2\Utils::addNameId().
См. также: SAML2\Utils::addNameId()
public setNameId ( array | null $nameId )
$nameId array | null The name identifier of the assertion.

setNameIdPolicy() публичный Метод

This function accepts an array with the following options: - 'Format' - 'SPNameQualifier' - 'AllowCreate'
public setNameIdPolicy ( array $nameIdPolicy )
$nameIdPolicy array The NameIDPolicy.

setProtocolBinding() публичный Метод

Set the value of the ProtocolBinding attribute.
public setProtocolBinding ( string $protocolBinding )
$protocolBinding string The ProtocolBinding attribute.

setProviderName() публичный Метод

Set the value of the ProviderName attribute.
public setProviderName ( string $ProviderName )
$ProviderName string The ProviderName attribute.

setProxyCount() публичный Метод

public setProxyCount ( integer $ProxyCount )
$ProxyCount integer

setRequestedAuthnContext() публичный Метод

Set the RequestedAuthnContext.
public setRequestedAuthnContext ( array | null $requestedAuthnContext )
$requestedAuthnContext array | null The RequestedAuthnContext.

setRequesterID() публичный Метод

public setRequesterID ( array $RequesterID )
$RequesterID array

setSubjectConfirmation() публичный Метод

Set the SubjectConfirmation elements that should be included in the assertion.
public setSubjectConfirmation ( array $subjectConfirmation )
$subjectConfirmation array

toUnsignedXML() публичный Метод

Convert this authentication request to an XML element.
public toUnsignedXML ( ) : DOMElement
Результат DOMElement This authentication request.