ucred.h revision 293896 
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 * 4. Neither the name of the University nor the names of its contributors
14 *    may be used to endorse or promote products derived from this software
15 *    without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 *	@(#)ucred.h	8.4 (Berkeley) 1/9/95
30 * $FreeBSD: releng/9.3/sys/sys/ucred.h 293896 2016-01-14 09:11:26Z glebius $
31 */
32
33#ifndef _SYS_UCRED_H_
34#define	_SYS_UCRED_H_
35
36#include <bsm/audit.h>
37
38struct loginclass;
39
40/*
41 * Credentials.
42 *
43 * Please do not inspect cr_uid directly to determine superuserness.  The
44 * priv(9) interface should be used to check for privilege.
45 */
46#if defined(_KERNEL) || defined(_WANT_UCRED)
47struct ucred {
48	u_int	cr_ref;			/* reference count */
49#define	cr_startcopy cr_uid
50	uid_t	cr_uid;			/* effective user id */
51	uid_t	cr_ruid;		/* real user id */
52	uid_t	cr_svuid;		/* saved user id */
53	int	cr_ngroups;		/* number of groups */
54	gid_t	cr_rgid;		/* real group id */
55	gid_t	cr_svgid;		/* saved group id */
56	struct uidinfo	*cr_uidinfo;	/* per euid resource consumption */
57	struct uidinfo	*cr_ruidinfo;	/* per ruid resource consumption */
58	struct prison	*cr_prison;	/* jail(2) */
59	struct loginclass	*cr_loginclass; /* login class */
60	u_int		cr_flags;	/* credential flags */
61	void 		*cr_pspare2[2];	/* general use 2 */
62#define	cr_endcopy	cr_label
63	struct label	*cr_label;	/* MAC label */
64	struct auditinfo_addr	cr_audit;	/* Audit properties. */
65	gid_t	*cr_groups;		/* groups */
66	int	cr_agroups;		/* Available groups */
67};
68#define	NOCRED	((struct ucred *)0)	/* no credential available */
69#define	FSCRED	((struct ucred *)-1)	/* filesystem credential */
70#endif /* _KERNEL || _WANT_UCRED */
71
72#define	XU_NGROUPS	16
73
74/*
75 * Flags for cr_flags.
76 */
77#define	CRED_FLAG_CAPMODE	0x00000001	/* In capability mode. */
78
79/*
80 * This is the external representation of struct ucred.
81 */
82struct xucred {
83	u_int	cr_version;		/* structure layout version */
84	uid_t	cr_uid;			/* effective user id */
85	short	cr_ngroups;		/* number of groups */
86	gid_t	cr_groups[XU_NGROUPS];	/* groups */
87	void	*_cr_unused1;		/* compatibility with old ucred */
88};
89#define	XUCRED_VERSION	0
90
91/* This can be used for both ucred and xucred structures. */
92#define	cr_gid cr_groups[0]
93
94#ifdef _KERNEL
95struct proc;
96struct thread;
97
98void	change_egid(struct ucred *newcred, gid_t egid);
99void	change_euid(struct ucred *newcred, struct uidinfo *euip);
100void	change_rgid(struct ucred *newcred, gid_t rgid);
101void	change_ruid(struct ucred *newcred, struct uidinfo *ruip);
102void	change_svgid(struct ucred *newcred, gid_t svgid);
103void	change_svuid(struct ucred *newcred, uid_t svuid);
104void	crcopy(struct ucred *dest, struct ucred *src);
105struct ucred	*crcopysafe(struct proc *p, struct ucred *cr);
106struct ucred	*crdup(struct ucred *cr);
107void	crextend(struct ucred *cr, int n);
108void	cred_update_thread(struct thread *td);
109void	crfree(struct ucred *cr);
110struct ucred	*crget(void);
111struct ucred	*crhold(struct ucred *cr);
112int	crshared(struct ucred *cr);
113void	cru2x(struct ucred *cr, struct xucred *xcr);
114void	crsetgroups(struct ucred *cr, int n, gid_t *groups);
115int	groupmember(gid_t gid, struct ucred *cred);
116#endif /* _KERNEL */
117
118#endif /* !_SYS_UCRED_H_ */
119