libsec: remove hash pickle functions, document ripemd160, cleanup sechash(2) manpage

7 files changed, 28 insertions, 149 deletions

diff --git a/sys/include/ape/libsec.h b/sys/include/ape/libsec.h
index ba339f1f9..167bcbb70 100644
--- a/sys/include/ape/libsec.h
+++ b/sys/include/ape/libsec.h
@@ -235,6 +235,7 @@ enum
 	SHA2_512dlen=	64,	/* SHA-512 digest length */
 	MD4dlen=	16,	/* MD4 digest length */
 	MD5dlen=	16,	/* MD5 digest length */
+	RIPEMD160dlen=	20,	/* RIPEMD-160 digest length */
 	Poly1305dlen=	16,	/* Poly1305 digest length */
 
 	Hmacblksz	= 64,	/* in bytes; from rfc2104 */
@@ -264,6 +265,7 @@ typedef struct DigestState MD4state;
 
 DigestState*	md4(uchar*, ulong, uchar*, DigestState*);
 DigestState*	md5(uchar*, ulong, uchar*, DigestState*);
+DigestState*	ripemd160(uchar *, ulong, uchar *, DigestState *);
 DigestState*	sha1(uchar*, ulong, uchar*, DigestState*);
 DigestState*	sha2_224(uchar*, ulong, uchar*, DigestState*);
 DigestState*	sha2_256(uchar*, ulong, uchar*, DigestState*);
@@ -279,11 +281,6 @@ DigestState*	hmac_sha2_224(uchar*, ulong, uchar*, ulong, uchar*, DigestState*);
 DigestState*	hmac_sha2_256(uchar*, ulong, uchar*, ulong, uchar*, DigestState*);
 DigestState*	hmac_sha2_384(uchar*, ulong, uchar*, ulong, uchar*, DigestState*);
 DigestState*	hmac_sha2_512(uchar*, ulong, uchar*, ulong, uchar*, DigestState*);
-char*		md5pickle(MD5state*);
-MD5state*	md5unpickle(char*);
-char*		sha1pickle(SHA1state*);
-SHA1state*	sha1unpickle(char*);
-
 DigestState*	poly1305(uchar*, ulong, uchar*, ulong, uchar*, DigestState*);
 
 /*
@@ -562,8 +559,6 @@ void	secp256r1(mpint *p, mpint *a, mpint *b, mpint *x, mpint *y, mpint *n, mpint
 void	secp256k1(mpint *p, mpint *a, mpint *b, mpint *x, mpint *y, mpint *n, mpint *h);
 void	secp384r1(mpint *p, mpint *a, mpint *b, mpint *x, mpint *y, mpint *n, mpint *h);
 
-DigestState*	ripemd160(uchar *, ulong, uchar *, DigestState *);
-
 /*
  * Diffie-Hellman key exchange
  */
diff --git a/sys/include/libsec.h b/sys/include/libsec.h
index fd063ebc0..1fa37a621 100644
--- a/sys/include/libsec.h
+++ b/sys/include/libsec.h
@@ -227,6 +227,7 @@ enum
 	SHA2_512dlen=	64,	/* SHA-512 digest length */
 	MD4dlen=	16,	/* MD4 digest length */
 	MD5dlen=	16,	/* MD5 digest length */
+	RIPEMD160dlen=	20,	/* RIPEMD-160 digest length */
 	Poly1305dlen=	16,	/* Poly1305 digest length */
 
 	Hmacblksz	= 64,	/* in bytes; from rfc2104 */
@@ -256,6 +257,7 @@ typedef struct DigestState MD4state;
 
 DigestState*	md4(uchar*, ulong, uchar*, DigestState*);
 DigestState*	md5(uchar*, ulong, uchar*, DigestState*);
+DigestState*	ripemd160(uchar *, ulong, uchar *, DigestState *);
 DigestState*	sha1(uchar*, ulong, uchar*, DigestState*);
 DigestState*	sha2_224(uchar*, ulong, uchar*, DigestState*);
 DigestState*	sha2_256(uchar*, ulong, uchar*, DigestState*);
