cmdctl.py.in 17.4 KB
Newer Older
Jeremy C. Reed's avatar
Jeremy C. Reed committed
1 2
#!@PYTHON@

Likun Zhang's avatar
Likun Zhang committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
# Copyright (C) 2010  Internet Systems Consortium.
#
# Permission to use, copy, modify, and distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SYSTEMS CONSORTIUM
# DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
# INTERNET SYSTEMS CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
# FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

18 19 20 21 22 23 24 25 26 27
''' cmdctl module is the configuration entry point for all commands from bindctl
or some other web tools client of bind10. cmdctl is pure https server which provi-
des RESTful API. When command client connecting with cmdctl, it should first login 
with legal username and password. 
    When cmdctl starting up, it will collect command specification and 
configuration specification/data of other available modules from configmanager, then
wait for receiving request from client, parse the request and resend the request to
the proper module. When getting the request result from the module, send back the 
resut to client.
'''
Likun Zhang's avatar
Likun Zhang committed
28

29
import sys; sys.path.append ('@@PYTHONPATH@@')
30
import os
Likun Zhang's avatar
Likun Zhang committed
31 32 33 34 35
import http.server
import urllib.parse
import json
import re
import ssl, socket
36
import isc
Likun Zhang's avatar
Likun Zhang committed
37 38 39 40
import pprint
import select
import csv
import random
41 42 43
import time
import signal
from optparse import OptionParser, OptionValueError
Likun Zhang's avatar
Likun Zhang committed
44 45 46 47 48 49
from hashlib import sha1
try:
    import threading
except ImportError:
    import dummy_threading as threading

50
__version__ = 'BIND10'
Likun Zhang's avatar
Likun Zhang committed
51
URL_PATTERN = re.compile('/([\w]+)(?:/([\w]+))?/?')
52 53 54 55 56 57 58 59 60 61 62

# If B10_FROM_SOURCE is set in the environment, we use data files
# from a directory relative to that, otherwise we use the ones
# installed on the system
if "B10_FROM_SOURCE" in os.environ:
    SPECFILE_PATH = os.environ["B10_FROM_SOURCE"] + "/src/bin/cmdctl"
else:
    PREFIX = "@prefix@"
    DATAROOTDIR = "@datarootdir@"
    SPECFILE_PATH = "@datadir@/@PACKAGE@".replace("${datarootdir}", DATAROOTDIR).replace("${prefix}", PREFIX)
SPECFILE_LOCATION = SPECFILE_PATH + "/cmdctl.spec"
63 64 65
USER_INFO_FILE = SPECFILE_PATH + "/cmdctl-accounts.csv"
PRIVATE_KEY_FILE = SPECFILE_PATH + "/cmdctl-keyfile.pem"
CERTIFICATE_FILE = SPECFILE_PATH + "/cmdctl-certfile.pem"
Likun Zhang's avatar
Likun Zhang committed
66 67
        
class SecureHTTPRequestHandler(http.server.BaseHTTPRequestHandler):
68 69
    '''https connection request handler.
    Currently only GET and POST are supported.
Likun Zhang's avatar
Likun Zhang committed
70

71
    '''
Likun Zhang's avatar
Likun Zhang committed
72 73

    def do_GET(self):
74
        '''The client should send its session id in header with 
75 76
        the name 'cookie'
        '''
77 78 79 80 81
        self.session_id = self.headers.get('cookie')
        rcode, reply = http.client.OK, []        
        if self._is_session_valid():
            if self._is_user_logged_in():
                rcode, reply = self._handle_get_request()
82
            else:
83 84 85 86
                rcode, reply = http.client.UNAUTHORIZED, ["please login"]
        else:
            rcode = http.client.BAD_REQUEST

87
        self.send_response(rcode)
Likun Zhang's avatar
Likun Zhang committed
88
        self.end_headers()
89
        self.wfile.write(json.dumps(reply).encode())
Likun Zhang's avatar
Likun Zhang committed
90

