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/>.
22 #include "libsmb/libsmb.h"
23 #include "../lib/util/tevent_ntstatus.h"
24 #include "smb_signing.h"
25 #include "async_smb.h"
27 /*******************************************************************
28 Setup the word count and byte count for a client smb message.
29 ********************************************************************/
31 int cli_set_message(char *buf,int num_words,int num_bytes,bool zero)
33 if (zero && (num_words || num_bytes)) {
34 memset(buf + smb_size,'\0',num_words*2 + num_bytes);
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);
42 /****************************************************************************
43 Change the timeout (in milliseconds).
44 ****************************************************************************/
46 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
48 unsigned int old_timeout = cli->timeout;
49 cli->timeout = timeout;
53 /****************************************************************************
54 convenience routine to find if we negotiated ucs2
55 ****************************************************************************/
57 bool cli_ucs2(struct cli_state *cli)
59 return ((cli_state_capabilities(cli) & CAP_UNICODE) != 0);
62 /****************************************************************************
63 Setup basics in a outgoing packet.
64 ****************************************************************************/
66 void cli_setup_packet_buf(struct cli_state *cli, char *buf)
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);
76 if (cli_state_protocol(cli) <= PROTOCOL_CORE) {
80 if (cli->case_sensitive) {
81 SCVAL(buf,smb_flg,0x0);
83 /* Default setting, case insensitive. */
84 SCVAL(buf,smb_flg,0x8);
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_state_capabilities(cli) & CAP_EXTENDED_SECURITY)
94 flags2 |= FLAGS2_EXTENDED_SECURITY;
95 SSVAL(buf,smb_flg2, flags2);
98 /****************************************************************************
99 Initialize Domain, user or password.
100 ****************************************************************************/
102 NTSTATUS cli_set_domain(struct cli_state *cli, const char *domain)
104 TALLOC_FREE(cli->domain);
105 cli->domain = talloc_strdup(cli, domain ? domain : "");
106 if (cli->domain == NULL) {
107 return NT_STATUS_NO_MEMORY;
112 NTSTATUS cli_set_username(struct cli_state *cli, const char *username)
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;
122 NTSTATUS cli_set_password(struct cli_state *cli, const char *password)
124 TALLOC_FREE(cli->password);
126 /* Password can be NULL. */
128 cli->password = talloc_strdup(cli, password);
129 if (cli->password == NULL) {
130 return NT_STATUS_NO_MEMORY;
133 /* Use zero NTLMSSP hashes and session key. */
134 cli->password = NULL;
140 /****************************************************************************
141 Initialise credentials of a client structure.
142 ****************************************************************************/
144 NTSTATUS cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
146 NTSTATUS status = cli_set_username(cli, username);
147 if (!NT_STATUS_IS_OK(status)) {
150 status = cli_set_domain(cli, domain);
151 if (!NT_STATUS_IS_OK(status)) {
154 DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
156 return cli_set_password(cli, password);
159 /****************************************************************************
160 Initialise a client structure. Always returns a talloc'ed struct.
161 Set the signing state (used from the command line).
162 ****************************************************************************/
164 struct cli_state *cli_state_create(TALLOC_CTX *mem_ctx,
166 const char *remote_name,
167 const char *remote_realm,
168 int signing_state, int flags)
170 struct cli_state *cli = NULL;
171 bool allow_smb_signing;
172 bool desire_smb_signing;
173 bool mandatory_signing;
176 bool use_spnego = lp_client_use_spnego();
177 bool force_dos_errors = false;
178 bool force_ascii = false;
179 bool use_level_II_oplocks = false;
181 /* Check the effective uid - make sure we are not setuid */
182 if (is_setuid_root()) {
183 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
187 cli = talloc_zero(mem_ctx, struct cli_state);
192 cli->dfs_mountpoint = talloc_strdup(cli, "");
193 if (!cli->dfs_mountpoint) {
196 cli->raw_status = NT_STATUS_INTERNAL_ERROR;
197 cli->timeout = 20000; /* Timeout is in milliseconds. */
198 cli->case_sensitive = false;
200 /* Set the CLI_FORCE_DOSERR environment variable to test
201 client routines using DOS errors instead of STATUS32
202 ones. This intended only as a temporary hack. */
203 if (getenv("CLI_FORCE_DOSERR")) {
204 force_dos_errors = true;
206 if (flags & CLI_FULL_CONNECTION_FORCE_DOS_ERRORS) {
207 force_dos_errors = true;
210 if (getenv("CLI_FORCE_ASCII")) {
213 if (flags & CLI_FULL_CONNECTION_FORCE_ASCII) {
217 if (flags & CLI_FULL_CONNECTION_DONT_SPNEGO) {
219 } else if (flags & CLI_FULL_CONNECTION_USE_KERBEROS) {
220 cli->use_kerberos = true;
222 if ((flags & CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS) &&
224 cli->fallback_after_kerberos = true;
227 if (flags & CLI_FULL_CONNECTION_USE_CCACHE) {
228 cli->use_ccache = true;
231 if (flags & CLI_FULL_CONNECTION_OPLOCKS) {
232 cli->use_oplocks = true;
234 if (flags & CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS) {
235 use_level_II_oplocks = true;
238 if (signing_state == Undefined) {
239 signing_state = lp_client_signing();
242 switch (signing_state) {
245 allow_smb_signing = false;
246 desire_smb_signing = false;
247 mandatory_signing = false;
250 /* if the server supports it */
251 allow_smb_signing = true;
252 desire_smb_signing = true;
253 mandatory_signing = false;
258 /* if the server requires it */
259 allow_smb_signing = true;
260 desire_smb_signing = false;
261 mandatory_signing = false;
265 allow_smb_signing = true;
266 desire_smb_signing = true;
267 mandatory_signing = true;
271 /* initialise signing */
272 cli->signing_state = smb_signing_init(cli,
276 if (!cli->signing_state) {
280 cli->conn.smb1.client.capabilities = 0;
281 cli->conn.smb1.client.capabilities |= CAP_LARGE_FILES;
282 cli->conn.smb1.client.capabilities |= CAP_NT_SMBS | CAP_RPC_REMOTE_APIS;
283 cli->conn.smb1.client.capabilities |= CAP_LOCK_AND_READ | CAP_NT_FIND;
284 cli->conn.smb1.client.capabilities |= CAP_DFS | CAP_W2K_SMBS;
285 cli->conn.smb1.client.capabilities |= CAP_LARGE_READX|CAP_LARGE_WRITEX;
286 cli->conn.smb1.client.capabilities |= CAP_LWIO;
288 if (!force_dos_errors) {
289 cli->conn.smb1.client.capabilities |= CAP_STATUS32;
293 cli->conn.smb1.client.capabilities |= CAP_UNICODE;
297 cli->conn.smb1.client.capabilities |= CAP_EXTENDED_SECURITY;
300 if (use_level_II_oplocks) {
301 cli->conn.smb1.client.capabilities |= CAP_LEVEL_II_OPLOCKS;
304 cli->conn.smb1.client.max_xmit = CLI_BUFFER_SIZE;
306 cli->conn.smb1.capabilities = cli->conn.smb1.client.capabilities;
307 cli->conn.smb1.max_xmit = 1024;
309 cli->conn.smb1.mid = 1;
311 cli->conn.outgoing = tevent_queue_create(cli, "cli_outgoing");
312 if (cli->conn.outgoing == NULL) {
315 cli->conn.pending = NULL;
317 cli->conn.remote_name = talloc_strdup(cli, remote_name);
318 if (cli->conn.remote_name == NULL) {
323 cli->conn.remote_realm = talloc_strdup(cli, remote_realm);
324 if (cli->conn.remote_realm == NULL) {
331 ss_length = sizeof(cli->conn.local_ss);
332 ret = getsockname(fd,
333 (struct sockaddr *)(void *)&cli->conn.local_ss,
338 ss_length = sizeof(cli->conn.remote_ss);
339 ret = getpeername(fd,
340 (struct sockaddr *)(void *)&cli->conn.remote_ss,
346 cli->smb1.pid = (uint16_t)sys_getpid();
347 cli->smb1.vc_num = cli->smb1.pid;
348 cli->smb1.tid = UINT16_MAX;
349 cli->smb1.uid = UID_FIELD_INVALID;
351 cli->initialised = 1;
354 /* Clean up after malloc() error */
362 bool cli_state_encryption_on(struct cli_state *cli)
364 return common_encryption_on(cli->trans_enc_state);
368 /****************************************************************************
369 Close all pipes open on this session.
370 ****************************************************************************/
372 void cli_nt_pipes_close(struct cli_state *cli)
374 while (cli->pipe_list != NULL) {
376 * No TALLOC_FREE here!
378 talloc_free(cli->pipe_list);
382 /****************************************************************************
383 Shutdown a client structure.
384 ****************************************************************************/
386 static void _cli_shutdown(struct cli_state *cli)
388 cli_nt_pipes_close(cli);
391 * tell our peer to free his resources. Wihtout this, when an
392 * application attempts to do a graceful shutdown and calls
393 * smbc_free_context() to clean up all connections, some connections
394 * can remain active on the peer end, until some (long) timeout period
395 * later. This tree disconnect forces the peer to clean up, since the
396 * connection will be going away.
398 if (cli_state_has_tcon(cli)) {
402 data_blob_free(&cli->secblob);
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]);
416 void cli_shutdown(struct cli_state *cli)
418 struct cli_state *cli_head;
422 DLIST_HEAD(cli, cli_head);
423 if (cli_head == cli) {
425 * head of a DFS list, shutdown all subsidiary DFS
428 struct cli_state *p, *next;
430 for (p = cli_head->next; p; p = next) {
432 DLIST_REMOVE(cli_head, p);
436 DLIST_REMOVE(cli_head, 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;
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) {
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;
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;
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;
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;
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 static const uint8_t zero;
573 if (cli->secblob.length == 8)
574 return cli->secblob.data;
580 const DATA_BLOB *cli_state_server_gss_blob(struct cli_state *cli)
582 return &cli->secblob;
585 uint16_t cli_state_security_mode(struct cli_state *cli)
587 return cli->conn.smb1.server.security_mode;
590 int cli_state_server_time_zone(struct cli_state *cli)
592 return cli->serverzone;
595 time_t cli_state_server_time(struct cli_state *cli)
597 return cli->servertime;
600 struct cli_echo_state {
606 static void cli_echo_done(struct tevent_req *subreq);
608 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
609 struct cli_state *cli, uint16_t num_echos,
612 struct tevent_req *req, *subreq;
613 struct cli_echo_state *state;
615 req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
619 SSVAL(state->vwv, 0, num_echos);
621 state->num_echos = num_echos;
623 subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
624 data.length, data.data);
625 if (subreq == NULL) {
628 tevent_req_set_callback(subreq, cli_echo_done, req);
635 static void cli_echo_done(struct tevent_req *subreq)
637 struct tevent_req *req = tevent_req_callback_data(
638 subreq, struct tevent_req);
639 struct cli_echo_state *state = tevent_req_data(
640 req, struct cli_echo_state);
646 status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
648 if (!NT_STATUS_IS_OK(status)) {
649 tevent_req_nterror(req, status);
652 if ((num_bytes != state->data.length)
653 || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
654 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
658 state->num_echos -=1;
659 if (state->num_echos == 0) {
660 tevent_req_done(req);
664 if (!cli_smb_req_set_pending(subreq)) {
665 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
671 * Get the result out from an echo request
672 * @param[in] req The async_req from cli_echo_send
673 * @retval Did the server reply correctly?
676 NTSTATUS cli_echo_recv(struct tevent_req *req)
678 return tevent_req_simple_recv_ntstatus(req);
682 * @brief Send/Receive SMBEcho requests
683 * @param[in] mem_ctx The memory context to put the async_req on
684 * @param[in] ev The event context that will call us back
685 * @param[in] cli The connection to send the echo to
686 * @param[in] num_echos How many times do we want to get the reply?
687 * @param[in] data The data we want to get back
688 * @retval Did the server reply correctly?
691 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
693 TALLOC_CTX *frame = talloc_stackframe();
694 struct event_context *ev;
695 struct tevent_req *req;
696 NTSTATUS status = NT_STATUS_OK;
698 if (cli_has_async_calls(cli)) {
700 * Can't use sync call while an async call is in flight
702 status = NT_STATUS_INVALID_PARAMETER;
706 ev = event_context_init(frame);
708 status = NT_STATUS_NO_MEMORY;
712 req = cli_echo_send(frame, ev, cli, num_echos, data);
714 status = NT_STATUS_NO_MEMORY;
718 if (!tevent_req_poll(req, ev)) {
719 status = map_nt_error_from_unix(errno);
723 status = cli_echo_recv(req);
730 * Is the SMB command able to hold an AND_X successor
731 * @param[in] cmd The SMB command in question
732 * @retval Can we add a chained request after "cmd"?
734 bool is_andx_req(uint8_t cmd)
754 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
755 uint8_t smb_command, uint8_t additional_flags,
756 uint8_t wct, uint16_t *vwv,
757 uint32_t num_bytes, const uint8_t *bytes,
758 struct tevent_req **result_parent,
759 uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
760 uint32_t *pnum_bytes, uint8_t **pbytes)
762 struct tevent_context *ev;
763 struct tevent_req *req = NULL;
764 NTSTATUS status = NT_STATUS_NO_MEMORY;
766 if (cli_has_async_calls(cli)) {
767 return NT_STATUS_INVALID_PARAMETER;
769 ev = tevent_context_init(mem_ctx);
773 req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
774 wct, vwv, num_bytes, bytes);
778 if (!tevent_req_poll_ntstatus(req, ev, &status)) {
781 status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
785 if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
786 *result_parent = req;