Debian Codegraph @

upstream/debian-unstable/man3/PBMAC1_get1_pbkdf2_param.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 "PBMAC1_GET1_PBKDF2_PARAM 3SSL"
58 .TH PBMAC1_GET1_PBKDF2_PARAM 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 PBMAC1_get1_pbkdf2_param \- Function to manipulate a PBMAC1
65 MAC structure
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/x509.h>
70 \&
71 \& PBKDF2PARAM *PBMAC1_get1_pbkdf2_param(const X509_ALGOR *macalg);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 \&\fBPBMAC1_get1_pbkdf2_param()\fR retrieves a \fBPBKDF2PARAM\fR structure from an
76 \&\fIX509_ALGOR\fR structure.
77 .SH "RETURN VALUES"
78 .IX Header "RETURN VALUES"
79 \&\fBPBMAC1_get1_pbkdf2_param()\fR returns NULL in case when PBMAC1 uses an algorithm
80 apart from \fBPBKDF2\fR or when passed incorrect parameters and a pointer to
81 \&\fBPBKDF2PARAM\fR structure otherwise.
82 .SH "CONFORMING TO"
83 .IX Header "CONFORMING TO"
84 IETF RFC 9579 (<https://tools.ietf.org/html/rfc9579>)
85 .SH "SEE ALSO"
86 .IX Header "SEE ALSO"
87 \&\fBopenssl\-pkcs12\fR\|(1)
88 .SH HISTORY
89 .IX Header "HISTORY"
90 The \fIPBMAC1_get1_pbkdf2_param\fR function was added in OpenSSL 3.4.
91 .SH COPYRIGHT
92 .IX Header "COPYRIGHT"
93 Copyright 2021\-2024 The OpenSSL Project Authors. All Rights Reserved.
94 .PP
95 Licensed under the Apache License 2.0 (the "License"). You may not use
96 this file except in compliance with the License. You can obtain a copy
97 in the file LICENSE in the source distribution or at
98 <https://www.openssl.org/source/license.html>.