/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: 2011-03-17 18:14:34 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110317181434-si1m0l8q5fakzgjx
* DBUS-API: Fix grammar.

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