[apple/xnu.git] / bsd / sys / ucred.h

/*
 * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1989, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)ucred.h	8.4 (Berkeley) 1/9/95
 */
/*
 * NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
 * support for mandatory and extensible security protections.  This notice
 * is included in support of clause 2.2 (b) of the Apple Public License,
 * Version 2.0.
 */

#ifndef _SYS_UCRED_H_
#define _SYS_UCRED_H_

#include <sys/appleapiopts.h>
#include <sys/cdefs.h>
#include <sys/param.h>
#include <bsm/audit.h>

struct label;

#ifdef __APPLE_API_UNSTABLE
#ifdef KERNEL
#include <sys/queue.h>
#include <os/base.h>

/*
 * In-kernel credential structure.
 *
 * Note that this structure should not be used outside the kernel, nor should
 * it or copies of it be exported outside.
 */
struct ucred {
	LIST_ENTRY(ucred)       cr_link; /* never modify this without KAUTH_CRED_HASH_LOCK */
#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L && !defined(__STDC_NO_ATOMICS__)
	_Atomic u_long          cr_ref;  /* reference count */
#elif defined(__cplusplus) && __cplusplus >= 201103L
	_Atomic u_long          cr_ref;  /* reference count */
#else
	volatile u_long         cr_ref;  /* reference count */
#endif

	struct posix_cred {
		/*
		 * The credential hash depends on everything from this point on
		 * (see kauth_cred_get_hashkey)
		 */
		uid_t   cr_uid;         /* effective user id */
		uid_t   cr_ruid;        /* real user id */
		uid_t   cr_svuid;       /* saved user id */
		u_short cr_ngroups;     /* number of groups in advisory list */
#if XNU_KERNEL_PRIVATE
		u_short __cr_padding;
#endif
		gid_t   cr_groups[NGROUPS];/* advisory group list */
		gid_t   cr_rgid;        /* real group id */
		gid_t   cr_svgid;       /* saved group id */
		uid_t   cr_gmuid;       /* UID for group membership purposes */
		int     cr_flags;       /* flags on credential */
	} cr_posix;
	struct label    * OS_PTRAUTH_SIGNED_PTR("ucred.cr_label") cr_label;     /* MAC label */

	/*
	 * NOTE: If anything else (besides the flags)
	 * added after the label, you must change
	 * kauth_cred_find().
	 */
	struct au_session cr_audit;             /* user auditing data */
};
#else /* KERNEL */
struct ucred;
struct posix_cred;
#endif /* KERNEL */

#ifndef _KAUTH_CRED_T
#define _KAUTH_CRED_T
typedef struct ucred *kauth_cred_t;
typedef struct posix_cred *posix_cred_t;
#endif  /* !_KAUTH_CRED_T */

/*
 * Credential flags that can be set on a credential
 */
#define CRF_NOMEMBERD   0x00000001      /* memberd opt out by setgroups() */
#define CRF_MAC_ENFORCE 0x00000002      /* force entry through MAC Framework */
                                        /* also forces credential cache miss */

/*
 * This is the external representation of struct ucred.
 */
struct xucred {
	u_int   cr_version;             /* structure layout version */
	uid_t   cr_uid;                 /* effective user id */
	short   cr_ngroups;             /* number of advisory groups */
	gid_t   cr_groups[NGROUPS];     /* advisory group list */
};
#define XUCRED_VERSION  0

#define cr_gid cr_groups[0]
#define NOCRED ((kauth_cred_t )0)       /* no credential available */
#define FSCRED ((kauth_cred_t )-1)      /* filesystem credential */

#define IS_VALID_CRED(_cr)      ((_cr) != NOCRED && (_cr) != FSCRED)

