1994-05-27 05:00:24 +00:00
|
|
|
.\" Copyright (c) 1990, 1991, 1993
|
|
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" This code is derived from software contributed to Berkeley by
|
|
|
|
.\" Chris Torek and the American National Standards Committee X3,
|
|
|
|
.\" on Information Processing Systems.
|
|
|
|
.\"
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
2013-05-28 20:57:40 +00:00
|
|
|
.\" 3. Neither the name of the University nor the names of its contributors
|
1994-05-27 05:00:24 +00:00
|
|
|
.\" may be used to endorse or promote products derived from this software
|
|
|
|
.\" without specific prior written permission.
|
|
|
|
.\"
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
.\"
|
|
|
|
.\" @(#)strcpy.3 8.1 (Berkeley) 6/4/93
|
1999-08-28 00:22:10 +00:00
|
|
|
.\" $FreeBSD$
|
1994-05-27 05:00:24 +00:00
|
|
|
.\"
|
2018-06-06 20:09:21 +00:00
|
|
|
.Dd June 6, 2018
|
1994-05-27 05:00:24 +00:00
|
|
|
.Dt STRCPY 3
|
2001-07-10 13:41:46 +00:00
|
|
|
.Os
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh NAME
|
2018-04-17 09:05:46 +00:00
|
|
|
.Nm stpcpy ,
|
|
|
|
.Nm stpncpy ,
|
|
|
|
.Nm strcpy ,
|
|
|
|
.Nm strncpy
|
1994-05-27 05:00:24 +00:00
|
|
|
.Nd copy strings
|
2000-04-21 09:42:15 +00:00
|
|
|
.Sh LIBRARY
|
|
|
|
.Lb libc
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh SYNOPSIS
|
2001-10-01 16:09:29 +00:00
|
|
|
.In string.h
|
1994-05-27 05:00:24 +00:00
|
|
|
.Ft char *
|
2009-02-28 06:00:58 +00:00
|
|
|
.Fn stpcpy "char * restrict dst" "const char * restrict src"
|
|
|
|
.Ft char *
|
|
|
|
.Fn stpncpy "char * restrict dst" "const char * restrict src" "size_t len"
|
2002-10-03 19:39:20 +00:00
|
|
|
.Ft char *
|
2002-09-06 11:24:06 +00:00
|
|
|
.Fn strcpy "char * restrict dst" "const char * restrict src"
|
1994-05-27 05:00:24 +00:00
|
|
|
.Ft char *
|
2002-09-06 11:24:06 +00:00
|
|
|
.Fn strncpy "char * restrict dst" "const char * restrict src" "size_t len"
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
The
|
|
|
|
.Fn strcpy
|
2018-06-06 20:09:21 +00:00
|
|
|
and
|
|
|
|
.Fn stpcpy
|
2002-10-23 08:55:14 +00:00
|
|
|
functions
|
|
|
|
copy the string
|
1994-05-27 05:00:24 +00:00
|
|
|
.Fa src
|
|
|
|
to
|
|
|
|
.Fa dst
|
|
|
|
(including the terminating
|
|
|
|
.Ql \e0
|
2002-10-23 08:55:14 +00:00
|
|
|
character.)
|
1994-05-27 05:00:24 +00:00
|
|
|
.Pp
|
|
|
|
The
|
|
|
|
.Fn strncpy
|
2018-06-06 20:09:21 +00:00
|
|
|
and
|
|
|
|
.Fn stpncpy
|
2009-02-28 06:00:58 +00:00
|
|
|
functions copy at most
|
1994-05-27 05:00:24 +00:00
|
|
|
.Fa len
|
2001-07-19 11:26:52 +00:00
|
|
|
characters from
|
|
|
|
.Fa src
|
|
|
|
into
|
2002-10-23 08:55:14 +00:00
|
|
|
.Fa dst .
|
2018-06-06 20:09:21 +00:00
|
|
|
.Bf Sy
|
2002-10-23 08:55:14 +00:00
|
|
|
If
|
1994-05-27 05:00:24 +00:00
|
|
|
.Fa src
|
|
|
|
is less than
|
|
|
|
.Fa len
|
2002-10-23 08:55:14 +00:00
|
|
|
characters long,
|
|
|
|
the remainder of
|
|
|
|
.Fa dst
|
|
|
|
is filled with
|
|
|
|
.Ql \e0
|
|
|
|
characters.
|
2018-06-06 20:09:21 +00:00
|
|
|
.Ef
|
2002-10-23 08:55:14 +00:00
|
|
|
Otherwise,
|
1994-05-27 05:00:24 +00:00
|
|
|
.Fa dst
|
2002-10-23 08:55:14 +00:00
|
|
|
is
|
|
|
|
.Em not
|
|
|
|
terminated.
|
2018-06-06 20:09:21 +00:00
|
|
|
.Pp
|
|
|
|
For all of
|
|
|
|
.Fn strcpy ,
|
|
|
|
.Fn strncpy ,
|
|
|
|
.Fn stpcpy ,
|
|
|
|
and
|
|
|
|
.Fn stpncpy ,
|
|
|
|
the result is undefined
|
|
|
|
if
|
2017-11-13 17:04:44 +00:00
|
|
|
.Fa src
|
|
|
|
and
|
|
|
|
.Fa dst
|
2018-06-06 20:09:21 +00:00
|
|
|
overlap.
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh RETURN VALUES
|
|
|
|
The
|
|
|
|
.Fn strcpy
|
|
|
|
and
|
|
|
|
.Fn strncpy
|
|
|
|
functions
|
|
|
|
return
|
|
|
|
.Fa dst .
|
2002-10-03 19:39:20 +00:00
|
|
|
The
|
|
|
|
.Fn stpcpy
|
2009-02-28 06:00:58 +00:00
|
|
|
and
|
|
|
|
.Fn stpncpy
|
|
|
|
functions return a pointer to the terminating
|
2002-10-03 19:39:20 +00:00
|
|
|
.Ql \e0
|
|
|
|
character of
|
|
|
|
.Fa dst .
|
2009-02-28 06:00:58 +00:00
|
|
|
If
|
|
|
|
.Fn stpncpy
|
|
|
|
does not terminate
|
|
|
|
.Fa dst
|
|
|
|
with a
|
|
|
|
.Dv NUL
|
|
|
|
character, it instead returns a pointer to
|
|
|
|
.Li dst[n]
|
|
|
|
(which does not necessarily refer to a valid memory location.)
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh EXAMPLES
|
|
|
|
The following sets
|
2001-08-09 17:10:48 +00:00
|
|
|
.Va chararray
|
1994-05-27 05:00:24 +00:00
|
|
|
to
|
|
|
|
.Dq Li abc\e0\e0\e0 :
|
|
|
|
.Bd -literal -offset indent
|
2001-08-09 17:10:48 +00:00
|
|
|
char chararray[6];
|
|
|
|
|
|
|
|
(void)strncpy(chararray, "abc", sizeof(chararray));
|
1994-05-27 05:00:24 +00:00
|
|
|
.Ed
|
|
|
|
.Pp
|
|
|
|
The following sets
|
2001-08-09 17:10:48 +00:00
|
|
|
.Va chararray
|
1994-05-27 05:00:24 +00:00
|
|
|
to
|
|
|
|
.Dq Li abcdef :
|
|
|
|
.Bd -literal -offset indent
|
2001-08-09 17:10:48 +00:00
|
|
|
char chararray[6];
|
|
|
|
|
|
|
|
(void)strncpy(chararray, "abcdefgh", sizeof(chararray));
|
|
|
|
.Ed
|
|
|
|
.Pp
|
|
|
|
Note that it does
|
|
|
|
.Em not
|
|
|
|
.Tn NUL
|
|
|
|
terminate
|
|
|
|
.Va chararray
|
|
|
|
because the length of the source string is greater than or equal
|
2002-12-19 09:40:28 +00:00
|
|
|
to the length argument.
|
2001-08-09 17:10:48 +00:00
|
|
|
.Pp
|
|
|
|
The following copies as many characters from
|
|
|
|
.Va input
|
|
|
|
to
|
|
|
|
.Va buf
|
|
|
|
as will fit and
|
|
|
|
.Tn NUL
|
|
|
|
terminates the result.
|
|
|
|
Because
|
|
|
|
.Fn strncpy
|
|
|
|
does
|
|
|
|
.Em not
|
|
|
|
guarantee to
|
|
|
|
.Tn NUL
|
|
|
|
terminate the string itself, this must be done explicitly.
|
|
|
|
.Bd -literal -offset indent
|
|
|
|
char buf[1024];
|
|
|
|
|
|
|
|
(void)strncpy(buf, input, sizeof(buf) - 1);
|
|
|
|
buf[sizeof(buf) - 1] = '\e0';
|
1994-05-27 05:00:24 +00:00
|
|
|
.Ed
|
2001-08-09 17:10:48 +00:00
|
|
|
.Pp
|
|
|
|
This could be better achieved using
|
|
|
|
.Xr strlcpy 3 ,
|
|
|
|
as shown in the following example:
|
|
|
|
.Pp
|
|
|
|
.Dl "(void)strlcpy(buf, input, sizeof(buf));"
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh SEE ALSO
|
|
|
|
.Xr bcopy 3 ,
|
|
|
|
.Xr memccpy 3 ,
|
|
|
|
.Xr memcpy 3 ,
|
1999-09-28 04:11:47 +00:00
|
|
|
.Xr memmove 3 ,
|
2009-04-07 13:42:53 +00:00
|
|
|
.Xr strlcpy 3 ,
|
|
|
|
.Xr wcscpy 3
|
1994-05-27 05:00:24 +00:00
|
|
|
.Sh STANDARDS
|
|
|
|
The
|
|
|
|
.Fn strcpy
|
|
|
|
and
|
|
|
|
.Fn strncpy
|
|
|
|
functions
|
|
|
|
conform to
|
2001-02-26 13:23:47 +00:00
|
|
|
.St -isoC .
|
2002-10-03 19:39:20 +00:00
|
|
|
The
|
|
|
|
.Fn stpcpy
|
2009-02-28 06:00:58 +00:00
|
|
|
and
|
|
|
|
.Fn stpncpy
|
|
|
|
functions conform to
|
|
|
|
.St -p1003.1-2008 .
|
2002-10-03 19:39:20 +00:00
|
|
|
.Sh HISTORY
|
|
|
|
The
|
|
|
|
.Fn stpcpy
|
|
|
|
function first appeared in
|
|
|
|
.Fx 4.4 ,
|
2009-02-28 06:00:58 +00:00
|
|
|
and
|
|
|
|
.Fn stpncpy
|
|
|
|
was added in
|
|
|
|
.Fx 8.0 .
|
2010-05-13 12:07:55 +00:00
|
|
|
.Sh SECURITY CONSIDERATIONS
|
2018-06-06 20:09:21 +00:00
|
|
|
All of the functions documented in this manual page are easily misused in a
|
|
|
|
manner which enables malicious users to arbitrarily change a running program's
|
|
|
|
functionality through a buffer overflow attack.
|
|
|
|
.Pp
|
|
|
|
It is strongly suggested that the
|
|
|
|
.Fn strlcpy
|
|
|
|
function be used in almost all cases.
|
|
|
|
.Pp
|
|
|
|
For some, but not all, fixed-length records, non-terminated strings may be both
|
|
|
|
valid and desirable.
|
|
|
|
In that specific case, the
|
|
|
|
.Fn strncpy
|
|
|
|
function may be most sensible.
|