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 March 3, 2002 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.Nm cru2x 41.Nd "functions related to user credentials" 42.Sh SYNOPSIS 43.In sys/param.h 44.In sys/ucred.h 45.Ft "struct ucred *" 46.Fn crget void 47.Ft "struct ucred *" 48.Fn crhold "struct ucred *cr" 49.Ft void 50.Fn crfree "struct ucred *cr" 51.Ft int 52.Fn crshared "struct ucred *cr" 53.Ft void 54.Fn crcopy "struct ucred *dest" "struct ucred *src" 55.Ft "struct ucred *" 56.Fn crdup "struct ucred *cr" 57.Ft void 58.Fn cru2x "struct ucred *cr" "struct xucred *xcr" 59.Sh DESCRIPTION 60The 61.Nm 62family of functions is used to manage user credential structures 63.Pq Vt "struct ucred" 64within the kernel. 65.Pp 66The 67.Fn crget 68function allocates memory 69for a new structure, sets its reference count to 1, and 70initializes its lock. 71.Pp 72The 73.Fn crhold 74function increases the reference count on the credential. 75.Pp 76The 77.Fn crfree 78function decreases the reference count on the credential. 79If the count drops to 0, the storage for the structure is freed. 80.Pp 81The 82.Fn crshared 83function returns true if the credential is shared. 84A credential is considered to be shared if its reference 85count is greater than one. 86.Pp 87The 88.Fn crcopy 89function copies the contents of the source (template) 90credential into the destination template. 91The 92.Vt uidinfo 93structure within the destination is referenced 94by calling 95.Xr uihold 9 . 96.Pp 97The 98.Fn crdup 99function allocates memory for a new structure and copies the 100contents of 101.Fa cr 102into it. 103The actual copying is performed by 104.Fn crcopy . 105.Pp 106The 107.Fn cru2x 108function converts a 109.Vt ucred 110structure to an 111.Vt xucred 112structure. 113That is, 114it copies data from 115.Fa cr 116to 117.Fa xcr ; 118it ignores fields in the former that are not present in the latter 119(e.g., 120.Va cr_uidinfo ) , 121and appropriately sets fields in the latter that are not present in 122the former 123(e.g., 124.Va cr_version ) . 125.Sh RETURN VALUES 126The functions that return values all return a pointer to a 127.Vt ucred 128structure. 129.Sh SEE ALSO 130.Xr uihold 9 131.Sh AUTHORS 132This man page was written by 133.An Chad David Aq davidc@acns.ab.ca . 134