X509_ACERT_add1_attr.3ossl 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  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_ACERT_ADD1_ATTR 3ossl"
  58. .TH X509_ACERT_ADD1_ATTR 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_ACERT_add1_attr,
  65. X509_ACERT_add1_attr_by_NID,
  66. X509_ACERT_add1_attr_by_OBJ,
  67. X509_ACERT_add1_attr_by_txt,
  68. X509_ACERT_delete_attr
  69. \&\- X509_ACERT attribute functions
  70. .SH SYNOPSIS
  71. .IX Header "SYNOPSIS"
  72. .Vb 1
  73. \& #include <openssl/x509_acert.h>
  74. \&
  75. \& int X509_ACERT_add1_attr(X509_ACERT *x, X509_ATTRIBUTE *attr);
  76. \& int X509_ACERT_add1_attr_by_NID(X509_ACERT *x, int nid, int type,
  77. \& const void *bytes, int len);
  78. \& int X509_ACERT_add1_attr_by_OBJ(X509_ACERT *x, const ASN1_OBJECT *obj,
  79. \& int type, const void *bytes, int len);
  80. \& int X509_ACERT_add1_attr_by_txt(X509_ACERT *x, const char *attrname, int type,
  81. \& const unsigned char *bytes, int len);
  82. \& X509_ATTRIBUTE *X509_ACERT_delete_attr(X509_ACERT *x, int loc);
  83. .Ve
  84. .SH DESCRIPTION
  85. .IX Header "DESCRIPTION"
  86. \&\fBX509_ACERT_add1_attr()\fR adds a constructed X509_ATTRIBUTE \fBattr\fR to the
  87. existing X509_ACERT structure \fBx\fR.
  88. .PP
  89. \&\fBX509_ACERT_add1_attr_by_NID()\fR and \fBX509_ACERT_add1_attr_by_OBJ()\fR
  90. add an attribute of type \fInid\fR or \fIobj\fR with a value of ASN1
  91. type \fItype\fR constructed using \fIlen\fR bytes from \fIbytes\fR.
  92. .PP
  93. \&\fBX509_ACERT_add1_attr_by_txt()\fR adds an attribute of type \fIattrname\fR with a value of
  94. ASN1 type \fItype\fR constructed using \fIlen\fR bytes from \fIbytes\fR.
  95. .PP
  96. \&\fBX509_ACERT_delete_attr()\fR will delete the \fIloc\fRth attribute from \fIx\fR and
  97. return a pointer to it or NULL if there are fewer than \fIloc\fR attributes
  98. contained in \fIx\fR.
  99. .SH "RETURN VALUES"
  100. .IX Header "RETURN VALUES"
  101. \&\fBX509_ACERT_add1_attr()\fR, \fBX509_ACERT_add1_attr_by_NID()\fR, and
  102. \&\fBX509_ACERT_add1_attr_by_OBJ()\fR return 1 for success and 0 for failure.
  103. .PP
  104. \&\fBX509_ACERT_delete_attr()\fR returns a \fBX509_ATTRIBUTE\fR pointer on
  105. success or NULL on failure.
  106. .SH "SEE ALSO"
  107. .IX Header "SEE ALSO"
  108. \&\fBX509_ACERT_get_attr_count\fR\|(3)
  109. .SH HISTORY
  110. .IX Header "HISTORY"
  111. \&\fBX509_ACERT_add1_attr()\fR, \fBX509_ACERT_add1_attr_by_NID()\fR, \fBX509_ACERT_add1_attr_by_OBJ()\fR,
  112. \&\fBX509_ACERT_add1_attr_by_txt()\fR and \fBX509_ACERT_delete_attr()\fR were added in OpenSSL 3.4.
  113. .SH COPYRIGHT
  114. .IX Header "COPYRIGHT"
  115. Copyright 2023\-2024 The OpenSSL Project Authors. All Rights Reserved.
  116. .PP
  117. Licensed under the Apache License 2.0 (the "License"). You may not use
  118. this file except in compliance with the License. You can obtain a copy
  119. in the file LICENSE in the source distribution or at
  120. <https://www.openssl.org/source/license.html>.