docs-xml: Fix rid idmap backend documentation
[Samba.git] / source3 / include / smb_acls.h
blob7203dd27d75975ee5d5d4e4e8619f4fc24bf257f
1 /*
2 Unix SMB/CIFS implementation.
3 Portable SMB ACL interface
4 Copyright (C) Jeremy Allison 2000
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 3 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, see <http://www.gnu.org/licenses/>.
20 #ifndef _SMB_ACLS_H
21 #define _SMB_ACLS_H
23 #include "librpc/gen_ndr/smb_acl.h"
25 struct vfs_handle_struct;
26 struct files_struct;
27 struct smb_filename;
29 typedef int SMB_ACL_TYPE_T;
31 * struct smb_acl_entry is defined in IDL as
32 * using mode_t values, pidl always converts these
33 * to uint32_t. Ensure the external type definitions
34 * match.
36 typedef uint32_t *SMB_ACL_PERMSET_T;
37 typedef uint32_t SMB_ACL_PERM_T;
39 typedef enum smb_acl_tag_t SMB_ACL_TAG_T;
40 typedef struct smb_acl_t *SMB_ACL_T;
42 typedef struct smb_acl_entry *SMB_ACL_ENTRY_T;
44 /* The following definitions come from lib/sysacls.c */
46 int sys_acl_get_entry(SMB_ACL_T acl_d, int entry_id, SMB_ACL_ENTRY_T *entry_p);
47 int sys_acl_get_tag_type(SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T *type_p);
48 int sys_acl_get_permset(SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T *permset_p);
49 void *sys_acl_get_qualifier(SMB_ACL_ENTRY_T entry_d);
50 int sys_acl_clear_perms(SMB_ACL_PERMSET_T permset_d);
51 int sys_acl_add_perm(SMB_ACL_PERMSET_T permset_d, SMB_ACL_PERM_T perm);
52 int sys_acl_get_perm(SMB_ACL_PERMSET_T permset_d, SMB_ACL_PERM_T perm);
53 char *sys_acl_to_text(const struct smb_acl_t *acl_d, ssize_t *len_p);
54 SMB_ACL_T sys_acl_init(TALLOC_CTX *mem_ctx);
55 int sys_acl_create_entry(SMB_ACL_T *acl_p, SMB_ACL_ENTRY_T *entry_p);
56 int sys_acl_set_tag_type(SMB_ACL_ENTRY_T entry_d, SMB_ACL_TAG_T tag_type);
57 int sys_acl_set_qualifier(SMB_ACL_ENTRY_T entry_d, void *qual_p);
58 int sys_acl_set_permset(SMB_ACL_ENTRY_T entry_d, SMB_ACL_PERMSET_T permset_d);
59 int sys_acl_free_text(char *text);
60 int sys_acl_valid(SMB_ACL_T acl_d);
61 SMB_ACL_T sys_acl_get_fd(struct vfs_handle_struct *handle,
62 struct files_struct *fsp,
63 SMB_ACL_TYPE_T type,
64 TALLOC_CTX *mem_ctx);
65 int sys_acl_set_fd(struct vfs_handle_struct *handle,
66 struct files_struct *fsp,
67 SMB_ACL_TYPE_T type,
68 SMB_ACL_T acl_d);
69 int sys_acl_delete_def_fd(struct vfs_handle_struct *handle,
70 struct files_struct *fsp);
71 int no_acl_syscall_error(int err);
73 #endif /* _SMB_ACLS_H */