tests/fake-pinentries: fake pinentries for downstream developers.
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Wed, 14 Sep 2016 19:55:13 +0000 (15:55 -0400)
committerJustus Winter <justus@g10code.com>
Thu, 15 Sep 2016 08:28:23 +0000 (10:28 +0200)
* tests/fake-pinentries/README.txt and
  tests/fake-pinentries/fake-pinentry.{sh,py,pl,php}}: New public
  domain (CC0) files to encourage better test suite practices from
  downstream developers.
* tests/fake-pinentries/COPYING (new): a copy of
  https://creativecommons.org/publicdomain/zero/1.0/legalcode.txt

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
tests/fake-pinentries/COPYING [new file with mode: 0644]
tests/fake-pinentries/README.txt [new file with mode: 0644]
tests/fake-pinentries/fake-pinentry.php [new file with mode: 0755]
tests/fake-pinentries/fake-pinentry.pl [new file with mode: 0755]
tests/fake-pinentries/fake-pinentry.py [new file with mode: 0755]
tests/fake-pinentries/fake-pinentry.sh [new file with mode: 0755]

diff --git a/tests/fake-pinentries/COPYING b/tests/fake-pinentries/COPYING
new file mode 100644 (file)
index 0000000..0e259d4
--- /dev/null
@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.
diff --git a/tests/fake-pinentries/README.txt b/tests/fake-pinentries/README.txt
new file mode 100644 (file)
index 0000000..1b447c4
--- /dev/null
@@ -0,0 +1,37 @@
+Fake Pinentries for Test Suites
+===============================
+
+If you're writing a test suite, it should use one of these pinentries
+by setting the following line in $GNUPGHOME/gpg-agent.conf:
+
+    pinentry-program /path/to/fake-pinentry.ext
+
+Note that different fake-pinentry programs have been supplied here in
+different languages, with the intent of making them available to
+developers who have different languages available.
+
+They are all licensed Creative Commons Zero (CC0-1.0-Universal, see
+the COPYING file in this directory), so they should be reusable by any
+project.  Feel free to copy them into your own project's test suite.
+
+Rationale
+---------
+
+If you're implementing software that uses GnuPG, you probably want a
+test suite that exercises your code, and you may have some that
+involve secret key material locked with a passphrase.  However, you
+don't want to require your developers to manually enter a passphrase
+while tests are run, and you probably also don't want to deal with
+alternate codepaths/workflows like using gpg's loopback pinentry.
+
+The solution for this is to use a fake pinentry in your test suite,
+one that simply returns a pre-selected passphrase.  In this case, all
+the other code follows the same path as normal, but the user
+interaction is bypassed because the fake-pinentry is used instead.
+
+Troubleshooting
+---------------
+
+If you have any trouble with this technique, please drop a line to the
+GnuPG development mailing list <gnupg-devel@gnupg.org> or open a
+report on the GnuPG bug tracker at https://bugs.gnupg.org/gnupg
diff --git a/tests/fake-pinentries/fake-pinentry.php b/tests/fake-pinentries/fake-pinentry.php
new file mode 100755 (executable)
index 0000000..bc4088f
--- /dev/null
@@ -0,0 +1,27 @@
+#!/usr/bin/php
+<?php
+# Use this for your test suites when a PHP interpreter is available.
+#
+# The encrypted keys in your test suite that you expect to work must
+# be locked with a passphrase of "passphrase"
+#
+# Author: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
+#
+# License: Creative Commons Zero ("Public Domain Dedication") --
+# Anyone may reuse it, modify it, redistribute it for any purpose.
+
+print("OK This is only for test suites, and should never be used in production\n");
+while (true) {
+    $line = fgets(STDIN);
+    if (False === $line)
+        break;
+    $line = strtolower(trim($line));
+    if (($line === "") || ($line[0] == '#'))
+        continue;
+    if ((0 === strncmp("getpin", $line, 6)))
+        print("D passphrase\n");
+    print("OK\n");
+    if ((0 === strncmp("bye", $line, 3)))
+        break;
+}
+?>
diff --git a/tests/fake-pinentries/fake-pinentry.pl b/tests/fake-pinentries/fake-pinentry.pl
new file mode 100755 (executable)
index 0000000..8cb337d
--- /dev/null
@@ -0,0 +1,27 @@
+#!/usr/bin/perl -w
+# Use this for your test suites when a perl interpreter is available.
+#
+# The encrypted keys in your test suite that you expect to work must
+# be locked with a passphrase of "passphrase"
+#
+# Author: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
+#
+# License: Creative Commons Zero ("Public Domain Dedication") --
+# Anyone may reuse it, modify it, redistribute it for any purpose.
+
+use strict;
+use warnings;
+
+# turn off buffering
+$| = 1;
+
+print "OK This is only for test suites, and should never be used in production\n";
+while (<STDIN>) {
+  chomp;
+  next if (/^$/);
+  next if (/^#/);
+  print ("D passphrase\n") if (/^getpin/i);
+  print "OK\n";
+  exit if (/^bye/i);
+}
+1;
diff --git a/tests/fake-pinentries/fake-pinentry.py b/tests/fake-pinentries/fake-pinentry.py
new file mode 100755 (executable)
index 0000000..78735c9
--- /dev/null
@@ -0,0 +1,30 @@
+#!/usr/bin/env python
+# Use this for your test suites when a python interpreter is available.
+#
+# The encrypted keys in your test suite that you expect to work must
+# be locked with a passphrase of "passphrase"
+#
+# Author: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
+#
+# License: Creative Commons Zero ("Public Domain Dedication") --
+# Anyone may reuse it, modify it, redistribute it for any purpose.
+
+import sys, os
+
+# turn off buffering:
+sys.stdin = os.fdopen(sys.stdin.fileno(), 'r', 0)
+sys.stdout = os.fdopen(sys.stdout.fileno(), 'w', 0)
+
+print("OK This is only for test suites, and should never be used in production")
+while True:
+    ln = sys.stdin.readline()
+    if (ln == ''):
+        break
+    ln = ln.lower()
+    if (ln.strip() == '') or (ln.startswith('#')):
+        continue
+    if (ln.startswith('getpin')):
+        sys.stdout.write('D passphrase\n')
+    sys.stdout.write('OK\n')
+    if (ln.startswith('bye')):
+        break
diff --git a/tests/fake-pinentries/fake-pinentry.sh b/tests/fake-pinentries/fake-pinentry.sh
new file mode 100755 (executable)
index 0000000..44aca21
--- /dev/null
@@ -0,0 +1,33 @@
+#!/bin/sh
+# Use this for your test suites when a POSIX shell is available.
+#
+# The encrypted keys in your test suite that you expect to work must
+# be locked with a passphrase of "passphrase"
+#
+# Author: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
+#
+# License: Creative Commons Zero ("Public Domain Dedication") --
+# Anyone may reuse it, modify it, redistribute it for any purpose.
+
+echo "OK This is only for test suites, and should never be used in production"
+while read cmd rest; do
+    cmd=$(printf "%s" "$cmd" | tr 'A-Z' 'a-z')
+    if [ -z "$cmd" ]; then
+        continue;
+    fi
+    case "$cmd" in
+        \#*)
+        ;;
+        getpin)
+            echo "D passphrase"
+            echo "OK"
+            ;;
+        bye)
+            echo "OK"
+            exit 0
+            ;;
+        *)
+            echo "OK"
+            ;;
+    esac
+done