path: root/server/wallet-admin.8

.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "WALLET-ADMIN 8"
.TH WALLET-ADMIN 8 "2010-02-21" "0.10" "wallet"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
wallet\-admin \- Wallet server administrative commands
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBwallet-admin\fR \fIcommand\fR [\fIargs\fR ...]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBwallet-admin\fR 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.
.PP
This program is a fairly thin wrapper around Wallet::Admin that translates
command strings into method calls and returns the results.
.SH "OPTIONS"
.IX Header "OPTIONS"
\&\fBwallet-admin\fR takes no traditional options.
.SH "COMMANDS"
.IX Header "COMMANDS"
.IP "destroy" 4
.IX Item "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
\&\f(CW\*(C`initialize\*(C'\fR command.  Since this command is destructive and cannot be
easily recovered from, \fBwallet-admin\fR will prompt first to be sure the
user intends to do this.
.IP "initialize <principal>" 4
.IX Item "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 \s-1ACL\s0
with the name \s-1ADMIN\s0, used for administrative privileges to the wallet
system, and adds an \s-1ACL\s0 entry to it with a scheme of \f(CW\*(C`krb5\*(C'\fR and an
instance of <principal>.  This bootstraps the authentication system and
allows that user to make further changes to the \s-1ADMIN\s0 \s-1ACL\s0 and the rest of
the wallet database.  \f(CW\*(C`initialize\*(C'\fR uses \f(CW\*(C`localhost\*(C'\fR as the hostname and
<principal> as the user when logging the history of the \s-1ADMIN\s0 \s-1ACL\s0 creation
and for any subsequent actions required to initialize the database.
.Sp
Before running \f(CW\*(C`initialize\*(C'\fR, the wallet system has to be configured.  See
\&\fIWallet::Config\fR\|(3) for more details.  Depending on the database backend
used, the database may also have to be created in advance.
.IP "list (acls | objects) [ <searchtype> [ <arg> ... ] ]" 4
.IX Item "list (acls | objects) [ <searchtype> [ <arg> ... ] ]"
Returns a list of ACLs or objects in the database.  ACLs will be listed
in the form:
.Sp
.Vb 1
\&    <name> (ACL ID: <id>)
.Ve
.Sp
where <name> is the human-readable name and <id> is the numeric \s-1ID\s0.  The
numeric \s-1ID\s0 is what's used internally by the wallet system.  Objects will
be listed in the form:
.Sp
.Vb 1
\&    <type> <name>
.Ve
.Sp
In both cases, there will be one line per \s-1ACL\s0 or object.
.Sp
If no search type is given, all the ACLs or objects in the database will
be returned.  If a search type (and possible search arguments) are given,
then the ACLs or objects will be limited to those that match the search.
.Sp
The currently supported object search types are:
.RS 4
.IP "list objects type <type>" 4
.IX Item "list objects type <type>"
Returns all objects of the given type.
.IP "list objects flag <flag>" 4
.IX Item "list objects flag <flag>"
Returns all objects which have the given flag set.
.IP "list objects owner <acl name>" 4
.IX Item "list objects owner <acl name>"
Returns all objects owned by the given \s-1ACL\s0 name.
.IP "list objects acl <acl name>" 4
.IX Item "list objects acl <acl name>"
Returns all objects for which the given \s-1ACL\s0 name has any permissions.
This includes those objects owned by the \s-1ACL\s0, but also those for which the
\&\s-1ACL\s0 has get permissions, for example.
.RE
.RS 4
.Sp
The currently supported \s-1ACL\s0 search types are:
.IP "list acls empty" 4
.IX Item "list acls empty"
Returns all ACLs which have no entries, generally so that abandoned ACLs
can be destroyed.
.IP "list acls entry <schema> <identifier>" 4
.IX Item "list acls entry <schema> <identifier>"
Returns all ACLs containing an entry with given schema and identifier.
The schema is used for an exact search, while the identifier given will
match any identifier containing that text, for flexibility.
.RE
.RS 4
.RE
.IP "register (object | verifier) <type> <class>" 4
.IX Item "register (object | verifier) <type> <class>"
Registers an implementation of a wallet object or \s-1ACL\s0 verifier in the
wallet database.  The Perl class <class> is registered as the
implementation of an object of type <type> or an \s-1ACL\s0 verifier of scheme
<type>, allowing creation of objects with that type or \s-1ACL\s0 lines with that
scheme.
.Sp
All object and \s-1ACL\s0 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
\&\s-1ACL\s0 schemes.
.IP "report <type> [ <arg> ... ]" 4
.IX Item "report <type> [ <arg> ... ]"
Runs a wallet report.  The currently supported report types are:
.RS 4
.IP "report owners <type\-pattern> <name\-pattern>" 4
.IX Item "report owners <type-pattern> <name-pattern>"
Returns a list of all \s-1ACL\s0 lines in owner ACLs for all objects matching
both <type\-pattern> and <name\-pattern>.  These can be the type or name of
objects or they can be patterns using \f(CW\*(C`%\*(C'\fR as the wildcard character
following the normal rules of \s-1SQL\s0 patterns.
.Sp
The output will be one line per \s-1ACL\s0 line in the form:
.Sp
.Vb 1
\&    <scheme> <identifier>
.Ve
.Sp
with duplicates suppressed.
.RE
.RS 4
.RE
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIWallet::Admin\fR\|(3), \fIWallet::Config\fR\|(3), \fIwallet\-backend\fR\|(8)
.PP
This program is part of the wallet system.  The current version is
available from <http://www.eyrie.org/~eagle/software/wallet/>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Russ Allbery <rra@stanford.edu>