[ class tree: OpenID ] [ index: OpenID ] [ all elements ]

Class: Auth_OpenID_TrustRoot

Source Location: /zp-extensions/federated_logon/Auth/OpenID/TrustRoot.php

Class Auth_OpenID_TrustRoot

Class Overview

A wrapper for trust-root related functions

Located in /zp-extensions/federated_logon/Auth/OpenID/TrustRoot.php [line 49]



		
		
		
		

Methods

[ Top ]
Method Summary
static void   buildDiscoveryURL()  
static bool   isSane()   Is this trust root sane?
static bool   match()   Does this URL match the given trust root?

[ Top ]
Methods
static method buildDiscoveryURL  [line 61]

  static void buildDiscoveryURL( $realm  )

Parameters:
   $realm: 


[ Top ]
static method isSane  [line 202]

  static bool isSane( string $trust_root  )

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

API Tags:
Return:  Whether the trust root looks OK


[ Top ]
static method match  [line 272]

  static bool match( string $trust_root, string $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

API Tags:
Return:  Whether the URL matches against the trust root


[ Top ]

Documentation generated on Tue, 20 Dec 2011 16:08:17 +0100 by phpDocumentor 1.4.3