Debian Codegraph @

upstream/debian-unstable/man3/PKCS12_add1_attr_by_NID.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
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 "PKCS12_ADD1_ATTR_BY_NID 3SSL"
58 .TH PKCS12_ADD1_ATTR_BY_NID 3SSL 2026-04-07 3.6.2 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 PKCS12_add1_attr_by_NID, PKCS12_add1_attr_by_txt \- Add an attribute to a PKCS#12
65 safeBag structure
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/pkcs12.h>
70 \&
71 \& int PKCS12_add1_attr_by_NID(PKCS12_SAFEBAG *bag, int nid, int type,
72 \& const unsigned char *bytes, int len);
73 \& int PKCS12_add1_attr_by_txt(PKCS12_SAFEBAG *bag, const char *attrname, int type,
74 \& const unsigned char *bytes, int len);
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 These functions add a PKCS#12 Attribute to the Attribute Set of the \fBbag\fR.
79 .PP
80 \&\fBPKCS12_add1_attr_by_NID()\fR adds an attribute of type \fBnid\fR with a value of ASN1
81 type \fBtype\fR constructed using \fBlen\fR bytes from \fBbytes\fR.
82 .PP
83 \&\fBPKCS12_add1_attr_by_txt()\fR adds an attribute of type \fBattrname\fR with a value of
84 ASN1 type \fBtype\fR constructed using \fBlen\fR bytes from \fBbytes\fR.
85 .SH NOTES
86 .IX Header "NOTES"
87 These functions do not check whether an existing attribute of the same type is
88 present. There can be multiple attributes with the same type assigned to a
89 safeBag.
90 .PP
91 Both functions were added in OpenSSL 3.0.
92 .SH "RETURN VALUES"
93 .IX Header "RETURN VALUES"
94 A return value of 1 indicates success, 0 indicates failure.
95 .SH "SEE ALSO"
96 .IX Header "SEE ALSO"
97 \&\fBPKCS12_create\fR\|(3)
98 .SH COPYRIGHT
99 .IX Header "COPYRIGHT"
100 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
101 .PP
102 Licensed under the Apache License 2.0 (the "License"). You may not use
103 this file except in compliance with the License. You can obtain a copy
104 in the file LICENSE in the source distribution or at
105 <https://www.openssl.org/source/license.html>.