r22920: Add in the UNIX capability for 24-bit readX, as discussed
[ira/wip.git] / source3 / libsmb / clientgen.c
1 /* 
2    Unix SMB/CIFS implementation.
3    SMB client generic functions
4    Copyright (C) Andrew Tridgell 1994-1998
5    Copyright (C) Jeremy Allison 2007.
6    
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.
11    
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.
16    
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.
20 */
21
22 #include "includes.h"
23
24 extern int smb_read_error;
25
26 /****************************************************************************
27  Change the timeout (in milliseconds).
28 ****************************************************************************/
29
30 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
31 {
32         unsigned int old_timeout = cli->timeout;
33         cli->timeout = timeout;
34         return old_timeout;
35 }
36
37 /****************************************************************************
38  Change the port number used to call on.
39 ****************************************************************************/
40
41 int cli_set_port(struct cli_state *cli, int port)
42 {
43         cli->port = port;
44         return port;
45 }
46
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
51
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 ****************************************************************************/
57
58 static ssize_t client_receive_smb(struct cli_state *cli, BOOL eat_keepalives, size_t maxlen)
59 {
60         ssize_t len;
61         int fd = cli->fd;
62         char *buffer = cli->inbuf;
63         unsigned int timeout = cli->timeout;
64
65         for(;;) {
66                 len = receive_smb_raw(fd, buffer, timeout, maxlen);
67
68                 if (len < 0) {
69                         DEBUG(10,("client_receive_smb failed\n"));
70                         show_msg(buffer);
71                         return len;
72                 }
73
74                 /* Ignore session keepalive packets. */
75                 if (eat_keepalives && (CVAL(buffer,0) == SMBkeepalive)) {
76                         continue;
77                 }
78                 break;
79         }
80
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",
85                                 nt_errstr(status)));
86                         cli->smb_rw_error = READ_BAD_DECRYPT;
87                         close(cli->fd);
88                         cli->fd = -1;
89                         return -1;
90                 }
91         }
92         show_msg(buffer);
93         return len;
94 }
95
96 /****************************************************************************
97  Recv an smb.
98 ****************************************************************************/
99
100 BOOL cli_receive_smb_internal(struct cli_state *cli, BOOL eat_keepalives)
101 {
102         ssize_t len;
103
104         /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
105         if (cli->fd == -1)
106                 return False; 
107
108  again:
109         len = client_receive_smb(cli, eat_keepalives, 0);
110
111         if (len >= 0 && !eat_keepalives && (CVAL(cli->inbuf,0) == SMBkeepalive)) {
112                 /* Give back the keepalive. */
113                 return True;
114         }
115         
116         if (len > 0) {
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)) {
126                                         return False;
127                                 }
128                         }
129                         /* try to prevent loops */
130                         SCVAL(cli->inbuf,smb_com,0xFF);
131                         goto again;
132                 }
133         }
134
135         /* If the server is not responding, note that now */
136         if (len <= 0) {
137                 DEBUG(0, ("Receiving SMB: Server stopped responding\n"));
138                 cli->smb_rw_error = smb_read_error;
139                 close(cli->fd);
140                 cli->fd = -1;
141                 return False;
142         }
143
144         if (!cli_check_sign_mac(cli)) {
145                 /*
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.
150                  */
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 &&
155                         cli_is_error(cli)) {
156
157                         /*
158                          * Reflected signature on login error. 
159                          * Set bad sig but don't close fd.
160                          */
161                         cli->smb_rw_error = READ_BAD_SIG;
162                         return True;
163                 }
164
165                 DEBUG(0, ("SMB Signature verification failed on incoming packet!\n"));
166                 cli->smb_rw_error = READ_BAD_SIG;
167                 close(cli->fd);
168                 cli->fd = -1;
169                 return False;
170         }
171
172         return True;
173 }
174
175 /****************************************************************************
176  Recv an smb - eat keepalives.
177 ****************************************************************************/
178
179 BOOL cli_receive_smb(struct cli_state *cli)
180 {
181         return cli_receive_smb_internal(cli, True);
182 }
183
184 /****************************************************************************
185  Recv an smb - return keepalives.
186 ****************************************************************************/
187
188 BOOL cli_receive_smb_return_keepalive(struct cli_state *cli)
189 {
190         return cli_receive_smb_internal(cli, False);
191 }
192
193 /****************************************************************************
194  Read the data portion of a readX smb.
195  The timeout is in milliseconds
196 ****************************************************************************/
197
198 ssize_t cli_receive_smb_data(struct cli_state *cli, char *buffer, size_t len)
199 {
200         if (cli->timeout > 0) {
201                 return read_socket_with_timeout(cli->fd, buffer, len, len, cli->timeout);
202         } else {
203                 return read_data(cli->fd, buffer, len);
204         }
205 }
206
207 /****************************************************************************
208  Read a smb readX header.
209  We can only use this if encryption and signing are off.
210 ****************************************************************************/
211
212 BOOL cli_receive_smb_readX_header(struct cli_state *cli)
213 {
214         ssize_t len, offset;
215
216         if (cli->fd == -1)
217                 return False; 
218
219  again:
220
221         /* Read up to the size of a readX header reply. */
222         len = client_receive_smb(cli, True, (smb_size - 4) + 24);
223         
224         if (len > 0) {
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);
231
232                         if (total_len > CLI_SAMBA_MAX_LARGE_READX_SIZE+SAFETY_MARGIN) {
233                                 goto read_err;
234                         }
235
236                         /* Read the rest of the data. */
237                         if (!cli_receive_smb_data(cli,cli->inbuf+len,total_len - len)) {
238                                 goto read_err;
239                         }
240
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;
245                         }
246                         /* try to prevent loops */
247                         SCVAL(cli->inbuf,smb_com,0xFF);
248                         goto again;
249                 }
250         }
251
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)) {
256                 /* 
257                  * We're not coping here with asnyc replies to
258                  * other calls. Punt here - we need async client
259                  * libs for this.
260                  */
261                 goto read_err;
262         }
263
264         /* 
265          * We know it's a readX reply - ensure we've read the
266          * padding bytes also.
267          */
268
269         offset = SVAL(cli->inbuf,smb_vwv6);
270         if (offset > len) {
271                 ssize_t ret;
272                 size_t padbytes = offset - len;
273                 ret = cli_receive_smb_data(cli,smb_buf(cli->inbuf),padbytes);
274                 if (ret != padbytes) {
275                         goto read_err;
276                 }
277         }
278
279         return True;
280
281   read_err:
282
283         cli->smb_rw_error = smb_read_error = READ_ERROR;
284         close(cli->fd);
285         cli->fd = -1;
286         return False;
287 }
288
289 static ssize_t write_socket(int fd, const char *buf, size_t len)
290 {
291         ssize_t ret=0;
292                                                                                                                                             
293         DEBUG(6,("write_socket(%d,%d)\n",fd,(int)len));
294         ret = write_data(fd,buf,len);
295
296         DEBUG(6,("write_socket(%d,%d) wrote %d\n",fd,(int)len,(int)ret));
297         if(ret <= 0)
298                 DEBUG(0,("write_socket: Error writing %d bytes to socket %d: ERRNO = %s\n",
299                         (int)len, fd, strerror(errno) ));
300                                                                                                                                             
301         return(ret);
302 }
303
304 /****************************************************************************
305  Send an smb to a fd.
306 ****************************************************************************/
307
308 BOOL cli_send_smb(struct cli_state *cli)
309 {
310         size_t len;
311         size_t nwritten=0;
312         ssize_t ret;
313         char *buf_out = cli->outbuf;
314         BOOL enc_on = cli_encryption_on(cli);
315
316         /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
317         if (cli->fd == -1) {
318                 return False;
319         }
320
321         cli_calculate_sign_mac(cli);
322
323         if (enc_on) {
324                 NTSTATUS status = cli_encrypt_message(cli, &buf_out);
325                 if (!NT_STATUS_IS_OK(status)) {
326                         close(cli->fd);
327                         cli->fd = -1;
328                         cli->smb_rw_error = WRITE_ERROR;
329                         DEBUG(0,("Error in encrypting client message. Error %s\n",
330                                 nt_errstr(status) ));
331                         return False;
332                 }
333         }
334
335         len = smb_len(buf_out) + 4;
336
337         while (nwritten < len) {
338                 ret = write_socket(cli->fd,buf_out+nwritten,len - nwritten);
339                 if (ret <= 0) {
340                         if (enc_on) {
341                                 cli_free_enc_buffer(cli, buf_out);
342                         }
343                         close(cli->fd);
344                         cli->fd = -1;
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) ));
348                         return False;
349                 }
350                 nwritten += ret;
351         }
352
353         cli_free_enc_buffer(cli, buf_out);
354
355         /* Increment the mid so we can tell between responses. */
356         cli->mid++;
357         if (!cli->mid) {
358                 cli->mid++;
359         }
360         return True;
361 }
362
363 /****************************************************************************
364  Setup basics in a outgoing packet.
365 ****************************************************************************/
366
367 void cli_setup_packet(struct cli_state *cli)
368 {
369         cli->rap_error = 0;
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) {
374                 uint16 flags2;
375                 if (cli->case_sensitive) {
376                         SCVAL(cli->outbuf,smb_flg,0x0);
377                 } else {
378                         /* Default setting, case insensitive. */
379                         SCVAL(cli->outbuf,smb_flg,0x8);
380                 }
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;
388                 if (cli->use_spnego)
389                         flags2 |= FLAGS2_EXTENDED_SECURITY;
390                 SSVAL(cli->outbuf,smb_flg2, flags2);
391         }
392 }
393
394 /****************************************************************************
395  Setup the bcc length of the packet from a pointer to the end of the data.
396 ****************************************************************************/
397
398 void cli_setup_bcc(struct cli_state *cli, void *p)
399 {
400         set_message_bcc(NULL,cli->outbuf, PTR_DIFF(p, smb_buf(cli->outbuf)));
401 }
402
403 /****************************************************************************
404  Initialise credentials of a client structure.
405 ****************************************************************************/
406
407 void cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
408 {
409         fstrcpy(cli->domain, domain);
410         fstrcpy(cli->user_name, username);
411         pwd_set_cleartext(&cli->pwd, password);
412         if (!*username) {
413                 cli->pwd.null_pwd = True;
414         }
415
416         DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
417 }
418
419 /****************************************************************************
420  Set the signing state (used from the command line).
421 ****************************************************************************/
422
423 void cli_setup_signing_state(struct cli_state *cli, int signing_state)
424 {
425         if (signing_state == Undefined)
426                 return;
427
428         if (signing_state == False) {
429                 cli->sign_info.allow_smb_signing = False;
430                 cli->sign_info.mandatory_signing = False;
431                 return;
432         }
433
434         cli->sign_info.allow_smb_signing = True;
435
436         if (signing_state == Required) 
437                 cli->sign_info.mandatory_signing = True;
438 }
439
440 /****************************************************************************
441  Initialise a client structure. Always returns a malloc'ed struct.
442 ****************************************************************************/
443
444 struct cli_state *cli_initialise(void)
445 {
446         struct cli_state *cli = NULL;
447
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"));
451                 return NULL;
452         }
453
454         cli = SMB_MALLOC_P(struct cli_state);
455         if (!cli) {
456                 return NULL;
457         }
458
459         ZERO_STRUCTP(cli);
460
461         cli->port = 0;
462         cli->fd = -1;
463         cli->cnum = -1;
464         cli->pid = (uint16)sys_getpid();
465         cli->mid = 1;
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;
476
477         cli->use_spnego = lp_client_use_spnego();
478
479         cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
480
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;
486
487         if (lp_client_signing()) 
488                 cli->sign_info.allow_smb_signing = True;
489
490         if (lp_client_signing() == Required) 
491                 cli->sign_info.mandatory_signing = True;
492                                    
493         if (!cli->outbuf || !cli->inbuf)
494                 goto error;
495
496         if ((cli->mem_ctx = talloc_init("cli based talloc")) == NULL)
497                 goto error;
498
499         memset(cli->outbuf, 0, cli->bufsize);
500         memset(cli->inbuf, 0, cli->bufsize);
501
502
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);
507 #endif
508
509         /* initialise signing */
510         cli_null_set_signing(cli);
511
512         cli->initialised = 1;
513
514         return cli;
515
516         /* Clean up after malloc() error */
517
518  error:
519
520         SAFE_FREE(cli->inbuf);
521         SAFE_FREE(cli->outbuf);
522         SAFE_FREE(cli);
523         return NULL;
524 }
525
526 /****************************************************************************
527  External interface.
528  Close an open named pipe over SMB. Free any authentication data.
529  Returns False if the cli_close call failed.
530  ****************************************************************************/
531
532 BOOL cli_rpc_pipe_close(struct rpc_pipe_client *cli)
533 {
534         BOOL ret;
535
536         if (!cli) {
537                 return False;
538         }
539
540         ret = cli_close(cli->cli, cli->fnum);
541
542         if (!ret) {
543                 DEBUG(1,("cli_rpc_pipe_close: cli_close failed on pipe %s, "
544                          "fnum 0x%x "
545                          "to machine %s.  Error was %s\n",
546                          cli->pipe_name,
547                          (int) cli->fnum,
548                          cli->cli->desthost,
549                          cli_errstr(cli->cli)));
550         }
551
552         if (cli->auth.cli_auth_data_free_func) {
553                 (*cli->auth.cli_auth_data_free_func)(&cli->auth);
554         }
555
556         DEBUG(10,("cli_rpc_pipe_close: closed pipe %s to machine %s\n",
557                 cli->pipe_name, cli->cli->desthost ));
558
559         DLIST_REMOVE(cli->cli->pipe_list, cli);
560         talloc_destroy(cli->mem_ctx);
561         return ret;
562 }
563
564 /****************************************************************************
565  Close all pipes open on this session.
566 ****************************************************************************/
567
568 void cli_nt_pipes_close(struct cli_state *cli)
569 {
570         struct rpc_pipe_client *cp, *next;
571
572         for (cp = cli->pipe_list; cp; cp = next) {
573                 next = cp->next;
574                 cli_rpc_pipe_close(cp);
575         }
576 }
577
578 /****************************************************************************
579  Shutdown a client structure.
580 ****************************************************************************/
581
582 void cli_shutdown(struct cli_state *cli)
583 {
584         cli_nt_pipes_close(cli);
585
586         /*
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.
593          *
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.
597          */
598         if ( (cli->cnum != (uint16)-1) && (cli->smb_rw_error != DO_NOT_DO_TDIS ) ) {
599                 cli_tdis(cli);
600         }
601         
602         SAFE_FREE(cli->outbuf);
603         SAFE_FREE(cli->inbuf);
604
605         cli_free_signing_context(cli);
606         cli_free_encryption_context(cli);
607
608         data_blob_free(&cli->secblob);
609         data_blob_free(&cli->user_session_key);
610
611         if (cli->mem_ctx) {
612                 talloc_destroy(cli->mem_ctx);
613                 cli->mem_ctx = NULL;
614         }
615
616         if (cli->fd != -1) {
617                 close(cli->fd);
618         }
619         cli->fd = -1;
620         cli->smb_rw_error = 0;
621
622         SAFE_FREE(cli);
623 }
624
625 /****************************************************************************
626  Set socket options on a open connection.
627 ****************************************************************************/
628
629 void cli_sockopt(struct cli_state *cli, const char *options)
630 {
631         set_socket_options(cli->fd, options);
632 }
633
634 /****************************************************************************
635  Set the PID to use for smb messages. Return the old pid.
636 ****************************************************************************/
637
638 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
639 {
640         uint16 ret = cli->pid;
641         cli->pid = pid;
642         return ret;
643 }
644
645 /****************************************************************************
646  Set the case sensitivity flag on the packets. Returns old state.
647 ****************************************************************************/
648
649 BOOL cli_set_case_sensitive(struct cli_state *cli, BOOL case_sensitive)
650 {
651         BOOL ret = cli->case_sensitive;
652         cli->case_sensitive = case_sensitive;
653         return ret;
654 }
655
656 /****************************************************************************
657 Send a keepalive packet to the server
658 ****************************************************************************/
659
660 BOOL cli_send_keepalive(struct cli_state *cli)
661 {
662         if (cli->fd == -1) {
663                 DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
664                 return False;
665         }
666         if (!send_keepalive(cli->fd)) {
667                 close(cli->fd);
668                 cli->fd = -1;
669                 DEBUG(0,("Error sending keepalive packet to client.\n"));
670                 return False;
671         }
672         return True;
673 }
674
675 /****************************************************************************
676  Send/receive a SMBecho command: ping the server
677 ****************************************************************************/
678
679 BOOL cli_echo(struct cli_state *cli, unsigned char *data, size_t length)
680 {
681         char *p;
682
683         SMB_ASSERT(length < 1024);
684
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);
693         p += length;
694
695         cli_setup_bcc(cli, p);
696
697         cli_send_smb(cli);
698         if (!cli_receive_smb(cli)) {
699                 return False;
700         }
701
702         if (cli_is_error(cli)) {
703                 return False;
704         }
705         return True;
706 }