1.\" 2.\" Copyright (C) 2001 Chad David <davidc@acns.ab.ca>. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice(s), this list of conditions and the following disclaimer as 9.\" the first lines of this file unmodified other than the possible 10.\" addition of one or more copyright notices. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice(s), this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY 16.\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 17.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 18.\" DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY 19.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 20.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 21.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 22.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 25.\" DAMAGE. 26.\" 27.\" $FreeBSD$ 28.\" 29.Dd July 9, 2001 30.Dt UCRED 9 31.Os 32.Sh NAME 33.Nm ucred , 34.Nm crget , 35.Nm crhold , 36.Nm crfree , 37.Nm crshared , 38.Nm crcopy , 39.Nm crdup 40.Nd "functions related to user credentials" 41.Sh SYNOPSIS 42.In sys/param.h 43.In sys/ucred.h 44.Ft "struct ucred *" 45.Fn crget void 46.Ft "struct ucred *" 47.Fn crhold "struct ucred *cr" 48.Ft void 49.Fn crfree "struct ucred *cr" 50.Ft int 51.Fn crshared "struct ucred *cr" 52.Ft void 53.Fn crcopy "struct ucred *dest" "struct ucred *src" 54.Ft "struct ucred *" 55.Fn crdup "struct ucred *cr" 56.Sh DESCRIPTION 57The 58.Nm 59family of functions is used to manage user credential structures 60.Pq Vt "struct ucred" 61within the kernel. 62.Pp 63The 64.Fn crget 65function allocates memory 66for a new structure, sets its reference count to 1, and 67initializes its lock. 68.Pp 69The 70.Fn crhold 71function increases the reference count on the credential. 72.Pp 73The 74.Fn crfree 75function decreases the reference count on the credential. 76If the count drops to 0, the storage for the structure is freed. 77.Pp 78The 79.Fn crshared 80function returns true if the credential is shared. 81A credential is considered to be shared if its reference 82count is greater than one. 83.Pp 84The 85.Fn crcopy 86function copies the contents of the source (template) 87credential into the destination template. 88The 89.Vt uidinfo 90structure within the destination is referenced 91by calling 92.Xr uihold 9 . 93.Pp 94The 95.Fn crdup 96function allocates memory for a new structure and copies the 97contents of 98.Fa cr 99into it. 100The actual copying is performed by 101.Fn crcopy . 102.Sh RETURN VALUES 103The functions that return values all return a pointer to a 104.Vt ucred 105structure. 106.Sh SEE ALSO 107.Xr uihold 9 108.Sh AUTHORS 109This man page was written by 110.An Chad David Aq davidc@acns.ab.ca . 111