From 0e0c31e6b65ed6649411e8e531c0eee48001233c Mon Sep 17 00:00:00 2001
From: Jaapio <jaap@ijaap.nl>
Date: Fri, 20 Nov 2020 14:56:42 +0100
Subject: [PATCH 1/2] Define new interfaces for version2

---
 src/CliWrapper.php           | 35 ++++++++++++++++++++++++++++
 src/GPG.php                  | 44 ++++++++++++++++++++++++++++++++++++
 src/InvalidHomeDirectory.php | 10 ++++++++
 src/InvalidKey.php           | 10 ++++++++
 src/KeyInfo.php              | 11 +++++++++
 src/PeclWrapper.php          | 35 ++++++++++++++++++++++++++++
 src/PublicKey.php            | 26 +++++++++++++++++++++
 src/SecretKey.php            | 15 ++++++++++++
 src/Signature.php            | 21 +++++++++++++++++
 src/VerificiationFailed.php  | 10 ++++++++
 10 files changed, 217 insertions(+)
 create mode 100644 src/CliWrapper.php
 create mode 100644 src/GPG.php
 create mode 100644 src/InvalidHomeDirectory.php
 create mode 100644 src/InvalidKey.php
 create mode 100644 src/KeyInfo.php
 create mode 100644 src/PeclWrapper.php
 create mode 100644 src/PublicKey.php
 create mode 100644 src/SecretKey.php
 create mode 100644 src/Signature.php
 create mode 100644 src/VerificiationFailed.php

diff --git a/src/CliWrapper.php b/src/CliWrapper.php
new file mode 100644
index 0000000..551ebee
--- /dev/null
+++ b/src/CliWrapper.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+use PharIo\Executor\Executor;
+use PharIo\FileSystem\Directory;
+
+final class CliWrapper implements GPG
+{
+    public function __construct(Executor $executor, Directory $home, ?Directory $temp = null)
+    {
+    }
+
+    public function importPublicKey(string $keyData): PublicKey
+    {
+        // TODO: Implement importPublicKey() method.
+    }
+
+    public function importSecretKey(string $keyData): SecretKey
+    {
+        // TODO: Implement importSecretKey() method.
+    }
+
+    public function verify(string $message, Signature $signature): KeyInfo
+    {
+        // TODO: Implement verify() method.
+    }
+
+    public function sign(SecretKey $privateKey, string $message): Signature
+    {
+        // TODO: Implement sign() method.
+    }
+}
diff --git a/src/GPG.php b/src/GPG.php
new file mode 100644
index 0000000..4233fea
--- /dev/null
+++ b/src/GPG.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+interface GPG
+{
+    /**
+     * @param string $keyData raw key data
+     *
+     * @throws InvalidHomeDirectory
+     * @throws InvalidKey
+     */
+    public function importPublicKey(string $keyData): PublicKey;
+
+    /**
+     *
+     * @since 2.1 this method can be added later because phive is no just using the verify logic
+     * @param string $keyData raw key data
+     *
+     * @throws InvalidHomeDirectory
+     * @throws InvalidKey
+     */
+    public function importSecretKey(string $keyData): SecretKey;
+
+    /**
+     * Verifies the message is signed with the sigature
+     *
+     * Ensures that the signature is valid.
+     *
+     * @throws VerificiationFailed When message was not signed with the signature
+     * @throws UnknownFingerPrint When signature doesn't belong to a known key, key must be imported first
+     */
+    public function verify(string $message, Signature $signature): KeyInfo;
+
+    /**
+     * Uses the secret to create a signature.
+     *
+     * @since 2.1 this method can be added later because phive is no just using the verify logic
+     * @return Signature
+     */
+    public function sign(SecretKey $privateKey, string $message): Signature;
+}
diff --git a/src/InvalidHomeDirectory.php b/src/InvalidHomeDirectory.php
new file mode 100644
index 0000000..f24bca2
--- /dev/null
+++ b/src/InvalidHomeDirectory.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+class InvalidHomeDirectory extends Exception
+{
+
+}
diff --git a/src/InvalidKey.php b/src/InvalidKey.php
new file mode 100644
index 0000000..a78fbca
--- /dev/null
+++ b/src/InvalidKey.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+class InvalidKey extends Exception
+{
+
+}
diff --git a/src/KeyInfo.php b/src/KeyInfo.php
new file mode 100644
index 0000000..8f655fb
--- /dev/null
+++ b/src/KeyInfo.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+
+class KeyInfo
+{
+
+}
diff --git a/src/PeclWrapper.php b/src/PeclWrapper.php
new file mode 100644
index 0000000..a0ec323
--- /dev/null
+++ b/src/PeclWrapper.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+use PharIo\FileSystem\Directory;
+
+final class PeclWrapper implements GPG
+{
+    public function __construct(Directory $home, ?Directory $temp = null)
+    {
+        $this->gpg = new \Gnupg();
+    }
+
+    public function importPublicKey(string $keyData): PublicKey
+    {
+        // TODO: Implement importPublicKey() method.
+    }
+
+    public function importSecretKey(string $keyData): SecretKey
+    {
+        // TODO: Implement importSecretKey() method.
+    }
+
+    public function verify(string $message, Signature $signature): KeyInfo
+    {
+        // TODO: Implement verify() method.
+    }
+
+    public function sign(SecretKey $privateKey, string $message): Signature
+    {
+        // TODO: Implement sign() method.
+    }
+}
diff --git a/src/PublicKey.php b/src/PublicKey.php
new file mode 100644
index 0000000..7243af6
--- /dev/null
+++ b/src/PublicKey.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+class PublicKey
+{
+    private function __construct(string $id, string $fingerprint, array $uids, string $key, \DateTimeImmutable $created)
+    {
+    }
+
+    public function getId(): string {
+    }
+
+    public function getInfo(): string {
+    }
+
+    public function getKey(): string {
+
+    }
+
+    public function getFingerprint(): string {
+
+    }
+}
diff --git a/src/SecretKey.php b/src/SecretKey.php
new file mode 100644
index 0000000..1c40d4d
--- /dev/null
+++ b/src/SecretKey.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+/**
+ * @todo define what is needed here.
+ */
+class SecretKey
+{
+
+
+    public function getKeyData() {}
+}
diff --git a/src/Signature.php b/src/Signature.php
new file mode 100644
index 0000000..e341fdd
--- /dev/null
+++ b/src/Signature.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+/**
+ * This class could be prevent sigatures form being serialized.
+ *
+ * @see https://github.com/paragonie/hidden-string/blob/master/src/HiddenString.php inspired by.
+ */
+class Signature
+{
+    /**
+     * Will return internal sigature data
+     *
+     * This can be stored to a file for example.
+     */
+    public function getData(): string {
+    }
+}
diff --git a/src/VerificiationFailed.php b/src/VerificiationFailed.php
new file mode 100644
index 0000000..ec47653
--- /dev/null
+++ b/src/VerificiationFailed.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+class VerificiationFailed extends Exception
+{
+
+}

