openssl-core.h.7ossl 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  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-CORE.H 7ossl"
  58. .TH OPENSSL-CORE.H 7ossl 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/core.h \- OpenSSL Core types
  65. .SH SYNOPSIS
  66. .IX Header "SYNOPSIS"
  67. .Vb 1
  68. \& #include <openssl/core.h>
  69. .Ve
  70. .SH DESCRIPTION
  71. .IX Header "DESCRIPTION"
  72. The \fI<openssl/core.h>\fR header defines a number of public types that
  73. are used to communicate between the OpenSSL libraries and
  74. implementation providers.
  75. These types are designed to minimise the need for intimate knowledge
  76. of internal structures between the OpenSSL libraries and the providers.
  77. .PP
  78. The types are:
  79. .IP \fBOSSL_DISPATCH\fR\|(3) 4
  80. .IX Item "OSSL_DISPATCH"
  81. .PD 0
  82. .IP \fBOSSL_ITEM\fR\|(3) 4
  83. .IX Item "OSSL_ITEM"
  84. .IP \fBOSSL_ALGORITHM\fR\|(3) 4
  85. .IX Item "OSSL_ALGORITHM"
  86. .IP \fBOSSL_PARAM\fR\|(3) 4
  87. .IX Item "OSSL_PARAM"
  88. .IP \fBOSSL_CALLBACK\fR\|(3) 4
  89. .IX Item "OSSL_CALLBACK"
  90. .IP \fBOSSL_PASSPHRASE_CALLBACK\fR\|(3) 4
  91. .IX Item "OSSL_PASSPHRASE_CALLBACK"
  92. .PD
  93. .SH "SEE ALSO"
  94. .IX Header "SEE ALSO"
  95. \&\fBopenssl\-core_dispatch.h\fR\|(7)
  96. .SH HISTORY
  97. .IX Header "HISTORY"
  98. The types described here were added in OpenSSL 3.0.
  99. .SH COPYRIGHT
  100. .IX Header "COPYRIGHT"
  101. Copyright 2019\-2021 The OpenSSL Project Authors. All Rights Reserved.
  102. .PP
  103. Licensed under the Apache License 2.0 (the "License"). You may not use
  104. this file except in compliance with the License. You can obtain a copy
  105. in the file LICENSE in the source distribution or at
  106. <https://www.openssl.org/source/license.html>.