/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-12-03 21:06:34 UTC
  • Revision ID: teddy@recompile.se-20151203210634-5dcyccalld40cygn
* debian/rules (override_dh_fixperms): Split into
                                       "override_dh_fixperms-arch" and
                                       "override_dh_fixperms-indep".
                                       Fixes Debian bug #806073.

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:
13
13
  | Path                  | Object            |
14
14
  |-----------------------+-------------------|
15
15
  | "/"                   | The Mandos Server |
16
 
  | "/clients/CLIENTNAME" | Mandos Client     |
17
 
 
18
 
  
 
16
 
 
17
  (To get a list of paths to client objects, use the standard D-Bus
 
18
  org.freedesktop.DBus.ObjectManager interface, which the server
 
19
  object supports.)
 
20
 
 
21
 
19
22
* Mandos Server Interface:
20
 
  Interface name: "se.bsnet.fukt.Mandos"
 
23
  Interface name: "se.recompile.Mandos"
21
24
  
22
25
** 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
26
*** RemoveClient(o: ObjectPath) → nothing
30
27
    Removes a client
31
28
   
32
29
** Signals:
33
 
*** ClientAdded(o: ObjectPath)
34
 
    A new client was added.
35
 
   
36
30
*** ClientNotFound(s: Fingerprint, s: Address)
37
31
    A client connected from Address using Fingerprint, but was
38
32
    rejected because it was not found in the server.  The fingerprint
39
33
    is represented as a string of hexadecimal digits.  The address is
40
34
    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
35
 
45
36
 
46
37
* Mandos Client Interface:
47
 
  Interface name: "se.bsnet.fukt.Mandos.Client"
 
38
  Interface name: "se.recompile.Mandos.Client"
48
39
  
49
40
** Methods
50
41
*** Approve(b: Approve) → nothing
55
46
    Assert that this client has been checked and found to be alive.
56
47
    This will restart the timeout before disabling this client.  See
57
48
    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
49
 
73
50
** Properties
74
51
   
86
63
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
87
64
   | Created (d)             | s    | Read       | N/A                 |
88
65
   | Enabled (e)             | b    | Read/Write | N/A                 |
 
66
   | Expires (f)             | s    | Read       | N/A                 |
 
67
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
89
68
   | Fingerprint             | s    | Read       | fingerprint         |
90
69
   | Host                    | s    | Read/Write | host                |
91
70
   | 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                 |
 
71
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
 
72
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
 
73
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
 
74
   | LastEnabled (j)         | s    | Read       | N/A                 |
95
75
   | Name                    | s    | Read       | (Section name)      |
96
 
   | ObjectPath              | o    | Read       | N/A                 |
97
 
   | Secret (i)              | ay   | Write      | secret (or secfile) |
 
76
   | Secret (k)              | ay   | Write      | secret (or secfile) |
98
77
   | Timeout (a)             | t    | Read/Write | timeout             |
99
78
   
100
79
   a) Represented as milliseconds.
101
80
   
102
81
   b) An approval is currently pending.
103
82
   
104
 
   c) Setting this property is equivalent to calling StartChecker() or
105
 
      StopChecker().
 
83
   c) Changing this property can either start a new checker or abort a
 
84
      running one.
106
85
   
107
86
   d) The creation time of this client object, as an RFC 3339 string.
108
87
   
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.
 
88
   e) Changing this property enables or disables a client.
 
89
   
 
90
   f) The date and time this client will be disabled, as an RFC 3339
 
91
      string, or an empty string if this is not scheduled.
 
92
   
 
93
   g) The date and time of the last approval request, as an RFC 3339
 
94
      string, or an empty string if this has not happened.
 
95
   
 
96
   h) The date and time a checker was last successful, as an RFC 3339
 
97
      string, or an empty string if this has not happened.  Setting
 
98
      this property is equivalent to calling CheckedOK(), i.e. the
 
99
      current time is set, regardless of the string sent.  Please
 
100
      always use an empty string when setting this property, to allow
 
101
      for possible future expansion.
 
102
   
 
103
   i) The exit status of the last checker, -1 if it did not exit
 
104
      cleanly, -2 if a checker has not yet returned.
 
105
   
 
106
   j) The date and time this client was last enabled, as an RFC 3339
 
107
      string, or an empty string if this has not happened.
 
108
   
 
109
   k) A raw byte array, not hexadecimal digits.
126
110
 
127
111
** Signals
128
112
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
141
125
    milliseconds, depending on ApprovedByDefault.  Approve() can now
142
126
    usefully be called on this client object.
143
127
    
144
 
*** PropertyChanged(s: Property, v: Value)
145
 
    The Property on this client has changed to Value.
146
 
    
147
128
*** Rejected(s: Reason)
148
129
    This client was not given its secret for a specified Reason.
149
130
 
150
131
* Copyright
151
132
 
152
 
    Copyright © 2010-2011 Teddy Hogeborn
153
 
    Copyright © 2010-2011 Björn Påhlsson
 
133
    Copyright © 2010-2015 Teddy Hogeborn
 
134
    Copyright © 2010-2015 Björn Påhlsson
154
135
  
155
136
** License:
156
137