Lightweight iOS library for local device fingerprinting
Installation (CocoaPods)
# Podfile
pod 'FingerprintJS'
Note: If you've never used CocoaPods for dependency management, check out their Using CocoaPods guide that will walk you through the setup process.
Quick Start (async/await - preferred)
import FingerprintJS
let fingerprinter = FingerprinterFactory.getInstance()
async {
// Get fingerprint for the current device
let fingerprint = await fingerprinter.getFingerprint()
// Do something awesome with the fingerprint
}
Quick Start (closures - backwards compatibility)
import FingerprintJS
let fingerprinter = FingerprinterFactory.getInstance()
fingerprinter.getFingerprint { fingerprint in
// Do something awesome with the fingerprint
}
Fingerprint vs. DeviceId
FingerprintJS provides two main methods that return different kinds of identifiers:
-
Device identifier retrieved by calling
Fingerprinter::getDeviceId()that internally uses theidentifierForVendor()method which returns a unique identifier for the current application (tied to the device).FingerprintJSfurther remembers this identifier in the keychain, making the identifier stable even between app reinstalls. -
Fingerprinter::getFingerprint()computes a device fingerprint by gathering device information (hardware, OS, device settings, etc.) and computing a hash value from available items. The fingerprint isn't currently as stable as the Device Identifier because the values might change between OS updates or when the user changes settings used to compute the previous value. Future library versions will provide an API with options to customize the stability of the fingerprint.
Configuration
Fingerprinter instance can be configured through the Configuration structure that provides options to select the fingerprint version or change the algorithm that is used to compute the individual fingerprints.
// note that this example exists only to illustrate the available options
// and that its outcome mirrors the current default configuration
let configuration = Configuration(version: .v1, algorithm: .sha256)
let fingerprinter = FingerprinterFactory.getInstance(config)
// fingerprinter uses version 1 of the fingerprint and SHA256 algorithm
Creating Custom Fingerprinting Function
The default hashing function which computes the fingerprint from the content data is SHA256. The Configuration structure offers a way to inject a custom hashing function by specifying .custom(YourCustomFingerprintFunctionInstance) in the algorithm variable:
class HitchhikersFunction: FingerprintFunction {
func fingerprint(_ data: Data) -> String {
return "42"
}
}
let fingerprintFunction = HitchhikersFunction()
let config = Configuration(version: .v1, algorithm: .custom(fingerprintFunction))
let fingerprinter = FingerprinterFactory.getInstance(config)
let fingerprint = await fingerprinter.getFingerprint() // returns "42"
Keep in mind that the change in the supplied hashing function will inevitably lead to the change of the output fingerprint.
License
This library is MIT licensed. Copyright FingerprintJS, Inc. 2022.
122 Dec 16, 2022
1.6k Dec 30, 2022
250 Jan 4, 2023
0 Jan 6, 2022
33 Sep 23, 2022
469 Dec 30, 2022
1.1k Jan 3, 2023
1.3k Dec 26, 2022
770 Dec 30, 2022
472 Dec 12, 2022
2.9k Dec 21, 2022
43 Nov 6, 2022
607 Sep 18, 2022
0 Jan 13, 2022
246 Jan 4, 2023
135 Dec 15, 2022
3.3k Dec 30, 2022