3 ## Name: dns_pleskxml.sh
5 ## Also uses some code from PR#1832 by @romanlum (https://github.com/acmesh-official/acme.sh/pull/1832/files)
7 ## This DNS-01 method uses the Plesk XML API described at:
8 ## https://docs.plesk.com/en-US/12.5/api-rpc/about-xml-api.28709
9 ## and more specifically: https://docs.plesk.com/en-US/12.5/api-rpc/reference.28784
11 ## Note: a DNS ID with host = empty string is OK for this API, see
12 ## https://docs.plesk.com/en-US/obsidian/api-rpc/about-xml-api/reference/managing-dns/managing-dns-records/adding-dns-record.34798
13 ## For example, to add a TXT record to DNS alias domain "acme-alias.com" would be a valid Plesk action.
14 ## So this API module can handle such a request, if needed.
16 ## For ACME v2 purposes, new TXT records are appended when added, and removing one TXT record will not affect any other TXT records.
18 ## The user credentials (username+password) and URL/URI for the Plesk XML API must be set by the user
19 ## before this module is called (case sensitive):
22 ## export pleskxml_uri="https://address-of-my-plesk-server.net:8443/enterprise/control/agent.php"
23 ## (or probably something similar)
24 ## export pleskxml_user="my plesk username"
25 ## export pleskxml_pass="my plesk password"
28 ## Ok, let's issue a cert now:
30 ## acme.sh --issue --dns dns_pleskxml -d example.com -d www.example.com
33 ## The `pleskxml_uri`, `pleskxml_user` and `pleskxml_pass` will be saved in `~/.acme.sh/account.conf` and reused when needed.
35 #################### INTERNAL VARIABLES + NEWLINE + API TEMPLATES ##################################
37 pleskxml_init_checks_done
=0
39 # Variable containing bare newline - not a style issue
40 # shellcheck disable=SC1004
44 pleskxml_tplt_get_domains
="<packet><customer><get-domain-list><filter/></get-domain-list></customer></packet>"
45 # Get a list of domains that PLESK can manage, so we can check root domain + host for acme.sh
46 # Also used to test credentials and URI.
49 pleskxml_tplt_get_dns_records
="<packet><dns><get_rec><filter><site-id>%s</site-id></filter></get_rec></dns></packet>"
50 # Get all DNS records for a Plesk domain ID.
51 # PARAM = Plesk domain id to query
53 pleskxml_tplt_add_txt_record
="<packet><dns><add_rec><site-id>%s</site-id><type>TXT</type><host>%s</host><value>%s</value></add_rec></dns></packet>"
54 # Add a TXT record to a domain.
55 # PARAMS = (1) Plesk internal domain ID, (2) "hostname" for the new record, eg '_acme_challenge', (3) TXT record value
57 pleskxml_tplt_rmv_dns_record
="<packet><dns><del_rec><filter><id>%s</id></filter></del_rec></dns></packet>"
58 # Delete a specific TXT record from a domain.
59 # PARAM = the Plesk internal ID for the DNS record to be deleted
61 #################### Public functions ##################################
63 #Usage: dns_pleskxml_add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
68 _info
"Entering dns_pleskxml_add() to add TXT record '$txtvalue' to domain '$fulldomain'..."
70 # Get credentials if not already checked, and confirm we can log in to Plesk XML API
71 if ! _credential_check
; then
75 # Get root and subdomain details, and Plesk domain ID
76 if ! _pleskxml_get_root_domain
"$fulldomain"; then
80 _debug
'Credentials OK, and domain identified. Calling Plesk XML API to add TXT record'
82 # printf using template in a variable - not a style issue
83 # shellcheck disable=SC2059
84 request
="$(printf "$pleskxml_tplt_add_txt_record" "$root_domain_id" "$sub_domain_name" "$txtvalue")"
85 if ! _call_api
"$request"; then
89 # OK, we should have added a TXT record. Let's check and return success if so.
90 # All that should be left in the result, is one section, containing <result><status>ok</status><id>NEW_DNS_RECORD_ID</id></result>
92 results
="$(_api_response_split "$pleskxml_prettyprint_result" 'result' '<status>')"
94 if ! _value
"$results" |
grep '<status>ok</status>' |
grep '<id>[0-9]\{1,\}</id>' >/dev
/null
; then
95 # Error - doesn't contain expected string. Something's wrong.
96 _err
'Error when calling Plesk XML API.'
97 _err
'The result did not contain the expected <id>XXXXX</id> section, or contained other values as well.'
98 _err
'This is unexpected: something has gone wrong.'
99 _err
'The full response was:'
100 _err
"$pleskxml_prettyprint_result"
104 recid
="$(_value "$results" | grep '<id>[0-9]\{1,\}</id>' | sed 's/^.*<id>\([0-9]\{1,\}\)<\/id>.*$/\1/')"
106 _info
"Success. TXT record appears to be correctly added (Plesk record ID=$recid). Exiting dns_pleskxml_add()."
111 #Usage: dns_pleskxml_rm _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
116 _info
"Entering dns_pleskxml_rm() to remove TXT record '$txtvalue' from domain '$fulldomain'..."
118 # Get credentials if not already checked, and confirm we can log in to Plesk XML API
119 if ! _credential_check
; then
123 # Get root and subdomain details, and Plesk domain ID
124 if ! _pleskxml_get_root_domain
"$fulldomain"; then
128 _debug
'Credentials OK, and domain identified. Calling Plesk XML API to get list of TXT records and their IDs'
130 # printf using template in a variable - not a style issue
131 # shellcheck disable=SC2059
132 request
="$(printf "$pleskxml_tplt_get_dns_records" "$root_domain_id")"
133 if ! _call_api
"$request"; then
137 # Reduce output to one line per DNS record, filtered for TXT records with a record ID only (which they should all have)
138 # Also strip out spaces between tags, redundant <data> and </data> group tags and any <self-closing/> tags
140 _api_response_split "$pleskxml_prettyprint_result" 'result' '<status>ok</status>' |
141 sed 's# \{1,\}<\([a-zA-Z]\)#<\1#g;s#</\{0,1\}data>##g;s#<[a-z][^/<>]*/>##g' |
142 grep "<site-id
>${root_domain_id}</site-id
>" |
143 grep '<id>[0-9]\{1,\}</id>' |
144 grep '<type>TXT</type>'
147 if [ -z "$reclist" ]; then
148 _err
"No TXT records found for root domain ${root_domain_name} (Plesk domain ID ${root_domain_id}). Exiting."
152 _debug
"Got list of DNS TXT records for root domain '$root_domain_name':"
157 grep "<host>${fulldomain}.
</host>" |
158 grep "<value
>${txtvalue}</value
>" |
159 sed 's/^.*<id>\([0-9]\{1,\}\)<\/id>.*$/\1/'
162 if ! _value
"$recid" |
grep '^[0-9]\{1,\}$' >/dev
/null
; then
163 _err
"DNS records for root domain '${root_domain_name}' (Plesk ID ${root_domain_id}) + host '${sub_domain_name}' do not contain the TXT record '${txtvalue}'"
164 _err
"Cannot delete TXT record. Exiting."
168 _debug
"Found Plesk record ID for target text string '${txtvalue}': ID=${recid}"
169 _debug
'Calling Plesk XML API to remove TXT record'
171 # printf using template in a variable - not a style issue
172 # shellcheck disable=SC2059
173 request
="$(printf "$pleskxml_tplt_rmv_dns_record" "$recid")"
174 if ! _call_api
"$request"; then
178 # OK, we should have removed a TXT record. Let's check and return success if so.
179 # All that should be left in the result, is one section, containing <result><status>ok</status><id>PLESK_DELETED_DNS_RECORD_ID</id></result>
181 results
="$(_api_response_split "$pleskxml_prettyprint_result" 'result' '<status>')"
183 if ! _value
"$results" |
grep '<status>ok</status>' |
grep '<id>[0-9]\{1,\}</id>' >/dev
/null
; then
184 # Error - doesn't contain expected string. Something's wrong.
185 _err
'Error when calling Plesk XML API.'
186 _err
'The result did not contain the expected <id>XXXXX</id> section, or contained other values as well.'
187 _err
'This is unexpected: something has gone wrong.'
188 _err
'The full response was:'
189 _err
"$pleskxml_prettyprint_result"
193 _info
"Success. TXT record appears to be correctly removed. Exiting dns_pleskxml_rm()."
197 #################### Private functions below (utility functions) ##################################
199 # Outputs value of a variable without additional newlines etc
204 # Outputs value of a variable (FQDN) and cuts it at 2 specified '.' delimiters, returning the text in between
205 # $1, $2 = where to cut
208 printf '%s' "$3" | cut
-d .
-f "${1}-${2}"
211 # Counts '.' present in a domain name or other string
214 _value
"$1" |
tr -dc '.' |
wc -c |
sed 's/ //g'
217 # Cleans up an API response, splits it "one line per item in the response" and greps for a string that in the context, identifies "useful" lines
218 # $1 - result string from API
219 # $2 - plain text tag to resplit on (usually "result" or "domain"). NOT REGEX
220 # $3 - basic regex to recognise useful return lines
221 # note: $3 matches via basic NOT extended regex (BRE), as extended regex capabilities not needed at the moment.
222 # Last line could change to <sed -n '/.../p'> instead, with suitable escaping of ['"/$],
223 # if future Plesk XML API changes ever require extended regex
224 _api_response_split
() {
226 sed 's/^ +//;s/ +$//' |
228 sed "s/<\/\{0,1\}$2>/${NEWLINE}/g" |
232 #################### Private functions below (DNS functions) ##################################
234 # Calls Plesk XML API, and checks results for obvious issues
239 _debug
'Entered _call_api(). Calling Plesk XML API with request:'
242 export _H1
="HTTP_AUTH_LOGIN: $pleskxml_user"
243 export _H2
="HTTP_AUTH_PASSWD: $pleskxml_pass"
244 export _H3
="content-Type: text/xml"
245 export _H4
="HTTP_PRETTY_PRINT: true"
246 pleskxml_prettyprint_result
="$(_post "${request}" "$pleskxml_uri" "" "POST
")"
247 pleskxml_retcode
="$?"
248 _debug
'The responses from the Plesk XML server were:'
249 _debug
"retcode=$pleskxml_retcode. Literal response:"
250 _debug
"'$pleskxml_prettyprint_result'"
252 # Detect any <status> that isn't "ok". None of the used calls should fail if the API is working correctly.
253 # Also detect if there simply aren't any status lines (null result?) and report that, as well.
255 statuslines_count_total
="$(echo "$pleskxml_prettyprint_result" | grep -c '^ *<status>[^<]*</status> *$')"
256 statuslines_count_okay
="$(echo "$pleskxml_prettyprint_result" | grep -c '^ *<status>ok</status> *$')"
258 if [ -z "$statuslines_count_total" ]; then
260 # We have no status lines at all. Results are empty
261 errtext
='The Plesk XML API unexpectedly returned an empty set of results for this call.'
263 elif [ "$statuslines_count_okay" -ne "$statuslines_count_total" ]; then
265 # We have some status lines that aren't "ok". Any available details are in API response fields "status" "errcode" and "errtext"
266 # Workaround for basic regex:
267 # - filter output to keep only lines like this: "SPACES<TAG>text</TAG>SPACES" (shouldn't be necessary with prettyprint but guarantees subsequent code is ok)
268 # - then edit the 3 "useful" error tokens individually and remove closing tags on all lines
269 # - then filter again to remove all lines not edited (which will be the lines not starting A-Z)
271 _value "$pleskxml_prettyprint_result" |
272 grep '^ *<[a-z]\{1,\}>[^<]*<\/[a-z]\{1,\}> *$' |
273 sed 's/^ *<status>/Status: /;s/^ *<errcode>/Error code: /;s/^ *<errtext>/Error text: /;s/<\/.*$//' |
279 if [ "$pleskxml_retcode" -ne 0 ] ||
[ "$errtext" != "" ]; then
280 # Call failed, for reasons either in the retcode or the response text...
282 if [ "$pleskxml_retcode" -eq 0 ]; then
283 _err
"The POST request was successfully sent to the Plesk server."
285 _err
"The return code for the POST request was $pleskxml_retcode (non-zero = failure in submitting request to server)."
288 if [ "$errtext" != "" ]; then
289 _err
'The error responses received from the Plesk server were:'
292 _err
"No additional error messages were received back from the Plesk server"
295 _err
"The Plesk XML API call failed."
300 _debug
"Leaving _call_api(). Successful call."
305 # Startup checks (credentials, URI)
306 _credential_check
() {
307 _debug
"Checking Plesk XML API login credentials and URI..."
309 if [ "$pleskxml_init_checks_done" -eq 1 ]; then
310 _debug
"Initial checks already done, no need to repeat. Skipped."
314 pleskxml_user
="${pleskxml_user:-$(_readaccountconf_mutable pleskxml_user)}"
315 pleskxml_pass
="${pleskxml_pass:-$(_readaccountconf_mutable pleskxml_pass)}"
316 pleskxml_uri
="${pleskxml_uri:-$(_readaccountconf_mutable pleskxml_uri)}"
318 if [ -z "$pleskxml_user" ] ||
[ -z "$pleskxml_pass" ] ||
[ -z "$pleskxml_uri" ]; then
322 _err
"You didn't specify one or more of the Plesk XML API username, password, or URI."
323 _err
"Please create these and try again."
324 _err
"Instructions are in the 'dns_pleskxml' plugin source code or in the acme.sh documentation."
328 # Test the API is usable, by trying to read the list of managed domains...
329 _call_api
"$pleskxml_tplt_get_domains"
330 if [ "$pleskxml_retcode" -ne 0 ]; then
331 _err
'Failed to access Plesk XML API.'
332 _err
"Please check your login credentials and Plesk URI, and that the URI is reachable, and try again."
336 _saveaccountconf_mutable pleskxml_uri
"$pleskxml_uri"
337 _saveaccountconf_mutable pleskxml_user
"$pleskxml_user"
338 _saveaccountconf_mutable pleskxml_pass
"$pleskxml_pass"
340 _debug
"Test login to Plesk XML API successful. Login credentials and URI successfully saved to the acme.sh configuration file for future use."
342 pleskxml_init_checks_done
=1
347 # For a FQDN, identify the root domain managed by Plesk, its domain ID in Plesk, and the host if any.
349 # IMPORTANT NOTE: a result with host = empty string is OK for this API, see
350 # https://docs.plesk.com/en-US/obsidian/api-rpc/about-xml-api/reference/managing-dns/managing-dns-records/adding-dns-record.34798
351 # See notes at top of this file
353 _pleskxml_get_root_domain
() {
354 original_full_domain_name
="$1"
356 _debug
"Identifying DNS root domain for '$original_full_domain_name' that is managed by the Plesk account."
358 # test if the domain as provided is valid for splitting.
360 if [ "$(_countdots "$original_full_domain_name")" -eq 0 ]; then
361 _err
"Invalid domain. The ACME domain must contain at least two parts (aa.bb) to identify a domain and tld for the TXT record."
365 _debug
"Querying Plesk server for list of managed domains..."
367 _call_api
"$pleskxml_tplt_get_domains"
368 if [ "$pleskxml_retcode" -ne 0 ]; then
372 # Generate a crude list of domains known to this Plesk account.
373 # We convert <ascii-name> tags to <name> so it'll flag on a hit with either <name> or <ascii-name> fields,
374 # for non-Western character sets.
375 # Output will be one line per known domain, containing 2 <name> tages and a single <id> tag
376 # We don't actually need to check for type, name, *and* id, but it guarantees only usable lines are returned.
378 output
="$(_api_response_split "$pleskxml_prettyprint_result" 'domain' '<type>domain</type>' | sed 's/<ascii-name>/<name>/g;s/<\/ascii-name>/<\/name>/g' | grep '<name>' | grep '<id>')"
380 _debug
'Domains managed by Plesk server are (ignore the hacked output):'
383 # loop and test if domain, or any parent domain, is managed by Plesk
384 # Loop until we don't have any '.' in the string we're testing as a candidate Plesk-managed domain
386 root_domain_name
="$original_full_domain_name"
390 _debug
"Checking if '$root_domain_name' is managed by the Plesk server..."
392 root_domain_id
="$(_value "$output" | grep "<name
>$root_domain_name</name
>" | _head_n 1 | sed 's/^.*<id>\([0-9]\{1,\}\)<\/id>.*$/\1/')"
394 if [ -n "$root_domain_id" ]; then
396 # SEE IMPORTANT NOTE ABOVE - THIS FUNCTION CAN RETURN HOST='', AND THAT'S OK FOR PLESK XML API WHICH ALLOWS IT.
397 # SO WE HANDLE IT AND DON'T PREVENT IT
398 sub_domain_name
="$(_value "$original_full_domain_name" | sed "s
/\.\
{0,1\
}${root_domain_name}"'$//')"
399 _info
"Success. Matched host '$original_full_domain_name' to: DOMAIN '${root_domain_name}' (Plesk ID '${root_domain_id}'), HOST '${sub_domain_name}'. Returning."
403 # No match, try next parent up (if any)...
405 root_domain_name
="$(_valuecut 2 1000 "$root_domain_name")"
407 if [ "$(_countdots "$root_domain_name")" -eq 0 ]; then
408 _debug
"No match, and next parent would be a TLD..."
409 _err
"Cannot find '$original_full_domain_name' or any parent domain of it, in Plesk."
410 _err
"Are you sure that this domain is managed by this Plesk server?"
414 _debug
"No match, trying next parent up..."