original/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  2012-07-19 "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 .sp
  42 .BI "char *strcpy(char *" dest ", const char *" src );
  43 .sp
  44 .BI "char *strncpy(char *" dest ", const char *" src ", 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\\0\(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 .in +4n
  92 .nf
  93
  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\\0\(aq; i++)
 100         dest[i] = src[i];
 101     for ( ; i < n; i++)
 102         dest[i] = \(aq\\0\(aq;
 103
 104     return dest;
 105 }
 106 .fi
 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 CONFORMING TO
 117 SVr4, 4.3BSD, C89, C99.
 118 .SH NOTES
 119 Some programmers consider
 120 .BR strncpy ()
 121 to be inefficient and error prone.
 122 If the programmer knows (i.e., includes code to test!)
 123 that the size of
 124 .I dest
 125 is greater than
 126 the length of
 127 .IR src ,
 128 then
 129 .BR strcpy ()
 130 can be used.
 131
 132 One valid (and intended) use of
 133 .BR strncpy ()
 134 is to copy a C string to a fixed-length buffer
 135 while ensuring both that the buffer is not overflowed
 136 and that unused bytes in the target buffer are zeroed out
 137 (perhaps to prevent information leaks if the buffer is to be
 138 written to media or transmitted to another process via an
 139 interprocess communication technique).
 140
 141 If there is no terminating null byte in the first
 142 .I n
 143 bytes of
 144 .IR src ,
 145 .BR strncpy ()
 146 produces an unterminated string in
 147 .IR dest .
 148 You can force termination using something like the following:
 149 .in +4n
 150 .nf
 151
 152 strncpy(buf, str, n);
 153 if (n > 0)
 154     buf[n \- 1]= \(aq\\0\(aq;
 155 .fi
 156 .in
 157 .PP
 158 (Of course, the above technique ignores the fact that
 159 information contained in
 160 .I src
 161 is lost in the copying to
 162 .IR dest .)
 163
 164 Some systems (the BSDs, Solaris, and others) provide the following function:
 165
 166     size_t strlcpy(char *dest, const char *src, size_t size);
 167
 168 .\" http://static.usenix.org/event/usenix99/full_papers/millert/millert_html/index.html
 169 .\"     "strlcpy and strlcat - consistent, safe, string copy and concatenation"
 170 .\"     1999 USENIX Annual Technical Conference
 171 This function is similar to
 172 .BR strncpy (),
 173 but it copies at most
 174 .I size\-1
 175 bytes to
 176 .IR dest ,
 177 always adds a terminating null byte,
 178 and does not pad the target with (further) null bytes.
 179 This function fixes some of the problems of
 180 .BR strcpy ()
 181 and
 182 .BR strncpy (),
 183 but the caller must still handle the possibility of data loss if
 184 .I size
 185 is too small.
 186 The return value of the function is the length of
 187 .IR src ,
 188 which allows truncation to be easily detected:
 189 if the return value is greater than or equal to
 190 .IR size ,
 191 truncation occurred.
 192 If loss of data matters, the caller
 193 .I must
 194 either check the arguments before the call,
 195 or test the function return value.
 196 .BR strlcpy ()
 197 is not present in glibc and is not standardized by POSIX,
 198 .\" https://lwn.net/Articles/506530/
 199 but is available on Linux via the
 200 .IR libbsd
 201 library.
 202 .SH BUGS
 203 If the destination string of a
 204 .BR strcpy ()
 205 is not large enough, then anything might happen.
 206 Overflowing fixed-length string buffers is a favorite cracker technique
 207 for taking complete control of the machine.
 208 Any time a program reads or copies data into a buffer,
 209 the program first needs to check that there's enough space.
 210 This may be unnecessary if you can show that overflow is impossible,
 211 but be careful: programs can get changed over time,
 212 in ways that may make the impossible possible.
 213 .SH SEE ALSO
 214 .BR bcopy (3),
 215 .BR memccpy (3),
 216 .BR memcpy (3),
 217 .BR memmove (3),
 218 .BR stpcpy (3),
 219 .BR stpncpy (3),
 220 .BR strdup (3),
 221 .BR string (3),
 222 .BR wcscpy (3),
 223 .BR wcsncpy (3)