doc/crypto/SMIME_read_CMS.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SMIME_read_CMS - parse S/MIME message.
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/cms.h>
  10
  11  CMS_ContentInfo *SMIME_read_CMS(BIO *in, BIO **bcont);
  12
  13 =head1 DESCRIPTION
  14
  15 SMIME_read_CMS() parses a message in S/MIME format.
  16
  17 B<in> is a BIO to read the message from.
  18
  19 If cleartext signing is used then the content is saved in
  20 a memory bio which is written to B<*bcont>, otherwise
  21 B<*bcont> is set to B<NULL>.
  22
  23 The parsed CMS_ContentInfo structure is returned or B<NULL> if an
  24 error occurred.
  25
  26 =head1 NOTES
  27
  28 If B<*bcont> is not B<NULL> then the message is clear text
  29 signed. B<*bcont> can then be passed to CMS_verify() with
  30 the B<CMS_DETACHED> flag set.
  31
  32 Otherwise the type of the returned structure can be determined
  33 using CMS_get0_type().
  34
  35 To support future functionality if B<bcont> is not B<NULL>
  36 B<*bcont> should be initialized to B<NULL>. For example:
  37
  38  BIO *cont = NULL;
  39  CMS_ContentInfo *cms;
  40
  41  cms = SMIME_read_CMS(in, &cont);
  42
  43 =head1 BUGS
  44
  45 The MIME parser used by SMIME_read_CMS() is somewhat primitive.
  46 While it will handle most S/MIME messages more complex compound
  47 formats may not work.
  48
  49 The parser assumes that the CMS_ContentInfo structure is always base64
  50 encoded and will not handle the case where it is in binary format
  51 or uses quoted printable format.
  52
  53 The use of a memory BIO to hold the signed content limits the size
  54 of message which can be processed due to memory restraints: a
  55 streaming single pass option should be available.
  56
  57 =head1 RETURN VALUES
  58
  59 SMIME_read_CMS() returns a valid B<CMS_ContentInfo> structure or B<NULL>
  60 if an error occurred. The error can be obtained from ERR_get_error(3).
  61
  62 =head1 SEE ALSO
  63
  64 L<ERR_get_error(3)|ERR_get_error(3)>, L<CMS_type(3)|CMS_type(3)>
  65 L<SMIME_read_CMS(3)|SMIME_read_CMS(3)>, L<CMS_sign(3)|CMS_sign(3)>,
  66 L<CMS_verify(3)|CMS_verify(3)>, L<CMS_encrypt(3)|CMS_encrypt(3)>
  67 L<CMS_decrypt(3)|CMS_decrypt(3)>
  68
  69 =head1 HISTORY
  70
  71 SMIME_read_CMS() was added to OpenSSL 0.9.8
  72
  73 =cut