add documentation for libssp
This commit is contained in:
christos
parent
0dd2f4778a
commit
d66f24ca74
@ -1,4 +1,4 @@
|
||||
# $NetBSD: Makefile,v 1.1 2006/11/08 19:52:11 christos Exp $
|
||||
# $NetBSD: Makefile,v 1.2 2007/05/23 14:41:02 christos Exp $
|
||||
|
||||
USE_SHLIBDIR= yes
|
||||
WARNS=4
|
||||
@ -11,6 +11,7 @@ SRCS= gets_chk.c fgets_chk.c memcpy_chk.c memmove_chk.c memset_chk.c \
|
||||
|
||||
INCS= ssp/ssp.h ssp/stdio.h ssp/string.h ssp/unistd.h
|
||||
INCSDIR=/usr/include
|
||||
MAN= ssp.3 __builtin_object_size.3
|
||||
|
||||
.include <bsd.own.mk>
|
||||
.include <bsd.shlib.mk>
|
||||
|
||||
92
lib/libssp/__builtin_object_size.3
Normal file
92
lib/libssp/__builtin_object_size.3
Normal file
@ -0,0 +1,92 @@
|
||||
.\" $NetBSD: __builtin_object_size.3,v 1.1 2007/05/23 14:41:02 christos Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2007 The NetBSD Foundation, Inc.
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" This code is derived from software contributed to The NetBSD Foundation
|
||||
.\" by Christos Zoulas.
|
||||
.\"
|
||||
.\" 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.
|
||||
.\" 3. All advertising materials mentioning features or use of this software
|
||||
.\" must display the following acknowledgement:
|
||||
.\" This product includes software developed by the NetBSD
|
||||
.\" Foundation, Inc. and its contributors.
|
||||
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
|
||||
.\" contributors may be used to endorse or promote products derived
|
||||
.\" from this software without specific prior written permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
|
||||
.\"
|
||||
.\"
|
||||
.Dd May 23, 2007
|
||||
.Dt __BUILTIN_OBJEXT_SIZE 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm __builtin_object_size
|
||||
.Nd return the size of the given object
|
||||
.Sh LIBRARY
|
||||
.Ft size_t
|
||||
.Fn __builtin_object_size "void *ptr" "int type"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn __builtin_object_size
|
||||
function is a
|
||||
.Xr gcc 1
|
||||
built-in function that returns the size of the
|
||||
.Fa ptr
|
||||
object if known at compile time and the object does not have any side
|
||||
effects.
|
||||
.Sh RETURN VALUES
|
||||
If the size of the object is not known or it has side effects the
|
||||
.Fn __builtin_object_size
|
||||
function returns:
|
||||
.Bl -tag -width (size_t)-1
|
||||
.It Dv (size_t)-1
|
||||
for
|
||||
.Fa type
|
||||
.Dv 0
|
||||
and
|
||||
.Dv 1 .
|
||||
.It Dv (size_t)0
|
||||
for
|
||||
.Fa type
|
||||
.Dv 2
|
||||
and
|
||||
.Dv 3 .
|
||||
.El
|
||||
.Pp
|
||||
If the size of the object is known, then the
|
||||
.Fn __builtin_object_size
|
||||
function returns the maximum size of all the objects that the compiler
|
||||
knows that they can be pointed to by
|
||||
.Fa ptr
|
||||
when
|
||||
.Fa type
|
||||
.Dv & 2 == 0 ,
|
||||
and the minimum size when
|
||||
.Fa type
|
||||
.Dv & 2 != 0 .
|
||||
.Sh SEE ALSO
|
||||
.Xr gcc 1 ,
|
||||
.Xr ssp 3 .
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Fn __builtin_object_size
|
||||
appeared in gcc 4.1.
|
||||
126
lib/libssp/ssp.3
Normal file
126
lib/libssp/ssp.3
Normal file
@ -0,0 +1,126 @@
|
||||
.\" $NetBSD: ssp.3,v 1.1 2007/05/23 14:41:02 christos Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2007 The NetBSD Foundation, Inc.
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" This code is derived from software contributed to The NetBSD Foundation
|
||||
.\" by Christos Zoulas.
|
||||
.\"
|
||||
.\" 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.
|
||||
.\" 3. All advertising materials mentioning features or use of this software
|
||||
.\" must display the following acknowledgement:
|
||||
.\" This product includes software developed by the NetBSD
|
||||
.\" Foundation, Inc. and its contributors.
|
||||
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
|
||||
.\" contributors may be used to endorse or promote products derived
|
||||
.\" from this software without specific prior written permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
|
||||
.\"
|
||||
.\"
|
||||
.Dd May 23, 2007
|
||||
.Dt SSP 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm ssp
|
||||
.Nd bounds checked libc functions
|
||||
.Sh LIBRARY
|
||||
.Lb libssp
|
||||
.Sh SYNOPSIS
|
||||
.In ssp/stdio.h
|
||||
.Ft int
|
||||
.Fn sprintf "char *str" "const char *fmt" "..."
|
||||
.Ft int
|
||||
.Fn vsprintf "char *str" "const char *fmt" "va_list ap"
|
||||
.Ft int
|
||||
.Fn snprintf "char *str" "size_t len" "const char *fmt" "..."
|
||||
.Ft int
|
||||
.Fn vsnprintf "char *str" "size_t len" "const char *fmt" "va_list ap"
|
||||
.Ft char *
|
||||
.Fn gets "char *str"
|
||||
.Ft char *
|
||||
.Fn fgets "char *str" "int len" "FILE *fp"
|
||||
.In ssp/string.h
|
||||
.Ft void *
|
||||
.Fn memcpy "void *str" "const void *ptr" "size_t len"
|
||||
.Ft void *
|
||||
.Fn memmove "void *str" "const void *ptr" "size_t len"
|
||||
.Ft void *
|
||||
.Fn memset "void *str" "int val" "size_t len"
|
||||
.Ft char *
|
||||
.Fn strcpy "char *str" "const char *ptr" "size_t len"
|
||||
.Ft char *
|
||||
.Fn strcat "char *str" "const char *ptr" "size_t len"
|
||||
.Ft char *
|
||||
.Fn strncpy "char *str" "const char *ptr" "size_t len"
|
||||
.Ft char *
|
||||
.Fn strncat "char *str" "const char *ptr" "size_t len"
|
||||
.In ssp/unistd.h
|
||||
.Ft ssize_t
|
||||
.Fn read "int fd", "void *str" "size_t len"
|
||||
.Ft int
|
||||
.Fn readlink "const char * restrict path", "char * restrict str" "size_t len"
|
||||
.Ft int
|
||||
.Fn getcwd "char *str" "size_t len"
|
||||
.Sh DESCRIPTION
|
||||
When
|
||||
.Dv _FORTIFY_SOURCE
|
||||
bounds checking is enabled as described below, the functions get overwriten
|
||||
to utilize the
|
||||
.Xr gcc 1
|
||||
.Xr __builtin_object_size 3
|
||||
function to compute the size of
|
||||
.Fa str
|
||||
if known at compile time and perform bounds check on it in order
|
||||
to avoid data buffer or stack buffer overflows.
|
||||
If such overflow is detected the routines will call
|
||||
.Xr abort 3 .
|
||||
.Pp
|
||||
To enable these functions the following should be added to the
|
||||
.Xr gcc 1
|
||||
command line:
|
||||
.Dq \-I/usr/include/ssp
|
||||
to override the standard include files and
|
||||
.Dq \-D_FORTIFY_SOURCE=1
|
||||
or
|
||||
.Dq \-D_FORTIFY_SOURCE=2 .
|
||||
.Pp
|
||||
If
|
||||
.Dv _FORTIFY_SOURCE is set to
|
||||
.Dv 1
|
||||
the code will compute the maximum possible buffer size for
|
||||
.Fa str ,
|
||||
and if set to
|
||||
.Dv 2
|
||||
it will compute the minimum buffer size.
|
||||
.Sh SEE ALSO
|
||||
.Xr gcc 1 ,
|
||||
.Xr read 2 ,
|
||||
.Xr readlink 2 ,
|
||||
.Xr getcwd 3 ,
|
||||
.Xr stdio 3 ,
|
||||
.Xr string 3 ,
|
||||
.Xr abort 3 ,
|
||||
.Xr __builtin_object_size 3
|
||||
.Sh HISTORY
|
||||
The
|
||||
.Nm ssp
|
||||
library appeared
|
||||
.Nx 4.0 .
|
||||
Loading…
Reference in New Issue
Block a user