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 "../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;
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)
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) {
81 if (cli->case_sensitive) {
82 SCVAL(buf,smb_flg,0x0);
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;
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;
123 NTSTATUS cli_set_password(struct cli_state *cli, const char *password)
125 TALLOC_FREE(cli->password);
127 /* Password can be NULL. */
129 cli->password = talloc_strdup(cli, password);
130 if (cli->password == NULL) {
131 return NT_STATUS_NO_MEMORY;
134 /* Use zero NTLMSSP hashes and session key. */
135 cli->password = NULL;
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)) {
151 status = cli_set_domain(cli, domain);
152 if (!NT_STATUS_IS_OK(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,
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;
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"));
188 cli = talloc_zero(mem_ctx, struct cli_state);
193 cli->dfs_mountpoint = talloc_strdup(cli, "");
194 if (!cli->dfs_mountpoint) {
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")) {
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;
254 allow_smb_signing = true;
255 desire_smb_signing = false;
256 mandatory_signing = false;
260 allow_smb_signing = true;
261 desire_smb_signing = true;
262 mandatory_signing = true;
266 /* initialise signing */
267 cli->signing_state = smb_signing_init(cli,
271 if (!cli->signing_state) {
275 cli->conn.smb1.client.capabilities = 0;
276 cli->conn.smb1.client.capabilities |= CAP_LARGE_FILES;
277 cli->conn.smb1.client.capabilities |= CAP_NT_SMBS | CAP_RPC_REMOTE_APIS;
278 cli->conn.smb1.client.capabilities |= CAP_LOCK_AND_READ | CAP_NT_FIND;
279 cli->conn.smb1.client.capabilities |= CAP_DFS | CAP_W2K_SMBS;
280 cli->conn.smb1.client.capabilities |= CAP_LARGE_READX|CAP_LARGE_WRITEX;
281 cli->conn.smb1.client.capabilities |= CAP_LWIO;
283 if (!force_dos_errors) {
284 cli->conn.smb1.client.capabilities |= CAP_STATUS32;
288 cli->conn.smb1.client.capabilities |= CAP_UNICODE;
292 cli->conn.smb1.client.capabilities |= CAP_EXTENDED_SECURITY;
295 if (use_level_II_oplocks) {
296 cli->conn.smb1.client.capabilities |= CAP_LEVEL_II_OPLOCKS;
299 cli->conn.smb1.client.max_xmit = CLI_BUFFER_SIZE;
301 cli->conn.smb1.capabilities = cli->conn.smb1.client.capabilities;
302 cli->conn.smb1.max_xmit = 1024;
304 cli->conn.smb1.mid = 1;
306 cli->conn.outgoing = tevent_queue_create(cli, "cli_outgoing");
307 if (cli->conn.outgoing == NULL) {
310 cli->conn.pending = NULL;
312 cli->conn.remote_name = talloc_strdup(cli, remote_name);
313 if (cli->conn.remote_name == NULL) {
318 cli->conn.remote_realm = talloc_strdup(cli, remote_realm);
319 if (cli->conn.remote_realm == NULL) {
326 ss_length = sizeof(cli->conn.local_ss);
327 ret = getsockname(fd,
328 (struct sockaddr *)(void *)&cli->conn.local_ss,
333 ss_length = sizeof(cli->conn.remote_ss);
334 ret = getpeername(fd,
335 (struct sockaddr *)(void *)&cli->conn.remote_ss,
341 cli->smb1.pid = (uint16_t)sys_getpid();
342 cli->smb1.vc_num = cli->smb1.pid;
343 cli->smb1.tid = UINT16_MAX;
344 cli->smb1.uid = UID_FIELD_INVALID;
346 cli->initialised = 1;
349 /* Clean up after malloc() error */
357 bool cli_state_encryption_on(struct cli_state *cli)
359 return common_encryption_on(cli->trans_enc_state);
363 /****************************************************************************
364 Close all pipes open on this session.
365 ****************************************************************************/
367 void cli_nt_pipes_close(struct cli_state *cli)
369 while (cli->pipe_list != NULL) {
371 * No TALLOC_FREE here!
373 talloc_free(cli->pipe_list);
377 /****************************************************************************
378 Shutdown a client structure.
379 ****************************************************************************/
381 static void _cli_shutdown(struct cli_state *cli)
383 cli_nt_pipes_close(cli);
386 * tell our peer to free his resources. Wihtout this, when an
387 * application attempts to do a graceful shutdown and calls
388 * smbc_free_context() to clean up all connections, some connections
389 * can remain active on the peer end, until some (long) timeout period
390 * later. This tree disconnect forces the peer to clean up, since the
391 * connection will be going away.
393 if (cli_state_has_tcon(cli)) {
397 data_blob_free(&cli->user_session_key);
399 cli_state_disconnect(cli);
402 * Need to free pending first, they remove themselves
404 while (cli->conn.pending) {
405 talloc_free(cli->conn.pending[0]);
410 void cli_shutdown(struct cli_state *cli)
412 struct cli_state *cli_head;
416 DLIST_HEAD(cli, cli_head);
417 if (cli_head == cli) {
419 * head of a DFS list, shutdown all subsidiary DFS
422 struct cli_state *p, *next;
424 for (p = cli_head->next; p; p = next) {
426 DLIST_REMOVE(cli_head, p);
430 DLIST_REMOVE(cli_head, cli);
436 /****************************************************************************
437 Set socket options on a open connection.
438 ****************************************************************************/
440 void cli_sockopt(struct cli_state *cli, const char *options)
442 set_socket_options(cli->conn.fd, options);
445 const struct sockaddr_storage *cli_state_local_sockaddr(struct cli_state *cli)
447 return &cli->conn.local_ss;
450 const struct sockaddr_storage *cli_state_remote_sockaddr(struct cli_state *cli)
452 return &cli->conn.remote_ss;
455 const char *cli_state_remote_name(struct cli_state *cli)
457 return cli->conn.remote_name;
460 const char *cli_state_remote_realm(struct cli_state *cli)
462 return cli->conn.remote_realm;
465 uint16_t cli_state_get_vc_num(struct cli_state *cli)
467 return cli->smb1.vc_num;
470 uint32_t cli_state_server_session_key(struct cli_state *cli)
472 return cli->conn.smb1.server.session_key;
475 /****************************************************************************
476 Set the PID to use for smb messages. Return the old pid.
477 ****************************************************************************/
479 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
481 uint16_t ret = cli->smb1.pid;
486 uint16_t cli_getpid(struct cli_state *cli)
488 return cli->smb1.pid;
491 bool cli_state_has_tcon(struct cli_state *cli)
493 if (cli->smb1.tid == UINT16_MAX) {
500 uint16_t cli_state_get_tid(struct cli_state *cli)
502 return cli->smb1.tid;
505 uint16_t cli_state_set_tid(struct cli_state *cli, uint16_t tid)
507 uint16_t ret = cli->smb1.tid;
512 uint16_t cli_state_get_uid(struct cli_state *cli)
514 return cli->smb1.uid;
517 uint16_t cli_state_set_uid(struct cli_state *cli, uint16_t uid)
519 uint16_t ret = cli->smb1.uid;
524 /****************************************************************************
525 Set the case sensitivity flag on the packets. Returns old state.
526 ****************************************************************************/
528 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
530 bool ret = cli->case_sensitive;
531 cli->case_sensitive = case_sensitive;
535 enum protocol_types cli_state_protocol(struct cli_state *cli)
537 return cli->conn.protocol;
540 uint32_t cli_state_capabilities(struct cli_state *cli)
542 return cli->conn.smb1.capabilities;
545 uint32_t cli_state_available_size(struct cli_state *cli, uint32_t ofs)
547 uint32_t ret = cli->conn.smb1.max_xmit;
558 uint16_t cli_state_max_requests(struct cli_state *cli)
560 return cli->conn.smb1.server.max_mux;
563 const uint8_t *cli_state_server_challenge(struct cli_state *cli)
565 return cli->conn.smb1.server.challenge;
568 const DATA_BLOB *cli_state_server_gss_blob(struct cli_state *cli)
570 return &cli->conn.smb1.server.gss_blob;
573 uint16_t cli_state_security_mode(struct cli_state *cli)
575 return cli->conn.smb1.server.security_mode;
578 int cli_state_server_time_zone(struct cli_state *cli)
580 return cli->conn.smb1.server.time_zone;
583 time_t cli_state_server_time(struct cli_state *cli)
585 return cli->conn.smb1.server.system_time;
588 struct cli_echo_state {
594 static void cli_echo_done(struct tevent_req *subreq);
596 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
597 struct cli_state *cli, uint16_t num_echos,
600 struct tevent_req *req, *subreq;
601 struct cli_echo_state *state;
603 req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
607 SSVAL(state->vwv, 0, num_echos);
609 state->num_echos = num_echos;
611 subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
612 data.length, data.data);
613 if (subreq == NULL) {
616 tevent_req_set_callback(subreq, cli_echo_done, req);
623 static void cli_echo_done(struct tevent_req *subreq)
625 struct tevent_req *req = tevent_req_callback_data(
626 subreq, struct tevent_req);
627 struct cli_echo_state *state = tevent_req_data(
628 req, struct cli_echo_state);
634 status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
636 if (!NT_STATUS_IS_OK(status)) {
637 tevent_req_nterror(req, status);
640 if ((num_bytes != state->data.length)
641 || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
642 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
646 state->num_echos -=1;
647 if (state->num_echos == 0) {
648 tevent_req_done(req);
652 if (!cli_smb_req_set_pending(subreq)) {
653 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
659 * Get the result out from an echo request
660 * @param[in] req The async_req from cli_echo_send
661 * @retval Did the server reply correctly?
664 NTSTATUS cli_echo_recv(struct tevent_req *req)
666 return tevent_req_simple_recv_ntstatus(req);
670 * @brief Send/Receive SMBEcho requests
671 * @param[in] mem_ctx The memory context to put the async_req on
672 * @param[in] ev The event context that will call us back
673 * @param[in] cli The connection to send the echo to
674 * @param[in] num_echos How many times do we want to get the reply?
675 * @param[in] data The data we want to get back
676 * @retval Did the server reply correctly?
679 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
681 TALLOC_CTX *frame = talloc_stackframe();
682 struct event_context *ev;
683 struct tevent_req *req;
684 NTSTATUS status = NT_STATUS_OK;
686 if (cli_has_async_calls(cli)) {
688 * Can't use sync call while an async call is in flight
690 status = NT_STATUS_INVALID_PARAMETER;
694 ev = event_context_init(frame);
696 status = NT_STATUS_NO_MEMORY;
700 req = cli_echo_send(frame, ev, cli, num_echos, data);
702 status = NT_STATUS_NO_MEMORY;
706 if (!tevent_req_poll(req, ev)) {
707 status = map_nt_error_from_unix(errno);
711 status = cli_echo_recv(req);
718 * Is the SMB command able to hold an AND_X successor
719 * @param[in] cmd The SMB command in question
720 * @retval Can we add a chained request after "cmd"?
722 bool is_andx_req(uint8_t cmd)
742 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
743 uint8_t smb_command, uint8_t additional_flags,
744 uint8_t wct, uint16_t *vwv,
745 uint32_t num_bytes, const uint8_t *bytes,
746 struct tevent_req **result_parent,
747 uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
748 uint32_t *pnum_bytes, uint8_t **pbytes)
750 struct tevent_context *ev;
751 struct tevent_req *req = NULL;
752 NTSTATUS status = NT_STATUS_NO_MEMORY;
754 if (cli_has_async_calls(cli)) {
755 return NT_STATUS_INVALID_PARAMETER;
757 ev = tevent_context_init(mem_ctx);
761 req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
762 wct, vwv, num_bytes, bytes);
766 if (!tevent_req_poll_ntstatus(req, ev, &status)) {
769 status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
773 if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
774 *result_parent = req;