aboutsummaryrefslogtreecommitdiffstats
path: root/libar2simplified_recommendation.3
blob: 842af40d1a102dce21f8a273fb1b606a3415a36c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
.TH LIBAR2SIMPLIFIED_RECOMMENDATION 3 LIBAR2SIMPLIFIED
.SH NAME
libar2simplified_recommendation - Get recommended hashing parameters

.SH SYNOPSIS
.nf
#include <libar2simplified.h>

const char *libar2simplified_recommendation(int \fIside_channel_free\fP);
.fi
.PP
Link with
.IR "-lar2simplified" .

.SH DESCRIPTION
The
.BR libar2simplified_recommendation ()
function returns a hashing parameter string
that can be used as input to the
.BR libar2simplified_crypt (3)
and
.BR libar2simplified_decode (3)
functions.
.PP
.I side_channel_free
shall be 1 if you know that the environment
is safe enought against side-channel attacks,
otherwise it shall be 0.
.PP
The output parameters are just so you have
something to start with, they shall not be taken
too seriously, and should be tween to your
requirements.

.SH RETURN VALUES
The
.BR libar2simplified_recommendation ()
function returns a statically allocated,
read-only, hashing parameter string.

.SH ERRORS
The
.BR libar2simplified_recommendation ()
function cannot fail.

.SH SEE ALSO
.BR libar2simplified (7),
.BR libar2simplified_crypt (3),
.BR libar2simplified_decode (3),
.BR libar2_hash (3)