123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814 |
- // Copyright (C) 2019-2023 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/>.
- // Package plugin provides support for the SFTPGo plugin system
- package plugin
- import (
- "crypto/sha256"
- "crypto/x509"
- "encoding/hex"
- "errors"
- "fmt"
- "sync"
- "sync/atomic"
- "time"
- "github.com/hashicorp/go-hclog"
- "github.com/hashicorp/go-plugin"
- "github.com/sftpgo/sdk/plugin/auth"
- "github.com/sftpgo/sdk/plugin/eventsearcher"
- "github.com/sftpgo/sdk/plugin/ipfilter"
- kmsplugin "github.com/sftpgo/sdk/plugin/kms"
- "github.com/sftpgo/sdk/plugin/metadata"
- "github.com/sftpgo/sdk/plugin/notifier"
- "github.com/drakkan/sftpgo/v2/internal/kms"
- "github.com/drakkan/sftpgo/v2/internal/logger"
- "github.com/drakkan/sftpgo/v2/internal/util"
- )
- const (
- logSender = "plugins"
- )
- var (
- // Handler defines the plugins manager
- Handler Manager
- pluginsLogLevel = hclog.Debug
- // ErrNoSearcher defines the error to return for events searches if no plugin is configured
- ErrNoSearcher = errors.New("no events searcher plugin defined")
- // ErrNoMetadater returns the error to return for metadata methods if no plugin is configured
- ErrNoMetadater = errors.New("no metadata plugin defined")
- )
- // Renderer defines the interface for generic objects rendering
- type Renderer interface {
- RenderAsJSON(reload bool) ([]byte, error)
- }
- // Config defines a plugin configuration
- type Config struct {
- // Plugin type
- Type string `json:"type" mapstructure:"type"`
- // NotifierOptions defines options for notifiers plugins
- NotifierOptions NotifierConfig `json:"notifier_options" mapstructure:"notifier_options"`
- // KMSOptions defines options for a KMS plugin
- KMSOptions KMSConfig `json:"kms_options" mapstructure:"kms_options"`
- // AuthOptions defines options for authentication plugins
- AuthOptions AuthConfig `json:"auth_options" mapstructure:"auth_options"`
- // Path to the plugin executable
- Cmd string `json:"cmd" mapstructure:"cmd"`
- // Args to pass to the plugin executable
- Args []string `json:"args" mapstructure:"args"`
- // SHA256 checksum for the plugin executable.
- // If not empty it will be used to verify the integrity of the executable
- SHA256Sum string `json:"sha256sum" mapstructure:"sha256sum"`
- // If enabled the client and the server automatically negotiate mTLS for
- // transport authentication. This ensures that only the original client will
- // be allowed to connect to the server, and all other connections will be
- // rejected. The client will also refuse to connect to any server that isn't
- // the original instance started by the client.
- AutoMTLS bool `json:"auto_mtls" mapstructure:"auto_mtls"`
- // unique identifier for kms plugins
- kmsID int
- }
- func (c *Config) getSecureConfig() (*plugin.SecureConfig, error) {
- if c.SHA256Sum != "" {
- checksum, err := hex.DecodeString(c.SHA256Sum)
- if err != nil {
- return nil, fmt.Errorf("invalid sha256 hash %q: %w", c.SHA256Sum, err)
- }
- return &plugin.SecureConfig{
- Checksum: checksum,
- Hash: sha256.New(),
- }, nil
- }
- return nil, nil
- }
- func (c *Config) newKMSPluginSecretProvider(base kms.BaseSecret, url, masterKey string) kms.SecretProvider {
- return &kmsPluginSecretProvider{
- BaseSecret: base,
- URL: url,
- MasterKey: masterKey,
- config: c,
- }
- }
- // Manager handles enabled plugins
- type Manager struct {
- closed atomic.Bool
- done chan bool
- // List of configured plugins
- Configs []Config `json:"plugins" mapstructure:"plugins"`
- notifLock sync.RWMutex
- notifiers []*notifierPlugin
- kmsLock sync.RWMutex
- kms []*kmsPlugin
- authLock sync.RWMutex
- auths []*authPlugin
- searcherLock sync.RWMutex
- searcher *searcherPlugin
- metadaterLock sync.RWMutex
- metadater *metadataPlugin
- ipFilterLock sync.RWMutex
- filter *ipFilterPlugin
- authScopes int
- hasSearcher bool
- hasMetadater bool
- hasNotifiers bool
- hasAuths bool
- hasIPFilter bool
- concurrencyGuard chan struct{}
- }
- // Initialize initializes the configured plugins
- func Initialize(configs []Config, logLevel string) error {
- logger.Debug(logSender, "", "initialize")
- Handler = Manager{
- Configs: configs,
- done: make(chan bool),
- authScopes: -1,
- concurrencyGuard: make(chan struct{}, 250),
- }
- Handler.closed.Store(false)
- setLogLevel(logLevel)
- if len(configs) == 0 {
- return nil
- }
- if err := Handler.validateConfigs(); err != nil {
- return err
- }
- if err := initializePlugins(); err != nil {
- return err
- }
- startCheckTicker()
- return nil
- }
- func initializePlugins() error {
- kmsID := 0
- for idx, config := range Handler.Configs {
- switch config.Type {
- case notifier.PluginName:
- plugin, err := newNotifierPlugin(config)
- if err != nil {
- return err
- }
- Handler.notifiers = append(Handler.notifiers, plugin)
- case kmsplugin.PluginName:
- plugin, err := newKMSPlugin(config)
- if err != nil {
- return err
- }
- Handler.kms = append(Handler.kms, plugin)
- Handler.Configs[idx].kmsID = kmsID
- kmsID++
- kms.RegisterSecretProvider(config.KMSOptions.Scheme, config.KMSOptions.EncryptedStatus,
- Handler.Configs[idx].newKMSPluginSecretProvider)
- logger.Info(logSender, "", "registered secret provider for scheme: %v, encrypted status: %v",
- config.KMSOptions.Scheme, config.KMSOptions.EncryptedStatus)
- case auth.PluginName:
- plugin, err := newAuthPlugin(config)
- if err != nil {
- return err
- }
- Handler.auths = append(Handler.auths, plugin)
- if Handler.authScopes == -1 {
- Handler.authScopes = config.AuthOptions.Scope
- } else {
- Handler.authScopes |= config.AuthOptions.Scope
- }
- case eventsearcher.PluginName:
- plugin, err := newSearcherPlugin(config)
- if err != nil {
- return err
- }
- Handler.searcher = plugin
- case metadata.PluginName:
- plugin, err := newMetadaterPlugin(config)
- if err != nil {
- return err
- }
- Handler.metadater = plugin
- case ipfilter.PluginName:
- plugin, err := newIPFilterPlugin(config)
- if err != nil {
- return err
- }
- Handler.filter = plugin
- default:
- return fmt.Errorf("unsupported plugin type: %v", config.Type)
- }
- }
- return nil
- }
- func (m *Manager) validateConfigs() error {
- kmsSchemes := make(map[string]bool)
- kmsEncryptions := make(map[string]bool)
- m.hasSearcher = false
- m.hasMetadater = false
- m.hasNotifiers = false
- m.hasAuths = false
- m.hasIPFilter = false
- for _, config := range m.Configs {
- switch config.Type {
- case kmsplugin.PluginName:
- if _, ok := kmsSchemes[config.KMSOptions.Scheme]; ok {
- return fmt.Errorf("invalid KMS configuration, duplicated scheme %q", config.KMSOptions.Scheme)
- }
- if _, ok := kmsEncryptions[config.KMSOptions.EncryptedStatus]; ok {
- return fmt.Errorf("invalid KMS configuration, duplicated encrypted status %q", config.KMSOptions.EncryptedStatus)
- }
- kmsSchemes[config.KMSOptions.Scheme] = true
- kmsEncryptions[config.KMSOptions.EncryptedStatus] = true
- case eventsearcher.PluginName:
- if m.hasSearcher {
- return errors.New("only one eventsearcher plugin can be defined")
- }
- m.hasSearcher = true
- case metadata.PluginName:
- if m.hasMetadater {
- return errors.New("only one metadata plugin can be defined")
- }
- m.hasMetadater = true
- case notifier.PluginName:
- m.hasNotifiers = true
- case auth.PluginName:
- m.hasAuths = true
- case ipfilter.PluginName:
- m.hasIPFilter = true
- }
- }
- return nil
- }
- // HasAuthenticators returns true if there is at least an auth plugin
- func (m *Manager) HasAuthenticators() bool {
- return m.hasAuths
- }
- // HasNotifiers returns true if there is at least a notifier plugin
- func (m *Manager) HasNotifiers() bool {
- return m.hasNotifiers
- }
- // NotifyFsEvent sends the fs event notifications using any defined notifier plugins
- func (m *Manager) NotifyFsEvent(event *notifier.FsEvent) {
- m.notifLock.RLock()
- defer m.notifLock.RUnlock()
- for _, n := range m.notifiers {
- n.notifyFsAction(event)
- }
- }
- // NotifyProviderEvent sends the provider event notifications using any defined notifier plugins
- func (m *Manager) NotifyProviderEvent(event *notifier.ProviderEvent, object Renderer) {
- m.notifLock.RLock()
- defer m.notifLock.RUnlock()
- for _, n := range m.notifiers {
- n.notifyProviderAction(event, object)
- }
- }
- // HasSearcher returns true if an event searcher plugin is defined
- func (m *Manager) HasSearcher() bool {
- return m.hasSearcher
- }
- // SearchFsEvents returns the filesystem events matching the specified filters
- func (m *Manager) SearchFsEvents(searchFilters *eventsearcher.FsEventSearch) ([]byte, []string, []string, error) {
- if !m.hasSearcher {
- return nil, nil, nil, ErrNoSearcher
- }
- m.searcherLock.RLock()
- plugin := m.searcher
- m.searcherLock.RUnlock()
- return plugin.searchear.SearchFsEvents(searchFilters)
- }
- // SearchProviderEvents returns the provider events matching the specified filters
- func (m *Manager) SearchProviderEvents(searchFilters *eventsearcher.ProviderEventSearch) ([]byte, []string, []string, error) {
- if !m.hasSearcher {
- return nil, nil, nil, ErrNoSearcher
- }
- m.searcherLock.RLock()
- plugin := m.searcher
- m.searcherLock.RUnlock()
- return plugin.searchear.SearchProviderEvents(searchFilters)
- }
- // HasMetadater returns true if a metadata plugin is defined
- func (m *Manager) HasMetadater() bool {
- return m.hasMetadater
- }
- // SetModificationTime sets the modification time for the specified object
- func (m *Manager) SetModificationTime(storageID, objectPath string, mTime int64) error {
- if !m.hasMetadater {
- return ErrNoMetadater
- }
- m.metadaterLock.RLock()
- plugin := m.metadater
- m.metadaterLock.RUnlock()
- return plugin.metadater.SetModificationTime(storageID, objectPath, mTime)
- }
- // GetModificationTime returns the modification time for the specified path
- func (m *Manager) GetModificationTime(storageID, objectPath string, isDir bool) (int64, error) {
- if !m.hasMetadater {
- return 0, ErrNoMetadater
- }
- m.metadaterLock.RLock()
- plugin := m.metadater
- m.metadaterLock.RUnlock()
- return plugin.metadater.GetModificationTime(storageID, objectPath)
- }
- // GetModificationTimes returns the modification times for all the files within the specified folder
- func (m *Manager) GetModificationTimes(storageID, objectPath string) (map[string]int64, error) {
- if !m.hasMetadater {
- return nil, ErrNoMetadater
- }
- m.metadaterLock.RLock()
- plugin := m.metadater
- m.metadaterLock.RUnlock()
- return plugin.metadater.GetModificationTimes(storageID, objectPath)
- }
- // RemoveMetadata deletes the metadata stored for the specified object
- func (m *Manager) RemoveMetadata(storageID, objectPath string) error {
- if !m.hasMetadater {
- return ErrNoMetadater
- }
- m.metadaterLock.RLock()
- plugin := m.metadater
- m.metadaterLock.RUnlock()
- return plugin.metadater.RemoveMetadata(storageID, objectPath)
- }
- // GetMetadataFolders returns the folders that metadata is associated with
- func (m *Manager) GetMetadataFolders(storageID, from string, limit int) ([]string, error) {
- if !m.hasMetadater {
- return nil, ErrNoMetadater
- }
- m.metadaterLock.RLock()
- plugin := m.metadater
- m.metadaterLock.RUnlock()
- return plugin.metadater.GetFolders(storageID, limit, from)
- }
- // IsIPBanned returns true if the IP filter plugin does not allow the specified ip.
- // If no IP filter plugin is defined this method returns false
- func (m *Manager) IsIPBanned(ip, protocol string) bool {
- if !m.hasIPFilter {
- return false
- }
- m.ipFilterLock.RLock()
- plugin := m.filter
- m.ipFilterLock.RUnlock()
- if plugin.exited() {
- logger.Warn(logSender, "", "ip filter plugin is not active, cannot check ip %q", ip)
- return false
- }
- return plugin.filter.CheckIP(ip, protocol) != nil
- }
- // ReloadFilter sends a reload request to the IP filter plugin
- func (m *Manager) ReloadFilter() {
- if !m.hasIPFilter {
- return
- }
- m.ipFilterLock.RLock()
- plugin := m.filter
- m.ipFilterLock.RUnlock()
- if err := plugin.filter.Reload(); err != nil {
- logger.Error(logSender, "", "unable to reload IP filter plugin: %v", err)
- }
- }
- func (m *Manager) kmsEncrypt(secret kms.BaseSecret, url string, masterKey string, kmsID int) (string, string, int32, error) {
- m.kmsLock.RLock()
- plugin := m.kms[kmsID]
- m.kmsLock.RUnlock()
- return plugin.Encrypt(secret, url, masterKey)
- }
- func (m *Manager) kmsDecrypt(secret kms.BaseSecret, url string, masterKey string, kmsID int) (string, error) {
- m.kmsLock.RLock()
- plugin := m.kms[kmsID]
- m.kmsLock.RUnlock()
- return plugin.Decrypt(secret, url, masterKey)
- }
- // HasAuthScope returns true if there is an auth plugin that support the specified scope
- func (m *Manager) HasAuthScope(scope int) bool {
- if m.authScopes == -1 {
- return false
- }
- return m.authScopes&scope != 0
- }
- // Authenticate tries to authenticate the specified user using an external plugin
- func (m *Manager) Authenticate(username, password, ip, protocol string, pkey string,
- tlsCert *x509.Certificate, authScope int, userAsJSON []byte,
- ) ([]byte, error) {
- switch authScope {
- case AuthScopePassword:
- return m.checkUserAndPass(username, password, ip, protocol, userAsJSON)
- case AuthScopePublicKey:
- return m.checkUserAndPublicKey(username, pkey, ip, protocol, userAsJSON)
- case AuthScopeKeyboardInteractive:
- return m.checkUserAndKeyboardInteractive(username, ip, protocol, userAsJSON)
- case AuthScopeTLSCertificate:
- cert, err := util.EncodeTLSCertToPem(tlsCert)
- if err != nil {
- logger.Error(logSender, "", "unable to encode tls certificate to pem: %v", err)
- return nil, fmt.Errorf("unable to encode tls cert to pem: %w", err)
- }
- return m.checkUserAndTLSCert(username, cert, ip, protocol, userAsJSON)
- default:
- return nil, fmt.Errorf("unsupported auth scope: %v", authScope)
- }
- }
- // ExecuteKeyboardInteractiveStep executes a keyboard interactive step
- func (m *Manager) ExecuteKeyboardInteractiveStep(req *KeyboardAuthRequest) (*KeyboardAuthResponse, error) {
- var plugin *authPlugin
- m.authLock.Lock()
- for _, p := range m.auths {
- if p.config.AuthOptions.Scope&AuthScopePassword != 0 {
- plugin = p
- break
- }
- }
- m.authLock.Unlock()
- if plugin == nil {
- return nil, errors.New("no auth plugin configured for keyaboard interactive authentication step")
- }
- return plugin.sendKeyboardIteractiveRequest(req)
- }
- func (m *Manager) checkUserAndPass(username, password, ip, protocol string, userAsJSON []byte) ([]byte, error) {
- var plugin *authPlugin
- m.authLock.Lock()
- for _, p := range m.auths {
- if p.config.AuthOptions.Scope&AuthScopePassword != 0 {
- plugin = p
- break
- }
- }
- m.authLock.Unlock()
- if plugin == nil {
- return nil, errors.New("no auth plugin configured for password checking")
- }
- return plugin.checkUserAndPass(username, password, ip, protocol, userAsJSON)
- }
- func (m *Manager) checkUserAndPublicKey(username, pubKey, ip, protocol string, userAsJSON []byte) ([]byte, error) {
- var plugin *authPlugin
- m.authLock.Lock()
- for _, p := range m.auths {
- if p.config.AuthOptions.Scope&AuthScopePublicKey != 0 {
- plugin = p
- break
- }
- }
- m.authLock.Unlock()
- if plugin == nil {
- return nil, errors.New("no auth plugin configured for public key checking")
- }
- return plugin.checkUserAndPublicKey(username, pubKey, ip, protocol, userAsJSON)
- }
- func (m *Manager) checkUserAndTLSCert(username, tlsCert, ip, protocol string, userAsJSON []byte) ([]byte, error) {
- var plugin *authPlugin
- m.authLock.Lock()
- for _, p := range m.auths {
- if p.config.AuthOptions.Scope&AuthScopeTLSCertificate != 0 {
- plugin = p
- break
- }
- }
- m.authLock.Unlock()
- if plugin == nil {
- return nil, errors.New("no auth plugin configured for TLS certificate checking")
- }
- return plugin.checkUserAndTLSCertificate(username, tlsCert, ip, protocol, userAsJSON)
- }
- func (m *Manager) checkUserAndKeyboardInteractive(username, ip, protocol string, userAsJSON []byte) ([]byte, error) {
- var plugin *authPlugin
- m.authLock.Lock()
- for _, p := range m.auths {
- if p.config.AuthOptions.Scope&AuthScopeKeyboardInteractive != 0 {
- plugin = p
- break
- }
- }
- m.authLock.Unlock()
- if plugin == nil {
- return nil, errors.New("no auth plugin configured for keyboard interactive checking")
- }
- return plugin.checkUserAndKeyboardInteractive(username, ip, protocol, userAsJSON)
- }
- func (m *Manager) checkCrashedPlugins() {
- m.notifLock.RLock()
- for idx, n := range m.notifiers {
- if n.exited() {
- defer func(cfg Config, index int) {
- Handler.restartNotifierPlugin(cfg, index)
- }(n.config, idx)
- } else {
- n.sendQueuedEvents()
- }
- }
- m.notifLock.RUnlock()
- m.kmsLock.RLock()
- for idx, k := range m.kms {
- if k.exited() {
- defer func(cfg Config, index int) {
- Handler.restartKMSPlugin(cfg, index)
- }(k.config, idx)
- }
- }
- m.kmsLock.RUnlock()
- m.authLock.RLock()
- for idx, a := range m.auths {
- if a.exited() {
- defer func(cfg Config, index int) {
- Handler.restartAuthPlugin(cfg, index)
- }(a.config, idx)
- }
- }
- m.authLock.RUnlock()
- if m.hasSearcher {
- m.searcherLock.RLock()
- if m.searcher.exited() {
- defer func(cfg Config) {
- Handler.restartSearcherPlugin(cfg)
- }(m.searcher.config)
- }
- m.searcherLock.RUnlock()
- }
- if m.hasMetadater {
- m.metadaterLock.RLock()
- if m.metadater.exited() {
- defer func(cfg Config) {
- Handler.restartMetadaterPlugin(cfg)
- }(m.metadater.config)
- }
- m.metadaterLock.RUnlock()
- }
- if m.hasIPFilter {
- m.ipFilterLock.RLock()
- if m.filter.exited() {
- defer func(cfg Config) {
- Handler.restartIPFilterPlugin(cfg)
- }(m.filter.config)
- }
- m.ipFilterLock.RUnlock()
- }
- }
- func (m *Manager) restartNotifierPlugin(config Config, idx int) {
- if m.closed.Load() {
- return
- }
- logger.Info(logSender, "", "try to restart crashed notifier plugin %q, idx: %v", config.Cmd, idx)
- plugin, err := newNotifierPlugin(config)
- if err != nil {
- logger.Error(logSender, "", "unable to restart notifier plugin %q, err: %v", config.Cmd, err)
- return
- }
- m.notifLock.Lock()
- plugin.queue = m.notifiers[idx].queue
- m.notifiers[idx] = plugin
- m.notifLock.Unlock()
- plugin.sendQueuedEvents()
- }
- func (m *Manager) restartKMSPlugin(config Config, idx int) {
- if m.closed.Load() {
- return
- }
- logger.Info(logSender, "", "try to restart crashed kms plugin %q, idx: %v", config.Cmd, idx)
- plugin, err := newKMSPlugin(config)
- if err != nil {
- logger.Error(logSender, "", "unable to restart kms plugin %q, err: %v", config.Cmd, err)
- return
- }
- m.kmsLock.Lock()
- m.kms[idx] = plugin
- m.kmsLock.Unlock()
- }
- func (m *Manager) restartAuthPlugin(config Config, idx int) {
- if m.closed.Load() {
- return
- }
- logger.Info(logSender, "", "try to restart crashed auth plugin %q, idx: %v", config.Cmd, idx)
- plugin, err := newAuthPlugin(config)
- if err != nil {
- logger.Error(logSender, "", "unable to restart auth plugin %q, err: %v", config.Cmd, err)
- return
- }
- m.authLock.Lock()
- m.auths[idx] = plugin
- m.authLock.Unlock()
- }
- func (m *Manager) restartSearcherPlugin(config Config) {
- if m.closed.Load() {
- return
- }
- logger.Info(logSender, "", "try to restart crashed searcher plugin %q", config.Cmd)
- plugin, err := newSearcherPlugin(config)
- if err != nil {
- logger.Error(logSender, "", "unable to restart searcher plugin %q, err: %v", config.Cmd, err)
- return
- }
- m.searcherLock.Lock()
- m.searcher = plugin
- m.searcherLock.Unlock()
- }
- func (m *Manager) restartMetadaterPlugin(config Config) {
- if m.closed.Load() {
- return
- }
- logger.Info(logSender, "", "try to restart crashed metadater plugin %q", config.Cmd)
- plugin, err := newMetadaterPlugin(config)
- if err != nil {
- logger.Error(logSender, "", "unable to restart metadater plugin %q, err: %v", config.Cmd, err)
- return
- }
- m.metadaterLock.Lock()
- m.metadater = plugin
- m.metadaterLock.Unlock()
- }
- func (m *Manager) restartIPFilterPlugin(config Config) {
- if m.closed.Load() {
- return
- }
- logger.Info(logSender, "", "try to restart crashed IP filter plugin %q", config.Cmd)
- plugin, err := newIPFilterPlugin(config)
- if err != nil {
- logger.Error(logSender, "", "unable to restart IP filter plugin %q, err: %v", config.Cmd, err)
- return
- }
- m.ipFilterLock.Lock()
- m.filter = plugin
- m.ipFilterLock.Unlock()
- }
- func (m *Manager) addTask() {
- m.concurrencyGuard <- struct{}{}
- }
- func (m *Manager) removeTask() {
- <-m.concurrencyGuard
- }
- // Cleanup releases all the active plugins
- func (m *Manager) Cleanup() {
- if m.closed.Swap(true) {
- return
- }
- logger.Debug(logSender, "", "cleanup")
- close(m.done)
- m.notifLock.Lock()
- for _, n := range m.notifiers {
- logger.Debug(logSender, "", "cleanup notifier plugin %v", n.config.Cmd)
- n.cleanup()
- }
- m.notifLock.Unlock()
- m.kmsLock.Lock()
- for _, k := range m.kms {
- logger.Debug(logSender, "", "cleanup kms plugin %v", k.config.Cmd)
- k.cleanup()
- }
- m.kmsLock.Unlock()
- m.authLock.Lock()
- for _, a := range m.auths {
- logger.Debug(logSender, "", "cleanup auth plugin %v", a.config.Cmd)
- a.cleanup()
- }
- m.authLock.Unlock()
- if m.hasSearcher {
- m.searcherLock.Lock()
- logger.Debug(logSender, "", "cleanup searcher plugin %v", m.searcher.config.Cmd)
- m.searcher.cleanup()
- m.searcherLock.Unlock()
- }
- if m.hasMetadater {
- m.metadaterLock.Lock()
- logger.Debug(logSender, "", "cleanup metadater plugin %v", m.metadater.config.Cmd)
- m.metadater.cleanup()
- m.metadaterLock.Unlock()
- }
- if m.hasIPFilter {
- m.ipFilterLock.Lock()
- logger.Debug(logSender, "", "cleanup IP filter plugin %v", m.filter.config.Cmd)
- m.filter.cleanup()
- m.ipFilterLock.Unlock()
- }
- }
- func setLogLevel(logLevel string) {
- switch logLevel {
- case "info":
- pluginsLogLevel = hclog.Info
- case "warn":
- pluginsLogLevel = hclog.Warn
- case "error":
- pluginsLogLevel = hclog.Error
- default:
- pluginsLogLevel = hclog.Debug
- }
- }
- func startCheckTicker() {
- logger.Debug(logSender, "", "start plugins checker")
- go func() {
- ticker := time.NewTicker(30 * time.Second)
- defer ticker.Stop()
- for {
- select {
- case <-Handler.done:
- logger.Debug(logSender, "", "handler done, stop plugins checker")
- return
- case <-ticker.C:
- Handler.checkCrashedPlugins()
- }
- }
- }()
- }
|