file-uncle

README

File Uncle (WIP)

file-uncle, an anywhere to anywhere file transfer utility using http.

Features

• Receive Files: Create a http server to Receive files from anywhere via http.
• Serve Files: Create a http file server to let anyone download the file from your system.

Installation

To install File Uncle, follow these steps:

1. Clone the repository: git clone https://github.com/theadarshsaxena/file-uncle.git
2. Navigate to the project directory: cd file-uncle
3. Run the project: go run .

Usage

Prerequisite

1. You need to install file-uncle in one system

Case #1: file-uncle installed in system #1

• Install file-uncle in system #1
• Run file-uncle serve command to start a http server in system #1
  • Both system in same network

    file-uncle serve --host <IPOfServer#1>
    

  • System on different network (send via internet)

    file-uncle serve --with-ngrok
    

• Above command will return a link, which will open a http page in browser with a list of files to download.
• Note: To download the files from CLI (system #2), use wget after copying link for any file by opening first in browser.

Case #2: file-uncle installed in system #2

• Install file-uncle in system #2
• Run file-uncle receive command to start the http server, it starts the server at 8080 (by default) and it also provide a webUI to upload the files
  • Both system in same network

    file-uncle receive --host <IPOfServer#2>
    (or)
    file-uncle receive --host <IPOfServer#2> --user <username> --password <somepassword>
    

  • System on different network (send via internet)

    file-uncle receive --with-ngrok
    (or)
    file-uncle receive --with-ngrok --user <username> --password <somepassword>
    

• Now, from system #1, open the link given by above command in browser and upload the file
• Note: To send file from system #1 using CLI, follows the below steps:

Sending Files via CLI (curl)

In addition to this, if you want to send the files via CLI in remote system, you the following commands:

1. To upload a file to the server using curl:

   curl -F "uploadFile=@/path/to/your/file" http://localhost:8080/
   

2. If authentication is enabled:

   curl -u username:password -F "uploadFile=@/path/to/your/file" http://localhost:8080/
   

Encrypting and Decrypting Files

For better security when sending the file via tunnel, e.g., ngrok, prefer sending the encrypted file. You can encrypt a file before sending and decrypt it after receiving using OpenSSL (AES-256) as follows:

1. Encrypt before sending:

   openssl enc -aes-256-cbc -salt -in /path/to/your/file -out /path/to/your/file.enc -k yourpassword
   

2. Send the encrypted file:

   curl -F "uploadFile=@/path/to/your/file.enc" http://localhost:8080/
   

3. Decrypt after receiving:

   openssl enc -d -aes-256-cbc -in /path/to/received/file.enc -out /path/to/decrypted/file -k yourpassword
   

   Replace /path/to/your/file and yourpassword with your actual file path and password.

Using Ngrok for sending/receiving via internet

1. To expose your server to the internet, use the built-in ngrok integration:

   • Add the --with-ngrok flag to either the serve or receive command:

     ./file-uncle serve --with-ngrok
     ./file-uncle receive --with-ngrok
     

   • Set the following environment variables before running the command:
     • NGROK_AUTHTOKEN: Your ngrok authtoken (required for authentication)
   • The tunnel endpoint will be printed in the console when started.
   • When you stop the server with CTRL+C, the tunnel will be closed

Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request. Make sure to follow our contribution guidelines.

License

This project is licensed under the MIT License.