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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
# Wallet::Admin -- Wallet system administrative interface.
#
# Written by Russ Allbery <rra@stanford.edu>
# Copyright 2008, 2009, 2010 Board of Trustees, Leland Stanford Jr. University
#
# See LICENSE for licensing terms.
##############################################################################
# Modules and declarations
##############################################################################
package Wallet::Admin;
require 5.006;
use strict;
use vars qw($VERSION);
use Wallet::ACL;
use Wallet::Database;
use Wallet::Schema;
# 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.05';
##############################################################################
# Constructor, destructor, and accessors
##############################################################################
# Create a new wallet administrator object. Opens a connection to the
# database that will be used for all of the wallet configuration information.
# Throw an exception if anything goes wrong.
sub new {
my ($class) = @_;
my $dbh = Wallet::Database->connect;
my $self = { dbh => $dbh };
bless ($self, $class);
return $self;
}
# Returns the database handle (used mostly for testing).
sub dbh {
my ($self) = @_;
return $self->{dbh};
}
# Set or return the error stashed in the object.
sub error {
my ($self, @error) = @_;
if (@error) {
my $error = join ('', @error);
chomp $error;
1 while ($error =~ s/ at \S+ line \d+\.?\z//);
$self->{error} = $error;
}
return $self->{error};
}
# Disconnect the database handle on object destruction to avoid warnings.
sub DESTROY {
my ($self) = @_;
$self->{dbh}->disconnect unless $self->{dbh}->{InactiveDestroy};
}
##############################################################################
# Database initialization
##############################################################################
# Initializes the database by populating it with our schema and then creates
# and returns a new wallet server object. This is used only for initial
# database creation. Takes the Kerberos principal who will be the default
# administrator so that we can create an initial administrator ACL. Returns
# true on success and false on failure, setting the object error.
sub initialize {
my ($self, $user) = @_;
my $schema = Wallet::Schema->new;
eval { $schema->create ($self->{dbh}) };
if ($@) {
$self->error ($@);
return;
}
my $acl = Wallet::ACL->create ('ADMIN', $self->{dbh}, $user, 'localhost');
unless ($acl->add ('krb5', $user, $user, 'localhost')) {
$self->error ($acl->error);
return;
}
return 1;
}
# The same as initialize, but also drops any existing tables first before
# creating the schema. Takes the same arguments. Returns true on success and
# false on failure.
sub reinitialize {
my ($self, $user) = @_;
return unless $self->destroy;
return $self->initialize ($user);
}
# Drop the database, including all of its data. Returns true on success and
# false on failure.
sub destroy {
my ($self) = @_;
my $schema = Wallet::Schema->new;
eval { $schema->drop ($self->{dbh}) };
if ($@) {
$self->error ($@);
return;
}
return 1;
}
##############################################################################
# Object registration
##############################################################################
# Given an object type and class name, add a new class mapping to that
# database for the given object type. This is used to register new object
# types. Returns true on success, false on failure, and sets the internal
# error on failure.
sub register_object {
my ($self, $type, $class) = @_;
eval {
my $sql = 'insert into types (ty_name, ty_class) values (?, ?)';
$self->{dbh}->do ($sql, undef, $type, $class);
$self->{dbh}->commit;
};
if ($@) {
$self->error ("cannot register $class for $type: $@");
$self->{dbh}->rollback;
return;
}
return 1;
}
# Given an ACL verifier scheme and class name, add a new class mapping to that
# database for the given ACL verifier scheme. This is used to register new
# ACL schemes. Returns true on success, false on failure, and sets the
# internal error on failure.
sub register_verifier {
my ($self, $scheme, $class) = @_;
eval {
my $sql = 'insert into acl_schemes (as_name, as_class) values (?, ?)';
$self->{dbh}->do ($sql, undef, $scheme, $class);
$self->{dbh}->commit;
};
if ($@) {
$self->error ("cannot registery $class for $scheme: $@");
$self->{dbh}->rollback;
return;
}
return 1;
}
1;
__DATA__
##############################################################################
# Documentation
##############################################################################
=head1 NAME
Wallet::Admin - Wallet system administrative interface
=for stopwords
ACL hostname Allbery
=head1 SYNOPSIS
use Wallet::Admin;
my $admin = Wallet::Admin->new;
unless ($admin->initialize ('user/admin@EXAMPLE.COM')) {
die $admin->error;
}
=head1 DESCRIPTION
Wallet::Admin implements the administrative interface to the wallet server
and database. It is normally instantiated and used by B<wallet-admin>, a
thin wrapper around this object that provides a command-line interface to
its actions.
To use this object, several configuration variables must be set (at least
the database configuration). For information on those variables and how
to set them, see Wallet::Config(3). For more information on the normal
user interface to the wallet server, see Wallet::Server(3).
=head1 CLASS METHODS
=over 4
=item new()
Creates a new wallet administrative object and connects to the database.
On any error, this method throws an exception.
=back
=head1 INSTANCE METHODS
For all methods that can fail, the caller should call error() after a
failure to get the error message.
=over 4
=item destroy()
Destroys the database, deleting all of its data and all of the tables used
by the wallet server. Returns true on success and false on failure.
=item error()
Returns the error of the last failing operation or undef if no operations
have failed. Callers should call this function to get the error message
after an undef return from any other instance method.
=item initialize(PRINCIPAL)
Initializes the database as configured in Wallet::Config and loads the
wallet database schema. Then, creates an ACL with the name ADMIN and adds
an ACL entry of scheme C<krb5> and instance PRINCIPAL to that ACL. This
bootstraps the authorization system and lets that Kerberos identity make
further changes to the ADMIN ACL and the rest of the wallet database.
Returns true on success and false on failure.
initialize() uses C<localhost> as the hostname and PRINCIPAL as the user
when logging the history of the ADMIN ACL creation and for any subsequent
actions on the object it returns.
=item register_object (TYPE, CLASS)
Register in the database a mapping from the object type TYPE to the class
CLASS. Returns true on success and false on failure (including when the
verifier is already registered).
=item register_verifier (SCHEME, CLASS)
Register in the database a mapping from the ACL scheme SCHEME to the class
CLASS. Returns true on success and false on failure (including when the
verifier is already registered).
=item reinitialize(PRINCIPAL)
Performs the same actions as initialize(), but first drops any existing
wallet database tables from the database, allowing this function to be
called on a prior wallet database. All data stored in the database will
be deleted and a fresh set of wallet database tables will be created.
This method is equivalent to calling destroy() followed by initialize().
Returns true on success and false on failure.
=back
=head1 SEE ALSO
wallet-admin(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
|
