X509_get0_uids.3ossl 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  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_GET0_UIDS 3ossl"
  58. .TH X509_GET0_UIDS 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. X509_get0_uids, X509_ACERT_get0_issuerUID
  65. \&\- get certificate and attribute certificate unique identifiers
  66. .SH SYNOPSIS
  67. .IX Header "SYNOPSIS"
  68. .Vb 1
  69. \& #include <openssl/x509.h>
  70. \&
  71. \& void X509_get0_uids(const X509 *x, const ASN1_BIT_STRING **piuid,
  72. \& const ASN1_BIT_STRING **psuid);
  73. \&
  74. \& #include <openssl/x509_acert.h>
  75. \&
  76. \& ASN1_BIT_STRING *X509_ACERT_get0_issuerUID(X509_ACERT *x);
  77. \&=head1 DESCRIPTION
  78. .Ve
  79. .PP
  80. \&\fBX509_get0_uids()\fR sets \fB*piuid\fR and \fB*psuid\fR to the issuer and subject unique
  81. identifiers of certificate \fBx\fR or NULL if the fields are not present.
  82. .PP
  83. \&\fBX509_ACERT_get0_issuerUID()\fR returns the issuer unique identifier of the
  84. attribute certificate \fBx\fR or NULL if the field is not present.
  85. .SH NOTES
  86. .IX Header "NOTES"
  87. The issuer and subject unique identifier fields are very rarely encountered in
  88. practice outside test cases.
  89. .SH "RETURN VALUES"
  90. .IX Header "RETURN VALUES"
  91. \&\fBX509_get0_uids()\fR does not return a value.
  92. .PP
  93. \&\fBX509_ACERT_get0_issuerUID()\fR returns a unique identifier on success or NULL
  94. on failure.
  95. .SH "SEE ALSO"
  96. .IX Header "SEE ALSO"
  97. \&\fBd2i_X509\fR\|(3),
  98. \&\fBERR_get_error\fR\|(3),
  99. \&\fBX509_CRL_get0_by_serial\fR\|(3),
  100. \&\fBX509_get0_signature\fR\|(3),
  101. \&\fBX509_get_ext_d2i\fR\|(3),
  102. \&\fBX509_get_extension_flags\fR\|(3),
  103. \&\fBX509_get_pubkey\fR\|(3),
  104. \&\fBX509_get_subject_name\fR\|(3),
  105. \&\fBX509_get_version\fR\|(3),
  106. \&\fBX509_NAME_add_entry_by_txt\fR\|(3),
  107. \&\fBX509_NAME_ENTRY_get_object\fR\|(3),
  108. \&\fBX509_NAME_get_index_by_NID\fR\|(3),
  109. \&\fBX509_NAME_print_ex\fR\|(3),
  110. \&\fBX509_new\fR\|(3),
  111. \&\fBX509_sign\fR\|(3),
  112. \&\fBX509V3_get_d2i\fR\|(3),
  113. \&\fBX509_verify_cert\fR\|(3)
  114. .SH HISTORY
  115. .IX Header "HISTORY"
  116. \&\fBX509_get0_uids()\fR was added in OpenSSL 1.1.0.
  117. .PP
  118. \&\fBX509_ACERT_get0_issuerUID()\fR was added in OpenSSL 3.4.
  119. .SH COPYRIGHT
  120. .IX Header "COPYRIGHT"
  121. Copyright 2015\-2024 The OpenSSL Project Authors. All Rights Reserved.
  122. .PP
  123. Licensed under the Apache License 2.0 (the "License"). You may not use
  124. this file except in compliance with the License. You can obtain a copy
  125. in the file LICENSE in the source distribution or at
  126. <https://www.openssl.org/source/license.html>.