lib/libcrypto/man/ENGINE_register_all_RSA.3

   1 .\" $OpenBSD: ENGINE_register_all_RSA.3,v 1.3 2018/04/18 03:39:22 schwarze Exp $
   2 .\" content checked up to:
   3 .\" OpenSSL ENGINE_add 1f13ad31 Dec 25 17:50:39 2017 +0800
   4 .\"
   5 .\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org>
   6 .\"
   7 .\" Permission to use, copy, modify, and distribute this software for any
   8 .\" purpose with or without fee is hereby granted, provided that the above
   9 .\" copyright notice and this permission notice appear in all copies.
  10 .\"
  11 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  12 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  13 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  14 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  15 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  16 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  17 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18 .\"
  19 .Dd $Mdocdate: April 18 2018 $
  20 .Dt ENGINE_REGISTER_ALL_RSA 3
  21 .Os
  22 .Sh NAME
  23 .Nm ENGINE_register_all_RSA ,
  24 .Nm ENGINE_register_all_DSA ,
  25 .Nm ENGINE_register_all_ECDH ,
  26 .Nm ENGINE_register_all_ECDSA ,
  27 .Nm ENGINE_register_all_DH ,
  28 .Nm ENGINE_register_all_RAND ,
  29 .Nm ENGINE_register_all_STORE ,
  30 .Nm ENGINE_register_all_ciphers ,
  31 .Nm ENGINE_register_all_digests ,
  32 .Nm ENGINE_register_all_complete ,
  33 .Nm ENGINE_load_builtin_engines ,
  34 .Nm ENGINE_load_dynamic
  35 .Nd register all engines as implementing an algorithm
  36 .Sh SYNOPSIS
  37 .In openssl/engine.h
  38 .Ft void
  39 .Fn ENGINE_register_all_RSA void
  40 .Ft void
  41 .Fn ENGINE_register_all_DSA void
  42 .Ft void
  43 .Fn ENGINE_register_all_ECDH void
  44 .Ft void
  45 .Fn ENGINE_register_all_ECDSA void
  46 .Ft void
  47 .Fn ENGINE_register_all_DH void
  48 .Ft void
  49 .Fn ENGINE_register_all_RAND void
  50 .Ft void
  51 .Fn ENGINE_register_all_STORE void
  52 .Ft void
  53 .Fn ENGINE_register_all_ciphers void
  54 .Ft void
  55 .Fn ENGINE_register_all_digests void
  56 .Ft int
  57 .Fn ENGINE_register_all_complete void
  58 .Ft void
  59 .Fn ENGINE_load_builtin_engines void
  60 .Ft void
  61 .Fn ENGINE_load_dynamic void
  62 .Sh DESCRIPTION
  63 These functions loop over all the
  64 .Vt ENGINE
  65 objects contained in the global table described in the
  66 .Xr ENGINE_add 3
  67 manual page.
  68 They register each object for the respective algorithm
  69 by calling the corresponding function described in
  70 .Xr ENGINE_register_RSA 3 .
  71 .Pp
  72 .Fn ENGINE_register_all_complete
  73 calls
  74 .Fn ENGINE_register_complete
  75 in this way, except that it skips those
  76 .Vt ENGINE
  77 objects that have the
  78 .Dv ENGINE_FLAGS_NO_REGISTER_ALL
  79 flag set with
  80 .Xr ENGINE_set_flags 3 .
  81 .Pp
  82 .Fn ENGINE_load_builtin_engines
  83 calls
  84 .Xr OPENSSL_init_crypto 3
  85 with no options, loads any built-in engines
  86 that are enabled by default, and calls
  87 .Fn ENGINE_register_all_complete .
  88 Currently, LibreSSL does not provide any engines.
  89 .Sy GOST
  90 and
  91 .Sy aesni
  92 support is provided by the crypto library itself
  93 and does not require any engines, not even built-in ones.
  94 .Pp
  95 .Fn ENGINE_load_dynamic
  96 has no effect and is only provided for compatibility.
  97 .Sh SEE ALSO
  98 .Xr ENGINE_add 3 ,
  99 .Xr ENGINE_new 3 ,
 100 .Xr ENGINE_register_RSA 3 ,
 101 .Xr ENGINE_set_flags 3 ,
 102 .Xr OPENSSL_config 3 ,
 103 .Xr OPENSSL_init_crypto 3
 104 .Sh HISTORY
 105 .Fn ENGINE_register_all_RSA ,
 106 .Fn ENGINE_register_all_DSA ,
 107 .Fn ENGINE_register_all_DH ,
 108 .Fn ENGINE_register_all_RAND ,
 109 .Fn ENGINE_register_all_ciphers ,
 110 .Fn ENGINE_register_all_digests ,
 111 .Fn ENGINE_register_all_complete ,
 112 .Fn ENGINE_load_builtin_engines ,
 113 and
 114 .Fn ENGINE_load_dynamic
 115 first appeared in OpenSSL 0.9.7 and have been available since
 116 .Ox 3.2 .
 117 .Pp
 118 .Fn ENGINE_register_all_ECDH ,
 119 .Fn ENGINE_register_all_ECDSA ,
 120 and
 121 .Fn ENGINE_register_all_STORE
 122 first appeared in OpenSSL 0.9.8 and have been available since
 123 .Ox 4.5 .