├── .gitattributes ├── .gitignore ├── README.md ├── StringTests.cpp ├── StringTests.sln ├── StringTests.vcxproj ├── StringTests.vcxproj.filters └── enc_temp_folder └── e0e682bd41bfb7dc9b51343233543b7 └── StringTests.cpp /.gitattributes: -------------------------------------------------------------------------------- 1 | ############################################################################### 2 | # Set default behavior to automatically normalize line endings. 3 | ############################################################################### 4 | * text=auto 5 | 6 | ############################################################################### 7 | # Set default behavior for command prompt diff. 8 | # 9 | # This is need for earlier builds of msysgit that does not have it on by 10 | # default for csharp files. 11 | # Note: This is only used by command line 12 | ############################################################################### 13 | #*.cs diff=csharp 14 | 15 | ############################################################################### 16 | # Set the merge driver for project and solution files 17 | # 18 | # Merging from the command prompt will add diff markers to the files if there 19 | # are conflicts (Merging from VS is not affected by the settings below, in VS 20 | # the diff markers are never inserted). Diff markers may cause the following 21 | # file extensions to fail to load in VS. An alternative would be to treat 22 | # these files as binary and thus will always conflict and require user 23 | # intervention with every merge. To do so, just uncomment the entries below 24 | ############################################################################### 25 | #*.sln merge=binary 26 | #*.csproj merge=binary 27 | #*.vbproj merge=binary 28 | #*.vcxproj merge=binary 29 | #*.vcproj merge=binary 30 | #*.dbproj merge=binary 31 | #*.fsproj merge=binary 32 | #*.lsproj merge=binary 33 | #*.wixproj merge=binary 34 | #*.modelproj merge=binary 35 | #*.sqlproj merge=binary 36 | #*.wwaproj merge=binary 37 | 38 | ############################################################################### 39 | # behavior for image files 40 | # 41 | # image files are treated as binary by default. 42 | ############################################################################### 43 | #*.jpg binary 44 | #*.png binary 45 | #*.gif binary 46 | 47 | ############################################################################### 48 | # diff behavior for common document formats 49 | # 50 | # Convert binary document formats to text before diffing them. This feature 51 | # is only available from the command line. Turn it on by uncommenting the 52 | # entries below. 53 | ############################################################################### 54 | #*.doc diff=astextplain 55 | #*.DOC diff=astextplain 56 | #*.docx diff=astextplain 57 | #*.DOCX diff=astextplain 58 | #*.dot diff=astextplain 59 | #*.DOT diff=astextplain 60 | #*.pdf diff=astextplain 61 | #*.PDF diff=astextplain 62 | #*.rtf diff=astextplain 63 | #*.RTF diff=astextplain 64 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Ww][Ii][Nn]32/ 27 | [Aa][Rr][Mm]/ 28 | [Aa][Rr][Mm]64/ 29 | bld/ 30 | [Bb]in/ 31 | [Oo]bj/ 32 | [Oo]ut/ 33 | [Ll]og/ 34 | [Ll]ogs/ 35 | 36 | # Visual Studio 2015/2017 cache/options directory 37 | .vs/ 38 | # Uncomment if you have tasks that create the project's static files in wwwroot 39 | #wwwroot/ 40 | 41 | # Visual Studio 2017 auto generated files 42 | Generated\ Files/ 43 | 44 | # MSTest test Results 45 | [Tt]est[Rr]esult*/ 46 | [Bb]uild[Ll]og.* 47 | 48 | # NUnit 49 | *.VisualState.xml 50 | TestResult.xml 51 | nunit-*.xml 52 | 53 | # Build Results of an ATL Project 54 | [Dd]ebugPS/ 55 | [Rr]eleasePS/ 56 | dlldata.c 57 | 58 | # Benchmark Results 59 | BenchmarkDotNet.Artifacts/ 60 | 61 | # .NET Core 62 | project.lock.json 63 | project.fragment.lock.json 64 | artifacts/ 65 | 66 | # ASP.NET Scaffolding 67 | ScaffoldingReadMe.txt 68 | 69 | # StyleCop 70 | StyleCopReport.xml 71 | 72 | # Files built by Visual Studio 73 | *_i.c 74 | *_p.c 75 | *_h.h 76 | *.ilk 77 | *.meta 78 | *.obj 79 | *.iobj 80 | *.pch 81 | *.pdb 82 | *.ipdb 83 | *.pgc 84 | *.pgd 85 | *.rsp 86 | *.sbr 87 | *.tlb 88 | *.tli 89 | *.tlh 90 | *.tmp 91 | *.tmp_proj 92 | *_wpftmp.csproj 93 | *.log 94 | *.vspscc 95 | *.vssscc 96 | .builds 97 | *.pidb 98 | *.svclog 99 | *.scc 100 | 101 | # Chutzpah Test files 102 | _Chutzpah* 103 | 104 | # Visual C++ cache files 105 | ipch/ 106 | *.aps 107 | *.ncb 108 | *.opendb 109 | *.opensdf 110 | *.sdf 111 | *.cachefile 112 | *.VC.db 113 | *.VC.VC.opendb 114 | 115 | # Visual Studio profiler 116 | *.psess 117 | *.vsp 118 | *.vspx 119 | *.sap 120 | 121 | # Visual Studio Trace Files 122 | *.e2e 123 | 124 | # TFS 2012 Local Workspace 125 | $tf/ 126 | 127 | # Guidance Automation Toolkit 128 | *.gpState 129 | 130 | # ReSharper is a .NET coding add-in 131 | _ReSharper*/ 132 | *.[Rr]e[Ss]harper 133 | *.DotSettings.user 134 | 135 | # TeamCity is a build add-in 136 | _TeamCity* 137 | 138 | # DotCover is a Code Coverage Tool 139 | *.dotCover 140 | 141 | # AxoCover is a Code Coverage Tool 142 | .axoCover/* 143 | !.axoCover/settings.json 144 | 145 | # Coverlet is a free, cross platform Code Coverage Tool 146 | coverage*.json 147 | coverage*.xml 148 | coverage*.info 149 | 150 | # Visual Studio code coverage results 151 | *.coverage 152 | *.coveragexml 153 | 154 | # NCrunch 155 | _NCrunch_* 156 | .*crunch*.local.xml 157 | nCrunchTemp_* 158 | 159 | # MightyMoose 160 | *.mm.* 161 | AutoTest.Net/ 162 | 163 | # Web workbench (sass) 164 | .sass-cache/ 165 | 166 | # Installshield output folder 167 | [Ee]xpress/ 168 | 169 | # DocProject is a documentation generator add-in 170 | DocProject/buildhelp/ 171 | DocProject/Help/*.HxT 172 | DocProject/Help/*.HxC 173 | DocProject/Help/*.hhc 174 | DocProject/Help/*.hhk 175 | DocProject/Help/*.hhp 176 | DocProject/Help/Html2 177 | DocProject/Help/html 178 | 179 | # Click-Once directory 180 | publish/ 181 | 182 | # Publish Web Output 183 | *.[Pp]ublish.xml 184 | *.azurePubxml 185 | # Note: Comment the next line if you want to checkin your web deploy settings, 186 | # but database connection strings (with potential passwords) will be unencrypted 187 | *.pubxml 188 | *.publishproj 189 | 190 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 191 | # checkin your Azure Web App publish settings, but sensitive information contained 192 | # in these scripts will be unencrypted 193 | PublishScripts/ 194 | 195 | # NuGet Packages 196 | *.nupkg 197 | # NuGet Symbol Packages 198 | *.snupkg 199 | # The packages folder can be ignored because of Package Restore 200 | **/[Pp]ackages/* 201 | # except build/, which is used as an MSBuild target. 202 | !**/[Pp]ackages/build/ 203 | # Uncomment if necessary however generally it will be regenerated when needed 204 | #!**/[Pp]ackages/repositories.config 205 | # NuGet v3's project.json files produces more ignorable files 206 | *.nuget.props 207 | *.nuget.targets 208 | 209 | # Microsoft Azure Build Output 210 | csx/ 211 | *.build.csdef 212 | 213 | # Microsoft Azure Emulator 214 | ecf/ 215 | rcf/ 216 | 217 | # Windows Store app package directories and files 218 | AppPackages/ 219 | BundleArtifacts/ 220 | Package.StoreAssociation.xml 221 | _pkginfo.txt 222 | *.appx 223 | *.appxbundle 224 | *.appxupload 225 | 226 | # Visual Studio cache files 227 | # files ending in .cache can be ignored 228 | *.[Cc]ache 229 | # but keep track of directories ending in .cache 230 | !?*.[Cc]ache/ 231 | 232 | # Others 233 | ClientBin/ 234 | ~$* 235 | *~ 236 | *.dbmdl 237 | *.dbproj.schemaview 238 | *.jfm 239 | *.pfx 240 | *.publishsettings 241 | orleans.codegen.cs 242 | 243 | # Including strong name files can present a security risk 244 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 245 | #*.snk 246 | 247 | # Since there are multiple workflows, uncomment next line to ignore bower_components 248 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 249 | #bower_components/ 250 | 251 | # RIA/Silverlight projects 252 | Generated_Code/ 253 | 254 | # Backup & report files from converting an old project file 255 | # to a newer Visual Studio version. Backup files are not needed, 256 | # because we have git ;-) 257 | _UpgradeReport_Files/ 258 | Backup*/ 259 | UpgradeLog*.XML 260 | UpgradeLog*.htm 261 | ServiceFabricBackup/ 262 | *.rptproj.bak 263 | 264 | # SQL Server files 265 | *.mdf 266 | *.ldf 267 | *.ndf 268 | 269 | # Business Intelligence projects 270 | *.rdl.data 271 | *.bim.layout 272 | *.bim_*.settings 273 | *.rptproj.rsuser 274 | *- [Bb]ackup.rdl 275 | *- [Bb]ackup ([0-9]).rdl 276 | *- [Bb]ackup ([0-9][0-9]).rdl 277 | 278 | # Microsoft Fakes 279 | FakesAssemblies/ 280 | 281 | # GhostDoc plugin setting file 282 | *.GhostDoc.xml 283 | 284 | # Node.js Tools for Visual Studio 285 | .ntvs_analysis.dat 286 | node_modules/ 287 | 288 | # Visual Studio 6 build log 289 | *.plg 290 | 291 | # Visual Studio 6 workspace options file 292 | *.opt 293 | 294 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 295 | *.vbw 296 | 297 | # Visual Studio LightSwitch build output 298 | **/*.HTMLClient/GeneratedArtifacts 299 | **/*.DesktopClient/GeneratedArtifacts 300 | **/*.DesktopClient/ModelManifest.xml 301 | **/*.Server/GeneratedArtifacts 302 | **/*.Server/ModelManifest.xml 303 | _Pvt_Extensions 304 | 305 | # Paket dependency manager 306 | .paket/paket.exe 307 | paket-files/ 308 | 309 | # FAKE - F# Make 310 | .fake/ 311 | 312 | # CodeRush personal settings 313 | .cr/personal 314 | 315 | # Python Tools for Visual Studio (PTVS) 316 | __pycache__/ 317 | *.pyc 318 | 319 | # Cake - Uncomment if you are using it 320 | # tools/** 321 | # !tools/packages.config 322 | 323 | # Tabs Studio 324 | *.tss 325 | 326 | # Telerik's JustMock configuration file 327 | *.jmconfig 328 | 329 | # BizTalk build output 330 | *.btp.cs 331 | *.btm.cs 332 | *.odx.cs 333 | *.xsd.cs 334 | 335 | # OpenCover UI analysis results 336 | OpenCover/ 337 | 338 | # Azure Stream Analytics local run output 339 | ASALocalRun/ 340 | 341 | # MSBuild Binary and Structured Log 342 | *.binlog 343 | 344 | # NVidia Nsight GPU debugger configuration file 345 | *.nvuser 346 | 347 | # MFractors (Xamarin productivity tool) working folder 348 | .mfractor/ 349 | 350 | # Local History for Visual Studio 351 | .localhistory/ 352 | 353 | # BeatPulse healthcheck temp database 354 | healthchecksdb 355 | 356 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 357 | MigrationBackup/ 358 | 359 | # Ionide (cross platform F# VS Code tools) working folder 360 | .ionide/ 361 | 362 | # Fody - auto-generated XML schema 363 | FodyWeavers.xsd -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SafeStrings 2 | 3 | Demos the proper use of C safe strings. This project is intended to accompany a YouTube video on the Dave's Garage showing how to use the safe string functions. 4 | -------------------------------------------------------------------------------- /StringTests.cpp: -------------------------------------------------------------------------------- 1 | //-------------------------------------------------------------------------------- 2 | // String String Function Demo - (c) 2021 Plummer's Software LLC DBA Dave's Garage 3 | //-------------------------------------------------------------------------------- 4 | // 5 | // Provided under the GPL Gnu Public License 2.0 6 | // 7 | // This code is intended to accompany the "Safe C String" video. It demonstrates 8 | // how to replace older usafe string functions that lack bounds and buffer checks 9 | // with more modern replacements intended for a hostile world. 10 | // 11 | // String Function Replacement Cheat Sheet 12 | // ======================================= 13 | // 14 | // Olden Days Hipsters 15 | // -------------------------------- 16 | // strlen -> strnlen_s 17 | // strcpy -> strcpy_s 18 | // strcat -> strcat_s 19 | // sprintf -> _snprintf_s 20 | // vsprintf -> vsnprintf_s 21 | // makepath -> _makepath_s 22 | // _splitpath -> _splitpath_s 23 | // scanf / sscanf -> sscanf_s 24 | // snscanf -> _snscanf_s 25 | // gets -> gets_s 26 | // 27 | // 8/24/2001 Davepl Created 28 | // 29 | //-------------------------------------------------------------------------------- 30 | 31 | #include 32 | #include 33 | #include 34 | #include 35 | #include 36 | #include 37 | #include 38 | 39 | // Forward declarations of functions that are defined after main 40 | 41 | void TestVarArgs(char *, size_t, const char*, ...); 42 | void TurnOffAsserts(); 43 | 44 | // main 45 | // 46 | // Entry point. Calls each string function properly as a quick demo 47 | // of how each of the "safe" string functions can be used. 48 | 49 | int main(int argc, char * argv []) 50 | { 51 | // Turns off the Abort/Retry/Fail dialog on parameter validation 52 | // failures and sets up an "ignore" handler for such events. 53 | 54 | TurnOffAsserts(); 55 | 56 | // Declare a too-small output buffer and a source string that is 57 | // too big to fit, which we shall use to test our failure cases 58 | 59 | char szBuffer[16]; 60 | const char szLongString[] = "This is a long string which is almost " 61 | "assuredly too big to fit into szBuffer."; 62 | // strlen -> strnlen_s 63 | // 64 | // What's Up: strlen doesn't let you say how long it should try. 65 | // strlen also blows up on a null ptr 66 | // 67 | // strlen_s let's you specify an upper bound on length 68 | // and it returns 0 if you pass it a null pointer 69 | 70 | int length1 = strnlen_s(szLongString, sizeof szLongString); 71 | 72 | // Quick test to confirm that passind null is ok 73 | 74 | assert(0 == strnlen_s(nullptr, RSIZE_MAX)); 75 | 76 | // strcpy -> strcpy_s 77 | // 78 | // What's Up: strcpy doesn't let you specify a max out buf length 79 | // 80 | // This would crash: strcpy(szBuffer, szLongString); 81 | // 82 | // strcpy_s allows you to specify the buffer size limit. When this 83 | // does not fit, it will call the paramter validation handler. 84 | 85 | strcpy_s(szBuffer, sizeof szBuffer, szLongString); 86 | 87 | // strcat -> strcat_s 88 | // 89 | // Same deal - We need to be able to specify the length. The following 90 | // can happen and will call the constraint handler: 91 | // 92 | // - src or dest is a null pointer 93 | // - destsz is zero or greater than max size 94 | // - there is no null terminator in the first destsz bytes of dest 95 | // - truncation would occur (can't fit src plus a nul terminator) 96 | 97 | strcat_s(szBuffer, sizeof szBuffer, szLongString); 98 | 99 | // sprintf -> snprintf_s 100 | // 101 | // Allows you to specify the buffer size and it detects the following 102 | // conditions at runtime, calling the constraint handler as appropriate. 103 | // 104 | // - %n is present 105 | // - any of the %s args is a null ptr 106 | // - format or buffer is a null pointer 107 | // - buffer size is zero or greater than RSIZE_MAX 108 | // - any encoding errors during formatting 109 | // - too long of a string in total 110 | 111 | _snprintf_s(szBuffer, sizeof szBuffer, "%s", szLongString); 112 | 113 | // makepath -> _makepath_s 114 | // 115 | // Allows you to specify the maximum size of the output buffer 116 | 117 | _makepath_s(szBuffer, sizeof szBuffer, "C", "\\foo", "bar", "txt"); 118 | 119 | // splitpath -> _splitpath_s 120 | // 121 | // Allows you to specify the size of each path component 122 | 123 | char szDrive [_MAX_DRIVE]; 124 | char szFolder[_MAX_DIR]; 125 | char szFile [_MAX_FNAME]; 126 | char szExt [_MAX_EXT]; 127 | 128 | _splitpath_s(szBuffer, 129 | szDrive, sizeof szDrive, 130 | szFolder, sizeof szFolder, 131 | szFile, sizeof szFile, 132 | szExt, sizeof szExt); 133 | 134 | // scanf/sscanf -> sscanf_s 135 | // 136 | // Allows you to specify the max size for each path component that 137 | // will be extrated from the string 138 | 139 | char szFolderOut[_MAX_DIR]; 140 | 141 | // sscanf_s(szBuffer, "%s", szFolderOut, sizeof szFolderOut); 142 | 143 | // snscanf -> _snscanf_s 144 | // 145 | // Allows you to pass a length specifier for each component that 146 | // you scan out of the main string 147 | 148 | // Make sure these all start out as empty strings 149 | 150 | char szWord1[16]; 151 | char szWord2[16]; 152 | char szWord3[16]; 153 | char szWord4[16]; 154 | 155 | _snscanf_s(szLongString, sizeof szLongString, 156 | "%s %s %s %s", 157 | szWord1, sizeof szWord1, 158 | szWord2, sizeof szWord2, 159 | szWord3, sizeof szWord3, 160 | szWord4, sizeof szWord4 161 | ); 162 | 163 | // vsprintf -> vsnprintf_s 164 | 165 | TestVarArgs(szBuffer, sizeof szBuffer, "%s", szLongString); 166 | 167 | // gets -> gets_s 168 | // 169 | // Allows you to specify the max buffer length and then writes at 170 | // most N-1 chars to it, plus the null terminator. Watches for 171 | // and throws on the following exceptional cases: 172 | // 173 | // - n is zero 174 | // - n is greater than RSIZE_MAX 175 | // - string is a null pointer 176 | // - Reached n-1 chars without EOL or EOF being hit yet 177 | 178 | puts("Press ENTER to continue."); 179 | gets_s(szBuffer, sizeof szBuffer); 180 | } 181 | 182 | // TestVarArgs 183 | // 184 | // Show use of vsnprintf_s, which takes a va_list, so we need a function 185 | // with a variable number of args to 'demo' it. 186 | 187 | void TestVarArgs(char * buffer, size_t cb, const char* format, ...) 188 | { 189 | // vsprintf -> vsnprintf_s 190 | // 191 | // Allows you to specify the buffer size and it detects the following 192 | // conditions at runtime, calling the constraint handler as appropriate. 193 | // 194 | // - %n is present 195 | // - any of the %s args is a null ptr 196 | // - format or buffer is a null pointer 197 | // - buffer size is zero or greater than RSIZE_MAX 198 | // - any encoding errors during formatting 199 | // - too long of a string in total 200 | // 201 | // vsnprintf_s(szBuffer, sizeof szBuffer, "%s", args1); 202 | 203 | va_list args; 204 | va_start(args, format); 205 | vsnprintf_s(buffer, cb, _TRUNCATE, format, args); 206 | va_end(args); 207 | } 208 | 209 | // I don't normally do the Unicode dance anymore, but dealing with 210 | // Microsoft proprietary stuff, I do it thierway, like so: 211 | 212 | void OurParameterValidationFailureHandler( 213 | const wchar_t * expression, 214 | const wchar_t * function, 215 | const wchar_t * file, 216 | unsigned int line, 217 | uintptr_t pReserved) 218 | { 219 | wprintf_s(L"Bad Mojo! The invalid parameter handler has been " 220 | L"called in %snFunction:%snFile:%snLine:%un", 221 | expression, function, file, line); 222 | } 223 | 224 | // TurnOffAsserts 225 | // 226 | // For MSVC, this will turn off the Abort/Retry/Fail dialog that you would 227 | // normally get for a failed assertion, which is how parameter validation 228 | // failures manifest themselves on Debug builds. 229 | 230 | void TurnOffAsserts() 231 | { 232 | // Prevent showing "debug assertion failed" dialog box, since we'll be 233 | // handling any such errors and continuing. 234 | 235 | _CrtSetReportMode(_CRT_ASSERT, 0); 236 | 237 | // The CRT now provides runtime checks when you're using the _s versions 238 | // of the string functions. Normally if something is amiss it will just 239 | // exit, but if you want to continue, you need to handle it yourself 240 | // by specifying your own handler function as follows: 241 | 242 | _set_invalid_parameter_handler(OurParameterValidationFailureHandler); 243 | } 244 | -------------------------------------------------------------------------------- /StringTests.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.31112.23 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "StringTests", "StringTests.vcxproj", "{3BFA784B-6773-403C-8BE4-C3FAF419F3E2}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|x64 = Debug|x64 11 | Debug|x86 = Debug|x86 12 | Release|x64 = Release|x64 13 | Release|x86 = Release|x86 14 | EndGlobalSection 15 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 16 | {3BFA784B-6773-403C-8BE4-C3FAF419F3E2}.Debug|x64.ActiveCfg = Debug|x64 17 | {3BFA784B-6773-403C-8BE4-C3FAF419F3E2}.Debug|x64.Build.0 = Debug|x64 18 | {3BFA784B-6773-403C-8BE4-C3FAF419F3E2}.Debug|x86.ActiveCfg = Debug|Win32 19 | {3BFA784B-6773-403C-8BE4-C3FAF419F3E2}.Debug|x86.Build.0 = Debug|Win32 20 | {3BFA784B-6773-403C-8BE4-C3FAF419F3E2}.Release|x64.ActiveCfg = Release|x64 21 | {3BFA784B-6773-403C-8BE4-C3FAF419F3E2}.Release|x64.Build.0 = Release|x64 22 | {3BFA784B-6773-403C-8BE4-C3FAF419F3E2}.Release|x86.ActiveCfg = Release|Win32 23 | {3BFA784B-6773-403C-8BE4-C3FAF419F3E2}.Release|x86.Build.0 = Release|Win32 24 | EndGlobalSection 25 | GlobalSection(SolutionProperties) = preSolution 26 | HideSolutionNode = FALSE 27 | EndGlobalSection 28 | GlobalSection(ExtensibilityGlobals) = postSolution 29 | SolutionGuid = {4A886031-CF76-4FFC-903C-FD4C6A86BE65} 30 | EndGlobalSection 31 | EndGlobal 32 | -------------------------------------------------------------------------------- /StringTests.vcxproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Debug 6 | Win32 7 | 8 | 9 | Release 10 | Win32 11 | 12 | 13 | Debug 14 | x64 15 | 16 | 17 | Release 18 | x64 19 | 20 | 21 | 22 | 16.0 23 | Win32Proj 24 | {3bfa784b-6773-403c-8be4-c3faf419f3e2} 25 | StringTests 26 | 10.0 27 | 28 | 29 | 30 | Application 31 | true 32 | v142 33 | Unicode 34 | 35 | 36 | Application 37 | false 38 | v142 39 | true 40 | Unicode 41 | 42 | 43 | Application 44 | true 45 | v142 46 | Unicode 47 | 48 | 49 | Application 50 | false 51 | v142 52 | true 53 | Unicode 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | true 75 | 76 | 77 | false 78 | 79 | 80 | true 81 | 82 | 83 | false 84 | 85 | 86 | 87 | Level3 88 | true 89 | WIN32;_DEBUG;_CONSOLE;%(PreprocessorDefinitions) 90 | true 91 | stdc17 92 | 93 | 94 | Console 95 | true 96 | 97 | 98 | 99 | 100 | Level3 101 | true 102 | true 103 | true 104 | WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions) 105 | true 106 | 107 | 108 | Console 109 | true 110 | true 111 | true 112 | 113 | 114 | 115 | 116 | Level3 117 | true 118 | _DEBUG;_CONSOLE;%(PreprocessorDefinitions) 119 | true 120 | 121 | 122 | Console 123 | true 124 | 125 | 126 | 127 | 128 | Level3 129 | true 130 | true 131 | true 132 | NDEBUG;_CONSOLE;%(PreprocessorDefinitions) 133 | true 134 | 135 | 136 | Console 137 | true 138 | true 139 | true 140 | 141 | 142 | 143 | 144 | 145 | 146 | 147 | 148 | -------------------------------------------------------------------------------- /StringTests.vcxproj.filters: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | 5 | {4FC737F1-C7A5-4376-A066-2A32D752A2FF} 6 | cpp;c;cc;cxx;c++;cppm;ixx;def;odl;idl;hpj;bat;asm;asmx 7 | 8 | 9 | {93995380-89BD-4b04-88EB-625FBE52EBFB} 10 | h;hh;hpp;hxx;h++;hm;inl;inc;ipp;xsd 11 | 12 | 13 | {67DA6AB6-F800-4c08-8B7A-83BB121AAD01} 14 | rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms 15 | 16 | 17 | 18 | 19 | Source Files 20 | 21 | 22 | -------------------------------------------------------------------------------- /enc_temp_folder/e0e682bd41bfb7dc9b51343233543b7/StringTests.cpp: -------------------------------------------------------------------------------- 1 | //-------------------------------------------------------------------------------- 2 | // String String Function Demo - (c) 2021 Plummer's Software LLC DBA Dave's Garage 3 | //-------------------------------------------------------------------------------- 4 | // 5 | // Provided under the GPL Gnu Public License 2.0 6 | // 7 | // This code is intended to accompany the "Safe C String" video. It demonstrates 8 | // how to replace older usafe string functions that lack bounds and buffer checks 9 | // with more modern replacements intended for a hostile world. 10 | // 11 | // String Function Replacement Cheat Sheet 12 | // ======================================= 13 | // 14 | // Olden Days Hipsters 15 | // -------------------------------- 16 | // strlen -> strnlen_s 17 | // strcpy -> strcpy_s 18 | // strcat -> strcat_s 19 | // sprintf -> _snprintf_s 20 | // vsprintf -> vsnprintf_s 21 | // makepath -> _makepath_s 22 | // _splitpath -> _splitpath_s 23 | // scanf / sscanf -> sscanf_s 24 | // snscanf -> _snscanf_s 25 | // gets -> gets_s 26 | // 27 | // 8/24/2001 Davepl Created 28 | // 29 | //-------------------------------------------------------------------------------- 30 | 31 | #include 32 | #include 33 | #include 34 | #include 35 | #include 36 | #include 37 | #include 38 | 39 | // Forward declarations of functions that are defined after main 40 | 41 | void TestVarArgs(char *, size_t, const char*, ...); 42 | void TurnOffAsserts(); 43 | 44 | // main 45 | // 46 | // Entry point. Calls each string function properly as a quick demo 47 | // of how each of the "safe" string functions can be used. 48 | 49 | int main(int argc, char * argv []) 50 | { 51 | // Turns off the Abort/Retry/Fail dialog on parameter validation 52 | // failures and sets up an "ignore" handler for such events. 53 | 54 | TurnOffAsserts(); 55 | 56 | // Declare a too-small output buffer and a source string that is 57 | // too big to fit, which we shall use to test our failure cases 58 | 59 | char szBuffer[16]; 60 | const char szLongString[] = "This is a long string which is almost " 61 | "assuredly too big to fit into szBuffer."; 62 | // strlen -> strnlen_s 63 | // 64 | // What's Up: strlen doesn't let you say how long it should try. 65 | // strlen also blows up on a null ptr 66 | // 67 | // strlen_s let's you specify an upper bound on length 68 | // and it returns 0 if you pass it a null pointer 69 | 70 | int length1 = strnlen_s(szLongString, sizeof szLongString); 71 | 72 | // Quick test to confirm that passind null is ok 73 | 74 | assert(0 == strnlen_s(nullptr, RSIZE_MAX)); 75 | 76 | // strcpy -> strcpy_s 77 | // 78 | // What's Up: strcpy doesn't let you specify a max out buf length 79 | // 80 | // This would crash: strcpy(szBuffer, szLongString); 81 | // 82 | // strcpy_s allows you to specify the buffer size limit. When this 83 | // does not fit, it will call the paramter validation handler. 84 | 85 | strcpy_s(szBuffer, sizeof szBuffer, szLongString); 86 | 87 | // strcat -> strcat_s 88 | // 89 | // Same deal - We need to be able to specify the length. The following 90 | // can happen and will call the constraint handler: 91 | // 92 | // - src or dest is a null pointer 93 | // - destsz is zero or greater than max size 94 | // - there is no null terminator in the first destsz bytes of dest 95 | // - truncation would occur (can't fit src plus a nul terminator) 96 | 97 | strcat_s(szBuffer, sizeof szBuffer, szLongString); 98 | 99 | // sprintf -> snprintf_s 100 | // 101 | // Allows you to specify the buffer size and it detects the following 102 | // conditions at runtime, calling the constraint handler as appropriate. 103 | // 104 | // - %n is present 105 | // - any of the %s args is a null ptr 106 | // - format or buffer is a null pointer 107 | // - buffer size is zero or greater than RSIZE_MAX 108 | // - any encoding errors during formatting 109 | // - too long of a string in total 110 | 111 | _snprintf_s(szBuffer, sizeof szBuffer, "%s", szLongString); 112 | 113 | // vsprintf -> vsnprintf_s 114 | 115 | TestVarArgs(szBuffer, sizeof szBuffer, "%s", szLongString); 116 | 117 | // makepath -> _makepath_s 118 | // 119 | // Allows you to specify the maximum size of the output buffer 120 | 121 | _makepath_s(szBuffer, sizeof szBuffer, "C", "\\foo", "bar", "txt"); 122 | 123 | // splitpath -> _splitpath_s 124 | // 125 | // Allows you to specify the size of each path component 126 | 127 | char szDrive [_MAX_DRIVE]; 128 | char szFolder[_MAX_DIR]; 129 | char szFile [_MAX_FNAME]; 130 | char szExt [_MAX_EXT]; 131 | 132 | _splitpath_s(szBuffer, 133 | szDrive, sizeof szDrive, 134 | szFolder, sizeof szFolder, 135 | szFile, sizeof szFile, 136 | szExt, sizeof szExt); 137 | 138 | // scanf/sscanf -> sscanf_s 139 | // 140 | // Allows you to specify the max size for each path component that 141 | // will be extrated from the string 142 | 143 | char szFolderOut[_MAX_DIR]; 144 | 145 | // sscanf_s(szBuffer, "%s", szFolderOut, sizeof szFolderOut); 146 | 147 | // snscanf -> _snscanf_s 148 | // 149 | // Allows you to pass a length specifier for each component that 150 | // you scan out of the main string 151 | 152 | // Make sure these all start out as empty strings 153 | 154 | char szWord1[16]; 155 | char szWord2[16]; 156 | char szWord3[16]; 157 | char szWord4[16]; 158 | 159 | _snscanf_s(szLongString, sizeof szLongString, 160 | "%s %s %s %s", 161 | szWord1, sizeof szWord1, 162 | szWord2, sizeof szWord2, 163 | szWord3, sizeof szWord3, 164 | szWord4, sizeof szWord4 165 | ); 166 | 167 | // gets -> gets_s 168 | // 169 | // Allows you to specify the max buffer length and then writes at 170 | // most N-1 chars to it, plus the null terminator. Watches for 171 | // and throws on the following exceptional cases: 172 | // 173 | // - n is zero 174 | // - n is greater than RSIZE_MAX 175 | // - string is a null pointer 176 | // - Reached n-1 chars without EOL or EOF being hit yet 177 | 178 | puts("Press ENTER to continue."); 179 | gets_s(szBuffer, sizeof szBuffer); 180 | } 181 | 182 | // TestVarArgs 183 | // 184 | // Show use of vsnprintf_s, which takes a va_list, so we need a function 185 | // with a variable number of args to 'demo' it. 186 | 187 | void TestVarArgs(char * buffer, size_t cb, const char* format, ...) 188 | { 189 | // vsprintf -> vsnprintf_s 190 | // 191 | // Allows you to specify the buffer size and it detects the following 192 | // conditions at runtime, calling the constraint handler as appropriate. 193 | // 194 | // - %n is present 195 | // - any of the %s args is a null ptr 196 | // - format or buffer is a null pointer 197 | // - buffer size is zero or greater than RSIZE_MAX 198 | // - any encoding errors during formatting 199 | // - too long of a string in total 200 | // 201 | // vsnprintf_s(szBuffer, sizeof szBuffer, "%s", args1); 202 | 203 | va_list args; 204 | va_start(args, format); 205 | vsnprintf_s(buffer, cb, _TRUNCATE, format, args); 206 | va_end(args); 207 | } 208 | 209 | // I don't normally do the Unicode dance anymore, but dealing with 210 | // Microsoft proprietary stuff, I do it thierway, like so: 211 | 212 | void OurParameterValidationFailureHandler( 213 | const wchar_t * expression, 214 | const wchar_t * function, 215 | const wchar_t * file, 216 | unsigned int line, 217 | uintptr_t pReserved) 218 | { 219 | wprintf_s(L"Bad Mojo! The invalid parameter handler has been " 220 | L"called in %snFunction:%snFile:%snLine:%un", 221 | expression, function, file, line); 222 | } 223 | 224 | // TurnOffAsserts 225 | // 226 | // For MSVC, this will turn off the Abort/Retry/Fail dialog that you would 227 | // normally get for a failed assertion, which is how parameter validation 228 | // failures manifest themselves on Debug builds. 229 | 230 | void TurnOffAsserts() 231 | { 232 | // Prevent showing "debug assertion failed" dialog box, since we'll be 233 | // handling any such errors and continuing. 234 | 235 | _CrtSetReportMode(_CRT_ASSERT, 0); 236 | 237 | // The CRT now provides runtime checks when you're using the _s versions 238 | // of the string functions. Normally if something is amiss it will just 239 | // exit, but if you want to continue, you need to handle it yourself 240 | // by specifying your own handler function as follows: 241 | 242 | _set_invalid_parameter_handler(OurParameterValidationFailureHandler); 243 | } 244 | --------------------------------------------------------------------------------