/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to DBUS-API

  • Committer: Teddy Hogeborn
  • Date: 2017-08-20 16:20:54 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 360.
  • Revision ID: teddy@recompile.se-20170820162054-jwig602syxx2k4l0
Alter copyright notices slightly.  Actual license is unchanged!

This alters all copyright notices to use the Free Software
Foundation's recommendations for license notices; from
<https://www.gnu.org/licenses/gpl-howto.html>:

  For programs that are more than one file, it is better to replace
  “this program” with the name of the program, and begin the statement
  with a line saying “This file is part of NAME”.

* DBUS-API: Use program name "Mandos" explicitly in license notice.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* legalnotice.xml: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* mandos-keygen: - '' -
* mandos-monitor: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
DBUS-API
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
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:
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
   
93
70
   | Interval (a)            | t    | Read/Write | interval            |
94
71
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
95
72
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
96
 
   | LastEnabled (i)         | s    | Read       | N/A                 |
 
73
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
 
74
   | LastEnabled (j)         | s    | Read       | N/A                 |
97
75
   | Name                    | s    | Read       | (Section name)      |
98
 
   | ObjectPath              | o    | Read       | N/A                 |
99
 
   | Secret (j)              | ay   | Write      | secret (or secfile) |
 
76
   | Secret (k)              | ay   | Write      | secret (or secfile) |
100
77
   | Timeout (a)             | t    | Read/Write | timeout             |
101
78
   
102
79
   a) Represented as milliseconds.
103
80
   
104
81
   b) An approval is currently pending.
105
82
   
106
 
   c) Setting this property is equivalent to calling StartChecker() or
107
 
      StopChecker().
 
83
   c) Changing this property can either start a new checker or abort a
 
84
      running one.
108
85
   
109
86
   d) The creation time of this client object, as an RFC 3339 string.
110
87
   
111
 
   e) Setting this property is equivalent to calling Enable() or
112
 
      Disable().
 
88
   e) Changing this property enables or disables a client.
113
89
   
114
90
   f) The date and time this client will be disabled, as an RFC 3339
115
 
      string, or an empty string if this has not happened.
 
91
      string, or an empty string if this is not scheduled.
116
92
   
117
93
   g) The date and time of the last approval request, as an RFC 3339
118
94
      string, or an empty string if this has not happened.
124
100
      always use an empty string when setting this property, to allow
125
101
      for possible future expansion.
126
102
   
127
 
   i) The date and time this client was last enabled, as an RFC 3339
 
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
128
107
      string, or an empty string if this has not happened.
129
108
   
130
 
   j) A raw byte array, not hexadecimal digits.
 
109
   k) A raw byte array, not hexadecimal digits.
131
110
 
132
111
** Signals
133
112
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
146
125
    milliseconds, depending on ApprovedByDefault.  Approve() can now
147
126
    usefully be called on this client object.
148
127
    
149
 
*** PropertyChanged(s: Property, v: Value)
150
 
    The Property on this client has changed to Value.
151
 
    
152
128
*** Rejected(s: Reason)
153
129
    This client was not given its secret for a specified Reason.
154
130
 
155
131
* Copyright
156
132
 
157
 
    Copyright © 2010-2011 Teddy Hogeborn
158
 
    Copyright © 2010-2011 Björn Påhlsson
 
133
    Copyright © 2010-2017 Teddy Hogeborn
 
134
    Copyright © 2010-2017 Björn Påhlsson
159
135
  
160
136
** License:
161
 
   
162
 
   This program is free software: you can redistribute it and/or
163
 
   modify it under the terms of the GNU General Public License as
164
 
   published by the Free Software Foundation, either version 3 of the
165
 
   License, or (at your option) any later version.
166
 
 
167
 
   This program is distributed in the hope that it will be useful, but
 
137
 
 
138
   This file is part of Mandos.
 
139
 
 
140
   Mandos is free software: you can redistribute it and/or modify it
 
141
   under the terms of the GNU General Public License as published by
 
142
   the Free Software Foundation, either version 3 of the License, or
 
143
   (at your option) any later version.
 
144
 
 
145
   Mandos is distributed in the hope that it will be useful, but
168
146
   WITHOUT ANY WARRANTY; without even the implied warranty of
169
147
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
170
148
   General Public License for more details.
171
149
 
172
150
   You should have received a copy of the GNU General Public License
173
 
   along with this program.  If not, see
174
 
   <http://www.gnu.org/licenses/>.
 
151
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
175
152
 
176
153
 
177
154
#+STARTUP: showall