https://github.com/ericlewis/thotp

Time-base & HMAC-based one-time password generator for iOS, tvOS, watchOS, and macOS
https://github.com/ericlewis/thotp

cryptokit hotp ios ipados macos otp otp-generator otpauth swift swift-library swift5-1 totp tvos watchos

Last synced: 3 months ago
JSON representation

Time-base & HMAC-based one-time password generator for iOS, tvOS, watchOS, and macOS

• Host: GitHub
• URL: https://github.com/ericlewis/thotp
• Owner: ericlewis
• License: mit
• Created: 2019-09-18T21:57:21.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-01T13:04:28.000Z (8 months ago)
• Last Synced: 2024-10-16T11:52:27.676Z (4 months ago)
• Topics: cryptokit, hotp, ios, ipados, macos, otp, otp-generator, otpauth, swift, swift-library, swift5-1, totp, tvos, watchos
• Language: Swift
• Homepage:
• Size: 147 KB
• Stars: 15
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        


    

        

     



    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

    

    





    Installation

  • Usage

  • Documentation

  • License

  • Issues

  • Pull Requests



### TOTP & HOTP generator for iOS, tvOS, watchOS, and macOS

Pure Swift implementation of [time-based](https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm) and [HMAC-based](https://en.wikipedia.org/wiki/HMAC-based_One-time_Password_algorithm) one-time password generators. Heavily inspired by the [OneTimePassword](https://github.com/mattrubin/OneTimePassword) library from [@mattrubin](https://github.com/mattrubin). Protocol based design, so you won't find any subclasses here.

## Installation

`THOTP` can be installed via Swift Package Manager.

Supported platforms are iOS (13.0+), tvOS (13.0+), watchOS (6.0+), and macOS (10.15+).

### Swift Package Manager

The easiest integration is to use the built in package manager tools in Xcode 11.0+. You can also do it manually.

Add the following as a dependency to your Package.swift:

```swift

.package(url: "https://github.com/ericlewis/THOTP.git", .upToNextMajor(from: "1.0.0"))

```

After specifying `THOTP` as a dependency of the target in which you want to use it, run:

```bash

swift package update

```

## Usage

By default, this includes basic concrete types for Password & Generators. If you are interested in persistence, there are a couple of options to choose from:

- Implement `PasswordProtocol` with your own concrete type, such as `NSManagedObject`

- Use [Valet-THOTP](https://github.com/ericlewis/Valet-THOTP), which adds extensions + a new concrete type for easily persisting using [Valet](https://github.com/square/Valet)

### Basic

The simplest usage is to parse a URL. `THOTP` is compatible with [Google Authenticator's URI Scheme](https://github.com/google/google-authenticator/wiki/Key-Uri-Format).

```swift

let password = try? Password(url: URL(string: "otpauth://totp/test?secret=GEZDGNBV")!)

print(password.currentPassword) // 123321

```

## Documentation

Docs are generated with [jazzy](https://github.com/realm/jazzy) & can be found [here](https://ericlewis.github.io/THOTP/docs/). The process is currently manual, so it's possible for documentation to be out of date. Tests are a great way to see how to use this library.

## License

This library is released under the [MIT License](http://opensource.org/licenses/MIT). See [LICENSE](https://github.com/ericlewis/THOTP/blob/master/LICENSE) for details.