Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nhatthm/go-otp
Manage and generate one-time passwords
https://github.com/nhatthm/go-otp
go go-keyring golang keychain otp otp-keychain otp-keyring totp
Last synced: 18 days ago
JSON representation
Manage and generate one-time passwords
- Host: GitHub
- URL: https://github.com/nhatthm/go-otp
- Owner: nhatthm
- License: mit
- Created: 2024-02-22T07:19:59.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-08-30T07:19:12.000Z (3 months ago)
- Last Synced: 2024-10-09T10:20:42.521Z (about 1 month ago)
- Topics: go, go-keyring, golang, keychain, otp, otp-keychain, otp-keyring, totp
- Language: Go
- Homepage:
- Size: 36.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OTP
[](https://github.com/nhatthm/go-otp/releases/latest)
[](https://github.com/nhatthm/go-otp/actions/workflows/test.yaml)
[](https://codecov.io/gh/nhatthm/go-otp)
[](https://goreportcard.com/report/go.nhat.io/otp)
[](https://pkg.go.dev/go.nhat.io/otp)
[](https://www.paypal.com/donate/?hosted_button_id=PJZSGJN57TDJY)
Manage and generate one-time passwords.
## Prerequisites
- `Go >= 1.22`
### Keyring (Optional)
Support **OS X**, **Linux/BSD (dbus)** and **Windows**.
#### OS X
The OS X implementation depends on the `/usr/bin/security` binary for
interfacing with the OS X keychain. It should be available by default.
#### Linux and *BSD
The Linux and *BSD implementation depends on the [Secret Service][SecretService] dbus
interface, which is provided by [GNOME Keyring](https://wiki.gnome.org/Projects/GnomeKeyring).
It's expected that the default collection `login` exists in the keyring, because
it's the default in most distros. If it doesn't exist, you can create it through the
keyring frontend program [Seahorse](https://wiki.gnome.org/Apps/Seahorse):
* Open `seahorse`
* Go to **File > New > Password Keyring**
* Click **Continue**
* When asked for a name, use: **login**
## Install
```bash
go get go.nhat.io/otp
```
## Usage
Example 1: Generate a new TOTP using a provided secret.
```go
package main
import (
"context"
"go.nhat.io/otp"
)
func do(ctx context.Context) {
result, err := otp.GenerateTOTP(ctx, otp.TOTPSecret("NBSWY3DP"))
if err != nil {
// Handle error.
}
// Use the result.
}
```
Example 2: Generate a new TOTP using a secret that persisted in keychain.
```go
package main
import (
"context"
"go.nhat.io/otp"
"go.nhat.io/otp/keyring"
)
func do(ctx context.Context) {
result, err := otp.GenerateTOTP(ctx, keyring.TOTPSecretFromKeyring("[email protected]"))
if err != nil {
// Handle error.
}
// Use the result.
}
```
## Donation
If this project help you reduce time to develop, you can give me a cup of coffee :)
### Paypal donation
[](https://www.paypal.com/donate/?hosted_button_id=PJZSGJN57TDJY)
or scan this
[SecretService]: https://specifications.freedesktop.org/secret-service/latest/