1b8d0f8faab6bc50b40ca8f20d4fee23b164513c
[openafs.git] / src / afs / VNOPS / afs_vnop_access.c
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 /*
11  * afs_vnop_access.c - access vop ccess mode bit support for vnode operations.
12  *
13  * Implements:
14  * afs_GetAccessBits
15  * afs_AccessOK
16  * afs_access
17  *
18  * Local:
19  * fileModeMap (table)
20  */
21
22 #include <afsconfig.h>
23 #include "afs/param.h"
24
25
26 #include "afs/sysincludes.h"    /* Standard vendor system headers */
27 #include "afsincludes.h"        /* Afs-based standard headers */
28 #include "afs/afs_stats.h"      /* statistics */
29 #include "afs/afs_cbqueue.h"
30 #include "afs/nfsclient.h"
31 #include "afs/afs_osidnlc.h"
32
33 #ifndef ANONYMOUSID
34 #define ANONYMOUSID     32766   /* make sure this is same as in ptserver.h */
35 #endif
36
37
38
39
40 /* access bits to turn off for various owner Unix mode values */
41 static char fileModeMap[8] = {
42     PRSFS_READ | PRSFS_WRITE,
43     PRSFS_READ | PRSFS_WRITE,
44     PRSFS_READ,
45     PRSFS_READ,
46     PRSFS_WRITE,
47     PRSFS_WRITE,
48     0,
49     0
50 };
51
52 /* avc must be held.  Returns bit map of mode bits.  Ignores file mode bits */
53 afs_int32
54 afs_GetAccessBits(register struct vcache *avc, register afs_int32 arights,
55                   register struct vrequest *areq)
56 {
57     AFS_STATCNT(afs_GetAccessBits);
58     /* see if anyuser has the required access bits */
59     if ((arights & avc->f.anyAccess) == arights) {
60         return arights;
61     }
62
63     /* look in per-pag cache */
64     if (avc->Access) {          /* not beautiful, but Sun's cc will tolerate it */
65         struct axscache *ac;
66
67         ac = afs_FindAxs(avc->Access, areq->uid);
68         if (ac) {
69             return (arights & ac->axess);
70         }
71     }
72
73     if (!(avc->f.states & CForeign)) {
74         /* If there aren't any bits cached for this user (but the vnode
75          * _is_ cached, obviously), make sure this user has valid tokens
76          * before bothering with the RPC.  */
77         struct unixuser *tu;
78         tu = afs_FindUser(areq->uid, avc->f.fid.Cell, READ_LOCK);
79         if (!tu) {
80             return (arights & avc->f.anyAccess);
81         }
82         if ((tu->vid == UNDEFVID) || !(tu->states & UHasTokens)
83             || (tu->states & UTokensBad)) {
84             afs_PutUser(tu, READ_LOCK);
85             return (arights & avc->f.anyAccess);
86         } else {
87             afs_PutUser(tu, READ_LOCK);
88         }
89     }
90
91     if (AFS_IS_DISCONNECTED && !AFS_IN_SYNC) {
92         /* If we get this far, we have to ask the network. But we can't, so
93          * they're out of luck... */
94         return 0;
95     } else
96     {                           /* Ok, user has valid tokens, go ask the server. */
97         struct AFSFetchStatus OutStatus;
98         afs_int32 code;
99
100         code = afs_FetchStatus(avc, &avc->f.fid, areq, &OutStatus);
101         return (code ? 0 : OutStatus.CallerAccess & arights);
102     }
103 }
104
105
106 /* the new access ok function.  AVC must be held but not locked. if avc is a
107  * file, its parent need not be held, and should not be locked. */
108
109 int
110 afs_AccessOK(struct vcache *avc, afs_int32 arights, struct vrequest *areq,
111              afs_int32 check_mode_bits)
112 {
113     register struct vcache *tvc;
114     struct VenusFid dirFid;
115     register afs_int32 mask;
116     afs_int32 dirBits;
117     register afs_int32 fileBits;
118
119     AFS_STATCNT(afs_AccessOK);
120
121     if ((vType(avc) == VDIR) || (avc->f.states & CForeign)) {
122         /* rights are just those from acl */
123         if (afs_InReadDir(avc)) {
124             /* if we are already in readdir, then they may have read and
125              * lookup, and nothing else, and nevermind the real ACL.
126              * Otherwise we might end up with problems trying to call
127              * FetchStatus on the vnode readdir is working on, and that
128              * would be a real mess.
129              */
130             dirBits = PRSFS_LOOKUP | PRSFS_READ;
131             return (arights == (dirBits & arights));
132         }
133         return (arights == afs_GetAccessBits(avc, arights, areq));
134     } else {
135         /* some rights come from dir and some from file.  Specifically, you 
136          * have "a" rights to a file if you are its owner, which comes
137          * back as "a" rights to the file. You have other rights just
138          * from dir, but all are restricted by the file mode bit. Now,
139          * if you have I and A rights to a file, we throw in R and W
140          * rights for free. These rights will then be restricted by
141          * the access mask. */
142         dirBits = 0;
143         if (avc->f.parent.vnode) {
144             dirFid.Cell = avc->f.fid.Cell;
145             dirFid.Fid.Volume = avc->f.fid.Fid.Volume;
146             dirFid.Fid.Vnode = avc->f.parent.vnode;
147             dirFid.Fid.Unique = avc->f.parent.unique;
148             /* Avoid this GetVCache call */
149             tvc = afs_GetVCache(&dirFid, areq, NULL, NULL);
150             if (tvc) {
151                 dirBits = afs_GetAccessBits(tvc, arights, areq);
152                 afs_PutVCache(tvc);
153             }
154         } else
155             dirBits = 0xffffffff;       /* assume OK; this is a race condition */
156         if (arights & PRSFS_ADMINISTER)
157             fileBits = afs_GetAccessBits(avc, arights, areq);
158         else
159             fileBits = 0;       /* don't make call if results don't matter */
160
161         /* compute basic rights in fileBits, taking A from file bits */
162         fileBits =
163             (fileBits & PRSFS_ADMINISTER) | (dirBits & ~PRSFS_ADMINISTER);
164
165         /* for files, throw in R and W if have I and A (owner).  This makes
166          * insert-only dirs work properly */
167         if (vType(avc) != VDIR
168             && (fileBits & (PRSFS_ADMINISTER | PRSFS_INSERT)) ==
169             (PRSFS_ADMINISTER | PRSFS_INSERT))
170             fileBits |= (PRSFS_READ | PRSFS_WRITE);
171
172         if (check_mode_bits & CHECK_MODE_BITS) {
173             /* owner mode bits are further restrictions on the access mode
174              * The mode bits are mapped to protection bits through the
175              * fileModeMap. If CMB_ALLOW_EXEC_AS_READ is set, it's from the
176              * NFS translator and we don't know if it's a read or execute
177              * on the NFS client, but both need to read the data.
178              */
179             mask = (avc->f.m.Mode & 0700) >> 6; /* file restrictions to use */
180             fileBits &= ~fileModeMap[mask];
181             if (check_mode_bits & CMB_ALLOW_EXEC_AS_READ) {
182                 if (avc->f.m.Mode & 0100)
183                     fileBits |= PRSFS_READ;
184             }
185         }
186         return ((fileBits & arights) == arights);       /* true if all rights bits are on */
187     }
188 }
189
190
191 #if defined(AFS_SUN5_ENV) || (defined(AFS_SGI_ENV) && !defined(AFS_SGI65_ENV))
192 int
193 afs_access(OSI_VC_DECL(avc), register afs_int32 amode, int flags,
194            afs_ucred_t *acred)
195 #else
196 int
197 afs_access(OSI_VC_DECL(avc), register afs_int32 amode,
198            afs_ucred_t *acred)
199 #endif
200 {
201     register afs_int32 code;
202     struct vrequest treq;
203     struct afs_fakestat_state fakestate;
204     OSI_VC_CONVERT(avc);
205
206     AFS_STATCNT(afs_access);
207     afs_Trace3(afs_iclSetp, CM_TRACE_ACCESS, ICL_TYPE_POINTER, avc,
208                ICL_TYPE_INT32, amode, ICL_TYPE_OFFSET,
209                ICL_HANDLE_OFFSET(avc->f.m.Length));
210     afs_InitFakeStat(&fakestate);
211     if ((code = afs_InitReq(&treq, acred)))
212         return code;
213
214     AFS_DISCON_LOCK();
215
216     if (afs_fakestat_enable && avc->mvstat == 1) {
217         code = afs_TryEvalFakeStat(&avc, &fakestate, &treq);
218         if (code == 0 && avc->mvstat == 1) {
219             afs_PutFakeStat(&fakestate);
220             AFS_DISCON_UNLOCK();
221             return 0;
222         }
223     } else {
224         code = afs_EvalFakeStat(&avc, &fakestate, &treq);
225     }
226
227     if (code) {
228         afs_PutFakeStat(&fakestate);
229         AFS_DISCON_UNLOCK();
230         return code;
231     }
232
233     if (vType(avc) != VDIR || !afs_InReadDir(avc)) {
234         code = afs_VerifyVCache(avc, &treq);
235         if (code) {
236             afs_PutFakeStat(&fakestate);
237             AFS_DISCON_UNLOCK();
238             code = afs_CheckCode(code, &treq, 16);
239             return code;
240         }
241     }
242
243     /* if we're looking for write access and we have a read-only file system, report it */
244     if ((amode & VWRITE) && (avc->f.states & CRO)) {
245         afs_PutFakeStat(&fakestate);
246         AFS_DISCON_UNLOCK();
247         return EROFS;
248     }
249     
250     /* If we're looking for write access, and we're disconnected without logging, forget it */
251     if ((amode & VWRITE) && (AFS_IS_DISCONNECTED && !AFS_IS_DISCON_RW)) {
252         afs_PutFakeStat(&fakestate);
253         AFS_DISCON_UNLOCK();
254         /* printf("Network is down in afs_vnop_access\n"); */
255         return ENETDOWN;
256     }
257     
258     code = 1;                   /* Default from here on in is access ok. */
259     if (avc->f.states & CForeign) {
260         /* In the dfs xlator the EXEC bit is mapped to LOOKUP */
261         if (amode & VEXEC)
262             code = afs_AccessOK(avc, PRSFS_LOOKUP, &treq, CHECK_MODE_BITS);
263         if (code && (amode & VWRITE)) {
264             code = afs_AccessOK(avc, PRSFS_WRITE, &treq, CHECK_MODE_BITS);
265             if (code && (vType(avc) == VDIR)) {
266                 if (code)
267                     code =
268                         afs_AccessOK(avc, PRSFS_INSERT, &treq,
269                                      CHECK_MODE_BITS);
270                 if (!code)
271                     code =
272                         afs_AccessOK(avc, PRSFS_DELETE, &treq,
273                                      CHECK_MODE_BITS);
274             }
275         }
276         if (code && (amode & VREAD))
277             code = afs_AccessOK(avc, PRSFS_READ, &treq, CHECK_MODE_BITS);
278     } else {
279         if (vType(avc) == VDIR) {
280             if (amode & VEXEC)
281                 code =
282                     afs_AccessOK(avc, PRSFS_LOOKUP, &treq, CHECK_MODE_BITS);
283             if (code && (amode & VWRITE)) {
284                 code =
285                     afs_AccessOK(avc, PRSFS_INSERT, &treq, CHECK_MODE_BITS);
286                 if (!code)
287                     code =
288                         afs_AccessOK(avc, PRSFS_DELETE, &treq,
289                                      CHECK_MODE_BITS);
290             }
291             if (code && (amode & VREAD))
292                 code =
293                     afs_AccessOK(avc, PRSFS_LOOKUP, &treq, CHECK_MODE_BITS);
294         } else {
295             if (amode & VEXEC) {
296                 code = afs_AccessOK(avc, PRSFS_READ, &treq, CHECK_MODE_BITS);
297                 if (code) {
298                         if ((avc->f.m.Mode & 0100) == 0)
299                             code = 0;
300                 } else if (avc->f.m.Mode & 0100)
301                     code = 1;
302             }
303             if (code && (amode & VWRITE)) {
304                 code = afs_AccessOK(avc, PRSFS_WRITE, &treq, CHECK_MODE_BITS);
305
306                 /* The above call fails when the NFS translator tries to copy
307                  ** a file with r--r--r-- permissions into a directory which
308                  ** has system:anyuser acl. This is because the destination file
309                  ** file is first created with r--r--r-- permissions through an
310                  ** unauthenticated connectin.  hence, the above afs_AccessOK
311                  ** call returns failure. hence, we retry without any file 
312                  ** mode bit checking */
313                 if (!code && AFS_NFSXLATORREQ(acred)
314                     && avc->f.m.Owner == ANONYMOUSID)
315                     code =
316                         afs_AccessOK(avc, PRSFS_WRITE, &treq,
317                                      DONT_CHECK_MODE_BITS);
318             }
319             if (code && (amode & VREAD))
320                 code = afs_AccessOK(avc, PRSFS_READ, &treq, CHECK_MODE_BITS);
321         }
322     }
323     afs_PutFakeStat(&fakestate);
324
325     AFS_DISCON_UNLOCK();
326     
327     if (code) {
328         return 0;               /* if access is ok */
329     } else {
330         code = afs_CheckCode(EACCES, &treq, 17);        /* failure code */
331         return code;
332     }
333 }
334
335 #if defined(UKERNEL) && defined(AFS_WEB_ENHANCEMENTS)
336 /*
337  * afs_getRights
338  * This function is just an interface to afs_GetAccessBits
339  */
340 int
341 afs_getRights(OSI_VC_DECL(avc), register afs_int32 arights,
342               afs_ucred_t *acred)
343 {
344     register afs_int32 code;
345     struct vrequest treq;
346     OSI_VC_CONVERT(avc);
347
348     if ((code = afs_InitReq(&treq, acred)))
349         return code;
350
351     code = afs_VerifyVCache(avc, &treq);
352     if (code) {
353         code = afs_CheckCode(code, &treq, 16);
354         return code;
355     }
356
357     return afs_GetAccessBits(avc, arights, &treq);
358 }
359 #endif /* defined(UKERNEL) && defined(AFS_WEB_ENHANCEMENTS) */