3 # Copyright (c) 2010-2015 Devin Teske
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
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.
15 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 ############################################################ INCLUDES
31 # Prevent `-d' from being interpreted as a debug flag by common.subr
32 DEBUG_SELF_INITIALIZE=
34 BSDCFG_SHARE="/usr/share/bsdconfig"
35 [ "$_COMMON_SUBR" ] || . $BSDCFG_SHARE/common.subr || exit 1
36 [ "$_SYSRC_SUBR" ] || f_include $BSDCFG_SHARE/sysrc.subr
38 ############################################################ GLOBALS
43 SYSRC_VERSION="6.3 Mar-4,2015"
62 ############################################################ FUNCTIONS
64 # die [ $fmt [ $opts ... ]]
66 # Optionally print a message to stderr before exiting with failure status.
71 [ $# -gt 0 ] && shift 1
72 [ "$fmt" ] && f_err "$fmt\n" "$@"
79 # Prints a short syntax statement and exits.
83 f_err "Usage: %s [OPTIONS] name[[+]=value] ...\n" "$pgm"
84 f_err "Try \`%s --help' for more information.\n" "$pgm"
90 # Prints a full syntax statement and exits.
94 local optfmt="\t%-11s%s\n"
95 local envfmt="\t%-17s%s\n"
97 f_err "Usage: %s [OPTIONS] name[[+|-]=value] ...\n" "$pgm"
100 f_err "$optfmt" "-a" \
101 "Dump a list of all non-default configuration variables."
102 f_err "$optfmt" "-A" \
103 "Dump a list of all configuration variables (incl. defaults)."
104 f_err "$optfmt" "-c" \
105 "Check. Return success if set or no changes, else error."
106 f_err "$optfmt" "-d" \
107 "Print a description of the given variable."
108 f_err "$optfmt" "-D" \
109 "Show default value(s) only (this is the same as setting"
111 "RC_CONFS to NULL or passing \`-f' with a NULL file-argument)."
112 f_err "$optfmt" "-e" \
113 "Print query results as \`var=value' (useful for producing"
115 "output to be fed back in). Ignored if \`-n' is specified."
116 f_err "$optfmt" "-f file" \
117 "Operate on the specified file(s) instead of rc_conf_files."
119 "Can be specified multiple times for additional files."
120 f_err "$optfmt" "-F" \
121 "Show only the last rc.conf(5) file each directive is in."
122 f_err "$optfmt" "-h" \
123 "Print a short usage statement to stderr and exit."
124 f_err "$optfmt" "--help" \
125 "Print this message to stderr and exit."
126 f_err "$optfmt" "-i" \
127 "Ignore unknown variables."
128 f_err "$optfmt" "-j jail" \
129 "The jid or name of the jail to operate within (overrides"
131 "\`-R dir'; requires jexec(8))."
132 f_err "$optfmt" "-n" \
133 "Show only variable values, not their names."
134 f_err "$optfmt" "-N" \
135 "Show only variable names, not their values."
136 f_err "$optfmt" "-q" \
137 "Quiet. Disable verbose and hide certain errors."
138 f_err "$optfmt" "-R dir" \
139 "Operate within the root directory \`dir' rather than \`/'."
140 f_err "$optfmt" "-v" \
141 "Verbose. Print the pathname of the specific rc.conf(5)"
143 "file where the directive was found."
144 f_err "$optfmt" "--version" \
145 "Print version information to stdout and exit."
146 f_err "$optfmt" "-x" \
147 "Remove variable(s) from specified file(s)."
150 f_err "ENVIRONMENT:\n"
151 f_err "$envfmt" "RC_CONFS" \
152 "Override default rc_conf_files (even if set to NULL)."
153 f_err "$envfmt" "RC_DEFAULTS" \
154 "Location of \`/etc/defaults/rc.conf' file."
161 # Dump dependencies such as language-file variables and include files to stdout
162 # to be piped-into sh(1) running via jexec(8)/chroot(8). As a security measure,
163 # this prevents existing language files and library files from being loaded in
164 # the jail. This also relaxes the requirement to have these files in every jail
165 # before sysrc can be used on said jail.
170 # Indicate that we are jailed
172 echo export _SYSRC_JAILED=1
175 # Print i18n language variables (their current values are sanitized
176 # and re-printed for interpretation so that the i18n language files
177 # do not need to exist within the jail).
181 msg_cannot_create_permission_denied \
182 msg_permission_denied \
183 msg_previous_syntax_errors \
185 val=$( eval echo \"\$$var\" |
186 awk '{ gsub(/'\''/, "'\''\\'\'\''"); print }' )
191 # Print include dependencies
193 echo DEBUG_SELF_INITIALIZE=
194 cat $BSDCFG_SHARE/common.subr
195 cat $BSDCFG_SHARE/sysrc.subr
198 ############################################################ MAIN SOURCE
201 # Perform sanity checks
203 [ $# -gt 0 ] || usage
206 # Check for `--help' and `--version' command-line option
208 ( # Operate in sub-shell to protect $@ in parent
209 while [ $# -gt 0 ]; do
212 --version) # see GLOBALS
213 echo "$SYSRC_VERSION"
215 -[fRj]) # These flags take an argument
224 # Process command-line flags
226 while getopts aAcdDef:Fhij:nNqR:vxX flag; do
228 a) SHOW_ALL=${SHOW_ALL:-1};;
234 f) RC_CONFS="$RC_CONFS${RC_CONFS:+ }$OPTARG";;
237 i) IGNORE_UNKNOWNS=1;;
238 j) [ "$OPTARG" ] || die \
239 "%s: Missing or null argument to \`-j' flag" "$pgm"
243 q) QUIET=1 SYSRC_VERBOSE=;;
244 R) [ "$OPTARG" ] || die \
245 "%s: Missing or null argument to \`-R' flag" "$pgm"
247 v) SYSRC_VERBOSE=1 QUIET=;;
248 x) DELETE=${DELETE:-1};;
253 shift $(( $OPTIND - 1 ))
256 # [More] Sanity checks (e.g., "sysrc --")
258 [ $# -eq 0 -a ! "$SHOW_ALL" ] && usage
261 # Taint-check all rc.conf(5) files
263 errmsg="$pgm: Exiting due to previous syntax errors"
264 if [ "${RC_CONFS+set}" ]; then
265 ( for i in $RC_CONFS; do
266 [ -e "$i" ] || continue
267 /bin/sh -n "$i" || exit $FAILURE
272 /bin/sh -n "$RC_DEFAULTS" || die "$errmsg"
274 for i in $rc_conf_files; do
275 [ -e "$i" ] || continue
276 /bin/sh -n "$i" || exit $FAILURE
283 # Process `-x' (and secret `-X') command-line options
285 errmsg="$pgm: \`-x' option incompatible with \`-a'/\`-A' options"
286 errmsg="$errmsg (use \`-X' to override)"
287 if [ "$DELETE" -a "$SHOW_ALL" ]; then
288 [ "$DELETE" = "2" ] || die "$errmsg"
292 # Pre-flight for `-c' command-line option
294 [ "$CHECK_ONLY" -a "$SHOW_ALL" ] &&
295 die "$pgm: \`-c' option incompatible with \`-a'/\`-A' options"
298 # Process `-e', `-n', and `-N' command-line options
301 [ "$SHOW_FILE" ] && SHOW_EQUALS=
302 [ "$SHOW_NAME" ] || SHOW_EQUALS=
303 [ "$SYSRC_VERBOSE" = "0" ] && SYSRC_VERBOSE=
304 if [ ! "$SHOW_VALUE" ]; then
308 [ "$SHOW_EQUALS" ] && SEP='="'
311 # Process `-j jail' and `-R dir' command-line options
313 if [ "$JAIL" -o "$ROOTDIR" ]; then
315 # Reconstruct the arguments that we want to carry-over
320 $( [ "$DELETE" = "1" ] && echo \ -x )
321 $( [ "$DELETE" = "2" ] && echo \ -X )
322 $( [ "$SHOW_ALL" = "1" ] && echo \ -a )
323 $( [ "$SHOW_ALL" = "2" ] && echo \ -A )
327 ${IGNORE_UNKNOWNS:+-i}
328 $( [ "$SHOW_NAME" ] || echo \ -n )
329 $( [ "$SHOW_VALUE" ] || echo \ -N )
330 $( [ "$SHOW_FILE" ] && echo \ -F )
332 if [ "${RC_CONFS+set}" ]; then
333 args="$args -f '$RC_CONFS'"
340 # If both are supplied, `-j jail' supercedes `-R dir'
344 # Re-execute ourselves with sh(1) via jexec(8)
349 ) | env - RC_DEFAULTS="$RC_DEFAULTS" \
350 /usr/sbin/jexec "$JAIL" /bin/sh
352 elif [ "$ROOTDIR" ]; then
354 # Make sure that the root directory specified is not to any
357 # NOTE: To maintain backward compatibility with older jails on
358 # older systems, we will not perform this check if either the
359 # jls(1) or jexec(8) utilities are missing.
361 if f_have jexec && f_have jls; then
362 jid="`jls jid path | \
364 while read JID JROOT; do
365 [ "$JROOT" = "$ROOTDIR" ] || continue
371 # If multiple running jails match the specified root
372 # directory, exit with error.
374 if [ "$jid" -a "${jid%[$IFS]*}" != "$jid" ]; then
375 die "%s: %s: %s" "$pgm" "$ROOTDIR" \
376 "$( echo "Multiple jails claim this" \
377 "directory as their root." \
378 "(use \`-j jail' instead)" )"
382 # If only a single running jail matches the specified
383 # root directory, implicitly use `-j jail'.
387 # Re-execute outselves with sh(1) via jexec(8)
392 ) | env - RC_DEFAULTS="$RC_DEFAULTS" \
393 /usr/sbin/jexec "$jid" /bin/sh
397 # Otherwise, fall through and allow chroot(8)
401 # Re-execute ourselves with sh(1) via chroot(8)
406 ) | env - RC_DEFAULTS="$RC_DEFAULTS" \
407 /usr/sbin/chroot "$ROOTDIR" /bin/sh
413 # Process `-a' or `-A' command-line options
415 if [ "$SHOW_ALL" ]; then
417 # Get a list of variables that are currently set in the rc.conf(5)
418 # files (included `/etc/defaults/rc.conf') by performing a call to
419 # source_rc_confs() in a clean environment.
421 ( # Operate in a sub-shell to protect the parent environment
423 # Set which variables we want to preserve in the environment.
424 # Append the pipe-character (|) to the list of internal field
425 # separation (IFS) characters, allowing us to use the below
426 # list both as an extended grep (-E) pattern and argument list
427 # (required to first get f_clean_env() to preserve these in the
428 # environment and then later to prune them from the list of
429 # variables produced by set(1)).
432 EXCEPT="IFS|EXCEPT|PATH|RC_DEFAULTS|OPTIND|DESCRIBE|SEP"
433 EXCEPT="$EXCEPT|DELETE|SHOW_ALL|SHOW_EQUALS|SHOW_NAME"
434 EXCEPT="$EXCEPT|SHOW_VALUE|SHOW_FILE|SYSRC_VERBOSE|RC_CONFS"
435 EXCEPT="$EXCEPT|pgm|SUCCESS|FAILURE|CHECK_ONLY"
436 EXCEPT="$EXCEPT|f_sysrc_desc_awk|f_sysrc_delete_awk"
439 # Clean the environment (except for our required variables)
440 # and then source the required files.
442 f_clean_env --except $EXCEPT
443 if [ -f "$RC_DEFAULTS" -a -r "$RC_DEFAULTS" ]; then
447 # If passed `-a' (rather than `-A'), re-purge the
448 # environment, removing the rc.conf(5) defaults.
450 [ "$SHOW_ALL" = "1" ] \
451 && f_clean_env --except rc_conf_files $EXCEPT
454 # If `-f file' was passed, set $rc_conf_files to an
455 # explicit value, modifying the default behavior of
458 [ "${RC_CONFS+set}" ] && rc_conf_files="$RC_CONFS"
463 # If passed `-a' (rather than `-A'), remove
464 # `rc_conf_files' unless it was defined somewhere
465 # other than rc.conf(5) defaults.
467 [ "$SHOW_ALL" = "1" -a \
468 "$( f_sysrc_find rc_conf_files )" = "$RC_DEFAULTS" \
470 && unset rc_conf_files
474 awk -F= '/^[[:alpha:]_][[:alnum:]_]*=/ {print $1}' |
475 grep -Ev "^($EXCEPT)$"
478 # If enabled, describe rather than expand value
480 if [ "$DESCRIBE" ]; then
481 echo "$NAME: $( f_sysrc_desc "$NAME" )"
486 # If `-F' is passed, find it and move on
488 if [ "$SHOW_FILE" ]; then
489 [ "$SHOW_NAME" ] && echo -n "$NAME: "
495 # If `-X' is passed, delete the variables
497 if [ "$DELETE" = "2" ]; then
498 f_sysrc_delete "$NAME"
502 [ "$SYSRC_VERBOSE" ] && \
503 echo -n "$( f_sysrc_find "$NAME" ): "
506 # If `-N' is passed, simplify the output
508 if [ ! "$SHOW_VALUE" ]; then
513 echo "${SHOW_NAME:+$NAME$SEP}$(
514 f_sysrc_get "$NAME" )${SHOW_EQUALS:+\"}"
520 # Ignore the remainder of positional arguments.
526 # Process command-line arguments
529 while [ $# -gt 0 ]; do
533 *+) mode=APPEND NAME="${NAME%+}" ;;
534 *-) mode=REMOVE NAME="${NAME%-}" ;;
539 echo "$NAME: $( f_sysrc_desc "$NAME" )"
544 # Like sysctl(8), if both `-d' AND "name=value" is passed,
545 # first describe (done above), then attempt to set
548 # If verbose, prefix line with where the directive lives
549 if [ "$SYSRC_VERBOSE" -a ! "$CHECK_ONLY" ]; then
550 file=$( f_sysrc_find "$NAME" )
551 [ "$file" = "$RC_DEFAULTS" -o ! "$file" ] && \
552 file=$( f_sysrc_get 'rc_conf_files%%[$IFS]*' )
553 if [ "$SHOW_EQUALS" ]; then
561 # If `-x' or `-X' is passed, delete the variable and ignore the
562 # desire to set some value
564 if [ "$DELETE" ]; then
565 f_sysrc_delete "$NAME" || status=$FAILURE
571 # If `-c' is passed, simply compare and move on
573 if [ "$CHECK_ONLY" ]; then
574 if ! IGNORED=$( f_sysrc_get "$NAME?" ); then
576 [ "$SYSRC_VERBOSE" ] &&
577 echo "$NAME: not currently set"
581 value=$( f_sysrc_get "$NAME" )
582 if [ "$value" != "${1#*=}" ]; then
584 if [ "$SYSRC_VERBOSE" ]; then
585 echo -n "$( f_sysrc_find "$NAME" ): "
586 echo -n "$NAME: would change from "
587 echo "\`$value' to \`${1#*=}'"
589 elif [ "$SYSRC_VERBOSE" ]; then
590 echo -n "$( f_sysrc_find "$NAME" ): "
591 echo "$NAME: already set to \`$value'"
598 # Determine both `before' value and appropriate `new' value
602 before=$( f_sysrc_get "$NAME" )
604 delim="${add%"${add#?}"}" # first character
607 ""|[$IFS]|[a-zA-Z0-9]) delim=" " ;;
615 [ "$b" = "$a" ] && skip=1 break
617 [ "$skip" ] || new="$new$delim$a"
619 new="${new#"$delim"}" IFS="$oldIFS"
620 unset add delim oldIFS a skip b
621 [ "$SHOW_FILE" ] && before=$( f_sysrc_find "$NAME" )
624 before=$( f_sysrc_get "$NAME" )
626 delim="${remove%"${remove#?}"}" # first character
629 ""|[$IFS]|[a-zA-Z0-9]) delim=" " ;;
637 [ "$r" = "$b" ] && add= break
639 [ "$add" ] && new="$new$delim$b"
641 new="${new#"$delim"}" IFS="$oldIFS"
642 unset remove delim oldIFS b add r
643 [ "$SHOW_FILE" ] && before=$( f_sysrc_find "$NAME" )
646 if [ "$SHOW_FILE" ]; then
647 before=$( f_sysrc_find "$NAME" )
649 before=$( f_sysrc_get "$NAME" )
655 # If `-N' is passed, simplify the output
657 if [ ! "$SHOW_VALUE" ]; then
659 f_sysrc_set "$NAME" "$new"
661 if f_sysrc_set "$NAME" "$new"; then
662 if [ "$SHOW_FILE" ]; then
663 after=$( f_sysrc_find "$NAME" )
665 after=$( f_sysrc_get "$NAME" )
667 echo -n "${SHOW_NAME:+$NAME$SEP}"
668 echo -n "$before${SHOW_EQUALS:+\" #}"
669 echo -n " -> ${SHOW_EQUALS:+\"}$after"
670 echo "${SHOW_EQUALS:+\"}"
675 if ! IGNORED=$( f_sysrc_get "$NAME?" ); then
676 [ "$IGNORE_UNKNOWNS" -o "$QUIET" ] ||
677 echo "$pgm: unknown variable '$NAME'"
683 # The above check told us what we needed for `-c'
684 if [ "$CHECK_ONLY" ]; then
690 # Like sysctl(8), when `-d' is passed, desribe it
691 # (already done above) rather than expanding it
694 if [ "$DESCRIBE" ]; then
700 # If `-x' or `-X' is passed, delete the variable
702 if [ "$DELETE" ]; then
703 f_sysrc_delete "$NAME" || status=$FAILURE
709 # If `-F' is passed, find it and move on
711 if [ "$SHOW_FILE" ]; then
712 [ "$SHOW_NAME" ] && echo -n "$NAME: "
718 if [ "$SYSRC_VERBOSE" ]; then
719 if [ "$SHOW_EQUALS" ]; then
720 echo -n ": $( f_sysrc_find "$NAME" ); "
722 echo -n "$( f_sysrc_find "$NAME" ): "
727 # If `-N' is passed, simplify the output
729 if [ ! "$SHOW_VALUE" ]; then
732 echo "${SHOW_NAME:+$NAME$SEP}$(
733 f_sysrc_get "$NAME" )${SHOW_EQUALS:+\"}"
739 exit $status # $SUCCESS unless error occurred with either `-c' or `-x'
741 ################################################################################
743 ################################################################################