Skip to content

Improve validation for AET, IP & hostnames/domain names #261

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.

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

Merged
merged 2 commits into from
Nov 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
84 changes: 84 additions & 0 deletions src/Configuration/Test/ValidationExtensionsTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/

using System;
using System.Collections.Generic;
using FellowOakDicom;
using Monai.Deploy.InformaticsGateway.Api;
using Xunit;
Expand Down Expand Up @@ -202,5 +203,88 @@ public void SourceApplicationEntity_Valid()
}

#endregion SourceApplicationEntity.IsValid

#region IsAeTitleValid
[Theory]
[InlineData("123")]
[InlineData("MYAET")]
[InlineData("EAST-123-123")]
public void GivenAValidAETitle_WhenIIsAeTitleValid_ExpectToReturnTrue(string value)
{
var errors = new List<string>();
Assert.True(ValidationExtensions.IsAeTitleValid("test", value, errors));
Assert.Empty(errors);
}

[Theory]
[InlineData("")]
[InlineData(" ")]
[InlineData("AE\\")]
[InlineData("AE/")]
[InlineData("1$")]
[InlineData("A.E.T.")]
public void GivenAnInvalidAETitle_WhenIsAeTitleValid_ExpectToReturnFalse(string value)
{
var errors = new List<string>();
Assert.False(ValidationExtensions.IsAeTitleValid("test", value, errors));
Assert.NotEmpty(errors);
}

#endregion

#region IsValidHostNameIp
[Theory]
[InlineData("0.0.0.0")]
[InlineData("10.20.30.40")]
[InlineData("255.255.255.0")]
[InlineData("1.2.3.4")]
[InlineData("192.168.0.1")]
public void GivenAValidIpAddress_WhenIsValidHostNameIpIsCalled_ExpectToReturnTrue(string value)
{
var errors = new List<string>();
Assert.True(ValidationExtensions.IsValidHostNameIp("test", value, errors));
Assert.Empty(errors);
}

[Theory]
[InlineData("256.256.256.256")]
[InlineData("1.0")]
[InlineData("1")]
[InlineData("2.3.4")]
public void GivenAnInvalidIpAddress_WhenIsValidHostNameIpIsCalled_ExpectToReturnFalse(string value)
{
var errors = new List<string>();
Assert.False(ValidationExtensions.IsValidHostNameIp("test", value, errors));
Assert.NotEmpty(errors);
}

[Theory]
[InlineData("localhost")]
[InlineData("east-1")]
[InlineData("east-2.k8s.local")]
[InlineData("cloud.com")]
[InlineData("east.cloud.com")]
[InlineData("super.west.cloud.com")]
[InlineData("example-mongodb-0.example-mongodb-svc.monai-deploy.svc.cluster.local")]
public void GivenAValidHostName_WhenIsValidHostNameIpIsCalled_ExpectToReturnTrue(string value)
{
var errors = new List<string>();
Assert.True(ValidationExtensions.IsValidHostNameIp("test", value, errors));
Assert.Empty(errors);
}

[Theory]
[InlineData("localhost!")]
[InlineData("cloud@com")]
[InlineData("[email protected]")]
[InlineData("super/west.cloud.com")]
public void GivenAnInvalidHostName_WhenIsValidHostNameIpIsCalled_ExpectToReturnFalse(string value)
{
var errors = new List<string>();
Assert.False(ValidationExtensions.IsValidHostNameIp("test", value, errors));
Assert.NotEmpty(errors);
}

#endregion
}
}
15 changes: 13 additions & 2 deletions src/Configuration/ValidationExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

using System.Collections.Generic;
using System.Linq;
using System.Text.RegularExpressions;
using Ardalis.GuardClauses;
using FellowOakDicom;
using Monai.Deploy.InformaticsGateway.Api;
Expand Down Expand Up @@ -94,15 +95,25 @@ public static bool IsAeTitleValid(string source, string aeTitle, IList<string> v
{
Guard.Against.NullOrWhiteSpace(source);

if (!string.IsNullOrWhiteSpace(aeTitle) && aeTitle.Length <= 15) return true;
if (!string.IsNullOrWhiteSpace(aeTitle) &&
aeTitle.Length <= 15 &&
Regex.IsMatch(aeTitle, @"^[a-zA-Z0-9_\-]+$"))
{
return true;
}

validationErrors?.Add($"'{aeTitle}' is not a valid AE Title (source: {source}).");
return false;
}

public static bool IsValidHostNameIp(string source, string hostIp, IList<string> validationErrors = null)
{
if (!string.IsNullOrWhiteSpace(hostIp)) return true;
if (!string.IsNullOrWhiteSpace(hostIp) &&
(Regex.IsMatch(hostIp, @"^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}$") || // IP address
Regex.IsMatch(hostIp, @"^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$"))) // Host/domain name
{
return true;
}

validationErrors?.Add($"Invalid host name/IP address '{hostIp}' specified for {source}.");
return false;
Expand Down