diff options
Diffstat (limited to 'doc/crypto/SMIME_read_CMS.pod')
-rw-r--r-- | doc/crypto/SMIME_read_CMS.pod | 35 |
1 files changed, 16 insertions, 19 deletions
diff --git a/doc/crypto/SMIME_read_CMS.pod b/doc/crypto/SMIME_read_CMS.pod index 84fbc0dd8b..acc5524c14 100644 --- a/doc/crypto/SMIME_read_CMS.pod +++ b/doc/crypto/SMIME_read_CMS.pod @@ -2,7 +2,7 @@ =head1 NAME -SMIME_read_CMS - parse S/MIME message. + SMIME_read_CMS - parse S/MIME message. =head1 SYNOPSIS @@ -16,24 +16,22 @@ SMIME_read_CMS() parses a message in S/MIME format. B<in> is a BIO to read the message from. -If cleartext signing is used then the content is saved in -a memory bio which is written to B<*bcont>, otherwise -B<*bcont> is set to B<NULL>. +If cleartext signing is used then the content is saved in a memory bio which is +written to B<*bcont>, otherwise B<*bcont> is set to NULL. -The parsed CMS_ContentInfo structure is returned or B<NULL> if an +The parsed CMS_ContentInfo structure is returned or NULL if an error occurred. =head1 NOTES -If B<*bcont> is not B<NULL> then the message is clear text -signed. B<*bcont> can then be passed to CMS_verify() with -the B<CMS_DETACHED> flag set. +If B<*bcont> is not NULL then the message is clear text signed. B<*bcont> can +then be passed to CMS_verify() with the B<CMS_DETACHED> flag set. Otherwise the type of the returned structure can be determined using CMS_get0_type(). -To support future functionality if B<bcont> is not B<NULL> -B<*bcont> should be initialized to B<NULL>. For example: +To support future functionality if B<bcont> is not NULL B<*bcont> should be +initialized to NULL. For example: BIO *cont = NULL; CMS_ContentInfo *cms; @@ -42,17 +40,16 @@ B<*bcont> should be initialized to B<NULL>. For example: =head1 BUGS -The MIME parser used by SMIME_read_CMS() is somewhat primitive. -While it will handle most S/MIME messages more complex compound -formats may not work. +The MIME parser used by SMIME_read_CMS() is somewhat primitive. While it will +handle most S/MIME messages more complex compound formats may not work. -The parser assumes that the CMS_ContentInfo structure is always base64 -encoded and will not handle the case where it is in binary format -or uses quoted printable format. +The parser assumes that the CMS_ContentInfo structure is always base64 encoded +and will not handle the case where it is in binary format or uses quoted +printable format. -The use of a memory BIO to hold the signed content limits the size -of message which can be processed due to memory restraints: a -streaming single pass option should be available. +The use of a memory BIO to hold the signed content limits the size of message +which can be processed due to memory restraints: a streaming single pass option +should be available. =head1 RETURN VALUES |