/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: 2011-07-15 01:07:51 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110715010751-bh9rhcm6hv8f174e
* initramfs-tools-script: Bug fix: Add missing "--options" argument to
                          getopt.

Show diffs side-by-side

added added

removed removed

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