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->vuid);
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_initialise_ex(int signing_state)
166 struct cli_state *cli = NULL;
167 bool allow_smb_signing = false;
168 bool mandatory_signing = false;
170 /* Check the effective uid - make sure we are not setuid */
171 if (is_setuid_root()) {
172 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
176 cli = talloc_zero(NULL, struct cli_state);
181 cli->dfs_mountpoint = talloc_strdup(cli, "");
182 if (!cli->dfs_mountpoint) {
186 cli->raw_status = NT_STATUS_INTERNAL_ERROR;
188 cli->vuid = UID_FIELD_INVALID;
189 cli->protocol = PROTOCOL_NT1;
190 cli->timeout = 20000; /* Timeout is in milliseconds. */
191 cli->max_xmit = CLI_BUFFER_SIZE+4;
192 cli->case_sensitive = false;
194 cli->use_spnego = lp_client_use_spnego();
196 cli->capabilities = CAP_UNICODE | CAP_STATUS32 | CAP_DFS;
198 /* Set the CLI_FORCE_DOSERR environment variable to test
199 client routines using DOS errors instead of STATUS32
200 ones. This intended only as a temporary hack. */
201 if (getenv("CLI_FORCE_DOSERR"))
202 cli->force_dos_errors = true;
204 if (lp_client_signing()) {
205 allow_smb_signing = true;
208 if (lp_client_signing() == Required) {
209 mandatory_signing = true;
212 if (signing_state != Undefined) {
213 allow_smb_signing = true;
216 if (signing_state == false) {
217 allow_smb_signing = false;
218 mandatory_signing = false;
221 if (signing_state == Required) {
222 mandatory_signing = true;
225 /* initialise signing */
226 cli->signing_state = smb_signing_init(cli,
229 if (!cli->signing_state) {
233 cli->outgoing = tevent_queue_create(cli, "cli_outgoing");
234 if (cli->outgoing == NULL) {
239 cli->initialised = 1;
242 cli->smb1.pid = (uint16_t)sys_getpid();
243 cli->smb1.vc_num = cli->smb1.pid;
247 /* Clean up after malloc() error */
255 struct cli_state *cli_initialise(void)
257 return cli_initialise_ex(Undefined);
260 /****************************************************************************
261 Close all pipes open on this session.
262 ****************************************************************************/
264 void cli_nt_pipes_close(struct cli_state *cli)
266 while (cli->pipe_list != NULL) {
268 * No TALLOC_FREE here!
270 talloc_free(cli->pipe_list);
274 /****************************************************************************
275 Shutdown a client structure.
276 ****************************************************************************/
278 static void _cli_shutdown(struct cli_state *cli)
280 cli_nt_pipes_close(cli);
283 * tell our peer to free his resources. Wihtout this, when an
284 * application attempts to do a graceful shutdown and calls
285 * smbc_free_context() to clean up all connections, some connections
286 * can remain active on the peer end, until some (long) timeout period
287 * later. This tree disconnect forces the peer to clean up, since the
288 * connection will be going away.
290 if (cli->cnum != (uint16)-1) {
294 data_blob_free(&cli->secblob);
295 data_blob_free(&cli->user_session_key);
303 * Need to free pending first, they remove themselves
305 while (cli->pending) {
306 talloc_free(cli->pending[0]);
311 void cli_shutdown(struct cli_state *cli)
313 struct cli_state *cli_head;
317 DLIST_HEAD(cli, cli_head);
318 if (cli_head == cli) {
320 * head of a DFS list, shutdown all subsidiary DFS
323 struct cli_state *p, *next;
325 for (p = cli_head->next; p; p = next) {
327 DLIST_REMOVE(cli_head, p);
331 DLIST_REMOVE(cli_head, cli);
337 /****************************************************************************
338 Set socket options on a open connection.
339 ****************************************************************************/
341 void cli_sockopt(struct cli_state *cli, const char *options)
343 set_socket_options(cli->fd, options);
346 uint16_t cli_state_get_vc_num(struct cli_state *cli)
348 return cli->smb1.vc_num;
351 /****************************************************************************
352 Set the PID to use for smb messages. Return the old pid.
353 ****************************************************************************/
355 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
357 uint16_t ret = cli->smb1.pid;
362 uint16_t cli_getpid(struct cli_state *cli)
364 return cli->smb1.pid;
367 /****************************************************************************
368 Set the case sensitivity flag on the packets. Returns old state.
369 ****************************************************************************/
371 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
373 bool ret = cli->case_sensitive;
374 cli->case_sensitive = case_sensitive;
378 struct cli_echo_state {
384 static void cli_echo_done(struct tevent_req *subreq);
386 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct event_context *ev,
387 struct cli_state *cli, uint16_t num_echos,
390 struct tevent_req *req, *subreq;
391 struct cli_echo_state *state;
393 req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
397 SSVAL(state->vwv, 0, num_echos);
399 state->num_echos = num_echos;
401 subreq = cli_smb_send(state, ev, cli, SMBecho, 0, 1, state->vwv,
402 data.length, data.data);
403 if (subreq == NULL) {
406 tevent_req_set_callback(subreq, cli_echo_done, req);
413 static void cli_echo_done(struct tevent_req *subreq)
415 struct tevent_req *req = tevent_req_callback_data(
416 subreq, struct tevent_req);
417 struct cli_echo_state *state = tevent_req_data(
418 req, struct cli_echo_state);
424 status = cli_smb_recv(subreq, state, &inbuf, 0, NULL, NULL,
426 if (!NT_STATUS_IS_OK(status)) {
427 tevent_req_nterror(req, status);
430 if ((num_bytes != state->data.length)
431 || (memcmp(bytes, state->data.data, num_bytes) != 0)) {
432 tevent_req_nterror(req, NT_STATUS_INVALID_NETWORK_RESPONSE);
436 state->num_echos -=1;
437 if (state->num_echos == 0) {
438 tevent_req_done(req);
442 if (!cli_smb_req_set_pending(subreq)) {
443 tevent_req_nterror(req, NT_STATUS_NO_MEMORY);
449 * Get the result out from an echo request
450 * @param[in] req The async_req from cli_echo_send
451 * @retval Did the server reply correctly?
454 NTSTATUS cli_echo_recv(struct tevent_req *req)
456 return tevent_req_simple_recv_ntstatus(req);
460 * @brief Send/Receive SMBEcho requests
461 * @param[in] mem_ctx The memory context to put the async_req on
462 * @param[in] ev The event context that will call us back
463 * @param[in] cli The connection to send the echo to
464 * @param[in] num_echos How many times do we want to get the reply?
465 * @param[in] data The data we want to get back
466 * @retval Did the server reply correctly?
469 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
471 TALLOC_CTX *frame = talloc_stackframe();
472 struct event_context *ev;
473 struct tevent_req *req;
474 NTSTATUS status = NT_STATUS_OK;
476 if (cli_has_async_calls(cli)) {
478 * Can't use sync call while an async call is in flight
480 status = NT_STATUS_INVALID_PARAMETER;
484 ev = event_context_init(frame);
486 status = NT_STATUS_NO_MEMORY;
490 req = cli_echo_send(frame, ev, cli, num_echos, data);
492 status = NT_STATUS_NO_MEMORY;
496 if (!tevent_req_poll(req, ev)) {
497 status = map_nt_error_from_unix(errno);
501 status = cli_echo_recv(req);
508 * Is the SMB command able to hold an AND_X successor
509 * @param[in] cmd The SMB command in question
510 * @retval Can we add a chained request after "cmd"?
512 bool is_andx_req(uint8_t cmd)
532 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
533 uint8_t smb_command, uint8_t additional_flags,
534 uint8_t wct, uint16_t *vwv,
535 uint32_t num_bytes, const uint8_t *bytes,
536 struct tevent_req **result_parent,
537 uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
538 uint32_t *pnum_bytes, uint8_t **pbytes)
540 struct tevent_context *ev;
541 struct tevent_req *req = NULL;
542 NTSTATUS status = NT_STATUS_NO_MEMORY;
544 if (cli_has_async_calls(cli)) {
545 return NT_STATUS_INVALID_PARAMETER;
547 ev = tevent_context_init(mem_ctx);
551 req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
552 wct, vwv, num_bytes, bytes);
556 if (!tevent_req_poll_ntstatus(req, ev, &status)) {
559 status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
563 if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
564 *result_parent = req;