91 92 93 94 95 96 97 98 99
    def _handle_get_request(self):
        '''Currently only support the following three url GET request '''
        id, module = self._parse_request_path()
        return self.server.get_reply_data_for_GET(id, module) 

    def _is_session_valid(self):
        return self.session_id 

    def _is_user_logged_in(self):
100 101 102 103 104 105 106 107 108 109
        login_time = self.server.user_sessions.get(self.session_id)
        if not login_time:
            return False
        
        idle_time = time.time() - login_time
        if idle_time > self.server.idle_timeout:
            return False
        # Update idle time
        self.server.user_sessions[self.session_id] = time.time()
        return True
110 111 112 113 114 115 116 117 118

    def _parse_request_path(self):
        '''Parse the url, the legal url should like /ldh or /ldh/ldh '''
        groups = URL_PATTERN.match(self.path) 
        if not groups:
            return (None, None)
        else:
            return (groups.group(1), groups.group(2))

Likun Zhang's avatar
Likun Zhang committed
119
    def do_POST(self):
120
        '''Process POST request. '''
121 122 123 124
        '''Process user login and send command to proper module  
        The client should send its session id in header with 
        the name 'cookie'
        '''
125
        self.session_id = self.headers.get('cookie')
126
        rcode, reply = http.client.OK, []
127
        if self._is_session_valid():
128
            if self.path == '/login':
129
                rcode, reply = self._handle_login()
130
            elif self._is_user_logged_in():
131
                rcode, reply = self._handle_post_request()
132 133
            else:
                rcode, reply = http.client.UNAUTHORIZED, ["please login"]
134 135 136
        else:
            rcode, reply = http.client.BAD_REQUEST, ["session isn't valid"]
      
Likun Zhang's avatar
Likun Zhang committed
137 138
        self.send_response(rcode)
        self.end_headers()
139 140
        self.wfile.write(json.dumps(reply).encode())

Likun Zhang's avatar
Likun Zhang committed
141

142 143 144 145 146
    def _handle_login(self):
        if self._is_user_logged_in():
            return http.client.OK, ["user has already login"]
        is_user_valid, error_info = self._check_user_name_and_pwd()
        if is_user_valid:
147
            self.server.save_user_session_id(self.session_id)
148 149 150 151 152
            return http.client.OK, ["login success "]
        else:
            return http.client.UNAUTHORIZED, error_info

    def _check_user_name_and_pwd(self):
153
        '''Check user name and its password '''
154 155 156
        length = self.headers.get('Content-Length')
        if not length:
            return False, ["invalid username or password"]     
157 158 159 160 161 162

        try:
            user_info = json.loads((self.rfile.read(int(length))).decode())
        except:
            return False, ["invalid username or password"]                

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
        user_name = user_info.get('username')
        if not user_name:
            return False, ["need user name"]
        if not self.server.user_infos.get(user_name):
            return False, ["user doesn't exist"]

        user_pwd = user_info.get('password')
        if not user_pwd:
            return False, ["need password"]
        local_info = self.server.user_infos.get(user_name)
        pwd_hashval = sha1((user_pwd + local_info[1]).encode())
        if pwd_hashval.hexdigest() != local_info[0]:
            return False, ["password doesn't match"] 

        return True, None
   

    def _handle_post_request(self):
181
        '''Handle all the post request from client. '''
182
        mod, cmd = self._parse_request_path()
183 184 185
        if (not mod) or (not cmd):
            return http.client.BAD_REQUEST, ['malformed url']

186 187 188
        param = None
        len = self.headers.get('Content-Length')
        if len:
189 190 191 192 193
            try:
                post_str = str(self.rfile.read(int(len)).decode())
                param = json.loads(post_str)
            except:
                pass
194

195
        rcode, reply = self.server.send_command_to_module(mod, cmd, param)
196
        print('b10-cmdctl finish send message \'%s\' to module %s' % (cmd, mod))
197 198 199 200 201 202 203 204 205 206
        ret = http.client.OK
        if rcode != 0:
            ret = http.client.BAD_REQUEST
        return ret, reply
    
    def log_request(self, code='-', size='-'):
        '''Rewrite the log request function, log nothing.'''
        pass