#ifdef KERNEL
#ifdef __APPLE_API_OBSOLETE
__BEGIN_DECLS
int             crcmp(kauth_cred_t cr1, kauth_cred_t cr2);
int             suser(kauth_cred_t cred, u_short *acflag);
int             set_security_token(struct proc * p);
int             set_security_token_task_internal(struct proc *p, void *task);
void            cru2x(kauth_cred_t cr, struct xucred *xcr);
__END_DECLS
#endif /* __APPLE_API_OBSOLETE */
#endif /* KERNEL */
#endif /* __APPLE_API_UNSTABLE */

#endif /* !_SYS_UCRED_H_ */
Commit	Line	Data
1c79356b	1	/*
5d5c5d0d A	2	* Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
5d5c5d0d A	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
0a7de745	5	*
2d21ac55 A	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 License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
0a7de745	14	*
2d21ac55 A	15	* Please obtain a copy of the License at
2d21ac55 A	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
0a7de745	17	*
2d21ac55 A	18	* The Original Code and all software distributed under the License are
2d21ac55 A	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
	24	* limitations under the License.
0a7de745	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/* Copyright (c) 1995, 1997 Apple Computer, Inc. All Rights Reserved */
	29	/*
	30	* Copyright (c) 1989, 1993
	31	* The Regents of the University of California. All rights reserved.
	32	*
	33	* Redistribution and use in source and binary forms, with or without
	34	* modification, are permitted provided that the following conditions
	35	* are met:
	36	* 1. Redistributions of source code must retain the above copyright
	37	* notice, this list of conditions and the following disclaimer.
	38	* 2. Redistributions in binary form must reproduce the above copyright
	39	* notice, this list of conditions and the following disclaimer in the
	40	* documentation and/or other materials provided with the distribution.
	41	* 3. All advertising materials mentioning features or use of this software
	42	* must display the following acknowledgement:
	43	* This product includes software developed by the University of
	44	* California, Berkeley and its contributors.
	45	* 4. Neither the name of the University nor the names of its contributors
	46	* may be used to endorse or promote products derived from this software
	47	* without specific prior written permission.
	48	*
	49	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	50	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	51	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	52	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	53	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	54	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	55	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	56	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	57	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	58	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	59	* SUCH DAMAGE.
	60	*
	61	* @(#)ucred.h 8.4 (Berkeley) 1/9/95
	62	*/
2d21ac55 A	63	/*
	64	* NOTICE: This file was modified by SPARTA, Inc. in 2005 to introduce
	65	* support for mandatory and extensible security protections. This notice
	66	* is included in support of clause 2.2 (b) of the Apple Public License,
	67	* Version 2.0.
	68	*/
1c79356b A	69
1c79356b A	70	#ifndef _SYS_UCRED_H_
0a7de745	71	#define _SYS_UCRED_H_
1c79356b	72
9bccf70c	73	#include <sys/appleapiopts.h>
91447636	74	#include <sys/cdefs.h>
1c79356b	75	#include <sys/param.h>
91447636	76	#include <bsm/audit.h>
1c79356b	77
2d21ac55 A	78	struct label;
2d21ac55 A	79
9bccf70c	80	#ifdef __APPLE_API_UNSTABLE
cb323159	81	#ifdef KERNEL
b0d623f7	82	#include <sys/queue.h>
f427ee49	83	#include <os/base.h>
91447636	84
1c79356b	85	/*
91447636 A	86	* In-kernel credential structure.
	87	*
	88	* Note that this structure should not be used outside the kernel, nor should
2d21ac55	89	* it or copies of it be exported outside.
1c79356b A	90	*/
1c79356b A	91	struct ucred {
0a7de745 A	92	LIST_ENTRY(ucred) cr_link; /* never modify this without KAUTH_CRED_HASH_LOCK */
	93	#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L && !defined(__STDC_NO_ATOMICS__)
	94	_Atomic u_long cr_ref; /* reference count */
	95	#elif defined(__cplusplus) && __cplusplus >= 201103L
	96	_Atomic u_long cr_ref; /* reference count */
	97	#else
	98	volatile u_long cr_ref; /* reference count */
	99	#endif
	100
	101	struct posix_cred {
	102	/*
	103	* The credential hash depends on everything from this point on
	104	* (see kauth_cred_get_hashkey)
	105	*/
	106	uid_t cr_uid; /* effective user id */
	107	uid_t cr_ruid; /* real user id */
	108	uid_t cr_svuid; /* saved user id */
f427ee49	109	u_short cr_ngroups; /* number of groups in advisory list */
c3c9b80d A	110	#if XNU_KERNEL_PRIVATE
	111	u_short __cr_padding;
	112	#endif
0a7de745 A	113	gid_t cr_groups[NGROUPS];/* advisory group list */
	114	gid_t cr_rgid; /* real group id */
	115	gid_t cr_svgid; /* saved group id */
	116	uid_t cr_gmuid; /* UID for group membership purposes */
	117	int cr_flags; /* flags on credential */
	118	} cr_posix;
f427ee49 A	119	struct label * OS_PTRAUTH_SIGNED_PTR("ucred.cr_label") cr_label; /* MAC label */
f427ee49 A	120
2d21ac55	121	/*
2d21ac55 A	122	* NOTE: If anything else (besides the flags)
	123	* added after the label, you must change
	124	* kauth_cred_find().
	125	*/
0a7de745	126	struct au_session cr_audit; /* user auditing data */
1c79356b	127	};
cb323159 A	128	#else /* KERNEL */
	129	struct ucred;
	130	struct posix_cred;
	131	#endif /* KERNEL */
	132
