2020-10-04 17:56:02 -04:00
/ * *
* This file contains info about available Certbot DNS plugins .
2020-10-06 08:49:02 -04:00
* This only works for plugins which use the standard argument structure , so :
* -- authenticator < plugin - name > -- < plugin - name > - credentials < FILE > -- < plugin - name > - propagation - seconds < number >
2020-10-04 17:56:02 -04:00
*
* File Structure :
*
* {
* cloudflare : {
* display _name : "Name displayed to the user" ,
* package _name : "Package name in PyPi repo" ,
* package _version : "Package version in PyPi repo" ,
2020-11-03 15:28:50 -05:00
* dependencies : "Additional dependencies, space separated (as you would pass it to pip install)" ,
2020-10-04 17:56:02 -04:00
* credentials : ` Template of the credentials file ` ,
* full _plugin _name : "The full plugin name as used in the commandline with certbot, including prefixes, e.g. 'certbot-dns-njalla:dns-njalla'" ,
* } ,
* ...
* }
*
* /
module . exports = {
2021-05-09 15:36:52 -04:00
//####################################################//
acmedns : {
display _name : 'ACME-DNS' ,
package _name : 'certbot-dns-acmedns' ,
package _version : '0.1.0' ,
dependencies : '' ,
credentials : ` certbot_dns_acmedns:dns_acmedns_api_url = http://acmedns-server/
certbot _dns _acmedns : dns _acmedns _registration _file = / d a t a / a c m e - r e g i s t r a t i o n . j s o n ` ,
full _plugin _name : 'certbot-dns-acmedns:dns-acmedns' ,
} ,
2020-11-22 03:08:56 -05:00
aliyun : {
display _name : 'Aliyun' ,
package _name : 'certbot-dns-aliyun' ,
package _version : '0.38.1' ,
dependencies : '' ,
credentials : ` certbot_dns_aliyun:dns_aliyun_access_key = 12345678
certbot _dns _aliyun : dns _aliyun _access _key _secret = 1234567890 abcdef1234567890abcdef ` ,
full _plugin _name : 'certbot-dns-aliyun:dns-aliyun' ,
} ,
//####################################################//
2021-05-19 15:03:07 -04:00
azure : {
display _name : 'Azure' ,
package _name : 'certbot-dns-azure' ,
package _version : '1.2.0' ,
dependencies : '' ,
credentials : ` # This plugin supported API authentication using either Service Principals or utilizing a Managed Identity assigned to the virtual machine.
# Regardless which authentication method used , the identity will need the “ DNS Zone Contributor ” role assigned to it .
# As multiple Azure DNS Zones in multiple resource groups can exist , the config file needs a mapping of zone to resource group ID . Multiple zones - > ID mappings can be listed by using the key dns _azure _zoneX where X is a unique number . At least 1 zone mapping is required .
2021-05-09 13:46:20 -04:00
2021-05-19 15:03:07 -04:00
# Using a service principal ( option 1 )
dns _azure _sp _client _id = 912 ce44a - 0156 - 4669 - ae22 - c16a17d34ca5
dns _azure _sp _client _secret = E - xqXU83Y - jzTI6xe9fs2YC ~ mck3ZzUih9
dns _azure _tenant _id = ed1090f3 - ab18 - 4 b12 - 816 c - 599 af8a88cf7
2021-05-09 13:46:20 -04:00
2021-05-19 15:03:07 -04:00
# Using used assigned MSI ( option 2 )
# dns _azure _msi _client _id = 912 ce44a - 0156 - 4669 - ae22 - c16a17d34ca5
2021-05-09 13:46:20 -04:00
2021-05-19 15:03:07 -04:00
# Using system assigned MSI ( option 3 )
# dns _azure _msi _system _assigned = true
2021-05-09 13:46:20 -04:00
2021-05-19 15:03:07 -04:00
# Zones ( at least one always required )
dns _azure _zone1 = example . com : / s u b s c r i p t i o n s / c 1 3 5 a b c e - d 8 7 d - 4 8 d f - 9 3 6 c - 1 5 5 9 6 c 6 9 6 8 a 5 / r e s o u r c e G r o u p s / d n s 1
dns _azure _zone2 = example . org : / s u b s c r i p t i o n s / 9 9 8 0 0 9 0 3 - f b 1 4 - 4 9 9 2 - 9 a f f - 1 2 e a f 2 7 4 4 6 2 2 / r e s o u r c e G r o u p s / d n s 2 ` ,
full _plugin _name : 'dns-azure' ,
} ,
2021-05-09 13:46:20 -04:00
//####################################################//
2020-10-14 20:33:51 -04:00
cloudflare : {
2020-11-03 16:38:09 -05:00
display _name : 'Cloudflare' ,
package _name : 'certbot-dns-cloudflare' ,
package _version : '1.8.0' ,
dependencies : 'cloudflare' ,
credentials : ` # Cloudflare API token
2020-10-04 17:56:02 -04:00
dns _cloudflare _api _token = 0123456789 abcdef0123456789abcdef01234567 ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'dns-cloudflare' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
2021-05-09 15:47:30 -04:00
cloudns : {
display _name : 'ClouDNS' ,
package _name : 'certbot-dns-cloudns' ,
package _version : '0.4.0' ,
dependencies : '' ,
credentials : ` # Target user ID (see https://www.cloudns.net/api-settings/)
dns _cloudns _auth _id = 1234
# Alternatively , one of the following two options can be set :
# dns _cloudns _sub _auth _id = 1234
# dns _cloudns _sub _auth _user = foobar
# API password
dns _cloudns _auth _password = password1 ` ,
full _plugin _name : 'dns-cloudns' ,
} ,
//####################################################//
2020-10-14 20:33:51 -04:00
cloudxns : {
2020-11-03 16:38:09 -05:00
display _name : 'CloudXNS' ,
package _name : 'certbot-dns-cloudxns' ,
package _version : '1.8.0' ,
dependencies : '' ,
credentials : ` dns_cloudxns_api_key = 1234567890abcdef1234567890abcdef
2020-10-04 17:56:02 -04:00
dns _cloudxns _secret _key = 1122334455667788 ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'dns-cloudxns' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
corenetworks : {
2020-11-03 16:38:09 -05:00
display _name : 'Core Networks' ,
package _name : 'certbot-dns-corenetworks' ,
package _version : '0.1.4' ,
dependencies : '' ,
credentials : ` certbot_dns_corenetworks:dns_corenetworks_username = asaHB12r
2020-10-06 09:16:45 -04:00
certbot _dns _corenetworks : dns _corenetworks _password = secure _password ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'certbot-dns-corenetworks:dns-corenetworks' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
cpanel : {
2020-11-03 16:38:09 -05:00
display _name : 'cPanel' ,
package _name : 'certbot-dns-cpanel' ,
package _version : '0.2.2' ,
dependencies : '' ,
credentials : ` certbot_dns_cpanel:cpanel_url = https://cpanel.example.com:2083
2020-10-06 09:16:45 -04:00
certbot _dns _cpanel : cpanel _username = user
certbot _dns _cpanel : cpanel _password = hunter2 ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'certbot-dns-cpanel:cpanel' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
2021-05-09 15:36:52 -04:00
duckdns : {
display _name : 'DuckDNS' ,
package _name : 'certbot-dns-duckdns' ,
2021-05-15 12:35:49 -04:00
package _version : '0.6' ,
2021-05-09 15:36:52 -04:00
dependencies : '' ,
2021-05-15 12:35:49 -04:00
credentials : 'dns_duckdns_token=your-duckdns-token' ,
2021-05-09 15:36:52 -04:00
full _plugin _name : 'dns-duckdns' ,
} ,
//####################################################//
2020-10-14 20:33:51 -04:00
digitalocean : {
2020-11-03 16:38:09 -05:00
display _name : 'DigitalOcean' ,
package _name : 'certbot-dns-digitalocean' ,
package _version : '1.8.0' ,
dependencies : '' ,
credentials : 'dns_digitalocean_token = 0000111122223333444455556666777788889999aaaabbbbccccddddeeeeffff' ,
full _plugin _name : 'dns-digitalocean' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
directadmin : {
2020-11-03 16:38:09 -05:00
display _name : 'DirectAdmin' ,
package _name : 'certbot-dns-directadmin' ,
package _version : '0.0.20' ,
dependencies : '' ,
credentials : ` directadmin_url = https://my.directadminserver.com:2222
2020-10-06 09:16:45 -04:00
directadmin _username = username
directadmin _password = aSuperStrongPassword ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'certbot-dns-directadmin:directadmin' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
dnsimple : {
2020-11-03 16:38:09 -05:00
display _name : 'DNSimple' ,
package _name : 'certbot-dns-dnsimple' ,
package _version : '1.8.0' ,
dependencies : '' ,
credentials : 'dns_dnsimple_token = MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw' ,
full _plugin _name : 'dns-dnsimple' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
dnsmadeeasy : {
2020-11-03 16:38:09 -05:00
display _name : 'DNS Made Easy' ,
package _name : 'certbot-dns-dnsmadeeasy' ,
package _version : '1.8.0' ,
dependencies : '' ,
credentials : ` dns_dnsmadeeasy_api_key = 1c1a3c91-4770-4ce7-96f4-54c0eb0e457a
2020-10-04 17:56:02 -04:00
dns _dnsmadeeasy _secret _key = c9b5625f - 9834 - 4 ff8 - baba - 4 ed5f32cae55 ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'dns-dnsmadeeasy' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
dnspod : {
2020-11-03 16:38:09 -05:00
display _name : 'DNSPod' ,
package _name : 'certbot-dns-dnspod' ,
package _version : '0.1.0' ,
dependencies : '' ,
credentials : ` certbot_dns_dnspod:dns_dnspod_email = "DNSPOD-API-REQUIRES-A-VALID-EMAIL"
2020-10-06 09:16:45 -04:00
certbot _dns _dnspod : dns _dnspod _api _token = "DNSPOD-API-TOKEN" ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'certbot-dns-dnspod:dns-dnspod' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
2021-05-15 12:32:49 -04:00
dynu : {
display _name : 'Dynu' ,
package _name : 'certbot-dns-dynu' ,
package _version : '0.0.1' ,
dependencies : '' ,
credentials : 'certbot_dns_dynu:dns_dynu_auth_token = YOUR_DYNU_AUTH_TOKEN' ,
full _plugin _name : 'certbot-dns-dynu:dns-dynu' ,
} ,
//####################################################//
2021-05-09 15:36:52 -04:00
eurodns : {
display _name : 'EuroDNS' ,
package _name : 'certbot-dns-eurodns' ,
package _version : '0.0.4' ,
dependencies : '' ,
credentials : ` dns_eurodns_applicationId = myuser
dns _eurodns _apiKey = mysecretpassword
dns _eurodns _endpoint = https : //rest-api.eurodns.com/user-api-gateway/proxy`,
full _plugin _name : 'certbot-dns-eurodns:dns-eurodns' ,
} ,
//####################################################//
2021-01-05 12:19:27 -05:00
gandi : {
2021-01-05 12:47:22 -05:00
display _name : 'Gandi Live DNS' ,
package _name : 'certbot_plugin_gandi' ,
package _version : '1.2.5' ,
dependencies : '' ,
credentials : 'certbot_plugin_gandi:dns_api_key = APIKEY' ,
full _plugin _name : 'certbot-plugin-gandi:dns' ,
2021-01-05 11:36:47 -05:00
} ,
//####################################################//
2021-05-12 10:28:09 -04:00
godaddy : {
display _name : 'GoDaddy' ,
package _name : 'certbot-dns-godaddy' ,
package _version : '0.2.0' ,
dependencies : '' ,
credentials : ` dns_godaddy_secret = 0123456789abcdef0123456789abcdef01234567
dns _godaddy _key = abcdef0123456789abcdef01234567abcdef0123 ` ,
full _plugin _name : 'dns-godaddy' ,
} ,
//####################################################//
2020-10-14 20:33:51 -04:00
google : {
2020-11-03 16:38:09 -05:00
display _name : 'Google' ,
package _name : 'certbot-dns-google' ,
package _version : '1.8.0' ,
dependencies : '' ,
credentials : ` {
2020-11-03 16:24:03 -05:00
"type" : "service_account" ,
...
2020-10-04 17:56:02 -04:00
} ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'dns-google' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
hetzner : {
2020-11-03 16:38:09 -05:00
display _name : 'Hetzner' ,
package _name : 'certbot-dns-hetzner' ,
package _version : '1.0.4' ,
dependencies : '' ,
credentials : 'certbot_dns_hetzner:dns_hetzner_api_token = 0123456789abcdef0123456789abcdef' ,
full _plugin _name : 'certbot-dns-hetzner:dns-hetzner' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
inwx : {
2020-11-03 16:38:09 -05:00
display _name : 'INWX' ,
package _name : 'certbot-dns-inwx' ,
package _version : '2.1.2' ,
dependencies : '' ,
credentials : ` certbot_dns_inwx:dns_inwx_url = https://api.domrobot.com/xmlrpc/
2020-10-06 09:16:45 -04:00
certbot _dns _inwx : dns _inwx _username = your _username
certbot _dns _inwx : dns _inwx _password = your _password
certbot _dns _inwx : dns _inwx _shared _secret = your _shared _secret optional ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'certbot-dns-inwx:dns-inwx' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
ispconfig : {
2020-11-03 16:38:09 -05:00
display _name : 'ISPConfig' ,
package _name : 'certbot-dns-ispconfig' ,
package _version : '0.2.0' ,
dependencies : '' ,
credentials : ` certbot_dns_ispconfig:dns_ispconfig_username = myremoteuser
2020-10-06 09:16:45 -04:00
certbot _dns _ispconfig : dns _ispconfig _password = verysecureremoteuserpassword
certbot _dns _ispconfig : dns _ispconfig _endpoint = https : //localhost:8080`,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'certbot-dns-ispconfig:dns-ispconfig' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
isset : {
2020-11-03 16:38:09 -05:00
display _name : 'Isset' ,
package _name : 'certbot-dns-isset' ,
package _version : '0.0.3' ,
dependencies : '' ,
credentials : ` certbot_dns_isset:dns_isset_endpoint="https://customer.isset.net/api"
2020-10-06 09:16:45 -04:00
certbot _dns _isset : dns _isset _token = "<token>" ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'certbot-dns-isset:dns-isset' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
linode : {
2020-11-03 16:38:09 -05:00
display _name : 'Linode' ,
package _name : 'certbot-dns-linode' ,
package _version : '1.8.0' ,
dependencies : '' ,
credentials : ` dns_linode_key = 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ64
2020-10-04 17:56:02 -04:00
dns _linode _version = [ < blank > | 3 | 4 ] ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'dns-linode' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
luadns : {
2020-11-03 16:38:09 -05:00
display _name : 'LuaDNS' ,
package _name : 'certbot-dns-luadns' ,
package _version : '1.8.0' ,
dependencies : '' ,
credentials : ` dns_luadns_email = user@example.com
2020-10-04 17:56:02 -04:00
dns _luadns _token = 0123456789 abcdef0123456789abcdef ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'dns-luadns' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
netcup : {
2020-11-03 16:38:09 -05:00
display _name : 'netcup' ,
package _name : 'certbot-dns-netcup' ,
package _version : '1.0.0' ,
dependencies : '' ,
2021-04-15 03:48:08 -04:00
credentials : ` certbot_dns_netcup:dns_netcup_customer_id = 123456
certbot _dns _netcup : dns _netcup _api _key = 0123456789 abcdef0123456789abcdef01234567
certbot _dns _netcup : dns _netcup _api _password = abcdef0123456789abcdef01234567abcdef0123 ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'certbot-dns-netcup:dns-netcup' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
njalla : {
2020-11-03 16:38:09 -05:00
display _name : 'Njalla' ,
package _name : 'certbot-dns-njalla' ,
package _version : '1.0.0' ,
dependencies : '' ,
credentials : 'certbot_dns_njalla:dns_njalla_token = 0123456789abcdef0123456789abcdef01234567' ,
full _plugin _name : 'certbot-dns-njalla:dns-njalla' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
nsone : {
2020-11-03 16:38:09 -05:00
display _name : 'NS1' ,
package _name : 'certbot-dns-nsone' ,
package _version : '1.8.0' ,
dependencies : '' ,
credentials : 'dns_nsone_api_key = MDAwMDAwMDAwMDAwMDAw' ,
full _plugin _name : 'dns-nsone' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
ovh : {
2020-11-03 16:38:09 -05:00
display _name : 'OVH' ,
package _name : 'certbot-dns-ovh' ,
package _version : '1.8.0' ,
dependencies : '' ,
credentials : ` dns_ovh_endpoint = ovh-eu
2020-10-04 17:56:02 -04:00
dns _ovh _application _key = MDAwMDAwMDAwMDAw
dns _ovh _application _secret = MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw
dns _ovh _consumer _key = MDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAw ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'dns-ovh' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
2021-05-15 12:31:33 -04:00
porkbun : {
display _name : 'Porkbun' ,
2021-05-15 12:35:49 -04:00
package _name : 'certbot-dns-porkbun' ,
2021-05-15 12:31:33 -04:00
package _version : '0.2' ,
dependencies : '' ,
credentials : ` dns_porkbun_key=your-porkbun-api-key
dns _porkbun _secret = your - porkbun - api - secret ` ,
full _plugin _name : 'dns-porkbun' ,
} ,
//####################################################//
2020-10-14 20:33:51 -04:00
powerdns : {
2020-11-03 16:38:09 -05:00
display _name : 'PowerDNS' ,
package _name : 'certbot-dns-powerdns' ,
package _version : '0.2.0' ,
dependencies : '' ,
credentials : ` certbot_dns_powerdns:dns_powerdns_api_url = https://api.mypowerdns.example.org
2020-10-06 09:16:45 -04:00
certbot _dns _powerdns : dns _powerdns _api _key = AbCbASsd ! @ 34 ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'certbot-dns-powerdns:dns-powerdns' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
2021-05-09 13:45:42 -04:00
regru : {
display _name : 'reg.ru' ,
package _name : 'certbot-regru' ,
package _version : '1.0.2' ,
dependencies : '' ,
credentials : ` certbot_regru:dns_username=username
certbot _regru : dns _password = password ` ,
full _plugin _name : 'certbot-regru:dns' ,
} ,
//####################################################//
2020-10-14 20:33:51 -04:00
rfc2136 : {
2020-11-03 16:38:09 -05:00
display _name : 'RFC 2136' ,
package _name : 'certbot-dns-rfc2136' ,
package _version : '1.8.0' ,
dependencies : '' ,
credentials : ` # Target DNS server
2020-10-04 17:56:02 -04:00
dns _rfc2136 _server = 192.0 . 2.1
# Target DNS port
dns _rfc2136 _port = 53
# TSIG key name
dns _rfc2136 _name = keyname .
# TSIG key secret
dns _rfc2136 _secret = 4 q4wM / 2 I180UXoMyN4INVhJNi8V9BCV + jMw2mXgZw / CSuxUT8C7NKKFs AmKd7ak51vWKgSl12ib86oQRPkpDjg ==
# TSIG key algorithm
dns _rfc2136 _algorithm = HMAC - SHA512 ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'dns-rfc2136' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
route53 : {
2020-11-03 16:38:09 -05:00
display _name : 'Route 53 (Amazon)' ,
package _name : 'certbot-dns-route53' ,
package _version : '1.8.0' ,
dependencies : '' ,
credentials : ` [default]
2020-10-14 03:20:52 -04:00
aws _access _key _id = AKIAIOSFODNN7EXAMPLE
aws _secret _access _key = wJalrXUtnFEMI / K7MDENG / bPxRfiCYEXAMPLEKEY ` ,
2020-11-03 16:38:09 -05:00
full _plugin _name : 'dns-route53' ,
2020-10-14 20:33:51 -04:00
} ,
//####################################################//
2021-03-11 07:33:42 -05:00
transip : {
display _name : 'TransIP' ,
package _name : 'certbot-dns-transip' ,
package _version : '0.3.3' ,
dependencies : '' ,
2021-03-11 09:44:20 -05:00
credentials : ` certbot_dns_transip:dns_transip_username = my_username
certbot _dns _transip : dns _transip _key _file = / e t c / l e t s e n c r y p t / t r a n s i p - r s a . k e y ` ,
2021-03-11 07:33:42 -05:00
full _plugin _name : 'certbot-dns-transip:dns-transip' ,
2021-03-16 07:57:26 -04:00
} ,
2021-03-16 05:49:27 -04:00
//####################################################//
2021-05-09 15:36:52 -04:00
vultr : {
display _name : 'Vultr' ,
package _name : 'certbot-dns-vultr' ,
package _version : '1.0.3' ,
2021-04-26 16:31:16 -04:00
dependencies : '' ,
2021-05-09 15:36:52 -04:00
credentials : 'certbot_dns_vultr:dns_vultr_key = YOUR_VULTR_API_KEY' ,
full _plugin _name : 'certbot-dns-vultr:dns-vultr' ,
2021-04-26 14:25:24 -04:00
} ,
2020-11-22 03:08:56 -05:00
} ;