From 7984bf9885d49189b05605b2e6bd32b587703fbf Mon Sep 17 00:00:00 2001
From: Jaapio <jaap@ijaap.nl>
Date: Fri, 4 Dec 2020 15:55:06 +0100
Subject: [PATCH 2/2] Improve signature verification

---
 src/FingerPrint.php                  | 15 ++++++++++++++
 src/GPG.php                          |  8 ++------
 src/KeyId.php                        | 15 ++++++++++++++
 src/Signature.php                    | 21 -------------------
 src/Signature/SigatureFileData.php   | 10 ++++++++++
 src/Signature/SigatureStringData.php | 10 ++++++++++
 src/Signature/Signature.php          | 30 ++++++++++++++++++++++++++++
 src/Signature/SignatureData.php      | 11 ++++++++++
 src/Signature/SignatureInfo.php      | 16 +++++++++++++++
 src/Signature/Status.php             | 15 ++++++++++++++
 src/UserId.php                       | 11 ++++++++++
 11 files changed, 135 insertions(+), 27 deletions(-)
 create mode 100644 src/FingerPrint.php
 create mode 100644 src/KeyId.php
 delete mode 100644 src/Signature.php
 create mode 100644 src/Signature/SigatureFileData.php
 create mode 100644 src/Signature/SigatureStringData.php
 create mode 100644 src/Signature/Signature.php
 create mode 100644 src/Signature/SignatureData.php
 create mode 100644 src/Signature/SignatureInfo.php
 create mode 100644 src/Signature/Status.php
 create mode 100644 src/UserId.php

