/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:45:29 UTC
  • Revision ID: teddy@recompile.se-20150802164529-pemtk1agiqluoiua
Deprecate some D-Bus methods in favor of D-Bus properties.

The following D-Bus methods on the interface
"se.recompile.Mandos.Client" are redundant, and are therefore
deprecated:  "Disable", "Enable", "StartChecker", and "StopChecker".
Instead, the D-Bus properties "Enabled" and "CheckerRunning" should be
set, as was always also possible.

* DBUS-API (se.recompile.Mandos.Client.Disable): Remove; deprecated.
  (se.recompile.Mandos.Client.Enable): - '' -
  (se.recompile.Mandos.Client.StartChecker): - '' -
  (se.recompile.Mandos.Client.StopChecker): - '' -
* mandos (ClientDBus.Enable): Annotate as deprecated.
  (ClientDBus.StartChecker): - '' -
  (ClientDBus.Disable): - '' -
  (ClientDBus.StopChecker): - '' -
* mandos-monitor (MandosClientWidget.keypress): Set properties instead
                                                of calling deprecated
                                                methods.

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
   
86
72
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
87
73
   | Created (d)             | s    | Read       | N/A                 |
88
74
   | Enabled (e)             | b    | Read/Write | N/A                 |
 
75
   | Expires (f)             | s    | Read       | N/A                 |
 
76
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
89
77
   | Fingerprint             | s    | Read       | fingerprint         |
90
78
   | Host                    | s    | Read/Write | host                |
91
79
   | Interval (a)            | t    | Read/Write | interval            |
92
 
   | LastApprovalRequest (f) | s    | Read       | N/A                 |
93
 
   | LastCheckedOK (g)       | s    | Read/Write | N/A                 |
94
 
   | LastEnabled (h)         | s    | Read       | N/A                 |
 
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                 |
95
84
   | Name                    | s    | Read       | (Section name)      |
96
85
   | ObjectPath              | o    | Read       | N/A                 |
97
 
   | Secret (i)              | ay   | Write      | secret (or secfile) |
 
86
   | Secret (k)              | ay   | Write      | secret (or secfile) |
98
87
   | Timeout (a)             | t    | Read/Write | timeout             |
99
88
   
100
89
   a) Represented as milliseconds.
101
90
   
102
91
   b) An approval is currently pending.
103
92
   
104
 
   c) Setting this property is equivalent to calling StartChecker() or
105
 
      StopChecker().
106
 
   
107
 
   d) The creation time of this client object, as a RFC 3339 string.
108
 
   
109
 
   e) Setting this property is equivalent to calling Enable() or
110
 
      Disable().
111
 
   
112
 
   f) The time of the last approval request, as a RFC 3339 string, or
113
 
      an empty string if this has not happened.
114
 
   
115
 
   g) The last time a checker was successful, as a RFC 3339 string, or
116
 
      an empty string if this has not happened.  Setting this property
117
 
      is equivalent to calling CheckedOK(), i.e. the current time is
118
 
      set, regardless of the string sent.  Please always use an empty
119
 
      string when setting this property, to allow for possible future
120
 
      expansion.
121
 
   
122
 
   h) The last time this client was enabled, as a RFC 3339 string, or
123
 
      an empty string if this has not happened.
124
 
   
125
 
   i) A raw byte array, not hexadecimal digits.
 
93
   c) Changing this property can either start a new checker or abort a
 
94
      running one.
 
95
   
 
96
   d) The creation time of this client object, as an RFC 3339 string.
 
97
   
 
98
   e) Changing this property enables or disables a client.
 
99
   
 
100
   f) The date and time this client will be disabled, as an RFC 3339
 
101
      string, or an empty string if this is not scheduled.
 
102
   
 
103
   g) The date and time of the last approval request, as an RFC 3339
 
104
      string, or an empty string if this has not happened.
 
105
   
 
106
   h) The date and time a checker was last successful, as an RFC 3339
 
107
      string, or an empty string if this has not happened.  Setting
 
108
      this property is equivalent to calling CheckedOK(), i.e. the
 
109
      current time is set, regardless of the string sent.  Please
 
110
      always use an empty string when setting this property, to allow
 
111
      for possible future expansion.
 
112
   
 
113
   i) The exit status of the last checker, -1 if it did not exit
 
114
      cleanly, -2 if a checker has not yet returned.
 
115
   
 
116
   j) The date and time this client was last enabled, as an RFC 3339
 
117
      string, or an empty string if this has not happened.
 
118
   
 
119
   k) A raw byte array, not hexadecimal digits.
126
120
 
127
121
** Signals
128
 
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
 
122
*** CheckerCompleted(n: Exitcode, x: Signal, s: Command)
129
123
    A checker (Command) has completed.  Exitcode is either the exit
130
 
    code or -1 for abnormal exit.  In any case, the full Waitstatus
131
 
    (as from wait(2)) is also available.
 
124
    code or -1 for abnormal exit, in which case, the signal number
 
125
    is available.
132
126
    
133
127
*** CheckerStarted(s: Command)
134
128
    A checker command (Command) has just been started.
140
134
    This client will be approved or denied in exactly Timeout
141
135
    milliseconds, depending on ApprovedByDefault.  Approve() can now
142
136
    usefully be called on this client object.
143
 
 
144
 
*** PropertyChanged(s: Property, v: Value)
145
 
    The Property on this client has changed to Value.
146
 
 
 
137
    
147
138
*** Rejected(s: Reason)
148
139
    This client was not given its secret for a specified Reason.
149
140
 
150
141
* Copyright
151
142
 
152
 
    Copyright © 2010 Teddy Hogeborn
153
 
    Copyright © 2010 Björn Påhlsson
 
143
    Copyright © 2010-2015 Teddy Hogeborn
 
144
    Copyright © 2010-2015 Björn Påhlsson
154
145
  
155
146
** License:
156
147