Local Authentication on iOS

During local authentication, an app authenticates the user against credentials stored locally on the device. In other words, the user "unlocks" the app or some inner layer of functionality by providing a valid PIN, password or biometric characteristics such as face or fingerprint, which is verified by referencing local data. Generally, this is done so that users can more conveniently resume an existing session with a remote service or as a means of step-up authentication to protect some critical function.
As stated before in chapter "Mobile App Authentication Architectures": The tester should be aware that local authentication should always be enforced at a remote endpoint or based on a cryptographic primitive. Attackers can easily bypass local authentication if no data returns from the authentication process.
Testing Local Authentication (MSTG-AUTH-8 and MSTG-STORAGE-11)
On iOS, a variety of methods are available for integrating local authentication into apps. The Local Authentication framework provides a set of APIs for developers to extend an authentication dialog to a user. In the context of connecting to a remote service, it is possible (and recommended) to leverage the keychain for implementing local authentication.
Fingerprint authentication on iOS is known as Touch ID. The fingerprint ID sensor is operated by the SecureEnclave security coprocessor and does not expose fingerprint data to any other parts of the system. Next to Touch ID, Apple introduced Face ID: which allows authentication based on facial recognition. Both use similar APIs on an application level, the actual method of storing the data and retrieving the data (e.g. facial data or fingerprint related data is different).
Developers have two options for incorporating Touch ID/Face ID authentication:
LocalAuthentication.framework is a high-level API that can be used to authenticate the user via Touch ID. The app can't access any data associated with the enrolled fingerprint and is notified only whether authentication was successful.
Security.framework is a lower level API to access keychain services. This is a secure option if your app needs to protect some secret data with biometric authentication, since the access control is managed on a system-level and can not easily be bypassed. Security.framework has a C API, but there are several open source wrappers available, making access to the keychain as simple as to NSUserDefaults. Security.framework underlies LocalAuthentication.framework; Apple recommends to default to higher-level APIs whenever possible.
Please be aware that using either the LocalAuthentication.framework or the Security.framework, will be a control that can be bypassed by an attacker as it does only return a boolean and no data to proceed with. See Don't touch me that way, by David Lindner et al for more details.
Local Authentication Framework
The Local Authentication framework provides facilities for requesting a passphrase or Touch ID authentication from users. Developers can display and utilize an authentication prompt by utilizing the function evaluatePolicy of the LAContext class.
Two available policies define acceptable forms of authentication:
deviceOwnerAuthentication(Swift) or LAPolicyDeviceOwnerAuthentication(Objective-C): When available, the user is prompted to perform Touch ID authentication. If Touch ID is not activated, the device passcode is requested instead. If the device passcode is not enabled, policy evaluation fails.
deviceOwnerAuthenticationWithBiometrics (Swift) or LAPolicyDeviceOwnerAuthenticationWithBiometrics(Objective-C): Authentication is restricted to biometrics where the user is prompted for Touch ID.
The evaluatePolicy function returns a boolean value indicating whether the user has authenticated successfully.
The Apple Developer website offers code samples for both Swift and Objective-C. A typical implementation in Swift looks as follows.
1
let context = LAContext()
2
var error: NSError?
3
​
4
guard context.canEvaluatePolicy(.deviceOwnerAuthentication, error: &error) else {
5
    // Could not evaluate policy; look at error and present an appropriate message to user
6
}
7
​
8
context.evaluatePolicy(.deviceOwnerAuthentication, localizedReason: "Please, pass authorization to enter this area") { success, evaluationError in
9
    guard success else {
10
        // User did not authenticate successfully, look at evaluationError and take appropriate action
11
    }
12
​
13
    // User authenticated successfully, take appropriate action
14
}
Copied!
Touch ID authentication in Swift using the Local Authentication Framework (official code sample from Apple).
Using Keychain Services for Local Authentication
The iOS keychain APIs can (and should) be used to implement local authentication. During this process, the app stores either a secret authentication token or another piece of secret data identifying the user in the keychain. In order to authenticate to a remote service, the user must unlock the keychain using their passphrase or fingerprint to obtain the secret data.
The keychain allows saving items with the special SecAccessControl attribute, which will allow access to the item from the keychain only after the user has passed Touch ID authentication (or passcode, if such a fallback is allowed by attribute parameters).
In the following example we will save the string "test_strong_password" to the keychain. The string can be accessed only on the current device while the passcode is set (kSecAttrAccessibleWhenPasscodeSetThisDeviceOnly parameter) and after Touch ID authentication for the currently enrolled fingers only (SecAccessControlCreateFlags.biometryCurrentSet parameter):
Swift
1
// 1. create AccessControl object that will represent authentication settings
2
​
3
var error: Unmanaged<CFError>?
4
​
5
guard let accessControl = SecAccessControlCreateWithFlags(kCFAllocatorDefault,
6
                                                          kSecAttrAccessibleWhenPasscodeSetThisDeviceOnly,
7
                                                          SecAccessControlCreateFlags.biometryCurrentSet,
8
                                                          &error) else {
9
    // failed to create AccessControl object
10
​
11
    return
12
}
13
​
14
// 2. define keychain services query. Pay attention that kSecAttrAccessControl is mutually exclusive with kSecAttrAccessible attribute
15
​
16
var query: [String: Any] = [:]
17
​
18
query[kSecClass as String] = kSecClassGenericPassword
19
query[kSecAttrLabel as String] = "com.me.myapp.password" as CFString
20
query[kSecAttrAccount as String] = "OWASP Account" as CFString
21
query[kSecValueData as String] = "test_strong_password".data(using: .utf8)! as CFData
22
query[kSecAttrAccessControl as String] = accessControl
23
​
24
// 3. save item
25
​
26
let status = SecItemAdd(query as CFDictionary, nil)
27
​
28
if status == noErr {
29
    // successfully saved
30
} else {
31
    // error while saving
32
}
Copied!
Objective-C
1
    // 1. create AccessControl object that will represent authentication settings
