JanRain OpenID Library

Documentation

Packages

OpenID

Interfaces, Classes, Traits and Enums

Auth_OpenID_Association: This class represents an association between a server and a consumer. In general, users of this library will never see instances of this object. The only exception is if you implement a custom {@link Auth_OpenID_OpenIDStore}.
Auth_OpenID_SessionNegotiator: A session negotiator controls the allowed and preferred association types and association session types. Both the {@link Auth_OpenID_Consumer} and {@link Auth_OpenID_Server} use negotiators when creating associations.
Auth_OpenID_AX: AX utility class.
Auth_OpenID_AX_Error: Results from data that does not meet the attribute exchange 1.0 specification
Auth_OpenID_AX_Message: Abstract class containing common code for attribute exchange messages.
Auth_OpenID_AX_AttrInfo: Represents a single attribute in an attribute exchange request. This should be added to an AXRequest object in order to request the attribute.
Auth_OpenID_AX_FetchRequest: An attribute exchange 'fetch_request' message. This message is sent by a relying party when it wishes to obtain attributes about the subject of an OpenID authentication request.
Auth_OpenID_AX_KeyValueMessage: An abstract class that implements a message that has attribute keys and values. It contains the common code between fetch_response and store_request.
Auth_OpenID_AX_FetchResponse: A fetch_response attribute exchange message.
Auth_OpenID_AX_StoreRequest: A store request attribute exchange message representation.
Auth_OpenID_AX_StoreResponse: An indication that the store request was processed along with this OpenID transaction. Use make(), NOT the constructor, to create response objects.
Auth_OpenID_MathLibrary: The superclass of all big-integer math implementations
Auth_OpenID_BcMathWrapper: Exposes BCmath math library functionality.
Auth_OpenID_GmpMathWrapper: Exposes GMP math library functionality.
Auth_OpenID_Consumer: An OpenID consumer implementation that performs discovery and does session management. See the Consumer.php file documentation for more information.
Auth_OpenID_DiffieHellmanSHA1ConsumerSession: A class implementing HMAC/DH-SHA1 consumer sessions.
Auth_OpenID_DiffieHellmanSHA256ConsumerSession: A class implementing HMAC/DH-SHA256 consumer sessions.
Auth_OpenID_PlainTextConsumerSession: A class implementing plaintext consumer sessions.
Auth_OpenID_GenericConsumer: This class is the interface to the OpenID consumer logic.
Auth_OpenID_AuthRequest: This class represents an authentication request from a consumer to an OpenID server.
Auth_OpenID_ConsumerResponse: The base class for responses from the Auth_OpenID_Consumer.
Auth_OpenID_SuccessResponse: A response with a status of Auth_OpenID_SUCCESS. Indicates that this request is a successful acknowledgement from the OpenID server that the supplied URL is, indeed controlled by the requesting agent. This has three relevant attributes:
Auth_OpenID_FailureResponse: A response with a status of Auth_OpenID_FAILURE. Indicates that the OpenID protocol has failed. This could be locally or remotely triggered. This has three relevant attributes:
Auth_OpenID_TypeURIMismatch: A specific, internal failure used to detect type URI mismatch.
Auth_OpenID_ServerErrorContainer: Exception that is raised when the server returns a 400 response code to a direct request.
Auth_OpenID_CancelResponse: A response with a status of Auth_OpenID_CANCEL. Indicates that the user cancelled the OpenID authentication request. This has two relevant attributes:
Auth_OpenID_SetupNeededResponse: A response with a status of Auth_OpenID_SETUP_NEEDED. Indicates that the request was in immediate mode, and the server is unable to authenticate the user without further interaction.
Auth_OpenID_CryptUtil
Auth_OpenID_DatabaseConnection: An empty base class intended to emulate PEAR connection functionality in applications that supply their own database abstraction mechanisms. See {@link Auth_OpenID_SQLStore} for more information. You should subclass this class if you need to create an SQL store that needs to access its database using an application's database abstraction layer instead of a PEAR database connection. Any subclass of Auth_OpenID_DatabaseConnection MUST adhere to the interface specified here.
Auth_OpenID_DiffieHellman: The Diffie-Hellman key exchange class. This class relies on {@link Auth_OpenID_MathLibrary} to perform large number operations.
Auth_OpenID_ServiceEndpoint: Object representing an OpenID service endpoint.
Auth_OpenID_DumbStore: This is a store for use in the worst case, when you have no way of saving state on the consumer site. Using this store makes the consumer vulnerable to replay attacks, as it's unable to use nonces. Avoid using this store if it is at all possible.
Auth_OpenID_Extension: A base class for accessing extension request and response data for the OpenID 2 protocol.
Auth_OpenID_FileStore: This is a filesystem-based store for OpenID associations and nonces. This store should be safe for use in concurrent systems on both windows and unix (excluding NFS filesystems). There are a couple race conditions in the system, but those failure cases have been set up in such a way that the worst-case behavior is someone having to try to log in a second time.
Auth_OpenID_OpenIDStore: This is the interface for the store objects the OpenID library uses. It is a single class that provides all of the persistence mechanisms that the OpenID library needs, for both servers and consumers. If you want to create an SQL-driven store, please see then {@link Auth_OpenID_SQLStore} class.
Auth_OpenID_KVForm: Container for key-value/comma-newline OpenID format and parsing
Auth_OpenID_MDB2Store: This store uses a PEAR::MDB2 connection to store persistence information.
Auth_OpenID_MemcachedStore: This is a memcached-based store for OpenID associations and nonces.
Auth_OpenID_Mapping: An Auth_OpenID_Mapping maintains a mapping from arbitrary keys to arbitrary values. (This is unlike an ordinary PHP array, whose keys may be only simple scalars.)
Auth_OpenID_NamespaceMap: Maintains a bijective map between namespace uris and aliases.
Auth_OpenID_Message: In the implementation of this object, null represents the global namespace as well as a namespace with no key.
Auth_OpenID_MySQLStore: An SQL store that uses MySQL as its backend.
Auth_OpenID_PAPE_Request: A Provider Authentication Policy request, sent from a relying party to a provider
Auth_OpenID_PAPE_Response: A Provider Authentication Policy response, sent from a provider to a relying party
Auth_OpenID_Parse
Auth_OpenID_PostgreSQLStore: An SQL store that uses PostgreSQL as its backend.
Auth_OpenID_PredisStore: Supplies Redis server store backend for OpenID servers and consumers.
Auth_OpenID_ServerError: An error class which gets instantiated and returned whenever an OpenID protocol error occurs. Be prepared to use this in place of an ordinary server response.
Auth_OpenID_NoReturnToError: Error returned by the server code when a return_to is absent from a request.
Auth_OpenID_MalformedReturnURL: An error indicating that the return_to URL is malformed.
Auth_OpenID_MalformedTrustRoot: This error is returned when the trust_root value is malformed.
Auth_OpenID_Request: The base class for all server request classes.
Auth_OpenID_CheckAuthRequest: A request to verify the validity of a previous response.
Auth_OpenID_PlainTextServerSession: A class implementing plaintext server sessions.
Auth_OpenID_DiffieHellmanSHA1ServerSession: A class implementing DH-SHA1 server sessions.
Auth_OpenID_DiffieHellmanSHA256ServerSession: A class implementing DH-SHA256 server sessions.
Auth_OpenID_AssociateRequest: A request to associate with the server.
Auth_OpenID_CheckIDRequest: A request to confirm the identity of a user.
Auth_OpenID_ServerResponse: This class encapsulates the response to an OpenID server request.
Auth_OpenID_WebResponse: A web-capable response object which you can use to generate a user-agent response.
Auth_OpenID_Signatory: Responsible for the signature of query data and the verification of OpenID signature values.
Auth_OpenID_Encoder: Encode an {@link Auth_OpenID_ServerResponse} to an {@link Auth_OpenID_WebResponse}.
Auth_OpenID_SigningEncoder: An encoder which also takes care of signing fields when required.
Auth_OpenID_Decoder: Decode an incoming query into an Auth_OpenID_Request.
Auth_OpenID_EncodingError: An error that indicates an encoding problem occurred.
Auth_OpenID_AlreadySigned: An error that indicates that a response was already signed.
Auth_OpenID_UntrustedReturnURL: An error that indicates that the given return_to is not under the given trust_root.
Auth_OpenID_Server: I handle requests for an OpenID server.
Auth_OpenID_ServerRequest: Object that holds the state of a request to the OpenID server
Auth_OpenID_SQLiteStore: An SQL store that uses SQLite as its backend.
Auth_OpenID_SQLStore: This is the parent class for the SQL stores, which contains the logic common to all of the SQL stores.
Auth_OpenID_SRegBase: A base class for classes dealing with Simple Registration protocol messages.
Auth_OpenID_SRegRequest: An object to hold the state of a simple registration request.
Auth_OpenID_SRegResponse: Represents the data returned in a simple registration response inside of an OpenID C{id_res} response. This object will be created by the OpenID server, added to the C{id_res} response object, and then extracted from the C{id_res} message by the Consumer.
Auth_OpenID_TrustRoot: A wrapper for trust-root related functions
Auth_OpenID: The OpenID utility function class.
Auth_Yadis_HTTPResponse
Auth_Yadis_HTTPFetcher: This class is the interface for HTTP fetchers the Yadis library uses. This interface is only important if you need to write a new fetcher for some reason.
Auth_Yadis_PHPSession: The base session class used by the Auth_Yadis_Manager. This class wraps the default PHP session machinery and should be subclassed if your application doesn't use PHP sessioning.
Auth_Yadis_SessionLoader: A session helper class designed to translate between arrays and objects. Note that the class used must have a constructor that takes no parameters. This is not a general solution, but it works for dumb objects that just need to have attributes set. The idea is that you'll subclass this and override $this->check($data) -> bool to implement your own session data validation.
Auth_OpenID_ServiceEndpointLoader: A concrete loader implementation for Auth_OpenID_ServiceEndpoints.
Auth_Yadis_ManagerLoader: A concrete loader implementation for Auth_Yadis_Managers.
Auth_Yadis_Manager: The Yadis service manager which stores state in a session and iterates over <Service> elements in a Yadis XRDS document and lets a caller attempt to use each one. This is used by the Yadis library internally.
Auth_Yadis_Discovery: State management for discovery.
Auth_Yadis_ParanoidHTTPFetcher: A paranoid {@link Auth_Yadis_HTTPFetcher} class which uses CURL for fetching.
Auth_Yadis_ParseHTML: This class is responsible for scanning an HTML string to find META tags and their attributes. This is used by the Yadis discovery process. This class must be instantiated to be used.
Auth_Yadis_PlainHTTPFetcher: This class implements a plain, hand-built socket-based fetcher which will be used in the event that CURL is unavailable.
Auth_Yadis_XMLParser: The base class for wrappers for available PHP XML-parsing extensions. To work with this Yadis library, subclasses of this class MUST implement the API as defined in the remarks for this class. Subclasses of Auth_Yadis_XMLParser are used to wrap particular PHP XML extensions such as 'domxml'. These are used internally by the library depending on the availability of supported PHP XML extensions.
Auth_Yadis_domxml: This concrete implementation of Auth_Yadis_XMLParser implements the appropriate API for the 'domxml' extension which is typically packaged with PHP 4. This class will be used whenever the 'domxml' extension is detected. See the Auth_Yadis_XMLParser class for details on this class's methods.
Auth_Yadis_dom: This concrete implementation of Auth_Yadis_XMLParser implements the appropriate API for the 'dom' extension which is typically packaged with PHP 5. This class will be used whenever the 'dom' extension is detected. See the Auth_Yadis_XMLParser class for details on this class's methods.
Auth_Yadis_Service: This class represents a <Service> element in an XRDS document.
Auth_Yadis_XRDS: This class performs parsing of XRDS documents.
Auth_Yadis_ProxyResolver
Auth_Yadis_DiscoveryResult: Contains the result of performing Yadis discovery on a URI.
Auth_Yadis_Yadis: This is the core of the PHP Yadis library. This is the only class a user needs to use to perform Yadis discovery. This class performs the discovery AND stores the result of the discovery.

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.
Auth_OpenID_AX_MINIMUM_SUPPORTED_ALIAS_LENGTH = 32
Auth_OpenID_AX_NS_URI = 'http://openid.net/srv/ax/1.0'
Auth_OpenID_AX_UNLIMITED_VALUES = 'unlimited'
Auth_OpenID_BARE_NS = 'Bare namespace'
Auth_OpenID_CANCEL = 'cancel': Status to indicate cancellation of OpenID authentication.
Auth_OpenID_digits = "0123456789"
Auth_OpenID_DO_ABOUT = 'do_about': Status code returned when there were no OpenID arguments passed. This code indicates that the caller should return a 200 OK response and display an HTML page that says that this is an OpenID server endpoint.
Auth_OpenID_DO_AUTH = 'do_auth': Status code returned when the caller needs to authenticate the user. The associated value is a {@link Auth_OpenID_ServerRequest} object that can be used to complete the authentication. If the user has taken some authentication action, use the retry() method of the {@link Auth_OpenID_ServerRequest} object to complete the request.
Auth_OpenID_ENCODE_HTML_FORM = 'HTML form'
Auth_OpenID_ENCODE_KVFORM = 'kfvorm'
Auth_OpenID_ENCODE_URL = 'URL/redirect'
Auth_OpenID_FAILURE = 'failure': This is the status code completeAuth returns when the value it received indicated an invalid login.
Auth_OpenID_FETCHER_MAX_RESPONSE_KB = 1024
Auth_OpenID_HMACSHA256_SUPPORTED = \false
AUTH_OPENID_HTTP_ERROR = 400
AUTH_OPENID_HTTP_OK = 200
AUTH_OPENID_HTTP_REDIRECT = 302
Auth_OpenID_IDENTIFIER_SELECT = "http://specs.openid.net/auth/2.0/identifier_select"
Auth_OpenID_letters = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ": Defines for regexes and format checking.
Auth_OpenID_LOCAL_ERROR = 'local_error': Status code returned by the server when the only option is to show an error page, since we do not have enough information to redirect back to the consumer. The associated value is an error message that should be displayed on an HTML error page.
Auth_OpenID_NO_DEFAULT = 'NO DEFAULT ALLOWED'
Auth_OpenID_NO_MATH_SUPPORT = true
Auth_OpenID_Nonce_CHRS = "abcdefghijklmnopqrstuvwxyz" . "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789": This is the characters that the nonces are made from.
Auth_OpenID_Nonce_REGEX = '/(\\d{4})-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)Z(.*)/'
Auth_OpenID_Nonce_TIME_FMT = '%Y-%m-%dT%H:%M:%SZ'
Auth_OpenID_NULL_NAMESPACE = 'Null namespace'
Auth_OpenID_OPENID1_NS = 'http://openid.net/signon/1.0'
Auth_OpenID_OPENID1_URL_LIMIT = 2047
Auth_OpenID_OPENID2_NS = 'http://specs.openid.net/auth/2.0'
Auth_OpenID_OPENID_NS = 'OpenID namespace'
Auth_OpenID_PAPE_NS_URI = "http://specs.openid.net/extensions/pape/1.0"
Auth_OpenID_PARSE_ERROR = 'parse error': This is the status code beginAuth returns when the page fetched from the entered OpenID URL doesn't contain the necessary link tags to function as an identity page.
Auth_OpenID_punct = "!\"#\$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
Auth_OpenID_RAND_SOURCE = '/dev/urandom': The filename for a source of random bytes. Define this yourself if you have a different source of randomness.
Auth_OpenID_REDIRECT = 'redirect': Status code returned when there is a redirect back to the consumer. The value is the URL to redirect back to. The caller should return a 302 Found redirect with a Location: header containing the URL.
Auth_OpenID_REMOTE_ERROR = 'remote_error': Status code returned when there is an error to return in key-value form to the consumer. The caller should return a 400 Bad Request response with content-type text/plain and the value as the body.
Auth_OpenID_REMOTE_OK = 'remote_ok': Status code returned when there is a key-value form OK response to the consumer. The value associated with this code is the response. The caller should return a 200 OK response with content-type text/plain and the value as the body.
Auth_OpenID_RP_RETURN_TO_URL_TYPE = 'http://specs.openid.net/auth/2.0/return_to'
Auth_OpenID_SETUP_NEEDED = 'setup needed': This is the status code completeAuth returns when the {@link Auth_OpenID_Consumer} instance is in immediate mode, and the identity server sends back a URL to send the user to to complete his or her login.
Auth_OpenID_SHA1_BLOCKSIZE = 64: SHA1_BLOCKSIZE is this module's SHA1 blocksize used by the fallback implementation.
Auth_OpenID_SHA256_SUPPORTED = \false
Auth_OpenID_SREG_NS_URI = \Auth_OpenID_SREG_NS_URI_1_1
Auth_OpenID_SREG_NS_URI_1_0 = 'http://openid.net/sreg/1.0'
Auth_OpenID_SREG_NS_URI_1_1 = 'http://openid.net/extensions/sreg/1.1'
Auth_OpenID_SREG_URI = 'http://openid.net/sreg/1.0'
Auth_OpenID_SUCCESS = 'success': This is the status code returned when the complete method returns successfully.
Auth_OpenID_THE_OTHER_OPENID1_NS = 'http://openid.net/signon/1.1'
Auth_OpenID_TYPE_1_0 = 'http://openid.net/signon/1.0'
Auth_OpenID_TYPE_1_1 = 'http://openid.net/signon/1.1'
Auth_OpenID_TYPE_1_2 = 'http://openid.net/signon/1.2'
Auth_OpenID_TYPE_2_0 = 'http://specs.openid.net/auth/2.0/signon'
Auth_OpenID_TYPE_2_0_IDP = 'http://specs.openid.net/auth/2.0/server'
Auth_OpenID_USER_AGENT = 'php-openid/' . \Auth_OpenID_VERSION . ' (php/' . \phpversion() . ')'
Auth_OpenID_VERSION = '3.0.3': The library version string
Auth_OpenID_XMLNS_1_0 = 'http://openid.net/xmlns/1.0'
Auth_Yadis_CONTENT_TYPE = 'application/xrds+xml': XRDS (yadis) content type
Auth_Yadis_HEADER_NAME = 'X-XRDS-Location': Yadis header
Auth_Yadis_XMLNS_XRD_2_0 = 'xri://$xrd*($v*2.0)': XRD XML namespace
Auth_Yadis_XMLNS_XRDS = 'xri://$xrds': XRDS XML namespace
PAPE_AUTH_MULTI_FACTOR = 'http://schemas.openid.net/pape/policies/2007/06/multi-factor'
PAPE_AUTH_MULTI_FACTOR_PHYSICAL = 'http://schemas.openid.net/pape/policies/2007/06/multi-factor-physical'
PAPE_AUTH_PHISHING_RESISTANT = 'http://schemas.openid.net/pape/policies/2007/06/phishing-resistant'
PAPE_TIME_VALIDATOR = '/^[0-9]{4,4}-[0-9][0-9]-[0-9][0-9]T[0-9][0-9]:[0-9][0-9]:[0-9][0-9]Z$/'
SERVICES_YADIS_MATCH_ALL = 101: This match mode means a given service must match ALL filters passed to the Auth_Yadis_XRDS::services() call.
SERVICES_YADIS_MATCH_ANY = 102: This match mode means a given service must match ANY filters (at least one) passed to the Auth_Yadis_XRDS::services() call.
SERVICES_YADIS_MAX_PRIORITY = \pow(2, 30): The priority value used for service elements with no priority specified.
Auth_OpenID_getSecretSize() : mixed
Auth_OpenID_getAllAssociationTypes() : mixed
Auth_OpenID_getSupportedAssociationTypes() : mixed
Auth_OpenID_getSessionTypes() : mixed
Auth_OpenID_checkSessionType() : mixed
Auth_OpenID_getDefaultAssociationOrder() : mixed
Auth_OpenID_getOnlyEncryptedOrder() : mixed
Auth_OpenID_getDefaultNegotiator() : mixed
Auth_OpenID_getEncryptedNegotiator() : mixed
Auth_OpenID_AX_checkAlias() : Auth_OpenID_AX_Error|bool: Check an alias for invalid characters; raise AXError if any are found. Return None if the alias is valid.
Auth_OpenID_AX_toTypeURIs() : array<string|int, string>|Auth_OpenID_AX_Error: Given a namespace mapping and a string containing a comma-separated list of namespace aliases, return a list of type URIs that correspond to those aliases.
Auth_OpenID_math_extensions() : mixed: Define the supported extensions. An extension array has keys 'modules', 'extension', and 'class'. 'modules' is an array of PHP module names which the loading code will attempt to load. These values will be suffixed with a library file extension (e.g. ".so").
Auth_OpenID_detectMathLibrary() : bool: Detect which (if any) math library is available
Auth_OpenID_getMathLib() : Auth_OpenID_MathLibrary|null: {@link Auth_OpenID_getMathLib} checks for the presence of long number extension modules and returns an instance of {@link Auth_OpenID_MathWrapper} which exposes the module's functionality.
Auth_OpenID_setNoMathSupport() : mixed
Auth_OpenID_noMathSupport() : mixed
Auth_OpenID_getAvailableSessionTypes() : mixed: Returns available session types.
Auth_OpenID_getDefaultMod() : mixed
Auth_OpenID_getDefaultGen() : mixed
Auth_OpenID_getOpenIDTypeURIs() : mixed
Auth_OpenID_getOpenIDConsumerTypeURIs() : mixed
Auth_OpenID_getOpenIDTypeName() : mixed
Auth_OpenID_findOPLocalIdentifier() : bool|null
filter_MatchesAnyOpenIDType() : bool
filter_MatchesAnyOpenIDConsumerType() : bool
Auth_OpenID_bestMatchingService() : mixed
Auth_OpenID_arrangeByType() : mixed
Auth_OpenID_getOPOrUserServices() : mixed
Auth_OpenID_makeOpenIDEndpoints() : array<string|int, mixed>
Auth_OpenID_discoverWithYadis() : mixed
Auth_OpenID_discoverURI() : mixed
Auth_OpenID_discoverWithoutYadis() : array<string|int, mixed>
Auth_OpenID_discoverXRI() : mixed
Auth_OpenID_discover() : array<string|int, mixed>
Auth_OpenID_SHA1() : mixed
Auth_OpenID_HMACSHA1() : string: Compute an HMAC/SHA1 hash.
Auth_OpenID_SHA256() : mixed
Auth_OpenID_HMACSHA256() : mixed
Auth_OpenID_isOpenID1() : mixed
Auth_OpenID_registerNamespaceAlias() : bool: Registers a (namespace URI, alias) mapping in a global namespace alias map. Raises NamespaceAliasRegistrationError if either the namespace URI or alias has already been registered with a different value. This function is required if you want to use a namespace with an OpenID 1 message.
Auth_OpenID_removeNamespaceAlias() : bool: Removes a (namespace_uri, alias) registration from the global namespace alias map. Returns true if the removal succeeded; false if not (if the mapping did not exist).
Auth_OpenID_splitNonce() : mixed
Auth_OpenID_checkTimestamp() : mixed
Auth_OpenID_mkNonce() : mixed
Auth_OpenID_legacy_discover() : mixed
Auth_OpenID_isError() : bool
Auth_OpenID_checkFieldName() : bool: Check to see that the given value is a valid simple registration data field name. Return true if so, false if not.
Auth_OpenID_supportsSReg() : bool: Does the given endpoint advertise support for simple registration?
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
Auth_OpenID_getURIPattern() : mixed
Auth_OpenID_getAuthorityPattern() : mixed
Auth_OpenID_getEncodedPattern() : mixed
Auth_OpenID_getURLIllegalCharRE() : mixed
Auth_OpenID_getUnreserved() : mixed
Auth_OpenID_getEscapeRE() : mixed
Auth_OpenID_pct_encoded_replace_unreserved() : mixed
Auth_OpenID_pct_encoded_replace() : mixed
Auth_OpenID_remove_dot_segments() : mixed
Auth_OpenID_urinorm() : mixed
Auth_OpenID_include_init() : mixed
Auth_Yadis_getUCSChars() : mixed: Miscellaneous utility values and functions for OpenID and Yadis.
Auth_Yadis_getIPrivateChars() : mixed
Auth_Yadis_pct_escape_unicode() : mixed
Auth_Yadis_startswith() : mixed
Auth_Yadis_setDefaultParser() : mixed: Set a default parser to override the extension-driven selection of available parser classes. This is helpful in a test environment or one in which multiple parsers can be used but one is more desirable.
Auth_Yadis_getSupportedExtensions() : mixed
Auth_Yadis_getXMLParser() : Auth_Yadis_XMLParser|bool: Returns an instance of a Auth_Yadis_XMLParser subclass based on the availability of PHP extensions for XML parsing. If Auth_Yadis_setDefaultParser has been called, the parser used in that call will be returned instead.
Auth_Yadis_getNSMap() : mixed
Auth_Yadis_array_scramble() : array<string|int, mixed>
Auth_Yadis_getXRDExpiration() : mixed
Auth_Yadis_getDefaultProxy() : mixed
Auth_Yadis_getXRIAuthorities() : mixed
Auth_Yadis_getEscapeRE() : mixed
Auth_Yadis_getXrefRE() : mixed
Auth_Yadis_identifierScheme() : mixed
Auth_Yadis_toIRINormal() : mixed
_escape_xref() : mixed
Auth_Yadis_escapeForIRI() : mixed
Auth_Yadis_toURINormal() : mixed
Auth_Yadis_iriToURI() : mixed
Auth_Yadis_XRIAppendArgs() : mixed
Auth_Yadis_providerIsAuthoritative() : mixed
Auth_Yadis_rootAuthority() : mixed
Auth_Yadis_XRI() : mixed
Auth_Yadis_getCanonicalID() : bool|string
Auth_Yadis_getServiceEndpoints() : string: Perform the Yadis protocol on the input URL and return an iterable of resulting endpoint objects.

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.

