KeyEditor: Add expire() method

Author: alecpl

Crypt/GPG/KeyEditor.php

@@ -220,6 +220,39 @@ public function deleteUserId(Crypt_GPG_UserId $userid, $by_email = false)
         return $this;
     }
 
+    /**
+     * Set expiration date for a primary key (`expire`).
+     *
+     * @param string|int $period  Validation period: Either of:
+     *                            - 0 or an empty string for no expiration
+     *                            - <n>  - expiration in days
+     *                            - <n>w - expiration in weeks
+     *                            - <n>m - expiration in months
+     *                            - <n>y - expiration in years
+     *
+     * @return Crypt_GPG_KeyEditor The current object, for fluent interface.
+     */
+    public function expire($period = '')
+    {
+        if ($period === '') {
+            $period = '0';
+        }
+
+        if (!preg_match('/^[0-9]+[wmy]?$/i', (string) $period)) {
+            $this->_close();
+            throw new Crypt_GPG_Exception('Failed to set expiration. Invalid period specification.');
+        }
+
+        $handlers = [
+            'keygen.valid' => (string) $period,
+            'passphrase.enter' => $this->passphrase,
+        ];
+
+        $this->_write('expire')->_read($handlers, ['keyedit.prompt']);
+
+        return $this;
+    }
+
     /**
      * Change a key passphrase (`passwd`).
      *

tests/KeyEditorTest.php

@@ -183,6 +183,32 @@ public function testDeleteUserIdUnknown()
         $keyEditor->edit('second-keypair@example.com', 'test2')->deleteUserId($user)->save();
     }
 
+    /**
+     * Test `expire` command
+     */
+    public function testExpire()
+    {
+        $keyEditor = $this->gpg->getKeyEditor();
+
+        // Test setting an expiration date (one year from today)
+        $keyEditor->edit('second-keypair@example.com', 'test2')->expire('1y')->save();
+
+        $keys = $this->gpg->getKeys('second-keypair@example.com');
+        $primary = $keys[0]->getPrimaryKey();
+        $this->assertSame((date('Y') + 1) . date('-m-d'), $primary->getExpirationDateTime()->format('Y-m-d'));
+
+        // Test unsetting an expiration date
+        $keyEditor->edit('second-keypair@example.com', 'test2')->expire(0)->save();
+
+        $keys = $this->gpg->getKeys('second-keypair@example.com');
+        $primary = $keys[0]->getPrimaryKey();
+        $this->assertNull($primary->getExpirationDateTime());
+
+        // Test invalid period
+        $this->expectException('Crypt_GPG_Exception');
+        $keyEditor->edit('second-keypair@example.com', 'test2')->expire('-1')->save();
+    }
+
     /**
      * Test `passwd` command
      */
@@ -218,8 +244,9 @@ public function testRevokeUserId()
         $keys = $this->gpg->getKeys('second-keypair@example.com');
         $userIds = $keys[0]->getUserIds();
         $this->assertCount(2, $userIds);
-        $userIds = array_filter($userIds, function ($id) use ($user1) { return $id->getEmail() == $user1->getEmail(); });
+        $userIds = array_values(array_filter($userIds, function ($id) use ($user1) { return $id->getEmail() == $user1->getEmail(); }));
         $this->assertCount(1, $userIds);
+        $this->assertTrue($userIds[0]->isRevoked());
 
         // Test revoking the last user
         $user = new Crypt_GPG_UserId('Second Keypair Test Key (do not encrypt important data with this key) <second-keypair@example.com>');