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 convenience routine to find if we negotiated ucs2
69 ****************************************************************************/
71 bool cli_ucs2(struct cli_state
*cli
)
73 return smbXcli_conn_use_unicode(cli
->conn
);
76 /****************************************************************************
77 Initialize Domain, user or password.
78 ****************************************************************************/
80 NTSTATUS
cli_set_domain(struct cli_state
*cli
, const char *domain
)
82 TALLOC_FREE(cli
->domain
);
83 cli
->domain
= talloc_strdup(cli
, domain
? domain
: "");
84 if (cli
->domain
== NULL
) {
85 return NT_STATUS_NO_MEMORY
;
90 NTSTATUS
cli_set_username(struct cli_state
*cli
, const char *username
)
92 TALLOC_FREE(cli
->user_name
);
93 cli
->user_name
= talloc_strdup(cli
, username
? username
: "");
94 if (cli
->user_name
== NULL
) {
95 return NT_STATUS_NO_MEMORY
;
100 NTSTATUS
cli_set_password(struct cli_state
*cli
, const char *password
)
102 TALLOC_FREE(cli
->password
);
104 /* Password can be NULL. */
106 cli
->password
= talloc_strdup(cli
, password
);
107 if (cli
->password
== NULL
) {
108 return NT_STATUS_NO_MEMORY
;
111 /* Use zero NTLMSSP hashes and session key. */
112 cli
->password
= NULL
;
118 /****************************************************************************
119 Initialise credentials of a client structure.
120 ****************************************************************************/
122 NTSTATUS
cli_init_creds(struct cli_state
*cli
, const char *username
, const char *domain
, const char *password
)
124 NTSTATUS status
= cli_set_username(cli
, username
);
125 if (!NT_STATUS_IS_OK(status
)) {
128 status
= cli_set_domain(cli
, domain
);
129 if (!NT_STATUS_IS_OK(status
)) {
132 DEBUG(10,("cli_init_creds: user %s domain %s\n", cli
->user_name
, cli
->domain
));
134 return cli_set_password(cli
, password
);
137 /****************************************************************************
138 Initialise a client structure. Always returns a talloc'ed struct.
139 Set the signing state (used from the command line).
140 ****************************************************************************/
142 struct cli_state
*cli_state_create(TALLOC_CTX
*mem_ctx
,
144 const char *remote_name
,
145 const char *remote_realm
,
146 int signing_state
, int flags
)
148 struct cli_state
*cli
= NULL
;
149 bool use_spnego
= lp_client_use_spnego();
150 bool force_dos_errors
= false;
151 bool force_ascii
= false;
152 bool use_level_II_oplocks
= false;
153 uint32_t smb1_capabilities
= 0;
154 uint32_t smb2_capabilities
= 0;
155 struct GUID client_guid
= GUID_random();
157 /* Check the effective uid - make sure we are not setuid */
158 if (is_setuid_root()) {
159 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
163 cli
= talloc_zero(mem_ctx
, struct cli_state
);
168 cli
->server_domain
= talloc_strdup(cli
, "");
169 if (!cli
->server_domain
) {
172 cli
->server_os
= talloc_strdup(cli
, "");
173 if (!cli
->server_os
) {
176 cli
->server_type
= talloc_strdup(cli
, "");
177 if (!cli
->server_type
) {
181 cli
->dfs_mountpoint
= talloc_strdup(cli
, "");
182 if (!cli
->dfs_mountpoint
) {
185 cli
->raw_status
= NT_STATUS_INTERNAL_ERROR
;
186 cli
->map_dos_errors
= true; /* remove this */
187 cli
->timeout
= 20000; /* Timeout is in milliseconds. */
188 cli
->case_sensitive
= false;
190 /* Set the CLI_FORCE_DOSERR environment variable to test
191 client routines using DOS errors instead of STATUS32
192 ones. This intended only as a temporary hack. */
193 if (getenv("CLI_FORCE_DOSERR")) {
194 force_dos_errors
= true;
196 if (flags
& CLI_FULL_CONNECTION_FORCE_DOS_ERRORS
) {
197 force_dos_errors
= true;
200 if (getenv("CLI_FORCE_ASCII")) {
203 if (flags
& CLI_FULL_CONNECTION_FORCE_ASCII
) {
207 if (flags
& CLI_FULL_CONNECTION_DONT_SPNEGO
) {
209 } else if (flags
& CLI_FULL_CONNECTION_USE_KERBEROS
) {
210 cli
->use_kerberos
= true;
212 if ((flags
& CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS
) &&
214 cli
->fallback_after_kerberos
= true;
217 if (flags
& CLI_FULL_CONNECTION_USE_CCACHE
) {
218 cli
->use_ccache
= true;
221 if (flags
& CLI_FULL_CONNECTION_OPLOCKS
) {
222 cli
->use_oplocks
= true;
224 if (flags
& CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS
) {
225 use_level_II_oplocks
= true;
228 if (signing_state
== SMB_SIGNING_DEFAULT
) {
229 signing_state
= lp_client_signing();
232 smb1_capabilities
= 0;
233 smb1_capabilities
|= CAP_LARGE_FILES
;
234 smb1_capabilities
|= CAP_NT_SMBS
| CAP_RPC_REMOTE_APIS
;
235 smb1_capabilities
|= CAP_LOCK_AND_READ
| CAP_NT_FIND
;
236 smb1_capabilities
|= CAP_DFS
| CAP_W2K_SMBS
;
237 smb1_capabilities
|= CAP_LARGE_READX
|CAP_LARGE_WRITEX
;
238 smb1_capabilities
|= CAP_LWIO
;
240 if (!force_dos_errors
) {
241 smb1_capabilities
|= CAP_STATUS32
;
245 smb1_capabilities
|= CAP_UNICODE
;
249 smb1_capabilities
|= CAP_EXTENDED_SECURITY
;
252 if (use_level_II_oplocks
) {
253 smb1_capabilities
|= CAP_LEVEL_II_OPLOCKS
;
256 smb2_capabilities
= SMB2_CAP_ALL
;
259 cli
->remote_realm
= talloc_strdup(cli
, remote_realm
);
260 if (cli
->remote_realm
== NULL
) {
265 cli
->conn
= smbXcli_conn_create(cli
, fd
, remote_name
,
270 if (cli
->conn
== NULL
) {
274 cli
->smb1
.pid
= (uint16_t)getpid();
275 cli
->smb1
.vc_num
= cli
->smb1
.pid
;
276 cli
->smb1
.tid
= UINT16_MAX
;
277 cli
->smb1
.uid
= UID_FIELD_INVALID
;
279 cli
->initialised
= 1;
282 /* Clean up after malloc() error */
290 bool cli_state_encryption_on(struct cli_state
*cli
)
292 return smb1cli_conn_encryption_on(cli
->conn
);
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
)) {
330 data_blob_free(&cli
->user_session_key
);
332 cli_state_disconnect(cli
);
337 void cli_shutdown(struct cli_state
*cli
)
339 struct cli_state
*cli_head
;
343 DLIST_HEAD(cli
, cli_head
);
344 if (cli_head
== cli
) {
346 * head of a DFS list, shutdown all subsidiary DFS
349 struct cli_state
*p
, *next
;
351 for (p
= cli_head
->next
; p
; p
= next
) {
353 DLIST_REMOVE(cli_head
, p
);
357 DLIST_REMOVE(cli_head
, cli
);
363 /****************************************************************************
364 Set socket options on a open connection.
365 ****************************************************************************/
367 void cli_sockopt(struct cli_state
*cli
, const char *options
)
369 smbXcli_conn_set_sockopt(cli
->conn
, options
);
372 const struct sockaddr_storage
*cli_state_local_sockaddr(struct cli_state
*cli
)
374 return smbXcli_conn_local_sockaddr(cli
->conn
);
377 const struct sockaddr_storage
*cli_state_remote_sockaddr(struct cli_state
*cli
)
379 return smbXcli_conn_remote_sockaddr(cli
->conn
);
382 const char *cli_state_remote_name(struct cli_state
*cli
)
384 return smbXcli_conn_remote_name(cli
->conn
);
387 const char *cli_state_remote_realm(struct cli_state
*cli
)
389 return cli
->remote_realm
;
392 uint16_t cli_state_get_vc_num(struct cli_state
*cli
)
394 return cli
->smb1
.vc_num
;
397 uint32_t cli_state_server_session_key(struct cli_state
*cli
)
399 return smb1cli_conn_server_session_key(cli
->conn
);
402 /****************************************************************************
403 Set the PID to use for smb messages. Return the old pid.
404 ****************************************************************************/
406 uint16
cli_setpid(struct cli_state
*cli
, uint16 pid
)
408 uint16_t ret
= cli
->smb1
.pid
;
413 uint16_t cli_getpid(struct cli_state
*cli
)
415 return cli
->smb1
.pid
;
418 bool cli_state_has_tcon(struct cli_state
*cli
)
420 if (cli
->smb1
.tid
== UINT16_MAX
) {
427 uint16_t cli_state_get_tid(struct cli_state
*cli
)
429 return cli
->smb1
.tid
;
432 uint16_t cli_state_set_tid(struct cli_state
*cli
, uint16_t tid
)
434 uint16_t ret
= cli
->smb1
.tid
;
439 uint16_t cli_state_get_uid(struct cli_state
*cli
)
441 return cli
->smb1
.uid
;
444 uint16_t cli_state_set_uid(struct cli_state
*cli
, uint16_t uid
)
446 uint16_t ret
= cli
->smb1
.uid
;
451 /****************************************************************************
452 Set the case sensitivity flag on the packets. Returns old state.
453 ****************************************************************************/
455 bool cli_set_case_sensitive(struct cli_state
*cli
, bool case_sensitive
)
457 bool ret
= cli
->case_sensitive
;
458 cli
->case_sensitive
= case_sensitive
;
462 enum protocol_types
cli_state_protocol(struct cli_state
*cli
)
464 return smbXcli_conn_protocol(cli
->conn
);
467 uint32_t cli_state_capabilities(struct cli_state
*cli
)
469 return smb1cli_conn_capabilities(cli
->conn
);
472 uint32_t cli_state_available_size(struct cli_state
*cli
, uint32_t ofs
)
474 uint32_t ret
= smb1cli_conn_max_xmit(cli
->conn
);
485 uint16_t cli_state_max_requests(struct cli_state
*cli
)
487 return smbXcli_conn_max_requests(cli
->conn
);
490 const uint8_t *cli_state_server_challenge(struct cli_state
*cli
)
492 return smb1cli_conn_server_challenge(cli
->conn
);
495 const DATA_BLOB
*cli_state_server_gss_blob(struct cli_state
*cli
)
497 return smbXcli_conn_server_gss_blob(cli
->conn
);
500 uint16_t cli_state_security_mode(struct cli_state
*cli
)
502 return smb1cli_conn_server_security_mode(cli
->conn
);
505 int cli_state_server_time_zone(struct cli_state
*cli
)
507 return smb1cli_conn_server_time_zone(cli
->conn
);
510 time_t cli_state_server_time(struct cli_state
*cli
)
515 nt
= smbXcli_conn_server_system_time(cli
->conn
);
516 t
= nt_time_to_unix(nt
);
521 struct cli_echo_state
{
527 static void cli_echo_done(struct tevent_req
*subreq
);
529 struct tevent_req
*cli_echo_send(TALLOC_CTX
*mem_ctx
, struct event_context
*ev
,
530 struct cli_state
*cli
, uint16_t num_echos
,
533 struct tevent_req
*req
, *subreq
;
534 struct cli_echo_state
*state
;
536 req
= tevent_req_create(mem_ctx
, &state
, struct cli_echo_state
);
540 SSVAL(state
->vwv
, 0, num_echos
);
542 state
->num_echos
= num_echos
;
544 subreq
= cli_smb_send(state
, ev
, cli
, SMBecho
, 0, 1, state
->vwv
,
545 data
.length
, data
.data
);
546 if (subreq
== NULL
) {
549 tevent_req_set_callback(subreq
, cli_echo_done
, req
);
556 static void cli_echo_done(struct tevent_req
*subreq
)
558 struct tevent_req
*req
= tevent_req_callback_data(
559 subreq
, struct tevent_req
);
560 struct cli_echo_state
*state
= tevent_req_data(
561 req
, struct cli_echo_state
);
567 status
= cli_smb_recv(subreq
, state
, &inbuf
, 0, NULL
, NULL
,
569 if (!NT_STATUS_IS_OK(status
)) {
570 tevent_req_nterror(req
, status
);
573 if ((num_bytes
!= state
->data
.length
)
574 || (memcmp(bytes
, state
->data
.data
, num_bytes
) != 0)) {
575 tevent_req_nterror(req
, NT_STATUS_INVALID_NETWORK_RESPONSE
);
579 state
->num_echos
-=1;
580 if (state
->num_echos
== 0) {
581 tevent_req_done(req
);
585 if (!cli_smb_req_set_pending(subreq
)) {
586 tevent_req_nterror(req
, NT_STATUS_NO_MEMORY
);
592 * Get the result out from an echo request
593 * @param[in] req The async_req from cli_echo_send
594 * @retval Did the server reply correctly?
597 NTSTATUS
cli_echo_recv(struct tevent_req
*req
)
599 return tevent_req_simple_recv_ntstatus(req
);
603 * @brief Send/Receive SMBEcho requests
604 * @param[in] mem_ctx The memory context to put the async_req on
605 * @param[in] ev The event context that will call us back
606 * @param[in] cli The connection to send the echo to
607 * @param[in] num_echos How many times do we want to get the reply?
608 * @param[in] data The data we want to get back
609 * @retval Did the server reply correctly?
612 NTSTATUS
cli_echo(struct cli_state
*cli
, uint16_t num_echos
, DATA_BLOB data
)
614 TALLOC_CTX
*frame
= talloc_stackframe();
615 struct event_context
*ev
;
616 struct tevent_req
*req
;
617 NTSTATUS status
= NT_STATUS_OK
;
619 if (cli_has_async_calls(cli
)) {
621 * Can't use sync call while an async call is in flight
623 status
= NT_STATUS_INVALID_PARAMETER
;
627 ev
= event_context_init(frame
);
629 status
= NT_STATUS_NO_MEMORY
;
633 req
= cli_echo_send(frame
, ev
, cli
, num_echos
, data
);
635 status
= NT_STATUS_NO_MEMORY
;
639 if (!tevent_req_poll(req
, ev
)) {
640 status
= map_nt_error_from_unix(errno
);
644 status
= cli_echo_recv(req
);
651 * Is the SMB command able to hold an AND_X successor
652 * @param[in] cmd The SMB command in question
653 * @retval Can we add a chained request after "cmd"?
655 bool is_andx_req(uint8_t cmd
)
675 NTSTATUS
cli_smb(TALLOC_CTX
*mem_ctx
, struct cli_state
*cli
,
676 uint8_t smb_command
, uint8_t additional_flags
,
677 uint8_t wct
, uint16_t *vwv
,
678 uint32_t num_bytes
, const uint8_t *bytes
,
679 struct tevent_req
**result_parent
,
680 uint8_t min_wct
, uint8_t *pwct
, uint16_t **pvwv
,
681 uint32_t *pnum_bytes
, uint8_t **pbytes
)
683 struct tevent_context
*ev
;
684 struct tevent_req
*req
= NULL
;
685 NTSTATUS status
= NT_STATUS_NO_MEMORY
;
687 if (cli_has_async_calls(cli
)) {
688 return NT_STATUS_INVALID_PARAMETER
;
690 ev
= tevent_context_init(mem_ctx
);
694 req
= cli_smb_send(mem_ctx
, ev
, cli
, smb_command
, additional_flags
,
695 wct
, vwv
, num_bytes
, bytes
);
699 if (!tevent_req_poll_ntstatus(req
, ev
, &status
)) {
702 status
= cli_smb_recv(req
, NULL
, NULL
, min_wct
, pwct
, pvwv
,
706 if (NT_STATUS_IS_OK(status
) && (result_parent
!= NULL
)) {
707 *result_parent
= req
;