Ubuntu Manpage: wallet-admin - Wallet server administrative commands

NAME

       wallet-admin - Wallet server administrative commands

SYNOPSIS

       wallet-admin command [args ...]

DESCRIPTION

       wallet-admin provides a command-line interface for performing administrative actions for the wallet
       system, such as setting up a new database or running reports.  It is intended to be run on the wallet
       server as a user with access to the wallet database and configuration.

       This program is a fairly thin wrapper around Wallet::Admin that translates command strings into method
       calls and returns the results.

OPTIONS

       wallet-admin takes no traditional options.

COMMANDS

destroy
Deletes all data in the wallet database and drops all of the wallet-created tables, restoring the
database to its state prior to an "initialize" command. Since this command is destructive and cannot
be easily recovered from, wallet-admin will prompt first to be sure the user intends to do this.

initialize <principal>
Given an empty database, initializes it for use with the wallet server by creating the necessary
tables and initial metadata. Also creates an ACL with the name ADMIN, used for administrative
privileges to the wallet system, and adds an ACL entry to it with a scheme of "krb5" and an instance
of <principal>. This bootstraps the authentication system and allows that user to make further
changes to the ADMIN ACL and the rest of the wallet database. "initialize" uses "localhost" as the
hostname and <principal> as the user when logging the history of the ADMIN ACL creation and for any
subsequent actions required to initialize the database.

Before running "initialize", the wallet system has to be configured. See Wallet::Config(3) for more
details. Depending on the database backend used, the database may also have to be created in
advance.

register (object | verifier) <type> <class>
Registers an implementation of a wallet object or ACL verifier in the wallet database. The Perl
class <class> is registered as the implementation of an object of type <type> or an ACL verifier of
scheme <type>, allowing creation of objects with that type or ACL lines with that scheme.

All object and ACL implementations that come with wallet are registered by default as part of
database initialization, so this command is used primarily to register local implementations of
additional object types or ACL schemes.

upgrade
Upgrades the database to the latest schema version, preserving data as much as possible.

AUTHOR

       Russ Allbery <eagle@eyrie.org>

COPYRIGHT AND LICENSE

       Copyright 2008-2011, 2013 The Board of Trustees of the Leland Stanford Junior University

       Permission is hereby granted, free of charge, to any  person  obtaining  a  copy  of  this  software  and
       associated  documentation  files (the "Software"), to deal in the Software without restriction, including
       without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,  and/or  sell
       copies  of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
       following conditions:

       The above copyright notice and this permission notice shall be included  in  all  copies  or  substantial
       portions of the Software.

       THE  SOFTWARE  IS  PROVIDED  "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
       LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND  NONINFRINGEMENT.   IN
       NO  EVENT  SHALL  THE  AUTHORS  OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
       WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT  OF  OR  IN  CONNECTION  WITH  THE
       SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

       SPDX-License-Identifier: MIT