Auth_OpenID_AX_MINIMUM_SUPPORTED_ALIAS_LENGTH


    public
        mixed
    Auth_OpenID_AX_MINIMUM_SUPPORTED_ALIAS_LENGTH
    = 32

Auth_OpenID_AX_NS_URI


    public
        mixed
    Auth_OpenID_AX_NS_URI
    = 'http://openid.net/srv/ax/1.0'

Auth_OpenID_AX_UNLIMITED_VALUES


    public
        mixed
    Auth_OpenID_AX_UNLIMITED_VALUES
    = 'unlimited'

Auth_OpenID_BARE_NS


    public
        mixed
    Auth_OpenID_BARE_NS
    = 'Bare namespace'

Auth_OpenID_CANCEL

Status to indicate cancellation of OpenID authentication.


    public
        mixed
    Auth_OpenID_CANCEL
    = 'cancel'

Auth_OpenID_digits


    public
        mixed
    Auth_OpenID_digits
    = "0123456789"

Auth_OpenID_DO_ABOUT

Status code returned when there were no OpenID arguments passed. This code indicates that the caller should return a 200 OK response and display an HTML page that says that this is an OpenID server endpoint.


    public
        mixed
    Auth_OpenID_DO_ABOUT
    = 'do_about'

Auth_OpenID_DO_AUTH

