Cross Reference: /pkg/src/svc/svc-pkg-depot

	svc-pkg-depot revision 1518
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#!/usr/bin/ksh -p
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# CDDL HEADER START
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# The contents of this file are subject to the terms of the
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# Common Development and Distribution License (the "License").
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# You may not use this file except in compliance with the License.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# or http://www.opensolaris.org/os/licensing.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# See the License for the specific language governing permissions
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# and limitations under the License.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# When distributing Covered Code, include this CDDL HEADER in each
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# If applicable, add the following below this CDDL HEADER, with the
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# fields enclosed by brackets "[]" replaced with your own identifying
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# information: Portions Copyright [yyyy] [name of copyright owner]
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# CDDL HEADER END
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# Use is subject to license terms.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte# Load SMF constants and functions
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte. /lib/svc/share/smf_include.sh
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forteif [[ -z "$SMF_FMRI" ]]; then
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    echo "this script can only be invoked by smf(5)"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    exit $SMF_EXIT_ERR_NOSMF
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Fortefi
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Fortecase "$1" in
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte'start')
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    # Handles depot startup
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    # boolean_props are properties which are communicated to the depot
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    # via a flag being present or absent on the command line.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    boolean_props="mirror readonly"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    set -A boolean_cmd_line "mirror" "readonly"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    # short_option_props are properties which are communicated to the depot
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    # via a single character flag which takes an argument.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    short_option_props="inst_root port threads socket_timeout"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    set -A short_option_cmd_line "d" "p" "s" "t"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    # short_option_props are properties which are communicated to the depot
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    # via a long option flag which takes an argument.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    long_option_props="cfg_file content_root debug log_access log_errors \
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte        proxy_base sort_file_max_size ssl_cert_file ssl_dialog ssl_key_file \
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte        writable_root"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    set -A long_option_cmd_line "cfg-file" "content-root" "debug" \
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte        "log-access" "log-errors" "proxy-base" "sort-file-max-size" \
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte        "ssl-cert-file" "ssl-dialog" "ssl-key-file" "writable-root"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    bool_ops=""
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    option_props=""
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    # retrieve the pkg_root property. If the variable is left empty
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    # pkg_root is /
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    pkg_root=$(svcprop -p pkg/pkg_root $SMF_FMRI)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    if [[ $? -ne 0 ]]; then
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte        echo "service property pkg/pkg_root not defined for" \
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte            "service: $SMF_FMRI"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte        exit $SMF_EXIT_ERR_CONFIG
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    fi
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    # make sure pkg_root ends with a /
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    echo $pkg_root | grep /$ >/dev/null
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    if [[ $? -ne 0 ]]; then
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte        pkg_root="${pkg_root}/"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    fi
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    # adjust the PYTHONPATH to point to the current environment
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    PYTHONPATH=${pkg_root}usr/lib/python2.4/vendor-packages/:$PYTHONPATH
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    export PYTHONPATH
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    # Go through each property in boolean_props and, if its value is set
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    # to true in SMF, add the appropriate command line flag to the string.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    cnt=0
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte    for b in $boolean_props; do
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte        val=$(svcprop -p pkg/$b $SMF_FMRI)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte        if [[ $? -ne 0 ]]; then
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte            echo "service property pkg/$b not defined for" \
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte                "service: $SMF_FMRI"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte            exit $SMF_EXIT_ERR_CONFIG
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte        fi
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte        # If the property is set to true, add the flag.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte        if [[ $val == 'true' ]]; then
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte            bool_ops="$bool_ops --${boolean_cmd_line[$cnt]}"
        fi
        cnt=$(($cnt + 1))
    done

    # Go through each property in short_option_props and, if its value is
    # set to something other than "", add the appropriate command line
    # flag and argument to the string.
    cnt=0
    for o in $short_option_props; do
        val=$(svcprop -p pkg/$o $SMF_FMRI)
        if [[ $? -ne 0 ]]; then
            echo "service property pkg/$o not defined for" \
                    "service: $SMF_FMRI"
            exit $SMF_EXIT_ERR_CONFIG
        fi
        # If the SMF property is set to something other than 'none', add
        # the flag and its argument to the command.
        if [[ $val != '""' ]]; then
            option_ops="$option_ops -${short_option_cmd_line[$cnt]} $val"
        fi
        cnt=$(($cnt + 1))
    done

    # Go through each property in long_option_props and, if its value is
    # set to something other than "", add the appropriate command line
    # flag and argument to the string.
    cnt=0
    for o in $long_option_props; do
        val=$(svcprop -p pkg/$o $SMF_FMRI)
        if [[ $? -ne 0 ]]; then
            echo "service property pkg/$o not defined for" \
                    "service: $SMF_FMRI"
            exit $SMF_EXIT_ERR_CONFIG
        fi
        # check if content_root is a relative or absolute path, if
        # relative append to pkg_root
        if [[ $o == 'content_root' ]]; then
            echo $val | grep ^/ >/dev/null
            if [[ $? -ne 0 ]]; then
                # pkg_root has been checked to end with a slash
                val="${pkg_root}$val"
            fi
        fi
        # If the SMF property is set to something other than 'none', add
        # the flag and its argument to the command.
        if [[ $o == 'ssl_dialog' && $val == 'smf' ]]; then
            option_ops="$option_ops --${long_option_cmd_line[$cnt]}=smf:$SMF_FMRI"
        elif [[ $val != '""' ]]; then
            option_ops="$option_ops --${long_option_cmd_line[$cnt]}=$val"
        fi
        cnt=$(($cnt + 1))
    done

    #
    # Determine if fork and exec are needed.
    #
    need_forkexec="true"
    if [[ $bool_ops == *'--readonly'* ]]; then
        need_forkexec="false"
        echo "option_ops: [$option_ops]"
        if [[ "$option_ops" == *--ssl-dialog=@(smf|exec):* && \
            "$option_ops" == *'--ssl-key-file='* && \
            "$option_ops" != *'--ssl-key-file=none'* ]]; then
            need_forkexec="true"
        fi
        if [[ "$option_ops" == *'--writable-root='* ]]; then
            need_forkexec="true"
        fi

    fi

    #
    # If we don't need them, drop fork and exec.
    #
    forkexec=""
    if [[ $need_forkexec == 'false' ]]; then
        echo "Dropping fork(2) and exec(2) privileges."
        forkexec=",-proc_fork,-proc_exec"
    fi

    #
    # If this process has net_privaddr, then we pass it along.
    # If not, we ensure that we don't specify it, since that will
    # cause ppriv to throw an error.
    #
    privaddr=""
    ppriv -v $$ | grep 'E: ' | grep net_privaddr > /dev/null 2>&1
    if [[ $? == 0 ]]; then
        echo "Dropping net_privaddr privilege."
        privaddr=",net_privaddr"
    fi
    #
    # We build up the privileges available starting with "basic".
    # This provides some protection even when the depot runs as root.
    #
    wrapper="ppriv -s A=basic,-file_link_any,-proc_info,-proc_session$privaddr$forkexec -e"

    # Build the command to start pkg.depotd with the specified options.
    cmd="$wrapper ${pkg_root}usr/lib/pkg.depotd $bool_ops $option_ops"
    # Echo the command so that the log contains the command used to start
    # the depot.
    echo $cmd

    exec $cmd

    ;;

