Skip to content

Release 1.18 #1621

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

Merged
merged 4 commits into from
Jun 6, 2022
Merged

Release 1.18 #1621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
de6672f
code cleanup before refactor parser (#1617)
terencefan May 26, 2022
621886c
Add authtypes (azure, azure.msi, azure.app) (#1616)
terencefan May 27, 2022
9534c1f
Promote client connection trace to info (#1620)
vicancy Jun 2, 2022
53252a4
Merge branch 'master' into release-1.18
vicancy Jun 6, 2022
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
144 changes: 113 additions & 31 deletions src/Microsoft.Azure.SignalR.Common/Utilities/ConnectionStringParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,69 +11,81 @@ namespace Microsoft.Azure.SignalR
internal static class ConnectionStringParser
{
private const string AccessKeyProperty = "accesskey";

private const string AuthTypeProperty = "authtype";

private const string ClientCertProperty = "clientCert";
private const string ClientEndpointProperty = "ClientEndpoint";

private const string ClientEndpointProperty = "clientEndpoint";

private const string ClientIdProperty = "clientId";

private const string ClientSecretProperty = "clientSecret";

private const string EndpointProperty = "endpoint";
private const string ServerEndpoint = "ServerEndpoint";

private const string InvalidVersionValueFormat = "Version {0} is not supported.";

private const string PortProperty = "port";

private const string ServerEndpoint = "ServerEndpoint";

// For SDK 1.x, only support Azure SignalR Service 1.x
private const string SupportedVersion = "1";

private const string TenantIdProperty = "tenantId";

private const string TypeAzure = "azure";

private const string TypeAzureAD = "aad";

private const string TypeAzureApp = "azure.app";

private const string TypeAzureMsi = "azure.msi";

private const string ValidVersionRegex = "^" + SupportedVersion + @"\.\d+(?:[\w-.]+)?$";

private const string VersionProperty = "version";
private static readonly string InvalidPortValue = $"Invalid value for {PortProperty} property.";

private static readonly string InvalidClientEndpointProperty = $"Invalid value for {ClientEndpointProperty} property, it must be a valid URI.";

private static readonly string InvalidEndpointProperty = $"Invalid value for {EndpointProperty} property, it must be a valid URI.";

private static readonly string InvalidPortValue = $"Invalid value for {PortProperty} property, it must be an positive integer between (0, 65536)";

private static readonly char[] KeyValueSeparator = { '=' };

private static readonly string MissingAccessKeyProperty =
$"{AccessKeyProperty} is required.";

private static readonly string MissingClientIdProperty =
$"Connection string missing required properties {ClientIdProperty}.";

private static readonly string MissingClientSecretProperty =
$"Connection string missing required properties {ClientSecretProperty} or {ClientCertProperty}.";

private static readonly string MissingEndpointProperty =
$"Connection string missing required properties {EndpointProperty}.";

private static readonly string MissingTenantIdProperty =
$"Connection string missing required properties {TenantIdProperty}.";

private static readonly char[] PropertySeparator = { ';' };

internal static ParsedConnectionString Parse(string connectionString)
{
var properties = connectionString.Split(PropertySeparator, StringSplitOptions.RemoveEmptyEntries);
if (properties.Length < 2)
{
throw new ArgumentException(MissingEndpointProperty, nameof(connectionString));
}

var dict = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
foreach (var property in properties)
{
var kvp = property.Split(KeyValueSeparator, 2);
if (kvp.Length != 2) continue;

var key = kvp[0].Trim();
if (dict.ContainsKey(key))
{
throw new ArgumentException($"Duplicate properties found in connection string: {key}.");
}

dict.Add(key, kvp[1].Trim());
}
var dict = ToDictionary(connectionString);

// parse and validate endpoint.
if (!dict.TryGetValue(EndpointProperty, out var endpoint))
{
throw new ArgumentException(MissingEndpointProperty, nameof(connectionString));
throw new ArgumentException(MissingEndpointProperty, nameof(endpoint));
}
endpoint = endpoint.TrimEnd('/');

if (!TryGetEndpointUri(endpoint, out var endpointUri))
{
throw new ArgumentException($"Endpoint property in connection string is not a valid URI: {dict[EndpointProperty]}.");
throw new ArgumentException(InvalidEndpointProperty, nameof(endpoint));
}
var builder = new UriBuilder(endpointUri);

Expand All @@ -83,38 +95,43 @@ internal static ParsedConnectionString Parse(string connectionString)
{
if (!Regex.IsMatch(v, ValidVersionRegex))
{
throw new ArgumentException(string.Format(InvalidVersionValueFormat, v), nameof(connectionString));
throw new ArgumentException(string.Format(InvalidVersionValueFormat, v), nameof(version));
}
version = v;
}

// parse and validate port.
if (dict.TryGetValue(PortProperty, out var s))
{
if (int.TryParse(s, out var p) && p > 0 && p <= 0xFFFF)
if (int.TryParse(s, out var port) && port > 0 && port <= 0xFFFF)
{
builder.Port = p;
builder.Port = port;
}
else
{
throw new ArgumentException(InvalidPortValue, nameof(connectionString));
throw new ArgumentException(InvalidPortValue, nameof(port));
}
}

Uri clientEndpointUri = null;

// parse and validate clientEndpoint.
if (dict.TryGetValue(ClientEndpointProperty, out var clientEndpoint))
{
if (!TryGetEndpointUri(clientEndpoint, out clientEndpointUri))
{
throw new ArgumentException($"{ClientEndpointProperty} property in connection string is not a valid URI: {clientEndpoint}.");
throw new ArgumentException(InvalidClientEndpointProperty, nameof(clientEndpoint));
}
}

// try building accesskey.
dict.TryGetValue(AuthTypeProperty, out var type);
var accessKey = type?.ToLower() switch
{
"aad" => BuildAadAccessKey(builder.Uri, dict),
TypeAzureAD => BuildAadAccessKey(builder.Uri, dict),
TypeAzure => BuildAzureAccessKey(builder.Uri, dict),
TypeAzureApp => BuildAzureAppAccessKey(builder.Uri, dict),
TypeAzureMsi => BuildAzureMsiAccessKey(builder.Uri, dict),
_ => BuildAccessKey(builder.Uri, dict),
};

Expand Down Expand Up @@ -180,5 +197,70 @@ private static AccessKey BuildAccessKey(Uri uri, Dictionary<string, string> dict
}
throw new ArgumentException(MissingAccessKeyProperty, AccessKeyProperty);
}

private static AccessKey BuildAzureAccessKey(Uri uri, Dictionary<string, string> dict)
{
return new AadAccessKey(uri, new DefaultAzureCredential());
}

private static AccessKey BuildAzureAppAccessKey(Uri uri, Dictionary<string, string> dict)
{
if (!dict.TryGetValue(ClientIdProperty, out var clientId))
{
throw new ArgumentException(MissingClientIdProperty, ClientIdProperty);
}

if (!dict.TryGetValue(TenantIdProperty, out var tenantId))
{
throw new ArgumentException(MissingTenantIdProperty, TenantIdProperty);
}

if (dict.TryGetValue(ClientSecretProperty, out var clientSecret))
{
return new AadAccessKey(uri, new ClientSecretCredential(tenantId, clientId, clientSecret));
}
else if (dict.TryGetValue(ClientCertProperty, out var clientCertPath))
{
return new AadAccessKey(uri, new ClientCertificateCredential(tenantId, clientId, clientCertPath));
}
throw new ArgumentException(MissingClientSecretProperty, ClientSecretProperty);
}

private static AccessKey BuildAzureMsiAccessKey(Uri uri, Dictionary<string, string> dict)
{
if (dict.TryGetValue(ClientIdProperty, out var clientId))
{
return new AadAccessKey(uri, new ManagedIdentityCredential(clientId));
}
return new AadAccessKey(uri, new ManagedIdentityCredential());
}

private static Dictionary<string, string> ToDictionary(string connectionString)
{
var properties = connectionString.Split(PropertySeparator, StringSplitOptions.RemoveEmptyEntries);
if (properties.Length < 2)
{
throw new ArgumentException(MissingEndpointProperty, nameof(connectionString));
}

var dict = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
foreach (var property in properties)
{
var kvp = property.Split(KeyValueSeparator, 2);
if (kvp.Length != 2)
{
continue;
}

var key = kvp[0].Trim();
if (dict.ContainsKey(key))
{
throw new ArgumentException($"Duplicate properties found in connection string: {key}.");
}

dict.Add(key, kvp[1].Trim());
}
return dict;
}
}
}
4 changes: 2 additions & 2 deletions src/Microsoft.Azure.SignalR/ServerConnections/ServiceConnection.Log.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ private static class Log
LoggerMessage.Define<ulong?, string>(LogLevel.Warning, new EventId(10, "ReceivedMessageForNonExistentConnection"), "Received message {tracingId} for connection {TransportConnectionId} which does not exist.");

private static readonly Action<ILogger, string, Exception> _connectedStarting =
LoggerMessage.Define<string>(LogLevel.Debug, new EventId(11, "ConnectedStarting"), "Connection {TransportConnectionId} started.");
LoggerMessage.Define<string>(LogLevel.Information, new EventId(11, "ConnectedStarting"), "Connection {TransportConnectionId} started.");

private static readonly Action<ILogger, string, Exception> _connectedEnding =
LoggerMessage.Define<string>(LogLevel.Debug, new EventId(12, "ConnectedEnding"), "Connection {TransportConnectionId} ended.");
LoggerMessage.Define<string>(LogLevel.Information, new EventId(12, "ConnectedEnding"), "Connection {TransportConnectionId} ended.");

private static readonly Action<ILogger, string, Exception> _closeConnection =
LoggerMessage.Define<string>(LogLevel.Debug, new EventId(13, "CloseConnection"), "Sending close connection message to the service for {TransportConnectionId}.");
Expand Down
Loading