112 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 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 ad06a46ec8 Drop stale sparkle:format when generate_appcast embeds HTML release notes (#2927)
When an existing item's description is rewritten with HTML release notes,
the sparkle:format attribute from a previous plain-text or markdown
description was kept, so Sparkle kept rendering the new HTML as that format.
2026-09-18 21:00:27 -07:00
Leo Camus 7a8baa664b Skip en and Base when recording Sparkle locales in generate_appcast (#2925)
The guard compared the directory name (e.g. "en.lproj") against "en" and
"Base", so it never matched and both locales were recorded in
sparkle:deltaFromSparkleLocales, taking up slots of the 7 sampled locales.
Compare the locale name after dropping the .lproj extension instead.
2026-09-16 20:41:23 -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 d80452a6b4 Bump minimum deployment target to 12.0 (#2883)
To support building Sparkle in Xcode 27 (beta 1), we need to bump the deployment target.
2026-06-10 17:54:01 -07:00
Zorg cd20a12e92 Fix generate_appcast failing if feed URL doesn't have lastPathComponent (#2862) 2026-03-21 07:25:50 -07:00
Nathan Manceaux-Panot 79475ea34a Make generate_appcast deltas order stable and thread-safe (#2848) 2026-02-21 10:45:12 -08:00
Zorg 7c460d70f6 Formalize disable-signing-warning flag in signing tools (#2841) 2026-01-12 20:49:12 -08:00
Zorg 787d844be3 Improve detecting non-canonical Sparkle bundles in generate_appcast (#2836)
Don't check for Contents parent directory when checking for "Resources"
2026-01-09 21:40:20 -08:00
Zorg ca426e4b2d Find non-canonical Sparkle.framework locations in generate_appcast (#2833)
If Sparkle.framework isn't in Contents/Frameworks/ then we do a deep scan in the app bundle (but ignore Contents/Resources/). Sparkle may be placed in a plug-in or other parent framework.

Also remove legacy SparkleCore lookup which is no longer needed.
2026-01-08 20:28:28 -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 f28aacfd89 Handle markdown paths for localized release notes in generate_appcast (#2817) 2025-12-29 17:38:04 -08:00
Zorg 82d7da9326 Add markdown support for release notes (#2810)
* Supports Markdown ordered/unordered lists, paragraphs, headers, code blocks, inline styling. Block quotes and thematic breaks are handled in simple manner through indentation and extra newline respectively. Tables are not supported. HTML isn't supported.
* Requires macOS 12 or later due to leveraging Foundation / presentation intents for markdown processing. Older OS's and older Sparkle versions >= 2.4.0 will fall back to plain-text interpretation. Additionally, TextKit 2 is now adopted for macOS 12+, and TextKit 1 only code is to be avoided.
* Adds delegate method to allow formatting / modifying the presented text before it will be shown for plain-text and markdown release notes. This, for example, can be used to adapting release notes based on currently installed version, but it could also open up styling release notes in other ways.
* Adds sparkle:format="markdown" option to <description> element for embedded release notes (in addition to already existingsparkle:format="plain-text" option)
* Adds support for generate_appcast to handle markdown release note files and embedded release notes.
* Adds a MARKDOWN test mode to Sparkle Test App.
2025-12-19 18:10:18 -05: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 e13e63c85e Improve unable decode private key error messages (#2675) 2024-12-08 17:47:08 -08:00
Zorg 597825d111 Make binary delta version 4 the default (#2668) 2024-12-07 14:46:23 -08: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 8bc4976a2c Use FileHandle for reading base64 secret key from file (#2615)
Fixes process substitution failing to work for providing the private key as file argument (#2605).
2024-08-30 17:48:59 -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 2247105ff3 Ignore crashes due to SIGPIPE in generate_appcast (#2563) 2024-05-19 20:52:07 -07:00
Zorg 946c583910 Create and use temp extraction directory in generate_appcast again (#2555)
This restores how the code used to work in 2.6.0 except we don't create a link to the archive file, and remove the temp directory before starting. I had removed too much of the prior code in 2.6.1 which included creating the extraction directory in generate_appcast.
2024-05-04 06:21:49 +02: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 1a0b023e1c Store private seed as the secret for newly generated keys (#2472)
This improves compatibility when using the seed onto other cryptography libraries.
2023-11-23 09:23:10 -05:00
Zorg bd90fb7b18 Filter for archive files in generate_appcast more intelligently (#2448) 2023-10-08 09:38:50 -07:00
Zorg c9c08b7f42 Report an error when detecting duplicate updates in generate_appcast (#2407) 2023-07-22 16:25:38 -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 9ab2c0d58c Hide impractical compression options only useful for debugging (#2335) 2023-03-04 18:03:45 -08:00
Zorg 362f50a8a1 Exit with an error if generate_appcast cannot sign an update (#2322) 2023-02-25 13:18:03 -08: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 be7f6952c2 Reduce code size and make codebase more consistent (#2305) 2022-12-27 12:03:03 -08:00
Zorg 1b1a7db1ac Expose maximum-versions option to preserve in feed per branch (#2259) 2022-09-05 16:20:35 -07:00
Zorg 1c560652e7 Remove ed25519 git submodule (#2244)
Also allow release scripts to work without git repository and bump the Sparkle versions.
2022-08-27 10:46:29 -07:00
Zorg fbfcec3453 Fix recently introduced bugs in generate_appcast with multiple feeds (#2232)
We fix the validation check for using the output option when multiple feeds are present, fix not generating new feeds when no prior feed is available, and fix incorrect logic with cleaning up delta files when multiple feeds are present.
2022-08-19 21:36:50 -07:00
Zorg 8f77f066c1 Add delta update attributes for validating an app hasn't been stripped (#2231) 2022-08-19 20:48:52 -07:00
Zorg 80a5b80ade Move old updates to old_updates in generate_appcast (#2228)
Document --versions in generate_appcast better and add comments to explain why certain policies were made.

Add separate option to automatically pruned old update files. Now we only automatically move old update files aside. If the user passes --auto-prune-update-files we will also remove the old update files automatically.

Move old release notes files too.

Don't make old-updates directory hidden.
2022-08-14 19:07:48 -07:00
Zorg 37ef179284 Prune and preserve necessary updates in generate_appcast (#2218)
We preserve a batch of updates for each branch point (defined by an update's {majorVersion, minSystemVersion, maxSystemVersion, channel}). The latest for each branch point is used for generating delta updates.

We prune older update items that are no longer needed in the feed or needed for generating delta updates from newer items. We move pruned update files into a separate hidden directory, which is later garbage collected after a couple weeks based on each file's last modification date.

To insert new update items that are older than the latest update in the feed, --version flag needs to be used.

The overall goal is to have the feed only keep a small window of updates to serve to the user. This will also ease future processing generate_appcast needs to do and ensure the cache's directory doesn't blow up by pruning old updates.
2022-08-07 19:13:20 -07:00
Zorg 372f0504a5 Bump minimum deployment target to macOS 10.13 (#2196) 2022-07-17 16:43:24 -07:00
Zorg 14e511f901 Fix memory leaks when using generate_appcast (#2193)
We fix one memory leak when calculating sha's, one memory leak in the xar delta applying path, and avoid creating Bundles for reading the Sparkle framework version.

There are some other small leaks with the xar delta creation/applying code but since it's a legacy implementation and the APIs are undocumented I don't want to touch it too much.

The biggest culprit here is the leak when calculating sha's I believe, if you have many archive items.
2022-07-09 12:22:36 -07:00
Zorg e64b7649f2 Deprecate -s flag and add --ed-key-file option to generate_appcast (#2170) 2022-06-24 21:19:10 -07:00
Eitot 180f8975cf Replace deprecated code with newer APIs (#2112)
* Use UniformTypeIdentifiers framework to replace deprecated types

kUTType* constants are deprecated since macOS 12. The UniformTypeIdentifiers framework is available since the macOS 11 SDK.

* Replace renamed constants

* Use API_AVAILABLE macro instead of __OSX_AVAILABLE
2022-04-24 16:51:48 -07:00
Zorg e8fea3481a Add generate_appcast support for recent features (#2082)
We add support for:
* <sparkle:belowVersion> in <sparkle:informationalUpdate>
* <sparkle:ignoreSkippedUpgradesBelowVersion>
2022-01-30 15:20:55 -08:00
Zorg 91bccdf0ad Verify code signing in generate_appcast (#2077)
In generate_appcast we:

* Validate code signing integrity of new updates
* Add hidden flag to disable checking for nested code during validation
* Warn if new and old apps have differing signing identities when generating deltas
2022-01-23 14:46:52 -08:00
Zorg 89e20a490d Add hidden option to generate_appcast to set max CDATA threshold (#2075) 2022-01-22 20:58:53 -08:00
Zorg 9e45a78e6f Verify applying delta patch in generate_appcast (#2076) 2022-01-22 20:14:45 -08:00