Skip to content

Add UTF8 #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alxcreate wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add UTF8 #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 31 additions & 6 deletions public/Send-SyslogMessage.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@ public enum Syslog_Protocol
}
"@

Add-Type -TypeDefinition @"
public enum Syslog_Encoding
{
ASCII,
UTF8
}
"@

Function Send-SyslogMessage
{
<#
Expand Down Expand Up @@ -161,6 +169,13 @@ Function Send-SyslogMessage
[Syslog_Protocol]
$Transport = 'UDP',

# Encoding charset (ASCII or UTF8) to be used when sending the message. Default is ASCII.
[Parameter(Mandatory = $false,
ValueFromPipelineByPropertyName = $true)]
[ValidateNotNullOrEmpty()]
[Syslog_Encoding]
$Encoding = 'ASCII',

#ProcessID or PID of generator of message. Will automatically use $PID global variable. If you want to override this and send null, specify '-' to meet RFC 5424 rquirements.
[Parameter(Mandatory = $false,
ValueFromPipelineByPropertyName = $true,
Expand Down Expand Up @@ -218,8 +233,18 @@ Function Send-SyslogMessage
{
Write-Debug -Message 'Starting the BEGIN block...'

# Create an ASCII Encoding object
$Encoding = [Text.Encoding]::ASCII
# Create an Encoding object
Switch ($Encoding)
{
'ASCII' {
Write-Verbose -Message 'Selected Encoding is ASCII'
$EncodingText = [System.Text.Encoding]::ASCII
}
'UTF8' {
Write-Verbose -Message 'Selected Encoding is UTF8'
$EncodingText = [System.Text.Encoding]::UTF8
}
}

# Initiate the required network objects
Switch ($Transport)
Expand Down Expand Up @@ -365,7 +390,7 @@ Function Send-SyslogMessage
Write-Verbose -Message ('Message attempting to send is: {0}' -f $FullSyslogMessage)

# Ensure that the message is not too long. We could just compare the strings length, however using the encoding is the more appropriate way of confirming the length in bytes.
if ($Encoding.GetByteCount($FullSyslogMessage) -gt $MaxLength)
if ($EncodingText.GetByteCount($FullSyslogMessage) -gt $MaxLength)
{
$FullSyslogMessage = $FullSyslogMessage.Substring(0,$MaxLength)
Write-Verbose -Message ('Message was too long and was shortened to {0} characters' -f $MaxLength)
Expand All @@ -377,7 +402,7 @@ Function Send-SyslogMessage
'UDP'
{
# Convert into byte array representation
$ByteSyslogMessage = $Encoding.GetBytes($FullSyslogMessage)
$ByteSyslogMessage = $EncodingText.GetBytes($FullSyslogMessage)

# Send the Message
Try
Expand All @@ -402,7 +427,7 @@ Function Send-SyslogMessage
{
'Octet-Counting'
{
$OctetCount = ($Encoding.GetBytes($FullSyslogMessage)).Length
$OctetCount = ($EncodingText.GetBytes($FullSyslogMessage)).Length
$FramedSyslogMessage = '{0} {1}' -f $OctetCount, $FullSyslogMessage
Write-Verbose -Message ('Octet-Counting - Framed message is: {0}' -f $FullSyslogMessage)
}
Expand All @@ -421,7 +446,7 @@ Function Send-SyslogMessage
}

# Convert into byte array representation
$ByteSyslogMessage = $Encoding.GetBytes($FramedSyslogMessage)
$ByteSyslogMessage = $EncodingText.GetBytes($FramedSyslogMessage)

# Send the Message
Try
Expand Down
76 changes: 54 additions & 22 deletions tests/Send-SyslogMessage.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,17 @@ InModuleScope $script:ModuleName {
}
Mock -ModuleName Posh-SYSLOG -CommandName Send-TCPMessage -MockWith {
$script:TestResult = $Datagram; return $null
$script:TestEncoding = $Encoding
}
Mock -ModuleName Posh-SYSLOG -CommandName Send-UDPMessage -MockWith {
$script:TestResult = $Datagram; return $null
$script:TestEncoding = $Encoding
}

$ExpectedTimeStamp = (New-Object datetime(2000,1,1)).ToString('yyyy-MM-ddTHH:mm:ss.ffffffzzz')

# Create an ASCII Encoding object
$Encoding = [Text.Encoding]::ASCII
$EncodingText = [Text.Encoding]::ASCII

Context 'Send-SyslogMessage = Parameter Validation' {
It 'Should not accept a null value for the server' {
Expand Down Expand Up @@ -222,6 +224,22 @@ InModuleScope $script:ModuleName {
{Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -Transport 'bob'} | Should Throw
}

It 'Should Accept ASCII as a Encoding' {
{Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -Encoding 'ASCII'} | Should Not Throw 'Cannot validate argument on parameter'
}

It 'Should Accept UTF8 as a Encoding' {
{Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -Encoding 'UTF8'} | Should Not Throw 'Cannot validate argument on parameter'
}

It 'Should not accept a null value for Encoding' {
{Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -Encoding $null} | Should Throw
}

It 'Should not accept an invalid value for Encoding' {
{Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -Encoding 'encoding'} | Should Throw
}

It 'Should reject ProcessID parameter if -RFC3164 is specified' {
{Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -RFC3164 -ProcessID 1} | Should Throw 'Parameter set cannot be resolved using the specified named parameters'
}
Expand Down Expand Up @@ -251,7 +269,6 @@ InModuleScope $script:ModuleName {
{Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -Transport 'TCPwithTLS' -SslProtocols $value} | Should Not Throw
}
}

}

Context 'Send-SyslogMessage = Pipeline input' {
Expand All @@ -270,7 +287,7 @@ InModuleScope $script:ModuleName {
}
$ExpectedResult = '<0>1 {0} TestHostname RandomAppName 12345678 messageid structuredata Test Syslog Message' -f $ExpectedTimeStamp
$null = $PipelineInput | Send-SyslogMessage -Server 'localhost'
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}

It 'Should accept valid input from the pipeline for RFC3164' {
Expand All @@ -284,7 +301,7 @@ InModuleScope $script:ModuleName {
}
$ExpectedResult = '<0>Jan 1 00:00:00 TestHostname RandomAppName Test Syslog Message'
$null = $PipelineInput | Send-SyslogMessage -Server 'localhost' -RFC3164
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}
}

Expand All @@ -294,25 +311,25 @@ InModuleScope $script:ModuleName {
It 'Calculates the correct priority of 0 if Facility is Kern and Severity is Emergency' {
$ExpectedResult = '<0>1 {0} TestHostname Send-SyslogMessage.Tests.ps1 {1} - - Test Syslog Message' -f $ExpectedTimeStamp, $PID
$null = Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Emergency' -Facility 'kern'
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}

It 'Calculates the correct priority of 7 if Facility is Kern and Severity is Debug' {
$ExpectedResult = '<7>1 {0} TestHostname Send-SyslogMessage.Tests.ps1 {1} - - Test Syslog Message' -f $ExpectedTimeStamp, $PID
$null = Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Debug' -Facility 'kern'
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}

It 'Calculates the correct priority of 24 if Facility is daemon and Severity is Emergency' {
$ExpectedResult = '<24>1 {0} TestHostname Send-SyslogMessage.Tests.ps1 {1} - - Test Syslog Message' -f $ExpectedTimeStamp, $PID
$null = Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Emergency' -Facility 'daemon'
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}

It 'Calculates the correct priority of 31 if Facility is daemon and Severity is Debug' {
$ExpectedResult = '<31>1 {0} TestHostname Send-SyslogMessage.Tests.ps1 {1} - - Test Syslog Message' -f $ExpectedTimeStamp, $PID
$null = Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Debug' -Facility 'daemon'
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}
}

Expand All @@ -324,15 +341,15 @@ InModuleScope $script:ModuleName {

$ExpectedResult = '<33>Jan 10 00:00:00 TestHostname Send-SyslogMessage.Tests.ps1 Test Syslog Message'
$null = Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -RFC3164
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}

It 'Should send RFC5424 formatted message with correct date format (1 to 9)' {
Mock -ModuleName Posh-SYSLOG Get-Date { return (New-Object datetime(2000,1,1)) }

$ExpectedResult = '<33>Jan 1 00:00:00 TestHostname Send-SyslogMessage.Tests.ps1 Test Syslog Message'
$null = Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -RFC3164
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}
}

Expand All @@ -342,7 +359,7 @@ InModuleScope $script:ModuleName {
It 'Should send RFC5424 formatted message' {
$ExpectedResult = '<33>1 {0} TestHostname Send-SyslogMessage.Tests.ps1 {1} - - Test Syslog Message' -f $ExpectedTimeStamp, $PID
$null = Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth'
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}
}

Expand All @@ -354,12 +371,12 @@ InModuleScope $script:ModuleName {
It 'truncates RFC 5424 messages to 2k' {
$ExpectedResult = ('<33>1 {0} TestHostname Send-SyslogMessage.Tests.ps1 {1} - - {2}' -f $ExpectedTimeStamp, $PID, $LongMsg).Substring(0,2048)
$null = Send-SyslogMessage -Server '127.0.0.1' -Message $LongMsg -Severity 'Alert' -Facility 'auth'
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}
It 'truncates RFC 3164 messages to 1k' {
$ExpectedResult = ('<33>Jan 1 00:00:00 TestHostname Send-SyslogMessage.Tests.ps1 {1}' -f $ExpectedTimeStamp, $LongMsg).Substring(0,1024)
$null = Send-SyslogMessage -Server '127.0.0.1' -Message $LongMsg -Severity 'Alert' -Facility 'auth' -RFC3164
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}
}

Expand All @@ -372,14 +389,14 @@ InModuleScope $script:ModuleName {
$FramedResult = '2048 {0}' -f $ExpectedResult

$null = Send-SyslogMessage -Server '127.0.0.1' -Message $LongMsg -Severity 'Alert' -Facility 'auth' -Transport TCP
$Encoding.GetString($script:TestResult) | should be $FramedResult
$EncodingText.GetString($script:TestResult) | should be $FramedResult
}
It 'truncates RFC 3164 messages to 1k' {
$ExpectedResult = ('<33>Jan 1 00:00:00 TestHostname Send-SyslogMessage.Tests.ps1 {1}' -f $ExpectedTimeStamp, $LongMsg).Substring(0,1024)
$FramedResult = '1024 {0}' -f $ExpectedResult

$null = Send-SyslogMessage -Server '127.0.0.1' -Message $LongMsg -Severity 'Alert' -Facility 'auth' -RFC3164 -Transport TCP
$Encoding.GetString($script:TestResult) | should be $FramedResult
$EncodingText.GetString($script:TestResult) | should be $FramedResult
}
}

Expand All @@ -391,28 +408,44 @@ InModuleScope $script:ModuleName {
$FramedResult = '{0} {1}' -f $ExpectedResult.Length, $ExpectedResult

$null = Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -Hostname TestHostname -Transport TCP
$Encoding.GetString($script:TestResult) | should be $FramedResult
$EncodingText.GetString($script:TestResult) | should be $FramedResult
}

It 'sends using TCP transport with Octet-Counting as the framing' {
$ExpectedResult = '<33>1 {0} TestHostname Send-SyslogMessage.Tests.ps1 {1} - - Test Syslog Message' -f $ExpectedTimeStamp, $PID
$FramedResult = '{0} {1}' -f $ExpectedResult.Length, $ExpectedResult

$null = Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -Hostname TestHostname -Transport TCP -FramingMethod Octet-Counting
$Encoding.GetString($script:TestResult) | should be $FramedResult
$EncodingText.GetString($script:TestResult) | should be $FramedResult
}
It 'sends using TCP transport with Non-Transparent-Framing as the framing' {
$ExpectedResult = '<33>1 {0} TestHostname Send-SyslogMessage.Tests.ps1 {1} - - Test Syslog Message{2}' -f $ExpectedTimeStamp, $PID, "`n"
$null = Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -Hostname TestHostname -Transport TCP -FramingMethod Non-Transparent-Framing
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}

It 'sends using TCP transport with no framing' {
$ExpectedResult = '<33>1 {0} TestHostname Send-SyslogMessage.Tests.ps1 {1} - - Test Syslog Message' -f $ExpectedTimeStamp, $PID
$null = Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -Hostname TestHostname -Transport TCP -FramingMethod None
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}
}

Context 'Send-SyslogMessage = Encoding Tests' {

It 'Correctly encodes non-ASCII characters with UTF8' {
$message = 'Test Syslog Message with non-ASCII characters: áéíóú'
$null = Send-SyslogMessage -Server '127.0.0.1' -Message $message -Severity 'Alert' -Facility 'auth' -Encoding 'UTF8'
$decodedMessage = [System.Text.Encoding]::UTF8.GetString($script:TestResult)
$decodedMessage | Should BeLike '*áéíóú*'
}

It 'Handles ASCII encoding for non-ASCII characters' {
$message = 'Test Syslog Message with non-ASCII characters: áéíóú'
$null = Send-SyslogMessage -Server '127.0.0.1' -Message $message -Severity 'Alert' -Facility 'auth' -Encoding 'ASCII'
$decodedMessage = [System.Text.Encoding]::ASCII.GetString($script:TestResult)
$decodedMessage | Should Not BeLike '*áéíóú*'
}
}

Context 'Send-SyslogMessage = Application Name Selection' {
Expand All @@ -421,13 +454,13 @@ InModuleScope $script:ModuleName {
It 'Takes an Application Name as specified' {
$ExpectedResult = '<33>1 {0} TestHostname SomeRandomName {1} - - Test Syslog Message' -f $ExpectedTimeStamp, $PID
$null = Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth' -ApplicationName 'SomeRandomName'
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}

It 'uses myInvocation.ScriptName if one is available' {
$ExpectedResult = '<33>1 {0} TestHostname Send-SyslogMessage.Tests.ps1 {1} - - Test Syslog Message' -f $ExpectedTimeStamp, $PID
$null = Send-SyslogMessage -Server '127.0.0.1' -Message 'Test Syslog Message' -Severity 'Alert' -Facility 'auth'
$Encoding.GetString($script:TestResult) | should be $ExpectedResult
$EncodingText.GetString($script:TestResult) | should be $ExpectedResult
}
}

Expand All @@ -440,5 +473,4 @@ InModuleScope $script:ModuleName {
}
}
}

}