ucred.h revision 84827 
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 84827 2001-10-11 23:38:17Z jhb $
35 */
36
37#ifndef _SYS_UCRED_H_
38#define	_SYS_UCRED_H_
39
40#include <sys/queue.h>
41#include <sys/_lock.h>
42#include <sys/_mutex.h>
43
44/*
45 * Credentials.
46 *
47 * Please do not inspect cr_uid directly to determine superuserness.
48 * Only the suser()/suser_xxx() function should be used for this.
49 */
50struct ucred {
51	u_int	cr_ref;			/* reference count */
52#define	cr_startcopy cr_uid
53	uid_t	cr_uid;			/* effective user id */
54	uid_t	cr_ruid;		/* real user id */
55	uid_t	cr_svuid;		/* saved user id */
56	short	cr_ngroups;		/* number of groups */
57	gid_t	cr_groups[NGROUPS];	/* groups */
58	gid_t	cr_rgid;		/* real group id */
59	gid_t	cr_svgid;		/* saved user id */
60	struct	uidinfo *cr_uidinfo;	/* per euid resource consumption */
61	struct	uidinfo *cr_ruidinfo;	/* per ruid resource consumption */
62	struct	prison *cr_prison;	/* jail(4) */
63#define	cr_endcopy cr_mtx
64	struct	mtx cr_mtx;		/* protect refcount */
65};
66#define cr_gid cr_groups[0]
67#define NOCRED ((struct ucred *)0)	/* no credential available */
68#define FSCRED ((struct ucred *)-1)	/* filesystem credential */
69
70/*
71 * This is the external representation of struct ucred, based upon the
72 * size of a 4.2-RELEASE struct ucred.  There will probably never be
73 * any need to change the size of this or layout of its used fields.
74 */
75struct xucred {
76	u_short	_cr_unused0;		/* compatibility with old ucred */
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
83#ifdef _KERNEL
84
85
86void		change_egid __P((struct ucred *newcred, gid_t egid));
87void		change_euid __P((struct ucred *newcred, uid_t euid));
88void		change_rgid __P((struct ucred *newcred, gid_t rgid));
89void		change_ruid __P((struct ucred *newcred, uid_t ruid));
90void		change_svgid __P((struct ucred *newcred, gid_t svgid));
91void		change_svuid __P((struct ucred *newcred, uid_t svuid));
92void		crcopy __P((struct ucred *dest, struct ucred *src));
93struct ucred	*crdup __P((struct ucred *cr));
94void		crfree __P((struct ucred *cr));
95struct ucred	*crget __P((void));
96struct ucred	*crhold __P((struct ucred *cr));
97int		crshared __P((struct ucred *cr));
98int		groupmember __P((gid_t gid, struct ucred *cred));
99#endif /* _KERNEL */
100
101#endif /* !_SYS_UCRED_H_ */
102