Tatsuhiko Miyagawa > Catalyst-Plugin-Authentication-Credential-OpenID-0.03 > Catalyst::Plugin::Authentication::Credential::OpenID

Download:
Catalyst-Plugin-Authentication-Credential-OpenID-0.03.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 0.03   Source  

NAME ^

Catalyst::Plugin::Authentication::Credential::OpenID - OpenID credential for Catalyst::Auth framework

SYNOPSIS ^

  use Catalyst qw/
    Authentication
    Authentication::Credential::OpenID
    Session
    Session::Store::FastMmap
    Session::State::Cookie
  /;

  # MyApp.yaml -- optional
  authentication:
    openid:
      use_session: 1
      user_class: MyApp::M::User::OpenID

  # whatever in your Controller pm
  sub default : Private {
      my($self, $c) = @_;
      if ($c->user_exists) { ... }
  }

  sub signin_openid : Local {
      my($self, $c) = @_;

      if ($c->authenticate_openid) {
          $c->res->redirect( $c->uri_for('/') );
      }
  }

  # foo.tt
  <form action="[% c.uri_for('/signin_openid') %]" method="GET">
  <input type="text" name="openid_url" class="openid" />
  <input type="submit" value="Sign in with OpenID" />
  </form>

DESCRIPTION ^

Catalyst::Plugin::Authentication::Credential::OpenID is an OpenID credential for Catalyst::Plugin::Authentication framework.

METHODS ^

authenticate_openid
  $c->authenticate_openid;

Call this method in the action you'd like to authenticate the user via OpenID. Returns 0 if auth is not successful, and 1 if user is authenticated.

User class specified with user_class config, which defaults to Catalyst::Plugin::Authentication::User::Hash, will be instantiated with the following parameters.

By default, authenticate_openid method looks for claimed URI parameter from the form field named openid_url, openid_identifier or claimed_uri. If you want to use another form field name, call it like:

  $c->authenticate_openid( $c->req->param('myopenid_param') );
url
display
rss
atom
foaf
declared_rss
declared_atom
declared_foaf
foafmaker

See Net::OpenID::VerifiedIdentity for details.

DIFFERENCE WITH Authentication::OpenID ^

There's already Catalyst::Plugin::Authentication::OpenID (Auth::OpenID) and this plugin tries to deprecate it.

AUTHOR ^

Six Apart, Ltd. <cpan@sixapart.com>

LICENSE ^

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO ^

Catalyst::Plugin::Authentication::OpenID, Catalyst::Plugin::Authentication::Credential::Flickr

syntax highlighting: