svc-pkg-depot revision 1527
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews# CDDL HEADER START
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# The contents of this file are subject to the terms of the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Common Development and Distribution License (the "License").
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# You may not use this file except in compliance with the License.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# See the License for the specific language governing permissions
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# and limitations under the License.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# When distributing Covered Code, include this CDDL HEADER in each
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# If applicable, add the following below this CDDL HEADER, with the
cedb0bd0c1e3c461b7e479a16d3adfd5b150f1f4Mark Andrews# fields enclosed by brackets "[]" replaced with your own identifying
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# information: Portions Copyright [yyyy] [name of copyright owner]
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# CDDL HEADER END
cedb0bd0c1e3c461b7e479a16d3adfd5b150f1f4Mark Andrews# Copyright 2009 Sun Microsystems, Inc. All rights reserved.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Use is subject to license terms.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Load SMF constants and functions
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austeinif [[ -z "$SMF_FMRI" ]]; then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "this script can only be invoked by smf(5)"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Handles depot startup
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # boolean_props are properties which are communicated to the depot
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # via a flag being present or absent on the command line.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # short_option_props are properties which are communicated to the depot
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # via a single character flag which takes an argument.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein short_option_props="inst_root port threads socket_timeout"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # short_option_props are properties which are communicated to the depot
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # via a long option flag which takes an argument.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein long_option_props="cfg_file content_root debug log_access log_errors \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein proxy_base sort_file_max_size ssl_cert_file ssl_dialog ssl_key_file \
cedb0bd0c1e3c461b7e479a16d3adfd5b150f1f4Mark Andrews writable_root"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein set -A long_option_cmd_line "cfg-file" "content-root" "debug" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "log-access" "log-errors" "proxy-base" "sort-file-max-size" \
cedb0bd0c1e3c461b7e479a16d3adfd5b150f1f4Mark Andrews "ssl-cert-file" "ssl-dialog" "ssl-key-file" "writable-root"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # retrieve the pkg_root property. If the variable is left empty
cedb0bd0c1e3c461b7e479a16d3adfd5b150f1f4Mark Andrews # pkg_root is /
cedb0bd0c1e3c461b7e479a16d3adfd5b150f1f4Mark Andrews echo "service property pkg/pkg_root not defined for" \
cedb0bd0c1e3c461b7e479a16d3adfd5b150f1f4Mark Andrews # make sure pkg_root ends with a /
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # adjust the PYTHONPATH to point to the current environment
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # we need to make sure to adjust the PYTHONPATH accordingly
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # to a Python 2.4 or 2.6 environment
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein python_ver=$(head -1 ${pkg_root}usr/lib/pkg.depotd 2>/dev/null |
cedb0bd0c1e3c461b7e479a16d3adfd5b150f1f4Mark Andrews echo "invalid python version $python_ver found in"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "${pkg_root}usr/lib/pkg.depotd"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein PYTHONPATH=${pkg_root}usr/lib/${python_ver}/vendor-packages/:$PYTHONPATH
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Go through each property in boolean_props and, if its value is set
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # to true in SMF, add the appropriate command line flag to the string.
cedb0bd0c1e3c461b7e479a16d3adfd5b150f1f4Mark Andrews echo "service property pkg/$b not defined for" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # If the property is set to true, add the flag.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein bool_ops="$bool_ops --${boolean_cmd_line[$cnt]}"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Go through each property in short_option_props and, if its value is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # set to something other than "", add the appropriate command line
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # flag and argument to the string.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "service property pkg/$o not defined for" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # If the SMF property is set to something other than 'none', add
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # the flag and its argument to the command.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein option_ops="$option_ops -${short_option_cmd_line[$cnt]} $val"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Go through each property in long_option_props and, if its value is
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # set to something other than "", add the appropriate command line
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # flag and argument to the string.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "service property pkg/$o not defined for" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # check if content_root is a relative or absolute path, if
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # relative append to pkg_root
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [[ $o == 'content_root' ]]; then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # pkg_root has been checked to end with a slash
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # If the SMF property is set to something other than 'none', add
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # the flag and its argument to the command.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [[ $o == 'ssl_dialog' && $val == 'smf' ]]; then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein option_ops="$option_ops --${long_option_cmd_line[$cnt]}=smf:$SMF_FMRI"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein option_ops="$option_ops --${long_option_cmd_line[$cnt]}=$val"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Determine if fork and exec are needed.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews echo "option_ops: [$option_ops]"
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews if [[ "$option_ops" == *--ssl-dialog=@(smf|exec):* && \
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews "$option_ops" != *'--ssl-key-file=none'* ]]; then
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews if [[ "$option_ops" == *'--writable-root='* ]]; then
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews # If we don't need them, drop fork and exec.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "Dropping fork(2) and exec(2) privileges."
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # If this process has net_privaddr, then we pass it along.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # If not, we ensure that we don't specify it, since that will
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # cause ppriv to throw an error.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ppriv -v $$ | grep 'E: ' | grep net_privaddr > /dev/null 2>&1
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if [[ $? == 0 ]]; then
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "Dropping net_privaddr privilege."
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # We build up the privileges available starting with "basic".
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # This provides some protection even when the depot runs as root.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein wrapper="ppriv -s A=basic,-file_link_any,-proc_info,-proc_session$privaddr$forkexec -e"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Build the command to start pkg.depotd with the specified options.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein cmd="$wrapper ${pkg_root}usr/lib/pkg.depotd $bool_ops $option_ops"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Echo the command so that the log contains the command used to start
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # the depot.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Strategy: First, try shutting down depot using polite kill. Use up
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # as much as possible of the allotted timeout period waiting for polite
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # kill to take effect. As time runs out, try a more aggressive kill.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein SVC_TIMEOUT=`svcprop -p stop/timeout_seconds $SMF_FMRI`
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "service property stop/timeout_seconds not defined" \
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein "for service: $SMF_FMRI"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Note that we're working around an oddity in smf_kill_contract: it
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # waits in 5 second chunks and can overshoot the specified timeout
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # by as many as 4 seconds. Example: a specified wait of 6 will result
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # in a wait of 10 seconds in reality. Since we may potentially do a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # first kill and then a second, we must ensure that at least 8 seconds
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # of slop is left in reserve. To be paranoid, we go for 10.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # '2' indicates timeout with non-empty contract.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "Gentle contract kill timed out after"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # Again, despite the specified timeout, this will
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # take a minimum of 5 seconds to complete.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein # If the timeout is too short, we just try once, politely.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein echo "Usage: $0 { start | stop }"