@@ -271,11 +273,6 @@ DigestState*	hmac_sha2_224(uchar*, ulong, uchar*, ulong, uchar*, DigestState*);
 DigestState*	hmac_sha2_256(uchar*, ulong, uchar*, ulong, uchar*, DigestState*);
 DigestState*	hmac_sha2_384(uchar*, ulong, uchar*, ulong, uchar*, DigestState*);
 DigestState*	hmac_sha2_512(uchar*, ulong, uchar*, ulong, uchar*, DigestState*);
-char*		md5pickle(MD5state*);
-MD5state*	md5unpickle(char*);
-char*		sha1pickle(SHA1state*);
-SHA1state*	sha1unpickle(char*);
-
 DigestState*	poly1305(uchar*, ulong, uchar*, ulong, uchar*, DigestState*);
 
 /*
@@ -554,8 +551,6 @@ void	secp256r1(mpint *p, mpint *a, mpint *b, mpint *x, mpint *y, mpint *n, mpint
 void	secp256k1(mpint *p, mpint *a, mpint *b, mpint *x, mpint *y, mpint *n, mpint *h);
 void	secp384r1(mpint *p, mpint *a, mpint *b, mpint *x, mpint *y, mpint *n, mpint *h);
 
-DigestState*	ripemd160(uchar *, ulong, uchar *, DigestState *);
-
 /*
  * Diffie-Hellman key exchange
  */
diff --git a/sys/man/2/sechash b/sys/man/2/sechash
index 2f1c85438..c93801367 100644
--- a/sys/man/2/sechash
+++ b/sys/man/2/sechash
@@ -1,12 +1,9 @@
 .TH SECHASH 2
 .SH NAME
-md4, md5,
+md4, md5, ripemd160,
 sha1, sha2_224, sha2_256, sha2_384, sha2_512,
-ripemd160, poly1305,
-hmac_x, hmac_md5,
-hmac_sha1, hmac_sha2_224, hmac_sha2_256, hmac_sha2_384, hmac_sha2_512,
-md5pickle, md5unpickle,
-sha1pickle, sha1unpickle \- cryptographically secure hashes
+hmac_x, hmac_md5, hmac_sha1, hmac_sha2_224, hmac_sha2_256, hmac_sha2_384, hmac_sha2_512,
+poly1305 \- cryptographically secure hashes
 .SH SYNOPSIS
 .nr Wd \w'\fLDS* \fP'u
 .nr In \w'\fLDS*   \fP'u
@@ -33,20 +30,10 @@ sha1pickle, sha1unpickle \- cryptographically secure hashes
 DS*	md4(uchar *data, ulong dlen, uchar *digest, DS *state)
 .Ti
 DS*	md5(uchar *data, ulong dlen, uchar *digest, DS *state)
-.PP
-.B
-char*	md5pickle(MD5state *state)
-.PP
-.B
-MD5state*	md5unpickle(char *p);
+.Ti
+DS*	ripemd160(uchar *data, ulong dlen, uchar *digest, DS *state)
 .Ti
 DS*	sha1(uchar *data, ulong dlen, uchar *digest, DS *state)
-.PP
-.B
-char*	sha1pickle(SHA1state *state)
-.PP
-.B
-SHA1state*	sha1unpickle(char *p);
 .Ti
 DS*	sha2_224(uchar *data, ulong dlen, uchar *digest, DS *state)
 .Ti
@@ -56,10 +43,6 @@ DS*	sha2_384(uchar *data, ulong dlen, uchar *digest, DS *state)
 .Ti
 DS*	sha2_512(uchar *data, ulong dlen, uchar *digest, DS *state)
 .Ti
-DS*	ripemd160(uchar *data, ulong dlen, uchar *digest, DS *state)
-.Ti
-DS*	poly1305(uchar *p, ulong len, uchar *key, ulong klen, uchar *digest, DS *state)
-.Ti
 DS*	hmac_x(uchar *p, ulong len, uchar *key, ulong klen, uchar *digest, DS *s, DS*(*x)(uchar*, ulong, uchar*, DS*), int xlen)
 .Ti
 DS*	hmac_md5(uchar *data, ulong dlen, uchar *key, ulong klen, uchar *digest, DS *state)
