lib/libssl/man/SSL_library_init.3

   1 .\"     $OpenBSD: SSL_library_init.3,v 1.6 2018/03/27 17:35:50 schwarze Exp $
   2 .\"     OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
   3 .\"
   4 .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
   5 .\" Copyright (c) 2000, 2006, 2010 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: March 27 2018 $
  52 .Dt SSL_LIBRARY_INIT 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_library_init ,
  56 .Nm OpenSSL_add_ssl_algorithms ,
  57 .Nm SSLeay_add_ssl_algorithms
  58 .Nd initialize SSL library by registering algorithms
  59 .Sh SYNOPSIS
  60 .In openssl/ssl.h
  61 .Ft int
  62 .Fn SSL_library_init void
  63 .Ft int
  64 .Fn OpenSSL_add_ssl_algorithms void
  65 .Ft int
  66 .Fn SSLeay_add_ssl_algorithms void
  67 .Sh DESCRIPTION
  68 .Fn SSL_library_init
  69 registers the available SSL/TLS ciphers and digests.
  70 .Pp
  71 .Fn OpenSSL_add_ssl_algorithms
  72 and
  73 .Fn SSLeay_add_ssl_algorithms
  74 are synonyms for
  75 .Fn SSL_library_init
  76 and are implemented as macros.
  77 .Pp
  78 .Fn SSL_library_init
  79 must be called before any other action takes place.
  80 .Fn SSL_library_init
  81 is not reentrant.
  82 .Pp
  83 .Fn SSL_library_init
  84 adds ciphers and digests used directly and indirectly by SSL/TLS.
  85 .Sh RETURN VALUES
  86 .Fn SSL_library_init
  87 always returns 1, so it is safe to discard the return value.
  88 .Sh EXAMPLES
  89 A typical TLS/SSL application will start with the library initialization, and
  90 provide readable error messages.
  91 .Bd -literal
  92 SSL_load_error_strings();                /* readable error messages */
  93 SSL_library_init();                      /* initialize library */
  94 .Ed
  95 .Sh SEE ALSO
  96 .Xr RAND_add 3 ,
  97 .Xr ssl 3 ,
  98 .Xr SSL_load_error_strings 3
  99 .Sh HISTORY
 100 .Fn SSLeay_add_ssl_algorithms
 101 first appeared in SSLeay 0.8.0 and has been available since
 102 .Ox 2.4 .
 103 .Pp
 104 .Fn SSL_library_init
 105 first appeared in OpenSSL 0.9.2b and has been available since
 106 .Ox 2.6 .
 107 .Pp
 108 .Fn OpenSSL_add_ssl_algorithms
 109 first appeared in OpenSSL 0.9.5 and has been available since
 110 .Ox 2.7 .