blob: dd95a6fa24bf41f177e3f78a78a46acc58b8813a [file] [log] [blame]
Steve Frenchbf820672005-12-01 22:32:42 -08001/*
2 * fs/cifs/cifsacl.h
3 *
Steve Frenchbcb02032007-09-25 16:17:24 +00004 * Copyright (c) International Business Machines Corp., 2007
Steve Frenchbf820672005-12-01 22:32:42 -08005 * Author(s): Steve French (sfrench@us.ibm.com)
6 *
7 * This library is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published
9 * by the Free Software Foundation; either version 2.1 of the License, or
10 * (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
15 * the GNU Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */
21
22#ifndef _CIFSACL_H
23#define _CIFSACL_H
24
Steve French297647c2007-10-12 04:11:59 +000025
Jeff Laytonfaa65f02012-12-03 06:05:29 -050026#define NUM_AUTHS (6) /* number of authority fields */
Jeff Layton30c9d6c2012-11-25 08:00:37 -050027#define SID_MAX_SUB_AUTHORITIES (15) /* max number of sub authority fields */
Steve French297647c2007-10-12 04:11:59 +000028
Steve Frencha750e772007-10-17 22:50:39 +000029#define READ_BIT 0x4
30#define WRITE_BIT 0x2
31#define EXEC_BIT 0x1
32
33#define UBITSHIFT 6
34#define GBITSHIFT 3
35
Steve French63d25832007-11-05 21:46:10 +000036#define ACCESS_ALLOWED 0
37#define ACCESS_DENIED 1
38
Shirish Pargaonkar9409ae52011-04-22 12:09:36 -050039#define SIDOWNER 1
40#define SIDGROUP 2
Jeff Layton30c9d6c2012-11-25 08:00:37 -050041
42/*
Jeff Layton7ee0b4c2012-12-03 06:05:31 -050043 * Security Descriptor length containing DACL with 3 ACEs (one each for
44 * owner, group and world).
45 */
46#define DEFAULT_SEC_DESC_LEN (sizeof(struct cifs_ntsd) + \
47 sizeof(struct cifs_acl) + \
48 (sizeof(struct cifs_ace) * 3))
49
50/*
Jeff Layton30c9d6c2012-11-25 08:00:37 -050051 * Maximum size of a string representation of a SID:
52 *
53 * The fields are unsigned values in decimal. So:
54 *
55 * u8: max 3 bytes in decimal
56 * u32: max 10 bytes in decimal
57 *
Jeff Layton193cdd82012-12-10 06:10:44 -050058 * "S-" + 3 bytes for version field + 15 for authority field + NULL terminator
59 *
60 * For authority field, max is when all 6 values are non-zero and it must be
61 * represented in hex. So "-0x" + 12 hex digits.
Jeff Laytonfaa65f02012-12-03 06:05:29 -050062 *
63 * Add 11 bytes for each subauthority field (10 bytes each + 1 for '-')
Jeff Layton30c9d6c2012-11-25 08:00:37 -050064 */
Jeff Layton193cdd82012-12-10 06:10:44 -050065#define SID_STRING_BASE_SIZE (2 + 3 + 15 + 1)
Jeff Laytonfaa65f02012-12-03 06:05:29 -050066#define SID_STRING_SUBAUTH_SIZE (11) /* size of a single subauth string */
Shirish Pargaonkar9409ae52011-04-22 12:09:36 -050067
Steve French442aa312007-09-24 20:25:46 +000068struct cifs_ntsd {
Steve Frenchaf6f4612007-10-16 18:40:37 +000069 __le16 revision; /* revision level */
70 __le16 type;
71 __le32 osidoffset;
72 __le32 gsidoffset;
73 __le32 sacloffset;
74 __le32 dacloffset;
Steve French442aa312007-09-24 20:25:46 +000075} __attribute__((packed));
76
Steve Frenchbf820672005-12-01 22:32:42 -080077struct cifs_sid {
78 __u8 revision; /* revision level */
Steve French40849732007-10-01 19:59:01 +000079 __u8 num_subauth;
Jeff Layton852e2292012-11-25 08:00:36 -050080 __u8 authority[NUM_AUTHS];
Jeff Layton30c9d6c2012-11-25 08:00:37 -050081 __le32 sub_auth[SID_MAX_SUB_AUTHORITIES]; /* sub_auth[num_subauth] */
Steve French442aa312007-09-24 20:25:46 +000082} __attribute__((packed));
83
Jeff Layton36f87ee2012-11-25 08:00:37 -050084/* size of a struct cifs_sid, sans sub_auth array */
85#define CIFS_SID_BASE_SIZE (1 + 1 + NUM_AUTHS)
86
Steve French442aa312007-09-24 20:25:46 +000087struct cifs_acl {
Steve Frenchaf6f4612007-10-16 18:40:37 +000088 __le16 revision; /* revision level */
89 __le16 size;
90 __le32 num_aces;
Steve French442aa312007-09-24 20:25:46 +000091} __attribute__((packed));
92
Steve French44093ca2007-10-23 21:22:55 +000093struct cifs_ace {
Steve French442aa312007-09-24 20:25:46 +000094 __u8 type;
95 __u8 flags;
Cyril Gorcunov8f2376a2007-10-14 17:58:43 +000096 __le16 size;
97 __le32 access_req;
Steve French44093ca2007-10-23 21:22:55 +000098 struct cifs_sid sid; /* ie UUID of user or group who gets these perms */
Steve Frenchbf820672005-12-01 22:32:42 -080099} __attribute__((packed));
100
Shirish Pargaonkaree25c6d2018-06-04 06:46:22 -0500101/*
102 * Minimum security identifier can be one for system defined Users
103 * and Groups such as NULL SID and World or Built-in accounts such
104 * as Administrator and Guest and consists of
105 * Revision + Num (Sub)Auths + Authority + Domain (one Subauthority)
106 */
107#define MIN_SID_LEN (1 + 1 + 6 + 4) /* in bytes */
108
109/*
110 * Minimum security descriptor can be one without any SACL and DACL and can
111 * consist of revision, type, and two sids of minimum size for owner and group
112 */
113#define MIN_SEC_DESC_LEN (sizeof(struct cifs_ntsd) + (2 * MIN_SID_LEN))
114
Steve Frencha6230af2006-01-08 20:04:55 -0800115#endif /* _CIFSACL_H */