AFS::PAG 1.02

(Perl bindings for AFS PAG manipulation)

Written by Russ Allbery <rra@cpan.org>

Copyright 2013, 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 below for more information.

BLURB

AFS::PAG provides the standard PAG and token manipulation functions setpag and unlog to Perl programs as a native module. It also provides the hasafs and haspag functions to detect whether AFS is running and whether the current process is in a PAG. Unlike the more general AFS module, it will build with any recent OpenAFS, Heimdal's libkafs, or on Linux without any AFS libraries at all.

DESCRIPTION

AFS is a distributed file system allowing cross-platform sharing of files among multiple computers. It associates client credentials (called AFS tokens) with a Process Authentication Group, or PAG. AFS::PAG makes available in Perl the PAG manipulation functions provided by the libkafs or libkopenafs libraries.

With the functions provided by this module, a Perl program can detect whether AFS is available on the local system and whether it is currently running inside a PAG. It can also create a new PAG and put the current process in it, and remove any AFS tokens in the current PAG.

This module doesn't provide a direct way to obtain new AFS tokens, only to create a new PAG so that any obtained tokens are isolated from other processes on the system and can be inherited by child processes.

REQUIREMENTS

Perl 5.10.1 or later, the Config::AutoConf module, and a C compiler are required to build this module. On any platform other than Linux, either the kafs library (from Heimdal) or the kopenafs library (from recent versions of OpenAFS) are also required.

The following additional Perl modules will be used by the test suite if present:

    IPC::System::Simple
    Test::MinimumVersion
    Test::Perl::Critic
    Test::Pod
    Test::Pod::Coverage
    Test::Spelling
    Test::Strict
    Test::Synopsis

All are available on CPAN. Those tests will be skipped if the modules are not available.

To enable tests that may be sensitive to the local environment or that produce a lot of false positives without uncovering many problems, set RRA_MAINTAINER_TESTS to a true value.

BUILDING AND INSTALLATION

AFS::PAG uses Module::Build and can be installed using the same process as any other Module::Build module:

    perl Build.PL
    ./Build
    ./Build test
    ./Build install

If your libkafs or libkopenafs libraries are in a path that's not searched by your linker by default, pass them to Build.PL using the --extra-linker-flags option, as in:

    perl Build.PL --extra-linker-flags '-L/opt/openafs/lib'

You will have to run the last command as root unless you're installing into a local Perl module tree in your home directory.

SUPPORT

The AFS::PAG web page at:

    http://www.eyrie.org/~eagle/software/afs-pag/

will always have the current version of this package, the current documentation, and pointers to any additional resources.

For bug tracking, this package uses the CPAN bug tracker at:

    https://rt.cpan.org/Public/Dist/Display.html?Name=AFS-PAG

I welcome bug reports and patches for this package at rra@cpan.org or via the CPAN bug tracker. However, please be aware that I tend to be extremely busy and work projects often take priority. I'll save your mail and get to it as soon as I can, but it may take me a couple of months.

SOURCE REPOSITORY

AFS::PAG is maintained using Git. You can access the current source by cloning the repository at:

    git://git.eyrie.org/afs/afs-pag.git

or view the repository via the web at:

    http://git.eyrie.org/?p=afs/afs-pag.git

When contributing modifications, either patches (possibly generated by git format-patch) or Git pull requests are welcome.

LICENSE

The AFS::PAG package as a whole is covered by the following copyright statement and license:

  Copyright 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.

All individual files without an explicit exception below are released under this license. Some files may have additional copyright holders as noted in those files. There is detailed information about the licensing of each file in the LICENSE file in this distribution.

Some files in this distribution are individually released under different licenses, all of which are compatible with the above general package license but which may require preservation of additional notices. All required notices are preserved in the LICENSE file.

Converted to XHTML by faq2html version 1.33