filecrypt

package module

v1.1.0 Latest Latest Go to latest Published: Dec 3, 2020 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/flew-software/filecrypt

Links

Open Source Insights

README ¶

filecrypt

GitHub repo size
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

Download the latest release from here
Create a folder named "filecrypt" in any drive
Move the downloaded executable(.exe) to the folder created in step 2
Add the path of the created folder created in step 2 into windows path variable
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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
filecrypt

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL