/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 recompile
  • Date: 2012-01-01 17:38:33 UTC
  • Revision ID: teddy@recompile.se-20120101173833-ai39bif1w0ftuyyh
* Makefile (install-server): Add intro(8mandos) man page.
* network-hooks.d/bridge: Add copyright info and year.
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
13
13
  | Path                  | Object            |
14
14
  |-----------------------+-------------------|
15
15
  | "/"                   | The Mandos Server |
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
 
 
 
16
  | "/clients/CLIENTNAME" | Mandos Client     |
 
17
 
 
18
  
22
19
* Mandos Server Interface:
23
20
  Interface name: "se.recompile.Mandos"
24
21
  
25
22
** 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
   
26
29
*** RemoveClient(o: ObjectPath) → nothing
27
30
    Removes a client
28
31
   
29
32
** Signals:
 
33
*** ClientAdded(o: ObjectPath)
 
34
    A new client was added.
 
35
   
30
36
*** ClientNotFound(s: Fingerprint, s: Address)
31
37
    A client connected from Address using Fingerprint, but was
32
38
    rejected because it was not found in the server.  The fingerprint
33
39
    is represented as a string of hexadecimal digits.  The address is
34
40
    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.
35
44
 
36
45
 
37
46
* Mandos Client Interface:
46
55
    Assert that this client has been checked and found to be alive.
47
56
    This will restart the timeout before disabling this client.  See
48
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.
49
72
 
50
73
** Properties
51
74
   
70
93
   | Interval (a)            | t    | Read/Write | interval            |
71
94
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
72
95
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
73
 
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
74
 
   | LastEnabled (j)         | s    | Read       | N/A                 |
 
96
   | LastEnabled (i)         | s    | Read       | N/A                 |
75
97
   | Name                    | s    | Read       | (Section name)      |
76
 
   | Secret (k)              | ay   | Write      | secret (or secfile) |
 
98
   | ObjectPath              | o    | Read       | N/A                 |
 
99
   | Secret (j)              | ay   | Write      | secret (or secfile) |
77
100
   | Timeout (a)             | t    | Read/Write | timeout             |
78
101
   
79
102
   a) Represented as milliseconds.
80
103
   
81
104
   b) An approval is currently pending.
82
105
   
83
 
   c) Changing this property can either start a new checker or abort a
84
 
      running one.
 
106
   c) Setting this property is equivalent to calling StartChecker() or
 
107
      StopChecker().
85
108
   
86
109
   d) The creation time of this client object, as an RFC 3339 string.
87
110
   
88
 
   e) Changing this property enables or disables a client.
 
111
   e) Setting this property is equivalent to calling Enable() or
 
112
      Disable().
89
113
   
90
114
   f) The date and time this client will be disabled, as an RFC 3339
91
115
      string, or an empty string if this is not scheduled.
100
124
      always use an empty string when setting this property, to allow
101
125
      for possible future expansion.
102
126
   
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
 
127
   i) The date and time this client was last enabled, as an RFC 3339
107
128
      string, or an empty string if this has not happened.
108
129
   
109
 
   k) A raw byte array, not hexadecimal digits.
 
130
   j) A raw byte array, not hexadecimal digits.
110
131
 
111
132
** Signals
112
133
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
125
146
    milliseconds, depending on ApprovedByDefault.  Approve() can now
126
147
    usefully be called on this client object.
127
148
    
 
149
*** PropertyChanged(s: Property, v: Value)
 
150
    The Property on this client has changed to Value.
 
151
    
128
152
*** Rejected(s: Reason)
129
153
    This client was not given its secret for a specified Reason.
130
154
 
 
155
*** NewRequest(s: IPAddress)
 
156
    A client at IPAdress has requested its secret.
 
157
 
131
158
* Copyright
132
159
 
133
 
    Copyright © 2010-2016 Teddy Hogeborn
134
 
    Copyright © 2010-2016 Björn Påhlsson
 
160
    Copyright © 2010-2012 Teddy Hogeborn
 
161
    Copyright © 2010-2012 Björn Påhlsson
135
162
  
136
163
** License:
137
164