/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: 2018-02-12 15:03:06 UTC
  • mto: This revision was merged to the branch mainline in revision 933.
  • Revision ID: teddy@recompile.se-20180212150306-x1bpg7rqb3xk4hog
Tags: version-1.7.18-1
* Makefile (version): Change to 1.7.18.
* NEWS (Version 1.7.18): Add new entry.
* debian/changelog (1.7.18-1): - '' -

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
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-2018 Teddy Hogeborn
 
134
    Copyright © 2010-2018 Björn Påhlsson
163
135
  
164
136
** License:
165
 
   
166
 
   This program is free software: you can redistribute it and/or
167
 
   modify it under the terms of the GNU General Public License as
168
 
   published by the Free Software Foundation, either version 3 of the
169
 
   License, or (at your option) any later version.
170
 
 
171
 
   This program is distributed in the hope that it will be useful, but
 
137
 
 
138
   This file is part of Mandos.
 
139
 
 
140
   Mandos is free software: you can redistribute it and/or modify it
 
141
   under the terms of the GNU General Public License as published by
 
142
   the Free Software Foundation, either version 3 of the License, or
 
143
   (at your option) any later version.
 
144
 
 
145
   Mandos is distributed in the hope that it will be useful, but
172
146
   WITHOUT ANY WARRANTY; without even the implied warranty of
173
147
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
174
148
   General Public License for more details.
175
149
 
176
150
   You should have received a copy of the GNU General Public License
177
 
   along with this program.  If not, see
178
 
   <http://www.gnu.org/licenses/>.
 
151
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
179
152
 
180
153
 
181
154
#+STARTUP: showall