Notarize

Notarization produces a ticket that tells Gatekeeper that your app is notarized. After notarization completes, when a user attempts to run your app on macOS 10.14 or later, Gatekeeper will find the ticket online.

Command

Notarization commands begin with:

smctl-mac-x64 notarization notarize

Note

The inputs differ based on the type of Apple credentials and notarize tool you are using.

Flags

Describe scan commands support these flags:

Table 1. Flags for describing a keypair

Shortcut	Flag	Description
	--input string	Path to file. Allowed file formats: .pkg .dmg .zip Compress .app binaries into a .zip
	--profile-name string	Provide a profile name for your credentials in Keychain.
	--tool string	Provide the notarization tool name that should be used to save your credentials to Keychain. Allowed tools: notarytool altool
-v	--verbose	Enable verbose logging for saving credentials.
-h	--help	Help for describing a scan.

Examples

The notarize commands depend on the type of Apple credentials and notarize tool you are using.

Example 1. Apple-ID and notary tool

To notarize using notarytool and Apple ID, use the command:

smctl-mac-x64 notarization notarize --tool notarytool --profile-name <Keychain credentials profile name> -v --input <file_path_to_notatize>

Command sample:

smctl-mac-x64 notarization notarize --tool notarytool --profile-name notarytool_user -v --input /Users/john.doe/Documents/testing/example.dylib.dmg

Command output:

{"path":"\/Users\/john.doe\/Documents\/testing\/example.dylib.dmg","id":"5cb03d00-8ab1-4fdc-bb0a-f4167dc01f03","message":"Successfully uploaded file"}
 
notarizeCommand command for file /Users/john.doe/Documents/testing/example.dylib.dmg was SUCCESSFUL
ID: a7abfd6f-4567-123e-96a6-ab7dff751447
SUBMISSION ID: 5cbz03d00-8ab1-4fdc-bb0a-f2167dc01f03
SIGNATUREID:
CREATED ON:2023-04-17 06:34:20 +0000 UTC
CREATED BY:stm user
MODIFIED ON:2023-04-17 06:34:20 +0000 UTC
MODIFIED BY:stm user
ACCOUNT ID:f28bd2a7-1234-1111-b40b-826ea4b1b3e4
LOG:
Tool Used: notarytool
Timestamp:2023-04-17 06:34:20.706515 +0000 UTC
log: {"path":"\/Users\/john.doe\/Documents\/testing\/example.dylib.dmg","id":"5cb03d00-8ab1-4fdc-bb0a-f4167dc01f03","message":"Successfully uploaded file"}

Example 2. App Store Connect API key and notarytool

To notarize using notarytool and Apple App Store Connect API key:

smctl-mac-x64 notarization notarize --tool notarytool --profile-name <Keychain credentials profile name> -v --input <file_path_to_notatize>

Sample command:

smctl-mac-x64 notarization notarize --tool notarytool --profile-name notarytool_user_key -v --input /Users/john.doe/Documents/testing/example.dmg

Command output:

 {"path":"\/Users\/john.doe\/Documents\/testing\/example.dmg","message":"Successfully uploaded file","id":"08a7c877-9e11-46d7-8936-a76398f44313"}
 
notarizeCommand command for file /Users/john.doe/Documents/testing/example.dmg was SUCCESSFUL
ID: fd8c9be9-4567-12e3-961b-9f3e1361c356
SUBMISSION ID: 08a7c877-9e11-46d7-8936-a76398f44313
SIGNATUREID:
CREATED ON:2023-04-17 06:35:13 +0000 UTC
CREATED BY:stm user
MODIFIED ON:2023-04-17 06:35:13 +0000 UTC
MODIFIED BY:stm user
ACCOUNT ID:f28bd2a7-1234-1111-b40b-826ea4b1b3e4
LOG:
Tool Used: notarytool
Timestamp:2023-04-17 06:35:13.619136 +0000 UTC
log: {"path":"\/Users\/john.doe\/Documents\/testing\/example.dmg","message":"Successfully uploaded file","id":"08a7c877-9e11-46d7-8936-a76398f44313"}

Example 3. Apple-ID and altool

To notarize using altool and Apple ID:

smctl-mac-x64 notarization notarize --tool altool --profile-name <Keychain credentials profile name> --apple-id <apple ID> -v --bundle-id "DigiCert" --input <path to signed file>

Sample command:

smctl-mac-x64 notarization notarize --tool altool --profile-name altool_user --apple-id john.doe@example.com -v --bundle-id "DigiCert" --input /Users/john.doe/Documents/testing/example.dylib.dmg

Command output:

 {"tool-version":"5.329.1309","tool-path":"\/Applications\/Xcode.app\/Contents\/SharedFrameworks\/ContentDeliveryServices.framework\/Versions\/A\/Frameworks\/AppStoreService.framework","notarization-upload":{"RequestUUID":"71daf9d8-403d-4884-9647-073c2c2d3de9"},"success-message":"No errors uploading '\/Users\/john.doe\/Documents\/testing\/example.dylib.dmg'.","os-version":"12.6.3","warnings":[{"message":"altool has been deprecated for notarization and starting in late 2023 will no longer be supported by the Apple notary service. You should start using notarytool to notarize your software.","userInfo":{"NSLocalizedDescription":"altool has been deprecated for notarization and starting in late 2023 will no longer be supported by the Apple notary service. You should start using notarytool to notarize your software."},"code":-1030}]}

 
notarizeCommand command for file /Users/john.doe/Documents/testing/example.dylib.dmg was SUCCESSFUL
ID: 217f182c-6e08-4cc3-bb2f-8717dc0512a5
SUBMISSION ID: 71daf9d8-403d-4884-9647-073c2c2d3de9
SIGNATUREID:
CREATED ON:2023-04-17 06:26:53 +0000 UTC
CREATED BY:stm user
MODIFIED ON:2023-04-17 06:26:53 +0000 UTC
MODIFIED BY:stm user
ACCOUNT ID:f28bd2a7-0183-4311-b40b-826ea4b1b3e4
LOG:
Tool Used: altool
Timestamp:2023-04-17 06:26:53.51834 +0000 UTC
log: {"tool-version":"5.329.1309","tool-path":"\/Applications\/Xcode.app\/Contents\/SharedFrameworks\/ContentDeliveryServices.framework\/Versions\/A\/Frameworks\/AppStoreService.framework","notarization-upload":{"RequestUUID":"71daf9d8-403d-4884-9647-073c2c2d3de9"},"success-message":"No errors uploading '\/Users\/john.doe\/Documents\/testing\/smpkcs11.dylib.dmg'.","os-version":"12.6.3","warnings":[{"message":"altool has been deprecated for notarization and starting in late 2023 will no longer be supported by the Apple notary service. You should start using notarytool to notarize your software.","userInfo":{"NSLocalizedDescription":"altool has been deprecated for notarization and starting in late 2023 will no longer be supported by the Apple notary service. You should start using notarytool to notarize your software."},"code":-1030}]}

Troubleshooting

For help with the describe scan command, use:

smctl-mac-x64 notarization notarize --help

Alternatively, use the abbreviated version of the command:

smctl-mac-x64 notarization notarize -h

Notarize

Command

Note

Flags

Examples

Troubleshooting

Related articles