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 #endif /* _VICEIOCTL */
  51
  52 #define VIOCSETAL               _VICEIOCTL(1)
  53 #define VIOCGETAL               _VICEIOCTL(2)
  54 #define VIOCSETTOK              _VICEIOCTL(3)
  55 #define VIOCGETVOLSTAT          _VICEIOCTL(4)
  56 #define VIOCSETVOLSTAT          _VICEIOCTL(5)
  57 #define VIOCFLUSH               _VICEIOCTL(6)
  58 #define VIOCGETTOK              _VICEIOCTL(8)
  59 #define VIOCUNLOG               _VICEIOCTL(9)
  60 #define VIOCCKSERV              _VICEIOCTL(10)
  61 #define VIOCCKBACK              _VICEIOCTL(11)
  62 #define VIOCCKCONN              _VICEIOCTL(12)
  63 #define VIOCWHEREIS             _VICEIOCTL(14)
  64 #define VIOCACCESS              _VICEIOCTL(20)
  65 #define VIOCUNPAG               _VICEIOCTL(21)
  66 #define VIOCGETFID              _VICEIOCTL(22)
  67 #define VIOCSETCACHESIZE        _VICEIOCTL(24)
  68 #define VIOCFLUSHCB             _VICEIOCTL(25)
  69 #define VIOCNEWCELL             _VICEIOCTL(26)
  70 #define VIOCGETCELL             _VICEIOCTL(27)
  71 #define VIOC_AFS_DELETE_MT_PT   _VICEIOCTL(28)
  72 #define VIOC_AFS_STAT_MT_PT     _VICEIOCTL(29)
  73 #define VIOC_FILE_CELL_NAME     _VICEIOCTL(30)
  74 #define VIOC_GET_WS_CELL        _VICEIOCTL(31)
  75 #define VIOC_AFS_MARINER_HOST   _VICEIOCTL(32)
  76 #define VIOC_GET_PRIMARY_CELL   _VICEIOCTL(33)
  77 #define VIOC_VENUSLOG           _VICEIOCTL(34)
  78 #define VIOC_GETCELLSTATUS      _VICEIOCTL(35)
  79 #define VIOC_SETCELLSTATUS      _VICEIOCTL(36)
  80 #define VIOC_FLUSHVOLUME        _VICEIOCTL(37)
  81 #define VIOC_AFS_SYSNAME        _VICEIOCTL(38)
  82 #define VIOC_EXPORTAFS          _VICEIOCTL(39)
  83 #define VIOCGETCACHEPARAMS      _VICEIOCTL(40)
  84 #define VIOC_GCPAGS             _VICEIOCTL(48)
  85
  86 struct ViceIoctl {
  87   caddr_t in, out;
  88   short in_size;
  89   short out_size;
  90 };
  91
  92 struct ClearToken {
  93   int32_t AuthHandle;
  94   char HandShakeKey[8];
  95   int32_t ViceId;
  96   int32_t BeginTimestamp;
  97   int32_t EndTimestamp;
  98 };
  99
 100 #ifdef __STDC__
 101 #ifndef __P
 102 #define __P(x) x
 103 #endif
 104 #else
 105 #ifndef __P
 106 #define __P(x) ()
 107 #endif
 108 #endif
 109
 110 /* Use k_hasafs() to probe if the machine supports AFS syscalls.
 111    The other functions will generate a SIGSYS if AFS is not supported */
 112
 113 int k_hasafs __P((void));
 114
 115 int krb_afslog __P((const char *cell, const char *realm));
 116 int krb_afslog_uid __P((const char *cell, const char *realm, uid_t uid));
 117 int krb_afslog_home __P((const char *cell, const char *realm,
 118                          const char *homedir));
 119 int krb_afslog_uid_home __P((const char *cell, const char *realm, uid_t uid,
 120                              const char *homedir));
 121
 122 int krb_realm_of_cell __P((const char *cell, char **realm));
 123
 124 /* compat */
 125 #define k_afsklog krb_afslog
 126 #define k_afsklog_uid krb_afslog_uid
 127
 128 int k_pioctl __P((char *a_path,
 129                   int o_opcode,
 130                   struct ViceIoctl *a_paramsP,
 131                   int a_followSymlinks));
 132 int k_unlog __P((void));
 133 int k_setpag __P((void));
 134 int k_afs_cell_of_file __P((const char *path, char *cell, int len));
 135
 136
 137
 138 /* XXX */
 139 #ifdef KFAILURE
 140 #define KRB_H_INCLUDED
 141 #endif
 142
 143 #ifdef KRB5_RECVAUTH_IGNORE_VERSION
 144 #define KRB5_H_INCLUDED
 145 #endif
 146
 147 void kafs_set_verbose __P((void (*kafs_verbose)(void *, const char *), void *));
 148 int kafs_settoken_rxkad __P((const char *, struct ClearToken *,
 149                              void *ticket, size_t ticket_len));
 150 #ifdef KRB_H_INCLUDED
 151 int kafs_settoken __P((const char*, uid_t, CREDENTIALS*));
 152 #endif
 153 #ifdef KRB5_H_INCLUDED
 154 int kafs_settoken5 __P((krb5_context, const char*, uid_t, krb5_creds*));
 155 #endif
 156
 157
 158 #ifdef KRB5_H_INCLUDED
 159 krb5_error_code krb5_afslog_uid __P((krb5_context context,
 160                                      krb5_ccache id,
 161                                      const char *cell,
 162                                      krb5_const_realm realm,
 163                                      uid_t uid));
 164 krb5_error_code krb5_afslog __P((krb5_context context,
 165                                  krb5_ccache id,
 166                                  const char *cell,
 167                                  krb5_const_realm realm));
 168 krb5_error_code krb5_afslog_uid_home __P((krb5_context context,
 169                                           krb5_ccache id,
 170                                           const char *cell,
 171                                           krb5_const_realm realm,
 172                                           uid_t uid,
 173                                           const char *homedir));
 174
 175 krb5_error_code krb5_afslog_home __P((krb5_context context,
 176                                       krb5_ccache id,
 177                                       const char *cell,
 178                                       krb5_const_realm realm,
 179                                       const char *homedir));
 180
 181 krb5_error_code krb5_realm_of_cell __P((const char *cell, char **realm));
 182
 183 #endif
 184
 185
 186 #define _PATH_VICE              "/usr/vice/etc/"
 187 #define _PATH_THISCELL          _PATH_VICE "ThisCell"
 188 #define _PATH_CELLSERVDB        _PATH_VICE "CellServDB"
 189 #define _PATH_THESECELLS        _PATH_VICE "TheseCells"
 190
 191 #define _PATH_ARLA_VICE         "/usr/arla/etc/"
 192 #define _PATH_ARLA_THISCELL     _PATH_ARLA_VICE "ThisCell"
 193 #define _PATH_ARLA_CELLSERVDB   _PATH_ARLA_VICE "CellServDB"
 194 #define _PATH_ARLA_THESECELLS   _PATH_ARLA_VICE "TheseCells"
 195
 196 #define _PATH_OPENAFS_DEBIAN_VICE               "/etc/openafs/"
 197 #define _PATH_OPENAFS_DEBIAN_THISCELL           _PATH_OPENAFS_DEBIAN_VICE "ThisCell"
 198 #define _PATH_OPENAFS_DEBIAN_CELLSERVDB         _PATH_OPENAFS_DEBIAN_VICE "CellServDB"
 199 #define _PATH_OPENAFS_DEBIAN_THESECELLS         _PATH_OPENAFS_DEBIAN_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 extern int _kafs_debug;
 207
 208 #endif /* __KAFS_H */