bsd/sys/ucred.h

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