nix: Update flake inputs

This is mainly to have new bats version (used in another branch).

nix: Switch from lorri to "use nix"

tests: Fix expect sendcont test

For some reason, more didn't exit automatically.

server: Drop novaboot-delayed-power-off.target

We used it in our first implementation of delayed power off, but now,
it is unused.

server: Unify installation target to PREFIX

Previously, we installed something to $PREFIX, something directly to
/usr/lib and /lib. Now, we use $PREFIX everywhere.

Update changelog for 20220425a release

Fix u-boot prompt handling

Commit 9c9a064 ("Reset u-boot download timeout with every '#'",
2022-04-03) broke behavior on systems with '#' in u-boot prompt. Due
to that commit, the prompt after file transfer is not detected and
novaboot timeouts. We fix that by switching the order of expect
patterns so that the prompt has priority over progress bar '#'
characters.

Update changelog for 20220425 release

server: Refactor delayed power-off logic

From time to time, I'm facing problems with delayed power off not
working. I'm not sure what is the exact reason, but a potential reason
could be that the board was powered on but the systemd service
novaboot-delayed-power-off.service, which is responsible for powering
off, was not started. To prevent that, we change the logic so that
powering on happens as a start job of the same service.

doc: Add preliminary Raspberry Pi guide

tests: Fix grub server tests

The behavior was probably changed in the recent network booting
changes. Since those tests were disabled, we didn't catch that a test
needs to be changed too.

tests: Check that server ssh login works and reenable server tests

tests: Fix ssh key setup for server tests

Reset u-boot download timeout with every '#'

Previously, we used two consecutive hash characters, but it turned out
that a Raspberry Pi, on our network experiences few timeouts at the
beginning (see '#T ' sequences below) and there are never two
consecutive hashes before the timeout elapses.

    U-Boot> tftpboot ${kernel_addr_r} /rpi/kernel
    Using ethernet@7d580000 device
    TFTP from server 10.35.95.2; our IP address is 10.35.95.45
    Filename '/rpi/kernel'.
    Load address: 0x80000
    Loading: #T #T T T Kernel load: timeout at /home/wsh/.nix-profile/bin/novaboot line 1298, <> line 7.

Therefore, we reset the timeout after just a single hash. Now the
above example runs as shown below:

    U-Boot> tftpboot ${kernel_addr_r} /rpi/kernel
    Using ethernet@7d580000 device
    TFTP from server 10.35.95.2; our IP address is 10.35.95.45
    Filename '/rpi/kernel'.
    Load address: 0x80000
    Loading: #T #T T ################################################  45 MiB
             2 MiB/s
    done

nix: Convert to flakes

We use flake-comapt to keep compatibility the old Nix.

nix: Adapt to renaming of buildPerlPackage

error: 'buildPerlPackage' has been renamed to/replaced by 'perlPackages.buildPerlPackage'

server: Doc grammar fixes

server: Fix enabling of delayed power off

The documented procedure stopped working after the last commit because
the [Install] section was removed from
novaboot-delayed-power-off.service.

In addition to adding the [Install] section, we also reshuffle
documentation and update systemd unit dependencies to make
power-on/off operations more reliable. The latter should (hopefully)
fix some race conditions that were possible in the past.

debian: Add example commands to produce package snapshot

server: Fix delayed power off

Th novaboot-delayed-power-off.service was meant to activate
system-level systemd timer at uses session shutdown. However, this
never worked, because an user service cannot be activated as a part of
session shutdown, because each service depends on app.slice and this
slice is being stopped in the shutdown sequence, which results in
removing the service start request from the shutdown transaction. This
behavior is demonstrated by the systemd debug log below:

    Pulling in novaboot-delayed-power-off.service/start from shutdown.target/start
    Added job novaboot-delayed-power-off.service/start to transaction.
    Pulling in app.slice/start from novaboot-delayed-power-off.service/start
    Pulling in novaboot-delayed-power-off.service/stop from app.slice/stop
    Added job novaboot-delayed-power-off.service/stop to transaction.
    Keeping job novaboot-delayed-power-off.service/stop because of app.slice/stop
    novaboot-delayed-power-off.service: Deleting job novaboot-delayed-power-off.service/start as dependency of job app.slice/start
    Keeping job novaboot-delayed-power-off.service/stop because of app.slice/stop
    Keeping job novaboot-delayed-power-off.service/stop because of app.slice/stop
    Keeping job novaboot-delayed-power-off.service/stop because of app.slice/stop
    Found redundant job novaboot-delayed-power-off.service/stop, dropping from transaction.

Therefore, we don't use a service with ExecStart, but use ExecStop to
start the shutdown timer and start the service by novaboot-shell
whenever the board is powered on.

