LIBRARY

AFS cache manager access library (libkafs, -lkafs)

SYNOPSIS

In kafs.h Ft int Fn k_afs_cell_of_file const char *path char *cell int len Ft int Fn k_hasafs void Ft int Fn k_hasafs_recheck void Ft int Fn k_pioctl char *a_path int o_opcode struct ViceIoctl *a_paramsP int a_followSymlinks Ft int Fn k_setpag void Ft int Fn k_unlog void Ft void Fn kafs_set_verbose void (*func)(void *, const char *, int) void * Ft int Fn kafs_settoken_rxkad const char *cell struct ClearToken *token void *ticket size_t ticket_len Ft int Fn kafs_settoken const char *cell uid_t uid CREDENTIALS *c Fn krb_afslog char *cell char *realm Ft int Fn krb_afslog_uid char *cell char *realm uid_t uid Ft krb5_error_code Fn krb5_afslog_uid krb5_context context krb5_ccache id const char *cell krb5_const_realm realm uid_t uid Ft int Fn kafs_settoken5 const char *cell uid_t uid krb5_creds *c Ft krb5_error_code Fn krb5_afslog krb5_context context krb5_ccache id const char *cell krb5_const_realm realm

DESCRIPTION

Fn k_hasafs initializes some library internal structures, and tests for the presence of AFS in the kernel, none of the other functions should be called before Fn k_hasafs is called, or if it fails.

Fn k_hasafs_recheck forces a recheck if a AFS client has started since last time Fn k_hasafs or Fn k_hasafs_recheck was called.

Fn kafs_set_verbose set a log function that will be called each time the kafs library does something important so that the application using libkafs can output verbose logging. Calling the function Fa kafs_set_verbose with the function argument set to NULL will stop libkafs from calling the logging function (if set).

Fn kafs_settoken_rxkad set rxkad with the Fa token and Fa ticket (that have the length Fa ticket_len ) for a given Fa cell .

Fn kafs_settoken and Fn kafs_settoken5 work the same way as Fn kafs_settoken_rxkad but internally converts the Kerberos 4 or 5 credential to a afs cleartoken and ticket.

Fn krb_afslog , and Fn krb_afslog_uid obtains new tokens (and possibly tickets) for the specified Fa cell and Fa realm . If Fa cell is NULL the local cell is used. If Fa realm is NULL the function tries to guess what realm to use. Unless you have some good knowledge of what cell or realm to use, you should pass NULL Fn krb_afslog will use the real user-id for the ViceId field in the token, Fn krb_afslog_uid will use Fa uid .

Fn krb5_afslog , and Fn krb5_afslog_uid are the Kerberos 5 equivalents of Fn krb_afslog , and Fn krb_afslog_uid .

Fn krb5_afslog , Fn kafs_settoken5 can be configured to behave differently via a krb5_appdefault option afs-use-524 in krb5.conf Possible values for afs-use-524 are:

yes

use the 524 server in the realm to convert the ticket

no

use the Kerberos 5 ticket directly, can be used with if the afs cell support 2b token.

local, 2b

convert the Kerberos 5 credential to a 2b token locally (the same work as a 2b 524 server should have done).

Example:

[appdefaults]
        SU.SE = { afs-use-524 = local }
        PDC.KTH.SE = { afs-use-524 = yes }
        afs-use-524 = yes

libkafs will use the libkafs as application name when running the krb5_appdefault function call.

The (uppercased) cell name is used as the realm to the krb5_appdefault function.

Fn k_afs_cell_of_file will in Fa cell return the cell of a specified file, no more than Fa len characters is put in Fa cell .

Fn k_pioctl does a Fn pioctl system call with the specified arguments. This function is equivalent to Fn lpioctl .

Fn k_setpag initializes a new PAG.

Fn k_unlog removes destroys all tokens in the current PAG.

RETURN VALUES

Fn k_hasafs returns 1 if AFS is present in the kernel, 0 otherwise. Fn krb_afslog and Fn krb_afslog_uid returns 0 on success, or a Kerberos error number on failure. Fn k_afs_cell_of_file , Fn k_pioctl , Fn k_setpag , and Fn k_unlog all return the value of the underlaying system call, 0 on success.

EXAMPLES

The following code from login will obtain a new PAG and tokens for the local cell and the cell of the users home directory.

if (k_hasafs()) {
        char cell[64];
        k_setpag();
        if(k_afs_cell_of_file(pwd->pw_dir, cell, sizeof(cell)) == 0)
                krb_afslog(cell, NULL);
        krb_afslog(NULL, NULL);
}

FILES

libkafs will search for ThisCell and TheseCells in the following locations: /usr/vice/etc /etc/openafs /var/db/openafs/etc /usr/arla/etc /etc/arla and /etc/afs