/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 at recompile
  • Date: 2020-04-08 19:15:13 UTC
  • mfrom: (237.4.130 release)
  • Revision ID: teddy@recompile.se-20200408191513-n0ke303478rw1g0b
Merge from release branch

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
 
*** 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:
64
55
   
65
56
   | Name                    | Type | Access     | clients.conf        |
66
57
   |-------------------------+------+------------+---------------------|
67
 
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
68
58
   | ApprovalDelay (a)       | t    | Read/Write | approval_delay      |
69
59
   | ApprovalDuration (a)    | t    | Read/Write | approval_duration   |
70
60
   | ApprovalPending (b)     | b    | Read       | N/A                 |
 
61
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
71
62
   | Checker                 | s    | Read/Write | checker             |
72
63
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
73
64
   | Created (d)             | s    | Read       | N/A                 |
77
68
   | Fingerprint             | s    | Read       | fingerprint         |
78
69
   | Host                    | s    | Read/Write | host                |
79
70
   | Interval (a)            | t    | Read/Write | interval            |
 
71
   | KeyID                   | s    | Read       | key_id              |
80
72
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
81
73
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
82
74
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
83
75
   | LastEnabled (j)         | s    | Read       | N/A                 |
84
76
   | Name                    | s    | Read       | (Section name)      |
85
 
   | ObjectPath              | o    | Read       | N/A                 |
86
77
   | Secret (k)              | ay   | Write      | secret (or secfile) |
87
78
   | Timeout (a)             | t    | Read/Write | timeout             |
88
79
   
119
110
   k) A raw byte array, not hexadecimal digits.
120
111
 
121
112
** Signals
122
 
*** CheckerCompleted(n: Exitcode, x: Signal, s: Command)
 
113
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
123
114
    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.
 
115
    code or -1 for abnormal exit.  In any case, the full Waitstatus
 
116
    (as from wait(2)) is also available.
126
117
    
127
118
*** CheckerStarted(s: Command)
128
119
    A checker command (Command) has just been started.
140
131
 
141
132
* Copyright
142
133
 
143
 
    Copyright © 2010-2015 Teddy Hogeborn
144
 
    Copyright © 2010-2015 Björn Påhlsson
 
134
    Copyright © 2010-2019 Teddy Hogeborn
 
135
    Copyright © 2010-2019 Björn Påhlsson
145
136
  
146
137
** License:
147
 
   
148
 
   This program is free software: you can redistribute it and/or
149
 
   modify it under the terms of the GNU General Public License as
150
 
   published by the Free Software Foundation, either version 3 of the
151
 
   License, or (at your option) any later version.
152
 
 
153
 
   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
154
147
   WITHOUT ANY WARRANTY; without even the implied warranty of
155
148
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
156
149
   General Public License for more details.
157
150
 
158
151
   You should have received a copy of the GNU General Public License
159
 
   along with this program.  If not, see
160
 
   <http://www.gnu.org/licenses/>.
 
152
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
161
153
 
162
154
 
163
155
#+STARTUP: showall