2 Unix SMB/CIFS implementation.
3 SMB client generic functions
4 Copyright (C) Andrew Tridgell 1994-1998
5 Copyright (C) Jeremy Allison 2007.
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/>.
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 ssize_t client_receive_smb(struct cli_state *cli, size_t maxlen)
60 len = receive_smb_raw(cli->fd, cli->inbuf, cli->timeout,
61 maxlen, &cli->smb_rw_error);
64 DEBUG(10,("client_receive_smb failed\n"));
69 /* Ignore session keepalive packets. */
70 if(CVAL(cli->inbuf,0) != SMBkeepalive) {
78 /****************************************************************************
80 ****************************************************************************/
82 bool cli_receive_smb(struct cli_state *cli)
86 /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
91 len = client_receive_smb(cli, 0);
94 /* it might be an oplock break request */
95 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) &&
96 CVAL(cli->inbuf,smb_com) == SMBlockingX &&
97 SVAL(cli->inbuf,smb_vwv6) == 0 &&
98 SVAL(cli->inbuf,smb_vwv7) == 0) {
99 if (cli->oplock_handler) {
100 int fnum = SVAL(cli->inbuf,smb_vwv2);
101 unsigned char level = CVAL(cli->inbuf,smb_vwv3+1);
102 if (!cli->oplock_handler(cli, fnum, level)) {
106 /* try to prevent loops */
107 SCVAL(cli->inbuf,smb_com,0xFF);
112 /* If the server is not responding, note that now */
114 DEBUG(0, ("Receiving SMB: Server stopped responding\n"));
120 if (!cli_check_sign_mac(cli)) {
122 * If we get a signature failure in sessionsetup, then
123 * the server sometimes just reflects the sent signature
124 * back to us. Detect this and allow the upper layer to
125 * retrieve the correct Windows error message.
127 if (CVAL(cli->outbuf,smb_com) == SMBsesssetupX &&
128 (smb_len(cli->inbuf) > (smb_ss_field + 8 - 4)) &&
129 (SVAL(cli->inbuf,smb_flg2) & FLAGS2_SMB_SECURITY_SIGNATURES) &&
130 memcmp(&cli->outbuf[smb_ss_field],&cli->inbuf[smb_ss_field],8) == 0 &&
134 * Reflected signature on login error.
135 * Set bad sig but don't close fd.
137 cli->smb_rw_error = SMB_READ_BAD_SIG;
141 DEBUG(0, ("SMB Signature verification failed on incoming packet!\n"));
142 cli->smb_rw_error = SMB_READ_BAD_SIG;
150 /****************************************************************************
151 Read the data portion of a readX smb.
152 The timeout is in milliseconds
153 ****************************************************************************/
155 ssize_t cli_receive_smb_data(struct cli_state *cli, char *buffer, size_t len)
157 if (cli->timeout > 0) {
158 return read_socket_with_timeout(cli->fd, buffer, len,
159 len, cli->timeout, &cli->smb_rw_error);
161 return read_data(cli->fd, buffer, len, &cli->smb_rw_error);
165 /****************************************************************************
166 Read a smb readX header.
167 ****************************************************************************/
169 bool cli_receive_smb_readX_header(struct cli_state *cli)
178 /* Read up to the size of a readX header reply. */
179 len = client_receive_smb(cli, (smb_size - 4) + 24);
182 /* it might be an oplock break request */
183 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) &&
184 CVAL(cli->inbuf,smb_com) == SMBlockingX &&
185 SVAL(cli->inbuf,smb_vwv6) == 0 &&
186 SVAL(cli->inbuf,smb_vwv7) == 0) {
187 ssize_t total_len = smb_len(cli->inbuf);
189 if (total_len > CLI_SAMBA_MAX_LARGE_READX_SIZE+SAFETY_MARGIN) {
193 /* Read the rest of the data. */
194 if ((total_len - len > 0) &&
195 !cli_receive_smb_data(cli,cli->inbuf+len,total_len - len)) {
199 if (cli->oplock_handler) {
200 int fnum = SVAL(cli->inbuf,smb_vwv2);
201 unsigned char level = CVAL(cli->inbuf,smb_vwv3+1);
202 if (!cli->oplock_handler(cli, fnum, level)) return False;
204 /* try to prevent loops */
205 SCVAL(cli->inbuf,smb_com,0xFF);
210 /* If it's not the above size it probably was an error packet. */
212 if ((len == (smb_size - 4) + 24) && !cli_is_error(cli)) {
213 /* Check it's a non-chained readX reply. */
214 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) ||
215 (CVAL(cli->inbuf,smb_vwv0) != 0xFF) ||
216 (CVAL(cli->inbuf,smb_com) != SMBreadX)) {
218 * We're not coping here with asnyc replies to
219 * other calls. Punt here - we need async client
226 * We know it's a readX reply - ensure we've read the
227 * padding bytes also.
230 offset = SVAL(cli->inbuf,smb_vwv6);
233 size_t padbytes = offset - len;
234 ret = cli_receive_smb_data(cli,smb_buf(cli->inbuf),padbytes);
235 if (ret != padbytes) {
245 cli->smb_rw_error = SMB_READ_ERROR;
251 static ssize_t write_socket(int fd, const char *buf, size_t len)
255 DEBUG(6,("write_socket(%d,%d)\n",fd,(int)len));
256 ret = write_data(fd,buf,len);
258 DEBUG(6,("write_socket(%d,%d) wrote %d\n",fd,(int)len,(int)ret));
260 DEBUG(0,("write_socket: Error writing %d bytes to socket %d: ERRNO = %s\n",
261 (int)len, fd, strerror(errno) ));
266 /****************************************************************************
268 ****************************************************************************/
270 bool cli_send_smb(struct cli_state *cli)
276 /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
280 cli_calculate_sign_mac(cli);
282 len = smb_len(cli->outbuf) + 4;
284 while (nwritten < len) {
285 ret = write_socket(cli->fd,cli->outbuf+nwritten,len - nwritten);
289 cli->smb_rw_error = SMB_WRITE_ERROR;
290 DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
291 (int)len,(int)ret, strerror(errno) ));
296 /* Increment the mid so we can tell between responses. */
303 /****************************************************************************
304 Send a "direct" writeX smb to a fd.
305 ****************************************************************************/
307 bool cli_send_smb_direct_writeX(struct cli_state *cli,
311 /* First length to send is the offset to the data. */
312 size_t len = SVAL(cli->outbuf,smb_vwv11) + 4;
316 /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
321 if (client_is_signing_on(cli)) {
322 DEBUG(0,("cli_send_smb_large: cannot send signed packet.\n"));
326 while (nwritten < len) {
327 ret = write_socket(cli->fd,cli->outbuf+nwritten,len - nwritten);
331 cli->smb_rw_error = SMB_WRITE_ERROR;
332 DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
333 (int)len,(int)ret, strerror(errno) ));
339 /* Now write the extra data. */
341 while (nwritten < extradata) {
342 ret = write_socket(cli->fd,p+nwritten,extradata - nwritten);
346 cli->smb_rw_error = SMB_WRITE_ERROR;
347 DEBUG(0,("Error writing %d extradata "
348 "bytes to client. %d (%s)\n",
349 (int)extradata,(int)ret, strerror(errno) ));
355 /* Increment the mid so we can tell between responses. */
362 /****************************************************************************
363 Setup basics in a outgoing packet.
364 ****************************************************************************/
366 void cli_setup_packet(struct cli_state *cli)
369 SSVAL(cli->outbuf,smb_pid,cli->pid);
370 SSVAL(cli->outbuf,smb_uid,cli->vuid);
371 SSVAL(cli->outbuf,smb_mid,cli->mid);
372 if (cli->protocol > PROTOCOL_CORE) {
374 if (cli->case_sensitive) {
375 SCVAL(cli->outbuf,smb_flg,0x0);
377 /* Default setting, case insensitive. */
378 SCVAL(cli->outbuf,smb_flg,0x8);
380 flags2 = FLAGS2_LONG_PATH_COMPONENTS;
381 if (cli->capabilities & CAP_UNICODE)
382 flags2 |= FLAGS2_UNICODE_STRINGS;
383 if ((cli->capabilities & CAP_DFS) && cli->dfsroot)
384 flags2 |= FLAGS2_DFS_PATHNAMES;
385 if (cli->capabilities & CAP_STATUS32)
386 flags2 |= FLAGS2_32_BIT_ERROR_CODES;
388 flags2 |= FLAGS2_EXTENDED_SECURITY;
389 SSVAL(cli->outbuf,smb_flg2, flags2);
393 /****************************************************************************
394 Setup the bcc length of the packet from a pointer to the end of the data.
395 ****************************************************************************/
397 void cli_setup_bcc(struct cli_state *cli, void *p)
399 set_message_bcc(cli->outbuf, PTR_DIFF(p, smb_buf(cli->outbuf)));
402 /****************************************************************************
403 Initialise credentials of a client structure.
404 ****************************************************************************/
406 void cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
408 fstrcpy(cli->domain, domain);
409 fstrcpy(cli->user_name, username);
410 pwd_set_cleartext(&cli->pwd, password);
412 cli->pwd.null_pwd = True;
415 DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
418 /****************************************************************************
419 Set the signing state (used from the command line).
420 ****************************************************************************/
422 void cli_setup_signing_state(struct cli_state *cli, int signing_state)
424 if (signing_state == Undefined)
427 if (signing_state == False) {
428 cli->sign_info.allow_smb_signing = False;
429 cli->sign_info.mandatory_signing = False;
433 cli->sign_info.allow_smb_signing = True;
435 if (signing_state == Required)
436 cli->sign_info.mandatory_signing = True;
439 /****************************************************************************
440 Initialise a client structure. Always returns a malloc'ed struct.
441 ****************************************************************************/
443 struct cli_state *cli_initialise(void)
445 struct cli_state *cli = NULL;
447 /* Check the effective uid - make sure we are not setuid */
448 if (is_setuid_root()) {
449 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
453 cli = SMB_MALLOC_P(struct cli_state);
463 cli->pid = (uint16)sys_getpid();
465 cli->vuid = UID_FIELD_INVALID;
466 cli->protocol = PROTOCOL_NT1;
467 cli->timeout = 20000; /* Timeout is in milliseconds. */
468 cli->bufsize = CLI_BUFFER_SIZE+4;
469 cli->max_xmit = cli->bufsize;
470 cli->outbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
471 cli->inbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
472 cli->oplock_handler = cli_oplock_ack;
473 cli->case_sensitive = False;
474 cli->smb_rw_error = 0;
476 cli->use_spnego = lp_client_use_spnego();
478 cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
480 /* Set the CLI_FORCE_DOSERR environment variable to test
481 client routines using DOS errors instead of STATUS32
482 ones. This intended only as a temporary hack. */
483 if (getenv("CLI_FORCE_DOSERR"))
484 cli->force_dos_errors = True;
486 if (lp_client_signing())
487 cli->sign_info.allow_smb_signing = True;
489 if (lp_client_signing() == Required)
490 cli->sign_info.mandatory_signing = True;
492 if (!cli->outbuf || !cli->inbuf)
495 memset(cli->outbuf, 0, cli->bufsize);
496 memset(cli->inbuf, 0, cli->bufsize);
499 #if defined(DEVELOPER)
500 /* just because we over-allocate, doesn't mean it's right to use it */
501 clobber_region(FUNCTION_MACRO, __LINE__, cli->outbuf+cli->bufsize, SAFETY_MARGIN);
502 clobber_region(FUNCTION_MACRO, __LINE__, cli->inbuf+cli->bufsize, SAFETY_MARGIN);
505 /* initialise signing */
506 cli_null_set_signing(cli);
508 cli->initialised = 1;
512 /* Clean up after malloc() error */
516 SAFE_FREE(cli->inbuf);
517 SAFE_FREE(cli->outbuf);
522 /****************************************************************************
524 Close an open named pipe over SMB. Free any authentication data.
525 Returns False if the cli_close call failed.
526 ****************************************************************************/
528 bool cli_rpc_pipe_close(struct rpc_pipe_client *cli)
536 ret = cli_close(cli->cli, cli->fnum);
539 DEBUG(1,("cli_rpc_pipe_close: cli_close failed on pipe %s, "
541 "to machine %s. Error was %s\n",
545 cli_errstr(cli->cli)));
548 if (cli->auth.cli_auth_data_free_func) {
549 (*cli->auth.cli_auth_data_free_func)(&cli->auth);
552 DEBUG(10,("cli_rpc_pipe_close: closed pipe %s to machine %s\n",
553 cli->pipe_name, cli->cli->desthost ));
555 DLIST_REMOVE(cli->cli->pipe_list, cli);
556 talloc_destroy(cli->mem_ctx);
560 /****************************************************************************
561 Close all pipes open on this session.
562 ****************************************************************************/
564 void cli_nt_pipes_close(struct cli_state *cli)
566 struct rpc_pipe_client *cp, *next;
568 for (cp = cli->pipe_list; cp; cp = next) {
570 cli_rpc_pipe_close(cp);
574 /****************************************************************************
575 Shutdown a client structure.
576 ****************************************************************************/
578 void cli_shutdown(struct cli_state *cli)
580 cli_nt_pipes_close(cli);
583 * tell our peer to free his resources. Wihtout this, when an
584 * application attempts to do a graceful shutdown and calls
585 * smbc_free_context() to clean up all connections, some connections
586 * can remain active on the peer end, until some (long) timeout period
587 * later. This tree disconnect forces the peer to clean up, since the
588 * connection will be going away.
590 * Also, do not do tree disconnect when cli->smb_rw_error is SMB_DO_NOT_DO_TDIS
591 * the only user for this so far is smbmount which passes opened connection
592 * down to kernel's smbfs module.
594 if ( (cli->cnum != (uint16)-1) && (cli->smb_rw_error != SMB_DO_NOT_DO_TDIS ) ) {
598 SAFE_FREE(cli->outbuf);
599 SAFE_FREE(cli->inbuf);
601 cli_free_signing_context(cli);
602 data_blob_free(&cli->secblob);
603 data_blob_free(&cli->user_session_key);
609 cli->smb_rw_error = 0;
614 /****************************************************************************
615 Set socket options on a open connection.
616 ****************************************************************************/
618 void cli_sockopt(struct cli_state *cli, const char *options)
620 set_socket_options(cli->fd, options);
623 /****************************************************************************
624 Set the PID to use for smb messages. Return the old pid.
625 ****************************************************************************/
627 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
629 uint16 ret = cli->pid;
634 /****************************************************************************
635 Set the case sensitivity flag on the packets. Returns old state.
636 ****************************************************************************/
638 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
640 bool ret = cli->case_sensitive;
641 cli->case_sensitive = case_sensitive;
645 /****************************************************************************
646 Send a keepalive packet to the server
647 ****************************************************************************/
649 bool cli_send_keepalive(struct cli_state *cli)
652 DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
655 if (!send_keepalive(cli->fd)) {
658 DEBUG(0,("Error sending keepalive packet to client.\n"));
664 /****************************************************************************
665 Send/receive a SMBecho command: ping the server
666 ****************************************************************************/
668 bool cli_echo(struct cli_state *cli, uint16 num_echos,
669 unsigned char *data, size_t length)
674 SMB_ASSERT(length < 1024);
676 memset(cli->outbuf,'\0',smb_size);
677 set_message(cli->outbuf,1,length,True);
678 SCVAL(cli->outbuf,smb_com,SMBecho);
679 SSVAL(cli->outbuf,smb_tid,65535);
680 SSVAL(cli->outbuf,smb_vwv0,num_echos);
681 cli_setup_packet(cli);
682 p = smb_buf(cli->outbuf);
683 memcpy(p, data, length);
686 cli_setup_bcc(cli, p);
690 for (i=0; i<num_echos; i++) {
691 if (!cli_receive_smb(cli)) {
695 if (cli_is_error(cli)) {