Simplify async programming a bit with helper routines
[kai/samba.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 3 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, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include "includes.h"
22
23 /*******************************************************************
24  Setup the word count and byte count for a client smb message.
25 ********************************************************************/
26
27 int cli_set_message(char *buf,int num_words,int num_bytes,bool zero)
28 {
29         if (zero && (num_words || num_bytes)) {
30                 memset(buf + smb_size,'\0',num_words*2 + num_bytes);
31         }
32         SCVAL(buf,smb_wct,num_words);
33         SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
34         smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
35         return (smb_size + num_words*2 + num_bytes);
36 }
37
38 /****************************************************************************
39  Change the timeout (in milliseconds).
40 ****************************************************************************/
41
42 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
43 {
44         unsigned int old_timeout = cli->timeout;
45         cli->timeout = timeout;
46         return old_timeout;
47 }
48
49 /****************************************************************************
50  Change the port number used to call on.
51 ****************************************************************************/
52
53 int cli_set_port(struct cli_state *cli, int port)
54 {
55         cli->port = port;
56         return port;
57 }
58
59 /****************************************************************************
60  Read an smb from a fd ignoring all keepalive packets.
61  The timeout is in milliseconds
62
63  This is exactly the same as receive_smb except that it never returns
64  a session keepalive packet (just as receive_smb used to do).
65  receive_smb was changed to return keepalives as the oplock processing means this call
66  should never go into a blocking read.
67 ****************************************************************************/
68
69 static ssize_t client_receive_smb(struct cli_state *cli, size_t maxlen)
70 {
71         size_t len;
72
73         for(;;) {
74                 NTSTATUS status;
75
76                 set_smb_read_error(&cli->smb_rw_error, SMB_READ_OK);
77
78                 status = receive_smb_raw(cli->fd, cli->inbuf, cli->bufsize,
79                                         cli->timeout, maxlen, &len);
80                 if (!NT_STATUS_IS_OK(status)) {
81                         DEBUG(10,("client_receive_smb failed\n"));
82                         show_msg(cli->inbuf);
83
84                         if (NT_STATUS_EQUAL(status, NT_STATUS_END_OF_FILE)) {
85                                 set_smb_read_error(&cli->smb_rw_error,
86                                                    SMB_READ_EOF);
87                                 return -1;
88                         }
89
90                         if (NT_STATUS_EQUAL(status, NT_STATUS_IO_TIMEOUT)) {
91                                 set_smb_read_error(&cli->smb_rw_error,
92                                                    SMB_READ_TIMEOUT);
93                                 return -1;
94                         }
95
96                         set_smb_read_error(&cli->smb_rw_error, SMB_READ_ERROR);
97                         return -1;
98                 }
99
100                 /*
101                  * I don't believe len can be < 0 with NT_STATUS_OK
102                  * returned above, but this check doesn't hurt. JRA.
103                  */
104
105                 if ((ssize_t)len < 0) {
106                         return len;
107                 }
108
109                 /* Ignore session keepalive packets. */
110                 if(CVAL(cli->inbuf,0) != SMBkeepalive) {
111                         break;
112                 }
113         }
114
115         if (cli_encryption_on(cli)) {
116                 NTSTATUS status = cli_decrypt_message(cli);
117                 if (!NT_STATUS_IS_OK(status)) {
118                         DEBUG(0, ("SMB decryption failed on incoming packet! Error %s\n",
119                                 nt_errstr(status)));
120                         cli->smb_rw_error = SMB_READ_BAD_DECRYPT;
121                         return -1;
122                 }
123         }
124
125         show_msg(cli->inbuf);
126         return len;
127 }
128
129 /****************************************************************************
130  Recv an smb.
131 ****************************************************************************/
132
133 bool cli_receive_smb(struct cli_state *cli)
134 {
135         ssize_t len;
136
137         /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
138         if (cli->fd == -1)
139                 return false; 
140
141  again:
142         len = client_receive_smb(cli, 0);
143         
144         if (len > 0) {
145                 /* it might be an oplock break request */
146                 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) &&
147                     CVAL(cli->inbuf,smb_com) == SMBlockingX &&
148                     SVAL(cli->inbuf,smb_vwv6) == 0 &&
149                     SVAL(cli->inbuf,smb_vwv7) == 0) {
150                         if (cli->oplock_handler) {
151                                 int fnum = SVAL(cli->inbuf,smb_vwv2);
152                                 unsigned char level = CVAL(cli->inbuf,smb_vwv3+1);
153                                 if (!cli->oplock_handler(cli, fnum, level)) {
154                                         return false;
155                                 }
156                         }
157                         /* try to prevent loops */
158                         SCVAL(cli->inbuf,smb_com,0xFF);
159                         goto again;
160                 }
161         }
162
163         /* If the server is not responding, note that now */
164         if (len < 0) {
165                 DEBUG(0, ("Receiving SMB: Server stopped responding\n"));
166                 close(cli->fd);
167                 cli->fd = -1;
168                 return false;
169         }
170
171         if (!cli_check_sign_mac(cli, cli->inbuf)) {
172                 /*
173                  * If we get a signature failure in sessionsetup, then
174                  * the server sometimes just reflects the sent signature
175                  * back to us. Detect this and allow the upper layer to
176                  * retrieve the correct Windows error message.
177                  */
178                 if (CVAL(cli->outbuf,smb_com) == SMBsesssetupX &&
179                         (smb_len(cli->inbuf) > (smb_ss_field + 8 - 4)) &&
180                         (SVAL(cli->inbuf,smb_flg2) & FLAGS2_SMB_SECURITY_SIGNATURES) &&
181                         memcmp(&cli->outbuf[smb_ss_field],&cli->inbuf[smb_ss_field],8) == 0 &&
182                         cli_is_error(cli)) {
183
184                         /*
185                          * Reflected signature on login error. 
186                          * Set bad sig but don't close fd.
187                          */
188                         cli->smb_rw_error = SMB_READ_BAD_SIG;
189                         return true;
190                 }
191
192                 DEBUG(0, ("SMB Signature verification failed on incoming packet!\n"));
193                 cli->smb_rw_error = SMB_READ_BAD_SIG;
194                 close(cli->fd);
195                 cli->fd = -1;
196                 return false;
197         };
198         return true;
199 }
200
201 /****************************************************************************
202  Read the data portion of a readX smb.
203  The timeout is in milliseconds
204 ****************************************************************************/
205
206 ssize_t cli_receive_smb_data(struct cli_state *cli, char *buffer, size_t len)
207 {
208         NTSTATUS status;
209
210         set_smb_read_error(&cli->smb_rw_error, SMB_READ_OK);
211
212         status = read_socket_with_timeout(
213                 cli->fd, buffer, len, len, cli->timeout, NULL);
214         if (NT_STATUS_IS_OK(status)) {
215                 return len;
216         }
217
218         if (NT_STATUS_EQUAL(status, NT_STATUS_END_OF_FILE)) {
219                 set_smb_read_error(&cli->smb_rw_error, SMB_READ_EOF);
220                 return -1;
221         }
222
223         if (NT_STATUS_EQUAL(status, NT_STATUS_IO_TIMEOUT)) {
224                 set_smb_read_error(&cli->smb_rw_error, SMB_READ_TIMEOUT);
225                 return -1;
226         }
227
228         set_smb_read_error(&cli->smb_rw_error, SMB_READ_ERROR);
229         return -1;
230 }
231
232 static ssize_t write_socket(int fd, const char *buf, size_t len)
233 {
234         ssize_t ret=0;
235
236         DEBUG(6,("write_socket(%d,%d)\n",fd,(int)len));
237         ret = write_data(fd,buf,len);
238
239         DEBUG(6,("write_socket(%d,%d) wrote %d\n",fd,(int)len,(int)ret));
240         if(ret <= 0)
241                 DEBUG(0,("write_socket: Error writing %d bytes to socket %d: ERRNO = %s\n",
242                         (int)len, fd, strerror(errno) ));
243
244         return(ret);
245 }
246
247 /****************************************************************************
248  Send an smb to a fd.
249 ****************************************************************************/
250
251 bool cli_send_smb(struct cli_state *cli)
252 {
253         size_t len;
254         size_t nwritten=0;
255         ssize_t ret;
256         char *buf_out = cli->outbuf;
257         bool enc_on = cli_encryption_on(cli);
258
259         /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
260         if (cli->fd == -1)
261                 return false;
262
263         cli_calculate_sign_mac(cli, cli->outbuf);
264
265         if (enc_on) {
266                 NTSTATUS status = cli_encrypt_message(cli, cli->outbuf,
267                                                       &buf_out);
268                 if (!NT_STATUS_IS_OK(status)) {
269                         close(cli->fd);
270                         cli->fd = -1;
271                         cli->smb_rw_error = SMB_WRITE_ERROR;
272                         DEBUG(0,("Error in encrypting client message. Error %s\n",
273                                 nt_errstr(status) ));
274                         return false;
275                 }
276         }
277
278         len = smb_len(buf_out) + 4;
279
280         while (nwritten < len) {
281                 ret = write_socket(cli->fd,buf_out+nwritten,len - nwritten);
282                 if (ret <= 0) {
283                         if (enc_on) {
284                                 cli_free_enc_buffer(cli, buf_out);
285                         }
286                         close(cli->fd);
287                         cli->fd = -1;
288                         cli->smb_rw_error = SMB_WRITE_ERROR;
289                         DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
290                                 (int)len,(int)ret, strerror(errno) ));
291                         return false;
292                 }
293                 nwritten += ret;
294         }
295
296         if (enc_on) {
297                 cli_free_enc_buffer(cli, buf_out);
298         }
299
300         /* Increment the mid so we can tell between responses. */
301         cli->mid++;
302         if (!cli->mid)
303                 cli->mid++;
304         return true;
305 }
306
307 /****************************************************************************
308  Send a "direct" writeX smb to a fd.
309 ****************************************************************************/
310
311 bool cli_send_smb_direct_writeX(struct cli_state *cli,
312                                 const char *p,
313                                 size_t extradata)
314 {
315         /* First length to send is the offset to the data. */
316         size_t len = SVAL(cli->outbuf,smb_vwv11) + 4;
317         size_t nwritten=0;
318         ssize_t ret;
319
320         /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
321         if (cli->fd == -1) {
322                 return false;
323         }
324
325         if (client_is_signing_on(cli)) {
326                 DEBUG(0,("cli_send_smb_large: cannot send signed packet.\n"));
327                 return false;
328         }
329
330         while (nwritten < len) {
331                 ret = write_socket(cli->fd,cli->outbuf+nwritten,len - nwritten);
332                 if (ret <= 0) {
333                         close(cli->fd);
334                         cli->fd = -1;
335                         cli->smb_rw_error = SMB_WRITE_ERROR;
336                         DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
337                                 (int)len,(int)ret, strerror(errno) ));
338                         return false;
339                 }
340                 nwritten += ret;
341         }
342
343         /* Now write the extra data. */
344         nwritten=0;
345         while (nwritten < extradata) {
346                 ret = write_socket(cli->fd,p+nwritten,extradata - nwritten);
347                 if (ret <= 0) {
348                         close(cli->fd);
349                         cli->fd = -1;
350                         cli->smb_rw_error = SMB_WRITE_ERROR;
351                         DEBUG(0,("Error writing %d extradata "
352                                 "bytes to client. %d (%s)\n",
353                                 (int)extradata,(int)ret, strerror(errno) ));
354                         return false;
355                 }
356                 nwritten += ret;
357         }
358
359         /* Increment the mid so we can tell between responses. */
360         cli->mid++;
361         if (!cli->mid)
362                 cli->mid++;
363         return true;
364 }
365
366 /****************************************************************************
367  Setup basics in a outgoing packet.
368 ****************************************************************************/
369
370 void cli_setup_packet_buf(struct cli_state *cli, char *buf)
371 {
372         uint16 flags2;
373         cli->rap_error = 0;
374         SIVAL(buf,smb_rcls,0);
375         SSVAL(buf,smb_pid,cli->pid);
376         memset(buf+smb_pidhigh, 0, 12);
377         SSVAL(buf,smb_uid,cli->vuid);
378         SSVAL(buf,smb_mid,cli->mid);
379
380         if (cli->protocol <= PROTOCOL_CORE) {
381                 return;
382         }
383
384         if (cli->case_sensitive) {
385                 SCVAL(buf,smb_flg,0x0);
386         } else {
387                 /* Default setting, case insensitive. */
388                 SCVAL(buf,smb_flg,0x8);
389         }
390         flags2 = FLAGS2_LONG_PATH_COMPONENTS;
391         if (cli->capabilities & CAP_UNICODE)
392                 flags2 |= FLAGS2_UNICODE_STRINGS;
393         if ((cli->capabilities & CAP_DFS) && cli->dfsroot)
394                 flags2 |= FLAGS2_DFS_PATHNAMES;
395         if (cli->capabilities & CAP_STATUS32)
396                 flags2 |= FLAGS2_32_BIT_ERROR_CODES;
397         if (cli->use_spnego)
398                 flags2 |= FLAGS2_EXTENDED_SECURITY;
399         SSVAL(buf,smb_flg2, flags2);
400 }
401
402 void cli_setup_packet(struct cli_state *cli)
403 {
404         cli_setup_packet_buf(cli, cli->outbuf);
405 }
406
407 /****************************************************************************
408  Setup the bcc length of the packet from a pointer to the end of the data.
409 ****************************************************************************/
410
411 void cli_setup_bcc(struct cli_state *cli, void *p)
412 {
413         set_message_bcc(cli->outbuf, PTR_DIFF(p, smb_buf(cli->outbuf)));
414 }
415
416 /****************************************************************************
417  Initialise credentials of a client structure.
418 ****************************************************************************/
419
420 void cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
421 {
422         fstrcpy(cli->domain, domain);
423         fstrcpy(cli->user_name, username);
424         pwd_set_cleartext(&cli->pwd, password);
425         if (!*username) {
426                 cli->pwd.null_pwd = true;
427         }
428
429         DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
430 }
431
432 /****************************************************************************
433  Set the signing state (used from the command line).
434 ****************************************************************************/
435
436 void cli_setup_signing_state(struct cli_state *cli, int signing_state)
437 {
438         if (signing_state == Undefined)
439                 return;
440
441         if (signing_state == false) {
442                 cli->sign_info.allow_smb_signing = false;
443                 cli->sign_info.mandatory_signing = false;
444                 return;
445         }
446
447         cli->sign_info.allow_smb_signing = true;
448
449         if (signing_state == Required) 
450                 cli->sign_info.mandatory_signing = true;
451 }
452
453 /****************************************************************************
454  Initialise a client structure. Always returns a malloc'ed struct.
455 ****************************************************************************/
456
457 struct cli_state *cli_initialise(void)
458 {
459         struct cli_state *cli = NULL;
460
461         /* Check the effective uid - make sure we are not setuid */
462         if (is_setuid_root()) {
463                 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
464                 return NULL;
465         }
466
467         cli = TALLOC_ZERO_P(NULL, struct cli_state);
468         if (!cli) {
469                 return NULL;
470         }
471
472         cli->port = 0;
473         cli->fd = -1;
474         cli->cnum = -1;
475         cli->pid = (uint16)sys_getpid();
476         cli->mid = 1;
477         cli->vuid = UID_FIELD_INVALID;
478         cli->protocol = PROTOCOL_NT1;
479         cli->timeout = 20000; /* Timeout is in milliseconds. */
480         cli->bufsize = CLI_BUFFER_SIZE+4;
481         cli->max_xmit = cli->bufsize;
482         cli->outbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
483         cli->inbuf = (char *)SMB_MALLOC(cli->bufsize+SAFETY_MARGIN);
484         cli->oplock_handler = cli_oplock_ack;
485         cli->case_sensitive = false;
486         cli->smb_rw_error = SMB_READ_OK;
487
488         cli->use_spnego = lp_client_use_spnego();
489
490         cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
491
492         /* Set the CLI_FORCE_DOSERR environment variable to test
493            client routines using DOS errors instead of STATUS32
494            ones.  This intended only as a temporary hack. */    
495         if (getenv("CLI_FORCE_DOSERR"))
496                 cli->force_dos_errors = true;
497
498         if (lp_client_signing()) 
499                 cli->sign_info.allow_smb_signing = true;
500
501         if (lp_client_signing() == Required) 
502                 cli->sign_info.mandatory_signing = true;
503                                    
504         if (!cli->outbuf || !cli->inbuf)
505                 goto error;
506
507         memset(cli->outbuf, 0, cli->bufsize);
508         memset(cli->inbuf, 0, cli->bufsize);
509
510
511 #if defined(DEVELOPER)
512         /* just because we over-allocate, doesn't mean it's right to use it */
513         clobber_region(FUNCTION_MACRO, __LINE__, cli->outbuf+cli->bufsize, SAFETY_MARGIN);
514         clobber_region(FUNCTION_MACRO, __LINE__, cli->inbuf+cli->bufsize, SAFETY_MARGIN);
515 #endif
516
517         /* initialise signing */
518         cli_null_set_signing(cli);
519
520         cli->initialised = 1;
521
522         return cli;
523
524         /* Clean up after malloc() error */
525
526  error:
527
528         SAFE_FREE(cli->inbuf);
529         SAFE_FREE(cli->outbuf);
530         SAFE_FREE(cli);
531         return NULL;
532 }
533
534 /****************************************************************************
535  Close all pipes open on this session.
536 ****************************************************************************/
537
538 void cli_nt_pipes_close(struct cli_state *cli)
539 {
540         while (cli->pipe_list != NULL) {
541                 /*
542                  * No TALLOC_FREE here!
543                  */
544                 talloc_free(cli->pipe_list);
545         }
546 }
547
548 /****************************************************************************
549  Shutdown a client structure.
550 ****************************************************************************/
551
552 void cli_shutdown(struct cli_state *cli)
553 {
554         cli_nt_pipes_close(cli);
555
556         /*
557          * tell our peer to free his resources.  Wihtout this, when an
558          * application attempts to do a graceful shutdown and calls
559          * smbc_free_context() to clean up all connections, some connections
560          * can remain active on the peer end, until some (long) timeout period
561          * later.  This tree disconnect forces the peer to clean up, since the
562          * connection will be going away.
563          *
564          * Also, do not do tree disconnect when cli->smb_rw_error is SMB_DO_NOT_DO_TDIS
565          * the only user for this so far is smbmount which passes opened connection
566          * down to kernel's smbfs module.
567          */
568         if ( (cli->cnum != (uint16)-1) && (cli->smb_rw_error != SMB_DO_NOT_DO_TDIS ) ) {
569                 cli_tdis(cli);
570         }
571         
572         SAFE_FREE(cli->outbuf);
573         SAFE_FREE(cli->inbuf);
574
575         cli_free_signing_context(cli);
576         data_blob_free(&cli->secblob);
577         data_blob_free(&cli->user_session_key);
578
579         if (cli->fd != -1) {
580                 close(cli->fd);
581         }
582         cli->fd = -1;
583         cli->smb_rw_error = SMB_READ_OK;
584
585         TALLOC_FREE(cli);
586 }
587
588 /****************************************************************************
589  Set socket options on a open connection.
590 ****************************************************************************/
591
592 void cli_sockopt(struct cli_state *cli, const char *options)
593 {
594         set_socket_options(cli->fd, options);
595 }
596
597 /****************************************************************************
598  Set the PID to use for smb messages. Return the old pid.
599 ****************************************************************************/
600
601 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
602 {
603         uint16 ret = cli->pid;
604         cli->pid = pid;
605         return ret;
606 }
607
608 /****************************************************************************
609  Set the case sensitivity flag on the packets. Returns old state.
610 ****************************************************************************/
611
612 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
613 {
614         bool ret = cli->case_sensitive;
615         cli->case_sensitive = case_sensitive;
616         return ret;
617 }
618
619 /****************************************************************************
620 Send a keepalive packet to the server
621 ****************************************************************************/
622
623 bool cli_send_keepalive(struct cli_state *cli)
624 {
625         if (cli->fd == -1) {
626                 DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
627                 return false;
628         }
629         if (!send_keepalive(cli->fd)) {
630                 close(cli->fd);
631                 cli->fd = -1;
632                 DEBUG(0,("Error sending keepalive packet to client.\n"));
633                 return false;
634         }
635         return true;
636 }
637
638 /**
639  * @brief: Collect a echo reply
640  * @param[in] req       The corresponding async request
641  *
642  * There might be more than one echo reply. This helper pulls the reply out of
643  * the data stream. If all expected replies have arrived, declare the
644  * async_req done.
645  */
646
647 static void cli_echo_recv_helper(struct async_req *req)
648 {
649         struct cli_request *cli_req;
650         uint8_t wct;
651         uint16_t *vwv;
652         uint16_t num_bytes;
653         uint8_t *bytes;
654         NTSTATUS status;
655
656         status = cli_pull_reply(req, &wct, &vwv, &num_bytes, &bytes);
657         if (!NT_STATUS_IS_OK(status)) {
658                 async_req_error(req, status);
659                 return;
660         }
661
662         cli_req = talloc_get_type_abort(req->private_data, struct cli_request);
663
664         if ((num_bytes != cli_req->data.echo.data.length)
665             || (memcmp(cli_req->data.echo.data.data, bytes,
666                        num_bytes) != 0)) {
667                 async_req_error(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
668                 return;
669         }
670
671         cli_req->data.echo.num_echos -= 1;
672
673         if (cli_req->data.echo.num_echos == 0) {
674                 client_set_trans_sign_state_off(cli_req->cli, cli_req->mid);
675                 async_req_done(req);
676                 return;
677         }
678
679         return;
680 }
681
682 /**
683  * @brief Send SMBEcho requests
684  * @param[in] mem_ctx   The memory context to put the async_req on
685  * @param[in] ev        The event context that will call us back
686  * @param[in] cli       The connection to send the echo to
687  * @param[in] num_echos How many times do we want to get the reply?
688  * @param[in] data      The data we want to get back
689  * @retval The async request
690  */
691
692 struct async_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
693                                 struct cli_state *cli, uint16_t num_echos,
694                                 DATA_BLOB data)
695 {
696         uint16_t vwv[1];
697         uint8_t *data_copy;
698         struct async_req *result;
699         struct cli_request *req;
700
701         SSVAL(vwv, 0, num_echos);
702
703         data_copy = (uint8_t *)talloc_memdup(mem_ctx, data.data, data.length);
704         if (data_copy == NULL) {
705                 return NULL;
706         }
707
708         result = cli_request_send(mem_ctx, ev, cli, SMBecho, 0, 1, vwv,
709                                   data.length, data.data);
710         if (result == NULL) {
711                 TALLOC_FREE(data_copy);
712                 return NULL;
713         }
714         req = talloc_get_type_abort(result->private_data, struct cli_request);
715
716         client_set_trans_sign_state_on(cli, req->mid);
717
718         req->data.echo.num_echos = num_echos;
719         req->data.echo.data.data = talloc_move(req, &data_copy);
720         req->data.echo.data.length = data.length;
721
722         req->recv_helper.fn = cli_echo_recv_helper;
723
724         return result;
725 }
726
727 /**
728  * Get the result out from an echo request
729  * @param[in] req       The async_req from cli_echo_send
730  * @retval Did the server reply correctly?
731  */
732
733 NTSTATUS cli_echo_recv(struct async_req *req)
734 {
735         return async_req_simple_recv(req);
736 }
737
738 /**
739  * @brief Send/Receive SMBEcho requests
740  * @param[in] mem_ctx   The memory context to put the async_req on
741  * @param[in] ev        The event context that will call us back
742  * @param[in] cli       The connection to send the echo to
743  * @param[in] num_echos How many times do we want to get the reply?
744  * @param[in] data      The data we want to get back
745  * @retval Did the server reply correctly?
746  */
747
748 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
749 {
750         TALLOC_CTX *frame = talloc_stackframe();
751         struct event_context *ev;
752         struct async_req *req;
753         NTSTATUS status = NT_STATUS_NO_MEMORY;
754
755         if (cli->fd_event != NULL) {
756                 /*
757                  * Can't use sync call while an async call is in flight
758                  */
759                 cli_set_error(cli, NT_STATUS_INVALID_PARAMETER);
760                 goto fail;
761         }
762
763         ev = event_context_init(frame);
764         if (ev == NULL) {
765                 goto fail;
766         }
767
768         req = cli_echo_send(frame, ev, cli, num_echos, data);
769         if (req == NULL) {
770                 goto fail;
771         }
772
773         while (req->state < ASYNC_REQ_DONE) {
774                 event_loop_once(ev);
775         }
776
777         status = cli_echo_recv(req);
778
779  fail:
780         TALLOC_FREE(frame);
781         return status;
782 }