fabiocaccamo/fcuuid

:iphone: :id: iOS UUID / Universally Unique Identifiers library as alternative to UDID and identifierForVendor.

FCUUID

iOS UUID library as alternative to the old good UDID and identifierForVendor. This library provides the simplest API to obtain universally unique identifiers with different levels of persistence.

It's possible to retrieve the UUIDs created for all devices of the same user, in this way with a little bit of server-side help it's possible manage guest accounts across multiple devices easily.

Requirements & dependencies

• iOS >= 5.0
• ARC enabled
• Key-value storage enabled (target / Capabilities / iCloud / Key-value storage)
• Security.framework
• UICKeyChainStore
• (optional) - Key-value storage enabled -> Target / Capabilities / iCloud / Key-value storage enabled if you want to share uuidsOfUserDevices values across multiple devices using the same iCloud account.
• (optional) - KeyChain sharing enabled (entitlements and provisioning profile) if you need to share the same uuidForDevice / uuidsOfUserDevices values across multiple apps with the same bundle seed.

Installation

CocoaPods:

pod 'FCUUID'

Swift Package Manager:

1. File > Swift Packages > Add Package Dependency
2. Add https://github.com/fabiocaccamo/FCUUID
3. Select "Up to Next Major" with "1.0.0"

Carthage:

github "fabiocaccamo/FCUUID"

Manual install:

• Copy FCUUID folder to your project.
• Manual install UICKeyChainStore

Optional setup:

It is recommended to do the setup in applicationDidFinishLaunchingWithOptions method.

