SSL_library_init.3ossl 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  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 "SSL_LIBRARY_INIT 3ossl"
  58. .TH SSL_LIBRARY_INIT 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. SSL_library_init, OpenSSL_add_ssl_algorithms
  65. \&\- initialize SSL library by registering algorithms
  66. .SH SYNOPSIS
  67. .IX Header "SYNOPSIS"
  68. .Vb 1
  69. \& #include <openssl/ssl.h>
  70. \&
  71. \& int SSL_library_init(void);
  72. \&
  73. \& int OpenSSL_add_ssl_algorithms(void);
  74. .Ve
  75. .SH DESCRIPTION
  76. .IX Header "DESCRIPTION"
  77. \&\fBSSL_library_init()\fR registers the available SSL/TLS ciphers and digests.
  78. .PP
  79. \&\fBOpenSSL_add_ssl_algorithms()\fR is a synonym for \fBSSL_library_init()\fR and is
  80. implemented as a macro.
  81. .SH NOTES
  82. .IX Header "NOTES"
  83. \&\fBSSL_library_init()\fR must be called before any other action takes place.
  84. \&\fBSSL_library_init()\fR is not reentrant.
  85. .SH WARNINGS
  86. .IX Header "WARNINGS"
  87. \&\fBSSL_library_init()\fR adds ciphers and digests used directly and indirectly by
  88. SSL/TLS.
  89. .SH "RETURN VALUES"
  90. .IX Header "RETURN VALUES"
  91. \&\fBSSL_library_init()\fR always returns "1", so it is safe to discard the return
  92. value.
  93. .SH "SEE ALSO"
  94. .IX Header "SEE ALSO"
  95. \&\fBssl\fR\|(7),
  96. \&\fBRAND_add\fR\|(3)
  97. .SH HISTORY
  98. .IX Header "HISTORY"
  99. The \fBSSL_library_init()\fR and \fBOpenSSL_add_ssl_algorithms()\fR functions were
  100. deprecated in OpenSSL 1.1.0 by \fBOPENSSL_init_ssl()\fR.
  101. .SH COPYRIGHT
  102. .IX Header "COPYRIGHT"
  103. Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
  104. .PP
  105. Licensed under the Apache License 2.0 (the "License"). You may not use
  106. this file except in compliance with the License. You can obtain a copy
  107. in the file LICENSE in the source distribution or at
  108. <https://www.openssl.org/source/license.html>.