Chapter 54: Controller: /nodeworx/sshd Up Part II: NodeWorx API Spec Chapter 56: Controller: /nodeworx/themes 

55 Controller: /nodeworx/ssl

Required Permissions "SSL"
Action: edit
Added in version 4.7.0-339
Description Edit an ssl certificate.
Input Parameters
Name Type Notes Required?
service string Example Values
SSL_Apache, SSL_IWorxWeb, SSL_Proftpd, SSL_Email_Pop3, SSL_Email_Imap, SSL_Email_SMTP
Yes
key string Yes
crt string Yes
ssl_ciphersuite string Help Entry
This complex directive uses a colon-separated cipher-spec string consisting of OpenSSL cipher specifications to configure the Cipher Suite the client is permitted to negotiate in the SSL handshake phase.
Example Default Value
ALL:!ADH:!EXPORT:!SSLv2:RC4+RSA:+HIGH:+MEDIUM:+LOW
No
restart_now integer Help Entry
Most services require a restart before a new SSL Certificate can be used. Selecting ’YES’ will restart the service immediately and selecting ’NO’ will restart the service within 5 minutes.
Example Values
1, 0
Example Default Value
0
No*
cascade_to_nodes integer Help Entry
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
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: generate
Added in version 4.7.0-339
Description Generate a self-signed SSL cert.
Input Parameters
Name Type Notes Required?
key_length integer Example Values
2048, 3072, 4096
Example Default Value
2048
No*
digest_alg string Help Entry
The digest algorithm to use for encryption.
Example Values
sha256, sha1
Example Default Value
sha256
No*
expiration_years integer Help Entry
Specifies the number of years before the self-signed SSL certificate expires.
Example Default Value
1
No*
countryName string Help Entry
Please enter the 2-letter country code corresponding to your country.
Example Values
US, CA, AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, ...
Example Default Value
US
No*
stateOrProvinceName string Help Entry
Please enter the name of the state or province in which you reside.
Yes
localityName string Help Entry
Please enter the name of the city in which you reside.
Yes
organizationName string Help Entry
Please enter the name of the company to which this certificate belongs.
Yes
organizationalUnitName string Help Entry
Please enter the name of the company division to which this certificate belongs.
Yes
commonName string Help Entry
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.
Yes
emailAddress string Help Entry
Please enter the email address that is associated with this certificate.
Yes
email_ssl_cert integer Help Entry
If this option is selected, an e-mail address can be specified. After the certificate is generated, it will be sent to that address.
Example Values
1
No
copy_to_email string Example Default Value
apidocs@interworx.com
No
services struct (string) Help Entry
Select which services will have the SSL certificated automatically installed.
Example Values
SSL_Apache, SSL_IWorxWeb, SSL_Proftpd, SSL_Email_Pop3, SSL_Email_Imap, SSL_Email_SMTP
No
restart_now integer Help Entry
Most services require a restart before a new SSL Certificate can be used. Selecting ’YES’ will restart the service immediately and selecting ’NO’ will restart the service within 5 minutes.
Example Values
1, 0
Example Default Value
0
No
* indicates that it’s actually required, but probably already has a valid default value
Action: listSslCerts
Added in version 4.8.0-393
Description List installed server SSL Certificates.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 =>
array (
’shortname’ => ’SSL_Apache’,
’name’ => ’Web-Server Default SSL’,
’domain’ => ’p1.unit.interworx.com’,
’is_expired’ => true,
’nearly_expired’ => false,
’expires’ => 1449243050,
’issuer’ => ’SomeOrganization’,
),
1 =>
array (
’shortname’ => ’SSL_IWorxWeb’,
’name’ => ’InterWorx-SSL’,
’domain’ => ’default-ssl.interworx.com’,
’is_expired’ => false,
’nearly_expired’ => false,
’expires’ => 1673627390,
’issuer’ => ’INTERWORX LLC’,
),
2 =>
array (
’shortname’ => ’SSL_Proftpd’,
’name’ => ’FTP Server’,
’domain’ => ’*.interworx.com’,
’is_expired’ => true,
’nearly_expired’ => false,
’expires’ => 1449246688,
’issuer’ => ’InterWorx, LLC’,
),
),
)
Action: queryEdit
Added in version 5.1.0-838
Description Displays the information available to the action "edit".
Input Parameters
Name Type Notes Required?
service string Example Values
SSL_Apache, SSL_IWorxWeb, SSL_Proftpd, SSL_Email_Pop3, SSL_Email_Imap, SSL_Email_SMTP
Yes
Sample output
array (
’status’ => 0,
’payload’ =>
array (
’key’ => ’—--BEGIN RSA PRIVATE KEY—--
MIICXQIBAAKBgQDUvS3m16u+GHm4Hh+tszxmNQKrOlfxdjGzdMw8hNGX5q6HLg2N
f78d7Msr2cuLTYKzUtSQd8yfATEqjfevLDBqTawCylB/q/jzwwYir0r7GXlsxz9n
p0XXJZ7xyazME3blTU/KOD11sMsVqFUcB5J1DVu551Te/ewV9m5nJ+AoqQIDAQAB
AoGBAKF/3FDaeW6edgjoFXRwFPIiXBxQ9mJAMArkKAfpbJO8c9H7jB5XVGcLVFG9
zV+7P/WSc/wYdiZfaUu86sL48Obe/OGChwgdFEiwhqAM2p3+x1QL0/5GunXX9S9y
g1BC64vQRbIFIRag5g7gOwfDpCAVvt+Ksy785BZsSvCSe/zhAkEA/UKf5GXxojtp
BH7nNO2wBbhd3GaJfK8NI+dzf4E48wRf1/eO8s+CpHe54DLBE3N1Lx7JwfEOn0sZ
YFj7aof01wJBANcKVe83b5i43FkabrWginZ6xsgQLoE8XnkzZoogCNL/eVYiawxc
Jat7veKCuHxFrLT0qvDkPMuythx6SgoXnn8CQQC39s5YROjplEgreNcPrlv/O7YK
Y/0YsbtUykouYzpv5EyOfwe6PpvCRimhvpxbObH0gWPC2gxqD04mm1w9PPbPAkAO
NSacWYNMCdq1IGP0KBk93rrHeRo5e62aQGUj9x3eIvb3U+rStDvg6poPHyflPg09
H3Uz2UCTDMmvc/z0Ub8tAkA8rUX3l4/nPzzOXuPYptSBntKkaJjbaq0Thfk0wVRX
D9S8r0I9AnG9kg3KMfHHKDbxmluz4kjq2ZWJVPlw2sOJ
—--END RSA PRIVATE KEY—--’,
’crt’ => ’—--BEGIN CERTIFICATE—--
MIIDPzCCAqigAwIBAgICaIIwDQYJKoZIhvcNAQEFBQAwgbsxCzAJBgNVBAYTAi0t
MRIwEAYDVQQIDAlTb21lU3RhdGUxETAPBgNVBAcMCFNvbWVDaXR5MRkwFwYDVQQK
DBBTb21lT3JnYW5pemF0aW9uMR8wHQYDVQQLDBZTb21lT3JnYW5pemF0aW9uYWxV
bml0MR4wHAYDVQQDDBVwMS51bml0LmludGVyd29yeC5jb20xKTAnBgkqhkiG9w0B
CQEWGnJvb3RAcDEudW5pdC5pbnRlcndvcnguY29tMB4XDTE0MTIwNDE1MzA1MFoX
DTE1MTIwNDE1MzA1MFowgbsxCzAJBgNVBAYTAi0tMRIwEAYDVQQIDAlTb21lU3Rh
dGUxETAPBgNVBAcMCFNvbWVDaXR5MRkwFwYDVQQKDBBTb21lT3JnYW5pemF0aW9u
MR8wHQYDVQQLDBZTb21lT3JnYW5pemF0aW9uYWxVbml0MR4wHAYDVQQDDBVwMS51
bml0LmludGVyd29yeC5jb20xKTAnBgkqhkiG9w0BCQEWGnJvb3RAcDEudW5pdC5p
bnRlcndvcnguY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDUvS3m16u+
GHm4Hh+tszxmNQKrOlfxdjGzdMw8hNGX5q6HLg2Nf78d7Msr2cuLTYKzUtSQd8yf
ATEqjfevLDBqTawCylB/q/jzwwYir0r7GXlsxz9np0XXJZ7xyazME3blTU/KOD11
sMsVqFUcB5J1DVu551Te/ewV9m5nJ+AoqQIDAQABo1AwTjAdBgNVHQ4EFgQUGbaM
JWH1B2YZOsap8Ddry/SrUMUwHwYDVR0jBBgwFoAUGbaMJWH1B2YZOsap8Ddry/Sr
UMUwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOBgQAIbP4d6Mw02zWyS6HG
+tM4kZF/dO/t4qKROI+NwbIROD02I2+2aTh//2g4k3R9qjlFvClOuxcGRHA7r0+T
kuBPCY4Fwf8uGdgpOLZBL8zfWhyUzh1S+j6b/PyCLIoiYzJz5d5zHIwGnQEvzrQs
uuwhJD5UdegHkXZNWq6ML8cJFQ==
—--END CERTIFICATE—--’,
’ssl_ciphersuite’ => ’ALL:!ADH:!EXPORT:!SSLv2:RC4+RSA:+HIGH:+MEDIUM:+LOW’,
’restart_now’ => ’0’,
’service’ => ’SSL_Apache’,
),
)
Action: syncLetsEncrypt
Added in version 5.1.6-1056
Description Syncs LetsEncrypt certs across cluster.
Action: updateall
Added in version 4.7.0-339
Description Update all services to use the same SSL cert.
Input Parameters
Name Type Notes Required?
services struct (string) Help Entry
Select which services will have the SSL certificated automatically installed.
Example Values
SSL_Apache, SSL_IWorxWeb, SSL_Proftpd, SSL_Email_Pop3, SSL_Email_Imap, SSL_Email_SMTP
Example Default Value
["SSL_Apache","SSL_IWorxWeb","SSL_Proftpd","SSL_Email_Pop3","SSL_Email_Imap","SSL_Email_SMTP"]
No*
restart_now integer Help Entry
Most services require a restart before a new SSL Certificate can be used. Selecting ’YES’ will restart the service immediately and selecting ’NO’ will restart the service within 5 minutes.
Example Values
1, 0
Example Default Value
0
No
key string No
crt string No
cascade_to_nodes integer Help Entry
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
Example Values
1
No
* indicates that it’s actually required, but probably already has a valid default value
Action: view
Added in version 4.7.0-339
Description View a given ssl cert, and any related information.
Input Parameters
Name Type Notes Required?
service string Example Values
SSL_Apache, SSL_IWorxWeb, SSL_Proftpd, SSL_Email_Pop3, SSL_Email_Imap, SSL_Email_SMTP
Yes
 Chapter 54: Controller: /nodeworx/sshd Up Part II: NodeWorx API Spec Chapter 56: Controller: /nodeworx/themes 

(C) 2017 by InterWorx LLC