DSA_do_sign.3ossl 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  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_DO_SIGN 3ossl"
  58. .TH DSA_DO_SIGN 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_do_sign, DSA_do_verify \- raw DSA signature operations
  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_SIG *DSA_do_sign(const unsigned char *dgst, int dlen, DSA *dsa);
  77. \&
  78. \& int DSA_do_verify(const unsigned char *dgst, int dgst_len,
  79. \& DSA_SIG *sig, DSA *dsa);
  80. .Ve
  81. .SH DESCRIPTION
  82. .IX Header "DESCRIPTION"
  83. All of the functions described on this page are deprecated.
  84. Applications should instead use \fBEVP_PKEY_sign_init\fR\|(3), \fBEVP_PKEY_sign\fR\|(3),
  85. \&\fBEVP_PKEY_verify_init\fR\|(3) and \fBEVP_PKEY_verify\fR\|(3).
  86. .PP
  87. \&\fBDSA_do_sign()\fR computes a digital signature on the \fBlen\fR byte message
  88. digest \fBdgst\fR using the private key \fBdsa\fR and returns it in a
  89. newly allocated \fBDSA_SIG\fR structure.
  90. .PP
  91. \&\fBDSA_sign_setup\fR\|(3) may be used to precompute part
  92. of the signing operation in case signature generation is
  93. time-critical.
  94. .PP
  95. \&\fBDSA_do_verify()\fR verifies that the signature \fBsig\fR matches a given
  96. message digest \fBdgst\fR of size \fBlen\fR. \fBdsa\fR is the signer's public
  97. key.
  98. .SH "RETURN VALUES"
  99. .IX Header "RETURN VALUES"
  100. \&\fBDSA_do_sign()\fR returns the signature, NULL on error. \fBDSA_do_verify()\fR
  101. returns 1 for a valid signature, 0 for an incorrect signature and \-1
  102. on error. The error codes can be obtained by
  103. \&\fBERR_get_error\fR\|(3).
  104. .SH "SEE ALSO"
  105. .IX Header "SEE ALSO"
  106. \&\fBDSA_new\fR\|(3), \fBERR_get_error\fR\|(3), \fBRAND_bytes\fR\|(3),
  107. \&\fBDSA_SIG_new\fR\|(3),
  108. \&\fBDSA_sign\fR\|(3)
  109. .SH HISTORY
  110. .IX Header "HISTORY"
  111. All of these functions were deprecated in OpenSSL 3.0.
  112. .SH COPYRIGHT
  113. .IX Header "COPYRIGHT"
  114. Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
  115. .PP
  116. Licensed under the Apache License 2.0 (the "License"). You may not use
  117. this file except in compliance with the License. You can obtain a copy
  118. in the file LICENSE in the source distribution or at
  119. <https://www.openssl.org/source/license.html>.