/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 DBUS-API

  • Committer: Teddy Hogeborn
  • Date: 2019-07-27 10:11:45 UTC
  • Revision ID: teddy@recompile.se-20190727101145-jnpbpf8220gldbcd
Add dracut(8) support

Add support for the dracut(8) system for generating initramfs image
files; dracut is an alternative to the "initramfs-tools" package.

* .bzrignore (dracut-module/password-agent): Ignore new binary file.
* dracut-module: New directory for the dracut module.
* INSTALL (Prerequisites/Libraries/Mandos Client): Add dracut as an
                                                   alternative to
                                                   initramfs-tools,
                                                   and also add GLib.
* Makefile (DRACUTMODULE, GLIB_CFLAGS, GLIB_LIBS): New.
  (CPROGS): Add "dracut-module/password-agent".
  (DOCS): Add "dracut-module/password-agent.8mandos".
  (dracut-module/password-agent.8mandos): New.
  (dracut-module/password-agent.8mandos.xhtml): - '' -
  (dracut-module/password-agent): - '' -
  (check): Add command to run tests of password-agent(8mandos).
  (install-client-nokey): Also install the dracut module directory,
                          its files, and the password-agent(8mandos)
                          manual page.
  (install-client): To update the initramfs image file, run
                    update-initramfs or dracut depending on what is
                    installed.
  (uninstall-client): - '' - and also uninstall the the files in the
                      dracut module directory, that directory itself,
                      and the password-agent(8mandos) manual page.
* debian/control (Build-Depends): Add "libglib2.0-dev (>=2.40)".
  (Package: mandos-client/Depends): Add "dracut (>= 044+241-3)" as an
                                    alternative dependency to
                                    initramfs-tools.
  (Package: mandos-client/Conflicts): New; set to
                                      "dracut-config-generic".
  (debian/mandos-client.README.Debian): Document alternative commands
                                        to update the initramfs image
                                        for when dracut is used.
* debian/mandos-client.postinst (update_initramfs): Use alternative
                                                    commands to update
                                                    the initramfs
                                                    image for when
                                                    dracut is used.
* debian/tests/control (password-agent, password-agent-suid): Add two
                                                              new tests.
* dracut-module/ask-password-mandos.path: New.
* dracut-module/ask-password-mandos.service: - '' -
* dracut-module/cmdline-mandos.sh: - '' -
* dracut-module/module-setup.sh: - '' -
* dracut-module/password-agent.c: - '' -
* dracut-module/password-agent.xml: - '' -
* initramfs-unpack: Use the dracut "skipcpio" command, if available.
                    Also be more flexible and try hard to detect where
                    compressed data starts.
* plugins.d/mandos-client.xml (SECURITY): Be more precise that the
                                          mandos-client binary might
                                          not always be setuid, but
                                          that the program assumes
                                          that it has been started
                                          that way.
* plugins.d/password-prompt.c: Add new "--prompt" option.
  (conflict_detection): First try to detect the new PID file of
                        plymouth.
  (main): Define and use new "prompt" variable.
* plugins.d/password-prompt.xml (SYNOPSIS): Show new --prompt option.
  (DESCRIPTION): Describe new behavior of looking for plymouth PID
                 file.
  (OPTIONS): Document new "--prompt" option.
  (ENVIRONMENT): Clarify that the CRYPTTAB_SOURCE and CRYPTTAB_NAME
                 environment variables are not used if the --prompt
                 option is used.  Remove unnecessarily specific
                 details about where the CRYPTTAB_SOURCE and
                 CRYPTTAB_NAME comes from, since this can now be
                 either initramfs-tools or dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference, and add commas
              to separate the other references.
* plugins.d/plymouth.c: Add new "--prompt" and "--debug" options.
  (debug): New global flag.
  (fprintf_plus): New function, used for debug output.
  (exec_and_wait): Add extra "const" to "argv" argument.
  (main): Define and use new "prompt" variable.  Add debug output.
  (main/options, main/parse_opt): New; used to parse options.
