acme.sh/dnsapi/README.md

263 lines
6.7 KiB
Markdown
Raw Normal View History

2016-11-15 13:24:07 +00:00
# How to use DNS API
2016-02-07 10:29:28 +00:00
2016-11-15 13:24:07 +00:00
## 1. Use CloudFlare domain API to automatically issue cert
2016-02-07 10:29:28 +00:00
2016-11-15 13:24:07 +00:00
First you need to login to your CloudFlare account to get your API key.
2016-02-07 10:29:28 +00:00
```
export CF_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
export CF_Email="xxxx@sss.com"
```
2016-11-15 13:24:07 +00:00
Ok, let's issue a cert now:
2016-02-07 10:29:28 +00:00
```
2016-11-15 13:24:07 +00:00
acme.sh --issue --dns dns_cf -d example.com -d www.example.com
2016-02-07 10:29:28 +00:00
```
2016-11-15 13:24:07 +00:00
The `CF_Key` and `CF_Email` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
2016-02-07 10:29:28 +00:00
2016-11-15 13:24:07 +00:00
## 2. Use DNSPod.cn domain API to automatically issue cert
2016-02-07 10:29:28 +00:00
2016-11-15 13:24:07 +00:00
First you need to login to your DNSPod account to get your API Key and ID.
2016-02-07 10:29:28 +00:00
```
export DP_Id="1234"
export DP_Key="sADDsdasdgdsf"
```
2016-11-15 13:24:07 +00:00
Ok, let's issue a cert now:
2016-02-07 10:29:28 +00:00
```
2016-11-15 13:24:07 +00:00
acme.sh --issue --dns dns_dp -d example.com -d www.example.com
2016-02-07 10:29:28 +00:00
```
2016-11-15 13:24:07 +00:00
The `DP_Id` and `DP_Key` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
2016-02-07 10:29:28 +00:00
2016-11-15 13:24:07 +00:00
## 3. Use CloudXNS.com domain API to automatically issue cert
2016-02-07 10:29:28 +00:00
2016-11-15 13:24:07 +00:00
First you need to login to your CloudXNS account to get your API Key and Secret.
2016-02-07 10:29:28 +00:00
```
export CX_Key="1234"
2016-02-07 12:14:53 +00:00
export CX_Secret="sADDsdasdgdsf"
2016-02-07 10:29:28 +00:00
```
2016-11-15 13:24:07 +00:00
Ok, let's issue a cert now:
2016-02-07 10:29:28 +00:00
```
2016-11-15 13:24:07 +00:00
acme.sh --issue --dns dns_cx -d example.com -d www.example.com
2016-02-07 10:29:28 +00:00
```
2016-11-15 13:24:07 +00:00
The `CX_Key` and `CX_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
2016-02-07 10:29:28 +00:00
2016-11-15 13:24:07 +00:00
## 4. Use GoDaddy.com domain API to automatically issue cert
2016-07-29 10:07:16 +00:00
2016-11-15 13:24:07 +00:00
First you need to login to your GoDaddy account to get your API Key and Secret.
2016-07-29 10:07:16 +00:00
https://developer.godaddy.com/keys/
2016-11-15 13:24:07 +00:00
Please create a Production key, instead of a Test key.
2016-07-29 10:07:16 +00:00
```
export GD_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
export GD_Secret="asdfsdafdsfdsfdsfdsfdsafd"
```
2016-11-15 13:24:07 +00:00
Ok, let's issue a cert now:
2016-07-29 10:07:16 +00:00
```
2016-11-15 13:24:07 +00:00
acme.sh --issue --dns dns_gd -d example.com -d www.example.com
2016-07-29 10:07:16 +00:00
```
2016-11-15 13:24:07 +00:00
The `GD_Key` and `GD_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
2016-07-29 10:07:16 +00:00
2016-11-15 13:24:07 +00:00
## 5. Use PowerDNS embedded API to automatically issue cert
2016-11-15 13:24:07 +00:00
First you need to login to your PowerDNS account to enable the API and set your API-Token in the configuration.
https://doc.powerdns.com/md/httpapi/README/
```
export PDNS_Url="http://ns.example.com:8081"
export PDNS_ServerId="localhost"
export PDNS_Token="0123456789ABCDEF"
export PDNS_Ttl=60
```
2016-11-15 13:24:07 +00:00
Ok, let's issue a cert now:
```
2016-11-15 13:24:07 +00:00
acme.sh --issue --dns dns_pdns -d example.com -d www.example.com
```
2016-11-15 13:24:07 +00:00
The `PDNS_Url`, `PDNS_ServerId`, `PDNS_Token` and `PDNS_Ttl` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
2016-11-14 14:56:07 +00:00
2016-11-15 13:24:07 +00:00
## 6. Use OVH/kimsufi/soyoustart/runabove API to automatically issue cert
2016-07-29 10:07:16 +00:00
2016-08-25 03:03:25 +00:00
https://github.com/Neilpang/acme.sh/wiki/How-to-use-OVH-domain-api
2016-02-07 10:29:28 +00:00
2016-11-15 13:24:07 +00:00
2016-11-15 09:28:15 +00:00
## 7. Use nsupdate to automatically issue cert
2016-11-14 14:56:07 +00:00
First, generate a key for updating the zone
```
b=$(dnssec-keygen -a hmac-sha512 -b 512 -n USER -K /tmp foo)
cat > /etc/named/keys/update.key <<EOF
key "update" {
algorithm hmac-sha512;
secret "$(awk '/^Key/{print $2}' /tmp/$b.private)";
};
EOF
rm -f /tmp/$b.{private,key}
```
Include this key in your named configuration
```
include "/etc/named/keys/update.key";
```
Next, configure your zone to allow dynamic updates.
2016-11-15 13:24:07 +00:00
2016-11-14 14:56:07 +00:00
Depending on your named version, use either
```
zone "example.com" {
type master;
allow-update { key "update"; };
};
```
or
```
zone "example.com" {
type master;
update-policy {
grant update subdomain example.com.;
};
}
```
2016-11-15 13:24:07 +00:00
Finally, make the DNS server and update Key available to `acme.sh`
2016-11-14 14:56:07 +00:00
```
2016-11-15 13:24:07 +00:00
export NSUPDATE_SERVER="dns.example.com"
export NSUPDATE_KEY="aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa=="
2016-11-14 14:56:07 +00:00
```
2016-11-15 13:24:07 +00:00
Ok, let's issue a cert now:
2016-11-14 14:56:07 +00:00
```
2016-11-15 13:24:07 +00:00
acme.sh --issue --dns dns_nsupdate -d example.com -d www.example.com
2016-11-14 14:56:07 +00:00
```
2016-11-15 13:24:07 +00:00
The `NSUPDATE_SERVER` and `NSUPDATE_KEY` settings will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
2016-11-14 14:56:07 +00:00
2016-11-15 09:28:15 +00:00
## 8. Use LuaDNS domain API
2016-11-06 15:52:43 +00:00
Get your API token at https://api.luadns.com/settings
```
export LUA_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
export LUA_Email="xxxx@sss.com"
```
To issue a cert:
```
2016-11-15 13:24:07 +00:00
acme.sh --issue --dns dns_lua -d example.com -d www.example.com
2016-11-06 15:52:43 +00:00
```
2016-11-15 13:24:07 +00:00
The `LUA_Key` and `LUA_Email` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
2016-11-06 15:52:43 +00:00
2016-11-15 09:28:15 +00:00
## 9. Use DNSMadeEasy domain API
2016-11-07 20:50:59 +00:00
Get your API credentials at https://cp.dnsmadeeasy.com/account/info
```
export ME_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
export ME_Secret="qdfqsdfkjdskfj"
```
To issue a cert:
```
2016-11-15 13:24:07 +00:00
acme.sh --issue --dns dns_me -d example.com -d www.example.com
2016-11-07 20:50:59 +00:00
```
2016-11-15 13:24:07 +00:00
The `ME_Key` and `ME_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
2016-11-07 20:50:59 +00:00
2016-11-20 15:21:07 +00:00
## 10. Use Amazon Route53 domain API
https://github.com/Neilpang/acme.sh/wiki/How-to-use-Amazon-Route53-API
```
export AWS_ACCESS_KEY_ID=XXXXXXXXXX
export AWS_SECRET_ACCESS_KEY=XXXXXXXXXXXXXXX
```
To issue a cert:
```
acme.sh --issue --dns dns_aws -d example.com -d www.example.com
```
The `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
## 11. Use Aliyun domain API to automatically issue cert
First you need to login to your Aliyun account to get your API key.
[https://ak-console.aliyun.com/#/accesskey](https://ak-console.aliyun.com/#/accesskey)
```
export Ali_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
export Ali_Secret="jlsdflanljkljlfdsaklkjflsa"
```
Ok, let's issue a cert now:
```
acme.sh --issue --dns dns_ali -d example.com -d www.example.com
```
The `Ali_Key` and `Ali_Secret` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
2016-11-24 15:00:32 +00:00
## 12. Use ISPConfig 3.1 API
This only works for ISPConfig 3.1 (and newer).
Create a Remote User in the ISPConfig Control Panel. The Remote User must have access to at least `DNS zone functions` and `DNS txt functions`.
```
export ISPC_User="xxx"
export ISPC_Password="xxx"
export ISPC_Api="https://ispc.domain.tld:8080/remote/json.php"
export ISPC_Api_Insecure=1
```
If you have installed ISPConfig on a different port, then alter the 8080 accordingly.
Leaver ISPC_Api_Insecure set to 1 if you have not a valid ssl cert for your installation. Change it to 0 if you have a valid ssl cert.
To issue a cert:
```
acme.sh --issue --dns dns_ispconfig -d example.com -d www.example.com
```
The `ISPC_User`, `ISPC_Password`, `ISPC_Api`and `ISPC_Api_Insecure` will be saved in `~/.acme.sh/account.conf` and will be reused when needed.
# 13. Use custom API
2016-11-15 09:28:15 +00:00
2016-11-15 13:24:07 +00:00
If your API is not supported yet, you can write your own DNS API.
2016-11-15 09:28:15 +00:00
2016-11-15 13:24:07 +00:00
Let's assume you want to name it 'myapi':
2016-11-15 09:28:15 +00:00
2016-11-15 13:24:07 +00:00
1. Create a bash script named `~/.acme.sh/dns_myapi.sh`,
2. In the script you must have a function named `dns_myapi_add()` which will be called by acme.sh to add the DNS records.
3. Then you can use your API to issue cert like this:
2016-11-15 09:28:15 +00:00
```
2016-11-15 13:24:07 +00:00
acme.sh --issue --dns dns_myapi -d example.com -d www.example.com
2016-11-15 09:28:15 +00:00
```
For more details, please check our sample script: [dns_myapi.sh](dns_myapi.sh)
2016-11-07 20:50:59 +00:00
2016-11-24 15:00:32 +00:00
## 14. Use lexicon DNS API
2016-02-07 10:29:28 +00:00
2016-11-15 13:24:07 +00:00
https://github.com/Neilpang/acme.sh/wiki/How-to-use-lexicon-dns-api