Libertine

Merge lp:~larryprice/libertine/libertine-shell-ssh into lp:libertine

libertine-shell-ssh
Merge into devel

Proposed by Larry Price on 2017-03-08

Status:

Merged

Approved by:

Christopher Townsend on 2017-04-07

Approved revision:

423

Merged at revision:

459

Proposed branch:

lp:~larryprice/libertine/libertine-shell-ssh

Merge into:

lp:libertine

Diff against target:

373 lines (+337/-3)

5 files modified

debian/libertine-tools.install (+3/-0)
tools/CMakeLists.txt (+3/-3)
tools/completions/libertine-shell (+50/-0)
tools/libertine-shell (+255/-0)
tools/libertine-shell.1 (+26/-0)

To merge this branch:

bzr merge lp:~larryprice/libertine/libertine-shell-ssh

Wishlist

Fix Committed

Link a bug report

Reviewer	Review Type	Date Requested	Status
Christopher Townsend		2017-03-08	Approve on 2017-04-07
Libertine CI Bot	continuous-integration		Approve on 2017-04-06
Review via email: mp+319369@code.launchpad.net

Commit message

Add tool to easily ssh into libertine containers.

Description of the change

Add tool to easily ssh into libertine containers.

Revision history for this message

Libertine CI Bot (libertine-ci-bot) wrote on 2017-03-08:

FAILED: Continuous integration, rev:416
https://jenkins.canonical.com/libertine/job/lp-libertine-ci/452/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/libertine/job/build/837/console
    SUCCESS: https://jenkins.canonical.com/libertine/job/build-0-fetch/847
    FAILURE: https://jenkins.canonical.com/libertine/job/build-2-binpkg/arch=amd64,release=xenial+overlay/839/console
    FAILURE: https://jenkins.canonical.com/libertine/job/build-2-binpkg/arch=amd64,release=zesty/839/console
    FAILURE: https://jenkins.canonical.com/libertine/job/build-2-binpkg/arch=i386,release=xenial+overlay/839/console
    FAILURE: https://jenkins.canonical.com/libertine/job/build-2-binpkg/arch=i386,release=zesty/839/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/libertine/job/lp-libertine-ci/452/rebuild

review: Needs Fixing (continuous-integration)

lp:~larryprice/libertine/libertine-shell-ssh updated on 2017-03-08

417. By Larry Price on 2017-03-08: how did i forget to add libertine-shell to install...

Revision history for this message

Libertine CI Bot (libertine-ci-bot) wrote on 2017-03-08:

Click here to trigger a rebuild:
https://jenkins.canonical.com/libertine/job/lp-libertine-ci/453/rebuild

review: Approve (continuous-integration)

lp:~larryprice/libertine/libertine-shell-ssh updated on 2017-03-09

418. By Larry Price on 2017-03-09: prevent non-lx* containers from using libertine-shell
419. By Larry Price on 2017-03-09: merge

Revision history for this message

Libertine CI Bot (libertine-ci-bot) wrote on 2017-03-09:

Click here to trigger a rebuild:
https://jenkins.canonical.com/libertine/job/lp-libertine-ci/457/rebuild

review: Approve (continuous-integration)

lp:~larryprice/libertine/libertine-shell-ssh updated on 2017-04-05

420. By Larry Price on 2017-04-05: merge

Revision history for this message

Libertine CI Bot (libertine-ci-bot) wrote on 2017-04-05:

Click here to trigger a rebuild:
https://jenkins.canonical.com/libertine/job/lp-libertine-ci/509/rebuild

review: Approve (continuous-integration)

Revision history for this message

Christopher Townsend (townsend) wrote on 2017-04-05:

I built the packages, installed them, and rebooted the system. I then logged in to U8, and this is what I get when running libertine-shell:

$ libertine-shell -i test-lxd
Traceback (most recent call last):
  File "/usr/bin/libertine-shell", line 248, in <module>
    main()
  File "/usr/bin/libertine-shell", line 216, in main
    with open(os.path.join(utils.get_libertine_container_home_dir(config.container_id), "libertine-shell-found-ip")) as f:
FileNotFoundError: [Errno 2] No such file or directory: '/home/townsend/.local/share/libertine-container/user-data/test-lxd/libertine-shell-found-ip'

review: Needs Fixing

lp:~larryprice/libertine/libertine-shell-ssh updated on 2017-04-05

421. By Larry Price on 2017-04-05: use bind mounted dir if necessary

Revision history for this message

