view release on metacpan or  search on metacpan

t/data/generate/wallet/output/thread  view on Meta::CPAN

\h2[Requirements]

The wallet client requires the C
\link[https://www.eyrie.org/~eagle/software/remctl/][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:

\bullet(packed)[Date::Parse (part of the TimeDate distribution)]
\bullet(packed)[DBI]
\bullet(packed)[DBIx::Class]
\bullet(packed)[Module::Build]
\bullet(packed)[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 \code[remctld] and use
\code[remctld] to do authentication.  It can be ported to any other
front-end, but doing so will require writing a new version of
\code[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 \code[kadmin] client program be installed.  The
Active Directory support requires the Net::LDAP, Authen::SASL, and
IPC::Run Perl modules and the \code[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 \code[keytab-backend] script must be runnable via remctl on
the KDC.  This script also requires an MIT Kerberos \code[kadmin.local]
binary that supports the \code[-norandkey] option to \code[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
\link[https://www.eyrie.org/~eagle/software/webauth/][WebAuth 4.4.0 or
later].

The Duo integration object support in the wallet server requires the
\link[https://www.eyrie.org/~eagle/software/net-duo/][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.

\h2[Download]

The distribution:

\table[][
    \program[wallet][wallet]
        [kerberos/wallet-\version[wallet]]
]

An \link[https://archives.eyrie.org/software/ARCHIVE/wallet/] [archive of
older releases] is also available.

A Debian package is available from my \link[../debian.html][personal
repository].

wallet is maintained using the Git version control system.  To check out
the current development tree, see
\link[https://github.com/rra/wallet][GitHub] or clone:

\pre[    https://git.eyrie.org/git/kerberos/wallet.git]

Pull requests on GitHub are welcome.  You can also
\link[https://git.eyrie.org/?p=kerberos/wallet.git][browse the current
development source].

\h2[Documentation]

\div(left)[
    \class(first)[User documentation:]

    \doc[readme.html][README]
    \doc[news.html][Change summary]
    \doc[setup.html][Setup and configuration]
    \doc[config.html][Configuration options]
    \doc[objects-and-schemes.html][Objects and ACL schemes]
    \doc[wallet.html][wallet]
    \doc[wallet-admin.html][wallet-admin]
    \doc[wallet-backend.html][wallet-backend]
    \doc[wallet-report.html][wallet-report]
    \doc[keytab-backend.html][keytab-backend]
    \doc[naming.html][Stanford wallet naming policy]
    \doc[thanks.html][Thanks and credits]
    \doc[license.html][License and copyright]

    Developer documentation:

    \doc[design.html][Overall design]
    \doc[design-acl.html][ACL design]
    \doc[design-api.html][Server module API design]