'stop')
    #
    # Strategy: First, try shutting down depot using polite kill.  Use up
    # as much as possible of the allotted timeout period waiting for polite
    # kill to take effect.  As time runs out, try a more aggressive kill.
    #
    SVC_TIMEOUT=`svcprop -p stop/timeout_seconds $SMF_FMRI`
    if [[ $? -ne 0 ]]; then
        echo "service property stop/timeout_seconds not defined" \
            "for service: $SMF_FMRI"
        exit $SMF_EXIT_ERR_CONFIG
    fi

    #
    # Note that we're working around an oddity in smf_kill_contract: it
    # waits in 5 second chunks and can overshoot the specified timeout
    # by as many as 4 seconds.  Example: a specified wait of 6 will result
    # in a wait of 10 seconds in reality.  Since we may potentially do a
    # first kill and then a second, we must ensure that at least 8 seconds
    # of slop is left in reserve.  To be paranoid, we go for 10.
    #
    ((POLITE=$SVC_TIMEOUT - 10))
    if [[ $POLITE -gt 0 ]]; then
        smf_kill_contract $2 TERM 1 $POLITE
        ret=$?
        # '2' indicates timeout with non-empty contract.
        if [[ $ret -eq 2 ]]; then
            echo "Gentle contract kill timed out after"
                    "$POLITE seconds, trying SIGKILL." >&2
            #
            # Again, despite the specified timeout, this will
            # take a minimum of 5 seconds to complete.
            #
            smf_kill_contract $2 KILL 1 1
            if [[ $ret -ne 0 ]]; then
                exit $SMF_EXIT_ERR_FATAL
            fi
        fi
    else
        # If the timeout is too short, we just try once, politely.
        smf_kill_contract $2 TERM
    fi
    ;;

*)
    echo "Usage: $0 { start | stop }"
    exit $SMF_EXIT_ERR_CONFIG
    ;;

esac
exit $SMF_EXIT_OK