Add (so far untested and undocument) support for pepperHEADmaster

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

1 files changed, 25 insertions, 10 deletions

diff --git a/librecrypt_crypt.3 b/librecrypt_crypt.3
index 63d08da..c7cba43 100644
--- a/librecrypt_crypt.3
+++ b/librecrypt_crypt.3
@@ -8,7 +8,7 @@ librecrypt_crypt - Compute password hash encoded in ASCII with settings prefix
 
 ssize_t \fBlibrecrypt_crypt\fP(char *restrict \fIout_buffer\fP, size_t \fIsize\fP,
                         const char *\fIphrase\fP, size_t \fIlen\fP,
-                        const char *\fIsettings\fP, void *\fIreserved\fP);
+                        const char *\fIsettings\fP, LIBRECRYPT_CONTEXT *\fIctx\fP);
 .fi
 .PP
 Link with
@@ -39,10 +39,13 @@ If
 contains a resulting hash, it is ignored.
 .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
@@ -80,11 +83,6 @@ The
 function will fail if:
 .TP
 .B EINVAL
-.I reserved
-is not
-.IR NULL .
-.TP
-.B EINVAL
 .I settings
 is invalid.
 .TP
@@ -127,6 +125,23 @@ The
 function was introduced in version 1.0 of
 .BR librecrypt .
 
+Since version 1.1 of the
+.BR librecrypt_crypt ()
+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_hash_binary (3),