Remove preprocessor tests for OpenSSL. It's a requirement.

[citadel.git] / citadel / tests / dkimtester / README.md

diff --git a/citadel/tests/dkimtester/README.md b/citadel/tests/dkimtester/README.md
index 4d46b69605d6dbde93be0001df17a74e5ac79aca..5a9d9e8912c33315bab25b24b546cdcf0e7b6ef6 100644 (file)
--- a/citadel/tests/dkimtester/README.md
+++ b/citadel/tests/dkimtester/README.md
@@ -1,13 +1,20 @@
 # dkimtester
 
-This was originally where we developed the DKIM code for Citadel
-but it is properly merged into Citadel now.  What's left is just
-a test harness.
+This is a test harness for Citadel's DKIM signing code.  It is not likely
+that you will use this program unless you're hacking on the DKIM signer
+itself.  The private key embedded in the test program matches the DKIM record
+for `dev.citadel.org` at the time this is being written.  That record looks
+like this:
 
-You must have the `Mail::DKIM::Verifier` perl module installed,
-which can be found on CPAN.
+```
+foo._domainkey.dev.citadel.org IN TXT "v=DKIM1;k=rsa;p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA37nn3HqaJEa56Ukg7MbvkA6ng/Bi/UJ2c/zeiMU3Qb+lnNdBMQXtiI0uXSiOwL4UkhCtMxhPB5KZsHnHG4nqUKnrnrXlswDGdbk+N2w95O3snu71qG4jj/ULaGBkerBtuYdluU23PdVuH3b2J8WFSY8fMCFRdH96Nub/q0LnqKNB5bxsgPf8YvRgGiS9OTpitcZzCYEr1v0PEM6u2qX9Q+lz1x7ob+bXrxJZGeY5bzNsNHE1cgMzK1IekZHJ/cTOPzT1mIIQXN4zuE6z50q6G0Bq19H3IsxPxTeiNIp9CnvGfoDDPDXhXLI7y2XvTKWPYtKcP8oCyIebdzuKqcAtSQIDAQAB"
+```
+If you intend to work with this program, that key will be long gone by the
+time you read this, and *you* don't control `dev.citadel.org` anyway, so you
+will have to create your own host name and set your own DKIM record.  You can
+use this private key if you want to, though.
 
-Also it depends on a DKIM record for `dev.citadel.org` which is
-correct at the time I am writing this.  Good luck keeping that in
-place.
+To run this test, you also must have the `Mail::DKIM::Verifier` perl module
+installed, which can be found on CPAN.
 
+Again -- this is not intended to be part of a regression test suite.