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 #define SMB_WARN(condition, message) \
  38     ((condition) ? (void)0 : \
  39      DEBUG(0, ("WARNING: %s: %s\n", #condition, message)))
  40
  41 #define SMB_ASSERT_ARRAY(a,n) SMB_ASSERT((sizeof(a)/sizeof((a)[0])) >= (n))
  42
  43 /* these are useful macros for checking validity of handles */
  44 #define IS_IPC(conn)       ((conn) && (conn)->ipc)
  45 #define IS_PRINT(conn)       ((conn) && (conn)->printer)
  46 /* you must add the following extern declaration to files using this macro
  47  * (do not add it to the macro as that causes nested extern declaration warnings)
  48  * extern struct current_user current_user;
  49  */
  50 #define FSP_BELONGS_CONN(fsp,conn) do {\
  51                         if (!((fsp) && (conn) && ((conn)==(fsp)->conn) && (current_user.vuid==(fsp)->vuid))) \
  52                                 return ERROR_NT(NT_STATUS_INVALID_HANDLE); \
  53                         } while(0)
  54
  55 #define CHECK_READ(fsp,req) (((fsp)->fh->fd != -1) && ((fsp)->can_read || \
  56                         ((req->flags2 & FLAGS2_READ_PERMIT_EXECUTE) && \
  57                          (fsp->access_mask & FILE_EXECUTE))))
  58
  59 /*
  60  * This is not documented in revision 49 of [MS-SMB2] but should be added in a
  61  * later revision (and torture test smb2.read.access as well as
  62  * smb2.ioctl_copy_chunk_bad_access against Server 2012R2 confirms this)
  63  *
  64  * If FILE_EXECUTE is granted to a handle then the SMB2 server acts as if
  65  * FILE_READ_DATA has also been granted. We must still keep the original granted
  66  * mask, because with ioctl requests, access checks are made on the file handle,
  67  * "below" the SMB2 server, and the object store below the SMB layer is not
  68  * aware of this arrangement (see smb2.ioctl.copy_chunk_bad_access torture
  69  * test).
  70  */
  71 #define CHECK_READ_SMB2(fsp) \
  72         (((fsp)->fh->fd != -1) && \
  73          ((fsp)->can_read || (fsp->access_mask & FILE_EXECUTE)))
  74
  75 /* An IOCTL readability check (validating read access
  76  * when the IOCTL code requires it)
  77  * http://social.technet.microsoft.com/wiki/contents/articles/24653.decoding-io-control-codes-ioctl-fsctl-and-deviceiocodes-with-table-of-known-values.aspx
  78  * ). On Windows servers, this is done by the IO manager, which is unaware of
  79  * the "if execute is granted then also grant read" arrangement.
  80  */
  81 #define CHECK_READ_IOCTL(fsp) (((fsp)->fh->fd != -1) && ((fsp)->can_read))
  82
  83 #define CHECK_WRITE(fsp) ((fsp)->can_write && ((fsp)->fh->fd != -1))
  84
  85 #define ERROR_WAS_LOCK_DENIED(status) (NT_STATUS_EQUAL((status), NT_STATUS_LOCK_NOT_GRANTED) || \
  86                                 NT_STATUS_EQUAL((status), NT_STATUS_FILE_LOCK_CONFLICT) )
  87
  88 /* the service number for the [globals] defaults */
  89 #define GLOBAL_SECTION_SNUM     (-1)
  90 /* translates a connection number into a service number */
  91 #define SNUM(conn)              ((conn)?(conn)->params->service:GLOBAL_SECTION_SNUM)
  92
  93
  94 /* access various service details */
  95 #define CAN_WRITE(conn)    (!conn->read_only)
  96 #define VALID_SNUM(snum)   (lp_snum_ok(snum))
  97 #define GUEST_OK(snum)     (VALID_SNUM(snum) && lp_guest_ok(snum))
  98 #define GUEST_ONLY(snum)   (VALID_SNUM(snum) && lp_guest_only(snum))
  99 #define CAN_PRINT(conn)    ((conn) && lp_printable(SNUM(conn)))
 100 #define MAP_HIDDEN(conn)   ((conn) && lp_map_hidden(SNUM(conn)))
 101 #define MAP_SYSTEM(conn)   ((conn) && lp_map_system(SNUM(conn)))
 102 #define MAP_ARCHIVE(conn)   ((conn) && lp_map_archive(SNUM(conn)))
 103 #define IS_HIDDEN_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->hide_list,(conn)->case_sensitive))
 104 #define IS_VETO_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_list,(conn)->case_sensitive))
 105 #define IS_VETO_OPLOCK_PATH(conn,path)  ((conn) && is_in_path((path),(conn)->veto_oplock_list,(conn)->case_sensitive))
 106
 107 /*
 108  * Used by the stat cache code to check if a returned
 109  * stat structure is valid.
 110  */
 111
 112 #define VALID_STAT(st) ((st).st_ex_nlink != 0)
 113 #define VALID_STAT_OF_DIR(st) (VALID_STAT(st) && S_ISDIR((st).st_ex_mode))
 114 #define SET_STAT_INVALID(st) ((st).st_ex_nlink = 0)
 115
 116 /* Macros to get at offsets within smb_lkrng and smb_unlkrng
 117    structures. We cannot define these as actual structures
 118    due to possible differences in structure packing
 119    on different machines/compilers. */
 120
 121 #define SMB_LPID_OFFSET(indx) (10 * (indx))
 122 #define SMB_LKOFF_OFFSET(indx) ( 2 + (10 * (indx)))
 123 #define SMB_LKLEN_OFFSET(indx) ( 6 + (10 * (indx)))
 124 #define SMB_LARGE_LPID_OFFSET(indx) (20 * (indx))
 125 #define SMB_LARGE_LKOFF_OFFSET_HIGH(indx) (4 + (20 * (indx)))
 126 #define SMB_LARGE_LKOFF_OFFSET_LOW(indx) (8 + (20 * (indx)))
 127 #define SMB_LARGE_LKLEN_OFFSET_HIGH(indx) (12 + (20 * (indx)))
 128 #define SMB_LARGE_LKLEN_OFFSET_LOW(indx) (16 + (20 * (indx)))
 129
 130 #define ERROR_NT(status) error_packet(outbuf,0,0,status,__LINE__,__FILE__)
 131 #define ERROR_BOTH(status,class,code) error_packet(outbuf,class,code,status,__LINE__,__FILE__)
 132
 133 #define reply_nterror(req,status) reply_nt_error(req,status,__LINE__,__FILE__)
 134 #define reply_force_doserror(req,eclass,ecode) reply_force_dos_error(req,eclass,ecode,__LINE__,__FILE__)
 135 #define reply_botherror(req,status,eclass,ecode) reply_both_error(req,eclass,ecode,status,__LINE__,__FILE__)
 136
 137 #if 0
 138 /* defined in IDL */
 139 /* these are the datagram types */
 140 #define DGRAM_DIRECT_UNIQUE 0x10
 141 #endif
 142
 143 #define SMB_ROUNDUP(x,r) ( ((x)%(r)) ? ( (((x)+(r))/(r))*(r) ) : (x))
 144
 145 /* Extra macros added by Ying Chen at IBM - speed increase by inlining. */
 146 #define smb_buf(buf) (((char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
 147 #define smb_buf_const(buf) (((const char *)(buf)) + smb_size + CVAL(buf,smb_wct)*2)
 148 #define smb_buflen(buf) (SVAL(buf,smb_vwv0 + (int)CVAL(buf, smb_wct)*2))
 149
 150 /* the remaining number of bytes in smb buffer 'buf' from pointer 'p'. */
 151 #define smb_bufrem(buf, p) (smb_buflen(buf)-PTR_DIFF(p, smb_buf(buf)))
 152 #define smbreq_bufrem(req, p) (req->buflen - PTR_DIFF(p, req->buf))
 153
 154
 155 /* Note that chain_size must be available as an extern int to this macro. */
 156 #define smb_offset(p,buf) (PTR_DIFF(p,buf+4))
 157
 158 #define smb_len(buf) smb_len_nbt(buf)
 159 #define _smb_setlen(buf, len) _smb_setlen_nbt(buf, len)
 160 #define smb_setlen(buf, len) smb_setlen_nbt(buf, len)
 161
 162 #define smb_len_large(buf) smb_len_tcp(buf)
 163 #define _smb_setlen_large(buf, len) _smb_setlen_tcp(buf, len)
 164
 165 #define ENCRYPTION_REQUIRED(conn) ((conn) ? ((conn)->encrypt_level == SMB_SIGNING_REQUIRED) : false)
 166 #define IS_CONN_ENCRYPTED(conn) ((conn) ? (conn)->encrypted_tid : false)
 167
 168 /****************************************************************************
 169 true if two IPv4 addresses are equal
 170 ****************************************************************************/
 171
 172 #define ip_equal_v4(ip1,ip2) ((ip1).s_addr == (ip2).s_addr)
 173
 174 /*****************************************************************
 175  splits out the last subkey of a key
 176  *****************************************************************/
 177
 178 #define reg_get_subkey(full_keyname, key_name, subkey_name) \
 179         split_at_last_component(full_keyname, key_name, '\\', subkey_name)
 180
 181 /****************************************************************************
 182  Return True if the offset is at zero.
 183 ****************************************************************************/
 184
 185 #define dptr_zero(buf) (IVAL(buf,1) == 0)
 186
 187 /*******************************************************************
 188 copy an IP address from one buffer to another
 189 ********************************************************************/
 190
 191 #define putip(dest,src) memcpy(dest,src,4)
 192
 193 /*******************************************************************
 194  Return True if a server has CIFS UNIX capabilities.
 195 ********************************************************************/
 196
 197 #define SERVER_HAS_UNIX_CIFS(c) (smb1cli_conn_capabilities(c->conn) & CAP_UNIX)
 198
 199 /****************************************************************************
 200  Make a filename into unix format.
 201 ****************************************************************************/
 202
 203 #define IS_DIRECTORY_SEP(c) ((c) == '\\' || (c) == '/')
 204 #define unix_format(fname) string_replace(fname,'\\','/')
 205
 206 /****************************************************************************
 207  Make a file into DOS format.
 208 ****************************************************************************/
 209
 210 #define dos_format(fname) string_replace(fname,'/','\\')
 211
 212 /*****************************************************************************
 213  Check to see if we are a DC for this domain
 214 *****************************************************************************/
 215
 216 #define IS_DC  (lp_server_role()==ROLE_DOMAIN_PDC || lp_server_role()==ROLE_DOMAIN_BDC || lp_server_role() == ROLE_ACTIVE_DIRECTORY_DC)
 217 #define IS_AD_DC  (lp_server_role() == ROLE_ACTIVE_DIRECTORY_DC)
 218
 219 /*
 220  * If you add any entries to KERBEROS_VERIFY defines, please modify the below expressions
 221  * so they remain accurate.
 222  */
 223 #define USE_KERBEROS_KEYTAB (KERBEROS_VERIFY_SECRETS != lp_kerberos_method())
 224 #define USE_SYSTEM_KEYTAB \
 225     ((KERBEROS_VERIFY_SECRETS_AND_KEYTAB == lp_kerberos_method()) || \
 226      (KERBEROS_VERIFY_SYSTEM_KEYTAB == lp_kerberos_method()))
 227
 228 /*****************************************************************************
 229  Safe allocation macros.
 230 *****************************************************************************/
 231
 232 #define SMB_MALLOC_ARRAY(type,count) (type *)malloc_array(sizeof(type),(count))
 233 #define SMB_MEMALIGN_ARRAY(type,align,count) (type *)memalign_array(sizeof(type),align,(count))
 234 #define SMB_REALLOC(p,s) Realloc((p),(s),True)  /* Always frees p on error or s == 0 */
 235 #define SMB_REALLOC_KEEP_OLD_ON_ERROR(p,s) Realloc((p),(s),False) /* Never frees p on error or s == 0 */
 236 #define SMB_REALLOC_ARRAY(p,type,count) (type *)realloc_array((p),sizeof(type),(count),True) /* Always frees p on error or s == 0 */
 237 #define SMB_REALLOC_ARRAY_KEEP_OLD_ON_ERROR(p,type,count) (type *)realloc_array((p),sizeof(type),(count),False) /* Never frees p on error or s == 0 */
 238 #define SMB_CALLOC_ARRAY(type,count) (type *)calloc_array(sizeof(type),(count))
 239 #define SMB_XMALLOC_P(type) (type *)smb_xmalloc_array(sizeof(type),1)
 240 #define SMB_XMALLOC_ARRAY(type,count) (type *)smb_xmalloc_array(sizeof(type),(count))
 241
 242 #define TALLOC(ctx, size) talloc_named_const(ctx, size, __location__)
 243 #define TALLOC_ZERO(ctx, size) _talloc_zero(ctx, size, __location__)
 244 #define TALLOC_SIZE(ctx, size) talloc_named_const(ctx, size, __location__)
 245 #define TALLOC_ZERO_SIZE(ctx, size) _talloc_zero(ctx, size, __location__)
 246
 247 #define TALLOC_REALLOC(ctx, ptr, count) _talloc_realloc(ctx, ptr, count, __location__)
 248 #define talloc_destroy(ctx) talloc_free(ctx)
 249 #ifndef TALLOC_FREE
 250 #define TALLOC_FREE(ctx) do { talloc_free(ctx); ctx=NULL; } while(0)
 251 #endif
 252
 253 /* only define PARANOID_MALLOC_CHECKER with --enable-developer */
 254
 255 #if defined(DEVELOPER)
 256 #  define PARANOID_MALLOC_CHECKER 1
 257 #endif
 258
 259 #if defined(PARANOID_MALLOC_CHECKER)
 260
 261 /* Get medieval on our ass about malloc.... */
 262
 263 /* Restrictions on malloc/realloc/calloc. */
 264 #ifdef malloc
 265 #undef malloc
 266 #endif
 267 #define malloc(s) __ERROR_DONT_USE_MALLOC_DIRECTLY
 268
 269 #ifdef realloc
 270 #undef realloc
 271 #endif
 272 #define realloc(p,s) __ERROR_DONT_USE_REALLOC_DIRECTLY
 273
 274 #ifdef calloc
 275 #undef calloc
 276 #endif
 277 #define calloc(n,s) __ERROR_DONT_USE_CALLOC_DIRECTLY
 278
 279 #ifdef strndup
 280 #undef strndup
 281 #endif
 282 #define strndup(s,n) __ERROR_DONT_USE_STRNDUP_DIRECTLY
 283
 284 #ifdef strdup
 285 #undef strdup
 286 #endif
 287 #define strdup(s) __ERROR_DONT_USE_STRDUP_DIRECTLY
 288
 289 #define SMB_MALLOC(s) malloc_(s)
 290 #define SMB_MALLOC_P(type) (type *)malloc_(sizeof(type))
 291
 292 #define SMB_STRDUP(s) smb_xstrdup(s)
 293 #define SMB_STRNDUP(s,n) smb_xstrndup(s,n)
 294
 295 #else
 296
 297 /* Regular malloc code. */
 298
 299 #define SMB_MALLOC(s) malloc(s)
 300 #define SMB_MALLOC_P(type) (type *)malloc(sizeof(type))
 301
 302 #define SMB_STRDUP(s) strdup(s)
 303 #define SMB_STRNDUP(s,n) strndup(s,n)
 304
 305 #endif
 306
 307 #define ADD_TO_ARRAY(mem_ctx, type, elem, array, num) \
 308 do { \
 309         *(array) = ((mem_ctx) != NULL) ? \
 310                 talloc_realloc(mem_ctx, (*(array)), type, (*(num))+1) : \
 311                 SMB_REALLOC_ARRAY((*(array)), type, (*(num))+1); \
 312         SMB_ASSERT((*(array)) != NULL); \
 313         (*(array))[*(num)] = (elem); \
 314         (*(num)) += 1; \
 315 } while (0)
 316
 317 #define ADD_TO_LARGE_ARRAY(mem_ctx, type, elem, array, num, size) \
 318         add_to_large_array((mem_ctx), sizeof(type), &(elem), (void *)(array), (num), (size));
 319
 320 #define trans_oob(bufsize, offset, length) \
 321         smb_buffer_oob(bufsize, offset, length)
 322
 323 #endif /* _SMB_MACROS_H */