* plugins.d/plymouth.xml (SYNOPSIS): Show new options.
  (OPTIONS): Document new options.
  (ENVIRONMENT): Clarify that the cryptsource and crypttarget
                 environment variables are not used if the --prompt
                 option is used.  Remove unnecessarily specific
                 details about where the cryptsource and crypttarget
                 comes from, since this can now be either
                 initramfs-tools or dracut.
  (EXAMPLE): Add an example using an option.
  (SEE ALSO): Remove superfluous crypttab(5) reference.
* plugins.d/splashy.xml (ENVIRONMENT): Clarify that the cryptsource
                                       and crypttarget environment
                                       variables are not used if the
                                       --prompt option is used.
                                       Remove unnecessarily specific
                                       details about where the
                                       cryptsource and crypttarget
                                       comes from, since this can now
                                       be either initramfs-tools or
                                       dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference.
* plugins.d/usplash.xml (ENVIRONMENT): Clarify that the cryptsource
                                       and crypttarget environment
                                       variables are not used if the
                                       --prompt option is used.
                                       Remove unnecessarily specific
                                       details about where the
                                       cryptsource and crypttarget
                                       comes from, since this can now
                                       be either initramfs-tools or
                                       dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference.

Show diffs side-by-side

added added

removed removed

Lines of Context:
DBUS-API
13
13
  | Path                  | Object            |
14
14
  |-----------------------+-------------------|
15
15
  | "/"                   | The Mandos Server |
16
 
  | "/clients/CLIENTNAME" | Mandos Client     |
17
 
 
18
 
  
 
16
 
 
17
  (To get a list of paths to client objects, use the standard D-Bus
 
18
  org.freedesktop.DBus.ObjectManager interface, which the server
 
19
  object supports.)
 
20
 
 
21
 
19
22
* Mandos Server Interface:
20
23
  Interface name: "se.recompile.Mandos"
21
24
  
22
25
** Methods:
23
 
*** GetAllClients() → (ao: Clients)
24
 
    Returns an array of all client D-Bus object paths
25
 
   
26
 
*** GetAllClientsWithProperties() → (a{oa{sv}}: ClientProperties)
27
 
    Returns an array of all clients and all their properties
28
 
   
29
26
*** RemoveClient(o: ObjectPath) → nothing
30
27
    Removes a client
31
28
   
32
29
** Signals:
33
 
*** ClientAdded(o: ObjectPath)
34
 
    A new client was added.
35
 
   
36
 
*** ClientNotFound(s: Fingerprint, s: Address)
37
 
    A client connected from Address using Fingerprint, but was
38
 
    rejected because it was not found in the server.  The fingerprint
 
30
*** ClientNotFound(s: KeyID, s: Address)
 
31
    A client connected from Address using KeyID, but was
 
32
    rejected because it was not found in the server.  The key ID
39
33
    is represented as a string of hexadecimal digits.  The address is
40
34
    an IPv4 or IPv6 address in its normal string format.
41
 
   
42
 
*** ClientRemoved(o: ObjectPath, s: Name)
43
 
    A client named Name on ObjectPath was removed.
44
35
 
45
36
 
46
37
* Mandos Client Interface:
55
46
    Assert that this client has been checked and found to be alive.
56
47
    This will restart the timeout before disabling this client.  See
57
48
    also the "LastCheckedOK" property.
58
 
    
59
 
*** Disable() → nothing
60
 
    Disable this client.  See also the "Enabled" property.
61
 
    
62
 
*** Enable() → nothing
63
 
    Enable this client.  See also the "Enabled" property.
64
 
    
65
 
*** StartChecker() → nothing
66
 
    Start a new checker for this client, if none is currently
67
 
    running.  See also the "CheckerRunning" property.
68
 
    
69
 
*** StopChecker() → nothing
70
 
    Abort a running checker process for this client, if any.  See also
71
 
    the "CheckerRunning" property.
72
49
 
73
50
** Properties
74
51
   
89
66
   | Expires (f)             | s    | Read       | N/A                 |
90
67
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
91
68
   | Fingerprint             | s    | Read       | fingerprint         |
 
