Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/auth0/lock.swift
A Swift & iOS framework to authenticate using Auth0 and with a Native Look & Feel
https://github.com/auth0/lock.swift
auth0 authentication dx-sdk ios jwt lock oauth2 social-authentication swift
Last synced: about 2 hours ago
JSON representation
A Swift & iOS framework to authenticate using Auth0 and with a Native Look & Feel
- Host: GitHub
- URL: https://github.com/auth0/lock.swift
- Owner: auth0
- License: mit
- Created: 2013-09-07T02:58:43.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T15:03:24.000Z (2 months ago)
- Last Synced: 2024-09-21T01:32:17.552Z (4 days ago)
- Topics: auth0, authentication, dx-sdk, ios, jwt, lock, oauth2, social-authentication, swift
- Language: Swift
- Homepage: https://auth0.com/lock
- Size: 11.7 MB
- Stars: 261
- Watchers: 57
- Forks: 114
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://circleci.com/gh/auth0/Lock.swift/tree/master)
[](https://codecov.io/github/auth0/Lock.swift)
📚 [**Documentation**](#documentation) • 🚀 [**Getting Started**](#getting-started) • 💬 [**Feedback**](#feedback)
Migrating from v1? Check the [Migration Guide](MIGRATION.md).
## Documentation
- [**Examples**](EXAMPLES.md) - explains how to use Lock.swift.
- [**Auth0 Documentation**](https://auth0.com/docs) - explore our docs site and learn more about Auth0.
## Getting Started
### Requirements
- iOS 9+
- Xcode 13.x / 14.x
- Swift 4.x / 5.x
**Lock.swift uses Auth0.swift 1.x**.
### Installation
#### Cocoapods
Add the following line to your `Podfile`:
```ruby
pod "Lock", "~> 2.24"
```
Then, run `pod install`.
#### Carthage
Add the following line to your `Cartfile`:
```ruby
github "auth0/Lock.swift" ~> 2.24
```
Then, run `carthage bootstrap --use-xcframeworks --platform iOS`.
#### 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:
```text
https://github.com/auth0/Lock.swift
```
Then, select the dependency rule and press **Add Package**.
### Configure the SDK
Head to the [Auth0 Dashboard](https://manage.auth0.com/#/applications/) and create a new **Native** application.
Lock.swift needs the **Client ID** and **Domain** of the Auth0 application to communicate with Auth0. You can find these details in the settings page of your Auth0 application. If you are using a [custom domain](https://auth0.com/docs/brand-and-customize/custom-domains), use the value of your custom domain instead of the value from the settings page.
#### Configure Client ID and Domain with a plist
Create a `plist` file named `Auth0.plist` in your app bundle with the following content:
```xml
ClientId
YOUR_AUTH0_CLIENT_ID
Domain
YOUR_AUTH0_DOMAIN
```
#### Configure Client ID and Domain programmatically
For Classic Lock
```swift
Lock
.classic(clientId: "YOUR_AUTH0_CLIENT_ID", domain: "YOUR_AUTH0_DOMAIN")
// ...
```
For Passwordless Lock
```swift
Lock
.passwordless(clientId: "YOUR_AUTH0_CLIENT_ID", domain: "YOUR_AUTH0_DOMAIN")
// ...
```
### Configure your app
Make sure Lock.swift can receive callback URLs.
Using the UIKit app lifecycle
```swift
// AppDelegate.swift
import Lock
// ...
func application(_ app: UIApplication,
open url: URL,
options: [UIApplication.OpenURLOptionsKey: Any]) -> Bool {
return Lock.resumeAuth(url, options: options)
}
```
Using the UIKit app lifecycle with Scenes
```swift
// SceneDelegate.swift
import Lock
// ...
func scene(_ scene: UIScene, openURLContexts URLContexts: Set) {
guard let url = URLContexts.first?.url else { return }
Lock.resumeAuth(url, options: [:])
}
```
### Next steps
**Learn how to use Lock.swift in [Examples ↗](EXAMPLES.md)**
- [**Lock Classic**](https://github.com/auth0/Lock.swift/blob/master/EXAMPLES.md#lock-classic) - handles authentication using Database, Social, and Enterprise connections.
- [**Lock Passwordless**](https://github.com/auth0/Lock.swift/blob/master/EXAMPLES.md#lock-passwordless) - handles authentication using Passwordless and Social connections.
## Feedback
### Contributing
We appreciate feedback and contribution to this repo! Before you get started, please see the following:
- [Auth0's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md)
- [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md)
- [Lock.swift's contribution guide](CONTRIBUTING.md)
### Raise an issue
To provide feedback or report a bug, please [raise an issue on our issue tracker](https://github.com/auth0/Lock.swift/issues).
### Vulnerability reporting
Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues.
---
Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?
This project is licensed under the MIT license. See the LICENSE file for more info.