bsd/sys/ucred.h

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