69
   | KeyID                   | s    | Read       | key_id              |
92
70
   | Host                    | s    | Read/Write | host                |
93
71
   | Interval (a)            | t    | Read/Write | interval            |
94
72
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
95
73
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
96
 
   | LastEnabled (i)         | s    | Read       | N/A                 |
 
74
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
 
75
   | LastEnabled (j)         | s    | Read       | N/A                 |
97
76
   | Name                    | s    | Read       | (Section name)      |
98
 
   | ObjectPath              | o    | Read       | N/A                 |
99
 
   | Secret (j)              | ay   | Write      | secret (or secfile) |
 
77
   | Secret (k)              | ay   | Write      | secret (or secfile) |
100
78
   | Timeout (a)             | t    | Read/Write | timeout             |
101
79
   
102
80
   a) Represented as milliseconds.
103
81
   
104
82
   b) An approval is currently pending.
105
83
   
106
 
   c) Setting this property is equivalent to calling StartChecker() or
107
 
      StopChecker().
 
84
   c) Changing this property can either start a new checker or abort a
 
85
      running one.
108
86
   
109
87
   d) The creation time of this client object, as an RFC 3339 string.
110
88
   
111
 
   e) Setting this property is equivalent to calling Enable() or
112
 
      Disable().
 
89
   e) Changing this property enables or disables a client.
113
90
   
114
91
   f) The date and time this client will be disabled, as an RFC 3339
115
92
      string, or an empty string if this is not scheduled.
124
101
      always use an empty string when setting this property, to allow
125
102
      for possible future expansion.
126
103
   
127
 
   i) The date and time this client was last enabled, as an RFC 3339
 
104
   i) The exit status of the last checker, -1 if it did not exit
 
105
      cleanly, -2 if a checker has not yet returned.
 
106
   
 
107
   j) The date and time this client was last enabled, as an RFC 3339
128
108
      string, or an empty string if this has not happened.
129
109
   
130
 
   j) A raw byte array, not hexadecimal digits.
 
110
   k) A raw byte array, not hexadecimal digits.
131
111
 
132
112
** Signals
133
113
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
146
126
    milliseconds, depending on ApprovedByDefault.  Approve() can now
147
127
    usefully be called on this client object.
148
128
    
149
 
*** PropertyChanged(s: Property, v: Value)
150
 
    The Property on this client has changed to Value.
151
 
    
152
129
*** Rejected(s: Reason)
153
130
    This client was not given its secret for a specified Reason.
154
131
 
155
 
*** NewRequest(s: IPAddress)
156
 
    A client at IPAdress has requested its secret.
157
 
 
158
132
* Copyright
159
133
 
160
 
    Copyright © 2010-2012 Teddy Hogeborn
161
 
    Copyright © 2010-2012 Björn Påhlsson
 
134
    Copyright © 2010-2019 Teddy Hogeborn
 
135
    Copyright © 2010-2019 Björn Påhlsson
162
136
  
163
137
** License:
164
 
   
165
 
   This program is free software: you can redistribute it and/or
166
 
   modify it under the terms of the GNU General Public License as
167
 
   published by the Free Software Foundation, either version 3 of the
168
 
   License, or (at your option) any later version.
169
 
 
170
 
   This program is distributed in the hope that it will be useful, but
 
138
 
 
139
   This file is part of Mandos.
 
140
 
 
141
   Mandos is free software: you can redistribute it and/or modify it
 
142
   under the terms of the GNU General Public License as published by
 
143
   the Free Software Foundation, either version 3 of the License, or
 
144
   (at your option) any later version.
 
145
 
 
146
   Mandos is distributed in the hope that it will be useful, but
171
147
   WITHOUT ANY WARRANTY; without even the implied warranty of
172
148
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
173
149
   General Public License for more details.
174
150
 
175
151
   You should have received a copy of the GNU General Public License
176
 
   along with this program.  If not, see
177
 
   <http://www.gnu.org/licenses/>.
 
152
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
178
153
 
179
154
 
180
155
#+STARTUP: showall