/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-08-03 13:42:21 UTC
  • mfrom: (237.4.118 release)
  • Revision ID: teddy@recompile.se-20190803134221-him6j8utmzc06gw1
Merge from release branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
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:
75
66
   | Expires (f)             | s    | Read       | N/A                 |
76
67
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
77
68
   | Fingerprint             | s    | Read       | fingerprint         |
 
69
   | KeyID                   | s    | Read       | key_id              |
78
70
   | Host                    | s    | Read/Write | host                |
79
71
   | Interval (a)            | t    | Read/Write | interval            |
80
72
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
118
110
   k) A raw byte array, not hexadecimal digits.
119
111
 
120
112
** Signals
121
 
*** CheckerCompleted(n: Exitcode, x: Signal, s: Command)
 
113
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
122
114
    A checker (Command) has completed.  Exitcode is either the exit
123
 
    code or -1 for abnormal exit, in which case, the signal number
124
 
    is available.
 
115
    code or -1 for abnormal exit.  In any case, the full Waitstatus
 
116
    (as from wait(2)) is also available.
125
117
    
126
118
*** CheckerStarted(s: Command)
127
119
    A checker command (Command) has just been started.
139
131
 
140
132
* Copyright
141
133
 
142
 
    Copyright © 2010-2015 Teddy Hogeborn
143
 
    Copyright © 2010-2015 Björn Påhlsson
 
134
    Copyright © 2010-2019 Teddy Hogeborn
 
135
    Copyright © 2010-2019 Björn Påhlsson
144
136
  
145
137
** License:
146
 
   
147
 
   This program is free software: you can redistribute it and/or
148
 
   modify it under the terms of the GNU General Public License as
149
 
   published by the Free Software Foundation, either version 3 of the
150
 
   License, or (at your option) any later version.
151
 
 
152
 
   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
153
147
   WITHOUT ANY WARRANTY; without even the implied warranty of
154
148
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
155
149
   General Public License for more details.
156
150
 
157
151
   You should have received a copy of the GNU General Public License
158
 
   along with this program.  If not, see
159
 
   <http://www.gnu.org/licenses/>.
 
152
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
160
153
 
161
154
 
162
155
#+STARTUP: showall