Full index

Package indexes


a b c d e f g h i m n o p q r s t u v w x y
a
top
$AUTH_KEY_LEN
addExtensionArg
Add an extension argument to this OpenID authentication request.
answer
answer
attributes
attributes
Return the attributes of a specified node.
attributes
Association.php
Association.php in Association.php
Auth_OpenID_AlreadySigned
An error that indicates that a response was already signed.
Auth_OpenID_Association
Auth_OpenID_Association in Association.php
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 Auth_OpenID_OpenIDStore.
Auth_OpenID_AuthRequest
Auth_OpenID_AuthRequest in Consumer.php
This class represents an authentication request from a consumer to an OpenID server.
Auth_OpenID_AuthRequest
Initialize an authentication request with the specified token, association, and endpoint.
Auth_OpenID_CANCEL
Auth_OpenID_CANCEL in Consumer.php
Status to indicate cancellation of OpenID authentication.
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_CancelResponse
Auth_OpenID_Consumer
Initialize a Consumer instance.
Auth_OpenID_Consumer
Auth_OpenID_Consumer in Consumer.php
An OpenID consumer implementation that performs discovery and does session management. See the Consumer.php file documentation for more information.
Auth_OpenID_ConsumerResponse
The base class for responses from the Auth_OpenID_Consumer.
Auth_OpenID_DatabaseConnection
Auth_OpenID_DatabaseConnection in DatabaseConnection.php
An empty base class intended to emulate PEAR connection
Auth_OpenID_Decoder
Auth_OpenID_Decoder in Server.php
Decode an incoming Auth_OpenID_WebResponse into an Auth_OpenID_Request.
Auth_OpenID_Decoder
Auth_OpenID_DEFAULT_NONCE_CHRS
This is the characters that the nonces are made from.
Auth_OpenID_DiffieHellmanConsumerSession
Auth_OpenID_DiffieHellmanConsumerSession
Auth_OpenID_DiffieHellmanServerSession
Auth_OpenID_DiffieHellmanServerSession
Auth_OpenID_digits
Auth_OpenID_digits in OpenID.php
Auth_OpenID_DO_ABOUT
Auth_OpenID_DO_ABOUT in OpenID.php
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
Auth_OpenID_DO_AUTH in OpenID.php
Status code returned when the caller needs to authenticate the
Auth_OpenID_DumbStore
Auth_OpenID_DumbStore in DumbStore.php
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_DumbStore
Creates a new Auth_OpenID_DumbStore instance. For the security of the tokens generated by the library, this class attempts to at least have a secure implementation of getAuthKey.
Auth_OpenID_Encoder
Auth_OpenID_Encoder in Server.php
Encode an Auth_OpenID_Response to an Auth_OpenID_WebResponse.
Auth_OpenID_EncodingError
Auth_OpenID_EncodingError
An error that indicates an encoding problem occurred.
Auth_OpenID_FAILURE
Auth_OpenID_FAILURE in Consumer.php
This is the status code completeAuth returns when the value it received indicated an invalid login.
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_FailureResponse
Auth_OpenID_FileStore
Initializes a new Auth_OpenID_FileStore. This initializes the nonce and association directories, which are subdirectories of the directory passed in.
Auth_OpenID_FileStore
Auth_OpenID_FileStore in FileStore.php
This is a filesystem-based store for OpenID associations and
AUTH_OPENID_HTTP_ERROR
AUTH_OPENID_HTTP_OK
AUTH_OPENID_HTTP_OK in Server.php
AUTH_OPENID_HTTP_REDIRECT
Auth_OpenID_letters
Auth_OpenID_letters in OpenID.php
Defines for regexes and format checking.
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.
Auth_OpenID_MalformedReturnURL
An error indicating that the return_to URL is malformed.
Auth_OpenID_MalformedReturnURL
Auth_OpenID_MalformedTrustRoot
This error is returned when the trust_root value is malformed.
Auth_OpenID_MySQLStore
Auth_OpenID_MySQLStore in MySQLStore.php
An SQL store that uses MySQL as its backend.
Auth_OpenID_NO_MATH_SUPPORT
Auth_OpenID_OpenIDStore
Auth_OpenID_OpenIDStore in Interface.php
This is the interface for the store objects the OpenID library
Auth_OpenID_PARSE_ERROR
Auth_OpenID_PARSE_ERROR in Consumer.php
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_PlainTextConsumerSession
Auth_OpenID_PlainTextServerSession
Auth_OpenID_PostgreSQLStore
Auth_OpenID_PostgreSQLStore in PostgreSQLStore.php
An SQL store that uses PostgreSQL as its backend.
Auth_OpenID_punct
Auth_OpenID_punct in OpenID.php
Auth_OpenID_REDIRECT
Auth_OpenID_REDIRECT in OpenID.php
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
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
Auth_OpenID_REMOTE_OK in OpenID.php
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_Server
Auth_OpenID_Server
Auth_OpenID_Server in Server.php
An object that implements the OpenID protocol for a single URL.
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_ServerRequest
Auth_OpenID_ServerRequest
Auth_OpenID_ServerRequest in ServerRequest.php
Object that holds the state of a request to the OpenID server
Auth_OpenID_ServiceEndpointLoader
A session helper class designed to translate between arrays and
Auth_OpenID_SetupNeededResponse
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_SETUP_NEEDED
Auth_OpenID_SETUP_NEEDED in Consumer.php
This is the status code completeAuth returns when the 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_Signatory
Create a new signatory using a given store.
Auth_OpenID_Signatory
Auth_OpenID_Signatory in Server.php
Responsible for the signature of query data and the verification of OpenID signature values.
Auth_OpenID_SigningEncoder
An encoder which also takes care of signing fields when required.
Auth_OpenID_SigningEncoder
Auth_OpenID_SQLiteStore
Auth_OpenID_SQLiteStore in SQLiteStore.php
An SQL store that uses SQLite as its backend.
Auth_OpenID_SQLStore
This creates a new SQLStore instance. It requires an established database connection be given to it, and it allows overriding the default table names.
Auth_OpenID_SQLStore
Auth_OpenID_SQLStore in SQLStore.php
This is the parent class for the SQL stores, which contains the logic common to all of the SQL stores.
Auth_OpenID_SUCCESS
Auth_OpenID_SUCCESS in Consumer.php
This is the status code returned when the complete method returns successfully.
Auth_OpenID_SuccessResponse
A response with a status of Auth_OpenID_SUCCESS. Indicates that
Auth_OpenID_UntrustedReturnURL
An error that indicates that the given return_to is not under the given trust_root.
Auth_OpenID_UntrustedReturnURL
Auth_OpenID_WebResponse
Auth_OpenID_WebResponse
A web-capable response object which you can use to generate a user-agent response.
autoCommit
Sets auto-commit mode on this database connection.
b
top
$body
begin
Start the OpenID authentication process. See steps 1-2 in the overview at the top of this file.
begin
Auth_OpenID_DatabaseConnection::begin() in DatabaseConnection.php
Starts a transaction on this connection, if supported.
beginWithoutDiscovery
Start OpenID verification without doing OpenID server
blobDecode
blobEncode
c
top
$code
Consumer.php
Consumer.php in Consumer.php
check
check
check
Override this.
clean
Remove expired entries from the database. This is potentially expensive, so only run when it is acceptable to take time.
cleanup
Clean up Yadis-related services in the session and return the most-recently-attempted service from the manager, if one exists.
commit
Commits a transaction on this connection, if supported.
complete
Called to interpret the server's response to an OpenID request. It is called in step 4 of the flow described in the consumer overview.
content
content
content
Return the textual content of a specified node.
contents
Return the contents of the session in array form.
createAssociation
Make a new association.
createAuthKey
Generate a new random auth key and safely store it in the location specified by $this->auth_key_name.
createTables
create_assoc_table
create_nonce_table
create_settings_table
curlPresent
d
top
$dumb_key
DatabaseConnection.php
DatabaseConnection.php in DatabaseConnection.php
DumbStore.php
DumbStore.php in DumbStore.php
decode
Given an HTTP query in an array (key-value pairs), decode it into an Auth_OpenID_Request object.
decodeRequest
Decodes a query args array into the appropriate Auth_OpenID_Request object.
defaultDecoder
del
Remove a key/value pair from the session.
deserialize
Parse an association as stored by serialize(). This is the inverse of serialize.
destroy
discover
This should be called statically and will build a Yadis instance if the discovery process succeeds. This implements Yadis discovery as specified in the Yadis specification.
e
top
encode
Sign an Auth_OpenID_Response and return an Auth_OpenID_WebResponse.
encode
Encode an Auth_OpenID_Response and return an Auth_OpenID_WebResponse.
encodeResponse
Encodes as response in the appropriate format suitable for sending to the user agent.
encodeToKVForm
Encodes the response to key-value form. This is a machine-readable format used to respond to messages which came directly from the consumer and not through the user-agent. See the OpenID specification.
encodeToURL
Encodes this error's response as a URL suitable for redirection. If the response has no return_to, another Auth_OpenID_ServerError is returned.
equal
This checks to see if two Auth_OpenID_Association instances represent the same association.
evalXPath
evalXPath
Evaluate an XPath expression and return the resulting node list. This should be overridden by subclasses.
evalXPath
extensionResponse
Extract signed extension data from the server's response.
extractSecret
extractSecret
f
top
FileStore.php
FileStore.php in FileStore.php
fromQuery
fromQuery
fromSession
Given a session data value (an array), this creates an object
g
top
get
Get a key's value from the session.
getAll
Run an SQL query with the specified parameters, if any.
getAssociation
Retrieve an association. If no handle is specified, return the association with the most recent issue time.
getAssociation
getAssociation
This method returns an Association object from storage that matches the server URL and, if specified, handle. It returns null if no such association is found or if the matching association is expired.
getAssociation
Given an association handle, get the association from the store, or return a ServerError or null if something goes wrong.
getAssociation
This implementation always returns null.
getAssociationFilename
Create a unique filename for a given server url and
getAuthKey
getAuthKey
This method returns a key used to sign the tokens, to ensure that they haven't been tampered with in transit. It should return the same key every time it is called. The key returned should be AUTH_KEY_LEN bytes long.
getAuthKey
Retrieve the auth key from the file specified by $this->auth_key_name, creating it if it does not exist.
getAuthKey
This method returns the auth key generated by the constructor.
getElements
Used to get XML elements from this object's <Service> element.
getExpiresIn
This returns the number of seconds this association is still valid for, or 0 if the association is no longer valid.
getHTTPFetcher
Returns an HTTP fetcher object. If the CURL extension is present, an instance of Services_Yadis_ParanoidHTTPFetcher is returned. If not, an instance of Services_Yadis_PlainHTTPFetcher is returned.
getNextService
Return the next authentication service for the pair of user_input and session. This function handles fallback.
getOne
Run an SQL query and return the first column of the first row of the result set, if any.
getPriority
Returns the "priority" attribute value of this <Service> element, if the attribute is present. Returns null if not.
getRequest
getRequest
getReturnTo
Get the openid.return_to argument from this response.
getRow
Run an SQL query and return the first row of the result set, if any.
getTypes
Return the URIs in the "Type" elements, if any, of this Service element.
getURIs
Return the URIs in the "URI" elements, if any, of this Service element. The URIs are returned sorted in priority order.
h
top
handleRequest
Handle a request. Given an Auth_OpenID_Request object, call the appropriate Auth_OpenID_Server method to process the request and generate a response.
hasReturnTo
Returns the return_to URL for the request which caused this error.
i
top
Interface.php
Interface.php in Interface.php
init
Initialize an instance of Services_Yadis_XMLParser with some XML and namespaces. This SHOULD NOT be overridden by subclasses.
invalidate
Invalidate a given association handle.
isDumb
This store is a dumb mode store, so this method is overridden to return true.
isDumb
This method must return true if the store is a dumb-mode-style store. Unlike all other methods in this class, this one provides a default implementation, which returns false.
isError
Returns true if $value constitutes a database error; returns false otherwise.
m
top
MySQLStore.php
MySQLStore.php in MySQLStore.php
Manager.php
Manager.php in Manager.php
n
top
$normal_key
newObject
Returns a new instance of this loader's class, using the session data to construct it if necessary. The object need only be created; $this->fromSession() will take care of setting the object's attributes.
newObject
newObject
nextService
Return the next service
o
top
OpenID.php
OpenID.php in OpenID.php
p
top
PostgreSQLStore.php
PostgreSQLStore.php in PostgreSQLStore.php
parseXRDS
Parse an XML string (XRDS document) and return either a Services_Yadis_XRDS object or null, depending on whether the XRDS XML is valid.
prepareForLoad
Prepares the data array by making any necessary changes.
prepareForLoad
prepareForSave
prepareForSave
Override this.
q
top
query
Auth_OpenID_DatabaseConnection::query() in DatabaseConnection.php
Run an SQL query with the specified parameters, if any.
r
top
$responseFactory
readAuthKey
Read the auth key from the auth key file. Will return None if there is currently no key.
redirectURL
Compute the appropriate redirection URL for this request based on a specified trust root and return-to.
registerNamespace
registerNamespace
registerNamespace
Register a namespace with the XML parser. This should be overridden by subclasses.
removeAssociation
removeAssociation
This method removes the matching association if it's found, and returns whether the association was removed or not.
removeAssociation
Remove an association if it exists. Do nothing if it does not.
removeAssociation
This implementation always returns false.
requiredKeys
requiredKeys
reset
Removes all entries from the store; implementation is optional.
reset
Resets the store by removing all records from the store's tables.
resultToBool
Converts a query result to a boolean. If the result is a database error according to $this->isError(), this returns false; otherwise, this returns true.
rollback
Performs a rollback on this connection, if supported.
s
top
$SECRET_LIFETIME
$session_type
An object that knows how to handle association requests with no session type.
$session_type
An object that knows how to handle association requests with the Diffie-Hellman session type.
$session_type
$session_type
$status
$status
$status
$status
$status
Server.php
Server.php in Server.php
ServerRequest.php
ServerRequest.php in ServerRequest.php
SQLiteStore.php
SQLiteStore.php in SQLiteStore.php
SQLStore.php
SQLStore.php in SQLStore.php
serialize
Convert an association to KV form.
services
Returns the list of service objects as described by the XRDS document, if this yadis object represents a successful Yadis discovery.
services
Returns a list of service objects which correspond to <Service> elements in the XRDS XML document for this object.
Services_Yadis_Discovery
Initialize a discovery object.
Services_Yadis_Discovery
State management for discovery.
Services_Yadis_dom
This concrete implementation of Services_Yadis_XMLParser implements
Services_Yadis_dom
Services_Yadis_domxml
Services_Yadis_domxml
This concrete implementation of Services_Yadis_XMLParser implements
Services_Yadis_getNSMap
Services_Yadis_getSupportedExtensions
Services_Yadis_getXMLParser
Returns an instance of a Services_Yadis_XMLParser subclass based on the availability of PHP extensions for XML parsing. If Services_Yadis_setDefaultParser has been called, the parser used in that call will be returned instead.
Services_Yadis_Manager
Services_Yadis_Manager in Manager.php
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.
Services_Yadis_ManagerLoader
A session helper class designed to translate between arrays and
SERVICES_YADIS_MATCH_ALL
This match mode means a given service must match ALL filters passed to the Services_Yadis_XRDS::services() call.
SERVICES_YADIS_MATCH_ANY
This match mode means a given service must match ANY filters (at least one) passed to the Services_Yadis_XRDS::services() call.
SERVICES_YADIS_MAX_PRIORITY
The priority value used for service elements with no priority specified.
Services_Yadis_PHPSession
The base session class used by the Services_Yadis_Manager. This class wraps the default PHP session machinery and should be subclassed if your application doesn't use PHP sessioning.
Services_Yadis_Service
This class represents a <Service> element in an XRDS document.
Services_Yadis_Service
Creates an empty service object.
Services_Yadis_SessionLoader
A session helper class designed to translate between arrays and
Services_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.
Services_Yadis_XMLParser
The base class for wrappers for available PHP XML-parsing
Services_Yadis_XRDS
This class performs parsing of XRDS documents.
Services_Yadis_XRDS
Instantiate a Services_Yadis_XRDS object. Requires an XPath instance which has been used to parse a valid XRDS document.
Services_Yadis_Yadis
Instantiates an empty Services_Yadis_Yadis object. This constructor should not be used by any user of the library.
Services_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.
set
Set a session key/value pair.
setSQL
setSQL
This method should be overridden by subclasses. This method is called by the constructor to set values in $this->sql, which is an array keyed on sql name.
setXML
setXML
Set this parser object's XML payload. This should be overridden by subclasses.
setXML
sign
Given a response, sign the fields in the response's 'signed' list, and insert the signature into the response.
storeAssociation
storeAssociation
Store an association in the association directory.
storeAssociation
This method puts an Association object into storage, retrievable by server URL and handle.
storeAssociation
This implementation does nothing.
storeNonce
This implementation does nothing.
storeNonce
Mark this nonce as present.
storeNonce
Stores a nonce. This is used by the consumer to prevent replay attacks.
t
top
tableExists
toSession
Returns an array of keys and values built from the attributes of $obj. If $this->prepareForSave($obj) returns an array, its keys and values are used to update the $data array of attributes from $obj.
toString
toString
Returns this error message.
toString
u
top
useNonce
useNonce
This method is called when the library is attempting to use a nonce. If the nonce is in the store, this method removes it and returns a value which evaluates as true. Otherwise it returns a value which evaluates as false.
useNonce
Return whether this nonce is present. As a side effect, mark it as no longer present.
useNonce
In a system truly limited to dumb mode, nonces must all be accepted. This therefore always returns true, which makes replay attacks feasible.
v
top
verify
Verify, using a given association handle, a signature with signed key-value pairs from an HTTP request.
w
top
whichEncoding
Returns one of $_Auth_OpenID_Encode_Url, $_Auth_OpenID_Encode_Kvform, or null, depending on the type of encoding expected for this error's payload.
x
top
XML.php
XML.php in XML.php
XRDS.php
XRDS.php in XRDS.php
y
top
Yadis.php
Yadis.php in Yadis.php
a b c d e f g h i m n o p q r s t u v w x y