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 "smb_signing.h"
25 #include "async_smb.h"
27 /*******************************************************************
28 Setup the word count and byte count for a client smb message.
29 ********************************************************************/
31 int cli_set_message(char *buf
,int num_words
,int num_bytes
,bool zero
)
33 if (zero
&& (num_words
|| num_bytes
)) {
34 memset(buf
+ smb_size
,'\0',num_words
*2 + num_bytes
);
36 SCVAL(buf
,smb_wct
,num_words
);
37 SSVAL(buf
,smb_vwv
+ num_words
*SIZEOFWORD
,num_bytes
);
38 smb_setlen(buf
,smb_size
+ num_words
*2 + num_bytes
- 4);
39 return (smb_size
+ num_words
*2 + num_bytes
);
42 /****************************************************************************
43 Change the timeout (in milliseconds).
44 ****************************************************************************/
46 unsigned int cli_set_timeout(struct cli_state
*cli
, unsigned int timeout
)
48 unsigned int old_timeout
= cli
->timeout
;
49 cli
->timeout
= timeout
;
53 /****************************************************************************
54 convenience routine to find if we negotiated ucs2
55 ****************************************************************************/
57 bool cli_ucs2(struct cli_state
*cli
)
59 return ((cli_state_capabilities(cli
) & CAP_UNICODE
) != 0);
62 /****************************************************************************
63 Setup basics in a outgoing packet.
64 ****************************************************************************/
66 void cli_setup_packet_buf(struct cli_state
*cli
, char *buf
)
70 SIVAL(buf
,smb_rcls
,0);
71 SSVAL(buf
,smb_pid
,cli
->smb1
.pid
);
72 memset(buf
+smb_pidhigh
, 0, 12);
73 SSVAL(buf
,smb_uid
, cli_state_get_uid(cli
));
74 SSVAL(buf
,smb_mid
,cli
->smb1
.mid
);
76 if (cli_state_protocol(cli
) <= PROTOCOL_CORE
) {
80 if (cli
->case_sensitive
) {
81 SCVAL(buf
,smb_flg
,0x0);
83 /* Default setting, case insensitive. */
84 SCVAL(buf
,smb_flg
,0x8);
86 flags2
= FLAGS2_LONG_PATH_COMPONENTS
;
87 if (cli_state_capabilities(cli
) & CAP_UNICODE
)
88 flags2
|= FLAGS2_UNICODE_STRINGS
;
89 if ((cli_state_capabilities(cli
) & CAP_DFS
) && cli
->dfsroot
)
90 flags2
|= FLAGS2_DFS_PATHNAMES
;
91 if (cli_state_capabilities(cli
) & CAP_STATUS32
)
92 flags2
|= FLAGS2_32_BIT_ERROR_CODES
;
94 flags2
|= FLAGS2_EXTENDED_SECURITY
;
95 SSVAL(buf
,smb_flg2
, flags2
);
98 /****************************************************************************
99 Initialize Domain, user or password.
100 ****************************************************************************/
102 NTSTATUS
cli_set_domain(struct cli_state
*cli
, const char *domain
)
104 TALLOC_FREE(cli
->domain
);
105 cli
->domain
= talloc_strdup(cli
, domain
? domain
: "");
106 if (cli
->domain
== NULL
) {
107 return NT_STATUS_NO_MEMORY
;
112 NTSTATUS
cli_set_username(struct cli_state
*cli
, const char *username
)
114 TALLOC_FREE(cli
->user_name
);
115 cli
->user_name
= talloc_strdup(cli
, username
? username
: "");
116 if (cli
->user_name
== NULL
) {
117 return NT_STATUS_NO_MEMORY
;
122 NTSTATUS
cli_set_password(struct cli_state
*cli
, const char *password
)
124 TALLOC_FREE(cli
->password
);
126 /* Password can be NULL. */
128 cli
->password
= talloc_strdup(cli
, password
);
129 if (cli
->password
== NULL
) {
130 return NT_STATUS_NO_MEMORY
;
133 /* Use zero NTLMSSP hashes and session key. */
134 cli
->password
= NULL
;
140 /****************************************************************************
141 Initialise credentials of a client structure.
142 ****************************************************************************/
144 NTSTATUS
cli_init_creds(struct cli_state
*cli
, const char *username
, const char *domain
, const char *password
)
146 NTSTATUS status
= cli_set_username(cli
, username
);
147 if (!NT_STATUS_IS_OK(status
)) {
150 status
= cli_set_domain(cli
, domain
);
151 if (!NT_STATUS_IS_OK(status
)) {
154 DEBUG(10,("cli_init_creds: user %s domain %s\n", cli
->user_name
, cli
->domain
));
156 return cli_set_password(cli
, password
);
159 /****************************************************************************
160 Initialise a client structure. Always returns a talloc'ed struct.
161 Set the signing state (used from the command line).
162 ****************************************************************************/
164 struct cli_state
*cli_state_create(TALLOC_CTX
*mem_ctx
,
166 const char *remote_name
,
167 const char *remote_realm
,
168 int signing_state
, int flags
)
170 struct cli_state
*cli
= NULL
;
171 bool allow_smb_signing
= false;
172 bool mandatory_signing
= false;
176 /* Check the effective uid - make sure we are not setuid */
177 if (is_setuid_root()) {
178 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
182 cli
= talloc_zero(mem_ctx
, struct cli_state
);
187 cli
->dfs_mountpoint
= talloc_strdup(cli
, "");
188 if (!cli
->dfs_mountpoint
) {
191 cli
->raw_status
= NT_STATUS_INTERNAL_ERROR
;
192 cli
->protocol
= PROTOCOL_NT1
;
193 cli
->timeout
= 20000; /* Timeout is in milliseconds. */
194 cli
->max_xmit
= CLI_BUFFER_SIZE
+4;
195 cli
->case_sensitive
= false;
197 cli
->use_spnego
= lp_client_use_spnego();
199 cli
->capabilities
= CAP_UNICODE
| CAP_STATUS32
| CAP_DFS
;
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 cli
->force_dos_errors
= true;
207 if (flags
& CLI_FULL_CONNECTION_FORCE_DOS_ERRORS
) {
208 cli
->force_dos_errors
= true;
211 if (getenv("CLI_FORCE_ASCII")) {
212 cli
->force_ascii
= true;
214 if (flags
& CLI_FULL_CONNECTION_FORCE_ASCII
) {
215 cli
->force_ascii
= true;
218 if (flags
& CLI_FULL_CONNECTION_DONT_SPNEGO
) {
219 cli
->use_spnego
= false;
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 cli
->use_level_II_oplocks
= true;
239 if (lp_client_signing()) {
240 allow_smb_signing
= true;
243 if (lp_client_signing() == Required
) {
244 mandatory_signing
= true;
247 if (signing_state
!= Undefined
) {
248 allow_smb_signing
= true;
251 if (signing_state
== false) {
252 allow_smb_signing
= false;
253 mandatory_signing
= false;
256 if (signing_state
== Required
) {
257 mandatory_signing
= true;
260 /* initialise signing */
261 cli
->signing_state
= smb_signing_init(cli
,
264 if (!cli
->signing_state
) {
268 cli
->conn
.outgoing
= tevent_queue_create(cli
, "cli_outgoing");
269 if (cli
->conn
.outgoing
== NULL
) {
272 cli
->conn
.pending
= NULL
;
274 cli
->conn
.remote_name
= talloc_strdup(cli
, remote_name
);
275 if (cli
->conn
.remote_name
== NULL
) {
280 cli
->conn
.remote_realm
= talloc_strdup(cli
, remote_realm
);
281 if (cli
->conn
.remote_realm
== NULL
) {
288 ss_length
= sizeof(cli
->conn
.local_ss
);
289 ret
= getsockname(fd
,
290 (struct sockaddr
*)(void *)&cli
->conn
.local_ss
,
295 ss_length
= sizeof(cli
->conn
.remote_ss
);
296 ret
= getpeername(fd
,
297 (struct sockaddr
*)(void *)&cli
->conn
.remote_ss
,
304 cli
->smb1
.pid
= (uint16_t)sys_getpid();
305 cli
->smb1
.vc_num
= cli
->smb1
.pid
;
306 cli
->smb1
.tid
= UINT16_MAX
;
307 cli
->smb1
.uid
= UID_FIELD_INVALID
;
309 cli
->initialised
= 1;
312 /* Clean up after malloc() error */
320 bool cli_state_encryption_on(struct cli_state
*cli
)
322 return common_encryption_on(cli
->trans_enc_state
);
326 /****************************************************************************
327 Close all pipes open on this session.
328 ****************************************************************************/
330 void cli_nt_pipes_close(struct cli_state
*cli
)
332 while (cli
->pipe_list
!= NULL
) {
334 * No TALLOC_FREE here!
336 talloc_free(cli
->pipe_list
);
340 /****************************************************************************
341 Shutdown a client structure.
342 ****************************************************************************/
344 static void _cli_shutdown(struct cli_state
*cli
)
346 cli_nt_pipes_close(cli
);
349 * tell our peer to free his resources. Wihtout this, when an
350 * application attempts to do a graceful shutdown and calls
351 * smbc_free_context() to clean up all connections, some connections
352 * can remain active on the peer end, until some (long) timeout period
353 * later. This tree disconnect forces the peer to clean up, since the
354 * connection will be going away.
356 if (cli_state_has_tcon(cli
)) {
360 data_blob_free(&cli
->secblob
);
361 data_blob_free(&cli
->user_session_key
);
363 cli_state_disconnect(cli
);
366 * Need to free pending first, they remove themselves
368 while (cli
->conn
.pending
) {
369 talloc_free(cli
->conn
.pending
[0]);
374 void cli_shutdown(struct cli_state
*cli
)
376 struct cli_state
*cli_head
;
380 DLIST_HEAD(cli
, cli_head
);
381 if (cli_head
== cli
) {
383 * head of a DFS list, shutdown all subsidiary DFS
386 struct cli_state
*p
, *next
;
388 for (p
= cli_head
->next
; p
; p
= next
) {
390 DLIST_REMOVE(cli_head
, p
);
394 DLIST_REMOVE(cli_head
, cli
);
400 /****************************************************************************
401 Set socket options on a open connection.
402 ****************************************************************************/
404 void cli_sockopt(struct cli_state
*cli
, const char *options
)
406 set_socket_options(cli
->conn
.fd
, options
);
409 const struct sockaddr_storage
*cli_state_local_sockaddr(struct cli_state
*cli
)
411 return &cli
->conn
.local_ss
;
414 const struct sockaddr_storage
*cli_state_remote_sockaddr(struct cli_state
*cli
)
416 return &cli
->conn
.remote_ss
;
419 const char *cli_state_remote_name(struct cli_state
*cli
)
421 return cli
->conn
.remote_name
;
424 const char *cli_state_remote_realm(struct cli_state
*cli
)
426 return cli
->conn
.remote_realm
;
429 uint16_t cli_state_get_vc_num(struct cli_state
*cli
)
431 return cli
->smb1
.vc_num
;
434 /****************************************************************************
435 Set the PID to use for smb messages. Return the old pid.
436 ****************************************************************************/
438 uint16
cli_setpid(struct cli_state
*cli
, uint16 pid
)
440 uint16_t ret
= cli
->smb1
.pid
;
445 uint16_t cli_getpid(struct cli_state
*cli
)
447 return cli
->smb1
.pid
;
450 bool cli_state_has_tcon(struct cli_state
*cli
)
452 if (cli
->smb1
.tid
== UINT16_MAX
) {
459 uint16_t cli_state_get_tid(struct cli_state
*cli
)
461 return cli
->smb1
.tid
;
464 uint16_t cli_state_set_tid(struct cli_state
*cli
, uint16_t tid
)
466 uint16_t ret
= cli
->smb1
.tid
;
471 uint16_t cli_state_get_uid(struct cli_state
*cli
)
473 return cli
->smb1
.uid
;
476 uint16_t cli_state_set_uid(struct cli_state
*cli
, uint16_t uid
)
478 uint16_t ret
= cli
->smb1
.uid
;
483 /****************************************************************************
484 Set the case sensitivity flag on the packets. Returns old state.
485 ****************************************************************************/
487 bool cli_set_case_sensitive(struct cli_state
*cli
, bool case_sensitive
)
489 bool ret
= cli
->case_sensitive
;
490 cli
->case_sensitive
= case_sensitive
;
494 enum protocol_types
cli_state_protocol(struct cli_state
*cli
)
496 return cli
->protocol
;
499 uint32_t cli_state_capabilities(struct cli_state
*cli
)
501 return cli
->capabilities
;
504 struct cli_echo_state
{
510 static void cli_echo_done(struct tevent_req
*subreq
);
512 struct tevent_req
*cli_echo_send(TALLOC_CTX
*mem_ctx
, struct event_context
*ev
,
513 struct cli_state
*cli
, uint16_t num_echos
,
516 struct tevent_req
*req
, *subreq
;
517 struct cli_echo_state
*state
;
519 req
= tevent_req_create(mem_ctx
, &state
, struct cli_echo_state
);
523 SSVAL(state
->vwv
, 0, num_echos
);
525 state
->num_echos
= num_echos
;
527 subreq
= cli_smb_send(state
, ev
, cli
, SMBecho
, 0, 1, state
->vwv
,
528 data
.length
, data
.data
);
529 if (subreq
== NULL
) {
532 tevent_req_set_callback(subreq
, cli_echo_done
, req
);
539 static void cli_echo_done(struct tevent_req
*subreq
)
541 struct tevent_req
*req
= tevent_req_callback_data(
542 subreq
, struct tevent_req
);
543 struct cli_echo_state
*state
= tevent_req_data(
544 req
, struct cli_echo_state
);
550 status
= cli_smb_recv(subreq
, state
, &inbuf
, 0, NULL
, NULL
,
552 if (!NT_STATUS_IS_OK(status
)) {
553 tevent_req_nterror(req
, status
);
556 if ((num_bytes
!= state
->data
.length
)
557 || (memcmp(bytes
, state
->data
.data
, num_bytes
) != 0)) {
558 tevent_req_nterror(req
, NT_STATUS_INVALID_NETWORK_RESPONSE
);
562 state
->num_echos
-=1;
563 if (state
->num_echos
== 0) {
564 tevent_req_done(req
);
568 if (!cli_smb_req_set_pending(subreq
)) {
569 tevent_req_nterror(req
, NT_STATUS_NO_MEMORY
);
575 * Get the result out from an echo request
576 * @param[in] req The async_req from cli_echo_send
577 * @retval Did the server reply correctly?
580 NTSTATUS
cli_echo_recv(struct tevent_req
*req
)
582 return tevent_req_simple_recv_ntstatus(req
);
586 * @brief Send/Receive SMBEcho requests
587 * @param[in] mem_ctx The memory context to put the async_req on
588 * @param[in] ev The event context that will call us back
589 * @param[in] cli The connection to send the echo to
590 * @param[in] num_echos How many times do we want to get the reply?
591 * @param[in] data The data we want to get back
592 * @retval Did the server reply correctly?
595 NTSTATUS
cli_echo(struct cli_state
*cli
, uint16_t num_echos
, DATA_BLOB data
)
597 TALLOC_CTX
*frame
= talloc_stackframe();
598 struct event_context
*ev
;
599 struct tevent_req
*req
;
600 NTSTATUS status
= NT_STATUS_OK
;
602 if (cli_has_async_calls(cli
)) {
604 * Can't use sync call while an async call is in flight
606 status
= NT_STATUS_INVALID_PARAMETER
;
610 ev
= event_context_init(frame
);
612 status
= NT_STATUS_NO_MEMORY
;
616 req
= cli_echo_send(frame
, ev
, cli
, num_echos
, data
);
618 status
= NT_STATUS_NO_MEMORY
;
622 if (!tevent_req_poll(req
, ev
)) {
623 status
= map_nt_error_from_unix(errno
);
627 status
= cli_echo_recv(req
);
634 * Is the SMB command able to hold an AND_X successor
635 * @param[in] cmd The SMB command in question
636 * @retval Can we add a chained request after "cmd"?
638 bool is_andx_req(uint8_t cmd
)
658 NTSTATUS
cli_smb(TALLOC_CTX
*mem_ctx
, struct cli_state
*cli
,
659 uint8_t smb_command
, uint8_t additional_flags
,
660 uint8_t wct
, uint16_t *vwv
,
661 uint32_t num_bytes
, const uint8_t *bytes
,
662 struct tevent_req
**result_parent
,
663 uint8_t min_wct
, uint8_t *pwct
, uint16_t **pvwv
,
664 uint32_t *pnum_bytes
, uint8_t **pbytes
)
666 struct tevent_context
*ev
;
667 struct tevent_req
*req
= NULL
;
668 NTSTATUS status
= NT_STATUS_NO_MEMORY
;
670 if (cli_has_async_calls(cli
)) {
671 return NT_STATUS_INVALID_PARAMETER
;
673 ev
= tevent_context_init(mem_ctx
);
677 req
= cli_smb_send(mem_ctx
, ev
, cli
, smb_command
, additional_flags
,
678 wct
, vwv
, num_bytes
, bytes
);
682 if (!tevent_req_poll_ntstatus(req
, ev
, &status
)) {
685 status
= cli_smb_recv(req
, NULL
, NULL
, min_wct
, pwct
, pvwv
,
689 if (NT_STATUS_IS_OK(status
) && (result_parent
!= NULL
)) {
690 *result_parent
= req
;