2d21ac55	133	#ifndef _KAUTH_CRED_T
0a7de745	134	#define _KAUTH_CRED_T
91447636	135	typedef struct ucred *kauth_cred_t;
6d2010ae	136	typedef struct posix_cred *posix_cred_t;
0a7de745	137	#endif /* !_KAUTH_CRED_T */
2d21ac55 A	138
	139	/*
	140	* Credential flags that can be set on a credential
	141	*/
0a7de745 A	142	#define CRF_NOMEMBERD 0x00000001 /* memberd opt out by setgroups() */
	143	#define CRF_MAC_ENFORCE 0x00000002 /* force entry through MAC Framework */
	144	/* also forces credential cache miss */
91447636	145
55e303ae A	146	/*
	147	* This is the external representation of struct ucred.
	148	*/
	149	struct xucred {
0a7de745 A	150	u_int cr_version; /* structure layout version */
	151	uid_t cr_uid; /* effective user id */
	152	short cr_ngroups; /* number of advisory groups */
	153	gid_t cr_groups[NGROUPS]; /* advisory group list */
55e303ae A	154	};
	155	#define XUCRED_VERSION 0
	156
1c79356b	157	#define cr_gid cr_groups[0]
0a7de745 A	158	#define NOCRED ((kauth_cred_t )0) /* no credential available */
0a7de745 A	159	#define FSCRED ((kauth_cred_t )-1) /* filesystem credential */
1c79356b	160
0a7de745	161	#define IS_VALID_CRED(_cr) ((_cr) != NOCRED && (_cr) != FSCRED)
0c530ab8	162
1c79356b	163	#ifdef KERNEL
91447636 A	164	#ifdef __APPLE_API_OBSOLETE
91447636 A	165	__BEGIN_DECLS
0a7de745 A	166	int crcmp(kauth_cred_t cr1, kauth_cred_t cr2);
	167	int suser(kauth_cred_t cred, u_short *acflag);
	168	int set_security_token(struct proc * p);
	169	int set_security_token_task_internal(struct proc p, void task);
	170	void cru2x(kauth_cred_t cr, struct xucred *xcr);
91447636 A	171	__END_DECLS
91447636 A	172	#endif /* __APPLE_API_OBSOLETE */
1c79356b	173	#endif /* KERNEL */
9bccf70c	174	#endif /* __APPLE_API_UNSTABLE */
1c79356b A	175
1c79356b A	176	#endif /* !_SYS_UCRED_H_ */