1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY libssh2-download-http "https://www.libssh2.org/download/libssh2-&libssh2-version;.tar.gz">
|
---|
8 | <!ENTITY libssh2-download-ftp " ">
|
---|
9 | <!ENTITY libssh2-md5sum "38857d10b5c5deb198d6989dacace2e6">
|
---|
10 | <!ENTITY libssh2-size "1.0 MB">
|
---|
11 | <!ENTITY libssh2-buildsize "15 MB (with tests)">
|
---|
12 | <!ENTITY libssh2-time "0.2 SBU (with tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="libssh2" xreflabel="libssh2-&libssh2-version;">
|
---|
16 | <?dbhtml filename="libssh2.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>libssh2-&libssh2-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="libssh2">
|
---|
22 | <primary sortas="a-libssh2">libssh2</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to libssh2</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | <application>Libssh2</application> package is a client-side C library
|
---|
30 | implementing the SSH2 protocol.
|
---|
31 | </para>
|
---|
32 |
|
---|
33 | &lfs122_checked;
|
---|
34 |
|
---|
35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
36 | <itemizedlist spacing="compact">
|
---|
37 | <listitem>
|
---|
38 | <para>
|
---|
39 | Download (HTTP): <ulink url="&libssh2-download-http;"/>
|
---|
40 | </para>
|
---|
41 | </listitem>
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (FTP): <ulink url="&libssh2-download-ftp;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download MD5 sum: &libssh2-md5sum;
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download size: &libssh2-size;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Estimated disk space required: &libssh2-buildsize;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated build time: &libssh2-time;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | </itemizedlist>
|
---|
68 |
|
---|
69 | <!--
|
---|
70 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
71 | <itemizedlist spacing="compact">
|
---|
72 | <listitem>
|
---|
73 | <para>
|
---|
74 | Required patch:
|
---|
75 | <ulink url="&patch-root;/libssh2-&libssh2-version;-security_fixes-1.patch"/>
|
---|
76 | </para>
|
---|
77 | </listitem>
|
---|
78 | </itemizedlist>
|
---|
79 | -->
|
---|
80 | <bridgehead renderas="sect3">libssh2 Dependencies</bridgehead>
|
---|
81 |
|
---|
82 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
83 | <para role="optional">
|
---|
84 | <xref linkend="cmake"/> (can be used instead of the
|
---|
85 | <command>configure</command> script),
|
---|
86 | <xref linkend="libgcrypt"/> (can be used instead of OpenSSL),
|
---|
87 | <xref linkend="openssh"/> (for some tests), and
|
---|
88 | <ulink url='https://www.docker.com'>Docker</ulink> (for some tests)
|
---|
89 | </para>
|
---|
90 |
|
---|
91 | </sect2>
|
---|
92 |
|
---|
93 | <sect2 role="installation">
|
---|
94 | <title>Installation of libssh2</title>
|
---|
95 | <!--
|
---|
96 | <para>
|
---|
97 | <!- - the Terrapin attack - ->
|
---|
98 | First, fix a critical security vulnerability in libssh2:
|
---|
99 | </para>
|
---|
100 |
|
---|
101 | <screen><userinput remap="pre">patch -Np1 -i ../libssh2-&libssh2-version;-security_fixes-1.patch</userinput></screen>
|
---|
102 |
|
---|
103 | <para>
|
---|
104 | If you want to test the package, exclude the tests requiring a static
|
---|
105 | library, and remove the reference to an insecure algorithm removed
|
---|
106 | since OpenSSH 9.8:
|
---|
107 | </para>
|
---|
108 |
|
---|
109 | <screen><userinput>sed -E '/^DOCKER_TEST/,/^SSHD_TEST/s/test_(auth_keyboard_info.* |hostkey |simple)/$(NOTHING)/' \
|
---|
110 | -i tests/Makefile.inc &&
|
---|
111 | autoreconf -fi &&
|
---|
112 | sed 's/ssh-dss,//' -i tests/openssh_server/sshd_config</userinput></screen>
|
---|
113 | -->
|
---|
114 | <para>
|
---|
115 | Install <application>libssh2</application> by running the following
|
---|
116 | commands:
|
---|
117 | </para>
|
---|
118 |
|
---|
119 | <screen><userinput>./configure --prefix=/usr \
|
---|
120 | --disable-docker-tests \
|
---|
121 | --disable-static &&
|
---|
122 | make</userinput></screen>
|
---|
123 |
|
---|
124 | <para>
|
---|
125 | To test the results, issue: <command>make check</command>.
|
---|
126 | </para>
|
---|
127 |
|
---|
128 | <para>
|
---|
129 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
130 | </para>
|
---|
131 |
|
---|
132 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
133 | </sect2>
|
---|
134 |
|
---|
135 | <sect2 role="commands">
|
---|
136 | <title>Command Explanations</title>
|
---|
137 |
|
---|
138 | <para>
|
---|
139 | <parameter>--disable-docker-tests</parameter>: Disable the tests
|
---|
140 | requiring Docker, which is beyond the scope of BLFS. Remove this
|
---|
141 | switch if you've installed Docker and you wish to run the test suite.
|
---|
142 | </para>
|
---|
143 |
|
---|
144 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
145 | href="../../xincludes/static-libraries.xml"/>
|
---|
146 |
|
---|
147 | </sect2>
|
---|
148 |
|
---|
149 | <sect2 role="content">
|
---|
150 | <title>Contents</title>
|
---|
151 |
|
---|
152 | <segmentedlist>
|
---|
153 | <segtitle>Installed Programs</segtitle>
|
---|
154 | <segtitle>Installed Library</segtitle>
|
---|
155 | <segtitle>Installed Directories</segtitle>
|
---|
156 |
|
---|
157 | <seglistitem>
|
---|
158 | <seg>
|
---|
159 | None
|
---|
160 | </seg>
|
---|
161 | <seg>
|
---|
162 | libssh2.so
|
---|
163 | </seg>
|
---|
164 | <seg>
|
---|
165 | None
|
---|
166 | </seg>
|
---|
167 | </seglistitem>
|
---|
168 | </segmentedlist>
|
---|
169 |
|
---|
170 | <variablelist>
|
---|
171 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
172 | <?dbfo list-presentation="list"?>
|
---|
173 | <?dbhtml list-presentation="table"?>
|
---|
174 |
|
---|
175 | <varlistentry id="libssh2-lib">
|
---|
176 | <term><filename class="libraryfile">libssh2.so</filename></term>
|
---|
177 | <listitem>
|
---|
178 | <para>
|
---|
179 | contains functions to use the SSH2 protocol
|
---|
180 | </para>
|
---|
181 | <indexterm zone="libssh2 libssh2-lib">
|
---|
182 | <primary sortas="c-libssh2">libssh2.so</primary>
|
---|
183 | </indexterm>
|
---|
184 | </listitem>
|
---|
185 | </varlistentry>
|
---|
186 | </variablelist>
|
---|
187 | </sect2>
|
---|
188 |
|
---|
189 | </sect1>
|
---|