Skip to content

Commit ebca3d3

Browse files
dirkaholicbillputer
dirkaholic
authored and
billputer
committedJul 23, 2018
Add support for ssl.getList, ssl.create & ssl.activate (#20)
* Add support for ssl.getList * Add support for ssl.create * Add support for ssl.activate
1 parent 521b63a commit ebca3d3

File tree

3 files changed

+437
-0
lines changed

3 files changed

+437
-0
lines changed
 

‎namecheap.go

+3
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ type ApiResponse struct {
5151
DomainsCheck []DomainCheckResult `xml:"CommandResponse>DomainCheckResult"`
5252
DomainNSInfo *DomainNSInfoResult `xml:"CommandResponse>DomainNSInfoResult"`
5353
DomainDNSSetCustom *DomainDNSSetCustomResult `xml:"CommandResponse>DomainDNSSetCustomResult"`
54+
SslActivate *SslActivateResult `xml:"CommandResponse>SSLActivateResult"`
55+
SslCreate *SslCreateResult `xml:"CommandResponse>SSLCreateResult"`
56+
SslCertificates []SslGetListResult `xml:"CommandResponse>SSLListResult>SSL"`
5457
UsersGetPricing []UsersGetPricingResult `xml:"CommandResponse>UserGetPricingResult>ProductType"`
5558
WhoisguardList []WhoisguardGetListResult `xml:"CommandResponse>WhoisguardGetListResult>Whoisguard"`
5659
WhoisguardEnable whoisguardEnableResult `xml:"CommandResponse>WhoisguardEnableResult"`

‎ssl.go

+136
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
package namecheap
2+
3+
import (
4+
"net/url"
5+
"strconv"
6+
)
7+
8+
const (
9+
sslActivate = "namecheap.ssl.activate"
10+
sslCreate = "namecheap.ssl.create"
11+
sslGetList = "namecheap.ssl.getList"
12+
)
13+
14+
// SslGetListResult represents the data returned by 'domains.getList'
15+
type SslGetListResult struct {
16+
CertificateID int `xml:"CertificateID,attr"`
17+
HostName string `xml:"HostName,attr"`
18+
SSLType string `xml:"SSLType,attr"`
19+
PurchaseDate string `xml:"PurchaseDate,attr"`
20+
ExpireDate string `xml:"ExpireDate,attr"`
21+
ActivationExpireDate string `xml:"ActivationExpireDate,attr"`
22+
IsExpired bool `xml:"IsExpiredYN,attr"`
23+
Status string `xml:"Status,attr"`
24+
}
25+
26+
type SslCreateResult struct {
27+
IsSuccess bool `xml:"IsSuccess,attr"`
28+
OrderId int `xml:"OrderId,attr"`
29+
TransactionId int `xml:"TransactionId,attr"`
30+
ChargedAmount float64 `xml:"ChargedAmount,attr"`
31+
SSLCertificate []SSLCertificate `xml:"SSLCertificate"`
32+
}
33+
34+
type SSLCertificate struct {
35+
CertificateID int `xml:"CertificateID,attr"`
36+
SSLType string `xml:"SSLType,attr"`
37+
Created string `xml:"Created,attr"`
38+
Years int `xml:"Years,attr"`
39+
Status string `xml:"Status,attr"`
40+
}
41+
42+
type SslActivateParams struct {
43+
CertificateId int
44+
Csr string
45+
AdminEmailAddress string
46+
WebServerType string
47+
ApproverEmail string
48+
IsHTTPDCValidation bool
49+
IsDNSDCValidation bool
50+
}
51+
52+
type SslActivateResult struct {
53+
ID int `xml:"ID,attr"`
54+
IsSuccess bool `xml:"IsSuccess,attr"`
55+
HttpDCValidation SslDcValidation `xml:"HttpDCValidation"`
56+
DNSDCValidation SslDcValidation `xml:"DNSDCValidation"`
57+
}
58+
59+
type SslDcValidation struct {
60+
ValueAvailable bool `xml:"ValueAvailable,attr"`
61+
Dns SslDns `xml:"DNS"`
62+
}
63+
64+
type SslDns struct {
65+
Domain string `xml:"domain,attr"`
66+
FileName string `xml:"FileName,omitempty"`
67+
FileContent string `xml:"FileContent,omitempty"`
68+
HostName string `xml:"HostName,omitempty"`
69+
Target string `xml:"Target,omitempty"`
70+
}
71+
72+
// SslGetList gets a list of SSL certificates for a particular user
73+
func (client *Client) SslGetList() ([]SslGetListResult, error) {
74+
requestInfo := &ApiRequest{
75+
command: sslGetList,
76+
method: "POST",
77+
params: url.Values{},
78+
}
79+
80+
resp, err := client.do(requestInfo)
81+
if err != nil {
82+
return nil, err
83+
}
84+
85+
return resp.SslCertificates, nil
86+
}
87+
88+
// SslCreate creates a new SSL certificate by purchasing it using the account funds
89+
func (client *Client) SslCreate(productType string, years int) (*SslCreateResult, error) {
90+
requestInfo := &ApiRequest{
91+
command: sslCreate,
92+
method: "POST",
93+
params: url.Values{},
94+
}
95+
requestInfo.params.Set("Type", productType)
96+
requestInfo.params.Set("Years", strconv.Itoa(years))
97+
98+
resp, err := client.do(requestInfo)
99+
if err != nil {
100+
return nil, err
101+
}
102+
103+
return resp.SslCreate, nil
104+
}
105+
106+
// SslActivate activates a purchased and non-activated SSL certificate
107+
func (client *Client) SslActivate(params SslActivateParams) (*SslActivateResult, error) {
108+
requestInfo := &ApiRequest{
109+
command: sslActivate,
110+
method: "POST",
111+
params: url.Values{},
112+
}
113+
requestInfo.params.Set("CertificateID", strconv.Itoa(params.CertificateId))
114+
requestInfo.params.Set("CSR", params.Csr)
115+
requestInfo.params.Set("AdminEmailAddress", params.AdminEmailAddress)
116+
requestInfo.params.Set("WebServerType", params.WebServerType)
117+
118+
if params.IsHTTPDCValidation {
119+
requestInfo.params.Set("HTTPDCValidation", "true")
120+
}
121+
122+
if params.IsDNSDCValidation {
123+
requestInfo.params.Set("DNSDCValidation", "true")
124+
}
125+
126+
if len(params.ApproverEmail) > 0 {
127+
requestInfo.params.Set("ApproverEmail", params.ApproverEmail)
128+
}
129+
130+
resp, err := client.do(requestInfo)
131+
if err != nil {
132+
return nil, err
133+
}
134+
135+
return resp.SslActivate, nil
136+
}

‎ssl_test.go

+298
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,298 @@
1+
package namecheap
2+
3+
import (
4+
"fmt"
5+
"net/http"
6+
"net/url"
7+
"reflect"
8+
"testing"
9+
)
10+
11+
func TestSslGetList(t *testing.T) {
12+
setup()
13+
defer teardown()
14+
15+
respXML := `
16+
<?xml version="1.0" encoding="UTF-8"?>
17+
<ApiResponse Status="OK">
18+
<Errors />
19+
<RequestedCommand>namecheap.ssl.getList</RequestedCommand>
20+
<CommandResponse Type="namecheap.ssl.getList">
21+
<SSLListResult>
22+
<SSL CertificateID="52556" HostName="domainxy.com" SSLType="SSLCertificate3" PurchaseDate="10/17/2006" ExpireDate="10/17/2008" ActivationExpireDate="12/31/2009" IsExpiredYN="false" Status="new" />
23+
</SSLListResult>
24+
<Paging>
25+
<TotalItems>3</TotalItems>
26+
<CurrentPage>1</CurrentPage>
27+
<PageSize>20</PageSize>
28+
</Paging>
29+
</CommandResponse>
30+
<Server>SERVER</Server>
31+
<GMTTimeDifference>+5:30</GMTTimeDifference>
32+
<ExecutionTime>1.094</ExecutionTime>
33+
</ApiResponse>`
34+
35+
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
36+
correctParams := fillDefaultParams(url.Values{})
37+
correctParams.Set("Command", "namecheap.ssl.getList")
38+
testBody(t, r, correctParams)
39+
testMethod(t, r, "POST")
40+
fmt.Fprint(w, respXML)
41+
})
42+
43+
certificates, err := client.SslGetList()
44+
45+
if err != nil {
46+
t.Errorf("SslGetList returned error: %v", err)
47+
}
48+
49+
// DomainGetListResult we expect, given the respXML above
50+
want := []SslGetListResult{{
51+
CertificateID: 52556,
52+
HostName: "domainxy.com",
53+
SSLType: "SSLCertificate3",
54+
PurchaseDate: "10/17/2006",
55+
ExpireDate: "10/17/2008",
56+
ActivationExpireDate: "12/31/2009",
57+
IsExpired: false,
58+
Status: "new",
59+
}}
60+
61+
if !reflect.DeepEqual(certificates, want) {
62+
t.Errorf("SslGetList returned %+v, want %+v", certificates, want)
63+
}
64+
}
65+
66+
func TestSslCreate(t *testing.T) {
67+
setup()
68+
defer teardown()
69+
70+
respXML := `
71+
<?xml version="1.0" encoding="UTF-8"?>
72+
<ApiResponse Status="OK" xmlns="http://api.namecheap.com/xml.response">
73+
<Errors/>
74+
<Warnings/>
75+
<RequestedCommand>namecheap.ssl.create</RequestedCommand>
76+
<CommandResponse Type="namecheap.ssl.create">
77+
<SSLCreateResult IsSuccess="true" OrderId="1234567" TransactionId="1234567" ChargedAmount="908.1600">
78+
<SSLCertificate CertificateID="123456" Created="02/20/2018" SSLType="PositiveSSL" Years="2" Status="NewPurchase"/>
79+
</SSLCreateResult>
80+
</CommandResponse>
81+
<Server>202005e9484c</Server>
82+
<GMTTimeDifference>--5:00</GMTTimeDifference>
83+
<ExecutionTime>2.608</ExecutionTime>
84+
</ApiResponse>`
85+
86+
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
87+
correctParams := fillDefaultParams(url.Values{})
88+
correctParams.Set("Command", "namecheap.ssl.create")
89+
correctParams.Set("Type", "PositiveSSL")
90+
correctParams.Set("Years", "2")
91+
testBody(t, r, correctParams)
92+
testMethod(t, r, "POST")
93+
fmt.Fprint(w, respXML)
94+
})
95+
96+
certificates, err := client.SslCreate("PositiveSSL", 2)
97+
98+
if err != nil {
99+
t.Errorf("SslCreate returned error: %v", err)
100+
}
101+
102+
// SslCreateResult we expect, given the respXML above
103+
want := &SslCreateResult{
104+
IsSuccess: true,
105+
OrderId: 1234567,
106+
TransactionId: 1234567,
107+
ChargedAmount: 908.1600,
108+
SSLCertificate: []SSLCertificate{{
109+
CertificateID: 123456,
110+
SSLType: "PositiveSSL",
111+
Created: "02/20/2018",
112+
Years: 2,
113+
Status: "NewPurchase",
114+
}},
115+
}
116+
117+
if !reflect.DeepEqual(certificates, want) {
118+
t.Errorf("SslCreate returned %+v, want %+v", certificates, want)
119+
}
120+
}
121+
122+
func TestSslActivateHttpDCValidation(t *testing.T) {
123+
setup()
124+
defer teardown()
125+
126+
respXML := `
127+
<?xml version="1.0" encoding="UTF-8"?>
128+
<ApiResponse Status="OK" xmlns="http://api.namecheap.com/xml.response">
129+
<Errors/>
130+
<Warnings/>
131+
<RequestedCommand>namecheap.ssl.activate</RequestedCommand>
132+
<CommandResponse Type="namecheap.ssl.activate">
133+
<SSLActivateResult ID="953413" IsSuccess="true">
134+
<HttpDCValidation ValueAvailable="true">
135+
<DNS domain="test.example.org">
136+
<FileName><![CDATA[4E3324A380B58813D5A2F32AA13A96F0.txt]]></FileName>
137+
<FileContent><![CDATA[6694010FAC8ED8F806F1EAD56A1A0478DE6620A256BB8C356A8DD2146B00E884 comodoca.com 5a955211b1f8c]]></FileContent>
138+
</DNS>
139+
</HttpDCValidation>
140+
</SSLActivateResult>
141+
</CommandResponse>
142+
<Server>5eda89c931f6</Server>
143+
<GMTTimeDifference>--5:00</GMTTimeDifference>
144+
<ExecutionTime>2.227</ExecutionTime>
145+
</ApiResponse>`
146+
147+
csrContent := `-----BEGIN CERTIFICATE REQUEST-----
148+
MIICyjCCAbICAQAwgYQxCzAJBgNVBAYTAkRFMQkwBwYDVQQIEwAxETAPBgNVBAcT
149+
CGlyZ2VuZHdvMQ8wDQYDVQQKEwZNQVggQUcxCTAHBgNVBAsTADEZMBcGA1UEAxMQ
150+
dGVzdC5leGFtcGxlLm9yZzEgMB4GCSqGSIb3DQEJARYRYWRtaW5AZXhhbXBsZS5v
151+
cmcwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDsYAf6QorCNP4+bbyX
152+
RoVHcx5zq37Qc7SzRH3Jus9i/zjINT+2Yq0rAKgyiJ2Z1duBl3fNoDS64KRNB15a
153+
v/d1aH5XBk3motdVxuPcX3/3a6yEepfew6eb2gWI/1J0v9OC3bPzNQB+EEXs0P4E
154+
wKhdG3+Qxp2XV8EHvdoh0da+kE9mvxlTyqSnkI/03Awu/iHJq7UChNgG3ElmM3qV
155+
ybqItYnzvi1iZ/gU0l5RrCkj3/uCc8ODnrMM6QeTM3FbVKtEF3b6O+iTRn4uz0LJ
156+
dKODzxSok9fUD8/FKSzHKwAxo4gmYpR1yIvbuHRPhekoP+bdelhySn5JeZnR1iEb
157+
dfNBAgMBAAGgADANBgkqhkiG9w0BAQsFAAOCAQEA6Xei1GBkTxqBqzu6QDft9d48
158+
J5ID4TU3U2piLJVkbjUDBPpkk5TRZWkUG/0PKZopd0c5ujzBJCx37ipsyU+T9g5i
159+
BEcoEzCPE+zlg9nTsMpNZVR17sBoM2xNkyHdytormrCYrAtu/E43Fymg8Fp8ygqQ
160+
/UvEww4vnadnLxNYitb7HeaG0QN+XlP3vt3uXW2HxZL9fpsQV93TQXZ5w5+B3mg4
161+
nnS+Y+N/O3nd4fcsQlIt7//mb5Ikd+txuAUYJRdm7bQMn1MN/Jef4slw4tP0KZA1
162+
v5DDv8p49Ae+08d0TTFRViMBI6sTHJ+AqF5vep0R4GWOsbdUjG/wiJhpyMLOGQ==
163+
-----END CERTIFICATE REQUEST-----`
164+
165+
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
166+
correctParams := fillDefaultParams(url.Values{})
167+
correctParams.Set("Command", "namecheap.ssl.activate")
168+
correctParams.Set("CertificateID", "953413")
169+
correctParams.Set("CSR", csrContent)
170+
correctParams.Set("AdminEmailAddress", "admin@example.org")
171+
correctParams.Set("WebServerType", "nginx")
172+
correctParams.Set("HTTPDCValidation", "true")
173+
testBody(t, r, correctParams)
174+
testMethod(t, r, "POST")
175+
fmt.Fprint(w, respXML)
176+
})
177+
178+
sslActivateparams := SslActivateParams{
179+
CertificateId: 953413,
180+
Csr: csrContent,
181+
AdminEmailAddress: "admin@example.org",
182+
WebServerType: "nginx",
183+
IsHTTPDCValidation: true,
184+
}
185+
186+
certificates, err := client.SslActivate(sslActivateparams)
187+
188+
if err != nil {
189+
t.Errorf("SslActivate returned error: %v", err)
190+
}
191+
192+
// SslActivateResult we expect, given the respXML above
193+
want := &SslActivateResult{
194+
ID: 953413,
195+
IsSuccess: true,
196+
HttpDCValidation: SslDcValidation{
197+
ValueAvailable: true,
198+
Dns: SslDns{
199+
Domain: "test.example.org",
200+
FileName: "4E3324A380B58813D5A2F32AA13A96F0.txt",
201+
FileContent: "6694010FAC8ED8F806F1EAD56A1A0478DE6620A256BB8C356A8DD2146B00E884 comodoca.com 5a955211b1f8c",
202+
},
203+
},
204+
}
205+
206+
if !reflect.DeepEqual(certificates, want) {
207+
t.Errorf("SslActivate returned %+v, want %+v", certificates, want)
208+
}
209+
}
210+
211+
func TestSslActivateDNSDCValidation(t *testing.T) {
212+
setup()
213+
defer teardown()
214+
215+
respXML := `
216+
<?xml version="1.0" encoding="UTF-8"?>
217+
<ApiResponse Status="OK" xmlns="http://api.namecheap.com/xml.response">
218+
<Errors/>
219+
<Warnings/>
220+
<RequestedCommand>namecheap.ssl.activate</RequestedCommand>
221+
<CommandResponse Type="namecheap.ssl.activate">
222+
<SSLActivateResult ID="953413" IsSuccess="true">
223+
<DNSDCValidation ValueAvailable="true">
224+
<DNS domain="test.example.org">
225+
<HostName><![CDATA[_4E3324A380B58813D5A2F32AA13A96F0.test.example.org]]></HostName>
226+
<Target><![CDATA[6694010FAC8ED8F806F1EAD56A1A0478.DE6620A256BB8C356A8DD2146B00E884.5a955211b1f8c.comodoca.com]]></Target>
227+
</DNS>
228+
</DNSDCValidation>
229+
</SSLActivateResult>
230+
</CommandResponse>
231+
<Server>5eda89c931f6</Server>
232+
<GMTTimeDifference>--5:00</GMTTimeDifference>
233+
<ExecutionTime>2.227</ExecutionTime>
234+
</ApiResponse>`
235+
236+
csrContent := `-----BEGIN CERTIFICATE REQUEST-----
237+
MIICyjCCAbICAQAwgYQxCzAJBgNVBAYTAkRFMQkwBwYDVQQIEwAxETAPBgNVBAcT
238+
CGlyZ2VuZHdvMQ8wDQYDVQQKEwZNQVggQUcxCTAHBgNVBAsTADEZMBcGA1UEAxMQ
239+
dGVzdC5leGFtcGxlLm9yZzEgMB4GCSqGSIb3DQEJARYRYWRtaW5AZXhhbXBsZS5v
240+
cmcwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDsYAf6QorCNP4+bbyX
241+
RoVHcx5zq37Qc7SzRH3Jus9i/zjINT+2Yq0rAKgyiJ2Z1duBl3fNoDS64KRNB15a
242+
v/d1aH5XBk3motdVxuPcX3/3a6yEepfew6eb2gWI/1J0v9OC3bPzNQB+EEXs0P4E
243+
wKhdG3+Qxp2XV8EHvdoh0da+kE9mvxlTyqSnkI/03Awu/iHJq7UChNgG3ElmM3qV
244+
ybqItYnzvi1iZ/gU0l5RrCkj3/uCc8ODnrMM6QeTM3FbVKtEF3b6O+iTRn4uz0LJ
245+
dKODzxSok9fUD8/FKSzHKwAxo4gmYpR1yIvbuHRPhekoP+bdelhySn5JeZnR1iEb
246+
dfNBAgMBAAGgADANBgkqhkiG9w0BAQsFAAOCAQEA6Xei1GBkTxqBqzu6QDft9d48
247+
J5ID4TU3U2piLJVkbjUDBPpkk5TRZWkUG/0PKZopd0c5ujzBJCx37ipsyU+T9g5i
248+
BEcoEzCPE+zlg9nTsMpNZVR17sBoM2xNkyHdytormrCYrAtu/E43Fymg8Fp8ygqQ
249+
/UvEww4vnadnLxNYitb7HeaG0QN+XlP3vt3uXW2HxZL9fpsQV93TQXZ5w5+B3mg4
250+
nnS+Y+N/O3nd4fcsQlIt7//mb5Ikd+txuAUYJRdm7bQMn1MN/Jef4slw4tP0KZA1
251+
v5DDv8p49Ae+08d0TTFRViMBI6sTHJ+AqF5vep0R4GWOsbdUjG/wiJhpyMLOGQ==
252+
-----END CERTIFICATE REQUEST-----`
253+
254+
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
255+
correctParams := fillDefaultParams(url.Values{})
256+
correctParams.Set("Command", "namecheap.ssl.activate")
257+
correctParams.Set("CertificateID", "953413")
258+
correctParams.Set("CSR", csrContent)
259+
correctParams.Set("AdminEmailAddress", "admin@example.org")
260+
correctParams.Set("WebServerType", "nginx")
261+
correctParams.Set("DNSDCValidation", "true")
262+
testBody(t, r, correctParams)
263+
testMethod(t, r, "POST")
264+
fmt.Fprint(w, respXML)
265+
})
266+
267+
sslActivateparams := SslActivateParams{
268+
CertificateId: 953413,
269+
Csr: csrContent,
270+
AdminEmailAddress: "admin@example.org",
271+
WebServerType: "nginx",
272+
IsDNSDCValidation: true,
273+
}
274+
275+
certificates, err := client.SslActivate(sslActivateparams)
276+
277+
if err != nil {
278+
t.Errorf("SslActivate returned error: %v", err)
279+
}
280+
281+
// SslActivateResult we expect, given the respXML above
282+
want := &SslActivateResult{
283+
ID: 953413,
284+
IsSuccess: true,
285+
DNSDCValidation: SslDcValidation{
286+
ValueAvailable: true,
287+
Dns: SslDns{
288+
Domain: "test.example.org",
289+
HostName: "_4E3324A380B58813D5A2F32AA13A96F0.test.example.org",
290+
Target: "6694010FAC8ED8F806F1EAD56A1A0478.DE6620A256BB8C356A8DD2146B00E884.5a955211b1f8c.comodoca.com",
291+
},
292+
},
293+
}
294+
295+
if !reflect.DeepEqual(certificates, want) {
296+
t.Errorf("SslActivate returned %+v, want %+v", certificates, want)
297+
}
298+
}

0 commit comments

Comments
 (0)
Please sign in to comment.