2
    CFErrorRef *err = nil;
3
​
4
    SecAccessControlRef sacRef = SecAccessControlCreateWithFlags(kCFAllocatorDefault,
5
        kSecAttrAccessibleWhenPasscodeSetThisDeviceOnly,
6
        kSecAccessControlUserPresence,
7
        err);
8
​
9
    // 2. define keychain services query. Pay attention that kSecAttrAccessControl is mutually exclusive with kSecAttrAccessible attribute
10
    NSDictionary* query = @{
11
        (_ _bridge id)kSecClass: (__bridge id)kSecClassGenericPassword,
12
        (__bridge id)kSecAttrLabel: @"com.me.myapp.password",
13
        (__bridge id)kSecAttrAccount: @"OWASP Account",
14
        (__bridge id)kSecValueData: [@"test_strong_password" dataUsingEncoding:NSUTF8StringEncoding],
15
        (__bridge id)kSecAttrAccessControl: (__bridge_transfer id)sacRef
16
    };
17
​
18
    // 3. save item
19
    OSStatus status = SecItemAdd((__bridge CFDictionaryRef)query, nil);
20
​
21
    if (status == noErr) {
22
        // successfully saved
23
    } else {
24
        // error while saving
25
    }
Copied!
Now we can request the saved item from the keychain. Keychain services will present the authentication dialog to the user and return data or nil depending on whether a suitable fingerprint was provided or not.
Swift
1
// 1. define query
2
var query = [String: Any]()
3
query[kSecClass as String] = kSecClassGenericPassword
4
query[kSecReturnData as String] = kCFBooleanTrue
5
query[kSecAttrAccount as String] = "My Name" as CFString
6
query[kSecAttrLabel as String] = "com.me.myapp.password" as CFString
7
query[kSecUseOperationPrompt as String] = "Please, pass authorisation to enter this area" as CFString
8
​
9
// 2. get item
10
var queryResult: AnyObject?
11
let status = withUnsafeMutablePointer(to: &queryResult) {
12
    SecItemCopyMatching(query as CFDictionary, UnsafeMutablePointer($0))
13
}
14
​
15
if status == noErr {
16
    let password = String(data: queryResult as! Data, encoding: .utf8)!
17
    // successfully received password
18
} else {
19
    // authorization not passed
20
}
Copied!
Objective-C
1
// 1. define query
2
NSDictionary *query = @{(__bridge id)kSecClass: (__bridge id)kSecClassGenericPassword,
3
    (__bridge id)kSecReturnData: @YES,
4
    (__bridge id)kSecAttrAccount: @"My Name1",
5
    (__bridge id)kSecAttrLabel: @"com.me.myapp.password",
6
    (__bridge id)kSecUseOperationPrompt: @"Please, pass authorisation to enter this area" };
