Difference between revisions of "GlobalSign SSL"

From WHMCS Documentation

 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This module automates SSL ordering and configuration with the GlobalSign platform.
+
== About this Module ==
  
'''Not got a GlobalSign Account Yet?''' If not, then sign up @ http://www.globalsign.com/partners/whmcs/ and get special introductory rates as a WHMCS user.
+
This module automates SSL ordering and configuration with the GlobalSign platform. For more information, see [http://www.globalsign.com/ssl/ the GlobalSign website].
  
==Available Certificate Types==
+
==Configuring a Product==
  
*'''Alpha SSL''' - This product is referenced as the DV_LOW.  It is our low end domain validated certificate and known to our resellers as AlphaSSL.  This product can only be purchased in standard or wildcard options, 1-5 year validity periods. None of the other options can be used with this product
+
To set up a GlobalSign SSL product:
  
*'''Domain SSL''' - This product is referenced as DV in the product codes. This product can also be ordered without having to generate a CSR on the end user side, and would then be referenced by the DV_SKIP product code. To our resellers, these two products are known as DomainSSL and DomainSSL with Auto-CSR .
+
#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.
  
*'''Organizational SSL''' - This product is referenced as OV in the product codes.  This product can also be ordered without having to generate a CSR on the end user side, and would then be referenced by the OV_SKIP product codes.  To our resellers, these two products are known as OrganizationalSSL and OrganizationalSSL with Auto-CSR.  Both of these product codes can be ordered as not only a standard and wildcard option, but also as a globalip option.
+
===Available Certificate Types===
  
*'''Extended SSL''' - This product is referenced as EV in the product codes.  This product is known to our resellers as the ExtendedSSL.  This product can be ordered as only a standard and globalip option, NOT as a wildcard option.
+
When you use this module, you have access to all of GlobalSign's SSL certificate types and both the Standard and Wildcard SSL options.
  
==Installation==
+
==== SSL Options ====
  
The GlobalSign module was first released in February 2010 so if you do not see it in your installation, simply download the module from the link below and upload to the directory /modules/servers/globalsignssl/ within your WHMCS folder. You will then be able to begin setting up products using it as described below.
+
You can use either of the following options:
  
[http://www.whmcs.com/members/dl.php?type=d&id=47 www.whmcs.com/members/dl.php?type=d&id=47]
+
'''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>).
  
==Configuring a Product==
+
'''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'''.
 +
 
 +
==== 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.
  
#Begin by going to '''Setup > Products/Services'''
+
You must have an active Test Mode account with GlobalSign. If you do not have a Test Account, contact
#Create a new product with type Other and the name of the Certificate you want to offer
+
your Account Manager to request Test Mode activation.
#Click '''Create''' to be taken to the full product configuration screen
 
#Set the description and other options as desired but leave the Welcome Email set to None
 
#Pricing should be set to one time as renewals cannot be processed
 
#Next, switch to the '''Module Settings''' tab and choose '''Globalsignssl''' in the Module dropdown
 
#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
 
#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
 
#Once complete, click '''Save Changes'''
 
  
 
==The Order Process==
 
==The Order Process==
  
In WHMCS, the SSL certificate order process is as follows:
+
In WHMCS, SSL certificate orders use the following process:
 +
 
 +
# The customer orders and pays for the product using the regular order process. This does not configure the certificate.
 +
# 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.
 +
# 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.
  
#The product is ordered and paid for by the customer with the regular order process and no configuration of the certificate
+
At no point in the process does your customer ever leave your WHMCS site. WHMCS handles everything automatically.
#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
 
#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.
+
==Troubleshooting==
  
===Year Selections===
+
===Error Code: -4001 - Login Failed===
  
*A configurable option can be setup to offer different validity period options for the customer to choose from at the time of ordering
+
The login details in the product's '''Module Settings''' tab are incorrect. Update them with the current login details for your Globalsign account.
*To do this, setup a [[Addons_and_Configurable_Options|Configurable Option Group]] in the normal way with an option name of "ValidityPeriod|Display Name Here" and options of the number of months you want to offer, eg 12, 24, 36, 48, 60
 
  
===Test Mode===
+
<div class="docs-alert-info">
 +
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.
 +
</div>
  
*To enable test mode, simply tick the Test Mode option in the '''Module Settings''' page of the product config
+
{{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