1 .\" Copyright (c) 2005-2007 Apple Inc
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 4. Neither the name of Apple Computer nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 .Nd user and group identifier translation functions
42 .Fn mbr_uid_to_uuid "uid_t id" "uuid_t uu"
44 .Fn mbr_gid_to_uuid "gid_t id" "uuid_t uu"
46 .Fn mbr_uuid_to_id "const uuid_t uu" "uid_t *id" "int *id_type"
48 .Fn mbr_sid_to_uuid "const nt_sid_t *sid" "uuid_t uu"
50 .Fn mbr_uuid_to_sid "const uuid_t uu" "nt_sid_t *sid"
52 Users and groups can be referred to in multiple ways.
53 In addition to the traditional uid and gid,
54 every user or group can be referenced by a 128 bit uuid.
55 Additionally, if the user or group is hosted on a PDC
56 or Active Directory server, it will have a 128 bit or larger sid.
58 These routines communicate with the
59 .Xr DirectoryService 8
63 takes a uid and looks up the associated user account.
64 It provides the the uuid for that user as an output parameter.
65 Note that this routine will succeed and return a fabricated uuid if the input user uid does not exist.
67 should be used to test for the existence of a uid.
70 similarly gets the uuid associated with a group.
71 Note that this routine will succeed and return a fabricated uuid if the input group gid does not exist.
73 should be used to test for the existence of a gid.
76 takes a uuid that refers to a user or group and fetches the corresponding uid or gid.
78 is set to ID_TYPE_UID or ID_TYPE_GID to indicate which type was found.
81 always returns an id even if the uuid is not found.
82 This returned id is not persistant,
83 but can be used to map back to the uuid during runtime.
84 To determine if the uuid exists, the returned id can be used in a call to
90 takes a sid and returns the associated uuid.
94 always returns a uuid for the sid, even if the sid can not be found.
97 returns a sid for the associated uuid.
99 These functions return 0 on success, or EIO if communications with the
100 .Xr DirectoryService 8
102 ENOENT is returned if the mapping can not be performed.
107 return 0 (success), even if the user/group does not exist.
111 .Xr mbr_check_membership 3 ,
112 .Xr DirectoryService 8