https://github.com/vpksoft/gauth-decode

A NPM package to decode Google Authenticator export data
https://github.com/vpksoft/gauth-decode

2fa decoder extractor google-authentication javascript nodejs npm-package totp typescript

Last synced: 19 days ago
JSON representation

A NPM package to decode Google Authenticator export data

• Host: GitHub
• URL: https://github.com/vpksoft/gauth-decode
• Owner: VPKSoft
• License: mit
• Created: 2023-10-01T11:56:47.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-29T13:25:39.000Z (4 months ago)
• Last Synced: 2024-08-05T09:21:51.119Z (3 months ago)
• Topics: 2fa, decoder, extractor, google-authentication, javascript, nodejs, npm-package, totp, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/gauth-decode
• Size: 1.95 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gauth-decode

A NPM package to decode Google Authenticator export data

[![npm](https://img.shields.io/npm/v/gauth-decode)](https://www.npmjs.com/package/gauth-decode)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FVPKSoft%2Fgauth-decode.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FVPKSoft%2Fgauth-decode?ref=badge_shield)

## Usage

```typescript

import { decodeMigrationUri } from "gauth-decode";

void decodeMigrationUri("otpauth-migration://offline?data=Ch8KBdFBKZJTEgpUZXN0IFRva2VuGgQyRkFTIAEoATACEAEYASAAKIji6ej7%2F%2F%2F%2F%2FwE%3D").then(result = console.log(result));

```

output:

```javascript

[

    {

        algorithm: "ALGO_SHA1",

        digits: 1,

        issuer: "2FAS",

        name: "Test Token",

        secret: "0UEpklM=",

        secretBase32: "2FASTEST",

        type: "OTP_TOTP"

    }

]

```

## Sample data

A sample [TOTP](https://en.wikipedia.org/wiki/Time-based_one-time_password) QR code from [2FAS](https://2fas.com/check-token/):

![image](https://github.com/VPKSoft/gauth-decode/assets/40712699/54a05400-0284-46d0-828e-cbd902b12b85)

Contained URI data: `otpauth://totp/Test%20Token?secret=2FASTEST&issuer=2FAS`

The same sample data exported from Google authenticator:

![image](https://github.com/VPKSoft/gauth-decode/assets/40712699/2aa815fc-5578-4c28-abb4-26d1f5b416d1)

Contained URI data: `otpauth-migration://offline?data=Ch8KBdFBKZJTEgpUZXN0IFRva2VuGgQyRkFTIAEoATACEAEYASAAKIji6ej7%2F%2F%2F%2F%2FwE%3D` and this can be decoded using this [package](#gauth-decode).

## Thanks to

* [google-authenticator-exporter](https://github.com/krissrex/google-authenticator-exporter) project to which the entire code is based upon.

* [TypeScript NPM Package Publishing: A Beginner’s Guide](https://pauloe-me.medium.com/typescript-npm-package-publishing-a-beginners-guide-40b95908e69c)

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FVPKSoft%2Fgauth-decode.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FVPKSoft%2Fgauth-decode?ref=badge_large)