Current File : //usr/lib/python2.7/site-packages/salt/modules/namecheap_ssl.pyc
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z y d d l Z e Z
Wn e k
ri e Z
n Xd d l
m Z d � Z d e d � Z d e d � Z d � Z d d � Z d d d
� Z e d � Z d � Z e d d
� Z d S( uf
Namecheap SSL Certificate Management
.. versionadded:: 2017.7.0
Prerequisites
-------------
This module uses the ``requests`` Python module to communicate to the namecheap
API.
Configuration
-------------
The Namecheap username, API key and URL should be set in the minion configuration
file, or in the Pillar data.
.. code-block:: yaml
namecheap.name: companyname
namecheap.key: a1b2c3d4e5f67a8b9c0d1e2f3
namecheap.client_ip: 162.155.30.172
#Real url
namecheap.url: https://api.namecheap.com/xml.response
#Sandbox url
#namecheap.url: https://api.sandbox.namecheap.xml.response
i ( t absolute_importt print_functiont unicode_literalsN( t sixc C@ s t r
d St S( uH
Check to make sure requests and xml are installed and requests
u
namecheap_ssl( t CAN_USE_NAMECHEAPt False( ( ( s> /usr/lib/python2.7/site-packages/salt/modules/namecheap_ssl.pyt __virtual__. s c K@ s t d d | | | | | | � S( u�
Reissues a purchased SSL certificate. Returns a dictionary of result
values.
csr_file
Path to Certificate Signing Request file
certificate_id
Unique ID of the SSL certificate you wish to activate
web_server_type
The type of certificate format to return. Possible values include:
- apache2
- apacheapachessl
- apacheopenssl
- apacheraven
- apachessl
- apachessleay
- c2net
- cobaltseries
- cpanel
- domino
- dominogo4625
- dominogo4626
- ensim
- hsphere
- ibmhttp
- iis
- iis4
- iis5
- iplanet
- ipswitch
- netscape
- other
- plesk
- tomcat
- weblogic
- website
- webstar
- zeusv3
approver_email
The email ID which is on the approver email list.
.. note::
``http_dc_validation`` must be set to ``False`` if this option is
used.
http_dc_validation : False
Whether or not to activate using HTTP-based validation.
.. note::
For other parameters which may be required, see here__.
.. __: https://www.namecheap.com/support/api/methods/ssl/reissue.aspx
CLI Example:
.. code-block:: bash
salt 'my-minion' namecheap_ssl.reissue my-csr-file my-cert-id apachessl
u namecheap.ssl.reissueu SSLReissueResult( t __get_certificates( t csr_filet certificate_idt web_server_typet approver_emailt http_dc_validationt kwargs( ( s> /usr/lib/python2.7/site-packages/salt/modules/namecheap_ssl.pyt reissue7 s Ec K@ s t d d | | | | | | � S( u�
Activates a newly-purchased SSL certificate. Returns a dictionary of result
values.
csr_file
Path to Certificate Signing Request file
certificate_id
Unique ID of the SSL certificate you wish to activate
web_server_type
The type of certificate format to return. Possible values include:
- apache2
- apacheapachessl
- apacheopenssl
- apacheraven
- apachessl
- apachessleay
- c2net
- cobaltseries
- cpanel
- domino
- dominogo4625
- dominogo4626
- ensim
- hsphere
- ibmhttp
- iis
- iis4
- iis5
- iplanet
- ipswitch
- netscape
- other
- plesk
- tomcat
- weblogic
- website
- webstar
- zeusv3
approver_email
The email ID which is on the approver email list.
.. note::
``http_dc_validation`` must be set to ``False`` if this option is
used.
http_dc_validation : False
Whether or not to activate using HTTP-based validation.
.. note::
For other parameters which may be required, see here__.
.. __: https://www.namecheap.com/support/api/methods/ssl/activate.aspx
CLI Example:
.. code-block:: bash
salt 'my-minion' namecheap_ssl.activate my-csr-file my-cert-id apachessl
u namecheap.ssl.activateu SSLActivateResult( R ( R R R
R R R
( ( s> /usr/lib/python2.7/site-packages/salt/modules/namecheap_ssl.pyt activate� s Ec C@ sk d0 } | | k r? t j j j j d | � t d | � � n | d k rv | rv t j j j j d � t d � � n | d k r� | r� t j j j j d � t d � � n t j j j | � } t j j j | d � �& }
t j j
j |
j � � | d! <Wd QX| | d" <| | d# <| d k r0| | d$ <n | rCd% | d& <n x' t
j | � D] \ } } | | | <qSWt j j j | � }
|
d k r�i S|
j | � d' } t j j j | � } | rg| j d( � } | d k rgt | � d' k rg| d' } | j d) � j � d* k rdi | j d+ � d' j d' j d, 6| j d- � d' j d' j d. 6} | | d/ <qdqgn | S(1 Nu
apacheopensslu apachesslu apacheravenu apachessleayu c2netu ibmhttpu iplanetu dominou dominogo4625u dominogo4626u netscapeu zeusv3u apache2u apacheapachesslu cobaltseriesu cpanelu ensimu hsphereu ipswitchu plesku tomcatu weblogicu websiteu webstaru iisu otheru iis4u iis5u# Invalid option for web_server_type=u= approver_email and http_dc_validation cannot both have valuesu6 approver_email or http_dc_validation must have a valueu rbu csru
CertificateIDu
WebServerTypeu
ApproverEmailu Trueu HTTPDCValidationi u HttpDCValidationu ValueAvailableu trueu FileNameu filenameu FileContentu filecontentu httpdcvalidation( u
apacheopensslu apachesslu apacheravenu apachessleayu c2netu ibmhttpu iplanetu dominou dominogo4625u dominogo4626u netscapeu zeusv3u apache2u apacheapachesslu cobaltseriesu cpanelu ensimu hsphereu ipswitchu plesku tomcatu weblogicu websiteu webstaru iisu otheru iis4u iis5( t saltt utilst namecheapt logt errort Exceptiont Nonet get_optst filest fopent stringutilst
to_unicodet readR t iteritemst post_requestt getElementsByTagNamet atts_to_dictt lent getAttributet lowert
childNodest data( t commandt result_tag_nameR R R
R R R
t web_server_typest optst
csr_handlet keyt valuet response_xmlt sslresultt resultt validation_tagt validation_dict( ( s> /usr/lib/python2.7/site-packages/salt/modules/namecheap_ssl.pyR � s�
!c C@ s? d* } | | k r? t j j j j d | � t d | � � n | d k sW | d! k r� t j j j j d" t j | � � t d" t j | � � � n t j j j d# � } t j | � | d$ <t j | � | d% <| | d& <| d+ k r� | | d' <n t j j j
| � } | d+ k ri S| j d( � d) } t j j j | � S(, u�
Renews an SSL certificate if it is ACTIVE and Expires <= 30 days. Returns
the following information:
- The certificate ID
- The order ID
- The transaction ID
- The amount charged for the order
years : 1
Number of years to register
certificate_id
Unique ID of the SSL certificate you wish to renew
certificate_type
Type of SSL Certificate. Possible values include:
- EV Multi Domain SSL
- EV SSL
- EV SSL SGC
- EssentialSSL
- EssentialSSL Wildcard
- InstantSSL
- InstantSSL Pro
- Multi Domain SSL
- PositiveSSL
- PositiveSSL Multi Domain
- PositiveSSL Wildcard
- PremiumSSL
- PremiumSSL Wildcard
- QuickSSL Premium
- RapidSSL
- RapidSSL Wildcard
- SGC Supercert
- SSL Web Server
- SSL Webserver EV
- SSL123
- Secure Site
- Secure Site Pro
- Secure Site Pro with EV
- Secure Site with EV
- True BusinessID
- True BusinessID Multi Domain
- True BusinessID Wildcard
- True BusinessID with EV
- True BusinessID with EV Multi Domain
- Unified Communications
promotional_code
An optional promo code to use when renewing the certificate
CLI Example:
.. code-block:: bash
salt 'my-minion' namecheap_ssl.renew 1 my-cert-id RapidSSL
u QuickSSL Premiumu RapidSSLu RapidSSL Wildcardu
PremiumSSLu
InstantSSLu PositiveSSLu PositiveSSL Wildcardu True BusinessID with EVu True BusinessIDu True BusinessID Wildcardu True BusinessID Multi Domainu$ True BusinessID with EV Multi Domainu Secure Siteu Secure Site Prou Secure Site with EVu Secure Site Pro with EVu EssentialSSLu EssentialSSL Wildcardu InstantSSL Prou PremiumSSL Wildcardu EV SSLu
EV SSL SGCu SSL123u SSL Web Serveru
SGC Supercertu SSL Webserver EVu EV Multi Domain SSLu Multi Domain SSLu PositiveSSL Multi Domainu Unified Communicationsu$ Invalid option for certificate_type=i i u Invalid option for years=u namecheap.ssl.renewu Yearsu
CertificateIDu SSLTypeu
PromotionCodeu SSLRenewResulti ( u QuickSSL Premiumu RapidSSLu RapidSSL Wildcardu
PremiumSSLu
InstantSSLu PositiveSSLu PositiveSSL Wildcardu True BusinessID with EVu True BusinessIDu True BusinessID Wildcardu True BusinessID Multi Domainu$ True BusinessID with EV Multi Domainu Secure Siteu Secure Site Prou Secure Site with EVu Secure Site Pro with EVu EssentialSSLu EssentialSSL Wildcardu InstantSSL Prou PremiumSSL Wildcardu EV SSLu
EV SSL SGCu SSL123u SSL Web Serveru
SGC Supercertu SSL Webserver EVu EV Multi Domain SSLu Multi Domain SSLu PositiveSSL Multi Domainu Unified CommunicationsN(
R R R R R R R t text_typeR R R R R ( t yearsR t certificate_typet promotion_codet valid_certsR) R- t sslrenewresult( ( s> /usr/lib/python2.7/site-packages/salt/modules/namecheap_ssl.pyt renew$ s^ < #
c
C@ sq d+ } | | k r? t j j j j d | � t d | � � n | d k sW | d! k r� t j j j j d" t j | � � t d" t j | � � � n t j j j d# � } | | d$ <| | d% <| d, k r� | | d& <n | d, k r� | | d' <n t j j j
| � } | d, k ri S| j d( � d) } | j d* � d) } t j j j | � } | j
t j j j | � � | S(- u@
Creates a new SSL certificate. Returns the following information:
- Whether or not the SSL order was successful
- The certificate ID
- The order ID
- The transaction ID
- The amount charged for the order
- The date on which the certificate was created
- The date on which the certificate will expire
- The type of SSL certificate
- The number of years for which the certificate was purchased
- The current status of the SSL certificate
years : 1
Number of years to register
certificate_type
Type of SSL Certificate. Possible values include:
- EV Multi Domain SSL
- EV SSL
- EV SSL SGC
- EssentialSSL
- EssentialSSL Wildcard
- InstantSSL
- InstantSSL Pro
- Multi Domain SSL
- PositiveSSL
- PositiveSSL Multi Domain
- PositiveSSL Wildcard
- PremiumSSL
- PremiumSSL Wildcard
- QuickSSL Premium
- RapidSSL
- RapidSSL Wildcard
- SGC Supercert
- SSL Web Server
- SSL Webserver EV
- SSL123
- Secure Site
- Secure Site Pro
- Secure Site Pro with EV
- Secure Site with EV
- True BusinessID
- True BusinessID Multi Domain
- True BusinessID Wildcard
- True BusinessID with EV
- True BusinessID with EV Multi Domain
- Unified Communications
promotional_code
An optional promo code to use when creating the certificate
sans_to_add : 0
This parameter defines the number of add-on domains to be purchased in
addition to the default number of domains included with a multi-domain
certificate. Each certificate that supports SANs has the default number
of domains included. You may check the default number of domains
included and the maximum number of domains that can be added to it in
the table below.
+----------+----------------+----------------------+-------------------+----------------+
| Provider | Product name | Default number of | Maximum number of | Maximum number |
| | | domains (domain from | total domains | of domains |
| | | CSR is counted here) | | that can be |
| | | | | passed in |
| | | | | sans_to_add |
| | | | | parameter |
+----------+----------------+----------------------+-------------------+----------------+
| Comodo | PositiveSSL | 3 | 100 | 97 |
| | Multi-Domain | | | |
+----------+----------------+----------------------+-------------------+----------------+
| Comodo | Multi-Domain | 3 | 100 | 97 |
| | SSL | | | |
+----------+----------------+----------------------+-------------------+----------------+
| Comodo | EV Multi- | 3 | 100 | 97 |
| | Domain SSL | | | |
+----------+----------------+----------------------+-------------------+----------------+
| Comodo | Unified | 3 | 100 | 97 |
| | Communications | | | |
+----------+----------------+----------------------+-------------------+----------------+
| GeoTrust | QuickSSL | 1 | 1 domain + | The only |
| | Premium | | 4 subdomains | supported |
| | | | | value is 4 |
+----------+----------------+----------------------+-------------------+----------------+
| GeoTrust | True | 5 | 25 | 20 |
| | BusinessID | | | |
| | with EV | | | |
| | Multi-Domain | | | |
+----------+----------------+----------------------+-------------------+----------------+
| GeoTrust | True Business | 5 | 25 | 20 |
| | ID Multi- | | | |
| | Domain | | | |
+----------+----------------+----------------------+-------------------+----------------+
| Thawte | SSL Web | 1 | 25 | 24 |
| | Server | | | |
+----------+----------------+----------------------+-------------------+----------------+
| Thawte | SSL Web | 1 | 25 | 24 |
| | Server with | | | |
| | EV | | | |
+----------+----------------+----------------------+-------------------+----------------+
| Thawte | SGC Supercerts | 1 | 25 | 24 |
+----------+----------------+----------------------+-------------------+----------------+
| Symantec | Secure Site | 1 | 25 | 24 |
| | Pro with EV | | | |
+----------+----------------+----------------------+-------------------+----------------+
| Symantec | Secure Site | 1 | 25 | 24 |
| | with EV | | | |
+----------+----------------+----------------------+-------------------+----------------+
| Symantec | Secure Site | 1 | 25 | 24 |
+----------+----------------+----------------------+-------------------+----------------+
| Symantec | Secure Site | 1 | 25 | 24 |
| | Pro | | | |
+----------+----------------+----------------------+-------------------+----------------+
CLI Example:
.. code-block:: bash
salt 'my-minion' namecheap_ssl.create 2 RapidSSL
u QuickSSL Premiumu RapidSSLu RapidSSL Wildcardu
PremiumSSLu
InstantSSLu PositiveSSLu PositiveSSL Wildcardu True BusinessID with EVu True BusinessIDu True BusinessID Wildcardu True BusinessID Multi Domainu$ True BusinessID with EV Multi Domainu Secure Siteu Secure Site Prou Secure Site with EVu Secure Site Pro with EVu EssentialSSLu EssentialSSL Wildcardu InstantSSL Prou PremiumSSL Wildcardu EV SSLu
EV SSL SGCu SSL123u SSL Web Serveru
SGC Supercertu SSL Webserver EVu EV Multi Domain SSLu Multi Domain SSLu PositiveSSL Multi Domainu Unified Communicationsu$ Invalid option for certificate_type=i i u Invalid option for years=u namecheap.ssl.createu Yearsu Typeu
PromotionCodeu SANStoADDu SSLCreateResulti u SSLCertificate( u QuickSSL Premiumu RapidSSLu RapidSSL Wildcardu
PremiumSSLu
InstantSSLu PositiveSSLu PositiveSSL Wildcardu True BusinessID with EVu True BusinessIDu True BusinessID Wildcardu True BusinessID Multi Domainu$ True BusinessID with EV Multi Domainu Secure Siteu Secure Site Prou Secure Site with EVu Secure Site Pro with EVu EssentialSSLu EssentialSSL Wildcardu InstantSSL Prou PremiumSSL Wildcardu EV SSLu
EV SSL SGCu SSL123u SSL Web Serveru
SGC Supercertu SSL Webserver EVu EV Multi Domain SSLu Multi Domain SSLu PositiveSSL Multi Domainu Unified CommunicationsN( R R R R R R R R2 R R R R R t update(
R3 R4 R5 t sans_to_addR6 R) R- t sslcreateresultt sslcertinfoR/ ( ( s> /usr/lib/python2.7/site-packages/salt/modules/namecheap_ssl.pyt create� sf { #
c C@ s� d) } | | k r? t j j j j d | � t d | � � n t j j j d � } t j j j | d! � �& } t j j j
| j � � | d" <Wd# QX| | d$ <| r� d% | d& <n t j j j | � } | j
d' � d( } t j j j | � S(* u4
Parses the CSR. Returns a dictionary of result values.
csr_file
Path to Certificate Signing Request file
certificate_type
Type of SSL Certificate. Possible values include:
- EV Multi Domain SSL
- EV SSL
- EV SSL SGC
- EssentialSSL
- EssentialSSL Wildcard
- InstantSSL
- InstantSSL Pro
- Multi Domain SSL
- PositiveSSL
- PositiveSSL Multi Domain
- PositiveSSL Wildcard
- PremiumSSL
- PremiumSSL Wildcard
- QuickSSL Premium
- RapidSSL
- RapidSSL Wildcard
- SGC Supercert
- SSL Web Server
- SSL Webserver EV
- SSL123
- Secure Site
- Secure Site Pro
- Secure Site Pro with EV
- Secure Site with EV
- True BusinessID
- True BusinessID Multi Domain
- True BusinessID Wildcard
- True BusinessID with EV
- True BusinessID with EV Multi Domain
- Unified Communications
http_dc_validation : False
Set to ``True`` if a Comodo certificate and validation should be
done with files instead of emails and to return the info to do so
CLI Example:
.. code-block:: bash
salt 'my-minion' namecheap_ssl.parse_csr my-csr-file PremiumSSL
u QuickSSL Premiumu RapidSSLu RapidSSL Wildcardu
PremiumSSLu
InstantSSLu PositiveSSLu PositiveSSL Wildcardu True BusinessID with EVu True BusinessIDu True BusinessID Wildcardu True BusinessID Multi Domainu$ True BusinessID with EV Multi Domainu Secure Siteu Secure Site Prou Secure Site with EVu Secure Site Pro with EVu EssentialSSLu EssentialSSL Wildcardu InstantSSL Prou PremiumSSL Wildcardu EV SSLu
EV SSL SGCu SSL123u SSL Web Serveru
SGC Supercertu SSL Webserver EVu EV Multi Domain SSLu Multi Domain SSLu PositiveSSL Multi Domainu Unified Communicationsu$ Invalid option for certificate_type=u namecheap.ssl.parseCSRu rbu csrNu CertificateTypeu trueu HTTPDCValidationu SSLParseCSRResulti ( u QuickSSL Premiumu RapidSSLu RapidSSL Wildcardu
PremiumSSLu
InstantSSLu PositiveSSLu PositiveSSL Wildcardu True BusinessID with EVu True BusinessIDu True BusinessID Wildcardu True BusinessID Multi Domainu$ True BusinessID with EV Multi Domainu Secure Siteu Secure Site Prou Secure Site with EVu Secure Site Pro with EVu EssentialSSLu EssentialSSL Wildcardu InstantSSL Prou PremiumSSL Wildcardu EV SSLu
EV SSL SGCu SSL123u SSL Web Serveru
SGC Supercertu SSL Webserver EVu EV Multi Domain SSLu Multi Domain SSLu PositiveSSL Multi Domainu Unified Communications( R R R R R R R R R R R R R R t xml_to_dict( R R4 R R6 R) R* R- t sslparseresult( ( s> /usr/lib/python2.7/site-packages/salt/modules/namecheap_ssl.pyt parse_csrO sV 3
c K@ s� t j j j d � } x' t j | � D] \ } } | | | <q% Wt j j j | � } | d k rd g S| j d � d } g } x9 | j d � D]( } t j j j | � } | j
| � q� W| S( u�
Returns a list of SSL certificates for a particular user
ListType : All
Possible values:
- All
- Processing
- EmailSent
- TechnicalProblem
- InProgress
- Completed
- Deactivated
- Active
- Cancelled
- NewPurchase
- NewRenewal
SearchTerm
Keyword to look for on the SSL list
Page : 1
Page number to return
PageSize : 20
Total number of SSL certificates to display per page (minimum:
``10``, maximum: ``100``)
SoryBy
One of ``PURCHASEDATE``, ``PURCHASEDATE_DESC``, ``SSLTYPE``,
``SSLTYPE_DESC``, ``EXPIREDATETIME``, ``EXPIREDATETIME_DESC``,
``Host_Name``, or ``Host_Name_DESC``
CLI Example:
.. code-block:: bash
salt 'my-minion' namecheap_ssl.get_list Processing
u namecheap.ssl.getListu
SSLListResulti u SSLN( R R R R R R t get_requestR R R t append( R
R) R+ R, R- t
ssllistresultR/ t et ssl( ( s> /usr/lib/python2.7/site-packages/salt/modules/namecheap_ssl.pyt get_list� s ( c C@ s� t j j j d � } | | d <| r� d | d <| d k r` t j j j j d � t d � � n | d
k r� t j j j j d | � t d | � � n | | d <n t j j j | � } | d k r� i S| j d
� d } t j j j
| � S( u
Retrieves information about the requested SSL certificate. Returns a
dictionary of information about the SSL certificate with two keys:
- **ssl** - Contains the metadata information
- **certificate** - Contains the details for the certificate such as the
CSR, Approver, and certificate data
certificate_id
Unique ID of the SSL certificate
returncertificate : False
Set to ``True`` to ask for the certificate in response
returntype
Optional type for the returned certificate. Can be either "Individual"
(for X.509 format) or "PKCS7"
.. note::
Required if ``returncertificate`` is ``True``
CLI Example:
.. code-block:: bash
salt 'my-minion' namecheap_ssl.get_info my-cert-id
u namecheap.ssl.getinfou
certificateIDu trueu returncertificateuB returntype must be specified when returncertificate is set to Trueu
Individualu PKCS7u9 returntype must be specified as Individual or PKCS7, not u
returntypeu SSLGetInfoResulti N( u
Individualu PKCS7( R R R R R R R R RA R R> ( R t returncertificatet
returntypeR) R- t
sslinforesult( ( s> /usr/lib/python2.7/site-packages/salt/modules/namecheap_ssl.pyt get_info� s
( t __doc__t
__future__R R R t salt.utils.filesR t salt.utils.stringutilst salt.utils.namecheapt TrueR t ImportErrorR t salt.extR R R R R R R8 R= R@ RF RJ ( ( ( s> /usr/lib/python2.7/site-packages/salt/modules/namecheap_ssl.pyt <module> s(
H E [ s� i ;
Mini Shell