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 32 #ifndef _SYS_UCRED_H_ 33 #define _SYS_UCRED_H_ 34 35 #if defined(_KERNEL) || defined(_WANT_UCRED) 36 #include <sys/_lock.h> 37 #include <sys/_mutex.h> 38 #endif 39 #include <bsm/audit.h> 40 41 struct loginclass; 42 43 #define XU_NGROUPS 16 44 45 /* 46 * Credentials. 47 * 48 * Please do not inspect cr_uid directly to determine superuserness. The 49 * priv(9) interface should be used to check for privilege. 50 * 51 * Lock reference: 52 * c - cr_mtx 53 * 54 * Unmarked fields are constant after creation. 55 * 56 * See "Credential management" comment in kern_prot.c for more information. 57 */ 58 #if defined(_KERNEL) || defined(_WANT_UCRED) 59 struct ucred { 60 struct mtx cr_mtx; 61 long cr_ref; /* (c) reference count */ 62 u_int cr_users; /* (c) proc + thread using this cred */ 63 u_int cr_flags; /* credential flags */ 64 struct auditinfo_addr cr_audit; /* Audit properties. */ 65 #define cr_startcopy cr_uid 66 uid_t cr_uid; /* effective user id */ 67 uid_t cr_ruid; /* real user id */ 68 uid_t cr_svuid; /* saved user id */ 69 int cr_ngroups; /* number of groups */ 70 gid_t cr_rgid; /* real group id */ 71 gid_t cr_svgid; /* saved group id */ 72 struct uidinfo *cr_uidinfo; /* per euid resource consumption */ 73 struct uidinfo *cr_ruidinfo; /* per ruid resource consumption */ 74 struct prison *cr_prison; /* jail(2) */ 75 struct loginclass *cr_loginclass; /* login class */ 76 void *cr_pspare2[2]; /* general use 2 */ 77 #define cr_endcopy cr_label 78 struct label *cr_label; /* MAC label */ 79 gid_t *cr_groups; /* groups */ 80 int cr_agroups; /* Available groups */ 81 gid_t cr_smallgroups[XU_NGROUPS]; /* storage for small groups */ 82 }; 83 #define NOCRED ((struct ucred *)0) /* no credential available */ 84 #define FSCRED ((struct ucred *)-1) /* filesystem credential */ 85 #endif /* _KERNEL || _WANT_UCRED */ 86 87 /* 88 * Flags for cr_flags. 89 */ 90 #define CRED_FLAG_CAPMODE 0x00000001 /* In capability mode. */ 91 92 /* 93 * This is the external representation of struct ucred. 94 */ 95 struct xucred { 96 u_int cr_version; /* structure layout version */ 97 uid_t cr_uid; /* effective user id */ 98 short cr_ngroups; /* number of groups */ 99 gid_t cr_groups[XU_NGROUPS]; /* groups */ 100 union { 101 void *_cr_unused1; /* compatibility with old ucred */ 102 pid_t cr_pid; 103 }; 104 }; 105 #define XUCRED_VERSION 0 106 107 /* This can be used for both ucred and xucred structures. */ 108 #define cr_gid cr_groups[0] 109 110 #ifdef _KERNEL 111 struct proc; 112 struct thread; 113 114 struct credbatch { 115 struct ucred *cred; 116 int users; 117 int ref; 118 }; 119 120 static inline void 121 credbatch_prep(struct credbatch *crb) 122 { 123 crb->cred = NULL; 124 crb->users = 0; 125 crb->ref = 0; 126 } 127 void credbatch_add(struct credbatch *crb, struct thread *td); 128 129 static inline void 130 credbatch_process(struct credbatch *crb __unused) 131 { 132 133 } 134 135 void credbatch_final(struct credbatch *crb); 136 137 void change_egid(struct ucred *newcred, gid_t egid); 138 void change_euid(struct ucred *newcred, struct uidinfo *euip); 139 void change_rgid(struct ucred *newcred, gid_t rgid); 140 void change_ruid(struct ucred *newcred, struct uidinfo *ruip); 141 void change_svgid(struct ucred *newcred, gid_t svgid); 142 void change_svuid(struct ucred *newcred, uid_t svuid); 143 void crcopy(struct ucred *dest, struct ucred *src); 144 struct ucred *crcopysafe(struct proc *p, struct ucred *cr); 145 struct ucred *crdup(struct ucred *cr); 146 void crextend(struct ucred *cr, int n); 147 void proc_set_cred(struct proc *p, struct ucred *cr); 148 void proc_unset_cred(struct proc *p); 149 void crfree(struct ucred *cr); 150 struct ucred *crcowsync(void); 151 struct ucred *crget(void); 152 struct ucred *crhold(struct ucred *cr); 153 struct ucred *crcowget(struct ucred *cr); 154 void crcowfree(struct thread *td); 155 void cru2x(struct ucred *cr, struct xucred *xcr); 156 void cru2xt(struct thread *td, struct xucred *xcr); 157 void crsetgroups(struct ucred *cr, int n, gid_t *groups); 158 bool groupmember(gid_t gid, struct ucred *cred); 159 bool realgroupmember(gid_t gid, struct ucred *cred); 160 #endif /* _KERNEL */ 161 162 #endif /* !_SYS_UCRED_H_ */ 163