acme.sh/dnsapi/dns_ovh.sh

323 lines
7.8 KiB
Bash
Raw Permalink Normal View History

#!/usr/bin/env sh
2017-03-26 05:24:26 +00:00
#Application Key
#OVH_AK="sdfsdfsdfljlbjkljlkjsdfoiwje"
#
#Application Secret
#OVH_AS="sdfsafsdfsdfdsfsdfsa"
#
#Consumer Key
#OVH_CK="sdfsdfsdfsdfsdfdsf"
#OVH_END_POINT=ovh-eu
#'ovh-eu'
OVH_EU='https://eu.api.ovh.com/1.0'
2017-04-17 11:08:34 +00:00
#'ovh-ca':
OVH_CA='https://ca.api.ovh.com/1.0'
#'kimsufi-eu'
KSF_EU='https://eu.api.kimsufi.com/1.0'
#'kimsufi-ca'
KSF_CA='https://ca.api.kimsufi.com/1.0'
#'soyoustart-eu'
SYS_EU='https://eu.api.soyoustart.com/1.0'
#'soyoustart-ca'
SYS_CA='https://ca.api.soyoustart.com/1.0'
#'runabove-ca'
RAV_CA='https://api.runabove.com/1.0'
2020-01-30 04:06:39 +00:00
wiki="https://github.com/acmesh-official/acme.sh/wiki/How-to-use-OVH-domain-api"
2020-01-30 04:06:39 +00:00
ovh_success="https://github.com/acmesh-official/acme.sh/wiki/OVH-Success"
_ovh_get_api() {
_ogaep="$1"
case "${_ogaep}" in
2016-11-09 11:30:39 +00:00
2020-08-17 14:18:20 +00:00
ovh-eu | ovheu)
printf "%s" $OVH_EU
return
;;
ovh-ca | ovhca)
printf "%s" $OVH_CA
return
;;
kimsufi-eu | kimsufieu)
printf "%s" $KSF_EU
return
;;
kimsufi-ca | kimsufica)
printf "%s" $KSF_CA
return
;;
soyoustart-eu | soyoustarteu)
printf "%s" $SYS_EU
return
;;
soyoustart-ca | soyoustartca)
printf "%s" $SYS_CA
return
;;
runabove-ca | runaboveca)
printf "%s" $RAV_CA
return
;;
*)
_err "Unknown parameter : $1"
return 1
;;
2016-11-09 11:30:39 +00:00
esac
}
2018-01-09 13:36:48 +00:00
_initAuth() {
2018-02-14 12:40:49 +00:00
OVH_AK="${OVH_AK:-$(_readaccountconf_mutable OVH_AK)}"
OVH_AS="${OVH_AS:-$(_readaccountconf_mutable OVH_AS)}"
2016-11-09 11:30:39 +00:00
if [ -z "$OVH_AK" ] || [ -z "$OVH_AS" ]; then
2016-11-12 03:13:40 +00:00
OVH_AK=""
OVH_AS=""
_err "You don't specify OVH application key and application secret yet."
_err "Please create you key and try again."
return 1
fi
2016-11-09 11:30:39 +00:00
if [ "$OVH_AK" != "$(_readaccountconf OVH_AK)" ]; then
_info "It seems that your ovh key is changed, let's clear consumer key first."
_clearaccountconf_mutable OVH_CK
fi
2018-02-14 12:40:49 +00:00
_saveaccountconf_mutable OVH_AK "$OVH_AK"
_saveaccountconf_mutable OVH_AS "$OVH_AS"
2016-11-09 11:30:39 +00:00
2018-02-14 12:40:49 +00:00
OVH_END_POINT="${OVH_END_POINT:-$(_readaccountconf_mutable OVH_END_POINT)}"
2016-11-09 11:30:39 +00:00
if [ -z "$OVH_END_POINT" ]; then
OVH_END_POINT="ovh-eu"
fi
_info "Using OVH endpoint: $OVH_END_POINT"
2016-11-09 11:30:39 +00:00
if [ "$OVH_END_POINT" != "ovh-eu" ]; then
2018-02-14 12:40:49 +00:00
_saveaccountconf_mutable OVH_END_POINT "$OVH_END_POINT"
fi
2016-11-09 11:30:39 +00:00
OVH_API="$(_ovh_get_api $OVH_END_POINT)"
_debug OVH_API "$OVH_API"
2018-02-14 12:40:49 +00:00
OVH_CK="${OVH_CK:-$(_readaccountconf_mutable OVH_CK)}"
2016-11-09 11:30:39 +00:00
if [ -z "$OVH_CK" ]; then
_info "OVH consumer key is empty, Let's get one:"
2016-11-09 11:30:39 +00:00
if ! _ovh_authentication; then
_err "Can not get consumer key."
fi
#return and wait for retry.
2016-11-09 11:30:39 +00:00
return 1
fi
_saveaccountconf_mutable OVH_CK "$OVH_CK"
2016-11-09 11:30:39 +00:00
_info "Checking authentication"
2016-11-09 11:30:39 +00:00
if ! _ovh_rest GET "domain" || _contains "$response" "INVALID_CREDENTIAL" || _contains "$response" "NOT_CREDENTIAL"; then
_err "The consumer key is invalid: $OVH_CK"
_err "Please retry to create a new one."
_clearaccountconf_mutable OVH_CK
return 1
fi
_info "Consumer key is ok."
2018-01-09 13:36:48 +00:00
return 0
}
######## Public functions #####################
#Usage: add _acme-challenge.www.domain.com "XKrxpRBosdIKFzxW_CT3KLZNf6q0HG9i01zxXp5CPBs"
dns_ovh_add() {
fulldomain=$1
txtvalue=$2
if ! _initAuth; then
return 1
fi
2016-11-09 11:30:39 +00:00
_debug "First detect the root zone"
2016-11-11 16:06:34 +00:00
if ! _get_root "$fulldomain"; then
_err "invalid domain"
return 1
fi
2016-11-11 16:50:44 +00:00
_debug _sub_domain "$_sub_domain"
_debug _domain "$_domain"
2016-11-09 11:30:39 +00:00
_info "Adding record"
if _ovh_rest POST "domain/zone/$_domain/record" "{\"fieldType\":\"TXT\",\"subDomain\":\"$_sub_domain\",\"target\":\"$txtvalue\",\"ttl\":60}"; then
if _contains "$response" "$txtvalue"; then
_ovh_rest POST "domain/zone/$_domain/refresh"
_debug "Refresh:$response"
2018-01-09 14:47:01 +00:00
_info "Added, sleep 10 seconds."
_sleep 10
return 0
fi
fi
_err "Add txt record error."
return 1
2016-11-09 11:30:39 +00:00
}
#fulldomain
dns_ovh_rm() {
fulldomain=$1
txtvalue=$2
2018-01-09 13:36:48 +00:00
if ! _initAuth; then
return 1
fi
_debug "First detect the root zone"
if ! _get_root "$fulldomain"; then
_err "invalid domain"
return 1
fi
_debug _sub_domain "$_sub_domain"
_debug _domain "$_domain"
_debug "Getting txt records"
2018-01-09 13:36:48 +00:00
if ! _ovh_rest GET "domain/zone/$_domain/record?fieldType=TXT&subDomain=$_sub_domain"; then
return 1
fi
2018-01-09 15:05:55 +00:00
for rid in $(echo "$response" | tr '][,' ' '); do
2018-01-09 13:36:48 +00:00
_debug rid "$rid"
if ! _ovh_rest GET "domain/zone/$_domain/record/$rid"; then
return 1
fi
if _contains "$response" "\"target\":\"$txtvalue\""; then
_debug "Found txt id:$rid"
if ! _ovh_rest DELETE "domain/zone/$_domain/record/$rid"; then
return 1
fi
_ovh_rest POST "domain/zone/$_domain/refresh"
_debug "Refresh:$response"
2018-01-09 13:36:48 +00:00
return 0
fi
done
return 1
}
2016-12-14 20:32:24 +00:00
#################### Private functions below ##################################
_ovh_authentication() {
2016-11-09 11:30:39 +00:00
_H1="X-Ovh-Application: $OVH_AK"
_H2="Content-type: application/json"
_H3=""
_H4=""
2016-11-09 11:30:39 +00:00
2018-01-09 13:36:48 +00:00
_ovhdata='{"accessRules": [{"method": "GET","path": "/auth/time"},{"method": "GET","path": "/domain"},{"method": "GET","path": "/domain/zone/*"},{"method": "GET","path": "/domain/zone/*/record"},{"method": "POST","path": "/domain/zone/*/record"},{"method": "POST","path": "/domain/zone/*/refresh"},{"method": "PUT","path": "/domain/zone/*/record/*"},{"method": "DELETE","path": "/domain/zone/*/record/*"}],"redirection":"'$ovh_success'"}'
2016-11-09 11:30:39 +00:00
response="$(_post "$_ovhdata" "$OVH_API/auth/credential")"
_debug3 response "$response"
validationUrl="$(echo "$response" | _egrep_o "validationUrl\":\"[^\"]*\"" | _egrep_o "http.*\"" | tr -d '"')"
2016-11-09 11:30:39 +00:00
if [ -z "$validationUrl" ]; then
_err "Unable to get validationUrl"
return 1
fi
_debug validationUrl "$validationUrl"
2016-11-09 11:30:39 +00:00
consumerKey="$(echo "$response" | _egrep_o "consumerKey\":\"[^\"]*\"" | cut -d : -f 2 | tr -d '"')"
2016-11-09 11:30:39 +00:00
if [ -z "$consumerKey" ]; then
_err "Unable to get consumerKey"
return 1
fi
2017-02-19 05:24:00 +00:00
_secure_debug consumerKey "$consumerKey"
2016-11-09 11:30:39 +00:00
OVH_CK="$consumerKey"
_saveaccountconf_mutable OVH_CK "$OVH_CK"
2016-11-09 11:30:39 +00:00
_info "Please open this link to do authentication: $(__green "$validationUrl")"
_info "Here is a guide for you: $(__green "$wiki")"
_info "Please retry after the authentication is done."
}
#_acme-challenge.www.domain.com
#returns
# _sub_domain=_acme-challenge.www
# _domain=domain.com
_get_root() {
domain=$1
i=1
p=1
2016-11-11 15:30:14 +00:00
while true; do
h=$(printf "%s" "$domain" | cut -d . -f $i-100)
2016-11-09 11:30:39 +00:00
if [ -z "$h" ]; then
#not valid
2016-11-09 11:30:39 +00:00
return 1
fi
2016-11-09 11:30:39 +00:00
if ! _ovh_rest GET "domain/zone/$h"; then
return 1
fi
2016-11-09 11:30:39 +00:00
2021-07-24 07:46:58 +00:00
if ! _contains "$response" "This service does not exist" >/dev/null &&
! _contains "$response" "This call has not been granted" >/dev/null &&
! _contains "$response" "NOT_GRANTED_CALL" >/dev/null; then
2016-11-11 15:30:14 +00:00
_sub_domain=$(printf "%s" "$domain" | cut -d . -f 1-$p)
_domain="$h"
return 0
fi
p=$i
2016-11-11 15:30:14 +00:00
i=$(_math "$i" + 1)
done
return 1
}
_ovh_timestamp() {
_H1=""
_H2=""
_H3=""
_H4=""
_H5=""
_get "$OVH_API/auth/time" "" 30
}
_ovh_rest() {
m=$1
ep="$2"
data="$3"
2016-11-11 15:30:14 +00:00
_debug "$ep"
2016-11-09 11:30:39 +00:00
_ovh_url="$OVH_API/$ep"
_debug2 _ovh_url "$_ovh_url"
_ovh_t="$(_ovh_timestamp)"
_debug2 _ovh_t "$_ovh_t"
_ovh_p="$OVH_AS+$OVH_CK+$m+$_ovh_url+$data+$_ovh_t"
2017-02-19 05:24:00 +00:00
_secure_debug _ovh_p "$_ovh_p"
_ovh_hex="$(printf "%s" "$_ovh_p" | _digest sha1 hex)"
_debug2 _ovh_hex "$_ovh_hex"
export _H1="X-Ovh-Application: $OVH_AK"
export _H2="X-Ovh-Signature: \$1\$$_ovh_hex"
_debug2 _H2 "$_H2"
export _H3="X-Ovh-Timestamp: $_ovh_t"
export _H4="X-Ovh-Consumer: $OVH_CK"
export _H5="Content-Type: application/json;charset=utf-8"
2018-01-09 13:36:48 +00:00
if [ "$data" ] || [ "$m" = "POST" ] || [ "$m" = "PUT" ] || [ "$m" = "DELETE" ]; then
_debug data "$data"
2016-11-11 16:06:34 +00:00
response="$(_post "$data" "$_ovh_url" "" "$m")"
else
response="$(_get "$_ovh_url")"
fi
2016-11-09 11:30:39 +00:00
2018-01-09 14:04:03 +00:00
if [ "$?" != "0" ] || _contains "$response" "INVALID_CREDENTIAL"; then
_err "error $response"
return 1
fi
_debug2 response "$response"
return 0
}