/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Teddy Hogeborn
  • Date: 2019-07-18 00:02:43 UTC
  • Revision ID: teddy@recompile.se-20190718000243-okz4s9xao1r1tfnx
Document bug in mandos-keygen which strips white space from passwords

Passwords, as read by mandos-keygen when given the --password or -p
options, are stripped of white space from the start and from the end
of the password.  This is because mandos-keygen is a shell script, and
the Bourne Shell "read" builtin does not seem to have a way to avoid
this.  Document this bug.

* manods-keygen.xml (OPTIONS): Document the white space-stripping
                               nature of the --password/-p option, and
                               also note in the description of
                               --passfile and -F that they avoid this
                               behavior.
  (BUGS): Again mention the problem with the --password and -p
          options, and suggest --passfile as a possible workaround.

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
40
40
*** Mandos Server
41
41
    + GnuTLS 3.3          https://www.gnutls.org/
42
42
      (but not 3.6.0 or later, until 3.6.6, which works)
43
 
    + Avahi 0.6.16        https://www.avahi.org/
44
 
    + Python 3           https://www.python.org/
45
 
      Note: Python 2.7 is still supported, if the "mandos",
46
 
      "mandos-ctl", and "mandos-monitor" files are edited to contain
47
 
      "#!/usr/bin/python" instead of python3.
 
43
    + Avahi 0.6.16        http://www.avahi.org/
 
44
    + Python 2.7          https://www.python.org/
48
45
    + dbus-python 0.82.4 https://dbus.freedesktop.org/doc/dbus-python/
49
 
    + PyGObject 3.8      https://wiki.gnome.org/Projects/PyGObject
 
46
    + PyGObject 3.7.1     https://wiki.gnome.org/Projects/PyGObject
50
47
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
51
48
    + Urwid 1.0.1         http://urwid.org/
52
49
      (Only needed by the "mandos-monitor" tool.)
56
53
    + ssh-keyscan from OpenSSH http://www.openssh.com/
57
54
    
58
55
    Package names:
59
 
    avahi-daemon python3 python3-dbus python3-gi python3-urwid
60
 
    pkg-config fping ssh-client
 
56
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
 
57
    fping ssh-client
61
58
    
62
59
*** Mandos Client
63
60
    + GNU C Library 2.17 https://gnu.org/software/libc/
 
61
    + initramfs-tools 0.85i
 
62
                        https://tracker.debian.org/pkg/initramfs-tools
64
63
    + GnuTLS 3.3        https://www.gnutls.org/
65
64
      (but not 3.6.0 or later, until 3.6.6 which works)
66
 
    + Avahi 0.6.16      https://www.avahi.org/
 
65
    + Avahi 0.6.16      http://www.avahi.org/
67
66
    + GnuPG 1.4.9       https://www.gnupg.org/
68
67
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
69
68
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
70
69
    + libnl-route 3     https://www.infradead.org/~tgr/libnl/
71
 
    + GLib 2.40         http://www.gtk.org/
72
 
    
73
 
    One of:
74
 
    + initramfs-tools 0.85i
75
 
                        https://tracker.debian.org/pkg/initramfs-tools
76
 
    + dracut 044+241
77
 
         http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
78
70
    
79
71
    Strongly recommended:
80
72
    + OpenSSH           http://www.openssh.com/
81
73
    
82
74
    Package names:
83
 
    initramfs-tools dracut libgnutls-dev gnutls-bin libavahi-core-dev
84
 
    gnupg libgpgme11-dev pkg-config ssh libnl-route-3-dev
85
 
    libglib2.0-dev
 
75
    initramfs-tools libgnutls-dev gnutls-bin libavahi-core-dev gnupg
 
76
    libgpgme11-dev pkg-config ssh libnl-route-3-dev
86
77
 
87
78
* Installing the Mandos server
88
79
  
90
81
  
91
82
  2. On the computer to run as a Mandos server, run the following
92
83
     command:
93
 
     For Debian: su - -c 'make install-server'
 
84
     For Debian: su -c 'make install-server'
94
85
     For Ubuntu: sudo make install-server
95
86
     
96
87
     (This creates a configuration without any clients configured; you
102
93
  
103
94
  2. On the computer to run as a Mandos client, run the following
104
95
     command:
105
 
     For Debian: su - -c 'make install-client'
 
96
     For Debian: su -c 'make install-client'
106
97
     For Ubuntu: sudo make install-client
107
98
     
108
99
     This will also create an OpenPGP key, which will take some time
109
100
     and entropy, so be patient.
110
101
  
111
102
  3. Run the following command:
112
 
     For Debian: su - -c 'mandos-keygen --password'
 
103
     For Debian: su -c 'mandos-keygen --password'
113
104
     For Ubuntu: sudo mandos-keygen --password
114
105
     
115
106
     When prompted, enter the password/passphrase for the encrypted
127
118
        # update-initramfs -k all -u
128
119
  
129
120
  5. On the server computer, start the server by running the command
130
 
     For Debian: su - -c 'invoke-rc.d mandos start'
 
121
     For Debian: su -c 'invoke-rc.d mandos start'
131
122
     For Ubuntu: sudo service mandos start
132
123
     
133
124
     At this point, it is possible to verify that the correct password