X-Git-Url: https://code.wpia.club/?a=blobdiff_plain;f=lib%2Fopenssl%2Fdoc%2Fcrypto%2FCMS_get0_type.pod;h=cad8d3f66280f68bed197d8c69bcd10196e35cf1;hb=02ed66432c92de70694700164f986190aad3cbc5;hp=8ff1c3115cd45d79eb8cc0bde9ace09409d87ea6;hpb=89016837dcbf2775cd15dc8cbaba00dc6379f86e;p=cassiopeia.git diff --git a/lib/openssl/doc/crypto/CMS_get0_type.pod b/lib/openssl/doc/crypto/CMS_get0_type.pod index 8ff1c31..cad8d3f 100644 --- a/lib/openssl/doc/crypto/CMS_get0_type.pod +++ b/lib/openssl/doc/crypto/CMS_get0_type.pod @@ -2,15 +2,16 @@ =head1 NAME - CMS_get0_type, CMS_set1_eContentType, CMS_get0_eContentType - get and set CMS content types +CMS_get0_type, CMS_set1_eContentType, CMS_get0_eContentType, CMS_get0_content - get and set CMS content types and content =head1 SYNOPSIS #include - const ASN1_OBJECT *CMS_get0_type(CMS_ContentInfo *cms); + const ASN1_OBJECT *CMS_get0_type(const CMS_ContentInfo *cms); int CMS_set1_eContentType(CMS_ContentInfo *cms, const ASN1_OBJECT *oid); const ASN1_OBJECT *CMS_get0_eContentType(CMS_ContentInfo *cms); + ASN1_OCTET_STRING **CMS_get0_content(CMS_ContentInfo *cms); =head1 DESCRIPTION @@ -26,11 +27,15 @@ undefined. ASN1_OBJECT *CMS_get0_eContentType() returns a pointer to the embedded content type. +CMS_get0_content() returns a pointer to the B pointer +containing the embedded content. + =head1 NOTES -As the B<0> implies CMS_get0_type() and CMS_get0_eContentType() return internal -pointers which should B be freed up. CMS_set1_eContentType() copies the -supplied OID and it B be freed up after use. +As the B<0> implies CMS_get0_type(), CMS_get0_eContentType() and +CMS_get0_content() return internal pointers which should B be freed up. +CMS_set1_eContentType() copies the supplied OID and it B be freed up +after use. The B values returned can be converted to an integer B value using OBJ_obj2nid(). For the currently supported content types the following @@ -43,6 +48,15 @@ values are returned: NID_pkcs7_encrypted NID_pkcs7_enveloped +The return value of CMS_get0_content() is a pointer to the B +content pointer. That means that for example: + + ASN1_OCTET_STRING **pconf = CMS_get0_content(cms); + +B<*pconf> could be NULL if there is no embedded content. Applications can +access, modify or create the embedded content in a B structure +using this function. Applications usually will not need to modify the +embedded content as it is normally set by higher level functions. =head1 RETURN VALUES @@ -53,11 +67,15 @@ error can be obtained from ERR_get_error(3). =head1 SEE ALSO -L +L + +=head1 COPYRIGHT -=head1 HISTORY +Copyright 2008-2016 The OpenSSL Project Authors. All Rights Reserved. -CMS_get0_type(), CMS_set1_eContentType() and CMS_get0_eContentType() were all -first added to OpenSSL 0.9.8 +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L. =cut