Likun Zhang's avatar
Likun Zhang committed
207
class CommandControl():
208 209 210 211
    '''Get all modules' config data/specification from configmanager.
    receive command from client and resend it to proper module.
    '''

Likun Zhang's avatar
Likun Zhang committed
212
    def __init__(self):
213
        self.cc = isc.cc.Session()
Likun Zhang's avatar
Likun Zhang committed
214
        self.cc.group_subscribe('Cmd-Ctrld')
215
        #self.cc.group_subscribe('Boss', 'Cmd-Ctrld')
Likun Zhang's avatar
Likun Zhang committed
216 217 218 219
        self.command_spec = self.get_cmd_specification()
        self.config_spec = self.get_data_specification()
        self.config_data = self.get_config_data()

220 221 222 223 224 225
    def _parse_command_result(self, rcode, reply):
        '''Ignore the error reason when command rcode isn't 0, '''
        if rcode != 0:
            return {}
        return reply

Likun Zhang's avatar
Likun Zhang committed
226
    def get_cmd_specification(self): 
227 228
        rcode, reply = self.send_command('ConfigManager', isc.config.ccsession.COMMAND_GET_COMMANDS_SPEC)
        return self._parse_command_result(rcode, reply)
Likun Zhang's avatar
Likun Zhang committed
229 230

    def get_config_data(self):
231
        '''Get config data for all modules from configmanager '''
232 233
        rcode, reply = self.send_command('ConfigManager', isc.config.ccsession.COMMAND_GET_CONFIG)
        return self._parse_command_result(rcode, reply)
Likun Zhang's avatar
Likun Zhang committed
234 235

    def update_config_data(self, module_name, command_name):
236
        '''Get lastest config data for all modules from configmanager '''
237
        if module_name == 'ConfigManager' and command_name == isc.config.ccsession.COMMAND_SET_CONFIG:
Likun Zhang's avatar
Likun Zhang committed
238 239 240
            self.config_data = self.get_config_data()

    def get_data_specification(self):
241 242
        rcode, reply = self.send_command('ConfigManager', isc.config.ccsession.COMMAND_GET_MODULE_SPEC)
        return self._parse_command_result(rcode, reply)
Likun Zhang's avatar
Likun Zhang committed
243 244

    def handle_recv_msg(self):
245
        '''Handle received message, if 'shutdown' is received, return False'''
Likun Zhang's avatar
Likun Zhang committed
246
        (message, env) = self.cc.group_recvmsg(True)
247 248 249 250 251 252 253 254
        command, arg = isc.config.ccsession.parse_command(message)
        while command:
            if command == isc.config.ccsession.COMMAND_COMMANDS_UPDATE:
                self.command_spec[arg[0]] = arg[1]
            elif command == isc.config.ccsession.COMMAND_SPECIFICATION_UPDATE:
                self.config_spec[arg[0]] = arg[1]
            elif command == "shutdown":
                return False
Likun Zhang's avatar
Likun Zhang committed
255
            (message, env) = self.cc.group_recvmsg(True)
256
            command, arg = isc.config.ccsession.parse_command(message)
Likun Zhang's avatar
Likun Zhang committed
257 258 259
        
        return True
    
260 261 262 263 264 265 266 267 268 269
    def send_command_with_check(self, module_name, command_name, params = None):
        '''Before send the command to modules, check if module_name, command_name
        parameters are legal according the spec file of the module.
        Return rcode, dict.
        rcode = 0: dict is the correct returned value.
        rcode > 0: dict is : { 'error' : 'error reason' }

        TODO. add check for parameters.
        '''

270 271 272 273
        # core module ConfigManager does not have a specification file
        if module_name == 'ConfigManager':
            return self.send_command(module_name, command_name, params)

274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
        if module_name not in self.command_spec.keys():
            return 1, {'error' : 'unknown module'}

        cmd_valid = False
        commands = self.command_spec[module_name]
        for cmd in commands:
            if cmd['command_name'] == command_name:
                cmd_valid = True
                break

        if not cmd_valid:
            return 1, {'error' : 'unknown command'}

        return self.send_command(module_name, command_name, params)

289
    def send_command(self, module_name, command_name, params = None):