server: Make systemd invoke novaboot-shell in the $HOME directory

This is the same directory as where novaboot-shell is invoked by sshd.

debian: Increase dh compat level to 13

Update changelog for 20211022 release

Make <<>> fail if it cannot open a file

By default, only a warning is printed and the script continues.

Example of this situation:

    % novaboot non-existent --gen-only
    novaboot: Read /home/wsh/.config/novaboot
    novaboot: Effective options: non-existent --gen-only
    Can't open non-existent: No such file or directory at /home/wsh/src/novaboot/novaboot line 362.

We do not add a test for this, because we make all warnings fatal when
running tests.

Replace <> with <<>>

The reason is that <> can be dangerous. From Perl documentation:

    Since the null filehandle uses the two argument form of "open" in
    perlfunc it interprets special characters, so if you have a script like
    this:

while (<>) {
    print;
}

    and call it with "perl dangerous.pl 'rm -rfv *|'", it actually opens a
    pipe, executes the "rm" command and reads "rm"'s output from that pipe.
    If you want all items in @ARGV to be interpreted as file names, you can
    use the module "ARGV::readonly" from CPAN, or use the double diamond
    bracket:

while (<<>>) {
    print;
}

    Using double angle brackets inside of a while causes the open to use
    the three argument form (with the second argument being "<"), so all
    arguments in "ARGV" are treated as literal filenames (including "-").
    (Note that for convenience, if you use "<<>>" and if @ARGV is empty, it
    will still read from the standard input.)

server: Add run_novaboot to be used as default_cmd

server: Allow reset_cmd to contain a shell function name

Merge branch 'feat/pxe-boot'

shell.nix: Add grub2 and dhcp

This is to allow manual testing of --dhcp-tftp --grub2 functionality.
Currently, I don't have time to fully automate the tests, but this is
how I tested it manually:

1. Create testboot script with the following content:

       #!/usr/bin/env novaboot

       BOOT_METHOD=linux
       load kernel
       load ramdisk

2. Create a bridge interface:

       brctl addbr br0
       ip link set dev br0 up

3. Run:

       ./testboot --dhcp-tftp --grub2 --remote-cmd="sleep inf" --netif=br0

4. Verify that the Qemu VM boots GRUB2:

       sudo qemu-system-x86_64 -boot n -nic bridge,br=br0 -nographic

Add tests for GRUB2 BOOT_METHOD

grub2: Don't perform unnecessary config modifications for the linux BOOT_METHOD

Create tftpd.pid in default location

This way we restrict the user in commands which he can run under sudo.
It's better to use * wildcard in the pkill command as it doesn't write
anything to the filesystem.

tftpd: allow varying path to the *.pid while run by sudo

Die in case of multiple initrds for the Linux kernel

dhcpd: Add sample config for different PXEClient architectures

Also use path to binaries generated with grub-mknetdir.

tftpd: Set root to the dir specified in --server

tftpd: Add call to grub-mknetdir

Move grub.cfg to the default location

The default path grub is looking for its config is
/boot/grub/grub.cfg.

Add BOOT_METHOD variable to control how to generate GRUB2 config

tftpd: Run with mapfile

This mapfile is needed as some pxeclient add zero byte \x00 to the end
of the filename. This is a known bug. The mapfile contains rule to
remove that byte.

Add test for GRUB2

This will allow us to verify that the changes to GRUB2 config file
generation code in the subsequent commits work as intended.

Fix typo

Copy files to TFTP server with default permissions

Previously, we used rsync's --perm option to mirror source permissions
at target. This could have caused the files to be inaccessible by the
TFTP server, because source permissions were to tight. To overcome
this problem, we now always set the target permissions to the default
value by using --chmod. From rsync manual:

    To give new files the destination-default permissions (while
    leaving existing files unchanged), make sure that the --perms
    option is off and use --chmod=ugo=rwX.

Note that this change does not require changes on the server
side (novaboot-shell).

Add --copy= as alias to --server=

"Copy" better corresponds to what this option does.

[This commit message and documentation was updated by Michal Sojka.]

Update changelog for 20210126a release

tests: Skip server tests during Debian package build

tests: Rework server tests to not require external ssh-agent

Strip trailing spaces in novaboot script load/copy lines

Trailing spaces break device tree detection in U-Boot support, because
the device tree is detected by \.dtb$ regex.

tests: Add simple u-boot tests

tests: Fix iprelay-cmd test to work on both Debian an NixOS

doc: Add missing "to"

Update changelog for 20210126 release

README: Fix link

Add README.md

It is shorter than the current README.pod (man page), to which it
links. In addition to the man page, it contains installation
instructions and links to server-side documentation.

server: Split documentation to separate files

