s3-winbindd: Move common code for LDAP id mapping to idmap_utils
[samba.git] / source3 / winbindd / idmap_util.c
1 /* 
2    Unix SMB/CIFS implementation.
3    ID Mapping
4    Copyright (C) Simo Sorce 2003
5    Copyright (C) Jeremy Allison 2006
6    Copyright (C) Michael Adam 2010
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 3 of the License, or
11    (at your option) any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program.  If not, see <http://www.gnu.org/licenses/>.*/
20
21 #include "includes.h"
22 #include "winbindd.h"
23 #include "winbindd_proto.h"
24 #include "idmap.h"
25 #include "idmap_cache.h"
26 #include "../libcli/security/security.h"
27
28 #undef DBGC_CLASS
29 #define DBGC_CLASS DBGC_IDMAP
30
31 /*****************************************************************
32  Returns the SID mapped to the given UID.
33  If mapping is not possible returns an error.
34 *****************************************************************/  
35
36 NTSTATUS idmap_uid_to_sid(const char *domname, struct dom_sid *sid, uid_t uid)
37 {
38         NTSTATUS ret;
39         struct id_map map;
40         bool expired;
41
42         DEBUG(10,("idmap_uid_to_sid: uid = [%lu], domain = '%s'\n",
43                   (unsigned long)uid, domname?domname:"NULL"));
44
45         if (winbindd_use_idmap_cache()
46             && idmap_cache_find_uid2sid(uid, sid, &expired)) {
47                 DEBUG(10, ("idmap_cache_find_uid2sid found %u%s\n",
48                         (unsigned int)uid,
49                            expired ? " (expired)": ""));
50                 if (expired && idmap_is_online()) {
51                         DEBUG(10, ("revalidating expired entry\n"));
52                         goto backend;
53                 }
54                 if (is_null_sid(sid)) {
55                         DEBUG(10, ("Returning negative cache entry\n"));
56                         return NT_STATUS_NONE_MAPPED;
57                 }
58                 DEBUG(10, ("Returning positive cache entry\n"));
59                 return NT_STATUS_OK;
60         }
61
62 backend:
63         ZERO_STRUCT(map);
64         map.sid = sid;
65         map.xid.type = ID_TYPE_UID;
66         map.xid.id = uid;
67
68         ret = idmap_backends_unixid_to_sid(domname, &map);
69         if ( ! NT_STATUS_IS_OK(ret)) {
70                 DEBUG(10, ("error mapping uid [%lu]\n", (unsigned long)uid));
71                 return ret;
72         }
73
74         if (map.status != ID_MAPPED) {
75                 if (winbindd_use_idmap_cache()) {
76                         struct dom_sid null_sid;
77                         struct unixid id;
78                         id.type = ID_TYPE_UID;
79                         id.id = uid;
80                         ZERO_STRUCT(null_sid);
81                         idmap_cache_set_sid2unixid(&null_sid, &id);
82                 }
83                 DEBUG(10, ("uid [%lu] not mapped\n", (unsigned long)uid));
84                 return NT_STATUS_NONE_MAPPED;
85         }
86
87         if (winbindd_use_idmap_cache()) {
88                 idmap_cache_set_sid2unixid(sid, &map.xid);
89         }
90
91         return NT_STATUS_OK;
92 }
93
94 /*****************************************************************
95  Returns SID mapped to the given GID.
96  If mapping is not possible returns an error.
97 *****************************************************************/  
98
99 NTSTATUS idmap_gid_to_sid(const char *domname, struct dom_sid *sid, gid_t gid)
100 {
101         NTSTATUS ret;
102         struct id_map map;
103         bool expired;
104
105         DEBUG(10,("idmap_gid_to_sid: gid = [%lu], domain = '%s'\n",
106                   (unsigned long)gid, domname?domname:"NULL"));
107
108         if (winbindd_use_idmap_cache()
109             && idmap_cache_find_gid2sid(gid, sid, &expired)) {
110                 DEBUG(10, ("idmap_cache_find_gid2sid found %u%s\n",
111                         (unsigned int)gid,
112                            expired ? " (expired)": ""));
113                 if (expired && idmap_is_online()) {
114                         DEBUG(10, ("revalidating expired entry\n"));
115                         goto backend;
116                 }
117                 if (is_null_sid(sid)) {
118                         DEBUG(10, ("Returning negative cache entry\n"));
119                         return NT_STATUS_NONE_MAPPED;
120                 }
121                 DEBUG(10, ("Returning positive cache entry\n"));
122                 return NT_STATUS_OK;
123         }
124
125 backend:
126         ZERO_STRUCT(map);
127         map.sid = sid;
128         map.xid.type = ID_TYPE_GID;
129         map.xid.id = gid;
130
131         ret = idmap_backends_unixid_to_sid(domname, &map);
132         if ( ! NT_STATUS_IS_OK(ret)) {
133                 DEBUG(10, ("error mapping gid [%lu]\n", (unsigned long)gid));
134                 return ret;
135         }
136
137         if (map.status != ID_MAPPED) {
138                 if (winbindd_use_idmap_cache()) {
139                         struct dom_sid null_sid;
140                         struct unixid id;
141                         id.type = ID_TYPE_GID;
142                         id.id = gid;
143                         ZERO_STRUCT(null_sid);
144                         idmap_cache_set_sid2unixid(&null_sid, &id);
145                 }
146                 DEBUG(10, ("gid [%lu] not mapped\n", (unsigned long)gid));
147                 return NT_STATUS_NONE_MAPPED;
148         }
149
150         if (winbindd_use_idmap_cache()) {
151                 idmap_cache_set_sid2unixid(sid, &map.xid);
152         }
153
154         return NT_STATUS_OK;
155 }
156
157 /**
158  * check whether a given unix id is inside the filter range of an idmap domain
159  */
160 bool idmap_unix_id_is_in_range(uint32_t id, struct idmap_domain *dom)
161 {
162         if (id == 0) {
163                 /* 0 is not an allowed unix id for id mapping */
164                 return false;
165         }
166
167         if ((dom->low_id && (id < dom->low_id)) ||
168             (dom->high_id && (id > dom->high_id)))
169         {
170                 return false;
171         }
172
173         return true;
174 }
175
176 /**
177  * Helper for unixids_to_sids: find entry by id in mapping array,
178  * search up to IDMAP_AD_MAX_IDS entries
179  */
180 struct id_map *idmap_find_map_by_id(struct id_map **maps, enum id_type type,
181                                     uint32_t id)
182 {
183         int i;
184
185         for (i = 0; i < IDMAP_LDAP_MAX_IDS; i++) {
186                 if (maps[i] == NULL) { /* end of the run */
187                         return NULL;
188                 }
189                 if ((maps[i]->xid.type == type) && (maps[i]->xid.id == id)) {
190                         return maps[i];
191                 }
192         }
193
194         return NULL;
195 }
196
197 /**
198  * Helper for sids_to_unix_ids: find entry by SID in mapping array,
199  * search up to IDMAP_AD_MAX_IDS entries
200  */
201 struct id_map *idmap_find_map_by_sid(struct id_map **maps, struct dom_sid *sid)
202 {
203         int i;
204
205         for (i = 0; i < IDMAP_LDAP_MAX_IDS; i++) {
206                 if (maps[i] == NULL) { /* end of the run */
207                         return NULL;
208                 }
209                 if (dom_sid_equal(maps[i]->sid, sid)) {
210                         return maps[i];
211                 }
212         }
213
214         return NULL;
215 }