source4/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 /* Some macros to ensure people don't use buffer overflow vulnerable string
  26    functions. */
  27
  28 #ifdef bcopy
  29 #undef bcopy
  30 #endif /* bcopy */
  31 #define bcopy(src,dest,size) __ERROR__XX__NEVER_USE_BCOPY___;
  32
  33 #ifdef strcpy
  34 #undef strcpy
  35 #endif /* strcpy */
  36 #define strcpy(dest,src) __ERROR__XX__NEVER_USE_STRCPY___;
  37
  38 #ifdef strcat
  39 #undef strcat
  40 #endif /* strcat */
  41 #define strcat(dest,src) __ERROR__XX__NEVER_USE_STRCAT___;
  42
  43 #ifdef sprintf
  44 #undef sprintf
  45 #endif /* sprintf */
  46 #define sprintf __ERROR__XX__NEVER_USE_SPRINTF__;
  47
  48 #endif /* !_SPLINT_ */
  49
  50 #define pstrcpy(d,s) safe_strcpy((d), (s),sizeof(pstring)-1)
  51 #define pstrcat(d,s) safe_strcat((d), (s),sizeof(pstring)-1)
  52 #define fstrcpy(d,s) safe_strcpy((d),(s),sizeof(fstring)-1)
  53 #define fstrcat(d,s) safe_strcat((d),(s),sizeof(fstring)-1)
  54
  55 /* replace some string functions with multi-byte
  56    versions */
  57 #define strlower(s) strlower_m(s)
  58 #define strupper(s) strupper_m(s)
  59
  60 /* the addition of the DEVELOPER checks in safe_strcpy means we must
  61  * update a lot of code. To make this a little easier here are some
  62  * functions that provide the lengths with less pain */
  63 #define pstrcpy_base(dest, src, pstring_base) \
  64     safe_strcpy(dest, src, sizeof(pstring)-PTR_DIFF(dest,pstring_base)-1)
  65
  66 #define push_pstring_base(dest, src, pstring_base) \
  67     push_ascii(dest, src, sizeof(pstring)-PTR_DIFF(dest,pstring_base)-1, STR_TERMINATE)
  68
  69 #endif