s3-utils: net - Fix one error/usage message
[Samba/gebeck_regimport.git] / source3 / libsmb / clientgen.c
blob117fc994ad246f509bdd23888d4e1fe248780710
1 /*
2 Unix SMB/CIFS implementation.
3 SMB client generic functions
4 Copyright (C) Andrew Tridgell 1994-1998
5 Copyright (C) Jeremy Allison 2007.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "includes.h"
22 #include "libsmb/libsmb.h"
23 #include "../lib/util/tevent_ntstatus.h"
24 #include "../libcli/smb/smb_signing.h"
25 #include "../libcli/smb/smb_seal.h"
26 #include "async_smb.h"
28 /*******************************************************************
29 Setup the word count and byte count for a client smb message.
30 ********************************************************************/
32 int cli_set_message(char *buf,int num_words,int num_bytes,bool zero)
34 if (zero && (num_words || num_bytes)) {
35 memset(buf + smb_size,'\0',num_words*2 + num_bytes);
37 SCVAL(buf,smb_wct,num_words);
38 SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
39 smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
40 return (smb_size + num_words*2 + num_bytes);
43 /****************************************************************************
44 Change the timeout (in milliseconds).
45 ****************************************************************************/
47 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
49 unsigned int old_timeout = cli->timeout;
50 cli->timeout = timeout;
51 return old_timeout;
54 /****************************************************************************
55 convenience routine to find if we negotiated ucs2
56 ****************************************************************************/
58 bool cli_ucs2(struct cli_state *cli)
60 return ((cli_state_capabilities(cli) & CAP_UNICODE) != 0);
63 /****************************************************************************
64 Setup basics in a outgoing packet.
65 ****************************************************************************/
67 void cli_setup_packet_buf(struct cli_state *cli, char *buf)
69 uint16 flags2;
70 cli->rap_error = 0;
71 SIVAL(buf,smb_rcls,0);
72 SSVAL(buf,smb_pid,cli->smb1.pid);
73 memset(buf+smb_pidhigh, 0, 12);
74 SSVAL(buf,smb_uid, cli_state_get_uid(cli));
75 SSVAL(buf,smb_mid, 0);
77 if (cli_state_protocol(cli) <= PROTOCOL_CORE) {
78 return;
81 if (cli->case_sensitive) {
82 SCVAL(buf,smb_flg,0x0);
83 } else {
84 /* Default setting, case insensitive. */
85 SCVAL(buf,smb_flg,0x8);
87 flags2 = FLAGS2_LONG_PATH_COMPONENTS;
88 if (cli_state_capabilities(cli) & CAP_UNICODE)
89 flags2 |= FLAGS2_UNICODE_STRINGS;
90 if ((cli_state_capabilities(cli) & CAP_DFS) && cli->dfsroot)
91 flags2 |= FLAGS2_DFS_PATHNAMES;
92 if (cli_state_capabilities(cli) & CAP_STATUS32)
93 flags2 |= FLAGS2_32_BIT_ERROR_CODES;
94 if (cli_state_capabilities(cli) & CAP_EXTENDED_SECURITY)
95 flags2 |= FLAGS2_EXTENDED_SECURITY;
96 SSVAL(buf,smb_flg2, flags2);
99 /****************************************************************************
100 Initialize Domain, user or password.
101 ****************************************************************************/
103 NTSTATUS cli_set_domain(struct cli_state *cli, const char *domain)
105 TALLOC_FREE(cli->domain);
106 cli->domain = talloc_strdup(cli, domain ? domain : "");
107 if (cli->domain == NULL) {
108 return NT_STATUS_NO_MEMORY;
110 return NT_STATUS_OK;
113 NTSTATUS cli_set_username(struct cli_state *cli, const char *username)
115 TALLOC_FREE(cli->user_name);
116 cli->user_name = talloc_strdup(cli, username ? username : "");
117 if (cli->user_name == NULL) {
118 return NT_STATUS_NO_MEMORY;
120 return NT_STATUS_OK;
123 NTSTATUS cli_set_password(struct cli_state *cli, const char *password)
125 TALLOC_FREE(cli->password);
127 /* Password can be NULL. */
128 if (password) {
129 cli->password = talloc_strdup(cli, password);
130 if (cli->password == NULL) {
131 return NT_STATUS_NO_MEMORY;
133 } else {
134 /* Use zero NTLMSSP hashes and session key. */
135 cli->password = NULL;
138 return NT_STATUS_OK;
141 /****************************************************************************
142 Initialise credentials of a client structure.
143 ****************************************************************************/
145 NTSTATUS cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
147 NTSTATUS status = cli_set_username(cli, username);
148 if (!NT_STATUS_IS_OK(status)) {
149 return status;
151 status = cli_set_domain(cli, domain);
152 if (!NT_STATUS_IS_OK(status)) {
153 return status;
155 DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
157 return cli_set_password(cli, password);
160 /****************************************************************************
161 Initialise a client structure. Always returns a talloc'ed struct.
162 Set the signing state (used from the command line).
163 ****************************************************************************/
165 struct cli_state *cli_state_create(TALLOC_CTX *mem_ctx,
166 int fd,
167 const char *remote_name,
168 const char *remote_realm,
169 int signing_state, int flags)
171 struct cli_state *cli = NULL;
172 bool allow_smb_signing;
173 bool desire_smb_signing;
174 bool mandatory_signing;
175 socklen_t ss_length;
176 int ret;
177 bool use_spnego = lp_client_use_spnego();
178 bool force_dos_errors = false;
179 bool force_ascii = false;
180 bool use_level_II_oplocks = false;
182 /* Check the effective uid - make sure we are not setuid */
183 if (is_setuid_root()) {
184 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
185 return NULL;
188 cli = talloc_zero(mem_ctx, struct cli_state);
189 if (!cli) {
190 return NULL;
193 cli->dfs_mountpoint = talloc_strdup(cli, "");
194 if (!cli->dfs_mountpoint) {
195 goto error;
197 cli->raw_status = NT_STATUS_INTERNAL_ERROR;
198 cli->timeout = 20000; /* Timeout is in milliseconds. */
199 cli->case_sensitive = false;
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 force_dos_errors = true;
207 if (flags & CLI_FULL_CONNECTION_FORCE_DOS_ERRORS) {
208 force_dos_errors = true;
211 if (getenv("CLI_FORCE_ASCII")) {
212 force_ascii = true;
214 if (flags & CLI_FULL_CONNECTION_FORCE_ASCII) {
215 force_ascii = true;
218 if (flags & CLI_FULL_CONNECTION_DONT_SPNEGO) {
219 use_spnego = false;
220 } else if (flags & CLI_FULL_CONNECTION_USE_KERBEROS) {
221 cli->use_kerberos = true;
223 if ((flags & CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS) &&
224 cli->use_kerberos) {
225 cli->fallback_after_kerberos = true;
228 if (flags & CLI_FULL_CONNECTION_USE_CCACHE) {
229 cli->use_ccache = true;
232 if (flags & CLI_FULL_CONNECTION_OPLOCKS) {
233 cli->use_oplocks = true;
235 if (flags & CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS) {
236 use_level_II_oplocks = true;
239 if (signing_state == Undefined) {
240 signing_state = lp_client_signing();
243 switch (signing_state) {
244 case false:
245 /* never */
246 allow_smb_signing = false;
247 desire_smb_signing = false;
248 mandatory_signing = false;
249 break;
250 case true:
251 /* if the server supports it */
252 allow_smb_signing = true;
253 desire_smb_signing = true;
254 mandatory_signing = false;
255 break;
256 default:
257 case Undefined:
258 case Auto:
259 /* if the server requires it */
260 allow_smb_signing = true;
261 desire_smb_signing = false;
262 mandatory_signing = false;
263 break;
264 case Required:
265 /* always */
266 allow_smb_signing = true;
267 desire_smb_signing = true;
268 mandatory_signing = true;
269 break;
272 /* initialise signing */
273 cli->signing_state = smb_signing_init(cli,
274 allow_smb_signing,
275 desire_smb_signing,
276 mandatory_signing);
277 if (!cli->signing_state) {
278 goto error;
281 cli->conn.smb1.client.capabilities = 0;
282 cli->conn.smb1.client.capabilities |= CAP_LARGE_FILES;
283 cli->conn.smb1.client.capabilities |= CAP_NT_SMBS | CAP_RPC_REMOTE_APIS;
284 cli->conn.smb1.client.capabilities |= CAP_LOCK_AND_READ | CAP_NT_FIND;
285 cli->conn.smb1.client.capabilities |= CAP_DFS | CAP_W2K_SMBS;
286 cli->conn.smb1.client.capabilities |= CAP_LARGE_READX|CAP_LARGE_WRITEX;
287 cli->conn.smb1.client.capabilities |= CAP_LWIO;
289 if (!force_dos_errors) {
290 cli->conn.smb1.client.capabilities |= CAP_STATUS32;
293 if (!force_ascii) {
294 cli->conn.smb1.client.capabilities |= CAP_UNICODE;
297 if (use_spnego) {
298 cli->conn.smb1.client.capabilities |= CAP_EXTENDED_SECURITY;
301 if (use_level_II_oplocks) {
302 cli->conn.smb1.client.capabilities |= CAP_LEVEL_II_OPLOCKS;
305 cli->conn.smb1.client.max_xmit = CLI_BUFFER_SIZE;
307 cli->conn.smb1.capabilities = cli->conn.smb1.client.capabilities;
308 cli->conn.smb1.max_xmit = 1024;
310 cli->conn.smb1.mid = 1;
312 cli->conn.outgoing = tevent_queue_create(cli, "cli_outgoing");
313 if (cli->conn.outgoing == NULL) {
314 goto error;
316 cli->conn.pending = NULL;
318 cli->conn.remote_name = talloc_strdup(cli, remote_name);
319 if (cli->conn.remote_name == NULL) {
320 goto error;
323 if (remote_realm) {
324 cli->conn.remote_realm = talloc_strdup(cli, remote_realm);
325 if (cli->conn.remote_realm == NULL) {
326 goto error;
330 cli->conn.fd = fd;
332 ss_length = sizeof(cli->conn.local_ss);
333 ret = getsockname(fd,
334 (struct sockaddr *)(void *)&cli->conn.local_ss,
335 &ss_length);
336 if (ret == -1) {
337 goto error;
339 ss_length = sizeof(cli->conn.remote_ss);
340 ret = getpeername(fd,
341 (struct sockaddr *)(void *)&cli->conn.remote_ss,
342 &ss_length);
343 if (ret == -1) {
344 goto error;
347 cli->smb1.pid = (uint16_t)sys_getpid();
348 cli->smb1.vc_num = cli->smb1.pid;
349 cli->smb1.tid = UINT16_MAX;
350 cli->smb1.uid = UID_FIELD_INVALID;
352 cli->initialised = 1;
353 return cli;
355 /* Clean up after malloc() error */
357 error:
359 TALLOC_FREE(cli);
360 return NULL;
363 bool cli_state_encryption_on(struct cli_state *cli)
365 return common_encryption_on(cli->trans_enc_state);
369 /****************************************************************************
370 Close all pipes open on this session.
371 ****************************************************************************/
373 void cli_nt_pipes_close(struct cli_state *cli)
375 while (cli->pipe_list != NULL) {
377 * No TALLOC_FREE here!
379 talloc_free(cli->pipe_list);
383 /****************************************************************************
384 Shutdown a client structure.
385 ****************************************************************************/
387 static void _cli_shutdown(struct cli_state *cli)
389 cli_nt_pipes_close(cli);
392 * tell our peer to free his resources. Wihtout this, when an
393 * application attempts to do a graceful shutdown and calls
394 * smbc_free_context() to clean up all connections, some connections
395 * can remain active on the peer end, until some (long) timeout period
396 * later. This tree disconnect forces the peer to clean up, since the
397 * connection will be going away.
399 if (cli_state_has_tcon(cli)) {
400 cli_tdis(cli);
403 data_blob_free(&cli->user_session_key);
405 cli_state_disconnect(cli);
408 * Need to free pending first, they remove themselves
410 while (cli->conn.pending) {
411 talloc_free(cli->conn.pending[0]);
413 TALLOC_FREE(cli);
416 void cli_shutdown(struct cli_state *cli)
418 struct cli_state *cli_head;
419 if (cli == NULL) {
420 return;
422 DLIST_HEAD(cli, cli_head);
423 if (cli_head == cli) {
425 * head of a DFS list, shutdown all subsidiary DFS
426 * connections.
428 struct cli_state *p, *next;
430 for (p = cli_head->next; p; p = next) {
431 next = p->next;
432 DLIST_REMOVE(cli_head, p);
433 _cli_shutdown(p);
435 } else {
436 DLIST_REMOVE(cli_head, cli);
439 _cli_shutdown(cli);
442 /****************************************************************************
443 Set socket options on a open connection.
444 ****************************************************************************/
446 void cli_sockopt(struct cli_state *cli, const char *options)
448 set_socket_options(cli->conn.fd, options);
451 const struct sockaddr_storage *cli_state_local_sockaddr(struct cli_state *cli)
453 return &cli->conn.local_ss;
456 const struct sockaddr_storage *cli_state_remote_sockaddr(struct cli_state *cli)
458 return &cli->conn.remote_ss;
461 const char *cli_state_remote_name(struct cli_state *cli)
463 return cli->conn.remote_name;
466 const char *cli_state_remote_realm(struct cli_state *cli)
468 return cli->conn.remote_realm;
471 uint16_t cli_state_get_vc_num(struct cli_state *cli)
473 return cli->smb1.vc_num;
476 uint32_t cli_state_server_session_key(struct cli_state *cli)
478 return cli->conn.smb1.server.session_key;
481 /****************************************************************************
482 Set the PID to use for smb messages. Return the old pid.
483 ****************************************************************************/
485 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
487 uint16_t ret = cli->smb1.pid;
488 cli->smb1.pid = pid;
489 return ret;
492 uint16_t cli_getpid(struct cli_state *cli)
494 return cli->smb1.pid;
497 bool cli_state_has_tcon(struct cli_state *cli)
499 if (cli->smb1.tid == UINT16_MAX) {
500 return false;
503 return true;
506 uint16_t cli_state_get_tid(struct cli_state *cli)
508 return cli->smb1.tid;
511 uint16_t cli_state_set_tid(struct cli_state *cli, uint16_t tid)
513 uint16_t ret = cli->smb1.tid;
514 cli->smb1.tid = tid;
515 return ret;
518 uint16_t cli_state_get_uid(struct cli_state *cli)
520 return cli->smb1.uid;
523 uint16_t cli_state_set_uid(struct cli_state *cli, uint16_t uid)
525 uint16_t ret = cli->smb1.uid;
526 cli->smb1.uid = uid;
527 return ret;
530 /****************************************************************************
531 Set the case sensitivity flag on the packets. Returns old state.
532 ****************************************************************************/
534 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
536 bool ret = cli->case_sensitive;
537 cli->case_sensitive = case_sensitive;
538 return ret;
541 enum protocol_types cli_state_protocol(struct cli_state *cli)
543 return cli->conn.protocol;
546 uint32_t cli_state_capabilities(struct cli_state *cli)
548 return cli->conn.smb1.capabilities;
551 uint32_t cli_state_available_size(struct cli_state *cli, uint32_t ofs)
553 uint32_t ret = cli->conn.smb1.max_xmit;
555 if (ofs >= ret) {
556 return 0;
559 ret -= ofs;
561 return ret;
564 uint16_t cli_state_max_requests(struct cli_state *cli)
566 return cli->conn.smb1.server.max_mux;
569 const uint8_t *cli_state_server_challenge(struct cli_state *cli)
571 return cli->conn.smb1.server.challenge;
574 const DATA_BLOB *cli_state_server_gss_blob(struct cli_state *cli)
576 return &cli->conn.smb1.server.gss_blob;
579 uint16_t cli_state_security_mode(struct cli_state *cli)
581 return cli->conn.smb1.server.security_mode;
584 int cli_state_server_time_zone(struct cli_state *cli)
586 return cli->conn.smb1.server.time_zone;
589 time_t cli_state_server_time(struct cli_state *cli)
591 return cli->conn.smb1.server.system_time;
594 struct cli_echo_state {
595 uint16_t vwv[1];
596 DATA_BLOB data;
597 int num_echos;
600 static void cli_echo_done(struct tevent_req *subreq);
602 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
603 struct cli_state *cli, uint16_t num_echos,
604 DATA_BLOB data)
606 struct tevent_req *req, *subreq;
607 struct cli_echo_state *state;
609 req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
610 if (req == NULL) {
611 return NULL;
613 SSVAL(state->vwv, 0, num_echos);
614 state->data = data;
615 state->num_echos = num_echos;
617 subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
618 data.length, data.data);
619 if (subreq == NULL) {
620 goto fail;
622 tevent_req_set_callback(subreq, cli_echo_done, req);
623 return req;
624 fail:
625 TALLOC_FREE(req);
626 return NULL;
629 static void cli_echo_done(struct tevent_req *subreq)
631 struct tevent_req *req = tevent_req_callback_data(
632 subreq, struct tevent_req);
633 struct cli_echo_state *state = tevent_req_data(
634 req, struct cli_echo_state);
635 NTSTATUS status;
636 uint32_t num_bytes;
637 uint8_t *bytes;
638 uint8_t *inbuf;
640 status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
641 &num_bytes, &bytes);
642 if (!NT_STATUS_IS_OK(status)) {
643 tevent_req_nterror(req, status);
644 return;
646 if ((num_bytes != state->data.length)
647 || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
648 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
649 return;
652 state->num_echos -=1;
653 if (state->num_echos == 0) {
654 tevent_req_done(req);
655 return;
658 if (!cli_smb_req_set_pending(subreq)) {
659 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
660 return;
665 * Get the result out from an echo request
666 * @param[in] req The async_req from cli_echo_send
667 * @retval Did the server reply correctly?
670 NTSTATUS cli_echo_recv(struct tevent_req *req)
672 return tevent_req_simple_recv_ntstatus(req);
676 * @brief Send/Receive SMBEcho requests
677 * @param[in] mem_ctx The memory context to put the async_req on
678 * @param[in] ev The event context that will call us back
679 * @param[in] cli The connection to send the echo to
680 * @param[in] num_echos How many times do we want to get the reply?
681 * @param[in] data The data we want to get back
682 * @retval Did the server reply correctly?
685 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
687 TALLOC_CTX *frame = talloc_stackframe();
688 struct event_context *ev;
689 struct tevent_req *req;
690 NTSTATUS status = NT_STATUS_OK;
692 if (cli_has_async_calls(cli)) {
694 * Can't use sync call while an async call is in flight
696 status = NT_STATUS_INVALID_PARAMETER;
697 goto fail;
700 ev = event_context_init(frame);
701 if (ev == NULL) {
702 status = NT_STATUS_NO_MEMORY;
703 goto fail;
706 req = cli_echo_send(frame, ev, cli, num_echos, data);
707 if (req == NULL) {
708 status = NT_STATUS_NO_MEMORY;
709 goto fail;
712 if (!tevent_req_poll(req, ev)) {
713 status = map_nt_error_from_unix(errno);
714 goto fail;
717 status = cli_echo_recv(req);
718 fail:
719 TALLOC_FREE(frame);
720 return status;
724 * Is the SMB command able to hold an AND_X successor
725 * @param[in] cmd The SMB command in question
726 * @retval Can we add a chained request after "cmd"?
728 bool is_andx_req(uint8_t cmd)
730 switch (cmd) {
731 case SMBtconX:
732 case SMBlockingX:
733 case SMBopenX:
734 case SMBreadX:
735 case SMBwriteX:
736 case SMBsesssetupX:
737 case SMBulogoffX:
738 case SMBntcreateX:
739 return true;
740 break;
741 default:
742 break;
745 return false;
748 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
749 uint8_t smb_command, uint8_t additional_flags,
750 uint8_t wct, uint16_t *vwv,
751 uint32_t num_bytes, const uint8_t *bytes,
752 struct tevent_req **result_parent,
753 uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
754 uint32_t *pnum_bytes, uint8_t **pbytes)
756 struct tevent_context *ev;
757 struct tevent_req *req = NULL;
758 NTSTATUS status = NT_STATUS_NO_MEMORY;
760 if (cli_has_async_calls(cli)) {
761 return NT_STATUS_INVALID_PARAMETER;
763 ev = tevent_context_init(mem_ctx);
764 if (ev == NULL) {
765 goto fail;
767 req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
768 wct, vwv, num_bytes, bytes);
769 if (req == NULL) {
770 goto fail;
772 if (!tevent_req_poll_ntstatus(req, ev, &status)) {
773 goto fail;
775 status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
776 pnum_bytes, pbytes);
777 fail:
778 TALLOC_FREE(ev);
779 if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
780 *result_parent = req;
782 return status;