/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: 2017-02-21 18:23:54 UTC
  • Revision ID: teddy@recompile.se-20170221182354-qjl75f74t02bbm5n
Suppress lintian warning about lsb-base dependency

This warning is erroneous since we do depend on lsb-base, we just also
depend on systemd-sysv as an alternative, since if that is installed,
the /etc/init.d/mandos script (which is the thing which actually
requires lsb-base) is never run anyway.  Suppress this warning.

* debian/mandos.lintian-overrides (mandos): Add new line
  "init.d-script-needs-depends-on-lsb-base etc/init.d/mandos (line
  49)"

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
30
*** ClientNotFound(s: Fingerprint, s: Address)
37
31
    A client connected from Address using Fingerprint, but was
38
32
    rejected because it was not found in the server.  The fingerprint
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
   
96
73
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
97
74
   | LastEnabled (j)         | s    | Read       | N/A                 |
98
75
   | Name                    | s    | Read       | (Section name)      |
99
 
   | ObjectPath              | o    | Read       | N/A                 |
100
76
   | Secret (k)              | ay   | Write      | secret (or secfile) |
101
77
   | Timeout (a)             | t    | Read/Write | timeout             |
102
78
   
104
80
   
105
81
   b) An approval is currently pending.
106
82
   
107
 
   c) Setting this property is equivalent to calling StartChecker() or
108
 
      StopChecker().
 
83
   c) Changing this property can either start a new checker or abort a
 
84
      running one.
109
85
   
110
86
   d) The creation time of this client object, as an RFC 3339 string.
111
87
   
112
 
   e) Setting this property is equivalent to calling Enable() or
113
 
      Disable().
 
88
   e) Changing this property enables or disables a client.
114
89
   
115
90
   f) The date and time this client will be disabled, as an RFC 3339
116
91
      string, or an empty string if this is not scheduled.
150
125
    milliseconds, depending on ApprovedByDefault.  Approve() can now
151
126
    usefully be called on this client object.
152
127
    
153
 
*** PropertyChanged(s: Property, v: Value)
154
 
    The Property on this client has changed to Value.
155
 
    
156
128
*** Rejected(s: Reason)
157
129
    This client was not given its secret for a specified Reason.
158
130
 
159
131
* Copyright
160
132
 
161
 
    Copyright © 2010-2012 Teddy Hogeborn
162
 
    Copyright © 2010-2012 Björn Påhlsson
 
133
    Copyright © 2010-2016 Teddy Hogeborn
 
134
    Copyright © 2010-2016 Björn Påhlsson
163
135
  
164
136
** License:
165
137