aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAllan Jude <allanjude@FreeBSD.org>2019-05-21 22:11:53 +0000
committerAllan Jude <allanjude@FreeBSD.org>2019-05-21 22:11:53 +0000
commitf26f4cf1700142de97990ceddfbc9e18ac2d3949 (patch)
tree930651da5da8fe63cb54f1f1eef58dc8aa898887
parent57e9b361baff42bec76f8bbb5dfa6ae6623382e3 (diff)
downloadsrc-f26f4cf1700142de97990ceddfbc9e18ac2d3949.tar.gz
src-f26f4cf1700142de97990ceddfbc9e18ac2d3949.zip
Add missing errors section to md[2-5], ripemd160, sha*, and skein* manpages
PR: 148987 Submitted by: Dan Lukes <dan@obluda.cz> (original version) MFC after: 1 week Sponsored by: Klara Systems Event: Waterloo Hackathon 2019
Notes
Notes: svn path=/head/; revision=348072
-rw-r--r--lib/libmd/mdX.322
-rw-r--r--lib/libmd/ripemd.320
-rw-r--r--lib/libmd/sha.322
-rw-r--r--lib/libmd/sha256.320
-rw-r--r--lib/libmd/sha512.322
-rw-r--r--lib/libmd/skein.322
6 files changed, 124 insertions, 4 deletions
diff --git a/lib/libmd/mdX.3 b/lib/libmd/mdX.3
index 9440c286b212..16bcb84bb614 100644
--- a/lib/libmd/mdX.3
+++ b/lib/libmd/mdX.3
@@ -8,7 +8,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd July 20, 2018
+.Dd May 21, 2019
.Dt MDX 3
.Os
.Sh NAME
@@ -144,6 +144,26 @@ after use.
If the
.Fa buf
argument is non-null it must point to at least 33 characters of buffer space.
+.Sh ERRORS
+The
+.Fn MDXEnd
+function called with a null buf argument may fail and return NULL if:
+.Bl -tag -width Er
+.It Bq Er ENOMEM
+Insufficient storage space is available.
+.El
+.Pp
+The
+.Fn MDXFile
+and
+.Fn MDXFileChunk
+may return NULL when underlying
+.Xr open 2 ,
+.Xr fstat 2 ,
+.Xr lseek 2 ,
+or
+.Xr MDXEnd 2
+fail.
.Sh SEE ALSO
.Xr md4 3 ,
.Xr md5 3 ,
diff --git a/lib/libmd/ripemd.3 b/lib/libmd/ripemd.3
index e4c5fa4a41c8..54cdf73ecc8d 100644
--- a/lib/libmd/ripemd.3
+++ b/lib/libmd/ripemd.3
@@ -124,6 +124,26 @@ after use.
If the
.Fa buf
argument is non-null it must point to at least 41 characters of buffer space.
+.Sh ERRORS
+The
+.Fn RIPEMD160_End
+function called with a null buf argument may fail and return NULL if:
+.Bl -tag -width Er
+.It Bq Er ENOMEM
+Insufficient storage space is available.
+.El
+.Pp
+The
+.Fn RIPEMD160_File
+and
+.Fn RIPEMD160_FileChunk
+may return NULL when underlying
+.Xr open 2 ,
+.Xr fstat 2 ,
+.Xr lseek 2 ,
+or
+.Xr RIPEMD160_End 2
+fail.
.Sh SEE ALSO
.Xr md4 3 ,
.Xr md5 3 ,
diff --git a/lib/libmd/sha.3 b/lib/libmd/sha.3
index 90cc93662429..a556c82145c6 100644
--- a/lib/libmd/sha.3
+++ b/lib/libmd/sha.3
@@ -9,7 +9,7 @@
.\" From: Id: mdX.3,v 1.14 1999/02/11 20:31:49 wollman Exp
.\" $FreeBSD$
.\"
-.Dd July 20, 2018
+.Dd May 21, 2019
.Dt SHA 3
.Os
.Sh NAME
@@ -155,6 +155,26 @@ after use.
If the
.Fa buf
argument is non-null it must point to at least 41 characters of buffer space.
+.Sh ERRORS
+The
+.Fn SHA1_End
+function called with a null buf argument may fail and return NULL if:
+.Bl -tag -width Er
+.It Bq Er ENOMEM
+Insufficient storage space is available.
+.El
+.Pp
+The
+.Fn SHA1_File
+and
+.Fn SHA1_FileChunk
+may return NULL when underlying
+.Xr open 2 ,
+.Xr fstat 2 ,
+.Xr lseek 2 ,
+or
+.Xr SHA1_End 2
+fail.
.Sh SEE ALSO
.Xr md4 3 ,
.Xr md5 3 ,
diff --git a/lib/libmd/sha256.3 b/lib/libmd/sha256.3
index eeac4041f479..a6829a5ed2ea 100644
--- a/lib/libmd/sha256.3
+++ b/lib/libmd/sha256.3
@@ -146,6 +146,26 @@ argument is non-null it must point to at least 65 characters of buffer space.
.Pp
SHA224 is identical SHA256, except it has slightly different initialization
vectors, and is truncated to a shorter digest.
+.Sh ERRORS
+The
+.Fn SHA256_End
+function called with a null buf argument may fail and return NULL if:
+.Bl -tag -width Er
+.It Bq Er ENOMEM
+Insufficient storage space is available.
+.El
+.Pp
+The
+.Fn SHA256_File
+and
+.Fn SHA256_FileChunk
+may return NULL when underlying
+.Xr open 2 ,
+.Xr fstat 2 ,
+.Xr lseek 2 ,
+or
+.Xr SHA256_End 2
+fail.
.Sh SEE ALSO
.Xr md4 3 ,
.Xr md5 3 ,
diff --git a/lib/libmd/sha512.3 b/lib/libmd/sha512.3
index a842e9cada61..64981e64310c 100644
--- a/lib/libmd/sha512.3
+++ b/lib/libmd/sha512.3
@@ -9,7 +9,7 @@
.\" From: Id: mdX.3,v 1.14 1999/02/11 20:31:49 wollman Exp
.\" $FreeBSD$
.\"
-.Dd July 20, 2018
+.Dd May 21, 2019
.Dt SHA512 3
.Os
.Sh NAME
@@ -190,6 +190,26 @@ which converts the return value to a 65-character
(including the terminating '\e0')
.Tn ASCII
string which represents the 256 bits in hexadecimal.
+.Sh ERRORS
+The
+.Fn SHA512_End
+function called with a null buf argument may fail and return NULL if:
+.Bl -tag -width Er
+.It Bq Er ENOMEM
+Insufficient storage space is available.
+.El
+.Pp
+The
+.Fn SHA512_File
+and
+.Fn SHA512_FileChunk
+may return NULL when underlying
+.Xr open 2 ,
+.Xr fstat 2 ,
+.Xr lseek 2 ,
+or
+.Xr SHA512_End 2
+fail.
.Sh SEE ALSO
.Xr md4 3 ,
.Xr md5 3 ,
diff --git a/lib/libmd/skein.3 b/lib/libmd/skein.3
index 2d6a9e3fd4b1..b0278028b1bc 100644
--- a/lib/libmd/skein.3
+++ b/lib/libmd/skein.3
@@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd May 28, 2016
+.Dd May 21, 2019
.Dt SKEIN 3
.Os
.Sh NAME
@@ -188,6 +188,26 @@ functions are similar to the
.Li SKEIN256_
functions except they produce a 512-bit, 65 character,
or 1024-bit, 129 character, output.
+.Sh ERRORS
+The
+.Fn SKEIN256_End
+function called with a null buf argument may fail and return NULL if:
+.Bl -tag -width Er
+.It Bq Er ENOMEM
+Insufficient storage space is available.
+.El
+.Pp
+The
+.Fn SKEIN256_File
+and
+.Fn SKEIN256_FileChunk
+may return NULL when underlying
+.Xr open 2 ,
+.Xr fstat 2 ,
+.Xr lseek 2 ,
+or
+.Xr SKEIN256_End 2
+fail.
.Sh SEE ALSO
.Xr md4 3 ,
.Xr md5 3 ,