openssl/doc/man3/PBMAC1_get1_pbkdf2_param.pod
Dmitry Belyavskiy 38aa61e5a7 Implementation of the RFC 9579, PBMAC1 in PKCS#12 - documentation
Reviewed-by: Paul Dale <ppzgs1@gmail.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/24577)
2024-08-07 10:00:16 +02:00

47 lines
1.0 KiB
Plaintext

=pod
=head1 NAME
PBMAC1_get1_pbkdf2_param - Function to manipulate a PBMAC1
MAC structure
=head1 SYNOPSIS
#include <openssl/x509.h>
PBKDF2PARAM *PBMAC1_get1_pbkdf2_param(const X509_ALGOR *macalg);
=head1 DESCRIPTION
PBMAC1_get1_pbkdf2_param() retrieves a B<PBKDF2PARAM> structure from an
I<X509_ALGOR> structure.
=head1 RETURN VALUES
PBMAC1_get1_pbkdf2_param() returns NULL in case when PBMAC1 uses an algorithm
apart from B<PBKDF2> or when passed incorrect parameters and a pointer to
B<PBKDF2PARAM> structure otherwise.
=head1 CONFORMING TO
IETF RFC 9579 (L<https://tools.ietf.org/html/rfc9579>)
=head1 SEE ALSO
L<openssl-pkcs12(1)>
=head1 HISTORY
The I<PBMAC1_get1_pbkdf2_param> function was added in OpenSSL 3.4.
=head1 COPYRIGHT
Copyright 2021-2024 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