/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: 2019-04-08 21:53:22 UTC
  • Revision ID: teddy@recompile.se-20190408215322-y3hmfxzdgs9t84l1
plugin-runner: Fix minor memory leak

* plugin-runner.c (free_plugin): Even if argv[0] is NULL, as for the
                                 pseudo-plugin for global options,
                                 free all other arguments by simply
                                 starting at argv[1] and freeing
                                 plugin_node->name (which is always
                                 argv[0]) separately.

Show diffs side-by-side

added added

removed removed

Lines of Context:
DBUS-API
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
 
*** ClientNotFound(s: Fingerprint, s: Address)
37
 
    A client connected from Address using Fingerprint, but was
38
 
    rejected because it was not found in the server.  The fingerprint
 
30
*** ClientNotFound(s: KeyID, s: Address)
 
31
    A client connected from Address using KeyID, but was
 
32
    rejected because it was not found in the server.  The key ID
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
   
76
53
   "clients.conf", in which case they are fully documented in
77
54
   mandos-clients.conf(5).
78
55
   
79
 
   | Name                 | Type | Access     | clients.conf        |
80
 
   |----------------------+------+------------+---------------------|
81
 
   | ApprovedByDefault    | b    | Read/Write | approved_by_default |
82
 
   | ApprovalDelay (a)    | t    | Read/Write | approval_delay      |
83
 
   | ApprovalDuration (a) | t    | Read/Write | approval_duration   |
84
 
   | ApprovalPending (b)  | b    | Read       | N/A                 |
85
 
   | Checker              | s    | Read/Write | checker             |
86
 
   | CheckerRunning (c)   | b    | Read/Write | N/A                 |
87
 
   | Created (d)          | s    | Read       | N/A                 |
88
 
   | Enabled (e)          | b    | Read/Write | N/A                 |
89
 
   | Fingerprint          | s    | Read       | fingerprint         |
90
 
   | Host                 | s    | Read/Write | host                |
91
 
   | Interval (a)         | t    | Read/Write | interval            |
92
 
   | LastCheckedOK (f)    | s    | Read/Write | N/A                 |
93
 
   | LastEnabled (g)      | s    | Read       | N/A                 |
94
 
   | Name                 | s    | Read       | (Section name)      |
95
 
   | ObjectPath           | o    | Read       | N/A                 |
96
 
   | Secret (h)           | ay   | Write      | secret (or secfile) |
97
 
   | Timeout (a)          | t    | Read/Write | timeout             |
 
56
   | Name                    | Type | Access     | clients.conf        |
 
57
   |-------------------------+------+------------+---------------------|
 
58
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
 
59
   | ApprovalDelay (a)       | t    | Read/Write | approval_delay      |
 
60
   | ApprovalDuration (a)    | t    | Read/Write | approval_duration   |
 
61
   | ApprovalPending (b)     | b    | Read       | N/A                 |
 
62
   | Checker                 | s    | Read/Write | checker             |
 
63
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
 
64
   | Created (d)             | s    | Read       | N/A                 |
 
65
   | Enabled (e)             | b    | Read/Write | N/A                 |
 
66
   | Expires (f)             | s    | Read       | N/A                 |
 
67
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
 
68
   | Fingerprint             | s    | Read       | fingerprint         |
 
69
   | KeyID                   | s    | Read       | key_id              |
 
70
   | Host                    | s    | Read/Write | host                |
 
71
   | Interval (a)            | t    | Read/Write | interval            |
 
72
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
 
73
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
 
74
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
 
75
   | LastEnabled (j)         | s    | Read       | N/A                 |
 
76
   | Name                    | s    | Read       | (Section name)      |
 
77
   | Secret (k)              | ay   | Write      | secret (or secfile) |
 
78
   | Timeout (a)             | t    | Read/Write | timeout             |
98
79
   
99
80
   a) Represented as milliseconds.
100
81
   
101
82
   b) An approval is currently pending.
102
83
   
103
 
   c) Setting this property is equivalent to calling StartChecker() or
104
 
      StopChecker().
105
 
   
106
 
   d) The creation time of this client object, as a RFC 3339 string.
107
 
   
108
 
   e) Setting this property is equivalent to calling Enable() or
109
 
      Disable().
110
 
   
111
 
   f) The last time a checker was successful, as a RFC 3339 string, or
112
 
      an empty string if this has not happened.  Setting this property
113
 
      is equivalent to calling CheckedOK(), i.e. the current time is
114
 
      set, regardless of the string sent.  Please always use an empty
115
 
      string when setting this property, to allow for possible future
116
 
      expansion.
117
 
   
118
 
   g) The last time this client was enabled, as a RFC 3339 string, or
119
 
      an empty string if this has not happened.
120
 
   
121
 
   h) A raw byte array, not hexadecimal digits.
 
84
   c) Changing this property can either start a new checker or abort a
 
85
      running one.
 
86
   
 
87
   d) The creation time of this client object, as an RFC 3339 string.
 
88
   
 
89
   e) Changing this property enables or disables a client.
 
90
   
 
91
   f) The date and time this client will be disabled, as an RFC 3339
 
92
      string, or an empty string if this is not scheduled.
 
93
   
 
94
   g) The date and time of the last approval request, as an RFC 3339
 
95
      string, or an empty string if this has not happened.
 
96
   
 
97
   h) The date and time a checker was last successful, as an RFC 3339
 
98
      string, or an empty string if this has not happened.  Setting
 
99
      this property is equivalent to calling CheckedOK(), i.e. the
 
100
      current time is set, regardless of the string sent.  Please
 
101
      always use an empty string when setting this property, to allow
 
102
      for possible future expansion.
 
103
   
 
104
   i) The exit status of the last checker, -1 if it did not exit
 
105
      cleanly, -2 if a checker has not yet returned.
 
106
   
 
107
   j) The date and time this client was last enabled, as an RFC 3339
 
108
      string, or an empty string if this has not happened.
 
109
   
 
110
   k) A raw byte array, not hexadecimal digits.
122
111
 
123
112
** Signals
124
113
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
136
125
    This client will be approved or denied in exactly Timeout
137
126
    milliseconds, depending on ApprovedByDefault.  Approve() can now
138
127
    usefully be called on this client object.
139
 
 
140
 
*** PropertyChanged(s: Property, v: Value)
141
 
    The Property on this client has changed to Value.
142
 
 
 
128
    
143
129
*** Rejected(s: Reason)
144
130
    This client was not given its secret for a specified Reason.
145
131
 
 
132
* Copyright
 
133
 
 
134
    Copyright © 2010-2019 Teddy Hogeborn
 
135
    Copyright © 2010-2019 Björn Påhlsson
 
136
  
 
137
** License:
 
138
 
 
139
   This file is part of Mandos.
 
140
 
 
141
   Mandos is free software: you can redistribute it and/or modify it
 
142
   under the terms of the GNU General Public License as published by
 
143
   the Free Software Foundation, either version 3 of the License, or
 
144
   (at your option) any later version.
 
145
 
 
146
   Mandos is distributed in the hope that it will be useful, but
 
147
   WITHOUT ANY WARRANTY; without even the implied warranty of
 
148
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
149
   General Public License for more details.
 
150
 
 
151
   You should have received a copy of the GNU General Public License
 
152
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
153
 
146
154
 
147
155
#+STARTUP: showall