sys/sys/ucred.h

   1 /*
   2  * Copyright (c) 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University 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 REGENTS 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 REGENTS 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  *      @(#)ucred.h     8.4 (Berkeley) 1/9/95
  34  * $FreeBSD: src/sys/sys/ucred.h,v 1.14.2.5 2002/03/09 05:20:25 dd Exp $
  35  * $DragonFly: src/sys/sys/ucred.h,v 1.2 2003/06/17 04:28:59 dillon Exp $
  36  */
  37
  38 #ifndef _SYS_UCRED_H_
  39 #define _SYS_UCRED_H_
  40
  41 /*
  42  * Credentials.
  43  *
  44  * Please do not inspect cr_uid directly to determine superuserness.
  45  * Only the suser()/suser_xxx() function should be used for this.
  46  */
  47 struct ucred {
  48         u_int   cr_ref;                 /* reference count */
  49         uid_t   cr_uid;                 /* effective user id */
  50         short   cr_ngroups;             /* number of groups */
  51         gid_t   cr_groups[NGROUPS];     /* groups */
  52         struct  uidinfo *cr_uidinfo;    /* per uid resource consumption */
  53 };
  54 #define cr_gid cr_groups[0]
  55 #define NOCRED ((struct ucred *)0)      /* no credential available */
  56 #define FSCRED ((struct ucred *)-1)     /* filesystem credential */
  57
  58 /*
  59  * This is the external representation of struct ucred, based upon the
  60  * size of a 4.2-RELEASE struct ucred.  There will probably never be
  61  * any need to change the size of this or layout of its used fields.
  62  */
  63 struct xucred {
  64         u_int   cr_version;             /* structure layout version */
  65         uid_t   cr_uid;                 /* effective user id */
  66         short   cr_ngroups;             /* number of groups */
  67         gid_t   cr_groups[NGROUPS];     /* groups */
  68         void    *_cr_unused1;           /* compatibility with old ucred */
  69 };
  70 #define XUCRED_VERSION  0
  71
  72 #ifdef _KERNEL
  73
  74 struct proc;
  75
  76 void            change_euid __P((struct proc *p, uid_t euid));
  77 void            change_ruid __P((struct proc *p, uid_t ruid));
  78 struct ucred    *crcopy __P((struct ucred *cr));
  79 struct ucred    *crdup __P((struct ucred *cr));
  80 void            crfree __P((struct ucred *cr));
  81 struct ucred    *crget __P((void));
  82 void            crhold __P((struct ucred *cr));
  83 void            cru2x __P((struct ucred *cr, struct xucred *xcr));
  84 int             groupmember __P((gid_t gid, struct ucred *cred));
  85 #endif /* _KERNEL */
  86
  87 #endif /* !_SYS_UCRED_H_ */