310 Commits
Author SHA1 Message Date
Zorg 3df8c96fcb Add <sparkle:bundleIdentifier> on appcast for signed feeds (#2954) 2026-11-15 15:17:39 -08:00
Zorg b390cd147f Avoid using host bundle filename for finding bundle to update (#2953)
The user can rename the host bundle filename so it's not reliable and gives a false sense of reliability. We keep matching against the name of the bundle derived from the Info.plist and the bundle identifier.
2026-11-14 16:32:12 -08:00
Zorg 76583dcf69 Trim whitespace/newline characters from <sparkle:releaseNotesLink> (#2944)
This fixes a regression introduced in Sparkle 2.9 when signed feeds were added. In our documentation we have suggested surrounding the release notes URL with newline/whitespace for pretty-print formatting reasons. However now that this bug surfaced, the documentation will be updated to remove the extraneous whitespace. Many developers generating appcasts programmatically or with generate_appcast will not run into this issue.
2026-10-24 12:34:21 -07:00
Zorg b41aa91142 Unarchive disk images using diskutil (#2930)
This change adopts using diskutil for dmg extraction on macOS 27.2+ where hdiutil has been deprecated.
2026-10-10 18:29:43 -07:00
Leo Camus 07db2480ad Fix appcast child elements being ignored when the Sparkle namespace uses a custom prefix (#2923)
The children of <sparkle:informationalUpdate> and <sparkle:tags> were matched
against their qualified name instead of being resolved through the Sparkle
namespace URI, unlike every other element in the parser.
2026-09-15 20:26:26 -07:00
Leo Camus 7565a07922 Fix reading release notes content length from appcast (#2921) 2026-09-13 08:13:54 -07:00
Zorg 4d95137122 Fix minor temporary file leaks on binary delta failure (#2906)
Also move temporaryDirectory() to unit tests only.
2026-08-28 21:16:29 -07:00
Zorg 164f2fd30f Move updating mdimporter modification date into applyBinaryDelta() (#2905)
This code was in SUBinaryDeltaUnarchiver.m but it is now moving into the BinaryDelta tool / applyBinaryDelta().
2026-08-27 22:10:18 -07:00
Zorg cb2c83e200 Fix binary delta testFileSystemCompression failing on macOS 27 (#2904) 2026-08-27 21:21:04 -07:00
Zorg 180b46555d Revert "Unarchive disk images using diskutil on macOS 27+" (#2903)
* Add more test cases for extracting licensed disk images

* Revert "Unarchive disk images using diskutil on macOS 27+ (#2902)"

This reverts commit 91ac4bbe81.
2026-08-23 20:39:14 -07:00
Zorg 91ac4bbe81 Unarchive disk images using diskutil on macOS 27+ (#2902)
This change adopts using diskutil for dmg extraction on macOS 27+ where hdiutil has been deprecated. hdiutil will still be used on older operating systems because diskutil's extraction support is worse prior to macOS 27 (e.g. can't handle license agreements in headless way, stricter --mountPoint policy requiring mount directory to exist).
2026-08-23 16:17:21 -07:00
Zorg 3ca274e711 Cleanup old availability checks and unused code (#2901) 2026-08-20 21:33:19 -07:00
Zorg 57dc6e0138 Reject package based installs when signing validation failed (#2895)
Package updates require EdDSA signing, therefore there is no code signing mechanism to fallback on.
2026-08-12 21:12:18 -07:00
Zorg a3f136022a Fix Xcode 26.4 beta compiler warnings (#2850) 2026-02-20 20:58:32 -08:00
Zorg 736b331dd6 Improve extracting signed markdown content (#2828)
This strips the beginning sparkle sign warning comment (if present) in the release notes downloader driver rather than the user driver. The comment is also stripped (if present) in generate_appcast when inserting embedded release notes.

Also improve markdown compatibility with sparkle-cli and alternative user driver in Sparkle Test App.
2026-01-03 19:43:12 -08:00
Zorg 7761e65c78 Add support for signing and verifying appcast feeds (#2822)
This provides enhanced opt-in security preventing informational attacks that for example suggest the user the auto-updater is broken and an update needs to be installed from a compromised website (assuming the developer's website is hijacked).

To opt in, developers need to add SURequireSignedFeed Info.plist key to their bundle.

generate_appcast and sign_update have been updated to support signing appcast feeds and release note files (both need to be signed). By default, they embed a HTML comment warning in the files that further modifications will invalidate previously signed signatures. Signed appcasts include a signing block comment at the end of the XML file describing the signature of the content preceding it. Signed release notes will have their signatures annotated in the <sparkle:releaseNotesLink> element with a sparkle:edSignature attribute (and optionally a sparkle:length attribute for diagnostic purposes).

A signingValidationStatus property is also now added to SUAppcast and SUAppcastItem indicating the signing status (skipped, succeeded, failed).

The standard user driver's release notes HTML web view rejects external file references when appcasts are signed. A bug has also been fixed where the update alert would not provide errors when loading external release note files fails. These changes also introduce a showing new error / localizable strings when the release notes is not signed correctly or fails to load.

As a hardening policy, we also enforce SUVerifyUpdateBeforeExtraction when opting into signed feeds, so key rotation is only possible with Developer ID code signed dmg archives.

A fallback feed signing failure expiration policy has also been added. When a signed feed has failed validation for more than a configurable period of time (by default SUSignedFeedFailureExpirationInterval is set to 20 days), Sparkle will allow appcast items to be shown to the user. However, these items operate in a safe mode that strip abusable information like release notes / descriptions / links, sanitize the version strings, and they cannot be marked critical or informational, nor be installed automatically. After this policy expires, this allows users installing updates as long as the updates are signed correctly, or be aware that the updater has not been functioning correctly.

Fixes #971.
2026-01-01 11:33:28 -08:00
Zorg 5d9649e29b Add sparkle:minimumUpdateVersion element (#2811)
This allows specifying a minimum version the host bundle needs to be on before upgrading. This may be useful for new appcast features where this requirement can be used instead of switching to a new appcast.
2025-12-19 16:08:13 -05:00
Zorg fc7350329e Add hardware requirements element (#2797)
The first requirement we support is arm64 which allows updates to mark themselves as Apple silicon only.

The message that shows up when users check for updates tells them their Mac is too old and a newer Apple silicon Mac is required for new updates. This introduces a new localizable string.

This requirement is also inferred if the minimum system version is >= 27.0

generate_appcast is also updated to handle a new branch for hardwareRequirements element, and for automatically populating it if needed.

Fixes #2796
2025-11-15 17:03:59 -08:00
Zorg 3c83ebb5cf Fix testParseAppcast failing on macOS 26 (#2772)
In the appcast there is an item with minimum OS requirement set to 17.0, which was never meant to be satisfied.
2025-09-16 20:37:23 -07:00
Zorg 4dac8e3ce8 Harden policy on what operations clients are allowed to take (#2763)
* For the Installer and Downloader XPC Services, if these executables are code signed with an Apple issued Team ID, then the connecting client must also be code signed with a matching Team ID.
* For the Downloader XPC Service, the request URL must be http/https
* For Autoupdate, if stage 1 of installation hasn't been completed yet and this executable is code signed with an Apple issued Team ID, then the connecting client must also be code signed with a matching Team ID. As before, multiple simultaneous connections are still disallowed.
* For Autoupdate, if it's not signed with Apple issued certificate, when installing package updates the bundle being updated must be itself and owned by root on disk (as one expects from a PKG installation)
* The authorization prompt message in the Installer Service is more computed inside the service so the client can't pass a completely arbitrary message
* Add extra nullable checking of parameters coming from XPC endpoints
* Add more thread-safe synchronization for Autoupdate installer
* Add logs for more failure points
2025-09-07 18:02:45 -07:00
Zorg 8702e2dd11 Add tests for file types changing when framework version changes (#2753) 2025-08-17 13:06:11 -07:00
jj 21e34394d0 Add support for relative urls for delta updates (#2741) 2025-07-12 11:13:46 -07:00
Nicolas Kick 1dec7ddce9 Set STRINGS_FILE_OUTPUT_ENCODING build setting to "binary" (#2712) 2025-04-01 20:24:38 -07:00
Zorg 62a1908333 Remove SPARKLE_BUILD_DMG_SUPPORT option (#2690) 2025-01-20 20:53:35 -08:00
Zorg 1ca60d5ab6 Add option to verify updates before extraction (#2667)
Adds an opt-in option (SUVerifyUpdateBeforeExtraction) to enforce verifying updates before extracting them for stronger security. EdDSA signing is required to use this option. As fallback in case EdDSA keys are lost, disk image archives's code signatures are validated assuming it's Developer ID signed. Key rotation is still possible.

Apple Archives (aar, yaa) now require using this option.
2024-12-08 16:31:26 -08:00
Zorg d04faabe7d Don't allow removal of signing keys more strictly (#2647)
* Don't allow removal of (Ed)DSA keys for pre-validated updates (delta updates, .aar updates)
* Don't allow removal of code signing identity in new update (at minimum, an adhoc signature can be used)
2024-10-20 18:14:05 -07:00
Zorg 14ba9efc51 Use crc32 hashes for binary delta version 4 (#2638)
This is more efficient than SHA1.
2024-10-13 16:58:54 -07:00
Zorg 6848a88abc Preserve bundle creation date when creating and applying delta updates (#2583)
This will preserve the file creation date of the new app bundle, but not the file creation date of any of the files inside the new app bundle because tracking those changes is complex/undesirable.

This bumps the major binary delta version to 4. A new test has been added for testing that the new bundle creation date is also preserved.
2024-09-29 18:25:38 -07:00
Zorg 661540d088 Improve robustness around dmg passwords (#2627)
* Handle failing to extract password protected disk images even when a decryption password isn't provided.
* Propagate error with more information when hdiutil attach fails.
* Wait for detaching disk images for unit tests (fixes not being able to run tests repeatably).
2024-09-15 06:58:00 -07:00
Zorg 8f86cad4a2 Retry extracting zip file without piping if extraction fails (#2616)
This is to workaround a bug in ditto prior to macOS 15.
2024-09-02 17:21:50 -07:00
Zorg dd9374356b Add support for extracting Apple Archives (.aar files) (#2586)
Check `man aa` and https://developer.apple.com/documentation/applearchive for more details. This is an efficient Apple custom archive format available since versions of macOS 10.15.

In macOS 10.15, this utility used to be called yaa.
2024-06-18 20:18:11 -07:00
Zorg 6e2366255b Add unarchiving test for regular encrypted disk image (#2571) 2024-05-27 14:10:28 -07:00
Zorg 27cf3b3650 Skip extracting auxiliary files and improve extraction progress for disk images (#2569) 2024-05-27 13:30:55 -07:00
Zorg 31b462f860 Extract archives in a separate directory from the input archive (#2550) 2024-04-30 21:24:43 +02:00
Viktor Szépe e9989a8ae7 Fix typos (#2537) 2024-04-13 16:12:23 -07:00
Zorg 1e419c8c16 Improve signing error message to developers (#2471)
If we detect the wrong archive is being served (i.e, expected content length differs from archive length) we log this out to developers. If the app version in the archive (if available) also differs, we report this discrepancy as well. If the update archive looks the same but signing validation fails, we tell the developer the update may have not been signed correctly.

I'm not changing the generic error that is reported to users about the update being improperly signed (that would involve propagating this information there and updating bunch of localizations). The extra info is more for the developer than it is for the user.

Fixes #2468
2023-11-18 16:04:44 -08:00
Zorg 469f423e28 Fix test cases for localized release notes (#2444) 2023-09-28 22:52:32 -07:00
Zorg f6a86f52b3 Default to English for XML nodes when no xml:lang is present (#2440)
This only applies when multiple XML nodes are present with the same name. E.g. multiple description or releaseNoteLink elements with different xml:lang's specified.

Also generate a warning if an language has to be interpreted implicitly when there is no xml:lang explicitly specified and there are multiple node items.
2023-09-28 20:02:29 -07:00
Zorg 39495fd562 Remove redundant codesign check (#2341) 2023-03-12 19:44:50 -07:00
Zorg 60568b82ba Don't allow DSA-only updates to pass if DSA is disabled (#2340) 2023-03-12 07:59:03 -07:00
Zorg ffc203b89a Add support for plain text release notes view (#2315)
This also allows embedded release notes to be plain text using sparkle:format="plain-text" attribute.

Also, Catalyst apps only support plain text release notes (compared to before where release notes weren't supported for Catalyst apps).
2023-02-11 19:34:26 -08:00
Zorg 348c3a9658 Don't construct appcast item if enclosure URL is invalid (#2317) 2023-02-07 20:12:07 -08:00
Zorg be7f6952c2 Reduce code size and make codebase more consistent (#2305) 2022-12-27 12:03:03 -08:00
Zorg 983d19580b Fix handle applying patches when files aren't writeable (#2216) 2022-07-23 10:37:29 -07:00
Zorg 372f0504a5 Bump minimum deployment target to macOS 10.13 (#2196) 2022-07-17 16:43:24 -07:00
Zorg d7942768b8 Validate permission bits of Sparkle executable for delta updates (#2151) 2022-06-11 11:21:52 -07:00
Zorg 9042c8dbd9 Fall back to regular update if delta update fails to download (#2118)
Also log out the download failure when a delta update fails to download (such as a 404 error for example).

Additionally, add a check to make sure that top-level appcast items cannot be delta update items.
2022-05-01 22:58:29 -07:00
Zorg 94719edeb3 Ignore custom icons set via resource forks in delta updates (#2114)
For creation, we will disallow creating delta updates if a custom resource fork icon data is found in either the old or app bundles.

For applying, we will just ignore the icon data when performing hash verification and continue applying the patch.
2022-04-24 00:38:42 -07:00
Zorg 94b48c45e7 Preserve file system compression when applying delta updates (#2084) 2022-01-30 23:37:42 -08:00
Zorg 8ea4d705f5 Add option to ignore skipped upgrades (#2081)
Normally when a major upgrade is skipped, subsequent updates for that major release are skipped. This element however allows publishing updates that ignore the user skipping the major version before a specific sub-release.
2022-01-29 23:02:45 -08:00