man3/strcpy.3

   1 .\" Copyright (C) 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 18:06:49 1993 by Rik Faith (faith@cs.unc.edu)
  30 .\" Modified Fri Aug 25 23:17:51 1995 by Andries Brouwer (aeb@cwi.nl)
  31 .\" Modified Wed Dec 18 00:47:18 1996 by Andries Brouwer (aeb@cwi.nl)
  32 .\" 2007-06-15, Marc Boyer <marc.boyer@enseeiht.fr> + mtk
  33 .\"     Improve discussion of strncpy().
  34 .\"
  35 .TH STRCPY 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  36 .SH NAME
  37 strcpy, strncpy \- copy a string
  38 .SH SYNOPSIS
  39 .nf
  40 .B #include <string.h>
  41 .PP
  42 .BI "char *strcpy(char *restrict " dest ", const char *" src );
  43 .BI "char *strncpy(char *restrict " dest ", const char *restrict " src \
  44 ", size_t " n );
  45 .fi
  46 .SH DESCRIPTION
  47 The
  48 .BR strcpy ()
  49 function copies the string pointed to by
  50 .IR src ,
  51 including the terminating null byte (\(aq\e0\(aq),
  52 to the buffer pointed to by
  53 .IR dest .
  54 The strings may not overlap, and the destination string
  55 .I dest
  56 must be large enough to receive the copy.
  57 .IR "Beware of buffer overruns!"
  58 (See BUGS.)
  59 .PP
  60 The
  61 .BR strncpy ()
  62 function is similar, except that at most
  63 .I n
  64 bytes of
  65 .I src
  66 are copied.
  67 .BR Warning :
  68 If there is no null byte
  69 among the first
  70 .I n
  71 bytes of
  72 .IR src ,
  73 the string placed in
  74 .I dest
  75 will not be null-terminated.
  76 .PP
  77 If the length of
  78 .I src
  79 is less than
  80 .IR n ,
  81 .BR strncpy ()
  82 writes additional null bytes to
  83 .I dest
  84 to ensure that a total of
  85 .I n
  86 bytes are written.
  87 .PP
  88 A simple implementation of
  89 .BR strncpy ()
  90 might be:
  91 .PP
  92 .in +4n
  93 .EX
  94 char *
  95 strncpy(char *dest, const char *src, size_t n)
  96 {
  97     size_t i;
  98
  99     for (i = 0; i < n && src[i] != \(aq\e0\(aq; i++)
 100         dest[i] = src[i];
 101     for ( ; i < n; i++)
 102         dest[i] = \(aq\e0\(aq;
 103
 104     return dest;
 105 }
 106 .EE
 107 .in
 108 .SH RETURN VALUE
 109 The
 110 .BR strcpy ()
 111 and
 112 .BR strncpy ()
 113 functions return a pointer to
 114 the destination string
 115 .IR dest .
 116 .SH ATTRIBUTES
 117 For an explanation of the terms used in this section, see
 118 .BR attributes (7).
 119 .ad l
 120 .nh
 121 .TS
 122 allbox;
 123 lbx lb lb
 124 l l l.
 125 Interface       Attribute       Value
 126 T{
 127 .BR strcpy (),
 128 .BR strncpy ()
 129 T}      Thread safety   MT-Safe
 130 .TE
 131 .hy
 132 .ad
 133 .sp 1
 134 .SH CONFORMING TO
 135 POSIX.1-2001, POSIX.1-2008, C89, C99, SVr4, 4.3BSD.
 136 .SH NOTES
 137 Some programmers consider
 138 .BR strncpy ()
 139 to be inefficient and error prone.
 140 If the programmer knows (i.e., includes code to test!)
 141 that the size of
 142 .I dest
 143 is greater than
 144 the length of
 145 .IR src ,
 146 then
 147 .BR strcpy ()
 148 can be used.
 149 .PP
 150 One valid (and intended) use of
 151 .BR strncpy ()
 152 is to copy a C string to a fixed-length buffer
 153 while ensuring both that the buffer is not overflowed
 154 and that unused bytes in the destination buffer are zeroed out
 155 (perhaps to prevent information leaks if the buffer is to be
 156 written to media or transmitted to another process via an
 157 interprocess communication technique).
 158 .PP
 159 If there is no terminating null byte in the first
 160 .I n
 161 bytes of
 162 .IR src ,
 163 .BR strncpy ()
 164 produces an unterminated string in
 165 .IR dest .
 166 If
 167 .I buf
 168 has length
 169 .IR buflen ,
 170 you can force termination using something like the following:
 171 .PP
 172 .in +4n
 173 .EX
 174 if (buflen > 0) {
 175     strncpy(buf, str, buflen \- 1);
 176     buf[buflen \- 1]= \(aq\e0\(aq;
 177 }
 178 .EE
 179 .in
 180 .PP
 181 (Of course, the above technique ignores the fact that, if
 182 .I src
 183 contains more than
 184 .I "buflen\ \-\ 1"
 185 bytes, information is lost in the copying to
 186 .IR dest .)
 187 .\"
 188 .SS strlcpy()
 189 Some systems (the BSDs, Solaris, and others) provide the following function:
 190 .PP
 191     size_t strlcpy(char *dest, const char *src, size_t size);
 192 .PP
 193 .\" http://static.usenix.org/event/usenix99/full_papers/millert/millert_html/index.html
 194 .\"     "strlcpy and strlcat - consistent, safe, string copy and concatenation"
 195 .\"     1999 USENIX Annual Technical Conference
 196 This function is similar to
 197 .BR strncpy (),
 198 but it copies at most
 199 .I size\-1
 200 bytes to
 201 .IR dest ,
 202 always adds a terminating null byte,
 203 and does not pad the destination with (further) null bytes.
 204 This function fixes some of the problems of
 205 .BR strcpy ()
 206 and
 207 .BR strncpy (),
 208 but the caller must still handle the possibility of data loss if
 209 .I size
 210 is too small.
 211 The return value of the function is the length of
 212 .IR src ,
 213 which allows truncation to be easily detected:
 214 if the return value is greater than or equal to
 215 .IR size ,
 216 truncation occurred.
 217 If loss of data matters, the caller
 218 .I must
 219 either check the arguments before the call,
 220 or test the function return value.
 221 .BR strlcpy ()
 222 is not present in glibc and is not standardized by POSIX,
 223 .\" https://lwn.net/Articles/506530/
 224 but is available on Linux via the
 225 .IR libbsd
 226 library.
 227 .SH BUGS
 228 If the destination string of a
 229 .BR strcpy ()
 230 is not large enough, then anything might happen.
 231 Overflowing fixed-length string buffers is a favorite cracker technique
 232 for taking complete control of the machine.
 233 Any time a program reads or copies data into a buffer,
 234 the program first needs to check that there's enough space.
 235 This may be unnecessary if you can show that overflow is impossible,
 236 but be careful: programs can get changed over time,
 237 in ways that may make the impossible possible.
 238 .SH SEE ALSO
 239 .BR bcopy (3),
 240 .BR memccpy (3),
 241 .BR memcpy (3),
 242 .BR memmove (3),
 243 .BR stpcpy (3),
 244 .BR stpncpy (3),
 245 .BR strdup (3),
 246 .BR string (3),
 247 .BR wcscpy (3),
 248 .BR wcsncpy (3)