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"
28 /*******************************************************************
29 Setup the word count and byte count for a client smb message.
30 ********************************************************************/
32 int cli_set_message(char *buf
,int num_words
,int num_bytes
,bool zero
)
34 if (zero
&& (num_words
|| num_bytes
)) {
35 memset(buf
+ smb_size
,'\0',num_words
*2 + num_bytes
);
37 SCVAL(buf
,smb_wct
,num_words
);
38 SSVAL(buf
,smb_vwv
+ num_words
*SIZEOFWORD
,num_bytes
);
39 smb_setlen(buf
,smb_size
+ num_words
*2 + num_bytes
- 4);
40 return (smb_size
+ num_words
*2 + num_bytes
);
43 /****************************************************************************
44 Change the timeout (in milliseconds).
45 ****************************************************************************/
47 unsigned int cli_set_timeout(struct cli_state
*cli
, unsigned int timeout
)
49 unsigned int old_timeout
= cli
->timeout
;
50 cli
->timeout
= timeout
;
54 /****************************************************************************
55 convenience routine to find if we negotiated ucs2
56 ****************************************************************************/
58 bool cli_ucs2(struct cli_state
*cli
)
60 return ((cli_state_capabilities(cli
) & CAP_UNICODE
) != 0);
63 /****************************************************************************
64 Setup basics in a outgoing packet.
65 ****************************************************************************/
67 void cli_setup_packet_buf(struct cli_state
*cli
, char *buf
)
71 SIVAL(buf
,smb_rcls
,0);
72 SSVAL(buf
,smb_pid
,cli
->smb1
.pid
);
73 memset(buf
+smb_pidhigh
, 0, 12);
74 SSVAL(buf
,smb_uid
, cli_state_get_uid(cli
));
75 SSVAL(buf
,smb_mid
, 0);
77 if (cli_state_protocol(cli
) <= PROTOCOL_CORE
) {
81 if (cli
->case_sensitive
) {
82 SCVAL(buf
,smb_flg
,0x0);
84 /* Default setting, case insensitive. */
85 SCVAL(buf
,smb_flg
,0x8);
87 flags2
= FLAGS2_LONG_PATH_COMPONENTS
;
88 if (cli_state_capabilities(cli
) & CAP_UNICODE
)
89 flags2
|= FLAGS2_UNICODE_STRINGS
;
90 if ((cli_state_capabilities(cli
) & CAP_DFS
) && cli
->dfsroot
)
91 flags2
|= FLAGS2_DFS_PATHNAMES
;
92 if (cli_state_capabilities(cli
) & CAP_STATUS32
)
93 flags2
|= FLAGS2_32_BIT_ERROR_CODES
;
94 if (cli_state_capabilities(cli
) & CAP_EXTENDED_SECURITY
)
95 flags2
|= FLAGS2_EXTENDED_SECURITY
;
96 SSVAL(buf
,smb_flg2
, flags2
);
99 /****************************************************************************
100 Initialize Domain, user or password.
101 ****************************************************************************/
103 NTSTATUS
cli_set_domain(struct cli_state
*cli
, const char *domain
)
105 TALLOC_FREE(cli
->domain
);
106 cli
->domain
= talloc_strdup(cli
, domain
? domain
: "");
107 if (cli
->domain
== NULL
) {
108 return NT_STATUS_NO_MEMORY
;
113 NTSTATUS
cli_set_username(struct cli_state
*cli
, const char *username
)
115 TALLOC_FREE(cli
->user_name
);
116 cli
->user_name
= talloc_strdup(cli
, username
? username
: "");
117 if (cli
->user_name
== NULL
) {
118 return NT_STATUS_NO_MEMORY
;
123 NTSTATUS
cli_set_password(struct cli_state
*cli
, const char *password
)
125 TALLOC_FREE(cli
->password
);
127 /* Password can be NULL. */
129 cli
->password
= talloc_strdup(cli
, password
);
130 if (cli
->password
== NULL
) {
131 return NT_STATUS_NO_MEMORY
;
134 /* Use zero NTLMSSP hashes and session key. */
135 cli
->password
= NULL
;
141 /****************************************************************************
142 Initialise credentials of a client structure.
143 ****************************************************************************/
145 NTSTATUS
cli_init_creds(struct cli_state
*cli
, const char *username
, const char *domain
, const char *password
)
147 NTSTATUS status
= cli_set_username(cli
, username
);
148 if (!NT_STATUS_IS_OK(status
)) {
151 status
= cli_set_domain(cli
, domain
);
152 if (!NT_STATUS_IS_OK(status
)) {
155 DEBUG(10,("cli_init_creds: user %s domain %s\n", cli
->user_name
, cli
->domain
));
157 return cli_set_password(cli
, password
);
160 /****************************************************************************
161 Initialise a client structure. Always returns a talloc'ed struct.
162 Set the signing state (used from the command line).
163 ****************************************************************************/
165 struct cli_state
*cli_state_create(TALLOC_CTX
*mem_ctx
,
167 const char *remote_name
,
168 const char *remote_realm
,
169 int signing_state
, int flags
)
171 struct cli_state
*cli
= NULL
;
172 bool allow_smb_signing
;
173 bool desire_smb_signing
;
174 bool mandatory_signing
;
177 bool use_spnego
= lp_client_use_spnego();
178 bool force_dos_errors
= false;
179 bool force_ascii
= false;
180 bool use_level_II_oplocks
= false;
182 /* Check the effective uid - make sure we are not setuid */
183 if (is_setuid_root()) {
184 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
188 cli
= talloc_zero(mem_ctx
, struct cli_state
);
193 cli
->dfs_mountpoint
= talloc_strdup(cli
, "");
194 if (!cli
->dfs_mountpoint
) {
197 cli
->raw_status
= NT_STATUS_INTERNAL_ERROR
;
198 cli
->timeout
= 20000; /* Timeout is in milliseconds. */
199 cli
->case_sensitive
= false;
201 /* Set the CLI_FORCE_DOSERR environment variable to test
202 client routines using DOS errors instead of STATUS32
203 ones. This intended only as a temporary hack. */
204 if (getenv("CLI_FORCE_DOSERR")) {
205 force_dos_errors
= true;
207 if (flags
& CLI_FULL_CONNECTION_FORCE_DOS_ERRORS
) {
208 force_dos_errors
= true;
211 if (getenv("CLI_FORCE_ASCII")) {
214 if (flags
& CLI_FULL_CONNECTION_FORCE_ASCII
) {
218 if (flags
& CLI_FULL_CONNECTION_DONT_SPNEGO
) {
220 } else if (flags
& CLI_FULL_CONNECTION_USE_KERBEROS
) {
221 cli
->use_kerberos
= true;
223 if ((flags
& CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS
) &&
225 cli
->fallback_after_kerberos
= true;
228 if (flags
& CLI_FULL_CONNECTION_USE_CCACHE
) {
229 cli
->use_ccache
= true;
232 if (flags
& CLI_FULL_CONNECTION_OPLOCKS
) {
233 cli
->use_oplocks
= true;
235 if (flags
& CLI_FULL_CONNECTION_LEVEL_II_OPLOCKS
) {
236 use_level_II_oplocks
= true;
239 if (signing_state
== SMB_SIGNING_DEFAULT
) {
240 signing_state
= lp_client_signing();
243 switch (signing_state
) {
244 case SMB_SIGNING_OFF
:
246 allow_smb_signing
= false;
247 desire_smb_signing
= false;
248 mandatory_signing
= false;
251 case SMB_SIGNING_DEFAULT
:
252 case SMB_SIGNING_IF_REQUIRED
:
253 allow_smb_signing
= true;
254 desire_smb_signing
= false;
255 mandatory_signing
= false;
257 case SMB_SIGNING_REQUIRED
:
259 allow_smb_signing
= true;
260 desire_smb_signing
= true;
261 mandatory_signing
= true;
265 /* initialise signing */
266 cli
->signing_state
= smb_signing_init(cli
,
270 if (!cli
->signing_state
) {
274 cli
->conn
.smb1
.client
.capabilities
= 0;
275 cli
->conn
.smb1
.client
.capabilities
|= CAP_LARGE_FILES
;
276 cli
->conn
.smb1
.client
.capabilities
|= CAP_NT_SMBS
| CAP_RPC_REMOTE_APIS
;
277 cli
->conn
.smb1
.client
.capabilities
|= CAP_LOCK_AND_READ
| CAP_NT_FIND
;
278 cli
->conn
.smb1
.client
.capabilities
|= CAP_DFS
| CAP_W2K_SMBS
;
279 cli
->conn
.smb1
.client
.capabilities
|= CAP_LARGE_READX
|CAP_LARGE_WRITEX
;
280 cli
->conn
.smb1
.client
.capabilities
|= CAP_LWIO
;
282 if (!force_dos_errors
) {
283 cli
->conn
.smb1
.client
.capabilities
|= CAP_STATUS32
;
287 cli
->conn
.smb1
.client
.capabilities
|= CAP_UNICODE
;
291 cli
->conn
.smb1
.client
.capabilities
|= CAP_EXTENDED_SECURITY
;
294 if (use_level_II_oplocks
) {
295 cli
->conn
.smb1
.client
.capabilities
|= CAP_LEVEL_II_OPLOCKS
;
298 cli
->conn
.smb1
.client
.max_xmit
= CLI_BUFFER_SIZE
;
300 cli
->conn
.smb1
.capabilities
= cli
->conn
.smb1
.client
.capabilities
;
301 cli
->conn
.smb1
.max_xmit
= 1024;
303 cli
->conn
.smb1
.mid
= 1;
305 cli
->conn
.outgoing
= tevent_queue_create(cli
, "cli_outgoing");
306 if (cli
->conn
.outgoing
== NULL
) {
309 cli
->conn
.pending
= NULL
;
311 cli
->conn
.remote_name
= talloc_strdup(cli
, remote_name
);
312 if (cli
->conn
.remote_name
== NULL
) {
317 cli
->conn
.remote_realm
= talloc_strdup(cli
, remote_realm
);
318 if (cli
->conn
.remote_realm
== NULL
) {
325 ss_length
= sizeof(cli
->conn
.local_ss
);
326 ret
= getsockname(fd
,
327 (struct sockaddr
*)(void *)&cli
->conn
.local_ss
,
332 ss_length
= sizeof(cli
->conn
.remote_ss
);
333 ret
= getpeername(fd
,
334 (struct sockaddr
*)(void *)&cli
->conn
.remote_ss
,
340 cli
->smb1
.pid
= (uint16_t)sys_getpid();
341 cli
->smb1
.vc_num
= cli
->smb1
.pid
;
342 cli
->smb1
.tid
= UINT16_MAX
;
343 cli
->smb1
.uid
= UID_FIELD_INVALID
;
345 cli
->initialised
= 1;
348 /* Clean up after malloc() error */
356 bool cli_state_encryption_on(struct cli_state
*cli
)
358 return common_encryption_on(cli
->trans_enc_state
);
362 /****************************************************************************
363 Close all pipes open on this session.
364 ****************************************************************************/
366 void cli_nt_pipes_close(struct cli_state
*cli
)
368 while (cli
->pipe_list
!= NULL
) {
370 * No TALLOC_FREE here!
372 talloc_free(cli
->pipe_list
);
376 /****************************************************************************
377 Shutdown a client structure.
378 ****************************************************************************/
380 static void _cli_shutdown(struct cli_state
*cli
)
382 cli_nt_pipes_close(cli
);
385 * tell our peer to free his resources. Wihtout this, when an
386 * application attempts to do a graceful shutdown and calls
387 * smbc_free_context() to clean up all connections, some connections
388 * can remain active on the peer end, until some (long) timeout period
389 * later. This tree disconnect forces the peer to clean up, since the
390 * connection will be going away.
392 if (cli_state_has_tcon(cli
)) {
396 data_blob_free(&cli
->user_session_key
);
398 cli_state_disconnect(cli
);
401 * Need to free pending first, they remove themselves
403 while (cli
->conn
.pending
) {
404 talloc_free(cli
->conn
.pending
[0]);
409 void cli_shutdown(struct cli_state
*cli
)
411 struct cli_state
*cli_head
;
415 DLIST_HEAD(cli
, cli_head
);
416 if (cli_head
== cli
) {
418 * head of a DFS list, shutdown all subsidiary DFS
421 struct cli_state
*p
, *next
;
423 for (p
= cli_head
->next
; p
; p
= next
) {
425 DLIST_REMOVE(cli_head
, p
);
429 DLIST_REMOVE(cli_head
, cli
);
435 /****************************************************************************
436 Set socket options on a open connection.
437 ****************************************************************************/
439 void cli_sockopt(struct cli_state
*cli
, const char *options
)
441 set_socket_options(cli
->conn
.fd
, options
);
444 const struct sockaddr_storage
*cli_state_local_sockaddr(struct cli_state
*cli
)
446 return &cli
->conn
.local_ss
;
449 const struct sockaddr_storage
*cli_state_remote_sockaddr(struct cli_state
*cli
)
451 return &cli
->conn
.remote_ss
;
454 const char *cli_state_remote_name(struct cli_state
*cli
)
456 return cli
->conn
.remote_name
;
459 const char *cli_state_remote_realm(struct cli_state
*cli
)
461 return cli
->conn
.remote_realm
;
464 uint16_t cli_state_get_vc_num(struct cli_state
*cli
)
466 return cli
->smb1
.vc_num
;
469 uint32_t cli_state_server_session_key(struct cli_state
*cli
)
471 return cli
->conn
.smb1
.server
.session_key
;
474 /****************************************************************************
475 Set the PID to use for smb messages. Return the old pid.
476 ****************************************************************************/
478 uint16
cli_setpid(struct cli_state
*cli
, uint16 pid
)
480 uint16_t ret
= cli
->smb1
.pid
;
485 uint16_t cli_getpid(struct cli_state
*cli
)
487 return cli
->smb1
.pid
;
490 bool cli_state_has_tcon(struct cli_state
*cli
)
492 if (cli
->smb1
.tid
== UINT16_MAX
) {
499 uint16_t cli_state_get_tid(struct cli_state
*cli
)
501 return cli
->smb1
.tid
;
504 uint16_t cli_state_set_tid(struct cli_state
*cli
, uint16_t tid
)
506 uint16_t ret
= cli
->smb1
.tid
;
511 uint16_t cli_state_get_uid(struct cli_state
*cli
)
513 return cli
->smb1
.uid
;
516 uint16_t cli_state_set_uid(struct cli_state
*cli
, uint16_t uid
)
518 uint16_t ret
= cli
->smb1
.uid
;
523 /****************************************************************************
524 Set the case sensitivity flag on the packets. Returns old state.
525 ****************************************************************************/
527 bool cli_set_case_sensitive(struct cli_state
*cli
, bool case_sensitive
)
529 bool ret
= cli
->case_sensitive
;
530 cli
->case_sensitive
= case_sensitive
;
534 enum protocol_types
cli_state_protocol(struct cli_state
*cli
)
536 return cli
->conn
.protocol
;
539 uint32_t cli_state_capabilities(struct cli_state
*cli
)
541 return cli
->conn
.smb1
.capabilities
;
544 uint32_t cli_state_available_size(struct cli_state
*cli
, uint32_t ofs
)
546 uint32_t ret
= cli
->conn
.smb1
.max_xmit
;
557 uint16_t cli_state_max_requests(struct cli_state
*cli
)
559 return cli
->conn
.smb1
.server
.max_mux
;
562 const uint8_t *cli_state_server_challenge(struct cli_state
*cli
)
564 return cli
->conn
.smb1
.server
.challenge
;
567 const DATA_BLOB
*cli_state_server_gss_blob(struct cli_state
*cli
)
569 return &cli
->conn
.smb1
.server
.gss_blob
;
572 uint16_t cli_state_security_mode(struct cli_state
*cli
)
574 return cli
->conn
.smb1
.server
.security_mode
;
577 int cli_state_server_time_zone(struct cli_state
*cli
)
579 return cli
->conn
.smb1
.server
.time_zone
;
582 time_t cli_state_server_time(struct cli_state
*cli
)
584 return cli
->conn
.smb1
.server
.system_time
;
587 struct cli_echo_state
{
593 static void cli_echo_done(struct tevent_req
*subreq
);
595 struct tevent_req
*cli_echo_send(TALLOC_CTX
*mem_ctx
, struct event_context
*ev
,
596 struct cli_state
*cli
, uint16_t num_echos
,
599 struct tevent_req
*req
, *subreq
;
600 struct cli_echo_state
*state
;
602 req
= tevent_req_create(mem_ctx
, &state
, struct cli_echo_state
);
606 SSVAL(state
->vwv
, 0, num_echos
);
608 state
->num_echos
= num_echos
;
610 subreq
= cli_smb_send(state
, ev
, cli
, SMBecho
, 0, 1, state
->vwv
,
611 data
.length
, data
.data
);
612 if (subreq
== NULL
) {
615 tevent_req_set_callback(subreq
, cli_echo_done
, req
);
622 static void cli_echo_done(struct tevent_req
*subreq
)
624 struct tevent_req
*req
= tevent_req_callback_data(
625 subreq
, struct tevent_req
);
626 struct cli_echo_state
*state
= tevent_req_data(
627 req
, struct cli_echo_state
);
633 status
= cli_smb_recv(subreq
, state
, &inbuf
, 0, NULL
, NULL
,
635 if (!NT_STATUS_IS_OK(status
)) {
636 tevent_req_nterror(req
, status
);
639 if ((num_bytes
!= state
->data
.length
)
640 || (memcmp(bytes
, state
->data
.data
, num_bytes
) != 0)) {
641 tevent_req_nterror(req
, NT_STATUS_INVALID_NETWORK_RESPONSE
);
645 state
->num_echos
-=1;
646 if (state
->num_echos
== 0) {
647 tevent_req_done(req
);
651 if (!cli_smb_req_set_pending(subreq
)) {
652 tevent_req_nterror(req
, NT_STATUS_NO_MEMORY
);
658 * Get the result out from an echo request
659 * @param[in] req The async_req from cli_echo_send
660 * @retval Did the server reply correctly?
663 NTSTATUS
cli_echo_recv(struct tevent_req
*req
)
665 return tevent_req_simple_recv_ntstatus(req
);
669 * @brief Send/Receive SMBEcho requests
670 * @param[in] mem_ctx The memory context to put the async_req on
671 * @param[in] ev The event context that will call us back
672 * @param[in] cli The connection to send the echo to
673 * @param[in] num_echos How many times do we want to get the reply?
674 * @param[in] data The data we want to get back
675 * @retval Did the server reply correctly?
678 NTSTATUS
cli_echo(struct cli_state
*cli
, uint16_t num_echos
, DATA_BLOB data
)
680 TALLOC_CTX
*frame
= talloc_stackframe();
681 struct event_context
*ev
;
682 struct tevent_req
*req
;
683 NTSTATUS status
= NT_STATUS_OK
;
685 if (cli_has_async_calls(cli
)) {
687 * Can't use sync call while an async call is in flight
689 status
= NT_STATUS_INVALID_PARAMETER
;
693 ev
= event_context_init(frame
);
695 status
= NT_STATUS_NO_MEMORY
;
699 req
= cli_echo_send(frame
, ev
, cli
, num_echos
, data
);
701 status
= NT_STATUS_NO_MEMORY
;
705 if (!tevent_req_poll(req
, ev
)) {
706 status
= map_nt_error_from_unix(errno
);
710 status
= cli_echo_recv(req
);
717 * Is the SMB command able to hold an AND_X successor
718 * @param[in] cmd The SMB command in question
719 * @retval Can we add a chained request after "cmd"?
721 bool is_andx_req(uint8_t cmd
)
741 NTSTATUS
cli_smb(TALLOC_CTX
*mem_ctx
, struct cli_state
*cli
,
742 uint8_t smb_command
, uint8_t additional_flags
,
743 uint8_t wct
, uint16_t *vwv
,
744 uint32_t num_bytes
, const uint8_t *bytes
,
745 struct tevent_req
**result_parent
,
746 uint8_t min_wct
, uint8_t *pwct
, uint16_t **pvwv
,
747 uint32_t *pnum_bytes
, uint8_t **pbytes
)
749 struct tevent_context
*ev
;
750 struct tevent_req
*req
= NULL
;
751 NTSTATUS status
= NT_STATUS_NO_MEMORY
;
753 if (cli_has_async_calls(cli
)) {
754 return NT_STATUS_INVALID_PARAMETER
;
756 ev
= tevent_context_init(mem_ctx
);
760 req
= cli_smb_send(mem_ctx
, ev
, cli
, smb_command
, additional_flags
,
761 wct
, vwv
, num_bytes
, bytes
);
765 if (!tevent_req_poll_ntstatus(req
, ev
, &status
)) {
768 status
= cli_smb_recv(req
, NULL
, NULL
, min_wct
, pwct
, pvwv
,
772 if (NT_STATUS_IS_OK(status
) && (result_parent
!= NULL
)) {
773 *result_parent
= req
;