xref: /titanic_50/usr/src/uts/common/fs/smbsrv/smb_negotiate.c (revision 380bdfdf3b87cbfda20ccdf5d4fa7c129623622b)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright 2012 Nexenta Systems, Inc.  All rights reserved.
24  */
25 
26 /*
27  * Notes on the virtual circuit (VC) values in the SMB Negotiate
28  * response and SessionSetupAndx request.
29  *
30  * A virtual circuit (VC) represents a connection between a client and a
31  * server using a reliable, session oriented transport protocol, such as
32  * NetBIOS or TCP/IP. Originally, each SMB session was restricted to a
33  * single underlying transport connection, i.e. a single NetBIOS session,
34  * which limited performance for raw data transfers.
35  *
36  * The intention behind multiple VCs was to improve performance by
37  * allowing parallelism over each NetBIOS session. For example, raw data
38  * could be transmitted using a different VC from other types of SMB
39  * requests to remove the interleaving restriction while a raw transfer
40  * is in progress. So the MaxNumberVcs field was added to the negotiate
41  * response to make the number of VCs configurable and to allow servers
42  * to specify how many they were prepared to support per session
43  * connection. This turned out to be difficult to manage and, with
44  * technology improvements, it has become obsolete.
45  *
46  * Servers should set the MaxNumberVcs value in the Negotiate response
47  * to 1. Clients should probably ignore it. If a server receives a
48  * SessionSetupAndx with a VC value of 0, it should close all other
49  * VCs to that client. If it receives a non-zero VC, it should leave
50  * other VCs in tact.
51  *
52  */
53 
54 /*
55  * SMB: negotiate
56  *
57  * Client Request                Description
58  * ============================  =======================================
59  *
60  * UCHAR WordCount;              Count of parameter words = 0
61  * USHORT ByteCount;             Count of data bytes; min = 2
62  * struct {
63  *    UCHAR BufferFormat;        0x02 -- Dialect
64  *    UCHAR DialectName[];       ASCII null-terminated string
65  * } Dialects[];
66  *
67  * The Client sends a list of dialects that it can communicate with.  The
68  * response is a selection of one of those dialects (numbered 0 through n)
69  * or -1 (hex FFFF) indicating that none of the dialects were acceptable.
70  * The negotiate message is binding on the virtual circuit and must be
71  * sent.  One and only one negotiate message may be sent, subsequent
72  * negotiate requests will be rejected with an error response and no action
73  * will be taken.
74  *
75  * The protocol does not impose any particular structure to the dialect
76  * strings.  Implementors of particular protocols may choose to include,
77  * for example, version numbers in the string.
78  *
79  * If the server does not understand any of the dialect strings, or if PC
80  * NETWORK PROGRAM 1.0 is the chosen dialect, the response format is
81  *
82  * Server Response               Description
83  * ============================  =======================================
84  *
85  * UCHAR WordCount;              Count of parameter words = 1
86  * USHORT DialectIndex;          Index of selected dialect
87  * USHORT ByteCount;             Count of data bytes = 0
88  *
89  * If the chosen dialect is greater than core up to and including
90  * LANMAN2.1, the protocol response format is
91  *
92  * Server Response               Description
93  * ============================  =======================================
94  *
95  * UCHAR WordCount;              Count of parameter words = 13
96  * USHORT  DialectIndex;         Index of selected dialect
97  * USHORT  SecurityMode;         Security mode:
98  *                               bit 0: 0 = share, 1 = user
99  *                               bit 1: 1 = use challenge/response
100  *                               authentication
101  * USHORT  MaxBufferSize;        Max transmit buffer size (>= 1024)
102  * USHORT  MaxMpxCount;          Max pending multiplexed requests
103  * USHORT  MaxNumberVcs;         Max VCs between client and server
104  * USHORT  RawMode;              Raw modes supported:
105  *                                bit 0: 1 = Read Raw supported
106  *                                bit 1: 1 = Write Raw supported
107  * ULONG SessionKey;             Unique token identifying this session
108  * SMB_TIME ServerTime;          Current time at server
109  * SMB_DATE ServerDate;          Current date at server
110  * USHORT ServerTimeZone;        Current time zone at server
111  * USHORT  EncryptionKeyLength;  MBZ if this is not LM2.1
112  * USHORT  Reserved;             MBZ
113  * USHORT  ByteCount             Count of data bytes
114  * UCHAR EncryptionKey[];        The challenge encryption key
115  * STRING PrimaryDomain[];       The server's primary domain
116  *
117  * MaxBufferSize is the size of the largest message which the client can
118  * legitimately send to the server
119  *
120  * If  bit0 of the Flags field is set in the negotiate response, this
121  * indicates the server supports the SMB_COM_LOCK_AND_READ and
122  * SMB_COM_WRITE_AND_UNLOCK client requests.
123  *
124  * If the SecurityMode field indicates the server is running in user mode,
125  * the client must send appropriate SMB_COM_SESSION_SETUP_ANDX requests
126  * before the server will allow the client to access resources.   If the
127  * SecurityMode fields indicates the client should use challenge/response
128  * authentication, the client should use the authentication mechanism
129  * specified in section 2.10.
130  *
131  * Clients should submit no more than MaxMpxCount distinct unanswered SMBs
132  * to the server when using multiplexed reads or writes (see sections 5.13
133  * and 5.25)
134  *
135  * Clients using the  "MICROSOFT NETWORKS 1.03" dialect use a different
136  * form of raw reads than documented here, and servers are better off
137  * setting RawMode in this response to 0 for such sessions.
138  *
139  * If the negotiated dialect is "DOS LANMAN2.1" or "LANMAN2.1", then
140  * PrimaryDomain string should be included in this response.
141  *
142  * If the negotiated dialect is NT LM 0.12, the response format is
143  *
144  * Server Response            Description
145  * ========================== =========================================
146  *
147  * UCHAR WordCount;           Count of parameter words = 17
148  * USHORT DialectIndex;       Index of selected dialect
149  * UCHAR SecurityMode;        Security mode:
150  *                             bit 0: 0 = share, 1 = user
151  *                             bit 1: 1 = encrypt passwords
152  * USHORT MaxMpxCount;        Max pending multiplexed requests
153  * USHORT MaxNumberVcs;       Max VCs between client and server
154  * ULONG MaxBufferSize;       Max transmit buffer size
155  * ULONG MaxRawSize;          Maximum raw buffer size
156  * ULONG SessionKey;          Unique token identifying this session
157  * ULONG Capabilities;        Server capabilities
158  * ULONG SystemTimeLow;       System (UTC) time of the server (low).
159  * ULONG SystemTimeHigh;      System (UTC) time of the server (high).
160  * USHORT ServerTimeZone;     Time zone of server (min from UTC)
161  * UCHAR EncryptionKeyLength; Length of encryption key.
162  * USHORT ByteCount;          Count of data bytes
163  * UCHAR EncryptionKey[];     The challenge encryption key
164  * UCHAR OemDomainName[];     The name of the domain (in OEM chars)
165  *
166  * In addition to the definitions above, MaxBufferSize is the size of the
167  * largest message which the client can legitimately send to the server.
168  * If the client is using a connectionless protocol,  MaxBufferSize must be
169  * set to the smaller of the server's internal buffer size and the amount
170  * of data which can be placed in a response packet.
171  *
172  * MaxRawSize specifies the maximum message size the server can send or
173  * receive for SMB_COM_WRITE_RAW or SMB_COM_READ_RAW.
174  *
175  * Connectionless clients must set Sid to 0 in the SMB request header.
176  *
177  * Capabilities allows the server to tell the client what it supports.
178  * The bit definitions defined in smb.h. Bit 0x2000 used to be set in
179  * the negotiate response capabilities but it caused problems with
180  * Windows 2000. It is probably not valid, it doesn't appear in the
181  * CIFS spec.
182  *
183  * 4.1.1.1   Errors
184  *
185  * SUCCESS/SUCCESS
186  * ERRSRV/ERRerror
187  */
188 #include <sys/types.h>
189 #include <sys/strsubr.h>
190 #include <sys/socketvar.h>
191 #include <sys/socket.h>
192 #include <netinet/in.h>
193 #include <smbsrv/smb_kproto.h>
194 #include <smbsrv/smbinfo.h>
195 
196 static const smb_xlate_t smb_dialect[] = {
197 	{ DIALECT_UNKNOWN,		"DIALECT_UNKNOWN" },
198 	{ PC_NETWORK_PROGRAM_1_0,	"PC NETWORK PROGRAM 1.0" },
199 	{ PCLAN1_0,			"PCLAN1.0" },
200 	{ MICROSOFT_NETWORKS_1_03,	"MICROSOFT NETWORKS 1.03" },
201 	{ MICROSOFT_NETWORKS_3_0,	"MICROSOFT NETWORKS 3.0" },
202 	{ LANMAN1_0,			"LANMAN1.0" },
203 	{ LM1_2X002,			"LM1.2X002" },
204 	{ DOS_LM1_2X002,		"DOS LM1.2X002" },
205 	{ DOS_LANMAN2_1,		"DOS LANMAN2.1" },
206 	{ LANMAN2_1,			"LANMAN2.1" },
207 	{ Windows_for_Workgroups_3_1a,	"Windows for Workgroups 3.1a" },
208 	{ NT_LM_0_12,			"NT LM 0.12" }
209 };
210 
211 /*
212  * Maximum buffer size for DOS: chosen to be the same as NT.
213  * Do not change this value, DOS is very sensitive to it.
214  */
215 #define	SMB_DOS_MAXBUF			0x1104
216 
217 /*
218  * The DOS TCP rcvbuf is set to 8700 because DOS 6.1 seems to have problems
219  * with other values. DOS 6.1 seems to depend on a window value of 8700 to
220  * send the next set of data. If we return a window value of 40KB, after
221  * sending 8700 bytes of data, it will start the next set of data from 40KB
222  * instead of 8.7k. Why 8.7k? We have no idea; it is the value that NT uses.
223  * September 2000.
224  *
225  * IR104720 Increased smb_nt_tcp_rcvbuf from 40KB to just under 1MB to allow
226  * for a larger TCP window sizei based on observations of Windows 2000 and
227  * performance testing. March 2003.
228  */
229 static uint32_t	smb_dos_tcp_rcvbuf = 8700;
230 static uint32_t	smb_nt_tcp_rcvbuf = 1048560;	/* scale factor of 4 */
231 
232 static int smb_xlate_dialect(const char *);
233 
234 int smb_cap_passthru = 1;
235 
236 smb_sdrc_t
237 smb_pre_negotiate(smb_request_t *sr)
238 {
239 	smb_arg_negotiate_t	*negprot;
240 	int			dialect;
241 	int			pos;
242 	int			rc = 0;
243 
244 	negprot = smb_srm_zalloc(sr, sizeof (smb_arg_negotiate_t));
245 	negprot->ni_index = -1;
246 	sr->sr_negprot = negprot;
247 
248 	for (pos = 0; smbsr_decode_data_avail(sr); pos++) {
249 		if (smbsr_decode_data(sr, "%L", sr, &negprot->ni_name) != 0) {
250 			smbsr_error(sr, 0, ERRSRV, ERRerror);
251 			rc = -1;
252 			break;
253 		}
254 
255 		if ((dialect = smb_xlate_dialect(negprot->ni_name)) < 0)
256 			continue;
257 
258 		if (negprot->ni_dialect < dialect) {
259 			negprot->ni_dialect = dialect;
260 			negprot->ni_index = pos;
261 		}
262 	}
263 
264 	DTRACE_SMB_2(op__Negotiate__start, smb_request_t *, sr,
265 	    smb_arg_negotiate_t, negprot);
266 	smb_rwx_rwenter(&sr->session->s_lock, RW_WRITER);
267 	return ((rc == 0) ? SDRC_SUCCESS : SDRC_ERROR);
268 }
269 
270 void
271 smb_post_negotiate(smb_request_t *sr)
272 {
273 	smb_arg_negotiate_t	*negprot = sr->sr_negprot;
274 
275 	DTRACE_SMB_2(op__Negotiate__done, smb_request_t *, sr,
276 	    smb_arg_negotiate_t, negprot);
277 	smb_rwx_rwexit(&sr->session->s_lock);
278 
279 	bzero(negprot, sizeof (smb_arg_negotiate_t));
280 }
281 
282 smb_sdrc_t
283 smb_com_negotiate(smb_request_t *sr)
284 {
285 	smb_arg_negotiate_t	*negprot = sr->sr_negprot;
286 	uint16_t		secmode;
287 	uint16_t		rawmode = 0;
288 	uint32_t		sesskey;
289 	char			ipaddr_buf[INET6_ADDRSTRLEN];
290 	char			*nbdomain;
291 	uint8_t			*wcbuf;
292 	int			wclen;
293 	smb_msgbuf_t		mb;
294 	int			rc;
295 
296 	if (sr->session->s_state != SMB_SESSION_STATE_ESTABLISHED) {
297 		/* The protocol has already been negotiated. */
298 		smbsr_error(sr, 0, ERRSRV, ERRerror);
299 		return (SDRC_ERROR);
300 	}
301 
302 	sr->session->secmode = NEGOTIATE_SECURITY_CHALLENGE_RESPONSE |
303 	    NEGOTIATE_SECURITY_USER_LEVEL;
304 	secmode = sr->session->secmode;
305 	sesskey = sr->session->sesskey;
306 
307 	(void) microtime(&negprot->ni_servertime);
308 	negprot->ni_tzcorrection = sr->sr_gmtoff / 60;
309 	negprot->ni_maxmpxcount = sr->sr_cfg->skc_maxworkers;
310 	negprot->ni_keylen = SMB_CHALLENGE_SZ;
311 	bcopy(&sr->session->challenge_key, negprot->ni_key, SMB_CHALLENGE_SZ);
312 	nbdomain = sr->sr_cfg->skc_nbdomain;
313 
314 	/*
315 	 * UNICODE support is required for long share names,
316 	 * long file names and streams.  Note: CAP_RAW_MODE
317 	 * is not supported because it does nothing to help
318 	 * modern clients and causes nasty complications.
319 	 */
320 	negprot->ni_capabilities = CAP_LARGE_FILES
321 	    | CAP_UNICODE
322 	    | CAP_NT_SMBS
323 	    | CAP_STATUS32
324 	    | CAP_NT_FIND
325 	    | CAP_LEVEL_II_OPLOCKS
326 	    | CAP_LOCK_AND_READ
327 	    | CAP_RPC_REMOTE_APIS
328 	    | CAP_LARGE_READX
329 	    | CAP_LARGE_WRITEX
330 	    | CAP_DFS;
331 
332 	if (smb_cap_passthru)
333 		negprot->ni_capabilities |= CAP_INFOLEVEL_PASSTHRU;
334 	else
335 		cmn_err(CE_NOTE, "smbsrv: cap passthru is %s",
336 		    (negprot->ni_capabilities & CAP_INFOLEVEL_PASSTHRU) ?
337 		    "enabled" : "disabled");
338 
339 	(void) smb_inet_ntop(&sr->session->ipaddr, ipaddr_buf,
340 	    SMB_IPSTRLEN(sr->session->ipaddr.a_family));
341 
342 	switch (negprot->ni_dialect) {
343 	case PC_NETWORK_PROGRAM_1_0:	/* core */
344 		(void) ksocket_setsockopt(sr->session->sock, SOL_SOCKET,
345 		    SO_RCVBUF, (const void *)&smb_dos_tcp_rcvbuf,
346 		    sizeof (smb_dos_tcp_rcvbuf), CRED());
347 		rc = smbsr_encode_result(sr, 1, 0, "bww", 1,
348 		    negprot->ni_index, 0);
349 		break;
350 
351 	case Windows_for_Workgroups_3_1a:
352 	case PCLAN1_0:
353 	case MICROSOFT_NETWORKS_1_03:
354 	case MICROSOFT_NETWORKS_3_0:
355 	case LANMAN1_0:
356 	case LM1_2X002:
357 	case DOS_LM1_2X002:
358 		(void) ksocket_setsockopt(sr->session->sock, SOL_SOCKET,
359 		    SO_RCVBUF, (const void *)&smb_dos_tcp_rcvbuf,
360 		    sizeof (smb_dos_tcp_rcvbuf), CRED());
361 		sr->smb_flg |= SMB_FLAGS_LOCK_AND_READ_OK;
362 		rc = smbsr_encode_result(sr, 13, VAR_BCC,
363 		    "bwwwwwwlYww2.w#c",
364 		    13,				/* wct */
365 		    negprot->ni_index,		/* dialect index */
366 		    secmode,			/* security mode */
367 		    SMB_DOS_MAXBUF,		/* max buffer size */
368 		    1,				/* max MPX */
369 		    1,				/* max VCs */
370 		    rawmode,			/* read/write raw (s/b 3) */
371 		    sesskey,			/* session key */
372 		    negprot->ni_servertime.tv_sec, /* server date/time */
373 		    negprot->ni_tzcorrection,
374 		    (uint16_t)negprot->ni_keylen, /* encryption key length */
375 						/* reserved field handled 2. */
376 		    VAR_BCC,
377 		    (int)negprot->ni_keylen,
378 		    negprot->ni_key);		/* encryption key */
379 		break;
380 
381 	case DOS_LANMAN2_1:
382 	case LANMAN2_1:
383 		(void) ksocket_setsockopt(sr->session->sock, SOL_SOCKET,
384 		    SO_RCVBUF, (const void *)&smb_dos_tcp_rcvbuf,
385 		    sizeof (smb_dos_tcp_rcvbuf), CRED());
386 		sr->smb_flg |= SMB_FLAGS_LOCK_AND_READ_OK;
387 		rc = smbsr_encode_result(sr, 13, VAR_BCC,
388 		    "bwwwwwwlYww2.w#cs",
389 		    13,				/* wct */
390 		    negprot->ni_index,		/* dialect index */
391 		    secmode,			/* security mode */
392 		    SMB_DOS_MAXBUF,		/* max buffer size */
393 		    1,				/* max MPX */
394 		    1,				/* max VCs */
395 		    rawmode,			/* read/write raw (s/b 3) */
396 		    sesskey,			/* session key */
397 		    negprot->ni_servertime.tv_sec, /* server date/time */
398 		    negprot->ni_tzcorrection,
399 		    (uint16_t)negprot->ni_keylen, /* encryption key length */
400 						/* reserved field handled 2. */
401 		    VAR_BCC,
402 		    (int)negprot->ni_keylen,
403 		    negprot->ni_key,		/* encryption key */
404 		    nbdomain);
405 		break;
406 
407 	case NT_LM_0_12:
408 		(void) ksocket_setsockopt(sr->session->sock, SOL_SOCKET,
409 		    SO_RCVBUF, (const void *)&smb_nt_tcp_rcvbuf,
410 		    sizeof (smb_nt_tcp_rcvbuf), CRED());
411 
412 		/*
413 		 * Turn off Extended Security Negotiation
414 		 */
415 		sr->smb_flg2 &= ~SMB_FLAGS2_EXT_SEC;
416 
417 		/*
418 		 * Allow SMB signatures if security challenge response enabled
419 		 */
420 		if ((secmode & NEGOTIATE_SECURITY_CHALLENGE_RESPONSE) &&
421 		    sr->sr_cfg->skc_signing_enable) {
422 			secmode |= NEGOTIATE_SECURITY_SIGNATURES_ENABLED;
423 			if (sr->sr_cfg->skc_signing_required)
424 				secmode |=
425 				    NEGOTIATE_SECURITY_SIGNATURES_REQUIRED;
426 
427 			sr->session->secmode = secmode;
428 		}
429 
430 		/*
431 		 * nbdomain is not expected to be aligned.
432 		 * Use temporary buffer to avoid alignment padding
433 		 */
434 		wclen = smb_wcequiv_strlen(nbdomain) + sizeof (smb_wchar_t);
435 		wcbuf = smb_srm_zalloc(sr, wclen);
436 		smb_msgbuf_init(&mb, wcbuf, wclen, SMB_MSGBUF_UNICODE);
437 		if (smb_msgbuf_encode(&mb, "U", nbdomain) < 0) {
438 			smb_msgbuf_term(&mb);
439 			smbsr_error(sr, 0, ERRSRV, ERRerror);
440 			return (SDRC_ERROR);
441 		}
442 
443 		rc = smbsr_encode_result(sr, 17, VAR_BCC,
444 		    "bwbwwllllTwbw#c#c",
445 		    17,				/* wct */
446 		    negprot->ni_index,		/* dialect index */
447 		    secmode,			/* security mode */
448 		    negprot->ni_maxmpxcount,	/* max MPX */
449 		    1,				/* max VCs */
450 		    (DWORD)smb_maxbufsize,	/* max buffer size */
451 		    0xFFFF,			/* max raw size */
452 		    sesskey,			/* session key */
453 		    negprot->ni_capabilities,
454 		    &negprot->ni_servertime,	/* system time */
455 		    negprot->ni_tzcorrection,
456 		    negprot->ni_keylen,		/* encryption key length */
457 		    VAR_BCC,
458 		    (int)negprot->ni_keylen,
459 		    negprot->ni_key,		/* encryption key */
460 		    wclen,
461 		    wcbuf);			/* nbdomain (unicode) */
462 
463 		smb_msgbuf_term(&mb);
464 		break;
465 
466 	default:
467 		rc = smbsr_encode_result(sr, 1, 0, "bww", 1, -1, 0);
468 		return ((rc == 0) ? SDRC_SUCCESS : SDRC_ERROR);
469 	}
470 
471 	if (rc != 0)
472 		return (SDRC_ERROR);
473 
474 	/*
475 	 * Save the agreed dialect. Note that this value is also
476 	 * used to detect and reject attempts to re-negotiate.
477 	 */
478 	sr->session->dialect = negprot->ni_dialect;
479 	sr->session->s_state = SMB_SESSION_STATE_NEGOTIATED;
480 	return (SDRC_SUCCESS);
481 }
482 
483 static int
484 smb_xlate_dialect(const char *dialect)
485 {
486 	const smb_xlate_t *dp;
487 	int		i;
488 
489 	for (i = 0; i < sizeof (smb_dialect) / sizeof (smb_dialect[0]); ++i) {
490 		dp = &smb_dialect[i];
491 
492 		if (strcmp(dp->str, dialect) == 0)
493 			return (dp->code);
494 	}
495 
496 	return (-1);
497 }
498