/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:
5
5
This file documents the D-Bus interface to the Mandos server.
6
6
 
7
7
* Bus: System bus
8
 
  Bus name: "se.bsnet.fukt.Mandos"
 
8
  Bus name: "se.recompile.Mandos"
9
9
 
10
10
 
11
11
* Object Paths:
17
17
 
18
18
  
19
19
* Mandos Server Interface:
20
 
  Interface name: "se.bsnet.fukt.Mandos"
 
20
  Interface name: "se.recompile.Mandos"
21
21
  
22
22
** Methods:
23
23
*** GetAllClients() → (ao: Clients)
44
44
 
45
45
 
46
46
* Mandos Client Interface:
47
 
  Interface name: "se.bsnet.fukt.Mandos.Client"
 
47
  Interface name: "se.recompile.Mandos.Client"
48
48
  
49
49
** Methods
50
50
*** Approve(b: Approve) → nothing
55
55
    Assert that this client has been checked and found to be alive.
56
56
    This will restart the timeout before disabling this client.  See
57
57
    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
58
 
73
59
** Properties
74
60
   
76
62
   "clients.conf", in which case they are fully documented in
77
63
   mandos-clients.conf(5).
78
64
   
79
 
   | Name                 | Type | Access     | clients.conf        |
80
 
   |----------------------+------+------------+---------------------|
81
 
   | ApprovedByDefault    | b    | Read/Write | approved_by_default |
82
 
   | ApprovalDelay (a)    | t    | Read/Write | approval_delay      |
83
 
   | ApprovalDuration (a) | t    | Read/Write | approval_duration   |
84
 
   | ApprovalPending (b)  | b    | Read       | N/A                 |
85
 
   | Checker              | s    | Read/Write | checker             |
86
 
   | CheckerRunning (c)   | b    | Read/Write | N/A                 |
87
 
   | Created (d)          | s    | Read       | N/A                 |
88
 
   | Enabled (e)          | b    | Read/Write | N/A                 |
89
 
   | Fingerprint          | s    | Read       | fingerprint         |
90
 
   | Host                 | s    | Read/Write | host                |
91
 
   | Interval (a)         | t    | Read/Write | interval            |
92
 
   | LastCheckedOK (f)    | s    | Read/Write | N/A                 |
93
 
   | LastEnabled (g)      | s    | Read       | N/A                 |
94
 
   | Name                 | s    | Read       | (Section name)      |
95
 
   | ObjectPath           | o    | Read       | N/A                 |
96
 
   | Secret (h)           | ay   | Write      | secret (or secfile) |
97
 
   | Timeout (a)          | t    | Read/Write | timeout             |
 
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             |
98
87
   
99
88
   a) Represented as milliseconds.
100
89
   
101
90
   b) An approval is currently pending.
102
91
   
103
 
   c) Setting this property is equivalent to calling StartChecker() or
104
 
      StopChecker().
105
 
   
106
 
   d) The creation time of this client object, as a RFC 3339 string.
107
 
   
108
 
   e) Setting this property is equivalent to calling Enable() or
109
 
      Disable().
110
 
   
111
 
   f) The last time a checker was successful, as a RFC 3339 string, or
112
 
      an empty string if this has not happened.  Setting this property
113
 
      is equivalent to calling CheckedOK(), i.e. the current time is
114
 
      set, regardless of the string sent.  Please always use an empty
115
 
      string when setting this property, to allow for possible future
116
 
      expansion.
117
 
   
118
 
   g) The last time this client was enabled, as a RFC 3339 string, or
119
 
      an empty string if this has not happened.
120
 
   
121
 
   h) A raw byte array, not hexadecimal digits.
 
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.
122
119
 
123
120
** Signals
124
 
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
 
121
*** CheckerCompleted(n: Exitcode, x: Signal, s: Command)
125
122
    A checker (Command) has completed.  Exitcode is either the exit
126
 
    code or -1 for abnormal exit.  In any case, the full Waitstatus
127
 
    (as from wait(2)) is also available.
 
123
    code or -1 for abnormal exit, in which case, the signal number
 
124
    is available.
128
125
    
129
126
*** CheckerStarted(s: Command)
130
127
    A checker command (Command) has just been started.
136
133
    This client will be approved or denied in exactly Timeout
137
134
    milliseconds, depending on ApprovedByDefault.  Approve() can now
138
135
    usefully be called on this client object.
139
 
 
140
 
*** PropertyChanged(s: Property, v: Value)
141
 
    The Property on this client has changed to Value.
142
 
 
 
136
    
143
137
*** Rejected(s: Reason)
144
138
    This client was not given its secret for a specified Reason.
145
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
 
146
161
 
147
162
#+STARTUP: showall