twocli

twocli is a command-line two-factor authentication (2FA) application written in Go. It allows you to manage and generate Time-based One-Time Passwords (TOTPs) for your accounts securely from the terminal. All secrets are encrypted using AES-256-GCM encryption with a user-provided master password.

Table of Contents

• Features
• Prerequisites
• Installation
• Usage
  • Add an Account
  • List Accounts
  • Generate TOTP Code
  • Update an Account
  • Delete an Account
• Security Considerations
• Examples
• Testing
• License
• Contributing
• Contact

---

Features

• Add Accounts: Securely store multiple 2FA accounts with names and secrets.
• List Accounts: View all saved account names.
• Generate TOTP Codes: Generate TOTP codes for your accounts.
• Update Accounts: Update the secret key of an existing account.
• Delete Accounts: Remove accounts you no longer need.
• Secure Encryption: All secrets are encrypted using AES-256-GCM with a master password.
• Cross-Platform: Works on Unix-like systems and Windows.

---

Prerequisites

• Go Programming Language: You need Go installed (version 1.17 or later).
  • Download and install Go from golang.org.

---

Installation

1. Clone the Repository

   git clone https://github.com/bykclk/twocli.git
   cd twocli

2. Initialize Go Modules

   go mod tidy

3. Build the Application

   go build -o twocli ./cmd/twocli

---

Usage

General Syntax:

./twocli [command] [options]

Available Commands

• add - Add a new account
• list - List all saved accounts
• code - Generate TOTP code for an account
• update - Update the secret key of an existing account
• delete - Delete an existing account

Global Options

• -h, --help - Show help information

---

Add an Account

Add a new account with a name and secret key.

Syntax:

./twocli add -name ACCOUNT_NAME -secret SECRET_KEY

Options:

• -name - The name of the account
• -secret - The base32-encoded secret key for the account

Example:

./twocli add -name GitHub -secret JBSWY3DPEHPK3PXP

---

List Accounts

List all saved accounts.

Syntax:

./twocli list

Example:

./twocli list

---

Generate TOTP Code

Generate a TOTP code for a specified account.

Syntax:

./twocli code -name ACCOUNT_NAME

Options:

• -name - The name of the account

Example:

./twocli code -name GitHub

---

Update an Account

Update the secret key of an existing account.

Syntax:

./twocli update -name ACCOUNT_NAME -secret NEW_SECRET_KEY

Options:

• -name - The name of the account
• -secret - The new base32-encoded secret key for the account

Example:

./twocli update -name GitHub -secret NEWSECRETKEY

---

Delete an Account

Delete an existing account.

Syntax:

./twocli delete -name ACCOUNT_NAME

Options:

• -name - The name of the account

Example:

./twocli delete -name GitHub

---

Security Considerations

• Master Password: A master password is required to encrypt and decrypt your account secrets. Choose a strong, memorable password.
• Password Input: When prompted for your master password, input is hidden for security.
• Encryption: Secrets are encrypted using AES-256-GCM with a key derived from your master password using PBKDF2 with SHA-256 and 100,000 iterations.
• Data Storage: Account data is stored in the data/accounts.db file with restrictive permissions (0600).
• Failed Attempts: After 3 incorrect master password attempts, the application will exit to prevent brute-force attacks.

---

Examples

Adding and Using an Account

1. Add an Account

   ./twocli add -name Gmail -secret JBSWY3DPEHPK3PXP

   • Enter your master password when prompted.

2. List Accounts

   ./twocli list

   • Enter your master password.

3. Generate TOTP Code

   ./twocli code -name Gmail

   • Enter your master password.
   • The TOTP code will be displayed.

Updating an Account’s Secret

./twocli update -name Gmail -secret NEWSECRETKEY

• Enter your master password.

Deleting an Account

./twocli delete -name Gmail

• Enter your master password.
• Confirm the deletion by typing yes when prompted.

---

Testing

The project includes unit tests for critical components.

Running Tests

go test ./...

---

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the Repository

   Click the “Fork” button at the top right of this page.

2. Clone Your Fork

   git clone https://github.com/bykclk/twocli.git

3. Create a Branch

   git checkout -b feature/your-feature-name

4. Commit Your Changes

   git commit -am 'Add new feature'

5. Push to the Branch

   git push origin feature/your-feature-name

6. Open a Pull Request

   Navigate to the original repository and click “New Pull Request”.

---

Contact

For questions or support, please open an issue on the GitHub repository.

---

Disclaimer: Use this tool responsibly. The author is not responsible for any loss of data or security breaches resulting from the use of this application.