fs/cifs/cifsacl.h

   1 /* SPDX-License-Identifier: LGPL-2.1 */
   2 /*
   3  *   fs/cifs/cifsacl.h
   4  *
   5  *   Copyright (c) International Business Machines  Corp., 2007
   6  *   Author(s): Steve French (sfrench@us.ibm.com)
   7  *
   8  */
   9
  10 #ifndef _CIFSACL_H
  11 #define _CIFSACL_H
  12
  13 #define NUM_AUTHS (6)   /* number of authority fields */
  14 #define SID_MAX_SUB_AUTHORITIES (15) /* max number of sub authority fields */
  15
  16 #define READ_BIT        0x4
  17 #define WRITE_BIT       0x2
  18 #define EXEC_BIT        0x1
  19
  20 #define ACL_OWNER_MASK 0700
  21 #define ACL_GROUP_MASK 0070
  22 #define ACL_EVERYONE_MASK 0007
  23
  24 #define UBITSHIFT       6
  25 #define GBITSHIFT       3
  26
  27 #define ACCESS_ALLOWED  0
  28 #define ACCESS_DENIED   1
  29
  30 #define SIDOWNER 1
  31 #define SIDGROUP 2
  32
  33 /*
  34  * Security Descriptor length containing DACL with 3 ACEs (one each for
  35  * owner, group and world).
  36  */
  37 #define DEFAULT_SEC_DESC_LEN (sizeof(struct cifs_ntsd) + \
  38                               sizeof(struct cifs_acl) + \
  39                               (sizeof(struct cifs_ace) * 4))
  40
  41 /*
  42  * Maximum size of a string representation of a SID:
  43  *
  44  * The fields are unsigned values in decimal. So:
  45  *
  46  * u8:  max 3 bytes in decimal
  47  * u32: max 10 bytes in decimal
  48  *
  49  * "S-" + 3 bytes for version field + 15 for authority field + NULL terminator
  50  *
  51  * For authority field, max is when all 6 values are non-zero and it must be
  52  * represented in hex. So "-0x" + 12 hex digits.
  53  *
  54  * Add 11 bytes for each subauthority field (10 bytes each + 1 for '-')
  55  */
  56 #define SID_STRING_BASE_SIZE (2 + 3 + 15 + 1)
  57 #define SID_STRING_SUBAUTH_SIZE (11) /* size of a single subauth string */
  58
  59 struct cifs_ntsd {
  60         __le16 revision; /* revision level */
  61         __le16 type;
  62         __le32 osidoffset;
  63         __le32 gsidoffset;
  64         __le32 sacloffset;
  65         __le32 dacloffset;
  66 } __attribute__((packed));
  67
  68 struct cifs_sid {
  69         __u8 revision; /* revision level */
  70         __u8 num_subauth;
  71         __u8 authority[NUM_AUTHS];
  72         __le32 sub_auth[SID_MAX_SUB_AUTHORITIES]; /* sub_auth[num_subauth] */
  73 } __attribute__((packed));
  74
  75 /* size of a struct cifs_sid, sans sub_auth array */
  76 #define CIFS_SID_BASE_SIZE (1 + 1 + NUM_AUTHS)
  77
  78 struct cifs_acl {
  79         __le16 revision; /* revision level */
  80         __le16 size;
  81         __le32 num_aces;
  82 } __attribute__((packed));
  83
  84 /* ACE types - see MS-DTYP 2.4.4.1 */
  85 #define ACCESS_ALLOWED_ACE_TYPE 0x00
  86 #define ACCESS_DENIED_ACE_TYPE  0x01
  87 #define SYSTEM_AUDIT_ACE_TYPE   0x02
  88 #define SYSTEM_ALARM_ACE_TYPE   0x03
  89 #define ACCESS_ALLOWED_COMPOUND_ACE_TYPE 0x04
  90 #define ACCESS_ALLOWED_OBJECT_ACE_TYPE  0x05
  91 #define ACCESS_DENIED_OBJECT_ACE_TYPE   0x06
  92 #define SYSTEM_AUDIT_OBJECT_ACE_TYPE    0x07
  93 #define SYSTEM_ALARM_OBJECT_ACE_TYPE    0x08
  94 #define ACCESS_ALLOWED_CALLBACK_ACE_TYPE 0x09
  95 #define ACCESS_DENIED_CALLBACK_ACE_TYPE 0x0A
  96 #define ACCESS_ALLOWED_CALLBACK_OBJECT_ACE_TYPE 0x0B
  97 #define ACCESS_DENIED_CALLBACK_OBJECT_ACE_TYPE  0x0C
  98 #define SYSTEM_AUDIT_CALLBACK_ACE_TYPE  0x0D
  99 #define SYSTEM_ALARM_CALLBACK_ACE_TYPE  0x0E /* Reserved */
 100 #define SYSTEM_AUDIT_CALLBACK_OBJECT_ACE_TYPE 0x0F
 101 #define SYSTEM_ALARM_CALLBACK_OBJECT_ACE_TYPE 0x10 /* reserved */
 102 #define SYSTEM_MANDATORY_LABEL_ACE_TYPE 0x11
 103 #define SYSTEM_RESOURCE_ATTRIBUTE_ACE_TYPE 0x12
 104 #define SYSTEM_SCOPED_POLICY_ID_ACE_TYPE 0x13
 105
 106 /* ACE flags */
 107 #define OBJECT_INHERIT_ACE      0x01
 108 #define CONTAINER_INHERIT_ACE   0x02
 109 #define NO_PROPAGATE_INHERIT_ACE 0x04
 110 #define INHERIT_ONLY_ACE        0x08
 111 #define INHERITED_ACE           0x10
 112 #define SUCCESSFUL_ACCESS_ACE_FLAG 0x40
 113 #define FAILED_ACCESS_ACE_FLAG  0x80
 114
 115 struct cifs_ace {
 116         __u8 type; /* see above and MS-DTYP 2.4.4.1 */
 117         __u8 flags;
 118         __le16 size;
 119         __le32 access_req;
 120         struct cifs_sid sid; /* ie UUID of user or group who gets these perms */
 121 } __attribute__((packed));
 122
 123 /*
 124  * The current SMB3 form of security descriptor is similar to what was used for
 125  * cifs (see above) but some fields are split, and fields in the struct below
 126  * matches names of fields to the spec, MS-DTYP (see sections 2.4.5 and
 127  * 2.4.6). Note that "CamelCase" fields are used in this struct in order to
 128  * match the MS-DTYP and MS-SMB2 specs which define the wire format.
 129  */
 130 struct smb3_sd {
 131         __u8 Revision; /* revision level, MUST be one */
 132         __u8 Sbz1; /* only meaningful if 'RM' flag set below */
 133         __le16 Control;
 134         __le32 OffsetOwner;
 135         __le32 OffsetGroup;
 136         __le32 OffsetSacl;
 137         __le32 OffsetDacl;
 138 } __packed;
 139
 140 /* Meaning of 'Control' field flags */
 141 #define ACL_CONTROL_SR  0x8000  /* Self relative */
 142 #define ACL_CONTROL_RM  0x4000  /* Resource manager control bits */
 143 #define ACL_CONTROL_PS  0x2000  /* SACL protected from inherits */
 144 #define ACL_CONTROL_PD  0x1000  /* DACL protected from inherits */
 145 #define ACL_CONTROL_SI  0x0800  /* SACL Auto-Inherited */
 146 #define ACL_CONTROL_DI  0x0400  /* DACL Auto-Inherited */
 147 #define ACL_CONTROL_SC  0x0200  /* SACL computed through inheritance */
 148 #define ACL_CONTROL_DC  0x0100  /* DACL computed through inheritence */
 149 #define ACL_CONTROL_SS  0x0080  /* Create server ACL */
 150 #define ACL_CONTROL_DT  0x0040  /* DACL provided by trusted source */
 151 #define ACL_CONTROL_SD  0x0020  /* SACL defaulted */
 152 #define ACL_CONTROL_SP  0x0010  /* SACL is present on object */
 153 #define ACL_CONTROL_DD  0x0008  /* DACL defaulted */
 154 #define ACL_CONTROL_DP  0x0004  /* DACL is present on object */
 155 #define ACL_CONTROL_GD  0x0002  /* Group was defaulted */
 156 #define ACL_CONTROL_OD  0x0001  /* User was defaulted */
 157
 158 /* Meaning of AclRevision flags */
 159 #define ACL_REVISION    0x02 /* See section 2.4.4.1 of MS-DTYP */
 160 #define ACL_REVISION_DS 0x04 /* Additional AceTypes allowed */
 161
 162 struct smb3_acl {
 163         u8 AclRevision; /* revision level */
 164         u8 Sbz1; /* MBZ */
 165         __le16 AclSize;
 166         __le16 AceCount;
 167         __le16 Sbz2; /* MBZ */
 168 } __packed;
 169
 170 /*
 171  * Used to store the special 'NFS SIDs' used to persist the POSIX uid and gid
 172  * See http://technet.microsoft.com/en-us/library/hh509017(v=ws.10).aspx
 173  */
 174 struct owner_sid {
 175         u8 Revision;
 176         u8 NumAuth;
 177         u8 Authority[6];
 178         __le32 SubAuthorities[3];
 179 } __packed;
 180
 181 struct owner_group_sids {
 182         struct owner_sid owner;
 183         struct owner_sid group;
 184 } __packed;
 185
 186 /*
 187  * Minimum security identifier can be one for system defined Users
 188  * and Groups such as NULL SID and World or Built-in accounts such
 189  * as Administrator and Guest and consists of
 190  * Revision + Num (Sub)Auths + Authority + Domain (one Subauthority)
 191  */
 192 #define MIN_SID_LEN  (1 + 1 + 6 + 4) /* in bytes */
 193
 194 /*
 195  * Minimum security descriptor can be one without any SACL and DACL and can
 196  * consist of revision, type, and two sids of minimum size for owner and group
 197  */
 198 #define MIN_SEC_DESC_LEN  (sizeof(struct cifs_ntsd) + (2 * MIN_SID_LEN))
 199
 200 #endif /* _CIFSACL_H */