ucred.h revision 72650 
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 72650 2001-02-18 13:30:20Z green $
35 */
36
37#ifndef _SYS_UCRED_H_
38#define	_SYS_UCRED_H_
39
40#include <sys/mutex.h>
41
42/*
43 * Credentials.
44 *
45 * Please do not inspect cr_uid directly to determine superuserness.
46 * Only the suser()/suser_xxx() function should be used for this.
47 */
48struct ucred {
49	u_int	cr_ref;			/* reference count */
50	uid_t	cr_uid;			/* effective user id */
51	short	cr_ngroups;		/* number of groups */
52	gid_t	cr_groups[NGROUPS];	/* groups */
53	struct	uidinfo *cr_uidinfo;	/* per uid resource consumption */
54	struct	mtx cr_mtx;		/* protect refcount */
55};
56#define cr_gid cr_groups[0]
57#define NOCRED ((struct ucred *)0)	/* no credential available */
58#define FSCRED ((struct ucred *)-1)	/* filesystem credential */
59
60/*
61 * This is the external representation of struct ucred, based upon the
62 * size of a 4.2-RELEASE struct ucred.  There will probably never be
63 * any need to change the size of this or layout of its used fields.
64 */
65struct xucred {
66	u_short	_cr_unused0;		/* compatibility with old ucred */
67	uid_t	cr_uid;			/* effective user id */
68	short	cr_ngroups;		/* number of groups */
69	gid_t	cr_groups[NGROUPS];	/* groups */
70	void	*_cr_unused1;		/* compatibility with old ucred */
71};
72
73#ifdef _KERNEL
74
75struct proc;
76
77void		change_euid __P((struct proc *p, uid_t euid));
78void		change_ruid __P((struct proc *p, uid_t ruid));
79struct ucred	*crcopy __P((struct ucred *cr));
80struct ucred	*crdup __P((struct ucred *cr));
81void		crfree __P((struct ucred *cr));
82struct ucred	*crget __P((void));
83void		crhold __P((struct ucred *cr));
84int		groupmember __P((gid_t gid, struct ucred *cred));
85#endif /* _KERNEL */
86
87#endif /* !_SYS_UCRED_H_ */
88