source3/include/safe_string.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Safe string handling routines.
   4    Copyright (C) Andrew Tridgell 1994-1998
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 #ifndef _SAFE_STRING_H
  22 #define _SAFE_STRING_H
  23
  24 #ifndef _SPLINT_ /* http://www.splint.org */
  25
  26 /* Some macros to ensure people don't use buffer overflow vulnerable string
  27    functions. */
  28
  29 #ifdef bcopy
  30 #undef bcopy
  31 #endif /* bcopy */
  32 #define bcopy(src,dest,size) __ERROR__XX__NEVER_USE_BCOPY___;
  33
  34 #ifdef strcpy
  35 #undef strcpy
  36 #endif /* strcpy */
  37 #define strcpy(dest,src) __ERROR__XX__NEVER_USE_STRCPY___;
  38
  39 #ifdef strcat
  40 #undef strcat
  41 #endif /* strcat */
  42 #define strcat(dest,src) __ERROR__XX__NEVER_USE_STRCAT___;
  43
  44 #ifdef sprintf
  45 #undef sprintf
  46 #endif /* sprintf */
  47 #define sprintf __ERROR__XX__NEVER_USE_SPRINTF__;
  48
  49 #endif /* !_SPLINT_ */
  50
  51 char * __unsafe_string_function_usage_here__(void);
  52
  53 #if 0 && defined __GNUC__ && __GNUC__ >= 2 && defined __OPTIMIZE__
  54
  55 #define pstrcpy(d,s) ((sizeof(d) != sizeof(pstring) && sizeof(d) != sizeof(char *)) ? __unsafe_string_function_usage_here__() : safe_strcpy((d), (s),sizeof(pstring)-1))
  56 #define pstrcat(d,s) ((sizeof(d) != sizeof(pstring) && sizeof(d) != sizeof(char *)) ? __unsafe_string_function_usage_here__() : safe_strcat((d), (s),sizeof(pstring)-1))
  57 #define fstrcpy(d,s) ((sizeof(d) != sizeof(fstring) && sizeof(d) != sizeof(char *)) ? __unsafe_string_function_usage_here__() : safe_strcpy((d),(s),sizeof(fstring)-1))
  58 #define fstrcat(d,s) ((sizeof(d) != sizeof(fstring) && sizeof(d) != sizeof(char *)) ? __unsafe_string_function_usage_here__() : safe_strcat((d),(s),sizeof(fstring)-1))
  59
  60 #define fstrterminate(d) ((sizeof(d) != sizeof(fstring) && sizeof(d) != sizeof(char *)) ? __unsafe_string_function_usage_here__() : (((d)[sizeof(fstring)-1]) = '\0'))
  61 #define pstrterminate(d) ((sizeof(d) != sizeof(pstring) && sizeof(d) != sizeof(char *)) ? __unsafe_string_function_usage_here__() : (((d)[sizeof(pstring)-1]) = '\0'))
  62
  63 #define wpstrcpy(d,s) ((sizeof(d) != sizeof(wpstring) && sizeof(d) != sizeof(smb_ucs2_t *)) ? __unsafe_string_function_usage_here__() : safe_strcpy_w((d),(s),sizeof(wpstring)))
  64 #define wpstrcat(d,s) ((sizeof(d) != sizeof(wpstring) && sizeof(d) != sizeof(smb_ucs2_t *)) ? __unsafe_string_function_usage_here__() : safe_strcat_w((d),(s),sizeof(wpstring)))
  65 #define wfstrcpy(d,s) ((sizeof(d) != sizeof(wfstring) && sizeof(d) != sizeof(smb_ucs2_t *)) ? __unsafe_string_function_usage_here__() : safe_strcpy_w((d),(s),sizeof(wfstring)))
  66 #define wfstrcat(d,s) ((sizeof(d) != sizeof(wfstring) && sizeof(d) != sizeof(smb_ucs2_t *)) ? __unsafe_string_function_usage_here__() : safe_strcat_w((d),(s),sizeof(wfstring)))
  67
  68 #else
  69
  70 #define pstrcpy(d,s) safe_strcpy((d), (s),sizeof(pstring)-1)
  71 #define pstrcat(d,s) safe_strcat((d), (s),sizeof(pstring)-1)
  72 #define fstrcpy(d,s) safe_strcpy((d),(s),sizeof(fstring)-1)
  73 #define fstrcat(d,s) safe_strcat((d),(s),sizeof(fstring)-1)
  74
  75 #define fstrterminate(d) (((d)[sizeof(fstring)-1]) = '\0')
  76 #define pstrterminate(d) (((d)[sizeof(pstring)-1]) = '\0')
  77
  78 #define wpstrcpy(d,s) safe_strcpy_w((d),(s),sizeof(wpstring))
  79 #define wpstrcat(d,s) safe_strcat_w((d),(s),sizeof(wpstring))
  80 #define wfstrcpy(d,s) safe_strcpy_w((d),(s),sizeof(wfstring))
  81 #define wfstrcat(d,s) safe_strcat_w((d),(s),sizeof(wfstring))
  82
  83 #endif
  84
  85 /* replace some string functions with multi-byte
  86    versions */
  87 #define strlower(s) strlower_m(s)
  88 #define strupper(s) strupper_m(s)
  89
  90 /* the addition of the DEVELOPER checks in safe_strcpy means we must
  91  * update a lot of code. To make this a little easier here are some
  92  * functions that provide the lengths with less pain */
  93 #define pstrcpy_base(dest, src, pstring_base) \
  94     safe_strcpy(dest, src, sizeof(pstring)-PTR_DIFF(dest,pstring_base)-1)
  95
  96 #define push_pstring_base(dest, src, pstring_base) \
  97     push_ascii(dest, src, sizeof(pstring)-PTR_DIFF(dest,pstring_base)-1, STR_TERMINATE)
  98
  99 #endif