fyle

File upload service with built-in encryption 📂🕵🏻

Description • Features • Quick Start • Usage • Documentation • Testing

📖 Description

Fyle is a file storage service written in Go that supports secure file managment with AES-GCM for unique encryption. It uses JWT authentication for user access and streams data in chunks to keep memory usage low. Sensitive data like credentials and encryption keys are safely stored in the system's keyring. Access the server through the CLI client. Application is tested with unit and integration tests ensuring high codebase test coverage.

✨ Features

• End-to-end encryption Encrypt files with AES-GCM to keep the data private and secure
• Security Different encryption result for each uploaded file
• Keyring Safely store sensitive data like credentials and encryption keys in the system's keyring
• Streaming files Upload and download files in chunks to keep memory usage low
• JWT Authentication Provides user authentication on the server
• CLI Client Easily interact with server through Cli Client (see 📄Usage)
• Testing Unit and integration tests, high codebase test coverage

🚀 Quick Start

1. Install CLI client

go install github.com/fmich7/fyle/cmd/fyle

2. Run server and PostgreSQL

docker-compose up

3. Use CLI client

fyle signup [username] [password]

[Recommended] Modify server configuration in cmd/server/example_server.env

📄 Usage

fyle ls                                # List all your files on the server
fyle upload [localPath] [serverPath]   # Upload file to the server
fyle download [serverPath] [localPath] # Download file from provided path
fyle signup [username] [password]      # Sign up a new user
fyle login [username] [password]       # Login to the server

Run fyle --help to see all available commands and options.

🛠️ Testing

The application has been tested on the following platforms:

• Linux (Ubuntu 22.04, WSL2)
• Windows 10
• Go version 1.23.3

To run integration test that verifies the entire workflow:

go test -v -race ./tests/integration_test.go

Run all tests:

# go test -v -timeout 10s -race ./pkg/... ./tests/...
make test

Generate test coverage file

# go test -timeout 10s -race ./pkg/... ./tests/... -coverprofile=cover.out
make coverage

Example tests:

• Integration test
• Encryption stream test
• JWT Auth test

💡 Documentation

Explore the full documentation for this package on

pkg.go.dev/github.com/fmich7/fyle