crash-reporter: Replace the crash_sender script by a service daemon.

      ],

    },

    {

      'target_name': 'list_proxies',

      'target_name': 'libproxies',

      'type': 'static_library',

      'variables': {

        'exported_deps': [

          'libchrome-<(libbase_ver)',

        ],

        'deps': ['<@(exported_deps)'],

      },

      'all_dependent_settings': {

        'variables': {

          'deps': [

            '<@(exported_deps)',

          ],

        },

      },

      'sources': [

        'libproxies.cc',

        'libproxies.h',

      ],

    },

    {

      'target_name': 'crash_sender',

      'type': 'executable',

      'variables': {

        'deps': [

          'dbus-1',

          'dbus-glib-1',

          'libchrome-<(libbase_ver)',

          'libchromeos-<(libbase_ver)',

          'libcurl',

          'libmetrics-<(libbase_ver)',

        ],

      },

      'dependencies': [

        'libproxies',

      ],

      'libraries': [

        '-lvboot_host',

      ],

      'sources': [

        'list_proxies.cc',

        'crash_sender_daemon.cc',

        'crash_sender_daemon.h',

        'crash_sender_service.cc',

        'crash_sender_service.h',

        'proxy_resolver.cc',

        'proxy_resolver.h',

      ],

    },

    {

#!/bin/sh

# Copyright (c) 2010 The Chromium OS Authors. All rights reserved.

# Use of this source code is governed by a BSD-style license that can be

# found in the LICENSE file.

set -e

# Default product ID in crash report (used if GOOGLE_CRASH_* is undefined).

CHROMEOS_PRODUCT=ChromeOS

# File whose existence implies crash reports may be sent, and whose

# contents includes our machine's anonymized guid.

CONSENT_ID="/home/chronos/Consent To Send Stats"

# Crash sender lock in case the sender is already running.

CRASH_SENDER_LOCK="/var/lock/crash_sender"

# Path to file that indicates a crash test is currently running.

CRASH_TEST_IN_PROGRESS_FILE="/tmp/crash-test-in-progress"

# Path to find which is required for computing the crash rate.

FIND="/usr/bin/find"

# Set this to 1 in the environment to allow uploading crash reports

# for unofficial versions.

FORCE_OFFICIAL=${FORCE_OFFICIAL:-0}

# Path to hardware class description.

HWCLASS_PATH="/sys/devices/platform/chromeos_acpi/HWID"

# Path to file that indicates this is a developer image.

LEAVE_CORE_FILE="/root/.leave_core"

# Path to list_proxies.

LIST_PROXIES="/usr/bin/list_proxies"

# Maximum crashes to send per day.

MAX_CRASH_RATE=${MAX_CRASH_RATE:-32}

# Path to metrics_client.

METRICS_CLIENT="/usr/bin/metrics_client"

# File whose existence mocks crash sending.  If empty we pretend the

# crash sending was successful, otherwise unsuccessful.

MOCK_CRASH_SENDING="/tmp/mock-crash-sending"

# Set this to 1 in the environment to pretend to have booted in developer

# mode.  This is used by autotests.

MOCK_DEVELOPER_MODE=${MOCK_DEVELOPER_MODE:-0}

# Ignore PAUSE_CRASH_SENDING file if set.

OVERRIDE_PAUSE_SENDING=${OVERRIDE_PAUSE_SENDING:-0}

# File whose existence causes crash sending to be delayed (for testing).

# Must be stateful to enable testing kernel crashes.

PAUSE_CRASH_SENDING="/var/lib/crash_sender_paused"

# URL to send official build crash reports to.

REPORT_UPLOAD_PROD_URL="https://clients2.google.com/cr/report"

# Path to a directory of restricted certificates which includes

# a certificate for ${REPORT_UPLOAD_PROD_URL}.

RESTRICTED_CERTIFICATES_PATH="/usr/share/chromeos-ca-certificates"

# File whose existence implies we're running and not to start again.

RUN_FILE="/var/run/crash_sender.pid"

# Maximum time to sleep between sends.

SECONDS_SEND_SPREAD=${SECONDS_SEND_SPREAD:-600}

# The syslog tag for all logging we emit.

TAG="$(basename $0)[$$]"

# Directory to store timestamp files indicating the uploads in the past 24

# hours.

TIMESTAMPS_DIR="/var/lib/crash_sender"

# Temp directory for this process.

TMP_DIR=""

# Chrome's crash report log file.

CHROME_CRASH_LOG="/var/log/chrome/Crash Reports/uploads.log"

lecho() {

  logger -t "${TAG}" "$@"

}

# Returns true if mock is enabled.

is_mock() {

  [ -f "${MOCK_CRASH_SENDING}" ] && return 0

  return 1

}

is_mock_successful() {

  local mock_in=$(cat "${MOCK_CRASH_SENDING}")

  [ "${mock_in}" = "" ] && return 0  # empty file means success

  return 1

}

cleanup() {

  if [ -n "${TMP_DIR}" ]; then

    rm -rf "${TMP_DIR}"

  fi

  rm -f "${RUN_FILE}"

  crash_done

}

crash_done() {

  if is_mock; then

    # For testing purposes, emit a message to log so that we

    # know when the test has received all the messages from this run.

    lecho "crash_sender done."

  fi

}

is_official_image() {

  [ ${FORCE_OFFICIAL} -ne 0 ] && return 0

  grep ^CHROMEOS_RELEASE_DESCRIPTION /etc/lsb-release | grep -q Official

}

# Returns 0 if the a crash test is currently running.  NOTE: Mirrors

# crash_collector.cc:CrashCollector::IsCrashTestInProgress().

is_crash_test_in_progress() {

  [ -f "${CRASH_TEST_IN_PROGRESS_FILE}" ] && return 0

  return 1

}

# Returns 0 if we should consider ourselves to be running on a developer

# image.  NOTE: Mirrors crash_collector.cc:CrashCollector::IsDeveloperImage().

is_developer_image() {

  # If we're testing crash reporter itself, we don't want to special-case

  # for developer images.

  is_crash_test_in_progress && return 1

  [ -f "${LEAVE_CORE_FILE}" ] && return 0

  return 1

}

# Returns 0 if we should consider ourselves to be running on a test image.

is_test_image() {

  # If we're testing crash reporter itself, we don't want to special-case

  # for test images.

  is_crash_test_in_progress && return 1

  case $(get_channel) in

  test*) return 0;;

  esac

  return 1

}

