aboutsummaryrefslogtreecommitdiffstats
path: root/librecrypt_realise_salts.3
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--librecrypt_realise_salts.334
1 files changed, 25 insertions, 9 deletions
diff --git a/librecrypt_realise_salts.3 b/librecrypt_realise_salts.3
index 7900a4f..dba21b1 100644
--- a/librecrypt_realise_salts.3
+++ b/librecrypt_realise_salts.3
@@ -8,7 +8,7 @@ librecrypt_realise_salts - Realise asterisk-encoded random salts in a settings s
ssize_t \fBlibrecrypt_realise_salts\fP(char *restrict \fIout_buffer\fP, size_t \fIsize\fP, const char *\fIsettings\fP,
ssize_t (*\fIrng\fP)(void *\fIout\fP, size_t \fIn\fP, void *\fIuser\fP), void *\fIuser\fP,
- void *\fIreserved\fP);
+ LIBRECRYPT_CONTEXT *\fIctx\fP);
.fi
.PP
Link with
@@ -65,9 +65,13 @@ and return the number of generated bytes, or
-1 on failure.
.PP
The
-.I reserved
-parameter is reserved for future use and should be
-.IR NULL .
+.I ctx
+parameter is used for providing library
+configurations, see
+.BR librecrypt_create_context (3)
+for more information; used
+.I NULL
+for default configurations.
.PP
On successful completion, if
.I size
@@ -109,11 +113,6 @@ The
.BR librecrypt_realise_salts ()
function will fail if:
.TP
-.B EINVAL
-.I reserved
-is not
-.IR NULL .
-.TP
.B ERANGE
The expected return value is greater than {SSIZE_MAX}.
.TP
@@ -164,6 +163,23 @@ The
function was introduced in version 1.0 of
.BR librecrypt .
+Since version 1.1 of the
+.BR librecrypt_realise_salts ()
+function, the
+.I ctx
+parameter (previously called
+.IR reserved )
+has the type
+.B LIBRECRYPT_CONTEXT *
+(previously
+.BR "void *" ),
+and setting it to
+.RI non- NULL
+no longer causes failure with
+.I errno
+set to
+.IR EINVAL .
+
.SH SEE ALSO
.BR librecrypt (7),
.BR librecrypt_make_settings (3)