doc/man3/SMIME_read_ASN1.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SMIME_read_ASN1_ex, SMIME_read_ASN1
   6 - parse S/MIME message
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/asn1.h>
  11
  12  ASN1_VALUE *SMIME_read_ASN1_ex(BIO *in, int flags, BIO **bcont,
  13                                 const ASN1_ITEM *it, ASN1_VALUE **x);
  14  ASN1_VALUE *SMIME_read_ASN1(BIO *in, BIO **bcont, const ASN1_ITEM *it);
  15
  16 =head1 DESCRIPTION
  17
  18 SMIME_read_ASN1_ex() parses a message in S/MIME format.
  19
  20 I<in> is a BIO to read the message from.
  21 If the I<flags> argument contains B<CMS_BINARY> then the input is assumed to be
  22 in binary format and is not translated to canonical form.
  23 If in addition B<SMIME_ASCIICRLF> is set then the binary input is assumed
  24 to be followed by B<CR> and B<LF> characters, else only by an B<LF> character.
  25 I<x> can be used to optionally supply
  26 a previously created I<it> ASN1_VALUE object (such as CMS_ContentInfo or PKCS7),
  27 it can be set to NULL. Valid values that can be used by ASN.1 structure I<it>
  28 are ASN1_ITEM_rptr(PKCS7) or ASN1_ITEM_rptr(CMS_ContentInfo).
  29
  30 If cleartext signing is used then the content is saved in a memory bio which is
  31 written to I<*bcont>, otherwise I<*bcont> is set to NULL.
  32
  33 The parsed ASN1_VALUE structure is returned or NULL if an error occurred.
  34
  35 SMIME_read_ASN1() is similar to SMIME_read_ASN1_ex() but sets the value of I<x>
  36 to NULL and the value of I<flags> to 0.
  37
  38 =head1 NOTES
  39
  40 The higher level functions L<SMIME_read_CMS_ex(3)> and
  41 L<SMIME_read_PKCS7_ex(3)> should be used instead of SMIME_read_ASN1_ex().
  42
  43 To support future functionality if I<bcont> is not NULL I<*bcont> should be
  44 initialized to NULL.
  45
  46 =head1 BUGS
  47
  48 The MIME parser used by SMIME_read_ASN1_ex() is somewhat primitive. While it will
  49 handle most S/MIME messages more complex compound formats may not work.
  50
  51 The use of a memory BIO to hold the signed content limits the size of message
  52 which can be processed due to memory restraints: a streaming single pass option
  53 should be available.
  54
  55 =head1 RETURN VALUES
  56
  57 SMIME_read_ASN1_ex() and SMIME_read_ASN1() return a valid B<ASN1_VALUE>
  58 structure or B<NULL> if an error occurred. The error can be obtained from
  59 ERR_get_error(3).
  60
  61 =head1 SEE ALSO
  62
  63 L<ERR_get_error(3)>,
  64 L<SMIME_read_CMS_ex(3)>,
  65 L<SMIME_read_PKCS7_ex(3)>,
  66 L<SMIME_write_ASN1(3)>,
  67 L<SMIME_write_ASN1_ex(3)>
  68
  69 =head1 HISTORY
  70
  71 The function SMIME_read_ASN1_ex() was added in OpenSSL 3.0.
  72
  73 =head1 COPYRIGHT
  74
  75 Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
  76
  77 Licensed under the Apache License 2.0 (the "License").  You may not use
  78 this file except in compliance with the License.  You can obtain a copy
  79 in the file LICENSE in the source distribution or at
  80 L<https://www.openssl.org/source/license.html>.
  81
  82 =cut