2 * Store Windows ACLs in data store - common functions.
3 * #included into modules/vfs_acl_xattr.c and modules/vfs_acl_tdb.c
5 * Copyright (C) Volker Lendecke, 2008
6 * Copyright (C) Jeremy Allison, 2009
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, see <http://www.gnu.org/licenses/>.
22 static NTSTATUS create_acl_blob(const struct security_descriptor *psd,
25 uint8_t hash[XATTR_SD_HASH_SIZE]);
27 static NTSTATUS get_acl_blob(TALLOC_CTX *ctx,
28 vfs_handle_struct *handle,
33 static NTSTATUS store_acl_blob_fsp(vfs_handle_struct *handle,
37 static NTSTATUS store_acl_blob_pathname(vfs_handle_struct *handle,
41 #define HASH_SECURITY_INFO (OWNER_SECURITY_INFORMATION | \
42 GROUP_SECURITY_INFORMATION | \
43 DACL_SECURITY_INFORMATION | \
44 SACL_SECURITY_INFORMATION)
46 /*******************************************************************
47 Hash a security descriptor.
48 *******************************************************************/
50 static NTSTATUS hash_sd_sha256(struct security_descriptor *psd,
57 memset(hash, '\0', XATTR_SD_HASH_SIZE);
58 status = create_acl_blob(psd, &blob, XATTR_SD_HASH_TYPE_SHA256, hash);
59 if (!NT_STATUS_IS_OK(status)) {
64 SHA256_Update(&tctx, blob.data, blob.length);
65 SHA256_Final(hash, &tctx);
70 /*******************************************************************
71 Parse out a struct security_descriptor from a DATA_BLOB.
72 *******************************************************************/
74 static NTSTATUS parse_acl_blob(const DATA_BLOB *pblob,
75 struct security_descriptor **ppdesc,
76 uint16_t *p_hash_type,
77 uint8_t hash[XATTR_SD_HASH_SIZE])
79 TALLOC_CTX *ctx = talloc_tos();
80 struct xattr_NTACL xacl;
81 enum ndr_err_code ndr_err;
84 ndr_err = ndr_pull_struct_blob(pblob, ctx, NULL, &xacl,
85 (ndr_pull_flags_fn_t)ndr_pull_xattr_NTACL);
87 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
88 DEBUG(5, ("parse_acl_blob: ndr_pull_xattr_NTACL failed: %s\n",
89 ndr_errstr(ndr_err)));
90 return ndr_map_error2ntstatus(ndr_err);;
93 switch (xacl.version) {
95 *ppdesc = make_sec_desc(ctx, SEC_DESC_REVISION,
96 xacl.info.sd_hs2->sd->type | SEC_DESC_SELF_RELATIVE,
97 xacl.info.sd_hs2->sd->owner_sid,
98 xacl.info.sd_hs2->sd->group_sid,
99 xacl.info.sd_hs2->sd->sacl,
100 xacl.info.sd_hs2->sd->dacl,
102 /* No hash - null out. */
103 *p_hash_type = XATTR_SD_HASH_TYPE_NONE;
104 memset(hash, '\0', XATTR_SD_HASH_SIZE);
107 *ppdesc = make_sec_desc(ctx, SEC_DESC_REVISION,
108 xacl.info.sd_hs3->sd->type | SEC_DESC_SELF_RELATIVE,
109 xacl.info.sd_hs3->sd->owner_sid,
110 xacl.info.sd_hs3->sd->group_sid,
111 xacl.info.sd_hs3->sd->sacl,
112 xacl.info.sd_hs3->sd->dacl,
114 *p_hash_type = xacl.info.sd_hs3->hash_type;
115 /* Current version 3. */
116 memcpy(hash, xacl.info.sd_hs3->hash, XATTR_SD_HASH_SIZE);
119 return NT_STATUS_REVISION_MISMATCH;
122 TALLOC_FREE(xacl.info.sd);
124 return (*ppdesc != NULL) ? NT_STATUS_OK : NT_STATUS_NO_MEMORY;
127 /*******************************************************************
128 Create a DATA_BLOB from a security descriptor.
129 *******************************************************************/
131 static NTSTATUS create_acl_blob(const struct security_descriptor *psd,
134 uint8_t hash[XATTR_SD_HASH_SIZE])
136 struct xattr_NTACL xacl;
137 struct security_descriptor_hash_v3 sd_hs3;
138 enum ndr_err_code ndr_err;
139 TALLOC_CTX *ctx = talloc_tos();
145 xacl.info.sd_hs3 = &sd_hs3;
146 xacl.info.sd_hs3->sd = CONST_DISCARD(struct security_descriptor *, psd);
147 xacl.info.sd_hs3->hash_type = hash_type;
148 memcpy(&xacl.info.sd_hs3->hash[0], hash, XATTR_SD_HASH_SIZE);
150 ndr_err = ndr_push_struct_blob(
151 pblob, ctx, NULL, &xacl,
152 (ndr_push_flags_fn_t)ndr_push_xattr_NTACL);
154 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
155 DEBUG(5, ("create_acl_blob: ndr_push_xattr_NTACL failed: %s\n",
156 ndr_errstr(ndr_err)));
157 return ndr_map_error2ntstatus(ndr_err);;
163 /*******************************************************************
164 Store a DATA_BLOB into an xattr given a pathname.
165 *******************************************************************/
167 static NTSTATUS get_nt_acl_internal(vfs_handle_struct *handle,
170 uint32_t security_info,
171 struct security_descriptor **ppdesc)
176 uint8_t hash[XATTR_SD_HASH_SIZE];
177 uint8_t hash_tmp[XATTR_SD_HASH_SIZE];
178 struct security_descriptor *pdesc_next = NULL;
180 if (fsp && name == NULL) {
181 name = fsp->fsp_name->base_name;
184 DEBUG(10, ("get_nt_acl_internal: name=%s\n", name));
186 status = get_acl_blob(talloc_tos(), handle, fsp, name, &blob);
187 if (!NT_STATUS_IS_OK(status)) {
188 DEBUG(10, ("get_acl_blob returned %s\n", nt_errstr(status)));
192 status = parse_acl_blob(&blob, ppdesc,
193 &hash_type, &hash[0]);
194 if (!NT_STATUS_IS_OK(status)) {
195 DEBUG(10, ("parse_acl_blob returned %s\n",
200 /* Ensure the hash type is one we know. */
202 case XATTR_SD_HASH_TYPE_NONE:
203 /* No hash, goto return blob sd. */
205 case XATTR_SD_HASH_TYPE_SHA256:
208 return NT_STATUS_REVISION_MISMATCH;
211 /* Get the full underlying sd, then hash. */
213 status = SMB_VFS_NEXT_FGET_NT_ACL(handle,
218 status = SMB_VFS_NEXT_GET_NT_ACL(handle,
224 if (!NT_STATUS_IS_OK(status)) {
228 status = hash_sd_sha256(pdesc_next, hash_tmp);
229 if (!NT_STATUS_IS_OK(status)) {
233 if (memcmp(&hash[0], &hash_tmp[0], XATTR_SD_HASH_SIZE) == 0) {
234 TALLOC_FREE(pdesc_next);
235 /* Hash matches, return blob sd. */
239 /* Hash doesn't match, return underlying sd. */
241 if (!(security_info & OWNER_SECURITY_INFORMATION)) {
242 pdesc_next->owner_sid = NULL;
244 if (!(security_info & GROUP_SECURITY_INFORMATION)) {
245 pdesc_next->group_sid = NULL;
247 if (!(security_info & DACL_SECURITY_INFORMATION)) {
248 pdesc_next->dacl = NULL;
250 if (!(security_info & SACL_SECURITY_INFORMATION)) {
251 pdesc_next->sacl = NULL;
254 TALLOC_FREE(*ppdesc);
255 *ppdesc = pdesc_next;
259 if (!(security_info & OWNER_SECURITY_INFORMATION)) {
260 (*ppdesc)->owner_sid = NULL;
262 if (!(security_info & GROUP_SECURITY_INFORMATION)) {
263 (*ppdesc)->group_sid = NULL;
265 if (!(security_info & DACL_SECURITY_INFORMATION)) {
266 (*ppdesc)->dacl = NULL;
268 if (!(security_info & SACL_SECURITY_INFORMATION)) {
269 (*ppdesc)->sacl = NULL;
272 TALLOC_FREE(blob.data);
276 /*********************************************************************
277 Create a default security descriptor for a file in case no inheritance
278 exists. All permissions to the owner and SYSTEM.
279 *********************************************************************/
281 static struct security_descriptor *default_file_sd(TALLOC_CTX *mem_ctx,
282 SMB_STRUCT_STAT *psbuf)
284 struct dom_sid owner_sid, group_sid;
286 struct security_ace *pace = NULL;
287 struct security_acl *pacl = NULL;
289 uid_to_sid(&owner_sid, psbuf->st_ex_uid);
290 gid_to_sid(&group_sid, psbuf->st_ex_gid);
292 pace = TALLOC_ARRAY(mem_ctx, struct security_ace, 2);
297 init_sec_ace(&pace[0], &owner_sid, SEC_ACE_TYPE_ACCESS_ALLOWED,
298 SEC_RIGHTS_FILE_ALL, 0);
299 init_sec_ace(&pace[1], &global_sid_System, SEC_ACE_TYPE_ACCESS_ALLOWED,
300 SEC_RIGHTS_FILE_ALL, 0);
302 pacl = make_sec_acl(mem_ctx,
309 return make_sec_desc(mem_ctx,
310 SECURITY_DESCRIPTOR_REVISION_1,
311 SEC_DESC_SELF_RELATIVE|SEC_DESC_DACL_PRESENT,
319 /*********************************************************************
320 *********************************************************************/
322 static NTSTATUS inherit_new_acl(vfs_handle_struct *handle,
323 struct smb_filename *smb_fname,
327 TALLOC_CTX *ctx = talloc_tos();
329 struct security_descriptor *parent_desc = NULL;
330 struct security_descriptor *psd = NULL;
331 struct security_descriptor *pdesc_next = NULL;
335 uint8_t hash[XATTR_SD_HASH_SIZE];
337 if (!parent_dirname(ctx, smb_fname->base_name, &parent_name, NULL)) {
338 return NT_STATUS_NO_MEMORY;
341 DEBUG(10,("inherit_new_acl: check directory %s\n",
344 status = get_nt_acl_internal(handle,
347 (OWNER_SECURITY_INFORMATION |
348 GROUP_SECURITY_INFORMATION |
349 DACL_SECURITY_INFORMATION),
351 if (NT_STATUS_IS_OK(status)) {
352 /* Create an inherited descriptor from the parent. */
354 if (DEBUGLEVEL >= 10) {
355 DEBUG(10,("inherit_new_acl: parent acl is:\n"));
356 NDR_PRINT_DEBUG(security_descriptor, parent_desc);
359 status = se_create_child_secdesc(ctx,
363 &handle->conn->server_info->ptok->user_sids[PRIMARY_USER_SID_INDEX],
364 &handle->conn->server_info->ptok->user_sids[PRIMARY_GROUP_SID_INDEX],
366 if (!NT_STATUS_IS_OK(status)) {
370 if (DEBUGLEVEL >= 10) {
371 DEBUG(10,("inherit_new_acl: child acl is:\n"));
372 NDR_PRINT_DEBUG(security_descriptor, psd);
376 DEBUG(10,("inherit_new_acl: directory %s failed "
379 nt_errstr(status) ));
382 if (!psd || psd->dacl == NULL) {
386 if (fsp && !fsp->is_directory && fsp->fh->fd != -1) {
387 ret = SMB_VFS_FSTAT(fsp, &smb_fname->st);
389 if (fsp && fsp->posix_open) {
390 ret = SMB_VFS_LSTAT(handle->conn, smb_fname);
392 ret = SMB_VFS_STAT(handle->conn, smb_fname);
396 return map_nt_error_from_unix(errno);
398 psd = default_file_sd(ctx, &smb_fname->st);
400 return NT_STATUS_NO_MEMORY;
403 if (DEBUGLEVEL >= 10) {
404 DEBUG(10,("inherit_new_acl: default acl is:\n"));
405 NDR_PRINT_DEBUG(security_descriptor, psd);
409 /* Object exists. Read the current SD to get the hash. */
411 status = SMB_VFS_NEXT_FGET_NT_ACL(handle,
416 status = SMB_VFS_NEXT_GET_NT_ACL(handle,
417 smb_fname->base_name,
422 if (!NT_STATUS_IS_OK(status)) {
426 status = hash_sd_sha256(pdesc_next, hash);
427 if (!NT_STATUS_IS_OK(status)) {
430 status = create_acl_blob(psd, &blob, XATTR_SD_HASH_TYPE_SHA256, hash);
431 if (!NT_STATUS_IS_OK(status)) {
435 return store_acl_blob_fsp(handle, fsp, &blob);
437 return store_acl_blob_pathname(handle, smb_fname->base_name,
442 /*********************************************************************
443 Check ACL on open. For new files inherit from parent directory.
444 *********************************************************************/
446 static int open_acl_common(vfs_handle_struct *handle,
447 struct smb_filename *smb_fname,
452 uint32_t access_granted = 0;
453 struct security_descriptor *pdesc = NULL;
454 bool file_existed = true;
459 /* Stream open. Base filename open already did the ACL check. */
460 DEBUG(10,("open_acl_common: stream open on %s\n",
461 smb_fname_str_dbg(smb_fname) ));
462 return SMB_VFS_NEXT_OPEN(handle, smb_fname, fsp, flags, mode);
465 status = get_full_smb_filename(talloc_tos(), smb_fname,
467 if (!NT_STATUS_IS_OK(status)) {
468 errno = map_errno_from_nt_status(status);
472 status = get_nt_acl_internal(handle,
475 (OWNER_SECURITY_INFORMATION |
476 GROUP_SECURITY_INFORMATION |
477 DACL_SECURITY_INFORMATION),
479 if (NT_STATUS_IS_OK(status)) {
480 /* See if we can access it. */
481 status = smb1_file_se_access_check(pdesc,
482 handle->conn->server_info->ptok,
485 if (!NT_STATUS_IS_OK(status)) {
486 DEBUG(10,("open_acl_xattr: file %s open "
487 "refused with error %s\n",
488 smb_fname_str_dbg(smb_fname),
489 nt_errstr(status) ));
490 errno = map_errno_from_nt_status(status);
493 } else if (NT_STATUS_EQUAL(status,NT_STATUS_OBJECT_NAME_NOT_FOUND)) {
494 file_existed = false;
497 DEBUG(10,("open_acl_xattr: get_nt_acl_attr_internal for "
498 "file %s returned %s\n",
499 smb_fname_str_dbg(smb_fname),
500 nt_errstr(status) ));
502 fsp->fh->fd = SMB_VFS_NEXT_OPEN(handle, smb_fname, fsp, flags, mode);
504 if (!file_existed && fsp->fh->fd != -1) {
505 /* File was created. Inherit from parent directory. */
506 status = fsp_set_smb_fname(fsp, smb_fname);
507 if (!NT_STATUS_IS_OK(status)) {
508 errno = map_errno_from_nt_status(status);
511 inherit_new_acl(handle, smb_fname, fsp, false);
517 static int mkdir_acl_common(vfs_handle_struct *handle, const char *path, mode_t mode)
519 struct smb_filename *smb_fname = NULL;
520 int ret = SMB_VFS_NEXT_MKDIR(handle, path, mode);
527 status = create_synthetic_smb_fname(talloc_tos(), path, NULL, NULL,
529 if (!NT_STATUS_IS_OK(status)) {
530 errno = map_errno_from_nt_status(status);
534 /* New directory - inherit from parent. */
535 inherit_new_acl(handle, smb_fname, NULL, true);
536 TALLOC_FREE(smb_fname);
540 /*********************************************************************
541 Fetch a security descriptor given an fsp.
542 *********************************************************************/
544 static NTSTATUS fget_nt_acl_common(vfs_handle_struct *handle, files_struct *fsp,
545 uint32_t security_info, struct security_descriptor **ppdesc)
547 return get_nt_acl_internal(handle, fsp,
548 NULL, security_info, ppdesc);
551 /*********************************************************************
552 Fetch a security descriptor given a pathname.
553 *********************************************************************/
555 static NTSTATUS get_nt_acl_common(vfs_handle_struct *handle,
556 const char *name, uint32_t security_info, struct security_descriptor **ppdesc)
558 return get_nt_acl_internal(handle, NULL,
559 name, security_info, ppdesc);
562 /*********************************************************************
563 Store a security descriptor given an fsp.
564 *********************************************************************/
566 static NTSTATUS fset_nt_acl_common(vfs_handle_struct *handle, files_struct *fsp,
567 uint32_t security_info_sent, const struct security_descriptor *psd)
571 struct security_descriptor *pdesc_next = NULL;
572 uint8_t hash[XATTR_SD_HASH_SIZE];
574 if (DEBUGLEVEL >= 10) {
575 DEBUG(10,("fset_nt_acl_xattr: incoming sd for file %s\n",
577 NDR_PRINT_DEBUG(security_descriptor,
578 CONST_DISCARD(struct security_descriptor *,psd));
581 /* Ensure owner and group are set. */
582 if (!psd->owner_sid || !psd->group_sid) {
584 DOM_SID owner_sid, group_sid;
585 struct security_descriptor *nc_psd = dup_sec_desc(talloc_tos(), psd);
590 if (fsp->is_directory || fsp->fh->fd == -1) {
591 if (fsp->posix_open) {
592 ret = SMB_VFS_LSTAT(fsp->conn, fsp->fsp_name);
594 ret = SMB_VFS_STAT(fsp->conn, fsp->fsp_name);
597 ret = SMB_VFS_FSTAT(fsp, &fsp->fsp_name->st);
600 /* Lower level acl set succeeded,
601 * so still return OK. */
604 create_file_sids(&fsp->fsp_name->st, &owner_sid, &group_sid);
605 /* This is safe as nc_psd is discarded at fn exit. */
606 nc_psd->owner_sid = &owner_sid;
607 nc_psd->group_sid = &group_sid;
608 security_info_sent |= (OWNER_SECURITY_INFORMATION|GROUP_SECURITY_INFORMATION);
612 status = SMB_VFS_NEXT_FSET_NT_ACL(handle, fsp, security_info_sent, psd);
613 if (!NT_STATUS_IS_OK(status)) {
617 /* Get the full underlying sd, then hash. */
618 status = SMB_VFS_NEXT_FGET_NT_ACL(handle,
623 if (!NT_STATUS_IS_OK(status)) {
627 status = hash_sd_sha256(pdesc_next, hash);
628 if (!NT_STATUS_IS_OK(status)) {
632 if (DEBUGLEVEL >= 10) {
633 DEBUG(10,("fset_nt_acl_xattr: storing xattr sd for file %s\n",
635 NDR_PRINT_DEBUG(security_descriptor,
636 CONST_DISCARD(struct security_descriptor *,psd));
638 create_acl_blob(psd, &blob, XATTR_SD_HASH_TYPE_SHA256, hash);
639 store_acl_blob_fsp(handle, fsp, &blob);