xref: /freebsd/crypto/openssl/doc/man3/CMS_digest_create.pod (revision a4e5e0106ac7145f56eb39a691e302cabb4635be)
1=pod
2
3=head1 NAME
4
5CMS_digest_create_ex, CMS_digest_create
6- Create CMS DigestedData object
7
8=head1 SYNOPSIS
9
10 #include <openssl/cms.h>
11
12 CMS_ContentInfo *CMS_digest_create_ex(BIO *in, const EVP_MD *md,
13                                       unsigned int flags, OSSL_LIB_CTX *ctx,
14                                       const char *propq);
15
16 CMS_ContentInfo *CMS_digest_create(BIO *in, const EVP_MD *md,
17                                    unsigned int flags);
18
19=head1 DESCRIPTION
20
21CMS_digest_create_ex() creates a B<CMS_ContentInfo> structure
22with a type B<NID_pkcs7_digest>. The data supplied via the I<in> BIO is digested
23using I<md>. The library context I<libctx> and the property query I<propq> are
24used when retrieving algorithms from providers.
25The I<flags> field supports the B<CMS_DETACHED> and B<CMS_STREAM> flags,
26Internally CMS_final() is called unless B<CMS_STREAM> is specified.
27
28The B<CMS_ContentInfo> structure can be freed using L<CMS_ContentInfo_free(3)>.
29
30CMS_digest_create() is similar to CMS_digest_create_ex()
31but uses default values of NULL for the library context I<libctx> and the
32property query I<propq>.
33
34
35=head1 RETURN VALUES
36
37If the allocation fails, CMS_digest_create_ex() and CMS_digest_create()
38return NULL and set an error code that can be obtained by L<ERR_get_error(3)>.
39Otherwise they return a pointer to the newly allocated structure.
40
41=head1 SEE ALSO
42
43L<ERR_get_error(3)>, L<CMS_final(3)>>
44
45=head1 HISTORY
46
47The CMS_digest_create_ex() method was added in OpenSSL 3.0.
48
49=head1 COPYRIGHT
50
51Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
52
53Licensed under the Apache License 2.0 (the "License").  You may not use
54this file except in compliance with the License.  You can obtain a copy
55in the file LICENSE in the source distribution or at
56L<https://www.openssl.org/source/license.html>.
57
58=cut
59