s3:libsmb: add cli_state_server_session_key()
[mat/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 #include "libsmb/libsmb.h"
23 #include "../lib/util/tevent_ntstatus.h"
24 #include "smb_signing.h"
25 #include "async_smb.h"
26
27 /*******************************************************************
28  Setup the word count and byte count for a client smb message.
29 ********************************************************************/
30
31 int cli_set_message(char *buf,int num_words,int num_bytes,bool zero)
32 {
33         if (zero && (num_words || num_bytes)) {
34                 memset(buf + smb_size,'\0',num_words*2 + num_bytes);
35         }
36         SCVAL(buf,smb_wct,num_words);
37         SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
38         smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
39         return (smb_size + num_words*2 + num_bytes);
40 }
41
42 /****************************************************************************
43  Change the timeout (in milliseconds).
44 ****************************************************************************/
45
46 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
47 {
48         unsigned int old_timeout = cli->timeout;
49         cli->timeout = timeout;
50         return old_timeout;
51 }
52
53 /****************************************************************************
54  convenience routine to find if we negotiated ucs2
55 ****************************************************************************/
56
57 bool cli_ucs2(struct cli_state *cli)
58 {
59         return ((cli_state_capabilities(cli) & CAP_UNICODE) != 0);
60 }
61
62 /****************************************************************************
63  Setup basics in a outgoing packet.
64 ****************************************************************************/
65
66 void cli_setup_packet_buf(struct cli_state *cli, char *buf)
67 {
68         uint16 flags2;
69         cli->rap_error = 0;
70         SIVAL(buf,smb_rcls,0);
71         SSVAL(buf,smb_pid,cli->smb1.pid);
72         memset(buf+smb_pidhigh, 0, 12);
73         SSVAL(buf,smb_uid, cli_state_get_uid(cli));
74         SSVAL(buf,smb_mid, 0);
75
76         if (cli_state_protocol(cli) <= PROTOCOL_CORE) {
77                 return;
78         }
79
80         if (cli->case_sensitive) {
81                 SCVAL(buf,smb_flg,0x0);
82         } else {
83                 /* Default setting, case insensitive. */
84                 SCVAL(buf,smb_flg,0x8);
85         }
86         flags2 = FLAGS2_LONG_PATH_COMPONENTS;
87         if (cli_state_capabilities(cli) & CAP_UNICODE)
88                 flags2 |= FLAGS2_UNICODE_STRINGS;
89         if ((cli_state_capabilities(cli) & CAP_DFS) && cli->dfsroot)
90                 flags2 |= FLAGS2_DFS_PATHNAMES;
91         if (cli_state_capabilities(cli) & CAP_STATUS32)
92                 flags2 |= FLAGS2_32_BIT_ERROR_CODES;
93         if (cli->use_spnego)
94                 flags2 |= FLAGS2_EXTENDED_SECURITY;
95         SSVAL(buf,smb_flg2, flags2);
96 }
97
98 /****************************************************************************
99  Initialize Domain, user or password.
100 ****************************************************************************/
101
102 NTSTATUS cli_set_domain(struct cli_state *cli, const char *domain)
103 {
104         TALLOC_FREE(cli->domain);
105         cli->domain = talloc_strdup(cli, domain ? domain : "");
106         if (cli->domain == NULL) {
107                 return NT_STATUS_NO_MEMORY;
108         }
109         return NT_STATUS_OK;
110 }
111
112 NTSTATUS cli_set_username(struct cli_state *cli, const char *username)
113 {
114         TALLOC_FREE(cli->user_name);
115         cli->user_name = talloc_strdup(cli, username ? username : "");
116         if (cli->user_name == NULL) {
117                 return NT_STATUS_NO_MEMORY;
118         }
119         return NT_STATUS_OK;
120 }
121
122 NTSTATUS cli_set_password(struct cli_state *cli, const char *password)
123 {
124         TALLOC_FREE(cli->password);
125
126         /* Password can be NULL. */
127         if (password) {
128                 cli->password = talloc_strdup(cli, password);
129                 if (cli->password == NULL) {
130                         return NT_STATUS_NO_MEMORY;
131                 }
132         } else {
133                 /* Use zero NTLMSSP hashes and session key. */
134                 cli->password = NULL;
135         }
136
137         return NT_STATUS_OK;
138 }
139
140 /****************************************************************************
141  Initialise credentials of a client structure.
142 ****************************************************************************/
143
144 NTSTATUS cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
145 {
146         NTSTATUS status = cli_set_username(cli, username);
147         if (!NT_STATUS_IS_OK(status)) {
148                 return status;
149         }
150         status = cli_set_domain(cli, domain);
151         if (!NT_STATUS_IS_OK(status)) {
152                 return status;
153         }
154         DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
155
156         return cli_set_password(cli, password);
157 }
158
159 /****************************************************************************
160  Initialise a client structure. Always returns a talloc'ed struct.
161  Set the signing state (used from the command line).
162 ****************************************************************************/
163
164 struct cli_state *cli_state_create(TALLOC_CTX *mem_ctx,
165                                    int fd,
166                                    const char *remote_name,
167                                    const char *remote_realm,
168                                    int signing_state, int flags)
169 {
170         struct cli_state *cli = NULL;
171         bool allow_smb_signing = false;
172         bool mandatory_signing = false;
173         socklen_t ss_length;
174         int ret;
175
176         /* Check the effective uid - make sure we are not setuid */
177         if (is_setuid_root()) {
178                 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
179                 return NULL;
180         }
181
182         cli = talloc_zero(mem_ctx, struct cli_state);
183         if (!cli) {
184                 return NULL;
185         }
186
187         cli->dfs_mountpoint = talloc_strdup(cli, "");
188         if (!cli->dfs_mountpoint) {
189                 goto error;
190         }
191         cli->raw_status = NT_STATUS_INTERNAL_ERROR;
192         cli->protocol = PROTOCOL_NT1;
193         cli->timeout = 20000; /* Timeout is in milliseconds. */
194         cli->max_xmit = CLI_BUFFER_SIZE+4;
195         cli->case_sensitive = false;
196
197         cli->use_spnego = lp_client_use_spnego();
198
199         cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
200
201         /* Set the CLI_FORCE_DOSERR environment variable to test
202            client routines using DOS errors instead of STATUS32
203            ones.  This intended only as a temporary hack. */    
204         if (getenv("CLI_FORCE_DOSERR")) {
205                 cli->force_dos_errors = true;
206         }
207         if (flags & CLI_FULL_CONNECTION_FORCE_DOS_ERRORS) {
208                 cli->force_dos_errors = true;
209         }
210
211         if (getenv("CLI_FORCE_ASCII")) {
212                 cli->force_ascii = true;
213         }
214         if (flags & CLI_FULL_CONNECTION_FORCE_ASCII) {
215                 cli->force_ascii = true;
216         }
217
218         if (flags & CLI_FULL_CONNECTION_DONT_SPNEGO) {
219                 cli->use_spnego = false;
220         } else if (flags & CLI_FULL_CONNECTION_USE_KERBEROS) {
221                 cli->use_kerberos = true;
222         }
223         if ((flags & CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS) &&
224              cli->use_kerberos) {
225                 cli->fallback_after_kerberos = true;
226         }
227
228         if (flags & CLI_FULL_CONNECTION_USE_CCACHE) {
229                 cli->use_ccache = true;
230         }
231
232         if (flags & CLI_FULL_CONNECTION_OPLOCKS) {
233                 cli->use_oplocks = true;
234         }
235         if (flags & CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS) {
236                 cli->use_level_II_oplocks = true;
237         }
238
239         if (lp_client_signing()) {
240                 allow_smb_signing = true;
241         }
242
243         if (lp_client_signing() == Required) {
244                 mandatory_signing = true;
245         }
246
247         if (signing_state != Undefined) {
248                 allow_smb_signing = true;
249         }
250
251         if (signing_state == false) {
252                 allow_smb_signing = false;
253                 mandatory_signing = false;
254         }
255
256         if (signing_state == Required) {
257                 mandatory_signing = true;
258         }
259
260         /* initialise signing */
261         cli->signing_state = smb_signing_init(cli,
262                                               allow_smb_signing,
263                                               mandatory_signing);
264         if (!cli->signing_state) {
265                 goto error;
266         }
267
268         cli->conn.outgoing = tevent_queue_create(cli, "cli_outgoing");
269         if (cli->conn.outgoing == NULL) {
270                 goto error;
271         }
272         cli->conn.pending = NULL;
273
274         cli->conn.remote_name = talloc_strdup(cli, remote_name);
275         if (cli->conn.remote_name == NULL) {
276                 goto error;
277         }
278
279         if (remote_realm) {
280                 cli->conn.remote_realm = talloc_strdup(cli, remote_realm);
281                 if (cli->conn.remote_realm == NULL) {
282                         goto error;
283                 }
284         }
285
286         cli->conn.fd = fd;
287
288         ss_length = sizeof(cli->conn.local_ss);
289         ret = getsockname(fd,
290                           (struct sockaddr *)(void *)&cli->conn.local_ss,
291                           &ss_length);
292         if (ret == -1) {
293                 goto error;
294         }
295         ss_length = sizeof(cli->conn.remote_ss);
296         ret = getpeername(fd,
297                           (struct sockaddr *)(void *)&cli->conn.remote_ss,
298                           &ss_length);
299         if (ret == -1) {
300                 goto error;
301         }
302
303         cli->smb1.mid = 1;
304         cli->smb1.pid = (uint16_t)sys_getpid();
305         cli->smb1.vc_num = cli->smb1.pid;
306         cli->smb1.tid = UINT16_MAX;
307         cli->smb1.uid = UID_FIELD_INVALID;
308
309         cli->initialised = 1;
310         return cli;
311
312         /* Clean up after malloc() error */
313
314  error:
315
316         TALLOC_FREE(cli);
317         return NULL;
318 }
319
320 bool cli_state_encryption_on(struct cli_state *cli)
321 {
322         return common_encryption_on(cli->trans_enc_state);
323 }
324
325
326 /****************************************************************************
327  Close all pipes open on this session.
328 ****************************************************************************/
329
330 void cli_nt_pipes_close(struct cli_state *cli)
331 {
332         while (cli->pipe_list != NULL) {
333                 /*
334                  * No TALLOC_FREE here!
335                  */
336                 talloc_free(cli->pipe_list);
337         }
338 }
339
340 /****************************************************************************
341  Shutdown a client structure.
342 ****************************************************************************/
343
344 static void _cli_shutdown(struct cli_state *cli)
345 {
346         cli_nt_pipes_close(cli);
347
348         /*
349          * tell our peer to free his resources.  Wihtout this, when an
350          * application attempts to do a graceful shutdown and calls
351          * smbc_free_context() to clean up all connections, some connections
352          * can remain active on the peer end, until some (long) timeout period
353          * later.  This tree disconnect forces the peer to clean up, since the
354          * connection will be going away.
355          */
356         if (cli_state_has_tcon(cli)) {
357                 cli_tdis(cli);
358         }
359         
360         data_blob_free(&cli->secblob);
361         data_blob_free(&cli->user_session_key);
362
363         cli_state_disconnect(cli);
364
365         /*
366          * Need to free pending first, they remove themselves
367          */
368         while (cli->conn.pending) {
369                 talloc_free(cli->conn.pending[0]);
370         }
371         TALLOC_FREE(cli);
372 }
373
374 void cli_shutdown(struct cli_state *cli)
375 {
376         struct cli_state *cli_head;
377         if (cli == NULL) {
378                 return;
379         }
380         DLIST_HEAD(cli, cli_head);
381         if (cli_head == cli) {
382                 /*
383                  * head of a DFS list, shutdown all subsidiary DFS
384                  * connections.
385                  */
386                 struct cli_state *p, *next;
387
388                 for (p = cli_head->next; p; p = next) {
389                         next = p->next;
390                         DLIST_REMOVE(cli_head, p);
391                         _cli_shutdown(p);
392                 }
393         } else {
394                 DLIST_REMOVE(cli_head, cli);
395         }
396
397         _cli_shutdown(cli);
398 }
399
400 /****************************************************************************
401  Set socket options on a open connection.
402 ****************************************************************************/
403
404 void cli_sockopt(struct cli_state *cli, const char *options)
405 {
406         set_socket_options(cli->conn.fd, options);
407 }
408
409 const struct sockaddr_storage *cli_state_local_sockaddr(struct cli_state *cli)
410 {
411         return &cli->conn.local_ss;
412 }
413
414 const struct sockaddr_storage *cli_state_remote_sockaddr(struct cli_state *cli)
415 {
416         return &cli->conn.remote_ss;
417 }
418
419 const char *cli_state_remote_name(struct cli_state *cli)
420 {
421         return cli->conn.remote_name;
422 }
423
424 const char *cli_state_remote_realm(struct cli_state *cli)
425 {
426         return cli->conn.remote_realm;
427 }
428
429 uint16_t cli_state_get_vc_num(struct cli_state *cli)
430 {
431         return cli->smb1.vc_num;
432 }
433
434 uint32_t cli_state_server_session_key(struct cli_state *cli)
435 {
436         return cli->sesskey;
437 }
438
439 /****************************************************************************
440  Set the PID to use for smb messages. Return the old pid.
441 ****************************************************************************/
442
443 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
444 {
445         uint16_t ret = cli->smb1.pid;
446         cli->smb1.pid = pid;
447         return ret;
448 }
449
450 uint16_t cli_getpid(struct cli_state *cli)
451 {
452         return cli->smb1.pid;
453 }
454
455 bool cli_state_has_tcon(struct cli_state *cli)
456 {
457         if (cli->smb1.tid == UINT16_MAX) {
458                 return false;
459         }
460
461         return true;
462 }
463
464 uint16_t cli_state_get_tid(struct cli_state *cli)
465 {
466         return cli->smb1.tid;
467 }
468
469 uint16_t cli_state_set_tid(struct cli_state *cli, uint16_t tid)
470 {
471         uint16_t ret = cli->smb1.tid;
472         cli->smb1.tid = tid;
473         return ret;
474 }
475
476 uint16_t cli_state_get_uid(struct cli_state *cli)
477 {
478         return cli->smb1.uid;
479 }
480
481 uint16_t cli_state_set_uid(struct cli_state *cli, uint16_t uid)
482 {
483         uint16_t ret = cli->smb1.uid;
484         cli->smb1.uid = uid;
485         return ret;
486 }
487
488 /****************************************************************************
489  Set the case sensitivity flag on the packets. Returns old state.
490 ****************************************************************************/
491
492 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
493 {
494         bool ret = cli->case_sensitive;
495         cli->case_sensitive = case_sensitive;
496         return ret;
497 }
498
499 enum protocol_types cli_state_protocol(struct cli_state *cli)
500 {
501         return cli->protocol;
502 }
503
504 uint32_t cli_state_capabilities(struct cli_state *cli)
505 {
506         return cli->capabilities;
507 }
508
509 uint32_t cli_state_available_size(struct cli_state *cli, uint32_t ofs)
510 {
511         uint32_t ret = cli->max_xmit;
512
513         if (ofs >= ret) {
514                 return 0;
515         }
516
517         ret -= ofs;
518
519         return ret;
520 }
521
522 uint16_t cli_state_max_requests(struct cli_state *cli)
523 {
524         return cli->max_mux;
525 }
526
527 uint16_t cli_state_security_mode(struct cli_state *cli)
528 {
529         return cli->sec_mode;
530 }
531
532 struct cli_echo_state {
533         uint16_t vwv[1];
534         DATA_BLOB data;
535         int num_echos;
536 };
537
538 static void cli_echo_done(struct tevent_req *subreq);
539
540 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
541                                  struct cli_state *cli, uint16_t num_echos,
542                                  DATA_BLOB data)
543 {
544         struct tevent_req *req, *subreq;
545         struct cli_echo_state *state;
546
547         req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
548         if (req == NULL) {
549                 return NULL;
550         }
551         SSVAL(state->vwv, 0, num_echos);
552         state->data = data;
553         state->num_echos = num_echos;
554
555         subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
556                               data.length, data.data);
557         if (subreq == NULL) {
558                 goto fail;
559         }
560         tevent_req_set_callback(subreq, cli_echo_done, req);
561         return req;
562  fail:
563         TALLOC_FREE(req);
564         return NULL;
565 }
566
567 static void cli_echo_done(struct tevent_req *subreq)
568 {
569         struct tevent_req *req = tevent_req_callback_data(
570                 subreq, struct tevent_req);
571         struct cli_echo_state *state = tevent_req_data(
572                 req, struct cli_echo_state);
573         NTSTATUS status;
574         uint32_t num_bytes;
575         uint8_t *bytes;
576         uint8_t *inbuf;
577
578         status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
579                               &num_bytes, &bytes);
580         if (!NT_STATUS_IS_OK(status)) {
581                 tevent_req_nterror(req, status);
582                 return;
583         }
584         if ((num_bytes != state->data.length)
585             || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
586                 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
587                 return;
588         }
589
590         state->num_echos -=1;
591         if (state->num_echos == 0) {
592                 tevent_req_done(req);
593                 return;
594         }
595
596         if (!cli_smb_req_set_pending(subreq)) {
597                 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
598                 return;
599         }
600 }
601
602 /**
603  * Get the result out from an echo request
604  * @param[in] req       The async_req from cli_echo_send
605  * @retval Did the server reply correctly?
606  */
607
608 NTSTATUS cli_echo_recv(struct tevent_req *req)
609 {
610         return tevent_req_simple_recv_ntstatus(req);
611 }
612
613 /**
614  * @brief Send/Receive SMBEcho requests
615  * @param[in] mem_ctx   The memory context to put the async_req on
616  * @param[in] ev        The event context that will call us back
617  * @param[in] cli       The connection to send the echo to
618  * @param[in] num_echos How many times do we want to get the reply?
619  * @param[in] data      The data we want to get back
620  * @retval Did the server reply correctly?
621  */
622
623 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
624 {
625         TALLOC_CTX *frame = talloc_stackframe();
626         struct event_context *ev;
627         struct tevent_req *req;
628         NTSTATUS status = NT_STATUS_OK;
629
630         if (cli_has_async_calls(cli)) {
631                 /*
632                  * Can't use sync call while an async call is in flight
633                  */
634                 status = NT_STATUS_INVALID_PARAMETER;
635                 goto fail;
636         }
637
638         ev = event_context_init(frame);
639         if (ev == NULL) {
640                 status = NT_STATUS_NO_MEMORY;
641                 goto fail;
642         }
643
644         req = cli_echo_send(frame, ev, cli, num_echos, data);
645         if (req == NULL) {
646                 status = NT_STATUS_NO_MEMORY;
647                 goto fail;
648         }
649
650         if (!tevent_req_poll(req, ev)) {
651                 status = map_nt_error_from_unix(errno);
652                 goto fail;
653         }
654
655         status = cli_echo_recv(req);
656  fail:
657         TALLOC_FREE(frame);
658         return status;
659 }
660
661 /**
662  * Is the SMB command able to hold an AND_X successor
663  * @param[in] cmd       The SMB command in question
664  * @retval Can we add a chained request after "cmd"?
665  */
666 bool is_andx_req(uint8_t cmd)
667 {
668         switch (cmd) {
669         case SMBtconX:
670         case SMBlockingX:
671         case SMBopenX:
672         case SMBreadX:
673         case SMBwriteX:
674         case SMBsesssetupX:
675         case SMBulogoffX:
676         case SMBntcreateX:
677                 return true;
678                 break;
679         default:
680                 break;
681         }
682
683         return false;
684 }
685
686 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
687                  uint8_t smb_command, uint8_t additional_flags,
688                  uint8_t wct, uint16_t *vwv,
689                  uint32_t num_bytes, const uint8_t *bytes,
690                  struct tevent_req **result_parent,
691                  uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
692                  uint32_t *pnum_bytes, uint8_t **pbytes)
693 {
694         struct tevent_context *ev;
695         struct tevent_req *req = NULL;
696         NTSTATUS status = NT_STATUS_NO_MEMORY;
697
698         if (cli_has_async_calls(cli)) {
699                 return NT_STATUS_INVALID_PARAMETER;
700         }
701         ev = tevent_context_init(mem_ctx);
702         if (ev == NULL) {
703                 goto fail;
704         }
705         req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
706                            wct, vwv, num_bytes, bytes);
707         if (req == NULL) {
708                 goto fail;
709         }
710         if (!tevent_req_poll_ntstatus(req, ev, &status)) {
711                 goto fail;
712         }
713         status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
714                               pnum_bytes, pbytes);
715 fail:
716         TALLOC_FREE(ev);
717         if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
718                 *result_parent = req;
719         }
720         return status;
721 }