Debian Codegraph @

upstream/debian-unstable/man7/ossl-guide-introduction.7ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OSSL-GUIDE-INTRODUCTION 7SSL"
58 .TH OSSL-GUIDE-INTRODUCTION 7SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 ossl\-guide\-introduction
65 \&\- OpenSSL Guide: An introduction to OpenSSL
66 .SH "WHAT IS OPENSSL?"
67 .IX Header "WHAT IS OPENSSL?"
68 OpenSSL is a robust, commercial-grade, full-featured toolkit for general-purpose
69 cryptography and secure communication. Its features are made available via a
70 command line application that enables users to perform various cryptography
71 related functions such as generating keys and certificates. Additionally it
72 supplies two libraries that application developers can use to implement
73 cryptography based capabilities and to securely communicate across a network.
74 Finally, it also has a set of providers that supply implementations of a broad
75 set of cryptographic algorithms.
76 .PP
77 OpenSSL is fully open source. Version 3.0 and above are distributed under the
78 Apache v2 license.
79 .SH "GETTING AND INSTALLING OPENSSL"
80 .IX Header "GETTING AND INSTALLING OPENSSL"
81 The OpenSSL Project develops and distributes the source code for OpenSSL. You
82 can obtain that source code via the OpenSSL website
83 (<https://www.openssl.org/source>).
84 .PP
85 Many Operating Systems (notably Linux distributions) supply pre-built OpenSSL
86 binaries either pre-installed or available via the package management system in
87 use for that OS. It is worth checking whether this applies to you before
88 attempting to build OpenSSL from the source code.
89 .PP
90 Some third parties also supply OpenSSL binaries (e.g. for Windows and some other
91 platforms). The OpenSSL project maintains a list of these third parties at
92 <https://github.com/openssl/openssl/wiki/Binaries>.
93 .PP
94 If you build and install OpenSSL from the source code then you should download
95 the appropriate files for the version that you want to use from the link given
96 above. Extract the contents of the \fBtar.gz\fR archive file that you downloaded
97 into an appropriate directory. Inside that archive you will find a file named
98 \&\fBINSTALL.md\fR which will supply detailed instructions on how to build and
99 install OpenSSL from source. Make sure you read the contents of that file
100 carefully in order to achieve a successful build. In the directory you will also
101 find a set of \fBNOTES\fR files that provide further platform specific information.
102 Make sure you carefully read the file appropriate to your platform. As well as
103 the platform specific \fBNOTES\fR files there is also a \fBNOTES\-PERL.md\fR file that
104 provides information about setting up Perl for use by the OpenSSL build system
105 across multiple platforms.
106 .PP
107 Sometimes you may want to build and install OpenSSL from source on a system
108 which already has a pre-built version of OpenSSL installed on it via the
109 Operating System package management system (for example if you want to use a
110 newer version of OpenSSL than the one supplied by your Operating System). In
111 this case it is strongly recommended to install OpenSSL to a different location
112 than where the pre-built version is installed. You should \fBnever\fR replace the
113 pre-built version with a different version as this may break your system.
114 .SH "CONTENTS OF THE OPENSSL GUIDE"
115 .IX Header "CONTENTS OF THE OPENSSL GUIDE"
116 The OpenSSL Guide is a series of documentation pages (starting with this one)
117 that introduce some of the main concepts in OpenSSL. The guide can either be
118 read end-to-end in order, or alternatively you can simply skip to the parts most
119 applicable to your use case. Note however that later pages may depend on and
120 assume knowledge from earlier pages.
121 .PP
122 The pages in the guide are as follows:
123 .IP "\fBossl\-guide\-libraries\-introduction\fR\|(7): An introduction to the OpenSSL libraries" 4
124 .IX Item "ossl-guide-libraries-introduction: An introduction to the OpenSSL libraries"
125 .PD 0
126 .IP "\fBossl\-guide\-libcrypto\-introduction\fR\|(7): An introduction to libcrypto" 4
127 .IX Item "ossl-guide-libcrypto-introduction: An introduction to libcrypto"
128 .IP "\fBossl\-guide\-libssl\-introduction\fR\|(7): An introduction to libssl" 4
129 .IX Item "ossl-guide-libssl-introduction: An introduction to libssl"
130 .IP "\fBossl\-guide\-tls\-introduction\fR\|(7): An introduction to SSL/TLS in OpenSSL" 4
131 .IX Item "ossl-guide-tls-introduction: An introduction to SSL/TLS in OpenSSL"
132 .IP "\fBossl\-guide\-tls\-client\-block\fR\|(7): Writing a simple blocking TLS client" 4
133 .IX Item "ossl-guide-tls-client-block: Writing a simple blocking TLS client"
134 .IP "\fBossl\-guide\-tls\-client\-non\-block\fR\|(7): Writing a simple nonblocking TLS client" 4
135 .IX Item "ossl-guide-tls-client-non-block: Writing a simple nonblocking TLS client"
136 .IP "\fBossl\-guide\-tls\-server\-block\fR\|(7): Writing a simple blocking TLS server" 4
137 .IX Item "ossl-guide-tls-server-block: Writing a simple blocking TLS server"
138 .IP "\fBossl\-guide\-quic\-introduction\fR\|(7): An introduction to QUIC in OpenSSL" 4
139 .IX Item "ossl-guide-quic-introduction: An introduction to QUIC in OpenSSL"
140 .IP "\fBossl\-guide\-quic\-client\-block\fR\|(7): Writing a simple blocking QUIC client" 4
141 .IX Item "ossl-guide-quic-client-block: Writing a simple blocking QUIC client"
142 .IP "\fBossl\-guide\-quic\-server\-block\fR\|(7): Writing a simple blocking QUIC server" 4
143 .IX Item "ossl-guide-quic-server-block: Writing a simple blocking QUIC server"
144 .IP "\fBossl\-guide\-quic\-multi\-stream\fR\|(7): Writing a simple multi-stream QUIC client" 4
145 .IX Item "ossl-guide-quic-multi-stream: Writing a simple multi-stream QUIC client"
146 .IP "\fBossl\-guide\-quic\-server\-non\-block\fR\|(7): Writing a simple nonblocking QUIC server" 4
147 .IX Item "ossl-guide-quic-server-non-block: Writing a simple nonblocking QUIC server"
148 .IP "\fBossl\-guide\-quic\-client\-non\-block\fR\|(7): Writing a simple nonblocking QUIC client" 4
149 .IX Item "ossl-guide-quic-client-non-block: Writing a simple nonblocking QUIC client"
150 .IP "\fBossl\-guide\-migration\fR\|(7): Migrating from older OpenSSL versions" 4
151 .IX Item "ossl-guide-migration: Migrating from older OpenSSL versions"
152 .PD
153 .SH COPYRIGHT
154 .IX Header "COPYRIGHT"
155 Copyright 2023\-2025 The OpenSSL Project Authors. All Rights Reserved.
156 .PP
157 Licensed under the Apache License 2.0 (the "License"). You may not use
158 this file except in compliance with the License. You can obtain a copy
159 in the file LICENSE in the source distribution or at
160 <https://www.openssl.org/source/license.html>.