/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: 2015-07-09 08:20:24 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150709082024-eitu9mav45lefl75
mandos-client: Add --dh-params FILE option.

* plugins.d/mandos-client.c: Added --dh-params FILE option.
  (init_gnutls_global): New "dhparamsfilename" argument.  All callers
                        changed.  Read and use Diffie-Hellman
                        parameters from it.  Bug fix:  check for error
                        when opening seckeyfile for the second time.
  (init_gnutls_session): Remove unnecessary call to
                         gnutls_dh_set_prime_bits();
  (main): New variable "dh_params_file".
  (main/argp_options): Added "--dh-params" option.
  (main/parse_opt): - '' -
* plugins.d/mandos-client.xml (SYNOPSIS): Add --dh-params option.
  (OPTIONS): Document --dh-params option and document that the
             --dh-bits options is potentially overridden by the
             --dh-params option.

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:
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
 
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
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
   
55
78
   
56
79
   | Name                    | Type | Access     | clients.conf        |
57
80
   |-------------------------+------+------------+---------------------|
 
81
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
58
82
   | ApprovalDelay (a)       | t    | Read/Write | approval_delay      |
59
83
   | ApprovalDuration (a)    | t    | Read/Write | approval_duration   |
60
84
   | ApprovalPending (b)     | b    | Read       | N/A                 |
61
 
   | ApprovedByDefault       | b    | Read/Write | approved_by_default |
62
85
   | Checker                 | s    | Read/Write | checker             |
63
86
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
64
87
   | Created (d)             | s    | Read       | N/A                 |
68
91
   | Fingerprint             | s    | Read       | fingerprint         |
69
92
   | Host                    | s    | Read/Write | host                |
70
93
   | Interval (a)            | t    | Read/Write | interval            |
71
 
   | KeyID                   | s    | Read       | key_id              |
72
94
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
73
95
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
74
96
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
75
97
   | LastEnabled (j)         | s    | Read       | N/A                 |
76
98
   | Name                    | s    | Read       | (Section name)      |
 
99
   | ObjectPath              | o    | Read       | N/A                 |
77
100
   | Secret (k)              | ay   | Write      | secret (or secfile) |
78
101
   | Timeout (a)             | t    | Read/Write | timeout             |
79
102
   
81
104
   
82
105
   b) An approval is currently pending.
83
106
   
84
 
   c) Changing this property can either start a new checker or abort a
85
 
      running one.
 
107
   c) Setting this property is equivalent to calling StartChecker() or
 
108
      StopChecker().
86
109
   
87
110
   d) The creation time of this client object, as an RFC 3339 string.
88
111
   
89
 
   e) Changing this property enables or disables a client.
 
112
   e) Setting this property is equivalent to calling Enable() or
 
113
      Disable().
90
114
   
91
115
   f) The date and time this client will be disabled, as an RFC 3339
92
116
      string, or an empty string if this is not scheduled.
110
134
   k) A raw byte array, not hexadecimal digits.
111
135
 
112
136
** Signals
113
 
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
 
137
*** CheckerCompleted(n: Exitcode, x: Signal, s: Command)
114
138
    A checker (Command) has completed.  Exitcode is either the exit
115
 
    code or -1 for abnormal exit.  In any case, the full Waitstatus
116
 
    (as from wait(2)) is also available.
 
139
    code or -1 for abnormal exit, in which case, the signal number
 
140
    is available.
117
141
    
118
142
*** CheckerStarted(s: Command)
119
143
    A checker command (Command) has just been started.
131
155
 
132
156
* Copyright
133
157
 
134
 
    Copyright © 2010-2019 Teddy Hogeborn
135
 
    Copyright © 2010-2019 Björn Påhlsson
 
158
    Copyright © 2010-2015 Teddy Hogeborn
 
159
    Copyright © 2010-2015 Björn Påhlsson
136
160
  
137
161
** 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
 
162
   
 
163
   This program is free software: you can redistribute it and/or
 
164
   modify it under the terms of the GNU General Public License as
 
165
   published by the Free Software Foundation, either version 3 of the
 
166
   License, or (at your option) any later version.
 
167
 
 
168
   This program is distributed in the hope that it will be useful, but
147
169
   WITHOUT ANY WARRANTY; without even the implied warranty of
148
170
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
149
171
   General Public License for more details.
150
172
 
151
173
   You should have received a copy of the GNU General Public License
152
 
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
174
   along with this program.  If not, see
 
175
   <http://www.gnu.org/licenses/>.
153
176
 
154
177
 
155
178
#+STARTUP: showall