/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-23 20:20:34 UTC
  • mfrom: (899 trunk)
  • mto: This revision was merged to the branch mainline in revision 900.
  • Revision ID: teddy@recompile.se-20170223202034-0820bcq0k7d1j9kf
Merge from trunk

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:
82
73
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
83
74
   | LastEnabled (j)         | s    | Read       | N/A                 |
84
75
   | Name                    | s    | Read       | (Section name)      |
85
 
   | ObjectPath              | o    | Read       | N/A                 |
86
76
   | Secret (k)              | ay   | Write      | secret (or secfile) |
87
77
   | Timeout (a)             | t    | Read/Write | timeout             |
88
78
   
119
109
   k) A raw byte array, not hexadecimal digits.
120
110
 
121
111
** Signals
122
 
*** CheckerCompleted(n: Exitcode, x: Signal, s: Command)
 
112
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
123
113
    A checker (Command) has completed.  Exitcode is either the exit
124
 
    code or -1 for abnormal exit, in which case, the signal number
125
 
    is available.
 
114
    code or -1 for abnormal exit.  In any case, the full Waitstatus
 
115
    (as from wait(2)) is also available.
126
116
    
127
117
*** CheckerStarted(s: Command)
128
118
    A checker command (Command) has just been started.
140
130
 
141
131
* Copyright
142
132
 
143
 
    Copyright © 2010-2015 Teddy Hogeborn
144
 
    Copyright © 2010-2015 Björn Påhlsson
 
133
    Copyright © 2010-2017 Teddy Hogeborn
 
134
    Copyright © 2010-2017 Björn Påhlsson
145
135
  
146
136
** License:
147
137