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  * 4. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)ucred.h     8.4 (Berkeley) 1/9/95
  30  * $FreeBSD$
  31  */
  32
  33 #ifndef _SYS_UCRED_H_
  34 #define _SYS_UCRED_H_
  35
  36 #include <bsm/audit.h>
  37
  38 /*
  39  * Credentials.
  40  *
  41  * Please do not inspect cr_uid directly to determine superuserness.  The
  42  * priv(9) interface should be used to check for privilege.
  43  */
  44 #if defined(_KERNEL) || defined(_WANT_UCRED)
  45 struct ucred {
  46         u_int   cr_ref;                 /* reference count */
  47 #define cr_startcopy cr_uid
  48         uid_t   cr_uid;                 /* effective user id */
  49         uid_t   cr_ruid;                /* real user id */
  50         uid_t   cr_svuid;               /* saved user id */
  51         int     cr_ngroups;             /* number of groups */
  52         gid_t   cr_rgid;                /* real group id */
  53         gid_t   cr_svgid;               /* saved group id */
  54         struct uidinfo  *cr_uidinfo;    /* per euid resource consumption */
  55         struct uidinfo  *cr_ruidinfo;   /* per ruid resource consumption */
  56         struct prison   *cr_prison;     /* jail(2) */
  57         void            *cr_pspare;     /* general use */
  58         u_int           cr_flags;       /* credential flags */
  59         void            *cr_pspare2[2]; /* general use 2 */
  60 #define cr_endcopy      cr_label
  61         struct label    *cr_label;      /* MAC label */
  62         struct auditinfo_addr   cr_audit;       /* Audit properties. */
  63         gid_t   *cr_groups;             /* groups */
  64         int     cr_agroups;             /* Available groups */
  65 };
  66 #define NOCRED  ((struct ucred *)0)     /* no credential available */
  67 #define FSCRED  ((struct ucred *)-1)    /* filesystem credential */
  68 #endif /* _KERNEL || _WANT_UCRED */
  69
  70 #define XU_NGROUPS      16
  71
  72 /*
  73  * This is the external representation of struct ucred.
  74  */
  75 struct xucred {
  76         u_int   cr_version;             /* structure layout version */
  77         uid_t   cr_uid;                 /* effective user id */
  78         short   cr_ngroups;             /* number of groups */
  79         gid_t   cr_groups[XU_NGROUPS];  /* groups */
  80         void    *_cr_unused1;           /* compatibility with old ucred */
  81 };
  82 #define XUCRED_VERSION  0
  83
  84 /* This can be used for both ucred and xucred structures. */
  85 #define cr_gid cr_groups[0]
  86
  87 #ifdef _KERNEL
  88 struct proc;
  89 struct thread;
  90
  91 void    change_egid(struct ucred *newcred, gid_t egid);
  92 void    change_euid(struct ucred *newcred, struct uidinfo *euip);
  93 void    change_rgid(struct ucred *newcred, gid_t rgid);
  94 void    change_ruid(struct ucred *newcred, struct uidinfo *ruip);
  95 void    change_svgid(struct ucred *newcred, gid_t svgid);
  96 void    change_svuid(struct ucred *newcred, uid_t svuid);
  97 void    crcopy(struct ucred *dest, struct ucred *src);
  98 struct ucred    *crcopysafe(struct proc *p, struct ucred *cr);
  99 struct ucred    *crdup(struct ucred *cr);
 100 void    cred_update_thread(struct thread *td);
 101 void    crfree(struct ucred *cr);
 102 struct ucred    *crget(void);
 103 struct ucred    *crhold(struct ucred *cr);
 104 int     crshared(struct ucred *cr);
 105 void    cru2x(struct ucred *cr, struct xucred *xcr);
 106 void    crsetgroups(struct ucred *cr, int n, gid_t *groups);
 107 int     groupmember(gid_t gid, struct ucred *cred);
 108 #endif /* _KERNEL */
 109
 110 #endif /* !_SYS_UCRED_H_ */