]>
Commit | Line | Data |
---|---|---|
db9ecf05 | 1 | /* SPDX-License-Identifier: LGPL-2.1-or-later */ |
1968a360 | 2 | |
a8fbdf54 | 3 | #include <errno.h> |
a8fbdf54 TA |
4 | #include <stddef.h> |
5 | #include <stdint.h> | |
6 | #include <stdio.h> | |
1968a360 | 7 | #include <stdlib.h> |
1968a360 | 8 | #include <sys/prctl.h> |
07630cea | 9 | #include <unistd.h> |
1968a360 | 10 | |
0a42426d ZJS |
11 | #include "sd-login.h" |
12 | ||
07630cea | 13 | #include "copy.h" |
612ebf6c | 14 | #include "env-util.h" |
3ffd4af2 | 15 | #include "fd-util.h" |
6432da6a ZJS |
16 | #include "fileio.h" |
17 | #include "io-util.h" | |
8752c575 | 18 | #include "locale-util.h" |
a8fbdf54 | 19 | #include "log.h" |
1968a360 | 20 | #include "macro.h" |
3ffd4af2 | 21 | #include "pager.h" |
07630cea | 22 | #include "process-util.h" |
595225af | 23 | #include "rlimit-util.h" |
ce30c8dc | 24 | #include "signal-util.h" |
07630cea | 25 | #include "string-util.h" |
57c9e047 | 26 | #include "strv.h" |
07630cea | 27 | #include "terminal-util.h" |
ca78ad1d | 28 | #include "util.h" |
1968a360 LP |
29 | |
30 | static pid_t pager_pid = 0; | |
31 | ||
3f603952 LP |
32 | static int stored_stdout = -1; |
33 | static int stored_stderr = -1; | |
34 | static bool stdout_redirected = false; | |
35 | static bool stderr_redirected = false; | |
36 | ||
848e863a | 37 | _noreturn_ static void pager_fallback(void) { |
6a7c676c | 38 | int r; |
46e65dcc | 39 | |
f5fbe71d | 40 | r = copy_bytes(STDIN_FILENO, STDOUT_FILENO, UINT64_MAX, 0); |
6a7c676c LP |
41 | if (r < 0) { |
42 | log_error_errno(r, "Internal pager failed: %m"); | |
4a8e40eb MS |
43 | _exit(EXIT_FAILURE); |
44 | } | |
46e65dcc | 45 | |
4a8e40eb MS |
46 | _exit(EXIT_SUCCESS); |
47 | } | |
48 | ||
6432da6a ZJS |
49 | static int no_quit_on_interrupt(int exe_name_fd, const char *less_opts) { |
50 | _cleanup_fclose_ FILE *file = NULL; | |
51 | _cleanup_free_ char *line = NULL; | |
52 | int r; | |
53 | ||
54 | assert(exe_name_fd >= 0); | |
55 | assert(less_opts); | |
56 | ||
57 | /* This takes ownership of exe_name_fd */ | |
58 | file = fdopen(exe_name_fd, "r"); | |
59 | if (!file) { | |
60 | safe_close(exe_name_fd); | |
1d788908 | 61 | return log_error_errno(errno, "Failed to create FILE object: %m"); |
6432da6a ZJS |
62 | } |
63 | ||
64 | /* Find the last line */ | |
65 | for (;;) { | |
66 | _cleanup_free_ char *t = NULL; | |
67 | ||
68 | r = read_line(file, LONG_LINE_MAX, &t); | |
69 | if (r < 0) | |
1d788908 | 70 | return log_error_errno(r, "Failed to read from socket: %m"); |
6432da6a ZJS |
71 | if (r == 0) |
72 | break; | |
73 | ||
74 | free_and_replace(line, t); | |
75 | } | |
76 | ||
77 | /* We only treat "less" specially. | |
78 | * Return true whenever option K is *not* set. */ | |
79 | r = streq_ptr(line, "less") && !strchr(less_opts, 'K'); | |
80 | ||
81 | log_debug("Pager executable is \"%s\", options \"%s\", quit_on_interrupt: %s", | |
82 | strnull(line), less_opts, yes_no(!r)); | |
83 | return r; | |
84 | } | |
85 | ||
384c2c32 | 86 | void pager_open(PagerFlags flags) { |
6432da6a | 87 | _cleanup_close_pair_ int fd[2] = { -1, -1 }, exe_name_pipe[2] = { -1, -1 }; |
43942e80 | 88 | _cleanup_strv_free_ char **pager_args = NULL; |
1d3b68f6 | 89 | _cleanup_free_ char *l = NULL; |
6432da6a | 90 | const char *pager, *less_opts; |
4c253ed1 | 91 | int r; |
1968a360 | 92 | |
0221d68a | 93 | if (flags & PAGER_DISABLE) |
384c2c32 | 94 | return; |
ea4b98e6 | 95 | |
1968a360 | 96 | if (pager_pid > 0) |
384c2c32 | 97 | return; |
1968a360 | 98 | |
ac96418b | 99 | if (terminal_is_dumb()) |
384c2c32 | 100 | return; |
729e3769 | 101 | |
85afeae8 | 102 | if (!is_main_thread()) |
384c2c32 | 103 | return (void) log_error_errno(SYNTHETIC_ERRNO(EPERM), "Pager invoked from wrong thread."); |
85afeae8 | 104 | |
bcbd61db LP |
105 | pager = getenv("SYSTEMD_PAGER"); |
106 | if (!pager) | |
107 | pager = getenv("PAGER"); | |
108 | ||
43942e80 YW |
109 | if (pager) { |
110 | pager_args = strv_split(pager, WHITESPACE); | |
111 | if (!pager_args) | |
384c2c32 | 112 | return (void) log_oom(); |
43942e80 YW |
113 | |
114 | /* If the pager is explicitly turned off, honour it */ | |
115 | if (strv_isempty(pager_args) || strv_equal(pager_args, STRV_MAKE("cat"))) | |
384c2c32 | 116 | return; |
43942e80 | 117 | } |
bcbd61db | 118 | |
d13b5227 LP |
119 | /* Determine and cache number of columns/lines before we spawn the pager so that we get the value from the |
120 | * actual tty */ | |
bcbd61db | 121 | (void) columns(); |
d13b5227 | 122 | (void) lines(); |
1968a360 | 123 | |
d262e99e | 124 | if (pipe2(fd, O_CLOEXEC) < 0) |
384c2c32 | 125 | return (void) log_error_errno(errno, "Failed to create pager pipe: %m"); |
1968a360 | 126 | |
6432da6a ZJS |
127 | /* This is a pipe to feed the name of the executed pager binary into the parent */ |
128 | if (pipe2(exe_name_pipe, O_CLOEXEC) < 0) | |
384c2c32 | 129 | return (void) log_error_errno(errno, "Failed to create exe_name pipe: %m"); |
6432da6a ZJS |
130 | |
131 | /* Initialize a good set of less options */ | |
132 | less_opts = getenv("SYSTEMD_LESS"); | |
133 | if (!less_opts) | |
134 | less_opts = "FRSXMK"; | |
1d3b68f6 AZ |
135 | if (flags & PAGER_JUMP_TO_END) { |
136 | l = strjoin(less_opts, " +G"); | |
137 | if (!l) | |
138 | return (void) log_oom(); | |
139 | less_opts = l; | |
140 | } | |
6432da6a | 141 | |
97033ba4 LP |
142 | /* We set SIGINT as PR_DEATHSIG signal here, to match the "K" parameter we set in $LESS, which enables SIGINT behaviour. */ |
143 | r = safe_fork("(pager)", FORK_RESET_SIGNALS|FORK_DEATHSIG_SIGINT|FORK_RLIMIT_NOFILE_SAFE|FORK_LOG, &pager_pid); | |
4c253ed1 | 144 | if (r < 0) |
384c2c32 | 145 | return; |
4c253ed1 | 146 | if (r == 0) { |
5980d463 | 147 | const char *less_charset; |
1968a360 | 148 | |
4c253ed1 | 149 | /* In the child start the pager */ |
ce30c8dc | 150 | |
1d788908 LP |
151 | if (dup2(fd[0], STDIN_FILENO) < 0) { |
152 | log_error_errno(errno, "Failed to duplicate file descriptor to STDIN: %m"); | |
153 | _exit(EXIT_FAILURE); | |
154 | } | |
155 | ||
3d94f76c | 156 | safe_close_pair(fd); |
1968a360 | 157 | |
1d788908 LP |
158 | if (setenv("LESS", less_opts, 1) < 0) { |
159 | log_error_errno(errno, "Failed to set environment variable LESS: %m"); | |
0357fa0d | 160 | _exit(EXIT_FAILURE); |
1d788908 | 161 | } |
1968a360 | 162 | |
612ebf6c | 163 | /* Initialize a good charset for less. This is particularly important if we output UTF-8 |
a1b4e6e9 LP |
164 | * characters. */ |
165 | less_charset = getenv("SYSTEMD_LESSCHARSET"); | |
166 | if (!less_charset && is_locale_utf8()) | |
167 | less_charset = "utf-8"; | |
0357fa0d | 168 | if (less_charset && |
1d788908 LP |
169 | setenv("LESSCHARSET", less_charset, 1) < 0) { |
170 | log_error_errno(errno, "Failed to set environment variable LESSCHARSET: %m"); | |
0357fa0d | 171 | _exit(EXIT_FAILURE); |
1d788908 | 172 | } |
a1b4e6e9 | 173 | |
612ebf6c | 174 | /* People might invoke us from sudo, don't needlessly allow less to be a way to shell out |
0a42426d ZJS |
175 | * privileged stuff. If the user set $SYSTEMD_PAGERSECURE, trust their configuration of the |
176 | * pager. If they didn't, use secure mode when under euid is changed. If $SYSTEMD_PAGERSECURE | |
177 | * wasn't explicitly set, and we autodetect the need for secure mode, only use the pager we | |
178 | * know to be good. */ | |
b8f736b3 | 179 | int use_secure_mode = getenv_bool_secure("SYSTEMD_PAGERSECURE"); |
0a42426d ZJS |
180 | bool trust_pager = use_secure_mode >= 0; |
181 | if (use_secure_mode == -ENXIO) { | |
182 | uid_t uid; | |
183 | ||
184 | r = sd_pid_get_owner_uid(0, &uid); | |
612ebf6c | 185 | if (r < 0) |
0a42426d | 186 | log_debug_errno(r, "sd_pid_get_owner_uid() failed, enabling pager secure mode: %m"); |
612ebf6c | 187 | |
0a42426d ZJS |
188 | use_secure_mode = r < 0 || uid != geteuid(); |
189 | ||
190 | } else if (use_secure_mode < 0) { | |
191 | log_warning_errno(use_secure_mode, "Unable to parse $SYSTEMD_PAGERSECURE, assuming true: %m"); | |
192 | use_secure_mode = true; | |
612ebf6c LP |
193 | } |
194 | ||
0a42426d ZJS |
195 | /* We generally always set variables used by less, even if we end up using a different pager. |
196 | * They shouldn't hurt in any case, and ideally other pagers would look at them too. */ | |
063f9f0d | 197 | r = set_unset_env("LESSSECURE", use_secure_mode ? "1" : NULL, true); |
0a42426d | 198 | if (r < 0) { |
063f9f0d | 199 | log_error_errno(r, "Failed to adjust environment variable LESSSECURE: %m"); |
0a42426d ZJS |
200 | _exit(EXIT_FAILURE); |
201 | } | |
202 | ||
203 | if (trust_pager && pager_args) { /* The pager config might be set globally, and we cannot | |
204 | * know if the user adjusted it to be appropriate for the | |
205 | * secure mode. Thus, start the pager specified through | |
206 | * envvars only when $SYSTEMD_PAGERSECURE was explicitly set | |
207 | * as well. */ | |
1d788908 LP |
208 | r = loop_write(exe_name_pipe[1], pager_args[0], strlen(pager_args[0]) + 1, false); |
209 | if (r < 0) { | |
210 | log_error_errno(r, "Failed to write pager name to socket: %m"); | |
6432da6a | 211 | _exit(EXIT_FAILURE); |
1d788908 | 212 | } |
6432da6a | 213 | |
43942e80 | 214 | execvp(pager_args[0], pager_args); |
1d788908 | 215 | log_full_errno(errno == ENOENT ? LOG_DEBUG : LOG_WARNING, errno, |
118dccc9 | 216 | "Failed to execute '%s', using fallback pagers: %m", pager_args[0]); |
6432da6a | 217 | } |
1968a360 | 218 | |
0a42426d ZJS |
219 | /* Debian's alternatives command for pagers is called 'pager'. Note that we do not call |
220 | * sensible-pagers here, since that is just a shell script that implements a logic that is | |
221 | * similar to this one anyway, but is Debian-specific. */ | |
b622d2f7 ZJS |
222 | static const char* pagers[] = { "pager", "less", "more", "(built-in)" }; |
223 | ||
224 | for (unsigned i = 0; i < ELEMENTSOF(pagers); i++) { | |
225 | /* Only less (and our trivial fallback) implement secure mode right now. */ | |
226 | if (use_secure_mode && !STR_IN_SET(pagers[i], "less", "(built-in)")) | |
0a42426d ZJS |
227 | continue; |
228 | ||
b622d2f7 ZJS |
229 | r = loop_write(exe_name_pipe[1], pagers[i], strlen(pagers[i]) + 1, false); |
230 | if (r < 0) { | |
1d788908 | 231 | log_error_errno(r, "Failed to write pager name to socket: %m"); |
6432da6a | 232 | _exit(EXIT_FAILURE); |
1d788908 | 233 | } |
1968a360 | 234 | |
b622d2f7 ZJS |
235 | if (i < ELEMENTSOF(pagers) - 1) { |
236 | execlp(pagers[i], pagers[i], NULL); | |
237 | log_full_errno(errno == ENOENT ? LOG_DEBUG : LOG_WARNING, errno, | |
238 | "Failed to execute '%s', will try '%s' next: %m", pagers[i], pagers[i+1]); | |
239 | } else { | |
240 | /* Close pipe to signal the parent to start sending data */ | |
241 | safe_close_pair(exe_name_pipe); | |
242 | pager_fallback(); | |
243 | assert_not_reached(); | |
244 | } | |
1d788908 | 245 | } |
1968a360 LP |
246 | } |
247 | ||
248 | /* Return in the parent */ | |
a45e7bb4 MS |
249 | stored_stdout = fcntl(STDOUT_FILENO, F_DUPFD_CLOEXEC, 3); |
250 | if (dup2(fd[1], STDOUT_FILENO) < 0) { | |
251 | stored_stdout = safe_close(stored_stdout); | |
384c2c32 | 252 | return (void) log_error_errno(errno, "Failed to duplicate pager pipe: %m"); |
a45e7bb4 MS |
253 | } |
254 | stdout_redirected = true; | |
255 | ||
256 | stored_stderr = fcntl(STDERR_FILENO, F_DUPFD_CLOEXEC, 3); | |
257 | if (dup2(fd[1], STDERR_FILENO) < 0) { | |
258 | stored_stderr = safe_close(stored_stderr); | |
384c2c32 | 259 | return (void) log_error_errno(errno, "Failed to duplicate pager pipe: %m"); |
a45e7bb4 MS |
260 | } |
261 | stderr_redirected = true; | |
1968a360 | 262 | |
6432da6a ZJS |
263 | exe_name_pipe[1] = safe_close(exe_name_pipe[1]); |
264 | ||
265 | r = no_quit_on_interrupt(TAKE_FD(exe_name_pipe[0]), less_opts); | |
6432da6a | 266 | if (r > 0) |
9c274488 | 267 | (void) ignore_signals(SIGINT); |
1968a360 LP |
268 | } |
269 | ||
270 | void pager_close(void) { | |
271 | ||
272 | if (pager_pid <= 0) | |
273 | return; | |
274 | ||
275 | /* Inform pager that we are done */ | |
a45e7bb4 | 276 | (void) fflush(stdout); |
77018a8c MS |
277 | if (stdout_redirected) |
278 | if (stored_stdout < 0 || dup2(stored_stdout, STDOUT_FILENO) < 0) | |
279 | (void) close(STDOUT_FILENO); | |
a45e7bb4 MS |
280 | stored_stdout = safe_close(stored_stdout); |
281 | (void) fflush(stderr); | |
77018a8c MS |
282 | if (stderr_redirected) |
283 | if (stored_stderr < 0 || dup2(stored_stderr, STDERR_FILENO) < 0) | |
284 | (void) close(STDERR_FILENO); | |
a45e7bb4 MS |
285 | stored_stderr = safe_close(stored_stderr); |
286 | stdout_redirected = stderr_redirected = false; | |
8b5264aa | 287 | |
74ca738f | 288 | (void) kill(pager_pid, SIGCONT); |
8f03de53 | 289 | (void) wait_for_terminate(TAKE_PID(pager_pid), NULL); |
1968a360 LP |
290 | pager_pid = 0; |
291 | } | |
f89a3b6f LP |
292 | |
293 | bool pager_have(void) { | |
294 | return pager_pid > 0; | |
295 | } | |
78002a67 ZJS |
296 | |
297 | int show_man_page(const char *desc, bool null_stdio) { | |
298 | const char *args[4] = { "man", NULL, NULL, NULL }; | |
299 | char *e = NULL; | |
300 | pid_t pid; | |
301 | size_t k; | |
302 | int r; | |
78002a67 ZJS |
303 | |
304 | k = strlen(desc); | |
305 | ||
306 | if (desc[k-1] == ')') | |
307 | e = strrchr(desc, '('); | |
308 | ||
309 | if (e) { | |
310 | char *page = NULL, *section = NULL; | |
311 | ||
2f82562b LP |
312 | page = strndupa_safe(desc, e - desc); |
313 | section = strndupa_safe(e + 1, desc + k - e - 2); | |
78002a67 ZJS |
314 | |
315 | args[1] = section; | |
316 | args[2] = page; | |
317 | } else | |
318 | args[1] = desc; | |
319 | ||
0672e2c6 | 320 | r = safe_fork("(man)", FORK_RESET_SIGNALS|FORK_DEATHSIG|(null_stdio ? FORK_NULL_STDIO : 0)|FORK_RLIMIT_NOFILE_SAFE|FORK_LOG, &pid); |
4c253ed1 | 321 | if (r < 0) |
b6e1fff1 | 322 | return r; |
4c253ed1 | 323 | if (r == 0) { |
78002a67 | 324 | /* Child */ |
78002a67 | 325 | execvp(args[0], (char**) args); |
56f64d95 | 326 | log_error_errno(errno, "Failed to execute man: %m"); |
78002a67 ZJS |
327 | _exit(EXIT_FAILURE); |
328 | } | |
329 | ||
2e87a1fd | 330 | return wait_for_terminate_and_check(NULL, pid, 0); |
78002a67 | 331 | } |