mirror of
https://github.com/drakkan/sftpgo.git
synced 2024-11-25 09:00:27 +00:00
c8158e14e0
SFTPGo is a daemon and command line tool, not a library. The public API are provided by the SDK Signed-off-by: Nicola Murino <nicola.murino@gmail.com>
723 lines
31 KiB
Go
723 lines
31 KiB
Go
// Copyright (C) 2019-2022 Nicola Murino
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published
|
|
// by the Free Software Foundation, version 3.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
//go:build !nomysql
|
|
// +build !nomysql
|
|
|
|
package dataprovider
|
|
|
|
import (
|
|
"context"
|
|
"crypto/tls"
|
|
"crypto/x509"
|
|
"database/sql"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/go-sql-driver/mysql"
|
|
|
|
"github.com/drakkan/sftpgo/v2/internal/logger"
|
|
"github.com/drakkan/sftpgo/v2/internal/version"
|
|
"github.com/drakkan/sftpgo/v2/internal/vfs"
|
|
)
|
|
|
|
const (
|
|
mysqlResetSQL = "DROP TABLE IF EXISTS `{{api_keys}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{folders_mapping}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{users_folders_mapping}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{users_groups_mapping}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{groups_folders_mapping}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{admins}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{folders}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{shares}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{users}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{groups}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{defender_events}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{defender_hosts}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{active_transfers}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{shared_sessions}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{rules_actions_mapping}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{events_actions}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{events_rules}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{tasks}}` CASCADE;" +
|
|
"DROP TABLE IF EXISTS `{{schema_version}}` CASCADE;"
|
|
mysqlInitialSQL = "CREATE TABLE `{{schema_version}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `version` integer NOT NULL);" +
|
|
"CREATE TABLE `{{admins}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `username` varchar(255) NOT NULL UNIQUE, " +
|
|
"`description` varchar(512) NULL, `password` varchar(255) NOT NULL, `email` varchar(255) NULL, `status` integer NOT NULL, " +
|
|
"`permissions` longtext NOT NULL, `filters` longtext NULL, `additional_info` longtext NULL, `last_login` bigint NOT NULL, " +
|
|
"`created_at` bigint NOT NULL, `updated_at` bigint NOT NULL);" +
|
|
"CREATE TABLE `{{active_transfers}}` (`id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
|
|
"`connection_id` varchar(100) NOT NULL, `transfer_id` bigint NOT NULL, `transfer_type` integer NOT NULL, " +
|
|
"`username` varchar(255) NOT NULL, `folder_name` varchar(255) NULL, `ip` varchar(50) NOT NULL, " +
|
|
"`truncated_size` bigint NOT NULL, `current_ul_size` bigint NOT NULL, `current_dl_size` bigint NOT NULL, " +
|
|
"`created_at` bigint NOT NULL, `updated_at` bigint NOT NULL);" +
|
|
"CREATE TABLE `{{defender_hosts}}` (`id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
|
|
"`ip` varchar(50) NOT NULL UNIQUE, `ban_time` bigint NOT NULL, `updated_at` bigint NOT NULL);" +
|
|
"CREATE TABLE `{{defender_events}}` (`id` bigint AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
|
|
"`date_time` bigint NOT NULL, `score` integer NOT NULL, `host_id` bigint NOT NULL);" +
|
|
"ALTER TABLE `{{defender_events}}` ADD CONSTRAINT `{{prefix}}defender_events_host_id_fk_defender_hosts_id` " +
|
|
"FOREIGN KEY (`host_id`) REFERENCES `{{defender_hosts}}` (`id`) ON DELETE CASCADE;" +
|
|
"CREATE TABLE `{{folders}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `name` varchar(255) NOT NULL UNIQUE, " +
|
|
"`description` varchar(512) NULL, `path` longtext NULL, `used_quota_size` bigint NOT NULL, " +
|
|
"`used_quota_files` integer NOT NULL, `last_quota_update` bigint NOT NULL, `filesystem` longtext NULL);" +
|
|
"CREATE TABLE `{{groups}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
|
|
"`name` varchar(255) NOT NULL UNIQUE, `description` varchar(512) NULL, `created_at` bigint NOT NULL, " +
|
|
"`updated_at` bigint NOT NULL, `user_settings` longtext NULL);" +
|
|
"CREATE TABLE `{{shared_sessions}}` (`key` varchar(128) NOT NULL PRIMARY KEY, " +
|
|
"`data` longtext NOT NULL, `type` integer NOT NULL, `timestamp` bigint NOT NULL);" +
|
|
"CREATE TABLE `{{users}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `username` varchar(255) NOT NULL UNIQUE, " +
|
|
"`status` integer NOT NULL, `expiration_date` bigint NOT NULL, `description` varchar(512) NULL, `password` longtext NULL, " +
|
|
"`public_keys` longtext NULL, `home_dir` longtext NOT NULL, `uid` bigint NOT NULL, `gid` bigint NOT NULL, " +
|
|
"`max_sessions` integer NOT NULL, `quota_size` bigint NOT NULL, `quota_files` integer NOT NULL, " +
|
|
"`permissions` longtext NOT NULL, `used_quota_size` bigint NOT NULL, `used_quota_files` integer NOT NULL, " +
|
|
"`last_quota_update` bigint NOT NULL, `upload_bandwidth` integer NOT NULL, `download_bandwidth` integer NOT NULL, " +
|
|
"`last_login` bigint NOT NULL, `filters` longtext NULL, `filesystem` longtext NULL, `additional_info` longtext NULL, " +
|
|
"`created_at` bigint NOT NULL, `updated_at` bigint NOT NULL, `email` varchar(255) NULL, " +
|
|
"`upload_data_transfer` integer NOT NULL, `download_data_transfer` integer NOT NULL, " +
|
|
"`total_data_transfer` integer NOT NULL, `used_upload_data_transfer` integer NOT NULL, " +
|
|
"`used_download_data_transfer` integer NOT NULL);" +
|
|
"CREATE TABLE `{{groups_folders_mapping}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
|
|
"`group_id` integer NOT NULL, `folder_id` integer NOT NULL, " +
|
|
"`virtual_path` longtext NOT NULL, `quota_size` bigint NOT NULL, `quota_files` integer NOT NULL);" +
|
|
"CREATE TABLE `{{users_groups_mapping}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
|
|
"`user_id` integer NOT NULL, `group_id` integer NOT NULL, `group_type` integer NOT NULL);" +
|
|
"CREATE TABLE `{{users_folders_mapping}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `virtual_path` longtext NOT NULL, " +
|
|
"`quota_size` bigint NOT NULL, `quota_files` integer NOT NULL, `folder_id` integer NOT NULL, `user_id` integer NOT NULL);" +
|
|
"ALTER TABLE `{{users_folders_mapping}}` ADD CONSTRAINT `{{prefix}}unique_user_folder_mapping` " +
|
|
"UNIQUE (`user_id`, `folder_id`);" +
|
|
"ALTER TABLE `{{users_folders_mapping}}` ADD CONSTRAINT `{{prefix}}users_folders_mapping_user_id_fk_users_id` " +
|
|
"FOREIGN KEY (`user_id`) REFERENCES `{{users}}` (`id`) ON DELETE CASCADE;" +
|
|
"ALTER TABLE `{{users_folders_mapping}}` ADD CONSTRAINT `{{prefix}}users_folders_mapping_folder_id_fk_folders_id` " +
|
|
"FOREIGN KEY (`folder_id`) REFERENCES `{{folders}}` (`id`) ON DELETE CASCADE;" +
|
|
"ALTER TABLE `{{users_groups_mapping}}` ADD CONSTRAINT `{{prefix}}unique_user_group_mapping` UNIQUE (`user_id`, `group_id`);" +
|
|
"ALTER TABLE `{{groups_folders_mapping}}` ADD CONSTRAINT `{{prefix}}unique_group_folder_mapping` UNIQUE (`group_id`, `folder_id`);" +
|
|
"ALTER TABLE `{{users_groups_mapping}}` ADD CONSTRAINT `{{prefix}}users_groups_mapping_group_id_fk_groups_id` " +
|
|
"FOREIGN KEY (`group_id`) REFERENCES `{{groups}}` (`id`) ON DELETE NO ACTION;" +
|
|
"ALTER TABLE `{{users_groups_mapping}}` ADD CONSTRAINT `{{prefix}}users_groups_mapping_user_id_fk_users_id` " +
|
|
"FOREIGN KEY (`user_id`) REFERENCES `{{users}}` (`id`) ON DELETE CASCADE;" +
|
|
"ALTER TABLE `{{groups_folders_mapping}}` ADD CONSTRAINT `{{prefix}}groups_folders_mapping_folder_id_fk_folders_id` " +
|
|
"FOREIGN KEY (`folder_id`) REFERENCES `{{folders}}` (`id`) ON DELETE CASCADE;" +
|
|
"ALTER TABLE `{{groups_folders_mapping}}` ADD CONSTRAINT `{{prefix}}groups_folders_mapping_group_id_fk_groups_id` " +
|
|
"FOREIGN KEY (`group_id`) REFERENCES `{{groups}}` (`id`) ON DELETE CASCADE;" +
|
|
"CREATE TABLE `{{shares}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
|
|
"`share_id` varchar(60) NOT NULL UNIQUE, `name` varchar(255) NOT NULL, `description` varchar(512) NULL, " +
|
|
"`scope` integer NOT NULL, `paths` longtext NOT NULL, `created_at` bigint NOT NULL, " +
|
|
"`updated_at` bigint NOT NULL, `last_use_at` bigint NOT NULL, `expires_at` bigint NOT NULL, " +
|
|
"`password` longtext NULL, `max_tokens` integer NOT NULL, `used_tokens` integer NOT NULL, " +
|
|
"`allow_from` longtext NULL, `user_id` integer NOT NULL);" +
|
|
"ALTER TABLE `{{shares}}` ADD CONSTRAINT `{{prefix}}shares_user_id_fk_users_id` " +
|
|
"FOREIGN KEY (`user_id`) REFERENCES `{{users}}` (`id`) ON DELETE CASCADE;" +
|
|
"CREATE TABLE `{{api_keys}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `name` varchar(255) NOT NULL, `key_id` varchar(50) NOT NULL UNIQUE," +
|
|
"`api_key` varchar(255) NOT NULL UNIQUE, `scope` integer NOT NULL, `created_at` bigint NOT NULL, `updated_at` bigint NOT NULL, `last_use_at` bigint NOT NULL, " +
|
|
"`expires_at` bigint NOT NULL, `description` longtext NULL, `admin_id` integer NULL, `user_id` integer NULL);" +
|
|
"ALTER TABLE `{{api_keys}}` ADD CONSTRAINT `{{prefix}}api_keys_admin_id_fk_admins_id` FOREIGN KEY (`admin_id`) REFERENCES `{{admins}}` (`id`) ON DELETE CASCADE;" +
|
|
"ALTER TABLE `{{api_keys}}` ADD CONSTRAINT `{{prefix}}api_keys_user_id_fk_users_id` FOREIGN KEY (`user_id`) REFERENCES `{{users}}` (`id`) ON DELETE CASCADE;" +
|
|
"CREATE INDEX `{{prefix}}users_updated_at_idx` ON `{{users}}` (`updated_at`);" +
|
|
"CREATE INDEX `{{prefix}}defender_hosts_updated_at_idx` ON `{{defender_hosts}}` (`updated_at`);" +
|
|
"CREATE INDEX `{{prefix}}defender_hosts_ban_time_idx` ON `{{defender_hosts}}` (`ban_time`);" +
|
|
"CREATE INDEX `{{prefix}}defender_events_date_time_idx` ON `{{defender_events}}` (`date_time`);" +
|
|
"CREATE INDEX `{{prefix}}active_transfers_connection_id_idx` ON `{{active_transfers}}` (`connection_id`);" +
|
|
"CREATE INDEX `{{prefix}}active_transfers_transfer_id_idx` ON `{{active_transfers}}` (`transfer_id`);" +
|
|
"CREATE INDEX `{{prefix}}active_transfers_updated_at_idx` ON `{{active_transfers}}` (`updated_at`);" +
|
|
"CREATE INDEX `{{prefix}}groups_updated_at_idx` ON `{{groups}}` (`updated_at`);" +
|
|
"CREATE INDEX `{{prefix}}shared_sessions_type_idx` ON `{{shared_sessions}}` (`type`);" +
|
|
"CREATE INDEX `{{prefix}}shared_sessions_timestamp_idx` ON `{{shared_sessions}}` (`timestamp`);" +
|
|
"INSERT INTO {{schema_version}} (version) VALUES (19);"
|
|
mysqlV20SQL = "CREATE TABLE `{{events_rules}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
|
|
"`name` varchar(255) NOT NULL UNIQUE, `description` varchar(512) NULL, `created_at` bigint NOT NULL, " +
|
|
"`updated_at` bigint NOT NULL, `trigger` integer NOT NULL, `conditions` longtext NOT NULL, `deleted_at` bigint NOT NULL);" +
|
|
"CREATE TABLE `{{events_actions}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
|
|
"`name` varchar(255) NOT NULL UNIQUE, `description` varchar(512) NULL, `type` integer NOT NULL, " +
|
|
"`options` longtext NOT NULL);" +
|
|
"CREATE TABLE `{{rules_actions_mapping}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, " +
|
|
"`rule_id` integer NOT NULL, `action_id` integer NOT NULL, `order` integer NOT NULL, `options` longtext NOT NULL);" +
|
|
"CREATE TABLE `{{tasks}}` (`id` integer AUTO_INCREMENT NOT NULL PRIMARY KEY, `name` varchar(255) NOT NULL UNIQUE, " +
|
|
"`updated_at` bigint NOT NULL, `version` bigint NOT NULL);" +
|
|
"ALTER TABLE `{{rules_actions_mapping}}` ADD CONSTRAINT `{{prefix}}unique_rule_action_mapping` UNIQUE (`rule_id`, `action_id`);" +
|
|
"ALTER TABLE `{{rules_actions_mapping}}` ADD CONSTRAINT `{{prefix}}rules_actions_mapping_rule_id_fk_events_rules_id` " +
|
|
"FOREIGN KEY (`rule_id`) REFERENCES `{{events_rules}}` (`id`) ON DELETE CASCADE;" +
|
|
"ALTER TABLE `{{rules_actions_mapping}}` ADD CONSTRAINT `{{prefix}}rules_actions_mapping_action_id_fk_events_targets_id` " +
|
|
"FOREIGN KEY (`action_id`) REFERENCES `{{events_actions}}` (`id`) ON DELETE NO ACTION;" +
|
|
"ALTER TABLE `{{users}}` ADD COLUMN `deleted_at` bigint DEFAULT 0 NOT NULL;" +
|
|
"ALTER TABLE `{{users}}` ALTER COLUMN `deleted_at` DROP DEFAULT;" +
|
|
"CREATE INDEX `{{prefix}}events_rules_updated_at_idx` ON `{{events_rules}}` (`updated_at`);" +
|
|
"CREATE INDEX `{{prefix}}events_rules_deleted_at_idx` ON `{{events_rules}}` (`deleted_at`);" +
|
|
"CREATE INDEX `{{prefix}}events_rules_trigger_idx` ON `{{events_rules}}` (`trigger`);" +
|
|
"CREATE INDEX `{{prefix}}rules_actions_mapping_order_idx` ON `{{rules_actions_mapping}}` (`order`);" +
|
|
"CREATE INDEX `{{prefix}}users_deleted_at_idx` ON `{{users}}` (`deleted_at`);"
|
|
mysqlV20DownSQL = "DROP TABLE `{{rules_actions_mapping}}` CASCADE;" +
|
|
"DROP TABLE `{{events_rules}}` CASCADE;" +
|
|
"DROP TABLE `{{events_actions}}` CASCADE;" +
|
|
"DROP TABLE `{{tasks}}` CASCADE;" +
|
|
"ALTER TABLE `{{users}}` DROP COLUMN `deleted_at`;"
|
|
)
|
|
|
|
// MySQLProvider defines the auth provider for MySQL/MariaDB database
|
|
type MySQLProvider struct {
|
|
dbHandle *sql.DB
|
|
}
|
|
|
|
func init() {
|
|
version.AddFeature("+mysql")
|
|
}
|
|
|
|
func initializeMySQLProvider() error {
|
|
var err error
|
|
|
|
connString, err := getMySQLConnectionString(false)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
redactedConnString, err := getMySQLConnectionString(true)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
dbHandle, err := sql.Open("mysql", connString)
|
|
if err == nil {
|
|
providerLog(logger.LevelDebug, "mysql database handle created, connection string: %#v, pool size: %v",
|
|
redactedConnString, config.PoolSize)
|
|
dbHandle.SetMaxOpenConns(config.PoolSize)
|
|
if config.PoolSize > 0 {
|
|
dbHandle.SetMaxIdleConns(config.PoolSize)
|
|
} else {
|
|
dbHandle.SetMaxIdleConns(2)
|
|
}
|
|
dbHandle.SetConnMaxLifetime(240 * time.Second)
|
|
provider = &MySQLProvider{dbHandle: dbHandle}
|
|
} else {
|
|
providerLog(logger.LevelError, "error creating mysql database handler, connection string: %#v, error: %v",
|
|
redactedConnString, err)
|
|
}
|
|
return err
|
|
}
|
|
func getMySQLConnectionString(redactedPwd bool) (string, error) {
|
|
var connectionString string
|
|
if config.ConnectionString == "" {
|
|
password := config.Password
|
|
if redactedPwd && password != "" {
|
|
password = "[redacted]"
|
|
}
|
|
sslMode := getSSLMode()
|
|
if sslMode == "custom" && !redactedPwd {
|
|
tlsConfig := &tls.Config{}
|
|
if config.RootCert != "" {
|
|
rootCAs, err := x509.SystemCertPool()
|
|
if err != nil {
|
|
rootCAs = x509.NewCertPool()
|
|
}
|
|
rootCrt, err := os.ReadFile(config.RootCert)
|
|
if err != nil {
|
|
return "", fmt.Errorf("unable to load root certificate %#v: %v", config.RootCert, err)
|
|
}
|
|
if !rootCAs.AppendCertsFromPEM(rootCrt) {
|
|
return "", fmt.Errorf("unable to parse root certificate %#v", config.RootCert)
|
|
}
|
|
tlsConfig.RootCAs = rootCAs
|
|
}
|
|
if config.ClientCert != "" && config.ClientKey != "" {
|
|
clientCert := make([]tls.Certificate, 0, 1)
|
|
tlsCert, err := tls.LoadX509KeyPair(config.ClientCert, config.ClientKey)
|
|
if err != nil {
|
|
return "", fmt.Errorf("unable to load key pair %#v, %#v: %v", config.ClientCert, config.ClientKey, err)
|
|
}
|
|
clientCert = append(clientCert, tlsCert)
|
|
tlsConfig.Certificates = clientCert
|
|
}
|
|
if config.SSLMode == 2 {
|
|
tlsConfig.InsecureSkipVerify = true
|
|
}
|
|
providerLog(logger.LevelInfo, "registering custom TLS config, root cert %#v, client cert %#v, client key %#v",
|
|
config.RootCert, config.ClientCert, config.ClientKey)
|
|
if err := mysql.RegisterTLSConfig("custom", tlsConfig); err != nil {
|
|
return "", fmt.Errorf("unable to register tls config: %v", err)
|
|
}
|
|
}
|
|
connectionString = fmt.Sprintf("%v:%v@tcp([%v]:%v)/%v?charset=utf8mb4&interpolateParams=true&timeout=10s&parseTime=true&tls=%v&writeTimeout=60s&readTimeout=60s",
|
|
config.Username, password, config.Host, config.Port, config.Name, sslMode)
|
|
} else {
|
|
connectionString = config.ConnectionString
|
|
}
|
|
return connectionString, nil
|
|
}
|
|
|
|
func (p *MySQLProvider) checkAvailability() error {
|
|
return sqlCommonCheckAvailability(p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) validateUserAndPass(username, password, ip, protocol string) (User, error) {
|
|
return sqlCommonValidateUserAndPass(username, password, ip, protocol, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) validateUserAndTLSCert(username, protocol string, tlsCert *x509.Certificate) (User, error) {
|
|
return sqlCommonValidateUserAndTLSCertificate(username, protocol, tlsCert, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) validateUserAndPubKey(username string, publicKey []byte, isSSHCert bool) (User, string, error) {
|
|
return sqlCommonValidateUserAndPubKey(username, publicKey, isSSHCert, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateTransferQuota(username string, uploadSize, downloadSize int64, reset bool) error {
|
|
return sqlCommonUpdateTransferQuota(username, uploadSize, downloadSize, reset, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateQuota(username string, filesAdd int, sizeAdd int64, reset bool) error {
|
|
return sqlCommonUpdateQuota(username, filesAdd, sizeAdd, reset, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getUsedQuota(username string) (int, int64, int64, int64, error) {
|
|
return sqlCommonGetUsedQuota(username, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) setUpdatedAt(username string) {
|
|
sqlCommonSetUpdatedAt(username, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateLastLogin(username string) error {
|
|
return sqlCommonUpdateLastLogin(username, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateAdminLastLogin(username string) error {
|
|
return sqlCommonUpdateAdminLastLogin(username, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) userExists(username string) (User, error) {
|
|
return sqlCommonGetUserByUsername(username, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) addUser(user *User) error {
|
|
return sqlCommonAddUser(user, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateUser(user *User) error {
|
|
return sqlCommonUpdateUser(user, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) deleteUser(user User, softDelete bool) error {
|
|
return sqlCommonDeleteUser(user, softDelete, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateUserPassword(username, password string) error {
|
|
return sqlCommonUpdateUserPassword(username, password, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) dumpUsers() ([]User, error) {
|
|
return sqlCommonDumpUsers(p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getRecentlyUpdatedUsers(after int64) ([]User, error) {
|
|
return sqlCommonGetRecentlyUpdatedUsers(after, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getUsers(limit int, offset int, order string) ([]User, error) {
|
|
return sqlCommonGetUsers(limit, offset, order, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getUsersForQuotaCheck(toFetch map[string]bool) ([]User, error) {
|
|
return sqlCommonGetUsersForQuotaCheck(toFetch, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) dumpFolders() ([]vfs.BaseVirtualFolder, error) {
|
|
return sqlCommonDumpFolders(p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getFolders(limit, offset int, order string, minimal bool) ([]vfs.BaseVirtualFolder, error) {
|
|
return sqlCommonGetFolders(limit, offset, order, minimal, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getFolderByName(name string) (vfs.BaseVirtualFolder, error) {
|
|
ctx, cancel := context.WithTimeout(context.Background(), defaultSQLQueryTimeout)
|
|
defer cancel()
|
|
return sqlCommonGetFolderByName(ctx, name, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) addFolder(folder *vfs.BaseVirtualFolder) error {
|
|
return sqlCommonAddFolder(folder, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateFolder(folder *vfs.BaseVirtualFolder) error {
|
|
return sqlCommonUpdateFolder(folder, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) deleteFolder(folder vfs.BaseVirtualFolder) error {
|
|
return sqlCommonDeleteFolder(folder, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateFolderQuota(name string, filesAdd int, sizeAdd int64, reset bool) error {
|
|
return sqlCommonUpdateFolderQuota(name, filesAdd, sizeAdd, reset, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getUsedFolderQuota(name string) (int, int64, error) {
|
|
return sqlCommonGetFolderUsedQuota(name, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getGroups(limit, offset int, order string, minimal bool) ([]Group, error) {
|
|
return sqlCommonGetGroups(limit, offset, order, minimal, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getGroupsWithNames(names []string) ([]Group, error) {
|
|
return sqlCommonGetGroupsWithNames(names, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getUsersInGroups(names []string) ([]string, error) {
|
|
return sqlCommonGetUsersInGroups(names, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) groupExists(name string) (Group, error) {
|
|
return sqlCommonGetGroupByName(name, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) addGroup(group *Group) error {
|
|
return sqlCommonAddGroup(group, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateGroup(group *Group) error {
|
|
return sqlCommonUpdateGroup(group, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) deleteGroup(group Group) error {
|
|
return sqlCommonDeleteGroup(group, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) dumpGroups() ([]Group, error) {
|
|
return sqlCommonDumpGroups(p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) adminExists(username string) (Admin, error) {
|
|
return sqlCommonGetAdminByUsername(username, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) addAdmin(admin *Admin) error {
|
|
return sqlCommonAddAdmin(admin, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateAdmin(admin *Admin) error {
|
|
return sqlCommonUpdateAdmin(admin, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) deleteAdmin(admin Admin) error {
|
|
return sqlCommonDeleteAdmin(admin, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getAdmins(limit int, offset int, order string) ([]Admin, error) {
|
|
return sqlCommonGetAdmins(limit, offset, order, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) dumpAdmins() ([]Admin, error) {
|
|
return sqlCommonDumpAdmins(p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) validateAdminAndPass(username, password, ip string) (Admin, error) {
|
|
return sqlCommonValidateAdminAndPass(username, password, ip, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) apiKeyExists(keyID string) (APIKey, error) {
|
|
return sqlCommonGetAPIKeyByID(keyID, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) addAPIKey(apiKey *APIKey) error {
|
|
return sqlCommonAddAPIKey(apiKey, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateAPIKey(apiKey *APIKey) error {
|
|
return sqlCommonUpdateAPIKey(apiKey, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) deleteAPIKey(apiKey APIKey) error {
|
|
return sqlCommonDeleteAPIKey(apiKey, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getAPIKeys(limit int, offset int, order string) ([]APIKey, error) {
|
|
return sqlCommonGetAPIKeys(limit, offset, order, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) dumpAPIKeys() ([]APIKey, error) {
|
|
return sqlCommonDumpAPIKeys(p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateAPIKeyLastUse(keyID string) error {
|
|
return sqlCommonUpdateAPIKeyLastUse(keyID, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) shareExists(shareID, username string) (Share, error) {
|
|
return sqlCommonGetShareByID(shareID, username, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) addShare(share *Share) error {
|
|
return sqlCommonAddShare(share, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateShare(share *Share) error {
|
|
return sqlCommonUpdateShare(share, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) deleteShare(share Share) error {
|
|
return sqlCommonDeleteShare(share, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getShares(limit int, offset int, order, username string) ([]Share, error) {
|
|
return sqlCommonGetShares(limit, offset, order, username, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) dumpShares() ([]Share, error) {
|
|
return sqlCommonDumpShares(p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateShareLastUse(shareID string, numTokens int) error {
|
|
return sqlCommonUpdateShareLastUse(shareID, numTokens, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getDefenderHosts(from int64, limit int) ([]DefenderEntry, error) {
|
|
return sqlCommonGetDefenderHosts(from, limit, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getDefenderHostByIP(ip string, from int64) (DefenderEntry, error) {
|
|
return sqlCommonGetDefenderHostByIP(ip, from, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) isDefenderHostBanned(ip string) (DefenderEntry, error) {
|
|
return sqlCommonIsDefenderHostBanned(ip, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateDefenderBanTime(ip string, minutes int) error {
|
|
return sqlCommonDefenderIncrementBanTime(ip, minutes, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) deleteDefenderHost(ip string) error {
|
|
return sqlCommonDeleteDefenderHost(ip, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) addDefenderEvent(ip string, score int) error {
|
|
return sqlCommonAddDefenderHostAndEvent(ip, score, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) setDefenderBanTime(ip string, banTime int64) error {
|
|
return sqlCommonSetDefenderBanTime(ip, banTime, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) cleanupDefender(from int64) error {
|
|
return sqlCommonDefenderCleanup(from, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) addActiveTransfer(transfer ActiveTransfer) error {
|
|
return sqlCommonAddActiveTransfer(transfer, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateActiveTransferSizes(ulSize, dlSize, transferID int64, connectionID string) error {
|
|
return sqlCommonUpdateActiveTransferSizes(ulSize, dlSize, transferID, connectionID, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) removeActiveTransfer(transferID int64, connectionID string) error {
|
|
return sqlCommonRemoveActiveTransfer(transferID, connectionID, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) cleanupActiveTransfers(before time.Time) error {
|
|
return sqlCommonCleanupActiveTransfers(before, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getActiveTransfers(from time.Time) ([]ActiveTransfer, error) {
|
|
return sqlCommonGetActiveTransfers(from, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) addSharedSession(session Session) error {
|
|
return sqlCommonAddSession(session, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) deleteSharedSession(key string) error {
|
|
return sqlCommonDeleteSession(key, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getSharedSession(key string) (Session, error) {
|
|
return sqlCommonGetSession(key, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) cleanupSharedSessions(sessionType SessionType, before int64) error {
|
|
return sqlCommonCleanupSessions(sessionType, before, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getEventActions(limit, offset int, order string, minimal bool) ([]BaseEventAction, error) {
|
|
return sqlCommonGetEventActions(limit, offset, order, minimal, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) dumpEventActions() ([]BaseEventAction, error) {
|
|
return sqlCommonDumpEventActions(p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) eventActionExists(name string) (BaseEventAction, error) {
|
|
return sqlCommonGetEventActionByName(name, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) addEventAction(action *BaseEventAction) error {
|
|
return sqlCommonAddEventAction(action, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateEventAction(action *BaseEventAction) error {
|
|
return sqlCommonUpdateEventAction(action, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) deleteEventAction(action BaseEventAction) error {
|
|
return sqlCommonDeleteEventAction(action, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getEventRules(limit, offset int, order string) ([]EventRule, error) {
|
|
return sqlCommonGetEventRules(limit, offset, order, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) dumpEventRules() ([]EventRule, error) {
|
|
return sqlCommonDumpEventRules(p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getRecentlyUpdatedRules(after int64) ([]EventRule, error) {
|
|
return sqlCommonGetRecentlyUpdatedRules(after, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) eventRuleExists(name string) (EventRule, error) {
|
|
return sqlCommonGetEventRuleByName(name, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) addEventRule(rule *EventRule) error {
|
|
return sqlCommonAddEventRule(rule, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateEventRule(rule *EventRule) error {
|
|
return sqlCommonUpdateEventRule(rule, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) deleteEventRule(rule EventRule, softDelete bool) error {
|
|
return sqlCommonDeleteEventRule(rule, softDelete, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) getTaskByName(name string) (Task, error) {
|
|
return sqlCommonGetTaskByName(name, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) addTask(name string) error {
|
|
return sqlCommonAddTask(name, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateTask(name string, version int64) error {
|
|
return sqlCommonUpdateTask(name, version, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) updateTaskTimestamp(name string) error {
|
|
return sqlCommonUpdateTaskTimestamp(name, p.dbHandle)
|
|
}
|
|
|
|
func (p *MySQLProvider) close() error {
|
|
return p.dbHandle.Close()
|
|
}
|
|
|
|
func (p *MySQLProvider) reloadConfig() error {
|
|
return nil
|
|
}
|
|
|
|
// initializeDatabase creates the initial database structure
|
|
func (p *MySQLProvider) initializeDatabase() error {
|
|
dbVersion, err := sqlCommonGetDatabaseVersion(p.dbHandle, false)
|
|
if err == nil && dbVersion.Version > 0 {
|
|
return ErrNoInitRequired
|
|
}
|
|
if errors.Is(err, sql.ErrNoRows) {
|
|
return errSchemaVersionEmpty
|
|
}
|
|
logger.InfoToConsole("creating initial database schema, version 19")
|
|
providerLog(logger.LevelInfo, "creating initial database schema, version 19")
|
|
initialSQL := sqlReplaceAll(mysqlInitialSQL)
|
|
|
|
return sqlCommonExecSQLAndUpdateDBVersion(p.dbHandle, strings.Split(initialSQL, ";"), 19, true)
|
|
}
|
|
|
|
func (p *MySQLProvider) migrateDatabase() error { //nolint:dupl
|
|
dbVersion, err := sqlCommonGetDatabaseVersion(p.dbHandle, true)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
switch version := dbVersion.Version; {
|
|
case version == sqlDatabaseVersion:
|
|
providerLog(logger.LevelDebug, "sql database is up to date, current version: %v", version)
|
|
return ErrNoInitRequired
|
|
case version < 19:
|
|
err = fmt.Errorf("database version %v is too old, please see the upgrading docs", version)
|
|
providerLog(logger.LevelError, "%v", err)
|
|
logger.ErrorToConsole("%v", err)
|
|
return err
|
|
case version == 19:
|
|
return updateMySQLDatabaseFromV19(p.dbHandle)
|
|
default:
|
|
if version > sqlDatabaseVersion {
|
|
providerLog(logger.LevelError, "database version %v is newer than the supported one: %v", version,
|
|
sqlDatabaseVersion)
|
|
logger.WarnToConsole("database version %v is newer than the supported one: %v", version,
|
|
sqlDatabaseVersion)
|
|
return nil
|
|
}
|
|
return fmt.Errorf("database version not handled: %v", version)
|
|
}
|
|
}
|
|
|
|
func (p *MySQLProvider) revertDatabase(targetVersion int) error {
|
|
dbVersion, err := sqlCommonGetDatabaseVersion(p.dbHandle, true)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if dbVersion.Version == targetVersion {
|
|
return errors.New("current version match target version, nothing to do")
|
|
}
|
|
|
|
switch dbVersion.Version {
|
|
case 20:
|
|
return downgradeMySQLDatabaseFromV20(p.dbHandle)
|
|
default:
|
|
return fmt.Errorf("database version not handled: %v", dbVersion.Version)
|
|
}
|
|
}
|
|
|
|
func (p *MySQLProvider) resetDatabase() error {
|
|
sql := sqlReplaceAll(mysqlResetSQL)
|
|
return sqlCommonExecSQLAndUpdateDBVersion(p.dbHandle, strings.Split(sql, ";"), 0, false)
|
|
}
|
|
|
|
func updateMySQLDatabaseFromV19(dbHandle *sql.DB) error {
|
|
return updateMySQLDatabaseFrom19To20(dbHandle)
|
|
}
|
|
|
|
func downgradeMySQLDatabaseFromV20(dbHandle *sql.DB) error {
|
|
return downgradeMySQLDatabaseFrom20To19(dbHandle)
|
|
}
|
|
|
|
func updateMySQLDatabaseFrom19To20(dbHandle *sql.DB) error {
|
|
logger.InfoToConsole("updating database version: 19 -> 20")
|
|
providerLog(logger.LevelInfo, "updating database version: 19 -> 20")
|
|
sql := strings.ReplaceAll(mysqlV20SQL, "{{events_actions}}", sqlTableEventsActions)
|
|
sql = strings.ReplaceAll(sql, "{{events_rules}}", sqlTableEventsRules)
|
|
sql = strings.ReplaceAll(sql, "{{rules_actions_mapping}}", sqlTableRulesActionsMapping)
|
|
sql = strings.ReplaceAll(sql, "{{users}}", sqlTableUsers)
|
|
sql = strings.ReplaceAll(sql, "{{tasks}}", sqlTableTasks)
|
|
sql = strings.ReplaceAll(sql, "{{prefix}}", config.SQLTablesPrefix)
|
|
return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, strings.Split(sql, ";"), 20, true)
|
|
}
|
|
|
|
func downgradeMySQLDatabaseFrom20To19(dbHandle *sql.DB) error {
|
|
logger.InfoToConsole("downgrading database version: 20 -> 19")
|
|
providerLog(logger.LevelInfo, "downgrading database version: 20 -> 19")
|
|
sql := strings.ReplaceAll(mysqlV20DownSQL, "{{events_actions}}", sqlTableEventsActions)
|
|
sql = strings.ReplaceAll(sql, "{{events_rules}}", sqlTableEventsRules)
|
|
sql = strings.ReplaceAll(sql, "{{rules_actions_mapping}}", sqlTableRulesActionsMapping)
|
|
sql = strings.ReplaceAll(sql, "{{users}}", sqlTableUsers)
|
|
sql = strings.ReplaceAll(sql, "{{tasks}}", sqlTableTasks)
|
|
return sqlCommonExecSQLAndUpdateDBVersion(dbHandle, strings.Split(sql, ";"), 19, false)
|
|
}
|