@@ -73,35 +56,28 @@ DS*	hmac_sha2_256(uchar *data, ulong dlen, uchar *key, ulong klen, uchar *digest
 DS*	hmac_sha2_384(uchar *data, ulong dlen, uchar *key, ulong klen, uchar *digest, DS *state)
 .Ti
 DS*	hmac_sha2_512(uchar *data, ulong dlen, uchar *key, ulong klen, uchar *digest, DS *state)
+.Ti
+DS*	poly1305(uchar *p, ulong len, uchar *key, ulong klen, uchar *digest, DS *state)
 .SH DESCRIPTION
 .DT
-We support several secure hash functions.  The output of a
-hash is called a
+The output of a hash is called a
 .IR digest .
 A hash is secure if, given the hashed data and the digest,
 it is difficult to predict the change to the digest resulting
 from some change to the data without rehashing
 the whole data.  Therefore, if a secret is part of the hashed
-data, the digest can be used as an integrity check of the data by anyone
-possessing the secret.
+data, the digest can be used as an integrity check of the data
+by anyone possessing the secret.
 .PP
 The routines
 .IR md4 ,
 .IR md5 ,
+.IR ripemd160 ,
 .IR sha1 ,
 .IR sha2_224 ,
 .IR sha2_256 ,
 .IR sha2_384 ,
 .IR sha2_512 ,
-.IR ripemd160 ,
-.IR poly1305 ,
-.IR hmac_md5 ,
-.IR hmac_sha1 ,
-.IR hmac_sha2_224 ,
-.IR hmac_sha2_256 ,
-.IR hmac_sha2_384 ,
-and
-.IR hmac_sha2_512
 differ only in the length of the resulting digest
 and in the security of the hash.
 .I Sha2_*
@@ -126,13 +102,14 @@ This last call will free the state and copy the result into
 The constants
 .IR MD4dlen ,
 .IR MD5dlen ,
+.IR RIPEMD160dlen ,
 .IR SHA1dlen ,
 .IR SHA2_224dlen ,
 .IR SHA2_256dlen ,
-.IR SHA2_384dlen,
-.IR SHA2_512dlen ,
+.IR SHA2_384dlen ,
+.I SHA2_512dlen
 and
-.I AESdlen
+.I Poly1305dlen
 define the lengths of the digests.
 .PP
 .IR Hmac_md5 ,
@@ -140,34 +117,25 @@ define the lengths of the digests.
 .IR hmac_sha2_224 ,
 .IR hmac_sha2_256 ,
 .IR hmac_sha2_384 ,
+.I hmac_sha2_512
 and
-.IR hmac_sha2_512
+.I poly1305
 are used slightly differently.  These hash algorithms are keyed and require
 a key to be specified on every call.
 The digest lengths for these hashes are the obvious ones from
 the above list of length constants.
-These routines all call
+The
+.I hmac_*
+routines all call
 .I hmac_x
 internally, but
 .I hmac_x
 is not intended for general use.
 .PP
-.IR Poly1305
-is a one-time authenticator designed by D. J. Bernstein. It takes a 32-byte
-one-time key and a message and produces a 16-byte tag.
-.PP
-The functions
-.I md5pickle
-and
-.I sha1pickle
-marshal the state of a digest for transmission.
-.I Md5unpickle
-and
-.I sha1unpickle
-unmarshal a pickled digest.
-All four routines return a pointer to a newly
-.IR malloc (2)'d
-object.
+.I Poly1305
+is a one-time authenticator designed by D. J. Bernstein is documented in
+.IR RFC8439 .
+It takes a 32-byte one-time key and a message and produces a 16-byte tag.
 .SH EXAMPLES
 To hash a single buffer using
 .IR md5 :
diff --git a/sys/src/ape/lib/sec/port/mkfile b/sys/src/ape/lib/sec/port/mkfile
index 54d96bb8a..6ff703857 100644
--- a/sys/src/ape/lib/sec/port/mkfile
+++ b/sys/src/ape/lib/sec/port/mkfile
@@ -8,7 +8,6 @@ CFILES = des.c desmodes.c desECB.c desCBC.c des3ECB.c des3CBC.c\
 	blowfish.c \
 	hmac.c md5.c md5block.c md4.c sha1.c sha1block.c\
 	sha2_64.c sha2_128.c sha2block64.c sha2block128.c\
-	sha1pickle.c md5pickle.c\
 	poly1305.c\
 	rc4.c\
 	chacha.c chachablock.c\
diff --git a/sys/src/libsec/port/md5pickle.c b/sys/src/libsec/port/md5pickle.c
deleted file mode 100644
index a3adb51f3..000000000
--- a/sys/src/libsec/port/md5pickle.c
+++ /dev/null
@@ -1,39 +0,0 @@
-#include "os.h"
-#include <libsec.h>
-
-char*
-md5pickle(MD5state *s)
-{
-	char *p;
-	int m, n;
-
-	m = 17+4*9+4*((s->blen+3)/3 + 1);
-	p = malloc(m);
-	if(p == nil)
-		return p;
-	n = sprint(p, "%16.16llux %8.8ux %8.8ux %8.8ux %8.8ux ",
-		s->len,
-		s->state[0], s->state[1], s->state[2],
-		s->state[3]);
-	enc64(p+n, m-n, s->buf, s->blen);
-	return p;
-}
-
-MD5state*
-md5unpickle(char *p)
-{
-	MD5state *s;
-
-	s = malloc(sizeof(*s));
-	if(s == nil)
-		return nil;
-	s->len = strtoull(p, &p, 16);
-	s->state[0] = strtoul(p, &p, 16);
-	s->state[1] = strtoul(p, &p, 16);
-	s->state[2] = strtoul(p, &p, 16);
-	s->state[3] = strtoul(p, &p, 16);
-	s->blen = dec64(s->buf, sizeof(s->buf), p, strlen(p));
-	s->malloced = 1;
-	s->seeded = 1;
-	return s;
-}
diff --git a/sys/src/libsec/port/mkfile b/sys/src/libsec/port/mkfile
index b6490b7bc..9628af1be 100644
--- a/sys/src/libsec/port/mkfile
+++ b/sys/src/libsec/port/mkfile
@@ -7,7 +7,6 @@ CFILES = des.c desmodes.c desECB.c desCBC.c des3ECB.c des3CBC.c\
 	blowfish.c \
 	hmac.c md5.c md5block.c md4.c sha1.c sha1block.c\
 	sha2_64.c sha2_128.c sha2block64.c sha2block128.c\
-	sha1pickle.c md5pickle.c\
 	poly1305.c\
 	rc4.c\
 	chacha.c chachablock.c\
diff --git a/sys/src/libsec/port/sha1pickle.c b/sys/src/libsec/port/sha1pickle.c
deleted file mode 100644
index 6139567b5..000000000
--- a/sys/src/libsec/port/sha1pickle.c
+++ /dev/null
@@ -1,38 +0,0 @@
-#include "os.h"
-#include <libsec.h>
-
-char*
-sha1pickle(SHA1state *s)
-{
-	char *p;
-	int m, n;
-
-	m = 5*9+4*((s->blen+3)/3);
-	p = malloc(m);
-	if(p == nil)
-		return p;
-	n = sprint(p, "%8.8ux %8.8ux %8.8ux %8.8ux %8.8ux ",
-		s->state[0], s->state[1], s->state[2],
-		s->state[3], s->state[4]);
-	enc64(p+n, m-n, s->buf, s->blen);
-	return p;
-}
-
-SHA1state*
-sha1unpickle(char *p)
-{
-	SHA1state *s;
-
-	s = malloc(sizeof(*s));
-	if(s == nil)
-		return nil;
-	s->state[0] = strtoul(p, &p, 16);
-	s->state[1] = strtoul(p, &p, 16);
-	s->state[2] = strtoul(p, &p, 16);
-	s->state[3] = strtoul(p, &p, 16);
-	s->state[4] = strtoul(p, &p, 16);
-	s->blen = dec64(s->buf, sizeof(s->buf), p, strlen(p));
-	s->malloced = 1;
-	s->seeded = 1;
-	return s;
-}