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