Controller: /siteworx/ssl
=========================

:Required Permissions: SSL
:Required Options: SSL Access

Action: ``fail``
----------------

:Added in Version: n/a
:Description: Magic function - test for failure mechanism.

Action: ``generateLetsEncrypt``
-------------------------------

:Added in Version: 5.1.4.1042
:Description: Generates SSL certs via LetsEncrypt.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``domain``
     - string
     - Yes
     - example.com, secondary.com
     - 
     - 
   * - ``commonName``
     - string
     - Yes
     - example.com, mail.example.com, www.example.com, ftp.example.com, sub.example.com
     - 
     - Please select the domain name (common name) this certificate will use. If you do not see your desired domain, you will first need to add it as a pointerdomain or as a subdomain in SiteWorx.<br/><br/>Note that 'www.domain.com' is <strong>not</strong> the same as 'domain.com'.<br/><br/>A wildcard domain begins with an asterisk, '\*', and is valid for all subdomains. For example, a Common Name of '\*.domain.com' would create a CSR that is valid for 'domain.com', 'sub1.domain.com', 'sub2.domain.com', and so on. - *Common Name*
   * - ``subjectAltName``
     - struct (string)
     - No
     - example.com, mail.example.com, www.example.com, ftp.example.com, sub.example.com
     - ["www.example.com"]
     - In addition to the primary domain, other domains may be included on the certificate. - *Subject Alternative Name*
   * - ``mode``
     - string
     - No*
     - staging, live
     - live
     - "Live" mode will generate a real LetsEncrypt signed certificate. "Staging" mode will generate a fake certificate that should only be used for testing purposes.

\* indicates that it's actually required, but probably already has a valid default value.

Action: ``install``
-------------------

:Added in Version: 4.7.0-339
:Description: Installs SSL to vhost config.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``domain``
     - string
     - Yes
     - example.com, secondary.com
     - 
     - 
   * - ``chain``
     - integer
     - Yes
     - 1, 0
     - 
     - 
   * - ``cascade_to_nodes``
     - integer
     - No
     - 1
     - 
     - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually

Action: ``listSslInfo``
-----------------------

:Added in Version: 6.0.11-1380
:Description: List SSL Info.

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       'config_exists' => true,
       'chain_pem' => '/home/example/var/example.com/ssl/example.com.chain.pem',
       'fullchain_pem' => '/home/example/var/example.com/ssl/example.com.fullchain.pem',
       'key' => '/home/example/var/example.com/ssl/example.com.priv.key',
       'csr' => '/home/example/var/example.com/ssl/example.com.csr',
       'crt' => '/home/example/var/example.com/ssl/example.com.crt',
       'ssl_domain' => 'example.com',
       'expiry' => 
       array (
         'valid_from' => 1578808273,
         'valid_to' => 1578808273,
       ),
       'parsed_cert' => 
       array (
         'C' => 'US',
         'ST' => 'PA',
         'L' => 'Pittsburgh',
         'O' => 'InterWorx',
         'OU' => 'Testing',
         'CN' => 'example.com',
         'emailAddress' => 'admin@example.com',
       ),
       'alt_names' => 
       array (
         'example.com' => 'example.com',
       ),
       'cert_issued_by' => '##LG_SSL_SELF_SIGNED_CERTIFICATE##',
       'issuing_organization' => '##LG_SSL_SELF_SIGNED_CERTIFICATE##',
     ),
     'reply_code' => 205,
   )


Action: ``reroute``
-------------------

:Added in Version: n/a
:Description: Action to re-route from the current controller to a different one.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``controller``
     - string
     - Yes
     - Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, DomainsAdvanced, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout
     - 
     - 

Action: ``uninstall``
---------------------

:Added in Version: 4.7.0-339
:Description: Removes SSL from vhost config.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``domain``
     - string
     - Yes
     - example.com, secondary.com
     - 
     - 
   * - ``cascade_to_nodes``
     - integer
     - No
     - 1
     - 
     - Selecting this option causes the action to be replayed on all nodes of the cluster automatically, as if you had logged in to each node manually

Action: ``win``
---------------

:Added in Version: n/a
:Description: Magic function - test for testing success mechanism.