feat(extract): add 'ident' flag for selecting specific RestoreRamDisk and update DMG extraction options

Author: blacktop

cmd/ipsw/cmd/extract.go

@@ -46,7 +46,7 @@ func init() {
 	extractCmd.Flags().BoolP("kernel", "k", false, "Extract kernelcache")
 	extractCmd.Flags().BoolP("dyld", "d", false, "Extract dyld_shared_cache")
 	extractCmd.Flags().Bool("dtree", false, "Extract DeviceTree")
-	extractCmd.Flags().String("dmg", "", "Extract DMG file (app, sys, fs)")
+	extractCmd.Flags().String("dmg", "", fmt.Sprintf("Extract DMG file (%s)", strings.Join(mount.DmgTypes, ", ")))
 	extractCmd.Flags().Bool("iboot", false, "Extract iBoot")
 	extractCmd.Flags().Bool("sep", false, "Extract sep-firmware")
 	extractCmd.Flags().Bool("sptm", false, "Extract SPTM and TXM Firmwares")
@@ -67,12 +67,14 @@ func init() {
 	})
 	extractCmd.Flags().Bool("driverkit", false, "Extract DriverKit dyld_shared_cache")
 	extractCmd.Flags().String("device", "", "Device to extract kernel for (e.g. iPhone10,6)")
+	extractCmd.Flags().String("ident", "", "Identity Variant to select specific RestoreRamDisk (e.g. 'Erase', 'Upgrade', 'Recovery')")
 	extractCmd.RegisterFlagCompletionFunc("dmg", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 		return []string{
 			"app\tAppOS",
 			"sys\tSystemOS",
 			"fs\tFileSystem",
 			"exc\tExclave",
+			"rdisk\tRestoreRamDisk",
 		}, cobra.ShellCompDirectiveDefault
 	})
 
@@ -100,6 +102,7 @@ func init() {
 	viper.BindPFlag("extract.dyld-arch", extractCmd.Flags().Lookup("dyld-arch"))
 	viper.BindPFlag("extract.driverkit", extractCmd.Flags().Lookup("driverkit"))
 	viper.BindPFlag("extract.device", extractCmd.Flags().Lookup("device"))
+	viper.BindPFlag("extract.ident", extractCmd.Flags().Lookup("ident"))
 }
 
 // extractCmd represents the extract command