Libertine CI Bot (libertine-ci-bot) wrote on 2017-04-05:

Click here to trigger a rebuild:
https://jenkins.canonical.com/libertine/job/lp-libertine-ci/510/rebuild

review: Approve (continuous-integration)

Revision history for this message

Christopher Townsend (townsend) wrote on 2017-04-06:

Ok, next issue:)

I'm trying this on a machine that I have never used ssh on. I get the following error:

$ libertine-shell -i test-lxd
Traceback (most recent call last):
  File "/usr/bin/libertine-shell", line 254, in <module>
    main()
  File "/usr/bin/libertine-shell", line 229, in main
    config.setup_public_keys(hostname)
  File "/usr/bin/libertine-shell", line 83, in setup_public_keys
    all_lines, host_line = self._ssh_config_lines(hostname)
  File "/usr/bin/libertine-shell", line 148, in _ssh_config_lines
    with open(config_path, 'r') as f:
FileNotFoundError: [Errno 2] No such file or directory: '/home/townsend/.ssh/config'

review: Needs Fixing

lp:~larryprice/libertine/libertine-shell-ssh updated on 2017-04-06

422. By Larry Price on 2017-04-06: don't read non-existent config

Revision history for this message

Libertine CI Bot (libertine-ci-bot) wrote on 2017-04-06:

Click here to trigger a rebuild:
https://jenkins.canonical.com/libertine/job/lp-libertine-ci/512/rebuild

review: Approve (continuous-integration)

lp:~larryprice/libertine/libertine-shell-ssh updated on 2017-04-07

423. By Larry Price on 2017-04-07: specify container type in help/manpage

Revision history for this message

Christopher Townsend (townsend) wrote on 2017-04-07:

Ok, works fine. +1

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Larry Price

Libertine Developers

 === modified file 'debian/libertine-tools.install'
 --- debian/libertine-tools.install	2017-03-13 15:50:54 +0000
 +++ debian/libertine-tools.install	2017-04-07 13:51:54 +0000
@@ -1,3 +1,6 @@
  usr/bin/libertine-container-manager
++usr/bin/libertine-shell
  usr/share/bash-completion/completions/libertine-container-manager
  usr/share/man/*/libertine-container-manager.1
++usr/share/bash-completion/completions/libertine-shell
++usr/share/man/*/libertine-shell.1
 === modified file 'tools/CMakeLists.txt'
 --- tools/CMakeLists.txt	2017-01-31 16:28:31 +0000
 +++ tools/CMakeLists.txt	2017-04-07 13:51:54 +0000
@@ -1,9 +1,9 @@
--install(PROGRAMS libertine-container-manager libertine-launch
++install(PROGRAMS libertine-container-manager libertine-launch libertine-shell
                   libertine-xmir libertine-lxc-setup libertine-lxd-setup libertined
          DESTINATION ${CMAKE_INSTALL_BINDIR})
  install(FILES libertine-launch.1 libertine-container-manager.1
--              libertine-xmir.1
++              libertine-xmir.1 libertine-shell.1
          DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
          COMPONENT doc)
--install(FILES completions/libertine-container-manager
++install(FILES completions/libertine-container-manager completions/libertine-shell
          DESTINATION ${DESTDIR}/usr/share/bash-completion/completions/)
 === added file 'tools/completions/libertine-shell'
 --- tools/completions/libertine-shell	1970-01-01 00:00:00 +0000
 +++ tools/completions/libertine-shell	2017-04-07 13:51:54 +0000
@@ -0,0 +1,50 @@
++# Copyright (C) 2017 Canonical Ltd.
++#
++# This program is free software: you can redistribute it and/or modify
++# it under the terms of the GNU General Public License as published by
++# the Free Software Foundation; version 3 of the License.
++#
++# This program is distributed in the hope that it will be useful,
++# but WITHOUT ANY WARRANTY; without even the implied warranty of
++# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
++# GNU General Public License for more details.
++#
++# You should have received a copy of the GNU General Public License
++# along with this program.  If not, see <http://www.gnu.org/licenses/>.
++
++
++_libertine-shell()
++{
++    local cur cmd opts
++    COMPREPLY=()
++    cur=${COMP_WORDS[COMP_CWORD]}
++
++    if [[ ${COMP_CWORD} -gt 1 ]]; then
++      cmd="$cur"
++      if [[ ${cmd} != -* ]]; then
++        cmd=${COMP_WORDS[COMP_CWORD-1]}
++      fi
++
++      case "${cmd}" in
++      "--username" )
++        opts=$(users)
++        ;;
++      "--identity-file" )
++        compopt -o filenames
++        local files=("${cur}"*)
++        [[ -e ${files[0]} ]] && COMPREPLY=( "${files[@]// /\ }" )
++        return 0
++        ;;
++      esac
++    fi
++
++    if [[ -z ${opts} ]]; then
++      opts="--help --identity-file --username --assume-yes --id"
++    fi
++
++    if [[ -n "${opts}" ]]; then
++      COMPREPLY=( $(compgen -W "${opts}" -- "${COMP_WORDS[COMP_CWORD]}") )
++      return 0
++    fi
++}
++complete -F _libertine-shell libertine-shell
 === added file 'tools/libertine-shell'
 --- tools/libertine-shell	1970-01-01 00:00:00 +0000
 +++ tools/libertine-shell	2017-04-07 13:51:54 +0000
