2 Unix SMB/CIFS implementation.
3 SMB client generic functions
4 Copyright (C) Andrew Tridgell 1994-1998
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 /****************************************************************************
24 Change the timeout (in milliseconds).
25 ****************************************************************************/
27 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
29 unsigned int old_timeout = cli->timeout;
30 cli->timeout = timeout;
34 /****************************************************************************
35 Change the port number used to call on.
36 ****************************************************************************/
38 int cli_set_port(struct cli_state *cli, int port)
44 /****************************************************************************
45 Read an smb from a fd ignoring all keepalive packets. Note that the buffer
46 *MUST* be of size BUFFER_SIZE+SAFETY_MARGIN.
47 The timeout is in milliseconds
49 This is exactly the same as receive_smb except that it never returns
50 a session keepalive packet (just as receive_smb used to do).
51 receive_smb was changed to return keepalives as the oplock processing means this call
52 should never go into a blocking read.
53 ****************************************************************************/
55 static BOOL client_receive_smb(int fd,char *buffer, unsigned int timeout)
60 ret = receive_smb_raw(fd, buffer, timeout);
63 DEBUG(10,("client_receive_smb failed\n"));
68 /* Ignore session keepalive packets. */
69 if(CVAL(buffer,0) != SMBkeepalive)
76 /****************************************************************************
78 ****************************************************************************/
80 BOOL cli_receive_smb(struct cli_state *cli)
82 extern int smb_read_error;
85 /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
90 ret = client_receive_smb(cli->fd,cli->inbuf,cli->timeout);
93 /* it might be an oplock break request */
94 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) &&
95 CVAL(cli->inbuf,smb_com) == SMBlockingX &&
96 SVAL(cli->inbuf,smb_vwv6) == 0 &&
97 SVAL(cli->inbuf,smb_vwv7) == 0) {
98 if (cli->oplock_handler) {
99 int fnum = SVAL(cli->inbuf,smb_vwv2);
100 unsigned char level = CVAL(cli->inbuf,smb_vwv3+1);
101 if (!cli->oplock_handler(cli, fnum, level)) return False;
103 /* try to prevent loops */
104 SCVAL(cli->inbuf,smb_com,0xFF);
109 /* If the server is not responding, note that now */
112 cli->smb_rw_error = smb_read_error;
118 if (!cli_check_sign_mac(cli)) {
119 DEBUG(0, ("SMB Signature verification failed on incoming packet!\n"));
120 cli->smb_rw_error = READ_BAD_SIG;
128 static ssize_t write_socket(int fd, const char *buf, size_t len)
132 DEBUG(6,("write_socket(%d,%d)\n",fd,(int)len));
133 ret = write_data(fd,buf,len);
135 DEBUG(6,("write_socket(%d,%d) wrote %d\n",fd,(int)len,(int)ret));
137 DEBUG(0,("write_socket: Error writing %d bytes to socket %d: ERRNO = %s\n",
138 (int)len, fd, strerror(errno) ));
143 /****************************************************************************
145 ****************************************************************************/
147 BOOL cli_send_smb(struct cli_state *cli)
153 /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
157 cli_calculate_sign_mac(cli);
159 len = smb_len(cli->outbuf) + 4;
161 while (nwritten < len) {
162 ret = write_socket(cli->fd,cli->outbuf+nwritten,len - nwritten);
166 cli->smb_rw_error = WRITE_ERROR;
167 DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
168 (int)len,(int)ret, strerror(errno) ));
173 /* Increment the mid so we can tell between responses. */
180 /****************************************************************************
181 Setup basics in a outgoing packet.
182 ****************************************************************************/
184 void cli_setup_packet(struct cli_state *cli)
187 SSVAL(cli->outbuf,smb_pid,cli->pid);
188 SSVAL(cli->outbuf,smb_uid,cli->vuid);
189 SSVAL(cli->outbuf,smb_mid,cli->mid);
190 if (cli->protocol > PROTOCOL_CORE) {
192 if (cli->case_sensitive) {
193 SCVAL(cli->outbuf,smb_flg,0x0);
195 /* Default setting, case insensitive. */
196 SCVAL(cli->outbuf,smb_flg,0x8);
198 flags2 = FLAGS2_LONG_PATH_COMPONENTS;
199 if (cli->capabilities & CAP_UNICODE)
200 flags2 |= FLAGS2_UNICODE_STRINGS;
201 if (cli->capabilities & CAP_DFS)
202 flags2 |= FLAGS2_DFS_PATHNAMES;
203 if (cli->capabilities & CAP_STATUS32)
204 flags2 |= FLAGS2_32_BIT_ERROR_CODES;
206 flags2 |= FLAGS2_EXTENDED_SECURITY;
207 SSVAL(cli->outbuf,smb_flg2, flags2);
211 /****************************************************************************
212 Setup the bcc length of the packet from a pointer to the end of the data.
213 ****************************************************************************/
215 void cli_setup_bcc(struct cli_state *cli, void *p)
217 set_message_bcc(cli->outbuf, PTR_DIFF(p, smb_buf(cli->outbuf)));
220 /****************************************************************************
221 Initialise credentials of a client structure.
222 ****************************************************************************/
224 void cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
226 fstrcpy(cli->domain, domain);
227 fstrcpy(cli->user_name, username);
228 pwd_set_cleartext(&cli->pwd, password);
230 cli->pwd.null_pwd = True;
233 DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
236 /****************************************************************************
237 Set the signing state (used from the command line).
238 ****************************************************************************/
240 void cli_setup_signing_state(struct cli_state *cli, int signing_state)
242 if (signing_state == Undefined)
245 if (signing_state == False) {
246 cli->sign_info.allow_smb_signing = False;
247 cli->sign_info.mandatory_signing = False;
251 cli->sign_info.allow_smb_signing = True;
253 if (signing_state == Required)
254 cli->sign_info.mandatory_signing = True;
257 /****************************************************************************
258 Initialise a client structure.
259 ****************************************************************************/
261 struct cli_state *cli_initialise(struct cli_state *cli)
263 BOOL alloced_cli = False;
265 /* Check the effective uid - make sure we are not setuid */
266 if (is_setuid_root()) {
267 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
272 cli = SMB_MALLOC_P(struct cli_state);
279 if (cli->initialised)
280 cli_close_connection(cli);
287 cli->pid = (uint16)sys_getpid();
289 cli->vuid = UID_FIELD_INVALID;
290 cli->protocol = PROTOCOL_NT1;
291 cli->timeout = 20000; /* Timeout is in milliseconds. */
292 cli->bufsize = CLI_BUFFER_SIZE+4;
293 cli->max_xmit = cli->bufsize;
294 cli->outbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
295 cli->inbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
296 cli->oplock_handler = cli_oplock_ack;
297 cli->case_sensitive = False;
298 cli->smb_rw_error = 0;
300 cli->use_spnego = lp_client_use_spnego();
302 cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
304 /* Set the CLI_FORCE_DOSERR environment variable to test
305 client routines using DOS errors instead of STATUS32
306 ones. This intended only as a temporary hack. */
307 if (getenv("CLI_FORCE_DOSERR"))
308 cli->force_dos_errors = True;
310 if (lp_client_signing())
311 cli->sign_info.allow_smb_signing = True;
313 if (lp_client_signing() == Required)
314 cli->sign_info.mandatory_signing = True;
316 if (!cli->outbuf || !cli->inbuf)
319 if ((cli->mem_ctx = talloc_init("cli based talloc")) == NULL)
322 memset(cli->outbuf, 0, cli->bufsize);
323 memset(cli->inbuf, 0, cli->bufsize);
326 #if defined(DEVELOPER)
327 /* just because we over-allocate, doesn't mean it's right to use it */
328 clobber_region(FUNCTION_MACRO, __LINE__, cli->outbuf+cli->bufsize, SAFETY_MARGIN);
329 clobber_region(FUNCTION_MACRO, __LINE__, cli->inbuf+cli->bufsize, SAFETY_MARGIN);
332 /* initialise signing */
333 cli_null_set_signing(cli);
335 cli->initialised = 1;
336 cli->allocated = alloced_cli;
340 /* Clean up after malloc() error */
344 SAFE_FREE(cli->inbuf);
345 SAFE_FREE(cli->outbuf);
353 /****************************************************************************
355 Close an open named pipe over SMB. Free any authentication data.
356 Returns False if the cli_close call failed.
357 ****************************************************************************/
359 BOOL cli_rpc_pipe_close(struct rpc_pipe_client *cli)
367 ret = cli_close(cli->cli, cli->fnum);
370 DEBUG(0,("cli_rpc_pipe_close: cli_close failed on pipe %s, "
372 "to machine %s. Error was %s\n",
376 cli_errstr(cli->cli)));
379 if (cli->auth.cli_auth_data_free_func) {
380 (*cli->auth.cli_auth_data_free_func)(&cli->auth);
383 DEBUG(10,("cli_rpc_pipe_close: closed pipe %s to machine %s\n",
384 cli->pipe_name, cli->cli->desthost ));
386 DLIST_REMOVE(cli->cli->pipe_list, cli);
387 talloc_destroy(cli->mem_ctx);
391 /****************************************************************************
392 Close all pipes open on this session.
393 ****************************************************************************/
395 void cli_nt_pipes_close(struct cli_state *cli)
397 struct rpc_pipe_client *cp, *next;
399 for (cp = cli->pipe_list; cp; cp = next) {
401 cli_rpc_pipe_close(cp);
405 /****************************************************************************
406 Close a client connection and free the memory without destroying cli itself.
407 ****************************************************************************/
409 void cli_close_connection(struct cli_state *cli)
411 cli_nt_pipes_close(cli);
414 * tell our peer to free his resources. Wihtout this, when an
415 * application attempts to do a graceful shutdown and calls
416 * smbc_free_context() to clean up all connections, some connections
417 * can remain active on the peer end, until some (long) timeout period
418 * later. This tree disconnect forces the peer to clean up, since the
419 * connection will be going away.
421 * Also, do not do tree disconnect when cli->smb_rw_error is DO_NOT_DO_TDIS
422 * the only user for this so far is smbmount which passes opened connection
423 * down to kernel's smbfs module.
425 if ( (cli->cnum != (uint16)-1) && (cli->smb_rw_error != DO_NOT_DO_TDIS ) ) {
429 SAFE_FREE(cli->outbuf);
430 SAFE_FREE(cli->inbuf);
432 cli_free_signing_context(cli);
433 data_blob_free(&cli->secblob);
434 data_blob_free(&cli->user_session_key);
437 talloc_destroy(cli->mem_ctx);
445 cli->smb_rw_error = 0;
448 /****************************************************************************
449 Shutdown a client structure.
450 ****************************************************************************/
452 void cli_shutdown(struct cli_state *cli)
454 BOOL allocated = cli->allocated;
455 cli_close_connection(cli);
462 /****************************************************************************
463 Set socket options on a open connection.
464 ****************************************************************************/
466 void cli_sockopt(struct cli_state *cli, const char *options)
468 set_socket_options(cli->fd, options);
471 /****************************************************************************
472 Set the PID to use for smb messages. Return the old pid.
473 ****************************************************************************/
475 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
477 uint16 ret = cli->pid;
482 /****************************************************************************
483 Set the case sensitivity flag on the packets. Returns old state.
484 ****************************************************************************/
486 BOOL cli_set_case_sensitive(struct cli_state *cli, BOOL case_sensitive)
488 BOOL ret = cli->case_sensitive;
489 cli->case_sensitive = case_sensitive;
493 /****************************************************************************
494 Send a keepalive packet to the server
495 ****************************************************************************/
497 BOOL cli_send_keepalive(struct cli_state *cli)
500 DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
503 if (!send_keepalive(cli->fd)) {
506 DEBUG(0,("Error sending keepalive packet to client.\n"));
512 /****************************************************************************
513 Send/receive a SMBecho command: ping the server
514 ****************************************************************************/
516 BOOL cli_echo(struct cli_state *cli, unsigned char *data, size_t length)
520 SMB_ASSERT(length < 1024);
522 memset(cli->outbuf,'\0',smb_size);
523 set_message(cli->outbuf,1,length,True);
524 SCVAL(cli->outbuf,smb_com,SMBecho);
525 SSVAL(cli->outbuf,smb_tid,65535);
526 SSVAL(cli->outbuf,smb_vwv0,1);
527 cli_setup_packet(cli);
528 p = smb_buf(cli->outbuf);
529 memcpy(p, data, length);
532 cli_setup_bcc(cli, p);
535 if (!cli_receive_smb(cli)) {
539 if (cli_is_error(cli)) {