auth0 / Lock-Facebook.iOS

Lock for iOS add-on to use Facebook iOS SDK
https://auth0.com/lock
MIT License
7 stars 6 forks source link

Lock-Facebook

Build Status Version License Platform

Auth0 is an authentication broker that supports social identity providers as well as enterprise identity providers such as Active Directory, LDAP, Google Apps and Salesforce.

Lock-Facebook helps you integrate native Login with Facebook iOS SDK and Lock

Deprecation notice

This package relies on a token endpoint that is now considered deprecated. If your Auth0 client was created after Jun 8th 2017 you won't be able to use this package. This repository is left for reference purposes.

We recommend using browser-based flows to authenticate users. You can do that using the auth0.swift package, as explained in this document.

Requierements

iOS 7+

Install

The Lock-Facebook is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "Lock-Facebook", "~> 2.1"

Build issues with CocoaPods

If you add uses_frameworks! flag to your Podfile, you'll not be able to build the project with an error similar to the following:

Include of non-modular header inside framework module 'FBSDKLoginKit.FBSDKLoginConstants'

This is due to how Facebook SDK handles headers. A workaround to this issue is to add the following to your Podfile:

post_install do |installer|
    installer.pods_project.build_configurations.each { |bc|
        bc.build_settings['CLANG_ALLOW_NON_MODULAR_INCLUDES_IN_FRAMEWORK_MODULES'] = 'YES'
    }
end

Before you start using Lock-Facebook

In order to authenticate against Facebook, you'll need to register your application in Facebook Developer portal. We recommend following their quickstart for iOS.

If you already have your FacebookAppID, then in your project's Info.plist file add the following entries:

Then register a custom URL Type with the format fb<FacebookAppId>.

Here's an example of how the entries should look like in your Info.plist file:

FB plist

Usage

Just create a new instance of A0FacebookAuthenticator for the default permission public_profile

A0FacebookAuthenticator *facebook = [A0FacebookAuthenticator newAuthenticationWithDefaultPermissions];
let facebook = A0FacebookAuthenticator.newAuthenticatorWithDefaultPermissions()

and register it with your instance of A0Lock

A0Lock *lock = //Get your A0Lock instance
[lock registerAuthenticators:@[facebook]];
let lock:A0Lock = //Get your A0Lock instance
lock.registerAuthenticators([facebook])

A good place to create and register A0FacebookAuthenticator is the AppDelegateclass.

Specify additional Read permissions

A0FacebookAuthenticator *facebook = [A0FacebookAuthenticator newAuthenticatorWithPermissions:@[@"public_profile", @"email"]];
let facebook = A0FacebookAuthenticator.newAuthenticatorWithPermissions(["public_profile", "email"])

Custom Facebook connection

A0FacebookAuthenticator *facebook = [A0FacebookAuthenticator newAuthenticatorWithDefaultPermissionsForConnectionName:@"custom-connection-name"];
let facebook = A0FacebookAuthenticator.newAuthenticatorWithDefaultPermissionsForConnectionName("custom-connection-name")

Please check CocoaDocs for more information about Lock-Facebook API

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

What is Auth0?

Auth0 helps you to:

Create a free account in Auth0

  1. Go to Auth0 and click Sign Up.
  2. Use Google, GitHub or Microsoft Account to login.

Author

Auth0

License

Lock-Facebook is available under the MIT license. See the LICENSE file for more info.