fbcd4cf8ed74be9bdbf5dd8c4ccc9bbae56c2056
[dragonfly.git] / lib / libc / string / strlcpy.3
1 .\" $OpenBSD: strlcpy.3,v 1.5 1999/06/06 15:17:32 aaron Exp $
2 .\"
3 .\" Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com>
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. The name of the author may not be used to endorse or promote products
15 .\"    derived from this software without specific prior written permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
18 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
19 .\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
20 .\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21 .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23 .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
25 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
26 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD: src/lib/libc/string/strlcpy.3,v 1.4.2.8 2002/01/19 12:29:40 yar Exp $
29 .\" $DragonFly: src/lib/libc/string/strlcpy.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
30 .\"
31 .Dd June 22, 1998
32 .Dt STRLCPY 3
33 .Os
34 .Sh NAME
35 .Nm strlcpy ,
36 .Nm strlcat
37 .Nd size-bounded string copying and concatenation
38 .Sh LIBRARY
39 .Lb libc
40 .Sh SYNOPSIS
41 .In string.h
42 .Ft size_t
43 .Fn strlcpy "char *dst" "const char *src" "size_t size"
44 .Ft size_t
45 .Fn strlcat "char *dst" "const char *src" "size_t size"
46 .Sh DESCRIPTION
47 The
48 .Fn strlcpy
49 and
50 .Fn strlcat
51 functions copy and concatenate strings respectively.  They are designed
52 to be safer, more consistent, and less error prone replacements for
53 .Xr strncpy 3
54 and
55 .Xr strncat 3 .
56 Unlike those functions,
57 .Fn strlcpy
58 and
59 .Fn strlcat
60 take the full size of the buffer (not just the length) and guarantee to
61 NUL-terminate the result (as long as
62 .Fa size
63 is larger than 0 or, in the case of
64 .Fn strlcat ,
65 as long as there is at least one byte free in
66 .Fa dst ) .
67 Note that you should include a byte for the NUL in
68 .Fa size .
69 Also note that
70 .Fn strlcpy
71 and
72 .Fn strlcat
73 only operate on true
74 .Dq C
75 strings.
76 This means that for
77 .Fn strlcpy
78 .Fa src
79 must be NUL-terminated and for
80 .Fn strlcat
81 both
82 .Fa src
83 and
84 .Fa dst
85 must be NUL-terminated.
86 .Pp
87 The
88 .Fn strlcpy
89 function copies up to
90 .Fa size
91 - 1 characters from the NUL-terminated string
92 .Fa src
93 to
94 .Fa dst ,
95 NUL-terminating the result.
96 .Pp
97 The
98 .Fn strlcat
99 function appends the NUL-terminated string
100 .Fa src
101 to the end of
102 .Fa dst .
103 It will append at most
104 .Fa size
105 - strlen(dst) - 1 bytes, NUL-terminating the result.
106 .Sh RETURN VALUES
107 The
108 .Fn strlcpy
109 and
110 .Fn strlcat
111 functions return the total length of the string they tried to
112 create.  For
113 .Fn strlcpy
114 that means the length of
115 .Fa src .
116 For
117 .Fn strlcat
118 that means the initial length of
119 .Fa dst
120 plus
121 the length of
122 .Fa src .
123 While this may seem somewhat confusing it was done to make
124 truncation detection simple.
125 .Pp
126 Note however, that if
127 .Fn strlcat
128 traverses
129 .Fa size
130 characters without finding a NUL, the length of the string is considered
131 to be
132 .Fa size
133 and the destination string will not be NUL-terminated (since there was
134 no space for the NUL).
135 This keeps
136 .Fn strlcat
137 from running off the end of a string.
138 In practice this should not happen (as it means that either
139 .Fa size
140 is incorrect or that
141 .Fa dst
142 is not a proper
143 .Dq C
144 string).
145 The check exists to prevent potential security problems in incorrect code.
146 .Sh EXAMPLES
147 The following code fragment illustrates the simple case:
148 .Bd -literal -offset indent
149 char *s, *p, buf[BUFSIZ];
150
151 \&...
152
153 (void)strlcpy(buf, s, sizeof(buf));
154 (void)strlcat(buf, p, sizeof(buf));
155 .Ed
156 .Pp
157 To detect truncation, perhaps while building a pathname, something
158 like the following might be used:
159 .Bd -literal -offset indent
160 char *dir, *file, pname[MAXPATHLEN];
161
162 \&...
163
164 if (strlcpy(pname, dir, sizeof(pname)) >= sizeof(pname))
165         goto toolong;
166 if (strlcat(pname, file, sizeof(pname)) >= sizeof(pname))
167         goto toolong;
168 .Ed
169 .Pp
170 Since we know how many characters we copied the first time, we can
171 speed things up a bit by using a copy instead of an append:
172 .Bd -literal -offset indent
173 char *dir, *file, pname[MAXPATHLEN];
174 size_t n;
175
176 \&...
177
178 n = strlcpy(pname, dir, sizeof(pname));
179 if (n >= sizeof(pname))
180         goto toolong;
181 if (strlcpy(pname + n, file, sizeof(pname) - n) >= sizeof(pname) - n)
182         goto toolong;
183 .Ed
184 .Pp
185 However, one may question the validity of such optimizations, as they
186 defeat the whole purpose of
187 .Fn strlcpy
188 and
189 .Fn strlcat .
190 As a matter of fact, the first version of this manual page got it wrong.
191 .Sh SEE ALSO
192 .Xr snprintf 3 ,
193 .Xr strncat 3 ,
194 .Xr strncpy 3
195 .Sh HISTORY
196 .Fn strlcpy
197 and
198 .Fn strlcat
199 functions first appeared in
200 .Ox 2.4 ,
201 and made their appearance in
202 .Fx 3.3 .