r-sitko / grpc-file-transfer

SSL secured file transfer gRPC client and server written in Python language

grpc-file-transfer

SSL secured file transfer gRPC client and server written in Python language.

Project structure

|-- cert - SSL certificates
|   `-- generate.sh - bash script for generating SSL certificates
|-- client - package with gRPC file transfer client code
|   |-- client.py
|   |-- __init__.py
|   `-- main.py
|-- protos - folder with gRPC interface for file transfer service
|   |-- file.proto
|   `-- __init__.py
|-- README.md
|-- requirements.txt
|-- resources
|   |-- client - example folder where files can be downloaded
|   `-- server - example folder for example files which can be downloaded
|       |-- test_file2.txt
|       `-- test_file.txt
`-- server - package with gRPC file transfer server code
    |-- __init__.py
    |-- main.py
    `-- server.py

Prerequisites

• Python3
• pip3
• OpenSSL

Example usage

1. Prepare project:
   • Go to project root directory.
   • Use the package manager for Python to install dependencies.

     pip3 install -r requirements.txt

   • Grant the owner of cert/generate.sh file execution permissions.

     chmod u+x cert/generate.sh

   • Generate certificate.
     Warning: Don't use such created certificates for production environment.

     cert/generate.sh /CN=localhost

     CN (Common Name) must match server name that you connect to with the client. In this example we will use localhost.
2. Lauch gRPC file transfer server in first console:

   python3 -m server.main -i localhost -p 5000 -w 2 -d resources/server -priv cert/server.key -cert cert/server.crt

3. Lauch gRPC file transfer client in second console:
   • list available files to download from server

     python3 -m client.main -i localhost -p 5000 -c cert/server.crt list

   • download test_file.txt file from server to resources/client directory:

     python3 -m client.main -i localhost -p 5000 -c cert/server.crt download -d resources/client -f test_file.txt

Description of client and server arguments

• server

usage: main.py [-h] -i IP_ADRESS -p PORT -w MAX_WORKERS -d FILES_DIRECTORY
               -priv PRIVATE_KEY_FILE -cert CERT_FILE

gRPC file transfer server

optional arguments:
  -h, --help            show this help message and exit
  -i IP_ADRESS, --ip_adress IP_ADRESS
                        IP address for server
  -p PORT, --port PORT  port address for server
  -w MAX_WORKERS, --max_workers MAX_WORKERS
                        maximum worker threads for server
  -d FILES_DIRECTORY, --files_directory FILES_DIRECTORY
                        directory containing files
  -priv PRIVATE_KEY_FILE, --private_key_file PRIVATE_KEY_FILE
                        private key file path
  -cert CERT_FILE, --cert_file CERT_FILE
                        certificate file path

• client

usage: main.py [-h] -i IP_ADRESS -p PORT -c CERT_FILE {download,list} ...

gRPC file transfer client

positional arguments:
  {download,list}       client possible actions
    download            download file from server
    list                list files on server

optional arguments:
  -h, --help            show this help message and exit
  -i IP_ADRESS, --ip_adress IP_ADRESS
                        IP address of server
  -p PORT, --port PORT  port address of server
  -c CERT_FILE, --cert_file CERT_FILE
                        certificate file path

If you use download action you must provide below paramaters:
optional arguments:
  -h, --help            show this help message and exit
  -d DIRECTORY, --directory DIRECTORY
                        where to save files
  -f FILE, --file FILE  file name to download