• Add an observer to the FCUUIDsOfUserDevicesDidChangeNotification to be notified about uuids of user devices changes.
• If necessary, migrate from a previously used UUID or UDID using one of the migrations methods listed in the API section (it's recommended to do migration before calling uuidForDevice or uuidsForUserDevices methods). Keep in mind that migration works only if the existing value is a valid uuid and uuidForDevice has not been created yet.
• Call any class method to enforce iCloud sync.

API

Get different UUIDs (each one with its own persistency level)

//changes each time (no persistent)
+(NSString *)uuid;

//changes each time (no persistent), but allows to keep in memory more temporary uuids
+(NSString *)uuidForKey:(id<NSCopying>)key;

//changes each time the app gets launched (persistent to session)
+(NSString *)uuidForSession;

//changes each time the app gets installed (persistent to installation)
+(NSString *)uuidForInstallation;

//changes each time all the apps of the same vendor are uninstalled (this works exactly as identifierForVendor)
+(NSString *)uuidForVendor;

//changes only on system reset, this is the best replacement to the good old udid (persistent to device)
+(NSString *)uuidForDevice;
//or
#import "UIDevice+FCUUID.h"
[[UIDevice currentDevice] uuid];

Get the list of UUIDs of user devices

//returns the list of all uuidForDevice of the same user, in this way it's possible manage guest accounts across multiple devices easily
+(NSArray *)uuidsOfUserDevices;

Migrate from a previously stored UUID / UDID Before migrating an existing value it's recommended to debug it by simply passing commitMigration:NO and logging the returned value. When you will be ready for committing the migration, use commitMigration:YES. After the migration, any future call to uuidForDevice will return the migrated value.

//these methods search for an existing UUID / UDID stored in the KeyChain or in UserDefaults for the given key / service / access-group
+(NSString *)uuidForDeviceMigratingValue:(NSString *)value commitMigration:(BOOL)commitMigration;
+(NSString *)uuidForDeviceMigratingValueForKey:(NSString *)key commitMigration:(BOOL)commitMigration;
+(NSString *)uuidForDeviceMigratingValueForKey:(NSString *)key service:(NSString *)service commitMigration:(BOOL)commitMigration;
+(NSString *)uuidForDeviceMigratingValueForKey:(NSString *)key service:(NSString *)service accessGroup:(NSString *)accessGroup commitMigration:(BOOL)commitMigration;

Check if value is a valid UUID

+(BOOL)uuidValueIsValid:(NSString *)uuidValue;

Persistence

• √ yes
• - no
• * read notes below

PERSISTS	App memory	App relaunch	Reset Advertising Identifier	App reinstall	System reboot	System upgrade	System reset
uuid	-	-	-	-	-	-	-
uuidForKey:key	√	-	-	-	-	-	-
uuidForSession	√	-	-	-	-	-	-
uuidForInstallation	√	√	√	-	√	-	-
uuidForVendor	√	√	-	√*	√	-	-
uuidForDevice	√	√	√	√	√	√	√**

*(persists only if the user have not uninstalled all apps of the same vendor)

**(persists only if the user restores a device backup which includes also keychain's data)

FAQ

How can I share the device uuid between two apps?

You must have KeyChain sharing enabled (entitlements and provisioning profile) and your apps identifiers must have the same bundle seed.

What happens if I call uuidForDevice on 2 different devices using same iCloud account and iCloud Keychain?

You will obtain 2 different uuid(s), and if you call uuidsOfUserDevices you will obtain a list containing the uuids of both devices.

When I reboot / upgrade / reset my device system, will device uuid change?

Please check the persistence table above.

Support development

License

Released under MIT License.

fcuuid's Issues

How can we find blow in Xcode7?

Key-value storage enabled (target / Capabilities / iCloud / Key-value storage)

iOS 10.3 deletes keychain items when an app is deleted.

https://twitter.com/ericshapiro/status/833685944477818882

Can I continue use this on iOS 14.5？

whether this library is limited on iOS 14.5?

thanks !

duplicated uuidForDevice when restoring from iCloud

Hey @fabiocaccamo, I'm having an issue when restoring a device using iCloud.

So, we are using uuidForDevice to have a unique id per user per device, but we are facing some issues when people are cloning their devices and as the uuidForDevice is the same (they do a full backup with encrypted data and everything), then for our system, the "new" app is the same user/same device.

Is there any chance to prevent this behavior? we might have users paying just for one device when they could be using several ones.

Thanks in advance!

Add `uuidForWiFi` method.

Transfer app to another account

Does it possible to keep device id when i transfer app to another developer account?

Same device, different signature,got different id?

Same device, different signature,got different id?
[FCUUID uuidForDevice]

Carthage support ?

Hi Team,

First, thanks for the work!

Would you consider an update if I do a PR with Carthage support?

Cheers,
Vincent

Same ID ,two devices

Why is the ID generated by the two devices the same?

uuidForDevice

When i want to get uuid after the system is reinstalled, i must log in to iCloud ?

What if user doesn't use iCloud?

Hi, I find your library is perfect to accomplish my client's app requirements and identify users. I'd need to use the uuidForDevice method to identify the user device. However I have a few questions:

-As I understand your library, it relies in NSUbiquitousKeyValueStore to persist across installations but, what happens if the user is logged out or even never created a iCloud account? This app is meant to be used mostly by old people so this can be an usual scenario. If this is the case, there's nothing to do, Am I right? Or there is any kind of automatically generated iCloud id created on iPhone activation?

-Can you identify just the current device instead of every user devices?

Thank you very much

Ricardo Mantero

uuidForInstallation persists after reinstall

Not sure if I'm getting it right but based on the persistence table, the uuidForInstallation is expected to be removed when the app is uninstalled. However, that's not the case (tested on iOS 9 and 10). Probably because of the following line:

_uuidForInstallation = [self _getOrCreateValueForKey:_uuidForInstallationKey defaultValue:nil userDefaults:YES keychain:YES service:nil accessGroup:nil synchronizable:NO];

I believe keychain argument should be NO here.

ios11 iphone8

ios11 will release , new device will come

_uuidForDevice starts to return the same UUID for different devices (issue probably started around iOS 16.6.1)

Hi,

we're currently seeing the case where 2 different iPads, which use the same apple ID would generate the same UUID, which is obviously not what one wants.

We don't know for sure, but it seems it all started with around iOS ~16.6.1.

Is anybody else seeing this, or even knows a fix for it?

Thanks a lot!

Upvote & Fund

• We're using Polar.sh so you can upvote and help fund this issue.
• We receive the funding once the issue is completed & confirmed by you.
• Thank you in advance for helping prioritize & fund our backlog.

shared uuid between two app.

how to set the "Keychain Access Groups"?

Will uuidForDevice reset when upgrade system?

At these conditions:

1. 9.0 -> 9.1 (within 9.x)
2. 9.0 -> 10.0

iCloud Keychain Syn

What Happens if iCloud is Sync Keychain and try to get device ID on 2 devices with same iCloud account.

How can I share the same UUID between two app ?

Use with Swift project?

I have Swift project and added FCUUID throw pods. And now I don't now how to use it. Import can not find FCUUID framework. Please can you write/describe fully FAQ integrating into Swift project

Crashes on iOS15, when FCUUID creating instance of NSUbiquitousKeyValueStore

same bundleid ，same device， different signature certificates，diffent id?

same ID，one iphone ，two UDID

I use FCUUID as NSString *deviceUUID = [FCUUID uuidForDevice];，but` same ID，one iphone ，two UDID，log is NSUbiquitousKeyValueStore error: com.xxx.xxx has no valid com.apple.developer.ubiquity-kvstore-identifier entitlement，can you help me?

同一个设备登录多个appid,同步了keychain信息的话

同一个设备登录多个appid,同步了keychain信息的话，会导致获取的uuid发生变化吗？会被新的appid中的keychain信息覆盖掉？

Upvote & Fund

• We're using Polar.sh so you can upvote and help fund this issue.
• We receive the funding once the issue is completed & confirmed by you.
• Thank you in advance for helping prioritize & fund our backlog.

Will there be a fee?

two devices ,two bundleIDs ,two apps

Will two different apps in two different devices generate the same id?
ps: Key-value storage disabled ，two different bundle IDs

Crash on uuid for device

"uuidForDeviceInMemory" is nil and calling "isEqualToString" on it causing crash.

line number in code

EDIT:

So here the scenario to generate
Use the UUIDForDevice, and then delete the app and reinstall it again,

IOS7 support

Before using i want to ensure does this plugin support ios7 and ios8. what it will return as UUID ? is it macid?

Same device id for same iCloud account

• I need unique id for my project so I have used this framework but then I realise it returns same user device id for same iCloud account

Will it change, when I upgrade my device system?

When I upgrade my device system, will uuid change?