From: Matt Caswell Date: Wed, 26 Jul 2023 11:18:44 +0000 (+0100) Subject: Provide an introductory page to the whole OpenSSL guide X-Git-Tag: openssl-3.2.0-alpha1~264 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=2740acf09c22ddf54d03984da303453dad32a6df;p=thirdparty%2Fopenssl.git Provide an introductory page to the whole OpenSSL guide Supply some initial overview information and some links to the other pages of the guide. Reviewed-by: Hugo Landau Reviewed-by: Tim Hudson Reviewed-by: Matthias St. Pierre Reviewed-by: Anton Arapov (Merged from https://github.com/openssl/openssl/pull/21560) --- diff --git a/doc/man7/ossl-guide-introduction.pod b/doc/man7/ossl-guide-introduction.pod new file mode 100644 index 00000000000..655c4c91113 --- /dev/null +++ b/doc/man7/ossl-guide-introduction.pod @@ -0,0 +1,95 @@ +=pod + +=head1 NAME + +ossl-guide-introduction +- OpenSSL Guide: An introduction to OpenSSL + +=head1 WHAT IS OPENSSL? + +OpenSSL is a robust, commercial-grade, full-featured toolkit for general-purpose +cryptography and secure communication. Its features are made available via a +command line application that enables users to perform various cryptography +related functions such as generating keys and certificates. Additionally it +supplies two libraries that application developers can use to implement +cryptography based capabilities and to securely communicate across a network. +Finally, it also has a set of providers that supply implementations of a broad +set of cryptographic algorithms. + +OpenSSL is fully open source. Version 3.0 and above are distributed under the +Apache v2 license. + +=head1 GETTING AND INSTALLING OPENSSL + +The OpenSSL Project develops and distributes the source code for OpenSSL. You +can obtain that source code via the OpenSSL website +(L). + +Many Operating Systems (notably Linux distributions) supply pre-built OpenSSL +binaries either pre-installed or available via the package management system in +use for that OS. It is worth checking whether this applies to you before +attempting to build OpenSSL from the source code. + +Some third parties also supply OpenSSL binaries (e.g. for Windows and some other +platforms). The OpenSSL project maintains a list of these third parties at +L. + +If you build and install OpenSSL from the source code then you should download +the appropriate files for the version that you want to use from the link given +above. Extract the contents of the B archive file that you downloaded +into an appropriate directory. Inside that archive you will find a file named +B which will supply detailed instructions on how to build and +install OpenSSL from source. Make sure you read the contents of that file +carefully in order to achieve a successful build. In the directory you will also +find a set of B files that provide further platform specific information. +Make sure you carefully read the file appropriate to your platform. As well as +the platform specific B files there is also a B file that +provides information about setting up Perl for use by the OpenSSL build system +across multiple platforms. + +Sometimes you may want to build and install OpenSSL from source on a system +which already has a pre-built version of OpenSSL installed on it via the +Operating System package management system (for example if you want to use a +newer version of OpenSSL than the one supplied by your Operating System). In +this case it is strongly recommended to install OpenSSL to a different location +than where the pre-built version is installed. You should B replace the +pre-built version with a different version as this may break your system. + +=head1 CONTENTS OF THE OPENSSL GUIDE + +The OpenSSL Guide is a series of documentation pages (starting with this one) +that introduce some of the main concepts in OpenSSL. The guide can either be +read end-to-end in order, or alternatively you can simply skip to the parts most +applicable to your use case. Note however that later pages may depend on and +assume knowledge from earlier pages. + +The pages in the guide are as follows: + +=over 4 + +=item L: An introduction to the OpenSSL libraries + +=item L: An introduction to libcrypto + +=item L: An introduction to libssl + +=item L: An introduction to SSL/TLS in OpenSSL + +=item L: Writing a simple blocking TLS client + +=item L: An introduction to QUIC in OpenSSL + +=item L: Writing a simple blocking QUIC client + +=back + +=head1 COPYRIGHT + +Copyright 2023 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. + +=cut diff --git a/doc/man7/ossl-guide-tls-introduction.pod b/doc/man7/ossl-guide-tls-introduction.pod index 1a8c489753e..28e52b86047 100644 --- a/doc/man7/ossl-guide-tls-introduction.pod +++ b/doc/man7/ossl-guide-tls-introduction.pod @@ -3,12 +3,12 @@ =head1 NAME ossl-guide-tls-introduction -- OpenSSL Guide: An introduction to TLS in OpenSSL +- OpenSSL Guide: An introduction to SSL/TLS in OpenSSL =head1 INTRODUCTION -This page will provide an introduction to some basic TLS concepts and background -and how it is used within OpenSSL. It assumes that you have a basic +This page will provide an introduction to some basic SSL/TLS concepts and +background and how it is used within OpenSSL. It assumes that you have a basic understanding of TCP/IP and sockets. =head1 WHAT IS TLS?