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->max_xmit = CLI_BUFFER_SIZE+4;
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")) {
214 if (flags & CLI_FULL_CONNECTION_FORCE_ASCII) {
218 if (flags & CLI_FULL_CONNECTION_DONT_SPNEGO) {
220 } else if (flags & CLI_FULL_CONNECTION_USE_KERBEROS) {
221 cli->use_kerberos = true;
223 if ((flags & CLI_FULL_CONNECTION_FALLBACK_AFTER_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) {
246 allow_smb_signing = false;
247 desire_smb_signing = false;
248 mandatory_signing = false;
251 /* if the server supports it */
252 allow_smb_signing = true;
253 desire_smb_signing = true;
254 mandatory_signing = false;
259 /* if the server requires it */
260 allow_smb_signing = true;
261 desire_smb_signing = false;
262 mandatory_signing = false;
266 allow_smb_signing = true;
267 desire_smb_signing = true;
268 mandatory_signing = true;
272 /* initialise signing */
273 cli->signing_state = smb_signing_init(cli,
277 if (!cli->signing_state) {
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;
294 cli->conn.smb1.client.capabilities |= CAP_UNICODE;
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.capabilities = cli->conn.smb1.client.capabilities;
307 cli->conn.smb1.mid = 1;
309 cli->conn.outgoing = tevent_queue_create(cli, "cli_outgoing");
310 if (cli->conn.outgoing == NULL) {
313 cli->conn.pending = NULL;
315 cli->conn.remote_name = talloc_strdup(cli, remote_name);
316 if (cli->conn.remote_name == NULL) {
321 cli->conn.remote_realm = talloc_strdup(cli, remote_realm);
322 if (cli->conn.remote_realm == NULL) {
329 ss_length = sizeof(cli->conn.local_ss);
330 ret = getsockname(fd,
331 (struct sockaddr *)(void *)&cli->conn.local_ss,
336 ss_length = sizeof(cli->conn.remote_ss);
337 ret = getpeername(fd,
338 (struct sockaddr *)(void *)&cli->conn.remote_ss,
344 cli->smb1.pid = (uint16_t)sys_getpid();
345 cli->smb1.vc_num = cli->smb1.pid;
346 cli->smb1.tid = UINT16_MAX;
347 cli->smb1.uid = UID_FIELD_INVALID;
349 cli->initialised = 1;
352 /* Clean up after malloc() error */
360 bool cli_state_encryption_on(struct cli_state *cli)
362 return common_encryption_on(cli->trans_enc_state);
366 /****************************************************************************
367 Close all pipes open on this session.
368 ****************************************************************************/
370 void cli_nt_pipes_close(struct cli_state *cli)
372 while (cli->pipe_list != NULL) {
374 * No TALLOC_FREE here!
376 talloc_free(cli->pipe_list);
380 /****************************************************************************
381 Shutdown a client structure.
382 ****************************************************************************/
384 static void _cli_shutdown(struct cli_state *cli)
386 cli_nt_pipes_close(cli);
389 * tell our peer to free his resources. Wihtout this, when an
390 * application attempts to do a graceful shutdown and calls
391 * smbc_free_context() to clean up all connections, some connections
392 * can remain active on the peer end, until some (long) timeout period
393 * later. This tree disconnect forces the peer to clean up, since the
394 * connection will be going away.
396 if (cli_state_has_tcon(cli)) {
400 data_blob_free(&cli->secblob);
401 data_blob_free(&cli->user_session_key);
403 cli_state_disconnect(cli);
406 * Need to free pending first, they remove themselves
408 while (cli->conn.pending) {
409 talloc_free(cli->conn.pending[0]);
414 void cli_shutdown(struct cli_state *cli)
416 struct cli_state *cli_head;
420 DLIST_HEAD(cli, cli_head);
421 if (cli_head == cli) {
423 * head of a DFS list, shutdown all subsidiary DFS
426 struct cli_state *p, *next;
428 for (p = cli_head->next; p; p = next) {
430 DLIST_REMOVE(cli_head, p);
434 DLIST_REMOVE(cli_head, cli);
440 /****************************************************************************
441 Set socket options on a open connection.
442 ****************************************************************************/
444 void cli_sockopt(struct cli_state *cli, const char *options)
446 set_socket_options(cli->conn.fd, options);
449 const struct sockaddr_storage *cli_state_local_sockaddr(struct cli_state *cli)
451 return &cli->conn.local_ss;
454 const struct sockaddr_storage *cli_state_remote_sockaddr(struct cli_state *cli)
456 return &cli->conn.remote_ss;
459 const char *cli_state_remote_name(struct cli_state *cli)
461 return cli->conn.remote_name;
464 const char *cli_state_remote_realm(struct cli_state *cli)
466 return cli->conn.remote_realm;
469 uint16_t cli_state_get_vc_num(struct cli_state *cli)
471 return cli->smb1.vc_num;
474 uint32_t cli_state_server_session_key(struct cli_state *cli)
479 /****************************************************************************
480 Set the PID to use for smb messages. Return the old pid.
481 ****************************************************************************/
483 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
485 uint16_t ret = cli->smb1.pid;
490 uint16_t cli_getpid(struct cli_state *cli)
492 return cli->smb1.pid;
495 bool cli_state_has_tcon(struct cli_state *cli)
497 if (cli->smb1.tid == UINT16_MAX) {
504 uint16_t cli_state_get_tid(struct cli_state *cli)
506 return cli->smb1.tid;
509 uint16_t cli_state_set_tid(struct cli_state *cli, uint16_t tid)
511 uint16_t ret = cli->smb1.tid;
516 uint16_t cli_state_get_uid(struct cli_state *cli)
518 return cli->smb1.uid;
521 uint16_t cli_state_set_uid(struct cli_state *cli, uint16_t uid)
523 uint16_t ret = cli->smb1.uid;
528 /****************************************************************************
529 Set the case sensitivity flag on the packets. Returns old state.
530 ****************************************************************************/
532 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
534 bool ret = cli->case_sensitive;
535 cli->case_sensitive = case_sensitive;
539 enum protocol_types cli_state_protocol(struct cli_state *cli)
541 return cli->conn.protocol;
544 uint32_t cli_state_capabilities(struct cli_state *cli)
546 return cli->conn.smb1.capabilities;
549 uint32_t cli_state_available_size(struct cli_state *cli, uint32_t ofs)
551 uint32_t ret = cli->max_xmit;
562 uint16_t cli_state_max_requests(struct cli_state *cli)
567 uint16_t cli_state_security_mode(struct cli_state *cli)
569 return cli->sec_mode;
572 int cli_state_server_time_zone(struct cli_state *cli)
574 return cli->serverzone;
577 time_t cli_state_server_time(struct cli_state *cli)
579 return cli->servertime;
582 struct cli_echo_state {
588 static void cli_echo_done(struct tevent_req *subreq);
590 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
591 struct cli_state *cli, uint16_t num_echos,
594 struct tevent_req *req, *subreq;
595 struct cli_echo_state *state;
597 req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
601 SSVAL(state->vwv, 0, num_echos);
603 state->num_echos = num_echos;
605 subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
606 data.length, data.data);
607 if (subreq == NULL) {
610 tevent_req_set_callback(subreq, cli_echo_done, req);
617 static void cli_echo_done(struct tevent_req *subreq)
619 struct tevent_req *req = tevent_req_callback_data(
620 subreq, struct tevent_req);
621 struct cli_echo_state *state = tevent_req_data(
622 req, struct cli_echo_state);
628 status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
630 if (!NT_STATUS_IS_OK(status)) {
631 tevent_req_nterror(req, status);
634 if ((num_bytes != state->data.length)
635 || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
636 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
640 state->num_echos -=1;
641 if (state->num_echos == 0) {
642 tevent_req_done(req);
646 if (!cli_smb_req_set_pending(subreq)) {
647 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
653 * Get the result out from an echo request
654 * @param[in] req The async_req from cli_echo_send
655 * @retval Did the server reply correctly?
658 NTSTATUS cli_echo_recv(struct tevent_req *req)
660 return tevent_req_simple_recv_ntstatus(req);
664 * @brief Send/Receive SMBEcho requests
665 * @param[in] mem_ctx The memory context to put the async_req on
666 * @param[in] ev The event context that will call us back
667 * @param[in] cli The connection to send the echo to
668 * @param[in] num_echos How many times do we want to get the reply?
669 * @param[in] data The data we want to get back
670 * @retval Did the server reply correctly?
673 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
675 TALLOC_CTX *frame = talloc_stackframe();
676 struct event_context *ev;
677 struct tevent_req *req;
678 NTSTATUS status = NT_STATUS_OK;
680 if (cli_has_async_calls(cli)) {
682 * Can't use sync call while an async call is in flight
684 status = NT_STATUS_INVALID_PARAMETER;
688 ev = event_context_init(frame);
690 status = NT_STATUS_NO_MEMORY;
694 req = cli_echo_send(frame, ev, cli, num_echos, data);
696 status = NT_STATUS_NO_MEMORY;
700 if (!tevent_req_poll(req, ev)) {
701 status = map_nt_error_from_unix(errno);
705 status = cli_echo_recv(req);
712 * Is the SMB command able to hold an AND_X successor
713 * @param[in] cmd The SMB command in question
714 * @retval Can we add a chained request after "cmd"?
716 bool is_andx_req(uint8_t cmd)
736 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
737 uint8_t smb_command, uint8_t additional_flags,
738 uint8_t wct, uint16_t *vwv,
739 uint32_t num_bytes, const uint8_t *bytes,
740 struct tevent_req **result_parent,
741 uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
742 uint32_t *pnum_bytes, uint8_t **pbytes)
744 struct tevent_context *ev;
745 struct tevent_req *req = NULL;
746 NTSTATUS status = NT_STATUS_NO_MEMORY;
748 if (cli_has_async_calls(cli)) {
749 return NT_STATUS_INVALID_PARAMETER;
751 ev = tevent_context_init(mem_ctx);
755 req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
756 wct, vwv, num_bytes, bytes);
760 if (!tevent_req_poll_ntstatus(req, ev, &status)) {
763 status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
767 if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
768 *result_parent = req;