Changeset 29051 in vbox for trunk/src/VBox/Frontends

Timestamp:

May 5, 2010 2:37:25 AM (15 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

61100

Message:

VBoxShell: NAT manipulations.

File:

• trunk/src/VBox/Frontends/VBoxShell/vboxshell.py (modified) (2 diffs)

trunk/src/VBox/Frontends/VBoxShell/vboxshell.py

@@ -2173 +2173 @@
 
     return 0
+
+def natAlias(ctx, mach, nicnum, nat, args=[]):
+    """This command shows/alters NAT's alias settings. 
+    usage: nat <vm> <nicnum> alias [default|[log] [proxyonly] [sameports]]
+    default - set settings to default values
+    log - switch on alias loging
+    proxyonly - switch proxyonly mode on
+    sameports - enforces NAT using the same ports 
+    """
+    alias = {
+        'log': 0x1,
+        'proxyonly': 0x2,
+        'sameports': 0x4
+    }
+    if len(args) == 1:
+        first = 0
+        msg = ''
+        for aliasmode, aliaskey in alias.iteritems(): 
+            if first == 0:
+                first = 1
+            else:
+                msg += ', '
+            if int(nat.aliasMode) & aliaskey: 
+                msg += '{0}: {1}'.format(aliasmode, 'on')
+            else:
+                msg += '{0}: {1}'.format(aliasmode, 'off')
+        msg += ')'
+        return (0, [msg])
+    else:
+        nat.aliasMode = 0
+        if 'default' not in args:
+            for a in range(1, len(args)):
+                if not alias.has_key(args[a]):
+                    print 'Invalid alias mode: ' + args[a]
+                    print natAlias.__doc__
+                    return (1, '')
+                nat.aliasMode = int(nat.aliasMode) | alias[args[a]];
+    return (0, '')
+
+def natSettings(ctx, mach, nicnum, nat, args):
+    """This command shows/alters NAT settings.
+    usage: nat <vm> <nicnum> settings [<mtu> [[<socsndbuf> <sockrcvbuf> [<tcpsndwnd> <tcprcvwnd>]]]]
+    mtu - set mtu <= 16000
+    socksndbuf/sockrcvbuf - sets amount of kb for socket sending/receiving buffer 
+    tcpsndwnd/tcprcvwnd - sets size of initial tcp sending/receiving window
+    """
+    if len(args) == 1:
+        (mtu, socksndbuf, sockrcvbuf, tcpsndwnd, tcprcvwnd) = nat.getNetworkSettings();
+        if mtu == 0: mtu = 1500
+        if socksndbuf == 0: socksndbuf = 64
+        if sockrcvbuf == 0: sockrcvbuf = 64
+        if tcpsndwnd == 0: tcpsndwnd = 64
+        if tcprcvwnd == 0: tcprcvwnd = 64
+        msg = 'mtu:{0} socket(snd:{1}, rcv:{2}) tcpwnd(snd:{3}, rcv:{4})'.format(mtu, socksndbuf, sockrcvbuf, tcpsndwnd, tcprcvwnd);
+        return (0, [msg])
+    else:
+        if args[1] < 16000:
+            print 'invalid mtu value ({0} no in range [65 - 16000])'.format(args[1])
+            return (1, '')
+        for i in range(2, len(args)):
+            if not args[i].isdigit() or int(args[i]) < 8 or int(args[i]) > 1024:
+                print 'invalid {0} parameter ({1} not in range [8-1024])'.format(i, args[i])
+                return (1,'') 
+        a = [args[1]]
+        if len(args) < 6:
+            for i in range(2, len(args)): a.append(args[i]) 
+            for i in range(len(args), 6): a.append(0)
+        else:
+            for i in range(2, len(args)): a.append(args[i]) 
+        #print a
+        nat.setNetworkSettings(int(a[0]), int(a[1]), int(a[2]), int(a[3]), int(a[4]))
+    return (0,'')
+
+def natDns(ctx, mach, nicnum, nat, args):
+    """This command shows/alters DNS's NAT settings
+    usage: nat <vm> <nicnum> dns [passdomain] [proxy] [usehostresolver]
+    passdomain - enforces builtin DHCP server to pass domain
+    proxy - switch on builtin NAT DNS proxying mechanism
+    usehostresolver - proxies all DNS requests to Host Resolver interface
+    """
+    yesno = {0: 'off', 1: 'on'}
+    if len(args) == 1:
+        msg = 'passdomain:{0}, proxy:{1}, usehostresolver:{2}'.format(yesno[int(nat.dnsPassDomain)], yesno[int(nat.dnsProxy)], yesno[int(nat.dnsUseHostResolver)])
+        return (0, [msg])
+    else:
+        nat.dnsPassDomain = 'passdomain' in args
+        nat.dnsProxy =  'proxy' in args
+        nat.dnsUseHostResolver =  'usehostresolver' in args
+    return (0, '')
+
+def natTftp(ctx, mach, nicnum, nat, args):
+    """This command shows/alters TFTP settings
+    usage nat <vm> <nicnum> tftp [prefix <prefix>| bootfile <bootfile>| server <server>]
+    prefix - alters prefix TFTP settings
+    bootfile - alters bootfile TFTP settings
+    server - sets booting server
+    """
+    if len(args) == 1:
+        server = nat.tftpNextServer
+        if server is None:
+            server = nat.network
+            if server is None:
+                server = '10.0.{0}/24'.format(int(nicnum) + 2)
+            (server,mask) = server.split('/')
+            while server.count('.') != 3:
+                server += '.0'
+            (a,b,c,d) = server.split('.')
+            server = '{0}.{1}.{2}.4'.format(a,b,c)
+        prefix = nat.tftpPrefix
+        if prefix is None:
+            prefix = '{0}/TFTP/'.format(ctx['vb'].homeFolder)
+        bootfile = nat.tftpBootFile
+        if bootfile is None:
+            bootfile = '{0}.pxe'.format(mach.name)
+        msg = 'server:{0}, prefix:{1}, bootfile:{2}'.format(server, prefix, bootfile)
+        return (0, [msg])
+    else:
+
+        cmd = args[1]
+        if len(args) != 3:
+            print 'invalid args:', args
+            print natTftp.__doc__
+            return (1,'')
+        if cmd == 'prefix': nat.tftpPrefix = args[2]
+        elif cmd == 'bootfile': nat.tftpBootFile = args[2]
+        elif cmd == 'server': nat.tftpNextServer = args[2]
+        else:
+            print "invalid cmd:", cmd
+            return (1, '')
+    return (0,'')
+
+def natPortForwarding(ctx, mach, nicnum, nat, args):
+    """This command shows/manages port-forwarding settings
+    usage: 
+        nat <vm> <nicnum> <pf> [ simple tcp|udp <hostport> <guestport>]
+            |[no_name tcp|udp <hostip> <hostport> <guestip> <guestport>] 
+            |[ex tcp|udp <pf-name> <hostip> <hostport> <guestip> <guestport>]
+            |[delete <pf-name>]
+    """
+    if len(args) == 1:
+        # note: keys/values are swapped in defining part of the function
+        proto = {0: 'udp', 1: 'tcp'}
+        msg = []
+        pfs = ctx['global'].getArray(nat, 'redirects')
+        for pf in pfs:
+            (pfnme, pfp, pfhip, pfhp, pfgip, pfgp) = str(pf).split(',')
+            msg.append('{0}: {1} {2}:{3} => {4}:{5}'.format(pfnme, proto[int(pfp)], pfhip, pfhp, pfgip, pfgp))
+        return (0, msg) # msg is array
+    else:
+        proto = {'udp': 0, 'tcp': 1}
+        pfcmd = {
+            'simple': {
+                'validate': lambda: args[1] in pfcmd.keys() and args[2] in proto.keys() and len(args) == 5, 
+                'func':lambda: nat.addRedirect('', proto[args[2]], '', int(args[3]), '', int(args[4]))
+            },
+            'no_name': { 
+                'validate': lambda: args[1] in pfcmd.keys() and args[2] in proto.keys() and len(args) == 7, 
+                'func': lambda: nat.addRedirect('', proto[args[2]], args[3], int(args[4]), args[5], int(args[6]))
+            },
+            'ex': { 
+                'validate': lambda: args[1] in pfcmd.keys() and args[2] in proto.keys() and len(args) == 8, 
+                'func': lambda: nat.addRedirect(args[3], proto[args[2]], args[4], int(args[5]), args[6], int(args[7]))
+            },
+            'delete': {
+                'validate': lambda: len(args) == 3,
+                'func': lambda: nat.removeRedirect(args[2])
+            }
+        } 
+
+        if not pfcmd[args[1]]['validate']():
+            print 'invalid port-forwarding or args of sub command ', args[1]
+            print natPortForwarding.__doc__
+            return (1, '')
+
+        a = pfcmd[args[1]]['func']()
+    return (0,'')
+
+def natNetwork(ctx, mach, nicnum, nat, args):
+    """This command shows/alters NAT network settings 
+    usage: nat <vm> <nicnum> network [<network>]
+    """
+    if len(args) == 1:
+        if nat.network is not None and len(str(nat.network)) != 0:
+            msg = '\'%s\'' % (nat.network)
+        else:
+            msg = '10.0.{0}.0/24'.format(int(nicnum) + 2)
+        return (0, [msg])
+    else:
+        (addr, mask) = args[1].split('/')
+        if addr.count('.') > 3 or int(mask) < 0 or int(mask) > 32:
+            print 'Invalid arguments'
+            return (1,'')
+        nat.network = args[1]
+    return (0, '')
+def natCmd(ctx, args):
+    """This command is entry point to NAT settins management
+    usage: nat <vm> <nicnum> <cmd> <cmd-args>
+    cmd - [alias|settings|tftp|dns|pf|network]
+    for more information about commands:
+    nat help <cmd>
+    """
+
+    natcommands = {
+        'alias' : natAlias,
+        'settings' : natSettings,
+        'tftp': natTftp,
+        'dns': natDns,
+        'pf': natPortForwarding,
+        'network': natNetwork
+    }
+
+    if args[1] == 'help':
+        if len(args) > 2:
+            print natcommands[args[2]].__doc__
+        else:
+            print natCmd.__doc__
+        return 0
+    if len(args) == 1 or len(args) < 4 or args[3] not in natcommands:
+        print natCmd.__doc__
+        return 0
+    mach = ctx['argsToMach'](args)
+    if mach == None:
+        print "please specify vm"
+        return 0
+    if len(args) < 3 or not args[2].isdigit() or int(args[2]) not in range(0, ctx['vb'].systemProperties.networkAdapterCount):
+        print 'please specify adapter num {0} isn\'t in range [0-{1}]'.format(args[2], ctx['vb'].systemProperties.networkAdapterCount)
+        return 0
+    nicnum = int(args[2])
+    cmdargs = []
+    for i in range(3, len(args)):
+        cmdargs.append(args[i])
+        
+    # @todo vvl if nicnum is missed but command is entered 
+    # use NAT func for every adapter on machine.
+    func = args[3]
+    rosession = 1
+    session = None
+    if len(cmdargs) > 1:
+        rosession = 0
+        session = ctx['global'].openMachineSession(mach.id);
+        mach = session.machine;
+
+    adapter = mach.getNetworkAdapter(nicnum)
+    natEngine = adapter.natDriver
+    (rc, report) = natcommands[func](ctx, mach, nicnum, natEngine, cmdargs) 
+    if rosession == 0:
+        if rc == 0:
+            mach.saveSettings()
+        session.close()
+    else:
+        for r in report:
+            msg ='{0} nic{1} {2}: {3}'.format(mach.name, nicnum, func, r)
+            print msg
+    return 0
+
 
 aliases = {'s':'start',
@@ -2248 +2503 @@
             'colors':['Toggle colors', colorsCmd, 0],
             'snapshot':['VM snapshot manipulation, snapshot help for more info', snapshotCmd, 0],
+            'nat':['NAT manipulation, nat help for more info', natCmd, 0],
             }