DSA_new.3ossl 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  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 "DSA_NEW 3ossl"
  58. .TH DSA_NEW 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. DSA_new, DSA_free \- allocate and free DSA objects
  65. .SH SYNOPSIS
  66. .IX Header "SYNOPSIS"
  67. .Vb 1
  68. \& #include <openssl/dsa.h>
  69. .Ve
  70. .PP
  71. The following functions have been deprecated since OpenSSL 3.0, and can be
  72. hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
  73. see \fBopenssl_user_macros\fR\|(7):
  74. .PP
  75. .Vb 1
  76. \& DSA* DSA_new(void);
  77. \&
  78. \& void DSA_free(DSA *dsa);
  79. .Ve
  80. .SH DESCRIPTION
  81. .IX Header "DESCRIPTION"
  82. All of the functions described on this page are deprecated.
  83. Applications should instead use \fBEVP_PKEY_new\fR\|(3) and \fBEVP_PKEY_free\fR\|(3).
  84. .PP
  85. \&\fBDSA_new()\fR allocates and initializes a \fBDSA\fR structure. It is equivalent to
  86. calling DSA_new_method(NULL).
  87. .PP
  88. \&\fBDSA_free()\fR frees the \fBDSA\fR structure and its components. The values are
  89. erased before the memory is returned to the system.
  90. If \fBdsa\fR is NULL nothing is done.
  91. .SH "RETURN VALUES"
  92. .IX Header "RETURN VALUES"
  93. If the allocation fails, \fBDSA_new()\fR returns \fBNULL\fR and sets an error
  94. code that can be obtained by
  95. \&\fBERR_get_error\fR\|(3). Otherwise it returns a pointer
  96. to the newly allocated structure.
  97. .PP
  98. \&\fBDSA_free()\fR returns no value.
  99. .SH "SEE ALSO"
  100. .IX Header "SEE ALSO"
  101. \&\fBEVP_PKEY_new\fR\|(3), \fBEVP_PKEY_free\fR\|(3),
  102. \&\fBDSA_new\fR\|(3), \fBERR_get_error\fR\|(3),
  103. \&\fBDSA_generate_parameters\fR\|(3),
  104. \&\fBDSA_generate_key\fR\|(3)
  105. .SH HISTORY
  106. .IX Header "HISTORY"
  107. All of these functions were deprecated in OpenSSL 3.0.
  108. .SH COPYRIGHT
  109. .IX Header "COPYRIGHT"
  110. Copyright 2000\-2016 The OpenSSL Project Authors. All Rights Reserved.
  111. .PP
  112. Licensed under the Apache License 2.0 (the "License"). You may not use
  113. this file except in compliance with the License. You can obtain a copy
  114. in the file LICENSE in the source distribution or at
  115. <https://www.openssl.org/source/license.html>.