JanRain OpenID Library

TrustRoot.php

Functions for dealing with OpenID trust roots

PHP versions 4 and 5

LICENSE: See the COPYING file included in this distribution.

Tags
author

JanRain, Inc. openid@janrain.com

copyright

2005-2008 Janrain, Inc.

license

http://www.apache.org/licenses/LICENSE-2.0 Apache

Interfaces, Classes, Traits and Enums

Auth_OpenID_TrustRoot
A wrapper for trust-root related functions

Table of Contents

Auth_OpenID___HostSegmentRe  = "/^(?:[-a-zA-Z0-9!\$&'\\(\\)\\*+,;=._~]|%[a-zA-Z0-9]{2})*\$/"
Auth_OpenID___TLDs  = '/\\.(ac|ad|ae|aero|af|ag|ai|al|am|an|ao|aq|ar|arpa|as|asia' . '|at|au|aw|ax|az|ba|bb|bd|be|bf|bg|bh|bi|biz|bj|bm|bn|bo|br' . '|bs|bt|bv|bw|by|bz|ca|cat|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|co' . '|com|coop|cr|cu|cv|cx|cy|cz|de|dj|dk|dm|do|dz|ec|edu|ee|eg' . '|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gg|gh|gi|gl' . '|gm|gn|gov|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie' . '|il|im|in|info|int|io|iq|ir|is|it|je|jm|jo|jobs|jp|ke|kg|kh' . '|ki|km|kn|kp|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly' . '|ma|mc|md|me|mg|mh|mil|mk|ml|mm|mn|mo|mobi|mp|mq|mr|ms|mt' . '|mu|museum|mv|mw|mx|my|mz|na|name|nc|ne|net|nf|ng|ni|nl|no' . '|np|nr|nu|nz|om|org|pa|pe|pf|pg|ph|pk|pl|pm|pn|pr|pro|ps|pt' . '|pw|py|qa|re|ro|rs|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj|sk|sl' . '|sm|sn|so|sr|st|su|sv|sy|sz|tc|td|tel|tf|tg|th|tj|tk|tl|tm' . '|tn|to|tp|tr|travel|tt|tv|tw|tz|ua|ug|uk|us|uy|uz|va|vc|ve' . '|vg|vi|vn|vu|wf|ws|xn--0zwm56d|xn--11b5bs3a9aj6g' . '|xn--80akhbyknj4f|xn--9t4b11yi5a|xn--deba0ad|xn--g6w251d' . '|xn--hgbk6aj7f53bba|xn--hlcj6aya9esc7a|xn--jxalpdlp' . '|xn--kgbechtv|xn--zckzah|ye|yt|yu|za|zm|zw)\\.?$/'
A regular expression that matches a domain ending in a top-level domains.
filter_extractReturnURL()  : Auth_OpenID_ServiceEndpoint|null
If the endpoint is a relying party OpenID return_to endpoint, return the endpoint URL. Otherwise, return None.
Auth_OpenID_extractReturnURL()  : mixed
Auth_OpenID_returnToMatches()  : mixed
Auth_OpenID_getAllowedReturnURLs()  : mixed
Auth_OpenID_verifyReturnTo()  : mixed

Constants

Auth_OpenID___HostSegmentRe

public mixed Auth_OpenID___HostSegmentRe = "/^(?:[-a-zA-Z0-9!\$&'\\(\\)\\*+,;=._~]|%[a-zA-Z0-9]{2})*\$/"

Auth_OpenID___TLDs

A regular expression that matches a domain ending in a top-level domains.

public mixed Auth_OpenID___TLDs = '/\\.(ac|ad|ae|aero|af|ag|ai|al|am|an|ao|aq|ar|arpa|as|asia' . '|at|au|aw|ax|az|ba|bb|bd|be|bf|bg|bh|bi|biz|bj|bm|bn|bo|br' . '|bs|bt|bv|bw|by|bz|ca|cat|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|co' . '|com|coop|cr|cu|cv|cx|cy|cz|de|dj|dk|dm|do|dz|ec|edu|ee|eg' . '|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gg|gh|gi|gl' . '|gm|gn|gov|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie' . '|il|im|in|info|int|io|iq|ir|is|it|je|jm|jo|jobs|jp|ke|kg|kh' . '|ki|km|kn|kp|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly' . '|ma|mc|md|me|mg|mh|mil|mk|ml|mm|mn|mo|mobi|mp|mq|mr|ms|mt' . '|mu|museum|mv|mw|mx|my|mz|na|name|nc|ne|net|nf|ng|ni|nl|no' . '|np|nr|nu|nz|om|org|pa|pe|pf|pg|ph|pk|pl|pm|pn|pr|pro|ps|pt' . '|pw|py|qa|re|ro|rs|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj|sk|sl' . '|sm|sn|so|sr|st|su|sv|sy|sz|tc|td|tel|tf|tg|th|tj|tk|tl|tm' . '|tn|to|tp|tr|travel|tt|tv|tw|tz|ua|ug|uk|us|uy|uz|va|vc|ve' . '|vg|vi|vn|vu|wf|ws|xn--0zwm56d|xn--11b5bs3a9aj6g' . '|xn--80akhbyknj4f|xn--9t4b11yi5a|xn--deba0ad|xn--g6w251d' . '|xn--hgbk6aj7f53bba|xn--hlcj6aya9esc7a|xn--jxalpdlp' . '|xn--kgbechtv|xn--zckzah|ye|yt|yu|za|zm|zw)\\.?$/'

Used in checking trust roots for sanity.

Tags
access

private

Functions

filter_extractReturnURL()

If the endpoint is a relying party OpenID return_to endpoint, return the endpoint URL. Otherwise, return None.

filter_extractReturnURL(Auth_OpenID_ServiceEndpoint $endpoint) : Auth_OpenID_ServiceEndpoint|null

This function is intended to be used as a filter for the Yadis filtering interface.

Parameters
$endpoint : Auth_OpenID_ServiceEndpoint

An XRDS BasicServiceEndpoint, as returned by performing Yadis dicovery.

Tags
see:

C{L{openid.yadis.services}}

see:

C{L{openid.yadis.filters}}

Return values
Auth_OpenID_ServiceEndpoint|null

The endpoint URL or None if the endpoint is not a relying party endpoint.

Auth_OpenID_extractReturnURL()

& Auth_OpenID_extractReturnURL(mixed &$endpoint_list) : mixed
Parameters
$endpoint_list : mixed
Return values
mixed

Auth_OpenID_returnToMatches()

Auth_OpenID_returnToMatches(mixed $allowed_return_to_urls, mixed $return_to) : mixed
Parameters
$allowed_return_to_urls : mixed
$return_to : mixed
Return values
mixed

Auth_OpenID_getAllowedReturnURLs()

Auth_OpenID_getAllowedReturnURLs(mixed $relying_party_url, mixed $fetcher[, mixed $discover_function = null ]) : mixed
Parameters
$relying_party_url : mixed
$fetcher : mixed
$discover_function : mixed = null
Return values
mixed

Auth_OpenID_verifyReturnTo()

Auth_OpenID_verifyReturnTo(mixed $realm_str, mixed $return_to, mixed $fetcher[, mixed $_vrfy = 'Auth_OpenID_getAllowedReturnURLs' ]) : mixed
Parameters
$realm_str : mixed
$return_to : mixed
$fetcher : mixed
$_vrfy : mixed = 'Auth_OpenID_getAllowedReturnURLs'
Return values
mixed

Search results