290
        '''Send the command from bindctl to proper module. '''
291 292
        
        errstr = 'no error'
293
        print('b10-cmdctl send command \'%s\' to %s' %(command_name, module_name))
Likun Zhang's avatar
Likun Zhang committed
294
        try:
295
            msg = isc.config.ccsession.create_command(command_name, params)
Likun Zhang's avatar
Likun Zhang committed
296
            self.cc.group_sendmsg(msg, module_name)
297
            #TODO, it may be blocked, msqg need to add a new interface waiting in timeout.
Likun Zhang's avatar
Likun Zhang committed
298
            answer, env = self.cc.group_recvmsg(False)
299 300 301 302 303 304
            if answer:
                try:
                    rcode, arg = isc.config.ccsession.parse_answer(answer)
                    if rcode == 0:
                        self.update_config_data(module_name, command_name)
                        if arg != None:
305 306 307
                            return rcode, arg
                        else:
                            return rcode, {}
308 309
                    else:
                        # todo: exception
310
                        errstr = str(answer['result'][1])
311
                except isc.config.ccsession.ModuleCCSessionError as mcse:
312
                    errstr = str("Error in ccsession answer:") + str(mcse)
313
                    print(answer)
Likun Zhang's avatar
Likun Zhang committed
314
        except Exception as e:
315
            errstr = str(e)
316 317
            print(e, ':b10-cmdctl fail send command \'%s\' to %s' % (command_name, module_name))
        
318
        return 1, {'error': errstr}
Likun Zhang's avatar
Likun Zhang committed
319 320 321


class SecureHTTPServer(http.server.HTTPServer):
322 323
    '''Make the server address can be reused.'''
    allow_reuse_address = True
Likun Zhang's avatar
Likun Zhang committed
324

325 326
    def __init__(self, server_address, RequestHandlerClass, idle_timeout = 1200):
        '''idle_timeout: the max idle time for login'''
Likun Zhang's avatar
Likun Zhang committed
327
        http.server.HTTPServer.__init__(self, server_address, RequestHandlerClass)
328 329
        self.user_sessions = {}
        self.idle_timeout = idle_timeout
Likun Zhang's avatar
Likun Zhang committed
330 331 332
        self.cmdctrl = CommandControl()
        self.__is_shut_down = threading.Event()
        self.__serving = False
333 334
        self.user_infos = {}
        self._read_user_info()
Likun Zhang's avatar
Likun Zhang committed
335

336
    def _read_user_info(self):
337
        '''Read all user's name and its' password from csv file.'''
338 339 340 341 342 343 344 345 346 347 348 349
        csvfile = None
        try:
            csvfile = open(USER_INFO_FILE)
            reader = csv.reader(csvfile)
            for row in reader:
                self.user_infos[row[0]] = [row[1], row[2]]
        except Exception as e:
            print("Fail to read user information ", e)                
        finally:
            if csvfile:
                csvfile.close()
        
350 351 352
    def save_user_session_id(self, session_id):
        # Record user's id and login time.
        self.user_sessions[session_id] = time.time()
353
        
Likun Zhang's avatar
Likun Zhang committed
354
    def get_request(self):
355
        '''Get client request socket and wrap it in SSL context. '''
Likun Zhang's avatar
Likun Zhang committed
356 357 358 359
        newsocket, fromaddr = self.socket.accept()
        try:
            connstream = ssl.wrap_socket(newsocket,
                                     server_side = True,
360
                                     certfile = CERTIFICATE_FILE,
361
                                     keyfile = PRIVATE_KEY_FILE,
Likun Zhang's avatar
Likun Zhang committed
362 363 364
                                     ssl_version = ssl.PROTOCOL_SSLv23)
            return (connstream, fromaddr)
        except ssl.SSLError as e :
365 366 367 368
            print("cmdctl: deny client's invalid connection", e)
            self.close_request(newsocket)
            # raise socket error to finish the request
            raise socket.error
Likun Zhang's avatar
Likun Zhang committed
369
            
370

371 372 373 374
    def get_reply_data_for_GET(self, id, module):
        '''Currently only support the following three url GET request '''
        rcode, reply = http.client.NO_CONTENT, []        
        if not module:
