/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 mandos-clients.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2015-08-10 09:00:23 UTC
  • Revision ID: teddy@recompile.se-20150810090023-fz6vjqr7zf33e2tf
Support the standard org.freedesktop.DBus.ObjectManager interface.

Now that the D-Bus standard has an interface to keep track of new and
removed objects, use that instead of our own methods.  This deprecates
our D-Bus methods "GetAllClients" and "GetAllClientsWithProperties"
and the signals "ClientAdded" and "ClientRemoved", all on the server
interface "se.recompile.Mandos".

* DBUS-API: Removed references to deprecated methods and signals;
  insert reference to the org.freedesktop.DBus.ObjectManager
  interface.
* mandos (DBusObjectWithProperties._get_all_interface_names): New.
  (dbus.OBJECT_MANAGER_IFACE): If not present, monkey patch.
  (DBusObjectWithObjectManager): New.
  (main/MandosDBusService): Inherit from DBusObjectWithObjectManager.
  (main/MandosDBusService.ClientRemoved): Annotate as deprecated.
  (main/MandosDBusService.GetAllClients): - '' -
  (main/MandosDBusService.GetAllClientsWithProperties): Annotate as
                                                        deprecated.
                                                        Also only
                                                        return
                                                        properties on
                                                        client
                                                        interface.
  (main/MandosDBusService.RemoveClient): Call client_removed_signal
                                         instead of ClientRemoved.
  (main/MandosDBusService.GetManagedObjects): New.
  (main/MandosDBusService.client_added_signal): New.
  (main/MandosDBusService.client_removed_signal): - '' -
  (main/cleanup): Call "client_removed_signal" instead of sending
                  "ClientRemoved" signal directly.
  (main): Call "client_added_signal" instead of sending "ClientAdded"
          signal directly.
* mandos-ctl: Use GetManagedObjects instead of
              GetAllClientsWithProperties.  Also, show better error
              message in case of failure to connect to the D-Bus

* mandos-monitor (MandosClientPropertyCache.properties_changed):
  Bug fix; only update properties on client interface.
  (UserInterface.find_and_remove_client): Change to accept arguments
                                          from InterfacesRemoved
                                          signal.  Also, bug fix:
                                          working error message when
                                          removing unknown client.
  (UserInterface.add_new_client): Change to accept arguments from
                                  InterfacesRemoved signal.  Pass
                                  properties to MandosClientWidget
                                  constructor.
  (UserInterface.run): Connect find_and_remove_client method to
                       InterfacesRemoved signal and the add_new_client
                       method to the InterfacesAdded signal.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY CONFNAME "mandos-clients.conf">
5
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2011-10-10">
 
6
<!ENTITY TIMESTAMP "2015-07-20">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
36
36
      <year>2009</year>
37
37
      <year>2010</year>
38
38
      <year>2011</year>
 
39
      <year>2012</year>
 
40
      <year>2013</year>
 
41
      <year>2014</year>
 
42
      <year>2015</year>
39
43
      <holder>Teddy Hogeborn</holder>
40
44
      <holder>Björn Påhlsson</holder>
41
45
    </copyright>
65
69
      ><refentrytitle>mandos</refentrytitle>
66
70
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
71
      The file needs to list all clients that should be able to use
68
 
      the service.  All clients listed will be regarded as enabled,
69
 
      even if a client was disabled in a previous run of the server.
 
72
      the service.  The settings in this file can be overridden by
 
73
      runtime changes to the server, which it saves across restarts.
 
