xref: /illumos-gate/usr/src/uts/common/fs/smbsrv/smb_nt_create_andx.c (revision 257873cfc1dd3337766407f80397db60a56f2f5a)
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 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 /*
27  * This command is used to create or open a file or directory.
28  */
29 
30 
31 #include <smbsrv/smb_incl.h>
32 #include <smbsrv/smb_fsops.h>
33 #include <smbsrv/smb_vops.h>
34 
35 /*
36  * smb_com_nt_create_andx
37  *
38  * This command is used to create or open a file or directory.
39  *
40  *  Client Request                     Description
41  *  =================================  ==================================
42  *
43  *  UCHAR WordCount;                   Count of parameter words = 24
44  *  UCHAR AndXCommand;                 Secondary command;  0xFF = None
45  *  UCHAR AndXReserved;                Reserved (must be 0)
46  *  USHORT AndXOffset;                 Offset to next command WordCount
47  *  UCHAR Reserved;                    Reserved (must be 0)
48  *  USHORT NameLength;                 Length of Name[] in bytes
49  *  ULONG Flags;                       Create bit set:
50  *                                     0x02 - Request an oplock
51  *                                     0x04 - Request a batch oplock
52  *                                     0x08 - Target of open must be
53  *                                     directory
54  *  ULONG RootDirectoryFid;            If non-zero, open is relative to
55  *                                     this directory
56  *  ACCESS_MASK DesiredAccess;         access desired
57  *  LARGE_INTEGER AllocationSize;      Initial allocation size
58  *  ULONG ExtFileAttributes;           File attributes
59  *  ULONG ShareAccess;                 Type of share access
60  *  ULONG CreateDisposition;           Action to take if file exists or
61  *                                     not
62  *  ULONG CreateOptions;               Options to use if creating a file
63  *  ULONG ImpersonationLevel;          Security QOS information
64  *  UCHAR SecurityFlags;               Security tracking mode flags:
65  *                                     0x1 - SECURITY_CONTEXT_TRACKING
66  *                                     0x2 - SECURITY_EFFECTIVE_ONLY
67  *  USHORT ByteCount;                  Length of byte parameters
68  *  STRING Name[];                     File to open or create
69  *
70  * The DesiredAccess parameter is specified in section 3.7 on  Access Mask
71  * Encoding.
72  *
73  * If no value is specified, it still allows an application to query
74  * attributes without actually accessing the file.
75  *
76  * The ExtFIleAttributes parameter specifies the file attributes and flags
77  * for the file. The parameter's value is the sum of allowed attributes and
78  * flags defined in section 3.11 on  Extended File Attribute Encoding
79  *
80  * The ShareAccess field Specifies how this file can be shared. This
81  * parameter must be some combination of the following values:
82  *
83  * Name              Value      Meaning
84  *                   0          Prevents the file from being shared.
85  * FILE_SHARE_READ   0x00000001 Other open operations can be performed on
86  *                               the file for read access.
87  * FILE_SHARE_WRITE  0x00000002 Other open operations can be performed on
88  *                               the file for write access.
89  * FILE_SHARE_DELETE 0x00000004 Other open operations can be performed on
90  *                               the file for delete access.
91  *
92  * The CreateDisposition parameter can contain one of the following values:
93  *
94  * CREATE_NEW        Creates a new file. The function fails if the
95  *                   specified file already exists.
96  * CREATE_ALWAYS     Creates a new file. The function overwrites the file
97  *                   if it exists.
98  * OPEN_EXISTING     Opens the file. The function fails if the file does
99  *                   not exist.
100  * OPEN_ALWAYS       Opens the file, if it exists. If the file does not
101  *                   exist, act like CREATE_NEW.
102  * TRUNCATE_EXISTING Opens the file. Once opened, the file is truncated so
103  *                   that its size is zero bytes. The calling process must
104  *                   open the file with at least GENERIC_WRITE access. The
105  *                   function fails if the file does not exist.
106  *
107  * The ImpersonationLevel parameter can contain one or more of the
108  * following values:
109  *
110  * SECURITY_ANONYMOUS        Specifies to impersonate the client at the
111  *                           Anonymous impersonation level.
112  * SECURITY_IDENTIFICATION   Specifies to impersonate the client at the
113  *                           Identification impersonation level.
114  * SECURITY_IMPERSONATION    Specifies to impersonate the client at the
115  *                           Impersonation impersonation level.
116  * SECURITY_DELEGATION       Specifies to impersonate the client at the
117  *                           Delegation impersonation level.
118  *
119  * The SecurityFlags parameter can have either of the following two flags
120  * set:
121  *
122  * SECURITY_CONTEXT_TRACKING  Specifies that the security tracking mode is
123  *                            dynamic. If this flag is not specified,
124  *                            Security Tracking Mode is static.
125  * SECURITY_EFFECTIVE_ONLY    Specifies that only the enabled aspects of
126  *                            the client's security context are available
127  *                            to the server. If you do not specify this
128  *                            flag, all aspects of the client's security
129  *                            context are available. This flag allows the
130  *                            client to limit the groups and privileges
131  *                            that a server can use while impersonating the
132  *                            client.
133  *
134  * The response is as follows:
135  *
136  *  Server Response                    Description
137  *  =================================  ==================================
138  *
139  *  UCHAR WordCount;                   Count of parameter words = 26
140  *  UCHAR AndXCommand;  Secondary      0xFF = None
141  *  command;
142  *  UCHAR AndXReserved;                MBZ
143  *  USHORT AndXOffset;                 Offset to next command WordCount
144  *  UCHAR OplockLevel;                 The oplock level granted
145  *                                     0 - No oplock granted
146  *                                     1 - Exclusive oplock granted
147  *                                     2 - Batch oplock granted
148  *                                     3 - Level II oplock granted
149  *  USHORT Fid;                        The file ID
150  *  ULONG CreateAction;                The action taken
151  *  TIME CreationTime;                 The time the file was created
152  *  TIME LastAccessTime;               The time the file was accessed
153  *  TIME LastWriteTime;                The time the file was last written
154  *  TIME ChangeTime;                   The time the file was last changed
155  *  ULONG ExtFileAttributes;           The file attributes
156  *  LARGE_INTEGER AllocationSize;      The number of bytes allocated
157  *  LARGE_INTEGER EndOfFile;           The end of file offset
158  *  USHORT FileType;
159  *  USHORT DeviceState;                state of IPC device (e.g. pipe)
160  *  BOOLEAN Directory;                 TRUE if this is a directory
161  *  USHORT ByteCount;                  = 0
162  *
163  * The following SMBs may follow SMB_COM_NT_CREATE_ANDX:
164  *
165  *    SMB_COM_READ    SMB_COM_READ_ANDX
166  *    SMB_COM_IOCTL
167  */
168 smb_sdrc_t
169 smb_pre_nt_create_andx(smb_request_t *sr)
170 {
171 	struct open_param *op = &sr->arg.open;
172 	uint8_t SecurityFlags;
173 	uint32_t Flags;
174 	uint32_t ImpersonationLevel;
175 	uint16_t NameLength;
176 	int rc;
177 
178 	bzero(op, sizeof (sr->arg.open));
179 
180 	rc = smbsr_decode_vwv(sr, "5.wlllqlllllb",
181 	    &NameLength,
182 	    &Flags,
183 	    &op->rootdirfid,
184 	    &op->desired_access,
185 	    &op->dsize,
186 	    &op->dattr,
187 	    &op->share_access,
188 	    &op->create_disposition,
189 	    &op->create_options,
190 	    &ImpersonationLevel,
191 	    &SecurityFlags);
192 
193 	if (rc == 0) {
194 		if (NameLength == 0) {
195 			op->fqi.path = "\\";
196 		} else if (NameLength >= MAXPATHLEN) {
197 			smbsr_error(sr, NT_STATUS_OBJECT_PATH_NOT_FOUND,
198 			    ERRDOS, ERROR_PATH_NOT_FOUND);
199 			rc = -1;
200 		} else {
201 			rc = smbsr_decode_data(sr, "%#u", sr, NameLength,
202 			    &op->fqi.path);
203 		}
204 	}
205 
206 	if (Flags) {
207 		if (Flags & NT_CREATE_FLAG_REQUEST_OPLOCK) {
208 			if (Flags & NT_CREATE_FLAG_REQUEST_OPBATCH) {
209 				op->my_flags = MYF_BATCH_OPLOCK;
210 			} else {
211 				op->my_flags = MYF_EXCLUSIVE_OPLOCK;
212 			}
213 		}
214 
215 		if (Flags & NT_CREATE_FLAG_OPEN_TARGET_DIR)
216 			op->my_flags |= MYF_MUST_BE_DIRECTORY;
217 	}
218 
219 	DTRACE_SMB_2(op__NtCreateX__start, smb_request_t *, sr,
220 	    struct open_param *, op);
221 
222 	return ((rc == 0) ? SDRC_SUCCESS : SDRC_ERROR);
223 }
224 
225 void
226 smb_post_nt_create_andx(smb_request_t *sr)
227 {
228 	DTRACE_SMB_1(op__NtCreateX__done, smb_request_t *, sr);
229 }
230 
231 smb_sdrc_t
232 smb_com_nt_create_andx(struct smb_request *sr)
233 {
234 	struct open_param	*op = &sr->arg.open;
235 	unsigned char		OplockLevel;
236 	unsigned char		DirFlag;
237 	smb_attr_t		new_attr;
238 	smb_node_t		*node;
239 	int rc;
240 
241 	if ((op->create_options & FILE_DELETE_ON_CLOSE) &&
242 	    !(op->desired_access & DELETE)) {
243 		smbsr_error(sr, NT_STATUS_INVALID_PARAMETER, 0, 0);
244 		return (SDRC_ERROR);
245 	}
246 
247 	if (op->dattr & FILE_FLAG_WRITE_THROUGH)
248 		op->create_options |= FILE_WRITE_THROUGH;
249 
250 	if (op->dattr & FILE_FLAG_DELETE_ON_CLOSE)
251 		op->create_options |= FILE_DELETE_ON_CLOSE;
252 
253 	if (op->dattr & FILE_FLAG_BACKUP_SEMANTICS)
254 		op->create_options |= FILE_OPEN_FOR_BACKUP_INTENT;
255 
256 	if (op->create_options & FILE_OPEN_FOR_BACKUP_INTENT)
257 		sr->user_cr = smb_user_getprivcred(sr->uid_user);
258 
259 	if (op->rootdirfid == 0) {
260 		op->fqi.dir_snode = sr->tid_tree->t_snode;
261 	} else {
262 		sr->smb_fid = (ushort_t)op->rootdirfid;
263 		sr->fid_ofile = smb_ofile_lookup_by_fid(sr->tid_tree,
264 		    sr->smb_fid);
265 		if (sr->fid_ofile == NULL) {
266 			smbsr_error(sr, NT_STATUS_INVALID_HANDLE,
267 			    ERRDOS, ERRbadfid);
268 			return (SDRC_ERROR);
269 		}
270 
271 		op->fqi.dir_snode = sr->fid_ofile->f_node;
272 		smbsr_disconnect_file(sr);
273 	}
274 
275 	if (smb_common_open(sr) != NT_STATUS_SUCCESS)
276 		return (SDRC_ERROR);
277 
278 	if (STYPE_ISDSK(sr->tid_tree->t_res_type)) {
279 		switch (MYF_OPLOCK_TYPE(op->my_flags)) {
280 		case MYF_EXCLUSIVE_OPLOCK :
281 			OplockLevel = 1;
282 			break;
283 		case MYF_BATCH_OPLOCK :
284 			OplockLevel = 2;
285 			break;
286 		case MYF_LEVEL_II_OPLOCK :
287 			OplockLevel = 3;
288 			break;
289 		case MYF_OPLOCK_NONE :
290 		default:
291 			OplockLevel = 0;
292 			break;
293 		}
294 
295 		if (op->create_options & FILE_DELETE_ON_CLOSE)
296 			smb_preset_delete_on_close(sr->fid_ofile);
297 
298 		/*
299 		 * Set up the directory flag and ensure that
300 		 * we don't return a stale file size.
301 		 */
302 		node = sr->fid_ofile->f_node;
303 		if (node->attr.sa_vattr.va_type == VDIR) {
304 			DirFlag = 1;
305 			new_attr.sa_vattr.va_size = 0;
306 		} else {
307 			DirFlag = 0;
308 			new_attr.sa_mask = SMB_AT_SIZE;
309 			(void) smb_fsop_getattr(sr, kcred, node, &new_attr);
310 			node->attr.sa_vattr.va_size = new_attr.sa_vattr.va_size;
311 		}
312 
313 		rc = smbsr_encode_result(sr, 34, 0, "bb.wbwlTTTTlqqwwbw",
314 		    34,
315 		    sr->andx_com,
316 		    0x67,
317 		    OplockLevel,
318 		    sr->smb_fid,
319 		    op->action_taken,
320 		    &node->attr.sa_crtime,
321 		    &node->attr.sa_vattr.va_atime,
322 		    &node->attr.sa_vattr.va_mtime,
323 		    &node->attr.sa_vattr.va_ctime,
324 		    op->dattr & FILE_ATTRIBUTE_MASK,
325 		    new_attr.sa_vattr.va_size,
326 		    new_attr.sa_vattr.va_size,
327 		    op->ftype,
328 		    op->devstate,
329 		    DirFlag,
330 		    0);
331 	} else {
332 		/* Named PIPE */
333 		OplockLevel = 0;
334 		rc = smbsr_encode_result(sr, 34, 0, "bb.wbwlqqqqlqqwwbw",
335 		    34,
336 		    sr->andx_com,
337 		    0x67,
338 		    OplockLevel,
339 		    sr->smb_fid,
340 		    op->action_taken,
341 		    0LL,
342 		    0LL,
343 		    0LL,
344 		    0LL,
345 		    FILE_ATTRIBUTE_NORMAL,
346 		    0x1000LL,
347 		    0LL,
348 		    op->ftype,
349 		    op->devstate,
350 		    0,
351 		    0);
352 	}
353 
354 	return ((rc == 0) ? SDRC_SUCCESS : SDRC_ERROR);
355 }
356