ne_ssl_set_protovers.3 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. '\" t
  2. .\" Title: ne_ssl_set_protovers
  3. .\" Author:
  4. .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
  5. .\" Date: 15 April 2025
  6. .\" Manual: neon API reference
  7. .\" Source: neon 0.34.2
  8. .\" Language: English
  9. .\"
  10. .TH "NE_SSL_SET_PROTOVERS" "3" "15 April 2025" "neon 0.34.2" "neon API reference"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. ne_ssl_set_protovers \- set session SSL/TLS minimum or maximum protocol version
  32. .SH "SYNOPSIS"
  33. .sp
  34. .ft B
  35. .nf
  36. #include <ne_session\&.h>
  37. .fi
  38. .ft
  39. .HP \w'int\ ne_ssl_set_protovers('u
  40. .BI "int ne_ssl_set_protovers(ne_session\ *" "sess" ", enum\ ne_ssl_protocol\ " "min" ", enum\ ne_ssl_protocol\ " "max" ");"
  41. .SH "DESCRIPTION"
  42. .PP
  43. The
  44. \fBne_ssl_set_protovers\fR
  45. function sets the minimum and/or maximum SSL/TLS version\&. Either minimum and/or maximum may be specified as
  46. \fBNE_SSL_PROTO_UNSPEC\fR, in which case no limit is imposed\&.
  47. .SH "RETURN VALUE"
  48. .PP
  49. The
  50. \fBne_ssl_set_protovers\fR
  51. function returns zero on success or non\-zero on error\&. Errors include an invalid range (minimum above maximum), or if the protocol version is not supported by the SSL/TLS toolkit in use, or if SSL/TLS is not in use for the session\&.
  52. .SH "HISTORY"
  53. .PP
  54. \fBne_ssl_set_protovers\fR
  55. is available in neon 0\&.34\&.0 and later\&.
  56. .SH "SEE ALSO"
  57. .PP
  58. ne_ssl_proto_name,
  59. ne_session_create\&.
  60. .SH "COPYRIGHT"
  61. .br
  62. Copyright \(co 2001-2024 Joe Orton
  63. .br