Add DNS provider for CPanel and WHM

[ldez]

• add a description to your PR
• have a homogeneous design with the other providers
• add tests (units)
• add tests ("live")
• add a provider descriptor
• generate CLI help, documentation, and readme.
• be able to do: (and put the output of this command to a comment in your PR)

  make build
  rm -rf .lego
  
  CPANEL_USERNAME = "yyyy"
  CPANEL_TOKEN = "xxxx"
  CPANEL_BASE_URL = "https://somecpanel.com:2083" \
  CPANEL_NAMESERVER = "ns1.somecpanel.com:53" \
  ./dist/lego -m your@email.com --dns cpanel -d *.example.com -d example.com -s https://acme-staging-v02.api.letsencrypt.org/directory run

  Note the wildcard domain is important.
• pass the linter
• do go mod tidy

Ping @ssipos90, @SirexToo can you run the command (with your domain, email, and credentials)?

#1060 (comment)

Closes #1060

[ssipos90]

I'm no longer on this, can't help.

[seebeen]

This doesn't work on a server which uses DNS clustering.

[ldez]

ok but can you explain what I have to change? (API endpoints, options, etc.)

[seebeen]

ok but can you explain what I have to change? (API endpoints, options, etc.)

There are two contexts:

cPanel - User context

Most cPanel providers disable API access for users.
This means that the code you wrote won't work in 99% of the cases, since cPanel users won't be able to access it. 😞

WHM - Admin context (reseller and root).

This is where the server control logic lies.

You need to split the initiation context as a param - whm for root / resellers - cPanel for endusers.

WHM Calls you need are here:
https://api.docs.cpanel.net/openapi/whm/tag/DNS-Zones/

Before doing anything with DNS - serverside related - you need this.
https://api.docs.cpanel.net/openapi/whm/operation/has_local_authority/

Check if the local targeted WHM Server is authoritative for the domain in question, and then use calls from the link above to do your thing.

Source: I'm a hosting provider.

P.S. I stumbled into this convo by chance. I'll be happy to sponsor further development of this, if it means it can be integrated into traefik 😊

[ldez]

The cPanel/WHM documentation is not really clear and the API is a bit weird.

If you are able to test it and be able to provide a real API response for the different cases, I can work on that (and your sponsoring will be welcome).
This provider will be usable inside Traefik.

[seebeen]

I can Do you one better. I can give you a cPanel server and a WHM api key to test with :)

Contact me via mail (xxxx) - or discord (seebeen)

[pcastelo]

@ldez what do you need to finish it ? , i can help

[ldez]

feel free to test the PR and suggest changes.

[ldez]

There are 5 APIs:

• cPanel UAPI https://api.docs.cpanel.net/cpanel/introduction/
• WHM API 1 https://api.docs.cpanel.net/whm/introduction/
• WHM API 0 ???
• cPanel API 2 (deprecated)
• cPanel API 1 (deprecated)

I don't know what is the difference between cPanel and WHM and why there are 2 completely different APIs (different path, different response format) for mainly the same things.

• https://api.docs.cpanel.net/openapi/cpanel/tag/DNS/
• https://api.docs.cpanel.net/openapi/whm/tag/DNS-Zones/
• https://api.docs.cpanel.net/openapi/cpanel/operation/has_local_authority/
• https://api.docs.cpanel.net/openapi/whm/operation/has_local_authority/

The comment #1977 (comment) seems to explain the difference (user/admin) but it's not clear why there are 2 contexts/APIs.

I can create 2 API clients, it's not a problem, but the usage of those APIs is cryptic.

[pcastelo]

letme try another call and let you know ,

thw whm is the reselle panel it can hand multiple zone from diferent user
cpanel is for end user and is limited in zones thant can handle

[ldez]

After several hours of fighting against the API and wrong API documentation, The PR is working 🎉

This PR adds the support for cPanel and WHM 🎉

Huge thanks to @pcastelo ❤️

I would also like to thank @seebeen 👍

[dmke]

LGTM, will need to look into the availablity of slices.Contains though.