74
      (See the section called <quote>PERSISTENT STATE</quote> in
 
75
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
76
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
77
      >changes</emphasis> to this file (including adding and removing
 
78
      clients) will, at startup, override changes done during runtime.
70
79
    </para>
71
80
    <para>
72
81
      The format starts with a <literal>[<replaceable>section
111
120
          <para>
112
121
            How long to wait for external approval before resorting to
113
122
            use the <option>approved_by_default</option> value.  The
114
 
            default is <quote>0s</quote>, i.e. not to wait.
 
123
            default is <quote>PT0S</quote>, i.e. not to wait.
115
124
          </para>
116
125
          <para>
117
126
            The format of <replaceable>TIME</replaceable> is the same
161
170
            This option is <emphasis>optional</emphasis>.
162
171
          </para>
163
172
          <para>
164
 
            This option allows you to override the default shell
165
 
            command that the server will use to check if the client is
166
 
            still up.  Any output of the command will be ignored, only
167
 
            the exit code is checked:  If the exit code of the command
168
 
            is zero, the client is considered up.  The command will be
169
 
            run using <quote><command><filename>/bin/sh</filename>
 
173
            This option overrides the default shell command that the
 
174
            server will use to check if the client is still up.  Any
 
175
            output of the command will be ignored, only the exit code
 
176
            is checked:  If the exit code of the command is zero, the
 
177
            client is considered up.  The command will be run using
 
178
            <quote><command><filename>/bin/sh</filename>
170
179
            <option>-c</option></command></quote>, so
171
180
            <varname>PATH</varname> will be searched.  The default
172
181
            value for the checker command is <quote><literal
173
182
            ><command>fping</command> <option>-q</option> <option
174
 
            >--</option> %%(host)s</literal></quote>.
 
183
            >--</option> %%(host)s</literal></quote>.  Note that
 
184
            <command>mandos-keygen</command>, when generating output
 
185
            to be inserted into this file, normally looks for an SSH
 
186
            server on the Mandos client, and, if it find one, outputs
 
187
            a <option>checker</option> option to check for the
 
188
            client’s key fingerprint – this is more secure against
 
189
            spoofing.
175
190
          </para>
176
191
          <para>
177
192
            In addition to normal start time expansion, this option
329
344
            <option>extended_timeout</option> option.
330
345
          </para>
331
346
          <para>
332
 
            The <replaceable>TIME</replaceable> is specified as a
333
 
            space-separated number of values, each of which is a
334
 
            number and a one-character suffix.  The suffix must be one
335
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
336
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
337
 
            minutes, hours, and weeks, respectively.  The values are
338
 
            added together to give the total time value, so all of
339
 
            <quote><literal>330s</literal></quote>,
340
 
            <quote><literal>110s 110s 110s</literal></quote>, and
341
 
            <quote><literal>5m 30s</literal></quote> will give a value
342
 
            of five minutes and thirty seconds.
 
347
            The <replaceable>TIME</replaceable> is specified as an RFC
 
348
            3339 duration; for example
 
349
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
 
350
            one year, two months, three days, four hours, five
 
351
            minutes, and six seconds.  Some values can be omitted, see
 
352
            RFC 3339 Appendix A for details.
 
353
          </para>
 
354
        </listitem>
 
355
      </varlistentry>
 
356
      
 
357
      <varlistentry>
 
358
        <term><option>enabled<literal> = </literal>{ <literal
 
359
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
360
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
361
        >no</literal> | <literal>false</literal> | <literal
 
362
        >off</literal> }</option></term>
 
363
        <listitem>
 
364
          <para>
 
365
            Whether this client should be enabled by default.  The
 
366
            default is <quote>true</quote>.
343
367
          </para>
344
368
        </listitem>
345
369
      </varlistentry>
389
413
        <quote><literal>approval_duration</literal></quote>,
390
414
        <quote><literal>created</literal></quote>,
391
415
        <quote><literal>enabled</literal></quote>,
 
416
        <quote><literal>expires</literal></quote>,
392
417
        <quote><literal>fingerprint</literal></quote>,
393
418
        <quote><literal>host</literal></quote>,
394
419
        <quote><literal>interval</literal></quote>,
444
469
    <informalexample>
445
470
      <programlisting>
446
471
[DEFAULT]
447
 
timeout = 5m
448
 
interval = 2m
 
472
timeout = PT5M
 
473
interval = PT2M
449
474
checker = fping -q -- %%(host)s
450
475
 
451
476
# Client "foo"
468
493
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
469
494
        QlnHIvPzEArRQLo=
470
495
host = foo.example.org
471
 
interval = 1m
 
496
interval = PT1M
472
497
 
473
498
# Client "bar"
474
499
[bar]
475
500
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
476
501
secfile = /etc/mandos/bar-secret
477
 
timeout = 15m
 
502
timeout = PT15M
478
503
approved_by_default = False
479
 
approval_delay = 30s
 
504
approval_delay = PT30S
480
505
      </programlisting>
481
506
    </informalexample>
482
507
  </refsect1>
491
516
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
492
517
      <manvolnum>5</manvolnum></citerefentry>,
493
518
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
519
      <manvolnum>8</manvolnum></citerefentry>,
 
520
      <citerefentry><refentrytitle>fping</refentrytitle>
494
521
      <manvolnum>8</manvolnum></citerefentry>
495
522
    </para>
 
523
    <variablelist>
 
524
      <varlistentry>
 
525
        <term>
 
526
          RFC 3339: <citetitle>Date and Time on the Internet:
 
527
          Timestamps</citetitle>
 
528
        </term>
 
529
      <listitem>
 
530
        <para>
 
531
          The time intervals are in the "duration" format, as
 
532
          specified in ABNF in Appendix A of RFC 3339.
 
533
        </para>
 
534
      </listitem>
 
535
      </varlistentry>
 
536
    </variablelist>
496
537
  </refsect1>
497
538
</refentry>
498
539
<!-- Local Variables: -->