Comment was in wrong place
[Samba.git] / source3 / libsmb / samlogon_cache.c
blob73b570c38342fe7f7983aa994fa36f297bbde9f4
1 /*
2 Unix SMB/CIFS implementation.
3 Net_sam_logon info3 helpers
4 Copyright (C) Alexander Bokovoy 2002.
5 Copyright (C) Andrew Bartlett 2002.
6 Copyright (C) Gerald Carter 2003.
7 Copyright (C) Tim Potter 2003.
8 Copyright (C) Guenther Deschner 2008.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "includes.h"
26 #define NETSAMLOGON_TDB "netsamlogon_cache.tdb"
28 static TDB_CONTEXT *netsamlogon_tdb = NULL;
30 /***********************************************************************
31 open the tdb
32 ***********************************************************************/
34 bool netsamlogon_cache_init(void)
36 if (!netsamlogon_tdb) {
37 netsamlogon_tdb = tdb_open_log(lock_path(NETSAMLOGON_TDB), 0,
38 TDB_DEFAULT, O_RDWR | O_CREAT, 0600);
41 return (netsamlogon_tdb != NULL);
45 /***********************************************************************
46 Shutdown samlogon_cache database
47 ***********************************************************************/
49 bool netsamlogon_cache_shutdown(void)
51 if (netsamlogon_tdb) {
52 return (tdb_close(netsamlogon_tdb) == 0);
55 return true;
58 /***********************************************************************
59 Clear cache getpwnam and getgroups entries from the winbindd cache
60 ***********************************************************************/
62 void netsamlogon_clear_cached_user(TDB_CONTEXT *tdb, struct netr_SamInfo3 *info3)
64 bool got_tdb = false;
65 DOM_SID sid;
66 fstring key_str, sid_string;
68 /* We may need to call this function from smbd which will not have
69 winbindd_cache.tdb open. Open the tdb if a NULL is passed. */
71 if (!tdb) {
72 tdb = tdb_open_log(lock_path("winbindd_cache.tdb"),
73 WINBINDD_CACHE_TDB_DEFAULT_HASH_SIZE,
74 TDB_DEFAULT, O_RDWR, 0600);
75 if (!tdb) {
76 DEBUG(5, ("netsamlogon_clear_cached_user: failed to open cache\n"));
77 return;
79 got_tdb = true;
82 sid_copy(&sid, info3->base.domain_sid);
83 sid_append_rid(&sid, info3->base.rid);
85 /* Clear U/SID cache entry */
87 fstr_sprintf(key_str, "U/%s", sid_to_fstring(sid_string, &sid));
89 DEBUG(10, ("netsamlogon_clear_cached_user: clearing %s\n", key_str));
91 tdb_delete(tdb, string_tdb_data(key_str));
93 /* Clear UG/SID cache entry */
95 fstr_sprintf(key_str, "UG/%s", sid_to_fstring(sid_string, &sid));
97 DEBUG(10, ("netsamlogon_clear_cached_user: clearing %s\n", key_str));
99 tdb_delete(tdb, string_tdb_data(key_str));
101 if (got_tdb) {
102 tdb_close(tdb);
106 /***********************************************************************
107 Store a netr_SamInfo3 structure in a tdb for later user
108 username should be in UTF-8 format
109 ***********************************************************************/
111 bool netsamlogon_cache_store(const char *username, struct netr_SamInfo3 *info3)
113 TDB_DATA data;
114 fstring keystr, tmp;
115 bool result = false;
116 DOM_SID user_sid;
117 time_t t = time(NULL);
118 TALLOC_CTX *mem_ctx;
119 DATA_BLOB blob;
120 enum ndr_err_code ndr_err;
121 struct netsamlogoncache_entry r;
123 if (!info3) {
124 return false;
127 if (!netsamlogon_cache_init()) {
128 DEBUG(0,("netsamlogon_cache_store: cannot open %s for write!\n",
129 NETSAMLOGON_TDB));
130 return false;
133 sid_copy(&user_sid, info3->base.domain_sid);
134 sid_append_rid(&user_sid, info3->base.rid);
136 /* Prepare key as DOMAIN-SID/USER-RID string */
137 slprintf(keystr, sizeof(keystr), "%s", sid_to_fstring(tmp, &user_sid));
139 DEBUG(10,("netsamlogon_cache_store: SID [%s]\n", keystr));
141 /* Prepare data */
143 if (!(mem_ctx = TALLOC_P( NULL, int))) {
144 DEBUG(0,("netsamlogon_cache_store: talloc() failed!\n"));
145 return false;
148 /* only Samba fills in the username, not sure why NT doesn't */
149 /* so we fill it in since winbindd_getpwnam() makes use of it */
151 if (!info3->base.account_name.string) {
152 info3->base.account_name.string = talloc_strdup(mem_ctx, username);
155 r.timestamp = t;
156 r.info3 = *info3;
158 if (DEBUGLEVEL >= 10) {
159 NDR_PRINT_DEBUG(netsamlogoncache_entry, &r);
162 ndr_err = ndr_push_struct_blob(&blob, mem_ctx, &r,
163 (ndr_push_flags_fn_t)ndr_push_netsamlogoncache_entry);
164 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
165 DEBUG(0,("netsamlogon_cache_store: failed to push entry to cache\n"));
166 TALLOC_FREE(mem_ctx);
167 return false;
170 data.dsize = blob.length;
171 data.dptr = blob.data;
173 if (tdb_store_bystring(netsamlogon_tdb, keystr, data, TDB_REPLACE) != -1) {
174 result = true;
177 TALLOC_FREE(mem_ctx);
179 return result;
182 /***********************************************************************
183 Retrieves a netr_SamInfo3 structure from a tdb. Caller must
184 free the user_info struct (malloc()'d memory)
185 ***********************************************************************/
187 struct netr_SamInfo3 *netsamlogon_cache_get(TALLOC_CTX *mem_ctx, const DOM_SID *user_sid)
189 struct netr_SamInfo3 *info3 = NULL;
190 TDB_DATA data;
191 fstring keystr, tmp;
192 enum ndr_err_code ndr_err;
193 DATA_BLOB blob;
194 struct netsamlogoncache_entry r;
196 if (!netsamlogon_cache_init()) {
197 DEBUG(0,("netsamlogon_cache_get: cannot open %s for write!\n",
198 NETSAMLOGON_TDB));
199 return false;
202 /* Prepare key as DOMAIN-SID/USER-RID string */
203 slprintf(keystr, sizeof(keystr), "%s", sid_to_fstring(tmp, user_sid));
204 DEBUG(10,("netsamlogon_cache_get: SID [%s]\n", keystr));
205 data = tdb_fetch_bystring( netsamlogon_tdb, keystr );
207 if (!data.dptr) {
208 return NULL;
211 info3 = TALLOC_ZERO_P(mem_ctx, struct netr_SamInfo3);
212 if (!info3) {
213 goto done;
216 blob.data = (uint8 *)data.dptr;
217 blob.length = data.dsize;
219 ndr_err = ndr_pull_struct_blob(&blob, mem_ctx, &r,
220 (ndr_pull_flags_fn_t)ndr_pull_netsamlogoncache_entry);
222 if (DEBUGLEVEL >= 10) {
223 NDR_PRINT_DEBUG(netsamlogoncache_entry, &r);
226 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
227 DEBUG(0,("netsamlogon_cache_get: failed to pull entry from cache\n"));
228 tdb_delete(netsamlogon_tdb, data);
229 TALLOC_FREE(info3);
230 goto done;
233 info3 = (struct netr_SamInfo3 *)talloc_memdup(mem_ctx, &r.info3,
234 sizeof(r.info3));
236 done:
237 SAFE_FREE(data.dptr);
239 return info3;
241 #if 0 /* The netsamlogon cache needs to hang around. Something about
242 this feels wrong, but it is the only way we can get all of the
243 groups. The old universal groups cache didn't expire either.
244 --jerry */
246 time_t now = time(NULL);
247 uint32 time_diff;
249 /* is the entry expired? */
250 time_diff = now - t;
252 if ( (time_diff < 0 ) || (time_diff > lp_winbind_cache_time()) ) {
253 DEBUG(10,("netsamlogon_cache_get: cache entry expired \n"));
254 tdb_delete( netsamlogon_tdb, key );
255 TALLOC_FREE( user );
258 #endif
261 bool netsamlogon_cache_have(const DOM_SID *user_sid)
263 TALLOC_CTX *mem_ctx = talloc_init("netsamlogon_cache_have");
264 struct netr_SamInfo3 *info3 = NULL;
265 bool result;
267 if (!mem_ctx)
268 return False;
270 info3 = netsamlogon_cache_get(mem_ctx, user_sid);
272 result = (info3 != NULL);
274 talloc_destroy(mem_ctx);
276 return result;