diff --git a/README.md b/README.md index 6cee8f7..29ab809 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Get Certificates From Jamf Pro Into Your iOS Apps ## Jamf Certificate SDK -###### Framework Architectures +#### Framework Architectures The included framework ships with two simulator architectures (i386 and x86_64) and two device architectures (armv7 and arm64). This allows third-party app developers to use the framework both in their own simulators @@ -19,12 +19,9 @@ this. #### Managed App Config Required Settings -To ensure proper use of the SDK, the iOS app is required to be distributed by Jamf Pro. During distribution, an App Configuration -can be specified that will let the SDK communicate with Jamf Pro and request the proper certificate. Here is a sample App Configuration -that can be used as a basis for your own app. +To ensure proper use of the SDK, the iOS app is required to be distributed by Jamf Pro. During distribution, an App Configuration can be specified that will let the SDK communicate with Jamf Pro and request the proper certificate. Here is a sample App Configuration that can be used as a basis for your own app. -Note that you can add your own key/value pairs to the App Configuration to configure other parts of your app. Jamf's keys are all prefixed -with `com.jamf.config.` so they will not clash with your own naming conventions for keys. +####### Note: You can add your own key/value pairs to the App Configuration to configure other parts of your app. Jamf's keys are all prefixed with `com.jamf.config.` so they will not clash with your own naming conventions for keys. com.jamf.config.jamfpro.invitation @@ -32,26 +29,27 @@ with `com.jamf.config.` so they will not clash with your own naming conventions com.jamf.config.device.udid $UDID com.jamf.config.jamfpro.url - https://the_jamf_pro_server_url_goes_here/ + https://qpzpaot.kube.jamf.build/ com.jamf.config.certificate-request.pkiId 1 com.jamf.config.certificate-request.template - User2 + blah com.jamf.config.certificate-request.subject cn=something com.jamf.config.certificate-request.sanType rfc822Name com.jamf.config.certificate-request.sanValue - somebody@example.com + $EMAIL + com.jamf.config.certificate-request.signature + $JAMF_SIGNATURE_com.jamf.config.certificate-request -###### MAC key discussion +#### MAC key discussion com.jamf.config.jamfpro.url: The value should be filled in with your Jamf Pro Server's URL. The keys prefixed with `com.jamf.config.certificate-request` are used during certificate generation. They will -be specific to your organization. You should confer with those responsible for Jamf Pro and your Certificate Authority to ensure -the proper settings are configured for your app. +be specific to your organization. You should confer with those responsible for Jamf Pro and your Certificate Authority to ensure the proper settings are configured for your app. * pkiId: (an integer but typed as string in the MAC) Jamf Pro ID of the PKI Integration/Certificate Authority to be used; find this in the Jamf Pro web UI at Settings > PKI Certificates > Your ADCS CA settings and then look in the URL bar for the number after "id=". You should have a URL something like "adcsSettings.html?id=3" @@ -60,5 +58,4 @@ web UI at Settings > PKI Certificates > Your ADCS CA settings and then look in t * sanType: (string) One of 'rfc822Name', 'dNSName', or 'uniformResourceIdentifier' * sanValue: (string) Subject Alternative Name to include in the certificate signing request -With the subject and sanValue fields, variable substitution is available as discussed under "Payload Variables for Mobile Device Configuration Profiles" at -http://docs.jamf.com/jamf-pro/administrator-guide/Mobile_Device_Configuration_Profiles.html +With the subject and sanValue fields, variable substitution is available as discussed under "Payload Variables for Mobile Device Configuration Profiles" at http://docs.jamf.com/jamf-pro/administrator-guide/Mobile_Device_Configuration_Profiles.html