/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 at bsnet
  • Date: 2010-09-27 17:53:53 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100927175353-skms2ds4cjswpf4t
* debian/mandos-client.README.Debian: Remove warning about --connect
                                      not looping, since it now does.

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
 
   | Secret (k)              | ay   | Write      | secret (or secfile) |
 
96
   | ObjectPath              | o    | Read       | N/A                 |
 
97
   | Secret (i)              | ay   | Write      | secret (or secfile) |
86
98
   | Timeout (a)             | t    | Read/Write | timeout             |
87
99
   
88
100
   a) Represented as milliseconds.
89
101
   
90
102
   b) An approval is currently pending.
91
103
   
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.
 
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.
119
126
 
120
127
** Signals
121
128
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
133
140
    This client will be approved or denied in exactly Timeout
134
141
    milliseconds, depending on ApprovedByDefault.  Approve() can now
135
142
    usefully be called on this client object.
136
 
    
 
143
 
 
144
*** PropertyChanged(s: Property, v: Value)
 
145
    The Property on this client has changed to Value.
 
146
 
137
147
*** Rejected(s: Reason)
138
148
    This client was not given its secret for a specified Reason.
139
149
 
140
150
* Copyright
141
151
 
142
 
    Copyright © 2010-2015 Teddy Hogeborn
143
 
    Copyright © 2010-2015 Björn Påhlsson
 
152
    Copyright © 2010 Teddy Hogeborn
 
153
    Copyright © 2010 Björn Påhlsson
144
154
  
145
155
** License:
146
156