Merge from vendor branch GCC:
[dragonfly.git] / lib / libcr / gen / fmtcheck.3
1 .\" Copyright (c) 2000 The NetBSD Foundation, Inc.
2 .\" All rights reserved.
3 .\"
4 .\" This file was contributed to The NetBSD Foundation by Allen Briggs.
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. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgement:
16 .\"        This product includes software developed by the NetBSD
17 .\"        Foundation, Inc. and its contributors.
18 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
19 .\"    contributors may be used to endorse or promote products derived
20 .\"    from this software without specific prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
23 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
25 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
26 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 .\" POSSIBILITY OF SUCH DAMAGE.
33 .\"
34 .\" $FreeBSD: src/lib/libc/gen/fmtcheck.3,v 1.2.2.4 2003/03/13 18:05:37 trhodes Exp $
35 .\" $DragonFly: src/lib/libcr/gen/Attic/fmtcheck.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
36 .Dd October 17, 2000
37 .Os
38 .Dt FMTCHECK 3
39 .Sh NAME
40 .Nm fmtcheck
41 .Nd sanitizes user-supplied
42 .Xr printf 3 Ns -style
43 format string
44 .Sh LIBRARY
45 .Lb libc
46 .Sh SYNOPSIS
47 .In stdio.h
48 .Ft const char *
49 .Fn fmtcheck "const char *fmt_suspect" "const char *fmt_default"
50 .Sh DESCRIPTION
51 The
52 .Fn fmtcheck
53 scans
54 .Fa fmt_suspect
55 and
56 .Fa fmt_default
57 to determine if
58 .Fa fmt_suspect
59 will consume the same argument types as
60 .Fa fmt_default
61 and to ensure that
62 .Fa fmt_suspect
63 is a valid format string.
64 .Pp
65 The
66 .Xr printf 3
67 family of functions cannot verify the types of arguments that they are
68 passed at run-time.  In some cases, like
69 .Xr catgets 3 ,
70 it is useful or necessary to use a user-supplied format string with no
71 guarantee that the format string matches the specified arguments.
72 .Pp
73 The
74 .Fn fmtcheck
75 was designed to be used in these cases, as in:
76 .Bd -literal -offset indent
77 printf(fmtcheck(user_format, standard_format), arg1, arg2);
78 .Ed
79 .Pp
80 In the check, field widths, fillers, precisions, etc. are ignored (unless
81 the field width or precision is an asterisk
82 .Ql *
83 instead of a digit string).  Also, any text other than the format specifiers
84 is completely ignored.
85 .Sh RETURN VALUES
86 If
87 .Fa fmt_suspect
88 is a valid format and consumes the same argument types as
89 .Fa fmt_default ,
90 then the
91 .Fn fmtcheck
92 will return
93 .Fa fmt_suspect .
94 Otherwise, it will return
95 .Fa fmt_default .
96 .Sh SECURITY CONSIDERATIONS
97 Note that the formats may be quite different as long as they accept the
98 same arguments.  For example,
99 .Qq Li "%p %o %30s %#llx %-10.*e %n"
100 is compatible with
101 .Qq Li "This number %lu %d%% and string %s has %qd numbers and %.*g floats (%n)" .
102 However,
103 .Qq Li %o
104 is not equivalent to
105 .Qq Li %lx
106 because
107 the first requires an integer and the second requires a long.
108 .Sh SEE ALSO
109 .Xr printf 3
110 .Sh BUGS
111 The
112 .Fn fmtcheck
113 function does not understand all of the conversions that
114 .Xr printf 3
115 does.