ucred.h revision 101848 
1/*
2 * Copyright (c) 1989, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the University of
16 *	California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 *	@(#)ucred.h	8.4 (Berkeley) 1/9/95
34 * $FreeBSD: head/sys/sys/ucred.h 101848 2002-08-14 01:04:43Z rwatson $
35 */
36
37#ifndef _SYS_UCRED_H_
38#define	_SYS_UCRED_H_
39
40/*
41 * XXXMAC: this recursive include could be #ifdef _KERNEL if struct
42 * ucred could also be #ifdef _KERNEL.
43 */
44#include <sys/_label.h>
45
46/*
47 * Credentials.
48 *
49 * Please do not inspect cr_uid directly to determine superuserness.
50 * Only the suser() or suser_cred() function should be used for this.
51 */
52struct ucred {
53	u_int	cr_ref;			/* reference count */
54#define	cr_startcopy cr_uid
55	uid_t	cr_uid;			/* effective user id */
56	uid_t	cr_ruid;		/* real user id */
57	uid_t	cr_svuid;		/* saved user id */
58	short	cr_ngroups;		/* number of groups */
59	gid_t	cr_groups[NGROUPS];	/* groups */
60	gid_t	cr_rgid;		/* real group id */
61	gid_t	cr_svgid;		/* saved user id */
62	struct uidinfo	*cr_uidinfo;	/* per euid resource consumption */
63	struct uidinfo	*cr_ruidinfo;	/* per ruid resource consumption */
64	struct prison	*cr_prison;	/* jail(4) */
65#define	cr_endcopy	cr_label
66	struct label	cr_label;	/* MAC label */
67	struct mtx	*cr_mtxp;      	/* protect refcount */
68};
69#define	NOCRED	((struct ucred *)0)	/* no credential available */
70#define	FSCRED	((struct ucred *)-1)	/* filesystem credential */
71
72/*
73 * This is the external representation of struct ucred.
74 */
75struct xucred {
76	u_int	cr_version;		/* structure layout version */
77	uid_t	cr_uid;			/* effective user id */
78	short	cr_ngroups;		/* number of groups */
79	gid_t	cr_groups[NGROUPS];	/* groups */
80	void	*_cr_unused1;		/* compatibility with old ucred */
81};
82#define	XUCRED_VERSION	0
83
84/* This can be used for both ucred and xucred structures. */
85#define	cr_gid cr_groups[0]
86
87#ifdef _KERNEL
88struct thread;
89
90#ifdef DIAGNOSTIC
91void	cred_free_thread(struct thread *td);
92#endif
93void	change_egid(struct ucred *newcred, gid_t egid);
94void	change_euid(struct ucred *newcred, struct uidinfo *euip);
95void	change_rgid(struct ucred *newcred, gid_t rgid);
96void	change_ruid(struct ucred *newcred, struct uidinfo *ruip);
97void	change_svgid(struct ucred *newcred, gid_t svgid);
98void	change_svuid(struct ucred *newcred, uid_t svuid);
99void	crcopy(struct ucred *dest, struct ucred *src);
100struct ucred	*crdup(struct ucred *cr);
101void	cred_update_thread(struct thread *td);
102void	crfree(struct ucred *cr);
103struct ucred	*crget(void);
104struct ucred	*crhold(struct ucred *cr);
105int	crshared(struct ucred *cr);
106void	cru2x(struct ucred *cr, struct xucred *xcr);
107int	groupmember(gid_t gid, struct ucred *cred);
108#endif /* _KERNEL */
109
110#endif /* !_SYS_UCRED_H_ */
111