xref: /onnv-gate/usr/src/uts/common/sys/cred_impl.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _SYS_CRED_IMPL_H
28*0Sstevel@tonic-gate #define	_SYS_CRED_IMPL_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <sys/types.h>
33*0Sstevel@tonic-gate #include <sys/cred.h>
34*0Sstevel@tonic-gate #include <sys/priv_impl.h>
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate #ifdef	__cplusplus
37*0Sstevel@tonic-gate extern "C" {
38*0Sstevel@tonic-gate #endif
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate /*
41*0Sstevel@tonic-gate  * The user credential implementation.
42*0Sstevel@tonic-gate  *
43*0Sstevel@tonic-gate  * This is is not a public interface.  This file must not be included
44*0Sstevel@tonic-gate  * except by those routines in Solaris proper that implement credential
45*0Sstevel@tonic-gate  * manipulation and kernel policy.
46*0Sstevel@tonic-gate  *
47*0Sstevel@tonic-gate  * Credentials are shared, and therefor read-only, data structure.
48*0Sstevel@tonic-gate  * After finalization, on the cr_ref field is changed through crhold/crfree.
49*0Sstevel@tonic-gate  *
50*0Sstevel@tonic-gate  * Kernel modules that need access to fields of cred_t should use the
51*0Sstevel@tonic-gate  * accessor functions defined in <sys/cred.h>
52*0Sstevel@tonic-gate  *
53*0Sstevel@tonic-gate  * The size of the cr_groups[] array is configurable but is the same
54*0Sstevel@tonic-gate  * (ngroups_max) for all cred_impl structures; cr_ngroups records the number
55*0Sstevel@tonic-gate  * of elements currently in use, not the array size.
56*0Sstevel@tonic-gate  *
57*0Sstevel@tonic-gate  * Changes in the implementation will move cr_groups[] around.
58*0Sstevel@tonic-gate  *
59*0Sstevel@tonic-gate  * Properly sized cred_t structures are only returned by crget()/crdup()
60*0Sstevel@tonic-gate  * crcopy().  It is not possible to declare one.
61*0Sstevel@tonic-gate  */
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate #if defined(_KERNEL) || defined(_KMEMUSER)
64*0Sstevel@tonic-gate 
65*0Sstevel@tonic-gate struct zone;		/* forward reference */
66*0Sstevel@tonic-gate 
67*0Sstevel@tonic-gate struct cred {
68*0Sstevel@tonic-gate 	uint_t		cr_ref;		/* reference count */
69*0Sstevel@tonic-gate 	uid_t		cr_uid;		/* effective user id */
70*0Sstevel@tonic-gate 	gid_t		cr_gid;		/* effective group id */
71*0Sstevel@tonic-gate 	uid_t		cr_ruid;	/* real user id */
72*0Sstevel@tonic-gate 	gid_t		cr_rgid;	/* real group id */
73*0Sstevel@tonic-gate 	uid_t		cr_suid;	/* "saved" user id (from exec) */
74*0Sstevel@tonic-gate 	gid_t		cr_sgid;	/* "saved" group id (from exec) */
75*0Sstevel@tonic-gate 	uint_t		cr_ngroups;	/* number of groups returned by */
76*0Sstevel@tonic-gate 					/* crgroups() */
77*0Sstevel@tonic-gate 	cred_priv_t	cr_priv;	/* privileges */
78*0Sstevel@tonic-gate 	projid_t	cr_projid;	/* project */
79*0Sstevel@tonic-gate 	struct zone	*cr_zone;	/* pointer to per-zone structure */
80*0Sstevel@tonic-gate 	gid_t		cr_groups[1];	/* cr_groups size not fixed */
81*0Sstevel@tonic-gate 					/* audit info is defined dynamically */
82*0Sstevel@tonic-gate 					/* and valid only when audit enabled */
83*0Sstevel@tonic-gate 	/* auditinfo_addr_t	cr_auinfo;	audit info */
84*0Sstevel@tonic-gate };
85*0Sstevel@tonic-gate 
86*0Sstevel@tonic-gate extern int ngroups_max;
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate #define	CR_PRIVS(c)	(&(c)->cr_priv)
89*0Sstevel@tonic-gate #define	CR_PRIVSETS(c)	(((c)->cr_priv.crprivs))
90*0Sstevel@tonic-gate 
91*0Sstevel@tonic-gate #endif	/* _KERNEL */
92*0Sstevel@tonic-gate 
93*0Sstevel@tonic-gate #ifdef	__cplusplus
94*0Sstevel@tonic-gate }
95*0Sstevel@tonic-gate #endif
96*0Sstevel@tonic-gate 
97*0Sstevel@tonic-gate #endif	/* _SYS_CRED_IMPL_H */
98