OPENSSL_load_builtin_modules.3ossl 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. .\" -*- mode: troff; coding: utf-8 -*-
  2. .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
  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 "OPENSSL_LOAD_BUILTIN_MODULES 3ossl"
  58. .TH OPENSSL_LOAD_BUILTIN_MODULES 3ossl 2025-01-17 3.4.0 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. OPENSSL_load_builtin_modules, ASN1_add_oid_module, ENGINE_add_conf_module \- add standard configuration modules
  65. .SH SYNOPSIS
  66. .IX Header "SYNOPSIS"
  67. .Vb 1
  68. \& #include <openssl/conf.h>
  69. \&
  70. \& void OPENSSL_load_builtin_modules(void);
  71. \& void ASN1_add_oid_module(void);
  72. \& void ENGINE_add_conf_module(void);
  73. .Ve
  74. .SH DESCRIPTION
  75. .IX Header "DESCRIPTION"
  76. The function \fBOPENSSL_load_builtin_modules()\fR adds all the standard OpenSSL
  77. configuration modules to the internal list. They can then be used by the
  78. OpenSSL configuration code.
  79. .PP
  80. \&\fBASN1_add_oid_module()\fR adds just the ASN1 OBJECT module.
  81. .PP
  82. \&\fBENGINE_add_conf_module()\fR adds just the ENGINE configuration module.
  83. .SH NOTES
  84. .IX Header "NOTES"
  85. If the simple configuration function \fBOPENSSL_config()\fR is called then
  86. \&\fBOPENSSL_load_builtin_modules()\fR is called automatically.
  87. .PP
  88. Applications which use the configuration functions directly will need to
  89. call \fBOPENSSL_load_builtin_modules()\fR themselves \fIbefore\fR any other
  90. configuration code.
  91. .PP
  92. Applications should call \fBOPENSSL_load_builtin_modules()\fR to load all
  93. configuration modules instead of adding modules selectively: otherwise
  94. functionality may be missing from the application if an when new
  95. modules are added.
  96. .SH "RETURN VALUES"
  97. .IX Header "RETURN VALUES"
  98. None of the functions return a value.
  99. .SH "SEE ALSO"
  100. .IX Header "SEE ALSO"
  101. \&\fBconfig\fR\|(5), \fBOPENSSL_config\fR\|(3)
  102. .SH HISTORY
  103. .IX Header "HISTORY"
  104. \&\fBENGINE_add_conf_module()\fR was deprecated in OpenSSL 3.0.
  105. .SH COPYRIGHT
  106. .IX Header "COPYRIGHT"
  107. Copyright 2004\-2020 The OpenSSL Project Authors. All Rights Reserved.
  108. .PP
  109. Licensed under the Apache License 2.0 (the "License"). You may not use
  110. this file except in compliance with the License. You can obtain a copy
  111. in the file LICENSE in the source distribution or at
  112. <https://www.openssl.org/source/license.html>.