Status code returned when the caller needs to authenticate the user. The associated value is a {@link Auth_OpenID_ServerRequest} object that can be used to complete the authentication. If the user has taken some authentication action, use the retry() method of the {@link Auth_OpenID_ServerRequest} object to complete the request.


    public
        mixed
    Auth_OpenID_DO_AUTH
    = 'do_auth'

Auth_OpenID_ENCODE_HTML_FORM


    public
        mixed
    Auth_OpenID_ENCODE_HTML_FORM
    = 'HTML form'

Auth_OpenID_ENCODE_KVFORM


    public
        mixed
    Auth_OpenID_ENCODE_KVFORM
    = 'kfvorm'

Auth_OpenID_ENCODE_URL


    public
        mixed
    Auth_OpenID_ENCODE_URL
    = 'URL/redirect'

Auth_OpenID_FAILURE

This is the status code completeAuth returns when the value it received indicated an invalid login.


    public
        mixed
    Auth_OpenID_FAILURE
    = 'failure'

Auth_OpenID_FETCHER_MAX_RESPONSE_KB


    public
        mixed
    Auth_OpenID_FETCHER_MAX_RESPONSE_KB
    = 1024

Auth_OpenID_HMACSHA256_SUPPORTED


    public
        mixed
    Auth_OpenID_HMACSHA256_SUPPORTED
    = \false

