SecItemAdd always returns error -34018 in Xcode 8 in iOS 10 simulator

Question

Update: This issue has been fixed in Xcode 8.2. Keychain works in the simulator without enabling keychain sharing.

Why am I always receiving error -34018 when calling SecItemAdd function in Xcode 8 / iOS 10 simulator?

Steps to Reproduce

Create a new Single page iOS app project in Xcode 8. Run the following code in viewDidLoad (or open this Xcode project).

let itemKey = "My key"
let itemValue = "My secretive bee "

// Remove from Keychain
// ----------------

let queryDelete: [String: AnyObject] = [
  kSecClass as String: kSecClassGenericPassword,
  kSecAttrAccount as String: itemKey as AnyObject
]

let resultCodeDelete = SecItemDelete(queryDelete as CFDictionary)

if resultCodeDelete != noErr {
  print("Error deleting from Keychain: \(resultCodeDelete)")
}


// Add to keychain
// ----------------

guard let valueData = itemValue.data(using: String.Encoding.utf8) else {
  print(" Error saving text to Keychain")
  return
}

let queryAdd: [String: AnyObject] = [
  kSecClass as String: kSecClassGenericPassword,
  kSecAttrAccount as String: itemKey as AnyObject,
  kSecValueData as String: valueData as AnyObject,
  kSecAttrAccessible as String: kSecAttrAccessibleWhenUnlocked
]

let resultCode = SecItemAdd(queryAdd as CFDictionary, nil)

if resultCode != noErr {
  print(" Error saving to Keychain: \(resultCode).")
} else {
  print(" Saved to keychain successfully.")
}

Expected Results

Item is added to Keychain.

Actual Results

Function SecItemAdd returns the following error code: -34018.

Version

Xcode version 8.1 (8B62), macOS Sierra 10.12.1.

Configuration

Always occurs in Xcode 8 since Beta 2 when testing in an iOS 10 simulator.

Does NOT occur in Xcode 8 when testing in an iOS 9.3 simulator.

Demo

https://dl.dropboxusercontent.com/u/11143285/2016/07/KeychainBugDemo.zip

References

Radar: https://openradar.appspot.com/27422249

Apple Developer Forums: https://forums.developer.apple.com/message/179846

This issue is different from the following post because it occurs consistently in Xcode 8. SecItemAdd and SecItemCopyMatching returns error code -34018 (errSecMissingEntitlement)

Answer 1

I was able to work around this in my app by adding Keychain Access Groups to the Entitlements file. I turned on the Keychain Sharing switch in the Capabilities section in your test app, and it is working for me as well.

Item to add to entitlements:

<key>keychain-access-groups</key>
<array>
    <string>$(AppIdentifierPrefix)com.evgenii.KeychainBugDemo</string>
</array>

I have only tried this on macOS Sierra (10.12), so I'm not sure if it will work for you on 10.11.5.

Answer 2

In Xcode 8.1 GM Release Notes Apple acknowledged the problem and suggested a cleaner workaround:

Keychain APIs may fail to work in the Simulator if your entitlements file doesn’t contain a value for the application-identifier entitlement. (28338972) Workaround: Add a user-defined build setting to your target named ENTITLEMENTS_REQUIRED and set the value to YES. This will cause Xcode to automatically insert an application-identifier entitlement when building.

Note that from what I have tried, it only works in Xcode 8.1. Although the text can mislead you into a build setting, what you need to do is add this to your Environment Variables, in your scheme.

Xcode 8.2 will solve this:

Resolved in Xcode 8.2 beta - IDE Keychain APIs work correctly in Simulator. (28338972)

Answer 3

This can happen if you have a test target that does not have a host app. To fix

1. add a dummy host app :

2. Enable automatic code signing and add a team :

3. Enable keychain sharing in capabilities

Answer 4

I got an error while signing with email, creating a new user or with sign out using firebase.

The error was:

firauth error domain code 17995

I turned on the Keychain Sharing switch in the Capabilities section in your test app, and it is working for me as well.

Answer 5

I was looking for a solution that didn't use Keychain sharing, as that wasn't the feature I was looking for. The developer forum Seems to have a good work around from EvergreenCoder that you can limit in scope to only the iOS 10 simulator (as this seems to be the only affected simulator). From the post:

The issue seems to be that there must be at least one entitlement in order for Xcode to properly add the "application-identifier" enttilement to the built application. This is why keychain sharing seems to be a solution but it is only indirectly so: any other entitlement seems to work fine.

You can create a .plist like so:

<?xml version="1.0" encoding="UTF-8"?>  
<!DOCTYPE plist PUBLIC "-/  
<plist version="1.0">  
    <dict>  
        <key>get-task-allow</key>  
        <true/>  
    </dict>  
</plist>

and provide a path to that file under Build Settings in

Code Signing->Debug->Simulater iOS 10 SDK->($SRCROOT)/your-path-to-file

As stated in the post, this entitlement just allows the debugger to be attached.

Answer 6

I had a similar issue, though I was getting the -34018 error when trying to run on device. I am using XCode 8.1 on Sierra with iOS 10.1. I work on a team and suddenly had this issue when we switched to "Automatically manage signing" in the project settings. When I turn this off and manually select my profile, everything works fine. I ended up having to delete my developer certificate from my keychain, then re-select "Automatically manage signing". On the next build, it generated a new signing certificate for me and everything works fine now. I'm still not sure what caused the issue as the other cert worked fine when manually selected, but not when being managed by XCode. Hope this helps stop an hours long headache for someone else.

Answer 7

I was able to solve this issue in Xcode 11 without any entitlement adjustments.

I simply added a new app target to my framework's project called MyFrameworkTestsHostApp.

Then I selected the MyFrameworkTests target and chose its Host Application as MyFrameworkTestsHostApp.

Answer 8

It works after enabling the keychain sharing in capabilities.

Answer 9

There 3 steps to take to resolve this issue quickly.

1. Turn on Keychain sharing in your project capabilities.
2. Select Automatic Provisioning with a profile
3. Ensure your custom entitlement option is set to Entitlement.plist.

This will do the magic