2020-10-10  Jiewen Tan  <jiewen_tan@apple.com>

        [WebAuthn] Implement a dummy WebAuthenticationAgent Part 2

        https://bugs.webkit.org/show_bug.cgi?id=217559

        <rdar://problem/70168749>

        Reviewed by NOBODY (OOPS!).

        This is a WIP patch. Just uploaded to showcase some problems I have encountered during this investigation.

        Two major road blockers are identified to make this daemon really happen.

        1) The major one is on macOS. New daemons cannot be installed without a system update. It means relocatable Safari (e.g. STP)

        and staged Safari on downlevel OSes will not get this feature. And relocatable STP can only utilize the system daemon. This

        seems a bimmer especailly for the STP case given it is heavily used to test latest web features. On the other hand, This patch

        showcases things we can do for non-staged Safari and staged Safari on +1 OSes (not completed). For non-staged Safari, the installation

        process can place a symlink of the launchd plist on /System/... to point to a location that is owned by WebKit/Safari which is outside

        of the system partition, and then staged/none-staged Safari can update this plist to point to the right binary. This location is well

        established for Safari daemons, but it is unknown whether WebKit can directly reuse that.

        2) Additional plumbing is needed for testing and engineering builds. This problem is specific to WebKit and is on both macOS and iOS.

        WebKit doesn't build roots to test engineering builds, which is required to update the plist on the above location. Hence, a separate

        configuration is needed to generate a different plist that points to the right engineering binary and additional scripts will be needed

        to ask launchd to load the plist before running any tests. Some extra exercises are probably needed to not confuse launchd about the

        engineering binary and system binary.

        Given the about two road blockers, making this process as a daemon is probably not the best approach for WebKit.

        Covered by manual tests.

        * Configurations/WebAuthenticationAgent.xcconfig:

        * Daemons/WebAuthenticationAgent/com.apple.webkit.WebAuthenticationAgent.plist:

        * Scripts/copy-launchd-plist-and-create-symlinks.sh: Added.

        * WebKit.xcodeproj/project.pbxproj:

LAUNCHD_PLIST_INSTALL_PATH[sdk=macosx*] = $(WEBKIT_FRAMEWORKS_DIR)/WebKit.framework/Versions/A/Resources;

LAUNCHD_PLIST_INSTALL_PATH[sdk=iphone*] = /System/Library/LaunchDaemons;

LAUNCHD_PLIST_FILE_NAME[sdk=macosx*] = com.apple.WebKit.WebAuthenticationAgent.plist

LAUNCHD_PLIST_FILE_NAME[sdk=iphone*] = com.apple.WebKit.WebAuthenticationAgent-iOS.plist

LAUNCHD_PLIST_INPUT_FILE = Daemons/WebAuthenticationAgent/$(LAUNCHD_PLIST_FILE_NAME)

LAUNCHD_PLIST_OUTPUT_FILE = $(LAUNCHD_PLIST_INSTALL_PATH)/$(LAUNCHD_PLIST_FILE_NAME)

LAUNCHD_PLIST_SYMLINK_PATH[sdk=macosx*] = /System/Library/LaunchAgents

#!/bin/sh

#

# Copyright (C) 2020 Apple Inc. 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 APPLE INC. AND ITS 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 APPLE INC. OR ITS 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.

if [ -z "${LAUNCHD_PLIST_INSTALL_PATH}" ]; then

    exit 0;

fi

if [[ "${SKIP_INSTALL}" == "YES" ]]; then

    exit 0;

fi

# On macOS, we install the launchd plist into $(WEBKIT_FRAMEWORKS_DIR)/WebKit.framework/Versions/A/Resources

# and then add a symlink from the standard place the launchd plists live to the above

# copy. This allows us to update the plist when shipping downlevels, since we otherwise

# can't change the contents of /System. The macOS plist needs to point to the binary

# inside $(WEBKIT_FRAMEWORKS_DIR)/WebKit.framework/Versions/A/XPCServices.

