wallet

An architect
who does not believe
in privacy
may also lack faith
in keeping out the rain

John M. Ford, Growing Up Weightless

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, Kerberos keytabs, and WebAuth keyrings. 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 is written in C and builds against the C remctl libraries. You will have to install the remctl client libraries in order to build it. The wallet client will build with either MIT Kerberos or Heimdal.

The wallet server is written in Perl and requires Perl 5.8.0 or later plus Module::Build to build. It uses DBIx::Class and DBI to talk to a database, and therefore the DBIx::Class and DBI modules (and their dependencies) and a DBD module for the database it will use must be installed. The Date::Parse (part of the TimeDate distribution) and DateTime modules are required for date handling, and the SQL::Translator Perl module is also required for schema deployment and database upgrades. You will also need the DateTime::Format::* module corresponding to your 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 file object support in the wallet server requires the Digest::MD5 Perl module, which comes with recent versions of Perl and is available on CPAN for older versions.

The keytab support in the wallet server supports either Heimdal or MIT Kerberos KDCs. The Heimdal support requires the Heimdal::Kadm5 Perl module. The MIT Kerberos support requires the MIT Kerberos kadmin client program be installed. In either case, wallet also requires that the wallet server have a keytab for a principal with appropriate access to create, modify, and delete principals from the KDC (as configured in kadm5.acl on an MIT Kerberos KDC).

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.

The Duo integration object support in the wallet server requires the Net::Duo Perl module.

To support the LDAP attribute ACL verifier, the Authen::SASL and Net::LDAP Perl modules must be installed on the server. This verifier only works with LDAP servers that support GSS-API binds.

To support the NetDB ACL verifier (only of interest at sites using NetDB to manage DNS), the Net::Remctl Perl module must be installed on the server.

Download

The distribution:

wallet 1.1 2014-07-16 tar.gz (PGP signature) tar.xz (PGP signature)

An archive of older releases is also available.

wallet is maintained using the Git version control system. To check out the current development tree, clone:

    git://git.eyrie.org/kerberos/wallet.git

You can also browse the current development source.

Documentation

User documentation:

Manual pages:

Developer documentation:

Stanford-specific policy documentation:

Contributed programs:

Server API documentation:

License

The wallet package as a whole is covered under the following license:

Copyright 2006, 2007, 2008, 2009, 2010, 2012, 2013, 2014 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.

Some individual source files are covered by other, compatible licenses. For complete copyright and license information, see the file LICENSE in the wallet source distribution.

Last modified and spun 2014-08-10