@@ -190,6 +193,7 @@ var extractCmd = &cobra.Command{
 			Output:       viper.GetString("extract.output"),
 			JSON:         viper.GetBool("extract.json"),
 			Lookup:       viper.GetBool("extract.lookup"),
+			Ident:        viper.GetString("extract.ident"),
 		}
 
 		if viper.GetBool("extract.remote") {

internal/commands/extract/extract.go

@@ -78,6 +78,8 @@ type Config struct {
 	Info bool `json:"info,omitempty"`
 	// Lookup decryption keys from theapplewiki.com
 	Lookup bool `json:"lookup,omitempty"`
+	// BuildManifest identity selector (used for rdisk)
+	Ident string `json:"ident,omitempty"`
 
 	info     *info.Info
 	wikiKeys download.WikiFWKeys
@@ -647,6 +649,11 @@ func DMG(c *Config) ([]string, error) {
 		if err != nil {
 			return nil, fmt.Errorf("failed to find exclaveOS DMG in IPSW: %v", err)
 		}
+	case "rdisk":
+		dmgPath, err = i.GetRestoreRamDiskDmg(c.Ident)
+		if err != nil {
+			return nil, fmt.Errorf("failed to find RestoreRamDisk DMG in IPSW: %v", err)
+		}
 	}
 
 	return utils.SearchZip(zr.File, regexp.MustCompile(dmgPath), filepath.Join(filepath.Clean(c.Output), folder), c.Flatten, c.Progress)

internal/commands/mount/mount.go

@@ -20,7 +20,7 @@ import (
 	"github.com/blacktop/ipsw/pkg/info"
 )
 
-var DmgTypes = []string{"fs", "sys", "app", "exc", "rdisk"}
+var DmgTypes = []string{"app", "sys", "fs", "exc", "rdisk"}
 
 // Config contains optional options for mounting a DMG from an IPSW
 type Config struct {
@@ -119,27 +119,9 @@ func DmgInIPSW(path, typ string, cfg *Config) (*Context, error) {
 			return nil, fmt.Errorf("failed to get ExclaveOS DMG: %v", err)
 		}
 	case "rdisk":
-		if len(cfg.Ident) > 0 {
-			dmgPath, err = i.GetRestoreRamDiskDmgByIdent(cfg.Ident)
-			if err != nil {
-				return nil, fmt.Errorf("failed to get RestoreRamDisk DMG: %v", err)
-			}
-		} else {
-			// Prefer Erase -> Update -> first
-			if p, err := i.GetRestoreRamDiskDmgByIdent("Erase"); err == nil {
-				dmgPath = p
-			} else if p, err := i.GetRestoreRamDiskDmgByIdent("Update"); err == nil {
-				dmgPath = p
-			} else {
-				if dmgs, err := i.GetRestoreRamDiskDmgs(); err == nil {
-					if len(dmgs) == 0 {
-						return nil, fmt.Errorf("no RestoreRamDisk DMG found")
-					}
-					dmgPath = dmgs[0]
-				} else {
-					return nil, fmt.Errorf("failed to get RestoreRamDisk DMGs: %v", err)
-				}
-			}
+		dmgPath, err = i.GetRestoreRamDiskDmg(cfg.Ident)
+		if err != nil {
+			return nil, fmt.Errorf("failed to get RestoreRamDisk DMG: %v", err)
 		}
 	default:
 		return nil, fmt.Errorf("invalid subcommand: %s; must be one of: '%s'", typ, strings.Join(DmgTypes, "', '"))

pkg/info/info.go

@@ -481,6 +481,30 @@ func (i *Info) GetRestoreRamDiskDmgByIdent(ident string) (string, error) {
 	}
 }
 
+// GetRestoreRamDiskDmg returns the best RestoreRamDisk DMG path.
+// If ident is non-empty, it finds a matching identity. Otherwise, it prefers
+// Erase, then Update, then falls back to the first available DMG.
+func (i *Info) GetRestoreRamDiskDmg(ident string) (string, error) {
+	if len(ident) > 0 {
+		return i.GetRestoreRamDiskDmgByIdent(ident)
+	}
+	// Prefer Erase -> Update -> first
+	if p, err := i.GetRestoreRamDiskDmgByIdent("Erase"); err == nil {
+		return p, nil
+	}
+	if p, err := i.GetRestoreRamDiskDmgByIdent("Update"); err == nil {
+		return p, nil
+	}
+	dmgs, err := i.GetRestoreRamDiskDmgs()
+	if err != nil {
+		return "", fmt.Errorf("failed to get RestoreRamDisk DMGs: %w", err)
+	}
+	if len(dmgs) == 0 {
+		return "", fmt.Errorf("no RestoreRamDisk DMG found")
+	}
+	return dmgs[0], nil
+}
+
 func (i *Info) GetExclaveOSDmg() (string, error) {
 	var dmgs []string
 	if i.Plists != nil && i.Plists.BuildManifest != nil {

www/docs/cli/ipsw/extract.md

@@ -47,7 +47,7 @@ $ ipsw extract --dyld --driverkit macOS.ipsw
 
 ```
       --device string           Device to extract kernel for (e.g. iPhone10,6)
-      --dmg string              Extract DMG file (app, sys, fs)
+      --dmg string              Extract DMG file (app, sys, fs, exc, rdisk)
       --driverkit               Extract DriverKit dyld_shared_cache
       --dtree                   Extract DeviceTree
   -d, --dyld                    Extract dyld_shared_cache
@@ -58,10 +58,12 @@ $ ipsw extract --dyld --driverkit macOS.ipsw
       --flat                    Do NOT preserve directory structure when extracting
   -h, --help                    help for extract
       --iboot                   Extract iBoot
+      --ident string            Identity Variant to select specific RestoreRamDisk (e.g. 'Erase', 'Upgrade', 'Recovery')
       --insecure                do not verify ssl certs
   -j, --json                    Output extracted paths as JSON
       --kbag                    Extract Im4p Keybags
   -k, --kernel                  Extract kernelcache
+  -l, --lookup                  Lookup decryption keys on theapplewiki.com
   -o, --output string           Folder to extract files to
   -p, --pattern string          Extract files that match regex
       --pem-db string           AEA pem DB JSON file