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.
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)
84 extern int smb_read_error;
87 /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
92 ret = client_receive_smb(cli->fd,cli->inbuf,cli->timeout);
95 /* it might be an oplock break request */
96 if (!(CVAL(cli->inbuf, smb_flg) & FLAG_REPLY) &&
97 CVAL(cli->inbuf,smb_com) == SMBlockingX &&
98 SVAL(cli->inbuf,smb_vwv6) == 0 &&
99 SVAL(cli->inbuf,smb_vwv7) == 0) {
100 if (cli->oplock_handler) {
101 int fnum = SVAL(cli->inbuf,smb_vwv2);
102 unsigned char level = CVAL(cli->inbuf,smb_vwv3+1);
103 if (!cli->oplock_handler(cli, fnum, level)) return False;
105 /* try to prevent loops */
106 SCVAL(cli->inbuf,smb_com,0xFF);
111 /* If the server is not responding, note that now */
114 cli->smb_rw_error = smb_read_error;
120 if (!cli_check_sign_mac(cli, True)) {
121 DEBUG(0, ("SMB Signature verification failed on incoming packet!\n"));
122 cli->smb_rw_error = READ_BAD_SIG;
130 /****************************************************************************
132 ****************************************************************************/
134 BOOL cli_send_smb(struct cli_state *cli)
140 /* fd == -1 causes segfaults -- Tom (tom@ninja.nl) */
144 cli_calculate_sign_mac(cli);
146 len = smb_len(cli->outbuf) + 4;
148 while (nwritten < len) {
149 ret = write_socket(cli->fd,cli->outbuf+nwritten,len - nwritten);
153 cli->smb_rw_error = WRITE_ERROR;
154 DEBUG(0,("Error writing %d bytes to client. %d (%s)\n",
155 (int)len,(int)ret, strerror(errno) ));
160 /* Increment the mid so we can tell between responses. */
167 /****************************************************************************
168 Setup basics in a outgoing packet.
169 ****************************************************************************/
171 void cli_setup_packet(struct cli_state *cli)
174 SSVAL(cli->outbuf,smb_pid,cli->pid);
175 SSVAL(cli->outbuf,smb_uid,cli->vuid);
176 SSVAL(cli->outbuf,smb_mid,cli->mid);
177 if (cli->protocol > PROTOCOL_CORE) {
179 SCVAL(cli->outbuf,smb_flg,0x8);
180 flags2 = FLAGS2_LONG_PATH_COMPONENTS;
181 if (cli->capabilities & CAP_UNICODE)
182 flags2 |= FLAGS2_UNICODE_STRINGS;
183 if (cli->capabilities & CAP_STATUS32)
184 flags2 |= FLAGS2_32_BIT_ERROR_CODES;
186 flags2 |= FLAGS2_EXTENDED_SECURITY;
187 SSVAL(cli->outbuf,smb_flg2, flags2);
191 /****************************************************************************
192 Setup the bcc length of the packet from a pointer to the end of the data.
193 ****************************************************************************/
195 void cli_setup_bcc(struct cli_state *cli, void *p)
197 set_message_bcc(cli->outbuf, PTR_DIFF(p, smb_buf(cli->outbuf)));
200 /****************************************************************************
201 Initialise credentials of a client structure.
202 ****************************************************************************/
204 void cli_init_creds(struct cli_state *cli, const struct ntuser_creds *usr)
206 /* copy_nt_creds(&cli->usr, usr); */
207 fstrcpy(cli->domain , usr->domain);
208 fstrcpy(cli->user_name, usr->user_name);
209 memcpy(&cli->pwd, &usr->pwd, sizeof(usr->pwd));
211 DEBUG(10,("cli_init_creds: user %s domain %s\n",
212 cli->user_name, cli->domain));
215 /****************************************************************************
216 Set the signing state (used from the command line).
217 ****************************************************************************/
219 void cli_setup_signing_state(struct cli_state *cli, int signing_state)
221 if (signing_state == Undefined)
224 if (signing_state == False) {
225 cli->sign_info.allow_smb_signing = False;
226 cli->sign_info.mandatory_signing = False;
230 cli->sign_info.allow_smb_signing = True;
232 if (signing_state == Required)
233 cli->sign_info.mandatory_signing = True;
236 /****************************************************************************
237 Initialise a client structure.
238 ****************************************************************************/
240 struct cli_state *cli_initialise(struct cli_state *cli)
242 BOOL alloced_cli = False;
244 /* Check the effective uid - make sure we are not setuid */
245 if (is_setuid_root()) {
246 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
251 cli = (struct cli_state *)malloc(sizeof(*cli));
258 if (cli->initialised)
259 cli_close_connection(cli);
266 cli->pid = (uint16)sys_getpid();
268 cli->vuid = UID_FIELD_INVALID;
269 cli->protocol = PROTOCOL_NT1;
270 cli->timeout = 20000; /* Timeout is in milliseconds. */
271 cli->bufsize = CLI_BUFFER_SIZE+4;
272 cli->max_xmit = cli->bufsize;
273 cli->outbuf = (char *)malloc(cli->bufsize+SAFETY_MARGIN);
274 cli->inbuf = (char *)malloc(cli->bufsize+SAFETY_MARGIN);
275 cli->oplock_handler = cli_oplock_ack;
277 cli->use_spnego = lp_client_use_spnego();
279 cli->capabilities = CAP_UNICODE | CAP_STATUS32;
281 /* Set the CLI_FORCE_DOSERR environment variable to test
282 client routines using DOS errors instead of STATUS32
283 ones. This intended only as a temporary hack. */
284 if (getenv("CLI_FORCE_DOSERR"))
285 cli->force_dos_errors = True;
287 if (lp_client_signing())
288 cli->sign_info.allow_smb_signing = True;
290 if (lp_client_signing() == Required)
291 cli->sign_info.mandatory_signing = True;
293 if (!cli->outbuf || !cli->inbuf)
296 if ((cli->mem_ctx = talloc_init("cli based talloc")) == NULL)
299 memset(cli->outbuf, 0, cli->bufsize);
300 memset(cli->inbuf, 0, cli->bufsize);
303 #if defined(DEVELOPER)
304 /* just because we over-allocate, doesn't mean it's right to use it */
305 clobber_region(FUNCTION_MACRO, __LINE__, cli->outbuf+cli->bufsize, SAFETY_MARGIN);
306 clobber_region(FUNCTION_MACRO, __LINE__, cli->inbuf+cli->bufsize, SAFETY_MARGIN);
309 /* initialise signing */
310 cli_null_set_signing(cli);
312 cli->nt_pipe_fnum = 0;
313 cli->saved_netlogon_pipe_fnum = 0;
315 cli->initialised = 1;
316 cli->allocated = alloced_cli;
322 /* Clean up after malloc() error */
326 SAFE_FREE(cli->inbuf);
327 SAFE_FREE(cli->outbuf);
335 /****************************************************************************
337 ****************************************************************************/
339 void cli_nt_session_close(struct cli_state *cli)
341 if (cli->ntlmssp_pipe_state) {
342 ntlmssp_end(&cli->ntlmssp_pipe_state);
345 if (cli->nt_pipe_fnum != 0)
346 cli_close(cli, cli->nt_pipe_fnum);
348 cli->nt_pipe_fnum = 0;
352 /****************************************************************************
353 close the NETLOGON session holding the session key for NETSEC
354 ****************************************************************************/
356 void cli_nt_netlogon_netsec_session_close(struct cli_state *cli)
358 if (cli->saved_netlogon_pipe_fnum != 0) {
359 cli_close(cli, cli->saved_netlogon_pipe_fnum);
360 cli->saved_netlogon_pipe_fnum = 0;
364 /****************************************************************************
365 Close a client connection and free the memory without destroying cli itself.
366 ****************************************************************************/
368 void cli_close_connection(struct cli_state *cli)
371 * tell our peer to free his resources. Wihtout this, when an
372 * application attempts to do a graceful shutdown and calls
373 * smbc_free_context() to clean up all connections, some connections
374 * can remain active on the peer end, until some (long) timeout period
375 * later. This tree disconnect forces the peer to clean up, since the
376 * connection will be going away.
378 * Also, do not do tree disconnect when cli->smb_rw_error is DO_NOT_DO_TDIS
379 * the only user for this so far is smbmount which passes opened connection
380 * down to kernel's smbfs module.
382 if ( (cli->cnum != (uint16)-1) && (cli->smb_rw_error != DO_NOT_DO_TDIS ) )
385 cli_nt_session_close(cli);
386 cli_nt_netlogon_netsec_session_close(cli);
388 SAFE_FREE(cli->outbuf);
389 SAFE_FREE(cli->inbuf);
391 cli_free_signing_context(cli);
392 data_blob_free(&cli->secblob);
393 data_blob_free(&cli->user_session_key);
395 if (cli->ntlmssp_pipe_state)
396 ntlmssp_end(&cli->ntlmssp_pipe_state);
399 talloc_destroy(cli->mem_ctx);
406 cli->smb_rw_error = 0;
410 /****************************************************************************
411 Shutdown a client structure.
412 ****************************************************************************/
414 void cli_shutdown(struct cli_state *cli)
416 BOOL allocated = cli->allocated;
417 cli_close_connection(cli);
423 /****************************************************************************
424 Set socket options on a open connection.
425 ****************************************************************************/
427 void cli_sockopt(struct cli_state *cli, const char *options)
429 set_socket_options(cli->fd, options);
432 /****************************************************************************
433 Set the PID to use for smb messages. Return the old pid.
434 ****************************************************************************/
436 uint16 cli_setpid(struct cli_state *cli, uint16 pid)
438 uint16 ret = cli->pid;
443 /****************************************************************************
444 Send a keepalive packet to the server
445 ****************************************************************************/
446 BOOL cli_send_keepalive(struct cli_state *cli)
449 DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
452 if (!send_keepalive(cli->fd)) {
455 DEBUG(0,("Error sending keepalive packet to client.\n"));