source3/include/smb_macros.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB parameters and setup
   4    Copyright (C) Andrew Tridgell 1992-1999
   5    Copyright (C) John H Terpstra 1996-1999
   6    Copyright (C) Luke Kenneth Casson Leighton 1996-1999
   7    Copyright (C) Paul Ashton 1998 - 1999
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #ifndef _SMB_MACROS_H
  24 #define _SMB_MACROS_H
  25
  26 /* Misc bit macros */
  27 #define BOOLSTR(b) ((b) ? "Yes" : "No")
  28 #define BITSETW(ptr,bit) ((SVAL(ptr,0) & (1<<(bit)))!=0)
  29
  30 /* for readability... */
  31 #define IS_DOS_READONLY(test_mode) (((test_mode) & FILE_ATTRIBUTE_READONLY) != 0)
  32 #define IS_DOS_DIR(test_mode)      (((test_mode) & FILE_ATTRIBUTE_DIRECTORY) != 0)
  33 #define IS_DOS_ARCHIVE(test_mode)  (((test_mode) & FILE_ATTRIBUTE_ARCHIVE) != 0)
  34 #define IS_DOS_SYSTEM(test_mode)   (((test_mode) & FILE_ATTRIBUTE_SYSTEM) != 0)
  35 #define IS_DOS_HIDDEN(test_mode)   (((test_mode) & FILE_ATTRIBUTE_HIDDEN) != 0)
  36
  37 /* these are useful macros for checking validity of handles */
  38 #define IS_IPC(conn)       ((conn) && (conn)->ipc)
  39 #define IS_PRINT(conn)       ((conn) && (conn)->printer)
  40
  41 #define CHECK_READ(fsp,req) \
  42         ((!(fsp)->fsp_flags.is_pathref) &&  \
  43          (fsp_get_io_fd(fsp) != -1) && \
  44          (((fsp)->fsp_flags.can_read) || \
  45           ((req->flags2 & FLAGS2_READ_PERMIT_EXECUTE) && \
  46            (fsp->access_mask & FILE_EXECUTE))))
  47
  48 /*
  49  * This is not documented in revision 49 of [MS-SMB2] but should be added in a
  50  * later revision (and torture test smb2.read.access as well as
  51  * smb2.ioctl_copy_chunk_bad_access against Server 2012R2 confirms this)
  52  *
  53  * If FILE_EXECUTE is granted to a handle then the SMB2 server acts as if
  54  * FILE_READ_DATA has also been granted. We must still keep the original granted
  55  * mask, because with ioctl requests, access checks are made on the file handle,
  56  * "below" the SMB2 server, and the object store below the SMB layer is not
  57  * aware of this arrangement (see smb2.ioctl.copy_chunk_bad_access torture
  58  * test).
  59  */
  60 #define CHECK_READ_SMB2(fsp) \
  61         ((!(fsp)->fsp_flags.is_pathref) &&  \
  62          (fsp_get_io_fd(fsp) != -1) && \
  63          (((fsp)->fsp_flags.can_read) || \
  64           (fsp->access_mask & FILE_EXECUTE)))
  65
  66 /* An IOCTL readability check (validating read access
  67  * when the IOCTL code requires it)
  68  * http://social.technet.microsoft.com/wiki/contents/articles/24653.decoding-io-control-codes-ioctl-fsctl-and-deviceiocodes-with-table-of-known-values.aspx
  69  * ). On Windows servers, this is done by the IO manager, which is unaware of
  70  * the "if execute is granted then also grant read" arrangement.
  71  */
  72 #define CHECK_READ_IOCTL(fsp) \
  73         ((!(fsp)->fsp_flags.is_pathref) &&  \
  74          (fsp_get_io_fd(fsp) != -1) && \
  75          (((fsp)->fsp_flags.can_read)))
  76
  77 #define ERROR_WAS_LOCK_DENIED(status) (NT_STATUS_EQUAL((status), NT_STATUS_LOCK_NOT_GRANTED) || \
  78                                 NT_STATUS_EQUAL((status), NT_STATUS_FILE_LOCK_CONFLICT) )
  79
  80 /* the service number for the [globals] defaults */
  81 #define GLOBAL_SECTION_SNUM     (-1)
  82 /* translates a connection number into a service number */
  83 #define SNUM(conn)              ((conn)?(conn)->params->service:GLOBAL_SECTION_SNUM)
  84
  85
  86 /* access various service details */
  87 #define CAN_WRITE(conn)    (!conn->read_only)
  88 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
  89 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
  90 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
  91 #define CAN_PRINT(conn)    ((conn) && lp_printable(SNUM(conn)))
  92 #define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden(SNUM(conn)))
  93 #define MAP_SYSTEM(conn)   ((conn) && lp_map_system(SNUM(conn)))
  94 #define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive(SNUM(conn)))
  95 #define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list,(conn)->case_sensitive))
  96 #define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list,(conn)->case_sensitive))
  97 #define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list,(conn)->case_sensitive))
  98
  99 /*
 100  * Used by the stat cache code to check if a returned
 101  * stat structure is valid.
 102  */
 103
 104 #define VALID_STAT(st) ((st).st_ex_nlink != 0)
 105 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_ex_mode))
 106 #define SET_STAT_INVALID(st) { \
 107                 (st).st_ex_nlink = 0;                                   \
 108                 (st).cached_dos_attributes = FILE_ATTRIBUTES_INVALID;   \
 109 };
 110
 111 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
 112    structures. We cannot define these as actual structures
 113    due to possible differences in structure packing
 114    on different machines/compilers. */
 115
 116 #define SMB_LPID_OFFSET(indx) (10 * (indx))
 117 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
 118 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
 119 #define SMB_LARGE_LPID_OFFSET(indx) (20 * (indx))
 120 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
 121 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
 122 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
 123 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
 124
 125 #define ERROR_NT(status) error_packet(outbuf,0,0,status,__LINE__,__FILE__)
 126 #define ERROR_BOTH(status,class,code) error_packet(outbuf,class,code,status,__LINE__,__FILE__)
 127
 128 #define reply_nterror(req,status) reply_nt_error(req,status,__LINE__,__FILE__)
 129 #define reply_force_doserror(req,eclass,ecode) reply_force_dos_error(req,eclass,ecode,__LINE__,__FILE__)
 130 #define reply_botherror(req,status,eclass,ecode) reply_both_error(req,eclass,ecode,status,__LINE__,__FILE__)
 131
 132 #if 0
 133 /* defined in IDL */
 134 /* these are the datagram types */
 135 #define DGRAM_DIRECT_UNIQUE 0x10
 136 #endif
 137
 138 #define SMB_ROUNDUP(x,r) ( ((x)%(r)) ? ( (((x)+(r))/(r))*(r) ) : (x))
 139
 140 /* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
 141 #define smb_buf(buf) (((char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
 142 #define smb_buf_const(buf) (((const char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
 143 #define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
 144
 145 /* the remaining number of bytes in smb buffer 'buf' from pointer 'p'. */
 146 #define smbreq_bufrem(req, p) ((req)->buflen < PTR_DIFF((p), (req)->buf) ? 0 : (req)->buflen - PTR_DIFF((p), (req)->buf))
 147
 148
 149 /* Note that chain_size must be available as an extern int to this macro. */
 150 #define smb_offset(p,buf) (PTR_DIFF(p,buf+4))
 151
 152 #define smb_len(buf) smb_len_nbt(buf)
 153 #define _smb_setlen(buf, len) _smb_setlen_nbt(buf, len)
 154 #define smb_setlen(buf, len) smb_setlen_nbt(buf, len)
 155
 156 #define smb_len_large(buf) smb_len_tcp(buf)
 157 #define _smb_setlen_large(buf, len) _smb_setlen_tcp(buf, len)
 158
 159 #define ENCRYPTION_REQUIRED(conn) ((conn) ? ((conn)->encrypt_level == SMB_SIGNING_REQUIRED) : false)
 160 #define IS_CONN_ENCRYPTED(conn) ((conn) ? (conn)->encrypted_tid : false)
 161
 162 /****************************************************************************
 163  Return True if the offset is at zero.
 164 ****************************************************************************/
 165
 166 #define dptr_zero(buf) (IVAL(buf,1) == 0)
 167
 168 /*******************************************************************
 169 copy an IP address from one buffer to another
 170 ********************************************************************/
 171
 172 #define putip(dest,src) memcpy(dest,src,4)
 173
 174 /*******************************************************************
 175  Return True if a server has CIFS UNIX capabilities.
 176 ********************************************************************/
 177
 178 #define SERVER_HAS_UNIX_CIFS(c) (smb1cli_conn_capabilities(c->conn) & CAP_UNIX)
 179
 180 /****************************************************************************
 181  Make a filename into unix format.
 182 ****************************************************************************/
 183
 184 #define IS_DIRECTORY_SEP(c) ((c) == '\\' || (c) == '/')
 185 #define unix_format(fname) string_replace(fname,'\\','/')
 186
 187 /****************************************************************************
 188  Make a file into DOS format.
 189 ****************************************************************************/
 190
 191 #define dos_format(fname) string_replace(fname,'/','\\')
 192
 193 /*****************************************************************************
 194  Check to see if we are a DC for this domain
 195 *****************************************************************************/
 196
 197 #define IS_DC  (lp_server_role()==ROLE_DOMAIN_PDC || lp_server_role()==ROLE_DOMAIN_BDC || lp_server_role() == ROLE_ACTIVE_DIRECTORY_DC || lp_server_role() == ROLE_IPA_DC)
 198 #define IS_AD_DC  (lp_server_role() == ROLE_ACTIVE_DIRECTORY_DC)
 199
 200 /*
 201  * If you add any entries to KERBEROS_VERIFY defines, please modify the below expressions
 202  * so they remain accurate.
 203  */
 204 #define USE_KERBEROS_KEYTAB (KERBEROS_VERIFY_SECRETS != lp_kerberos_method())
 205 #define USE_SYSTEM_KEYTAB \
 206     ((KERBEROS_VERIFY_SECRETS_AND_KEYTAB == lp_kerberos_method()) || \
 207      (KERBEROS_VERIFY_SYSTEM_KEYTAB == lp_kerberos_method()))
 208
 209 /*****************************************************************************
 210  Safe allocation macros.
 211 *****************************************************************************/
 212
 213 #define SMB_MALLOC_ARRAY(type,count) (type *)malloc_array(sizeof(type),(count))
 214 #define SMB_MEMALIGN_ARRAY(type,align,count) (type *)memalign_array(sizeof(type),align,(count))
 215 #define SMB_REALLOC(p,s) Realloc((p),(s),True)  /* Always frees p on error or s == 0 */
 216 #define SMB_REALLOC_ARRAY(p,type,count) (type *)realloc_array((p),sizeof(type),(count),True) /* Always frees p on error or s == 0 */
 217 #define SMB_CALLOC_ARRAY(type,count) (type *)calloc_array(sizeof(type),(count))
 218 #define SMB_XMALLOC_P(type) (type *)smb_xmalloc_array(sizeof(type),1)
 219 #define SMB_XMALLOC_ARRAY(type,count) (type *)smb_xmalloc_array(sizeof(type),(count))
 220
 221 #define TALLOC(ctx, size) talloc_named_const(ctx, size, __location__)
 222 #define TALLOC_SIZE(ctx, size) talloc_named_const(ctx, size, __location__)
 223 #define TALLOC_REALLOC(ctx, ptr, count) _talloc_realloc(ctx, ptr, count, __location__)
 224 #define talloc_destroy(ctx) talloc_free(ctx)
 225 #ifndef TALLOC_FREE
 226 #define TALLOC_FREE(ctx) do { talloc_free(ctx); ctx=NULL; } while(0)
 227 #endif
 228
 229 /* only define PARANOID_MALLOC_CHECKER with --enable-developer */
 230
 231 #if defined(DEVELOPER)
 232 #  define PARANOID_MALLOC_CHECKER 1
 233 #endif
 234
 235 #if defined(PARANOID_MALLOC_CHECKER)
 236
 237 /* Get medieval on our ass about malloc.... */
 238
 239 /* Restrictions on malloc/realloc/calloc. */
 240 #ifdef malloc
 241 #undef malloc
 242 #endif
 243 #define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
 244
 245 #ifdef realloc
 246 #undef realloc
 247 #endif
 248 #define realloc(p,s) __ERROR_DONT_USE_REALLOC_DIRECTLY
 249
 250 #ifdef calloc
 251 #undef calloc
 252 #endif
 253 #define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
 254
 255 #ifdef strndup
 256 #undef strndup
 257 #endif
 258 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
 259
 260 #ifdef strdup
 261 #undef strdup
 262 #endif
 263 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
 264
 265 #define SMB_MALLOC(s) malloc_(s)
 266 #define SMB_MALLOC_P(type) (type *)malloc_(sizeof(type))
 267
 268 #define SMB_STRDUP(s) smb_xstrdup(s)
 269 #define SMB_STRNDUP(s,n) smb_xstrndup(s,n)
 270
 271 #else
 272
 273 /* Regular malloc code. */
 274
 275 #define SMB_MALLOC(s) malloc(s)
 276 #define SMB_MALLOC_P(type) (type *)malloc(sizeof(type))
 277
 278 #define SMB_STRDUP(s) strdup(s)
 279 #define SMB_STRNDUP(s,n) strndup(s,n)
 280
 281 #endif
 282
 283 #define ADD_TO_ARRAY(mem_ctx, type, elem, array, num) \
 284 do { \
 285         *(array) = ((mem_ctx) != NULL) ? \
 286                 talloc_realloc(mem_ctx, (*(array)), type, (*(num))+1) : \
 287                 SMB_REALLOC_ARRAY((*(array)), type, (*(num))+1); \
 288         SMB_ASSERT((*(array)) != NULL); \
 289         (*(array))[*(num)] = (elem); \
 290         (*(num)) += 1; \
 291 } while (0)
 292
 293 #define ADD_TO_LARGE_ARRAY(mem_ctx, type, elem, array, num, size) \
 294         add_to_large_array((mem_ctx), sizeof(type), &(elem), (void *)(array), (num), (size));
 295
 296 #endif /* _SMB_MACROS_H */