Authenticating with AuthSub
The AuthSub mechanism enables you to write web applications
that acquire authenticated access Google Data services,
without having to write code that handles user credentials.
See http://code.google.com/apis/accounts/AuthForWebApps.html
for more information about Google Data AuthSub authentication.
The Google documentation says the ClientLogin mechanism is appropriate
for "installed applications" whereas the AuthSub mechanism is
for "web applications." The difference is that AuthSub requires
interaction from the user, and a browser interface that can react
to redirection requests. The ClientLogin solution uses PHP code to
supply the account credentials; the user is not required to enter her
credentials interactively.
The account credentials supplied via the AuthSub mechanism are
entered by the user of the web application. Therefore they must be
account credentials that are known to that user.
Registered applications
Zend_Gdata currently does not support use of secure tokens,
because the AuthSub authentication does not support passing a digital certificate
to acquire a secure token.
Creating an AuthSub authenticated Http Client
Your PHP application should provide a hyperlink to the
Google URL that performs authentication. The static function
Zend_Gdata_AuthSub::getAuthSubTokenUri()
provides the correct URL. The arguments to this function include
the URL to your PHP application so that Google can
redirect the user's browser back to your application after the user's
credentials have been verified.
After Google's authentication server redirects the user's browser
back to the current application, a GET request parameter is set,
called token. The value of this parameter is a single-use token
that can be used for authenticated access. This token can be converted into a multi-use
token and stored in your session.
Then use the token value in a call to
Zend_Gdata_AuthSub::getHttpClient().
This function returns an instance of Zend_Http_Client,
with appropriate headers set so that subsequent requests your
application submits using that HTTP Client are also authenticated.
Below is an example of PHP code for a web application
to acquire authentication to use the Google Calendar service
and create a Zend_Gdata client object using that authenticated
HTTP Client.
here " .
"to authorize this application.";
exit();
}
}
// Create an authenticated HTTP Client to talk to Google.
$client = Zend_Gdata_AuthSub::getHttpClient($_SESSION['cal_token']);
// Create a Gdata object using the authenticated Http Client
$cal = new Zend_Gdata_Calendar($client);
]]>
Revoking AuthSub authentication
To terminate the authenticated status of a given token, use the
Zend_Gdata_AuthSub::AuthSubRevokeToken()
static function. Otherwise, the token is still valid for
some time.
Security notes
The treatment of the $php_self variable in the
example above is a general security guideline, it is not
specific to Zend_Gdata. You should always filter content you
output to HTTP headers.
Regarding revoking authentication tokens, it is recommended to
do this when the user is finished with her Google Data session.
The possibility that someone can intercept the token and use
it for malicious purposes is very small, but nevertheless it is
a good practice to terminate authenticated access to any service.