├── LICENSE
├── README.md
└── create_macos_recovery.sh


/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2019 rtrouton
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # create_macos_recovery
 2 | Tool for repairing the Recovery volume (APFS) or partition (HFS+) on Macs running macOS 10.13.x or later.
 3 | 
 4 | This script uses a macOS 10.13 and later installer application to repair the Recovery volume (APFS) or partition (HFS+).
 5 | 
 6 | **Pre-requisites**
 7 | 
 8 | 1. This script
 9 | 2. An installer from Apple's Mac App Store for one of the following versions of macOS:
10 | 
11 | * 10.13.x
12 | * 10.14.x
13 | * 10.15.x
14 | 
15 | **Note:** macOS Big Sur (macOS 11.x) made significant changes to the Recovery volume and it is unlikely this script will support any version of macOS past macOS 10.15.x.
16 | 
17 | 
18 | **Running the script**
19 | 
20 | Run the `create_macos_recovery.sh` script with one argument: the path to an "Install macOS.app".
21 | 
22 | `/path/to/create_macos_recovery.sh "/path/to/Install macOS [Name].app"`
23 | 
24 | 
25 | Example usage: 
26 | 
27 | If you have a macOS Catalina 10.15.x installer available, run this command:
28 | 
29 | `sudo /path/to/create_macos_recovery.sh "/Applications/Install macOS Catalina.app"`
30 | 
31 | This should replace the existing Recovery volume or partition with a fresh install, using the Recovery installation tools available from the macOS installer app.
32 | 
33 | 
34 | What the script does:
35 | 
36 | 1. Downloads the following installer package from Apple's Software Update service: `SecUpd2020-001HighSierra.RecoveryHDUpdate.pkg`
37 | 
38 | 2. Expands `SecUpd2020-001HighSierra.RecoveryHDUpdate.pkg` into a directory in `/private/tmp` in order to get access to the `dm` tool included with this installer package.
39 | 
40 | 3. Uses the `dm` tool and the Recovery installation tools available from the macOS installer app to rebuild the Recovery volume or partition.
41 | 
42 | 4. Cleans up by removing the downloaded `SecUpd2020-001HighSierra.RecoveryHDUpdate.pkg` and expanded package contents.
43 | 
44 | This script has been tested with the following OS installers from the Mac App Store:
45 | 
46 | * macOS 10.13.6
47 | * macOS 10.14.6
48 | * macOS 10.15.0
49 | 


--------------------------------------------------------------------------------
/create_macos_recovery.sh:
--------------------------------------------------------------------------------
  1 | #!/bin/bash
  2 | 
  3 | # This script uses a macOS 10.13 and later installer application to repair the Recovery volume (APFS) or partition (HFS+).
  4 | # 
  5 | # Based on the following script:
  6 | # https://gist.github.com/jonathantneal/f20e6f3e03d5637f983f8543df70cef5
  7 | 
  8 | 
  9 | # Provide custom colors in Terminal for status and error messages
 10 | 
 11 | msg_status() {
 12 | 	echo -e "\033[0;32m-- $1\033[0m"
 13 | }
 14 | msg_error() {
 15 | 	echo -e "\033[0;31m-- $1\033[0m"
 16 | }
 17 | 
 18 | # Explanation of how the script works
 19 | 
 20 | usage() {
 21 | 	cat <<EOF
 22 | Usage:
 23 | $(basename "$0") "/path/to/Install macOS [Name].app"
 24 | 
 25 | Description:
 26 | This script uses a macOS 10.13 and later installer application to repair the Recovery volume (APFS) or partition (HFS+).
 27 | Requirements:
 28 | 
 29 | Compatible macOS installer application for the Mac's installed OS.
 30 | Account with the ability to run commands using sudo, to allow specific functions to run with root privileges.
 31 | 
 32 | EOF
 33 | }
 34 | 
 35 | # Set the macOS installer path as a variable.
 36 | 
 37 | macOS_installer="$1"
 38 | mount_point="$macOS_installer/Contents/SharedSupport"
 39 | 
 40 | # Remove trailing slashes from input paths if needed
 41 | 
 42 | macOS_installer=${macOS_installer%%/}
 43 | 
 44 | # Check to see if the path to the macOS installer application has been provided
 45 | # as part of running the script.
 46 | 
 47 | if [[ -z "$1" ]] || [[ ! -d "$1" ]]; then
 48 |     msg_error "The path to the macOS installer application is required as the first argument."
 49 |     usage
 50 | 	exit 1
 51 | else
 52 |     msg_status "macOS installer is $macOS_installer"
 53 | fi
 54 | 
 55 | # Check for the OS information of both the macOS installer application
 56 | # and that of the Mac this script is running on.
 57 | 
 58 | macos_version=$(/usr/bin/sw_vers -productVersion)
 59 | macos_version_digits_only=$(echo "$macos_version" | awk -F'[^0-9]*' '$0=$1$2$3')
 60 | installer_version=$(/usr/libexec/PlistBuddy -c 'Print :System\ Image\ Info:version' "$macOS_installer/Contents/SharedSupport/InstallInfo.plist")
 61 | installer_version_digits_only=$(echo $installer_version | awk -F'[^0-9]*' '$0=$1$2$3')
 62 | installer_qualifies=$(echo $installer_version_digits_only | head -c4)
 63 | installer_mounted_volume=$(echo "$macOS_installer" | grep -o 'Install.*' | sed 's/....$//')
 64 | 
 65 | # If the installed OS is only four digits long, add a zero to the end.
 66 | 
 67 | if [[ $(echo -n "$macos_version_digits_only" | wc -m | tr -d '[:space:]') = "4" ]]; then
 68 |    macos_version_digits_only="$macos_version_digits_only"0
 69 | fi
 70 | 
 71 | # If the installer's OS version is only four digits long, add a zero to the end.
 72 | 
 73 | if [[ $(echo -n "$installer_version_digits_only" | wc -m | tr -d '[:space:]') = "4" ]]; then
 74 |    installer_version_digits_only="$installer_version_digits_only"0
 75 | fi
 76 | 
 77 | # Define download URL and name for the RecoveryHDUpdate installer package
 78 | # which includes the tools needed to rebuild the Recovery volume or partition.
 79 | 
 80 | recovery_download="http://swcdn.apple.com/content/downloads/14/54/001-08570-A_XCP1PVIXQK/xg4hvg6zgpoxonqkgiw2e2cqo1c0isl97q/SecUpd2020-004HighSierra.RecoveryHDUpdate.pkg"
 81 | recovery_package="SecUpd2020-004HighSierra.RecoveryHDUpdate.pkg"
 82 | 
 83 | # Detect if the macOS installer application is running macOS 10.13.x or later. If the
 84 | # macOS installer application is for 10.12.x or earlier, stop and display an error message.
 85 | 
 86 | if [[ "$installer_qualifies" -lt 1013 ]]; then
 87 |     msg_error "This script supports repairing Recovery for macOS 10.13.0 and later."
 88 |     msg_error "Please use an installer app which installs macOS 10.13.0 or later."
 89 | 	exit 1
 90 | else
 91 |     msg_status "Installer application for macOS $installer_version detected. Proceeding...."
 92 | fi
 93 | 
 94 | if [[ "$installer_version_digits_only" -lt "$macos_version_digits_only" ]]; then
 95 |     msg_error "The macOS installer app provided installs $installer_version's Recovery, which is earlier than macOS $macos_version"
 96 |     msg_error "Please use an installer app which installs macOS $macos_version or later."
 97 |     usage
 98 | 	exit 1
 99 | fi
