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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
# Wallet::ACL::NetDB::Root -- Wallet NetDB role ACL verifier (root instances).
#
# Written by Russ Allbery <eagle@eyrie.org>
# Copyright 2007, 2010, 2014
# The Board of Trustees of the Leland Stanford Junior University
#
# See LICENSE for licensing terms.
##############################################################################
# Modules and declarations
##############################################################################
package Wallet::ACL::NetDB::Root;
require 5.006;
use strict;
use warnings;
use vars qw(@ISA $VERSION);
use Wallet::ACL::NetDB;
use Wallet::Config;
@ISA = qw(Wallet::ACL::NetDB);
# 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.02';
##############################################################################
# Interface
##############################################################################
# Override the check method of Wallet::ACL::NetDB to require that the
# principal be a root instance and to strip /root out of the principal name
# before checking roles.
sub check {
my ($self, $principal, $acl) = @_;
unless ($principal) {
$self->error ('no principal specified');
return;
}
unless ($principal =~ s%^([^/\@]+)/root(\@|\z)%$1$2%) {
return 0;
}
return $self->SUPER::check ($principal, $acl);
}
##############################################################################
# Documentation
##############################################################################
=for stopwords
ACL NetDB DNS DHCP Allbery verifier
=head1 NAME
Wallet::ACL::NetDB::Root - Wallet ACL verifier for NetDB roles (root instances)
=head1 SYNOPSIS
my $verifier = Wallet::ACL::NetDB::Root->new;
my $status = $verifier->check ($principal, $node);
if (not defined $status) {
die "Something failed: ", $verifier->error, "\n";
} elsif ($status) {
print "Access granted\n";
} else {
print "Access denied\n";
}
=head1 DESCRIPTION
Wallet::ACL::NetDB::Root works identically to Wallet::ACL::NetDB except
that it requires the principal to be a root instance (in other words, to
be in the form <principal>/root@<realm>) and strips the C</root> portion
from the principal before checking against NetDB roles. As with the base
NetDB ACL verifier, the value of a C<netdb-root> ACL is a node, and the
ACL grants access to a given principal if and only if the that principal
(with C</root> stripped) has one of the roles user, admin, or team for
that node.
To use this object, the same configuration parameters must be set as for
Wallet::ACL::NetDB. See Wallet::Config(3) for details on those
configuration parameters and information about how to set wallet
configuration.
=head1 METHODS
=over 4
=item check(PRINCIPAL, ACL)
Returns true if PRINCIPAL is granted access according to ACL, false if
not, and undef on an error (see L<"DIAGNOSTICS"> below). ACL is a node,
and PRINCIPAL will be granted access if it has an instance of C<root> and
if (with C</root> stripped off and the realm stripped off if configured)
has the user, admin, or team role for that node.
=back
=head1 DIAGNOSTICS
Same as for Wallet::ACL::NetDB.
=head1 CAVEATS
The instance to strip is not currently configurable.
The list of possible NetDB roles that should be considered sufficient to
grant access is not currently configurable.
=head1 SEE ALSO
Net::Remctl(3), Wallet::ACL(3), Wallet::ACL::Base(3),
Wallet::ACL::NetDB(3), Wallet::Config(3), wallet-backend(8)
NetDB is a free software system for managing DNS, DHCP, and related
machine information for large organizations. For more information on
NetDB, see L<http://www.stanford.edu/group/networking/netdb/>.
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 <eagle@eyrie.org>
=cut
|
