bsd/sys/ucred.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
  24 /*
  25  * Copyright (c) 1989, 1993
  26  *      The Regents of the University of California.  All rights reserved.
  27  *
  28  * Redistribution and use in source and binary forms, with or without
  29  * modification, are permitted provided that the following conditions
  30  * are met:
  31  * 1. Redistributions of source code must retain the above copyright
  32  *    notice, this list of conditions and the following disclaimer.
  33  * 2. Redistributions in binary form must reproduce the above copyright
  34  *    notice, this list of conditions and the following disclaimer in the
  35  *    documentation and/or other materials provided with the distribution.
  36  * 3. All advertising materials mentioning features or use of this software
  37  *    must display the following acknowledgement:
  38  *      This product includes software developed by the University of
  39  *      California, Berkeley and its contributors.
  40  * 4. Neither the name of the University nor the names of its contributors
  41  *    may be used to endorse or promote products derived from this software
  42  *    without specific prior written permission.
  43  *
  44  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  45  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  46  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  47  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  48  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  49  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  50  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  51  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  52  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  53  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  54  * SUCH DAMAGE.
  55  *
  56  *      @(#)ucred.h     8.4 (Berkeley) 1/9/95
  57  */
  58
  59 #ifndef _SYS_UCRED_H_
  60 #define _SYS_UCRED_H_
  61
  62 #include <sys/appleapiopts.h>
  63 #include <sys/cdefs.h>
  64 #include <sys/param.h>
  65 #include <bsm/audit.h>
  66
  67 #ifdef __APPLE_API_UNSTABLE
  68
  69 /*
  70  * In-kernel credential structure.
  71  *
  72  * Note that this structure should not be used outside the kernel, nor should
  73  * it or copies of it be exported outside.
  74  */
  75 struct ucred {
  76         TAILQ_ENTRY(ucred)      cr_link; /* never modify this without KAUTH_CRED_HASH_LOCK */
  77         u_long  cr_ref;                 /* reference count */
  78
  79         /* credential hash depends on everything from this point on (see kauth_cred_get_hashkey) */
  80         uid_t   cr_uid;                 /* effective user id */
  81         uid_t   cr_ruid;                /* real user id */
  82         uid_t   cr_svuid;               /* saved user id */
  83         short   cr_ngroups;             /* number of groups in advisory list */
  84         gid_t   cr_groups[NGROUPS];     /* advisory group list */
  85         gid_t   cr_rgid;                /* real group id */
  86         gid_t   cr_svgid;               /* saved group id */
  87         uid_t   cr_gmuid;               /* user id for group membership purposes */
  88         struct auditinfo cr_au;         /* user auditing data */
  89 };
  90 typedef struct ucred *kauth_cred_t;
  91
  92 /*
  93  * This is the external representation of struct ucred.
  94  */
  95 struct xucred {
  96         u_int   cr_version;             /* structure layout version */
  97         uid_t   cr_uid;                 /* effective user id */
  98         short   cr_ngroups;             /* number of advisory groups */
  99         gid_t   cr_groups[NGROUPS];     /* advisory group list */
 100 };
 101 #define XUCRED_VERSION  0
 102
 103 #define cr_gid cr_groups[0]
 104 #define NOCRED ((kauth_cred_t )0)       /* no credential available */
 105 #define FSCRED ((kauth_cred_t )-1)      /* filesystem credential */
 106
 107 #ifdef KERNEL
 108 #ifdef __APPLE_API_OBSOLETE
 109 __BEGIN_DECLS
 110 int             crcmp(kauth_cred_t cr1, kauth_cred_t cr2);
 111 int             suser(kauth_cred_t cred, u_short *acflag);
 112 int             set_security_token(struct proc * p);
 113 void            cru2x(kauth_cred_t cr, struct xucred *xcr);
 114 __END_DECLS
 115 #endif /* __APPLE_API_OBSOLETE */
 116 #endif /* KERNEL */
 117 #endif /* __APPLE_API_UNSTABLE */
 118
 119 #endif /* !_SYS_UCRED_H_ */