# Generate launchd plist and replace placeholder values with their real paths.

GENERATED_LAUNCHD_PLIST_DIR="${BUILT_PRODUCTS_DIR}/DerivedSources/WebKit2"

mkdir -p "${GENERATED_LAUNCHD_PLIST_DIR}"

GENERATED_LAUNCHD_PLIST_PATH="${GENERATED_LAUNCHD_PLIST_DIR}/${LAUNCHD_PLIST_FILE_NAME}"

echo "Replacing placeholders in ${LAUNCHD_PLIST_INPUT_FILE} and saving to ${GENERATED_LAUNCHD_PLIST_PATH}"

sed -e "s|\${INSTALL_PATH}|${INSTALL_PATH}|" -e "s|\${PRODUCT_NAME}|${PRODUCT_NAME}|" "${LAUNCHD_PLIST_INPUT_FILE}" > "${GENERATED_LAUNCHD_PLIST_PATH}"

# Install the plist.

DSTROOT_LAUNCHD_PLIST_OUTPUT_FILE="${DSTROOT}${LAUNCHD_PLIST_OUTPUT_FILE}"

mkdir -p "${DSTROOT}${LAUNCHD_PLIST_INSTALL_PATH}"

echo "Copying ${GENERATED_LAUNCHD_PLIST_PATH} to ${DSTROOT_LAUNCHD_PLIST_OUTPUT_FILE}"

ditto "${GENERATED_LAUNCHD_PLIST_PATH}" "${DSTROOT_LAUNCHD_PLIST_OUTPUT_FILE}"

if [[ ${WK_PLATFORM_NAME} != "macosx" || "${USE_STAGING_INSTALL_PATH}" == "YES" || "${WK_IS_TECH_PREVIEW_BUILD}" == "YES" ]]; then

    exit 0;

fi

# On non-staged and non-STP macOS builds, create the symlink.

DSTROOT_LAUNCHD_PLIST_SYMLINK_DIR="${DSTROOT}/${LAUNCHD_PLIST_SYMLINK_PATH}"

echo "Creating a symlink at ${DSTROOT_LAUNCHD_PLIST_SYMLINK_DIR} pointing to ${LAUNCHD_PLIST_OUTPUT_FILE}"

mkdir -p "${DSTROOT_LAUNCHD_PLIST_SYMLINK_DIR}"

ln -sf "${LAUNCHD_PLIST_OUTPUT_FILE}" "${DSTROOT_LAUNCHD_PLIST_SYMLINK_DIR}"

		5742A2E2253196A800B7BA14 /* copy-launchd-plist-and-create-symlinks.sh */ = {isa = PBXFileReference; lastKnownFileType = text.script.sh; path = "copy-launchd-plist-and-create-symlinks.sh"; sourceTree = "<group>"; };

				5742A2E2253196A800B7BA14 /* copy-launchd-plist-and-create-symlinks.sh */,

				5742A2E32531A8C700B7BA14 /* Copy launchd plist and create symlinks */,

		5742A2E32531A8C700B7BA14 /* Copy launchd plist and create symlinks */ = {

			isa = PBXShellScriptBuildPhase;

			buildActionMask = 8;

			files = (

			);

			inputFileListPaths = (

			);

			inputPaths = (

				"$(SRCROOT)/$(LAUNCHD_PLIST_INPUT_FILE)",

				"$(SRCROOT)/Scripts/copy-launchd-plist-and-create-symlinks.sh",

			);

			name = "Copy launchd plist and create symlinks";

			outputFileListPaths = (

			);

			outputPaths = (

				"$(DSTROOT)/$(LAUNCHD_PLIST_PATH)/$(LAUNCHD_PLIST_FILE_NAME)",

			);

			runOnlyForDeploymentPostprocessing = 1;

			shellPath = /bin/sh;

			shellScript = "Scripts/copy-launchd-plist-and-create-symlinks.sh\n";

		};