Difference between revisions of "GlobalSign SSL"

From WHMCS Documentation

 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This module automates SSL ordering and configuration with the GlobalSign platform.
+
== About this Module ==
  
==Available Certificate Types==
+
This module automates SSL ordering and configuration with the GlobalSign platform. For more information, see [http://www.globalsign.com/ssl/ the GlobalSign website].
  
You have access to all GlobalSign SSL Certificate types and the Wildcard SSL
+
==Configuring a Product==
option. For more details on the product features and benefits please visit
 
www.globalsign.com/ssl/
 
  
===Options===
+
To set up a GlobalSign SSL product:
  
*'''Standard SSL option''' - this is the default option type for all GlobalSign SSL. Standard SSL Certificates are issued to a single fully qualified domain name such as www.globalsign.com. Applications for domains starting with www will also work with the non-www version of the domain (i.e. a Certificate for https://www.globalsign.com will also work for https://globalsign.com).
+
#G o to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.
 +
# Create a new product with type '''Other''' and the name of the certificate you want to offer.
 +
# Click '''Create'''.
 +
# Configure the product.
 +
#* Set '''Welcome Email''' to ''None''.
 +
#* Set '''Pricing''' to '''One Time'''.
 +
#* In the '''Module Settings''' tab, choose ''Globalsignssl'' for '''Module'''. Enter your GlobalSign username and password and choose a certificate product code, base option, and validity period and your preferred automation action.
 +
# Click '''Save Changes'''
 +
# Whitelist your server IP address by contacting Globalsign support and asking for access to their API. If you do not do this, you will see a "This IP Address is not registered" error message.
  
*'''Wildcard SSL option''' - the Wildcard SSL option allows Certificates to be issued to a wildcard domain such as *.globalsign.com. The * character allows the Certificate to be used to secure any subdomain on the domain (i.e. a Certifiacte for *.globalsign.com could be used to secure products.globalsign.com, webmail.globalsign.com, anything.globalsign.com). Wildcard SSL will support an unlimited number of subdomains. The Wildcard SSL Option is supported for AlphaSSL, DomainSSL and OrganizationSSL only.
+
===Available Certificate Types===
  
===SSL Certificate Types===
+
When you use this module, you have access to all of GlobalSign's SSL certificate types and both the Standard and Wildcard SSL options.
  
*'''AlphaSSL''' - A low cost, entry level SSL Certificate ideal for hosting bundles and entry level websites. AlphaSSL can be purchased in standard or Wildcard options, 1-5 year validity periods. AlphaSSL has automated email based verification and is issued instantly.
+
==== SSL Options ====
  
*'''DomainSSL''' - DomainSSL is a higher end branded GlobalSign SSL Certificate with a clickable Secure Site Seal. DomainSSL can be purchased in standard or Wildcard options, 1-5 year validity periods. DomainSSL has automated email based verification and is issued instantly.
+
You can use either of the following options:
  
*'''OrganizationSSL''' - OrganizationSSL is a traditionally vetted and a higher end GlobalSign branded SSL Certificate with a clickable Secure Site Seal. OrganizationSSL can be purchased in standard or Wildcard options, 1-5 year validity periods. As OrganizationSSL is manually vetted the issuance period is 1-2 business days.
+
'''Standard SSL option''' is the default option type for all GlobalSign SSL.
 +
* GlobalSign issues Standard SSL Certificates to a single fully qualified domain name like <tt><nowiki>www.globalsign.com</nowiki></tt>.  
 +
* Applications for domains that start with <tt>www</tt> will also work with the non-<tt>www</tt> version of the domain (for example, a certificate for <tt><nowiki>https://www.globalsign.com</nowiki></tt> will also work for <tt><nowiki>https://globalsign.com</nowiki></tt>).
  
*'''ExtendedSSL''' - ExtendedSSL is an Extended Validation (EV) SSL Certificate conforming to the EV SSL guidelines and will activate the green address bar in all new browsers. ExtendedSSL can be purchased only as a standard option and 1-2 year validity periods. ExtendedSSL provides the highest trust levels offered by SSL and is manually vetted within 3 business days.
+
'''Wildcard SSL option''' allows you to issue certificates to a wildcard domain like <tt><nowiki>*.globalsign.com</nowiki></tt>. The <tt>*</tt> character allows the certificate to be used to secure any subdomain on the domain.
 +
* For example, a certifiacte for <tt><nowiki>*.globalsign.com</nowiki></tt> could secure <tt><nowiki>products.globalsign.com</nowiki></tt>, <tt><nowiki>webmail.globalsign.com</nowiki></tt>, <tt><nowiki>anything.globalsign.com</nowiki></tt>).
 +
* Wildcard SSL will support an unlimited number of subdomains.  
 +
* You can only use this option for '''AlphaSSL''', '''DomainSSL''', and '''OrganizationSSL'''.
  
==Configuring a Product==
+
==== SSL Types ====
 +
You can use any of the following types if your chosen option supports them:
  
#Begin by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.
+
* '''AlphaSSL''' — A low cost, entry level SSL certificate for hosting bundles and entry-level websites.
#Create a new product with type Other and the name of the Certificate you want to offer
+
** AlphaSSL is available for Standard or Wildcard SSL options with one to five-year validity periods.
#Click '''Create''' to be taken to the full product configuration screen
+
** AlphaSSL has automated email based verification and is issued instantly.
#Set the description and other options as desired but leave the Welcome Email set to None
+
* '''DomainSSL''' — DomainSSL is a higher-end branded GlobalSign SSL certificate with a clickable Secure Site Seal.  
#Pricing should be set to one time as renewals cannot be processed
+
** DomainSSL is available for Standard or Wildcard SSL options with one to five-year validity periods.
#Next, switch to the '''Module Settings''' tab and choose '''Globalsignssl''' in the Module dropdown
+
** DomainSSL has automated email based verification and is issued instantly.
#Now the GlobalSign product options will appear where you'll be asked to enter your GlobalSign username & password, choose the certificate product code, base option & validity period this product is for
+
* '''OrganizationSSL''' — OrganizationSSL is a traditionally vetted and a higher-end GlobalSign branded SSL certificate with a clickable Secure Site Seal.
#In the automation choices, you can choose you're preferred action and this determines when the configuration email link is sent - it can be instantly on payment or only when you have reviewed and manually accepted the new order
+
** OrganizationSSL is available for Standard or Wildcard SSL options with one to five-year validity periods.
#Once complete, click '''Save Changes'''
+
** Because OrganizationSSL is manually vetted, the issuance period is one to two business days.
#Finally your server IP address will need to be whitelisted by Globalsign support for access to their API. Failure to do so will result in a "This IP Address is not registered" error message.
+
*'''ExtendedSSL''' — ExtendedSSL is an Extended Validation (EV) SSL certificate that conforms to the EV SSL guidelines and will activate the green address bar in all new browsers. It provides the highest trust levels available in SSL.
 +
** ExtendedSSL is only available for the Standard SSL option with one to two-year validity periods.
 +
** Because ExtendedSSL is manually vetted, the issuance period is one to three business days.
  
==The Order Process==
+
===Test Mode===
  
In WHMCS, the SSL certificate order process is as follows:
+
To enable test mode, check '''Test Mode''' in the module settings page of the product configuration.
  
#The product is ordered and paid for by the customer with the regular order process and no configuration of the certificate
+
You must have an active Test Mode account with GlobalSign. If you do not have a Test Account, contact
#When the product is activated, the email template '''SSL Certificate Configuration Required''' is sent to the customer with a link back to the WHMCS client area where they must go to configure the certificate
+
your Account Manager to request Test Mode activation.
#At the configuration page, the user is asked for their server type, the CSR, the admin details to assign the certificate and the email address they want the verification email sent to
 
#Once completed, the certificate is delivered via email to the chosen admin address
 
  
At no point in the process does your customer ever leave your WHMCS site. Everything is handled automatically through WHMCS.
+
==The Order Process==
  
===Year Selections===
+
In WHMCS, SSL certificate orders use the following process:
  
*A configurable option can be setup to offer different validity period options for the customer to choose from at the time of ordering
+
# The customer orders and pays for the product using the regular order process. This does not configure the certificate.
*To do this, setup a [[Addons_and_Configurable_Options|Configurable Option Group]] in the normal way with an option name of "Years|Display Name Here" and options of the number of years you want to offer, eg 1, 2, 3, 4 or 5
+
# When the product is activated, the customer receives the '''SSL Certificate Configuration Required''' [[Email Templates|email template]] with a link to configure the certificate in the WHMCS Client Area.
For example your configurable option might look like this:
+
# At the configuration page, the user supplies their server type, the CSR, the admin details to assign the certificate, and the email address to send the verification email to.
 +
# The system delivers the certificate via email.
  
[[Image:Geotrustssl configop.png]]
+
At no point in the process does your customer ever leave your WHMCS site. WHMCS handles everything automatically.
  
===Test Mode===
+
==Troubleshooting==
  
To enable test mode, simply tick the Test Mode option in the Module Settings
+
===Error Code: -4001 - Login Failed===
page of the product config. Note: you must have an active Test Mode account
 
with GlobalSign. If you have not already been given a Test Account, contact
 
your Account Manager to request Test Mode activation.
 
  
==Common Problems==
+
The login details in the product's '''Module Settings''' tab are incorrect. Update them with the current login details for your Globalsign account.
===Error Code: -4001 - Login Failed===
 
The login details entered under the product's Module Settings tab are incorrect. Please update them with the current login details for your Globalsign account.
 
  
 
<div class="docs-alert-info">
 
<div class="docs-alert-info">
<span class="title">Note:</span><br />
+
This module's '''Create''' function does not generate a username and password. The username and password will be blank in the client's profile's '''[[Clients:Products/Services Tab|Products/Services]]''' tab.
The module create function of this module does not generate a username and password by design. Therefore the username/password fields will be blank under the client's Products/services tab.
 
 
</div>
 
</div>
 +
 +
{{modules}}

Latest revision as of 17:58, 13 May 2022

About this Module

This module automates SSL ordering and configuration with the GlobalSign platform. For more information, see the GlobalSign website.

Configuring a Product

To set up a GlobalSign SSL product:

  1. G o to Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services.
  2. Create a new product with type Other and the name of the certificate you want to offer.
  3. Click Create.
  4. Configure the product.
    • Set Welcome Email to None.
    • Set Pricing to One Time.
    • In the Module Settings tab, choose Globalsignssl for Module. Enter your GlobalSign username and password and choose a certificate product code, base option, and validity period and your preferred automation action.
  5. Click Save Changes
  6. Whitelist your server IP address by contacting Globalsign support and asking for access to their API. If you do not do this, you will see a "This IP Address is not registered" error message.

Available Certificate Types

When you use this module, you have access to all of GlobalSign's SSL certificate types and both the Standard and Wildcard SSL options.

SSL Options

You can use either of the following options:

Standard SSL option is the default option type for all GlobalSign SSL.

  • GlobalSign issues Standard SSL Certificates to a single fully qualified domain name like www.globalsign.com.
  • Applications for domains that start with www will also work with the non-www version of the domain (for example, a certificate for https://www.globalsign.com will also work for https://globalsign.com).

Wildcard SSL option allows you to issue certificates to a wildcard domain like *.globalsign.com. The * character allows the certificate to be used to secure any subdomain on the domain.

  • For example, a certifiacte for *.globalsign.com could secure products.globalsign.com, webmail.globalsign.com, anything.globalsign.com).
  • Wildcard SSL will support an unlimited number of subdomains.
  • You can only use this option for AlphaSSL, DomainSSL, and OrganizationSSL.

SSL Types

You can use any of the following types if your chosen option supports them:

  • AlphaSSL — A low cost, entry level SSL certificate for hosting bundles and entry-level websites.
    • AlphaSSL is available for Standard or Wildcard SSL options with one to five-year validity periods.
    • AlphaSSL has automated email based verification and is issued instantly.
  • DomainSSL — DomainSSL is a higher-end branded GlobalSign SSL certificate with a clickable Secure Site Seal.
    • DomainSSL is available for Standard or Wildcard SSL options with one to five-year validity periods.
    • DomainSSL has automated email based verification and is issued instantly.
  • OrganizationSSL — OrganizationSSL is a traditionally vetted and a higher-end GlobalSign branded SSL certificate with a clickable Secure Site Seal.
    • OrganizationSSL is available for Standard or Wildcard SSL options with one to five-year validity periods.
    • Because OrganizationSSL is manually vetted, the issuance period is one to two business days.
  • ExtendedSSL — ExtendedSSL is an Extended Validation (EV) SSL certificate that conforms to the EV SSL guidelines and will activate the green address bar in all new browsers. It provides the highest trust levels available in SSL.
    • ExtendedSSL is only available for the Standard SSL option with one to two-year validity periods.
    • Because ExtendedSSL is manually vetted, the issuance period is one to three business days.

Test Mode

To enable test mode, check Test Mode in the module settings page of the product configuration.

You must have an active Test Mode account with GlobalSign. If you do not have a Test Account, contact your Account Manager to request Test Mode activation.

The Order Process

In WHMCS, SSL certificate orders use the following process:

  1. The customer orders and pays for the product using the regular order process. This does not configure the certificate.
  2. When the product is activated, the customer receives the SSL Certificate Configuration Required email template with a link to configure the certificate in the WHMCS Client Area.
  3. At the configuration page, the user supplies their server type, the CSR, the admin details to assign the certificate, and the email address to send the verification email to.
  4. The system delivers the certificate via email.

At no point in the process does your customer ever leave your WHMCS site. WHMCS handles everything automatically.

Troubleshooting

Error Code: -4001 - Login Failed

The login details in the product's Module Settings tab are incorrect. Update them with the current login details for your Globalsign account.

This module's Create function does not generate a username and password. The username and password will be blank in the client's profile's Products/Services tab.

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible