blob: 66b7f1c04aebf63fd0fc6a9c66b314f8426d2f2a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
# Namecheap CLI
A CLI to list/add/remove/update DNS records for a
Namecheap managed domain using only standard Go libraries.
[](https://gitlab.com/kdam0/nccli/-/blob/main/out.gif)
## Why
At the time of writing, there is no simple way to "add"
DNS records to my Namecheap domain from the CLI,
since strictly "adding" is not supported.
Instead, we have to first get all the current records and include
the new one as part of the
[setHosts](https://www.namecheap.com/support/api/methods/domains-dns/set-hosts/)
method. This would involve a bunch of XML parsing which is beyond my bash-fu.
## Pre-Requisites
You must setup an API Access Key, and whitelist your access IP.
Follow instructions for
[Enabling API Access](https://www.namecheap.com/support/api/intro/).
## Usage
Available sub-commands:
* `list`: show all DNS records currently configured.
* `add`: add a DNS record.
* `update`: update an existing DNS record.
* `remove`: remove existing DNS record(s).
You will be prompted for which record(s) you want to remove.
### Non-Docker
1. Build:
```bash
go build nccli.go
```
2. Create `nccli.env` file with content:
```bash
API_USER="[ your namecheap user ]"
API_KEY="[ your namecheap api access key ]"
ACCESS_IP="[ your namecheap api whitelisted IP ]"
```
3. Run:
```bash
DOMAIN=[ your namecheap domain (eg. foo.xyz) ] ./run.sh list
# OR
source nccli.env
DOMAIN=[ your namecheap domain (eg. foo.xyz) ] ./nccli list
```
### Docker
```bash
docker run --rm -it --name nctest \
-e API_USER="[ your namecheap user ]" \
-e API_KEY="[ your namecheap api access key ]" \
-e ACCESS_IP="[ your namecheap api whitelisted IP ]" \
-e DOMAIN="[ your namecheap domain (eg. foo.xyz) ]" \
registry.gitlab.com/kdam0/nccli:[your architecture] \
/bin/nccli list
```
Example Outputs:
```bash
Usage of add:
-name string
Name of DNS record.
-priority int
Value of the DNS record.
-ttl int
TTL of the DNS record. (default 1800)
-type string
Type of DNS record.
-v Verbosity. More output. Default=false.
-value string
Value of the DNS record.
```
Images are available for the following architectures:
* linux/amd64
* linux/arm32v7
## How to use it to automate Certbot DNS verification
Certbot does not have a DNS plugin for Namecheap, so we rely on its
`--manual-auth-hook` flag to run a script to place DNS records
it generates into our Namecheap domain so that it can complete DNS verification.
[Docs](https://eff-certbot.readthedocs.io/en/stable/using.html#pre-and-post-validation-hooks).
Eg. `certbot` cmd:
```bash
certbot \
certonly -n --agree-tos --email [your email] \
--config-dir [default: /etc/letsencrypt] \
--work-dir [default: /etc/letsencrypt] \
--logs-dir /tmp/letsencrypt \
--server https://acme-v02.api.letsencrypt.org/directory \
--manual --preferred-challenges=dns \
--manual-auth-hook /path/to/auth.sh \
-d '*.wildcard.domain'
```
where `auth.sh` is:
```bash
#!/bin/bash
API_USER="[ your namecheap user ]"
API_KEY="[ your namecheap api access key ]"
API_ACCESS_IP="[ your namecheap api whitelisted IP ]"
DOMAIN="[ your namecheap domain (eg. foo.xyz) ]"
echo "CERTBOT DOMAIN: ${CERTBOT_DOMAIN}"
echo "CERTBOT VALUE: ${CERTBOT_VALIDATION}"
# Create TXT record
docker run --rm -it \
--name nctest \
-e API_USER="${API_USER}" \
-e API_KEY="${API_KEY}" \
-e ACCESS_IP="${API_ACCESS_IP}" \
-e DOMAIN="${DOMAIN}" \
registry.gitlab.com/kdam0/nccli \
/bin/nccli \
add \
-name "_acme-challenge" \
-value "${CERTBOT_VALIDATION}" \
-type "TXT" \
-priority 11 \
-ttl 60
# Save info for cleanup
if [ ! -d /tmp/CERTBOT_$CERTBOT_DOMAIN ];then
mkdir -m 0700 /tmp/CERTBOT_$CERTBOT_DOMAIN
fi
# Sleep to make sure the change has time to propagate over to DNS
sleep 45
```
After the `certbot` cmd, we can run `nccli delete` command to remove the
temporary entries added.
|
