1 /*------------------------------------------------------------------
2  * safe_str_constraint.h
3  *
4  * October 2008, Bo Berry
5  *
6  * Copyright (c) 2008-2011 Cisco Systems
7  * All rights reserved.
8  *
9  * Permission is hereby granted, free of charge, to any person
10  * obtaining a copy of this software and associated documentation
11  * files (the "Software"), to deal in the Software without
12  * restriction, including without limitation the rights to use,
13  * copy, modify, merge, publish, distribute, sublicense, and/or
14  * sell copies of the Software, and to permit persons to whom the
15  * Software is furnished to do so, subject to the following
16  * conditions:
17  *
18  * The above copyright notice and this permission notice shall be
19  * included in all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
23  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
25  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
26  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28  * OTHER DEALINGS IN THE SOFTWARE.
29  *------------------------------------------------------------------
30  */
31 
32 #ifndef __SAFE_STR_CONSTRAINT_H__
33 #define __SAFE_STR_CONSTRAINT_H__
34 
35 #include "safeclib_private.h"
36 
37 /*
38  * Function used by the libraries to invoke the registered
39  * runtime-constraint handler. Always needed.
40  */
41 extern void invoke_safe_str_constraint_handler(const char *msg, void *ptr, errno_t error);
42 
43 /*
44  * Safe C Lib internal string routine to consolidate error handling
45  */
handle_error(char * orig_dest,rsize_t orig_dmax,char * err_msg,errno_t err_code)46 static inline void handle_error(char *orig_dest, rsize_t orig_dmax, char *err_msg,
47                                 errno_t err_code) {
48 #ifdef SAFECLIB_STR_NULL_SLACK
49     /* null string to eliminate partial copy */
50     while (orig_dmax) {
51         *orig_dest = '\0';
52         orig_dmax--;
53         orig_dest++;
54     }
55 #else
56     *orig_dest = '\0';
57 #endif
58 
59     invoke_safe_str_constraint_handler(err_msg, NULL, err_code);
60     return;
61 }
62 
handle_wc_error(wchar_t * orig_dest,rsize_t orig_dmax,char * err_msg,errno_t err_code)63 static inline void handle_wc_error(wchar_t *orig_dest, rsize_t orig_dmax, char *err_msg,
64                                    errno_t err_code) {
65 #ifdef SAFECLIB_STR_NULL_SLACK
66     /* null string to eliminate partial copy */
67     while (orig_dmax) {
68         *orig_dest = L'\0';
69         orig_dmax--;
70         orig_dest++;
71     }
72 #else
73     *orig_dest = L'\0';
74 #endif
75 
76     invoke_safe_str_constraint_handler(err_msg, NULL, err_code);
77     return;
78 }
79 
80 #endif /* __SAFE_STR_CONSTRAINT_H__ */
81