]> code.delx.au - refind/blob - install.sh
Added ability to mount an unmounted ESP under Linux to install.sh.
[refind] / install.sh
1 #!/bin/bash
2 #
3 # Linux/MacOS X script to install rEFInd
4 #
5 # Usage:
6 #
7 # ./install.sh [options]
8 #
9 # options include:
10 # "--esp" to install to the ESP rather than to the system's root
11 # filesystem. This is the default on Linux.
12 # "--usedefault {devicefile}" to install as default
13 # (/EFI/BOOT/BOOTX64.EFI and similar) to the specified device
14 # (/dev/sdd1 or whatever) without registering with the NVRAM.
15 # "--ownhfs {devicefile}" to install to an HFS+ volume that's NOT currently
16 # an OS X boot volume.
17 # "--root {dir}" to specify installation using the specified directory
18 # as the system's root
19 # "--alldrivers" to install all drivers along with regular files
20 # "--nodrivers" to suppress driver installation (default in Linux is
21 # driver used on /boot; --nodrivers is OS X default)
22 # "--shim {shimfile}" to install a shim.efi file for Secure Boot
23 # "--preloader" is synonymous with "--shim"
24 # "--localkeys" to re-sign x86-64 binaries with a locally-generated key
25 # "--yes" to assume a "yes" response to all prompts
26 #
27 # The "esp" option is valid only on Mac OS X; it causes
28 # installation to the EFI System Partition (ESP) rather than
29 # to the current OS X boot partition. Under Linux, this script
30 # installs to the ESP by default.
31 #
32 # This program is copyright (c) 2012 by Roderick W. Smith
33 # It is released under the terms of the GNU GPL, version 3,
34 # a copy of which should be included in the file COPYING.txt.
35 #
36 # Revision history:
37 #
38 # 0.7.7 -- Fixed bug that created mangled refind_linux.conf file; added ability
39 # to locate and mount ESP on Linux, if it's not mounted
40 # 0.7.6 -- Added --ownhfs {device-filename} option
41 # 0.7.5 -- Fixed bug when installing to ESP on recent versions of OS X
42 # 0.7.2 -- Fixed code that could be confused by use of autofs to mount the ESP
43 # 0.7.0 -- Added support for the new Btrfs driver
44 # 0.6.12 -- Added support for PreLoader as well as for shim
45 # 0.6.11 -- Improvements in script's ability to handle directories with spaces
46 # in their names
47 # 0.6.9 -- Install gptsync on Macs
48 # 0.6.8 -- Bug fix: ESP scan now uses "uniq".
49 # 0.6.6 -- Bug fix: Upgrade drivers when installed to EFI/BOOT. Also enable
50 # copying shim.efi and MokManager.efi over themselves.
51 # 0.6.4 -- Copies ext2 driver rather than ext4 driver for ext2/3fs
52 # 0.6.3 -- Support for detecting rEFInd in EFI/BOOT and EFI/Microsoft/Boot
53 # directories & for installing to EFI/BOOT in BIOS mode
54 # 0.6.2-1 -- Added --yes option & tweaked key-copying for use with RPM install script
55 # 0.6.1 -- Added --root option; minor bug fixes
56 # 0.6.0 -- Changed --drivers to --alldrivers and added --nodrivers option;
57 # changed default driver installation behavior in Linux to install
58 # the driver needed to read /boot (if available)
59 # 0.5.1.2 -- Fixed bug that caused failure to generate refind_linux.conf file
60 # 0.5.1.1 -- Fixed bug that caused script failure under OS X
61 # 0.5.1 -- Added --shim & --localkeys options & create sample refind_linux.conf
62 # in /boot
63 # 0.5.0 -- Added --usedefault & --drivers options & changed "esp" option to "--esp"
64 # 0.4.5 -- Fixed check for rEFItBlesser in OS X
65 # 0.4.2 -- Added notice about BIOS-based OSes & made NVRAM changes in Linux smarter
66 # 0.4.1 -- Added check for rEFItBlesser in OS X
67 # 0.3.3.1 -- Fixed OS X 10.7 bug; also works as make target
68 # 0.3.2.1 -- Check for presence of source files; aborts if not present
69 # 0.3.2 -- Initial version
70 #
71 # Note: install.sh version numbers match those of the rEFInd package
72 # with which they first appeared.
73
74 RootDir="/"
75 TargetDir=/EFI/refind
76 LocalKeysBase="refind_local"
77 ShimSource="none"
78 ShimType="none"
79 TargetShim="default"
80 TargetX64="refind_x64.efi"
81 TargetIA32="refind_ia32.efi"
82 LocalKeys=0
83 DeleteRefindDir=0
84 AlwaysYes=0
85
86 #
87 # Functions used by both OS X and Linux....
88 #
89
90 GetParams() {
91 InstallToEspOnMac=0
92 if [[ $OSName == "Linux" ]] ; then
93 # Install the driver required to read /boot, if it's available
94 InstallDrivers="boot"
95 else
96 InstallDrivers="none"
97 fi
98 while [[ $# -gt 0 ]]; do
99 case $1 in
100 --esp | --ESP) InstallToEspOnMac=1
101 ;;
102 --ownhfs) OwnHfs=1
103 TargetPart="$2"
104 TargetDir=/System/Library/CoreServices
105 shift
106 ;;
107 --usedefault) TargetDir=/EFI/BOOT
108 TargetPart="$2"
109 TargetX64="bootx64.efi"
110 TargetIA32="bootia32.efi"
111 shift
112 ;;
113 --root) RootDir="$2"
114 shift
115 ;;
116 --localkeys) LocalKeys=1
117 ;;
118 --shim | --preloader) ShimSource="$2"
119 ShimType=`basename $ShimSource`
120 shift
121 ;;
122 --drivers | --alldrivers) InstallDrivers="all"
123 ;;
124 --nodrivers) InstallDrivers="none"
125 ;;
126 --yes) AlwaysYes=1
127 ;;
128 * ) echo "Usage: $0 [--esp | --usedefault {device-file} | --root {directory} |"
129 echo " --ownhfs {device-file} ]"
130 echo " [--nodrivers | --alldrivers] [--shim {shim-filename}]"
131 echo " [--localkeys] [--yes]"
132 exit 1
133 esac
134 shift
135 done
136
137 if [[ $InstallToEspOnMac == 1 && "$TargetDir" == '/EFI/BOOT' ]] ; then
138 echo "You may use --esp OR --usedefault, but not both! Aborting!"
139 exit 1
140 fi
141 if [[ "$RootDir" != '/' && "$TargetDir" == '/EFI/BOOT' ]] ; then
142 echo "You may use --usedefault OR --root, but not both! Aborting!"
143 exit 1
144 fi
145 if [[ "$RootDir" != '/' && $InstallToEspOnMac == 1 ]] ; then
146 echo "You may use --root OR --esp, but not both! Aborting!"
147 exit 1
148 fi
149 if [[ "$TargetDir" != '/System/Library/CoreServices' && "$OwnHfs" == '1' ]] ; then
150 echo "If you use --ownhfs, you may NOT use --usedefault! Aborting!"
151 exit 1
152 fi
153
154 RLConfFile="$RootDir/boot/refind_linux.conf"
155 EtcKeysDir="$RootDir/etc/refind.d/keys"
156 } # GetParams()
157
158 # Get a yes/no response from the user and place it in the YesNo variable.
159 # If the AlwaysYes variable is set to 1, skip the user input and set "Y"
160 # in the YesNo variable.
161 ReadYesNo() {
162 if [[ $AlwaysYes == 1 ]] ; then
163 YesNo="Y"
164 echo "Y"
165 else
166 read YesNo
167 fi
168 }
169
170 # Abort if the rEFInd files can't be found.
171 # Also sets $ConfFile to point to the configuration file,
172 # $IconsDir to point to the icons directory, and
173 # $ShimSource to the source of the shim.efi file (if necessary).
174 CheckForFiles() {
175 # Note: This check is satisfied if EITHER the 32- or the 64-bit version
176 # is found, even on the wrong platform. This is because the platform
177 # hasn't yet been determined. This could obviously be improved, but it
178 # would mean restructuring lots more code....
179 if [[ ! -f "$RefindDir/refind_ia32.efi" && ! -f "$RefindDir/refind_x64.efi" ]] ; then
180 echo "The rEFInd binary file is missing! Aborting installation!"
181 exit 1
182 fi
183
184 if [[ -f "$RefindDir/refind.conf-sample" ]] ; then
185 ConfFile="$RefindDir/refind.conf-sample"
186 elif [[ -f "$ThisDir/refind.conf-sample" ]] ; then
187 ConfFile="$ThisDir/refind.conf-sample"
188 else
189 echo "The sample configuration file is missing! Aborting installation!"
190 exit 1
191 fi
192
193 if [[ -d "$RefindDir/icons" ]] ; then
194 IconsDir="$RefindDir/icons"
195 elif [[ -d "$ThisDir/icons" ]] ; then
196 IconsDir="$ThisDir/icons"
197 else
198 echo "The icons directory is missing! Aborting installation!"
199 exit 1
200 fi
201
202 if [[ "$ShimSource" != "none" ]] ; then
203 if [[ -f "$ShimSource" ]] ; then
204 if [[ $ShimType == "shimx64.efi" || $ShimType == "shim.efi" ]] ; then
205 TargetX64="grubx64.efi"
206 MokManagerSource=`dirname "$ShimSource"`/MokManager.efi
207 elif [[ $ShimType == "preloader.efi" || $ShimType == "PreLoader.efi" ]] ; then
208 TargetX64="loader.efi"
209 MokManagerSource=`dirname "$ShimSource"`/HashTool.efi
210 else
211 echo "Unknown shim/PreBootloader filename: $ShimType!"
212 echo "Known filenames are shimx64.efi, shim.efi, and PreLoader.efi. Aborting!"
213 exit 1
214 fi
215 else
216 echo "The specified shim/PreBootloader file, $ShimSource, doesn't exist!"
217 echo "Aborting installation!"
218 exit 1
219 fi
220 fi
221 } # CheckForFiles()
222
223 # Helper for CopyRefindFiles; copies shim files (including MokManager, if it's
224 # available) to target.
225 CopyShimFiles() {
226 cp -fb "$ShimSource" "$InstallDir/$TargetDir/$TargetShim"
227 if [[ $? != 0 ]] ; then
228 Problems=1
229 fi
230 if [[ -f "$MokManagerSource" ]] ; then
231 cp -fb "$MokManagerSource" "$InstallDir/$TargetDir/"
232 fi
233 if [[ $? != 0 ]] ; then
234 Problems=1
235 fi
236 } # CopyShimFiles()
237
238 # Copy the public keys to the installation medium
239 CopyKeys() {
240 if [[ $LocalKeys == 1 ]] ; then
241 mkdir -p "$InstallDir/$TargetDir/keys/"
242 cp "$EtcKeysDir/$LocalKeysBase.cer" "$InstallDir/$TargetDir/keys/"
243 cp "$EtcKeysDir/$LocalKeysBase.crt" "$InstallDir/$TargetDir/keys/"
244 fi
245 } # CopyKeys()
246
247 # Copy drivers from $RefindDir/drivers_$1 to $InstallDir/$TargetDir/drivers_$1,
248 # honoring the $InstallDrivers condition. Must be passed a suitable
249 # architecture code (ia32 or x64).
250 CopyDrivers() {
251 if [[ $InstallDrivers == "all" ]] ; then
252 mkdir -p "$InstallDir/$TargetDir/drivers_$1"
253 cp "$ThisDir"/drivers_$1/*_$1.efi "$InstallDir/$TargetDir/drivers_$1/" 2> /dev/null
254 cp "$RefindDir"/drivers_$1/*_$1.efi "$InstallDir/$TargetDir/drivers_$1/" 2> /dev/null
255 elif [[ "$InstallDrivers" == "boot" && -x `which blkid` ]] ; then
256 BootPart=`df /boot | grep dev | cut -f 1 -d " "`
257 BootFS=`blkid -o export $BootPart 2> /dev/null | grep TYPE= | cut -f 2 -d =`
258 DriverType=""
259 case $BootFS in
260 ext2 | ext3) DriverType="ext2"
261 # Could use ext4, but that can create unwanted entries from symbolic
262 # links in / to /boot/vmlinuz if a separate /boot partition is used.
263 ;;
264 ext4) DriverType="ext4"
265 ;;
266 reiserfs) DriverType="reiserfs"
267 ;;
268 btrfs) DriverType="btrfs"
269 ;;
270 hfsplus) DriverType="hfs"
271 ;;
272 *) BootFS=""
273 esac
274 if [[ -n $BootFS ]] ; then
275 echo "Installing driver for $BootFS (${DriverType}_$1.efi)"
276 mkdir -p "$InstallDir/$TargetDir/drivers_$1"
277 cp "$ThisDir/drivers_$1/${DriverType}_$1.efi" "$InstallDir/$TargetDir/drivers_$1/" 2> /dev/null
278 cp "$RefindDir/drivers_$1/${DriverType}_$1.efi" "$InstallDir/$TargetDir/drivers_$1"/ 2> /dev/null
279 fi
280 fi
281 }
282
283 # Copy tools (currently only gptsync, and that only on Macs) to the EFI/tools
284 # directory on the ESP. Must be passed a suitable architecture code (ia32
285 # or x64).
286 CopyTools() {
287 mkdir -p $InstallDir/EFI/tools
288 if [[ $OSName == 'Darwin' ]] ; then
289 cp -f "$RefindDir/tools_$1/gptsync_$1.efi" "$InstallDir/EFI/tools/"
290 if [[ -f "$InstallDir/EFI/tools/gptsync.efi" ]] ; then
291 mv "$InstallDir/EFI/tools/gptsync.efi" "$InstallDir/EFI/tools/gptsync.efi-disabled"
292 echo "Found old gptsync.efi; disabling it by renaming it to gptsync.efi-disabled"
293 fi
294 fi
295 } # CopyTools()
296
297 # Copy the rEFInd files to the ESP or OS X root partition.
298 # Sets Problems=1 if any critical commands fail.
299 CopyRefindFiles() {
300 mkdir -p "$InstallDir/$TargetDir"
301 if [[ "$TargetDir" == '/EFI/BOOT' ]] ; then
302 cp "$RefindDir/refind_ia32.efi" "$InstallDir/$TargetDir/$TargetIA32" 2> /dev/null
303 if [[ $? != 0 ]] ; then
304 echo "Note: IA32 (x86) binary not installed!"
305 fi
306 cp "$RefindDir/refind_x64.efi" "$InstallDir/$TargetDir/$TargetX64" 2> /dev/null
307 if [[ $? != 0 ]] ; then
308 Problems=1
309 fi
310 if [[ "$ShimSource" != "none" ]] ; then
311 TargetShim="bootx64.efi"
312 CopyShimFiles
313 fi
314 if [[ $InstallDrivers == "all" ]] ; then
315 cp -r "$RefindDir"/drivers_* "$InstallDir/$TargetDir/" 2> /dev/null
316 cp -r "$ThisDir"/drivers_* "$InstallDir/$TargetDir/" 2> /dev/null
317 elif [[ $Upgrade == 1 ]] ; then
318 if [[ $Platform == 'EFI64' ]] ; then
319 CopyDrivers x64
320 CopyTools x64
321 else
322 CopyDrivers ia32
323 CopyTools ia32
324 fi
325 fi
326 Refind=""
327 CopyKeys
328 elif [[ $Platform == 'EFI64' || $TargetDir == "/EFI/Microsoft/Boot" ]] ; then
329 cp "$RefindDir/refind_x64.efi" "$InstallDir/$TargetDir/$TargetX64"
330 if [[ $? != 0 ]] ; then
331 Problems=1
332 fi
333 CopyDrivers x64
334 CopyTools x64
335 Refind="refind_x64.efi"
336 CopyKeys
337 if [[ "$ShimSource" != "none" ]] ; then
338 if [[ "$TargetShim" == "default" ]] ; then
339 TargetShim=`basename "$ShimSource"`
340 fi
341 CopyShimFiles
342 Refind="$TargetShim"
343 if [[ $LocalKeys == 0 ]] ; then
344 echo "Storing copies of rEFInd Secure Boot public keys in $EtcKeysDir"
345 mkdir -p "$EtcKeysDir"
346 cp "$ThisDir/keys/refind.cer" "$EtcKeysDir" 2> /dev/null
347 cp "$ThisDir/keys/refind.crt" "$EtcKeysDir" 2> /dev/null
348 fi
349 fi
350 if [[ "$TargetDir" == '/System/Library/CoreServices' ]] ; then
351 SetupMacHfs $TargetX64
352 fi
353 elif [[ $Platform == 'EFI32' ]] ; then
354 cp "$RefindDir/refind_ia32.efi" "$InstallDir/$TargetDir/$TargetIA32"
355 if [[ $? != 0 ]] ; then
356 Problems=1
357 fi
358 CopyDrivers ia32
359 CopyTools ia32
360 Refind="refind_ia32.efi"
361 if [[ "$TargetDir" == '/System/Library/CoreServices' ]] ; then
362 SetupMacHfs $TargetIA32
363 fi
364 else
365 echo "Unknown platform! Aborting!"
366 exit 1
367 fi
368 echo "Copied rEFInd binary files"
369 echo ""
370 if [[ -d "$InstallDir/$TargetDir/icons" ]] ; then
371 rm -rf "$InstallDir/$TargetDir/icons-backup" &> /dev/null
372 mv -f "$InstallDir/$TargetDir/icons" "$InstallDir/$TargetDir/icons-backup"
373 echo "Notice: Backed up existing icons directory as icons-backup."
374 fi
375 cp -r "$IconsDir" "$InstallDir/$TargetDir"
376 if [[ $? != 0 ]] ; then
377 Problems=1
378 fi
379 mkdir -p "$InstallDir/$TargetDir/keys"
380 cp -rf "$ThisDir"/keys/*.[cd]er "$InstallDir/$TargetDir/keys/" 2> /dev/null
381 cp -rf "$EtcKeysDir"/*.[cd]er "$InstallDir/$TargetDir/keys/" 2> /dev/null
382 if [[ -f "$InstallDir/$TargetDir/refind.conf" ]] ; then
383 echo "Existing refind.conf file found; copying sample file as refind.conf-sample"
384 echo "to avoid overwriting your customizations."
385 echo ""
386 cp -f "$ConfFile" "$InstallDir/$TargetDir"
387 if [[ $? != 0 ]] ; then
388 Problems=1
389 fi
390 else
391 echo "Copying sample configuration file as refind.conf; edit this file to configure"
392 echo "rEFInd."
393 echo ""
394 cp -f "$ConfFile" "$InstallDir/$TargetDir/refind.conf"
395 if [[ $? != 0 ]] ; then
396 Problems=1
397 fi
398 fi
399 if [[ $DeleteRefindDir == 1 ]] ; then
400 echo "Deleting the temporary directory $RefindDir"
401 rm -r "$RefindDir"
402 fi
403 } # CopyRefindFiles()
404
405 # Mount the partition the user specified with the --usedefault or --ownhfs option
406 MountDefaultTarget() {
407 InstallDir=/tmp/refind_install
408 mkdir -p "$InstallDir"
409 UnmountEsp=1
410 if [[ $OSName == 'Darwin' ]] ; then
411 if [[ $OwnHfs == '1' ]] ; then
412 Temp=`diskutil info "$TargetPart" | grep "Mount Point"`
413 InstallDir=`echo $Temp | cut -f 3-30 -d ' '`
414 if [[ $InstallDir == '' ]] ; then
415 InstallDir=/tmp/refind_install
416 mount -t hfs "$TargetPart" "$InstallDir"
417 else
418 UnmountEsp=0
419 fi
420 else
421 mount -t msdos "$TargetPart" "$InstallDir"
422 fi
423 elif [[ $OSName == 'Linux' ]] ; then
424 mount -t vfat "$TargetPart" "$InstallDir"
425 fi
426 if [[ $? != 0 ]] ; then
427 echo "Couldn't mount $TargetPart ! Aborting!"
428 rmdir "$InstallDir"
429 exit 1
430 fi
431 echo "UnmountEsp = $UnmountEsp"
432 } # MountDefaultTarget()
433
434 #
435 # A series of OS X support functions....
436 #
437
438 # Mount the ESP at /Volumes/ESP or determine its current mount
439 # point.
440 # Sets InstallDir to the ESP mount point
441 # Sets UnmountEsp if we mounted it
442 MountOSXESP() {
443 # Identify the ESP. Note: This returns the FIRST ESP found;
444 # if the system has multiple disks, this could be wrong!
445 Temp=`diskutil list | grep " EFI " | grep -o 'disk.*'`
446 Esp=/dev/`echo $Temp`
447 # If the ESP is mounted, use its current mount point....
448 Temp=`df -P | grep "$Esp"`
449 InstallDir=`echo $Temp | cut -f 6 -d ' '`
450 if [[ "$InstallDir" == '' ]] ; then
451 mkdir /Volumes/ESP &> /dev/null
452 mount -t msdos "$Esp" /Volumes/ESP
453 if [[ $? != 0 ]] ; then
454 echo "Unable to mount ESP! Aborting!\n"
455 exit 1
456 fi
457 UnmountEsp=1
458 InstallDir="/Volumes/ESP"
459 fi
460 } # MountOSXESP()
461
462 # Set up for booting from Mac HFS+ volume that boots rEFInd in MJG's way
463 # (http://mjg59.dreamwidth.org/7468.html)
464 # Must be passed the original rEFInd binary filename (without a path).
465 SetupMacHfs() {
466 if [[ -s "$InstallDir/mach_kernel" ]] ; then
467 echo "Attempt to install rEFInd to a partition with a /mach_kernel file! Aborting!"
468 exit 1
469 fi
470 cp -n "$InstallDir/$TargetDir/boot.efi" "$InstallDir/$TargetDir/boot.efi-backup" &> /dev/null
471 ln -f "$InstallDir/$TargetDir/$1" "$InstallDir/$TargetDir/boot.efi"
472 touch "$InstallDir/mach_kernel"
473 cp -n "$RefindDir/icons/os_refind.icns" "$InstallDir/.VolumeIcon.icns" &> /dev/null
474 rm "$InstallDir/$TargetDir/SystemVersion.plist" &> /dev/null
475 cat - << ENDOFHERE >> "$InstallDir/$TargetDir/SystemVersion.plist"
476 <xml version="1.0" encoding="UTF-8"?>
477 <plist version="1.0">
478 <dict>
479 <key>ProductBuildVersion</key>
480 <string></string>
481 <key>ProductName</key>
482 <string>rEFInd</string>
483 <key>ProductVersion</key>
484 <string>0.7.6</string>
485 </dict>
486 </plist>
487 ENDOFHERE
488 } # SetupMacHfs()
489
490 # Control the OS X installation.
491 # Sets Problems=1 if problems found during the installation.
492 InstallOnOSX() {
493 echo "Installing rEFInd on OS X...."
494 if [[ "$TargetDir" == "/EFI/BOOT" || "$OwnHfs" == '1' ]] ; then
495 MountDefaultTarget
496 elif [[ "$InstallToEspOnMac" == "1" ]] ; then
497 MountOSXESP
498 else
499 InstallDir="$RootDir/"
500 fi
501 echo "Installing rEFInd to the partition mounted at $InstallDir"
502 Platform=`ioreg -l -p IODeviceTree | grep firmware-abi | cut -d "\"" -f 4`
503 CopyRefindFiles
504 if [[ $InstallToEspOnMac == "1" ]] ; then
505 bless --mount "$InstallDir" --setBoot --file "$InstallDir/$TargetDir/$Refind"
506 elif [[ "$TargetDir" != "/EFI/BOOT" ]] ; then
507 bless --setBoot --folder "$InstallDir/$TargetDir" --file "$InstallDir/$TargetDir/$Refind"
508 fi
509 if [[ $? != 0 ]] ; then
510 Problems=1
511 fi
512 if [[ -f /Library/StartupItems/rEFItBlesser || -d /Library/StartupItems/rEFItBlesser ]] ; then
513 echo
514 echo "/Library/StartupItems/rEFItBlesser found!"
515 echo "This program is part of rEFIt, and will cause rEFInd to fail to work after"
516 echo -n "its first boot. Do you want to remove rEFItBlesser (Y/N)? "
517 ReadYesNo
518 if [[ $YesNo == "Y" || $YesNo == "y" ]] ; then
519 echo "Deleting /Library/StartupItems/rEFItBlesser..."
520 rm -r /Library/StartupItems/rEFItBlesser
521 else
522 echo "Not deleting rEFItBlesser."
523 fi
524 fi
525 echo
526 echo "WARNING: If you have an Advanced Format disk, *DO NOT* attempt to check the"
527 echo "bless status with 'bless --info', since this is known to cause disk corruption"
528 echo "on some systems!!"
529 echo
530 } # InstallOnOSX()
531
532
533 #
534 # Now a series of Linux support functions....
535 #
536
537 # Check for evidence that we're running in Secure Boot mode. If so, and if
538 # appropriate options haven't been set, warn the user and offer to abort.
539 # If we're NOT in Secure Boot mode but the user HAS specified the --shim
540 # or --localkeys option, warn the user and offer to abort.
541 #
542 # FIXME: Although I checked the presence (and lack thereof) of the
543 # /sys/firmware/efi/vars/SecureBoot* files on my Secure Boot test system
544 # before releasing this script, I've since found that they are at least
545 # sometimes present when Secure Boot is absent. This means that the first
546 # test can produce false alarms. A better test is highly desirable.
547 CheckSecureBoot() {
548 VarFile=`ls -d /sys/firmware/efi/vars/SecureBoot* 2> /dev/null`
549 if [[ -n "$VarFile" && "$TargetDir" != '/EFI/BOOT' && "$ShimSource" == "none" ]] ; then
550 echo ""
551 echo "CAUTION: Your computer appears to support Secure Boot, but you haven't"
552 echo "specified a valid shim.efi file source. If you've disabled Secure Boot and"
553 echo "intend to leave it disabled, this is fine; but if Secure Boot is active, the"
554 echo "resulting installation won't boot. You can read more about this topic at"
555 echo "http://www.rodsbooks.com/refind/secureboot.html."
556 echo ""
557 echo -n "Do you want to proceed with installation (Y/N)? "
558 ReadYesNo
559 if [[ $YesNo == "Y" || $YesNo == "y" ]] ; then
560 echo "OK; continuing with the installation..."
561 else
562 exit 0
563 fi
564 fi
565
566 if [[ "$ShimSource" != "none" && ! -n "$VarFile" ]] ; then
567 echo ""
568 echo "You've specified installing using a shim.efi file, but your computer does not"
569 echo "appear to be running in Secure Boot mode. Although installing in this way"
570 echo "should work, it's unnecessarily complex. You may continue, but unless you"
571 echo "plan to enable Secure Boot, you should consider stopping and omitting the"
572 echo "--shim option. You can read more about this topic at"
573 echo "http://www.rodsbooks.com/refind/secureboot.html."
574 echo ""
575 echo -n "Do you want to proceed with installation (Y/N)? "
576 ReadYesNo
577 if [[ $YesNo == "Y" || $YesNo == "y" ]] ; then
578 echo "OK; continuing with the installation..."
579 else
580 exit 0
581 fi
582 fi
583
584 if [[ $LocalKeys != 0 && ! -n "$VarFile" ]] ; then
585 echo ""
586 echo "You've specified re-signing your rEFInd binaries with locally-generated keys,"
587 echo "but your computer does not appear to be running in Secure Boot mode. The"
588 echo "keys you generate will be useless unless you enable Secure Boot. You may"
589 echo "proceed with this installation, but before you do so, you may want to read"
590 echo "more about it at http://www.rodsbooks.com/refind/secureboot.html."
591 echo ""
592 echo -n "Do you want to proceed with installation (Y/N)? "
593 ReadYesNo
594 if [[ $YesNo == "Y" || $YesNo == "y" ]] ; then
595 echo "OK; continuing with the installation..."
596 else
597 exit 0
598 fi
599 fi
600
601 } # CheckSecureBoot()
602
603 # Check for the presence of locally-generated keys from a previous installation in
604 # $EtcKeysDir (/etc/refind.d/keys). If they're not present, generate them using
605 # openssl.
606 GenerateKeys() {
607 PrivateKey="$EtcKeysDir/$LocalKeysBase.key"
608 CertKey="$EtcKeysDir/$LocalKeysBase.crt"
609 DerKey="$EtcKeysDir/$LocalKeysBase.cer"
610 OpenSSL=`which openssl 2> /dev/null`
611
612 # Do the work only if one or more of the necessary keys is missing
613 # TODO: Technically, we don't need the DerKey; but if it's missing and openssl
614 # is also missing, this will fail. This could be improved.
615 if [[ ! -f "$PrivateKey" || ! -f "$CertKey" || ! -f "$DerKey" ]] ; then
616 echo "Generating a fresh set of local keys...."
617 mkdir -p "$EtcKeysDir"
618 chmod 0700 "$EtcKeysDir"
619 if [[ ! -x "$OpenSSL" ]] ; then
620 echo "Can't find openssl, which is required to create your private signing keys!"
621 echo "Aborting!"
622 exit 1
623 fi
624 if [[ -f "$PrivateKey" ]] ; then
625 echo "Backing up existing $PrivateKey"
626 cp -f "$PrivateKey" "$PrivateKey.backup" 2> /dev/null
627 fi
628 if [[ -f "$CertKey" ]] ; then
629 echo "Backing up existing $CertKey"
630 cp -f "$CertKey" "$CertKey.backup" 2> /dev/null
631 fi
632 if [[ -f "$DerKey" ]] ; then
633 echo "Backing up existing $DerKey"
634 cp -f "$DerKey" "$DerKey.backup" 2> /dev/null
635 fi
636 "$OpenSSL" req -new -x509 -newkey rsa:2048 -keyout "$PrivateKey" -out "$CertKey" \
637 -nodes -days 3650 -subj "/CN=Locally-generated rEFInd key/"
638 "$OpenSSL" x509 -in "$CertKey" -out "$DerKey" -outform DER
639 chmod 0600 "$PrivateKey"
640 else
641 echo "Using existing local keys...."
642 fi
643 }
644
645 # Sign a single binary. Requires parameters:
646 # $1 = source file
647 # $2 = destination file
648 # Also assumes that the SBSign, PESign, UseSBSign, UsePESign, and various key variables are set
649 # appropriately.
650 # Aborts script on error
651 SignOneBinary() {
652 $SBSign --key "$PrivateKey" --cert "$CertKey" --output "$2" "$1"
653 if [[ $? != 0 ]] ; then
654 echo "Problem signing the binary $1! Aborting!"
655 exit 1
656 fi
657 }
658
659 # Re-sign the x86-64 binaries with a locally-generated key, First look for appropriate
660 # key files in $EtcKeysDir. If they're present, use them to re-sign the binaries. If
661 # not, try to generate new keys and store them in $EtcKeysDir.
662 ReSignBinaries() {
663 SBSign=`which sbsign 2> /dev/null`
664 echo "Found sbsign at $SBSign"
665 TempDir="/tmp/refind_local"
666 if [[ ! -x "$SBSign" ]] ; then
667 echo "Can't find sbsign, which is required to sign rEFInd with your own keys!"
668 echo "Aborting!"
669 exit 1
670 fi
671 GenerateKeys
672 mkdir -p "$TempDir/drivers_x64"
673 cp "$RefindDir/refind.conf-sample $TempDir" 2> /dev/null
674 cp "$ThisDir/refind.conf-sample $TempDir" 2> /dev/null
675 cp "$RefindDir/refind_ia32.efi $TempDir" 2> /dev/null
676 cp -a "$RefindDir/drivers_ia32 $TempDir" 2> /dev/null
677 cp -a "$ThisDir/drivers_ia32 $TempDir" 2> /dev/null
678 SignOneBinary "$RefindDir/refind_x64.efi" "$TempDir/refind_x64.efi"
679 SaveIFS=$IFS
680 IFS=$(echo -en "\n\b")
681 for Driver in `ls "$RefindDir"/drivers_x64/*.efi "$ThisDir"/drivers_x64/*.efi 2> /dev/null` ; do
682 TempName=`basename "$Driver"`
683 SignOneBinary "$Driver" "$TempDir/drivers_x64/$TempName"
684 done
685 IFS=$SaveIFS
686 RefindDir="$TempDir"
687 DeleteRefindDir=1
688 } # ReSignBinaries()
689
690 # Locate and mount an ESP, if possible, based on parted output.
691 # Should be called only if /boot/efi is NOT an acceptable ESP.
692 # Sets InstallDir to the mounted ESP's path ($RootDir/boot/efi)
693 # and EspFilesystem the filesystem (always "vfat")
694 FindLinuxESP() {
695 echo "The ESP doesn't seem to be mounted! Trying to find it...."
696 local Drive
697 local PartNum
698 local TableType
699 for Drive in `ls /dev/[sh]d?` ; do
700 TableType=`parted $Drive print -m -s 2> /dev/null | head -n 2 | tail -n 1 | cut -d ":" -f 6`
701 if [[ $TableType == 'gpt' ]] ; then # read only GPT disks
702 PartNum=`parted $Drive print -m -s 2> /dev/null | grep ":boot[,;]" | cut -d ":" -f 1`
703 if [ "$PartNum" -eq "$PartNum" ] 2> /dev/null ; then
704 InstallDir="$RootDir/boot/efi"
705 mkdir -p $InstallDir
706 mount $Drive$PartNum $InstallDir
707 EspFilesystem=`grep "$Drive$PartNum.*/boot/efi" /etc/mtab | uniq | grep -v autofs | cut -d " " -f 3`
708 if [[ $EspFilesystem != 'vfat' ]] ; then
709 umount $InstallDir
710 else
711 echo "Mounting ESP at $InstallDir"
712 break;
713 fi
714 fi # $PartNum -eq $PartNum
715 fi # TableType
716 done
717 } # FindLinuxESP()
718
719 # Identifies the ESP's location (/boot or /boot/efi, or these locations under
720 # the directory specified by --root); aborts if the ESP isn't mounted at
721 # either location.
722 # Sets InstallDir to the ESP mount point.
723 FindMountedESP() {
724 EspLine=`df "$RootDir/boot/efi" 2> /dev/null | grep boot/efi`
725 if [[ ! -n "$EspLine" ]] ; then
726 EspLine=`df "$RootDir"/boot | grep boot`
727 fi
728 InstallDir=`echo $EspLine | cut -d " " -f 6`
729
730 if [[ -n "$InstallDir" ]] ; then
731 EspFilesystem=`grep "$InstallDir" /etc/mtab | uniq | grep -v autofs | cut -d " " -f 3`
732 fi
733 if [[ $EspFilesystem != 'vfat' ]] ; then
734 FindLinuxESP
735 fi
736 if [[ $EspFilesystem != 'vfat' ]] ; then
737 echo "$RootDir/$InstallDir doesn't seem to be on a VFAT filesystem. The ESP must be"
738 echo "mounted at $RootDir/boot or $RootDir/boot/efi and it must be VFAT! Aborting!"
739 exit 1
740 fi
741 echo "ESP was found at $InstallDir using $EspFilesystem"
742 } # FindMountedESP
743
744 # Uses efibootmgr to add an entry for rEFInd to the EFI's NVRAM.
745 # If this fails, sets Problems=1
746 AddBootEntry() {
747 local PartNum
748 InstallIt="0"
749 Efibootmgr=`which efibootmgr 2> /dev/null`
750 if [[ "$Efibootmgr" ]] ; then
751 InstallDisk=`grep "$InstallDir" /etc/mtab | cut -d " " -f 1 | cut -c 1-8`
752 PartNum=`grep "$InstallDir" /etc/mtab | cut -d " " -f 1 | cut -c 9-10`
753 EntryFilename="$TargetDir/$Refind"
754 EfiEntryFilename=`echo ${EntryFilename//\//\\\}`
755 EfiEntryFilename2=`echo ${EfiEntryFilename} | sed s/\\\\\\\\/\\\\\\\\\\\\\\\\/g`
756 ExistingEntry=`"$Efibootmgr" -v | grep -i "$EfiEntryFilename2"`
757
758 if [[ "$ExistingEntry" ]] ; then
759 ExistingEntryBootNum=`echo "$ExistingEntry" | cut -c 5-8`
760 FirstBoot=`"$Efibootmgr" | grep BootOrder | cut -c 12-15`
761 if [[ "$ExistingEntryBootNum" != "$FirstBoot" ]] ; then
762 echo "An existing rEFInd boot entry exists, but isn't set as the default boot"
763 echo "manager. The boot order is being adjusted to make rEFInd the default boot"
764 echo "manager. If this is NOT what you want, you should use efibootmgr to"
765 echo "manually adjust your EFI's boot order."
766 "$Efibootmgr" -b $ExistingEntryBootNum -B &> /dev/null
767 InstallIt="1"
768 fi
769 else
770 InstallIt="1"
771 fi
772
773 if [[ $InstallIt == "1" ]] ; then
774 echo "Installing it!"
775 "$Efibootmgr" -c -l "$EfiEntryFilename" -L "rEFInd Boot Manager" -d $InstallDisk -p $PartNum &> /dev/null
776 if [[ $? != 0 ]] ; then
777 EfibootmgrProblems=1
778 Problems=1
779 fi
780 fi
781
782 else # efibootmgr not found
783 EfibootmgrProblems=1
784 Problems=1
785 fi
786
787 if [[ $EfibootmgrProblems ]] ; then
788 echo
789 echo "ALERT: There were problems running the efibootmgr program! You may need to"
790 echo "rename the $Refind binary to the default name (EFI/boot/bootx64.efi"
791 echo "on x86-64 systems or EFI/boot/bootia32.efi on x86 systems) to have it run!"
792 echo
793 else
794 echo "rEFInd has been set as the default boot manager."
795 fi
796 } # AddBootEntry()
797
798 # Create a minimal/sample refind_linux.conf file in /boot.
799 GenerateRefindLinuxConf() {
800 if [[ -f "$RLConfFile" ]] ; then
801 echo "Existing $RLConfFile found; not overwriting."
802 else
803 echo "Creating $RLConfFile; edit it to adjust kernel options."
804 if [[ -f "$RootDir/etc/default/grub" ]] ; then
805 # We want the default options used by the distribution, stored here....
806 source "$RootDir/etc/default/grub"
807 echo "Setting default boot options based on $RootDir/etc/default/grub"
808 fi
809 RootFS=`df "$RootDir" | grep dev | cut -f 1 -d " "`
810 StartOfDevname=`echo "$RootFS" | cut -b 1-7`
811 if [[ "$StartOfDevname" == "/dev/sd" || "$StartOfDevName" == "/dev/hd" ]] ; then
812 # Identify root filesystem by UUID rather than by device node, if possible
813 Uuid=`blkid -o export -s UUID "$RootFS" 2> /dev/null | grep UUID=`
814 if [[ -n $Uuid ]] ; then
815 RootFS="$Uuid"
816 fi
817 fi
818 DefaultOptions="$GRUB_CMDLINE_LINUX $GRUB_CMDLINE_LINUX_DEFAULT"
819 echo "\"Boot with standard options\" \"ro root=$RootFS $DefaultOptions \"" > $RLConfFile
820 echo "\"Boot to single-user mode\" \"ro root=$RootFS $DefaultOptions single\"" >> $RLConfFile
821 echo "\"Boot with minimal options\" \"ro root=$RootFS\"" >> $RLConfFile
822 fi
823 }
824
825 # Set varaibles for installation in EFI/BOOT directory
826 SetVarsForBoot() {
827 TargetDir="/EFI/BOOT"
828 if [[ $ShimSource == "none" ]] ; then
829 TargetX64="bootx64.efi"
830 TargetIA32="bootia32.efi"
831 else
832 if [[ $ShimType == "shim.efi" || $ShimType == "shimx64.efi" ]] ; then
833 TargetX64="grubx64.efi"
834 elif [[ $ShimType == "preloader.efi" || $ShimType == "PreLoader.efi" ]] ; then
835 TargetX64="loader.efi"
836 else
837 echo "Unknown shim/PreBootloader type: $ShimType"
838 echo "Aborting!"
839 exit 1
840 fi
841 TargetIA32="bootia32.efi"
842 TargetShim="bootx64.efi"
843 fi
844 } # SetFilenamesForBoot()
845
846 # Set variables for installation in EFI/Microsoft/Boot directory
847 SetVarsForMsBoot() {
848 TargetDir="/EFI/Microsoft/Boot"
849 if [[ $ShimSource == "none" ]] ; then
850 TargetX64="bootmgfw.efi"
851 else
852 if [[ $ShimType == "shim.efi" || $ShimType == "shimx64.efi" ]] ; then
853 TargetX64="grubx64.efi"
854 elif [[ $ShimType == "preloader.efi" || $ShimType == "PreLoader.efi" ]] ; then
855 TargetX64="loader.efi"
856 else
857 echo "Unknown shim/PreBootloader type: $ShimType"
858 echo "Aborting!"
859 exit 1
860 fi
861 TargetShim="bootmgfw.efi"
862 fi
863 }
864
865 # TargetDir defaults to /EFI/refind; however, this function adjusts it as follows:
866 # - If an existing refind.conf is available in /EFI/BOOT or /EFI/Microsoft/Boot,
867 # install to that directory under the suitable name; but DO NOT do this if
868 # refind.conf is also in /EFI/refind.
869 # - If booted in BIOS mode and the ESP lacks any other EFI files, install to
870 # /EFI/BOOT
871 # - If booted in BIOS mode and there's no refind.conf file and there is a
872 # /EFI/Microsoft/Boot/bootmgfw.efi file, move it down one level and
873 # install under that name, "hijacking" the Windows boot loader filename
874 DetermineTargetDir() {
875 Upgrade=0
876
877 if [[ -f $InstallDir/EFI/BOOT/refind.conf ]] ; then
878 SetVarsForBoot
879 Upgrade=1
880 fi
881 if [[ -f $InstallDir/EFI/Microsoft/Boot/refind.conf ]] ; then
882 SetVarsForMsBoot
883 Upgrade=1
884 fi
885 if [[ -f $InstallDir/EFI/refind/refind.conf ]] ; then
886 TargetDir="/EFI/refind"
887 Upgrade=1
888 fi
889 if [[ $Upgrade == 1 ]] ; then
890 echo "Found rEFInd installation in $InstallDir$TargetDir; upgrading it."
891 fi
892
893 if [[ ! -d /sys/firmware/efi && $Upgrade == 0 ]] ; then # BIOS-mode
894 FoundEfiFiles=`find "$InstallDir/EFI/BOOT" -name "*.efi" 2> /dev/null`
895 FoundConfFiles=`find "$InstallDir" -name "refind\.conf" 2> /dev/null`
896 if [[ ! -n "$FoundConfFiles" && -f "$InstallDir/EFI/Microsoft/Boot/bootmgfw.efi" ]] ; then
897 mv -n "$InstallDir/EFI/Microsoft/Boot/bootmgfw.efi" "$InstallDir/EFI/Microsoft" &> /dev/null
898 SetVarsForMsBoot
899 echo "Running in BIOS mode with a suspected Windows installation; moving boot loader"
900 echo "files so as to install to $InstallDir$TargetDir."
901 elif [[ ! -n "$FoundEfiFiles" ]] ; then # In BIOS mode and no default loader; install as default loader
902 SetVarsForBoot
903 echo "Running in BIOS mode with no existing default boot loader; installing to"
904 echo $InstallDir$TargetDir
905 else
906 echo "Running in BIOS mode with an existing default boot loader; backing it up and"
907 echo "installing rEFInd in its place."
908 if [[ -d "$InstallDir/EFI/BOOT-rEFIndBackup" ]] ; then
909 echo ""
910 echo "Caution: An existing backup of a default boot loader exists! If the current"
911 echo "default boot loader and the backup are different boot loaders, the current"
912 echo "one will become inaccessible."
913 echo ""
914 echo -n "Do you want to proceed with installation (Y/N)? "
915 ReadYesNo
916 if [[ $YesNo == "Y" || $YesNo == "y" ]] ; then
917 echo "OK; continuing with the installation..."
918 else
919 exit 0
920 fi
921 fi
922 mv -n "$InstallDir/EFI/BOOT" "$InstallDir/EFI/BOOT-rEFIndBackup"
923 SetVarsForBoot
924 fi
925 fi # BIOS-mode
926 } # DetermineTargetDir()
927
928 # Controls rEFInd installation under Linux.
929 # Sets Problems=1 if something goes wrong.
930 InstallOnLinux() {
931 if [[ "$TargetDir" == "/System/Library/CoreServices" ]] ; then
932 echo "You may not use the --ownhfs option under Linux! Aborting!"
933 exit 1
934 fi
935 echo "Installing rEFInd on Linux...."
936 modprobe efivars &> /dev/null
937 if [[ $TargetDir == "/EFI/BOOT" ]] ; then
938 MountDefaultTarget
939 else
940 FindMountedESP
941 DetermineTargetDir
942 fi
943 CpuType=`uname -m`
944 if [[ $CpuType == 'x86_64' ]] ; then
945 Platform="EFI64"
946 elif [[ ($CpuType == 'i386' || $CpuType == 'i486' || $CpuType == 'i586' || $CpuType == 'i686') ]] ; then
947 Platform="EFI32"
948 # If we're in EFI mode, do some sanity checks, and alert the user or even
949 # abort. Not in BIOS mode, though, since that could be used on an emergency
950 # disc to try to recover a troubled Linux installation.
951 if [[ -d /sys/firmware/efi ]] ; then
952 if [[ "$ShimSource" != "none" && "$TargetDir" != "/BOOT/EFI" ]] ; then
953 echo ""
954 echo "CAUTION: shim does not currently supports 32-bit systems, so you should not"
955 echo "use the --shim option to install on such systems. Aborting!"
956 echo ""
957 exit 1
958 fi
959 echo
960 echo "CAUTION: This Linux installation uses a 32-bit kernel. 32-bit EFI-based"
961 echo "computers are VERY RARE. If you've installed a 32-bit version of Linux"
962 echo "on a 64-bit computer, you should manually install the 64-bit version of"
963 echo "rEFInd. If you're installing on a Mac, you should do so from OS X. If"
964 echo "you're positive you want to continue with this installation, answer 'Y'"
965 echo "to the following question..."
966 echo
967 echo -n "Are you sure you want to continue (Y/N)? "
968 ReadYesNo
969 if [[ $YesNo == "Y" || $YesNo == "y" ]] ; then
970 echo "OK; continuing with the installation..."
971 else
972 exit 0
973 fi
974 fi # in EFI mode
975 else
976 echo "Unknown CPU type '$CpuType'; aborting!"
977 exit 1
978 fi
979
980 if [[ $LocalKeys == 1 ]] ; then
981 ReSignBinaries
982 fi
983
984 CheckSecureBoot
985 CopyRefindFiles
986 if [[ "$TargetDir" != "/EFI/BOOT" && "$TargetDir" != "/EFI/Microsoft/Boot" ]] ; then
987 AddBootEntry
988 GenerateRefindLinuxConf
989 fi
990 } # InstallOnLinux()
991
992 #
993 # The main part of the script. Sets a few environment variables,
994 # performs a few startup checks, and then calls functions to
995 # install under OS X or Linux, depending on the detected platform.
996 #
997
998 OSName=`uname -s`
999 GetParams "$@"
1000 ThisDir="$( cd -P "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
1001 RefindDir="$ThisDir/refind"
1002 ThisScript="$ThisDir/`basename $0`"
1003 if [[ `whoami` != "root" ]] ; then
1004 echo "Not running as root; attempting to elevate privileges via sudo...."
1005 sudo "$ThisScript" "$@"
1006 if [[ $? != 0 ]] ; then
1007 echo "This script must be run as root (or using sudo). Exiting!"
1008 exit 1
1009 else
1010 exit 0
1011 fi
1012 fi
1013 CheckForFiles
1014 if [[ $OSName == 'Darwin' ]] ; then
1015 if [[ "$ShimSource" != "none" ]] ; then
1016 echo "The --shim option is not supported on OS X! Exiting!"
1017 exit 1
1018 fi
1019 if [[ "$LocalKeys" != 0 ]] ; then
1020 echo "The --localkeys option is not supported on OS X! Exiting!"
1021 exit 1
1022 fi
1023 InstallOnOSX $1
1024 elif [[ $OSName == 'Linux' ]] ; then
1025 InstallOnLinux
1026 else
1027 echo "Running on unknown OS; aborting!"
1028 fi
1029
1030 if [[ $Problems ]] ; then
1031 echo
1032 echo "ALERT:"
1033 echo "Installation has completed, but problems were detected. Review the output for"
1034 echo "error messages and take corrective measures as necessary. You may need to"
1035 echo "re-run this script or install manually before rEFInd will work."
1036 echo
1037 else
1038 echo
1039 echo "Installation has completed successfully."
1040 echo
1041 fi
1042
1043 if [[ $UnmountEsp == '1' ]] ; then
1044 echo "Unmounting install dir"
1045 umount $InstallDir
1046 fi
1047
1048 if [[ "$InstallDir" == /tmp/refind_install ]] ; then
1049 # sleep 5
1050 rmdir "$InstallDir"
1051 fi