x509.7ossl 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  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 "X509 7ossl"
  58. .TH X509 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. x509 \- X.509 certificate handling
  65. .SH SYNOPSIS
  66. .IX Header "SYNOPSIS"
  67. .Vb 1
  68. \& #include <openssl/x509.h>
  69. .Ve
  70. .SH DESCRIPTION
  71. .IX Header "DESCRIPTION"
  72. An X.509 certificate is a structured grouping of information about
  73. an individual, a device, or anything one can imagine. An X.509 CRL
  74. (certificate revocation list) is a tool to help determine if a
  75. certificate is still valid. The exact definition of those can be
  76. found in the X.509 document from ITU-T, or in RFC3280 from PKIX.
  77. In OpenSSL, the type X509 is used to express such a certificate, and
  78. the type X509_CRL is used to express a CRL.
  79. .PP
  80. A related structure is a certificate request, defined in PKCS#10 from
  81. RSA Security, Inc, also reflected in RFC2896. In OpenSSL, the type
  82. X509_REQ is used to express such a certificate request.
  83. .PP
  84. To handle some complex parts of a certificate, there are the types
  85. X509_NAME (to express a certificate name), X509_ATTRIBUTE (to express
  86. a certificate attribute), X509_EXTENSION (to express a certificate
  87. extension) and a few more.
  88. .PP
  89. Finally, there's the supertype X509_INFO, which can contain a CRL, a
  90. certificate and a corresponding private key.
  91. .PP
  92. \&\fBX509_\fR\fIXXX\fR, \fBd2i_X509_\fR\fIXXX\fR, and \fBi2d_X509_\fR\fIXXX\fR functions
  93. handle X.509 certificates, with some exceptions, shown below.
  94. .PP
  95. \&\fBX509_CRL_\fR\fIXXX\fR, \fBd2i_X509_CRL_\fR\fIXXX\fR, and \fBi2d_X509_CRL_\fR\fIXXX\fR
  96. functions handle X.509 CRLs.
  97. .PP
  98. \&\fBX509_REQ_\fR\fIXXX\fR, \fBd2i_X509_REQ_\fR\fIXXX\fR, and \fBi2d_X509_REQ_\fR\fIXXX\fR
  99. functions handle PKCS#10 certificate requests.
  100. .PP
  101. \&\fBX509_NAME_\fR\fIXXX\fR functions handle certificate names.
  102. .PP
  103. \&\fBX509_ATTRIBUTE_\fR\fIXXX\fR functions handle certificate attributes.
  104. .PP
  105. \&\fBX509_EXTENSION_\fR\fIXXX\fR functions handle certificate extensions.
  106. .SH "SEE ALSO"
  107. .IX Header "SEE ALSO"
  108. \&\fBX509_NAME_ENTRY_get_object\fR\|(3),
  109. \&\fBX509_NAME_add_entry_by_txt\fR\|(3),
  110. \&\fBX509_NAME_add_entry_by_NID\fR\|(3),
  111. \&\fBX509_NAME_print_ex\fR\|(3),
  112. \&\fBX509_NAME_new\fR\|(3),
  113. \&\fBPEM_X509_INFO_read\fR\|(3),
  114. \&\fBd2i_X509\fR\|(3),
  115. \&\fBd2i_X509_ALGOR\fR\|(3),
  116. \&\fBd2i_X509_CRL\fR\|(3),
  117. \&\fBd2i_X509_NAME\fR\|(3),
  118. \&\fBd2i_X509_REQ\fR\|(3),
  119. \&\fBd2i_X509_SIG\fR\|(3),
  120. \&\fBcrypto\fR\|(7)
  121. .SH COPYRIGHT
  122. .IX Header "COPYRIGHT"
  123. Copyright 2003\-2021 The OpenSSL Project Authors. All Rights Reserved.
  124. .PP
  125. Licensed under the Apache License 2.0 (the "License"). You may not use
  126. this file except in compliance with the License. You can obtain a copy
  127. in the file LICENSE in the source distribution or at
  128. <https://www.openssl.org/source/license.html>.