Lock.swift

Un widget qui offre une expérience de connexion et d’inscription fluide pour vos applications iOS natives.

Ce guide de référence vous montrera comment mettre en œuvre l’interface utilisateur de Lock et vous donnera des détails sur la façon de configurer et de personnaliser Lock afin de l’utiliser comme interface utilisateur pour vos besoins d’authentification. Cependant, si vous souhaitez en apprendre davantage sur ce que vous pouvez faire avec Auth0 et Swift, notamment comment enregistrer, utiliser dans des requêtes et actualiser des jetons d’accès, obtenir des renseignements sur le profil de l’utilisateur, et plus encore, consultez le Auth0.swift SDK. Ou jetez un coup d’œil au Quickstart Swift pour suivre des exemples complets et voir les options, autant pour utiliser Lock comme interface que pour utiliser une interface personnalisée.

Consultez le dépôt Lock.swift sur GitHub.

Configuration requise

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

Installation

Cocoapods

Si vous utilisez Cocoapods, ajoutez cette ligne à votre Podfile :

pod 'Lock', '~> 2.0'

Ensuite, exécutez pod install. Pour en savoir plus sur Cocoapods, consultez la documentation officielle.

Carthage

Si vous utilisez Carthage, ajoutez la ligne suivante à votre Cartfile :

github "auth0/Lock.swift" ~> 2.0 Exécutez ensuite carthage bootstrap. Pour plus d’information sur l’utilisation de Carthage, consultez la documentation officielle.

SPM

Si vous utilisez Swift Package Manager, ouvrez l’élément de menu suivant dans Xcode :

File > Swift Packages > Add Package Dependency…

Dans la fenêtre Choose Package Repository, ajoutez cette URL :

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

Ensuite, cliquez sur Next et suivez les étapes restantes.

Pour en savoir plus sur SPM, consultez la documentation officielle.

Configuration

Intégrer votre application

Lock doit être informé lorsqu’on demande à l’application d’ouvrir une URL. Vous pouvez le faire dans le fichier AppDelegate.

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

Importation de Lock

Importez Lock partout où vous en avez besoin

import lock

Identifiants Auth0

Pour utiliser Lock, vous devez fournir votre Auth0 Client ID et votre Domaine, que vous trouverez dans l’Auth0 Dashboard, dans les paramètres de votre application.

Dans le bundle de votre application, vous pouvez ajouter un fichier plist nommé Auth0.plist contenant vos identifiants, selon le format suivant.

Mise en œuvre de Lock Classic

Lock Classic gère l’authentification au moyen de connexions Database, Social et Enterprise.

Mode conforme à OIDC

Il est fortement recommandé d’utiliser ce SDK en mode conforme à OIDC. Lorsque ce mode est activé, il oblige le SDK à utiliser le pipeline d’authentification actuel d’Auth0 et l’empêche d’accéder à des points de terminaison hérités. Par défaut, cette valeur est false

.withOptions {
    $0.oidcConformant = true
}

Pour afficher Lock, ajoutez l’extrait de code suivant dans votre UIViewController.

Lock
    .classic()
    // withConnections, withOptions, withStyle, et ainsi de suite
    .withOptions {
      $0.oidcConformant = true
      $0.scope = "openid profile"
    }
    .onAuth { credentials in
      // Sauvegardons la valeur de credentials.accessToken
    }
    .present(from: self)

Utiliser la bibliothèque Auth0.Swift pour accéder au profil utilisateur

Pour accéder aux renseignements du profil utilisateur, vous devrez utiliser la bibliothèque Auth0.Swift :

Auth0
   .authentication()
   .userInfo(withAccessToken: accessToken)
   .start { result in
       switch result {
       case .success(let profile):
           print("User Profile: \(profile)")
       case .failure(let error):
           print("Failed with \(error)")
       }
   }

Consultez la documentation de la bibliothèque Auth0.Swift pour en savoir plus sur son utilisation.

Spécifier les connexions

Lock chargera automatiquement les connexions configurées pour votre application. Si vous souhaitez modifier le comportement par défaut, vous pouvez préciser manuellement quelles connexions il doit présenter aux utilisateurs comme options d’authentification. Pour ce faire, appelez la méthode et fournissez une fonction de fermeture permettant de préciser la ou les connexions.

Ajouter une connexion de base de données :

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

Ajout de plusieurs connexions sociales :

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

Style et personnalisation

Lock offre de nombreuses options de personnalisation visuelle pour vous aider à appliquer votre propre image de marque à Lock avec withStyle. Par exemple, vous pouvez modifier la couleur principale et le texte d’en-tête de votre widget Lock :

Personnalisez le titre, le logo et la couleur principale

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

Vous pouvez consulter l’ensemble des options de style permettant de modifier l’apparence de Lock pour votre application dans le Guide de personnalisation.

Options de configuration

Il existe de nombreuses options pour configurer le comportement de Lock. Voici un exemple de Lock configuré de façon à pouvoir être fermé, à être limité aux seuls noms d’utilisateur (et non aux adresses courriel), et à n’afficher que les écrans Connexion et Réinitialiser le mot de passe.

Lock
  .classic()
  .withOptions {
    $0.closable = true
    $0.usernameStyle = [.Username]
    $0.allow = [.Login, .ResetPassword]
  }

Vous pouvez consulter l’ensemble des options de configuration du comportement qui permettent de modifier le fonctionnement de Lock pour votre application dans le guide de configuration.

Prise en charge du gestionnaire de mots de passe

Par défaut, la prise en charge de 1Password est activée pour les connexions de base de données. Pour que l’option s’affiche dans les écrans de connexion et d’inscription, l’utilisateur doit tout de même avoir installé l’application 1Password. Vous pouvez désactiver la prise en charge de 1Password à l’aide de la propriété enabled de passwordManager.

.withOptions {
    $0.passwordManager.enabled = false
}

Par défaut, appIdentifier correspondra au Bundle Identifier de l’application et displayName à son nom d’affichage. Vous pouvez les personnaliser comme suit :

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

Vous devrez ajouter les éléments suivants au fichier info.plist de votre application :

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

En savoir plus

• Lock.swift : options de personnalisation du style
• Lock.swift : options de configuration
• Lock.swift : champs personnalisés à l’inscription
• Internationalisation de Lock.swift
• Déconnexion