Merge branch 'serial-console' of github.com:c-po/vyos-1x into current

* 'serial-console' of github.com:c-po/vyos-1x:
  console: T2569: run VGA console powersave on tty1
  console: T2569: replicate console settings to grub.cfg
  Debian: fix warning about undefined substitution variables
  console: T2569: only start serial console if device exists
  console: T2529: migrate from ttyUSB device to new device in /dev/serial/by-bus
  console: T2570: remove support for Hayes Modems
  netconsole: T2561: use migrator to delete config nodes
  console: T2569: initial implementation with XML and Python

5 files changed, 337 insertions, 5 deletions

diff --git a/data/templates/getty/serial-getty.service.tmpl b/data/templates/getty/serial-getty.service.tmpl
new file mode 100644
index 000000000..0183eae7d
--- /dev/null
+++ b/data/templates/getty/serial-getty.service.tmpl
@@ -0,0 +1,37 @@
+[Unit]
+Description=Serial Getty on %I
+Documentation=man:agetty(8) man:systemd-getty-generator(8)
+Documentation=http://0pointer.de/blog/projects/serial-console.html
+BindsTo=dev-%i.device
+After=dev-%i.device systemd-user-sessions.service plymouth-quit-wait.service getty-pre.target
+After=vyos-router.service
+
+# If additional gettys are spawned during boot then we should make
+# sure that this is synchronized before getty.target, even though
+# getty.target didn't actually pull it in.
+Before=getty.target
+IgnoreOnIsolate=yes
+
+# IgnoreOnIsolate causes issues with sulogin, if someone isolates
+# rescue.target or starts rescue.service from multi-user.target or
+# graphical.target.
+Conflicts=rescue.service
+Before=rescue.service
+
+[Service]
+# The '-o' option value tells agetty to replace 'login' arguments with an
+# option to preserve environment (-p), followed by '--' for safety, and then
+# the entered username.
+ExecStart=-/sbin/agetty -o '-p -- \\u' --keep-baud {{ speed }} %I $TERM
+Type=idle
+Restart=always
+UtmpIdentifier=%I
+TTYPath=/dev/%I
+TTYReset=yes
+TTYVHangup=yes
+KillMode=process
+IgnoreSIGPIPE=no
+SendSIGHUP=yes
+
+[Install]
+WantedBy=getty.target
diff --git a/debian/control b/debian/control
index 7c1555416..104a267ea 100644
--- a/debian/control
+++ b/debian/control
@@ -98,17 +98,13 @@ Depends: python3,
   salt-minion,
   vyos-utils,
   nftables (>= 0.9.3),
-  conntrack,
-  ${shlibs:Depends},
-  ${misc:Depends}
+  conntrack
 Description: VyOS configuration scripts and data
  VyOS configuration scripts, interface definitions, and everything
 
 Package: vyos-1x-vmware
 Architecture: amd64 i386
 Depends:
- ${misc:Depends},
- ${shlibs:Depends},
  vyos-1x,
  open-vm-tools
 Description: VyOS configuration scripts and data for VMware
