Frequently Asked Questions
Installing Suspicious Package
What versions of OS X does Suspicious Package support?
Suspicious Package supports:
- macOS 10.12 (Sierra)
- OS X 10.11 (El Capitan)
- OS X 10.10 (Yosemite) and
- OS X 10.9 (Mavericks)
If you're using an older version of OS X, you can still download an old version of the standalone Quick Look plugin:
- For OS X 10.8 (Mountain Lion), use Version 2.0.2.
- For OS X 10.7 (Lion) or OS X 10.6 (Snow Leopard), use Version 1.3.
- For OS X 10.5 (Leopard), use Version 1.2.
We make these old versions available for those who want to try them, but bear in mind that we have not tested them since they were current.
Why don't I get the Suspicious Package preview in Quick Look?
Although you can install Suspicious Package app anywhere you like, Quick Look can be stubborn about recognizing the plug-in that is bundled inside of it. Specifically, you must open the Suspicious Package app at least once before Quick Look will even consider using its plug-in (this is, presumably, a security measure, so that only apps which pass the Gatekeeper checks can generate Quick Look previews). After you do that, Quick Look will eventually find the plug-in, but it may not happen immediately.
When the Suspicious Package app is opened for the first time, it will request that Quick Look update its plug-in registry, and that will usually suffice to get previews working immediately. However, if you open the app before dragging it to your Applications folder (or wherever) — perhaps you opened it initially from the disk image — the request to Quick Look will not help matters.
So, if you are unable to get a proper Suspicious Package preview from Quick Look, try these steps:
- Open the Suspicious Package app at least once from its installed location (not merely from the disk image).
- Open the Terminal and run the following command to get Quick Look to update its plug-in registry:
The second step ought not be necessary, but the Suspicious Package app is currently not smart enough to redo the Quick Look request when the app location has changed. We'll attempt to improve this in the next release.
Does Suspicious Package automatically check for updates?
Yes, once every 2 weeks — or less, if you use it less often — Suspicious Package will download a small file from our website to get the current version number. If a newer version is available, you'll see an Update Available button on the right side of the app's title bar: and at the bottom of the Quick Look preview:
Click on Update Available to open the Suspicious Package download page, where you can get the latest version.
If you want to change the frequency with which Suspicious Package checks for updates, or turn off automatic checking entirely, use Suspicious Package > Preferences > Update: Note that the automatic check preference you set here applies to both the app and the Quick Look plug-in.
Suspicious Package never automatically downloads or installs the actual updated app. You make the decision about when or if to download it, and where and how to install it.
How do I remove the old standalone Quick Look plugin?
Although Quick Look should find the new plug-in inside the Suspicious Package app (eventually), you may still want to remove the old standalone plug-in, just to save disk space and avoid unnecessary cruft.
After launching the app, you can use Suspicious Package > Move Old Plug-in to Trash to get rid of the standalone plug-in, whether it was installed for the current user or for all users. (If you don't see this item in the app menu, no standalone plug-in was found in either of the standard locations.)
Can I download Suspicious Package as a disk image (and what happened to XIP)?
Suspicious Package was previously distributed as a XIP archive, but in macOS 10.12 (Sierra), Apple has removed support for XIP archives, except for those signed by Apple.
From the Suspicious Package download page, you will now get a disk image instead. This disk image is “signed” for the benefit of macOS 10.12 (Sierra), but is still compatible with earlier versions of OS X. As with any app distributed via a disk image, you will need to open the disk image, copy the app to your Applications folder (or wherever), and then eject and trash the disk image.
For the sake of existing scripts and distribution tools, we will continue to make Suspicious Package available as a XIP archive for the near future. But you should switch to using the disk image download when feasible.
I don't want an app. Can I install only the Quick Look plugin?
No. But you don't have to use the app at all, if you don't want to. As a bonus, bundling the Quick Look plugin inside the app simplifies installation: drag the app into your Applications folder (or wherever) and the Quick Look plugin is automatically available (see here for troubleshooting). No more ironic Suspicious Package package!
Don't try to drag the Quick Look plugin out of the app bundle. It won't work, because the plugin relies on other resources within the app bundle.
Using Suspicious Package
If Suspicious Package “didn't find any issues for review,” is the package safe to install?
No, not necessarily. Although the Suspicious Package app examines the package for a number of potential issues, it doesn't know how to determine if the package is truly safe to install. The review is intended only to highlight things that might be of interest in your determination of safety. So, finding no issues for review simply means that none of the things that Suspicious Package knows to look for are there — that doesn't mean that there aren't other issues.
There is, unfortunately, no substitute for the hard work of evaluating the contents and scripts in the package, and vetting the package signature. (If that could all be done algorithmically, Apple would presumably have OS X do it directly, and none of this would be necessary!)
How can I tell which files a
Custom Install will install?
Some installer packages contain sub-packages, and allow you to deselect one or more of these through the Customize dialog. And some installer packages contain sub-packages that are selected or deselected automatically, based on the OS X version, the other software installed, or even the hardware of your Mac.
Suspicious Package doesn't have the smarts to figure out which sub-packages will actually be installed, and merely assumes that they all would be. For the purpose of evaluating what a package might do to your system, this is usually enough.
What's the difference between Suspicious Package and “Show Package Contents” in the Finder?
Show Package Contents in the Finder's context menu actually refers to a completely different sort of package. OS X also uses the term “package” to refer to a folder that appears to be a file in the Finder. (A developer might call this a bundle, but a package is actually a more generic thing, since a bundle implies a specific internal structure, such as an Info.plist file and a Resources directory.) The Finder's Show Package Contents command is just saying to open the folder in the Finder, instead of opening the application associated with the package.
A modern (“flat”) installer package is not even a folder, so you won't see this Finder command. On an older (“bundle-style”) installer package, the Finder will offer to Show Package Contents, but that will show you only the internal structure of the installer package, which isn't the same as seeing what the package will install. (However, it is occasionally useful for finding scripts and executables referenced by install scripts: see more details.)
Why does Suspicious Package show the wrong icon for this file or application?
Suspicious Package actually has no idea what icon an item will have after being installed. (It would have to essentially do the install in order to determine this reliably.) Instead, Suspicious Package shows a generic icon, determined from metadata about the item, such as its name, extension, location and permissions. This is why you'll see only generic application icons, for example. These icons are intended only to give you helpful visual clues as you scan the file view.
Why don't I get a Quick Look preview in Finder windows set to use Column view?
Finder's Column view (i.e. View > as Columns) shows Quick Look previews in the rightmost pane for some types of files. But it doesn't support interactive previews such as Suspicious Package (excepting some of the built-in types, like PDF files or movie files).
You might notice that, for a large package, Column view will work a bit before simply showing the generic package icon. This, unfortunately, is Suspicious Package producing a Quick Look preview, which the Finder will then decline to show. We tried to find a way to avoid this, but there seems to be no way to tell the Finder ahead of time that it shouldn't bother.
Why doesn't Suspicious Package show the indirect scripts for certain packages?
Suspicious Package shows all scripts for modern (so-called “flat”) installer packages. It is otherwise extremely difficult to see the scripts in a flat package.
An older package format (known as “bundle-style”) can also have indirect scripts. But in this case, the scripts are visible within the bundle, if you open the package using the Finder's Show Package Contents command (see above). Suspicious Package shows only the top-level (preinstall and postinstall) scripts in this case, rather than trying to show the entire contents of the package, and doing so less effectively than the Finder.
What is a “distribution” script and should I inspect it?
For example, the distribution might declare which OS X version and/or Macintosh hardware is required for the installed software. It defines any special UI that the Installer displays, such as a software license agreement. It determines what choices the user can make on the Customize dialog, and how those customizations change which sub-packages will be installed. It can even automatically change which sub-packages will be installed, based on which OS X version — or other software — is already installed.
system.run() [or its relative,
system.runOnce()]. If a distribution declares its
intention to use this exception, Suspicious Package will flag this as a potential issue:
This also causes the OS X Installer to present a warning dialog when it opens the package:
If you click the Show Scripts That Run on Open button, Suspicious Package will show you the scripts within
the package that might be run by
system.run(). However, the distribution may also run system commands with this
mechanism, so in order to completely understand what it does, you really need to read the distribution script.
Which brings us to the other bad news: the distribution script is an arcane, Apple-defined format that is not easy to interpret. The Distribution XML Reference provides some reference information, but if you've never looked at a distribution file before, it probably won't help much. Even those of us that have been staring at these things for years are no experts!
All of this is why Suspicious Package does not show you the distribution script by default. Given the challenges of making heads or tails of it, you're probably better off focusing on other evidence of trustworthiness, such as the identity of the distributor. But if you want to see the distribution script in all its glory, you can go to Suspicious Package > Preferences > General and check Distribution script.
How should I evaluate scripts that run when the OS X Installer opens?
As noted above, a script that runs when the OS X Installer opens is an artifact of
the distribution script's
system.run() capability. Suspicious Package will always show such scripts that
are bundled with the package itself: these appear under the Installer Package heading in the scripts browser. But as
described above, the distribution can also run system commands, and the only way to determine that is by inspecting
the distribution script itself.
With that proviso, the important things to know about scripts that run when the OS X Installer opens are:
- These scripts may run as soon as you click Continue in the OS X Installer dialog that says “this package will run a program to determine if the software can be installed.”
- These scripts run as the current user, so they can't change system files, but they can do anything with the files in your home folder.
- The command-line arguments passed to these scripts are up to the distribution script.
How should I evaluate a package that contains plug-in code for the OS X Installer?
The OS X Installer provides a plug-in mechanism by which a package can add UI to the installer: this normally takes the form of additional steps, such as entering registration or licensing information, or performing some sort of post-install cleanup or update checking.
However, this mechanism results in code provided by the package being run by the OS X Installer, upon opening of the package. As with run-on-open scripts, this also will cause the OS X Installer to present this warning dialog:
Unfortunately, unlike the distribution script mechanisms, where there's something that you can see (no matter how arcane), there is basically nothing you can check here: OS X Installer plugins are binary executables, and there's not much you can do to analyze them beforehand. Again, you're probably better off focusing on other evidence of trustworthiness, such as the identity of the distributor.
Why does Suspicious Package always export “All Openable Items”?
Suspicious Package allows a subset of installed files (such as property lists) to be opened in another application. To make this work, it exports these “openable files” into a temporary location, shortly after you open the package. Depending on the size of the package, this automatic export might take awhile, so Suspicious Package shows the progress in the Exports list like so:
For more on how to open these automatically exported files, see Opening Installed Files in Another Application.
Suspicious Package automatically deletes these files again when you close the window for the package.
What purpose do package identifiers and bundle overwrite rules serve?
The metadata presented by Suspicious Package in the Info pane of the All Files tab all pertains to the end result of installing the package. There is additional data in the package (usually) that has more to do with the way that the OS X Installer performs the install; Suspicious Package does not show these by default. They are generally only of interest if you're developing or debugging a package yourself.
That said, if you want to see this additional data in the Info pane, you can enable it by going to Suspicious Package > Preferences > General, and checking Component package and bundle info. This adds two fields to the info pane:
- Package shows the identifiers of the sub-package(s) that install the item. This can be useful if you're trying to determine what sub-package is installing what, especially in a package that is bundling sub-packages from other places. Note that there can be multiple sub-package identifiers for folders, since their installed folder structure can overlap.
- When a bundle is selected, the Bundle field cycles through various information about the way that the OS X Installer handles that bundle. For example, the Installer might (or might not) look for an existing copy of that bundle that has been moved elsewhere and update it there (this is generally only pertinent for application bundles). Or the Installer may need to follow specific rules about how to update an existing version of the bundle. Hopefully, if you need this information, the descriptions given in the Bundle field will make sense to you!
What happened to certificate validity information in the Quick Look preview?
OS X provides a standard “certificate trust” sheet for examining a chain of certificates. This UI includes detail on each certificate, including its validity (or lack thereof). The Suspicious Package app uses this standard UI, much like other OS X applications, like Safari or the OS X Installer.
Because of the way that Quick Look previews work, Suspicious Package can't use the standard UI there. Instead, it has always re-created this UI, using lower-level OS X APIs to get the relevant certificate information. But in macOS 10.12 (Sierra), those lower-level APIs no longer provide details of individual certificate validity. We've reported this to Apple (as bug 27930542), but at this writing, the situation is unchanged.
So, at least for the time being, on Sierra, the Quick Look preview omits the validity information for individual certificates, rather than presenting information that might be wrong. If you need this detail, you can open the package in the Suspicious Package app, and use Window > Signature Details (Cmd-5) to access the standard certificate trust sheet. We may — or may not — bring back this information in a future release, depending on what happens with the OS.