diff --git a/src/FingerPrint.php b/src/FingerPrint.php
new file mode 100644
index 0000000..7e05efd
--- /dev/null
+++ b/src/FingerPrint.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+final class FingerPrint
+{
+    private string $fingerPrint;
+
+    public function getFingerPrint(): string
+    {
+        return $this->fingerPrint;
+    }
+}
diff --git a/src/GPG.php b/src/GPG.php
index 4233fea..051c14f 100644
--- a/src/GPG.php
+++ b/src/GPG.php
@@ -22,17 +22,13 @@ public function importPublicKey(string $keyData): PublicKey;
      * @throws InvalidHomeDirectory
      * @throws InvalidKey
      */
-    public function importSecretKey(string $keyData): SecretKey;
+    public function importSecretKey(string $keyData, ?string $passphrase = null): SecretKey;
 
     /**
      * Verifies the message is signed with the sigature
      *
-     * Ensures that the signature is valid.
-     *
-     * @throws VerificiationFailed When message was not signed with the signature
-     * @throws UnknownFingerPrint When signature doesn't belong to a known key, key must be imported first
      */
-    public function verify(string $message, Signature $signature): KeyInfo;
+    public function verify(string $message, SignatureData $signature): Signature;
 
     /**
      * Uses the secret to create a signature.
diff --git a/src/KeyId.php b/src/KeyId.php
new file mode 100644
index 0000000..f9b7493
--- /dev/null
+++ b/src/KeyId.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+final class KeyId
+{
+    private string $id;
+
+    public function getId(): string
+    {
+        return $this->id;
+    }
+}
diff --git a/src/Signature.php b/src/Signature.php
deleted file mode 100644
index e341fdd..0000000
--- a/src/Signature.php
+++ /dev/null
@@ -1,21 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace PharIo\GnuPG;
-
-/**
- * This class could be prevent sigatures form being serialized.
- *
- * @see https://github.com/paragonie/hidden-string/blob/master/src/HiddenString.php inspired by.
- */
-class Signature
-{
-    /**
-     * Will return internal sigature data
-     *
-     * This can be stored to a file for example.
-     */
-    public function getData(): string {
-    }
-}
diff --git a/src/Signature/SigatureFileData.php b/src/Signature/SigatureFileData.php
new file mode 100644
index 0000000..72bb546
--- /dev/null
+++ b/src/Signature/SigatureFileData.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+class SigatureFileData implements SignatureData
+{
+
+}
diff --git a/src/Signature/SigatureStringData.php b/src/Signature/SigatureStringData.php
new file mode 100644
index 0000000..8b406bc
--- /dev/null
+++ b/src/Signature/SigatureStringData.php
@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+final class SigatureFileData implements SignatureData
+{
+
+}
diff --git a/src/Signature/Signature.php b/src/Signature/Signature.php
new file mode 100644
index 0000000..e3f159c
--- /dev/null
+++ b/src/Signature/Signature.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+
+Class Signature
+{
+    public function getKeyId(): KeyId
+    {}
+
+    public function getUserId(): UserId
+    {}
+
+    public function getSignatureInformation(): ?SignatureInfo
+    {}
+
+    public function getStatus(): Status
+    {
+    }
+
+    /**
+     * Will return internal sigature data
+     *
+     * This can be stored to a file for example.
+     */
+    public function getData(): SignatureData {
+    }
+}
diff --git a/src/Signature/SignatureData.php b/src/Signature/SignatureData.php
new file mode 100644
index 0000000..6d374c4
--- /dev/null
+++ b/src/Signature/SignatureData.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+
+interface SignatureData
+{
+
+}
diff --git a/src/Signature/SignatureInfo.php b/src/Signature/SignatureInfo.php
new file mode 100644
index 0000000..a1d074e
--- /dev/null
+++ b/src/Signature/SignatureInfo.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+Final class SignatureInfo
+{
+    private FingerPrint $fingerPrint;
+
+    private DateTimeImmutable $createdAt;
+
+    private DateTimeImmutable $expireAt;
+
+    private UserId $userId;
+}
diff --git a/src/Signature/Status.php b/src/Signature/Status.php
new file mode 100644
index 0000000..6d6ed61
--- /dev/null
+++ b/src/Signature/Status.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+final class Status
+{
+    public static Good(): Status;
+    public static Expired(): Status;
+    public static KeyExpired(): Status;
+    public static KeyRevoked(): Status;
+    public static Bad(): Status;
+    public static Error(): Status;
+}
diff --git a/src/UserId.php b/src/UserId.php
new file mode 100644
index 0000000..622aafc
--- /dev/null
+++ b/src/UserId.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PharIo\GnuPG;
+
+class UserId
+{
+    private string $name;
+    private string $email;
+}