File Coverage

blib/lib/Concierge/Auth/Base.pm

Criterion	Covered	Total	%
statement	19	25	76.0
branch			n/a
condition			n/a
subroutine	9	15	60.0
pod	13	13	100.0
total	41	53	77.3

package Concierge::Auth::Base v0.5.0;
use v5.36;

# ABSTRACT: Base class / contract for Concierge::Auth backends

use Concierge::Auth::Generators ();

# Define interface methods that must be implemented by subclasses:
# Concierge::Auth::MyBackend->new(%args);
sub new { die "Subclass must implement new" }

# $backend->authenticate($user_id, $credential);
sub authenticate { die "Subclass must implement authenticate" }

# $backend->is_id_known($user_id);
sub is_id_known { die "Subclass must implement is_id_known" }

# $backend->enroll($user_id, $credential, \%opts);
sub enroll { die "Subclass must implement enroll" }

# $backend->change_credentials($user_id, $new_credential);
sub change_credentials { die "Subclass must implement change_credentials" }

# $backend->revoke($user_id);
sub revoke { die "Subclass must implement revoke" }

# Generator methods -- default implementations delegate to the plain
# functions in Concierge::Auth::Generators, preserving its wantarray
# (value)/(value, message) dual-return convention. Unlike the five
# methods above, these are NOT required overrides: a backend that has
# no reason to customize ID/token generation gets a working
# implementation for free. Any backend may still override one or more
# of these with its own logic (e.g. an LDAP backend deferring ID
# generation to the directory).
sub gen_uuid          { my $self = shift; return Concierge::Auth::Generators::gen_uuid(@_); }
sub gen_random_id     { my $self = shift; return Concierge::Auth::Generators::gen_random_id(@_); }
sub gen_random_token  { my $self = shift; return Concierge::Auth::Generators::gen_random_token(@_); }
sub gen_random_string { my $self = shift; return Concierge::Auth::Generators::gen_random_string(@_); }
sub gen_word_phrase   { my $self = shift; return Concierge::Auth::Generators::gen_word_phrase(@_); }
# Does NOT call the original deprecated methods; calls their replacements
# But these are still considered deprecated method names
sub gen_token         { my $self = shift; return Concierge::Auth::Generators::gen_random_token(@_); }
sub gen_crypt_token   { my $self = shift; return Concierge::Auth::Generators::gen_random_token(@_); }

1;

__END__