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(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
)) {
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_caclulate_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
) ));
163 /****************************************************************************
164 Setup basics in a outgoing packet.
165 ****************************************************************************/
167 void cli_setup_packet(struct cli_state
*cli
)
170 SSVAL(cli
->outbuf
,smb_pid
,cli
->pid
);
171 SSVAL(cli
->outbuf
,smb_uid
,cli
->vuid
);
172 SSVAL(cli
->outbuf
,smb_mid
,cli
->mid
);
173 if (cli
->protocol
> PROTOCOL_CORE
) {
175 SCVAL(cli
->outbuf
,smb_flg
,0x8);
176 flags2
= FLAGS2_LONG_PATH_COMPONENTS
;
177 if (cli
->capabilities
& CAP_UNICODE
)
178 flags2
|= FLAGS2_UNICODE_STRINGS
;
179 if (cli
->capabilities
& CAP_STATUS32
)
180 flags2
|= FLAGS2_32_BIT_ERROR_CODES
;
182 flags2
|= FLAGS2_EXTENDED_SECURITY
;
183 SSVAL(cli
->outbuf
,smb_flg2
, flags2
);
187 /****************************************************************************
188 Setup the bcc length of the packet from a pointer to the end of the data.
189 ****************************************************************************/
191 void cli_setup_bcc(struct cli_state
*cli
, void *p
)
193 set_message_bcc(cli
->outbuf
, PTR_DIFF(p
, smb_buf(cli
->outbuf
)));
196 /****************************************************************************
197 Initialise credentials of a client structure.
198 ****************************************************************************/
200 void cli_init_creds(struct cli_state
*cli
, const struct ntuser_creds
*usr
)
202 /* copy_nt_creds(&cli->usr, usr); */
203 fstrcpy(cli
->domain
, usr
->domain
);
204 fstrcpy(cli
->user_name
, usr
->user_name
);
205 memcpy(&cli
->pwd
, &usr
->pwd
, sizeof(usr
->pwd
));
206 cli
->ntlmssp_flags
= usr
->ntlmssp_flags
;
207 cli
->ntlmssp_cli_flgs
= usr
!= NULL
? usr
->ntlmssp_flags
: 0;
209 DEBUG(10,("cli_init_creds: user %s domain %s flgs: %x\nntlmssp_cli_flgs:%x\n",
210 cli
->user_name
, cli
->domain
,
211 cli
->ntlmssp_flags
,cli
->ntlmssp_cli_flgs
));
214 /****************************************************************************
215 Initialise a client structure.
216 ****************************************************************************/
218 struct cli_state
*cli_initialise(struct cli_state
*cli
)
220 BOOL alloced_cli
= False
;
222 /* Check the effective uid - make sure we are not setuid */
223 if (is_setuid_root()) {
224 DEBUG(0,("libsmb based programs must *NOT* be setuid root.\n"));
229 cli
= (struct cli_state
*)malloc(sizeof(*cli
));
236 if (cli
->initialised
)
237 cli_close_connection(cli
);
244 cli
->pid
= (uint16
)sys_getpid();
246 cli
->vuid
= UID_FIELD_INVALID
;
247 cli
->protocol
= PROTOCOL_NT1
;
248 cli
->timeout
= 20000; /* Timeout is in milliseconds. */
249 cli
->bufsize
= CLI_BUFFER_SIZE
+4;
250 cli
->max_xmit
= cli
->bufsize
;
251 cli
->outbuf
= (char *)malloc(cli
->bufsize
+SAFETY_MARGIN
);
252 cli
->inbuf
= (char *)malloc(cli
->bufsize
+SAFETY_MARGIN
);
253 cli
->oplock_handler
= cli_oplock_ack
;
255 cli
->use_spnego
= lp_client_use_spnego();
257 cli
->capabilities
= CAP_UNICODE
| CAP_STATUS32
;
259 /* Set the CLI_FORCE_DOSERR environment variable to test
260 client routines using DOS errors instead of STATUS32
261 ones. This intended only as a temporary hack. */
262 if (getenv("CLI_FORCE_DOSERR"))
263 cli
->force_dos_errors
= True
;
265 if (lp_client_signing())
266 cli
->sign_info
.allow_smb_signing
= True
;
268 if (!cli
->outbuf
|| !cli
->inbuf
)
271 if ((cli
->mem_ctx
= talloc_init("cli based talloc")) == NULL
)
274 memset(cli
->outbuf
, 0, cli
->bufsize
);
275 memset(cli
->inbuf
, 0, cli
->bufsize
);
277 /* just becouse we over-allocate, doesn't mean it's right to use it */
278 clobber_region(FUNCTION_MACRO
, __LINE__
, cli
->outbuf
+cli
->bufsize
, SAFETY_MARGIN
);
279 clobber_region(FUNCTION_MACRO
, __LINE__
, cli
->inbuf
+cli
->bufsize
, SAFETY_MARGIN
);
281 /* initialise signing */
282 cli_null_set_signing(cli
);
284 cli
->nt_pipe_fnum
= 0;
285 cli
->saved_netlogon_pipe_fnum
= 0;
287 cli
->initialised
= 1;
288 cli
->allocated
= alloced_cli
;
292 /* Clean up after malloc() error */
296 SAFE_FREE(cli
->inbuf
);
297 SAFE_FREE(cli
->outbuf
);
305 /****************************************************************************
306 Close a client connection and free the memory without destroying cli itself.
307 ****************************************************************************/
309 void cli_close_connection(struct cli_state
*cli
)
311 SAFE_FREE(cli
->outbuf
);
312 SAFE_FREE(cli
->inbuf
);
314 cli_free_signing_context(cli
);
315 data_blob_free(&cli
->secblob
);
318 talloc_destroy(cli
->mem_ctx
);
325 cli
->smb_rw_error
= 0;
329 /****************************************************************************
330 Shutdown a client structure.
331 ****************************************************************************/
333 void cli_shutdown(struct cli_state
*cli
)
335 BOOL allocated
= cli
->allocated
;
336 cli_close_connection(cli
);
342 /****************************************************************************
343 Set socket options on a open connection.
344 ****************************************************************************/
346 void cli_sockopt(struct cli_state
*cli
, const char *options
)
348 set_socket_options(cli
->fd
, options
);
351 /****************************************************************************
352 Set the PID to use for smb messages. Return the old pid.
353 ****************************************************************************/
355 uint16
cli_setpid(struct cli_state
*cli
, uint16 pid
)
357 uint16 ret
= cli
->pid
;
362 /****************************************************************************
363 Send a keepalive packet to the server
364 ****************************************************************************/
365 BOOL
cli_send_keepalive(struct cli_state
*cli
)
368 DEBUG(3, ("cli_send_keepalive: fd == -1\n"));
371 if (!send_keepalive(cli
->fd
)) {
374 DEBUG(0,("Error sending keepalive packet to client.\n"));