openssl.xml 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  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-fin-sbu;</seg>
  29. <seg>&openssl-fin-du;</seg>
  30. </seglistitem>
  31. </segmentedlist>
  32. </sect2>
  33. <sect2 role="installation">
  34. <title>Installation of OpenSSL</title>
  35. <para>Prepare OpenSSL for compilation:</para>
  36. <screen><userinput remap="configure">./config --prefix=/usr \
  37. --openssldir=/etc/ssl \
  38. --libdir=lib \
  39. shared \
  40. zlib-dynamic</userinput></screen>
  41. <para>Compile the package:</para>
  42. <screen><userinput remap="make">make</userinput></screen>
  43. <para>To test the results, issue:</para>
  44. <screen><userinput remap="test">make test</userinput></screen>
  45. <para>One test 30-test_afalg.t is known to fail on some kernel
  46. configurations (it apparently assumes certain unspecified crypto
  47. options have been selected).</para>
  48. <para>Install the package:</para>
  49. <screen><userinput remap="install">sed -i '/INSTALL_LIBS/s/libcrypto.a libssl.a//' Makefile
  50. make MANSUFFIX=ssl install</userinput></screen>
  51. <para>Add the version to the documentation directory name, to be
  52. consistent with other packages:</para>
  53. <screen><userinput remap="install">mv -v /usr/share/doc/openssl /usr/share/doc/openssl-&openssl-version;</userinput></screen>
  54. <para>If desired, install some additional documentation:</para>
  55. <screen><userinput remap="install">cp -vfr doc/* /usr/share/doc/openssl-&openssl-version;</userinput></screen>
  56. </sect2>
  57. <sect2 id="contents-openssl" role="content">
  58. <title>Contents of OpenSSL</title>
  59. <segmentedlist>
  60. <segtitle>Installed programs</segtitle>
  61. <segtitle>Installed libraries</segtitle>
  62. <segtitle>Installed directories</segtitle>
  63. <seglistitem>
  64. <seg>
  65. c_rehash and openssl
  66. </seg>
  67. <seg>
  68. libcrypto.so and libssl.so
  69. </seg>
  70. <seg>
  71. /etc/ssl,
  72. /usr/include/openssl,
  73. /usr/lib/engines and
  74. /usr/share/doc/openssl-&openssl-version;
  75. </seg>
  76. </seglistitem>
  77. </segmentedlist>
  78. <variablelist>
  79. <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  80. <?dbfo list-presentation="list"?>
  81. <?dbhtml list-presentation="table"?>
  82. <varlistentry id="c_rehash">
  83. <term><command>c_rehash</command></term>
  84. <listitem>
  85. <para>
  86. is a <application>Perl</application> script that scans all files in
  87. a directory and adds symbolic links to their hash values.
  88. </para>
  89. <indexterm zone="ch-system-openssl c_rehash">
  90. <primary sortas="b-c_rehash">c_rehash</primary>
  91. </indexterm>
  92. </listitem>
  93. </varlistentry>
  94. <varlistentry id="openssl-prog">
  95. <term><command>openssl</command></term>
  96. <listitem>
  97. <para>
  98. is a command-line tool for using the various cryptography functions
  99. of <application>OpenSSL</application>'s crypto library from the
  100. shell. It can be used for various functions which are documented in
  101. <command>man 1 openssl</command>.
  102. </para>
  103. <indexterm zone="ch-system-openssl openssl-prog">
  104. <primary sortas="b-openssl">openssl</primary>
  105. </indexterm>
  106. </listitem>
  107. </varlistentry>
  108. <varlistentry id="libcrypto">
  109. <term><filename class="libraryfile">libcrypto.so</filename></term>
  110. <listitem>
  111. <para>
  112. implements a wide range of cryptographic algorithms used in various
  113. Internet standards. The services provided by this library are used
  114. by the <application>OpenSSL</application> implementations of SSL,
  115. TLS and S/MIME, and they have also been used to implement
  116. <application>OpenSSH</application>,
  117. <application>OpenPGP</application>, and other cryptographic
  118. standards.
  119. </para>
  120. <indexterm zone="ch-system-openssl libcrypto">
  121. <primary sortas="c-libcrypto">libcrypto.so</primary>
  122. </indexterm>
  123. </listitem>
  124. </varlistentry>
  125. <varlistentry id="libssl">
  126. <term><filename class="libraryfile">libssl.so</filename></term>
  127. <listitem>
  128. <para>
  129. implements the Transport Layer Security (TLS v1) protocol.
  130. It provides a rich API, documentation
  131. on which can be found by running <command>man 3 ssl</command>.
  132. </para>
  133. <indexterm zone="ch-system-openssl libssl">
  134. <primary sortas="c-libssl">libssl.so</primary>
  135. </indexterm>
  136. </listitem>
  137. </varlistentry>
  138. </variablelist>
  139. </sect2>
  140. </sect1>