Certificates management

Author: tzurbaev

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Configuration (nginx and ENV) files management;
 - Recipes management;
+- SSL Certificates management.
 
 ## [1.0.1] - 2017-03-14
 ### Added

docs/certificates.md

@@ -0,0 +1,150 @@
+# Overview
+
+SDK provides Certificates Manager that allows you to create, list, clone, install, activate, delete certificates and obtain new Let's Encrypt certificate for your Forge sites.
+
+# Usage
+
+Documentation assumes that you've already retrieved site instance from `SitesManager` class.
+
+All operations are performed via `Laravel\Forge\Certificates\CertificatesManager` instance.
+
+All methods return either instance of `Laravel\Forge\Certificates\Certificate` or array of `Laravel\Forge\Certificates\Certificate` instances.
+
+## Create new certificate
+
+```php
+<?php
+
+use Laravel\Forge\Certificates\CertificatesManager;
+
+$certificates = new CertificatesManager();
+
+$certificate = $certificates->create('example.org')
+    ->ownedBy('My Company Name')
+    ->locatedAt('US', 'NY', 'New York')
+    ->assignedTo('Department Name')
+    ->on($site);
+```
+
+## Installing an existed certificate
+
+```php
+<?php
+
+use Laravel\Forge\Certificates\CertificatesManager;
+
+$certificates = new CertificatesManager();
+
+$certificate = $certificates->install('private-key', 'certificate-content')
+    ->on($site);
+```
+
+## Cloning an existed certificate
+
+```php
+<?php
+
+use Laravel\Forge\Certificates\CertificatesManager;
+
+$certificates = new CertificatesManager();
+
+$certificateId = 1234;
+$certificate = $certificates->clone($certificateId)->on($site);
+```
+
+## Obtain a Let's Encrypt certificate
+
+```php
+<?php
+
+use Laravel\Forge\Certificates\CertificatesManager;
+
+$certificates = new CertificatesManager();
+
+$domains = ['example.org', 'www.example.org'];
+$certificate = $certificates->obtain($domains)->on($site);
+```
+
+## List certificates
+
+```php
+<?php
+
+use Laravel\Forge\Certificates\CertificatesManager;
+
+$certificates = new CertificatesManager();
+
+$siteCertificates = $certificates->list()->from($site);
+```
+
+## Get single certificate by ID
+
+```php
+<?php
+
+use Laravel\Forge\Certificates\CertificatesManager;
+
+$certificates = new CertificatesManager();
+
+$certificateId = 1234;
+$certificate = $certificates->get($certificateId)->from($site);
+```
+
+## Get Signing Request
+
+This method returns the full certificate signing request content.
+
+```php
+<?php
+
+use Laravel\Forge\Certificates\CertificatesManager;
+
+$certificates = new CertificatesManager();
+$certificate = $certificates->get(1234)->from($site);
+
+$csr = $certificate->csr();
+```
+
+## Install certificate
+
+```php
+<?php
+
+use Laravel\Forge\Certificates\CertificatesManager;
+
+$certificates = new CertificatesManager();
+$certificate = $certificates->get(1234)->from($site);
+
+$certificateContent = 'content-here';
+$addIntermediates = false;
+
+$result = $certificate->install($certificateContent, $addIntermediates);
+```
+
+## Activate certificate
+
+```php
+<?php
+
+use Laravel\Forge\Certificates\CertificatesManager;
+
+$certificates = new CertificatesManager();
+$certificate = $certificates->get(1234)->from($site);
+
+$result = $certificate->activate();
+```
+
+## Delete certificate
+
+```php
+<?php
+
+use Laravel\Forge\Certificates\CertificatesManager;
+
+$certificates = new CertificatesManager();
+$certificate = $certificates->get(1234)->from($site);
+
+$result = $certificate->delete();
+```
+
+[Back to Table of Contents](./readme.md)

docs/getting-started.md

@@ -19,10 +19,7 @@ This SDK supports following Forge API features:
 - Firewall rules;
 - Scheduled jobs;
 - Workers;
-- Recipes.
-
-## Coming soon
-
+- Recipes;
 - SSL certificates management.
 
 # Requirements

docs/readme.md

@@ -17,3 +17,4 @@
     + [Deployment](./deployment.md)
     + [Workers](./workers.md)
 - [Recipes](./recipes.md)
+- [SSL Certificates](./certificates.md)

src/Certificates/Certificate.php

@@ -0,0 +1,142 @@
+<?php
+
+namespace Laravel\Forge\Certificates;
+
+use Laravel\Forge\ApiResource;
+
+class Certificate extends ApiResource
+{
+    /**
+     * Resource type.
+     *
+     * @return string
+     */
+    public static function resourceType()
+    {
+        return 'certificate';
+    }
+
+    /**
+     * Resource path (relative to owner or API root).
+     *
+     * @return string
+     */
+    public function resourcePath()
+    {
+        return 'certificates';
+    }
+
+    /**
+     * Resource name.
+     *
+     * @return string|null
+     */
+    public function name()
+    {
+        return $this->domain();
+    }
+
+    /**
+     * Certificate domain.
+     *
+     * @return string|null
+     */
+    public function domain()
+    {
+        return $this->getData('domain');
+    }
+
+    /**
+     * Certificate type.
+     *
+     * @return string|null
+     */
+    public function type()
+    {
+        return $this->getData('type');
+    }
+
+    /**
+     * Request status.
+     *
+     * @return string|null
+     */
+    public function requestStatus()
+    {
+        return $this->getData('request_status');
+    }
+
+    /**
+     * Determines if certificate is active.
+     *
+     * @return bool
+     */
+    public function active(): bool
+    {
+        return intval($this->getData('active')) === 1;
+    }
+
+    /**
+     * Determines if current certificate was installed from existing certificate.
+     *
+     * @return bool
+     */
+    public function existing(): bool
+    {
+        return intval($this->getData('existing')) === 1;
+    }
+
+    /**
+     * Determines if current certificate is Let's Encrypt certificate.
+     *
+     * @return bool
+     */
+    public function letsencrypt(): bool
+    {
+        return $this->type() === 'letsencrypt';
+    }
+
+    /**
+     * Get Certificate Signing Request value.
+     *
+     * @return string
+     */
+    public function csr()
+    {
+        $response = $this->getHttpClient()->request('GET', $this->apiUrl('/csr'));
+
+        return (string) $response->getBody();
+    }
+
+    /**
+     * Install certificate.
+     *
+     * @param string $content
+     * @param bool   $addIntermediates = false
+     *
+     * @return string|null
+     */
+    public function install(string $content, bool $addIntermediates = false): bool
+    {
+        $response = $this->getHttpClient()->request('POST', $this->apiUrl('/install'), [
+            'form_params' => [
+                'certificate' => $content,
+                'add_intermediates' => $addIntermediates,
+            ],
+        ]);
+
+        return true;
+    }
+
+    /**
+     * Activate certificate.
+     *
+     * @return bool
+     */
+    public function activate(): bool
+    {
+        $this->getHttpClient()->request('POST', $this->apiUrl('/activate'));
+
+        return true;
+    }
+}