7
​
8
// 2. get item
9
CFTypeRef queryResult = NULL;
10
OSStatus status = SecItemCopyMatching((__bridge CFDictionaryRef)query, &queryResult);
11
​
12
if (status == noErr){
13
    NSData* resultData = ( __bridge_transfer NSData* )queryResult;
14
    NSString* password = [[NSString alloc] initWithData:resultData encoding:NSUTF8StringEncoding];
15
    NSLog(@"%@", password);
16
} else {
17
    NSLog(@"Something went wrong");
18
}
Copied!
Usage of frameworks in an app can also be detected by analyzing the app binary's list of shared dynamic libraries. This can be done by using otool:
1
$ otool -L <AppName>.app/<AppName>
Copied!
If LocalAuthentication.framework is used in an app, the output will contain both of the following lines (remember that LocalAuthentication.framework uses Security.framework under the hood):
1
/System/Library/Frameworks/LocalAuthentication.framework/LocalAuthentication
2
/System/Library/Frameworks/Security.framework/Security
Copied!
If Security.framework is used, only the second one will be shown.
Static Analysis
It is important to remember that the LocalAuthentication framework is an event-based procedure and as such, should not be the sole method of authentication. Though this type of authentication is effective on the user-interface level, it is easily bypassed through patching or instrumentation. Therefore, it is best to use the keychain service method, which means you should:
Verify that sensitive processes, such as re-authenticating a user performing a payment transaction, are protected using the keychain services method.
Verify that access control flags are set for the keychain item which ensure that the data of the keychain item can only be unlocked by means of authenticating the user. This can be done with one of the following flags:
kSecAccessControlBiometryCurrentSet (before iOS 11.3 kSecAccessControlTouchIDCurrentSet). This will make sure that a user needs to authenticate with biometrics (e.g. Face ID or Touch ID) before accessing the data in the keychain item. Whenever the user adds a fingerprint or facial representation to the device, it will automatically invalidate the entry in the Keychain. This makes sure that the keychain item can only ever be unlocked by users that were enrolled when the item was added to the keychain.
kSecAccessControlBiometryAny (before iOS 11.3 kSecAccessControlTouchIDAny). This will make sure that a user needs to authenticate with biometrics (e.g. Face ID or Touch ID) before accessing the data in the Keychain entry. The Keychain entry will survive any (re-)enroling of new fingerprints or facial representation. This can be very convenient if the user has a changing fingerprint. However, it also means that attackers, who are somehow able to enrole their fingerprints or facial representations to the device, can now access those entries as well.
kSecAccessControlUserPresence can be used as an alternative. This will allow the user to authenticate through a passcode if the biometric authentication no longer works. This is considered to be weaker than kSecAccessControlBiometryAny since it is much easier to steal someone's passcode entry by means of shouldersurfing, than it is to bypass the Touch ID or Face ID service.
In order to make sure that biometrics can be used, verify that the kSecAttrAccessibleWhenPasscodeSetThisDeviceOnly or the kSecAttrAccessibleWhenPasscodeSet protection class is set when the SecAccessControlCreateWithFlags method is called. Note that the ...ThisDeviceOnly variant will make sure that the keychain item is not synchronized with other iOS devices.
Note, a data protection class specifies the access methodology used to secure the data. Each class uses different policies to determine when the data is accessible.
Dynamic Analysis
​Objection Biometrics Bypass can be used to bypass LocalAuthentication. Objection uses Frida to instrument the evaluatePolicy function so that it returns True even if authentication was not successfully performed. Use the ios ui biometrics_bypass command to bypass the insecure biometric authentication. Objection will register a job, which will replace the evaluatePolicy result. It will work in both, Swift and Objective-C implementations.
1
...itudehacks.DVIAswiftv2.develop on (iPhone: 13.2.3) [usb] # ios ui biometrics_bypass
2
(agent) Registering job 3mhtws9x47q. Type: ios-biometrics-disable
3
...itudehacks.DVIAswiftv2.develop on (iPhone: 13.2.3) [usb] # (agent) [3mhtws9x47q] Localized Reason for auth requirement: Please authenticate yourself
4
(agent) [3mhtws9x47q] OS authentication response: false
5
(agent) [3mhtws9x47q] Marking OS response as True instead
6
(agent) [3mhtws9x47q] Biometrics bypass hook complete
Copied!
If vulnerable, the module will automatically bypass the login form.
Note regarding temporariness of keys in the Keychain
Unlike macOS and Android, iOS currently (at iOS 12) does not support temporariness of an item's accessibility in the keychain: when there is no additional security check when entering the keychain (e.g. kSecAccessControlUserPresence or similar is set), then once the device is unlocked, a key will be accessible.
References
OWASP MASVS
MSTG-AUTH-8: "Biometric authentication, if any, is not event-bound (i.e. using an API that simply returns "true" or "false"). Instead, it is based on unlocking the keychain/keystore."
MSTG-STORAGE-11: "The app enforces a minimum device-access-security policy, such as requiring the user to set a device passcode."
iOS Testing Guide - Previous
iOS Cryptographic APIs
Next - iOS Testing Guide
iOS Network APIs
Last modified 1mo ago
Copy link
Contents
Testing Local Authentication (MSTG-AUTH-8 and MSTG-STORAGE-11)
Local Authentication Framework
Using Keychain Services for Local Authentication
Static Analysis
Dynamic Analysis
Note regarding temporariness of keys in the Keychain
References
OWASP MASVS