Docs For Class HTTP_Request2_Adapter

$challenges = array()

[line 94]

Data for digest authentication scheme

The keys for the array are URL prefixes.

The values are associative arrays with data (realm, nonce, nonce-count, opaque...) needed for digest authentication. Stored here to prevent making duplicate requests to digest-protected resources after we have already received the challenge.

Access: protected

Type:

array

[ Top ]

$chunkLength = 0

[line 120]

Remaining length of the current chunk, when reading chunked response

See: HTTP_Request2_Adapter_Socket::readChunked()
Access: protected

Type:

integer

[ Top ]

$proxyChallenge =

[line 113]

Challenge used for proxy digest authentication

Access: protected

Type:

array

[ Top ]

$redirectCountdown = null

[line 130]

Remaining amount of redirections to follow

Starts at 'max_redirects' configuration parameter and is reduced on each subsequent redirect. An Exception will be thrown once it reaches zero.

Access: protected

Type:

integer

[ Top ]

$serverChallenge =

[line 107]

Challenge used for server digest authentication

Access: protected

Type:

array

[ Top ]

$socket =

[line 101]

Connected socket

See: HTTP_Request2_Adapter_Socket::connect()
Access: protected

Type:

HTTP_Request2_SocketWrapper

[ Top ]

$sockets = array()

[line 80]

Connected sockets, needed for Keep-Alive support

See: HTTP_Request2_Adapter_Socket::connect()
Access: protected

Type:

array

[ Top ]

addAuthorizationHeader [line 728]

void addAuthorizationHeader(
array
&$headers, string
$requestHost, string
$requestUrl)

Adds 'Authorization' header (if needed) to request headers array

Throws: HTTP_Request2_NotImplementedException
Access: protected

Parameters:

array	`&$headers`	—	request headers
string	`$requestHost`	—	request host (needed for digest authentication)
string	`$requestUrl`	—	request URL (needed for digest authentication)

[ Top ]

addProxyAuthorizationHeader [line 773]

void addProxyAuthorizationHeader(
array
&$headers, string
$requestUrl)

Adds 'Proxy-Authorization' header (if needed) to request headers array

Throws: HTTP_Request2_NotImplementedException
Access: protected

Parameters:

array	`&$headers`	—	request headers
string	`$requestUrl`	—	request URL (needed for digest authentication)

[ Top ]

canKeepAlive [line 371]

boolean canKeepAlive(
boolean
$requestKeepAlive, HTTP_Request2_Response
$response)

Checks whether current connection may be reused or should be closed

Access: protected

Parameters:

boolean	`$requestKeepAlive`	—	whether connection could be persistent in the first place
HTTP_Request2_Response	`$response`	—	response object to check

[ Top ]

connect [line 200]

bool connect(
)

Connects to the remote server

Return: whether the connection can be persistent
Throws: HTTP_Request2_Exception
Access: protected

[ Top ]

createDigestResponse [line 682]

string createDigestResponse(
string
$user, string
$password, string
$url, array
&$challenge)

Creates a value for [Proxy-]Authorization header when using digest authentication

Return: value of [Proxy-]Authorization request header
Link: http://tools.ietf.org/html/rfc2617#section-3.2.2
Access: protected

Parameters:

string	`$user`	—	user name
string	`$password`	—	password
string	`$url`	—	request URL
array	`&$challenge`	—	digest challenge parameters

[ Top ]

disconnect [line 394]

void disconnect(
)

Disconnects from the remote server

Access: protected

[ Top ]

establishTunnel [line 343]

void establishTunnel(
)

Establishes a tunnel to a secure remote server via HTTP CONNECT request

This method will fail if 'ssl_verify_peer' is enabled. Probably because PHP sees that we are connected to a proxy server (duh!) rather than the server that presents its certificate.

Link: http://tools.ietf.org/html/rfc2817#section-5.2
Throws: HTTP_Request2_Exception
Access: protected

[ Top ]

handleRedirect [line 415]

HTTP_Request2_Response handleRedirect(
HTTP_Request2
$request, HTTP_Request2_Response
$response)

Handles HTTP redirection

This method will throw an Exception if redirect to a non-HTTP(S) location is attempted, also if number of redirects performed already is equal to 'max_redirects' configuration parameter.

Return: Response from a new location
Throws: HTTP_Request2_Exception
Access: protected

Parameters:

HTTP_Request2	`$request`	—	Original request
HTTP_Request2_Response	`$response`	—	Response containing redirect

[ Top ]

parseDigestChallenge [line 599]

mixed parseDigestChallenge(
string
$headerValue)

Extracts digest method challenge from (WWW|Proxy)-Authenticate header value

There is a problem with implementation of RFC 2617: several of the parameters are defined as quoted-string there and thus may contain backslash escaped double quotes (RFC 2616, section 2.2). However, RFC 2617 defines unq(X) as just value of quoted-string X without surrounding quotes, it doesn't speak about removing backslash escaping.