# Returns 0 if the machine booted up in developer mode.

is_developer_mode() {

  [ ${MOCK_DEVELOPER_MODE} -ne 0 ] && return 0

  # If we're testing crash reporter itself, we don't want to special-case

  # for developer mode.

  is_crash_test_in_progress && return 1

  crossystem "devsw_boot?1"  # exit status will be accurate

}

# Generate a uniform random number in 0..max-1.

generate_uniform_random() {

  local max=$1

  local random="$(od -An -N4 -tu /dev/urandom)"

  echo $((random % max))

}

# Check if sending a crash now does not exceed the maximum 24hr rate and

# commit to doing so, if not.

check_rate() {

  mkdir -p ${TIMESTAMPS_DIR}

  # Only consider minidumps written in the past 24 hours by removing all older.

  ${FIND} "${TIMESTAMPS_DIR}" -mindepth 1 -mmin +$((24 * 60)) \

      -exec rm -- '{}' ';'

  local sends_in_24hrs=$(echo "${TIMESTAMPS_DIR}"/* | wc -w)

  lecho "Current send rate: ${sends_in_24hrs}sends/24hrs"

  if [ ${sends_in_24hrs} -ge ${MAX_CRASH_RATE} ]; then

    lecho "Cannot send more crashes:"

    lecho "  current ${sends_in_24hrs}send/24hrs >= " \

          "max ${MAX_CRASH_RATE}send/24hrs"

    return 1

  fi

  mktemp "${TIMESTAMPS_DIR}"/XXXX > /dev/null

  return 0

}

# Gets the base part of a crash report file, such as name.01234.5678.9012 from

# name.01234.5678.9012.meta or name.01234.5678.9012.log.tar.xz.  We make sure

# "name" is sanitized in CrashCollector::Sanitize to not include any periods.

get_base() {

  echo "$1" | cut -d. -f-4

}

get_extension() {

  local extension="${1##*.}"

  local filename="${1%.*}"

  # For gzipped file, we ignore .gz and get the real extension

  if [ "${extension}" = "gz" ]; then

    echo "${filename##*.}"

  else

    echo "${extension}"

  fi

}

# Return which kind of report the given metadata file relates to

get_kind() {

  local payload="$(get_key_value "$1" "payload")"

  if [ ! -r "${payload}" ]; then

    lecho "Missing payload: ${payload}"

    echo "undefined"

    return

  fi

  local kind="$(get_extension "${payload}")"

  if [ "${kind}" = "dmp" ]; then

    echo "minidump"

    return

  fi

  echo "${kind}"

}

get_key_value() {

  local file="$1" key="$2" value

  if [ -f "${file}" ]; then

    # Return the first entry.  There shouldn't be more than one anyways.

    # Substr at length($1) + 2 skips past the key and following = sign (awk

    # uses 1-based indexes), but preserves embedded = characters.

    value=$(sed -n "/^${key}[[:space:]]*=/{s:^[^=]*=::p;q}" "${file}")

  fi

  echo "${value:-undefined}"

}

get_keys() {

  local file="$1" regex="$2"

  awk -F'[[:space:]=]' -vregex="${regex}" \

      'match($1, regex) { print $1 }' "${file}"

}

# Return the board name.

get_board() {

  get_key_value "/etc/lsb-release" "CHROMEOS_RELEASE_BOARD"

}

# Return the channel name (sans "-channel" suffix).

get_channel() {

  get_key_value "/etc/lsb-release" "CHROMEOS_RELEASE_TRACK" |

    sed 's:-channel$::'

}

# Return the hardware class or "undefined".

get_hardware_class() {

  if [ -r "${HWCLASS_PATH}" ]; then

    cat "${HWCLASS_PATH}"

  elif crossystem hwid > /dev/null 2>&1; then

    echo "$(crossystem hwid)"

  else

    echo "undefined"

  fi

}

send_crash() {

  local meta_path="$1"

  local report_payload="$(get_key_value "${meta_path}" "payload")"

  local kind="$(get_kind "${meta_path}")"

  local exec_name="$(get_key_value "${meta_path}" "exec_name")"

  local url="${REPORT_UPLOAD_PROD_URL}"

  local chromeos_version="$(get_key_value "${meta_path}" "ver")"

  local board="$(get_board)"

  local hwclass="$(get_hardware_class)"

  local write_payload_size="$(get_key_value "${meta_path}" "payload_size")"

  local log="$(get_key_value "${meta_path}" "log")"

  local sig="$(get_key_value "${meta_path}" "sig")"

  local send_payload_size="$(stat --printf=%s "${report_payload}" 2>/dev/null)"

  local product="$(get_key_value "${meta_path}" "upload_var_prod")"

  local version="$(get_key_value "${meta_path}" "upload_var_ver")"

  local upload_prefix="$(get_key_value "${meta_path}" "upload_prefix")"

  local guid

  set -- \

    -F "write_payload_size=${write_payload_size}" \

    -F "send_payload_size=${send_payload_size}"

  if [ "${sig}" != "undefined" ]; then

    set -- "$@" \

      -F "sig=${sig}" \

      -F "sig2=${sig}"

  fi

  if [ -r "${report_payload}" ]; then

    set -- "$@" \

      -F "upload_file_${kind}=@${report_payload}"

  fi

  if [ "${log}" != "undefined" -a -r "${log}" ]; then

    set -- "$@" \

      -F "log=@${log}"

  fi

  if [ "${upload_prefix}" = "undefined" ]; then

    upload_prefix=""

  fi

  # Grab any variable that begins with upload_.

  local v

  for k in $(get_keys "${meta_path}" "^upload_"); do

    v="$(get_key_value "${meta_path}" "${k}")"

    case ${k} in

      # Product & version are handled separately.

      upload_var_prod) ;;

      upload_var_ver) ;;

      upload_var_*)

        set -- "$@" -F "${upload_prefix}${k#upload_var_}=${v}"

        ;;

      upload_file_*)

        if [ -r "${v}" ]; then

          set -- "$@" -F "${upload_prefix}${k#upload_file_}=@${v}"

        fi

        ;;

    esac

  done

  # When uploading Chrome reports we need to report the right product and

  # version. If the meta file does not specify it, use GOOGLE_CRASH_ID

  # as the product and GOOGLE_CRASH_VERSION_ID as the version.

  if [ "${product}" = "undefined" ]; then

    product="$(get_key_value /etc/os-release 'GOOGLE_CRASH_ID')"

  fi

  if [ "${version}" = "undefined" ]; then

    version="$(get_key_value /etc/os-release 'GOOGLE_CRASH_VERSION_ID')"

  fi

  # If GOOGLE_CRASH_* is undefined, we look for ID and VERSION_ID in

  # /etc/os-release.

  if [ "${product}" = "undefined" ]; then

    product="$(get_key_value /etc/os-release 'ID')"

  fi

  if [ "${version}" = "undefined" ]; then

    version="$(get_key_value /etc/os-release 'VERSION_ID')"

  fi

  # If ID or VERSION_ID is undefined, we use the default product name

  # and CHROMEOS_RELEASE_VERSION from /etc/lsb-release.

  if [ "${product}" = "undefined" ]; then

    product="${CHROMEOS_PRODUCT}"

  fi

  if [ "${version}" = "undefined" ]; then

    version="${chromeos_version}"

  fi

  local image_type

  if is_test_image; then

    image_type="test"

  elif is_developer_image; then

    image_type="dev"

  elif [ ${FORCE_OFFICIAL} -ne 0 ]; then

    image_type="force-official"

  elif is_mock && ! is_mock_successful; then

    image_type="mock-fail"

  fi

  local boot_mode

  if ! crossystem "cros_debug" > /dev/null 2>&1; then

    # Sanity-check failed that makes sure crossystem exists.

    lecho "Cannot determine boot mode due to error running crossystem command"

    boot_mode="missing-crossystem"

  elif is_developer_mode; then

    boot_mode="dev"

  fi

  # Need to strip dashes ourselves as Chrome preserves it in the file

  # nowadays.  This is also what the Chrome breakpad client does.

  guid=$(tr -d '-' < "${CONSENT_ID}")

  local error_type="$(get_key_value "${meta_path}" "error_type")"

  [ "${error_type}" = "undefined" ] && error_type=

  lecho "Sending crash:"

  if [ "${product}" != "${CHROMEOS_PRODUCT}" ]; then

    lecho "  Sending crash report on behalf of ${product}"

  fi

  lecho "  Metadata: ${meta_path} (${kind})"

  lecho "  Payload: ${report_payload}"

  lecho "  Version: ${version}"

  [ -n "${image_type}" ] && lecho "  Image type: ${image_type}"

  [ -n "${boot_mode}" ] && lecho "  Boot mode: ${boot_mode}"

  if is_mock; then

    lecho "  Product: ${product}"

    lecho "  URL: ${url}"

    lecho "  Board: ${board}"

    lecho "  HWClass: ${hwclass}"

    lecho "  write_payload_size: ${write_payload_size}"

    lecho "  send_payload_size: ${send_payload_size}"

    if [ "${log}" != "undefined" ]; then

      lecho "  log: @${log}"

    fi

    if [ "${sig}" != "undefined" ]; then

      lecho "  sig: ${sig}"

    fi

  fi

  lecho "  Exec name: ${exec_name}"

  [ -n "${error_type}" ] && lecho "  Error type: ${error_type}"

  if is_mock; then

    if ! is_mock_successful; then

      lecho "Mocking unsuccessful send"

      return 1

    fi

    lecho "Mocking successful send"

    return 0

  fi

  # Read in the first proxy, if any, for a given URL.  NOTE: The

  # double-quotes are necessary due to a bug in dash with the "local"

  # builtin command and values that have spaces in them (see

  # "https://bugs.launchpad.net/ubuntu/+source/dash/+bug/139097").

  local proxy="`${LIST_PROXIES} -quiet "${url}" | head -1`"

  # if a direct connection should be used, unset the proxy variable.

  [ "${proxy}" = "direct://" ] && proxy=

  local report_id="${TMP_DIR}/report_id"

  local curl_stderr="${TMP_DIR}/curl_stderr"

  set +e

  curl "${url}" -v ${proxy:+--proxy "$proxy"} \

    --capath "${RESTRICTED_CERTIFICATES_PATH}" --ciphers HIGH \

    -F "prod=${product}" \

    -F "ver=${version}" \

    -F "board=${board}" \

    -F "hwclass=${hwclass}" \

    -F "exec_name=${exec_name}" \

    ${image_type:+-F "image_type=${image_type}"} \

    ${boot_mode:+-F "boot_mode=${boot_mode}"} \

    ${error_type:+-F "error_type=${error_type}"} \

    -F "guid=${guid}" \

    -o "${report_id}" \

    "$@" \

    2>"${curl_stderr}"

  curl_result=$?

  set -e

  if [ ${curl_result} -eq 0 ]; then

    local id="$(cat "${report_id}")"

    local product_name

    local timestamp="$(date +%s)"

    case ${product} in

    Chrome_ChromeOS)

      if is_official_image; then

        product_name="Chrome"

      else

        product_name="Chromium"

      fi

      ;;

    *)

      if is_official_image; then

        product_name="ChromeOS"

      else

        product_name="ChromiumOS"

      fi

      ;;

    esac

    printf '%s,%s,%s\n' \

      "${timestamp}" "${id}" "${product_name}" >> "${CHROME_CRASH_LOG}"

    lecho "Crash report receipt ID ${id}"

  else

    lecho "Crash sending failed with exit code ${curl_result}: " \

      "$(cat "${curl_stderr}")"

  fi

  rm -f "${report_id}"

  return ${curl_result}

}

# *.meta files always end with done=1 so we can tell if they are complete.

is_complete_metadata() {

  grep -q "done=1" "$1"

}

# Remove the given report path.

remove_report() {

  local base="${1%.*}"

  rm -f -- "${base}".*

}

# Send all crashes from the given directory.  This applies even when we're on a

# 3G connection (see crosbug.com/3304 for discussion).

send_crashes() {

  local dir="$1"

  if [ ! -d "${dir}" ]; then

    return

  fi

  # Consider any old files which still have no corresponding meta file

  # as orphaned, and remove them.

  for old_file in $(${FIND} "${dir}" -mindepth 1 \

                    -mmin +$((24 * 60)) -type f); do

    if [ ! -e "$(get_base "${old_file}").meta" ]; then

      lecho "Removing old orphaned file: ${old_file}."

      rm -f -- "${old_file}"

    fi

  done

  # Look through all metadata (*.meta) files, oldest first.  That way, the rate

  # limit does not stall old crashes if there's a high amount of new crashes

  # coming in.

  # For each crash report, first evaluate conditions that might lead to its

  # removal to honor user choice and to free disk space as soon as possible,

  # then decide whether it should be sent right now or kept for later sending.

  for meta_path in $(ls -1tr "${dir}"/*.meta 2>/dev/null); do

    lecho "Considering metadata ${meta_path}."

    local kind=$(get_kind "${meta_path}")

    if [ "${kind}" != "minidump" ] && \

       [ "${kind}" != "kcrash" ] && \

       [ "${kind}" != "log" ]; then

      lecho "Unknown report kind ${kind}.  Removing report."

      remove_report "${meta_path}"

      continue

    fi

    if ! is_complete_metadata "${meta_path}"; then

      # This report is incomplete, so if it's old, just remove it.

      local old_meta=$(${FIND} "${dir}" -mindepth 1 -name \

        $(basename "${meta_path}") -mmin +$((24 * 60)) -type f)

      if [ -n "${old_meta}" ]; then

        lecho "Removing old incomplete metadata."

        remove_report "${meta_path}"

      else

        lecho "Ignoring recent incomplete metadata."

      fi

      continue

    fi

    if ! is_mock && ! is_official_image; then

      lecho "Not an official OS version.  Removing crash."

      remove_report "${meta_path}"

      continue

    fi

    # Don't send crash reports from previous sessions while we're in guest mode

    # to avoid the impression that crash reporting was enabled, which it isn't.

    # (Don't exit right now because subsequent reports may be candidates for

    # deletion.)

    if ${METRICS_CLIENT} -g; then

      lecho "Guest mode has been entered.  Delaying crash sending until exited."

      continue

    fi

    # Remove existing crashes in case user consent has not (yet) been given or

    # has been revoked.  This must come after the guest mode check because

    # ${METRICS_CLIENT} always returns "not consented" in guest mode.

    if ! ${METRICS_CLIENT} -c; then

      lecho "Crash reporting is disabled.  Removing crash."

      remove_report "${meta_path}"

      continue

    fi

    # Skip report if the upload rate is exceeded.  (Don't exit right now because

    # subsequent reports may be candidates for deletion.)

    if ! check_rate; then

      lecho "Sending ${meta_path} would exceed rate.  Leaving for later."

      continue

    fi

    # The .meta file should be written *after* all to-be-uploaded files that it

    # references.  Nevertheless, as a safeguard, a hold-off time of thirty

    # seconds after writing the .meta file is ensured.  Also, sending of crash

    # reports is spread out randomly by up to SECONDS_SEND_SPREAD.  Thus, for

    # the sleep call the greater of the two delays is used.

    local now=$(date +%s)

    local holdoff_time=$(($(stat --format=%Y "${meta_path}") + 30 - ${now}))

    local spread_time=$(generate_uniform_random "${SECONDS_SEND_SPREAD}")

    local sleep_time

    if [ ${spread_time} -gt ${holdoff_time} ]; then

      sleep_time="${spread_time}"

    else

      sleep_time="${holdoff_time}"

    fi

    lecho "Scheduled to send in ${sleep_time}s."

    if ! is_mock; then

      if ! sleep "${sleep_time}"; then

          lecho "Sleep failed"

          return 1

      fi

    fi

    # Try to upload.

    if ! send_crash "${meta_path}"; then

      lecho "Problem sending ${meta_path}, not removing."

      continue

    fi

    # Send was successful, now remove.

    lecho "Successfully sent crash ${meta_path} and removing."

    remove_report "${meta_path}"

  done

}

usage() {

  cat <<EOF

Usage: crash_sender [options]

Options:

 -e <var>=<val>     Set env |var| to |val| (only some vars)

EOF

  exit ${1:-1}

}

parseargs() {

  # Parse the command line arguments.

  while [ $# -gt 0 ]; do

    case $1 in

    -e)

      shift

      case $1 in

      FORCE_OFFICIAL=*|\

      MAX_CRASH_RATE=*|\

      MOCK_DEVELOPER_MODE=*|\

      OVERRIDE_PAUSE_SENDING=*|\

      SECONDS_SEND_SPREAD=*)

        export "$1"

        ;;

      *)

        lecho "Unknown var passed to -e: $1"

        exit 1

        ;;

      esac

      ;;

    -h)

      usage 0

      ;;

    *)

      lecho "Unknown options: $*"

      exit 1

      ;;

    esac

    shift

  done

}

main() {

  trap cleanup EXIT INT TERM

  parseargs "$@"

  if [ -e "${PAUSE_CRASH_SENDING}" ] && \

     [ ${OVERRIDE_PAUSE_SENDING} -eq 0 ]; then

    lecho "Exiting early due to ${PAUSE_CRASH_SENDING}."

    exit 1

  fi

  if is_test_image; then

    lecho "Exiting early due to test image."

    exit 1

  fi

  # We don't perform checks on this because we have a master lock with the

  # CRASH_SENDER_LOCK file.  This pid file is for the system to keep track

  # (like with autotests) that we're still running.

  echo $$ > "${RUN_FILE}"

  for dependency in "${FIND}" "${METRICS_CLIENT}" \

                    "${RESTRICTED_CERTIFICATES_PATH}"; do

    if [ ! -x "${dependency}" ]; then

      lecho "Fatal: Crash sending disabled: ${dependency} not found."

      exit 1

    fi

  done

  TMP_DIR="$(mktemp -d /tmp/crash_sender.XXXXXX)"

  # Send system-wide crashes

  send_crashes "/var/spool/crash"

  # Send user-specific crashes

  local d

  for d in /home/chronos/crash /home/chronos/u-*/crash; do

    send_crashes "${d}"

  done

}

(

if ! flock -n 9; then

  lecho "Already running; quitting."

  crash_done

  exit 1

fi

main "$@"

) 9>"${CRASH_SENDER_LOCK}"

# Copyright 2014 The Chromium OS Authors. All rights reserved.

# Use of this source code is governed by a BSD-style license that can

# be found in the LICENSE file.

# This file has the format:

# NAME=value

# Product ID in crash report.

CHROMEOS_PRODUCT=ChromeOS

# Set this to 1 to allow uploading crash reports for unofficial versions.

FORCE_OFFICIAL=0