diff --git a/interface-definitions/system-console.xml.in b/interface-definitions/system-console.xml.in
new file mode 100644
index 000000000..71e63d0cb
--- /dev/null
+++ b/interface-definitions/system-console.xml.in
@@ -0,0 +1,90 @@
+<?xml version="1.0"?>
+<interfaceDefinition>
+  <node name="system">
+    <children>
+      <node name="console" owner="${vyos_conf_scripts_dir}/system_console.py">
+        <properties>
+          <help>Serial console configuration</help>
+          <priority>100</priority>
+        </properties>
+        <children>
+          <tagNode name="device">
+            <properties>
+              <help>Serial console device name</help>
+              <completionHelp>
+                <script>ls -1 /dev | grep -e ttyS -e hvc</script>
+                <script>if [ -d /dev/serial/by-bus ]; then ls -1 /dev/serial/by-bus; fi</script>
+              </completionHelp>
+              <valueHelp>
+                <format>ttySN</format>
+                <description>TTY device name, regular serial port</description>
+              </valueHelp>
+              <valueHelp>
+                <format>usbNbXpY</format>
+                <description>TTY device name, USB based</description>
+              </valueHelp>
+              <valueHelp>
+                <format>hvcN</format>
+                <description>Xen console</description>
+              </valueHelp>
+              <constraint>
+                  <regex>^(ttyS[0-9]+|hvc[0-9]+|usb[0-9]+b.*)$</regex>
+              </constraint>
+            </properties>
+            <children>
+              <leafNode name="speed">
+                <properties>
+                  <help>Console baud rate</help>
+                  <completionHelp>
+                    <list>1200 2400 4800 9600 19200 38400 57600 115200</list>
+                  </completionHelp>
+                  <valueHelp>
+                    <format>1200</format>
+                    <description>1200 bps</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>2400</format>
+                    <description>2400 bps</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>4800</format>
+                    <description>4800 bps</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>9600</format>
+                    <description>9600 bps</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>19200</format>
+                    <description>19200 bps</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>38400</format>
+                    <description>38400 bps</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>57600</format>
+                    <description>57600 bps</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>115200</format>
+                    <description>115200 bps</description>
+                  </valueHelp>
+                  <constraint>
+                    <regex>(1200|2400|4800|9600|19200|38400|57600|115200)</regex>
+                  </constraint>
+                </properties>
+              </leafNode>
+            </children>
+          </tagNode>
+          <leafNode name="powersave">
+            <properties>
+              <help>Enable screen blank powersaving on VGA console</help>
+              <valueless/>
+            </properties>
+          </leafNode>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>
diff --git a/src/conf_mode/system_console.py b/src/conf_mode/system_console.py
new file mode 100755
index 000000000..0831232fb
--- /dev/null
+++ b/src/conf_mode/system_console.py
@@ -0,0 +1,134 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2020 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# 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 os
+import re
+
+from fileinput import input as replace_in_file
+from vyos.config import Config
+from vyos.util import call
+from vyos.template import render
+from vyos import ConfigError, airbag
+airbag.enable()
+
+by_bus_dir = '/dev/serial/by-bus'
+
+def get_config():
+    conf = Config()
+    base = ['system', 'console']
+
+    # retrieve configuration at once
+    console = conf.get_config_dict(base)
+
+    # bail out early if no serial console is configured
+    if 'device' not in console.keys():
+        return console
+
+    # convert CLI values to system values
+    for device in console['device'].keys():
+        # no speed setting has been configured - use default value
+        if not 'speed' in console['device'][device].keys():
+            tmp = { 'speed': '' }
+            if device.startswith('hvc'):
+                tmp['speed'] = 38400
+            else:
+                tmp['speed'] = 115200
+
+            console['device'][device].update(tmp)
+
+        if device.startswith('usb'):
+            # It is much easiert to work with the native ttyUSBn name when using
+            # getty, but that name may change across reboots - depending on the
+            # amount of connected devices. We will resolve the fixed device name
+            # to its dynamic device file - and create a new dict entry for it.
+            by_bus_device = f'{by_bus_dir}/{device}'
+            if os.path.isdir(by_bus_dir) and os.path.exists(by_bus_device):
+                tmp = os.path.basename(os.readlink(by_bus_device))
+                # updating the dict must come as last step in the loop!
+                console['device'][tmp] = console['device'].pop(device)
+
+    return console
+
+def verify(console):
+    return None
+
+def generate(console):
+    base_dir = '/etc/systemd/system'
+    # Remove all serial-getty configuration files in advance
+    for root, dirs, files in os.walk(base_dir):
+        for basename in files:
+            if 'serial-getty' in basename:
+                call(f'systemctl stop {basename}')
+                os.unlink(os.path.join(root, basename))
+
+    for device in console['device'].keys():
+        config_file = base_dir + f'/serial-getty@{device}.service'
+        render(config_file, 'getty/serial-getty.service.tmpl', console['device'][device])
+
+    # Reload systemd manager configuration
+    call('systemctl daemon-reload')
+
+    # GRUB
+    # For existing serial line change speed (if necessary)
+    # Only applys to ttyS0
+    if 'ttyS0' not in console['device'].keys():
+        return None
+
+    speed = console['device']['ttyS0']['speed']
+    grub_config = '/boot/grub/grub.cfg'
+    if not os.path.isfile(grub_config):
+        return None
+
+    # stdin/stdout are redirected in replace_in_file(), thus print() is fine
+    p = re.compile(r'^(.* console=ttyS0),[0-9]+(.*)$')
+    for line in replace_in_file(grub_config, inplace=True):
+        if line.startswith('serial --unit'):
+            line = f'serial --unit=0 --speed={speed}\n'
+        elif p.match(line):
+            line = '{},{}{}\n'.format(p.search(line)[1], speed, p.search(line)[2])
+
+        print(line, end='')
+
+    return None
+
+def apply(console):
+    # reset screen blanking
+    call('/usr/bin/setterm -blank 0 -powersave off -powerdown 0 -term linux </dev/tty1 >/dev/tty1 2>&1')
+    if not console:
+        return None
+
+    if 'powersave' in console.keys():
+        # Configure screen blank powersaving on VGA console
+        call('/usr/bin/setterm -blank 15 -powersave powerdown -powerdown 60 -term linux </dev/tty1 >/dev/tty1 2>&1')
+
+    # Start getty process on configured serial interfaces
+    for device in console['device'].keys():
+        # Only start console if it exists on the running system. If a user
+        # detaches a USB serial console and reboots - it should not fail!
+        if os.path.exists(f'/dev/{device}'):
+            call(f'systemctl start serial-getty@{device}.service')
+
+    return None
+
+if __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        exit(1)
diff --git a/src/migration-scripts/system/16-to-17 b/src/migration-scripts/system/16-to-17
new file mode 100755
index 000000000..981149d1b
--- /dev/null
+++ b/src/migration-scripts/system/16-to-17
@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2020 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# 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/>.
+
+# remove "system console netconsole"
+# remove "system console device <device> modem"
+
+import os
+import sys
+
+from vyos.configtree import ConfigTree
+
+if (len(sys.argv) < 1):
+    print("Must specify file name!")
+    sys.exit(1)
+
+file_name = sys.argv[1]
+
+with open(file_name, 'r') as f:
+    config_file = f.read()
+
+config = ConfigTree(config_file)
+base = ['system', 'console']
+if not config.exists(base):
+    # Nothing to do
+    sys.exit(0)
+else:
+    # remove "system console netconsole" (T2561)
+    if config.exists(base + ['netconsole']):
+        config.delete(base + ['netconsole'])
+
+    for device in config.list_nodes(base + ['device']):
+        dev_path = base + ['device', device]
+        # remove "system console device <device> modem" (T2570)
+        if config.exists(dev_path + ['modem']):
+            config.delete(dev_path + ['modem'])
+
+        # Only continue on USB based serial consoles
+        if not 'ttyUSB' in device:
+            continue
+
+        # A serial console has been configured but it does no longer
+        # exist on the system - cleanup
+        if not os.path.exists(f'/dev/{device}'):
+            config.delete(dev_path)
+            continue
+
+        # migrate from ttyUSB device to new device in /dev/serial/by-bus
+        for root, dirs, files in os.walk('/dev/serial/by-bus'):
+            for usb_device in files:
+                device_file = os.path.realpath(os.path.join(root, usb_device))
+                # migrate to new USB device names (T2529)
+                if os.path.basename(device_file) == device:
+                    config.copy(dev_path, base + ['device', usb_device])
+                    # Delete old USB node from config
+                    config.delete(dev_path)
+
+    try:
+        with open(file_name, 'w') as f:
+            f.write(config.to_string())
+    except OSError as e:
+        print("Failed to save the modified config: {}".format(e))
+        sys.exit(1)