Moved big horrible table to a separate header.
[u/mdw/catacomb] / Makefile.m4
CommitLineData
d03ab969 1## -*-makefile-*-
2##
e7dc130f 3## $Id: Makefile.m4,v 1.51 2001/04/19 18:26:32 mdw Exp $
d03ab969 4##
5## Makefile for Catacomb
6##
7## (c) 1999 Straylight/Edgeware
8##
9
10##----- Licensing notice ----------------------------------------------------
11##
12## This file is part of Catacomb.
13##
14## Catacomb is free software; you can redistribute it and/or modify
15## it under the terms of the GNU Library General Public License as
16## published by the Free Software Foundation; either version 2 of the
17## License, or (at your option) any later version.
18##
19## Catacomb is distributed in the hope that it will be useful,
20## but WITHOUT ANY WARRANTY; without even the implied warranty of
21## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22## GNU Library General Public License for more details.
23##
24## You should have received a copy of the GNU Library General Public
25## License along with Catacomb; if not, write to the Free
26## Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
27## MA 02111-1307, USA.
28
29##----- Revision history ----------------------------------------------------
30##
31## $Log: Makefile.m4,v $
e7dc130f 32## Revision 1.51 2001/04/19 18:26:32 mdw
33## Add CRC as another hash function.
34##
51a0f805 35## Revision 1.50 2001/04/06 22:05:10 mdw
36## Add support for SSL pseudo-random function.
37##
d83a82be 38## Revision 1.49 2001/04/04 20:10:52 mdw
39## Add support for the TLS pseudo-random function.
40##
b348397a 41## Revision 1.48 2001/04/03 19:36:50 mdw
42## New block cipher DESX added.
43##
abef5380 44## Revision 1.47 2001/03/03 13:14:13 mdw
45## Distribute md2-tab.h
46##
d3187d77 47## Revision 1.46 2001/02/21 20:03:22 mdw
48## Added support for MD2 hash function.
49##
f2ec324f 50## Revision 1.45 2001/02/03 16:09:41 mdw
51## New files added.
52##
eee16120 53## Revision 1.44 2000/10/15 17:49:00 mdw
54## New SHA variants with longer outputs.
55##
7c0acba6 56## Revision 1.43 2000/10/08 16:01:26 mdw
57## Add binary poly arithmetic. Tidy table generation stuff. Distribute
58## calc prototypes.
59##
9312c71f 60## Revision 1.42 2000/10/08 12:16:06 mdw
61## Remove vestiges of @primorial@.
62##
3fe3eae5 63## Revision 1.41 2000/08/15 21:46:20 mdw
64## Set up the dependencies on primetab.[ch] and mptypes.h properly.
65## There's some m4 hacking, but it's worth it not to have to recompile all
66## the cipher modes.
67##
b55540f6 68## Revision 1.40 2000/08/06 10:50:55 mdw
69## (mkphrase): New program for generating random passphrases with measured
70## strength.
71##
525af7b8 72## Revision 1.39 2000/07/29 21:55:32 mdw
73## Make sure the pixie is installed setuid-root (workaround for an Automake
74## bug). Install new manpages.
75##
bc981076 76## Revision 1.38 2000/07/29 10:54:55 mdw
77## Further fixing to support building using normal `make' again. ;-) I
78## think we're there now.
79##
5a1a3a89 80## Revision 1.37 2000/07/29 10:02:36 mdw
81## Lots of fixing to support `make -j' building.
82##
c080c887 83## Revision 1.36 2000/07/20 20:13:38 mdw
84## Added Bellare and Rogaway's PSS encoding for RSA signatures.
85##
ea38161e 86## Revision 1.35 2000/07/16 20:00:46 mdw
87## Bug fixes to distribution.
88##
a16cc8cf 89## Revision 1.34 2000/07/15 20:55:32 mdw
90## More hashes and ciphers. An extra tool.
91##
817d0432 92## Revision 1.33 2000/07/09 21:34:15 mdw
93## New hash functions and other stuff.
94##
d3325040 95## Revision 1.32 2000/07/01 11:27:32 mdw
96## Name changes and new files.
97##
90484749 98## Revision 1.31 2000/06/25 13:02:07 mdw
99## Fix cleaning of generated files.
100##
1cf8e9fb 101## Revision 1.30 2000/06/22 19:10:33 mdw
102## Fix Makefile to test mp-sqrt.c.
103##
338b4cd3 104## Revision 1.29 2000/06/22 19:04:19 mdw
105## More new functions to be added.
106##
ad47fc73 107## Revision 1.28 2000/06/18 23:31:18 mdw
108## Rearrange build order to ensure that `mptypes.h' exists by the time it's
109## needed.
110##
df9ed0a1 111## Revision 1.27 2000/06/17 13:28:50 mdw
112## Minor tidying and fixing.
113##
cc44d54e 114## Revision 1.26 2000/06/17 10:33:43 mdw
115## Lots of new ciphers and other files.
116##
86a47753 117## Revision 1.25 2000/02/12 18:55:40 mdw
118## Make it all compile properly.
119##
876b4f53 120## Revision 1.24 2000/02/12 18:22:26 mdw
121## Missed a file. Whoops.
122##
052b36d0 123## Revision 1.23 2000/02/12 18:21:01 mdw
124## Overhaul of key management (again).
125##
de5585f8 126## Revision 1.22 1999/12/22 16:04:06 mdw
127## Lots of new files.
128##
6f51228e 129## Revision 1.21 1999/12/13 15:47:58 mdw
130## Fix a couple of minor bugs in the distribution set.
c08b284a 131##
b6f2c5a0 132## Revision 1.19 1999/12/11 10:58:24 mdw
133## Fix bug in test rig link flags. Add Karatsuba squaring.
134##
bba24c1d 135## Revision 1.18 1999/12/10 23:30:01 mdw
136## Lots of new files.
137##
70b904c5 138## Revision 1.17 1999/11/25 11:38:31 mdw
139## Support for conversions between MPs and C integers.
140##
9fc256e8 141## Revision 1.16 1999/11/22 20:51:33 mdw
142## Add yet more source files.
143##
02b5177b 144## Revision 1.15 1999/11/22 14:08:30 mdw
145## Improve dependencies for test programs.
146##
8b6cedcc 147## Revision 1.14 1999/11/22 00:17:09 mdw
148## Create object files for test programs so that rebuilding doesn't take so
149## long.
ce79f967 150##
151## Revision 1.12 1999/11/20 22:36:26 mdw
152## Improve dependencies. Move mpx testing into mpx.c.
44c240ee 153##
154## Revision 1.11 1999/11/20 22:24:53 mdw
155## Add Diffie-Hellman support.
a7557fb1 156##
157## Revision 1.10 1999/11/19 19:28:24 mdw
158## Add DSA files and tests.
471db039 159##
160## Revision 1.9 1999/11/17 18:05:35 mdw
161## Many new files and test cases for multiprecision arithmetic.
76f32ed2 162##
163## Revision 1.8 1999/11/13 01:56:07 mdw
164## Include multiprecision maths stuff.
a094cab7 165##
166## Revision 1.7 1999/11/11 19:01:02 mdw
167## Use `libtool' to generate a shared library.
8149619d 168##
169## Revision 1.6 1999/11/11 17:47:34 mdw
170## Updates for new configuration system, and `mptypes' generator.
748ed8dc 171##
8149619d 172## Revision 1.5 1999/11/11 00:59:17 mdw
748ed8dc 173## Minor reformatting.
3701c54f 174##
748ed8dc 175## Revision 1.4 1999/10/24 10:20:36 mdw
3701c54f 176## Modify for standalone distribution. The library's getting far too large
177## to be sensibly embedded in other programs.
d03ab969 178##
3701c54f 179## Revision 1.3 1999/10/24 10:04:26 mdw
9183ab7b 180## Install headers in the right directory.
181##
182## Revision 1.2 1999/10/23 12:55:35 mdw
d03ab969 183## The `CVS' directory can't be hardlinked. Don't worry about this
184## overmuch.
185##
a094cab7 186## Revision 1.1 1999/09/03 08:41:11 mdw
187## Initial import.
d03ab969 188##
189
190AUTOMAKE_OPTIONS = foreign
191
cc44d54e 192SUBDIRS = tests
193
d03ab969 194archincludedir = $(libdir)/catacomb/include
195
196## --- List handling macros ---
197##
198## List handling is nice, usually. Unfortunately, I based this design on
199## TeX list macros rather than anything sensible...
200
201define(`_', `define(`_item', $1)define(`_item_2', $2)emit`'')
202define(`adorn', `pushdef(`emit', `$1`'_item`'$3')$2`'popdef(`emit')')
203define(`join',
204`pushdef(`emit', `adorn(``_(''_item`$2', `$3', ``)'')`'')$1`'popdef(`emit')')
205define(`addsuffix', `adorn(`', `$1', `$2')')
206define(`lit', `adorn(`', `$1', `')')
207define(`nl', `
208')
209
210define(`allwithsuffix',
211`addsuffix(`$1', `$3') addsuffix(`$2', `$3') dnl
212addsuffix(join(`$1', `-', `$2'), `$3')')
213
214## --- Autogenerated source files ---
215
cc44d54e 216define(`ciphers', `dnl
b348397a 217_(des) _(desx) _(des3) dnl
cc44d54e 218_(idea) dnl
219_(blowfish) _(twofish) dnl
a16cc8cf 220_(tea) _(xtea) dnl
cc44d54e 221_(rc2) _(rc5) dnl
a16cc8cf 222_(skipjack) dnl
cc44d54e 223_(cast128) _(cast256) dnl
a16cc8cf 224_(square) _(rijndael) dnl
cc44d54e 225_(serpent)')
226define(`cipher_modes', `_(ecb) _(cbc) _(cfb) _(ofb) _(counter)')
d03ab969 227
817d0432 228define(`hashes', `dnl
d3187d77 229_(md5) _(md4) _(md2) _(tiger) dnl
eee16120 230_(sha) _(sha256) _(sha384) _(sha512) dnl
817d0432 231_(rmd128) _(rmd160) _(rmd256) _(rmd320)')
cc44d54e 232define(`hash_modes', `_(mgf) _(hmac)')
d03ab969 233
234MODES = \
235 adorn(`$(srcdir)/', join(`ciphers', `-', `cipher_modes'), `.c') \
236 adorn(`$(srcdir)/', join(`ciphers', `-', `cipher_modes'), `.h') \
237 adorn(`$(srcdir)/', join(`hashes', `-', `hash_modes'), `.c') \
238 adorn(`$(srcdir)/', join(`hashes', `-', `hash_modes'), `.h')
239
5a1a3a89 240$(MODES): modes-stamp
241modes-stamp: genmodes
a7557fb1 242 cd $(srcdir); ./genmodes "lit(`ciphers')" "lit(`cipher_modes')"
243 cd $(srcdir); ./genmodes "lit(`hashes')" "lit(`hash_modes')"
5a1a3a89 244 echo datestamp >modes-stamp
245
bc981076 246define(`gen_tables', `dnl
5a1a3a89 247_(des) _(blowfish) _(twofish) _(square) _(rijndael) _(tiger) dnl
7c0acba6 248_(gfshare) _(gfx-sqr)')
a7557fb1 249
bc981076 250autoheaders: addsuffix(`gen_tables', `-tab.h') primetab.h mptypes.h
5a1a3a89 251define(`emit', `
252_item`'-tab.h: _item`'-mktab
253 ./_item`'-mktab >_item`'-tab.h')dnl
bc981076 254gen_tables
5a1a3a89 255
256primetab.h: primetab.c
257primetab.c: genprimes
3fe3eae5 258 ./genprimes -h primetab.h -c primetab.c -n 256 \
259 -t "unsigned short" -i primetab
d03ab969 260archinclude_HEADERS = mptypes.h
d03ab969 261mptypes.h: mptypes
d03ab969 262 ./mptypes >mptypes.h
263
264BUILT_SOURCES = \
265 getdate.c \
266 addsuffix(join(`ciphers', `-', `cipher_modes'), `.c') \
267 addsuffix(join(`ciphers', `-', `cipher_modes'), `.h') \
d03ab969 268 addsuffix(join(`hashes', `-', `hash_modes'), `.c') \
269 addsuffix(join(`hashes', `-', `hash_modes'), `.h')
ffc086db 270
271## --- Building the main library ---
8582bb3b 272
ffc086db 273lib_LTLIBRARIES = libcatacomb.la
274
cc44d54e 275libcatacomb_la_LDFLAGS = -version-info 2:0:0
d03ab969 276## Middle number is the patchlevel. Final number is the minor version. The
277## difference between the first and last numbers is major version.
278
d03ab969 279pkginclude_HEADERS = \
cc44d54e 280 arena.h paranoia.h \
5a1a3a89 281 blkc.h hash.h gcipher.h ghash.h gmac.h grand.h ghash-def.h \
282 lcrand.h fibrand.h rc4.h seal.h rand.h noise.h fipstest.h maurer.h \
876b4f53 283 key.h key-data.h passphrase.h pixie.h lmem.h \
70b904c5 284 mpx.h mpw.h mpscan.h mparena.h mp.h mptext.h mpint.h \
5a1a3a89 285 mpbarrett.h mpmont.h mpcrt.h mprand.h mpmul.h \
7c0acba6 286 gfx.h \
9312c71f 287 primetab.h pfilt.h rabin.h \
f2ec324f 288 pgen.h prim.h strongprime.h limlee.h keycheck.h \
052b36d0 289 bbs.h rsa.h dh.h dsarand.h dsa.h \
51a0f805 290 oaep.h pkcs1.h pss.h tlsprf.h sslprf.h \
cc44d54e 291 gfshare.h share.h \
817d0432 292 rho.h \
d03ab969 293 allwithsuffix(`ciphers', `cipher_modes', `.h') \
bba24c1d 294 allwithsuffix(`hashes', `hash_modes', `.h') \
295 addsuffix(`cipher_modes', `-def.h') \
e7dc130f 296 addsuffix(`hash_modes', `-def.h') crc32.h
d03ab969 297
3fe3eae5 298define(`MP_SOURCES',
299 `mpx.c mpx-kmul.c mpx-ksqr.c mpscan.c mparena.c \
a7557fb1 300 mp-misc.c mp-mem.c mp-const.c mp-io.c mp-arith.c mp-test.c \
338b4cd3 301 mp-sqrt.c mp-gcd.c mp-jacobi.c mp-modsqrt.c \
5a1a3a89 302 mpint.c mptext.c mptext-file.c mptext-string.c mptext-dstr.c \
303 mpbarrett.c mpmont.c mpmont-mexp.c mpcrt.c mpmul.c mprand.c \
3fe3eae5 304 rho.c \
7c0acba6 305 GF_SOURCES PGEN_SOURCES')
306
307define(`GF_SOURCES',
308 `gfx.c gfx-kmul.c gfx-sqr.c')
3fe3eae5 309
310define(`PGEN_SOURCES',
9312c71f 311 `pfilt.c rabin.c \
cc44d54e 312 pgen.c pgen-stdev.c pgen-safe.c pgen-gcd.c prim.c strongprime.c \
817d0432 313 limlee.c \
f2ec324f 314 keycheck.c keycheck-mp.c keycheck-report.c \
cc44d54e 315 bbs-rand.c bbs-gen.c bbs-jump.c bbs-fetch.c \
d3325040 316 rsa-priv.c rsa-pub.c rsa-gen.c rsa-recover.c rsa-fetch.c \
f2ec324f 317 dh-gen.c dh-limlee.c dh-check.c dh-fetch.c \
318 dsarand.c dsa-sign.c dsa-verify.c dsa-gen.c dsa-check.c \
ad47fc73 319 key-data.c key-flags.c key-text.c key-binary.c key-pass.c \
5a1a3a89 320 key-pack.c key-misc.c key-file.c key-attr.c key-io.c key-moan.c \
bc981076 321 key-error.c key-fetch.c \
3fe3eae5 322 primetab.c share.c')
323
324libcatacomb_la_SOURCES = \
325 grand.c keysz.c \
326 lcrand.c fibrand.c rc4.c seal.c rand.c noise.c fipstest.c maurer.c \
327 arena.c \
328 passphrase.c pixie-client.c pixie-common.c lmem.c \
51a0f805 329 oaep.c pkcs1.c pss.c tlsprf.c sslprf.c \
3fe3eae5 330 gfshare.c \
7c0acba6 331 MP_SOURCES karatsuba.h \
3fe3eae5 332 des-base.c des-base.h \
333 cast-s.c cast-sk.c cast-base.h cast-tab.h \
abef5380 334 md2-tab.h \
3fe3eae5 335 serpent-sbox.h skipjack-tab.h tiger-base.h \
336 daftstory.h \
d03ab969 337 addsuffix(join(`ciphers', `-', `cipher_modes'), `.c') \
ce79f967 338 addsuffix(join(`hashes', `-', `hash_modes'), `.c') \
e7dc130f 339 addsuffix(`ciphers', `.c') addsuffix(`hashes', `.c') crc32.c
76f32ed2 340
cc44d54e 341des-base.lo: des-tab.h
342blowfish.lo: blowfish-tab.h
343twofish.lo: twofish-tab.h
a16cc8cf 344square.lo: square-tab.h
cc44d54e 345rijndael.lo: rijndael-tab.h
a16cc8cf 346tiger.lo: tiger-tab.h
5a1a3a89 347gfshare.lo: gfshare-tab.h
7c0acba6 348gfx-sqr.lo: gfx-sqr-tab.h
3fe3eae5 349patsubst(MP_SOURCES, `\.c\>', `.lo') dsig.o keyutil.o rspit.o: mptypes.h
350patsubst(PGEN_SOURCES, `\.c\>', `.lo') dsig.o keyutil.o rspit.o: primetab.h
748ed8dc 351
d03ab969 352## --- Utility programs ---
a7557fb1 353
b55540f6 354bin_PROGRAMS = dsig key pixie rspit factorial hashsum mkphrase
de5585f8 355bin_SCRIPTS = catacomb-config xpixie
cc44d54e 356noinst_PROGRAMS = \
7c0acba6 357 genprimes mptypes serpent-check \
358 addsuffix(`gen_tables', `-mktab')
d03ab969 359LDADD = libcatacomb.la
a094cab7 360
cc44d54e 361dsig_SOURCES = dsig.c getdate.y getdate.h
a094cab7 362key_SOURCES = keyutil.c getdate.y getdate.h
a16cc8cf 363hashsum_SOURCES = hashsum.c
bba24c1d 364rspit_SOURCES = rspit.c
817d0432 365factorial_SOURCES = factorial.c
a16cc8cf 366pixie_SOURCES = pixie.c pixie-common.c lmem.c arena.c
367pixie_LDADD =
b55540f6 368mkphrase_SOURCES = mkphrase.c
817d0432 369
7c0acba6 370define(`emit', `
371patsubst(_item, `[^a-zA-Z0-9]', `_')_mktab_SOURCES = _item`'-mktab.c
372patsubst(_item, `[^a-zA-Z0-9]', `_')_mktab_LDADD =')dnl
373gen_tables
374
cc44d54e 375serpent_check_SOURCES = serpent-check.c
376serpent_check_LDADD =
cc44d54e 377
d03ab969 378genprimes_SOURCES = genprimes.c
379genprimes_LDADD =
380
381mptypes_SOURCES = mptypes.c
382mptypes_LDADD =
383
de5585f8 384## --- Install the pixie setuid-root if we can ---
525af7b8 385##
386## Bodge around a bug in Automake: it doesn't call `install-exec-hook' from
387## `install' if there are subdirectories.
de5585f8 388
389changequote(<, >)
525af7b8 390install: install-exec-hook
de5585f8 391install-exec-hook:
392 @pixie="$(bindir)/`echo pixie|sed $(transform)`"; \
393 if chown root $$pixie && chmod 4755 $$pixie; then \
394 echo "chown root $$pixie"; \
395 echo "chmod 4755 $$pixie"; \
396 else \
397 echo "***"; \
398 echo "*** You should probably install $$pixie setuid-root."; \
399 echo "***"; \
400 fi
401changequote(`, ')
402
d03ab969 403## --- Documentation ---
404
525af7b8 405man_MANS = key.1 hashsum.1 keyring.5 pixie.1
d03ab969 406
407## --- Other handy definitions ---
9183ab7b 408
6f51228e 409EXTRA_DIST = \
de5585f8 410 Makefile.m4 genmodes $(man_MANS) xpixie \
6f51228e 411 README.cipher README.hash README.random README.mp
d03ab969 412
413dist-hook:
414 @ln getdate.c $(distdir) || ln $(srcdir)/getdate.c $(distdir) || true
5a1a3a89 415 @echo datestamp >$(distdir)/modes-stamp || true
7c0acba6 416 @for i in calc tests; do \
417 mkdir $(distdir)/$$i; \
418 ln $(srcdir)/$$i/*[!~] $(distdir)/$$i; \
419 done || true
cc44d54e 420# kr=$$HOME/.catacomb/dsig-keyring; \
421# if [ -r $$kr ]; then \
422# cd $(distdir); \
423# ../key -k $$kr extract -f -secret KEYRING; \
424# find . -type f -print0 | ../dsig -k $$kr sign -0 -oMANIFEST; \
425# fi
471db039 426
a094cab7 427## --- Testing ---
d03ab969 428
471db039 429define(`testprogs', `')
430
431define(`CTESTRIG',
ffc086db 432`define(`testprogs', testprogs \
d03ab969 433 $1.t)dnl
8b6cedcc 434$1.to: $1.c
435 $(COMPILE) -c -DTEST_RIG -DSRCDIR=\"$(srcdir)\" $(srcdir)/$1.c -o $1.to
bba24c1d 436$1.t: $1.to $1.o libcatacomb.la
b6f2c5a0 437 $(CC) $(CFLAGS) $(LDFLAGS) $1.to .libs/libcatacomb.a $(LIBS) -o $1.t')
a7557fb1 438
439CTESTRIG(rc4)
cc44d54e 440CTESTRIG(seal)
a7557fb1 441adorn(`nl`'CTESTRIG(', `ciphers', `)')
ce79f967 442adorn(`nl`'CTESTRIG(', `hashes', `)')
471db039 443adorn(`nl`'CTESTRIG(', join(`ciphers', `-', `cipher_modes'), `)')
444adorn(`nl`'CTESTRIG(', join(`hashes', `-', `hash_modes'), `)')
bba24c1d 445CTESTRIG(lcrand)
a16cc8cf 446CTESTRIG(oaep)
d83a82be 447CTESTRIG(tlsprf)
51a0f805 448CTESTRIG(sslprf)
471db039 449CTESTRIG(mpx)
bba24c1d 450CTESTRIG(mpx-kmul)
b6f2c5a0 451CTESTRIG(mpx-ksqr)
a7557fb1 452CTESTRIG(mp-arith)
1cf8e9fb 453CTESTRIG(mp-modsqrt)
a7557fb1 454CTESTRIG(mp-gcd)
9fc256e8 455CTESTRIG(mp-jacobi)
1cf8e9fb 456CTESTRIG(mp-sqrt)
bba24c1d 457CTESTRIG(mptext)
70b904c5 458CTESTRIG(mpint)
bba24c1d 459CTESTRIG(mpbarrett)
a7557fb1 460CTESTRIG(mpmont)
461CTESTRIG(mpmont-mexp)
9fc256e8 462CTESTRIG(mpcrt)
817d0432 463CTESTRIG(mpmul)
7c0acba6 464CTESTRIG(gfx)
465CTESTRIG(gfx-kmul)
a7557fb1 466CTESTRIG(pgen)
471db039 467CTESTRIG(dsa-gen)
468CTESTRIG(dsa-sign)
d03ab969 469CTESTRIG(dsa-verify)
bba24c1d 470CTESTRIG(bbs-rand)
471CTESTRIG(bbs-jump)
cc44d54e 472CTESTRIG(gfshare)
473CTESTRIG(share)
817d0432 474CTESTRIG(rho)
a7557fb1 475
a16cc8cf 476TESTS = serpent-check testprogs
d03ab969 477
cc44d54e 478CLEANFILES = \
479 *.t *.to \
480 mptypes.h primetab.c primetab.h \
bc981076 481 addsuffix(`gen_tables', `-tab.h')
d03ab969 482
483## --- Makefile building (haha!) ---
484
485$(srcdir)/Makefile.am: $(srcdir)/Makefile.m4
486 m4 $(srcdir)/Makefile.m4 >$(srcdir)/Makefile.am
a7557fb1 487
9312c71f 488DISTCLEANFILES = libtool
489
a7557fb1 490MAINTAINERCLEANFILES = \
d03ab969 491 $(srcdir)/Makefile.am \
492 $(srcdir)/getdate.c getdate.c \
5a1a3a89 493 $(MODES) modes-stamp $(srcdir)/modes-stamp
d03ab969 494
495##----- That's all, folks ---------------------------------------------------