chore: clean .gitignore cache
This commit is contained in:
GitHub Actions
@@ -1,35 +0,0 @@
|
||||
# PowerDNS Plugin for Charon
|
||||
|
||||
This is an example DNS provider plugin for Charon that adds support for PowerDNS Authoritative Server.
|
||||
|
||||
## Building
|
||||
|
||||
To build this plugin, you **must** use `CGO_ENABLED=1` and the same Go version as the Charon binary:
|
||||
|
||||
```bash
|
||||
cd plugins/powerdns
|
||||
CGO_ENABLED=1 go build -buildmode=plugin -o ../powerdns.so main.go
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
1. Build the plugin as shown above
|
||||
2. Copy `powerdns.so` to `/app/plugins/` (or your configured plugin directory)
|
||||
3. Restart Charon to load the plugin
|
||||
4. The PowerDNS provider will appear in the DNS providers list
|
||||
|
||||
## Configuration
|
||||
|
||||
The PowerDNS plugin requires:
|
||||
|
||||
- **API URL**: The PowerDNS HTTP API endpoint (e.g., `https://pdns.example.com:8081`)
|
||||
- **API Key**: Your PowerDNS API key (X-API-Key header value)
|
||||
- **Server ID** (optional): PowerDNS server ID (default: `localhost`)
|
||||
|
||||
## Caddy Requirement
|
||||
|
||||
This plugin only handles the Charon UI/API integration. To use PowerDNS for DNS challenges, Caddy must be built with the [caddy-dns/powerdns](https://github.com/caddy-dns/powerdns) module.
|
||||
|
||||
## Security
|
||||
|
||||
Always verify the plugin source before loading it. Plugins run in the same process as Charon and have full access to system resources.
|
||||
@@ -1,142 +0,0 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"runtime"
|
||||
"time"
|
||||
|
||||
"github.com/Wikid82/charon/backend/pkg/dnsprovider"
|
||||
)
|
||||
|
||||
// Plugin is the exported symbol that Charon looks for.
|
||||
var Plugin dnsprovider.ProviderPlugin = &PowerDNSProvider{}
|
||||
|
||||
// PowerDNSProvider implements the ProviderPlugin interface for PowerDNS.
|
||||
type PowerDNSProvider struct{}
|
||||
|
||||
func (p *PowerDNSProvider) Type() string {
|
||||
return "powerdns"
|
||||
}
|
||||
|
||||
func (p *PowerDNSProvider) Metadata() dnsprovider.ProviderMetadata {
|
||||
return dnsprovider.ProviderMetadata{
|
||||
Type: "powerdns",
|
||||
Name: "PowerDNS",
|
||||
Description: "PowerDNS Authoritative Server with HTTP API",
|
||||
DocumentationURL: "https://doc.powerdns.com/authoritative/http-api/",
|
||||
Author: "Charon Community",
|
||||
Version: "1.0.0",
|
||||
IsBuiltIn: false,
|
||||
GoVersion: runtime.Version(),
|
||||
InterfaceVersion: dnsprovider.InterfaceVersion,
|
||||
}
|
||||
}
|
||||
|
||||
func (p *PowerDNSProvider) Init() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (p *PowerDNSProvider) Cleanup() error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (p *PowerDNSProvider) RequiredCredentialFields() []dnsprovider.CredentialFieldSpec {
|
||||
return []dnsprovider.CredentialFieldSpec{
|
||||
{
|
||||
Name: "api_url",
|
||||
Label: "API URL",
|
||||
Type: "text",
|
||||
Placeholder: "https://pdns.example.com:8081",
|
||||
Hint: "PowerDNS HTTP API endpoint",
|
||||
},
|
||||
{
|
||||
Name: "api_key",
|
||||
Label: "API Key",
|
||||
Type: "password",
|
||||
Placeholder: "Your PowerDNS API key",
|
||||
Hint: "X-API-Key header value",
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func (p *PowerDNSProvider) OptionalCredentialFields() []dnsprovider.CredentialFieldSpec {
|
||||
return []dnsprovider.CredentialFieldSpec{
|
||||
{
|
||||
Name: "server_id",
|
||||
Label: "Server ID",
|
||||
Type: "text",
|
||||
Placeholder: "localhost",
|
||||
Hint: "PowerDNS server ID (default: localhost)",
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
func (p *PowerDNSProvider) ValidateCredentials(creds map[string]string) error {
|
||||
if creds["api_url"] == "" {
|
||||
return fmt.Errorf("api_url is required")
|
||||
}
|
||||
if creds["api_key"] == "" {
|
||||
return fmt.Errorf("api_key is required")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (p *PowerDNSProvider) TestCredentials(creds map[string]string) error {
|
||||
if err := p.ValidateCredentials(creds); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Test API connectivity
|
||||
serverID := creds["server_id"]
|
||||
if serverID == "" {
|
||||
serverID = "localhost"
|
||||
}
|
||||
url := fmt.Sprintf("%s/api/v1/servers/%s", creds["api_url"], serverID)
|
||||
req, err := http.NewRequest("GET", url, nil)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create request: %w", err)
|
||||
}
|
||||
req.Header.Set("X-API-Key", creds["api_key"])
|
||||
client := &http.Client{Timeout: 10 * time.Second}
|
||||
resp, err := client.Do(req)
|
||||
if err != nil {
|
||||
return fmt.Errorf("API connection failed: %w", err)
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return fmt.Errorf("API returned status %d", resp.StatusCode)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (p *PowerDNSProvider) SupportsMultiCredential() bool {
|
||||
return false
|
||||
}
|
||||
|
||||
func (p *PowerDNSProvider) BuildCaddyConfig(creds map[string]string) map[string]any {
|
||||
serverID := creds["server_id"]
|
||||
if serverID == "" {
|
||||
serverID = "localhost"
|
||||
}
|
||||
return map[string]any{
|
||||
"name": "powerdns",
|
||||
"api_url": creds["api_url"],
|
||||
"api_key": creds["api_key"],
|
||||
"server_id": serverID,
|
||||
}
|
||||
}
|
||||
|
||||
func (p *PowerDNSProvider) BuildCaddyConfigForZone(baseDomain string, creds map[string]string) map[string]any {
|
||||
return p.BuildCaddyConfig(creds)
|
||||
}
|
||||
|
||||
func (p *PowerDNSProvider) PropagationTimeout() time.Duration {
|
||||
return 60 * time.Second
|
||||
}
|
||||
|
||||
func (p *PowerDNSProvider) PollingInterval() time.Duration {
|
||||
return 2 * time.Second
|
||||
}
|
||||
|
||||
func main() {}
|
||||
Reference in New Issue
Block a user