blob: aad126d5653a881ccb4fb00773e1038db71b4ec4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
# Wallet::ACL::Base -- Parent class for wallet ACL verifiers.
# $Id$
#
# Written by Russ Allbery <rra@stanford.edu>
# Copyright 2007 Board of Trustees, Leland Stanford Jr. University
#
# See README for licensing terms.
##############################################################################
# Modules and declarations
##############################################################################
package Wallet::ACL::Base;
require 5.006;
use strict;
use vars qw($VERSION);
# This version should be increased on any code change to this module. Always
# use two digits for the minor version with a leading zero if necessary so
# that it will sort properly.
$VERSION = '0.01';
##############################################################################
# Interface
##############################################################################
# Creates a new persistant verifier, taking a database handle. This parent
# class just creates an empty object and ignores the handle. Child classes
# should override if there are necessary initialization tasks or if the handle
# will be used by the verifier.
sub new {
my $type = shift;
my $self = {};
bless ($self, $type);
return $self;
}
# The default check method denies all access.
sub check {
return 0;
}
# Return the error stashed in the object.
sub error {
my ($self) = @_;
return $self->{error};
}
1;
__END__
##############################################################################
# Documentation
##############################################################################
=head1 NAME
Wallet::ACL::Base - Generic parent class for wallet ACL verifiers
=head1 SYNOPSIS
package Wallet::ACL::Simple
@ISA = qw(Wallet::ACL::Base);
sub check {
my ($self, $principal, $acl) = @_;
return ($principal eq $acl) ? 1 : 0;
}
=head1 DESCRIPTION
Wallet::ACL::Base is the generic parent class for wallet ACL verifiers. It
provides default functions and behavior and all ACL verifiers should inherit
from it. It is not used directly.
=head1 METHODS
=over 4
=item new()
Creates a new ACL verifier. The generic function provided here just creates
and blesses an object.
=item check(PRINCIPAL, ACL)
This method should always be overridden by child classes. The default
implementation just declines all access.
=item error()
Returns whatever is stored in the error key of the object hash. Child
classes should store error messages in that key when returning undef from
check().
=back
=head1 SEE ALSO
walletd(8)
This module is part of the wallet system. The current version is available
from L<http://www.eyrie.org/~eagle/software/wallet/>.
=head1 AUTHOR
Russ Allbery <rra@stanford.edu>
=cut
|
