/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:
 
1
                   -*- mode: org; coding: utf-8 -*-
 
2
 
 
3
                    Mandos Server D-Bus Interface
 
4
 
 
5
This file documents the D-Bus interface to the Mandos server.
 
6
 
 
7
* Bus: System bus
 
8
  Bus name: "se.recompile.Mandos"
 
9
 
 
10
 
 
11
* Object Paths:
 
12
  
 
13
  | Path                  | Object            |
 
14
  |-----------------------+-------------------|
 
15
  | "/"                   | The Mandos Server |
 
16
  | "/clients/CLIENTNAME" | Mandos Client     |
 
17
 
 
18
  
 
19
* Mandos Server Interface:
 
20
  Interface name: "se.recompile.Mandos"
 
21
  
 
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
   
 
29
*** RemoveClient(o: ObjectPath) → nothing
 
30
    Removes a client
 
31
   
 
32
** 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
 
39
    is represented as a string of hexadecimal digits.  The address is
 
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.
 
44
 
 
45
 
 
46
* Mandos Client Interface:
 
47
  Interface name: "se.recompile.Mandos.Client"
 
48
  
 
49
** Methods
 
50
*** Approve(b: Approve) → nothing
 
51
    Approve or deny a connected client waiting for approval.  If
 
52
    denied, a client will not be sent its secret.
 
53
    
 
54
*** CheckedOK() → nothing
 
55
    Assert that this client has been checked and found to be alive.
 
56
    This will restart the timeout before disabling this client.  See
 
57
    also the "LastCheckedOK" property.
 
58
 
 
59
** Properties
 
60
   
 
61
   Note: Many of these properties directly correspond to a setting in
 
62
   "clients.conf", in which case they are fully documented in
 
63
   mandos-clients.conf(5).
 
64
   
 
65
   | Name                    | Type | Access     | clients.conf        |
 
66
   |-------------------------+------+------------+---------------------|
 
67
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
 
68
   | ApprovalDelay (a)       | t    | Read/Write | approval_delay      |
 
69
   | ApprovalDuration (a)    | t    | Read/Write | approval_duration   |
 
70
   | ApprovalPending (b)     | b    | Read       | N/A                 |
 
71
   | Checker                 | s    | Read/Write | checker             |
 
72
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
 
73
   | Created (d)             | s    | Read       | N/A                 |
 
74
   | Enabled (e)             | b    | Read/Write | N/A                 |
 
75
   | Expires (f)             | s    | Read       | N/A                 |
 
76
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
 
77
   | Fingerprint             | s    | Read       | fingerprint         |
 
78
   | Host                    | s    | Read/Write | host                |
 
79
   | Interval (a)            | t    | Read/Write | interval            |
 
80
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
 
81
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
 
82
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
 
83
   | LastEnabled (j)         | s    | Read       | N/A                 |
 
84
   | Name                    | s    | Read       | (Section name)      |
 
85
   | Secret (k)              | ay   | Write      | secret (or secfile) |
 
86
   | Timeout (a)             | t    | Read/Write | timeout             |
 
87
   
 
88
   a) Represented as milliseconds.
 
89
   
 
90
   b) An approval is currently pending.
 
91
   
 
92
   c) Changing this property can either start a new checker or abort a
 
93
      running one.
 
94
   
 
95
   d) The creation time of this client object, as an RFC 3339 string.
 
96
   
 
97
   e) Changing this property enables or disables a client.
 
98
   
 
99
   f) The date and time this client will be disabled, as an RFC 3339
 
100
      string, or an empty string if this is not scheduled.
 
101
   
 
102
   g) The date and time of the last approval request, as an RFC 3339
 
103
      string, or an empty string if this has not happened.
 
104
   
 
105
   h) The date and time a checker was last successful, as an RFC 3339
 
106
      string, or an empty string if this has not happened.  Setting
 
107
      this property is equivalent to calling CheckedOK(), i.e. the
 
108
      current time is set, regardless of the string sent.  Please
 
109
      always use an empty string when setting this property, to allow
 
110
      for possible future expansion.
 
111
   
 
112
   i) The exit status of the last checker, -1 if it did not exit
 
113
      cleanly, -2 if a checker has not yet returned.
 
114
   
 
115
   j) The date and time this client was last enabled, as an RFC 3339
 
116
      string, or an empty string if this has not happened.
 
117
   
 
118
   k) A raw byte array, not hexadecimal digits.
 
119
 
 
120
** Signals
 
121
*** CheckerCompleted(n: Exitcode, x: Signal, s: Command)
 
122
    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.
 
125
    
 
126
*** CheckerStarted(s: Command)
 
127
    A checker command (Command) has just been started.
 
128
    
 
129
*** GotSecret()
 
130
    This client has been sent its secret.
 
131
    
 
132
*** NeedApproval(t: Timeout, b: ApprovedByDefault)
 
133
    This client will be approved or denied in exactly Timeout
 
134
    milliseconds, depending on ApprovedByDefault.  Approve() can now
 
135
    usefully be called on this client object.
 
136
    
 
137
*** Rejected(s: Reason)
 
138
    This client was not given its secret for a specified Reason.
 
139
 
 
140
* Copyright
 
141
 
 
142
    Copyright © 2010-2015 Teddy Hogeborn
 
143
    Copyright © 2010-2015 Björn Påhlsson
 
144
  
 
145
** 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
 
153
   WITHOUT ANY WARRANTY; without even the implied warranty of
 
154
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
155
   General Public License for more details.
 
156
 
 
157
   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/>.
 
160
 
 
161
 
 
162
#+STARTUP: showall