wallet-report

(Wallet server reporting interface)

SYNOPSIS

wallet-report type [args ...]

DESCRIPTION

wallet-report provides a command-line interface for running reports on the wallet database. It is intended to be run on the wallet server as a user with access to the wallet database and configuration, but can also be made available via remctl to users who should have reporting privileges.

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

OPTIONS

wallet-report takes no traditional options.

COMMANDS

acls
acls duplicate
acls empty
acls entry <scheme> <identifier>
acls unused

Returns a list of ACLs in the database. Except for the duplicate report, ACLs will be listed in the form:

    <name> (ACL ID: <id>)

where <name> is the human-readable name and <id> is the numeric ID. The numeric ID is what's used internally by the wallet system. There will be one line per ACL.

For the duplicate report, the output will instead be one duplicate set per line. This will be a set of ACLs that all have the same entries. Only the names will be given, separated by spaces.

If no search type is given, all the ACLs in the database will be returned. If a search type (and possible search arguments) are given, then the ACLs will be limited to those that match the search.

The currently supported ACL search types are:

acls duplicate

Returns all sets of ACLs that are duplicates, meaning that they contain exactly the same entries. Each line will be the names of the ACLs in a set of duplicates, separated by spaces.

acls empty

Returns all ACLs which have no entries, generally so that abandoned ACLs can be destroyed.

acls entry <scheme> <identifier>

Returns all ACLs containing an entry with given scheme and identifier. The scheme must be an exact match, but the <identifier> string will match any identifier containing that string.

acls nested <acl>

Returns all ACLs that contain this ACL as a nested entry.

acls unused

Returns all ACLs that are not referenced by any of the objects in the wallet database, either as an owner or on one of the more specific ACLs.

audit acls name
audit objects name

Returns all ACLs or objects that violate the current site naming policy. Objects will be listed in the form:

    <type> <name>

and ACLs in the form:

    <name> (ACL ID: <id>)

where <name> is the human-readable name and <id> is the numeric ID. The numeric ID is what's used internally by the wallet system. There will be one line per object or ACL.

help

Displays a summary of all available commands.

objects
objects acl <acl>
objects flag <flag>
objects owner <owner>
objects type <type>
objects unused
objects unstored

Returns a list of objects in the database. Objects will be listed in the form:

    <type> <name>

There will be one line per object.

If no search type is given, all objects in the database will be returned. If a search type (and possible search arguments) are given, the objects will be limited to those that match the search.

The currently supported object search types are:

objects acl <acl>

Returns all objects for which the given ACL name or ID has any permissions. This includes those objects owned by the ACL as well as those where that ACL has any other, more limited permissions.

objects flag <flag>

Returns all objects which have the given flag set.

objects host <hostname>

Returns all objects that belong to the given host. This requires adding local configuration to identify objects that belong to a given host. See "OBJECT HOST-BASED NAMES" in Wallet::Config for more information.

objects owner <acl>

Returns all objects owned by the given ACL name or ID.

objects type <type>

Returns all objects of the given type.

objects unused

Returns all objects that have never been downloaded (have never been the target of a get command).

owners <type-pattern> <name-pattern>

Returns a list of all ACL entries 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 % as the wildcard character following the normal rules of SQL patterns.

The output will be one line per ACL line in the form:

    <scheme> <identifier>

with duplicates suppressed.

schemes

Returns a list of all registered ACL schemes.

types

Returns a list of all registered object types.

AUTHOR

Russ Allbery <eagle@eyrie.org>

COPYRIGHT AND LICENSE

Copyright 2016 Russ Allbery <eagle@eyrie.org>

Copyright 2008, 2009, 2010, 2013, 2015 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.

SEE ALSO

Wallet::Config(3), Wallet::Report(3), wallet-backend(8)

This program is part of the wallet system. The current version is available from <http://www.eyrie.org/~eagle/software/wallet/>.

Last modified and spun 2016-01-24