aboutsummaryrefslogtreecommitdiffstats
path: root/librecrypt_chain_length.3
blob: eb0b1cc8b12637c98ee9f21b21fe53d6dcf44902 (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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
.TH LIBRECRYPT_CHAIN_LENGTH 3 LIBRECRYPT
.SH NAME
librecrypt_chain_length - Get number of algorithms in a chained password hash string

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

size_t \fBlibrecrypt_chain_length\fP(const char *\fIhash\fP);
.fi
.PP
Link with
.IR -lrecrypt .

.SH DESCRIPTION
The
.BR librecrypt_chain_length ()
function returns the number of hash algorithms
specified in the chain contained in
.IR hash .
Algorithms are delimited by
.I LIBRECRYPT_ALGORITHM_LINK_DELIMITER
(which is
.BR "\(aq>\(aq" ).
.PP
.I hash
must not be
.IR NULL .

.SH RETURN VALUES
The
.BR librecrypt_chain_length ()
function returns the number of chained hash algorithms.
The return value is always non-zero.

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

.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.PP
.TS
allbox;
lb lb lb
l l l.
Interface	Attribute	Value
T{
.BR librecrypt_chain_length ()
T}	Thread safety	MT-Safe
T{
.BR librecrypt_chain_length ()
T}	Async-signal safety	AS-Safe
.TE
.sp

.SH HISTORY
The
.BR librecrypt_chain_length ()
function was introduced in version 1.0 of
.BR librecrypt .

.SH SEE ALSO
.BR librecrypt (7),
.BR librecrypt_decompose_chain (3),
.BR librecrypt_decompose_chain1 (3),
.BR librecrypt_next_algorithm (3)