from django.db import models from django.utils.translation import gettext_lazy as _ from common.db.models import ChoicesMixin from common.decorators import cached_method from .base import FillType __all__ = ['Protocol'] class Protocol(ChoicesMixin, models.TextChoices): ssh = 'ssh', 'SSH' rdp = 'rdp', 'RDP' telnet = 'telnet', 'Telnet' vnc = 'vnc', 'VNC' winrm = 'winrm', 'WinRM' mysql = 'mysql', 'MySQL' mariadb = 'mariadb', 'MariaDB' oracle = 'oracle', 'Oracle' postgresql = 'postgresql', 'PostgreSQL' sqlserver = 'sqlserver', 'SQLServer' clickhouse = 'clickhouse', 'ClickHouse' redis = 'redis', 'Redis' mongodb = 'mongodb', 'MongoDB' k8s = 'k8s', 'K8S' http = 'http', 'HTTP(s)' chatgpt = 'chatgpt', 'ChatGPT' @classmethod def device_protocols(cls): return { cls.ssh: { 'port': 22, 'secret_types': ['password', 'ssh_key'], 'setting': { 'sftp_enabled': { 'type': 'bool', 'default': True, 'label': _('SFTP enabled') }, 'sftp_home': { 'type': 'str', 'default': '/tmp', 'label': _('SFTP home') }, } }, cls.rdp: { 'port': 3389, 'secret_types': ['password'], 'setting': { 'console': { 'type': 'bool', 'default': False, 'label': _('Console'), 'help_text': _("Connect to console session") }, 'security': { 'type': 'choice', 'choices': [('any', _('Any')), ('rdp', 'RDP'), ('tls', 'TLS'), ('nla', 'NLA')], 'default': 'any', 'label': _('Security'), 'help_text': _("Security layer to use for the connection") }, 'ad_domain': { 'type': 'str', 'required': False, 'default': '', 'label': _('AD domain') } } }, cls.vnc: { 'port': 5900, 'secret_types': ['password'], }, cls.telnet: { 'port': 23, 'secret_types': ['password'], }, cls.winrm: { 'port': 5985, 'secret_types': ['password'], 'setting': { 'use_ssl': { 'type': 'bool', 'default': False, 'label': _('Use SSL') }, } }, } @classmethod def database_protocols(cls): return { cls.mysql: { 'port': 3306, 'setting': {}, 'required': True, 'secret_types': ['password'], }, cls.mariadb: { 'port': 3306, 'required': True, 'secret_types': ['password'], }, cls.postgresql: { 'port': 5432, 'required': True, 'secret_types': ['password'], }, cls.oracle: { 'port': 1521, 'required': True, 'secret_types': ['password'], }, cls.sqlserver: { 'port': 1433, 'required': True, 'secret_types': ['password'], }, cls.clickhouse: { 'port': 9000, 'required': True, 'secret_types': ['password'], }, cls.mongodb: { 'port': 27017, 'required': True, 'secret_types': ['password'], }, cls.redis: { 'port': 6379, 'required': True, 'secret_types': ['password'], 'setting': { 'auth_username': { 'type': 'bool', 'default': False, 'label': _('Auth username') }, } }, } @classmethod def cloud_protocols(cls): return { cls.k8s: { 'port': 443, 'port_from_addr': True, 'required': True, 'secret_types': ['token'], }, cls.http: { 'port': 80, 'port_from_addr': True, 'secret_types': ['password'], 'setting': { 'autofill': { 'type': 'choice', 'choices': FillType.choices, 'default': 'basic', }, 'username_selector': { 'type': 'str', 'default': 'name=username', 'label': _('Username selector') }, 'password_selector': { 'type': 'str', 'default': 'name=password', 'label': _('Password selector') }, 'submit_selector': { 'type': 'str', 'default': 'type=submit', 'label': _('Submit selector') } } }, } @classmethod def gpt_protocols(cls): return { cls.chatgpt: { 'port': 443, 'required': True, 'port_from_addr': True, 'secret_types': ['api_key'], 'setting': { 'api_mode': { 'type': 'choice', 'default': 'gpt-3.5-turbo', 'label': _('API mode'), 'choices': [ ('gpt-3.5-turbo', 'GPT-3.5 Turbo'), ('gpt-3.5-turbo-16k', 'GPT-3.5 Turbo 16K'), ('gpt-4', 'GPT-4'), ('gpt-4-32k', 'GPT-4 32K'), ] } } } } @classmethod @cached_method(ttl=600) def settings(cls): return { **cls.device_protocols(), **cls.database_protocols(), **cls.cloud_protocols(), **cls.gpt_protocols(), } @classmethod def protocol_secret_types(cls): settings = cls.settings() return { protocol: settings[protocol]['secret_types'] or ['password'] for protocol in cls.settings() }