OLD | NEW |
(Empty) | |
| 1 =pod |
| 2 |
| 3 =head1 NAME |
| 4 |
| 5 CMS_get0_SignerInfos, CMS_SignerInfo_get0_signer_id, CMS_SignerInfo_cert_cmp, C
MS_set1_signer_certs - CMS signedData signer functions. |
| 6 |
| 7 =head1 SYNOPSIS |
| 8 |
| 9 #include <openssl/cms.h> |
| 10 |
| 11 STACK_OF(CMS_SignerInfo) *CMS_get0_SignerInfos(CMS_ContentInfo *cms); |
| 12 |
| 13 int CMS_SignerInfo_get0_signer_id(CMS_SignerInfo *si, ASN1_OCTET_STRING **keyid
, X509_NAME **issuer, ASN1_INTEGER **sno); |
| 14 int CMS_SignerInfo_cert_cmp(CMS_SignerInfo *si, X509 *cert); |
| 15 void CMS_SignerInfo_set1_signer_cert(CMS_SignerInfo *si, X509 *signer); |
| 16 |
| 17 =head1 DESCRIPTION |
| 18 |
| 19 The function CMS_get0_SignerInfos() returns all the CMS_SignerInfo structures |
| 20 associated with a CMS signedData structure. |
| 21 |
| 22 CMS_SignerInfo_get0_signer_id() retrieves the certificate signer identifier |
| 23 associated with a specific CMS_SignerInfo structure B<si>. Either the |
| 24 keyidentifier will be set in B<keyid> or B<both> issuer name and serial number |
| 25 in B<issuer> and B<sno>. |
| 26 |
| 27 CMS_SignerInfo_cert_cmp() compares the certificate B<cert> against the signer |
| 28 identifier B<si>. It returns zero if the comparison is successful and non zero |
| 29 if not. |
| 30 |
| 31 CMS_SignerInfo_set1_signer_cert() sets the signers certificate of B<si> to |
| 32 B<signer>. |
| 33 |
| 34 =head1 NOTES |
| 35 |
| 36 The main purpose of these functions is to enable an application to lookup |
| 37 signers certificates using any appropriate technique when the simpler method |
| 38 of CMS_verify() is not appropriate. |
| 39 |
| 40 In typical usage and application will retrieve all CMS_SignerInfo structures |
| 41 using CMS_get0_SignerInfo() and retrieve the identifier information using |
| 42 CMS. It will then obtain the signer certificate by some unspecified means |
| 43 (or return and error if it cannot be found) and set it using |
| 44 CMS_SignerInfo_set1_signer_cert(). |
| 45 |
| 46 Once all signer certificates have been set CMS_verify() can be used. |
| 47 |
| 48 Although CMS_get0_SignerInfos() can return NULL is an error occur B<or> if |
| 49 there are no signers this is not a problem in practice because the only |
| 50 error which can occur is if the B<cms> structure is not of type signedData |
| 51 due to application error. |
| 52 |
| 53 =head1 RETURN VALUES |
| 54 |
| 55 CMS_get0_SignerInfos() returns all CMS_SignerInfo structures, or NULL there |
| 56 are no signers or an error occurs. |
| 57 |
| 58 CMS_SignerInfo_get0_signer_id() returns 1 for success and 0 for failure. |
| 59 |
| 60 CMS_SignerInfo_cert_cmp() returns 0 for a successful comparison and non |
| 61 zero otherwise. |
| 62 |
| 63 CMS_SignerInfo_set1_signer_cert() does not return a value. |
| 64 |
| 65 Any error can be obtained from L<ERR_get_error(3)|ERR_get_error(3)> |
| 66 |
| 67 =head1 SEE ALSO |
| 68 |
| 69 L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_verify(3)|CMS_verify(3)> |
| 70 |
| 71 =head1 HISTORY |
| 72 |
| 73 These functions were first was added to OpenSSL 0.9.8 |
| 74 |
| 75 =cut |
OLD | NEW |