view release on metacpan or  search on metacpan

t/data/generate/wallet/output/readme-md  view on Meta::CPAN

# wallet

[![Build
status](https://github.com/rra/wallet/workflows/build/badge.svg)](https://github.com/rra/wallet/actions)

Copyright 2014, 2016, 2018 Russ Allbery <eagle@eyrie.org>.  Copyright
2006-2010, 2012-2014 The Board of Trustees of the Leland Stanford Junior
University.  This software is distributed under a BSD-style license.
Please see the section [License](#license) below for more information.

## Blurb

The wallet is a system for managing secure data, authorization rules to
retrieve or change that data, and audit rules for documenting actions
taken on that data.  Objects of various types may be stored in the wallet
or generated on request and retrieved by authorized users.  The wallet
tracks ACLs, metadata, and trace information.  It is built on top of the
remctl protocol and uses Kerberos GSS-API authentication.  One of the
object types it supports is Kerberos keytabs, making it suitable as a
user-accessible front-end to Kerberos kadmind with richer ACL and metadata
operations.

## Description

The wallet is a client/server system using a central server with a
supporting database and a stand-alone client that can be widely
distributed to users.  The server runs on a secure host with access to a
local database; tracks object metadata such as ACLs, attributes, history,
expiration, and ownership; and has the necessary access privileges to
create wallet-managed objects in external systems (such as Kerberos
service principals).  The client uses the remctl protocol to send commands
to the server, store and retrieve objects, and query object metadata.  The
same client can be used for both regular user operations and wallet
administrative actions.

All wallet actions are controlled by a fine-grained set of ACLs.  Each
object has an owner ACL and optional get, store, show, destroy, and flags
ACLs that control more specific actions.  A global administrative ACL
controls access to administrative actions.  An ACL consists of zero or
more entries, each of which is a generic scheme and identifier pair,
allowing the ACL system to be extended to use any existing authorization
infrastructure.  Supported ACL types include Kerberos principal names,
regexes matching Kerberos principal names, and LDAP attribute checks.

Currently, the object types supported are simple files, passwords,
Kerberos keytabs, WebAuth keyrings, and Duo integrations.  By default,
whenever a Kerberos keytab object is retrieved from the wallet, the key is
changed in the Kerberos KDC and the wallet returns a keytab for the new
key.  However, a keytab object can also be configured to preserve the
existing keys when retrieved.  Included in the wallet distribution is a
script that can be run via remctl on an MIT Kerberos KDC to extract the
existing key for a principal, and the wallet system will use that
interface to retrieve the current key if the unchanging flag is set on a
Kerberos keytab object for MIT Kerberos.  (Heimdal doesn't require any
special support.)

## Requirements

The wallet client requires the C
[remctl](https://www.eyrie.org/~eagle/software/remctl/) client library and
a Kerberos library.  It will build with either MIT Kerberos or Heimdal.

The wallet server is written in Perl and requires Perl 5.8.0 or later plus
the following Perl modules:

* Date::Parse (part of the TimeDate distribution)
* DBI
* DBIx::Class
* Module::Build
* SQL::Translator

You will also need a DBD Perl module for the database backend that you
intend to use, and the DateTime::Format::* module corresponding to that
DBD module (such as DateTime::Format::SQLite or DateTime::Format::PG).

Currently, the server has only been tested against SQLite 3, MySQL 5, and
PostgreSQL, and prebuilt SQL files (for database upgrades) are only
provided for those servers.  It will probably not work fully with other
database backends.  Porting is welcome.

The wallet server is intended to be run under `remctld` and use `remctld`
to do authentication.  It can be ported to any other front-end, but doing
so will require writing a new version of `server/wallet-backend` that
translates the actions in that protocol into calls to the Wallet::Server
Perl object.

The keytab support in the wallet server supports Heimdal and MIT Kerberos
KDCs and has experimental support for Active Directory.  The Heimdal
support requires the Heimdal::Kadm5 Perl module.  The MIT Kerberos support
requires the MIT Kerberos `kadmin` client program be installed.  The
Active Directory support requires the Net::LDAP, Authen::SASL, and
IPC::Run Perl modules and the `msktutil` client program.

To support the unchanging flag on keytab objects with an MIT Kerberos KDC,
the Net::Remctl Perl module (shipped with remctl) must be installed on the
server and the `keytab-backend` script must be runnable via remctl on the
KDC.  This script also requires an MIT Kerberos `kadmin.local` binary that
supports the `-norandkey` option to `ktadd`.  This option is included in
MIT Kerberos 1.7 and later.

The WebAuth keyring object support in the wallet server requires the
WebAuth Perl module from [WebAuth 4.4.0 or
later](https://www.eyrie.org/~eagle/software/webauth/).

The Duo integration object support in the wallet server requires the
[Net::Duo](https://www.eyrie.org/~eagle/software/net-duo/), JSON, and
Perl6::Slurp Perl modules.

The password object support in the wallet server requires the
Crypt::GeneratePassword Perl module.

The LDAP attribute ACL verifier requires the Authen::SASL and Net::LDAP
Perl modules.  This verifier only works with LDAP servers that support
GSS-API binds.

The NetDB ACL verifier (only of interest at sites using NetDB to manage
DNS) requires the Net::Remctl Perl module.

To bootstrap from a Git checkout, or if you change the Automake files and
need to regenerate Makefile.in, you will need Automake 1.11 or later.  For
bootstrap or if you change configure.ac or any of the m4 files it includes
and need to regenerate configure or config.h.in, you will need Autoconf
2.64 or later.  Perl is also required to generate manual pages from a
fresh Git checkout.

## Building and Installation

You can build and install wallet with the standard commands:

```
    ./configure
    make
    make install
```

If you are building from a Git clone, first run `./bootstrap` in the
source directory to generate the build files.  `make install` will
probably have to be done as root.  Building outside of the source
directory is also supported, if you wish, by creating an empty directory
and then running configure with the correct relative path.

If you are upgrading the wallet server from an earlier installed version,
run `wallet-admin upgrade` after installation to upgrade the database
schema.  See the wallet-admin manual page for more information.

You can pass the `--with-wallet-server` and `--with-wallet-port` options
to configure to compile in a default wallet server and port.  If no port
is set, the remctl default port is used.  If no server is set, the server
must be specified either in `krb5.conf` configuration or on the wallet
command line or the client will exit with an error.

By default, wallet uses whatever Perl executable exists in the current
`PATH`.  That Perl's path is what the server scripts will use, and that
Perl's configuration will be used to determine where the server Perl
modules will be installed.

To specify a particular Perl executable to use, either set the `PERL`
environment variable or pass it to configure like:

```
    ./configure PERL=/path/to/my/perl
```

By default, wallet installs itself under `/usr/local` except for the
server Perl modules, which are installed into whatever default site module
path is used by your Perl installation.  To change the installation
location of the files other than the Perl modules, pass the `--prefix=DIR`
argument to configure.