/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: 2015-08-02 16:57:09 UTC
  • Revision ID: teddy@recompile.se-20150802165709-k0vuxe3vjph3n5ss
Deprecate the D-Bus property "se.recompile.Mandos.Client.ObjectPath".

The D-Bus property "se.recompile.Mandos.Client.ObjectPath" is
unnecessary - is not used by mandos-monitor or mandos-ctl, and I
cannot see it being useful for anyone.

* DBUS-API (se.recompile.Mandos.Client.ObjectPath): Remove;
                                                    deprecated.
* mandos (ClientDBus.ObjectPath_dbus_property): Annotate as
                                                deprecated.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
20
  Interface name: "se.recompile.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:
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
 
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
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:
55
64
   
56
65
   | Name                    | Type | Access     | clients.conf        |
57
66
   |-------------------------+------+------------+---------------------|
 
67
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
58
68
   | ApprovalDelay (a)       | t    | Read/Write | approval_delay      |
59
69
   | ApprovalDuration (a)    | t    | Read/Write | approval_duration   |
60
70
   | ApprovalPending (b)     | b    | Read       | N/A                 |
61
 
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
62
71
   | Checker                 | s    | Read/Write | checker             |
63
72
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
64
73
   | Created (d)             | s    | Read       | N/A                 |
68
77
   | Fingerprint             | s    | Read       | fingerprint         |
69
78
   | Host                    | s    | Read/Write | host                |
70
79
   | Interval (a)            | t    | Read/Write | interval            |
71
 
   | KeyID                   | s    | Read       | key_id              |
72
80
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
73
81
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
74
82
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
110
118
   k) A raw byte array, not hexadecimal digits.
111
119
 
112
120
** Signals
113
 
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
 
121
*** CheckerCompleted(n: Exitcode, x: Signal, s: Command)
114
122
    A checker (Command) has completed.  Exitcode is either the exit
115
 
    code or -1 for abnormal exit.  In any case, the full Waitstatus
116
 
    (as from wait(2)) is also available.
 
123
    code or -1 for abnormal exit, in which case, the signal number
 
124
    is available.
117
125
    
118
126
*** CheckerStarted(s: Command)
119
127
    A checker command (Command) has just been started.
131
139
 
132
140
* Copyright
133
141
 
134
 
    Copyright © 2010-2020 Teddy Hogeborn
135
 
    Copyright © 2010-2020 Björn Påhlsson
 
142
    Copyright © 2010-2015 Teddy Hogeborn
 
143
    Copyright © 2010-2015 Björn Påhlsson
136
144
  
137
145
** License:
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
 
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
147
153
   WITHOUT ANY WARRANTY; without even the implied warranty of
148
154
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
149
155
   General Public License for more details.
150
156
 
151
157
   You should have received a copy of the GNU General Public License
152
 
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
158
   along with this program.  If not, see
 
159
   <http://www.gnu.org/licenses/>.
153
160
 
154
161
 
155
162
#+STARTUP: showall