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_OPLOCKS
) {
213 cli
->use_oplocks
= true;
215 if (flags
& CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS
) {
216 use_level_II_oplocks
= true;
219 if (signing_state
== SMB_SIGNING_DEFAULT
) {
220 signing_state
= lp_client_signing();
223 smb1_capabilities
= 0;
224 smb1_capabilities
|= CAP_LARGE_FILES
;
225 smb1_capabilities
|= CAP_NT_SMBS
| CAP_RPC_REMOTE_APIS
;
226 smb1_capabilities
|= CAP_LOCK_AND_READ
| CAP_NT_FIND
;
227 smb1_capabilities
|= CAP_DFS
| CAP_W2K_SMBS
;
228 smb1_capabilities
|= CAP_LARGE_READX
|CAP_LARGE_WRITEX
;
229 smb1_capabilities
|= CAP_LWIO
;
231 if (!force_dos_errors
) {
232 smb1_capabilities
|= CAP_STATUS32
;
236 smb1_capabilities
|= CAP_UNICODE
;
240 smb1_capabilities
|= CAP_EXTENDED_SECURITY
;
243 if (use_level_II_oplocks
) {
244 smb1_capabilities
|= CAP_LEVEL_II_OPLOCKS
;
247 smb2_capabilities
= SMB2_CAP_ALL
;
250 cli
->remote_realm
= talloc_strdup(cli
, remote_realm
);
251 if (cli
->remote_realm
== NULL
) {
256 cli
->conn
= smbXcli_conn_create(cli
, fd
, remote_name
,
261 if (cli
->conn
== NULL
) {
265 cli
->smb1
.pid
= (uint16_t)getpid();
266 cli
->smb1
.vc_num
= cli
->smb1
.pid
;
267 cli
->smb1
.tid
= UINT16_MAX
;
268 cli
->smb1
.uid
= UID_FIELD_INVALID
;
270 cli
->initialised
= 1;
273 /* Clean up after malloc() error */
281 /****************************************************************************
282 Close all pipes open on this session.
283 ****************************************************************************/
285 void cli_nt_pipes_close(struct cli_state
*cli
)
287 while (cli
->pipe_list
!= NULL
) {
289 * No TALLOC_FREE here!
291 talloc_free(cli
->pipe_list
);
295 /****************************************************************************
296 Shutdown a client structure.
297 ****************************************************************************/
299 static void _cli_shutdown(struct cli_state
*cli
)
301 cli_nt_pipes_close(cli
);
304 * tell our peer to free his resources. Wihtout this, when an
305 * application attempts to do a graceful shutdown and calls
306 * smbc_free_context() to clean up all connections, some connections
307 * can remain active on the peer end, until some (long) timeout period
308 * later. This tree disconnect forces the peer to clean up, since the
309 * connection will be going away.
311 if (cli_state_has_tcon(cli
)) {
315 data_blob_free(&cli
->user_session_key
);
317 smbXcli_conn_disconnect(cli
->conn
, NT_STATUS_OK
);
322 void cli_shutdown(struct cli_state
*cli
)
324 struct cli_state
*cli_head
;
328 DLIST_HEAD(cli
, cli_head
);
329 if (cli_head
== cli
) {
331 * head of a DFS list, shutdown all subsidiary DFS
334 struct cli_state
*p
, *next
;
336 for (p
= cli_head
->next
; p
; p
= next
) {
338 DLIST_REMOVE(cli_head
, p
);
342 DLIST_REMOVE(cli_head
, cli
);
348 const char *cli_state_remote_realm(struct cli_state
*cli
)
350 return cli
->remote_realm
;
353 uint16_t cli_state_get_vc_num(struct cli_state
*cli
)
355 return cli
->smb1
.vc_num
;
358 /****************************************************************************
359 Set the PID to use for smb messages. Return the old pid.
360 ****************************************************************************/
362 uint16
cli_setpid(struct cli_state
*cli
, uint16 pid
)
364 uint16_t ret
= cli
->smb1
.pid
;
369 uint16_t cli_getpid(struct cli_state
*cli
)
371 return cli
->smb1
.pid
;
374 bool cli_state_has_tcon(struct cli_state
*cli
)
376 if (cli
->smb1
.tid
== UINT16_MAX
) {
383 uint16_t cli_state_get_tid(struct cli_state
*cli
)
385 return cli
->smb1
.tid
;
388 uint16_t cli_state_set_tid(struct cli_state
*cli
, uint16_t tid
)
390 uint16_t ret
= cli
->smb1
.tid
;
395 uint16_t cli_state_get_uid(struct cli_state
*cli
)
397 return cli
->smb1
.uid
;
400 uint16_t cli_state_set_uid(struct cli_state
*cli
, uint16_t uid
)
402 uint16_t ret
= cli
->smb1
.uid
;
407 /****************************************************************************
408 Set the case sensitivity flag on the packets. Returns old state.
409 ****************************************************************************/
411 bool cli_set_case_sensitive(struct cli_state
*cli
, bool case_sensitive
)
413 bool ret
= cli
->case_sensitive
;
414 cli
->case_sensitive
= case_sensitive
;
418 uint32_t cli_state_available_size(struct cli_state
*cli
, uint32_t ofs
)
420 uint32_t ret
= smb1cli_conn_max_xmit(cli
->conn
);
431 time_t cli_state_server_time(struct cli_state
*cli
)
436 nt
= smbXcli_conn_server_system_time(cli
->conn
);
437 t
= nt_time_to_unix(nt
);
442 struct cli_echo_state
{
448 static void cli_echo_done(struct tevent_req
*subreq
);
450 struct tevent_req
*cli_echo_send(TALLOC_CTX
*mem_ctx
, struct event_context
*ev
,
451 struct cli_state
*cli
, uint16_t num_echos
,
454 struct tevent_req
*req
, *subreq
;
455 struct cli_echo_state
*state
;
457 req
= tevent_req_create(mem_ctx
, &state
, struct cli_echo_state
);
461 SSVAL(state
->vwv
, 0, num_echos
);
463 state
->num_echos
= num_echos
;
465 subreq
= cli_smb_send(state
, ev
, cli
, SMBecho
, 0, 1, state
->vwv
,
466 data
.length
, data
.data
);
467 if (subreq
== NULL
) {
470 tevent_req_set_callback(subreq
, cli_echo_done
, req
);
477 static void cli_echo_done(struct tevent_req
*subreq
)
479 struct tevent_req
*req
= tevent_req_callback_data(
480 subreq
, struct tevent_req
);
481 struct cli_echo_state
*state
= tevent_req_data(
482 req
, struct cli_echo_state
);
487 status
= cli_smb_recv(subreq
, state
, NULL
, 0, NULL
, NULL
,
489 if (!NT_STATUS_IS_OK(status
)) {
490 tevent_req_nterror(req
, status
);
493 if ((num_bytes
!= state
->data
.length
)
494 || (memcmp(bytes
, state
->data
.data
, num_bytes
) != 0)) {
495 tevent_req_nterror(req
, NT_STATUS_INVALID_NETWORK_RESPONSE
);
499 state
->num_echos
-=1;
500 if (state
->num_echos
== 0) {
501 tevent_req_done(req
);
505 if (!smbXcli_req_set_pending(subreq
)) {
506 tevent_req_nterror(req
, NT_STATUS_NO_MEMORY
);
512 * Get the result out from an echo request
513 * @param[in] req The async_req from cli_echo_send
514 * @retval Did the server reply correctly?
517 NTSTATUS
cli_echo_recv(struct tevent_req
*req
)
519 return tevent_req_simple_recv_ntstatus(req
);
523 * @brief Send/Receive SMBEcho requests
524 * @param[in] mem_ctx The memory context to put the async_req on
525 * @param[in] ev The event context that will call us back
526 * @param[in] cli The connection to send the echo to
527 * @param[in] num_echos How many times do we want to get the reply?
528 * @param[in] data The data we want to get back
529 * @retval Did the server reply correctly?
532 NTSTATUS
cli_echo(struct cli_state
*cli
, uint16_t num_echos
, DATA_BLOB data
)
534 TALLOC_CTX
*frame
= talloc_stackframe();
535 struct event_context
*ev
;
536 struct tevent_req
*req
;
537 NTSTATUS status
= NT_STATUS_OK
;
539 if (smbXcli_conn_has_async_calls(cli
->conn
)) {
541 * Can't use sync call while an async call is in flight
543 status
= NT_STATUS_INVALID_PARAMETER
;
547 ev
= event_context_init(frame
);
549 status
= NT_STATUS_NO_MEMORY
;
553 req
= cli_echo_send(frame
, ev
, cli
, num_echos
, data
);
555 status
= NT_STATUS_NO_MEMORY
;
559 if (!tevent_req_poll(req
, ev
)) {
560 status
= map_nt_error_from_unix(errno
);
564 status
= cli_echo_recv(req
);
571 * Is the SMB command able to hold an AND_X successor
572 * @param[in] cmd The SMB command in question
573 * @retval Can we add a chained request after "cmd"?
575 bool is_andx_req(uint8_t cmd
)
595 NTSTATUS
cli_smb(TALLOC_CTX
*mem_ctx
, struct cli_state
*cli
,
596 uint8_t smb_command
, uint8_t additional_flags
,
597 uint8_t wct
, uint16_t *vwv
,
598 uint32_t num_bytes
, const uint8_t *bytes
,
599 struct tevent_req
**result_parent
,
600 uint8_t min_wct
, uint8_t *pwct
, uint16_t **pvwv
,
601 uint32_t *pnum_bytes
, uint8_t **pbytes
)
603 struct tevent_context
*ev
;
604 struct tevent_req
*req
= NULL
;
605 NTSTATUS status
= NT_STATUS_NO_MEMORY
;
607 if (smbXcli_conn_has_async_calls(cli
->conn
)) {
608 return NT_STATUS_INVALID_PARAMETER
;
610 ev
= tevent_context_init(mem_ctx
);
614 req
= cli_smb_send(mem_ctx
, ev
, cli
, smb_command
, additional_flags
,
615 wct
, vwv
, num_bytes
, bytes
);
619 if (!tevent_req_poll_ntstatus(req
, ev
, &status
)) {
622 status
= cli_smb_recv(req
, NULL
, NULL
, min_wct
, pwct
, pvwv
,
626 if (NT_STATUS_IS_OK(status
) && (result_parent
!= NULL
)) {
627 *result_parent
= req
;