ranger-compiler 3.2.0 → 3.4.0

package/dist/lib/apple/AppleSigning.rgr

@@ -0,0 +1,379 @@
+; SPDX-License-Identifier: MIT
+
+; =============================================================================
+; AppleSigning.rgr -- finding the identity and the profile so nobody types them.
+; =============================================================================
+;
+; A simulator build is signed ad hoc and needs nothing. A DEVICE build needs
+; three things that come as a set, and typing them out is what makes "build it
+; onto my phone" a three-flag command instead of one:
+;
+;   the identity   a certificate in the keychain, named like
+;                  "Apple Development: Someone (ABC123DEF4)". `security
+;                  find-identity` lists them.
+;   the profile    a .mobileprovision that names the app, the team and the
+;                  devices it may run on. Xcode writes them into a directory
+;                  and never mentions it again.
+;   the match      the profile has to be FOR this bundle id and has to list
+;                  THIS device, or the app installs and refuses to launch with
+;                  no message anyone can act on.
+;
+; All three are discoverable, so this file discovers them. `--identity` and
+; `--profile` still win when given; this is what happens when they are not.
+;
+; What it cannot do: CREATE a profile. That is a conversation with Apple's
+; developer portal, and the only command line tool that has it is `xcodebuild
+; -allowProvisioningUpdates`, which is the thing this whole directory exists to
+; avoid. Open the project in Xcode once, or register the device on the portal;
+; after that the profile is on the machine and this finds it.
+; =============================================================================
+
+Import "../Shell.rgr"
+
+class AppleSigningIdentity {
+
+    ; The 40-hex fingerprint. `codesign --sign` takes either this or the name;
+    ; the fingerprint is unambiguous when two certificates share a name, which
+    ; happens every time one is renewed.
+    def sha1:string ""
+    def name:string ""
+
+    Constructor () {
+    }
+
+    ; "Apple Development: Someone (ABC123DEF4)" -> "ABC123DEF4". The team id is
+    ; the last parenthesised group, and it is what a profile's
+    ; application-identifier is prefixed with.
+    fn teamId:string () {
+        def openAt:int (indexOf name "(")
+        if (openAt < 0) {
+            return ""
+        }
+        def closeAt:int (indexOf name ")")
+        if (closeAt <= (openAt + 1)) {
+            return ""
+        }
+        return (substring name (openAt + 1) closeAt)
+    }
+
+    ; A development certificate signs a build for a device you own. A
+    ; distribution one is for the store and cannot be tested on a cable.
+    fn isDevelopment:boolean () {
+        if ((indexOf name "Apple Development") == 0) {
+            return true
+        }
+        if ((indexOf name "iPhone Developer") == 0) {
+            return true
+        }
+        return false
+    }
+
+    fn describe:string () {
+        return (name + "  " + sha1)
+    }
+}
+
+class AppleProvisioningProfile {
+
+    def path:string ""
+    ; The profile's own name, which is what Xcode shows.
+    def name:string ""
+    ; "ABC123DEF4.fi.ranger.dashboard", or "ABC123DEF4.*" for a wildcard.
+    def appId:string ""
+    ; The device identifiers this profile may install onto, as the raw JSON
+    ; array text. Searched as text rather than parsed: the question is only
+    ; "is this udid in there", and a JSON reader for one membership test is a
+    ; dependency for nothing.
+    def devicesRaw:string ""
+    def expires:string ""
+
+    Constructor () {
+    }
+
+    fn teamId:string () {
+        def dot:int (indexOf appId ".")
+        if (dot <= 0) {
+            return ""
+        }
+        return (substring appId 0 dot)
+    }
+
+    ; The bundle id this profile is for, with the team prefix taken off.
+    fn bundlePattern:string () {
+        def dot:int (indexOf appId ".")
+        if (dot < 0) {
+            return ""
+        }
+        return (substring appId (dot + 1) (strlen appId))
+    }
+
+    ; A development profile carries the devices it may run on. One with no such
+    ; list is an App Store or enterprise profile, which cannot be tested on a
+    ; cable.
+    fn isDevelopment:boolean () {
+        return ((strlen devicesRaw) > 0)
+    }
+
+    fn hasDevice:boolean (udid:string) {
+        if ((strlen udid) == 0) {
+            return false
+        }
+        return ((indexOf devicesRaw udid) >= 0)
+    }
+
+    fn describe:string () {
+        return (name + "  [" + appId + "]  " + path)
+    }
+}
+
+class AppleSigning {
+
+    def sh:Shell
+
+    Constructor (shell:Shell) {
+        sh = shell
+    }
+
+    ; --- identities -----------------------------------------------------------
+
+    ; `security find-identity -v -p codesigning` writes one indented line per
+    ; certificate:
+    ;
+    ;     1) A1B2...78 "Apple Development: Someone (ABC123DEF4)"
+    ;        1 valid identities found
+    ;
+    ; The quoted name is the field that matters and the only one with spaces in
+    ; it, so it is read between the first and last quote rather than by
+    ; splitting the line up.
+    sfn parseIdentities:[AppleSigningIdentity] (text:string) {
+        def found:[AppleSigningIdentity]
+        def lines:[string] (strsplit text "\n")
+        for lines rawLine:string i {
+            def line:string (trim rawLine)
+            def firstQuote:int (indexOf line "\"")
+            if (firstQuote > 0) {
+                def rest:string (substring line (firstQuote + 1) (strlen line))
+                def lastQuote:int (indexOf rest "\"")
+                if (lastQuote > 0) {
+                    def name:string (substring rest 0 lastQuote)
+                    ; The fingerprint is the word before the quote, after the
+                    ; "N)" the listing numbers each line with.
+                    def head:string (trim (substring line 0 firstQuote))
+                    def parts:[string] (strsplit head " ")
+                    def sha:string ""
+                    for parts p:string pi {
+                        if ((strlen p) == 40) {
+                            sha = p
+                        }
+                    }
+                    if ((strlen sha) == 40) {
+                        def id:AppleSigningIdentity (new AppleSigningIdentity)
+                        id.sha1 = sha
+                        id.name = name
+                        push found id
+                    }
+                }
+            }
+        }
+        return found
+    }
+
+    ; A DEVELOPMENT identity wins, because this is for testing on a cable. A
+    ; caller who wants a distribution certificate names it.
+    sfn pickIdentity@(optional):AppleSigningIdentity (identities:[AppleSigningIdentity] wanted:string) {
+        def want:string (trim wanted)
+        def found@(optional):AppleSigningIdentity
+        if ((strlen want) > 0) {
+            for identities id:AppleSigningIdentity i {
+                if (null? found) {
+                    if ((indexOf id.name want) >= 0) {
+                        found = id
+                    }
+                    if (id.sha1 == want) {
+                        found = id
+                    }
+                }
+            }
+            return found
+        }
+        for identities id:AppleSigningIdentity i {
+            if (null? found) {
+                if (id.isDevelopment()) {
+                    found = id
+                }
+            }
+        }
+        if (null? found) {
+            for identities id2:AppleSigningIdentity i2 {
+                if (null? found) {
+                    found = id2
+                }
+            }
+        }
+        return found
+    }
+
+    fn findIdentities:[AppleSigningIdentity] () {
+        def argv:[string]
+        push argv "find-identity"
+        push argv "-v"
+        push argv "-p"
+        push argv "codesigning"
+        def res:ShellResult (sh.capture("security" argv))
+        if (res.failed()) {
+            def none:[AppleSigningIdentity]
+            return none
+        }
+        return (AppleSigning.parseIdentities(res.out))
+    }
+
+    ; --- profiles -------------------------------------------------------------
+
+    ; Where Xcode keeps them. It moved in Xcode 16, and an installation that has
+    ; been upgraded has profiles in both, so both are looked in.
+    fn profileDirs:[string] () {
+        def dirs:[string]
+        def home@(optional):string (env_var "HOME")
+        if (null? home) {
+            return dirs
+        }
+        def h:string (unwrap home)
+        push dirs (h + "/Library/Developer/Xcode/UserData/Provisioning Profiles")
+        push dirs (h + "/Library/MobileDevice/Provisioning Profiles")
+        return dirs
+    }
+
+    ; `ls` rather than a directory operator, because this library is already in
+    ; the business of running programs and `ls` is on every machine Xcode is.
+    fn profilePaths:[string] () {
+        def paths:[string]
+        def dirs:[string] (this.profileDirs())
+        for dirs dir:string di {
+            def argv:[string]
+            push argv dir
+            def res:ShellResult (sh.capture("ls" argv))
+            if (res.ok()) {
+                def names:[string] (res.outLines())
+                for names n:string ni {
+                    def name:string (trim n)
+                    if ((strlen name) > 16) {
+                        if ((indexOf name ".mobileprovision") > 0) {
+                            push paths (dir + "/" + name)
+                        }
+                    }
+                }
+            }
+        }
+        return paths
+    }
+
+    ; A .mobileprovision is a CMS envelope around a plist. `security cms -D`
+    ; opens it and `plutil -extract` reads one key back out, which is two tools
+    ; and no plist parser.
+    fn extractKey:string (plistPath:string key:string format:string) {
+        def argv:[string]
+        push argv "-extract"
+        push argv key
+        push argv format
+        push argv "-o"
+        push argv "-"
+        push argv plistPath
+        def res:ShellResult (sh.capture("plutil" argv))
+        if (res.failed()) {
+            return ""
+        }
+        return (trim res.out)
+    }
+
+    ; `workDir` is where the decoded plist is put; it is overwritten per
+    ; profile, because nothing needs two of them at once.
+    fn readProfile@(optional):AppleProvisioningProfile (path:string workDir:string) {
+        def none@(optional):AppleProvisioningProfile
+        def argv:[string]
+        push argv "cms"
+        push argv "-D"
+        push argv "-i"
+        push argv path
+        def decoded:ShellResult (sh.capture("security" argv))
+        if (decoded.failed()) {
+            return none
+        }
+        def plistPath:string (workDir + "/profile.plist")
+        if (sh.dryRun == false) {
+            create_dir workDir
+            write_file workDir "profile.plist" decoded.out
+        }
+        def p:AppleProvisioningProfile (new AppleProvisioningProfile)
+        p.path = path
+        p.name = (this.extractKey(plistPath "Name" "raw"))
+        p.appId = (this.extractKey(plistPath "Entitlements.application-identifier" "raw"))
+        p.devicesRaw = (this.extractKey(plistPath "ProvisionedDevices" "json"))
+        p.expires = (this.extractKey(plistPath "ExpirationDate" "raw"))
+        if ((strlen p.appId) == 0) {
+            return none
+        }
+        def hit@(optional):AppleProvisioningProfile p
+        return hit
+    }
+
+    ; Does this profile's application-identifier cover this bundle id? A
+    ; wildcard profile ends in ".*" and covers everything under its prefix,
+    ; which is what an Xcode "Team Provisioning Profile" is.
+    sfn appIdMatches:boolean (appId:string bundleId:string) {
+        def dot:int (indexOf appId ".")
+        if (dot < 0) {
+            return false
+        }
+        def pattern:string (substring appId (dot + 1) (strlen appId))
+        if (pattern == bundleId) {
+            return true
+        }
+        def starAt:int (indexOf pattern "*")
+        if (starAt < 0) {
+            return false
+        }
+        if (starAt == 0) {
+            return true
+        }
+        def prefix:string (substring pattern 0 starAt)
+        return ((indexOf bundleId prefix) == 0)
+    }
+
+    ; The profile to sign with: for this bundle id, listing this device, and an
+    ; exact bundle id beats a wildcard because that is the one Xcode made for
+    ; this app.
+    fn pickProfile@(optional):AppleProvisioningProfile (bundleId:string deviceUdid:string workDir:string) {
+        def exact@(optional):AppleProvisioningProfile
+        def wildcard@(optional):AppleProvisioningProfile
+        def paths:[string] (this.profilePaths())
+        for paths path:string pi {
+            def readOpt@(optional):AppleProvisioningProfile (this.readProfile(path workDir))
+            if (!null? readOpt) {
+                def p:AppleProvisioningProfile (unwrap readOpt)
+                if (AppleSigning.appIdMatches(p.appId bundleId)) {
+                    if (p.isDevelopment()) {
+                        def usable:boolean true
+                        if ((strlen deviceUdid) > 0) {
+                            usable = (p.hasDevice(deviceUdid))
+                        }
+                        if usable {
+                            if ((p.bundlePattern()) == bundleId) {
+                                if (null? exact) {
+                                    exact = p
+                                }
+                            } {
+                                if (null? wildcard) {
+                                    wildcard = p
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        }
+        if (!null? exact) {
+            return exact
+        }
+        return wildcard
+    }
+}

package/dist/lib/apple/AppleSimulator.rgr

@@ -0,0 +1,248 @@
+; SPDX-License-Identifier: MIT
+
+; =============================================================================
+; AppleSimulator.rgr -- reading `xcrun simctl list devices`.
+; =============================================================================
+;
+; simctl can answer in JSON, and this reads the PLAIN TEXT instead, on purpose:
+; the text form is stable, it is what a person sees when they run the command
+; themselves, and parsing it needs no JSON library on any target this compiles
+; to. The parser is a pure function over a string, which means the one part of
+; the simulator story that has edge cases is the one part that can be tested on
+; a machine with no simulator on it.
+;
+; The format:
+;
+;     == Devices ==
+;     -- iOS 17.5 --
+;         iPhone SE (3rd generation) (A1B2...-...) (Shutdown)
+;         iPad Pro 13-inch (M4) (C3D4...-...) (Booted)
+;     -- watchOS 10.5 --
+;         Apple Watch Series 9 (45mm) (E5F6...-...) (Shutdown)
+;
+; The trap is that a device NAME contains parentheses at least as often as not,
+; so the fields cannot be found by counting them from the left. They are found
+; from the RIGHT: the last group is the state, the one before it is the UDID,
+; and whatever is left is the name however many brackets it holds.
+; =============================================================================
+
+class AppleSimulator {
+
+    def name:string ""
+    def udid:string ""
+    ; "Booted", "Shutdown", "Creating"...
+    def state:string ""
+    ; The runtime heading this device was listed under: "iOS 17.5".
+    def runtime:string ""
+
+    Constructor () {
+    }
+
+    fn isBooted:boolean () {
+        return (state == "Booted")
+    }
+
+    fn describe:string () {
+        return (name + " [" + runtime + "] " + udid + " (" + state + ")")
+    }
+}
+
+class AppleSimulatorList {
+
+    ; Peel one trailing "(...)" group off a line. Answers ([head, inner]), or
+    ; ([line, ""]) when there is no group to peel.
+    ; Characters are compared as one-character SUBSTRINGS rather than as code
+    ; points: `charAt` answers a `char`, and what a `char` is differs enough
+    ; between targets that the arithmetic form does not compile everywhere.
+    sfn pair:[string] (a:string b:string) {
+        def v:[string]
+        push v a
+        push v b
+        return v
+    }
+
+    sfn peelTail:[string] (line:string) {
+        def s:string (trim line)
+        def n:int (strlen s)
+        if (n < 2) {
+            return (AppleSimulatorList.pair(s ""))
+        }
+        if ((substring s (n - 1) n) != ")") {
+            return (AppleSimulatorList.pair(s ""))
+        }
+        ; Walk back to the matching "(", counting depth so a nested group in a
+        ; name does not end the search early.
+        def depth:int 0
+        def i:int (n - 1)
+        def openAt:int (0 - 1)
+        while (i >= 0) {
+            def c:string (substring s i (i + 1))
+            if (c == ")") {
+                depth = depth + 1
+            }
+            if (c == "(") {
+                depth = depth - 1
+                if (depth == 0) {
+                    openAt = i
+                    i = 0 - 1
+                }
+            }
+            if (i >= 0) {
+                i = i - 1
+            }
+        }
+        if (openAt < 0) {
+            return (AppleSimulatorList.pair(s ""))
+        }
+        def head:string (trim (substring s 0 openAt))
+        def inner:string (substring s (openAt + 1) (n - 1))
+        return (AppleSimulatorList.pair(head inner))
+    }
+
+    ; A runtime heading looks like "-- iOS 17.5 --". Anything else on a line
+    ; that starts with "--" is a section this parser has no use for.
+    sfn runtimeOf:string (line:string) {
+        def s:string (trim line)
+        def n:int (strlen s)
+        if (n < 5) {
+            return ""
+        }
+        if ((substring s 0 2) != "--") {
+            return ""
+        }
+        if ((substring s (n - 2) n) != "--") {
+            return ""
+        }
+        return (trim (substring s 2 (n - 2)))
+    }
+
+    ; Does this look like a UDID rather than part of a device name? simctl
+    ; writes a UUID, and the length plus the dash positions are enough to tell
+    ; it from "3rd generation" without a regex engine on every target.
+    sfn looksLikeUdid:boolean (s:string) {
+        if ((strlen s) != 36) {
+            return false
+        }
+        if ((substring s 8 9) != "-") {
+            return false
+        }
+        if ((substring s 13 14) != "-") {
+            return false
+        }
+        if ((substring s 18 19) != "-") {
+            return false
+        }
+        if ((substring s 23 24) != "-") {
+            return false
+        }
+        return true
+    }
+
+    sfn parse:[AppleSimulator] (text:string) {
+        def found:[AppleSimulator]
+        def runtime:string ""
+        def lines:[string] (strsplit text "\n")
+        for lines rawLine:string i {
+            def line:string (trim rawLine)
+            if ((strlen line) > 0) {
+                def heading:string (AppleSimulatorList.runtimeOf(line))
+                if ((strlen heading) > 0) {
+                    runtime = heading
+                    ; A runtime simctl cannot use is listed under an
+                    ; "Unavailable: ..." heading. Its devices cannot be booted,
+                    ; so they are not offered.
+                    if ((indexOf heading "Unavailable") == 0) {
+                        runtime = ""
+                    }
+                } {
+                    if ((strlen runtime) > 0) {
+                        def statePeel:[string] (AppleSimulatorList.peelTail(line))
+                        def state:string (itemAt statePeel 1)
+                        if ((strlen state) > 0) {
+                            def udidPeel:[string] (AppleSimulatorList.peelTail((itemAt statePeel 0)))
+                            def udid:string (itemAt udidPeel 1)
+                            if (AppleSimulatorList.looksLikeUdid(udid)) {
+                                def dev:AppleSimulator (new AppleSimulator)
+                                dev.name = (trim (itemAt udidPeel 0))
+                                dev.udid = udid
+                                dev.state = (trim state)
+                                dev.runtime = runtime
+                                push found dev
+                            }
+                        }
+                    }
+                }
+            }
+        }
+        return found
+    }
+
+    ; Everything on a given platform. `prefix` is "iOS" or "watchOS", matched
+    ; against the runtime heading, so "iOS 17.5" and "iOS 18.0" both answer to
+    ; "iOS" and neither answers to "watchOS".
+    sfn onPlatform:[AppleSimulator] (devices:[AppleSimulator] prefix:string) {
+        def out:[AppleSimulator]
+        for devices d:AppleSimulator i {
+            if ((indexOf d.runtime prefix) == 0) {
+                push out d
+            }
+        }
+        return out
+    }
+
+    ; The device to use, given what the caller asked for.
+    ;
+    ; A device that is ALREADY BOOTED wins over one that is not, whatever the
+    ; name preference says: booting a second simulator when one is open is slow,
+    ; and it puts the app on a window the person is not looking at.
+    sfn pick@(optional):AppleSimulator (devices:[AppleSimulator] nameWanted:string) {
+        def wanted:string (trim nameWanted)
+        def bootedMatch@(optional):AppleSimulator
+        def anyMatch@(optional):AppleSimulator
+        def bootedAny@(optional):AppleSimulator
+        def firstAny@(optional):AppleSimulator
+        for devices d:AppleSimulator i {
+            def isMatch:boolean false
+            if ((strlen wanted) > 0) {
+                if ((indexOf d.name wanted) >= 0) {
+                    isMatch = true
+                }
+                if (d.udid == wanted) {
+                    isMatch = true
+                }
+            }
+            if (d.isBooted()) {
+                if (null? bootedAny) {
+                    bootedAny = d
+                }
+                if isMatch {
+                    if (null? bootedMatch) {
+                        bootedMatch = d
+                    }
+                }
+            }
+            if (null? firstAny) {
+                firstAny = d
+            }
+            if isMatch {
+                if (null? anyMatch) {
+                    anyMatch = d
+                }
+            }
+        }
+        if ((strlen wanted) > 0) {
+            if (!null? bootedMatch) {
+                return bootedMatch
+            }
+            if (!null? anyMatch) {
+                return anyMatch
+            }
+            def noSuchName@(optional):AppleSimulator
+            return noSuchName
+        }
+        if (!null? bootedAny) {
+            return bootedAny
+        }
+        return firstAny
+    }
+}