/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 clients.conf

  • Committer: Teddy Hogeborn
  • Date: 2024-09-08 00:08:15 UTC
  • Revision ID: teddy@recompile.se-20240908000815-x3gr5xion3kyyoio
Improve documentation

* mandos.conf.xml (DESCRIPTION): Remove the unnecessary word "simple".
* plugin-runner.xml (PLUGINS): Remove the unnecessary word "simply",
  and add the "executable" qualifier to the description of plugins.
* mandos-client.xml (DESCRIPTION, OPTIONS): Do not refer to
  "plugin-runner"; instead refer to the section "OVERVIEW".
  (OVERVIEW): Don't only describe plugin-runner; also describe
  how password-agent can start mandos-client.
  (EXAMPLE): Do not refer to "plugin-runner"; instead refer to the
  section "OVERVIEW".
  (SEE ALSO): Replace reference to "password-prompt" with
  "password-agent".

Show diffs side-by-side

added added

removed removed

Lines of Context:
clients.conf
2
2
# values, so uncomment and change them if you want different ones.
3
3
[DEFAULT]
4
4
 
5
 
# How long until a client is considered invalid - that is, ineligible
6
 
# to get the data this server holds.
7
 
;timeout = 1h
 
5
# How long until a client is disabled and not be allowed to get the
 
6
# data this server holds.
 
7
# (RFC 3339 duration syntax)
 
8
;timeout = PT5M
8
9
 
9
10
# How often to run the checker to confirm that a client is still up.
10
11
# Note: a new checker will not be started if an old one is still
11
12
# running.  The server will wait for a checker to complete until the
12
 
# "timeout" above occurs, at which time the client will be marked
13
 
# invalid, and any running checker killed.
14
 
;interval = 5m
 
13
# above "timeout" occurs, at which time the client will be disabled,
 
14
# and any running checker killed.
 
15
# (RFC 3339 duration syntax)
 
16
;interval = PT2M
 
17
 
 
18
# Extended timeout is an added timeout that is given once after a
 
19
# password has been sent sucessfully to a client.  This allows for
 
20
# additional delays caused by file system checks and quota checks.
 
21
# (RFC 3339 duration syntax)
 
22
;extended_timeout = PT15M
15
23
 
16
24
# What command to run as "the checker".
17
25
;checker = fping -q -- %%(host)s
18
26
 
 
27
# Whether to approve a client by default after the approval delay.
 
28
;approved_by_default = True
 
29
 
 
30
# How long to wait for approval.
 
31
# (RFC 3339 duration syntax)
 
32
;approval_delay = PT0S
 
33
 
 
34
# How long one approval will last.
 
35
# (RFC 3339 duration syntax)
 
36
;approval_duration = PT1S
 
37
 
 
38
# Whether this client is enabled by default
 
39
;enabled = True
 
40
 
19
41
 
20
42
;####
21
43
;# Example client
22
44
;[foo]
23
45
;
 
46
;# TLS public key ID
 
47
;key_id = f33fcbed11ed5e03073f6a55b86ffe92af0e24c045fb6e3b40547b3dc0c030ed
 
48
;
24
49
;# OpenPGP key fingerprint
25
50
;fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
26
51
;
27
52
;# This is base64-encoded binary data.  It will be decoded and sent to
28
 
;# the client matching the above fingerprint.  This should, of course,
29
 
;# be OpenPGP encrypted data, decryptable only by the client.
 
53
;# the client matching the above key_id (for GnuTLS 3.6.6 or later) or
 
54
;# the above fingerprint (for GnuTLS before 3.6.0).  This should, of
 
55
;# course, be OpenPGP encrypted data, decryptable only by the client.
30
56
;secret =
31
57
;        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
32
58
;        REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
43
69
;        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
44
70
;        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
45
71
;        QlnHIvPzEArRQLo=
46
 
;        =iHhv
47
72
;
48
73
;# Host name; used only by the checker, not used by the server itself.
49
74
;host = foo.example.org
52
77
;####
53
78
;# Another example client, named "bar".
54
79
;[bar]
 
80
;# The key ID is not space or case sensitive
 
81
;key_id = F33FCBED11ED5E03073F6A55B86FFE92 AF0E24C045FB6E3B40547B3DC0C030ED
 
82
;
55
83
;# The fingerprint is not space or case sensitive
56
84
;fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
57
85
;
58
86
;# If "secret" is not specified, a file can be read for the data.
59
 
;;secfile = /etc/mandos/bar-secret.txt.asc
 
87
;secfile = /etc/keys/mandos/bar-secret.bin
60
88
;
61
89
;# An IP address for host is also fine, if the checker accepts it.
62
90
;host = 192.0.2.3
63
91
;
64
92
;# Parameters from the [DEFAULT] section can be overridden per client.
65
 
;interval = 5m
 
93
;interval = PT1M
 
94
;
 
95
;# This client requires manual approval before it receives its secret.
 
96
;approved_by_default = False
 
97
;# Require approval within 30 seconds.
 
98
;approval_delay = PT30S
66
99
;####