Auth_OpenID_TrustRoot Class Reference

List of all members.

---

Detailed Description

A wrapper for trust-root related functions

Definition at line 47 of file TrustRoot.php.

Public Member Functions
	buildDiscoveryURL ($realm)
	match ($trust_root, $url)
Static Public Member Functions
	_parse ($trust_root)
	isSane ($trust_root)

---

Member Function Documentation

Auth_OpenID_TrustRoot.buildDiscoveryURL

(

$

realm

)

Definition at line 59 of file TrustRoot.php.

Auth_OpenID_TrustRoot._parse

(

$

trust_root

)

[static]

Parse a URL into its trust_root parts.

private

Parameters:

string

$trust_root The url to parse

Returns:

mixed $parsed Either an associative array of trust root parts or false if parsing failed.

Definition at line 94 of file TrustRoot.php.

Auth_OpenID_TrustRoot.isSane

(

$

trust_root

)

[static]

Is this trust root sane?

A trust root is sane if it is syntactically valid and it has a reasonable domain name. Specifically, the domain name must be more than one level below a standard TLD or more than two levels below a two-letter tld.

For example, '*.com' is not a sane trust root, but '*.foo.com' is. '*.co.uk' is not sane, but '*.bbc.co.uk' is.

This check is not always correct, but it attempts to err on the side of marking sane trust roots insane instead of marking insane trust roots sane. For example, 'kink.fm' is marked as insane even though it "should" (for some meaning of should) be marked sane.

This function should be used when creating OpenID servers to alert the users of the server when a consumer attempts to get the user to accept a suspicious trust root.

Parameters:

string

$trust_root The trust root to check

Returns:

bool $sanity Whether the trust root looks OK

Definition at line 200 of file TrustRoot.php.

Auth_OpenID_TrustRoot.match	(	$	trust_root,
		$	url
	)

Does this URL match the given trust root?

Return whether the URL falls under the given trust root. This does not check whether the trust root is sane. If the URL or trust root do not parse, this function will return false.

Parameters:

	string	$trust_root The trust root to match against
	string	$url The URL to check

Returns:

bool $matches Whether the URL matches against the trust root

Definition at line 270 of file TrustRoot.php.

---

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

• core/openid/Auth/OpenID/TrustRoot.php