bsd/sys/ucred.h

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