Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/RijulGulati/go-andotp

CLI program to encrypt/decrypt andOTP files
https://github.com/RijulGulati/go-andotp

Last synced: about 2 months ago
JSON representation

CLI program to encrypt/decrypt andOTP files

Host: GitHub
URL: https://github.com/RijulGulati/go-andotp
Owner: RijulGulati
License: mit
Created: 2021-05-09T16:58:51.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2023-04-02T14:07:44.000Z (about 1 year ago)
Last Synced: 2024-03-21T20:05:21.338Z (3 months ago)
Language: Go
Size: 13.7 KB
Stars: 27
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-go - go-andotp - A CLI program to encrypt/decrypt [andOTP](https://github.com/andOTP/andOTP) files. Can be used as a library as well. (Command Line / Standard CLI)
awesome-go-extra - go-andotp - 05-09T16:58:51Z|2021-06-03T19:08:16Z| (Build Automation / Standard CLI)

README

# go-andotp
CLI program to encrypt/decrypt [andOTP](https://github.com/andOTP/andOTP) files.

## Installation

Linux

Download:
* [x86_64](https://github.com/RijulGulati/go-andotp/releases/latest/download/go-andotp-linux-x86_64) Intel or AMD 64-Bit CPU
```shell
curl -L "https://github.com/RijulGulati/go-andotp/releases/latest/download/go-andotp-linux-x86_64" \
-o "go-andotp" && \
chmod +x "go-andotp"
```
* [arm64](https://github.com/RijulGulati/go-andotp/releases/latest/download/go-andotp-linux-arm64) Arm-based 64-Bit CPU (i.e. in Raspberry Pi)
```shell
curl -L "https://github.com/RijulGulati/go-andotp/releases/latest/download/go-andotp-linux-arm64" \
-o "go-andotp" && \
chmod +x "go-andotp"
```

To determine your OS version, run `getconf LONG_BIT` or `uname -m` at the command line.

macOS

Download:
* [x86_64](https://github.com/RijulGulati/go-andotp/releases/latest/download/go-andotp-macos-x86_64) Intel 64-bit
```shell
curl -L "https://github.com/RijulGulati/go-andotp/releases/latest/download/go-andotp-macos-x86_64" \
-o "go-andotp" && \
chmod +x "go-andotp"
```
* [arm64](https://github.com/RijulGulati/go-andotp/releases/latest/download/go-andotp-macos-arm64) Apple silicon 64-bit
```shell
curl -L "https://github.com/RijulGulati/go-andotp/releases/latest/download/go-andotp-macos-arm64" \
-o "go-andotp" && \
chmod +x "go-andotp"
```

To determine your OS version, run `uname -m` at the command line.

Windows

Download:
* [x86_64](https://github.com/RijulGulati/go-andotp/releases/latest/download/go-andotp-windows-x86_64.exe) Intel or AMD 64-Bit CPU
```powershell
Invoke-WebRequest -Uri "https://github.com/RijulGulati/go-andotp/releases/latest/download/go-andotp-windows-x86_64.exe" -OutFile "go-andotp.exe"
```
* [arm64](https://github.com/RijulGulati/go-andotp/releases/latest/download/go-andotp-windows-arm64.exe) Arm-based 64-Bit CPU
```powershell
Invoke-WebRequest -Uri "https://github.com/RijulGulati/go-andotp/releases/latest/download/go-andotp-windows-arm64.exe" -OutFile "go-andotp.exe"
```
To determine your OS version, run `echo %PROCESSOR_ARCHITECTURE%` at the command line.

```shell
go install github.com/grijul/go-andotp
```

## Usage
```text
Usage: go-andotp -i {-e|-d} [-o ] [-p PASSWORD]

-d Decrypt file
-e Encrypt file.
-i string
Input File
-o string
Output File. If no file is provided, output is printed to STDOUT
-p string
Encryption Password. This option can be skipped to get password prompt.
```

## Examples
- Encrypt JSON file (Password is asked after hitting ```Enter```. Password is not echoed)
```shell
go-andotp -e -i file.json -o file.json.aes
```
- Encrypt JSON file (Password is entered through CLI)
```shell
go-andotp -e -i file.json -o file.json.aes -p testpass
```
- Decrypt JSON file
```shell
go-andotp -d -i file.aes.json -o file.json
```
- Decrypt JSON file and print json to console
```shell
go-andotp -d -i file.aes.json
```

## Using go-andotp as library
go-andotp can be used as library as well. It implements ```Encrypt()``` and ```Decrypt()``` functions to encrypt/decrypt text (respectively).
It's documentation is available at: https://pkg.go.dev/github.com/grijul/go-andotp/andotp

Example usage:
```go
import "github.com/grijul/go-andotp/andotp"

func main() {
andotp.Encrypt(...)
andotp.Decrypt(...)
}
```

## Build
Compile `go-andotp` on your computer:

```shell
go build -o go-andotp main.go
```

To compile `go-andotp` for another platform please set the `GOARCH` and `GOOS` environmental variables.
Example:
```shell
GOOS=windows GOARCH=amd64 go build -o go-andotp.exe main.go
```

To compile `go-andotp` for Windows, macOS and Linux you can use the script `build.sh`:
```shell
bash build.sh
```

More help:

# License
[MIT](https://github.com/grijul/go-andotp/blob/main/LICENSE)