Now realm parameter is user-defined and human-readable, strange things happen when it contains quotes:

Apache allows quotes in realm, but apparently uses realm value without backslashes for digest computation
Squid allows (manually escaped) quotes there, but it is impossible to authorize with either escaped or unescaped quotes used in digest, probably it can't parse the response (?)
Both IE and Firefox display realm value with backslashes in the password popup and apparently use the same value for digest

HTTP_Request2 follows IE and Firefox (and hopefully RFC 2617) in quoted-string handling, unfortunately that means failure to authorize sometimes

Return: associative array with challenge parameters, false if no challenge is present in header value
Throws: HTTP_Request2_NotImplementedException in case of unsupported challenge parameters
Access: protected

Parameters:

string $headerValue — value of WWW-Authenticate or Proxy-Authenticate header

[ Top ]

prepareHeaders [line 819]

string prepareHeaders(
)

Creates the string with the Request-Line and request headers

Throws: HTTP_Request2_Exception
Access: protected

[ Top ]

readChunked [line 988]

string readChunked(
int
$bufferSize)

Reads a part of response body encoded with chunked Transfer-Encoding

Throws: HTTP_Request2_MessageException
Access: protected

Parameters:

int $bufferSize — buffer size to use for reading

[ Top ]

readResponse [line 913]

HTTP_Request2_Response readResponse(
)

Reads the remote server's response

Throws: HTTP_Request2_Exception
Access: protected

[ Top ]

sendRequest [line 140]

HTTP_Request2_Response sendRequest(
HTTP_Request2
$request)

Sends request to the remote server and returns its response

Throws: HTTP_Request2_Exception
Access: public

Overrides HTTP_Request2_Adapter::sendRequest() (Sends request to the remote server and returns its response)

Parameters:

HTTP_Request2 $request — HTTP request message

[ Top ]

shouldUseProxyDigestAuth [line 547]

boolean shouldUseProxyDigestAuth(
HTTP_Request2_Response
$response)

Checks whether another request should be performed with proxy digest auth

Several conditions should be satisfied for it to return true:

response status should be 407
proxy auth credentials should be set in the request object
response should contain Proxy-Authenticate header with digest challenge
there is either no challenge stored for this proxy or new challenge contains stale=true parameter (in other case we probably just failed due to invalid username / password)

The method stores challenge values in $challenges static property

Return: whether another request should be performed
Throws: HTTP_Request2_Exception in case of unsupported challenge parameters
Access: protected

Parameters:

HTTP_Request2_Response $response — response to check

[ Top ]

shouldUseServerDigestAuth [line 482]

boolean shouldUseServerDigestAuth(
HTTP_Request2_Response
$response)

Checks whether another request should be performed with server digest auth

Several conditions should be satisfied for it to return true:

response status should be 401
auth credentials should be set in the request object
response should contain WWW-Authenticate header with digest challenge
there is either no challenge stored for this URL or new challenge contains stale=true parameter (in other case we probably just failed due to invalid username / password)

The method stores challenge values in $challenges static property

Return: whether another request should be performed
Throws: HTTP_Request2_Exception in case of unsupported challenge parameters
Access: protected

Parameters:

HTTP_Request2_Response $response — response to check

[ Top ]

updateChallenge [line 650]

void updateChallenge(
array
&$challenge, string
$headerValue)

Parses [Proxy-]Authentication-Info header value and updates challenge

Todo: validate server rspauth response
Access: protected

Parameters:

array	`&$challenge`	—	challenge to update
string	`$headerValue`	—	value of [Proxy-]Authentication-Info header

[ Top ]

writeBody [line 881]

void writeBody(
)

Sends the request body

Throws: HTTP_Request2_MessageException
Access: protected

[ Top ]

Class: HTTP_Request2_Adapter_Socket

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Class: HTTP_Request2_Adapter

Inherited Methods

Class: HTTP_Request2_Adapter

Class Details

Class Variables

$challenges = array()

$chunkLength = 0

$proxyChallenge =

$redirectCountdown = null

$serverChallenge =

$socket =

$sockets = array()

Method Detail

addAuthorizationHeader [line 728]

Parameters:

addProxyAuthorizationHeader [line 773]

Parameters:

canKeepAlive [line 371]

Parameters:

connect [line 200]

createDigestResponse [line 682]

Parameters:

disconnect [line 394]

establishTunnel [line 343]

handleRedirect [line 415]

Parameters:

parseDigestChallenge [line 599]

Parameters:

prepareHeaders [line 819]

readChunked [line 988]

Parameters:

readResponse [line 913]

sendRequest [line 140]

Parameters:

shouldUseProxyDigestAuth [line 547]

Parameters:

shouldUseServerDigestAuth [line 482]

Parameters:

updateChallenge [line 650]

Parameters:

writeBody [line 881]