master
1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1989, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. Neither the name of the University nor the names of its contributors
16 * may be used to endorse or promote products derived from this software
17 * without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 *
31 * @(#)ucred.h 8.4 (Berkeley) 1/9/95
32 */
33
34#ifndef _SYS_UCRED_H_
35#define _SYS_UCRED_H_
36
37#if defined(_KERNEL) || defined(_WANT_UCRED)
38#include <sys/_lock.h>
39#include <sys/_mutex.h>
40#endif
41#include <bsm/audit.h>
42
43struct loginclass;
44
45#define XU_NGROUPS 16
46
47/*
48 * Credentials.
49 *
50 * Please do not inspect cr_uid directly to determine superuserness. The
51 * priv(9) interface should be used to check for privilege.
52 *
53 * Lock reference:
54 * c - cr_mtx
55 *
56 * Unmarked fields are constant after creation.
57 *
58 * See "Credential management" comment in kern_prot.c for more information.
59 */
60#if defined(_KERNEL) || defined(_WANT_UCRED)
61struct ucred {
62 struct mtx cr_mtx;
63 long cr_ref; /* (c) reference count */
64 u_int cr_users; /* (c) proc + thread using this cred */
65 u_int cr_flags; /* credential flags */
66 struct auditinfo_addr cr_audit; /* Audit properties. */
67#define cr_startcopy cr_uid
68 uid_t cr_uid; /* effective user id */
69 uid_t cr_ruid; /* real user id */
70 uid_t cr_svuid; /* saved user id */
71 int cr_ngroups; /* number of groups */
72 gid_t cr_rgid; /* real group id */
73 gid_t cr_svgid; /* saved group id */
74 struct uidinfo *cr_uidinfo; /* per euid resource consumption */
75 struct uidinfo *cr_ruidinfo; /* per ruid resource consumption */
76 struct prison *cr_prison; /* jail(2) */
77 struct loginclass *cr_loginclass; /* login class */
78 void *cr_pspare2[2]; /* general use 2 */
79#define cr_endcopy cr_label
80 struct label *cr_label; /* MAC label */
81 gid_t *cr_groups; /* groups */
82 int cr_agroups; /* Available groups */
83 gid_t cr_smallgroups[XU_NGROUPS]; /* storage for small groups */
84};
85#define NOCRED ((struct ucred *)0) /* no credential available */
86#define FSCRED ((struct ucred *)-1) /* filesystem credential */
87#endif /* _KERNEL || _WANT_UCRED */
88
89/*
90 * Flags for cr_flags.
91 */
92#define CRED_FLAG_CAPMODE 0x00000001 /* In capability mode. */
93
94/*
95 * This is the external representation of struct ucred.
96 */
97struct xucred {
98 u_int cr_version; /* structure layout version */
99 uid_t cr_uid; /* effective user id */
100 short cr_ngroups; /* number of groups */
101 gid_t cr_groups[XU_NGROUPS]; /* groups */
102 union {
103 void *_cr_unused1; /* compatibility with old ucred */
104 pid_t cr_pid;
105 };
106};
107#define XUCRED_VERSION 0
108
109/* This can be used for both ucred and xucred structures. */
110#define cr_gid cr_groups[0]
111
112#ifdef _KERNEL
113struct proc;
114struct thread;
115
116struct credbatch {
117 struct ucred *cred;
118 int users;
119 int ref;
120};
121
122static inline void
123credbatch_prep(struct credbatch *crb)
124{
125 crb->cred = NULL;
126 crb->users = 0;
127 crb->ref = 0;
128}
129void credbatch_add(struct credbatch *crb, struct thread *td);
130
131static inline void
132credbatch_process(struct credbatch *crb __unused)
133{
134
135}
136
137void credbatch_final(struct credbatch *crb);
138
139void change_egid(struct ucred *newcred, gid_t egid);
140void change_euid(struct ucred *newcred, struct uidinfo *euip);
141void change_rgid(struct ucred *newcred, gid_t rgid);
142void change_ruid(struct ucred *newcred, struct uidinfo *ruip);
143void change_svgid(struct ucred *newcred, gid_t svgid);
144void change_svuid(struct ucred *newcred, uid_t svuid);
145void crcopy(struct ucred *dest, struct ucred *src);
146struct ucred *crcopysafe(struct proc *p, struct ucred *cr);
147struct ucred *crdup(struct ucred *cr);
148void crextend(struct ucred *cr, int n);
149void proc_set_cred_init(struct proc *p, struct ucred *cr);
150void proc_set_cred(struct proc *p, struct ucred *cr);
151void proc_unset_cred(struct proc *p);
152void crfree(struct ucred *cr);
153struct ucred *crcowsync(void);
154struct ucred *crget(void);
155struct ucred *crhold(struct ucred *cr);
156struct ucred *crcowget(struct ucred *cr);
157void crcowfree(struct thread *td);
158void cru2x(struct ucred *cr, struct xucred *xcr);
159void cru2xt(struct thread *td, struct xucred *xcr);
160void crsetgroups(struct ucred *cr, int n, gid_t *groups);
161bool groupmember(gid_t gid, struct ucred *cred);
162bool realgroupmember(gid_t gid, struct ucred *cred);
163#endif /* _KERNEL */
164
165#endif /* !_SYS_UCRED_H_ */