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->capabilities & 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,cli->smb1.mid);
76 if (cli->protocol <= 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->capabilities & CAP_UNICODE)
88 flags2 |= FLAGS2_UNICODE_STRINGS;
89 if ((cli->capabilities & CAP_DFS) && cli->dfsroot)
90 flags2 |= FLAGS2_DFS_PATHNAMES;
91 if (cli->capabilities & CAP_STATUS32)
92 flags2 |= FLAGS2_32_BIT_ERROR_CODES;
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 *desthost,
169 struct cli_state *cli = NULL;
170 bool allow_smb_signing = false;
171 bool mandatory_signing = false;
175 /* Check the effective uid - make sure we are not setuid */
176 if (is_setuid_root()) {
177 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
181 cli = talloc_zero(mem_ctx, struct cli_state);
186 cli->dfs_mountpoint = talloc_strdup(cli, "");
187 if (!cli->dfs_mountpoint) {
190 cli->raw_status = NT_STATUS_INTERNAL_ERROR;
191 cli->protocol = PROTOCOL_NT1;
192 cli->timeout = 20000; /* Timeout is in milliseconds. */
193 cli->max_xmit = CLI_BUFFER_SIZE+4;
194 cli->case_sensitive = false;
196 cli->use_spnego = lp_client_use_spnego();
198 cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
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 cli->force_dos_errors = true;
206 if (lp_client_signing()) {
207 allow_smb_signing = true;
210 if (lp_client_signing() == Required) {
211 mandatory_signing = true;
214 if (signing_state != Undefined) {
215 allow_smb_signing = true;
218 if (signing_state == false) {
219 allow_smb_signing = false;
220 mandatory_signing = false;
223 if (signing_state == Required) {
224 mandatory_signing = true;
227 /* initialise signing */
228 cli->signing_state = smb_signing_init(cli,
231 if (!cli->signing_state) {
235 cli->conn.outgoing = tevent_queue_create(cli, "cli_outgoing");
236 if (cli->conn.outgoing == NULL) {
239 cli->conn.pending = NULL;
241 cli->desthost = talloc_strdup(cli, desthost);
242 if (cli->desthost == NULL) {
248 ss_length = sizeof(cli->src_ss);
249 ret = getsockname(fd,
250 (struct sockaddr *)(void *)&cli->src_ss,
255 ss_length = sizeof(cli->dest_ss);
256 ret = getpeername(fd,
257 (struct sockaddr *)(void *)&cli->dest_ss,
264 cli->smb1.pid = (uint16_t)sys_getpid();
265 cli->smb1.vc_num = cli->smb1.pid;
266 cli->smb1.tid = UINT16_MAX;
267 cli->smb1.uid = UID_FIELD_INVALID;
269 cli->initialised = 1;
272 /* Clean up after malloc() error */
280 bool cli_state_encryption_on(struct cli_state *cli)
282 return common_encryption_on(cli->trans_enc_state);
286 /****************************************************************************
287 Close all pipes open on this session.
288 ****************************************************************************/
290 void cli_nt_pipes_close(struct cli_state *cli)
292 while (cli->pipe_list != NULL) {
294 * No TALLOC_FREE here!
296 talloc_free(cli->pipe_list);
300 /****************************************************************************
301 Shutdown a client structure.
302 ****************************************************************************/
304 static void _cli_shutdown(struct cli_state *cli)
306 cli_nt_pipes_close(cli);
309 * tell our peer to free his resources. Wihtout this, when an
310 * application attempts to do a graceful shutdown and calls
311 * smbc_free_context() to clean up all connections, some connections
312 * can remain active on the peer end, until some (long) timeout period
313 * later. This tree disconnect forces the peer to clean up, since the
314 * connection will be going away.
316 if (cli_state_has_tcon(cli)) {
320 data_blob_free(&cli->secblob);
321 data_blob_free(&cli->user_session_key);
323 cli_state_disconnect(cli);
326 * Need to free pending first, they remove themselves
328 while (cli->conn.pending) {
329 talloc_free(cli->conn.pending[0]);
334 void cli_shutdown(struct cli_state *cli)
336 struct cli_state *cli_head;
340 DLIST_HEAD(cli, cli_head);
341 if (cli_head == cli) {
343 * head of a DFS list, shutdown all subsidiary DFS
346 struct cli_state *p, *next;
348 for (p = cli_head->next; p; p = next) {
350 DLIST_REMOVE(cli_head, p);
354 DLIST_REMOVE(cli_head, cli);
360 /****************************************************************************
361 Set socket options on a open connection.
362 ****************************************************************************/
364 void cli_sockopt(struct cli_state *cli, const char *options)
366 set_socket_options(cli->conn.fd, options);
369 const struct sockaddr_storage *cli_state_local_sockaddr(struct cli_state *cli)
374 const struct sockaddr_storage *cli_state_remote_sockaddr(struct cli_state *cli)
376 return &cli->dest_ss;
379 uint16_t cli_state_get_vc_num(struct cli_state *cli)
381 return cli->smb1.vc_num;
384 /****************************************************************************
385 Set the PID to use for smb messages. Return the old pid.
386 ****************************************************************************/
388 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
390 uint16_t ret = cli->smb1.pid;
395 uint16_t cli_getpid(struct cli_state *cli)
397 return cli->smb1.pid;
400 bool cli_state_has_tcon(struct cli_state *cli)
402 if (cli->smb1.tid == UINT16_MAX) {
409 uint16_t cli_state_get_tid(struct cli_state *cli)
411 return cli->smb1.tid;
414 uint16_t cli_state_set_tid(struct cli_state *cli, uint16_t tid)
416 uint16_t ret = cli->smb1.tid;
421 uint16_t cli_state_get_uid(struct cli_state *cli)
423 return cli->smb1.uid;
426 uint16_t cli_state_set_uid(struct cli_state *cli, uint16_t uid)
428 uint16_t ret = cli->smb1.uid;
433 /****************************************************************************
434 Set the case sensitivity flag on the packets. Returns old state.
435 ****************************************************************************/
437 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
439 bool ret = cli->case_sensitive;
440 cli->case_sensitive = case_sensitive;
444 struct cli_echo_state {
450 static void cli_echo_done(struct tevent_req *subreq);
452 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
453 struct cli_state *cli, uint16_t num_echos,
456 struct tevent_req *req, *subreq;
457 struct cli_echo_state *state;
459 req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
463 SSVAL(state->vwv, 0, num_echos);
465 state->num_echos = num_echos;
467 subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
468 data.length, data.data);
469 if (subreq == NULL) {
472 tevent_req_set_callback(subreq, cli_echo_done, req);
479 static void cli_echo_done(struct tevent_req *subreq)
481 struct tevent_req *req = tevent_req_callback_data(
482 subreq, struct tevent_req);
483 struct cli_echo_state *state = tevent_req_data(
484 req, struct cli_echo_state);
490 status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
492 if (!NT_STATUS_IS_OK(status)) {
493 tevent_req_nterror(req, status);
496 if ((num_bytes != state->data.length)
497 || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
498 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
502 state->num_echos -=1;
503 if (state->num_echos == 0) {
504 tevent_req_done(req);
508 if (!cli_smb_req_set_pending(subreq)) {
509 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
515 * Get the result out from an echo request
516 * @param[in] req The async_req from cli_echo_send
517 * @retval Did the server reply correctly?
520 NTSTATUS cli_echo_recv(struct tevent_req *req)
522 return tevent_req_simple_recv_ntstatus(req);
526 * @brief Send/Receive SMBEcho requests
527 * @param[in] mem_ctx The memory context to put the async_req on
528 * @param[in] ev The event context that will call us back
529 * @param[in] cli The connection to send the echo to
530 * @param[in] num_echos How many times do we want to get the reply?
531 * @param[in] data The data we want to get back
532 * @retval Did the server reply correctly?
535 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
537 TALLOC_CTX *frame = talloc_stackframe();
538 struct event_context *ev;
539 struct tevent_req *req;
540 NTSTATUS status = NT_STATUS_OK;
542 if (cli_has_async_calls(cli)) {
544 * Can't use sync call while an async call is in flight
546 status = NT_STATUS_INVALID_PARAMETER;
550 ev = event_context_init(frame);
552 status = NT_STATUS_NO_MEMORY;
556 req = cli_echo_send(frame, ev, cli, num_echos, data);
558 status = NT_STATUS_NO_MEMORY;
562 if (!tevent_req_poll(req, ev)) {
563 status = map_nt_error_from_unix(errno);
567 status = cli_echo_recv(req);
574 * Is the SMB command able to hold an AND_X successor
575 * @param[in] cmd The SMB command in question
576 * @retval Can we add a chained request after "cmd"?
578 bool is_andx_req(uint8_t cmd)
598 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
599 uint8_t smb_command, uint8_t additional_flags,
600 uint8_t wct, uint16_t *vwv,
601 uint32_t num_bytes, const uint8_t *bytes,
602 struct tevent_req **result_parent,
603 uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
604 uint32_t *pnum_bytes, uint8_t **pbytes)
606 struct tevent_context *ev;
607 struct tevent_req *req = NULL;
608 NTSTATUS status = NT_STATUS_NO_MEMORY;
610 if (cli_has_async_calls(cli)) {
611 return NT_STATUS_INVALID_PARAMETER;
613 ev = tevent_context_init(mem_ctx);
617 req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
618 wct, vwv, num_bytes, bytes);
622 if (!tevent_req_poll_ntstatus(req, ev, &status)) {
625 status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
629 if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
630 *result_parent = req;