Plugins/DuckDNS.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
function Get-CurrentPluginType { 'dns-01' }

function Add-DnsTxt {
    [CmdletBinding(DefaultParameterSetName='Secure')]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(ParameterSetName='Secure',Mandatory,Position=2)]
        [securestring]$DuckToken,
        [Parameter(ParameterSetName='DeprecatedInsecure',Mandatory,Position=2)]
        [string]$DuckTokenInsecure,
        [Parameter(Mandatory,Position=3)]
        [string[]]$DuckDomain,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    # get the plaintext version of the token
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $DuckTokenInsecure = [pscredential]::new('a',$DuckToken).GetNetworkCredential().Password
    }

    Write-Verbose "Adding TXT $TxtValue on DuckDNS for $($DuckDomain -join ',')"
    $domains = $DuckDomain -join ','
    $uri = "https://www.duckdns.org/update?domains=$domains&token=$DuckTokenInsecure&txt=$TxtValue"
    try {
        $response = Invoke-RestMethod $uri @script:UseBasic -EA Stop
    } catch { throw }

    if ($response -ne 'OK') {
        throw "Failed to add DuckDNS TXT record."
    }

    <#
    .SYNOPSIS
        Add a DNS TXT record to DuckDNS
 
    .DESCRIPTION
        Add a DNS TXT record to DuckDNS
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER DuckToken
        The API token for DuckDNS.
 
    .PARAMETER DuckTokenInsecure
        (DEPRECATED) The API token for DuckDNS.
 
    .PARAMETER DuckDomains
        The list of domains associated with this token to update. Domains do not need to include the .duckdns.org part, just the subname.
 
    .PARAMETER ExtraParams
        This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports.
 
    .EXAMPLE
        $token = Read-Host 'Token' -AsSecureString
        Add-DnsTxt '_acme-challenge.mydomain.duckdns.org' 'txt-value' $token 'mydomain'
 
        Adds a TXT record for the specified site with the specified value.
    #>

}

function Remove-DnsTxt {
    [CmdletBinding(DefaultParameterSetName='Secure')]
    param(
        [Parameter(Mandatory,Position=0)]
        [string]$RecordName,
        [Parameter(Mandatory,Position=1)]
        [string]$TxtValue,
        [Parameter(ParameterSetName='Secure',Mandatory,Position=2)]
        [securestring]$DuckToken,
        [Parameter(ParameterSetName='DeprecatedInsecure',Mandatory,Position=2)]
        [string]$DuckTokenInsecure,
        [Parameter(Mandatory,Position=3)]
        [string[]]$DuckDomain,
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    # get the plaintext version of the token
    if ('Secure' -eq $PSCmdlet.ParameterSetName) {
        $DuckTokenInsecure = [pscredential]::new('a',$DuckToken).GetNetworkCredential().Password
    }

    Write-Verbose "Clearing TXT on DuckDNS for $($DuckDomain -join ',')"
    $domains = $DuckDomain -join ','
    $uri = "https://www.duckdns.org/update?domains=$domains&token=$DuckTokenInsecure&txt=$TxtValue&clear=true"
    try {
        $response = Invoke-RestMethod $uri @script:UseBasic -EA Stop
    } catch { throw }

    if ($response -ne 'OK') {
        throw "Failed to clear DuckDNS TXT record."
    }

    <#
    .SYNOPSIS
        Remove a DNS TXT record from DuckDNS
 
    .DESCRIPTION
        Remove a DNS TXT record from DuckDNS
 
    .PARAMETER RecordName
        The fully qualified name of the TXT record.
 
    .PARAMETER TxtValue
        The value of the TXT record.
 
    .PARAMETER DuckToken
        The API token for DuckDNS.
 
    .PARAMETER DuckTokenInsecure
        (DEPRECATED) The API token for DuckDNS.
 
    .PARAMETER DuckDomains
        The list of domains associated with this token to update. Domains do not need to include the .duckdns.org part, just the subname.
 
    .PARAMETER ExtraParams
        This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports.
 
    .EXAMPLE
        $token = Read-Host 'Token' -AsSecureString
        Remove-DnsTxt '_acme-challenge.mydomain.duckdns.org' 'txt-value' $token 'mydomain'
 
        Removes a TXT record for the specified site with the specified value.
    #>

}

function Save-DnsTxt {
    [CmdletBinding()]
    param(
        [Parameter(ValueFromRemainingArguments)]
        $ExtraParams
    )

    <#
    .SYNOPSIS
        Not required.
 
    .DESCRIPTION
        This provider does not require calling this function to commit changes to DNS records.
 
    .PARAMETER ExtraParams
        This parameter can be ignored and is only used to prevent errors when splatting with more parameters than this function supports.
    #>

}