T2 root

bin/tessel-2.js

@@ -197,6 +197,36 @@ parser.command('rename')
   .help('Change the name of a Tessel to something new.');
 
 
+// accessing the root shell of your tessels
+// Fixes issue https://github.com/tessel/t2-cli/issues/80
+/**
+$ t2 root --help
+> Usage: tessel root [-i <path>] [--help]
+>  -i <path>:   provide a path to the desired ssh key
+$ 
+
+$ t2 root
+> Accessing root...
+root@192.168.128.124 # 
+*/
+var default_id_rsa = '~/.tessel/id_rsa';
+var functional_msg = '\nGain SSH root access to one of your authorized tessels (menu listing if multiple targets)';
+parser.command('root')
+  .usage(functional_msg + '\n\nUsage: t2 root [-i PATH] [--help]\n\n-i PATH:   Optional targeting a different Private Key \n\n(Note: default target created by "t2 key generate" is ' + default_id_rsa + ')\n')
+  .option('path', {
+    abbr: 'i',
+    full: 'path',
+    metavar: 'PATH',
+    default: default_id_rsa,
+    help: 'Private Key (Note: created by "t2 key generate")'
+  })
+  .callback(function(opts) {
+    controller.root(opts)
+      .then(closeSuccessfulCommand, closeFailedCommand);
+  })
+  .help(functional_msg);
+
+
 module.exports = function(args) {
   parser.parse(args);
 };

lib/controller.js

@@ -7,6 +7,10 @@ var sprintf = require('sprintf-js').sprintf;
 var cp = require('child_process');
 var async = require('async');
 var controller = {};