It will be easier to look up the documentation on GitHub.

server: Add support for default_cmd configuration variable

server: Refactor console setup to a separate function

Also drop exec before the command, because it only causes troubles.
Thanks to dropping exec, we had to change the testsuite, because
without exec it starts a new process, which is not killed by "kill
$COPROC_PID" and since it holds a lock (via flock), we could not run
the following tests.

This change will be useful in next commits.

server: Document how to use shell function for console_cmd

Fixes for all tests to pass on NixOS

nix: Make Nix shell contain all needed Perl packages

Namely: novaboot dependencies as well as pod2X needed for README
creation during commit (my git hook).

server: Do not hardcode bash path

nix: Allow running (at least a part of) test suite from nix-shell

Add test for functionality in the previous commit

Prioritize 'exiton' over 'expect_raw'

server: Document automatic power off

tests: Make shebangs NixOS compatible

Update changelog for 20201217 release

server: Call "systemctl is-enabled" with --quiet

Rename novaboot-power-off.service to novaboot-delayed-power-off.service

Also rework the logic to not relay on systemd's Conflicts but switch
off the timer explicitly in novaboot-power script.

Run pre-commit hook in bash

We need "set -o pipefail" and it needs bash.

Make novaboot shebang NixOS compatible

nix: Add derivation for novaboot-server

server: Add missing files for delayed power-off

These should have been a part of commit 9dffa51 ("Simplify systemd
logic for automated delayed power off", 2019-11-21).

Catch errors in pre-commit hook

Add basic Nix support

doc: Cosmetic changes

doc: Add section about booting Linux

Allow configuring the default value of --netif globally in configuration files

Simplify systemd logic for automated delayed power off

TODO documentation

server: Use Makefile to install the server

This will become handy in the next commit.

tests: Get rid of asynchronous process substitution

Under bash, processes substitution is run asynchronously. This means
that the messages printed by the process can be mixed with other
messages, which causes random tests to fail, because the wvtest
protocol lines are corrupted.

Now we run all processes synchronously and the test no longer fail
randomly.

server: User temporary RUN_DIR in $HOME does not exist

This is the case under pbuilder.

debian: Add build-depends to be able to run tests under pbuilder

debian: Fix version syntax in Depends

tests: Remove home directory for server tests

It is not needed since commit 84f456f ("tests: Convert server tests to
use the account from last commit", 2019-11-16),

Allow specifying /dev/null as load argument

This is useful if only kernel parameters are important, but kernel
image is taken from somewhere else.

server: Ensure that configuration can depend on logged-in user name

Revert "server: Add experimental support for the ssh sub-command"

This reverts commit 65dbc765ea6bb1eb7a5b72f34bfc71323617106a.

It would be better to use SSH port forwarding to access target's SSH.

tests: Convert server tests to use the account from last commit

test: Add script for creating test account

Disable echo in default stty arguments

From time to time I observe that the novaboot hangs in the uboot menu
with weird characters on the line like this

    => MC:   mmc@7000: 0^M^JLoading Environment from MMC... OK^M^JIn:    serial@3000^M^JNet:   eth0: ethernet@ff3f0000^M^JHit any key to stop autoboot:  2 ^H^H^H 0^M^J=> MC:   mmc@7000: 0^M^JLoading Environment from MMC... OK^M^JIn:    serial@3000^M^JNet:
    Unknown command 'MC:' - try 'help'

When I tried to play with stty options I realized that the echo option
breaks the communication. The reason is that when echo is
enabled (which is by default), all characters sent by the target are
echoed back to the target, which may interpret them.

To confirm that, I tested the following options:

    --stty="raw -crtscts -onlcr 115200 -echo" (working)
    --stty="raw -crtscts -onlcr 115200 echo" (not working)

It turns out that the problem appears only during the first initial
novaboot conversation with the bootloader after. After switching to
interactive mode, echo is automatically disabled by Expect.pm and for
subsequent boots, echo remains disabled.

[Note: Commit message updated by Michal Sojka based on GitHub
discussion https://github.com/wentasah/novaboot/pull/5 and his
investigation of the issue.]

tests: Make some server tests more readable

server: Always use flock with --no-fork

Without this my test suite fails. The reason for not using --no-fork
was that it didn't work well on some systems. Since I'm annoyed by not
working test suite, I'm willing to investigate --no-fork problems if
they still exist on current Linux systems.

Improve an error message

server: Add experimental support for the ssh sub-command

server: Document get-config

server: Mention get-config command in help message

Update changelog for 20191023 release

server: Add novaboot users to the novaboot group

This is mainly intended for allowing "Match Group" configuration in
sshd_config.

server: Mention adduser-novaboot in novaboot-shell documentation