ECPKParameters_print.3ossl 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  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 "ECPKPARAMETERS_PRINT 3ossl"
  58. .TH ECPKPARAMETERS_PRINT 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. ECPKParameters_print, ECPKParameters_print_fp \- Functions for decoding and
  65. encoding ASN1 representations of elliptic curve entities
  66. .SH SYNOPSIS
  67. .IX Header "SYNOPSIS"
  68. .Vb 1
  69. \& #include <openssl/ec.h>
  70. .Ve
  71. .PP
  72. The following functions have been deprecated since OpenSSL 3.0, and can be
  73. hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
  74. see \fBopenssl_user_macros\fR\|(7):
  75. .PP
  76. .Vb 2
  77. \& int ECPKParameters_print(BIO *bp, const EC_GROUP *x, int off);
  78. \& int ECPKParameters_print_fp(FILE *fp, const EC_GROUP *x, int off);
  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_print_params\fR\|(3)
  84. .PP
  85. The ECPKParameters represent the public parameters for an
  86. \&\fBEC_GROUP\fR structure, which represents a curve.
  87. .PP
  88. The \fBECPKParameters_print()\fR and \fBECPKParameters_print_fp()\fR functions print
  89. a human-readable output of the public parameters of the EC_GROUP to \fBbp\fR
  90. or \fBfp\fR. The output lines are indented by \fBoff\fR spaces.
  91. .SH "RETURN VALUES"
  92. .IX Header "RETURN VALUES"
  93. \&\fBECPKParameters_print()\fR and \fBECPKParameters_print_fp()\fR
  94. return 1 for success and 0 if an error occurs.
  95. .SH "SEE ALSO"
  96. .IX Header "SEE ALSO"
  97. \&\fBcrypto\fR\|(7), \fBEC_GROUP_new\fR\|(3), \fBEC_GROUP_copy\fR\|(3),
  98. \&\fBEC_POINT_new\fR\|(3), \fBEC_POINT_add\fR\|(3), \fBEC_KEY_new\fR\|(3),
  99. \&\fBEC_GFp_simple_method\fR\|(3),
  100. .SH HISTORY
  101. .IX Header "HISTORY"
  102. All of these functions were deprecated in OpenSSL 3.0.
  103. .SH COPYRIGHT
  104. .IX Header "COPYRIGHT"
  105. Copyright 2013\-2021 The OpenSSL Project Authors. All Rights Reserved.
  106. .PP
  107. Licensed under the Apache License 2.0 (the "License"). You may not use
  108. this file except in compliance with the License. You can obtain a copy
  109. in the file LICENSE in the source distribution or at
  110. <https://www.openssl.org/source/license.html>.