@@ -0,0 +1,255 @@
++#!/usr/bin/python3
++# -*- coding: utf-8 -*-
++#
++# Copyright (C) 2017 Canonical Ltd.
++#
++# This program is free software: you can redistribute it and/or modify
++# it under the terms of the GNU General Public License as published by
++# the Free Software Foundation; version 3 of the License.
++#
++# This program is distributed in the hope that it will be useful,
++# but WITHOUT ANY WARRANTY; without even the implied warranty of
++# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
++# GNU General Public License for more details.
++#
++# You should have received a copy of the GNU General Public License
++# along with this program.  If not, see <http://www.gnu.org/licenses/>.
++
++import argparse
++import os
++import shlex
++import subprocess
++import sys
++
++from libertine import ContainersConfig, utils, Libertine
++from shutil import copyfile
++
++import gettext
++gettext.textdomain('libertine')
++_ = gettext.gettext
++
++class ShellConfig(object):
++    def __init__(self, args):
++        super().__init__()
++        self._validate(self._parse(args))
++
++    @property
++    def public_key(self):
++        return "{}.pub".format(self.identity_file)
++
++    def _parse(self, args):
++        arg_parser = argparse.ArgumentParser(description=_('Launch an SSH session within a lxc/lxd Libertine container'))
++        arg_parser.add_argument('-i', '--id',
++                                help=_('Container identifier'))
++        arg_parser.add_argument('-u', '--username',
++                                help=_('Container username'))
++        arg_parser.add_argument('-f', '--identity-file',
++                                help=_('SSH key to be used'))
++        arg_parser.add_argument('-y', '--assume-yes',
++                                action='store_true',
++                                help=_('Assume yes to all prompts'))
++
++        return arg_parser.parse_args(args=args)
++
++    def _validate(self, options):
++        self.assume_yes = options.assume_yes or False
++        self.username = options.username
++
++        config = ContainersConfig.ContainersConfig()
++        self.container_id = config.check_container_id(options.id)
++        self.container_type = config.get_container_type(self.container_id)
++        utils.get_logger().debug("Using Container ID: {}".format(self.container_id))
++
++        self.identity_file = None
++
++        if options.identity_file:
++            utils.get_logger().debug("Public key file path: {}".format(options.identity_file))
++
++            if not os.path.exists(options.identity_file):
++                if not os.path.dirname(options.identity_file) and os.path.exists(os.path.join(os.environ['HOME'], '.ssh', options.identity_file)):
++                    self.identity_file = os.path.join(os.environ['HOME'], '.ssh', options.identity_file)
++                else:
++                    utils.get_logger().error(_("Identity file not found at '{}'. Leave blank for default.").format(options.identity_file))
++                    sys.exit(1)
++            else:
++                self.identity_file = options.identity_file
++
++            if not os.path.exists(self.public_key):
++                utils.get_logger().error(_("Corresponding public key not found for '{}'.").format(self.identity_file))
++                sys.exit(1)
++
++    def setup_public_keys(self, hostname):
++        should_save = False
++        all_lines, host_line = self._ssh_config_lines(hostname)
++
++        if host_line:
++            identity_files = [line for line in host_line.split('\n') if "IdentityFile " in line]
++            if identity_files:
++                if not self.identity_file:
++                    self.identity_file = identity_files[-1].split(' ')[-1]
++                elif not [i for i in identity_files if self.identity_file in i]:
++                    should_save = True
++                    host_line += "\n\tIdentityFile {}".format(self.identity_file)
++                    if self.username and not "User {}".format(self.username) in host_line:
++                        host_line += "\tUser {}\n".format(self.username)
++        elif self.identity_file:
++            should_save = True
++            host_line = "Host {}\n\tIdentityFile {}".format(hostname, self.identity_file)
++            all_lines.append(host_line)
++
++        if host_line and self.username and not "User {}".format(self.username) in host_line:
++            should_save = True
++            host_line += "\n\tUser {}\n".format(self.username)
++
++        if not self.identity_file:
++            DEFAULT_KEYS = ["id_dsa", "id_rsa", "id_ecdsa", "id_ed25519"]
++            keys = [key for key in os.listdir(os.path.join(os.environ['HOME'], '.ssh')) if key in DEFAULT_KEYS]
++            if keys:
++                self.identity_file = os.path.join(os.environ['HOME'], '.ssh', keys[0])
++
++        if self.identity_file and not (os.path.exists(self.identity_file) or os.path.exists(self.public_key)):
++            utils.get_logger().error(_("Configured identity file or public key matching '{}' do not exist.").format(self.identity_file))
++            sys.exit(1)
++
++        if should_save and self._ask_save_ssh_config():
++            try:
++                config_path = os.path.join(os.environ['HOME'], ".ssh", "config")
++                copyfile(config_path, config_path + ".bak")
++                with open(config_path, 'w') as f:
++                    for i in range(0, len(all_lines)):
++                        if i == (len(all_lines)-1):
++                            newlines = '\n'
++                        else:
++                            newlines = '\n\n'
++
++                        if not all_lines[i].startswith("Host {}".format(hostname)):
++                            f.write(all_lines[i] + newlines)
++                        else:
++                            f.write(host_line + newlines)
++            except Exception as e:
++                utils.get_logger().warning("Error caught during config edit: {}.".format(str(e)))
++                utils.get_logger().warning("Restoring previous version of '{}' and continuing".format(config_path))
++                copyfile(config_path + ".bak", config_path)
++
++            os.remove(config_path + ".bak")
++
++    def _ssh_config_lines(self, hostname):
++        ssh_dir = os.path.join(os.environ['HOME'], ".ssh")
++        if not os.path.exists(ssh_dir):
++            utils.get_logger().error(_("It looks like no SSH keys are set up. Please generate a key and try again. "
++                                       "You can use the following command to generate an appropriate key:\n"
++                                       "\tssh-keygen -t rsa -b 4096 -C 'your_email@example.com'"))
++            sys.exit(1)
++
++        config_path = os.path.join(ssh_dir, "config")
++
++        all_lines = []
++        host_line = []
++        if os.path.exists(config_path):
++            with open(config_path, 'r') as f:
++                all_lines = [line.strip() for line in f.read().split('\n\n')]
++                host_line = [line for line in all_lines if line.startswith("Host {}".format(hostname))]
++                if host_line:
++                    host_line = host_line[-1]
++
++        return (all_lines, host_line or '')
++
++    def _ask_save_ssh_config(self):
++        if not self.assume_yes:
++            if self.username:
++                prompt = input(_("Always use '{}' as identity file and username '{}' "
++                                 "when connecting to '{}'? [Yn]").format(self.identity_file, self.username, self.container_id))
++            else:
++                prompt = input(_("Always use '{}' as identity file when connecting to '{}'? [Yn]").format(self.identity_file, self.container_id))
++
++            if not (prompt == _('Y') or prompt == _('y') or prompt == ''):
++                utils.get_logger().debug("Responded 'no' to saving identity configuration")
++                return False
++
++        return True
++
++    def command(self, hostname):
++        if self.username:
++            hostname = "{}@{}".format(self.username, hostname)
++
++        options = ""
++        if self.identity_file:
++            options += " -i {} ".format(self.identity_file)
++
++        return "ssh {} {} -t 'bash -s'".format(options, hostname)
++
++    def get_ip_host_file_path(self, home):
++        if home in ContainersConfig.ContainersConfig().get_container_bind_mounts(self.container_id):
++            return os.path.join(home, 'libertine-shell-found-ip')
++
++        return os.path.join(utils.get_libertine_container_home_dir(self.container_id), 'libertine-shell-found-ip')
++
++
++def main():
++    if subprocess.Popen(shlex.split("bash -c \"which sshd &> /dev/null\"")).wait() != 0:
++        utils.get_logger().error(_("No sshd found. You can install openssh with the following command:\n"
++                                   "\tapt install openssh-client"))
++        sys.exit(1)
++
++    config = ShellConfig(sys.argv[1:])
++
++    if not (config.container_type == 'lxd' or config.container_type == 'lxc'):
++        utils.get_logger().error(_("'{}' is a '{}' container. Only 'lxd' or 'lxc' "
++                                   "containers are able to use this tool.".format(
++                                   config.container_id, config.container_type)))
++        sys.exit(1)
++
++    container = Libertine.LibertineContainer(config.container_id)
++
++
++    with Libertine.ContainerRunning(container.container):
++        if not container.container._binary_exists("sshd"):
++            if not config.assume_yes:
++                prompt = input(_("openssh-server not detected in container '{}'. Install now? [Yn]").format(config.container_id))
++                if not (prompt == _('Y') or prompt == _('y') or prompt == ''):
++                    utils.get_logger().debug("Responded 'no' to openssh-server installation")
++                    sys.exit(1)
++
++            if not container.install_package("openssh-server") or not container.exec_command("update-rc.d ssh defaults"):
++                utils.get_logger().error(_("Failed to install openssh-server"))
++                sys.exit(1)
++
++        username = config.username or os.environ['USER']
++
++        if not container.exec_command('bash -c "hostname -I | awk \'{ print $1 }\' > /home/%s/libertine-shell-found-ip"' % username):
++            utils.get_logger().error(_("Unable to get IP address for '{}'".format(config.container_id)))
++            sys.exit(1)
++
++        with open(config.get_ip_host_file_path('/home/%s' % username)) as f:
++            hostname = f.read().strip()
++            utils.get_logger().debug(hostname)
++            if not hostname:
++                utils.get_logger().error(_("Unable to get IP address for '{}'".format(config.container_id)))
++                sys.exit(1)
++
++        config.setup_public_keys(hostname)
++
++        if not container.exec_command('test -e /home/{}/.ssh/authorized_keys'.format(username)):
++            container.exec_command("bash -c 'mkdir -p /home/{user}/.ssh && "
++                                   "chown {user}:{user} /home/{user}/.ssh'".format(user=username))
++            container.exec_command("bash -c 'touch /home/{user}/.ssh/authorized_keys && "
++                                   "chown {user}:{user} /home/{user}/.ssh/authorized_keys'".format(user=username))
++
++        with open(config.public_key, 'r') as f:
++            public_key = f.read().strip()
++            if not container.exec_command('grep -q "{}$" /home/{}/.ssh/authorized_keys'.format(public_key, username)):
++                if not config.assume_yes:
++                    prompt = input(_("OK to add public key '{}' to container '{}'? [Yn]").format(config.public_key, config.container_id))
++                    if not (prompt == _('Y') or prompt == _('y') or prompt == ''):
++                        utils.get_logger().error(_("Public key must be added to container to continue."))
++                        sys.exit(1)
++
++                if not container.exec_command('bash -c "echo {} >> /home/{}/.ssh/authorized_keys"'.format(public_key, username)):
++                    utils.get_logger().error(_("Failed to add public key to container's authorized keys."))
++                    sys.exit(1)
++
++        subprocess.call(shlex.split(config.command(hostname)))
++
++
++if __name__ == '__main__':
++    main()
 === added file 'tools/libertine-shell.1'
 --- tools/libertine-shell.1	1970-01-01 00:00:00 +0000
 +++ tools/libertine-shell.1	2017-04-07 13:51:54 +0000
@@ -0,0 +1,26 @@
++.TH libertine-shell "1" "March 2017" "libertine-shell 1.0" "User Commands"
++
++.SH NAME
++libertine-shell \- Launch an SSH session connected to a lxc/lxd Libertine container
++
++.SH DESCRIPTION
++usage: libertine\-shell [\-h] [-i ID] [-u USER] [-f IDENTITY_FILE_PATH] [-y]
++.PP
++Launch an SSH session connected to a Libertine container
++
++.SS "optional arguments:"
++.TP
++\fB\-h\fR, \fB\-\-help\fR
++show this help message and exit
++.TP
++\fB\-i\fR, \fB\-\-id\fR
++Container identifier (default container if none specified)
++.TP
++\fB\-u\fR, \fB\-\-username\fR
++Container username (current username if none specified)
++.TP
++\fB\-f\fR, \fB\-\-identity-file\fR
++Full path of SSH key to be used
++.TP
++\fB\-y\fR, \fB\-\-assume-yes\fR
++Assume yes to all prompts (installations, public key copy, configuration changes)