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 2 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, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 extern int smb_read_error;
26 /****************************************************************************
27 Change the timeout (in milliseconds).
28 ****************************************************************************/
30 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
32 unsigned int old_timeout = cli->timeout;
33 cli->timeout = timeout;
37 /****************************************************************************
38 Change the port number used to call on.
39 ****************************************************************************/
41 int cli_set_port(struct cli_state *cli, int port)
47 /****************************************************************************
48 Read an smb from a fd ignoring all keepalive packets. Note that the buffer
49 *MUST* be of size BUFFER_SIZE+SAFETY_MARGIN.
50 The timeout is in milliseconds
52 This is exactly the same as receive_smb except that it can be set to never return
53 a session keepalive packet (just as receive_smb used to do).
54 receive_smb was changed to return keepalives as the oplock processing means this call
55 should never go into a blocking read.
56 ****************************************************************************/
58 static ssize_t client_receive_smb(struct cli_state *cli, BOOL eat_keepalives, size_t maxlen)
62 char *buffer = cli->inbuf;
63 unsigned int timeout = cli->timeout;
66 len = receive_smb_raw(fd, buffer, timeout, maxlen);
69 DEBUG(10,("client_receive_smb failed\n"));
74 /* Ignore session keepalive packets. */
75 if (eat_keepalives && (CVAL(buffer,0) == SMBkeepalive)) {
81 if (cli_encryption_on(cli)) {
82 NTSTATUS status = cli_decrypt_message(cli);
83 if (!NT_STATUS_IS_OK(status)) {
84 DEBUG(0, ("SMB decryption failed on incoming packet! Error %s\n",
86 cli->smb_rw_error = READ_BAD_DECRYPT;
96 /****************************************************************************
98 ****************************************************************************/
100 BOOL cli_receive_smb_internal(struct cli_state *cli, BOOL eat_keepalives)
104 /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
109 len = client_receive_smb(cli, eat_keepalives, 0);
111 if (len >= 0 && !eat_keepalives && (CVAL(cli->inbuf,0) == SMBkeepalive)) {
112 /* Give back the keepalive. */
117 /* it might be an oplock break request */
118 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) &&
119 CVAL(cli->inbuf,smb_com) == SMBlockingX &&
120 SVAL(cli->inbuf,smb_vwv6) == 0 &&
121 SVAL(cli->inbuf,smb_vwv7) == 0) {
122 if (cli->oplock_handler) {
123 int fnum = SVAL(cli->inbuf,smb_vwv2);
124 unsigned char level = CVAL(cli->inbuf,smb_vwv3+1);
125 if (!cli->oplock_handler(cli, fnum, level)) {
129 /* try to prevent loops */
130 SCVAL(cli->inbuf,smb_com,0xFF);
135 /* If the server is not responding, note that now */
137 DEBUG(0, ("Receiving SMB: Server stopped responding\n"));
138 cli->smb_rw_error = smb_read_error;
144 if (!cli_check_sign_mac(cli)) {
146 * If we get a signature failure in sessionsetup, then
147 * the server sometimes just reflects the sent signature
148 * back to us. Detect this and allow the upper layer to
149 * retrieve the correct Windows error message.
151 if (CVAL(cli->outbuf,smb_com) == SMBsesssetupX &&
152 (smb_len(cli->inbuf) > (smb_ss_field + 8 - 4)) &&
153 (SVAL(cli->inbuf,smb_flg2) & FLAGS2_SMB_SECURITY_SIGNATURES) &&
154 memcmp(&cli->outbuf[smb_ss_field],&cli->inbuf[smb_ss_field],8) == 0 &&
158 * Reflected signature on login error.
159 * Set bad sig but don't close fd.
161 cli->smb_rw_error = READ_BAD_SIG;
165 DEBUG(0, ("SMB Signature verification failed on incoming packet!\n"));
166 cli->smb_rw_error = READ_BAD_SIG;
175 /****************************************************************************
176 Recv an smb - eat keepalives.
177 ****************************************************************************/
179 BOOL cli_receive_smb(struct cli_state *cli)
181 return cli_receive_smb_internal(cli, True);
184 /****************************************************************************
185 Recv an smb - return keepalives.
186 ****************************************************************************/
188 BOOL cli_receive_smb_return_keepalive(struct cli_state *cli)
190 return cli_receive_smb_internal(cli, False);
193 /****************************************************************************
194 Read the data portion of a readX smb.
195 The timeout is in milliseconds
196 ****************************************************************************/
198 ssize_t cli_receive_smb_data(struct cli_state *cli, char *buffer, size_t len)
200 if (cli->timeout > 0) {
201 return read_socket_with_timeout(cli->fd, buffer, len, len, cli->timeout);
203 return read_data(cli->fd, buffer, len);
207 /****************************************************************************
208 Read a smb readX header.
209 We can only use this if encryption and signing are off.
210 ****************************************************************************/
212 BOOL cli_receive_smb_readX_header(struct cli_state *cli)
221 /* Read up to the size of a readX header reply. */
222 len = client_receive_smb(cli, True, (smb_size - 4) + 24);
225 /* it might be an oplock break request */
226 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) &&
227 CVAL(cli->inbuf,smb_com) == SMBlockingX &&
228 SVAL(cli->inbuf,smb_vwv6) == 0 &&
229 SVAL(cli->inbuf,smb_vwv7) == 0) {
230 ssize_t total_len = smb_len(cli->inbuf);
232 if (total_len > CLI_SAMBA_MAX_LARGE_READX_SIZE+SAFETY_MARGIN) {
236 /* Read the rest of the data. */
237 if (!cli_receive_smb_data(cli,cli->inbuf+len,total_len - len)) {
241 if (cli->oplock_handler) {
242 int fnum = SVAL(cli->inbuf,smb_vwv2);
243 unsigned char level = CVAL(cli->inbuf,smb_vwv3+1);
244 if (!cli->oplock_handler(cli, fnum, level)) return False;
246 /* try to prevent loops */
247 SCVAL(cli->inbuf,smb_com,0xFF);
252 /* Check it's a non-chained readX reply. */
253 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) ||
254 (CVAL(cli->inbuf,smb_vwv0) != 0xFF) ||
255 (CVAL(cli->inbuf,smb_com) != SMBreadX)) {
257 * We're not coping here with asnyc replies to
258 * other calls. Punt here - we need async client
265 * We know it's a readX reply - ensure we've read the
266 * padding bytes also.
269 offset = SVAL(cli->inbuf,smb_vwv6);
272 size_t padbytes = offset - len;
273 ret = cli_receive_smb_data(cli,smb_buf(cli->inbuf),padbytes);
274 if (ret != padbytes) {
283 cli->smb_rw_error = smb_read_error = READ_ERROR;
289 static ssize_t write_socket(int fd, const char *buf, size_t len)
293 DEBUG(6,("write_socket(%d,%d)\n",fd,(int)len));
294 ret = write_data(fd,buf,len);
296 DEBUG(6,("write_socket(%d,%d) wrote %d\n",fd,(int)len,(int)ret));
298 DEBUG(0,("write_socket: Error writing %d bytes to socket %d: ERRNO = %s\n",
299 (int)len, fd, strerror(errno) ));
304 /****************************************************************************
306 ****************************************************************************/
308 BOOL cli_send_smb(struct cli_state *cli)
313 char *buf_out = cli->outbuf;
314 BOOL enc_on = cli_encryption_on(cli);
316 /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
321 cli_calculate_sign_mac(cli);
324 NTSTATUS status = cli_encrypt_message(cli, &buf_out);
325 if (!NT_STATUS_IS_OK(status)) {
328 cli->smb_rw_error = WRITE_ERROR;
329 DEBUG(0,("Error in encrypting client message. Error %s\n",
330 nt_errstr(status) ));
335 len = smb_len(buf_out) + 4;
337 while (nwritten < len) {
338 ret = write_socket(cli->fd,buf_out+nwritten,len - nwritten);
341 cli_free_enc_buffer(cli, buf_out);
345 cli->smb_rw_error = WRITE_ERROR;
346 DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
347 (int)len,(int)ret, strerror(errno) ));
353 cli_free_enc_buffer(cli, buf_out);
355 /* Increment the mid so we can tell between responses. */
363 /****************************************************************************
364 Setup basics in a outgoing packet.
365 ****************************************************************************/
367 void cli_setup_packet(struct cli_state *cli)
370 SSVAL(cli->outbuf,smb_pid,cli->pid);
371 SSVAL(cli->outbuf,smb_uid,cli->vuid);
372 SSVAL(cli->outbuf,smb_mid,cli->mid);
373 if (cli->protocol > PROTOCOL_CORE) {
375 if (cli->case_sensitive) {
376 SCVAL(cli->outbuf,smb_flg,0x0);
378 /* Default setting, case insensitive. */
379 SCVAL(cli->outbuf,smb_flg,0x8);
381 flags2 = FLAGS2_LONG_PATH_COMPONENTS;
382 if (cli->capabilities & CAP_UNICODE)
383 flags2 |= FLAGS2_UNICODE_STRINGS;
384 if ((cli->capabilities & CAP_DFS) && cli->dfsroot)
385 flags2 |= FLAGS2_DFS_PATHNAMES;
386 if (cli->capabilities & CAP_STATUS32)
387 flags2 |= FLAGS2_32_BIT_ERROR_CODES;
389 flags2 |= FLAGS2_EXTENDED_SECURITY;
390 SSVAL(cli->outbuf,smb_flg2, flags2);
394 /****************************************************************************
395 Setup the bcc length of the packet from a pointer to the end of the data.
396 ****************************************************************************/
398 void cli_setup_bcc(struct cli_state *cli, void *p)
400 set_message_bcc(NULL,cli->outbuf, PTR_DIFF(p, smb_buf(cli->outbuf)));
403 /****************************************************************************
404 Initialise credentials of a client structure.
405 ****************************************************************************/
407 void cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
409 fstrcpy(cli->domain, domain);
410 fstrcpy(cli->user_name, username);
411 pwd_set_cleartext(&cli->pwd, password);
413 cli->pwd.null_pwd = True;
416 DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
419 /****************************************************************************
420 Set the signing state (used from the command line).
421 ****************************************************************************/
423 void cli_setup_signing_state(struct cli_state *cli, int signing_state)
425 if (signing_state == Undefined)
428 if (signing_state == False) {
429 cli->sign_info.allow_smb_signing = False;
430 cli->sign_info.mandatory_signing = False;
434 cli->sign_info.allow_smb_signing = True;
436 if (signing_state == Required)
437 cli->sign_info.mandatory_signing = True;
440 /****************************************************************************
441 Initialise a client structure. Always returns a malloc'ed struct.
442 ****************************************************************************/
444 struct cli_state *cli_initialise(void)
446 struct cli_state *cli = NULL;
448 /* Check the effective uid - make sure we are not setuid */
449 if (is_setuid_root()) {
450 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
454 cli = SMB_MALLOC_P(struct cli_state);
464 cli->pid = (uint16)sys_getpid();
466 cli->vuid = UID_FIELD_INVALID;
467 cli->protocol = PROTOCOL_NT1;
468 cli->timeout = 20000; /* Timeout is in milliseconds. */
469 cli->bufsize = CLI_BUFFER_SIZE+4;
470 cli->max_xmit = cli->bufsize;
471 cli->outbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
472 cli->inbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
473 cli->oplock_handler = cli_oplock_ack;
474 cli->case_sensitive = False;
475 cli->smb_rw_error = 0;
477 cli->use_spnego = lp_client_use_spnego();
479 cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
481 /* Set the CLI_FORCE_DOSERR environment variable to test
482 client routines using DOS errors instead of STATUS32
483 ones. This intended only as a temporary hack. */
484 if (getenv("CLI_FORCE_DOSERR"))
485 cli->force_dos_errors = True;
487 if (lp_client_signing())
488 cli->sign_info.allow_smb_signing = True;
490 if (lp_client_signing() == Required)
491 cli->sign_info.mandatory_signing = True;
493 if (!cli->outbuf || !cli->inbuf)
496 if ((cli->mem_ctx = talloc_init("cli based talloc")) == NULL)
499 memset(cli->outbuf, 0, cli->bufsize);
500 memset(cli->inbuf, 0, cli->bufsize);
503 #if defined(DEVELOPER)
504 /* just because we over-allocate, doesn't mean it's right to use it */
505 clobber_region(FUNCTION_MACRO, __LINE__, cli->outbuf+cli->bufsize, SAFETY_MARGIN);
506 clobber_region(FUNCTION_MACRO, __LINE__, cli->inbuf+cli->bufsize, SAFETY_MARGIN);
509 /* initialise signing */
510 cli_null_set_signing(cli);
512 cli->initialised = 1;
516 /* Clean up after malloc() error */
520 SAFE_FREE(cli->inbuf);
521 SAFE_FREE(cli->outbuf);
526 /****************************************************************************
528 Close an open named pipe over SMB. Free any authentication data.
529 Returns False if the cli_close call failed.
530 ****************************************************************************/
532 BOOL cli_rpc_pipe_close(struct rpc_pipe_client *cli)
540 ret = cli_close(cli->cli, cli->fnum);
543 DEBUG(1,("cli_rpc_pipe_close: cli_close failed on pipe %s, "
545 "to machine %s. Error was %s\n",
549 cli_errstr(cli->cli)));
552 if (cli->auth.cli_auth_data_free_func) {
553 (*cli->auth.cli_auth_data_free_func)(&cli->auth);
556 DEBUG(10,("cli_rpc_pipe_close: closed pipe %s to machine %s\n",
557 cli->pipe_name, cli->cli->desthost ));
559 DLIST_REMOVE(cli->cli->pipe_list, cli);
560 talloc_destroy(cli->mem_ctx);
564 /****************************************************************************
565 Close all pipes open on this session.
566 ****************************************************************************/
568 void cli_nt_pipes_close(struct cli_state *cli)
570 struct rpc_pipe_client *cp, *next;
572 for (cp = cli->pipe_list; cp; cp = next) {
574 cli_rpc_pipe_close(cp);
578 /****************************************************************************
579 Shutdown a client structure.
580 ****************************************************************************/
582 void cli_shutdown(struct cli_state *cli)
584 cli_nt_pipes_close(cli);
587 * tell our peer to free his resources. Wihtout this, when an
588 * application attempts to do a graceful shutdown and calls
589 * smbc_free_context() to clean up all connections, some connections
590 * can remain active on the peer end, until some (long) timeout period
591 * later. This tree disconnect forces the peer to clean up, since the
592 * connection will be going away.
594 * Also, do not do tree disconnect when cli->smb_rw_error is DO_NOT_DO_TDIS
595 * the only user for this so far is smbmount which passes opened connection
596 * down to kernel's smbfs module.
598 if ( (cli->cnum != (uint16)-1) && (cli->smb_rw_error != DO_NOT_DO_TDIS ) ) {
602 SAFE_FREE(cli->outbuf);
603 SAFE_FREE(cli->inbuf);
605 cli_free_signing_context(cli);
606 cli_free_encryption_context(cli);
608 data_blob_free(&cli->secblob);
609 data_blob_free(&cli->user_session_key);
612 talloc_destroy(cli->mem_ctx);
620 cli->smb_rw_error = 0;
625 /****************************************************************************
626 Set socket options on a open connection.
627 ****************************************************************************/
629 void cli_sockopt(struct cli_state *cli, const char *options)
631 set_socket_options(cli->fd, options);
634 /****************************************************************************
635 Set the PID to use for smb messages. Return the old pid.
636 ****************************************************************************/
638 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
640 uint16 ret = cli->pid;
645 /****************************************************************************
646 Set the case sensitivity flag on the packets. Returns old state.
647 ****************************************************************************/
649 BOOL cli_set_case_sensitive(struct cli_state *cli, BOOL case_sensitive)
651 BOOL ret = cli->case_sensitive;
652 cli->case_sensitive = case_sensitive;
656 /****************************************************************************
657 Send a keepalive packet to the server
658 ****************************************************************************/
660 BOOL cli_send_keepalive(struct cli_state *cli)
663 DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
666 if (!send_keepalive(cli->fd)) {
669 DEBUG(0,("Error sending keepalive packet to client.\n"));
675 /****************************************************************************
676 Send/receive a SMBecho command: ping the server
677 ****************************************************************************/
679 BOOL cli_echo(struct cli_state *cli, unsigned char *data, size_t length)
683 SMB_ASSERT(length < 1024);
685 memset(cli->outbuf,'\0',smb_size);
686 set_message(NULL,cli->outbuf,1,length,True);
687 SCVAL(cli->outbuf,smb_com,SMBecho);
688 SSVAL(cli->outbuf,smb_tid,65535);
689 SSVAL(cli->outbuf,smb_vwv0,1);
690 cli_setup_packet(cli);
691 p = smb_buf(cli->outbuf);
692 memcpy(p, data, length);
695 cli_setup_bcc(cli, p);
698 if (!cli_receive_smb(cli)) {
702 if (cli_is_error(cli)) {