diff options
author | schwarze <> | 2016-09-05 10:43:42 +0000 |
---|---|---|
committer | schwarze <> | 2016-09-05 10:43:42 +0000 |
commit | 8bc3352bee3f743c2b8f9fd9c743fca60706336c (patch) | |
tree | 8ddbb216e39c4571145c2d202a95596f977cdfe0 /src/lib/libcrypto/man/CMS_get0_SignerInfos.3 | |
parent | de12fbc1ebd942810e5ca1e55d7a6e213023f318 (diff) | |
download | openbsd-8bc3352bee3f743c2b8f9fd9c743fca60706336c.tar.gz openbsd-8bc3352bee3f743c2b8f9fd9c743fca60706336c.tar.bz2 openbsd-8bc3352bee3f743c2b8f9fd9c743fca60706336c.zip |
remove CMS manuals; beck@ agress with the general idea
Diffstat (limited to '')
-rw-r--r-- | src/lib/libcrypto/man/CMS_get0_SignerInfos.3 | 119 |
1 files changed, 0 insertions, 119 deletions
diff --git a/src/lib/libcrypto/man/CMS_get0_SignerInfos.3 b/src/lib/libcrypto/man/CMS_get0_SignerInfos.3 deleted file mode 100644 index 99aab48193..0000000000 --- a/src/lib/libcrypto/man/CMS_get0_SignerInfos.3 +++ /dev/null | |||
@@ -1,119 +0,0 @@ | |||
1 | .Dd $Mdocdate: November 11 2015 $ | ||
2 | .Dt CMS_GET0_SIGNERINFOS 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm CMS_get0_SignerInfos , | ||
6 | .Nm CMS_SignerInfo_get0_signer_id , | ||
7 | .Nm CMS_SignerInfo_cert_cmp , | ||
8 | .Nm CMS_set1_signer_certs | ||
9 | .Nd CMS signedData signer functions | ||
10 | .Sh SYNOPSIS | ||
11 | .In openssl/cms.h | ||
12 | .Ft STACK_OF(CMS_SignerInfo) * | ||
13 | .Fo CMS_get0_SignerInfos | ||
14 | .Fa "CMS_ContentInfo *cms" | ||
15 | .Fc | ||
16 | .Ft int | ||
17 | .Fo CMS_SignerInfo_get0_signer_id | ||
18 | .Fa "CMS_SignerInfo *si" | ||
19 | .Fa "ASN1_OCTET_STRING **keyid" | ||
20 | .Fa "X509_NAME **issuer" | ||
21 | .Fa "ASN1_INTEGER **sno" | ||
22 | .Fc | ||
23 | .Ft int | ||
24 | .Fo CMS_SignerInfo_cert_cmp | ||
25 | .Fa "CMS_SignerInfo *si" | ||
26 | .Fa "X509 *cert" | ||
27 | .Fc | ||
28 | .Ft void | ||
29 | .Fo CMS_SignerInfo_set1_signer_cert | ||
30 | .Fa "CMS_SignerInfo *si" | ||
31 | .Fa "X509 *signer" | ||
32 | .Fc | ||
33 | .Sh DESCRIPTION | ||
34 | The function | ||
35 | .Fn CMS_get0_SignerInfos | ||
36 | returns all the | ||
37 | .Vt CMS_SignerInfo | ||
38 | structures associated with a CMS signedData structure. | ||
39 | .Pp | ||
40 | .Fn CMS_SignerInfo_get0_signer_id | ||
41 | retrieves the certificate signer identifier associated with a specific | ||
42 | .Vt CMS_SignerInfo | ||
43 | structure | ||
44 | .Fa si . | ||
45 | Either the keyidentifier will be set in | ||
46 | .Fa keyid | ||
47 | or | ||
48 | .Em both | ||
49 | issuer name and serial number in | ||
50 | .Fa issuer | ||
51 | and | ||
52 | .Fa sno . | ||
53 | .Pp | ||
54 | .Fn CMS_SignerInfo_cert_cmp | ||
55 | compares the certificate | ||
56 | .Fa cert | ||
57 | against the signer identifier | ||
58 | .Fa si . | ||
59 | It returns zero if the comparison is successful and non zero if not. | ||
60 | .Pp | ||
61 | .Fn CMS_SignerInfo_set1_signer_cert | ||
62 | sets the signers certificate of | ||
63 | .Fa si | ||
64 | to | ||
65 | .Fa signer . | ||
66 | .Sh NOTES | ||
67 | The main purpose of these functions is to enable an application to | ||
68 | lookup signers certificates using any appropriate technique when the | ||
69 | simpler method of | ||
70 | .Xr CMS_verify 3 | ||
71 | is not appropriate. | ||
72 | .Pp | ||
73 | In typical usage and application will retrieve all | ||
74 | .Vt CMS_SignerInfo | ||
75 | structures using | ||
76 | .Fn CMS_get0_SignerInfo | ||
77 | and retrieve the identifier information using CMS. | ||
78 | It will then obtain the signer certificate by some unspecified means | ||
79 | (or return and error if it cannot be found) and set it using | ||
80 | .Fn CMS_SignerInfo_set1_signer_cert . | ||
81 | .Pp | ||
82 | Once all signer certificates have been set, | ||
83 | .Xr CMS_verify 3 | ||
84 | can be used. | ||
85 | .Pp | ||
86 | Although | ||
87 | .Fn CMS_get0_SignerInfos | ||
88 | can return | ||
89 | .Dv NULL | ||
90 | if an error occur | ||
91 | .Em or | ||
92 | if there are no signers, this is not a problem in practice because the | ||
93 | only error which can occur is if the | ||
94 | .Fa cms | ||
95 | structure is not of type signedData due to application error. | ||
96 | .Sh RETURN VALUES | ||
97 | .Fn CMS_get0_SignerInfos | ||
98 | returns all | ||
99 | .Vt CMS_SignerInfo | ||
100 | structures, or | ||
101 | .Dv NULL | ||
102 | if there are no signers or an error occurs. | ||
103 | .Pp | ||
104 | .Fn CMS_SignerInfo_get0_signer_id | ||
105 | returns 1 for success and 0 for failure. | ||
106 | .Pp | ||
107 | .Fn CMS_SignerInfo_cert_cmp | ||
108 | returns 0 for a successful comparison and non zero otherwise. | ||
109 | .Pp | ||
110 | .Fn CMS_SignerInfo_set1_signer_cert | ||
111 | does not return a value. | ||
112 | .Pp | ||
113 | Any error can be obtained from | ||
114 | .Xr ERR_get_error 3 . | ||
115 | .Sh SEE ALSO | ||
116 | .Xr CMS_verify 3 , | ||
117 | .Xr ERR_get_error 3 | ||
118 | .Sh HISTORY | ||
119 | These functions were first was added to OpenSSL 0.9.8. | ||