Provide safer string copy than strncpy
[openjpeg.git] / src / bin / common / opj_string.h
1 /*
2  * The copyright in this software is being made available under the 2-clauses
3  * BSD License, included below. This software may be subject to other third
4  * party and contributor rights, including patent rights, and no such rights
5  * are granted under this license.
6  *
7  * Copyright (c) 2015, Matthieu Darbois
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #ifndef OPJ_STRING_H
33 #define OPJ_STRING_H
34
35 #include <errno.h>
36 #include <string.h>
37
38 /* strnlen is not standard, strlen_s is C11... */
39 /* keep in mind there still is a buffer read overflow possible */
40 static size_t opj_strnlen_s(const char *src, size_t max_len)
41 {
42         size_t len;
43         
44         if (src == NULL) {
45                 return 0U;
46         }
47         for (len = 0U; (*src != '\0') && (len < max_len); src++, len++);
48         return len;
49 }
50
51 /* should be equivalent to C11 function except for the handler */
52 /* keep in mind there still is a buffer read overflow possible */
53 static int opj_strcpy_s(char* dst, size_t dst_size, const char* src)
54 {
55         size_t src_len = 0U;
56         if ((dst == NULL) || (dst_size == 0U)) {
57                 return EINVAL;
58         }
59         if (src == NULL) {
60                 dst[0] = '\0';
61                 return EINVAL;
62         }
63         src_len = opj_strnlen_s(src, dst_size);
64         if (src_len >= dst_size) {
65                 return ERANGE;
66         }
67         memcpy(dst, src, src_len);
68         dst[src_len] = '\0';
69         return 0;
70 }
71
72 #endif /* OPJ_STRING_H */