| 1 |
.\" Automatically generated by Pandoc 3.1.11.1 |
| 2 |
.\" |
| 3 |
.TH "UPDATE\-OPENSSH\-KNOWN\-HOSTS" "8" "2014\-02\-03" "" "" |
| 4 |
.SH NAME |
| 5 |
update\-openssh\-knwon\-hosts \- download, filter and merge known_hosts |
| 6 |
for OpenSSH |
| 7 |
.SH SYNOPSIS |
| 8 |
\f[I]update\-openssh\-known\-hosts\f[R] [\f[I]\-f\f[R]] |
| 9 |
.SH DESCRIPTION |
| 10 |
update\-openssh\-known\-hosts manages downloading, filtering and |
| 11 |
mergeing of ssh_known_hosts files from anywhere into one local file for |
| 12 |
use by ssh(1). |
| 13 |
.SH OPTIONS |
| 14 |
.TP |
| 15 |
\-f |
| 16 |
treat every non\-zero exit from download plugin as an error, see |
| 17 |
EXIT_IGNORE below. |
| 18 |
.SH RETURN VALUES |
| 19 |
Returns zero on success and anything else on error. |
| 20 |
.SH ENVIRONMENT |
| 21 |
.TP |
| 22 |
CONFDIR |
| 23 |
Configuration directory, defaults to /etc/openssh\-known\-hosts. |
| 24 |
Currently there is only a sources subdirectory in it. |
| 25 |
.TP |
| 26 |
PLUGIN_PATH |
| 27 |
Plugin search path, defaults to |
| 28 |
/usr/local/share/openssh\-known\-hosts/plugins:/usr/share/openssh\-known\-hosts/plugins. |
| 29 |
.TP |
| 30 |
CACHEDIR |
| 31 |
Cache directory, defaults to /var/cache/openssh\-known\-hosts. |
| 32 |
.TP |
| 33 |
LOCK |
| 34 |
Lockfile path, defaults to /var/lock/openssh\-known\-hosts. |
| 35 |
.TP |
| 36 |
OUTFILE |
| 37 |
Output file name, defaults to |
| 38 |
/var/lib/openssh\-known\-hosts/ssh_known_hosts |
| 39 |
.SH SOURCE DEFINITIONS |
| 40 |
A source definition is shell snippet dropped into CONFDIR/sources/ with |
| 41 |
a run\-parts(8) compliant name. |
| 42 |
There are two variables not specific to a download plugin: |
| 43 |
.TP |
| 44 |
PLUGIN |
| 45 |
name of the download plugin to use, searched for in PLUGIN_PATH. |
| 46 |
.TP |
| 47 |
EXIT_IGNORE |
| 48 |
optional space\-seperated list of exitcodes which should be ignored. |
| 49 |
Upon such exit code the previously downloaded version is used. |
| 50 |
.SH DOWNLOAD PLUGINS |
| 51 |
Download plugins are executables dropped into PLUGIN_PATH and referenced |
| 52 |
via the PLUGIN variable in the source definition. |
| 53 |
A plugin gets the variables set in the source definition in its |
| 54 |
environment. |
| 55 |
The working directory will be set to the source\[cq]s cache directory. |
| 56 |
Everything a plugin has to do is to create a file named \[lq]new\[rq]. |
| 57 |
\[lq]current\[rq] must not be touched but can be used as a hint to skip |
| 58 |
downloading the same file again. |
| 59 |
stdout and stderr will be connected to \[lq]log\[rq], which will be |
| 60 |
output on error. |
| 61 |
Plugins needn\[cq]t create \[lq]new\[rq] if it would be identical to |
| 62 |
\[lq]current\[rq]. |
| 63 |
.SH HOSTNAME FILTERS |
| 64 |
Place a file foo.filter next to your source definition foo. |
| 65 |
Each line shall contain a rule consisting of an action, a space and a |
| 66 |
pattern. |
| 67 |
The first rule with a matching pattern decides: If the action starts |
| 68 |
with a, o, p or y (for accept, admit, allow, ok, pass, permit, print, |
| 69 |
yes, \&...) |
| 70 |
the hostname will be used, otherwise it is discarded. |
| 71 |
If a key has no hostnames left it is discarded as a whole. |
| 72 |
.SH SEE ALSO |
| 73 |
ssh(1), sshd(8), ssh_config(5), curl(1), rsync(1), psql(1), |
| 74 |
run\-parts(8) |
| 75 |
.SH AUTHORS |
| 76 |
Timo Weingärtner \c |
| 77 |
.MT [email protected] |
| 78 |
.ME \c. |