Lock.swift

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 makes it easy to integrate SSO in your app. You won't have to worry about:

• Having a professional looking login dialog that displays well on any device.
• Finding the right icons for popular social providers.
• Solving the home realm discovery challenge with enterprise users (i.e.: asking the enterprise user the email, and redirecting to the right enterprise identity provider).
• Implementing a standard sign in protocol (OpenID Connect / OAuth2 Login)

Need help migrating from v1? Please check our Migration Guide.

Table of Contents

• Requirements
• Installation
• Usage
• Lock Classic
• Styling Lock
• Lock Passwordless
• Customization Options
• What is Auth0?
• Create a Free Auth0 Account
• Issue Reporting
• Author
• License

Requirements

• iOS 9+
• Xcode 12.x / 13.x
• Swift 4.x / 5.x

Lock.swift uses Auth0.swift 1.x.

Installation

Cocoapods

If you are using Cocoapods, add this line to your Podfile:

pod "Lock", "~> 2.24"

Then run pod install.

For more information on Cocoapods, check their official documentation.

Carthage

If you are using Carthage, add the following line to your Cartfile:

github "auth0/Lock.swift" ~> 2.24

Then run carthage bootstrap --use-xcframeworks --platform iOS.

For more information about Carthage usage, check their official documentation.

SPM

If you are using the Swift Package Manager, open the following menu item in Xcode:

File > Add Packages...

In the Search or Enter Package URL search box enter this url:

https://github.com/auth0/Lock.swift.git

Then select the dependency rule and press Add Package.

For further reference on SPM, check its official documentation.

Usage

First import Lock:

import Lock

Next in your AppDelegate.swift add the following:

func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
  return Lock.resumeAuth(url, options: options)
}

Configuration

In order to use Lock you need to provide your Auth0 Client ID and Domain.

The Auth0 Client ID & Domain can be found in your Auth0 Dashboard

Auth0.plist file

In your application bundle you can add a plist file named Auth0.plist with the following information:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
  <key>ClientId</key>
  <string>{YOUR_CLIENT_ID}</string>
  <key>Domain</key>
  <string>{YOUR_DOMAIN}</string>
</dict>
</plist>

Lock Classic

Lock Classic handles authentication using Database, Social & Enterprise connections.

OIDC Conformant Mode

It is strongly encouraged that this SDK be used in OIDC Conformant mode. When this mode is enabled, it will force the SDK to use Auth0's current authentication pipeline and will prevent it from reaching legacy endpoints. By default this is false.

.withOptions {
    $0.oidcConformant = true
}

For more information, please see the OIDC adoption guide.

To show Lock, add the following snippet in your UIViewController:

Lock
    .classic()
    .withOptions {
        $0.closable = false
        $0.oidcConformant = true
    }
    .withStyle {
      $0.title = "Welcome to my App!"
    }
    .onAuth {
      print("Obtained credentials \($0)")
    }
    .onError {
      print("Failed with \($0)")
    }
    .onCancel {
      print("User cancelled")
    }
    .present(from: self)

Important: Database Connection Authentication

Since June 2017 new Clients no longer have the Password Grant Type enabled by default. If you are using a Database Connection in Lock then you will need to enable the Password Grant Type, please follow this guide.

Specify connections

Lock will automatically load your application configuration automatically, if you wish to override this behaviour you can manually specify which of your connections to use.

Before presenting Lock you can tell it what connections it should display and use to authenticate an user. You can do that by calling the method and supply a closure that can specify the connections.

Adding a Database connection

.withConnections {
    $0.database(name: "Username-Password-Authentication", requiresUsername: true)
}

Adding Social connections

.withConnections { connections in
    connections.social(name: "facebook", style: .Facebook)
    connections.social(name: "google-oauth2", style: .Google)
}

Adding Enterprise connections

.withConnections { connections in
    connections.enterprise(name: "customAD", domains: ["domain1.com", "domain2.com"])
    connections.enterprise(name: "alternativeAD", domains: ["domain3.com"], style: .Microsoft)
}

Custom Domains

If you are using Custom Domains, you will need to set the configurationBaseURL to your Auth0 Domain so the Lock configuration can be read correctly:

.withOptions {
   $0.configurationBase = "https://<YOUR DOMAIN>.auth0.com"
}

Logging

You can easily turn on/off logging capabilities:

Lock
    .classic()
    .withOptions {
        $0.logLevel = .all
        $0.logHttpRequest = true
    }

Styling Lock

Lock provides many styling options to help you apply your own brand identity to Lock.

iPad Modal Presentation

iPad presentation is show in a modal popup, this can be disabled to use full screen as follows:

.withStyle {
  $0.modalPopup = false
}

Customize Your Header and Primary Color

.withStyle {
  $0.title = "Company LLC"
  $0.logo = UIImage(named: "company_logo")
  $0.primaryColor = UIColor(red: 0.6784, green: 0.5412, blue: 0.7333, alpha: 1.0)
}

You can explore the full range of styling options in Style.swift

Styling a Custom OAuth2 Connection

.withStyle {
  $0.oauth2["slack"] = AuthStyle(
      name: "Slack",
      color: UIColor(red: 0.4118, green: 0.8078, blue: 0.6588, alpha: 1.0),
      withImage: UIImage(named: "ic_slack")
  )
}

Lock Passwordless

Lock Passwordless handles authentication using Passwordless & Social Connections.

The Passwordless feature requires your application to have the Passwordless OTP Grant Type enabled. Check this article for more information.

To use Passwordless Authentication with Lock, you need to configure it with OIDC Conformant Mode set to true.

OIDC Conformant Mode will force Lock to use Auth0's current authentication pipeline and will prevent it from reaching legacy endpoints. By default this mode is disabled. For more information, please see the OIDC adoption guide.

To show Lock, add the following snippet in your UIViewController:

Lock
    .passwordless()
    .withOptions {
        $0.oidcConformant = true
    }
    .withStyle {
      $0.title = "Welcome to my App!"
    }
    .onAuth {
      print("Obtained credentials \($0)")
    }
    .onError {
      print("Failed with \($0)")
    }
    .onCancel {
      print("User cancelled")
    }
    .onPasswordless {
      print("Passwordless requested for \($0)")
    }
    .present(from: self)

Notes:

• Passwordless can only be used with a single connection and will prioritize the use of email connections over sms.

Passwordless method

When using Lock Passwordless the default passwordlessMethod is .code which sends the user a one time passcode to login. If you want to use Universal Links you can add the following:

.withOptions {
    $0.passwordlessMethod = .magicLink
}

Activity callback

If you are using Lock Passwordless and have specified the .magicLink option to send the user a universal link then you will need to add the following to your AppDelegate.swift:

func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
    return Lock.continueAuth(using: userActivity)
}

Adding a Passwordless connection

SMS

.withConnections {
    $0.sms(name: "sms")
}

Email

.withConnections {
    $0.email(name: "email")
}

Customization Options

Lock provides numerous options to customize the Lock experience.

Closable

Allows Lock to be dismissed by the user. By default this is false.

.withOptions {
    $0.closable = true
}

Terms of Service

By default Lock will use Auth0's Terms of Service and Privacy Policy:

.withOptions {
    $0.termsOfService = "https://mycompany.com/terms"
    $0.privacyPolicy = "https://mycompany.com/privacy"
}

Must accept Terms of Service

Database connection will require explicit acceptance of terms of service:

.withOptions {
    $0.mustAcceptTerms = true
}

Show Terms of Service

Database connection will display the Terms & Service dialog. Default is true.

.withOptions {
    $0.showTerms = true
}

Note: Terms will always be shown if the mustAcceptTerms flag has been enabled.

Logging

• logLevel: By default this is .off, Syslog logging levels are supported.
• logHttpRequest: Log Auth0.swift API requests. By default this is false
• loggerOutput: Specify output handler, by default this uses the print statement.

.withOptions {
    $0.logLevel = .all
    $0.logHttpRequest = true
    $0.loggerOutput = CleanroomLockLogger()
}

In the code above, the loggerOutput has been set to use CleanroomLogger. This can typically be achieved by implementing the loggerOutput protocol. You can of course use your favorite logger library.

class CleanroomLockLogger: LoggerOutput {
  func message(_ message: String, level: LoggerLevel, filename: String, line: Int) {
    let channel: LogChannel?
    switch level {
    case .debug:
        channel = Log.debug
    case .error:
        channel = Log.error
    case .info:
        channel = Log.info
    case .verbose:
        channel = Log.verbose
    case .warn:
        channel = Log.warning
    default:
        channel = nil
    }
    channel?.message(message, filePath: filename, fileLine: line)
  }
}

