Add Cancel-Lock support in nnrpd and a secrets file

Implement Cancel-Lock support in nnrpd, based on RFC 8315 and libcanlock.

Secrets are configured in a new inn-secrets.conf file.

see #47

Author: Julien-Elie

.gitignore

@@ -188,6 +188,7 @@
 /tests/lib/artnumber.t
 /tests/lib/asprintf.t
 /tests/lib/buffer.t
+/tests/lib/canlock.t
 /tests/lib/concat.t
 /tests/lib/conffile.t
 /tests/lib/confparse.t

MANIFEST

@@ -156,6 +156,7 @@ doc/man/ident.8                       Manpage for ident resolver
 doc/man/incoming.conf.5               Manpage for incoming.conf config file
 doc/man/inews.1                       Manpage for inews frontend
 doc/man/inn-radius.conf.5             Manpage for inn-radius.conf config file
+doc/man/inn-secrets.conf.5            Manpage for inn-secrets.conf
 doc/man/inn.conf.5                    Manpage for inn.conf config file
 doc/man/innbind.8                     Manpage for innbind
 doc/man/inncheck.8                    Manpage for inncheck utility
@@ -273,6 +274,7 @@ doc/pod/ident.pod                     Master file for ident.8
 doc/pod/incoming.conf.pod             Master file for incoming.conf.5
 doc/pod/inews.pod                     Master file for inews.1
 doc/pod/inn-radius.conf.pod           Master file for inn-radius.conf.5
+doc/pod/inn-secrets.conf.pod          Master file for inn-secrets.conf.5
 doc/pod/inn.conf.pod                  Master file for inn.conf.5
 doc/pod/innbind.pod                   Master file for innbind.8
 doc/pod/inncheck.pod                  Master file for inncheck.8
@@ -422,6 +424,7 @@ include/inn/ov.h                      Header file for old overview API
 include/inn/overview.h                Header file for the overview API
 include/inn/paths.h.in                Header file for paths
 include/inn/qio.h                     Header file for quick I/O package
+include/inn/secrets.h                 Header file for the secrets struct
 include/inn/sequence.h                Header file for sequence space arithmetic
 include/inn/storage.h                 Header file for storage API
 include/inn/timer.h                   Header file for generic timers
@@ -503,6 +506,7 @@ lib/argparse.c                        Functions for parsing arguments
 lib/artnumber.c                       Manipulation of article numbers
 lib/asprintf.c                        asprintf replacement
 lib/buffer.c                          Reusable counted buffer
+lib/canlock.c                         Routines for Cancel-Lock
 lib/cleanfrom.c                       Clean out a From line
 lib/clientactive.c                    Client access to the active file
 lib/clientlib.c                       Replacement for C News library routine
@@ -557,6 +561,7 @@ lib/remopen.c                         Open a remote NNTP connection
 lib/reservedfd.c                      File descriptor reservation
 lib/resource.c                        Get process CPU usage
 lib/sd-daemon.c                       Stubs for systemd library functions
+lib/secrets.c                         Parsing and manipulating inn-secrets.conf
 lib/sendarticle.c                     Send an article, NNTP style
 lib/sendpass.c                        Send NNTP authentication
 lib/sequence.c                        Sequence space arithmetic routines
@@ -582,6 +587,7 @@ lib/xwrite.c                          write that handles partial transfers
 m4                                    Autoconf support macros (Directory)
 m4/aux-libs.m4                        Autoconf macro for extra libraries
 m4/bdb.m4                             Autoconf macros for Berkeley DB
+m4/canlock.m4                         Autoconf macros for Cancel-Lock support
 m4/cc-c-o.m4                          Autoconf macro for -c -o compiler support
 m4/cc-flags.m4                        Autoconf macro for compiler flags
 m4/compress.m4                        Autoconf macro for compress detection
@@ -668,6 +674,7 @@ samples/filter_innd.py                Sample Python filter for innd
 samples/filter_nnrpd.pl               Sample Perl filter for nnrpd
 samples/incoming.conf                 Permissions for incoming feeds
 samples/inn-radius.conf               Sample config for RADIUS authentication
