Skip to content

Latest commit

 

History

History
211 lines (169 loc) · 8.06 KB

README.md

File metadata and controls

211 lines (169 loc) · 8.06 KB
Raw

PasswordExtension

Version License Platform

Rewritten version of one-password-app-extension by AgileBits in Swift 4

PasswordExtension lets you give users access to their third party password manager conforming to the PasswordExtension url scheme (i.e. 1Password, LastPass) to fill in their login credentials from their vault, add credentials to their vault, and change their password in their vault for any given url.

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

  • Swift 4
  • iOS 8 and above

Installation

PasswordExtension is available through:

CocoaPods

To install it, simply add the following line to your Podfile:

pod 'PasswordExtension'

Carthage

To install it, simply add the following to your Cartfile:

github "fahlout/PasswordExtension"

Swift Package Manager

Use GitHub URL (https://github.com/fahlout/PasswordExtension) to integrate with SPM inside Xcode.

Manual Installation

Add all swift files in the 'PasswordExtension/Classes' directory to your project and you'll be ready to go.

Getting started

In order for your app to be able to fully integrate with this extension the following needs to be added to the Info.plist file in your app to allow the url scheme that password managers like 1Password and LastPass use to check if those apps are installed on the users device.

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

You're now ready to use this library to let users fill in credentials, save credentials and change passwords in their password manager vault.

Just add a button with an appropriate icon (i.e. the 1Password icon) to your apps login screen, etc. and show it based on the isAvailable function in PasswordExtension. This button should now be used to invoke the desired PasswordExtension feature.

NOTE: Not every field in PasswordExtensionLoginDetails may be supported in every password manager. PEGeneratedPasswordOptions also may or may not be supported depending on the password manager.

Example Code

Find credentials in users' vault

// Using the provided classes
PasswordExtension.shared.findLoginDetails(for: "https://test.com", viewController: self, sender: nil) { (loginDetails, error) in
    if let loginDetails = loginDetails {
        print("Title: \(loginDetails.title ?? "")")
        print("Username: \(loginDetails.username)")
        print("Password: \(loginDetails.password ?? "")")
        print("URL: \(loginDetails.urlString)")
    } else if let error = error {
        switch error.code {
        case .extensionCancelledByUser:
            print(error.localizedDescription)
        default:
            print("Error: \(error)")
        }
    }
}
// Using dictionaries
PasswordExtension.shared.findLoginDict(for: "https://test.com", viewController: self, sender: nil) { (loginDict, error) in
    if let loginDict = loginDict {
        print("Title: \(loginDict[PELogin.title.key()] as? String ?? "")")
        print("Username: \(loginDict[PELogin.username.key()] as? String ?? "")")
        print("Password: \(loginDict[PELogin.password.key()] as? String ?? "")")
        print("URL: \(loginDict[PELogin.urlString.key()] as? String ?? "")")
    } else if let error = error {
        switch error.code {
        case .extensionCancelledByUser:
            print(error.localizedDescription)
        default:
            print("Error: \(error)")
        }
    }
}

Store new credentials in users' vault

// Using the provided classes
let fields = [
    "firstname": "Tim",
    "lastname": "Tester"
]
let loginDetails = PELoginDetails(urlString: "https://test.com", username: "tester1337", password: "test1234", title: "Test App", notes: "Saved with PasswordExtension", fields: fields)
let generatedPasswordOptions = PEGeneratedPasswordOptions(minLength: 5, maxLength: 45)

PasswordExtension.shared.storeLogin(for: loginDetails, generatedPasswordOptions: generatedPasswordOptions, viewController: self, sender: nil) { (loginDetails, error) in
    if let loginDetails = loginDetails {
        print("Title: \(loginDetails.title ?? "")")
        print("Username: \(loginDetails.username)")
        print("Password: \(loginDetails.password ?? "")")
        print("URL: \(loginDetails.urlString)")
    } else if let error = error {
        print("Error: \(error)")
    }
}
// Using dictionaries
let fields = [
    "firstname": "Tim",
    "lastname": "Tester"
]

let loginDetails: [String : Any] = [
    PELogin.urlString.key(): "https://test.com",
    PELogin.username.key(): "tester1337",
    PELogin.password.key(): "test1234",
    PELogin.title.key(): "Test App",
    PELogin.fields.key(): fields
]

let generatedPasswordOptions: [String: Any] = [
    PEGeneratedPassword.minLength.key(): 5,
    PEGeneratedPassword.maxLength.key(): 45
]

PasswordExtension.shared.storeLogin(for: loginDetails, generatedPasswordOptions: generatedPasswordOptions, viewController: self, sender: nil) { (loginDict, error) in
    if let loginDict = loginDict {
        print("Title: \(loginDict[PELogin.title.key()] as? String ?? "")")
        print("Username: \(loginDict[PELogin.username.key()] as? String ?? "")")
        print("Password: \(loginDict[PELogin.password.key()] as? String ?? "")")
        print("URL: \(loginDict[PELogin.urlString.key()] as? String ?? "")")
    } else if let error = error {
        print("Error: \(error)")
    }
}

Update credentials in users' vault

// Using the provided classes
let loginDetails = PELoginDetails(urlString: "https://test.com", username: "tester1337", title: "Test App")
let generatedPasswordOptions = PEGeneratedPasswordOptions(minLength: 5, maxLength: 45)

PasswordExtension.shared.changePasswordForLogin(for: loginDetails, generatedPasswordOptions: generatedPasswordOptions, viewController: self, sender: nil) { (loginDetails, error) in
    if let loginDetails = loginDetails {
        print("Title: \(loginDetails.title ?? "")")
        print("Username: \(loginDetails.username)")
        print("Old Password: \(loginDetails.oldPassword ?? "")")
        print("Password: \(loginDetails.password ?? "")")
        print("URL: \(loginDetails.urlString)")
    } else if let error = error {
        print("Error: \(error)")
    }
}
// Using dictionaries
let loginDetails: [String : Any] = [
    PELogin.urlString.key(): "https://test.com",
    PELogin.username.key(): "tester1337",
    PELogin.title.key(): "Test App"
]

let generatedPasswordOptions: [String: Any] = [
    PEGeneratedPassword.minLength.key(): 5,
    PEGeneratedPassword.maxLength.key(): 45
]

PasswordExtension.shared.changePasswordForLogin(for: loginDetails, generatedPasswordOptions: generatedPasswordOptions, viewController: self, sender: nil) { (loginDict, error) in
    if let loginDict = loginDict {
        print("Title: \(loginDict[PELogin.title.key()] as? String ?? "")")
        print("Username: \(loginDict[PELogin.username.key()] as? String ?? "")")
        print("Old Password: \(loginDict[PELogin.oldPassword.key()] as? String ?? "")")
        print("Password: \(loginDict[PELogin.password.key()] as? String ?? "")")
        print("URL: \(loginDict[PELogin.urlString.key()] as? String ?? "")")
    } else if let error = error {
        print("Error: \(error)")
    }
}

Author

Niklas Fahl (fahlout) - LinkedIn

License

PasswordExtension is available under the MIT license. See the LICENSE file for more info.