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"
27 #include "../libcli/smb/smbXcli_base.h"
28 #include "../librpc/ndr/libndr.h"
30 /*******************************************************************
31 Setup the word count and byte count for a client smb message.
32 ********************************************************************/
34 int cli_set_message(char *buf
,int num_words
,int num_bytes
,bool zero
)
36 if (zero
&& (num_words
|| num_bytes
)) {
37 memset(buf
+ smb_size
,'\0',num_words
*2 + num_bytes
);
39 SCVAL(buf
,smb_wct
,num_words
);
40 SSVAL(buf
,smb_vwv
+ num_words
*SIZEOFWORD
,num_bytes
);
41 smb_setlen(buf
,smb_size
+ num_words
*2 + num_bytes
- 4);
42 return (smb_size
+ num_words
*2 + num_bytes
);
45 /****************************************************************************
46 Change the timeout (in milliseconds).
47 ****************************************************************************/
49 unsigned int cli_set_timeout(struct cli_state
*cli
, unsigned int timeout
)
51 unsigned int old_timeout
= cli
->timeout
;
52 cli
->timeout
= timeout
;
56 /****************************************************************************
57 Set the 'backup_intent' flag.
58 ****************************************************************************/
60 bool cli_set_backup_intent(struct cli_state
*cli
, bool flag
)
62 bool old_state
= cli
->backup_intent
;
63 cli
->backup_intent
= flag
;
67 /****************************************************************************
68 Initialize Domain, user or password.
69 ****************************************************************************/
71 NTSTATUS
cli_set_domain(struct cli_state
*cli
, const char *domain
)
73 TALLOC_FREE(cli
->domain
);
74 cli
->domain
= talloc_strdup(cli
, domain
? domain
: "");
75 if (cli
->domain
== NULL
) {
76 return NT_STATUS_NO_MEMORY
;
81 NTSTATUS
cli_set_username(struct cli_state
*cli
, const char *username
)
83 TALLOC_FREE(cli
->user_name
);
84 cli
->user_name
= talloc_strdup(cli
, username
? username
: "");
85 if (cli
->user_name
== NULL
) {
86 return NT_STATUS_NO_MEMORY
;
91 NTSTATUS
cli_set_password(struct cli_state
*cli
, const char *password
)
93 TALLOC_FREE(cli
->password
);
95 /* Password can be NULL. */
97 cli
->password
= talloc_strdup(cli
, password
);
98 if (cli
->password
== NULL
) {
99 return NT_STATUS_NO_MEMORY
;
102 /* Use zero NTLMSSP hashes and session key. */
103 cli
->password
= NULL
;
109 /****************************************************************************
110 Initialise credentials of a client structure.
111 ****************************************************************************/
113 NTSTATUS
cli_init_creds(struct cli_state
*cli
, const char *username
, const char *domain
, const char *password
)
115 NTSTATUS status
= cli_set_username(cli
, username
);
116 if (!NT_STATUS_IS_OK(status
)) {
119 status
= cli_set_domain(cli
, domain
);
120 if (!NT_STATUS_IS_OK(status
)) {
123 DEBUG(10,("cli_init_creds: user %s domain %s\n", cli
->user_name
, cli
->domain
));
125 return cli_set_password(cli
, password
);
128 /****************************************************************************
129 Initialise a client structure. Always returns a talloc'ed struct.
130 Set the signing state (used from the command line).
131 ****************************************************************************/
133 struct cli_state
*cli_state_create(TALLOC_CTX
*mem_ctx
,
135 const char *remote_name
,
136 const char *remote_realm
,
137 int signing_state
, int flags
)
139 struct cli_state
*cli
= NULL
;
140 bool use_spnego
= lp_client_use_spnego();
141 bool force_dos_errors
= false;
142 bool force_ascii
= false;
143 bool use_level_II_oplocks
= false;
144 uint32_t smb1_capabilities
= 0;
145 uint32_t smb2_capabilities
= 0;
146 struct GUID client_guid
= GUID_random();
148 /* Check the effective uid - make sure we are not setuid */
149 if (is_setuid_root()) {
150 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
154 cli
= talloc_zero(mem_ctx
, struct cli_state
);
159 cli
->server_domain
= talloc_strdup(cli
, "");
160 if (!cli
->server_domain
) {
163 cli
->server_os
= talloc_strdup(cli
, "");
164 if (!cli
->server_os
) {
167 cli
->server_type
= talloc_strdup(cli
, "");
168 if (!cli
->server_type
) {
172 cli
->dfs_mountpoint
= talloc_strdup(cli
, "");
173 if (!cli
->dfs_mountpoint
) {
176 cli
->raw_status
= NT_STATUS_INTERNAL_ERROR
;
177 cli
->map_dos_errors
= true; /* remove this */
178 cli
->timeout
= 20000; /* Timeout is in milliseconds. */
179 cli
->case_sensitive
= false;
181 /* Set the CLI_FORCE_DOSERR environment variable to test
182 client routines using DOS errors instead of STATUS32
183 ones. This intended only as a temporary hack. */
184 if (getenv("CLI_FORCE_DOSERR")) {
185 force_dos_errors
= true;
187 if (flags
& CLI_FULL_CONNECTION_FORCE_DOS_ERRORS
) {
188 force_dos_errors
= true;
191 if (getenv("CLI_FORCE_ASCII")) {
194 if (flags
& CLI_FULL_CONNECTION_FORCE_ASCII
) {
198 if (flags
& CLI_FULL_CONNECTION_DONT_SPNEGO
) {
200 } else if (flags
& CLI_FULL_CONNECTION_USE_KERBEROS
) {
201 cli
->use_kerberos
= true;
203 if ((flags
& CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS
) &&
205 cli
->fallback_after_kerberos
= true;
208 if (flags
& CLI_FULL_CONNECTION_USE_CCACHE
) {
209 cli
->use_ccache
= true;
212 if (flags
& CLI_FULL_CONNECTION_USE_NT_HASH
) {
213 cli
->pw_nt_hash
= true;
216 if (flags
& CLI_FULL_CONNECTION_OPLOCKS
) {
217 cli
->use_oplocks
= true;
219 if (flags
& CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS
) {
220 use_level_II_oplocks
= true;
223 if (signing_state
== SMB_SIGNING_DEFAULT
) {
224 signing_state
= lp_client_signing();
227 smb1_capabilities
= 0;
228 smb1_capabilities
|= CAP_LARGE_FILES
;
229 smb1_capabilities
|= CAP_NT_SMBS
| CAP_RPC_REMOTE_APIS
;
230 smb1_capabilities
|= CAP_LOCK_AND_READ
| CAP_NT_FIND
;
231 smb1_capabilities
|= CAP_DFS
| CAP_W2K_SMBS
;
232 smb1_capabilities
|= CAP_LARGE_READX
|CAP_LARGE_WRITEX
;
233 smb1_capabilities
|= CAP_LWIO
;
235 if (!force_dos_errors
) {
236 smb1_capabilities
|= CAP_STATUS32
;
240 smb1_capabilities
|= CAP_UNICODE
;
244 smb1_capabilities
|= CAP_EXTENDED_SECURITY
;
247 if (use_level_II_oplocks
) {
248 smb1_capabilities
|= CAP_LEVEL_II_OPLOCKS
;
251 smb2_capabilities
= SMB2_CAP_ALL
;
254 cli
->remote_realm
= talloc_strdup(cli
, remote_realm
);
255 if (cli
->remote_realm
== NULL
) {
260 cli
->conn
= smbXcli_conn_create(cli
, fd
, remote_name
,
265 if (cli
->conn
== NULL
) {
269 cli
->smb1
.pid
= (uint16_t)getpid();
270 cli
->smb1
.vc_num
= cli
->smb1
.pid
;
271 cli
->smb1
.tid
= UINT16_MAX
;
272 cli
->smb1
.uid
= UID_FIELD_INVALID
;
274 cli
->initialised
= 1;
277 /* Clean up after malloc() error */
285 /****************************************************************************
286 Close all pipes open on this session.
287 ****************************************************************************/
289 void cli_nt_pipes_close(struct cli_state
*cli
)
291 while (cli
->pipe_list
!= NULL
) {
293 * No TALLOC_FREE here!
295 talloc_free(cli
->pipe_list
);
299 /****************************************************************************
300 Shutdown a client structure.
301 ****************************************************************************/
303 static void _cli_shutdown(struct cli_state
*cli
)
305 cli_nt_pipes_close(cli
);
308 * tell our peer to free his resources. Wihtout this, when an
309 * application attempts to do a graceful shutdown and calls
310 * smbc_free_context() to clean up all connections, some connections
311 * can remain active on the peer end, until some (long) timeout period
312 * later. This tree disconnect forces the peer to clean up, since the
313 * connection will be going away.
315 if (cli_state_has_tcon(cli
)) {
319 data_blob_free(&cli
->user_session_key
);
321 smbXcli_conn_disconnect(cli
->conn
, NT_STATUS_OK
);
326 void cli_shutdown(struct cli_state
*cli
)
328 struct cli_state
*cli_head
;
332 DLIST_HEAD(cli
, cli_head
);
333 if (cli_head
== cli
) {
335 * head of a DFS list, shutdown all subsidiary DFS
338 struct cli_state
*p
, *next
;
340 for (p
= cli_head
->next
; p
; p
= next
) {
342 DLIST_REMOVE(cli_head
, p
);
346 DLIST_REMOVE(cli_head
, cli
);
352 const char *cli_state_remote_realm(struct cli_state
*cli
)
354 return cli
->remote_realm
;
357 uint16_t cli_state_get_vc_num(struct cli_state
*cli
)
359 return cli
->smb1
.vc_num
;
362 /****************************************************************************
363 Set the PID to use for smb messages. Return the old pid.
364 ****************************************************************************/
366 uint16
cli_setpid(struct cli_state
*cli
, uint16 pid
)
368 uint16_t ret
= cli
->smb1
.pid
;
373 uint16_t cli_getpid(struct cli_state
*cli
)
375 return cli
->smb1
.pid
;
378 bool cli_state_has_tcon(struct cli_state
*cli
)
380 if (cli
->smb1
.tid
== UINT16_MAX
) {
387 uint16_t cli_state_get_tid(struct cli_state
*cli
)
389 return cli
->smb1
.tid
;
392 uint16_t cli_state_set_tid(struct cli_state
*cli
, uint16_t tid
)
394 uint16_t ret
= cli
->smb1
.tid
;
399 uint16_t cli_state_get_uid(struct cli_state
*cli
)
401 return cli
->smb1
.uid
;
404 uint16_t cli_state_set_uid(struct cli_state
*cli
, uint16_t uid
)
406 uint16_t ret
= cli
->smb1
.uid
;
411 /****************************************************************************
412 Set the case sensitivity flag on the packets. Returns old state.
413 ****************************************************************************/
415 bool cli_set_case_sensitive(struct cli_state
*cli
, bool case_sensitive
)
417 bool ret
= cli
->case_sensitive
;
418 cli
->case_sensitive
= case_sensitive
;
422 uint32_t cli_state_available_size(struct cli_state
*cli
, uint32_t ofs
)
424 uint32_t ret
= smb1cli_conn_max_xmit(cli
->conn
);
435 time_t cli_state_server_time(struct cli_state
*cli
)
440 nt
= smbXcli_conn_server_system_time(cli
->conn
);
441 t
= nt_time_to_unix(nt
);
446 struct cli_echo_state
{
452 static void cli_echo_done(struct tevent_req
*subreq
);
454 struct tevent_req
*cli_echo_send(TALLOC_CTX
*mem_ctx
, struct event_context
*ev
,
455 struct cli_state
*cli
, uint16_t num_echos
,
458 struct tevent_req
*req
, *subreq
;
459 struct cli_echo_state
*state
;
461 req
= tevent_req_create(mem_ctx
, &state
, struct cli_echo_state
);
465 SSVAL(state
->vwv
, 0, num_echos
);
467 state
->num_echos
= num_echos
;
469 subreq
= cli_smb_send(state
, ev
, cli
, SMBecho
, 0, 1, state
->vwv
,
470 data
.length
, data
.data
);
471 if (subreq
== NULL
) {
474 tevent_req_set_callback(subreq
, cli_echo_done
, req
);
481 static void cli_echo_done(struct tevent_req
*subreq
)
483 struct tevent_req
*req
= tevent_req_callback_data(
484 subreq
, struct tevent_req
);
485 struct cli_echo_state
*state
= tevent_req_data(
486 req
, struct cli_echo_state
);
491 status
= cli_smb_recv(subreq
, state
, NULL
, 0, NULL
, NULL
,
493 if (!NT_STATUS_IS_OK(status
)) {
494 tevent_req_nterror(req
, status
);
497 if ((num_bytes
!= state
->data
.length
)
498 || (memcmp(bytes
, state
->data
.data
, num_bytes
) != 0)) {
499 tevent_req_nterror(req
, NT_STATUS_INVALID_NETWORK_RESPONSE
);
503 state
->num_echos
-=1;
504 if (state
->num_echos
== 0) {
505 tevent_req_done(req
);
509 if (!smbXcli_req_set_pending(subreq
)) {
510 tevent_req_nterror(req
, NT_STATUS_NO_MEMORY
);
516 * Get the result out from an echo request
517 * @param[in] req The async_req from cli_echo_send
518 * @retval Did the server reply correctly?
521 NTSTATUS
cli_echo_recv(struct tevent_req
*req
)
523 return tevent_req_simple_recv_ntstatus(req
);
527 * @brief Send/Receive SMBEcho requests
528 * @param[in] mem_ctx The memory context to put the async_req on
529 * @param[in] ev The event context that will call us back
530 * @param[in] cli The connection to send the echo to
531 * @param[in] num_echos How many times do we want to get the reply?
532 * @param[in] data The data we want to get back
533 * @retval Did the server reply correctly?
536 NTSTATUS
cli_echo(struct cli_state
*cli
, uint16_t num_echos
, DATA_BLOB data
)
538 TALLOC_CTX
*frame
= talloc_stackframe();
539 struct event_context
*ev
;
540 struct tevent_req
*req
;
541 NTSTATUS status
= NT_STATUS_OK
;
543 if (smbXcli_conn_has_async_calls(cli
->conn
)) {
545 * Can't use sync call while an async call is in flight
547 status
= NT_STATUS_INVALID_PARAMETER
;
551 ev
= event_context_init(frame
);
553 status
= NT_STATUS_NO_MEMORY
;
557 req
= cli_echo_send(frame
, ev
, cli
, num_echos
, data
);
559 status
= NT_STATUS_NO_MEMORY
;
563 if (!tevent_req_poll(req
, ev
)) {
564 status
= map_nt_error_from_unix(errno
);
568 status
= cli_echo_recv(req
);
575 * Is the SMB command able to hold an AND_X successor
576 * @param[in] cmd The SMB command in question
577 * @retval Can we add a chained request after "cmd"?
579 bool is_andx_req(uint8_t cmd
)
599 NTSTATUS
cli_smb(TALLOC_CTX
*mem_ctx
, struct cli_state
*cli
,
600 uint8_t smb_command
, uint8_t additional_flags
,
601 uint8_t wct
, uint16_t *vwv
,
602 uint32_t num_bytes
, const uint8_t *bytes
,
603 struct tevent_req
**result_parent
,
604 uint8_t min_wct
, uint8_t *pwct
, uint16_t **pvwv
,
605 uint32_t *pnum_bytes
, uint8_t **pbytes
)
607 struct tevent_context
*ev
;
608 struct tevent_req
*req
= NULL
;
609 NTSTATUS status
= NT_STATUS_NO_MEMORY
;
611 if (smbXcli_conn_has_async_calls(cli
->conn
)) {
612 return NT_STATUS_INVALID_PARAMETER
;
614 ev
= tevent_context_init(mem_ctx
);
618 req
= cli_smb_send(mem_ctx
, ev
, cli
, smb_command
, additional_flags
,
619 wct
, vwv
, num_bytes
, bytes
);
623 if (!tevent_req_poll_ntstatus(req
, ev
, &status
)) {
626 status
= cli_smb_recv(req
, NULL
, NULL
, min_wct
, pwct
, pvwv
,
630 if (NT_STATUS_IS_OK(status
) && (result_parent
!= NULL
)) {
631 *result_parent
= req
;