2 Unix SMB/CIFS implementation.
4 Winbind daemon connection manager
6 Copyright (C) Tim Potter 2001
7 Copyright (C) Andrew Bartlett 2002
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 We need to manage connections to domain controllers without having to
26 mess up the main winbindd code with other issues. The aim of the
27 connection manager is to:
29 - make connections to domain controllers and cache them
30 - re-establish connections when networks or servers go down
31 - centralise the policy on connection timeouts, domain controller
33 - manage re-entrancy for when winbindd becomes able to handle
34 multiple outstanding rpc requests
36 Why not have connection management as part of the rpc layer like tng?
37 Good question. This code may morph into libsmb/rpc_cache.c or something
38 like that but at the moment it's simply staying as part of winbind. I
39 think the TNG architecture of forcing every user of the rpc layer to use
40 the connection caching system is a bad idea. It should be an optional
41 method of using the routines.
43 The TNG design is quite good but I disagree with some aspects of the
51 - I'm pretty annoyed by all the make_nmb_name() stuff. It should be
52 moved down into another function.
54 - Take care when destroying cli_structs as they can be shared between
62 #define DBGC_CLASS DBGC_WINBIND
64 /* Global list of connections. Initially a DLIST but can become a hash
65 table or whatever later. */
67 struct winbindd_cm_conn {
68 struct winbindd_cm_conn *prev, *next;
72 size_t mutex_ref_count;
73 struct cli_state *cli;
77 static struct winbindd_cm_conn *cm_conns = NULL;
80 /* Choose between anonymous or authenticated connections. We need to use
81 an authenticated connection if DCs have the RestrictAnonymous registry
82 entry set > 0, or the "Additional restrictions for anonymous
83 connections" set in the win2k Local Security Policy.
85 Caller to free() result in domain, username, password
88 static void cm_get_ipc_userpass(char **username, char **domain, char **password)
90 *username = secrets_fetch(SECRETS_AUTH_USER, NULL);
91 *domain = secrets_fetch(SECRETS_AUTH_DOMAIN, NULL);
92 *password = secrets_fetch(SECRETS_AUTH_PASSWORD, NULL);
94 if (*username && **username) {
96 if (!*domain || !**domain)
97 *domain = smb_xstrdup(lp_workgroup());
99 if (!*password || !**password)
100 *password = smb_xstrdup("");
102 DEBUG(3, ("IPC$ connections done by user %s\\%s\n",
103 *domain, *username));
106 DEBUG(3, ("IPC$ connections done anonymously\n"));
107 *username = smb_xstrdup("");
108 *domain = smb_xstrdup("");
109 *password = smb_xstrdup("");
113 /* Open a connction to the remote server, cache failures for 30 seconds */
115 static NTSTATUS cm_open_connection(const char *domain, const int pipe_index,
116 struct winbindd_cm_conn *new_conn)
119 char *ipc_username, *ipc_domain, *ipc_password;
120 struct in_addr dc_ip;
126 fstrcpy(new_conn->domain, domain);
127 fstrcpy(new_conn->pipe_name, get_pipe_name_from_index(pipe_index));
129 /* connection failure cache has been moved inside of get_dc_name
130 so we can deal with half dead DC's --jerry */
132 if (!get_dc_name(domain, new_conn->controller, &dc_ip)) {
133 result = NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND;
134 add_failed_connection_entry(domain, "", result);
138 /* Initialise SMB connection */
140 cm_get_ipc_userpass(&ipc_username, &ipc_domain, &ipc_password);
142 DEBUG(5, ("connecting to %s from %s with username [%s]\\[%s]\n",
143 new_conn->controller, global_myname(), ipc_domain, ipc_username));
145 for (i = 0; retry && (i < 3); i++) {
147 if (!(got_mutex = secrets_named_mutex(new_conn->controller, WINBIND_SERVER_MUTEX_WAIT_TIME))) {
148 DEBUG(0,("cm_open_connection: mutex grab failed for %s\n", new_conn->controller));
149 result = NT_STATUS_POSSIBLE_DEADLOCK;
153 result = cli_full_connection(&new_conn->cli, global_myname(), new_conn->controller,
154 &dc_ip, 0, "IPC$", "IPC", ipc_username, ipc_domain,
155 ipc_password, CLI_FULL_CONNECTION_ANNONYMOUS_FALLBACK, &retry);
157 secrets_named_mutex_release(new_conn->controller);
159 if (NT_STATUS_IS_OK(result))
163 SAFE_FREE(ipc_username);
164 SAFE_FREE(ipc_domain);
165 SAFE_FREE(ipc_password);
167 if (!NT_STATUS_IS_OK(result)) {
168 add_failed_connection_entry(domain, new_conn->controller, result);
172 /* set the domain if empty; needed for schannel connections */
173 if ( !*new_conn->cli->domain )
174 fstrcpy( new_conn->cli->domain, domain );
177 if ( !cli_nt_session_open (new_conn->cli, pipe_index) ) {
178 result = NT_STATUS_PIPE_NOT_AVAILABLE;
180 * only cache a failure if we are not trying to open the
181 * **win2k** specific lsarpc UUID. This could be an NT PDC
182 * and therefore a failure is normal. This should probably
183 * be abstracted to a check for 2k specific pipes and wondering
184 * if the PDC is an NT4 box. but since there is only one 2k
185 * specific UUID right now, i'm not going to bother. --jerry
187 if ( !is_win2k_pipe(pipe_index) )
188 add_failed_connection_entry(domain, new_conn->controller, result);
189 cli_shutdown(new_conn->cli);
196 /* Return true if a connection is still alive */
198 static BOOL connection_ok(struct winbindd_cm_conn *conn)
201 smb_panic("Invalid parameter passed to connection_ok(): conn was NULL!\n");
206 DEBUG(3, ("Connection to %s for domain %s (pipe %s) has NULL conn->cli!\n",
207 conn->controller, conn->domain, conn->pipe_name));
211 if (!conn->cli->initialised) {
212 DEBUG(3, ("Connection to %s for domain %s (pipe %s) was never initialised!\n",
213 conn->controller, conn->domain, conn->pipe_name));
217 if (conn->cli->fd == -1) {
218 DEBUG(3, ("Connection to %s for domain %s (pipe %s) has died or was never started (fd == -1)\n",
219 conn->controller, conn->domain, conn->pipe_name));
226 /* Search the cache for a connection. If there is a broken one,
227 shut it down properly and return NULL. */
229 static void find_cm_connection(const char *domain, const char *pipe_name,
230 struct winbindd_cm_conn **conn_out)
232 struct winbindd_cm_conn *conn;
234 for (conn = cm_conns; conn; ) {
235 if (strequal(conn->domain, domain) &&
236 strequal(conn->pipe_name, pipe_name)) {
237 if (!connection_ok(conn)) {
238 /* Dead connection - remove it. */
239 struct winbindd_cm_conn *conn_temp = conn->next;
241 cli_shutdown(conn->cli);
242 DLIST_REMOVE(cm_conns, conn);
244 conn = conn_temp; /* Keep the loop moving */
256 /* Initialize a new connection up to the RPC BIND. */
258 static NTSTATUS new_cm_connection(const char *domain, const char *pipe_name,
259 struct winbindd_cm_conn **conn_out)
261 struct winbindd_cm_conn *conn;
264 if (!(conn = malloc(sizeof(*conn))))
265 return NT_STATUS_NO_MEMORY;
269 if (!NT_STATUS_IS_OK(result = cm_open_connection(domain, get_pipe_index(pipe_name), conn))) {
270 DEBUG(3, ("Could not open a connection to %s for %s (%s)\n",
271 domain, pipe_name, nt_errstr(result)));
275 DLIST_ADD(cm_conns, conn);
281 /* Get a connection to the remote DC and open the pipe. If there is already a connection, use that */
283 static NTSTATUS get_connection_from_cache(const char *domain, const char *pipe_name,
284 struct winbindd_cm_conn **conn_out)
286 find_cm_connection(domain, pipe_name, conn_out);
288 if (*conn_out != NULL)
291 return new_cm_connection(domain, pipe_name, conn_out);
294 /**********************************************************************************
295 **********************************************************************************/
297 BOOL cm_check_for_native_mode_win2k( const char *domain )
300 struct winbindd_cm_conn conn;
308 if ( !NT_STATUS_IS_OK(result = cm_open_connection(domain, PI_LSARPC_DS, &conn)) ) {
309 DEBUG(5, ("cm_check_for_native_mode_win2k: Could not open a connection to %s for PIPE_LSARPC (%s)\n",
310 domain, nt_errstr(result)));
315 if ( !NT_STATUS_IS_OK(cli_ds_getprimarydominfo( conn.cli,
316 conn.cli->mem_ctx, DsRolePrimaryDomainInfoBasic, &ctr)) ) {
322 if ( (ctr.basic->flags & DSROLE_PRIMARY_DS_RUNNING)
323 && !(ctr.basic->flags & DSROLE_PRIMARY_DS_MIXED_MODE) )
330 * I don't think we need to shutdown here ? JRA.
333 cli_shutdown( conn.cli );
341 /* Return a LSA policy handle on a domain */
343 NTSTATUS cm_get_lsa_handle(const char *domain, CLI_POLICY_HND **return_hnd)
345 struct winbindd_cm_conn *conn;
346 uint32 des_access = SEC_RIGHTS_MAXIMUM_ALLOWED;
348 static CLI_POLICY_HND hnd;
350 /* Look for existing connections */
352 if (!NT_STATUS_IS_OK(result = get_connection_from_cache(domain, PIPE_LSARPC, &conn)))
355 /* This *shitty* code needs scrapping ! JRA */
357 if (policy_handle_is_valid(&conn->pol)) {
365 result = cli_lsa_open_policy(conn->cli, conn->cli->mem_ctx, False,
366 des_access, &conn->pol);
368 if (!NT_STATUS_IS_OK(result)) {
369 /* Hit the cache code again. This cleans out the old connection and gets a new one */
370 if (conn->cli->fd == -1) { /* Try again, if the remote host disapeared */
371 if (!NT_STATUS_IS_OK(result = get_connection_from_cache(domain, PIPE_LSARPC, &conn)))
374 result = cli_lsa_open_policy(conn->cli, conn->cli->mem_ctx, False,
375 des_access, &conn->pol);
378 if (!NT_STATUS_IS_OK(result)) {
379 cli_shutdown(conn->cli);
380 DLIST_REMOVE(cm_conns, conn);
394 /* Return a SAM policy handle on a domain */
396 NTSTATUS cm_get_sam_handle(char *domain, CLI_POLICY_HND **return_hnd)
398 struct winbindd_cm_conn *conn;
399 uint32 des_access = SEC_RIGHTS_MAXIMUM_ALLOWED;
401 static CLI_POLICY_HND hnd;
403 /* Look for existing connections */
405 if (!NT_STATUS_IS_OK(result = get_connection_from_cache(domain, PIPE_SAMR, &conn)))
408 /* This *shitty* code needs scrapping ! JRA */
410 if (policy_handle_is_valid(&conn->pol)) {
419 result = cli_samr_connect(conn->cli, conn->cli->mem_ctx,
420 des_access, &conn->pol);
422 if (!NT_STATUS_IS_OK(result)) {
423 /* Hit the cache code again. This cleans out the old connection and gets a new one */
424 if (conn->cli->fd == -1) { /* Try again, if the remote host disapeared */
426 if (!NT_STATUS_IS_OK(result = get_connection_from_cache(domain, PIPE_SAMR, &conn)))
429 result = cli_samr_connect(conn->cli, conn->cli->mem_ctx,
430 des_access, &conn->pol);
433 if (!NT_STATUS_IS_OK(result)) {
435 cli_shutdown(conn->cli);
436 DLIST_REMOVE(cm_conns, conn);
451 /* Get a handle on a netlogon pipe. This is a bit of a hack to re-use the
452 netlogon pipe as no handle is returned. */
454 NTSTATUS cm_get_netlogon_cli(const char *domain,
455 const unsigned char *trust_passwd,
456 uint32 sec_channel_type,
458 struct cli_state **cli)
460 NTSTATUS result = NT_STATUS_DOMAIN_CONTROLLER_NOT_FOUND;
461 struct winbindd_cm_conn *conn;
466 return NT_STATUS_INVALID_PARAMETER;
468 /* Open an initial conection - keep the mutex. */
470 find_cm_connection(domain, PIPE_NETLOGON, &conn);
472 if ( fresh && (conn != NULL) ) {
473 cli_shutdown(conn->cli);
478 /* purge connection from cache */
479 find_cm_connection(domain, PIPE_NETLOGON, &conn);
481 DEBUG(0,("Could not purge connection\n"));
482 return NT_STATUS_UNSUCCESSFUL;
491 result = new_cm_connection(domain, PIPE_NETLOGON, &conn);
493 if (!NT_STATUS_IS_OK(result))
496 fstr_sprintf(lock_name, "NETLOGON\\%s", conn->controller);
498 if (!(got_mutex = secrets_named_mutex(lock_name, WINBIND_SERVER_MUTEX_WAIT_TIME))) {
499 DEBUG(0,("cm_get_netlogon_cli: mutex grab failed for %s\n", conn->controller));
502 if ( sec_channel_type == SEC_CHAN_DOMAIN )
503 fstr_sprintf(conn->cli->mach_acct, "%s$", lp_workgroup());
505 result = cli_nt_establish_netlogon(conn->cli, sec_channel_type, trust_passwd);
508 secrets_named_mutex_release(lock_name);
510 if (!NT_STATUS_IS_OK(result)) {
511 cli_shutdown(conn->cli);
512 DLIST_REMOVE(cm_conns, conn);
522 /* Dump the current connection status */
524 static void dump_conn_list(void)
526 struct winbindd_cm_conn *con;
528 DEBUG(0, ("\tDomain Controller Pipe\n"));
530 for(con = cm_conns; con; con = con->next) {
533 /* Display pipe info */
535 if (asprintf(&msg, "\t%-15s %-15s %-16s", con->domain, con->controller, con->pipe_name) < 0) {
536 DEBUG(0, ("Error: not enough memory!\n"));
538 DEBUG(0, ("%s\n", msg));
544 void winbindd_cm_status(void)
546 /* List open connections */
548 DEBUG(0, ("winbindd connection manager status:\n"));
553 DEBUG(0, ("\tNo active connections\n"));
556 /* Close all cached connections */
558 void winbindd_cm_flush(void)
560 struct winbindd_cm_conn *conn, tmp;
562 /* Flush connection cache */
564 for (conn = cm_conns; conn; conn = conn->next) {
566 if (!connection_ok(conn))
569 DEBUG(10, ("Closing connection to %s on %s\n",
570 conn->pipe_name, conn->controller));
573 cli_shutdown(conn->cli);
575 tmp.next = conn->next;
577 DLIST_REMOVE(cm_conns, conn);
582 /* Flush failed connection cache */
584 flush_negative_conn_cache();