lib/libcrypto/man/OPENSSL_load_builtin_modules.3

   1 .\"     $OpenBSD: OPENSSL_load_builtin_modules.3,v 1.4 2016/11/28 15:08:58 schwarze Exp $
   2 .\"     OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
   3 .\"
   4 .\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
   5 .\" Copyright (c) 2004, 2013 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: November 28 2016 $
  52 .Dt OPENSSL_LOAD_BUILTIN_MODULES 3
  53 .Os
  54 .Sh NAME
  55 .Nm OPENSSL_load_builtin_modules ,
  56 .Nm ASN1_add_oid_module ,
  57 .Nm ENGINE_add_conf_module
  58 .Nd add standard configuration modules
  59 .Sh SYNOPSIS
  60 .In openssl/conf.h
  61 .Ft void
  62 .Fn OPENSSL_load_builtin_modules void
  63 .Ft void
  64 .Fn ASN1_add_oid_module void
  65 .Ft void
  66 .Fn ENGINE_add_conf_module void
  67 .Sh DESCRIPTION
  68 The function
  69 .Fn OPENSSL_load_builtin_modules
  70 adds all the standard OpenSSL configuration modules to the internal
  71 list.
  72 They can then be used by the OpenSSL configuration code.
  73 .Pp
  74 .Fn ASN1_add_oid_module
  75 adds just the ASN.1 OBJECT module.
  76 .Pp
  77 .Fn ENGINE_add_conf_module
  78 adds just the ENGINE configuration module.
  79 .Pp
  80 If the simple configuration function
  81 .Xr OPENSSL_config 3
  82 is called then
  83 .Fn OPENSSL_load_builtin_modules
  84 is called automatically.
  85 .Pp
  86 Applications which use the configuration functions directly will need to
  87 call
  88 .Fn OPENSSL_load_builtin_modules
  89 themselves
  90 .Em before
  91 any other configuration code.
  92 .Pp
  93 Applications should call
  94 .Fn OPENSSL_load_builtin_modules
  95 to load all configuration modules instead of adding modules selectively:
  96 otherwise functionality may be missing from the application when
  97 new modules are added.
  98 .Sh SEE ALSO
  99 .Xr OPENSSL_config 3
 100 .Sh HISTORY
 101 These functions first appeared in OpenSSL 0.9.7.