filecrypt

README

filecrypt

A super easy to use file encryption utility written in golang

What's the difference

• Speed
• Simple
• Works on all operating systems

How to use

Windows

1. Download the latest release from here
2. Create a folder named "filecrypt" in any drive
3. Move the downloaded executable(.exe) to the folder created in step 2
4. Add the path of the created folder created in step 2 into windows path variable
5. Open the command prompt and enter filecrypt --help for detailed info about using flags

flags

• --force - Force write even if a file exists with that name (overwrite) DESTRUCTIVE
• --location - The location of the file to encrypt/decrypt(determined by the mode flag)
• --mode - FileCrypt mode (encrypt/decrypt These can be replaced with their first letters) Example: filecrypt --mode=e --location="super secret file.txt" --password="test"
• --password - Password to be used while encrypting/decrypting

Q&A

How can I help?

• Staring this project on github
• Creating issues
• Contributing with code or documentation
• Sharing this project with your friends

What is a .fcef file

fcef (File. Crypt. Encrypted. File) is an encrypted file that is generated by FileCrypt, If you know the password that it was encrypted with it can be decrypted with FileCrypt using the --mode=dor --mode=decrypt flag.

How is FileCrypt so small

Because Filecrypt

• Only uses the standard library
• Has no unwanted code
• Is built with -ldflags "-s -w" flag
• Executable is compressed with upx (Only extra small binaries)

Documentation

Index

• type App
  • func (a *App) Decrypt(fileLocation string, password Passphrase) (string, error)
  • func (a *App) Encrypt(fileLocation string, password Passphrase) (string, error)
• type Passphrase
  • func (p Passphrase) String() string

Types

type App

type App struct {
	// FileCryptExtension is the file extension of encrypted files.
	FileCryptExtension string
	// Overwrite defines whether or not to overwrite existing files.
	Overwrite bool
}

App contains the actual application logic.

func (*App) Decrypt

func (a *App) Decrypt(fileLocation string, password Passphrase) (string, error)

Decrypt decrypts the given file and returns the path to an unencrypted file.

func (*App) Encrypt

func (a *App) Encrypt(fileLocation string, password Passphrase) (string, error)

Encrypt encrypts the given file and returns the path the an encrypted file.

type Passphrase

type Passphrase string

Passphrase is a password.

func (Passphrase) String

func (p Passphrase) String() string

String returns the Passphrase as a string.