Adding telegram connector (#1190)

fclairamb · slayer · web-flow · commit e58ef15c812c · 2024-05-28T21:33:58.000Z
* Telegram connector (#1) * Initial telegram interface implementation * bump go version to 1.21.3 * update doc; remove debug logging * actions/checkout@v4.1.1 * goreleaser: add goarch, goarm params * sync fork (#2) * sync fork * SSL certs (#3) * SSL certs required to connect telegram API --------- Co-authored-by: Vlad <57521+slayer@users.noreply.github.com> Co-authored-by: Vlad <devvlad@gmail.com>
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -12,7 +12,7 @@ jobs:
   build:
     # The type of runner that the job will run on
     runs-on: ubuntu-22.04
-  
+
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE
@@ -29,7 +29,7 @@ jobs:
       - name: Setup go
         uses: actions/setup-go@v5.0.1
         with:
-          go-version: 1.19
+          go-version: 1.21.3
 
       - name: Build
         run: go build -v ./...
diff --git a/.github/workflows/goreleaser.yml b/.github/workflows/goreleaser.yml
@@ -11,7 +11,7 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v4.1.1.1.1
+        uses: actions/checkout@v4.1.1
         with:
           fetch-depth: 0
       -
diff --git a/.goreleaser.yaml b/.goreleaser.yaml
@@ -1,3 +1,17 @@
 builds:
-  - ldflags:
+  - env:
+      - CGO_ENABLED=0
+      - GO111MODULE=on
+    goos:
+      - linux
+      - darwin
+      - windows
+    goarch:
+      - amd64
+      - arm
+      - arm64
+    goarm:
+      - "6"
+      - "7"
+    ldflags:
       - -s -w -X main.BuildVersion={{.Version}} -X main.Commit={{.Commit}} -X main.BuildDate={{.Date}}
diff --git a/Dockerfile b/Dockerfile
@@ -4,7 +4,7 @@
 # Preparing the build environment
 FROM golang:1.22-alpine AS builder
 ENV GOFLAGS="-mod=readonly"
-RUN apk add --update --no-cache bash ca-certificates curl git
+RUN apk add --update --no-cache bash ca-certificates curl git && update-ca-certificates
 RUN mkdir -p /workspace
 WORKDIR /workspace
 
@@ -15,6 +15,7 @@ RUN CGO_ENABLED=0 go build -mod=readonly -ldflags='-w -s' -v -o ftpserver
 # Preparing the final image
 FROM scratch
 WORKDIR /app
+COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
 EXPOSE 2121-2130
 COPY --from=builder /workspace/ftpserver /bin/ftpserver
 ENTRYPOINT [ "/bin/ftpserver" ]
diff --git a/Dockerfile.alpine b/Dockerfile.alpine
@@ -4,7 +4,7 @@
 # Preparing the build environment
 FROM golang:1.22-alpine AS builder
 ENV GOFLAGS="-mod=readonly"
-RUN apk add --update --no-cache bash ca-certificates curl git
+RUN apk add --update --no-cache bash ca-certificates curl git && update-ca-certificates
 RUN mkdir -p /workspace
 WORKDIR /workspace
 
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ At the current stage, supported backend are:
 - [Google Drive](https://developers.google.com/drive) (see [doc](https://github.com/fclairamb/ftpserver/tree/master/fs/gdrive)) through [afero-gdrive](https://github.com/fclairamb/afero-gdrive)
 - [SFTP](https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol) through [afero's sftpfs](https://github.com/spf13/afero/)
 - Email through [go-mail](https://github.com/go-mail/mail) thanks to [@x-way](https://github.com/x-way)
+- Telegram through [telebot](https://github.com/tucnak/telebot) by [@slayer](https://github.com/slayer), see [doc](fs/telegram/README.md)
 
 And with those are supported common parameters to switch them to read-only, enable login access, or use a temporary directory file (see [doc](https://github.com/fclairamb/ftpserver/tree/master/fs)).
 
@@ -191,6 +192,16 @@ Here is a sample config file:
             "password": "password",
             "hostname": "192.168.168.11:22"
          }
+      },
+      {
+         "user": "telegram",
+         "pass": "telegram",
+         "fs": "telegram",
+         "shared": true,
+         "params": {
+            "Token": "<OBTAIN_TOKEN_FROM_BOTFATHER>",
+            "ChatID": "<INSERT_CHAT_ID_HERE>"
+         }
       }
    ]
 }
diff --git a/fs/fs.go b/fs/fs.go
@@ -15,6 +15,7 @@ import (
 	"github.com/fclairamb/ftpserver/fs/mail"
 	"github.com/fclairamb/ftpserver/fs/s3"
 	"github.com/fclairamb/ftpserver/fs/sftp"
+	"github.com/fclairamb/ftpserver/fs/telegram"
 )
 
 // UnsupportedFsError is returned when the described file system is not supported
@@ -45,6 +46,8 @@ func LoadFs(access *confpar.Access, logger log.Logger) (afero.Fs, error) {
 		fs, err = gdrive.LoadFs(access, logger.With("component", "gdrive"))
 	case "dropbox":
 		fs, err = dropbox.LoadFs(access)
+	case "telegram":
+		fs, err = telegram.LoadFs(access, logger.With("component", "telegram"))
 	default:
 		fs, err = nil, &UnsupportedFsError{Type: access.Fs}
 	}
diff --git a/fs/telegram/README.md b/fs/telegram/README.md
@@ -0,0 +1,47 @@
+# FTPServer Telegram connector
+
+[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://stand-with-ukraine.pp.ua)
+
+## Register bot
+
+Read about telegram bots at https://core.telegram.org/bots/tutorial.
+
+Bots are not allowed to contact users. You need to make the first contact from the user for which you want to set up the bot.
+
+### Quick start
+
+- Create a bot with [@BotFather](https://t.me/BotFather), let's say with username `my_ftp_bot`
+- Get bot token from BotFather's response, use it as `Token` in config
+- Get bot id by run `curl https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getMe`
+- Find `@my_ftp_bot` in telegram and start chat with it
+- Send `/start` to bot
+- Run `curl https://api.telegram.org/bot<YOUR_BOT_TOKEN>/getUpdates` and find your chat id in response, use it as `ChatID` in config
+
+
+## Config example
+
+Please note about `shared` flag. If it's `true` then bot instance will be shared between all connections.
+If it's `false` then each user (or even each ftp connection) will have own bot instance and it can lead to telegram bot flood protection.
+
+```json
+{
+  "version": 1,
+  "accesses": [
+    {
+      "fs": "telegram",
+      "shared": true,
+      "user": "my_ftp_bot",
+      "pass": "my_secure_password",
+      "params": {
+        "Token": "<YOUR_BOT_TOKEN>",
+        "ChatID": "<YOUR_CHAT_ID>"
+      }
+
+    }
+  ],
+  "passive_transfer_port_range": {
+    "start": 2122,
+    "end": 2130
+  }
+}
+```
diff --git a/fs/telegram/example.conf b/fs/telegram/example.conf
@@ -0,0 +1,20 @@
+{
+  "version": 1,
+  "accesses": [
+    {
+      "fs": "telegram",
+      "shared": true,
+      "user": "test",
+      "pass": "test",
+      "params": {
+        "Token": "123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789",
+        "ChatID": "123456789"
+      }
+
+    }
+  ],
+  "passive_transfer_port_range": {
+    "start": 2122,
+    "end": 2130
+  }
+}
diff --git a/fs/telegram/fake_fs.go b/fs/telegram/fake_fs.go
@@ -0,0 +1,79 @@
+package telegram
+
+import (
+	"os"
+	"sync"
+)
+
+// fakeFilesystem is a really simple and limited fake filesystem intended for store temporary info about files
+// since some ftp clients expect to perform mkdir() + stat() on files and directories before upload
+type fakeFilesystem struct {
+	sync.Mutex
+	dict map[string]*FileInfo
+	// dir fakeDir
+}
+
+type fakeDir struct {
+	name    string
+	content []os.FileInfo
+}
+
+// newFakeFilesystem creates a new fake filesystem
+func newFakeFilesystem() *fakeFilesystem {
+	return &fakeFilesystem{
+		dict: map[string]*FileInfo{},
+		// dir: fakeDir{content: []os.FileInfo{}},
+	}
+}
+
+// mkdir creates a directory
+func (f *fakeFilesystem) mkdir(name string, mode os.FileMode) {
+	f.Lock()
+	defer f.Unlock()
+	f.dict[name] = &FileInfo{&FileData{
+		name: name,
+		dir:  true,
+		mode: mode,
+	}}
+}
+
+// create creates a file
+func (f *fakeFilesystem) create(name string) {
+	f.Lock()
+	defer f.Unlock()
+	f.dict[name] = &FileInfo{&FileData{
+		name: name,
+		dir:  false,
+	}}
+}
+
+// setSize sets the size of a file
+func (f *fakeFilesystem) setSize(name string, size int64) {
+	f.Lock()
+	defer f.Unlock()
+	if fileInfo, found := f.dict[name]; found {
+		fileInfo.size = size
+	}
+}
+
+// stat returns a file info
+func (f *fakeFilesystem) stat(name string) *FileInfo {
+	f.Lock()
+	defer f.Unlock()
+	return f.dict[name]
+}
+
+// remove removes a file
+func (f *fakeFilesystem) remove(name string) {
+	f.Lock()
+	defer f.Unlock()
+	delete(f.dict, name)
+}
+
+// exists checks if a file exists
+func (f *fakeFilesystem) exists(name string) bool {
+	f.Lock()
+	defer f.Unlock()
+	_, ok := f.dict[name]
+	return ok
+}
diff --git a/fs/telegram/file_info.go b/fs/telegram/file_info.go
@@ -0,0 +1,37 @@
+package telegram
+
+import (
+	"os"
+	"path/filepath"
+	"time"
+)
+
+// FileData is a simple structure to store file information and implement os.FileInfo interface
+type FileData struct {
+	name    string
+	dir     bool
+	mode    os.FileMode
+	modtime time.Time
+	size    int64
+}
+
+type FileInfo struct {
+	*FileData
+}
+
+// Implements os.FileInfo
+func (s *FileInfo) Name() string {
+	_, name := filepath.Split(s.name)
+	return name
+}
+
+func (s *FileInfo) Mode() os.FileMode  { return s.mode }
+func (s *FileInfo) ModTime() time.Time { return s.modtime }
+func (s *FileInfo) IsDir() bool        { return s.dir }
+func (s *FileInfo) Sys() interface{}   { return nil }
+func (s *FileInfo) Size() int64 {
+	if s.IsDir() {
+		return int64(42)
+	}
+	return s.size
+}
diff --git a/fs/telegram/telegram.go b/fs/telegram/telegram.go
diff --git a/go.mod b/go.mod
diff --git a/go.sum b/go.sum

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ jobs:`
`11`	`11`	`steps:`
`12`	`12`	`-`
`13`	`13`	`name: Checkout`
`14`		`- uses: actions/checkout@v4.1.1.1.1`
	`14`	`+ uses: actions/checkout@v4.1.1`
`15`	`15`	`with:`
`16`	`16`	`fetch-depth: 0`
`17`	`17`	`-`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ At the current stage, supported backend are:`
`18`	`18`	`- [Google Drive](https://developers.google.com/drive) (see [doc](https://github.com/fclairamb/ftpserver/tree/master/fs/gdrive)) through [afero-gdrive](https://github.com/fclairamb/afero-gdrive)`
`19`	`19`	`- [SFTP](https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol) through [afero's sftpfs](https://github.com/spf13/afero/)`
`20`	`20`	`- Email through [go-mail](https://github.com/go-mail/mail) thanks to [@x-way](https://github.com/x-way)`
	`21`	`+- Telegram through [telebot](https://github.com/tucnak/telebot) by [@slayer](https://github.com/slayer), see [doc](fs/telegram/README.md)`
`21`	`22`
`22`	`23`	`And with those are supported common parameters to switch them to read-only, enable login access, or use a temporary directory file (see [doc](https://github.com/fclairamb/ftpserver/tree/master/fs)).`
`23`	`24`
`@@ -191,6 +192,16 @@ Here is a sample config file:`
`191`	`192`	`"password": "password",`
`192`	`193`	`"hostname": "192.168.168.11:22"`
`193`	`194`	`}`
	`195`	`+ },`
	`196`	`+ {`
	`197`	`+ "user": "telegram",`
	`198`	`+ "pass": "telegram",`
	`199`	`+ "fs": "telegram",`
	`200`	`+ "shared": true,`
	`201`	`+ "params": {`
	`202`	`+ "Token": "<OBTAIN_TOKEN_FROM_BOTFATHER>",`
	`203`	`+ "ChatID": "<INSERT_CHAT_ID_HERE>"`
	`204`	`+ }`
`194`	`205`	`}`
`195`	`206`	`]`
`196`	`207`	`}`