xref: /openbsd/sys/sys/ucred.h (revision a97e0511)
1 /*	$OpenBSD: ucred.h,v 1.14 2022/03/17 14:23:34 visa Exp $	*/
2 /*	$NetBSD: ucred.h,v 1.12 1995/06/01 22:44:50 jtc Exp $	*/
3 
4 /*
5  * Copyright (c) 1989, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)ucred.h	8.2 (Berkeley) 1/4/94
33  */
34 
35 #ifndef _SYS_UCRED_H_
36 #define	_SYS_UCRED_H_
37 
38 #include <sys/refcnt.h>
39 #include <sys/syslimits.h>
40 
41 /*
42  * Credentials.
43  */
44 struct ucred {
45 	struct refcnt	cr_refcnt;	/* reference count */
46 
47 /* The following fields are all copied by crset() */
48 #define	cr_startcopy	cr_uid
49 	uid_t	cr_uid;			/* effective user id */
50 	uid_t	cr_ruid;		/* Real user id. */
51 	uid_t	cr_svuid;		/* Saved effective user id. */
52 	gid_t	cr_gid;			/* effective group id */
53 	gid_t	cr_rgid;		/* Real group id. */
54 	gid_t	cr_svgid;		/* Saved effective group id. */
55 	short	cr_ngroups;		/* number of groups */
56 	gid_t	cr_groups[NGROUPS_MAX];	/* groups */
57 };
58 #define NOCRED ((struct ucred *)-1)	/* no credential available */
59 #define FSCRED ((struct ucred *)-2)	/* filesystem credential */
60 
61 /*
62  *  Userspace version, for use in syscalls arguments
63  */
64 struct xucred {
65 	uid_t	cr_uid;			/* user id */
66 	gid_t	cr_gid;			/* group id */
67 	short	cr_ngroups;		/* number of groups */
68 	gid_t	cr_groups[NGROUPS_MAX];	/* groups */
69 };
70 
71 #ifdef _KERNEL
72 
73 int		crfromxucred(struct ucred *, const struct xucred *);
74 void		crset(struct ucred *, const struct ucred *);
75 struct ucred	*crcopy(struct ucred *cr);
76 struct ucred	*crdup(struct ucred *cr);
77 void		crfree(struct ucred *cr);
78 struct ucred	*crget(void);
79 struct ucred	*crhold(struct ucred *);
80 int		suser(struct proc *p);
81 int		suser_ucred(struct ucred *cred);
82 
83 #endif /* _KERNEL */
84 
85 #endif /* !_SYS_UCRED_H_ */
86