lib/kafs/kafs.h

   1 /*
   2  * Copyright (c) 1995 - 2001, 2003 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /* $Id$ */
  35
  36 #ifndef __KAFS_H
  37 #define __KAFS_H
  38
  39 /* XXX must include krb5.h or krb.h */
  40
  41 /* sys/ioctl.h must be included manually before kafs.h */
  42
  43 /*
  44  */
  45 #define AFSCALL_PIOCTL 20
  46 #define AFSCALL_SETPAG 21
  47
  48 #ifndef _VICEIOCTL
  49 #define _VICEIOCTL(id)  ((unsigned int ) _IOW('V', id, struct ViceIoctl))
  50 #define _AFSCIOCTL(id)  ((unsigned int ) _IOW('C', id, struct ViceIoctl))
  51 #endif /* _VICEIOCTL */
  52
  53 #define VIOCSETAL               _VICEIOCTL(1)
  54 #define VIOCGETAL               _VICEIOCTL(2)
  55 #define VIOCSETTOK              _VICEIOCTL(3)
  56 #define VIOCGETVOLSTAT          _VICEIOCTL(4)
  57 #define VIOCSETVOLSTAT          _VICEIOCTL(5)
  58 #define VIOCFLUSH               _VICEIOCTL(6)
  59 #define VIOCGETTOK              _VICEIOCTL(8)
  60 #define VIOCUNLOG               _VICEIOCTL(9)
  61 #define VIOCCKSERV              _VICEIOCTL(10)
  62 #define VIOCCKBACK              _VICEIOCTL(11)
  63 #define VIOCCKCONN              _VICEIOCTL(12)
  64 #define VIOCWHEREIS             _VICEIOCTL(14)
  65 #define VIOCACCESS              _VICEIOCTL(20)
  66 #define VIOCUNPAG               _VICEIOCTL(21)
  67 #define VIOCGETFID              _VICEIOCTL(22)
  68 #define VIOCSETCACHESIZE        _VICEIOCTL(24)
  69 #define VIOCFLUSHCB             _VICEIOCTL(25)
  70 #define VIOCNEWCELL             _VICEIOCTL(26)
  71 #define VIOCGETCELL             _VICEIOCTL(27)
  72 #define VIOC_AFS_DELETE_MT_PT   _VICEIOCTL(28)
  73 #define VIOC_AFS_STAT_MT_PT     _VICEIOCTL(29)
  74 #define VIOC_FILE_CELL_NAME     _VICEIOCTL(30)
  75 #define VIOC_GET_WS_CELL        _VICEIOCTL(31)
  76 #define VIOC_AFS_MARINER_HOST   _VICEIOCTL(32)
  77 #define VIOC_GET_PRIMARY_CELL   _VICEIOCTL(33)
  78 #define VIOC_VENUSLOG           _VICEIOCTL(34)
  79 #define VIOC_GETCELLSTATUS      _VICEIOCTL(35)
  80 #define VIOC_SETCELLSTATUS      _VICEIOCTL(36)
  81 #define VIOC_FLUSHVOLUME        _VICEIOCTL(37)
  82 #define VIOC_AFS_SYSNAME        _VICEIOCTL(38)
  83 #define VIOC_EXPORTAFS          _VICEIOCTL(39)
  84 #define VIOCGETCACHEPARAMS      _VICEIOCTL(40)
  85 #define VIOC_GCPAGS             _VICEIOCTL(48)
  86
  87 #define VIOCGETTOK2             _AFSCIOCTL(7)
  88 #define VIOCSETTOK2             _AFSCIOCTL(8)
  89
  90 struct ViceIoctl {
  91   caddr_t in, out;
  92   short in_size;
  93   short out_size;
  94 };
  95
  96 struct ClearToken {
  97   int32_t AuthHandle;
  98   char HandShakeKey[8];
  99   int32_t ViceId;
 100   int32_t BeginTimestamp;
 101   int32_t EndTimestamp;
 102 };
 103
 104 /* Use k_hasafs() to probe if the machine supports AFS syscalls.
 105    The other functions will generate a SIGSYS if AFS is not supported */
 106
 107 int k_hasafs (void);
 108 int k_hasafs_recheck (void);
 109
 110 int krb_afslog (const char *cell, const char *realm);
 111 int krb_afslog_uid (const char *cell, const char *realm, uid_t uid);
 112 int krb_afslog_home (const char *cell, const char *realm,
 113                          const char *homedir);
 114 int krb_afslog_uid_home (const char *cell, const char *realm, uid_t uid,
 115                              const char *homedir);
 116
 117 int krb_realm_of_cell (const char *cell, char **realm);
 118
 119 /* compat */
 120 #define k_afsklog krb_afslog
 121 #define k_afsklog_uid krb_afslog_uid
 122
 123 int k_pioctl (char *a_path,
 124                   int o_opcode,
 125                   struct ViceIoctl *a_paramsP,
 126                   int a_followSymlinks);
 127 int k_unlog (void);
 128 int k_setpag (void);
 129 int k_afs_cell_of_file (const char *path, char *cell, int len);
 130
 131
 132
 133 /* XXX */
 134 #ifdef KFAILURE
 135 #define KRB_H_INCLUDED
 136 #endif
 137
 138 #ifdef KRB5_RECVAUTH_IGNORE_VERSION
 139 #define KRB5_H_INCLUDED
 140 #endif
 141
 142 void kafs_set_verbose (void (*kafs_verbose)(void *, const char *), void *);
 143 int kafs_settoken_rxkad (const char *, struct ClearToken *,
 144                              void *ticket, size_t ticket_len);
 145 #ifdef KRB_H_INCLUDED
 146 int kafs_settoken (const char*, uid_t, CREDENTIALS*);
 147 #endif
 148 #ifdef KRB5_H_INCLUDED
 149 int kafs_settoken5 (krb5_context, const char*, uid_t, krb5_creds*);
 150 #endif
 151
 152
 153 #ifdef KRB5_H_INCLUDED
 154 krb5_error_code krb5_afslog_uid (krb5_context context,
 155                                      krb5_ccache id,
 156                                      const char *cell,
 157                                      krb5_const_realm realm,
 158                                      uid_t uid);
 159 krb5_error_code krb5_afslog (krb5_context context,
 160                                  krb5_ccache id,
 161                                  const char *cell,
 162                                  krb5_const_realm realm);
 163 krb5_error_code krb5_afslog_uid_home (krb5_context context,
 164                                           krb5_ccache id,
 165                                           const char *cell,
 166                                           krb5_const_realm realm,
 167                                           uid_t uid,
 168                                           const char *homedir);
 169
 170 krb5_error_code krb5_afslog_home (krb5_context context,
 171                                       krb5_ccache id,
 172                                       const char *cell,
 173                                       krb5_const_realm realm,
 174                                       const char *homedir);
 175
 176 krb5_error_code krb5_realm_of_cell (const char *cell, char **realm);
 177
 178 #endif
 179
 180
 181 #define _PATH_VICE              "/usr/vice/etc/"
 182 #define _PATH_THISCELL          _PATH_VICE "ThisCell"
 183 #define _PATH_CELLSERVDB        _PATH_VICE "CellServDB"
 184 #define _PATH_THESECELLS        _PATH_VICE "TheseCells"
 185
 186 #define _PATH_ARLA_VICE         "/usr/arla/etc/"
 187 #define _PATH_ARLA_THISCELL     _PATH_ARLA_VICE "ThisCell"
 188 #define _PATH_ARLA_CELLSERVDB   _PATH_ARLA_VICE "CellServDB"
 189 #define _PATH_ARLA_THESECELLS   _PATH_ARLA_VICE "TheseCells"
 190
 191 #define _PATH_OPENAFS_DEBIAN_VICE               "/etc/openafs/"
 192 #define _PATH_OPENAFS_DEBIAN_THISCELL           _PATH_OPENAFS_DEBIAN_VICE "ThisCell"
 193 #define _PATH_OPENAFS_DEBIAN_CELLSERVDB         _PATH_OPENAFS_DEBIAN_VICE "CellServDB"
 194 #define _PATH_OPENAFS_DEBIAN_THESECELLS         _PATH_OPENAFS_DEBIAN_VICE "TheseCells"
 195
 196 #define _PATH_OPENAFS_MACOSX_VICE               "/var/db/openafs/etc/"
 197 #define _PATH_OPENAFS_MACOSX_THISCELL           _PATH_OPENAFS_MACOSX_VICE "ThisCell"
 198 #define _PATH_OPENAFS_MACOSX_CELLSERVDB         _PATH_OPENAFS_MACOSX_VICE "CellServDB"
 199 #define _PATH_OPENAFS_MACOSX_THESECELLS         _PATH_OPENAFS_MACOSX_VICE "TheseCells"
 200
 201 #define _PATH_ARLA_DEBIAN_VICE                  "/etc/arla/"
 202 #define _PATH_ARLA_DEBIAN_THISCELL              _PATH_ARLA_DEBIAN_VICE "ThisCell"
 203 #define _PATH_ARLA_DEBIAN_CELLSERVDB            _PATH_ARLA_DEBIAN_VICE "CellServDB"
 204 #define _PATH_ARLA_DEBIAN_THESECELLS            _PATH_ARLA_DEBIAN_VICE "TheseCells"
 205
 206 #define _PATH_ARLA_OPENBSD_VICE                 "/etc/afs/"
 207 #define _PATH_ARLA_OPENBSD_THISCELL             _PATH_ARLA_OPENBSD_VICE "ThisCell"
 208 #define _PATH_ARLA_OPENBSD_CELLSERVDB           _PATH_ARLA_OPENBSD_VICE "CellServDB"
 209 #define _PATH_ARLA_OPENBSD_THESECELLS           _PATH_ARLA_OPENBSD_VICE "TheseCells"
 210
 211 extern int _kafs_debug;
 212
 213 #endif /* __KAFS_H */