AUTH_OPENID_HTTP_ERROR


    public
        mixed
    AUTH_OPENID_HTTP_ERROR
    = 400

AUTH_OPENID_HTTP_OK


    public
        mixed
    AUTH_OPENID_HTTP_OK
    = 200

AUTH_OPENID_HTTP_REDIRECT


    public
        mixed
    AUTH_OPENID_HTTP_REDIRECT
    = 302

Auth_OpenID_IDENTIFIER_SELECT


    public
        mixed
    Auth_OpenID_IDENTIFIER_SELECT
    = "http://specs.openid.net/auth/2.0/identifier_select"

Auth_OpenID_letters

Defines for regexes and format checking.


    public
        mixed
    Auth_OpenID_letters
    = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"

Auth_OpenID_LOCAL_ERROR

Status code returned by the server when the only option is to show an error page, since we do not have enough information to redirect back to the consumer. The associated value is an error message that should be displayed on an HTML error page.


    public
        mixed
    Auth_OpenID_LOCAL_ERROR
    = 'local_error'

Auth_OpenID_NO_DEFAULT


    public
        mixed
    Auth_OpenID_NO_DEFAULT
    = 'NO DEFAULT ALLOWED'

Auth_OpenID_NO_MATH_SUPPORT


    public
        mixed
    Auth_OpenID_NO_MATH_SUPPORT
    = true

Auth_OpenID_Nonce_CHRS

This is the characters that the nonces are made from.


    public
        mixed
    Auth_OpenID_Nonce_CHRS
    = "abcdefghijklmnopqrstuvwxyz" . "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"

Auth_OpenID_Nonce_REGEX


    public
        mixed
    Auth_OpenID_Nonce_REGEX
    = '/(\\d{4})-(\\d\\d)-(\\d\\d)T(\\d\\d):(\\d\\d):(\\d\\d)Z(.*)/'

Auth_OpenID_Nonce_TIME_FMT


    public
        mixed
    Auth_OpenID_Nonce_TIME_FMT
    = '%Y-%m-%dT%H:%M:%SZ'

Auth_OpenID_NULL_NAMESPACE


    public
        mixed
    Auth_OpenID_NULL_NAMESPACE
    = 'Null namespace'

Auth_OpenID_OPENID1_NS


    public
        mixed
    Auth_OpenID_OPENID1_NS
    = 'http://openid.net/signon/1.0'

Auth_OpenID_OPENID1_URL_LIMIT


    public
        mixed
    Auth_OpenID_OPENID1_URL_LIMIT
    = 2047

Auth_OpenID_OPENID2_NS


    public
        mixed
    Auth_OpenID_OPENID2_NS
    = 'http://specs.openid.net/auth/2.0'

Auth_OpenID_OPENID_NS


    public
        mixed
    Auth_OpenID_OPENID_NS
    = 'OpenID namespace'

Auth_OpenID_PAPE_NS_URI


    public
        mixed
    Auth_OpenID_PAPE_NS_URI
    = "http://specs.openid.net/extensions/pape/1.0"

Auth_OpenID_PARSE_ERROR

This is the status code beginAuth returns when the page fetched from the entered OpenID URL doesn't contain the necessary link tags to function as an identity page.


    public
        mixed
    Auth_OpenID_PARSE_ERROR
    = 'parse error'

Auth_OpenID_punct


    public
        mixed
    Auth_OpenID_punct
    = "!\"#\$%&'()*+,-./:;<=>?@[\\]^_`{|}~"

Auth_OpenID_RAND_SOURCE

The filename for a source of random bytes. Define this yourself if you have a different source of randomness.


    public
        mixed
    Auth_OpenID_RAND_SOURCE
    = '/dev/urandom'

Auth_OpenID_REDIRECT

Status code returned when there is a redirect back to the consumer. The value is the URL to redirect back to. The caller should return a 302 Found redirect with a Location: header containing the URL.


    public
        mixed
    Auth_OpenID_REDIRECT
    = 'redirect'

Auth_OpenID_REMOTE_ERROR

Status code returned when there is an error to return in key-value form to the consumer. The caller should return a 400 Bad Request response with content-type text/plain and the value as the body.


    public
        mixed
    Auth_OpenID_REMOTE_ERROR
    = 'remote_error'

Auth_OpenID_REMOTE_OK

Status code returned when there is a key-value form OK response to the consumer. The value associated with this code is the response. The caller should return a 200 OK response with content-type text/plain and the value as the body.


    public
        mixed
    Auth_OpenID_REMOTE_OK
    = 'remote_ok'

Auth_OpenID_RP_RETURN_TO_URL_TYPE


    public
        mixed
    Auth_OpenID_RP_RETURN_TO_URL_TYPE
    = 'http://specs.openid.net/auth/2.0/return_to'

Auth_OpenID_SETUP_NEEDED

This is the status code completeAuth returns when the {@link Auth_OpenID_Consumer} instance is in immediate mode, and the identity server sends back a URL to send the user to to complete his or her login.


    public
        mixed
    Auth_OpenID_SETUP_NEEDED
    = 'setup needed'

Auth_OpenID_SHA1_BLOCKSIZE

SHA1_BLOCKSIZE is this module's SHA1 blocksize used by the fallback implementation.


    public
        mixed
    Auth_OpenID_SHA1_BLOCKSIZE
    = 64

Auth_OpenID_SHA256_SUPPORTED


    public
        mixed
    Auth_OpenID_SHA256_SUPPORTED
    = \false

Auth_OpenID_SREG_NS_URI


    public
        mixed
    Auth_OpenID_SREG_NS_URI
    = \Auth_OpenID_SREG_NS_URI_1_1

Auth_OpenID_SREG_NS_URI_1_0


    public
        mixed
    Auth_OpenID_SREG_NS_URI_1_0
    = 'http://openid.net/sreg/1.0'

Auth_OpenID_SREG_NS_URI_1_1


    public
        mixed
    Auth_OpenID_SREG_NS_URI_1_1
    = 'http://openid.net/extensions/sreg/1.1'

Auth_OpenID_SREG_URI


    public
        mixed
    Auth_OpenID_SREG_URI
    = 'http://openid.net/sreg/1.0'

Auth_OpenID_SUCCESS

This is the status code returned when the complete method returns successfully.


    public
        mixed
    Auth_OpenID_SUCCESS
    = 'success'

Auth_OpenID_THE_OTHER_OPENID1_NS


    public
        mixed
    Auth_OpenID_THE_OTHER_OPENID1_NS
    = 'http://openid.net/signon/1.1'

Auth_OpenID_TYPE_1_0


    public
        mixed
    Auth_OpenID_TYPE_1_0
    = 'http://openid.net/signon/1.0'

Auth_OpenID_TYPE_1_1


    public
        mixed
    Auth_OpenID_TYPE_1_1
    = 'http://openid.net/signon/1.1'

Auth_OpenID_TYPE_1_2


    public
        mixed
    Auth_OpenID_TYPE_1_2
    = 'http://openid.net/signon/1.2'

Auth_OpenID_TYPE_2_0


    public
        mixed
    Auth_OpenID_TYPE_2_0
    = 'http://specs.openid.net/auth/2.0/signon'

Auth_OpenID_TYPE_2_0_IDP


    public
        mixed
    Auth_OpenID_TYPE_2_0_IDP
    = 'http://specs.openid.net/auth/2.0/server'

Auth_OpenID_USER_AGENT


    public
        mixed
    Auth_OpenID_USER_AGENT
    = 'php-openid/' . \Auth_OpenID_VERSION . ' (php/' . \phpversion() . ')'

Auth_OpenID_VERSION

The library version string


    public
        mixed
    Auth_OpenID_VERSION
    = '3.0.3'

Auth_OpenID_XMLNS_1_0


    public
        mixed
    Auth_OpenID_XMLNS_1_0
    = 'http://openid.net/xmlns/1.0'

Auth_Yadis_CONTENT_TYPE

XRDS (yadis) content type


    public
        mixed
    Auth_Yadis_CONTENT_TYPE
    = 'application/xrds+xml'

Auth_Yadis_HEADER_NAME

Yadis header


    public
        mixed
    Auth_Yadis_HEADER_NAME
    = 'X-XRDS-Location'

Auth_Yadis_XMLNS_XRD_2_0

XRD XML namespace


    public
        mixed
    Auth_Yadis_XMLNS_XRD_2_0
    = 'xri://$xrd*($v*2.0)'

Auth_Yadis_XMLNS_XRDS

XRDS XML namespace


    public
        mixed
    Auth_Yadis_XMLNS_XRDS
    = 'xri://$xrds'

PAPE_AUTH_MULTI_FACTOR


    public
        mixed
    PAPE_AUTH_MULTI_FACTOR
    = 'http://schemas.openid.net/pape/policies/2007/06/multi-factor'

PAPE_AUTH_MULTI_FACTOR_PHYSICAL


    public
        mixed
    PAPE_AUTH_MULTI_FACTOR_PHYSICAL
    = 'http://schemas.openid.net/pape/policies/2007/06/multi-factor-physical'

PAPE_AUTH_PHISHING_RESISTANT


    public
        mixed
    PAPE_AUTH_PHISHING_RESISTANT
    = 'http://schemas.openid.net/pape/policies/2007/06/phishing-resistant'

PAPE_TIME_VALIDATOR


    public
        mixed
    PAPE_TIME_VALIDATOR
    = '/^[0-9]{4,4}-[0-9][0-9]-[0-9][0-9]T[0-9][0-9]:[0-9][0-9]:[0-9][0-9]Z$/'

SERVICES_YADIS_MATCH_ALL

This match mode means a given service must match ALL filters passed to the Auth_Yadis_XRDS::services() call.


    public
        mixed
    SERVICES_YADIS_MATCH_ALL
    = 101

SERVICES_YADIS_MATCH_ANY

This match mode means a given service must match ANY filters (at least one) passed to the Auth_Yadis_XRDS::services() call.


    public
        mixed
    SERVICES_YADIS_MATCH_ANY
    = 102

