1=pod 2 3=head1 NAME 4 5CMS_get0_type, CMS_set1_eContentType, CMS_get0_eContentType, CMS_get0_content - get and set CMS content types and content 6 7=head1 SYNOPSIS 8 9 #include <openssl/cms.h> 10 11 const ASN1_OBJECT *CMS_get0_type(const CMS_ContentInfo *cms); 12 int CMS_set1_eContentType(CMS_ContentInfo *cms, const ASN1_OBJECT *oid); 13 const ASN1_OBJECT *CMS_get0_eContentType(CMS_ContentInfo *cms); 14 ASN1_OCTET_STRING **CMS_get0_content(CMS_ContentInfo *cms); 15 16=head1 DESCRIPTION 17 18CMS_get0_type() returns the content type of a CMS_ContentInfo structure as 19an ASN1_OBJECT pointer. An application can then decide how to process the 20CMS_ContentInfo structure based on this value. 21 22CMS_set1_eContentType() sets the embedded content type of a CMS_ContentInfo 23structure. It should be called with CMS functions (such as L<CMS_sign(3)>, 24L<CMS_encrypt(3)>) 25with the B<CMS_PARTIAL> 26flag and B<before> the structure is finalised, otherwise the results are 27undefined. 28 29ASN1_OBJECT *CMS_get0_eContentType() returns a pointer to the embedded 30content type. 31 32CMS_get0_content() returns a pointer to the B<ASN1_OCTET_STRING> pointer 33containing the embedded content. 34 35=head1 NOTES 36 37As the B<0> implies CMS_get0_type(), CMS_get0_eContentType() and 38CMS_get0_content() return internal pointers which should B<not> be freed up. 39CMS_set1_eContentType() copies the supplied OID and it B<should> be freed up 40after use. 41 42The B<ASN1_OBJECT> values returned can be converted to an integer B<NID> value 43using OBJ_obj2nid(). For the currently supported content types the following 44values are returned: 45 46 NID_pkcs7_data 47 NID_pkcs7_signed 48 NID_pkcs7_digest 49 NID_id_smime_ct_compressedData: 50 NID_pkcs7_encrypted 51 NID_pkcs7_enveloped 52 53The return value of CMS_get0_content() is a pointer to the B<ASN1_OCTET_STRING> 54content pointer. That means that for example: 55 56 ASN1_OCTET_STRING **pconf = CMS_get0_content(cms); 57 58B<*pconf> could be NULL if there is no embedded content. Applications can 59access, modify or create the embedded content in a B<CMS_ContentInfo> structure 60using this function. Applications usually will not need to modify the 61embedded content as it is normally set by higher level functions. 62 63=head1 RETURN VALUES 64 65CMS_get0_type() and CMS_get0_eContentType() return an ASN1_OBJECT structure. 66 67CMS_set1_eContentType() returns 1 for success or 0 if an error occurred. The 68error can be obtained from ERR_get_error(3). 69 70=head1 SEE ALSO 71 72L<ERR_get_error(3)> 73 74=head1 COPYRIGHT 75 76Copyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved. 77 78Licensed under the Apache License 2.0 (the "License"). You may not use 79this file except in compliance with the License. You can obtain a copy 80in the file LICENSE in the source distribution or at 81L<https://www.openssl.org/source/license.html>. 82 83=cut 84
