summaryrefslogtreecommitdiffstats
path: root/src/man/sss_ssh_knownhostsproxy.1.xml
blob: 0b89ce9882543b02a0bb9f3dc7728151b36e5ec5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<reference>
<title>SSSD Manual pages</title>
<refentry>
    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />

    <refmeta>
        <refentrytitle>sss_ssh_knownhostsproxy</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>

    <refnamediv id='name'>
        <refname>sss_ssh_knownhostsproxy</refname>
        <refpurpose>get OpenSSH host keys</refpurpose>
    </refnamediv>

    <refsynopsisdiv id='synopsis'>
        <cmdsynopsis>
            <command>sss_ssh_knownhostsproxy</command>
            <arg choice='opt'>
                <replaceable>options</replaceable>
            </arg>
            <arg choice='plain'><replaceable>HOST</replaceable></arg>
            <arg choice='opt'><replaceable>PROXY_COMMAND</replaceable></arg>
        </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1 id='description'>
        <title>DESCRIPTION</title>
        <para>
            <command>sss_ssh_knownhostsproxy</command> acquires SSH host
            public keys for host <replaceable>HOST</replaceable>, stores
            them in a custom OpenSSH known_hosts file (see the
            <quote>SSH_KNOWN_HOSTS FILE FORMAT</quote> section of
            <citerefentry><refentrytitle>sshd</refentrytitle>
            <manvolnum>8</manvolnum></citerefentry> for more information)
            <filename>/var/lib/sss/pubconf/known_hosts</filename> and
            establishes the connection to the host.
        </para>
        <para>
            If <replaceable>PROXY_COMMAND</replaceable> is specified,
            it is used to create the connection to the host instead of
            opening a socket.
        </para>
        <para>
            <citerefentry><refentrytitle>ssh</refentrytitle>
            <manvolnum>1</manvolnum></citerefentry> can be configured to
            use <command>sss_ssh_knownhostsproxy</command> for host key
            authentication by using the following directives for
            <citerefentry><refentrytitle>ssh</refentrytitle>
            <manvolnum>1</manvolnum></citerefentry> configuration:
<programlisting>
ProxyCommand /usr/bin/sss_ssh_knownhostsproxy -p %p %h
GlobalKnownHostsFile /var/lib/sss/pubconf/known_hosts
</programlisting>
        </para>
    </refsect1>

    <refsect1 id='options'>
        <title>OPTIONS</title>
        <variablelist remap='IP'>
            <varlistentry>
                <term>
                    <option>-p</option>,<option>--port</option>
                    <replaceable>PORT</replaceable>
                </term>
                <listitem>
                    <para>
                        Use port <replaceable>PORT</replaceable> to connect to the host.
                        By default, port 22 is used.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-d</option>,<option>--domain</option>
                    <replaceable>DOMAIN</replaceable>
                </term>
                <listitem>
                    <para>
                        Search for host public keys in SSSD domain <replaceable>DOMAIN</replaceable>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>
                    <option>-k</option>,<option>--pubkey</option>
                </term>
                <listitem>
                    <para>
                        Print the host ssh public keys for host <replaceable>HOST</replaceable>.
                    </para>
                </listitem>
            </varlistentry>
            <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/param_help.xml" />
        </variablelist>
    </refsect1>

    <refsect1 id='exit_status'>
        <title>EXIT STATUS</title>
        <para>
            In case of success, an exit value of 0 is returned. Otherwise,
            1 is returned.
        </para>
    </refsect1>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/seealso.xml" />

</refentry>
</reference>