SERVICES_YADIS_MAX_PRIORITY

The priority value used for service elements with no priority specified.


    public
        mixed
    SERVICES_YADIS_MAX_PRIORITY
    = \pow(2, 30)

Auth_OpenID_getSecretSize()


    
                    Auth_OpenID_getSecretSize(mixed $assoc_type) : mixed

Parameters

$assoc_type : mixed

Return values

mixed —

Auth_OpenID_getAllAssociationTypes()


    
                    Auth_OpenID_getAllAssociationTypes() : mixed

Return values

mixed —

Auth_OpenID_getSupportedAssociationTypes()


    
                    Auth_OpenID_getSupportedAssociationTypes() : mixed

Return values

mixed —

Auth_OpenID_getSessionTypes()


    
                    Auth_OpenID_getSessionTypes(string $assoc_type) : mixed

Parameters

$assoc_type : string

Return values

mixed —

Auth_OpenID_checkSessionType()


    
                    Auth_OpenID_checkSessionType(mixed $assoc_type, mixed $session_type) : mixed

Parameters

$assoc_type : mixed
$session_type : mixed

Return values

mixed —

Auth_OpenID_getDefaultAssociationOrder()


    
                    Auth_OpenID_getDefaultAssociationOrder() : mixed

Return values

mixed —

Auth_OpenID_getOnlyEncryptedOrder()


    
                    Auth_OpenID_getOnlyEncryptedOrder() : mixed

Return values

mixed —

Auth_OpenID_getDefaultNegotiator()


    
                    Auth_OpenID_getDefaultNegotiator() : mixed

Return values

mixed —

Auth_OpenID_getEncryptedNegotiator()


    
                    Auth_OpenID_getEncryptedNegotiator() : mixed

Return values

mixed —

Auth_OpenID_AX_checkAlias()

Check an alias for invalid characters; raise AXError if any are found. Return None if the alias is valid.


    
                    Auth_OpenID_AX_checkAlias(string $alias) : Auth_OpenID_AX_Error|bool

Parameters

$alias : string

Return values

Auth_OpenID_AX_Error|bool —

Auth_OpenID_AX_toTypeURIs()

Given a namespace mapping and a string containing a comma-separated list of namespace aliases, return a list of type URIs that correspond to those aliases.


    
                    Auth_OpenID_AX_toTypeURIs(Auth_OpenID_NamespaceMap $namespace_map, string $alias_list_s) : array<string|int, string>|Auth_OpenID_AX_Error

Parameters

$namespace_map : Auth_OpenID_NamespaceMap: The mapping from namespace URI to alias
$alias_list_s : string: The string containing the comma-separated list of aliases. May also be None for convenience.

Return values

array<string|int, string>|Auth_OpenID_AX_Error —

The list of namespace URIs that corresponds to the supplied list of aliases. If the string was zero-length or None, an empty list will be returned.

return null If an alias is present in the list of aliases but is not present in the namespace map.

Auth_OpenID_math_extensions()

Define the supported extensions. An extension array has keys 'modules', 'extension', and 'class'. 'modules' is an array of PHP module names which the loading code will attempt to load. These values will be suffixed with a library file extension (e.g. ".so").


    
                    Auth_OpenID_math_extensions() : mixed

'extension' is the name of a PHP extension which will be tested before 'modules' are loaded. 'class' is the string name of a subclass which should be instantiated if a given extension is present.

You can define new math library implementations and add them to this array.

Return values

mixed —

Auth_OpenID_detectMathLibrary()

Detect which (if any) math library is available


    
                    Auth_OpenID_detectMathLibrary(array<string|int, mixed> $exts) : bool

Parameters

$exts : array<string|int, mixed>

Return values

bool —

Auth_OpenID_getMathLib()

{@link Auth_OpenID_getMathLib} checks for the presence of long number extension modules and returns an instance of {@link Auth_OpenID_MathWrapper} which exposes the module's functionality.


    
                    Auth_OpenID_getMathLib() : Auth_OpenID_MathLibrary|null

Checks for the existence of an extension module described by the result of and returns an instance of a wrapper for that extension module. If no extension module is found, an instance of is returned, which wraps the native PHP integer implementation. The proper calling convention for this method is $lib = Auth_OpenID_getMathLib().

This function checks for the existence of specific long number implementations in the following order: GMP followed by BCmath.

Return values

Auth_OpenID_MathLibrary|null —

Auth_OpenID_setNoMathSupport()


    
                    Auth_OpenID_setNoMathSupport() : mixed

Return values

mixed —

Auth_OpenID_noMathSupport()


    
                    Auth_OpenID_noMathSupport() : mixed

Return values

mixed —

Auth_OpenID_getAvailableSessionTypes()

Returns available session types.


    
                    Auth_OpenID_getAvailableSessionTypes() : mixed

Return values

mixed —

Auth_OpenID_getDefaultMod()


    
                    Auth_OpenID_getDefaultMod() : mixed

Return values

mixed —

Auth_OpenID_getDefaultGen()


    
                    Auth_OpenID_getDefaultGen() : mixed

Return values

mixed —

Auth_OpenID_getOpenIDTypeURIs()


    
                    Auth_OpenID_getOpenIDTypeURIs() : mixed

Return values

mixed —

Auth_OpenID_getOpenIDConsumerTypeURIs()


    
                    Auth_OpenID_getOpenIDConsumerTypeURIs() : mixed

Return values

mixed —

Auth_OpenID_getOpenIDTypeName()


    
                    Auth_OpenID_getOpenIDTypeName(mixed $type_uri) : mixed

Parameters

$type_uri : mixed

Return values

mixed —

Auth_OpenID_findOPLocalIdentifier()


    
                    Auth_OpenID_findOPLocalIdentifier(Auth_Yadis_Service $service, array<string|int, mixed> $type_uris) : bool|null

Parameters

$service : Auth_Yadis_Service
$type_uris : array<string|int, mixed>

Return values

bool|null —

filter_MatchesAnyOpenIDType()


    
                    filter_MatchesAnyOpenIDType(Auth_Yadis_Service $service) : bool

Parameters

$service : Auth_Yadis_Service

Return values

bool —

filter_MatchesAnyOpenIDConsumerType()


    
                    filter_MatchesAnyOpenIDConsumerType(Auth_Yadis_Service &$service) : bool

Parameters

$service : Auth_Yadis_Service

Return values

bool —

Auth_OpenID_bestMatchingService()


    
                    Auth_OpenID_bestMatchingService(mixed $service, mixed $preferred_types) : mixed

Parameters

$service : mixed
$preferred_types : mixed

Return values

mixed —

Auth_OpenID_arrangeByType()


    
                    Auth_OpenID_arrangeByType(mixed $service_list, mixed $preferred_types) : mixed

Parameters

$service_list : mixed
$preferred_types : mixed

Return values

mixed —

Auth_OpenID_getOPOrUserServices()


    
                    Auth_OpenID_getOPOrUserServices(mixed $openid_services) : mixed

Parameters

$openid_services : mixed

Return values

mixed —

Auth_OpenID_makeOpenIDEndpoints()


    
                    Auth_OpenID_makeOpenIDEndpoints(string $uri, array<string|int, Auth_Yadis_Service> $yadis_services) : array<string|int, mixed>

Parameters

$uri : string
$yadis_services : array<string|int, Auth_Yadis_Service>

Return values

array<string|int, mixed> —

Auth_OpenID_discoverWithYadis()


    
                    Auth_OpenID_discoverWithYadis(mixed $uri, mixed $fetcher[, mixed $endpoint_filter = 'Auth_OpenID_getOPOrUserServices' ][, mixed $discover_function = null ]) : mixed

Parameters

$uri : mixed
$fetcher : mixed
$endpoint_filter : mixed = 'Auth_OpenID_getOPOrUserServices'
$discover_function : mixed = null

