Koha/Koha/ApiKey.pm
Jonathan Druart 3929db6bc2 Bug 28772: Make validate_secret return 1|0
Not an empty string

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2021-09-30 09:48:41 +02:00

143 lines
3.1 KiB
Perl

package Koha::ApiKey;
# Copyright BibLibre 2015
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.
use Modern::Perl;
use Koha::AuthUtils qw(hash_password);
use Koha::Exceptions::Object;
use List::MoreUtils qw(any);
use UUID;
use base qw(Koha::Object);
=head1 NAME
Koha::ApiKey - Koha API Key Object class
=head1 API
=head2 Class methods
=head3 store
my $api_key = Koha::ApiKey->new({ patron_id => $patron_id })->store;
Overloaded I<store> method.
=cut
sub store {
my ($self) = @_;
if ( $self->in_storage ) {
my %dirty_columns = $self->_result->get_dirty_columns;
# only allow 'description' and 'active' to be updated
for my $property ( keys %dirty_columns ) {
Koha::Exceptions::Object::ReadOnlyProperty->throw( property => $property )
if $property ne 'description' and $property ne 'active';
}
} else {
$self->{_plain_text_secret} = $self->_generate_unused_uuid('secret');
$self->set(
{ secret => Koha::AuthUtils::hash_password( $self->{_plain_text_secret} ),
client_id => $self->_generate_unused_uuid('client_id'),
}
);
}
return $self->SUPER::store();
}
=head3 validate_secret
if ( $api_key->validate_secret( $secret ) ) { ... }
Returns a boolean that tells if the passed secret matches the one on the DB.
=cut
sub validate_secret {
my ( $self, $secret ) = @_;
my $digest = Koha::AuthUtils::hash_password( $secret, $self->secret );
return ( $self->secret eq $digest ) ? 1 : 0;
}
=head3 plain_text_secret
my $generated_secret = $api_key->store->plain_text_secret;
Returns the generated I<secret> so it can be displayed to the end user.
This is only accessible when the object is new and has just been stored.
Returns I<undef> if the object was retrieved from the database.
=cut
sub plain_text_secret {
my ($self) = @_;
return $self->{_plain_text_secret}
if $self->{_plain_text_secret};
return;
}
=head2 Internal methods
=cut
=head3 _type
=cut
sub _type {
return 'ApiKey';
}
=head3 _generate_unused_uuid
my $string = $self->_generate_unused_uuid($column);
$column can be 'client_id' or 'secret'.
=cut
sub _generate_unused_uuid {
my ($self, $column) = @_;
my ( $uuid, $uuidstring );
UUID::generate($uuid);
UUID::unparse( $uuid, $uuidstring );
while ( Koha::ApiKeys->search({ $column => $uuidstring })->count > 0 ) {
# Make sure $secret is unique
UUID::generate($uuid);
UUID::unparse( $uuid, $uuidstring );
}
return $uuidstring;
}
1;