+samples/inn-secrets.conf              Sample secrets file
 samples/inn.conf.in                   General INN configuration
 samples/innfeed.conf                  Outgoing feed configuration
 samples/innreport.conf.in             Log summary configuration
@@ -914,6 +921,7 @@ tests/lib                             Test suite for libinn (Directory)
 tests/lib/artnumber-t.c               Tests for lib/artnumber.c
 tests/lib/asprintf-t.c                Tests for lib/asprintf.c
 tests/lib/buffer-t.c                  Tests for lib/buffer.c
+tests/lib/canlock-t.c                 Tests for lib/canlock.c
 tests/lib/concat-t.c                  Tests for lib/concat.c
 tests/lib/conffile-t.c                Tests for lib/conffile.c
 tests/lib/confparse-t.c               Tests for lib/confparse.c

Makefile.global.in

@@ -154,9 +154,17 @@ KRB5_LIBS	= @KRB5_LIBS@
 
 ##  Systemd support.  Additional flags and libraries used when compiling or
 ##  linking code that contains systemd support.
+
 SYSTEMD_CFLAGS	= @SYSTEMD_CFLAGS@
 SYSTEMD_LIBS	= @SYSTEMD_LIBS@
 
+##  libcanlock support.  Additional flags and libraries used when compiling or
+##  linking code that contains Cancel-Lock support.
+
+CANLOCK_CPPFLAGS= @CANLOCK_CPPFLAGS@
+CANLOCK_LDFLAGS	= @CANLOCK_LDFLAGS@
+CANLOCK_LIBS	= $(abs_builddir)/lib/canlock$(LIBSUFFIX).o @CANLOCK_LIBS@
+
 ##  Missing functions.	If non-empty, configure detected that your system
 ##  was missing some standard functions, and INN will be providing its own
 ##  replacements from the lib directory.

TODO

