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