Add (so far untested and undocument) support for pepperHEADmaster

Signed-off-by: Mattias Andrée <m@maandree.se>

1 files changed, 25 insertions, 9 deletions

diff --git a/librecrypt_make_settings.3 b/librecrypt_make_settings.3
index ca31417..9b39bd9 100644
--- a/librecrypt_make_settings.3
+++ b/librecrypt_make_settings.3
@@ -9,7 +9,7 @@ librecrypt_make_settings - Generate a password hash settings string
 ssize_t \fBlibrecrypt_make_settings\fP(char *\fIout_buffer\fP, size_t \fIsize\fP, const char *\fIalgorithm\fP,
                                 size_t \fImemcost\fP, uintmax_t \fItimecost\fP, int \fIgensalt\fP,
                                 ssize_t (*\fIrng\fP)(void *\fIout\fP, size_t \fIn\fP, void *\fIuser\fP),
-                                void *\fIuser\fP, void *\fIreserved\fP);
+                                void *\fIuser\fP, LIBRECRYPT_CONTEXT *\fIctx\fP);
 .fi
 .PP
 Link with
@@ -78,9 +78,13 @@ with the same name, as is and may be used by
 for user-defined purposes.
 .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
@@ -120,11 +124,6 @@ The
 function will fail if:
 .TP
 .B EINVAL
-.I reserved
-is not
-.IR NULL .
-.TP
-.B EINVAL
 .I algorithm
 represents a chain of algorithms.
 .TP
@@ -183,6 +182,23 @@ The
 function was introduced in version 1.0 of
 .BR librecrypt .
 
+Since version 1.1 of the
+.BR librecrypt_make_settings ()
+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_realise_salts (3)