PowerShell/Scripts/Encode-String.ps1 at main · jpann/PowerShell · GitHub

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
<#
    .SYNOPSIS
    Functions for URL encoding and decoding strings .

    .DESCRIPTION
    Functions for URL encoding and decoding strings .

    .NOTES
    Author:         Jonathan Panning <jpann [at] impostr-labs.com>
    Filename:     	Encode-String.ps1
    Created on:   	12-06-2023
    Version:        1.0
    Last updated:   12-06-2023

    .EXAMPLE
    PS> Import-Module .\Encode-String.ps1
    PS> Encode-String -String "this is a test"
    this+is+a+test

    PS> Import-Module .\Encode-String.ps1
    PS> Decode-String -String "this+is+a+test"
    this is a test
#>


function Encode-String
{
<#
    .SYNOPSIS
    URL encodes a string.

    .DESCRIPTION
    URL encodes a string.

    .NOTES
    Author:         Jonathan Panning <jpann [at] impostr-labs.com>
    Filename:     	Encode-String.ps1
    Created on:   	12-06-2023
    Version:        1.0
    Last updated:   12-06-2023

    .PARAMETER String
    String to encode

    .INPUTS
    System.String. String to encode.

    .OUTPUTS
    System.String. The URL encoded string.

    .EXAMPLE
    PS> Encode-String -String "this is a test"
    this+is+a+test

    .EXAMPLE
    PS> "this is a test" | Encode-String
    this+is+a+test
#>
    [CmdletBinding()]
    [OutputType('System.String')]
    Param(
        [parameter(Mandatory=$true,Position=0,
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [string]$String
    )

    Add-Type -AssemblyName System.Web

    $EncodedString = [System.Web.HttpUtility]::UrlEncode($String)

    Write-Output $EncodedString
}

function Decode-String
{
<#
    .SYNOPSIS
    URL decodes a string.

    .DESCRIPTION
    URL decodes a string.

    .NOTES
    Author:         Jonathan Panning <jpann [at] impostr-labs.com>
    Created on:   	12-06-2023
    Version:        1.0
    Last updated:   12-06-2023

    .PARAMETER String
    String to encode

    .INPUTS
    System.String. The URL encoded string.

    .OUTPUTS
    System.String. The decoded string.

    .EXAMPLE
    PS> Decode-String -String "this+is+a+test"
    this is a test

    .EXAMPLE
    PS> "this+is+a+test" | Decode-String
    this is a test
#>
    [CmdletBinding()]
    [OutputType('System.String')]
    Param(
        [parameter(Mandatory=$true,Position=0,
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true)]
        [ValidateNotNullOrEmpty()]
        [string]$String
    )

    Add-Type -AssemblyName System.Web

    $DecodedString = [System.Web.HttpUtility]::UrlDecode($String)

    Write-Output $DecodedString
}