Symantec CryptoExec For WHMCS - Installation and Management Guide
Symantec CryptoExec For WHMCS - Installation and Management Guide
Symantec CryptoExec For WHMCS - Installation and Management Guide
WHMCS
CryptoExec
For
Legal notice
Copyright 2015 Symantec, Inc. All rights reserved.
Symantec and the Symantec Logo are trademarks or registered trademarks of Symantec Inc. or its affiliates in the
U.S. and other countries. Other names may be trademarks of their respective owners.
This Symantec product may contain third party software for which Symantec is required to provide attribution to the
third party (Third Party Programs). Some of the Third Party Programs are available under open source or free
software licenses.
The product described in this document is distributed under licenses restricting its use, copying, distribution, and
decompilation/reverse engineering. No part of this document may be reproduced in any form by any means without
prior written authorization of Symantec Inc. and its licensors, if any.
THE DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS,
REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY
INVALID. THAWTE INC. SHALL NOT BE LIABLE FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES
IN CONNECTION WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS DOCUMENTATION. THE
INFORMATION CONTAINED IN THIS DOCUMENTATION IS SUBJECT TO CHANGE WITHOUT NOTICE.
The Licensed Software and Documentation are deemed to be commercial computer software as defined in FAR
12.212 and subject to restricted rights as defined in FAR Section 52.227-19 "Commercial Computer Software Restricted Rights" and DFARS 227.7202, "Rights in Commercial Computer Software or Commercial Computer
Software Documentation", as applicable, and any successor regulations. Any use, modification, reproduction
release, performance, display or disclosure of the Licensed Software and Documentation by the U.S. Government
shall be solely in accordance with the terms of this Agreement.
7/7/2015
Contents
7/7/2015
Chapter
Voucher Based Ordering with Symantec CryptoExec for WHMCS Vouchers. For resellers to automate
the generation and installation of SSL certificates within a cPanel environment.
Classic SSL Based ordering with Symantec CryptoExec for WHMCS. This process flow is similar to
ordering online (capturing CSR, contact information, delivery information). This solution is for customers
that do not want to use the cPanel module.
7/7/2015
Chapter
Installing Symantec
CryptoExec for WHMCS
System requirements
MySQL
PHP
SOAP
OpenSSL
WHMCS 5.3.14+
Installation steps
To install Symantec CryptoExec for WHMCS
1.
2.
3.
Note that WHMCS_SymantecCryptoExecVoucher is for users who want to WHMCS and cPanel/WHM in
voucher flow and WHMCS_SymantecCryptoExec is for users who just want to use WHMCS in classic
flow.
7/7/2015
Chapter
Configuring products in
WHMCS
About configuring products
Complete the following procedure for each product you want to configure.
1.
Open WHMCS and click Setup, Products/Services, and then select Products/Services.
2.
Create a new group for the product. Name it, choose a template, assign payment gateways and your save
changes.
3.
Add a new product in this group. Select Other Product/Service as the product type and the group you
created in step 2 as the product group. Enter a name for the product and make sure to unselect Require
domain:
7/7/2015
4.
In the Module Settings tab next to module name, select SymantecCryptoExec or for a voucher-based
flow, select SymantecCryptoExecVoucher.
5.
Enter your Partner API username, password, and partner code. If you do not have Partner API credentials
or a partner code, contact your Symantec account manager or apisupport@symantec.com.
Test mode test mode will allow you to connect to your GeoCenter test account portal. This will allow you
to test the configuration of each product. When you are ready to go live, you must clear this option and
enter your PRODUCTION credentials, which are different than your test credentials.
6.
7.
Choose the product you created in step 3. Depending on the product you selected, SAN Support may
appear to the right.
8.
Same as Order Administrative Contact if the technical contact will also be used as the order
administrative contact information
Custom if you have different contact information for administrative and technical contacts.
7/7/2015
9.
Configure Domain Control Validation for DV Certificates: This field is ignored for OV and EV certificates.
There are 3 options to select for default Domain Validated certificates during the ordering process:
o FILE * This is domain control validation by File creation at the root of the website.
o DNS - This is domain control validation by DNS Entry.
o EMAIL - This is domain control validation by Email Approval
Important: For Domain Validated certificates like QuickSSL Premium, we recommend defaulting to the
voucher product to as this is the optimal way to install the certificate within the cPanel environment.
10. Click Install next to Install Custom Fields to automatically add all required custom fields.
11. Click Install next to Install Configurable Options to generate all required configurable options.
o
Once generated go to Setup, Products/Services, and then click Configurable Options. Edit the
product options, and number of SANs option.
All pricing options appear next to each option name: 1|1 State your individual rates and save your
changes.
12. Click Install next to Set Default Pricing to set up possible pricing options. Then go to the Pricing section
on the same page to manage pricing and declare your rates.
13. Repeat this procedure for each product you want to add.
7/7/2015
Chapter
Configuring certificates
in WHMCS
About configuring certificates
Clients
can
purchase
the
products
you
added
from
their
client
area
like
any
other
product.
After
a
product
is
activated,
clients
can
view
its
details
in
their
client
area.
To configure a certificate
1.
In
the
SSL
Certificate
Details
for
a
certificate
that
is
awaiting
configuration,
click
Click
to
configure
certificate.
7/7/2015
2.
Select a web server type, enter a valid CSR, and choose the domain validation type. Enter any additional
domains (SANs) you want to secure.
3.
4.
5.
After correctly entering the information, more certificate details appear. Choose certificate approval email
and click Continue. Youll receive an email after the order is validated by the Certificate Authority.
6.
The certificates status should be Completed, while order status and order state should be in process.
Youll receive an email after the order is approved.
10
7/7/2015
After the process is complete, the certificate details should look like this:
11
7/7/2015
Chapter
Management Actions
About management actions
The
Symantec
CrypoExec
for
WHMCS
module
allows
you
to
perform
a
variety
of
certificate
management
actions,
based
on
the
certificate
type.
You
can
cancel
and
reissue
certificates,
resend
or
change
the
approver
email
for
a
certificate,
see
certificate
details,
and
request
cancellation
if
you
want
to
cancel
an
entire
product.
12
7/7/2015
Chapter
Module logging
capabilities
About module logging
The WHMCS administration portal has full logging capabilities to track and review any issues that occur during the
configuration process. You can find the log by going to Utilities Logs Module Logs.
Note: This functionality must be enabled in order for the Modules to commence logging. To enable it, select Enable
Debug Logging.
The logging page shows the module and the steps that were performed. The request and response sections are the
actual API calls made into the Symantec API.
13
7/7/2015
Chapter
Troubleshooting guide
I do not see my modules installed within WHMCS?
In order for the modules and their respective templates to load, please make sure the files are placed within
1. For Module components: <whmcs home>/modules/servers
2. For Template components: <whmcs home>/templates/default
14
7/7/2015