/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: 2009-10-24 19:17:52 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091024191752-7g6xlf6wpp2pdexb
Convert some programs to use the exit codes from <sysexits.h>.  Change
all programs using the "argp" parsing functions to use them correctly;
checking return value, using argp_error() to report parse errors etc.

* plugin-runner.c: Use <sysexits.h> exit codes.  Always use fallback,
                   even on option errors, except for "--help", etc.
  (getplugin): Make sure "errno" is set correctly on return.
  (main): Declare our own "--help", "--usage", and "--version"
          options which do not cause the fallback to be invoked.
          In all other options, use fallback on any error.
  (parse_opt, parse_opt_config_file): Reset errno at start and return
                                      errno.  No need to check "arg"
                                      for NULL.  New "--help",
                                      "--usage", and "--version"
                                      options.
  (parse_opt): Accept empty string as global option.  Do not print
               errors which will be detected and reported later.  Do
               "argp_error()" on parse error or empty plugin names.
* plugins.d/mandos-client.c: Use <sysexits.h> exit codes.  Do not
                             return successful exit code on "--help",
                             etc. since this would give the wrong
                             message to "plugin-runner".
  (main): Declare our own "--help", "--usage", and "--version"
          options which do not return a successful exit code.
  (parse_opt): Reset errno at start and return errno.  Do
               "argp_error()" on parse errors.  New "--help",
               "--usage", and "--version" options.
* plugins.d/password-prompt.c: Use exit codes from <sysexits.h>.  Do
                               not return successful exit code on
                               "--help", etc. since this would give
                               the wrong message to "plugin-runner".
  (main): Declare our own "--help", "--usage", and "--version" options
          which do not return a successful exit code.  Do
          close(STDOUT_FILENO) after writing to check its return code.
  (parse_opt): Reset errno at start and return errno.

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
  
5
5
** Operating System
6
6
   
7
 
   Debian 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat".
 
7
   Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
8
8
   
9
9
   This is mostly for the support scripts which make sure that the
10
10
   client is installed and started in the initial RAM disk environment
11
11
   and that the initrd.img file is automatically made unreadable.  The
12
12
   server and client programs themselves *could* be run in other
13
13
   distributions, but they *are* specific to GNU/Linux systems, and
14
 
   are not written with portabillity to other Unixes in mind.
15
 
   
 
14
   are not intended to be portable to other Unixes.
 
15
  
16
16
** Libraries
17
17
   
18
18
   The following libraries and packages are needed.  (It is possible
35
35
    To build just the documentation, run the command "make doc".  Then
36
36
    the manual page "mandos.8", for example, can be read by running
37
37
    "man -l mandos.8".
38
 
    
 
38
   
39
39
*** Mandos Server
40
40
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
41
41
    + Avahi 0.6.16        http://www.avahi.org/
42
 
    + Python 2.6          http://www.python.org/
 
42
    + Python 2.5          http://www.python.org/
43
43
    + Python-GnuTLS 1.1.5 http://pypi.python.org/pypi/python-gnutls/
44
44
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
 
45
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
45
46
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
46
 
    + Urwid 0.9.8.3       http://excess.org/urwid/
47
47
    
48
48
    Strongly recommended:
49
49
    + fping 2.4b2-to-ipv6 http://www.fping.com/
50
50
    
51
51
    Package names:
52
52
    python-gnutls avahi-daemon python python-avahi python-dbus
53
 
    python-gobject python-urwid
54
 
    
 
53
    python-ctypes python-gobject
 
54
   
55
55
*** Mandos Client
56
56
    + initramfs-tools 0.85i
57
57
                  http://packages.qa.debian.org/i/initramfs-tools.html
99
99
     server computer*.
100
100
  
101
101
  4. Configure the client to use the correct network interface.  The
102
 
     interface to use is automatically chosen at boot, and if this
103
 
     needs to be adjusted, it will be necessary to edit
104
 
     /etc/initramfs-tools/initramfs.conf to change the DEVICE setting
105
 
     there.  Alternatively, the file /etc/mandos/plugin-runner.conf
106
 
     can be edited to add a "--device" parameter for the
107
 
     mandos-client(8) plugin.  Please note: If any of those files are
108
 
     changed, the initrd.img file must be updated, possibly using the
109
 
     following command:
 
102
     default is "eth0", and if this needs to be adjusted, it will be
 
103
     necessary to edit /etc/mandos/plugin-runner.conf to uncomment and
 
104
     change the line there.  If that file is changed, the initrd.img
 
105
     file must be updated, possibly using the following command:
110
106
     
111
107
        # update-initramfs -k all -u
112
108
  
113
109
  5. On the server computer, start the server by running the command
114
110
     For Debian: su -c 'invoke-rc.d mandos start'
115
 
     For Ubuntu: sudo service mandos start
 
111
     For Ubuntu: sudo invoke-rc.d mandos start
116
112
     
117
113
     At this point, it is possible to verify that the correct password
118
114
     will be received by the client by running the command: