Debian Codegraph @

upstream/debian-unstable/man3/CMS_digest_create.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "CMS_DIGEST_CREATE 3SSL"
58 .TH CMS_DIGEST_CREATE 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 CMS_digest_create_ex, CMS_digest_create
65 \&\- Create CMS DigestedData object
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/cms.h>
70 \&
71 \& CMS_ContentInfo *CMS_digest_create_ex(BIO *in, const EVP_MD *md,
72 \& unsigned int flags, OSSL_LIB_CTX *ctx,
73 \& const char *propq);
74 \&
75 \& CMS_ContentInfo *CMS_digest_create(BIO *in, const EVP_MD *md,
76 \& unsigned int flags);
77 .Ve
78 .SH DESCRIPTION
79 .IX Header "DESCRIPTION"
80 \&\fBCMS_digest_create_ex()\fR creates a \fBCMS_ContentInfo\fR structure
81 with a type \fBNID_pkcs7_digest\fR. The data supplied via the \fIin\fR BIO is digested
82 using \fImd\fR. The library context \fIlibctx\fR and the property query \fIpropq\fR are
83 used when retrieving algorithms from providers.
84 The \fIflags\fR field supports the \fBCMS_DETACHED\fR and \fBCMS_STREAM\fR flags,
85 Internally \fBCMS_final()\fR is called unless \fBCMS_STREAM\fR is specified.
86 .PP
87 The \fBCMS_ContentInfo\fR structure can be freed using \fBCMS_ContentInfo_free\fR\|(3).
88 .PP
89 \&\fBCMS_digest_create()\fR is similar to \fBCMS_digest_create_ex()\fR
90 but uses default values of NULL for the library context \fIlibctx\fR and the
91 property query \fIpropq\fR.
92 .SH "RETURN VALUES"
93 .IX Header "RETURN VALUES"
94 If the allocation fails, \fBCMS_digest_create_ex()\fR and \fBCMS_digest_create()\fR
95 return NULL and set an error code that can be obtained by \fBERR_get_error\fR\|(3).
96 Otherwise they return a pointer to the newly allocated structure.
97 .SH "SEE ALSO"
98 .IX Header "SEE ALSO"
99 \&\fBERR_get_error\fR\|(3), \fBCMS_final\fR\|(3)>
100 .SH HISTORY
101 .IX Header "HISTORY"
102 The \fBCMS_digest_create_ex()\fR method was added in OpenSSL 3.0.
103 .SH COPYRIGHT
104 .IX Header "COPYRIGHT"
105 Copyright 2020\-2021 The OpenSSL Project Authors. All Rights Reserved.
106 .PP
107 Licensed under the Apache License 2.0 (the "License"). You may not use
108 this file except in compliance with the License. You can obtain a copy
109 in the file LICENSE in the source distribution or at
110 <https://www.openssl.org/source/license.html>.