Close Menu

ohmyauth

Welcome to the documentation for OhMyAuth, a powerful authentication library for iOS and macOS developers. This comprehensive guide will help you integrate OhMyAuth into your projects and understand its features and capabilities.

Installation

To get started with OhMyAuth, you need to follow these simple steps:

  1. Ensure that you have the latest version of Xcode installed on your machine.
  2. Open your project in Xcode.
  3. Add OhMyAuth as a dependency to your project using one of the following methods:
    • CocoaPods: Add the following line to your Podfile: pod 'OhMyAuth'. Then run pod install to install the library.
    • Carthage: Add the following line to your Cartfile: github "ohmyauth/ohmyauth". Then run carthage update to fetch and build the library.
    • Manual: Download the latest OhMyAuth framework from the official GitHub repository (link) and manually add it to your project.
  4. Start integrating OhMyAuth into your app by following the usage instructions in the next sections.

Usage

Basic Authentication

OhMyAuth provides a straightforward way to authenticate users using basic authentication.

  1. Import the OhMyAuth framework into your class: import OhMyAuth.
  2. Create an instance of the Authenticator class.
  3. Set the username and password properties of the Authenticator instance.
  4. Call the authenticate method on the Authenticator instance.
  5. Handle the authentication result using the provided closure.

OAuth2 Authentication

If you prefer using OAuth2 for authentication, OhMyAuth has you covered.

  1. Import the OhMyAuth framework into your class: import OhMyAuth.
  2. Create an instance of the OAuth2Authenticator class.
  3. Configure the required OAuth2 parameters such as clientId, clientSecret, and redirectURI.
  4. Call the authorize method on the OAuth2Authenticator instance.
  5. Handle the authorization result using the provided closure.

Additional Features

Keychain Integration

OhMyAuth includes built-in keychain integration, allowing you to securely store user credentials and tokens.

  1. Create an instance of the KeychainManager class.
  2. Use the provided methods to store and retrieve data securely in the keychain.

JWT Support

OhMyAuth supports JSON Web Tokens (JWT) for enhanced security and flexibility.

  1. Use the JWTEncoder and JWTDecoder classes to generate and verify JWTs respectively.
  2. Configure the required JWT parameters such as algorithm and secret.
  3. Encode and sign data using the encode method.
  4. Verify and decode JWTs using the verify method.

Conclusion

With OhMyAuth, you have a powerful and versatile authentication library at your disposal. It simplifies the authentication process and provides robust security features.

Refer to the detailed API documentation for more information about OhMyAuth’s classes, methods, and properties.