2 Unix SMB/CIFS implementation.
3 SMB client generic functions
4 Copyright (C) Andrew Tridgell 1994-1998
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 extern int smb_read_error
;
25 /****************************************************************************
26 Change the timeout (in milliseconds).
27 ****************************************************************************/
29 unsigned int cli_set_timeout(struct cli_state
*cli
, unsigned int timeout
)
31 unsigned int old_timeout
= cli
->timeout
;
32 cli
->timeout
= timeout
;
36 /****************************************************************************
37 Change the port number used to call on.
38 ****************************************************************************/
40 int cli_set_port(struct cli_state
*cli
, int port
)
46 /****************************************************************************
47 Read an smb from a fd ignoring all keepalive packets. Note that the buffer
48 *MUST* be of size BUFFER_SIZE+SAFETY_MARGIN.
49 The timeout is in milliseconds
51 This is exactly the same as receive_smb except that it never returns
52 a session keepalive packet (just as receive_smb used to do).
53 receive_smb was changed to return keepalives as the oplock processing means this call
54 should never go into a blocking read.
55 ****************************************************************************/
57 static BOOL
client_receive_smb(int fd
,char *buffer
, unsigned int timeout
)
62 ret
= receive_smb_raw(fd
, buffer
, timeout
);
65 DEBUG(10,("client_receive_smb failed\n"));
70 /* Ignore session keepalive packets. */
71 if(CVAL(buffer
,0) != SMBkeepalive
)
78 /****************************************************************************
80 ****************************************************************************/
82 BOOL
cli_receive_smb(struct cli_state
*cli
)
86 /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
91 ret
= client_receive_smb(cli
->fd
,cli
->inbuf
,cli
->timeout
);
94 /* it might be an oplock break request */
95 if (!(CVAL(cli
->inbuf
, smb_flg
) & FLAG_REPLY
) &&
96 CVAL(cli
->inbuf
,smb_com
) == SMBlockingX
&&
97 SVAL(cli
->inbuf
,smb_vwv6
) == 0 &&
98 SVAL(cli
->inbuf
,smb_vwv7
) == 0) {
99 if (cli
->oplock_handler
) {
100 int fnum
= SVAL(cli
->inbuf
,smb_vwv2
);
101 unsigned char level
= CVAL(cli
->inbuf
,smb_vwv3
+1);
102 if (!cli
->oplock_handler(cli
, fnum
, level
)) return False
;
104 /* try to prevent loops */
105 SCVAL(cli
->inbuf
,smb_com
,0xFF);
110 /* If the server is not responding, note that now */
112 DEBUG(0, ("Receiving SMB: Server stopped responding\n"));
113 cli
->smb_rw_error
= smb_read_error
;
119 if (!cli_check_sign_mac(cli
)) {
121 * If we get a signature failure in sessionsetup, then
122 * the server sometimes just reflects the sent signature
123 * back to us. Detect this and allow the upper layer to
124 * retrieve the correct Windows error message.
126 if (CVAL(cli
->outbuf
,smb_com
) == SMBsesssetupX
&&
127 (smb_len(cli
->inbuf
) > (smb_ss_field
+ 8 - 4)) &&
128 (SVAL(cli
->inbuf
,smb_flg2
) & FLAGS2_SMB_SECURITY_SIGNATURES
) &&
129 memcmp(&cli
->outbuf
[smb_ss_field
],&cli
->inbuf
[smb_ss_field
],8) == 0 &&
133 * Reflected signature on login error.
134 * Set bad sig but don't close fd.
136 cli
->smb_rw_error
= READ_BAD_SIG
;
140 DEBUG(0, ("SMB Signature verification failed on incoming packet!\n"));
141 cli
->smb_rw_error
= READ_BAD_SIG
;
149 static ssize_t
write_socket(int fd
, const char *buf
, size_t len
)
153 DEBUG(6,("write_socket(%d,%d)\n",fd
,(int)len
));
154 ret
= write_data(fd
,buf
,len
);
156 DEBUG(6,("write_socket(%d,%d) wrote %d\n",fd
,(int)len
,(int)ret
));
158 DEBUG(0,("write_socket: Error writing %d bytes to socket %d: ERRNO = %s\n",
159 (int)len
, fd
, strerror(errno
) ));
164 /****************************************************************************
166 ****************************************************************************/
168 BOOL
cli_send_smb(struct cli_state
*cli
)
174 /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
178 cli_calculate_sign_mac(cli
);
180 len
= smb_len(cli
->outbuf
) + 4;
182 while (nwritten
< len
) {
183 ret
= write_socket(cli
->fd
,cli
->outbuf
+nwritten
,len
- nwritten
);
187 cli
->smb_rw_error
= WRITE_ERROR
;
188 DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
189 (int)len
,(int)ret
, strerror(errno
) ));
194 /* Increment the mid so we can tell between responses. */
201 /****************************************************************************
202 Setup basics in a outgoing packet.
203 ****************************************************************************/
205 void cli_setup_packet(struct cli_state
*cli
)
208 SSVAL(cli
->outbuf
,smb_pid
,cli
->pid
);
209 SSVAL(cli
->outbuf
,smb_uid
,cli
->vuid
);
210 SSVAL(cli
->outbuf
,smb_mid
,cli
->mid
);
211 if (cli
->protocol
> PROTOCOL_CORE
) {
213 if (cli
->case_sensitive
) {
214 SCVAL(cli
->outbuf
,smb_flg
,0x0);
216 /* Default setting, case insensitive. */
217 SCVAL(cli
->outbuf
,smb_flg
,0x8);
219 flags2
= FLAGS2_LONG_PATH_COMPONENTS
;
220 if (cli
->capabilities
& CAP_UNICODE
)
221 flags2
|= FLAGS2_UNICODE_STRINGS
;
222 if ((cli
->capabilities
& CAP_DFS
) && cli
->dfsroot
)
223 flags2
|= FLAGS2_DFS_PATHNAMES
;
224 if (cli
->capabilities
& CAP_STATUS32
)
225 flags2
|= FLAGS2_32_BIT_ERROR_CODES
;
227 flags2
|= FLAGS2_EXTENDED_SECURITY
;
228 SSVAL(cli
->outbuf
,smb_flg2
, flags2
);
232 /****************************************************************************
233 Setup the bcc length of the packet from a pointer to the end of the data.
234 ****************************************************************************/
236 void cli_setup_bcc(struct cli_state
*cli
, void *p
)
238 set_message_bcc(cli
->outbuf
, PTR_DIFF(p
, smb_buf(cli
->outbuf
)));
241 /****************************************************************************
242 Initialise credentials of a client structure.
243 ****************************************************************************/
245 void cli_init_creds(struct cli_state
*cli
, const char *username
, const char *domain
, const char *password
)
247 fstrcpy(cli
->domain
, domain
);
248 fstrcpy(cli
->user_name
, username
);
249 pwd_set_cleartext(&cli
->pwd
, password
);
251 cli
->pwd
.null_pwd
= True
;
254 DEBUG(10,("cli_init_creds: user %s domain %s\n", cli
->user_name
, cli
->domain
));
257 /****************************************************************************
258 Set the signing state (used from the command line).
259 ****************************************************************************/
261 void cli_setup_signing_state(struct cli_state
*cli
, int signing_state
)
263 if (signing_state
== Undefined
)
266 if (signing_state
== False
) {
267 cli
->sign_info
.allow_smb_signing
= False
;
268 cli
->sign_info
.mandatory_signing
= False
;
272 cli
->sign_info
.allow_smb_signing
= True
;
274 if (signing_state
== Required
)
275 cli
->sign_info
.mandatory_signing
= True
;
278 /****************************************************************************
279 Initialise a client structure. Always returns a malloc'ed struct.
280 ****************************************************************************/
282 struct cli_state
*cli_initialise(void)
284 struct cli_state
*cli
= NULL
;
286 /* Check the effective uid - make sure we are not setuid */
287 if (is_setuid_root()) {
288 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
292 cli
= SMB_MALLOC_P(struct cli_state
);
302 cli
->pid
= (uint16
)sys_getpid();
304 cli
->vuid
= UID_FIELD_INVALID
;
305 cli
->protocol
= PROTOCOL_NT1
;
306 cli
->timeout
= 20000; /* Timeout is in milliseconds. */
307 cli
->bufsize
= CLI_BUFFER_SIZE
+4;
308 cli
->max_xmit
= cli
->bufsize
;
309 cli
->outbuf
= (char *)SMB_MALLOC(cli
->bufsize
+SAFETY_MARGIN
);
310 cli
->inbuf
= (char *)SMB_MALLOC(cli
->bufsize
+SAFETY_MARGIN
);
311 cli
->oplock_handler
= cli_oplock_ack
;
312 cli
->case_sensitive
= False
;
313 cli
->smb_rw_error
= 0;
315 cli
->use_spnego
= lp_client_use_spnego();
317 cli
->capabilities
= CAP_UNICODE
| CAP_STATUS32
| CAP_DFS
;
319 /* Set the CLI_FORCE_DOSERR environment variable to test
320 client routines using DOS errors instead of STATUS32
321 ones. This intended only as a temporary hack. */
322 if (getenv("CLI_FORCE_DOSERR"))
323 cli
->force_dos_errors
= True
;
325 if (lp_client_signing())
326 cli
->sign_info
.allow_smb_signing
= True
;
328 if (lp_client_signing() == Required
)
329 cli
->sign_info
.mandatory_signing
= True
;
331 if (!cli
->outbuf
|| !cli
->inbuf
)
334 if ((cli
->mem_ctx
= talloc_init("cli based talloc")) == NULL
)
337 memset(cli
->outbuf
, 0, cli
->bufsize
);
338 memset(cli
->inbuf
, 0, cli
->bufsize
);
341 #if defined(DEVELOPER)
342 /* just because we over-allocate, doesn't mean it's right to use it */
343 clobber_region(FUNCTION_MACRO
, __LINE__
, cli
->outbuf
+cli
->bufsize
, SAFETY_MARGIN
);
344 clobber_region(FUNCTION_MACRO
, __LINE__
, cli
->inbuf
+cli
->bufsize
, SAFETY_MARGIN
);
347 /* initialise signing */
348 cli_null_set_signing(cli
);
350 cli
->initialised
= 1;
354 /* Clean up after malloc() error */
358 SAFE_FREE(cli
->inbuf
);
359 SAFE_FREE(cli
->outbuf
);
364 /****************************************************************************
366 Close an open named pipe over SMB. Free any authentication data.
367 Returns False if the cli_close call failed.
368 ****************************************************************************/
370 BOOL
cli_rpc_pipe_close(struct rpc_pipe_client
*cli
)
378 ret
= cli_close(cli
->cli
, cli
->fnum
);
381 DEBUG(1,("cli_rpc_pipe_close: cli_close failed on pipe %s, "
383 "to machine %s. Error was %s\n",
387 cli_errstr(cli
->cli
)));
390 if (cli
->auth
.cli_auth_data_free_func
) {
391 (*cli
->auth
.cli_auth_data_free_func
)(&cli
->auth
);
394 DEBUG(10,("cli_rpc_pipe_close: closed pipe %s to machine %s\n",
395 cli
->pipe_name
, cli
->cli
->desthost
));
397 DLIST_REMOVE(cli
->cli
->pipe_list
, cli
);
398 talloc_destroy(cli
->mem_ctx
);
402 /****************************************************************************
403 Close all pipes open on this session.
404 ****************************************************************************/
406 void cli_nt_pipes_close(struct cli_state
*cli
)
408 struct rpc_pipe_client
*cp
, *next
;
410 for (cp
= cli
->pipe_list
; cp
; cp
= next
) {
412 cli_rpc_pipe_close(cp
);
416 /****************************************************************************
417 Shutdown a client structure.
418 ****************************************************************************/
420 void cli_shutdown(struct cli_state
*cli
)
422 cli_nt_pipes_close(cli
);
425 * tell our peer to free his resources. Wihtout this, when an
426 * application attempts to do a graceful shutdown and calls
427 * smbc_free_context() to clean up all connections, some connections
428 * can remain active on the peer end, until some (long) timeout period
429 * later. This tree disconnect forces the peer to clean up, since the
430 * connection will be going away.
432 * Also, do not do tree disconnect when cli->smb_rw_error is DO_NOT_DO_TDIS
433 * the only user for this so far is smbmount which passes opened connection
434 * down to kernel's smbfs module.
436 if ( (cli
->cnum
!= (uint16
)-1) && (cli
->smb_rw_error
!= DO_NOT_DO_TDIS
) ) {
440 SAFE_FREE(cli
->outbuf
);
441 SAFE_FREE(cli
->inbuf
);
443 cli_free_signing_context(cli
);
444 data_blob_free(&cli
->secblob
);
445 data_blob_free(&cli
->user_session_key
);
448 talloc_destroy(cli
->mem_ctx
);
456 cli
->smb_rw_error
= 0;
461 /****************************************************************************
462 Set socket options on a open connection.
463 ****************************************************************************/
465 void cli_sockopt(struct cli_state
*cli
, const char *options
)
467 set_socket_options(cli
->fd
, options
);
470 /****************************************************************************
471 Set the PID to use for smb messages. Return the old pid.
472 ****************************************************************************/
474 uint16
cli_setpid(struct cli_state
*cli
, uint16 pid
)
476 uint16 ret
= cli
->pid
;
481 /****************************************************************************
482 Set the case sensitivity flag on the packets. Returns old state.
483 ****************************************************************************/
485 BOOL
cli_set_case_sensitive(struct cli_state
*cli
, BOOL case_sensitive
)
487 BOOL ret
= cli
->case_sensitive
;
488 cli
->case_sensitive
= case_sensitive
;
492 /****************************************************************************
493 Send a keepalive packet to the server
494 ****************************************************************************/
496 BOOL
cli_send_keepalive(struct cli_state
*cli
)
499 DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
502 if (!send_keepalive(cli
->fd
)) {
505 DEBUG(0,("Error sending keepalive packet to client.\n"));
511 /****************************************************************************
512 Send/receive a SMBecho command: ping the server
513 ****************************************************************************/
515 BOOL
cli_echo(struct cli_state
*cli
, unsigned char *data
, size_t length
)
519 SMB_ASSERT(length
< 1024);
521 memset(cli
->outbuf
,'\0',smb_size
);
522 set_message(cli
->outbuf
,1,length
,True
);
523 SCVAL(cli
->outbuf
,smb_com
,SMBecho
);
524 SSVAL(cli
->outbuf
,smb_tid
,65535);
525 SSVAL(cli
->outbuf
,smb_vwv0
,1);
526 cli_setup_packet(cli
);
527 p
= smb_buf(cli
->outbuf
);
528 memcpy(p
, data
, length
);
531 cli_setup_bcc(cli
, p
);
534 if (!cli_receive_smb(cli
)) {
538 if (cli_is_error(cli
)) {