Koha/Auth/Identity/Provider/OAuth.pm

   1 package Koha::Auth::Identity::Provider::OAuth;
   2
   3 # Copyright Theke Solutions 2022
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21
  22 use base qw(Koha::Auth::Identity::Provider);
  23
  24 =head1 NAME
  25
  26 Koha::Auth::Identity::Provider::OAuth - Koha Auth Provider Object class
  27
  28 =head1 API
  29
  30 =head2 Class methods
  31
  32 =head3 new
  33
  34     my $oauth = Koha::Auth::Identity::Provider::OAuth->new( \%{params} );
  35
  36 Overloaded class to create a new OAuth provider.
  37
  38 =cut
  39
  40 sub new {
  41     my ( $class, $params ) = @_;
  42
  43     $params->{protocol} = 'OAuth';
  44
  45     return $class->SUPER::new($params);
  46 }
  47
  48 =head2 Internal methods
  49
  50 =head3 mandatory_config_attributes
  51
  52 Returns a list of the mandatory config entries for the protocol.
  53
  54 =cut
  55
  56 sub mandatory_config_attributes {
  57     return qw(
  58       key
  59       secret
  60       authorize_url
  61       token_url
  62     );
  63 }
  64
  65 1;