openssl.xml 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  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. <sect1 id="ch-system-openssl" role="wrap">
  8. <?dbhtml filename="openssl.html"?>
  9. <sect1info condition="script">
  10. <productname>openssl</productname>
  11. <productnumber>&openssl-version;</productnumber>
  12. <address>&openssl-url;</address>
  13. </sect1info>
  14. <title>OpenSSL-&openssl-version;</title>
  15. <indexterm zone="ch-system-openssl">
  16. <primary sortas="a-OpenSSL">OpenSSL</primary>
  17. </indexterm>
  18. <sect2 role="package">
  19. <title/>
  20. <para>The OpenSSL package contains management tools and libraries relating
  21. to cryptography. These are useful for providing cryptographic functions
  22. to other packages, such as OpenSSH, email applications and web browsers
  23. (for accessing HTTPS sites). </para>
  24. <segmentedlist>
  25. <segtitle>&buildtime;</segtitle>
  26. <segtitle>&diskspace;</segtitle>
  27. <seglistitem>
  28. <seg>&openssl-ch6-sbu;</seg>
  29. <seg>&openssl-ch6-du;</seg>
  30. </seglistitem>
  31. </segmentedlist>
  32. </sect2>
  33. <sect2 role="installation">
  34. <title>Installation of OpenSSL</title>
  35. <!--
  36. <para>First, fix a problem identified upstream:</para>
  37. <screen><userinput remap="pre">sed -i '/\} data/s/ =.*$/;\n memset(\&amp;data, 0, sizeof(data));/' \
  38. crypto/rand/rand_lib.c</userinput></screen>
  39. -->
  40. <para>Prepare OpenSSL for compilation:</para>
  41. <screen><userinput remap="configure">./config --prefix=/usr \
  42. --openssldir=/etc/ssl \
  43. --libdir=lib \
  44. shared \
  45. zlib-dynamic</userinput></screen>
  46. <para>Compile the package:</para>
  47. <screen><userinput remap="make">make</userinput></screen>
  48. <para>To test the results, issue:</para>
  49. <screen><userinput remap="test">make test</userinput></screen>
  50. <para>One test 30-test_afalg.t is known to fail on some kernel
  51. configurations (it apparently assumes certain unspecified crypto
  52. options have been selected).</para>
  53. <para>Install the package:</para>
  54. <screen><userinput remap="install">sed -i '/INSTALL_LIBS/s/libcrypto.a libssl.a//' Makefile
  55. make MANSUFFIX=ssl install</userinput></screen>
  56. <para>If desired, install the documentation:</para>
  57. <screen><userinput remap="install">mv -v /usr/share/doc/openssl /usr/share/doc/openssl-&openssl-version;
  58. cp -vfr doc/* /usr/share/doc/openssl-&openssl-version;</userinput></screen>
  59. </sect2>
  60. <sect2 id="contents-openssl" role="content">
  61. <title>Contents of OpenSSL</title>
  62. <segmentedlist>
  63. <segtitle>Installed programs</segtitle>
  64. <segtitle>Installed libraries</segtitle>
  65. <segtitle>Installed directories</segtitle>
  66. <seglistitem>
  67. <seg>
  68. c_rehash and openssl
  69. </seg>
  70. <seg>
  71. libcrypto.{so,a} and libssl.{so,a}
  72. </seg>
  73. <seg>
  74. /etc/ssl,
  75. /usr/include/openssl,
  76. /usr/lib/engines and
  77. /usr/share/doc/openssl-&openssl-version;
  78. </seg>
  79. </seglistitem>
  80. </segmentedlist>
  81. <variablelist>
  82. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  83. <?dbfo list-presentation="list"?>
  84. <?dbhtml list-presentation="table"?>
  85. <varlistentry id="c_rehash">
  86. <term><command>c_rehash</command></term>
  87. <listitem>
  88. <para>
  89. is a <application>Perl</application> script that scans all files in
  90. a directory and adds symbolic links to their hash values.
  91. </para>
  92. <indexterm zone="ch-system-openssl c_rehash">
  93. <primary sortas="b-c_rehash">c_rehash</primary>
  94. </indexterm>
  95. </listitem>
  96. </varlistentry>
  97. <varlistentry id="openssl-prog">
  98. <term><command>openssl</command></term>
  99. <listitem>
  100. <para>
  101. is a command-line tool for using the various cryptography functions
  102. of <application>OpenSSL</application>'s crypto library from the
  103. shell. It can be used for various functions which are documented in
  104. <command>man 1 openssl</command>.
  105. </para>
  106. <indexterm zone="ch-system-openssl openssl-prog">
  107. <primary sortas="b-openssl">openssl</primary>
  108. </indexterm>
  109. </listitem>
  110. </varlistentry>
  111. <varlistentry id="libcrypto">
  112. <term><filename class="libraryfile">libcrypto.so</filename></term>
  113. <listitem>
  114. <para>
  115. implements a wide range of cryptographic algorithms used in various
  116. Internet standards. The services provided by this library are used
  117. by the <application>OpenSSL</application> implementations of SSL,
  118. TLS and S/MIME, and they have also been used to implement
  119. <application>OpenSSH</application>,
  120. <application>OpenPGP</application>, and other cryptographic
  121. standards.
  122. </para>
  123. <indexterm zone="ch-system-openssl libcrypto">
  124. <primary sortas="c-libcrypto">libcrypto.so</primary>
  125. </indexterm>
  126. </listitem>
  127. </varlistentry>
  128. <varlistentry id="libssl">
  129. <term><filename class="libraryfile">libssl.so</filename></term>
  130. <listitem>
  131. <para>
  132. implements the Transport Layer Security (TLS v1) protocol.
  133. It provides a rich API, documentation
  134. on which can be found by running <command>man 3 ssl</command>.
  135. </para>
  136. <indexterm zone="ch-system-openssl libssl">
  137. <primary sortas="c-libssl">libssl.so</primary>
  138. </indexterm>
  139. </listitem>
  140. </varlistentry>
  141. </variablelist>
  142. </sect2>
  143. </sect1>