2 Unix SMB/CIFS implementation.
4 Trusted domain names cache on top of gencache.
6 Copyright (C) Rafal Szczesniak 2002
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 2 of the License, or
11 (at your option) any later version.
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.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #define DBGC_CLASS DBGC_ALL /* there's no proper class yet */
28 #define TDOMKEY_FMT "TDOM/%s"
29 #define TDOMTSKEY "TDOMCACHE/TIMESTAMP"
33 * @file trustdom_cache.c
35 * Implementation of trusted domain names cache useful when
36 * samba acts as domain member server. In such case, caching
37 * domain names currently trusted gives a performance gain
38 * because there's no need to query PDC each time we need
39 * list of trusted domains
44 * Initialise trustdom name caching system. Call gencache
45 * initialisation routine to perform necessary activities.
47 * @return true upon successful cache initialisation or
48 * false if cache init failed
51 BOOL
trustdom_cache_enable(void)
53 /* Init trustdom cache by calling gencache initialisation */
54 if (!gencache_init()) {
55 DEBUG(2, ("trustdomcache_enable: Couldn't initialise trustdom cache on top of gencache.\n"));
64 * Shutdown trustdom name caching system. Calls gencache
67 * @return true upon successful cache close or
71 BOOL
trustdom_cache_shutdown(void)
73 /* Close trustdom cache by calling gencache shutdown */
74 if (!gencache_shutdown()) {
75 DEBUG(2, ("trustdomcache_shutdown: Couldn't shutdown trustdom cache on top of gencache.\n"));
84 * Form up trustdom name key. It is based only
87 * @param name trusted domain name
88 * @return cache key for use in gencache mechanism
91 static char* trustdom_cache_key(const char* name
)
94 asprintf(&keystr
, TDOMKEY_FMT
, strupper_static(name
));
101 * Store trusted domain in gencache as the domain name (key)
102 * and ip address of domain controller (value)
104 * @param name trusted domain name
105 * @param alt_name alternative trusted domain name (used in ADS domains)
106 * @param sid trusted domain's SID
107 * @param timeout cache entry expiration time
108 * @return true upon successful value storing or
109 * false if store attempt failed
112 BOOL
trustdom_cache_store(char* name
, char* alt_name
, const DOM_SID
*sid
,
119 * we use gecache call to avoid annoying debug messages
120 * about initialised trustdom
122 if (!gencache_init()) return False
;
124 DEBUG(5, ("trustdom_store: storing SID %s of domain %s\n",
125 sid_string_static(sid
), name
));
127 key
= trustdom_cache_key(name
);
128 alt_key
= alt_name
? trustdom_cache_key(alt_name
) : NULL
;
130 /* Generate string representation domain SID */
131 sid_to_string(sid_string
, sid
);
134 * try to put the names in the cache
137 return (gencache_set(alt_key
, sid_string
, timeout
)
138 && gencache_set(key
, sid_string
, timeout
));
141 return gencache_set(key
, sid_string
, timeout
);
146 * Fetch trusted domain's dc from the gencache.
147 * This routine can also be used to check whether given
148 * domain is currently trusted one.
150 * @param name trusted domain name
151 * @param sid trusted domain's SID to be returned
152 * @return true if entry is found or
153 * false if has expired/doesn't exist
156 BOOL
trustdom_cache_fetch(const char* name
, DOM_SID
* sid
)
162 if (!gencache_init()) return False
;
164 /* exit now if null pointers were passed as they're required further */
165 if (!sid
) return False
;
167 /* prepare a key and get the value */
168 key
= trustdom_cache_key(name
);
169 if (!key
) return False
;
171 if (!gencache_get(key
, &value
, &timeout
)) {
172 DEBUG(5, ("no entry for trusted domain %s found.\n", name
));
177 DEBUG(5, ("trusted domain %s found (%s)\n", name
, value
));
180 /* convert ip string representation into in_addr structure */
181 if(! string_to_sid(sid
, value
)) {
190 /*******************************************************************
191 fetch the timestamp from the last update
192 *******************************************************************/
194 uint32
trustdom_cache_fetch_timestamp( void )
201 if (!gencache_init())
204 if (!gencache_get(TDOMTSKEY
, &value
, &timeout
)) {
205 DEBUG(5, ("no timestamp for trusted domain cache located.\n"));
209 timestamp
= atoi(value
);
214 /*******************************************************************
215 store the timestamp from the last update
216 *******************************************************************/
218 BOOL
trustdom_cache_store_timestamp( uint32 t
, time_t timeout
)
223 if (!gencache_init())
226 fstr_sprintf(value
, "%d", t
);
228 if (!gencache_set(TDOMTSKEY
, value
, timeout
)) {
229 DEBUG(5, ("failed to set timestamp for trustdom_cache\n"));
237 /*******************************************************************
238 lock the timestamp entry in the trustdom_cache
239 *******************************************************************/
241 BOOL
trustdom_cache_lock_timestamp( void )
243 return gencache_lock_entry( TDOMTSKEY
) != -1;
246 /*******************************************************************
247 unlock the timestamp entry in the trustdom_cache
248 *******************************************************************/
250 void trustdom_cache_unlock_timestamp( void )
252 gencache_unlock_entry( TDOMTSKEY
);
256 * Delete single trustdom entry. Look at the
257 * gencache_iterate definition.
261 static void flush_trustdom_name(const char* key
, const char *value
, time_t timeout
, void* dptr
)
264 DEBUG(5, ("Deleting entry %s\n", key
));
269 * Flush all the trusted domains entries from the cache.
272 void trustdom_cache_flush(void)
274 if (!gencache_init())
278 * iterate through each TDOM cache's entry and flush it
279 * by flush_trustdom_name function
281 gencache_iterate(flush_trustdom_name
, NULL
, trustdom_cache_key("*"));
282 DEBUG(5, ("Trusted domains cache flushed\n"));
285 /********************************************************************
286 update the trustdom_cache if needed
287 ********************************************************************/
288 #define TRUSTDOM_UPDATE_INTERVAL 600
290 void update_trustdom_cache( void )
297 TALLOC_CTX
*mem_ctx
= NULL
;
298 time_t now
= time(NULL
);
301 /* get the timestamp. We have to initialise it if the last timestamp == 0 */
303 if ( (last_check
= trustdom_cache_fetch_timestamp()) == 0 )
304 trustdom_cache_store_timestamp(0, now
+TRUSTDOM_UPDATE_INTERVAL
);
306 time_diff
= now
- last_check
;
308 if ( (time_diff
> 0) && (time_diff
< TRUSTDOM_UPDATE_INTERVAL
) ) {
309 DEBUG(10,("update_trustdom_cache: not time to update trustdom_cache yet\n"));
313 /* lock the timestamp */
314 if ( !trustdom_cache_lock_timestamp() )
317 if ( !(mem_ctx
= talloc_init("update_trustdom_cache")) ) {
318 DEBUG(0,("update_trustdom_cache: talloc_init() failed!\n"));
322 /* get the domains and store them */
324 if ( enumerate_domain_trusts(mem_ctx
, lp_workgroup(), &domain_names
,
325 &num_domains
, &dom_sids
) )
327 for ( i
=0; i
<num_domains
; i
++ ) {
328 trustdom_cache_store( domain_names
[i
], NULL
, &dom_sids
[i
],
329 now
+TRUSTDOM_UPDATE_INTERVAL
);
332 trustdom_cache_store_timestamp( now
, now
+TRUSTDOM_UPDATE_INTERVAL
);
336 /* unlock and we're done */
337 trustdom_cache_unlock_timestamp();
339 talloc_destroy( mem_ctx
);