1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
|
#!/bin/sh
#-
# Copyright (c) 2010-2014 Devin Teske
# All rights reserved.
#
# 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.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
#
# $FreeBSD$
#
############################################################ INCLUDES
# Prevent `-d' from being interpreted as a debug flag by common.subr
DEBUG_SELF_INITIALIZE=
BSDCFG_SHARE="/usr/share/bsdconfig"
[ "$_COMMON_SUBR" ] || . $BSDCFG_SHARE/common.subr || exit 1
[ "$_SYSRC_SUBR" ] || f_include $BSDCFG_SHARE/sysrc.subr
############################################################ GLOBALS
#
# Version information
#
SYSRC_VERSION="6.1 Jul-18,2014"
#
# Options
#
CHECK_ONLY=
DELETE=
DESCRIBE=
IGNORE_UNKNOWNS=
JAIL=
QUIET=
ROOTDIR=
SHOW_ALL=
SHOW_EQUALS=
SHOW_FILE=
SHOW_NAME=1
SHOW_VALUE=1
SYSRC_VERBOSE=
############################################################ FUNCTIONS
# die [ $fmt [ $opts ... ]]
#
# Optionally print a message to stderr before exiting with failure status.
#
die()
{
local fmt="$1"
[ $# -gt 0 ] && shift 1
[ "$fmt" ] && f_err "$fmt\n" "$@"
exit $FAILURE
}
# usage
#
# Prints a short syntax statement and exits.
#
usage()
{
f_err "Usage: %s [OPTIONS] name[=value] ...\n" "$pgm"
f_err "Try \`%s --help' for more information.\n" "$pgm"
die
}
# help
#
# Prints a full syntax statement and exits.
#
help()
{
local optfmt="\t%-11s%s\n"
local envfmt="\t%-17s%s\n"
f_err "Usage: %s [OPTIONS] name[=value] ...\n" "$pgm"
f_err "OPTIONS:\n"
f_err "$optfmt" "-a" \
"Dump a list of all non-default configuration variables."
f_err "$optfmt" "-A" \
"Dump a list of all configuration variables (incl. defaults)."
f_err "$optfmt" "-c" \
"Check. Return success if set or no changes, else error."
f_err "$optfmt" "-d" \
"Print a description of the given variable."
f_err "$optfmt" "-D" \
"Show default value(s) only (this is the same as setting"
f_err "$optfmt" "" \
"RC_CONFS to NULL or passing \`-f' with a NULL file-argument)."
f_err "$optfmt" "-e" \
"Print query results as \`var=value' (useful for producing"
f_err "$optfmt" "" \
"output to be fed back in). Ignored if \`-n' is specified."
f_err "$optfmt" "-f file" \
"Operate on the specified file(s) instead of rc_conf_files."
f_err "$optfmt" "" \
"Can be specified multiple times for additional files."
f_err "$optfmt" "-F" \
"Show only the last rc.conf(5) file each directive is in."
f_err "$optfmt" "-h" \
"Print a short usage statement to stderr and exit."
f_err "$optfmt" "--help" \
"Print this message to stderr and exit."
f_err "$optfmt" "-i" \
"Ignore unknown variables."
f_err "$optfmt" "-j jail" \
"The jid or name of the jail to operate within (overrides"
f_err "$optfmt" "" \
"\`-R dir'; requires jexec(8))."
f_err "$optfmt" "-n" \
"Show only variable values, not their names."
f_err "$optfmt" "-N" \
"Show only variable names, not their values."
f_err "$optfmt" "-q" \
"Quiet. Disable verbose and hide certain errors."
f_err "$optfmt" "-R dir" \
"Operate within the root directory \`dir' rather than \`/'."
f_err "$optfmt" "-v" \
"Verbose. Print the pathname of the specific rc.conf(5)"
f_err "$optfmt" "" \
"file where the directive was found."
f_err "$optfmt" "--version" \
"Print version information to stdout and exit."
f_err "$optfmt" "-x" \
"Remove variable(s) from specified file(s)."
f_err "\n"
f_err "ENVIRONMENT:\n"
f_err "$envfmt" "RC_CONFS" \
"Override default rc_conf_files (even if set to NULL)."
f_err "$envfmt" "RC_DEFAULTS" \
"Location of \`/etc/defaults/rc.conf' file."
die
}
# jail_depend
#
# Dump dependencies such as language-file variables and include files to stdout
# to be piped-into sh(1) running via jexec(8)/chroot(8). As a security measure,
# this prevents existing language files and library files from being loaded in
# the jail. This also relaxes the requirement to have these files in every jail
# before sysrc can be used on said jail.
#
jail_depend()
{
#
# Indicate that we are jailed
#
echo export _SYSRC_JAILED=1
#
# Print i18n language variables (their current values are sanitized
# and re-printed for interpretation so that the i18n language files
# do not need to exist within the jail).
#
local var val
for var in \
msg_cannot_create_permission_denied \
msg_permission_denied \
msg_previous_syntax_errors \
; do
val=$( eval echo \"\$$var\" |
awk '{ gsub(/'\''/, "'\''\\'\'\''"); print }' )
echo $var="'$val'"
done
#
# Print include dependencies
#
echo DEBUG_SELF_INITIALIZE=
cat $BSDCFG_SHARE/common.subr
cat $BSDCFG_SHARE/sysrc.subr
}
############################################################ MAIN SOURCE
#
# Perform sanity checks
#
[ $# -gt 0 ] || usage
#
# Check for `--help' and `--version' command-line option
#
( # Operate in sub-shell to protect $@ in parent
while [ $# -gt 0 ]; do
case "$1" in
--help) help ;;
--version) # see GLOBALS
echo "$SYSRC_VERSION"
exit 1 ;;
-[fRj]) # These flags take an argument
shift 1 ;;
esac
shift 1
done
exit 0
) || die
#
# Process command-line flags
#
while getopts aAcdDef:Fhij:nNqR:vxX flag; do
case "$flag" in
a) SHOW_ALL=${SHOW_ALL:-1};;
A) SHOW_ALL=2;;
c) CHECK_ONLY=1;;
d) DESCRIBE=1;;
D) RC_CONFS=;;
e) SHOW_EQUALS=1;;
f) RC_CONFS="$RC_CONFS${RC_CONFS:+ }$OPTARG";;
F) SHOW_FILE=1;;
h) usage;;
i) IGNORE_UNKNOWNS=1;;
j) [ "$OPTARG" ] || die \
"%s: Missing or null argument to \`-j' flag" "$pgm"
JAIL="$OPTARG";;
n) SHOW_NAME=;;
N) SHOW_VALUE=;;
q) QUIET=1 SYSRC_VERBOSE=;;
R) [ "$OPTARG" ] || die \
"%s: Missing or null argument to \`-R' flag" "$pgm"
ROOTDIR="$OPTARG";;
v) SYSRC_VERBOSE=1 QUIET=;;
x) DELETE=${DELETE:-1};;
X) DELETE=2;;
\?) usage;;
esac
done
shift $(( $OPTIND - 1 ))
#
# [More] Sanity checks (e.g., "sysrc --")
#
[ $# -eq 0 -a ! "$SHOW_ALL" ] && usage
#
# Taint-check all rc.conf(5) files
#
errmsg="$pgm: Exiting due to previous syntax errors"
if [ "${RC_CONFS+set}" ]; then
( for i in $RC_CONFS; do
[ -e "$i" ] || continue
/bin/sh -n "$i" || exit $FAILURE
done
exit $SUCCESS
) || die "$errmsg"
else
/bin/sh -n "$RC_DEFAULTS" || die "$errmsg"
( . "$RC_DEFAULTS"
for i in $rc_conf_files; do
[ -e "$i" ] || continue
/bin/sh -n "$i" || exit $FAILURE
done
exit $SUCCESS
) || die "$errmsg"
fi
#
# Process `-x' (and secret `-X') command-line options
#
errmsg="$pgm: \`-x' option incompatible with \`-a'/\`-A' options"
errmsg="$errmsg (use \`-X' to override)"
if [ "$DELETE" -a "$SHOW_ALL" ]; then
[ "$DELETE" = "2" ] || die "$errmsg"
fi
#
# Pre-flight for `-c' command-line option
#
[ "$CHECK_ONLY" -a "$SHOW_ALL" ] &&
die "$pgm: \`-c' option incompatible with \`-a'/\`-A' options"
#
# Process `-e', `-n', and `-N' command-line options
#
SEP=': '
[ "$SHOW_FILE" ] && SHOW_EQUALS=
[ "$SHOW_NAME" ] || SHOW_EQUALS=
[ "$SYSRC_VERBOSE" = "0" ] && SYSRC_VERBOSE=
if [ ! "$SHOW_VALUE" ]; then
SHOW_NAME=1
SHOW_EQUALS=
fi
[ "$SHOW_EQUALS" ] && SEP='="'
#
# Process `-j jail' and `-R dir' command-line options
#
if [ "$JAIL" -o "$ROOTDIR" ]; then
#
# Reconstruct the arguments that we want to carry-over
#
args="
${SYSRC_VERBOSE:+-v}
${QUIET:+-q}
$( [ "$DELETE" = "1" ] && echo \ -x )
$( [ "$DELETE" = "2" ] && echo \ -X )
$( [ "$SHOW_ALL" = "1" ] && echo \ -a )
$( [ "$SHOW_ALL" = "2" ] && echo \ -A )
${CHECK_ONLY:+-c}
${DESCRIBE:+-d}
${SHOW_EQUALS:+-e}
${IGNORE_UNKNOWNS:+-i}
$( [ "$SHOW_NAME" ] || echo \ -n )
$( [ "$SHOW_VALUE" ] || echo \ -N )
$( [ "$SHOW_FILE" ] && echo \ -F )
"
if [ "${RC_CONFS+set}" ]; then
args="$args -f '$RC_CONFS'"
fi
for arg in "$@"; do
args="$args '$arg'"
done
#
# If both are supplied, `-j jail' supercedes `-R dir'
#
if [ "$JAIL" ]; then
#
# Re-execute ourselves with sh(1) via jexec(8)
#
( echo set -- $args
jail_depend
cat $0
) | env - RC_DEFAULTS="$RC_DEFAULTS" \
/usr/sbin/jexec "$JAIL" /bin/sh
exit $?
elif [ "$ROOTDIR" ]; then
#
# Make sure that the root directory specified is not to any
# running jails.
#
# NOTE: To maintain backward compatibility with older jails on
# older systems, we will not perform this check if either the
# jls(1) or jexec(8) utilities are missing.
#
if f_have jexec && f_have jls; then
jid="`jls jid path | \
(
while read JID JROOT; do
[ "$JROOT" = "$ROOTDIR" ] || continue
echo $JID
done
)`"
#
# If multiple running jails match the specified root
# directory, exit with error.
#
if [ "$jid" -a "${jid%[$IFS]*}" != "$jid" ]; then
die "%s: %s: %s" "$pgm" "$ROOTDIR" \
"$( echo "Multiple jails claim this" \
"directory as their root." \
"(use \`-j jail' instead)" )"
fi
#
# If only a single running jail matches the specified
# root directory, implicitly use `-j jail'.
#
if [ "$jid" ]; then
#
# Re-execute outselves with sh(1) via jexec(8)
#
( echo set -- $args
jail_depend
cat $0
) | env - RC_DEFAULTS="$RC_DEFAULTS" \
/usr/sbin/jexec "$jid" /bin/sh
exit $?
fi
# Otherwise, fall through and allow chroot(8)
fi
#
# Re-execute ourselves with sh(1) via chroot(8)
#
( echo set -- $args
jail_depend
cat $0
) | env - RC_DEFAULTS="$RC_DEFAULTS" \
/usr/sbin/chroot "$ROOTDIR" /bin/sh
exit $?
fi
fi
#
# Process `-a' or `-A' command-line options
#
if [ "$SHOW_ALL" ]; then
#
# Get a list of variables that are currently set in the rc.conf(5)
# files (included `/etc/defaults/rc.conf') by performing a call to
# source_rc_confs() in a clean environment.
#
( # Operate in a sub-shell to protect the parent environment
#
# Set which variables we want to preserve in the environment.
# Append the pipe-character (|) to the list of internal field
# separation (IFS) characters, allowing us to use the below
# list both as an extended grep (-E) pattern and argument list
# (required to first get f_clean_env() to preserve these in the
# environment and then later to prune them from the list of
# variables produced by set(1)).
#
IFS="$IFS|"
EXCEPT="IFS|EXCEPT|PATH|RC_DEFAULTS|OPTIND|DESCRIBE|SEP"
EXCEPT="$EXCEPT|DELETE|SHOW_ALL|SHOW_EQUALS|SHOW_NAME"
EXCEPT="$EXCEPT|SHOW_VALUE|SHOW_FILE|SYSRC_VERBOSE|RC_CONFS"
EXCEPT="$EXCEPT|pgm|SUCCESS|FAILURE|CHECK_ONLY"
EXCEPT="$EXCEPT|f_sysrc_desc_awk|f_sysrc_delete_awk"
#
# Clean the environment (except for our required variables)
# and then source the required files.
#
f_clean_env --except $EXCEPT
if [ -f "$RC_DEFAULTS" -a -r "$RC_DEFAULTS" ]; then
. "$RC_DEFAULTS"
#
# If passed `-a' (rather than `-A'), re-purge the
# environment, removing the rc.conf(5) defaults.
#
[ "$SHOW_ALL" = "1" ] \
&& f_clean_env --except rc_conf_files $EXCEPT
#
# If `-f file' was passed, set $rc_conf_files to an
# explicit value, modifying the default behavior of
# source_rc_confs().
#
[ "${RC_CONFS+set}" ] && rc_conf_files="$RC_CONFS"
source_rc_confs
#
# If passed `-a' (rather than `-A'), remove
# `rc_conf_files' unless it was defined somewhere
# other than rc.conf(5) defaults.
#
[ "$SHOW_ALL" = "1" -a \
"$( f_sysrc_find rc_conf_files )" = "$RC_DEFAULTS" \
] \
&& unset rc_conf_files
fi
for NAME in $( set |
awk -F= '/^[[:alpha:]_][[:alnum:]_]*=/ {print $1}' |
grep -Ev "^($EXCEPT)$"
); do
#
# If enabled, describe rather than expand value
#
if [ "$DESCRIBE" ]; then
echo "$NAME: $( f_sysrc_desc "$NAME" )"
continue
fi
#
# If `-F' is passed, find it and move on
#
if [ "$SHOW_FILE" ]; then
[ "$SHOW_NAME" ] && echo -n "$NAME: "
f_sysrc_find "$NAME"
continue
fi
#
# If `-X' is passed, delete the variables
#
if [ "$DELETE" = "2" ]; then
f_sysrc_delete "$NAME"
continue
fi
[ "$SYSRC_VERBOSE" ] && \
echo -n "$( f_sysrc_find "$NAME" ): "
#
# If `-N' is passed, simplify the output
#
if [ ! "$SHOW_VALUE" ]; then
echo "$NAME"
continue
fi
echo "${SHOW_NAME:+$NAME$SEP}$(
f_sysrc_get "$NAME" )${SHOW_EQUALS:+\"}"
done
)
#
# Ignore the remainder of positional arguments.
#
exit $SUCCESS
fi
#
# Process command-line arguments
#
status=$SUCCESS
while [ $# -gt 0 ]; do
NAME="${1%%=*}"
[ "$DESCRIBE" ] && \
echo "$NAME: $( f_sysrc_desc "$NAME" )"
case "$1" in
*=*)
#
# Like sysctl(8), if both `-d' AND "name=value" is passed,
# first describe (done above), then attempt to set
#
# If verbose, prefix line with where the directive lives
if [ "$SYSRC_VERBOSE" -a ! "$CHECK_ONLY" ]; then
file=$( f_sysrc_find "$NAME" )
[ "$file" = "$RC_DEFAULTS" -o ! "$file" ] && \
file=$( f_sysrc_get 'rc_conf_files%%[$IFS]*' )
if [ "$SHOW_EQUALS" ]; then
echo -n ": $file; "
else
echo -n "$file: "
fi
fi
#
# If `-x' or `-X' is passed, delete the variable and ignore the
# desire to set some value
#
if [ "$DELETE" ]; then
f_sysrc_delete "$NAME" || status=$FAILURE
shift 1
continue
fi
#
# If `-c' is passed, simply compare and move on
#
if [ "$CHECK_ONLY" ]; then
if ! IGNORED=$( f_sysrc_get "$NAME?" ); then
status=$FAILURE
[ "$SYSRC_VERBOSE" ] &&
echo "$NAME: not currently set"
shift 1
continue
fi
value=$( f_sysrc_get "$NAME" )
if [ "$value" != "${1#*=}" ]; then
status=$FAILURE
if [ "$SYSRC_VERBOSE" ]; then
echo -n "$( f_sysrc_find "$NAME" ): "
echo -n "$NAME: would change from "
echo "\`$value' to \`${1#*=}'"
fi
elif [ "$SYSRC_VERBOSE" ]; then
echo -n "$( f_sysrc_find "$NAME" ): "
echo "$NAME: already set to \`$value'"
fi
shift 1
continue
fi
#
# If `-N' is passed, simplify the output
#
if [ ! "$SHOW_VALUE" ]; then
echo "$NAME"
f_sysrc_set "$NAME" "${1#*}"
else
if [ "$SHOW_FILE" ]; then
before=$( f_sysrc_find "$NAME" )
else
before=$( f_sysrc_get "$NAME" )
fi
if f_sysrc_set "$NAME" "${1#*=}"; then
if [ "$SHOW_FILE" ]; then
after=$( f_sysrc_find "$NAME" )
else
after=$( f_sysrc_get "$NAME" )
fi
echo -n "${SHOW_NAME:+$NAME$SEP}"
echo -n "$before${SHOW_EQUALS:+\" #}"
echo -n " -> ${SHOW_EQUALS:+\"}$after"
echo "${SHOW_EQUALS:+\"}"
fi
fi
;;
*)
if ! IGNORED=$( f_sysrc_get "$NAME?" ); then
[ "$IGNORE_UNKNOWNS" -o "$QUIET" ] ||
echo "$pgm: unknown variable '$NAME'"
shift 1
status=$FAILURE
continue
fi
# The above check told us what we needed for `-c'
if [ "$CHECK_ONLY" ]; then
shift 1
continue
fi
#
# Like sysctl(8), when `-d' is passed, desribe it
# (already done above) rather than expanding it
#
if [ "$DESCRIBE" ]; then
shift 1
continue
fi
#
# If `-x' or `-X' is passed, delete the variable
#
if [ "$DELETE" ]; then
f_sysrc_delete "$NAME" || status=$FAILURE
shift 1
continue
fi
#
# If `-F' is passed, find it and move on
#
if [ "$SHOW_FILE" ]; then
[ "$SHOW_NAME" ] && echo -n "$NAME: "
f_sysrc_find "$NAME"
shift 1
continue
fi
if [ "$SYSRC_VERBOSE" ]; then
if [ "$SHOW_EQUALS" ]; then
echo -n ": $( f_sysrc_find "$NAME" ); "
else
echo -n "$( f_sysrc_find "$NAME" ): "
fi
fi
#
# If `-N' is passed, simplify the output
#
if [ ! "$SHOW_VALUE" ]; then
echo "$NAME"
else
echo "${SHOW_NAME:+$NAME$SEP}$(
f_sysrc_get "$NAME" )${SHOW_EQUALS:+\"}"
fi
esac
shift 1
done
exit $status # $SUCCESS unless error occurred with either `-c' or `-x'
################################################################################
# END
################################################################################
|