1 d13b044d 2023-08-07 op /* $OpenBSD: vis.c,v 1.26 2022/05/04 18:57:50 deraadt Exp $ */
3 d13b044d 2023-08-07 op * Copyright (c) 1989, 1993
4 d13b044d 2023-08-07 op * The Regents of the University of California. All rights reserved.
6 d13b044d 2023-08-07 op * Redistribution and use in source and binary forms, with or without
7 d13b044d 2023-08-07 op * modification, are permitted provided that the following conditions
9 d13b044d 2023-08-07 op * 1. Redistributions of source code must retain the above copyright
10 d13b044d 2023-08-07 op * notice, this list of conditions and the following disclaimer.
11 d13b044d 2023-08-07 op * 2. Redistributions in binary form must reproduce the above copyright
12 d13b044d 2023-08-07 op * notice, this list of conditions and the following disclaimer in the
13 d13b044d 2023-08-07 op * documentation and/or other materials provided with the distribution.
14 d13b044d 2023-08-07 op * 3. Neither the name of the University nor the names of its contributors
15 d13b044d 2023-08-07 op * may be used to endorse or promote products derived from this software
16 d13b044d 2023-08-07 op * without specific prior written permission.
18 d13b044d 2023-08-07 op * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 d13b044d 2023-08-07 op * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 d13b044d 2023-08-07 op * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 d13b044d 2023-08-07 op * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 d13b044d 2023-08-07 op * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 d13b044d 2023-08-07 op * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 d13b044d 2023-08-07 op * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 d13b044d 2023-08-07 op * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 d13b044d 2023-08-07 op * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 d13b044d 2023-08-07 op * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 d13b044d 2023-08-07 op * SUCH DAMAGE.
31 877b479b 2023-08-07 op #include "../config.h"
33 d13b044d 2023-08-07 op #include <sys/types.h>
34 d13b044d 2023-08-07 op #include <errno.h>
35 d13b044d 2023-08-07 op #include <ctype.h>
36 d13b044d 2023-08-07 op #include <limits.h>
37 d13b044d 2023-08-07 op #include <string.h>
38 d13b044d 2023-08-07 op #include <stdlib.h>
39 d13b044d 2023-08-07 op #include <vis.h>
42 d13b044d 2023-08-07 op isoctal(int c)
44 d13b044d 2023-08-07 op u_char uc = c;
46 d13b044d 2023-08-07 op return uc >= '0' && uc <= '7';
50 d13b044d 2023-08-07 op isvisible(int c, int flag)
52 d13b044d 2023-08-07 op int vis_sp = flag & VIS_SP;
53 d13b044d 2023-08-07 op int vis_tab = flag & VIS_TAB;
54 d13b044d 2023-08-07 op int vis_nl = flag & VIS_NL;
55 d13b044d 2023-08-07 op int vis_safe = flag & VIS_SAFE;
56 d13b044d 2023-08-07 op int vis_glob = flag & VIS_GLOB;
57 d13b044d 2023-08-07 op int vis_all = flag & VIS_ALL;
58 d13b044d 2023-08-07 op u_char uc = c;
60 d13b044d 2023-08-07 op if (c == '\\' || !vis_all) {
61 d13b044d 2023-08-07 op if ((u_int)c <= UCHAR_MAX && isascii(uc) &&
62 d13b044d 2023-08-07 op ((c != '*' && c != '?' && c != '[' && c != '#') || !vis_glob) &&
65 d13b044d 2023-08-07 op if (!vis_sp && c == ' ')
67 d13b044d 2023-08-07 op if (!vis_tab && c == '\t')
69 d13b044d 2023-08-07 op if (!vis_nl && c == '\n')
71 d13b044d 2023-08-07 op if (vis_safe && (c == '\b' || c == '\007' || c == '\r' || isgraph(uc)))
78 d13b044d 2023-08-07 op * vis - visually encode characters
81 d13b044d 2023-08-07 op vis(char *dst, int c, int flag, int nextc)
83 d13b044d 2023-08-07 op int vis_dq = flag & VIS_DQ;
84 d13b044d 2023-08-07 op int vis_noslash = flag & VIS_NOSLASH;
85 d13b044d 2023-08-07 op int vis_cstyle = flag & VIS_CSTYLE;
86 d13b044d 2023-08-07 op int vis_octal = flag & VIS_OCTAL;
87 d13b044d 2023-08-07 op int vis_glob = flag & VIS_GLOB;
89 d13b044d 2023-08-07 op if (isvisible(c, flag)) {
90 d13b044d 2023-08-07 op if ((c == '"' && vis_dq) ||
91 d13b044d 2023-08-07 op (c == '\\' && !vis_noslash))
92 d13b044d 2023-08-07 op *dst++ = '\\';
98 d13b044d 2023-08-07 op if (vis_cstyle) {
101 d13b044d 2023-08-07 op *dst++ = '\\';
102 d13b044d 2023-08-07 op *dst++ = 'n';
105 d13b044d 2023-08-07 op *dst++ = '\\';
106 d13b044d 2023-08-07 op *dst++ = 'r';
109 d13b044d 2023-08-07 op *dst++ = '\\';
110 d13b044d 2023-08-07 op *dst++ = 'b';
113 d13b044d 2023-08-07 op *dst++ = '\\';
114 d13b044d 2023-08-07 op *dst++ = 'a';
117 d13b044d 2023-08-07 op *dst++ = '\\';
118 d13b044d 2023-08-07 op *dst++ = 'v';
121 d13b044d 2023-08-07 op *dst++ = '\\';
122 d13b044d 2023-08-07 op *dst++ = 't';
125 d13b044d 2023-08-07 op *dst++ = '\\';
126 d13b044d 2023-08-07 op *dst++ = 'f';
129 d13b044d 2023-08-07 op *dst++ = '\\';
130 d13b044d 2023-08-07 op *dst++ = 's';
133 d13b044d 2023-08-07 op *dst++ = '\\';
134 d13b044d 2023-08-07 op *dst++ = '0';
135 d13b044d 2023-08-07 op if (isoctal(nextc)) {
136 d13b044d 2023-08-07 op *dst++ = '0';
137 d13b044d 2023-08-07 op *dst++ = '0';
142 d13b044d 2023-08-07 op if (((c & 0177) == ' ') || vis_octal ||
143 d13b044d 2023-08-07 op (vis_glob && (c == '*' || c == '?' || c == '[' || c == '#'))) {
144 d13b044d 2023-08-07 op *dst++ = '\\';
145 d13b044d 2023-08-07 op *dst++ = ((u_char)c >> 6 & 07) + '0';
146 d13b044d 2023-08-07 op *dst++ = ((u_char)c >> 3 & 07) + '0';
147 d13b044d 2023-08-07 op *dst++ = ((u_char)c & 07) + '0';
150 d13b044d 2023-08-07 op if (!vis_noslash)
151 d13b044d 2023-08-07 op *dst++ = '\\';
152 d13b044d 2023-08-07 op if (c & 0200) {
154 d13b044d 2023-08-07 op *dst++ = 'M';
156 d13b044d 2023-08-07 op if (iscntrl((u_char)c)) {
157 d13b044d 2023-08-07 op *dst++ = '^';
158 d13b044d 2023-08-07 op if (c == 0177)
159 d13b044d 2023-08-07 op *dst++ = '?';
161 d13b044d 2023-08-07 op *dst++ = c + '@';
163 d13b044d 2023-08-07 op *dst++ = '-';
168 d13b044d 2023-08-07 op return (dst);
172 d13b044d 2023-08-07 op * strvis, strnvis, strvisx - visually encode characters from src into dst
174 d13b044d 2023-08-07 op * Dst must be 4 times the size of src to account for possible
175 d13b044d 2023-08-07 op * expansion. The length of dst, not including the trailing NULL,
176 d13b044d 2023-08-07 op * is returned.
178 d13b044d 2023-08-07 op * Strnvis will write no more than siz-1 bytes (and will NULL terminate).
179 d13b044d 2023-08-07 op * The number of bytes needed to fully encode the string is returned.
181 d13b044d 2023-08-07 op * Strvisx encodes exactly len bytes from src into dst.
182 d13b044d 2023-08-07 op * This is useful for encoding a block of data.
185 d13b044d 2023-08-07 op strvis(char *dst, const char *src, int flag)
190 d13b044d 2023-08-07 op for (start = dst; (c = *src);)
191 d13b044d 2023-08-07 op dst = vis(dst, c, flag, *++src);
193 d13b044d 2023-08-07 op return (dst - start);
197 d13b044d 2023-08-07 op strnvis(char *dst, const char *src, size_t siz, int flag)
199 d13b044d 2023-08-07 op int vis_dq = flag & VIS_DQ;
200 d13b044d 2023-08-07 op int vis_noslash = flag & VIS_NOSLASH;
201 d13b044d 2023-08-07 op char *start, *end;
202 d13b044d 2023-08-07 op char tbuf[5];
206 d13b044d 2023-08-07 op for (start = dst, end = start + siz - 1; (c = *src) && dst < end; ) {
207 d13b044d 2023-08-07 op if (isvisible(c, flag)) {
208 d13b044d 2023-08-07 op if ((c == '"' && vis_dq) ||
209 d13b044d 2023-08-07 op (c == '\\' && !vis_noslash)) {
210 d13b044d 2023-08-07 op /* need space for the extra '\\' */
211 d13b044d 2023-08-07 op if (dst + 1 >= end) {
215 d13b044d 2023-08-07 op *dst++ = '\\';
221 d13b044d 2023-08-07 op i = vis(tbuf, c, flag, *++src) - tbuf;
222 d13b044d 2023-08-07 op if (dst + i <= end) {
223 d13b044d 2023-08-07 op memcpy(dst, tbuf, i);
233 d13b044d 2023-08-07 op if (dst + i > end) {
234 d13b044d 2023-08-07 op /* adjust return value for truncation */
235 d13b044d 2023-08-07 op while ((c = *src))
236 d13b044d 2023-08-07 op dst += vis(tbuf, c, flag, *++src) - tbuf;
238 d13b044d 2023-08-07 op return (dst - start);
242 d13b044d 2023-08-07 op stravis(char **outp, const char *src, int flag)
245 d13b044d 2023-08-07 op int len, serrno;
247 d13b044d 2023-08-07 op buf = reallocarray(NULL, 4, strlen(src) + 1);
248 d13b044d 2023-08-07 op if (buf == NULL)
250 d13b044d 2023-08-07 op len = strvis(buf, src, flag);
251 d13b044d 2023-08-07 op serrno = errno;
252 d13b044d 2023-08-07 op *outp = realloc(buf, len + 1);
253 d13b044d 2023-08-07 op if (*outp == NULL) {
255 d13b044d 2023-08-07 op errno = serrno;
257 d13b044d 2023-08-07 op return (len);
261 d13b044d 2023-08-07 op strvisx(char *dst, const char *src, size_t len, int flag)
266 d13b044d 2023-08-07 op for (start = dst; len > 1; len--) {
268 d13b044d 2023-08-07 op dst = vis(dst, c, flag, *++src);
271 d13b044d 2023-08-07 op dst = vis(dst, *src, flag, '\0');
273 d13b044d 2023-08-07 op return (dst - start);