1 package Catalyst::Plugin::Authentication::Credential::TypeKey;
8 use Catalyst::Utils ();
10 use UNIVERSAL::require;
18 my $config = $c->config->{authentication}{typekey} ||= {};
20 $config->{typekey_object} ||= do {
21 ( $config->{user_class} ||=
22 "Catalyst::Plugin::Authentication::User::Hash" )->require;
24 $config->{key_cache} ||=
25 File::Spec->catfile( Catalyst::Utils::class2tempdir( $c, 1 ),
28 my $typekey = Authen::TypeKey->new;
30 for ( grep { exists $config->{$_} }
31 qw/expires key_cache key_url token version skip_expiry_check/ )
33 $typekey->$_( $config->{$_} );
42 sub authenticate_typekey {
47 if ( Scalar::Util::blessed( $p[0] ) ) {
49 Catalyst::Exception->throw(
50 "Attempted to authenticate user object, but "
51 . "user doesnt't support 'typekey_credentials'" )
52 unless $user->supports(qw/typekey_credentials/);
53 $p = $user->typekey_credentials;
60 $p = @p ? {@p} : undef;
63 my $config = $c->config->{authentication}{typekey};
65 my $typekey = $p && delete( $p->{typekey_object} )
66 || $config->{typekey_object};
70 if ( my $res = $typekey->verify($p) ) {
71 $c->log->debug("Successfully authenticated user '$res->{name}'.")
74 if ( !$user and my $store = $config->{auth_store} ) {
75 $store = $c->get_auth_store($store) unless ref $store;
76 $user = $store->get_user( $res->{name}, $p, $res );
80 my $user_class = $config->{user_class};
81 $user = $user_class->new($res);
84 $c->set_authenticated($user);
90 sprintf "Failed to authenticate user '%s'. Reason: '%s'",
91 $p->{name} || $p->param("name"),
106 Catalyst::Plugin::Authentication::Credential::TypeKey - TypeKey Authentication
111 use Catalyst qw/Authentication::Credential::TypeKey/;
113 MyApp->config->{authentication}{typekey} = {
114 token => 'xxxxxxxxxxxxxxxxxxxx',
118 my ( $self, $c ) = @_;
120 if ( $c->authenticate_typekey ) {
122 # you can also specify the params manually: $c->authenticate_typekey(
128 # successful autentication
130 $c->user; # this is set
136 my ( $self, $c ) = @_;
138 $c->authenticate_typekey; # uses $c->req
145 This module integrates L<Authen::TypeKey> with
146 L<Catalyst::Plugin::Authentication>.
150 =head3 authenticate_typekey %parameters
152 =head3 authenticate_typekey
154 =head3 EXTENDED METHODS
158 Fills the config with defaults.
162 C<<$c->config->{autentication}{typekey}>> is a hash with these fields (all can
169 If this field does not exist an L<Authen::TypeKey> object will be created based
170 on the other param and put here.
180 See L<Authen::TypeKey> for all of these. If they aren't specified
181 L<Authen::TypeKey>'s defaults will be used.
185 Also see L<Authen::TypeKey>.
187 Defaults to C<regkeys.txt> under L<Catalyst::Utils/class2tempdir>.
191 A store (or store name) to retrieve the user from.
193 When a user is successfully authenticated it will call this:
195 $store->get_user( $name, $parameters, $result_of_verify );
197 Where C<$parameters> is a the hash reference passed to
198 L<Authen::TypeKey/verify>, and C<$result_of_verify> is the value returned by
199 L<Authen::TypeKey/verify>.
201 If this is unset, L<Catalyst::Plugin::Authentication/default_auth_store> will
206 If C<auth_store> or the default store returns nothing from get_user, this class
207 will be used to instantiate an object by calling C<new> on the class with the
208 return value from L<Authen::TypeKey/verify>.
214 L<Authen::TypeKey>, L<Catalyst>, L<Catalyst::Plugin::Authentication>.
220 Yuval Kogman, C<nothingmuch@woobling.org>
224 This library is free software . You can redistribute it and/or modify it under
225 the same terms as perl itself.