s3:libsmb: s/struct event_context/struct tevent_context
[Samba/gebeck_regimport.git] / source3 / libsmb / clientgen.c
blob821a134a6ce8f588807269a34feef08fbbfc46bd
1 /*
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/>.
21 #include "includes.h"
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"
27 #include "../libcli/smb/smbXcli_base.h"
28 #include "../librpc/ndr/libndr.h"
29 #include "../include/client.h"
31 /*******************************************************************
32 Setup the word count and byte count for a client smb message.
33 ********************************************************************/
35 int cli_set_message(char *buf,int num_words,int num_bytes,bool zero)
37 if (zero && (num_words || num_bytes)) {
38 memset(buf + smb_size,'\0',num_words*2 + num_bytes);
40 SCVAL(buf,smb_wct,num_words);
41 SSVAL(buf,smb_vwv + num_words*SIZEOFWORD,num_bytes);
42 smb_setlen(buf,smb_size + num_words*2 + num_bytes - 4);
43 return (smb_size + num_words*2 + num_bytes);
46 /****************************************************************************
47 Change the timeout (in milliseconds).
48 ****************************************************************************/
50 unsigned int cli_set_timeout(struct cli_state *cli, unsigned int timeout)
52 unsigned int old_timeout = cli->timeout;
53 cli->timeout = timeout;
54 return old_timeout;
57 /****************************************************************************
58 Set the 'backup_intent' flag.
59 ****************************************************************************/
61 bool cli_set_backup_intent(struct cli_state *cli, bool flag)
63 bool old_state = cli->backup_intent;
64 cli->backup_intent = flag;
65 return old_state;
68 /****************************************************************************
69 Initialize Domain, user or password.
70 ****************************************************************************/
72 NTSTATUS cli_set_domain(struct cli_state *cli, const char *domain)
74 TALLOC_FREE(cli->domain);
75 cli->domain = talloc_strdup(cli, domain ? domain : "");
76 if (cli->domain == NULL) {
77 return NT_STATUS_NO_MEMORY;
79 return NT_STATUS_OK;
82 NTSTATUS cli_set_username(struct cli_state *cli, const char *username)
84 TALLOC_FREE(cli->user_name);
85 cli->user_name = talloc_strdup(cli, username ? username : "");
86 if (cli->user_name == NULL) {
87 return NT_STATUS_NO_MEMORY;
89 return NT_STATUS_OK;
92 NTSTATUS cli_set_password(struct cli_state *cli, const char *password)
94 TALLOC_FREE(cli->password);
96 /* Password can be NULL. */
97 if (password) {
98 cli->password = talloc_strdup(cli, password);
99 if (cli->password == NULL) {
100 return NT_STATUS_NO_MEMORY;
102 } else {
103 /* Use zero NTLMSSP hashes and session key. */
104 cli->password = NULL;
107 return NT_STATUS_OK;
110 /****************************************************************************
111 Initialise credentials of a client structure.
112 ****************************************************************************/
114 NTSTATUS cli_init_creds(struct cli_state *cli, const char *username, const char *domain, const char *password)
116 NTSTATUS status = cli_set_username(cli, username);
117 if (!NT_STATUS_IS_OK(status)) {
118 return status;
120 status = cli_set_domain(cli, domain);
121 if (!NT_STATUS_IS_OK(status)) {
122 return status;
124 DEBUG(10,("cli_init_creds: user %s domain %s\n", cli->user_name, cli->domain));
126 return cli_set_password(cli, password);
129 /****************************************************************************
130 Initialise a client structure. Always returns a talloc'ed struct.
131 Set the signing state (used from the command line).
132 ****************************************************************************/
134 struct cli_state *cli_state_create(TALLOC_CTX *mem_ctx,
135 int fd,
136 const char *remote_name,
137 const char *remote_realm,
138 int signing_state, int flags)
140 struct cli_state *cli = NULL;
141 bool use_spnego = lp_client_use_spnego();
142 bool force_dos_errors = false;
143 bool force_ascii = false;
144 bool use_level_II_oplocks = false;
145 uint32_t smb1_capabilities = 0;
146 uint32_t smb2_capabilities = 0;
147 struct GUID client_guid = GUID_random();
149 /* Check the effective uid - make sure we are not setuid */
150 if (is_setuid_root()) {
151 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
152 return NULL;
155 cli = talloc_zero(mem_ctx, struct cli_state);
156 if (!cli) {
157 return NULL;
160 cli->server_domain = talloc_strdup(cli, "");
161 if (!cli->server_domain) {
162 goto error;
164 cli->server_os = talloc_strdup(cli, "");
165 if (!cli->server_os) {
166 goto error;
168 cli->server_type = talloc_strdup(cli, "");
169 if (!cli->server_type) {
170 goto error;
173 cli->dfs_mountpoint = talloc_strdup(cli, "");
174 if (!cli->dfs_mountpoint) {
175 goto error;
177 cli->raw_status = NT_STATUS_INTERNAL_ERROR;
178 cli->map_dos_errors = true; /* remove this */
179 cli->timeout = CLIENT_TIMEOUT;
180 cli->case_sensitive = false;
182 /* Set the CLI_FORCE_DOSERR environment variable to test
183 client routines using DOS errors instead of STATUS32
184 ones. This intended only as a temporary hack. */
185 if (getenv("CLI_FORCE_DOSERR")) {
186 force_dos_errors = true;
188 if (flags & CLI_FULL_CONNECTION_FORCE_DOS_ERRORS) {
189 force_dos_errors = true;
192 if (getenv("CLI_FORCE_ASCII")) {
193 force_ascii = true;
195 if (!lp_unicode()) {
196 force_ascii = true;
198 if (flags & CLI_FULL_CONNECTION_FORCE_ASCII) {
199 force_ascii = true;
202 if (flags & CLI_FULL_CONNECTION_DONT_SPNEGO) {
203 use_spnego = false;
204 } else if (flags & CLI_FULL_CONNECTION_USE_KERBEROS) {
205 cli->use_kerberos = true;
207 if ((flags & CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS) &&
208 cli->use_kerberos) {
209 cli->fallback_after_kerberos = true;
212 if (flags & CLI_FULL_CONNECTION_USE_CCACHE) {
213 cli->use_ccache = true;
216 if (flags & CLI_FULL_CONNECTION_USE_NT_HASH) {
217 cli->pw_nt_hash = true;
220 if (flags & CLI_FULL_CONNECTION_OPLOCKS) {
221 cli->use_oplocks = true;
223 if (flags & CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS) {
224 use_level_II_oplocks = true;
227 if (signing_state == SMB_SIGNING_DEFAULT) {
228 signing_state = lp_client_signing();
231 smb1_capabilities = 0;
232 smb1_capabilities |= CAP_LARGE_FILES;
233 smb1_capabilities |= CAP_NT_SMBS | CAP_RPC_REMOTE_APIS;
234 smb1_capabilities |= CAP_LOCK_AND_READ | CAP_NT_FIND;
235 smb1_capabilities |= CAP_DFS | CAP_W2K_SMBS;
236 smb1_capabilities |= CAP_LARGE_READX|CAP_LARGE_WRITEX;
237 smb1_capabilities |= CAP_LWIO;
239 if (!force_dos_errors) {
240 smb1_capabilities |= CAP_STATUS32;
243 if (!force_ascii) {
244 smb1_capabilities |= CAP_UNICODE;
247 if (use_spnego) {
248 smb1_capabilities |= CAP_EXTENDED_SECURITY;
251 if (use_level_II_oplocks) {
252 smb1_capabilities |= CAP_LEVEL_II_OPLOCKS;
255 smb2_capabilities = SMB2_CAP_ALL;
257 if (remote_realm) {
258 cli->remote_realm = talloc_strdup(cli, remote_realm);
259 if (cli->remote_realm == NULL) {
260 goto error;
264 cli->conn = smbXcli_conn_create(cli, fd, remote_name,
265 signing_state,
266 smb1_capabilities,
267 &client_guid,
268 smb2_capabilities);
269 if (cli->conn == NULL) {
270 goto error;
273 cli->smb1.pid = (uint16_t)getpid();
274 cli->smb1.vc_num = cli->smb1.pid;
275 cli->smb1.tcon = smbXcli_tcon_create(cli);
276 if (cli->smb1.tcon == NULL) {
277 goto error;
279 smb1cli_tcon_set_id(cli->smb1.tcon, UINT16_MAX);
280 cli->smb1.session = smbXcli_session_create(cli, cli->conn);
281 if (cli->smb1.session == NULL) {
282 goto error;
285 cli->initialised = 1;
286 return cli;
288 /* Clean up after malloc() error */
290 error:
292 TALLOC_FREE(cli);
293 return NULL;
296 /****************************************************************************
297 Close all pipes open on this session.
298 ****************************************************************************/
300 void cli_nt_pipes_close(struct cli_state *cli)
302 while (cli->pipe_list != NULL) {
304 * No TALLOC_FREE here!
306 talloc_free(cli->pipe_list);
310 /****************************************************************************
311 Shutdown a client structure.
312 ****************************************************************************/
314 static void _cli_shutdown(struct cli_state *cli)
316 cli_nt_pipes_close(cli);
319 * tell our peer to free his resources. Wihtout this, when an
320 * application attempts to do a graceful shutdown and calls
321 * smbc_free_context() to clean up all connections, some connections
322 * can remain active on the peer end, until some (long) timeout period
323 * later. This tree disconnect forces the peer to clean up, since the
324 * connection will be going away.
326 if (cli_state_has_tcon(cli)) {
327 cli_tdis(cli);
330 smbXcli_conn_disconnect(cli->conn, NT_STATUS_OK);
332 TALLOC_FREE(cli);
335 void cli_shutdown(struct cli_state *cli)
337 struct cli_state *cli_head;
338 if (cli == NULL) {
339 return;
341 DLIST_HEAD(cli, cli_head);
342 if (cli_head == cli) {
344 * head of a DFS list, shutdown all subsidiary DFS
345 * connections.
347 struct cli_state *p, *next;
349 for (p = cli_head->next; p; p = next) {
350 next = p->next;
351 DLIST_REMOVE(cli_head, p);
352 _cli_shutdown(p);
354 } else {
355 DLIST_REMOVE(cli_head, cli);
358 _cli_shutdown(cli);
361 const char *cli_state_remote_realm(struct cli_state *cli)
363 return cli->remote_realm;
366 uint16_t cli_state_get_vc_num(struct cli_state *cli)
368 return cli->smb1.vc_num;
371 /****************************************************************************
372 Set the PID to use for smb messages. Return the old pid.
373 ****************************************************************************/
375 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
377 uint16_t ret = cli->smb1.pid;
378 cli->smb1.pid = pid;
379 return ret;
382 uint16_t cli_getpid(struct cli_state *cli)
384 return cli->smb1.pid;
387 bool cli_state_has_tcon(struct cli_state *cli)
389 uint16_t tid = cli_state_get_tid(cli);
391 if (tid == UINT16_MAX) {
392 return false;
395 return true;
398 uint16_t cli_state_get_tid(struct cli_state *cli)
400 return smb1cli_tcon_current_id(cli->smb1.tcon);
403 uint16_t cli_state_set_tid(struct cli_state *cli, uint16_t tid)
405 uint16_t ret = smb1cli_tcon_current_id(cli->smb1.tcon);
406 smb1cli_tcon_set_id(cli->smb1.tcon, tid);
407 return ret;
410 uint16_t cli_state_get_uid(struct cli_state *cli)
412 return smb1cli_session_current_id(cli->smb1.session);
415 uint16_t cli_state_set_uid(struct cli_state *cli, uint16_t uid)
417 uint16_t ret = smb1cli_session_current_id(cli->smb1.session);
418 smb1cli_session_set_id(cli->smb1.session, uid);
419 return ret;
422 /****************************************************************************
423 Set the case sensitivity flag on the packets. Returns old state.
424 ****************************************************************************/
426 bool cli_set_case_sensitive(struct cli_state *cli, bool case_sensitive)
428 bool ret = cli->case_sensitive;
429 cli->case_sensitive = case_sensitive;
430 return ret;
433 uint32_t cli_state_available_size(struct cli_state *cli, uint32_t ofs)
435 uint32_t ret = smb1cli_conn_max_xmit(cli->conn);
437 if (ofs >= ret) {
438 return 0;
441 ret -= ofs;
443 return ret;
446 time_t cli_state_server_time(struct cli_state *cli)
448 NTTIME nt;
449 time_t t;
451 nt = smbXcli_conn_server_system_time(cli->conn);
452 t = nt_time_to_unix(nt);
454 return t;
457 struct cli_echo_state {
458 bool is_smb2;
461 static void cli_echo_done(struct tevent_req *subreq);
463 struct tevent_req *cli_echo_send(TALLOC_CTX *mem_ctx, struct tevent_context *ev,
464 struct cli_state *cli, uint16_t num_echos,
465 DATA_BLOB data)
467 struct tevent_req *req, *subreq;
468 struct cli_echo_state *state;
470 req = tevent_req_create(mem_ctx, &state, struct cli_echo_state);
471 if (req == NULL) {
472 return NULL;
475 if (smbXcli_conn_protocol(cli->conn) >= PROTOCOL_SMB2_02) {
476 state->is_smb2 = true;
477 subreq = smb2cli_echo_send(state, ev,
478 cli->conn,
479 cli->timeout);
480 } else {
481 subreq = smb1cli_echo_send(state, ev,
482 cli->conn,
483 cli->timeout,
484 num_echos,
485 data);
487 if (tevent_req_nomem(subreq, req)) {
488 return tevent_req_post(req, ev);
490 tevent_req_set_callback(subreq, cli_echo_done, req);
492 return req;
495 static void cli_echo_done(struct tevent_req *subreq)
497 struct tevent_req *req = tevent_req_callback_data(
498 subreq, struct tevent_req);
499 struct cli_echo_state *state = tevent_req_data(
500 req, struct cli_echo_state);
501 NTSTATUS status;
503 if (state->is_smb2) {
504 status = smb2cli_echo_recv(subreq);
505 } else {
506 status = smb1cli_echo_recv(subreq);
508 TALLOC_FREE(subreq);
509 if (!NT_STATUS_IS_OK(status)) {
510 tevent_req_nterror(req, status);
511 return;
514 tevent_req_done(req);
518 * Get the result out from an echo request
519 * @param[in] req The async_req from cli_echo_send
520 * @retval Did the server reply correctly?
523 NTSTATUS cli_echo_recv(struct tevent_req *req)
525 return tevent_req_simple_recv_ntstatus(req);
529 * @brief Send/Receive SMBEcho requests
530 * @param[in] mem_ctx The memory context to put the async_req on
531 * @param[in] ev The event context that will call us back
532 * @param[in] cli The connection to send the echo to
533 * @param[in] num_echos How many times do we want to get the reply?
534 * @param[in] data The data we want to get back
535 * @retval Did the server reply correctly?
538 NTSTATUS cli_echo(struct cli_state *cli, uint16_t num_echos, DATA_BLOB data)
540 TALLOC_CTX *frame = talloc_stackframe();
541 struct tevent_context *ev;
542 struct tevent_req *req;
543 NTSTATUS status = NT_STATUS_OK;
545 if (smbXcli_conn_has_async_calls(cli->conn)) {
547 * Can't use sync call while an async call is in flight
549 status = NT_STATUS_INVALID_PARAMETER;
550 goto fail;
553 ev = samba_tevent_context_init(frame);
554 if (ev == NULL) {
555 status = NT_STATUS_NO_MEMORY;
556 goto fail;
559 req = cli_echo_send(frame, ev, cli, num_echos, data);
560 if (req == NULL) {
561 status = NT_STATUS_NO_MEMORY;
562 goto fail;
565 if (!tevent_req_poll(req, ev)) {
566 status = map_nt_error_from_unix(errno);
567 goto fail;
570 status = cli_echo_recv(req);
571 fail:
572 TALLOC_FREE(frame);
573 return status;
577 * Is the SMB command able to hold an AND_X successor
578 * @param[in] cmd The SMB command in question
579 * @retval Can we add a chained request after "cmd"?
581 bool is_andx_req(uint8_t cmd)
583 switch (cmd) {
584 case SMBtconX:
585 case SMBlockingX:
586 case SMBopenX:
587 case SMBreadX:
588 case SMBwriteX:
589 case SMBsesssetupX:
590 case SMBulogoffX:
591 case SMBntcreateX:
592 return true;
593 break;
594 default:
595 break;
598 return false;
601 NTSTATUS cli_smb(TALLOC_CTX *mem_ctx, struct cli_state *cli,
602 uint8_t smb_command, uint8_t additional_flags,
603 uint8_t wct, uint16_t *vwv,
604 uint32_t num_bytes, const uint8_t *bytes,
605 struct tevent_req **result_parent,
606 uint8_t min_wct, uint8_t *pwct, uint16_t **pvwv,
607 uint32_t *pnum_bytes, uint8_t **pbytes)
609 struct tevent_context *ev;
610 struct tevent_req *req = NULL;
611 NTSTATUS status = NT_STATUS_NO_MEMORY;
613 if (smbXcli_conn_has_async_calls(cli->conn)) {
614 return NT_STATUS_INVALID_PARAMETER;
616 ev = samba_tevent_context_init(mem_ctx);
617 if (ev == NULL) {
618 goto fail;
620 req = cli_smb_send(mem_ctx, ev, cli, smb_command, additional_flags,
621 wct, vwv, num_bytes, bytes);
622 if (req == NULL) {
623 goto fail;
625 if (!tevent_req_poll_ntstatus(req, ev, &status)) {
626 goto fail;
628 status = cli_smb_recv(req, NULL, NULL, min_wct, pwct, pvwv,
629 pnum_bytes, pbytes);
630 fail:
631 TALLOC_FREE(ev);
632 if (NT_STATUS_IS_OK(status) && (result_parent != NULL)) {
633 *result_parent = req;
635 return status;