diff options
author | schwarze <> | 2016-12-22 16:05:22 +0000 |
---|---|---|
committer | schwarze <> | 2016-12-22 16:05:22 +0000 |
commit | c0effee5bc1f5cdc6f4668d160e173746cbbf7de (patch) | |
tree | a214bad3e268c7c3de500b995d829ef4803ca1a0 /src/lib/libcrypto/man/PKCS12_SAFEBAG_new.3 | |
parent | 38633ba03a5091d9b9b3db1ecffb4f92a0043e1a (diff) | |
download | openbsd-c0effee5bc1f5cdc6f4668d160e173746cbbf7de.tar.gz openbsd-c0effee5bc1f5cdc6f4668d160e173746cbbf7de.tar.bz2 openbsd-c0effee5bc1f5cdc6f4668d160e173746cbbf7de.zip |
Write new manual pages PKCS12_new(3) and PKCS12_SAFEBAG_new(3) from
scratch. All these functions are listed in <openssl/pkcs12.h> and
in OpenSSL doc/man3/X509_dup.pod. As usual, OpenSSL documentation
specifies the wrong header file.
Note that PKCS#12 documentation is still scanty at best.
For example, out of 19 public functions handling PKCS12 objects,
five are now documented, and this commit documents the first two
out of 24 public functions handling PKCS12_SAFEBAG objects.
Diffstat (limited to 'src/lib/libcrypto/man/PKCS12_SAFEBAG_new.3')
-rw-r--r-- | src/lib/libcrypto/man/PKCS12_SAFEBAG_new.3 | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/PKCS12_SAFEBAG_new.3 b/src/lib/libcrypto/man/PKCS12_SAFEBAG_new.3 new file mode 100644 index 0000000000..8cb6835194 --- /dev/null +++ b/src/lib/libcrypto/man/PKCS12_SAFEBAG_new.3 | |||
@@ -0,0 +1,92 @@ | |||
1 | .\" $OpenBSD: PKCS12_SAFEBAG_new.3,v 1.1 2016/12/22 16:05:22 schwarze Exp $ | ||
2 | .\" | ||
3 | .\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org> | ||
4 | .\" | ||
5 | .\" Permission to use, copy, modify, and distribute this software for any | ||
6 | .\" purpose with or without fee is hereby granted, provided that the above | ||
7 | .\" copyright notice and this permission notice appear in all copies. | ||
8 | .\" | ||
9 | .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | ||
10 | .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | ||
11 | .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | ||
12 | .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | ||
13 | .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | ||
14 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | ||
15 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||
16 | .\" | ||
17 | .Dd $Mdocdate: December 22 2016 $ | ||
18 | .Dt PKCS12_SAFEBAG_NEW 3 | ||
19 | .Os | ||
20 | .Sh NAME | ||
21 | .Nm PKCS12_SAFEBAG_new , | ||
22 | .Nm PKCS12_SAFEBAG_free , | ||
23 | .Nm PKCS12_BAGS_new , | ||
24 | .Nm PKCS12_BAGS_free | ||
25 | .Nd PKCS#12 container for one piece of information | ||
26 | .Sh SYNOPSIS | ||
27 | .In openssl/pkcs12.h | ||
28 | .Ft PKCS12_SAFEBAG * | ||
29 | .Fn PKCS12_SAFEBAG_new void | ||
30 | .Ft void | ||
31 | .Fn PKCS12_SAFEBAG_free "PKCS12_SAFEBAG *safebag" | ||
32 | .Ft PKCS12_BAGS * | ||
33 | .Fn PKCS12_BAGS_new void | ||
34 | .Ft void | ||
35 | .Fn PKCS12_BAGS_free "PKCS12_BAGS *bag" | ||
36 | .Sh DESCRIPTION | ||
37 | .Fn PKCS12_SAFEBAG_new | ||
38 | allocates and initializes an empty | ||
39 | .Vt PKCS12_SAFEBAG | ||
40 | object, representing an ASN.1 SafeBag structure | ||
41 | defined in RFC 7292 section 4.2. | ||
42 | It can hold a pointer to a | ||
43 | .Vt PKCS12_BAGS | ||
44 | object together with a type identifier and optional attributes. | ||
45 | .Fn PKCS12_SAFEBAG_free | ||
46 | frees | ||
47 | .Fa safebag . | ||
48 | .Pp | ||
49 | .Fn PKCS12_BAGS_new | ||
50 | allocates and initializes an empty | ||
51 | .Vt PKCS12_BAGS | ||
52 | object, representing the bagValue field of an ASN.1 SafeBag structure. | ||
53 | It is used in | ||
54 | .Vt PKCS12_SAFEBAG | ||
55 | and can hold a DER-encoded X.509 certificate, | ||
56 | a base64-encoded SDSI certificate, | ||
57 | a DER-encoded X.509 CRL, | ||
58 | or other user-defined information. | ||
59 | .Pp | ||
60 | If an instance of | ||
61 | .Vt PKCS12_SAFEBAG | ||
62 | contains | ||
63 | .Vt PKCS8_PRIV_KEY_INFO , | ||
64 | .Vt X509_SIG , | ||
65 | or nested | ||
66 | .Vt PKCS12_SAFEBAG | ||
67 | objects, the respective pointers are stored directly in the | ||
68 | .Vt PKCS12_SAFEBAG | ||
69 | object rather than in the contained | ||
70 | .Vt PKCS12_BAGS | ||
71 | object as required by RFC 7292. | ||
72 | .Sh RETURN VALUES | ||
73 | .Fn PKCS12_SAFEBAG_new | ||
74 | and | ||
75 | .Fn PKCS12_BAGS_new | ||
76 | return the new | ||
77 | .Vt PKCS12_SAFEBAG | ||
78 | or | ||
79 | .Vt PKCS12_BAGS | ||
80 | object, respectively, or | ||
81 | .Dv NULL | ||
82 | if an error occurs. | ||
83 | .Sh SEE ALSO | ||
84 | .Xr PKCS12_new 3 , | ||
85 | .Xr PKCS8_PRIV_KEY_INFO_new 3 , | ||
86 | .Xr X509_ATTRIBUTE_new 3 , | ||
87 | .Xr X509_CRL_new 3 , | ||
88 | .Xr X509_new 3 , | ||
89 | .Xr X509_SIG_new 3 | ||
90 | .Sh STANDARDS | ||
91 | RFC 7292: PKCS #12: Personal Information Exchange Syntax, | ||
92 | section 4.2: The SafeBag Type | ||