burmatovan/openuds
1
0
Fork 0
forked from shaba/openuds
Code Issues Pull Requests Projects Releases Wiki Activity

refactorizing uds.core.setransports: lenames & some fixes

Browse Source
This commit is contained in:
Adolfo Gómez García 2019-08-19 11:51:14 +02:00
parent 23834328dd
commit 22b079cf53
13 changed files with 16 additions and 338 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
server/src/uds/core/services/service.py
View File

@ -36,6 +36,7 @@ import typing
from django.utils.translation import ugettext_noop as _
from uds.core import Module
from uds.core.transports import protocols
from . import types
from .publication import Publication
from .user_deployment import UserDeployment

258
server/src/uds/core/transports/BaseTransport.py
View File

@ -1,258 +0,0 @@
# -*- coding: utf-8 -*-
#
# Copyright (c) 2012-2019 Virtual Cable S.L.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
# * Neither the name of Virtual Cable S.L. nor the names of its contributors
# may be used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""
@author: Adolfo Gómez, dkmaster at dkmon dot com
"""
import logging
import typing
from django.utils.translation import ugettext_noop as _
from uds.core.util import OsDetector
from uds.core import Module
from uds.core.transports import protocols
from uds.core.util import encoders
from uds.core.util import connection
# Not imported in runtime, just for type checking
if typing.TYPE_CHECKING:
from django.http import HttpRequest # pylint: disable=ungrouped-imports
from uds.core.environment import Environment
from uds import models
logger = logging.getLogger(__name__)
DIRECT_GROUP = _('Direct')
TUNNELED_GROUP = _('Tunneled')
class Transport(Module):
"""
An OS Manager is responsible for communication the service the different actions to take (i.e. adding a windows machine to a domain)
The Service (i.e. virtual machine) communicates with the OSManager via a published web method, that must include the unique ID.
In order to make easier to agents identify themselfs, the Unique ID can be a list with various Ids (i.e. the macs of the virtual machine).
Server will iterate thought them and look for an identifier associated with the service. This list is a comma separated values (i.e. AA:BB:CC:DD:EE:FF,00:11:22:...)
Remember also that we inherit the test and check methods from BaseModule
"""
# Transport informational related data, inherited from BaseModule
typeName = 'Base Transport Manager'
typeType = 'Base Transport'
typeDescription = 'Base Transport'
iconFile = 'transport.png'
# Supported names for OS (used right now, but lots of more names for sure)
# Windows
# Macintosh
# Linux
supportedOss: typing.Tuple = OsDetector.desktopOss # Supported operating systems
# If this transport is visible via Web, via Thin Client or both
webTransport: bool = False
tcTransport: bool = False
# If the link to use transport is provided by transport itself
ownLink: bool = False
# Protocol "type". This is not mandatory, but will help
protocol: str = protocols.NONE
# For allowing grouping transport on dashboard "new" menu, and maybe other places
group: str = DIRECT_GROUP
def __init__(self, environment: 'Environment', values: Module.ValuesType):
super().__init__(environment, values)
self.initialize(values)
def initialize(self, values: Module.ValuesType):
"""
This method will be invoked from __init__ constructor.
This is provided so you don't have to provide your own __init__ method,
and invoke base methods.
This will get invoked when all initialization stuff is done
Args:
Values: If values is not none, this object is being initialized
from administration interface, and not unmarshal will be done.
If it's None, this is initialized internally, and unmarshal will
be called after this.
Default implementation does nothing
"""
def destroy(self) -> None:
"""
Invoked when Transport is deleted
"""
def testServer(self, userService: 'models.UserService', ip: str, port: typing.Union[str, int], timeout: int = 4) -> bool:
proxy: 'models.Proxy' = userService.deployed_service.service.proxy
if proxy is not None:
return proxy.doTestServer(ip, port, timeout)
return connection.testServer(ip, str(port), timeout)
def isAvailableFor(self, userService: 'models.UserService', ip: str) -> bool:
"""
Checks if the transport is available for the requested destination ip
Override this in yours transports
"""
return False
def getCustomAvailableErrorMsg(self, userService: 'models.UserService', ip: str) -> str:
"""
Returns a customized error message, that will be used when a service fails to check "isAvailableFor"
Override this in yours transports if needed
"""
return "Not accessible (using service ip {})".format(ip)
@classmethod
def supportsProtocol(cls, protocol: typing.Union[typing.Iterable, str]):
if isinstance(protocol, str):
return protocol.lower() == cls.protocol.lower()
# Not string group of strings
for v in protocol:
if cls.supportsProtocol(v):
return True
return False
@classmethod
def supportsOs(cls, osName: str) -> bool:
"""
Helper method to check if transport supports requested operating system.
Class method
"""
logger.debug('Checking suported os %s against %s', osName, cls.supportedOss)
return cls.supportedOss.count(osName) > 0
@classmethod
def providesConnetionInfo(cls) -> bool:
"""
Helper method to check if transport provides information about connection
"""
return cls.getConnectionInfo != Transport.getConnectionInfo
def getConnectionInfo(self, userService: 'models.UserService', user: 'models.User', password: str) -> typing.Dict[str, str]:
"""
This method must provide information about connection.
We don't have to implement it, but if we wont to allow some types of connections
(such as Client applications, some kinds of TC, etc... we must provide it or those
kind of terminals/application will not work
Args:
userService: DeployedUserService for witch we are rendering the connection (db model), or ServicePool (db model)
user: user (dbUser) logged in
pass: password used in authentication
The expected result from this method is a dictionary, containing at least:
'protocol': protocol to use, (there are a few standard defined in 'protocols.py', if yours does not fit those, use your own name
'username': username (transformed if needed to) used to login to service
'password': password (transformed if needed to) used to login to service
'domain': domain (extracted from username or wherever) that will be used. (Not necesarily an AD domain)
:note: The provided service can be an user service or an deployed service (parent of user services).
I have implemented processUserPassword in both so in most cases we do not need if the service is
ServicePool or UserService. In case of processUserPassword for an ServicePool, no transformation
is done, because there is no relation at that level between user and service.
"""
return {'protocol': self.protocol, 'username': '', 'password': '', 'domain': ''}
def processedUser(self, userService: 'models.UserService', user: 'models.User') -> str:
"""
Used to "transform" username that will be sent to service
This is used to make the "user" that will receive the service match with that sent in notification
@return: transformed username
"""
return user.name
def getUDSTransportScript(
self,
userService: 'models.UserService',
transport: 'models.Transport',
ip: str,
os: typing.Dict[str, str],
user: 'models.User',
password: str,
request: 'HttpRequest'
) -> typing.Tuple[str, str, typing.Dict[str, str]]:
"""
If this is an uds transport, this will return the tranport script needed for executing
this on client
"""
return "raise Exception('The transport {transport} is not supported on your platform.'.format(transport=params['transport']))", \
'EH/91J7u9+/sHtB5+EUVRDW1+jqF0LuZzfRi8qxyIuSdJuWt'\
'8V8Yngu24p0NNr13TaxPQ1rpGN8x0NsU/Ma8k4GGohc+zxdf'\
'4xlkwMjAIytp8jaMHKkzvcihiIAMtaicP786FZCwGMmFTH4Z'\
'A9i7YWaSzT95h84kirAG67J0GWKiyATxs6mtxBNaLgqU4juA'\
'Qn98hYp5ffWa5FQDSAmheiDyQbCXMRwtWcxVHVQCAoZbsvCe'\
'njKc+FaeKNmXsYOgmcj+pz8IViNOyTbueP9u7lTzuBlIyV+7'\
'OlBPTqb5yA5wOBicKIpplPd8V71Oh3pdpRvdlvVbbwNfsCl5'\
'v6s1X20MxaQOSwM5z02eY1lJSbLIp8d9WRkfVty0HP/4Z8JZ'\
'kavkWNaGiKXEZXqojx/ZdzvTfvBkYrREQ8lMCIvtawBTysus'\
'IV4vHnDRdSmRxpYdj+1SNfzB0s1VuY6F7bSdBvgzja4P3Zbo'\
'Z63yNGuBhIsqUDA2ARmiMHRx9jr6eilFBKhoyWgNi9izTkar'\
'3iMYtXfvcFnmz4jvuJHUccbpUo4O31K2G7OaqlLylQ5dCu62'\
'JuVuquKKSfiwOIdYcdPJ6gvpgkQQDPqt7wN+duyZA0FI5F4h'\
'O6acQZmbjBCqZoo9Qsg7k9cTcalNkc5flEYAk1mULnddgDM6'\
'YGmoJgVnDr0=', {'transport': transport.name}
def getEncodedTransportScript(
self,
userService: 'models.UserService',
transport: 'models.Transport',
ip: str,
os: typing.Dict[str, str],
user: 'models.User',
password: str,
request: 'HttpRequest'
) -> typing.Tuple[str, str, typing.Dict[str, str]]:
"""
Encodes the script so the client can understand it
"""
script, signature, params = self.getUDSTransportScript(userService, transport, ip, os, user, password, request)
logger.debug('Transport script: %s', script)
return typing.cast(str, encoders.encode(encoders.encode(script, 'bz2'), 'base64', asText=True)).replace('\n', ''), signature, params
def getLink(
self,
userService: 'models.UserService',
transport: 'models.Transport',
ip: str,
os: typing.Dict[str, str],
user: 'models.User',
password: str,
request: 'HttpRequest'
) -> str:
"""
Must override if transport does provides its own link
If transport provides own link, this method provides the link itself
"""
return 'https://www.udsenterprise.com'
def __str__(self):
return 'Base OS Manager'

65
server/src/uds/core/transports/TransportsFactory.py
View File

@ -1,65 +0,0 @@
# -*- coding: utf-8 -*-
#
# Copyright (c) 2012-2019 Virtual Cable S.L.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
# * Neither the name of Virtual Cable S.L. nor the names of its contributors
# may be used to endorse or promote products derived from this software
# without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""
@author: Adolfo Gómez, dkmaster at dkmon dot com
"""
import logging
import typing
if typing.TYPE_CHECKING:
from .BaseTransport import Transport
logger = logging.getLogger(__name__)
class TransportsFactory:
_factory: typing.Optional['TransportsFactory'] = None
_transports: typing.Dict[str, typing.Type['Transport']]
def __init__(self):
self._transports = {}
@staticmethod
def factory() -> 'TransportsFactory':
if TransportsFactory._factory is None:
TransportsFactory._factory = TransportsFactory()
return TransportsFactory._factory
def providers(self) -> typing.Dict[str, typing.Type['Transport']]:
return self._transports
def insert(self, type_: typing.Type['Transport']) -> None:
logger.debug('Adding transport %s as %s', type_.type(), type_)
typeName = type_.type().lower()
self._transports[typeName] = type_
def lookup(self, typeName: str) -> typing.Optional[typing.Type['Transport']]:
return self._transports.get(typeName.lower(), None)

4
server/src/uds/core/transports/__init__.py
View File

@ -32,12 +32,12 @@ UDS Service modules interfaces and classes.
.. moduleauthor:: Adolfo Gómez, dkmaster at dkmon dot com
"""
from .BaseTransport import Transport
from .transport import Transport
def factory():
"""
Returns factory for register/access to service providers
"""
from .TransportsFactory import TransportsFactory
from .transport_factory import TransportsFactory
return TransportsFactory.factory()

4
server/src/uds/transports/HTML5RDP/HTML5RDP.py
View File

@ -38,8 +38,8 @@ from django.urls import reverse
from django.http import HttpResponseRedirect
from uds.core.ui import gui
from uds.core.transports.BaseTransport import Transport
from uds.core.transports.BaseTransport import TUNNELED_GROUP
from uds.core.transports.transport import Transport
from uds.core.transports.transport import TUNNELED_GROUP
from uds.core.transports import protocols
from uds.core.util import connection

2
server/src/uds/transports/NX/BaseNXTransport.py
View File

@ -35,7 +35,7 @@ import os
import logging
from typing import Tuple
from uds.core.transports.BaseTransport import Transport
from uds.core.transports.transport import Transport
logger = logging.getLogger(__name__)

4
server/src/uds/transports/NX/TSNXTransport.py
View File

@ -35,8 +35,8 @@ Created on Jul 29, 2011
from django.utils.translation import ugettext_noop as _
from uds.core.managers.user_preferences import CommonPrefs
from uds.core.ui import gui
from uds.core.transports.BaseTransport import Transport
from uds.core.transports.BaseTransport import TUNNELED_GROUP
from uds.core.transports.transport import Transport
from uds.core.transports.transport import TUNNELED_GROUP
from uds.core.transports import protocols
from uds.models import TicketStore
from uds.core.util import OsDetector

2
server/src/uds/transports/RDP/BaseRDPTransport.py
View File

@ -33,7 +33,7 @@
from django.utils.translation import ugettext_noop as _
from uds.core.ui import gui
from uds.core.transports.BaseTransport import Transport
from uds.core.transports.transport import Transport
from uds.core.transports import protocols
from typing import Tuple

4
server/src/uds/transports/RDP/TRDPTransport.py
View File

@ -34,8 +34,8 @@ from __future__ import unicode_literals
from django.utils.translation import ugettext_noop as _
from uds.core.managers.user_preferences import CommonPrefs
from uds.core.ui import gui
from uds.core.transports.BaseTransport import Transport
from uds.core.transports.BaseTransport import TUNNELED_GROUP
from uds.core.transports.transport import Transport
from uds.core.transports.transport import TUNNELED_GROUP
from uds.core.transports import protocols
from uds.models import TicketStore
from uds.core.util import OsDetector

2
server/src/uds/transports/SPICE/BaseSPICETransport.py
View File

@ -34,7 +34,7 @@
from django.utils.translation import ugettext_noop as _
from uds.core.managers.user_preferences import CommonPrefs
from uds.core.ui import gui
from uds.core.transports.BaseTransport import Transport
from uds.core.transports.transport import Transport
from uds.core.transports import protocols
from uds.core.util import connection

4
server/src/uds/transports/SPICE/TSPICETransport.py
View File

@ -33,8 +33,8 @@
from django.utils.translation import ugettext_noop as _
from uds.core.ui import gui
from uds.core.transports.BaseTransport import Transport
from uds.core.transports.BaseTransport import TUNNELED_GROUP
from uds.core.transports.transport import Transport
from uds.core.transports.transport import TUNNELED_GROUP
from uds.core.transports import protocols
from uds.core.util import OsDetector
from uds.core.util import tools

2
server/src/uds/transports/X2GO/BaseX2GOTransport.py
View File

@ -35,7 +35,7 @@ from django.utils.translation import ugettext_noop as _
from uds.core.managers.user_preferences import CommonPrefs
from uds.core.managers import userServiceManager
from uds.core.ui import gui
from uds.core.transports.BaseTransport import Transport
from uds.core.transports.transport import Transport
from uds.core.transports import protocols
from uds.core.util import OsDetector
from uds.core.util import connection

2
server/src/uds/transports/X2GO/TX2GOTransport.py
View File

@ -36,7 +36,7 @@ from uds.core.ui import gui
from uds.core.managers.user_preferences import CommonPrefs
from uds.core.util import OsDetector
from uds.core.util import tools
from uds.core.transports.BaseTransport import TUNNELED_GROUP
from uds.core.transports.transport import TUNNELED_GROUP
from uds.models import TicketStore
from .BaseX2GOTransport import BaseX2GOTransport
from . import x2gofile