Plug-n-Play login system for iOS written in Swift

@initFabian I upgraded the Swift version, and to make it easier to update in the future, it is only declared at the project level. All targets will inherit from the one setting.

As noted in the previous PR, this should be tagged as a new release. No code changes were needed from Swift 4.2, so I would think this can be v2.2, but upgrading to Swift 5 could be considered a breaking change, so v3.0 is also a viable option.

@initFabian The targets were still building against Swift 4.0. I've updated them to 4.2 (which should probably be marked as release 2.1) and will make another PR for 5.0 (which can then be marked as 2.2).

Hi,

thanks for this library! Do you have any plan to implement a signup flow as well, i.e. with a separate screen and a callback similar to loginCompletionBlock?

How should I do dependency injection? Suppose I need to access an external service inside my login viewcontroller (the initial viewcontroller for loginStoryboard). The service is defined as a protocol. I could use an implicitly unwrapped optional, but how could I set it? Thank you, Luca-

Hi folks, running Cely, I get the following error on iOS 12:

error: The operation couldn’t be completed. (Cely.LocksmithError error 7.)

Im following the same example as in the docs, and im not sure what the issues is.

Hi, When trying to update by : carthage update with github "Cely/Cely" ~> 2.0.0 in Cartfile

I got this response :

A shell task (/usr/bin/env git clone --bare --quiet https://github.com/Cely/Cely.git /Users/xxx/Library/Caches/org.carthage.CarthageKit/dependencies/Cely) failed with exit code 128:
fatal: could not read Username for 'https://github.com': terminal prompts disabled

This works only with repo : github "chaione/Cely" ~> 2.0.0

How to Test:

Test .homeViewController

• go into AppDelegate.swift for the Cely Demo target
• set the following option:

.homeStoryboard: UIStoryboard(name: "Main", bundle: nil)

• run application
• VERIFY: deprecation warning appears with Fix button
• Replace option with:

.homeViewController: UIStoryboard(name: "Main", bundle: nil).instantiateViewController(withIdentifier: "SecondViewController")

• run application
• VERIFY: application builds
• put in the credentials:
  • username: asdf
  • password: asdf
• VERIFY: you are brought to the set view controller

Test .loginViewController

• set the following option:

.loginStoryboard: UIStoryboard(name: "TestStoryboard", bundle: nil)

• run application
• VERIFY: deprecation warning appears with Fix button
• Replace option with:

.loginStoryboard: UIStoryboard(name: "TestStoryboard", bundle: nil).instantiateInitialViewController()

• run application
• VERIFY: a different login view controller is displayed. the elements aren't connected to anything so the login feature wont work.

Changelog

• Restructured application using cookie-cutter framework template to handle multiple platforms which includes the addition of Cocoapods support.
• Improved test

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

CocoaPods 1.1.0+ is required to build Cely 2.0.0+.

To integrate Cely into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

pod 'Cely', '~> 2.0.0'

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Cely into your Xcode project using Carthage, specify it in your Cartfile:

github "Cely/Cely" ~> 2.0.0

Manually

If you prefer not to use either of the aforementioned dependency managers, you can integrate Cely into your project manually.

Git Submodules

• Open up Terminal, cd into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:

$ git init

• Add Cely as a git submodule by running the following command:

$ git submodule add https://github.com/ChaiOne/Cely.git
$ git submodule update --init --recursive

• Open the new Cely folder, and drag the Cely.xcodeproj into the Project Navigator of your application's Xcode project.

  It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.

• Select the Cely.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.

• Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.

• In the tab bar at the top of that window, open the "General" panel.

• Click on the + button under the "Embedded Binaries" section.

• You will see two different Cely.xcodeproj folders each with two different versions of the Cely.framework nested inside a Products folder.

  It does not matter which Products folder you choose from.

• Select the Cely.framework.

• And that's it!

The Cely.framework is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.

Embeded Binaries

• Download the latest release from https://github.com/ChaiOne/Cely/releases
• Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
• In the tab bar at the top of that window, open the "General" panel.
• Click on the + button under the "Embedded Binaries" section.
• Add the downloaded Cely.framework.
• And that's it!

In this PR:

• Migrated LocksmithError to CelyStorageError
• Migrated StorageResult to Result<T, CelyStorageError>
• Updated bundle identifier to cely-tools
• Removed some unused code

I'd still consider this PR a WIP since there are still some print statements I'd like to get rid of in this PR.

Purpose:

Add biometrics functionality.

New Cely Credentials API

Please refer to documentation docs for usage. I know I pulled the trigger a little early around the documentation site, buuuttttt I wanted to focus on the experience around documentation and have that drive the code for this release. Please give your honest opinion and API design and potential shortcomings.

Cely Documentation

This is going to be something new and entirely different so don't feel responsible for this part of the code. It uses mkdocs to generate the site. But if you are able to check out the docs and give your thoughts that would be amazing! I understand all this was made in a cave and should be viewed as a First Draft.

What did I do?

• Introduces new CelyCredentials API
• Added new file demo file CelyDemo/BiometricsLoginViewController.swift that in the Cely Demo Target that uses new CelyCredentials API
• set CelyDemo/Appdelegate.swift to point to BiometricsLoginViewController.swift for testing
• Add a button to CelyDemo/SettingsViewController.swift that logs credentials to the console
• improve encapsulation (private) around methods/variables throughout Cely
• Replace StorageResult with Swift Result
• replace CelyStorageProtocol.removeAllData() with clearStorage()
• Add class CelyKeychain
  • responsible for CRUD operations for KeychainObject (Keychain Items)
• Add class CelySecureStorage
  • responsible for creating KeychainObject and storing them with CelyKeychain
  • implements CelyStorageProtocol (.clearStorage() gets called from CelyStorage when user is logging out)
• Add class KeychainObject
  • syntactic sugar around KeychainItem. (I'm not entirely in love with how this came out around toGetMap/toLookupMap since they aren't really descriptive on what they're used for.)

Notes

When I created this PR, it was to finally get the code in front of someone else. In terms of what this PR sought out to do (add the biometrics functionality), it does just that. but as far as how we get there, that's where I have thoughts. Things such as should we allow the developer to use kSecClassGenericPassword instead of kSecClassInternetPassword or use kSecAttrAccessibleWhenUnlocked instead of kSecAttrAccessibleWhenUnlockedThisDeviceOnly. Definitely read Cely's documentation over Understanding Keychain to form an opinion on what Cely should/shouldn't do.

In all, I would say this PR is 97% done. Really the only thing I don't like is around KeychainObject, but that class is only used internally and not exposed to the user/developer. so I'm not sure if we want to give that class the green light for now and just improve it at a later time.

Lastly, this PR did a lot. I really wish it didn't, but I wanted to do one big push for v3 to get the ball rolling.

How to Test:

0. Have device with biometrics (FaceID/TouchID)
1. Pull down branch
2. Change Scheme to Cely Demo
3. Error will happen around team/bundleID. change values to allow App to run

• if you can help with find a long term solution on this, that would be awesome!

4. Log into app with the credentials username:asdf and password:asdf
5. VERIFY: App logs you in
6. go to settings page and click Get Credentials
7. VERIFY: biometrics are run on device
8. VERIFY: credentials are logged to the console.

We have targets for macOS, watchOS, tvOS that don’t build (watchOS doesn’t even make sense 🤪). I’m leaving this here so I can fix/remove as appropriate.

I am trying out Cely in a small app that I am building, but I am not using Storyboards. I use the 'old' way, of just instantiating a UIViewController and assigning it to my UIWindow.

AppDelegate.swift

self.window = UIWindow()
self.window?.rootViewController = MainViewController()
self.window?.makeKeyAndVisible()

After this I setup Cely: Cely.setup(with: window, forModel: User(), requiredProperties: [.token], withOptions: nil)

But while starting my application it crashes with the following error message: *** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: 'Could not find a storyboard named 'Main' in bundle NSBundle

Would using a custom CelyAnimator solve this (not sure?)

@initFabian I'd like to get your opinion on how to add the following Expirable protocol so I can manage tokens.

https://github.com/AndrewSB/Expirable

This will enable us see which token expired or is expiring soon. So far following your example I don't know where I am able to enable the Expirable protocol

struct AuthUser: CelyUser {
    
    enum Property: CelyProperty {
        
        case username = "username"
        case email = "email"
        case access_token = "access_token"
        case refresh_token = "refresh_token"
            
        func securely() -> Bool {
            switch self {
            case .access_token, .refresh_token:
                return true
            default:
                return false
            }
        }
        
        func persisted() -> Bool {
            switch self {
            case .access_token, .refresh_token:
                return true
            default:
                return false
            }
        }
        
        func save(_ value: Any) {
            Cely.save(value, forKey: rawValue, securely: securely(), persisted: persisted())
        }
        
        func get() -> Any? {
            return Cely.get(key: rawValue)
        }
    }
}

// MARK: - Save/Get User Properties

extension AuthUser {
    
    static func save(_ value: Any, as property: Property) {
        property.save(value)
    }
    
    static func save(_ data: [Property : Any]) {
        data.forEach { property, value in
            property.save(value)
        }
    }
    
    static func get(_ property: Property) -> Any? {
        return property.get()
    }
}