xref: /freebsd-10.1-release/sys/sys/ucred.h

/*
 * Copyright (c) 1989, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)ucred.h	8.4 (Berkeley) 1/9/95
 * $FreeBSD: head/sys/sys/ucred.h 94020 2002-04-07 03:59:31Z dd $
 */

#ifndef _SYS_UCRED_H_
#define	_SYS_UCRED_H_

/*
 * Credentials.
 *
 * Please do not inspect cr_uid directly to determine superuserness.
 * Only the suser() or suser_cred() function should be used for this.
 */
struct ucred {
	u_int		cr_ref;		/* reference count */
#define	cr_startcopy cr_uid
	uid_t		cr_uid;		/* effective user id */
	uid_t		cr_ruid;	/* real user id */
	uid_t		cr_svuid;	/* saved user id */
	short		cr_ngroups;	/* number of groups */
	gid_t		cr_groups[NGROUPS]; /* groups */
	gid_t		cr_rgid;	/* real group id */
	gid_t		cr_svgid;	/* saved user id */
	struct uidinfo	*cr_uidinfo;	/* per euid resource consumption */
	struct uidinfo	*cr_ruidinfo;	/* per ruid resource consumption */
	struct prison	*cr_prison;	/* jail(4) */
#define	cr_endcopy cr_mtxp
	struct mtx	*cr_mtxp;      	/* protect refcount */
};
#define NOCRED ((struct ucred *)0)	/* no credential available */
#define FSCRED ((struct ucred *)-1)	/* filesystem credential */

/*
 * This is the external representation of struct ucred.
 */
struct xucred {
	u_int	cr_version;		/* structure layout version */
	uid_t	cr_uid;			/* effective user id */
	short	cr_ngroups;		/* number of groups */
	gid_t	cr_groups[NGROUPS];	/* groups */
	void	*_cr_unused1;		/* compatibility with old ucred */
};
#define	XUCRED_VERSION	0

/* This can be used for both ucred and xucred structures. */
#define cr_gid cr_groups[0]

#ifdef _KERNEL
struct thread;

#ifdef DIAGNOSTIC
void		cred_free_thread(struct thread *td);
#endif
void		cred_update_thread(struct thread *td);
void		change_egid(struct ucred *newcred, gid_t egid);
void		change_euid(struct ucred *newcred, uid_t euid);
void		change_rgid(struct ucred *newcred, gid_t rgid);
void		change_ruid(struct ucred *newcred, uid_t ruid);
void		change_svgid(struct ucred *newcred, gid_t svgid);
void		change_svuid(struct ucred *newcred, uid_t svuid);
void		crcopy(struct ucred *dest, struct ucred *src);
struct ucred	*crdup(struct ucred *cr);
void		crfree(struct ucred *cr);
struct ucred	*crget(void);
struct ucred	*crhold(struct ucred *cr);
int		crshared(struct ucred *cr);
void		cru2x(struct ucred *cr, struct xucred *xcr);
int		groupmember(gid_t gid, struct ucred *cred);
#endif /* _KERNEL */

#endif /* !_SYS_UCRED_H_ */