diff options
Diffstat (limited to 'src/lib/libcrypto/man/CMS_add0_cert.3')
| -rw-r--r-- | src/lib/libcrypto/man/CMS_add0_cert.3 | 127 |
1 files changed, 0 insertions, 127 deletions
diff --git a/src/lib/libcrypto/man/CMS_add0_cert.3 b/src/lib/libcrypto/man/CMS_add0_cert.3 deleted file mode 100644 index b02eb06673..0000000000 --- a/src/lib/libcrypto/man/CMS_add0_cert.3 +++ /dev/null | |||
| @@ -1,127 +0,0 @@ | |||
| 1 | .Dd $Mdocdate: November 11 2015 $ | ||
| 2 | .Dt CMS_ADD0_CERT 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm CMS_add0_cert , | ||
| 6 | .Nm CMS_add1_cert , | ||
| 7 | .Nm CMS_get1_certs , | ||
| 8 | .Nm CMS_add0_crl , | ||
| 9 | .Nm CMS_add1_crl , | ||
| 10 | .Nm CMS_get1_crls | ||
| 11 | .Nd CMS certificate and CRL utility functions | ||
| 12 | .Sh SYNOPSIS | ||
| 13 | .In openssl/cms.h | ||
| 14 | .Ft int | ||
| 15 | .Fo CMS_add0_cert | ||
| 16 | .Fa "CMS_ContentInfo *cms" | ||
| 17 | .Fa "X509 *cert" | ||
| 18 | .Fc | ||
| 19 | .Ft int | ||
| 20 | .Fo CMS_add1_cert | ||
| 21 | .Fa "CMS_ContentInfo *cms" | ||
| 22 | .Fa "X509 *cert" | ||
| 23 | .Fc | ||
| 24 | .Ft STACK_OF(X509) * | ||
| 25 | .Fo CMS_get1_certs | ||
| 26 | .Fa "CMS_ContentInfo *cms" | ||
| 27 | .Fc | ||
| 28 | .Ft int | ||
| 29 | .Fo CMS_add0_crl | ||
| 30 | .Fa "CMS_ContentInfo *cms" | ||
| 31 | .Fa "X509_CRL *crl" | ||
| 32 | .Fc | ||
| 33 | .Ft int | ||
| 34 | .Fo CMS_add1_crl | ||
| 35 | .Fa "CMS_ContentInfo *cms" | ||
| 36 | .Fa "X509_CRL *crl" | ||
| 37 | .Fc | ||
| 38 | .Ft STACK_OF(X509_CRL) * | ||
| 39 | .Fo CMS_get1_crls | ||
| 40 | .Fa "CMS_ContentInfo *cms" | ||
| 41 | .Fc | ||
| 42 | .Sh DESCRIPTION | ||
| 43 | .Fn CMS_add0_cert | ||
| 44 | and | ||
| 45 | .Fn CMS_add1_cert | ||
| 46 | add certificate | ||
| 47 | .Fa cert | ||
| 48 | to | ||
| 49 | .Fa cms . | ||
| 50 | .Fa cms | ||
| 51 | must be of type signed data or enveloped data. | ||
| 52 | .Pp | ||
| 53 | .Fn CMS_get1_certs | ||
| 54 | returns all certificates in | ||
| 55 | .Fa cms . | ||
| 56 | .Pp | ||
| 57 | .Fn CMS_add0_crl | ||
| 58 | and | ||
| 59 | .Fn CMS_add1_crl | ||
| 60 | add CRL | ||
| 61 | .Fa crl | ||
| 62 | to | ||
| 63 | .Fa cms . | ||
| 64 | .Fn CMS_get1_crls | ||
| 65 | returns any CRLs in | ||
| 66 | .Fa cms . | ||
| 67 | .Sh NOTES | ||
| 68 | The | ||
| 69 | .Vt CMS_ContentInfo | ||
| 70 | structure | ||
| 71 | .Fa cms | ||
| 72 | must be of type signed data or enveloped data or an error will be | ||
| 73 | returned. | ||
| 74 | .Pp | ||
| 75 | For signed data, certificates and CRLs are added to the | ||
| 76 | .Fa certificates | ||
| 77 | and | ||
| 78 | .Fa crls | ||
| 79 | fields of the SignedData structure. | ||
| 80 | For enveloped data, they are added to | ||
| 81 | .Fa OriginatorInfo . | ||
| 82 | .Pp | ||
| 83 | As the | ||
| 84 | .Sq 0 | ||
| 85 | implies, | ||
| 86 | .Fn CMS_add0_cert | ||
| 87 | adds | ||
| 88 | .Fa cert | ||
| 89 | internally to | ||
| 90 | .Fa cms | ||
| 91 | and it must not be freed up after the call, as opposed to | ||
| 92 | .Fn CMS_add1_cert | ||
| 93 | where | ||
| 94 | .Fa cert | ||
| 95 | must be freed up. | ||
| 96 | .Pp | ||
| 97 | The same certificate or CRL must not be added to the same cms structure | ||
| 98 | more than once. | ||
| 99 | .Sh RETURN VALUES | ||
| 100 | .Fn CMS_add0_cert , | ||
| 101 | .Fn CMS_add1_cert , | ||
| 102 | .Fn CMS_add0_crl , | ||
| 103 | and | ||
| 104 | .Fn CMS_add1_crl | ||
| 105 | return 1 for success and 0 for failure. | ||
| 106 | .Pp | ||
| 107 | .Fn CMS_get1_certs | ||
| 108 | and | ||
| 109 | .Fn CMS_get1_crls | ||
| 110 | return the STACK of certificates or CRLs or | ||
| 111 | .Dv NULL | ||
| 112 | if there are none or an error occurs. | ||
| 113 | The only error which will occur in practice is if the | ||
| 114 | .Fa cms | ||
| 115 | type is invalid. | ||
| 116 | .Sh SEE ALSO | ||
| 117 | .Xr CMS_encrypt 3 , | ||
| 118 | .Xr CMS_sign 3 , | ||
| 119 | .Xr ERR_get_error 3 | ||
| 120 | .Sh HISTORY | ||
| 121 | .Fn CMS_add0_cert , | ||
| 122 | .Fn CMS_add1_cert , | ||
| 123 | .Fn CMS_get1_certs , | ||
| 124 | .Fn CMS_add0_crl | ||
| 125 | and | ||
| 126 | .Fn CMS_get1_crls | ||
| 127 | were all first added to OpenSSL 0.9.8. | ||