100 | 
101 | # Identify the target disk
102 | 
103 | boot_drive=$(/usr/sbin/diskutil info "$(bless --info --getBoot)" | awk -F':' '/Volume Name/ { print $2 }' | sed -e 's/^[[:space:]]*//')
104 | msg_status "Target disk is ${boot_drive}."
105 | 
106 | # Detect the target disk's filesystem type (APFS or HFS+)
107 | 
108 | filesystem_type=$(/usr/sbin/diskutil info "$boot_drive" | awk '$1 == "Type" { print $NF }')
109 | msg_status "Target filesystem is ${filesystem_type}."
110 | 
111 | msg_status "Downloading $recovery_package into /private/tmp"
112 | /usr/bin/curl "$recovery_download" --progress-bar -L -o /private/tmp/"$recovery_package"
113 | pkgutil --expand /private/tmp/"$recovery_package" /private/tmp/recoveryupdate"$installer_version"
114 | 
115 | if [[ -d /private/tmp/recoveryupdate"$installer_version" ]]; then
116 |    return_code=0
117 |   if [[ "${filesystem_type}" == "apfs" ]]; then
118 | 	msg_status "Running ensureRecoveryBooter for APFS target volume: ${boot_drive}"
119 | 	/private/tmp/recoveryupdate"$installer_version"/Scripts/Tools/dm ensureRecoveryBooter "$boot_drive" -base "$mount_point/BaseSystem.dmg" "$mount_point/BaseSystem.chunklist" -diag "$mount_point/AppleDiagnostics.dmg" "$mount_point/AppleDiagnostics.chunklist" -diagmachineblacklist 0 -installbootfromtarget 0 -slurpappleboot 0 -delappleboot 0 -addkernelcoredump 0
120 |     return_code=$(($return_code + $?))
121 |       if [[ "$return_code" == 0 ]]; then
122 |          msg_status "Successfully created $installer_version Recovery volume on ${boot_drive}."
123 |       else
124 |          msg_error "Failed to create $installer_version Recovery volume on ${boot_drive}."
125 |          msg_error "Recovery tools returned the following non-zero exit code: $return_code"
126 |          exit $return_code
127 |       fi
128 |   elif [[ "${filesystem_type}" == "hfs" ]]; then
129 | 	msg_status "Running ensureRecoveryPartition for non-APFS target volume: ${boot_drive}"
130 | 	/private/tmp/recoveryupdate"$installer_version"/Scripts/Tools/dm ensureRecoveryPartition "$boot_drive" "$mount_point/BaseSystem.dmg" "$mount_point/BaseSystem.chunklist" "$mount_point/AppleDiagnostics.dmg" "$mount_point/AppleDiagnostics.chunklist" 0 0 0
131 | 	return_code=$(($return_code + $?))
132 |       if [[ "$return_code" == 0 ]]; then
133 |          msg_status "Successfully created $installer_version Recovery partition on ${boot_drive}."
134 |       else
135 |          msg_error "Failed to create $installer_version Recovery partition on ${boot_drive}."
136 |          msg_error "Recovery tools returned the following non-zero exit code: $return_code"
137 |          exit $return_code
138 |       fi
139 |   else
140 | 	msg_error "Failed to create $installer_version Recovery partition on ${boot_drive}."
141 | 	msg_error "${boot_drive} does not have an APFS or HFS+ filesystem."
142 |   fi
143 | else
144 |    msg_error "Unable to locate the following directory: /private/tmp/recoveryupdate"$installer_version""
145 |    exit 1
146 | fi
147 | 
148 | # Clean up
149 | /bin/rm -rf /private/tmp/"$recovery_package"
150 | /bin/rm -rf /private/tmp/recoveryupdate"$installer_version"
151 | 


--------------------------------------------------------------------------------