PHP 클래스 SAML2\AuthnRequest

상속: extends Request

파일 보기 프로젝트 열기: simplesamlphp/saml2 1 사용 예제들

공개 메소드들

메소드	설명
__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.