Giter Club home page Giter Club logo

ft_otp's Introduction

๐Ÿ” TOTP

๐Ÿ“„ Overview

This project is a simple command-line tool created as a school project using Rust. ๐ŸŽ“ It's designed to generate Time-based One-Time Passwords (TOTP) by encrypting a key and generating a QR code for TOTP app registration. ๐Ÿ•’

โœจ Features

  • Encrypt Key: ๐Ÿ”’ Securely encrypts a provided hex key and saves it for TOTP generation.
  • Generate QR Code: ๐Ÿ“ฑ Creates a QR code to easily add the encrypted key to a TOTP app.
  • Generate TOTP: ๐Ÿ—๏ธ Produces a TOTP code using the encrypted key and current time.

๐Ÿ“‹ Requirements

  • Rust Programming Language ๐Ÿฆ€

๐Ÿš€ Installation

To set up this project, follow these steps:

git clone <repository-url>
cd ft_otp
cargo build --release

๐Ÿ› ๏ธ Usage

Execute the program with options to encrypt a key, generate a QR code, or produce a TOTP code:

./target/release/ft_otp [OPTIONS]

Options

  • -g, --generate <path>: ๐Ÿ” Encrypt and save a hex key from a specified path.
  • -q, --qrcode <file>: ๐Ÿ–ผ๏ธ Specify the output file for the QR code (default qr.png).
  • -k, --key <path>: ๐Ÿ—๏ธ Use an encrypted key file to generate the TOTP code (default ft_otp.key).

๐Ÿ“ Examples

  • To encrypt a key and generate a QR code:
    ./target/release/ft_otp --generate your_key_path --qrcode your_qr_code.png
    
  • To generate a TOTP code:
    ./target/release/ft_otp --key your_encrypted_key_file
    

ft_otp's People

Contributors

hboissel avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.