Likun Zhang's avatar
Likun Zhang committed
375
            if id == 'command_spec':
376
               rcode, reply = http.client.OK, self.cmdctrl.command_spec
Likun Zhang's avatar
Likun Zhang committed
377
            elif id == 'config_data':
378
               rcode, reply = http.client.OK, self.cmdctrl.config_data
Likun Zhang's avatar
Likun Zhang committed
379
            elif id == 'config_spec':
380
               rcode, reply = http.client.OK, self.cmdctrl.config_spec
381
        
382
        return rcode, reply 
Likun Zhang's avatar
Likun Zhang committed
383

384
        
Likun Zhang's avatar
Likun Zhang committed
385
    def serve_forever(self, poll_interval = 0.5):
386
        '''Start cmdctl as one tcp server. '''
Likun Zhang's avatar
Likun Zhang committed
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
        self.__serving = True
        self.__is_shut_down.clear()
        while self.__serving:
            if not self.cmdctrl.handle_recv_msg():
                break

            r, w, e = select.select([self], [], [], poll_interval)
            if r:
                self._handle_request_noblock()

        self.__is_shut_down.set()
    
    def shutdown(self):
        self.__serving = False
        self.__is_shut_down.wait()


    def send_command_to_module(self, module_name, command_name, params):
405
        return self.cmdctrl.send_command_with_check(module_name, command_name, params)
Likun Zhang's avatar
Likun Zhang committed
406

407 408 409 410 411 412
httpd = None

def signal_handler(signal, frame):
    if httpd:
        httpd.shutdown()
    sys.exit(0)
413

414 415 416 417 418
def set_signal_handler():
    signal.signal(signal.SIGTERM, signal_handler)
    signal.signal(signal.SIGINT, signal_handler)

def run(addr = 'localhost', port = 8080, idle_timeout = 1200):
419
    ''' Start cmdctl as one https server. '''
420
    print("b10-cmdctl module is starting on :%s port:%d" %(addr, port))
421
    httpd = SecureHTTPServer((addr, port), SecureHTTPRequestHandler, idle_timeout)
Likun Zhang's avatar
Likun Zhang committed
422 423
    httpd.serve_forever()

424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
def check_port(option, opt_str, value, parser):
    if (value < 0) or (value > 65535):
        raise OptionValueError('%s requires a port number (0-65535)' % opt_str)
    parser.values.port = value

def check_addr(option, opt_str, value, parser):
    ipstr = value
    ip_family = socket.AF_INET
    if (ipstr.find(':') != -1):
        ip_family = socket.AF_INET6

    try:
        socket.inet_pton(ip_family, ipstr)
    except:
        raise OptionValueError("%s invalid ip address" % ipstr)

    parser.values.addr = value

def set_cmd_options(parser):
    parser.add_option('-p', '--port', dest = 'port', type = 'int',
            action = 'callback', callback=check_port,
            default = '8080', help = 'port cmdctl will use')

    parser.add_option('-a', '--address', dest = 'addr', type = 'string',
            action = 'callback', callback=check_addr,
            default = '127.0.0.1', help = 'IP address cmdctl will use')

    parser.add_option('-i', '--idle-timeout', dest = 'idle_timeout', type = 'int',
            default = '1200', help = 'login idle time out')

Likun Zhang's avatar
Likun Zhang committed
454 455 456

if __name__ == '__main__':
    try:
457 458 459 460 461
        parser = OptionParser(version = __version__)
        set_cmd_options(parser)
        (options, args) = parser.parse_args()
        set_signal_handler()
        run(options.addr, options.port, options.idle_timeout)
462
    except isc.cc.SessionError as se:
463
        print("[b10-cmdctl] Error creating b10-cmdctl, "
Likun Zhang's avatar
Likun Zhang committed
464 465 466
                "is the command channel daemon running?")        
    except KeyboardInterrupt:
        print("exit http server")
467 468 469 470 471

    if httpd:
        httpd.shutdown()


Likun Zhang's avatar
Likun Zhang committed
472