Return values

mixed —

Auth_OpenID_discoverURI()


    
                    Auth_OpenID_discoverURI(mixed $uri, mixed $fetcher) : mixed

Parameters

$uri : mixed
$fetcher : mixed

Return values

mixed —

Auth_OpenID_discoverWithoutYadis()


    
                    Auth_OpenID_discoverWithoutYadis(string $uri, Auth_Yadis_PlainHTTPFetcher $fetcher) : array<string|int, mixed>

Parameters

$uri : string
$fetcher : Auth_Yadis_PlainHTTPFetcher

Return values

array<string|int, mixed> —

Auth_OpenID_discoverXRI()


    
                    Auth_OpenID_discoverXRI(mixed $iname, mixed $fetcher) : mixed

Parameters

$iname : mixed
$fetcher : mixed

Return values

mixed —

Auth_OpenID_discover()


    
                    Auth_OpenID_discover(string $uri, Auth_Yadis_PlainHTTPFetcher $fetcher) : array<string|int, mixed>

Parameters

$uri : string
$fetcher : Auth_Yadis_PlainHTTPFetcher

Return values

array<string|int, mixed> —

Auth_OpenID_SHA1()


    
                    Auth_OpenID_SHA1(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

Auth_OpenID_HMACSHA1()

Compute an HMAC/SHA1 hash.


    
                    Auth_OpenID_HMACSHA1(string $key, string $text) : string

Parameters

$key : string: The HMAC key
$text : string: The message text to hash

Return values

string —

$mac The MAC

Auth_OpenID_SHA256()


    
                    Auth_OpenID_SHA256(mixed $text) : mixed

Parameters

$text : mixed

Return values

mixed —

Auth_OpenID_HMACSHA256()


    
                    Auth_OpenID_HMACSHA256(mixed $key, mixed $text) : mixed

Parameters

$key : mixed
$text : mixed

Return values

mixed —

Auth_OpenID_isOpenID1()


    
                    Auth_OpenID_isOpenID1(mixed $ns) : mixed

Parameters

$ns : mixed

Return values

mixed —

Auth_OpenID_registerNamespaceAlias()

Registers a (namespace URI, alias) mapping in a global namespace alias map. Raises NamespaceAliasRegistrationError if either the namespace URI or alias has already been registered with a different value. This function is required if you want to use a namespace with an OpenID 1 message.


    
                    Auth_OpenID_registerNamespaceAlias(string $namespace_uri, string $alias) : bool

Parameters

$namespace_uri : string
$alias : string

Return values

bool —

Auth_OpenID_removeNamespaceAlias()

Removes a (namespace_uri, alias) registration from the global namespace alias map. Returns true if the removal succeeded; false if not (if the mapping did not exist).


    
                    Auth_OpenID_removeNamespaceAlias(string $namespace_uri, string $alias) : bool

Parameters

$namespace_uri : string
$alias : string

Return values

bool —

Auth_OpenID_splitNonce()


    
                    Auth_OpenID_splitNonce(mixed $nonce_string) : mixed

Parameters

$nonce_string : mixed

Return values

mixed —

Auth_OpenID_checkTimestamp()


    
                    Auth_OpenID_checkTimestamp(mixed $nonce_string[, mixed $allowed_skew = null ][, mixed $now = null ]) : mixed

Parameters

$nonce_string : mixed
$allowed_skew : mixed = null
$now : mixed = null

Return values

mixed —

Auth_OpenID_mkNonce()


    
                    Auth_OpenID_mkNonce([mixed $when = null ]) : mixed

Parameters

$when : mixed = null

Return values

mixed —

Auth_OpenID_legacy_discover()


    
                    Auth_OpenID_legacy_discover(mixed $html_text, mixed $server_rel, mixed $delegate_rel) : mixed

Parameters

$html_text : mixed
$server_rel : mixed
$delegate_rel : mixed

Return values

mixed —

Auth_OpenID_isError()


    
                    Auth_OpenID_isError(object|string $obj[, string $cls = 'Auth_OpenID_ServerError' ]) : bool

Parameters

$obj : object|string
$cls : string = 'Auth_OpenID_ServerError'

Return values

bool —

Auth_OpenID_checkFieldName()

Check to see that the given value is a valid simple registration data field name. Return true if so, false if not.


    
                    Auth_OpenID_checkFieldName(string $field_name) : bool

Parameters

$field_name : string

Return values

bool —

Auth_OpenID_supportsSReg()

Does the given endpoint advertise support for simple registration?


    
                    Auth_OpenID_supportsSReg(Auth_OpenID_ServiceEndpoint $endpoint) : bool

Parameters

$endpoint : Auth_OpenID_ServiceEndpoint: The endpoint object as returned by OpenID discovery. returns whether an sreg type was advertised by the endpoint

Return values

bool —

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.

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 —

Auth_OpenID_getURIPattern()


    
                    Auth_OpenID_getURIPattern() : mixed

Return values

mixed —

Auth_OpenID_getAuthorityPattern()


    
                    Auth_OpenID_getAuthorityPattern() : mixed

Return values

mixed —

Auth_OpenID_getEncodedPattern()


    
                    Auth_OpenID_getEncodedPattern() : mixed

Return values

mixed —

Auth_OpenID_getURLIllegalCharRE()


    
                    Auth_OpenID_getURLIllegalCharRE() : mixed

Return values

mixed —

Auth_OpenID_getUnreserved()


    
                    Auth_OpenID_getUnreserved() : mixed

Return values

mixed —

Auth_OpenID_getEscapeRE()


    
                    Auth_OpenID_getEscapeRE() : mixed

Return values

mixed —

Auth_OpenID_pct_encoded_replace_unreserved()


    
                    Auth_OpenID_pct_encoded_replace_unreserved(mixed $mo) : mixed

Parameters

$mo : mixed

Return values

mixed —

Auth_OpenID_pct_encoded_replace()


    
                    Auth_OpenID_pct_encoded_replace(mixed $mo) : mixed

Parameters

$mo : mixed

Return values

mixed —

Auth_OpenID_remove_dot_segments()


    
                    Auth_OpenID_remove_dot_segments(mixed $path) : mixed

Parameters

$path : mixed

Return values

mixed —

Auth_OpenID_urinorm()


    
                    Auth_OpenID_urinorm(mixed $uri) : mixed

Parameters

$uri : mixed

Return values

mixed —

Auth_OpenID_include_init()


    
                    Auth_OpenID_include_init() : mixed

Return values

mixed —

Auth_Yadis_getUCSChars()

Miscellaneous utility values and functions for OpenID and Yadis.


    
                    Auth_Yadis_getUCSChars() : mixed

Return values

mixed —

Auth_Yadis_getIPrivateChars()


    
                    Auth_Yadis_getIPrivateChars() : mixed

Return values

mixed —

Auth_Yadis_pct_escape_unicode()


    
                    Auth_Yadis_pct_escape_unicode(mixed $char_match) : mixed

Parameters

$char_match : mixed

Return values

mixed —

Auth_Yadis_startswith()


    
                    Auth_Yadis_startswith(mixed $s, mixed $stuff) : mixed

Parameters

$s : mixed
$stuff : mixed

Return values

mixed —

Auth_Yadis_setDefaultParser()

Set a default parser to override the extension-driven selection of available parser classes. This is helpful in a test environment or one in which multiple parsers can be used but one is more desirable.


    
                    Auth_Yadis_setDefaultParser(Auth_Yadis_XMLParser $parser) : mixed

Parameters

$parser : Auth_Yadis_XMLParser: An instance of a Auth_Yadis_XMLParser subclass.

Return values

mixed —

Auth_Yadis_getSupportedExtensions()


    
                    Auth_Yadis_getSupportedExtensions() : mixed

Return values

mixed —

Auth_Yadis_getXMLParser()

Returns an instance of a Auth_Yadis_XMLParser subclass based on the availability of PHP extensions for XML parsing. If Auth_Yadis_setDefaultParser has been called, the parser used in that call will be returned instead.


    
                    Auth_Yadis_getXMLParser() : Auth_Yadis_XMLParser|bool

Return values

Auth_Yadis_XMLParser|bool —

Auth_Yadis_getNSMap()


    
                    Auth_Yadis_getNSMap() : mixed

Return values

mixed —

Auth_Yadis_array_scramble()


    
                    Auth_Yadis_array_scramble(array<string|int, mixed> $arr) : array<string|int, mixed>

Parameters

$arr : array<string|int, mixed>

Return values

array<string|int, mixed> —

Auth_Yadis_getXRDExpiration()


    
                    Auth_Yadis_getXRDExpiration(mixed $xrd_element[, mixed $default = null ]) : mixed

Parameters

$xrd_element : mixed
$default : mixed = null

Return values

mixed —

Auth_Yadis_getDefaultProxy()


    
                    Auth_Yadis_getDefaultProxy() : mixed

Return values

mixed —

Auth_Yadis_getXRIAuthorities()


    
                    Auth_Yadis_getXRIAuthorities() : mixed

Return values

mixed —

Auth_Yadis_getEscapeRE()


    
                    Auth_Yadis_getEscapeRE() : mixed

Return values

mixed —

Auth_Yadis_getXrefRE()


    
                    Auth_Yadis_getXrefRE() : mixed

Return values

mixed —

Auth_Yadis_identifierScheme()


    
                    Auth_Yadis_identifierScheme(mixed $identifier) : mixed

Parameters

$identifier : mixed

Return values

mixed —

Auth_Yadis_toIRINormal()


    
                    Auth_Yadis_toIRINormal(mixed $xri) : mixed

Parameters

$xri : mixed

Return values

mixed —

_escape_xref()


    
                    _escape_xref(mixed $xref_match) : mixed

Parameters

$xref_match : mixed

Return values

mixed —

Auth_Yadis_escapeForIRI()


    
                    Auth_Yadis_escapeForIRI(mixed $xri) : mixed

Parameters

$xri : mixed

Return values

mixed —

Auth_Yadis_toURINormal()


    
                    Auth_Yadis_toURINormal(mixed $xri) : mixed

Parameters

$xri : mixed

Return values

mixed —

Auth_Yadis_iriToURI()


    
                    Auth_Yadis_iriToURI(mixed $iri) : mixed

Parameters

$iri : mixed

Return values

mixed —

Auth_Yadis_XRIAppendArgs()


    
                    Auth_Yadis_XRIAppendArgs(mixed $url, mixed $args) : mixed

Parameters

$url : mixed
$args : mixed

Return values

mixed —

Auth_Yadis_providerIsAuthoritative()


    
                    Auth_Yadis_providerIsAuthoritative(mixed $providerID, mixed $canonicalID) : mixed

Parameters

$providerID : mixed
$canonicalID : mixed

Return values

mixed —

Auth_Yadis_rootAuthority()


    
                    Auth_Yadis_rootAuthority(mixed $xri) : mixed

Parameters

$xri : mixed

Return values

mixed —

Auth_Yadis_XRI()


    
                    Auth_Yadis_XRI(mixed $xri) : mixed

Parameters

$xri : mixed

Return values

mixed —

Auth_Yadis_getCanonicalID()


    
                    Auth_Yadis_getCanonicalID(string $iname, Auth_Yadis_XRDS $xrds) : bool|string

Parameters

$iname : string
$xrds : Auth_Yadis_XRDS

Return values

bool|string —

Auth_Yadis_getServiceEndpoints()

Perform the Yadis protocol on the input URL and return an iterable of resulting endpoint objects.


    
                    Auth_Yadis_getServiceEndpoints(string $input_url,  $xrds_parse_func[, null $discover_func = null ][, null $fetcher = null ]) : string

input_url: The URL on which to perform the Yadis protocol

Parameters

$input_url : string
$xrds_parse_func :
$discover_func : null = null
$fetcher : null = null

Return values

string —

The normalized identity URL and an iterable of endpoint objects generated by the filter function.

xrds_parse_func: a callback which will take (uri, xrds_text) and return an array of service endpoint objects or null. Usually array('Auth_OpenID_ServiceEndpoint', 'fromXRDS').

discover_func: if not null, a callback which should take (uri) and return an Auth_Yadis_Yadis object or null.

Documentation

Packages

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

Auth_OpenID___HostSegmentRe

Auth_OpenID___TLDs

Tags

Auth_OpenID_AX_MINIMUM_SUPPORTED_ALIAS_LENGTH

Auth_OpenID_AX_NS_URI

Auth_OpenID_AX_UNLIMITED_VALUES

Auth_OpenID_BARE_NS

Auth_OpenID_CANCEL

Auth_OpenID_digits

Auth_OpenID_DO_ABOUT

Tags

Auth_OpenID_DO_AUTH

Tags

Auth_OpenID_ENCODE_HTML_FORM

Tags

Auth_OpenID_ENCODE_KVFORM

Tags

Auth_OpenID_ENCODE_URL

Tags

Auth_OpenID_FAILURE

Auth_OpenID_FETCHER_MAX_RESPONSE_KB

Auth_OpenID_HMACSHA256_SUPPORTED

AUTH_OPENID_HTTP_ERROR

AUTH_OPENID_HTTP_OK

AUTH_OPENID_HTTP_REDIRECT

Auth_OpenID_IDENTIFIER_SELECT

Auth_OpenID_letters

Auth_OpenID_LOCAL_ERROR

Tags

Auth_OpenID_NO_DEFAULT

Auth_OpenID_NO_MATH_SUPPORT

Auth_OpenID_Nonce_CHRS

Auth_OpenID_Nonce_REGEX

Auth_OpenID_Nonce_TIME_FMT

Auth_OpenID_NULL_NAMESPACE

Auth_OpenID_OPENID1_NS

Auth_OpenID_OPENID1_URL_LIMIT

Auth_OpenID_OPENID2_NS

Auth_OpenID_OPENID_NS

Auth_OpenID_PAPE_NS_URI

Auth_OpenID_PARSE_ERROR

Auth_OpenID_punct

Auth_OpenID_RAND_SOURCE

Auth_OpenID_REDIRECT

Tags

Auth_OpenID_REMOTE_ERROR

Tags

Auth_OpenID_REMOTE_OK

Tags

Auth_OpenID_RP_RETURN_TO_URL_TYPE

Auth_OpenID_SETUP_NEEDED

Auth_OpenID_SHA1_BLOCKSIZE

Auth_OpenID_SHA256_SUPPORTED

Auth_OpenID_SREG_NS_URI

Auth_OpenID_SREG_NS_URI_1_0

Auth_OpenID_SREG_NS_URI_1_1

Auth_OpenID_SREG_URI

Auth_OpenID_SUCCESS

Auth_OpenID_THE_OTHER_OPENID1_NS

Auth_OpenID_TYPE_1_0

Auth_OpenID_TYPE_1_1

Auth_OpenID_TYPE_1_2

Auth_OpenID_TYPE_2_0

Auth_OpenID_TYPE_2_0_IDP

Auth_OpenID_USER_AGENT

Auth_OpenID_VERSION

Auth_OpenID_XMLNS_1_0

Auth_Yadis_CONTENT_TYPE

Auth_Yadis_HEADER_NAME

Auth_Yadis_XMLNS_XRD_2_0

Auth_Yadis_XMLNS_XRDS

PAPE_AUTH_MULTI_FACTOR

PAPE_AUTH_MULTI_FACTOR_PHYSICAL

PAPE_AUTH_PHISHING_RESISTANT

PAPE_TIME_VALIDATOR