mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2024-11-27 05:21:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for CMS_EnvelopedData_create()

Browse Source 
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
(Merged from https://github.com/openssl/openssl/pull/11529)
This commit is contained in:
Jakub Zelenka 2020-04-12 21:29:41 +01:00 committed by Dmitry Belyavskiy
parent 31b069ecea
commit 2b5e12f509
2 changed files with 52 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
doc/man3/CMS_EnvelopedData_create.pod Normal file
View File

@ -0,0 +1,52 @@
=pod
=head1 NAME
CMS_EnvelopedData_create - Create CMS envelope
=head1 SYNOPSIS
#include <openssl/cms.h>
CMS_ContentInfo *CMS_EnvelopedData_create(const EVP_CIPHER *cipher);
=head1 DESCRIPTION
CMS_EnvelopedData_create() creates a B<CMS_ContentInfo> structure with
a type B<NID_pkcs7_enveloped>. B<cipher> is the symmetric cipher to use.
The algorithm passed in the B<cipher> parameter must support ASN1 encoding of
its parameters.
The recipients can be added later using L<CMS_add1_recipient_cert(3)> or
L<CMS_add0_recipient_key(3)>.
The B<CMS_ContentInfo> structure needs to be finalized using L<CMS_final(3)>
and then freed using L<CMS_ContentInfo_free(3)>.
=head1 NOTES
Although CMS_EnvelopedData_create() allocates a new B<CMS_ContentInfo>
structure it is usually not used in applications. The wrappers
L<CMS_encrypt(3)> and L<CMS_decrypt(3)> are often used instead.
=head1 RETURN VALUES
If the allocation fails, CMS_EnvelopedData_create() returns NULL and sets
an error code that can be obtained by L<ERR_get_error(3)>.
Otherwise it returns a pointer to the newly allocated structure.
=head1 SEE ALSO
L<ERR_get_error(3)>, L<CMS_encrypt(3)>, L<CMS_decrypt(3)>, L<CMS_final(3)>
=head1 COPYRIGHT
Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut

1
util/missingcrypto.txt
View File

@ -314,7 +314,6 @@ CMS_ContentInfo_it(3)
CMS_EncryptedData_decrypt(3)
CMS_EncryptedData_encrypt(3)
CMS_EncryptedData_set1_key(3)
CMS_EnvelopedData_create(3)
CMS_ReceiptRequest_it(3)
CMS_RecipientEncryptedKey_cert_cmp(3)
CMS_RecipientEncryptedKey_get0_id(3)