@@ -411,10 +411,6 @@ Requested New Features
   of stuff that Russ has copies of, for example.  [Patches included in
   tickets #133 and #134.]
 
-* There are various available patches for Cancel-Lock and an Internet
-  draft; support should be added to INN for both generation and
-  verification (definitely optional and not on by default at this point).
-
 * It would be nice to be able to reload inn.conf (although difficult, due
   to the amount of data that's generated from it and stashed in various
   places).

ci/apt-packages

@@ -4,6 +4,7 @@
 ##  line, to install for testing.
 
 default-mta
+libcanlock-dev
 libdb5.3-dev
 libgd-perl
 libkrb5-dev

ci/test

@@ -31,7 +31,8 @@ make test
 
 # Test --enable-keywords and disabling optional dependencies.
 make distclean
-./configure CC="$COMPILER" --enable-keywords --without-bdb --without-krb5 \
-    --without-openssl --without-sasl --without-sqlite3 --without-zlib
+./configure CC="$COMPILER" --enable-keywords --without-bdb --without-canlock \
+    --without-krb5 --without-openssl --without-sasl --without-sqlite3 \
+    --without-zlib
 make warnings
 make test

configure.ac

@@ -37,6 +37,7 @@ m4_define_default([AM_CONDITIONAL], [:])
 dnl Lots of our macros are stored in separate files for ease of maintenance.
 m4_include([m4/aux-libs.m4])
 m4_include([m4/bdb.m4])
+m4_include([m4/canlock.m4])
 m4_include([m4/cc-c-o.m4])
 m4_include([m4/cc-flags.m4])
 m4_include([m4/compress.m4])
@@ -426,6 +427,7 @@ fi
 dnl Handle optional libraries and probing for their locations and component
 dnl libraries if needed.
 INN_LIB_BDB_OPTIONAL
+INN_LIB_CANLOCK_OPTIONAL
 INN_LIB_KRB5_OPTIONAL
 INN_LIB_OPENSSL_OPTIONAL
 INN_LIB_SASL_OPTIONAL

doc/FAQ

@@ -108,12 +108,12 @@ Subject: 1.1. What is INN?
 The README that comes with INN has this to say (in part):
 
     INN (InterNetNews), originally written by Rich Salz, is an extremely
-    flexible and configurable Usenet / Netnews news server.  For a complete
-    description of the protocols behind Usenet and Netnews, see RFC 3977
-    (NNTP), RFC 4642 updated by RFC 8143 (TLS/NNTP), RFC 4643 (NNTP
-    authentication), RFC 4644 (streaming NNTP feeds), RFC 5536 (USEFOR),
-    RFC 5537 (USEPRO), RFC 6048 (NNTP LIST additions) and RFC 8054 (NNTP
-    compression) or their replacements.
+    flexible and configurable Usenet / Netnews news server.  For a
+    complete description of the protocols behind Usenet and Netnews, see
+    RFC 3977 (NNTP), RFC 4642 updated by RFC 8143 (TLS/NNTP), RFC 4643 (NNTP
+    authentication), RFC 4644 (streaming NNTP feeds), RFC 5536 (USEFOR), RFC
+    5537 (USEPRO), RFC 6048 (NNTP LIST additions), RFC 8054 (NNTP compression)
+    and RFC 8315 (Cancel-Lock) or their replacements.
 
     In brief, Netnews is a set of protocols for exchanging messages between
     a decentralized network of news servers.  News articles are organized

doc/man/Makefile

@@ -15,7 +15,7 @@ SEC3PM	= INN__Config.3pm \
 SEC5	= active.5 active.times.5 buffindexed.conf.5 control.ctl.5 \
 	cycbuff.conf.5 distrib.pats.5 distributions.5 expire.ctl.5 \
 	history.5 incoming.conf.5 \
-	inn.conf.5 innfeed.conf.5 innreport.conf.5 \
+	inn.conf.5 innfeed.conf.5 innreport.conf.5 inn-secrets.conf.5 \
 	innwatch.ctl.5 moderators.5 motd.news.5 \
 	newsfeeds.5 newsgroups.5 newslog.5 nnrpd.track.5 nntpsend.ctl.5 ovdb.5 \
 	ovsqlite.5 passwd.nntp.5 inn-radius.conf.5 readers.conf.5 \

doc/pod/Makefile

@@ -22,7 +22,8 @@ MAN5	= ../man/active.5 ../man/active.times.5 ../man/buffindexed.conf.5 \
 	../man/control.ctl.5 ../man/cycbuff.conf.5 ../man/distrib.pats.5 \
 	../man/distributions.5 ../man/expire.ctl.5 ../man/history.5 \
 	../man/incoming.conf.5 ../man/inn.conf.5 ../man/innfeed.conf.5 \
-	../man/innreport.conf.5 ../man/innwatch.ctl.5 ../man/moderators.5 \
+	../man/innreport.conf.5 ../man/inn-secrets.conf.5 \
+	../man/innwatch.ctl.5 ../man/moderators.5 \
 	../man/motd.news.5 ../man/newsfeeds.5 ../man/newsgroups.5 \
 	../man/newslog.5 ../man/nnrpd.track.5 ../man/nntpsend.ctl.5 \
 	../man/ovdb.5 ../man/ovsqlite.5 \
@@ -107,6 +108,7 @@ maintclean: distclean
 ../man/inn.conf.5:	inn.conf.pod		; $(POD2MAN) -s 5 $? > $@
 ../man/innfeed.conf.5:	innfeed.conf.pod	; $(POD2MAN) -s 5 $? > $@
 ../man/innreport.conf.5: innreport.conf.pod	; $(POD2MAN) -s 5 $? > $@
+../man/inn-secrets.conf.5: inn-secrets.conf.pod	; $(POD2MAN) -s 5 $? > $@
 ../man/innwatch.ctl.5:	innwatch.ctl.pod	; $(POD2MAN) -s 5 $? > $@
 ../man/moderators.5:	moderators.pod		; $(POD2MAN) -s 5 $? > $@
 ../man/motd.news.5:	motd.news.pod		; $(POD2MAN) -s 5 $? > $@