+controller.ssh = require('./root_controller');
+var Menu = require('terminal-menu');
+var networkInterfaces = require('os').networkInterfaces();
+var debug = require('debug')('controller');
 
 Tessel.list = function(opts) {
 
@@ -22,21 +26,22 @@ Tessel.list = function(opts) {
     // When a Tessel is found
     seeker.on('tessel', function displayResults(tessel) {
       var note = '';
-
       // Add it to our array
       foundTessels.push(tessel);
-
       // Add a note if the user isn't authorized to use it yet
       if (tessel.connection.connectionType === 'LAN' && !tessel.connection.authorized) {
         note = '(USB connect and run `tessel provision` to authorize)';
       }
-
       // Print out details...
       logs.basic(sprintf('\t%s\t%s\t%s', tessel.name, tessel.connection.connectionType, note));
     });
 
     // Called after CTRL+C or timeout
     function stopSearch() {
+      if (foundTessels.length > 1) {
+        debug('heuristics ? => found: ' + foundTessels.length + ' === 1 || (' + foundTessels.length + ' === 2 && ' + foundTessels[0].name + ' === ' + foundTessels[1].name + ' && ' + foundTessels[0].connections[0].connectionType + ' !== ' + foundTessels[1].connections[0].connectionType + ')');
+
+      }
       // If the seeker exists (it should)
       if (seeker !== undefined) {
         // Stop looking for more Tessels
@@ -54,8 +59,10 @@ Tessel.list = function(opts) {
       }
       // If we have only one Tessel or two Tessels with the same name (just USB and LAN)
       else if (foundTessels.length === 1 ||
-        (foundTessels.length === 2 && foundTessels[0].name === foundTessels[1].name)) {
+        (foundTessels.length === 2 && foundTessels[0].name === foundTessels[1].name && foundTessels[0].connections[0].connectionType !== foundTessels[1].connections[0].connectionType)) {
         // Close all opened connections and resolve
+        console.log(foundTessels[0].connections.connectionType);
+        console.log(foundTessels[1].connections.connectionType);
         controller.closeTesselConnections(foundTessels)
           .then(resolve);
       }
@@ -170,6 +177,134 @@ Tessel.get = function(opts) {
     }
   });
 };
+/*
+Because of sync problem with master trunk and parallel development on Tessel.list 
+it was necessary to go my own way...
+
+The seekTessels method never uses heuristics because all possible login variants are required.
+There is a new feature in: In the case your network topology causes a Tessels IP is found twice, the 
+menu will only list it once.
+
+Due to my own stupid failing with mixing up a tessel is accessable via gateway and a Tessel is in the 
+same Netmask, I've added a notice for the case someone run into same issue.
+*/
+Tessel.seekTessels = function(opts) {
+  return new Promise(function(resolve, reject) {
+
+    if (opts.timeout && typeof opts.timeout === 'number') {
+      // Stop the search after that duration
+      setTimeout(stopSeeker, opts.timeout * 1000);
+    } else {
+      // default to 3 seconds searching
+      setTimeout(stopSeeker, 3000);
+    }
+    logs.info('Searching accessable Tessels ...');
+
+    var seeker = new discover.TesselSeeker().start();
+    var tessels = [];
+
+    // When we find Tessels
+    seeker.on('tessel', function(tessel) {
+      controller.closeTesselConnections(tessel)
+        .then(function() {
+          var known = false;
+          if (tessels.length >= 1) {
+            for (var i in tessels) {
+              if (tessel.connections[0].ip === tessels[i].connections[0].ip && tessel.connections[0].connectionType === 'LAN') {
+                // Your network topology causes a single tessel is found twice
+                debug('known = true');
+                known = true;
+              }
+            }
+
+          }
+          if (known) {
+            debug('Due to your Network-Topology ' + tessel.name + ' is found twice! (' + tessel.connections[0].ip + ')');
+          } else {
+            // Add it to our array
+            tessels.push(tessel);
+          }
+        });
+    });
+
+    seeker.on('error', function(e) {
+      reject(e);
+    });
+
+    function stopSeeker() {
+      try {
+        // If there were no Tessels found
+        if (!tessels || tessels.length === 0) {
+          // Report the sadness
+          debug('We are searching the following networks:\n', networkInterfaces);
+          debug('\n(Important: Check your Netmask - we do not follow gateways for discovering!)');
+          logs.warn('No Tessels found (DEBUG=controller t2 root # might help!)');
+          resolve();
+        }
+        seeker.stop();
+        seeker = null; // preventing memory leaks
+        return resolve(tessels);
+      } catch (e) {
+        reject(e);
+      }
+    }
+  });
+};
+/*
+  The T2 root command is used to login into the firmware and gaining superuser access.
+  The security is provided by RSA - your Tessel get the keys while provisioning via USB.
+
+  If you have only one Tessel, the T2 root command will login directly else there is 
+  a ncurses like menu you can select the Tessel you like to gain root access...
+
+  The structure of code and maybe unusual parts are paid due being testable.
+  The lightweight terminal-menu isn't written testable what needs a little bit hacking.
+
+  Finally some parts are causing from my personnal learning curve about writing unit tests using sinon!
+*/
+controller.root = function(opts) {
+  // ~ conversion to home because spawn isn't able to handle this right
+  if (opts.path && opts.path.substring(0, 1) === '~') {
+    var home = process.env.HOME;
+    opts.path = opts.path.replace('~', home);
+  }
+  var rtm;
+  if (!opts.menu) {
+    // TODO: Tessel cooperate identity conform menu required (color, ascii logo)
+    rtm = Menu({
+      width: 50,
+      x: 1,
+      y: 2,
+      bg: 'red'
+    });
+  } else {
+    // used while testing to override methods by stubs (testing doesn't like user interactions)
+    rtm = opts.menu;
+  }
+  return new Promise(function(resolve, reject) {
+    controller.ssh.seek(opts)
+      .then(function(tessels) {
+
+        if (tessels && tessels.length >= 2) {
+          controller.ssh.multipleTessels(opts, tessels, rtm, resolve, reject);
+        } else if (tessels && tessels.length === 1) {
+          if (tessels[0].connection.authorized) {
+            controller.ssh.runSSH(0, opts, tessels, resolve, reject);
+          } else {
+            logs.warn('Sorry, you are not authorized!');
+            logs.info('"t2 key generate" might help :-)');
+            resolve();
+          }
+        } else {
+          // everything works fine, but no tessels found
+          resolve();
+        }
+
+      }).catch(function(e) {
+        reject(e);
+      });
+  });
+};
 
 /*
 Takes a list of Tessels with connections that
@@ -451,7 +586,6 @@ controller.connectToNetwork = function(opts) {
         });
     });
 };
-
 module.exports = controller;
 
 // Shared exports