Scope

Scope used for authentication. By default is openid. It will return not only the access_token, but also an id_token which is a JSON Web Token (JWT) containing user information.

.withOptions {
  $0.scope = "openid name email picture"
}

Connection scope

Allows you to set provider scopes for oauth2/social connections with a comma separated list. By default is empty.

.withOptions {
  $0.connectionScope = ["facebook": "user_friends,email"]

Database

• allow: Which database screens will be accessible, the default is enable all screens e.g. .Login, .Signup, .ResetPassword
• initialScreen: The first screen to present to the user, the default is .login.
• usernameStyle: Specify the type of identifier the login will require. The default is either [.Username, .Email]. However it's important to note that this option is only active if you have set the requires_username flag to true in your Auth0 Dashboard

.withOptions {
  $0.allow = [.Login, .ResetPassword]
  $0.initialScreen = .login
  $0.usernameStyle = [.Username]
}

Custom signup fields

When signing up the default information requirements are the user's email and password. You can expand your data capture requirements as needed.

If you want to save the value of the attribute in the root of a user's profile, ensure you set the storage parameter to .rootAttribute. Only a subset of values can be stored this way. The list of attributes that can be added to your root profile is here. By default, every additional sign up field is stored inside the user's user_metadata object.

When signing up, your app may need to assign values to the user's profile that are not entered by the user. The hidden property of CustomTextField prevents the signup field from being shown to the user, allowing your app to assign default values to the user profile.

.withOptions {
  $0.customSignupFields = [
    CustomTextField(name: "first_name", placeholder: "First Name", storage: .rootAttribute, icon: UIImage(named: "ic_person", bundle: Lock.bundle), contentType: .givenName),
    CustomTextField(name: "last_name", placeholder: "Last Name", storage: .rootAttribute, icon: UIImage(named: "ic_person", bundle: Lock.bundle), contentType: .familyName),
    CustomTextField(name: "referral_code", placeholder: "Referral Code", defaultValue: referralCode, hidden: true)
  ]
}

Note: You must specify the icon to use with your custom text field and store it in your App's bundle.

Password manager

This functionality has been removed as of Release 2.18 due to the 1Password extension using deprecated methods, which can result in your app being rejected by the AppStore. This functionality was superseded in iOS 12 when Apple introduced the integration of password managers into login forms.

The following options are now deprecated:

.withOptions {
    $0.passwordManager.enabled = false
    $0.passwordManager.appIdentifier = "www.myapp.com"
    $0.passwordManager.displayName = "My App"
}

You may also safely remove the following entry from your app's Info.plist:

<key>LSApplicationQueriesSchemes</key>
<array>
    <string>org-appextension-feature-password-management</string>
</array>

Show password

By default a show password icon is shown in password fields to toggle visibility of the input text. You can disable this using the allowShowPassword option:

.withOptions {
    $0.allowShowPassword = false
}

Note: Show password will not be available if the Password Manager is available.

Enterprise

• enterpriseConnectionUsingActiveAuth: By default Enterprise connections will use Web Authentication. However you can specify which connections will alternatively use credential authentication and prompt for a username and password.
• activeDirectoryEmailAsUsername: When Lock request your enterprise credentials after performing Home Realm Discovery (HRD), e.g. for Active Directory, it will try to prefill the username for you. By default it will parse the email's local part and use that as the username, e.g. john.doe@auth0.com will be john.doe. If you don't want that you can turn on this flag and it will just use the email address.

.withOptions {
  $0.activeDirectoryEmailAsUsername = true
  $0.enterpriseConnectionUsingActiveAuth = ["enterprisedomain.com"]
}

What is Auth0?

Auth0 helps you to:

• Add authentication with multiple sources, either social identity providers such as Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce (amongst others), or enterprise identity systems like Windows Azure AD, Google Apps, Active Directory, ADFS, or any SAML Identity Provider.
• Add authentication through more traditional username/password databases.
• Add support for linking different user accounts with the same user.
• Support for generating signed JSON Web Tokens to call your APIs and flow the user identity securely.
• Analytics of how, when, and where users are logging in.
• Pull data from other sources and add it to the user profile through JavaScript rules.

Create a Free Auth0 Account

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

Issue Reporting

If you have found a bug or to request a feature, please raise an issue. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.