selftest: mark failing print_tests more specifically
[Samba/vl.git] / source3 / lib / idmap_cache.c
blob413029c7a15887c537e3030da7947d6d53c61287
1 /*
2 Unix SMB/CIFS implementation.
3 ID Mapping Cache
5 Copyright (C) Volker Lendecke 2008
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.*/
20 #include "includes.h"
21 #include "idmap_cache.h"
22 #include "../libcli/security/security.h"
24 /**
25 * Find a sid2uid mapping
26 * @param[in] sid the sid to map
27 * @param[out] puid where to put the result
28 * @param[out] expired is the cache entry expired?
29 * @retval Was anything in the cache at all?
31 * If *puid == -1 this was a negative mapping.
34 bool idmap_cache_find_sid2uid(const struct dom_sid *sid, uid_t *puid,
35 bool *expired)
37 fstring sidstr;
38 char *key;
39 char *value;
40 char *endptr;
41 time_t timeout;
42 uid_t uid;
43 bool ret;
45 key = talloc_asprintf(talloc_tos(), "IDMAP/SID2UID/%s",
46 sid_to_fstring(sidstr, sid));
47 if (key == NULL) {
48 return false;
50 ret = gencache_get(key, &value, &timeout);
51 TALLOC_FREE(key);
52 if (!ret) {
53 return false;
55 uid = strtol(value, &endptr, 10);
56 ret = (*endptr == '\0');
57 SAFE_FREE(value);
58 if (ret) {
59 *puid = uid;
60 *expired = (timeout <= time(NULL));
62 return ret;
65 /**
66 * Find a uid2sid mapping
67 * @param[in] uid the uid to map
68 * @param[out] sid where to put the result
69 * @param[out] expired is the cache entry expired?
70 * @retval Was anything in the cache at all?
72 * If "is_null_sid(sid)", this was a negative mapping.
75 bool idmap_cache_find_uid2sid(uid_t uid, struct dom_sid *sid, bool *expired)
77 char *key;
78 char *value;
79 time_t timeout;
80 bool ret = true;
82 key = talloc_asprintf(talloc_tos(), "IDMAP/UID2SID/%d", (int)uid);
83 if (key == NULL) {
84 return false;
86 ret = gencache_get(key, &value, &timeout);
87 TALLOC_FREE(key);
88 if (!ret) {
89 return false;
91 ZERO_STRUCTP(sid);
92 if (value[0] != '-') {
93 ret = string_to_sid(sid, value);
95 SAFE_FREE(value);
96 if (ret) {
97 *expired = (timeout <= time(NULL));
99 return ret;
103 * Store a mapping in the idmap cache
104 * @param[in] sid the sid to map
105 * @param[in] uid the uid to map
107 * If both parameters are valid values, then a positive mapping in both
108 * directions is stored. If "is_null_sid(sid)" is true, then this will be a
109 * negative mapping of uid, we want to cache that for this uid we could not
110 * find anything. Likewise if "uid==-1", then we want to cache that we did not
111 * find a mapping for the sid passed here.
114 void idmap_cache_set_sid2uid(const struct dom_sid *sid, uid_t uid)
116 time_t now = time(NULL);
117 time_t timeout;
118 fstring sidstr, key, value;
120 if (!is_null_sid(sid)) {
121 fstr_sprintf(key, "IDMAP/SID2UID/%s",
122 sid_to_fstring(sidstr, sid));
123 fstr_sprintf(value, "%d", (int)uid);
124 timeout = (uid == -1)
125 ? lp_idmap_negative_cache_time()
126 : lp_idmap_cache_time();
127 gencache_set(key, value, now + timeout);
129 if (uid != -1) {
130 fstr_sprintf(key, "IDMAP/UID2SID/%d", (int)uid);
131 if (is_null_sid(sid)) {
132 /* negative uid mapping */
133 fstrcpy(value, "-");
134 timeout = lp_idmap_negative_cache_time();
136 else {
137 sid_to_fstring(value, sid);
138 timeout = lp_idmap_cache_time();
140 gencache_set(key, value, now + timeout);
145 * Find a sid2gid mapping
146 * @param[in] sid the sid to map
147 * @param[out] pgid where to put the result
148 * @param[out] expired is the cache entry expired?
149 * @retval Was anything in the cache at all?
151 * If *pgid == -1 this was a negative mapping.
154 bool idmap_cache_find_sid2gid(const struct dom_sid *sid, gid_t *pgid,
155 bool *expired)
157 fstring sidstr;
158 char *key;
159 char *value;
160 char *endptr;
161 time_t timeout;
162 gid_t gid;
163 bool ret;
165 key = talloc_asprintf(talloc_tos(), "IDMAP/SID2GID/%s",
166 sid_to_fstring(sidstr, sid));
167 if (key == NULL) {
168 return false;
170 ret = gencache_get(key, &value, &timeout);
171 TALLOC_FREE(key);
172 if (!ret) {
173 return false;
175 gid = strtol(value, &endptr, 10);
176 ret = (*endptr == '\0');
177 SAFE_FREE(value);
178 if (ret) {
179 *pgid = gid;
180 *expired = (timeout <= time(NULL));
182 return ret;
186 * Find a gid2sid mapping
187 * @param[in] gid the gid to map
188 * @param[out] sid where to put the result
189 * @param[out] expired is the cache entry expired?
190 * @retval Was anything in the cache at all?
192 * If "is_null_sid(sid)", this was a negative mapping.
195 bool idmap_cache_find_gid2sid(gid_t gid, struct dom_sid *sid, bool *expired)
197 char *key;
198 char *value;
199 time_t timeout;
200 bool ret = true;
202 key = talloc_asprintf(talloc_tos(), "IDMAP/GID2SID/%d", (int)gid);
203 if (key == NULL) {
204 return false;
206 ret = gencache_get(key, &value, &timeout);
207 TALLOC_FREE(key);
208 if (!ret) {
209 return false;
211 ZERO_STRUCTP(sid);
212 if (value[0] != '-') {
213 ret = string_to_sid(sid, value);
215 SAFE_FREE(value);
216 if (ret) {
217 *expired = (timeout <= time(NULL));
219 return ret;
223 * Store a mapping in the idmap cache
224 * @param[in] sid the sid to map
225 * @param[in] gid the gid to map
227 * If both parameters are valid values, then a positive mapping in both
228 * directions is stored. If "is_null_sid(sid)" is true, then this will be a
229 * negative mapping of gid, we want to cache that for this gid we could not
230 * find anything. Likewise if "gid==-1", then we want to cache that we did not
231 * find a mapping for the sid passed here.
234 void idmap_cache_set_sid2gid(const struct dom_sid *sid, gid_t gid)
236 time_t now = time(NULL);
237 time_t timeout;
238 fstring sidstr, key, value;
240 if (!is_null_sid(sid)) {
241 fstr_sprintf(key, "IDMAP/SID2GID/%s",
242 sid_to_fstring(sidstr, sid));
243 fstr_sprintf(value, "%d", (int)gid);
244 timeout = (gid == -1)
245 ? lp_idmap_negative_cache_time()
246 : lp_idmap_cache_time();
247 gencache_set(key, value, now + timeout);
249 if (gid != -1) {
250 fstr_sprintf(key, "IDMAP/GID2SID/%d", (int)gid);
251 if (is_null_sid(sid)) {
252 /* negative gid mapping */
253 fstrcpy(value, "-");
254 timeout = lp_idmap_negative_cache_time();
256 else {
257 sid_to_fstring(value, sid);
258 timeout = lp_idmap_cache_time();
260 gencache_set(key, value, now + timeout);
266 * Store a mapping in the idmap cache
267 * @param[in] sid the sid to map
268 * @param[in] uid/gid the uid/gid to map
270 * If both parameters are valid values, then a positive mapping in both
271 * directions is stored. If "is_null_sid(sid)" is true, then this will be a
272 * negative mapping of gid, we want to cache that for this id we could not
273 * find anything. Likewise if "id==-1", then we want to cache that we did not
274 * find a mapping for the sid passed here.
277 void idmap_cache_set_sid2both(const struct dom_sid *sid, uid_t id)
279 time_t now = time(NULL);
280 time_t timeout;
281 fstring sidstr, key, value;
283 if (!is_null_sid(sid)) {
284 fstr_sprintf(key, "IDMAP/SID2BOTH/%s",
285 sid_to_fstring(sidstr, sid));
286 fstr_sprintf(value, "%d", (int)id);
287 timeout = (id == -1)
288 ? lp_idmap_negative_cache_time()
289 : lp_idmap_cache_time();
290 gencache_set(key, value, now + timeout);
292 if (id != -1) {
293 fstr_sprintf(key, "IDMAP/BOTH2SID/%d", (int)id);
294 if (is_null_sid(sid)) {
295 /* negative id mapping */
296 fstrcpy(value, "-");
297 timeout = lp_idmap_negative_cache_time();
299 else {
300 sid_to_fstring(value, sid);
301 timeout = lp_idmap_cache_time();
303 gencache_set(key, value, now + timeout);
308 static char* key_xid2sid_str(TALLOC_CTX* mem_ctx, char t, const char* id) {
309 if (t == 'B') {
310 return talloc_asprintf(mem_ctx, "IDMAP/BOTH2SID/%s", id);
312 return talloc_asprintf(mem_ctx, "IDMAP/%cID2SID/%s", t, id);
315 static char* key_xid2sid(TALLOC_CTX* mem_ctx, char t, int id) {
316 char str[32];
317 snprintf(str, sizeof(str), "%d", id);
318 return key_xid2sid_str(mem_ctx, t, str);
321 static char* key_sid2xid_str(TALLOC_CTX* mem_ctx, char t, const char* sid) {
322 if (t == 'B') {
323 return talloc_asprintf(mem_ctx, "IDMAP/SID2BOTH/%s", sid);
325 return talloc_asprintf(mem_ctx, "IDMAP/SID2%cID/%s", t, sid);
328 /* static char* key_sid2xid(TALLOC_CTX* mem_ctx, char t, const struct dom_sid* sid) */
329 /* { */
330 /* char* sid_str = sid_string_talloc(mem_ctx, sid); */
331 /* char* key = key_sid2xid_str(mem_ctx, t, sid_str); */
332 /* talloc_free(sid_str); */
333 /* return key; */
334 /* } */
336 static bool idmap_cache_del_xid(char t, int xid)
338 TALLOC_CTX* mem_ctx = talloc_stackframe();
339 const char* key = key_xid2sid(mem_ctx, t, xid);
340 char* sid_str = NULL;
341 time_t timeout;
342 bool ret = true;
344 if (!gencache_get(key, &sid_str, &timeout)) {
345 DEBUG(3, ("no entry: %s\n", key));
346 ret = false;
347 goto done;
350 if (sid_str[0] != '-') {
351 const char* sid_key = key_sid2xid_str(mem_ctx, t, sid_str);
352 if (!gencache_del(sid_key)) {
353 DEBUG(2, ("failed to delete: %s\n", sid_key));
354 ret = false;
355 } else {
356 DEBUG(5, ("delete: %s\n", sid_key));
361 if (!gencache_del(key)) {
362 DEBUG(1, ("failed to delete: %s\n", key));
363 ret = false;
364 } else {
365 DEBUG(5, ("delete: %s\n", key));
368 done:
369 talloc_free(mem_ctx);
370 return ret;
373 bool idmap_cache_del_uid(uid_t uid) {
374 return idmap_cache_del_xid('U', uid);
377 bool idmap_cache_del_gid(gid_t gid) {
378 return idmap_cache_del_xid('G', gid);
381 bool idmap_cache_del_both(uid_t id) {
382 return idmap_cache_del_xid('B', id);
385 static bool idmap_cache_del_sid2xid(TALLOC_CTX* mem_ctx, char t, const char* sid)
387 const char* sid_key = key_sid2xid_str(mem_ctx, t, sid);
388 char* xid_str;
389 time_t timeout;
390 bool ret = true;
392 if (!gencache_get(sid_key, &xid_str, &timeout)) {
393 ret = false;
394 goto done;
397 if (atoi(xid_str) != -1) {
398 const char* xid_key = key_xid2sid_str(mem_ctx, t, xid_str);
399 if (!gencache_del(xid_key)) {
400 DEBUG(2, ("failed to delete: %s\n", xid_key));
401 ret = false;
402 } else {
403 DEBUG(5, ("delete: %s\n", xid_key));
407 if (!gencache_del(sid_key)) {
408 DEBUG(2, ("failed to delete: %s\n", sid_key));
409 ret = false;
410 } else {
411 DEBUG(5, ("delete: %s\n", sid_key));
413 done:
414 return ret;
417 bool idmap_cache_del_sid(const struct dom_sid *sid)
419 TALLOC_CTX* mem_ctx = talloc_stackframe();
420 const char* sid_str = sid_string_talloc(mem_ctx, sid);
421 bool ret = true;
423 if (!idmap_cache_del_sid2xid(mem_ctx, 'U', sid_str) &&
424 !idmap_cache_del_sid2xid(mem_ctx, 'G', sid_str) &&
425 !idmap_cache_del_sid2xid(mem_ctx, 'B', sid_str))
427 DEBUG(3, ("no entry: %s\n", key_xid2sid_str(mem_ctx, '?', sid_str)));
428 ret = false;
431 talloc_free(mem_ctx);
432 return ret;