Swiftpack.co - Package - IBM-Swift/Kitura-CredentialsFacebook

Kitura

Docs Build Status - Master macOS Linux Apache 2 Slack Status

Kitura-CredentialsFacebook

Plugins for the Credentials framework that authenticate using Facebook

Summary

Plugins for Kitura-Credentials framework that authenticate using the Facebook web login with OAuth and a Facebook OAuth token that was acquired by a mobile app or other client of the Kitura based backend.

Table of Contents

Swift version

The latest version of Kitura-CredentialsFacebook requires Swift 4.0 or newer. You can download this version of the Swift binaries by following this link. Compatibility with other Swift versions is not guaranteed.

Example of Facebook web login

A complete sample can be found in Kitura-Credentials-Sample.

First set up the session:

import KituraSession

router.all(middleware: Session(secret: "Very very secret..."))

Create an instance of CredentialsFacebook plugin and register it with Credentials framework:

import Credentials
import CredentialsFacebook

let credentials = Credentials()
let fbCredentials = CredentialsFacebook(clientId: fbClientId,
                                        clientSecret: fbClientSecret,
                                        callbackUrl: serverUrl + "/login/facebook/callback",
                                        options: options)
credentials.register(fbCredentials)

Where:

  • fbClientId is the App ID of your app in the Facebook Developer dashboard
  • fbClientSecret is the App Secret of your app in the Facebook Developer dashboard
  • options is an optional dictionary ([String:Any]) of Facebook authentication options whose keys are listed in CredentialsFacebookOptions.

Note: The callbackUrl parameter above is used to tell the Facebook web login page where the user's browser should be redirected when the login is successful. It should be a URL handled by the server you are writing. Specify where to redirect non-authenticated requests:

credentials.options["failureRedirect"] = "/login/facebook"

Connect credentials middleware to requests to /private:

router.all("/private", middleware: credentials)
router.get("/private/data", handler:
    { request, response, next in
        ...  
        next()
})

And call authenticate to login with Facebook and to handle the redirect (callback) from the Facebook login web page after a successful login:

router.get("/login/facebook",
           handler: credentials.authenticate(fbCredentials.name))

router.get("/login/facebook/callback",
           handler: credentials.authenticate(fbCredentials.name))

Example of authentication with Facebook OAuth token

This example shows how to use CredentialsFacebookToken plugin to authenticate post requests, it shows both the server side and the client side of the request involved.

Server side

First create an instance of Credentials and an instance of CredentialsFacebookToken plugin:

import Credentials
import CredentialsFacebook

let credentials = Credentials()
let fbCredentials = CredentialsFacebookToken(options: options)

Where:

  • options is an optional dictionary ([String:Any]) of Facebook authentication options whose keys are listed in CredentialsFacebookOptions.

Now register the plugin:

credentials.register(fbCredentials)

Connect credentials middleware to post requests:

router.post("/collection/:new", middleware: credentials)

If the authentication is successful, request.userProfile will contain user profile information received from Facebook:

router.post("/collection/:new") {request, response, next in
  ...
  let profile = request.userProfile
  let userId = profile.id
  let userName = profile.displayName
  ...
  next()
}

Client side

The client needs to put Facebook access token in request's access_token HTTP header field, and "FacebookToken" in X-token-type field:

let urlRequest = NSMutableURLRequest(URL: NSURL(string: "http://\(serverUrl)/collection/\(name)"))
urlRequest.HTTPMethod = "POST"
urlRequest.HTTPBody = ...

urlRequest.addValue(FBSDKAccessToken.currentAccessToken().tokenString, forHTTPHeaderField: "access_token")
urlRequest.addValue("FacebookToken", forHTTPHeaderField: "X-token-type")            

Alamofire.request(urlRequest).responseJSON {response in
  ...
}

License

This library is licensed under Apache 2.0. Full license text is available in LICENSE.

Github

link
Stars: 8
Help us keep the lights on

Used By

Total:

Releases

2.2.3 - Jun 21, 2018

Type-Safe Facebook Tokens:

  • fix: Make appID optional and allow OAuth appID verification to be skipped (#45)
  • Define cacheSize parameter to allow TypeSafeFacebookToken cache size to be limited (#44)

2.2.0 - Jun 12, 2018

  • feat: Type-Safe Facebook Token Credentials using TypeSafeMiddleware (#41)

2.1.0 - Jan 27, 2018

What's New

  • Update dependencies
    • Kitura-Credentials to 2.1.x
    • Remove SwiftyJSON