Skip to content
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

Connect Enhancements #833

Merged
merged 9 commits into from
Oct 30, 2023
Merged

Connect Enhancements #833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
180c53e
Reconnect On Connect and Auth Error Handling
scottf Oct 26, 2023
d8cfdcb
fixed api docs
scottf Oct 26, 2023
90b8440
fixed encoding test - remove unecessary
scottf Oct 27, 2023
af72e19
TLS Handshake First
scottf Oct 27, 2023
9100944
replace corrupted conf file
scottf Oct 27, 2023
5970183
replace corrupted conf file (2)
scottf Oct 28, 2023
4e9a7e7
replace corrupted conf file (3)
scottf Oct 28, 2023
ddc472d
replace corrupted conf file (4)
scottf Oct 28, 2023
d6e81ca
Tls First Testing only runs on 2.10.3 or later
scottf Oct 28, 2023
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
64 changes: 43 additions & 21 deletions src/NATS.Client/Connection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1134,7 +1134,15 @@ private void processConnectInit(Srv s)
try
{
conn.ReceiveTimeout = opts.Timeout;
processExpectedInfo(s);
if (!opts.TlsFirst)
{
processExpectedInfo();
}
checkForSecure(s);
if (opts.TlsFirst)
{
processExpectedInfo();
}
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tls first, don't check/process the server info. checkForSecure used to be the last thing in processExpectedInfo. I moved it out so I could do it on either side. I supposed I could have done the change inside processExpectedInfo but this matches the java code

sendConnect();
}
catch (IOException ex)
Expand Down Expand Up @@ -1188,8 +1196,10 @@ internal bool connect(Srv s, out Exception exToThrow)
}
catch (NATSConnectionException ex)
{
if (!ex.IsAuthorizationViolationError() && !ex.IsAuthenticationExpiredError())
if (!ex.IsAuthenticationOrAuthorizationError())
{
throw;
}
scottf marked this conversation as resolved.
Show resolved Hide resolved

ScheduleErrorEvent(s, ex);

Expand Down Expand Up @@ -1222,7 +1232,7 @@ internal void ScheduleErrorEvent(object sender, NATSException ex, Subscription s
opts.AsyncErrorEventHandlerOrDefault(sender, new ErrEventArgs(this, subscription, ex.Message)));
}

internal void connect()
internal void connect(bool reconnectOnConnect)
{
Exception exToThrow = null;

Expand All @@ -1234,11 +1244,22 @@ internal void connect()
{
if (status != ConnState.CONNECTED)
{
if (exToThrow is NATSException)
throw exToThrow;
if (exToThrow != null)
throw new NATSConnectionException("Failed to connect", exToThrow);
throw new NATSNoServersException("Unable to connect to a server.");
if (reconnectOnConnect)
{
doReconnect();
}
scottf marked this conversation as resolved.
Show resolved Hide resolved
else
{
if (exToThrow is NATSException)
{
throw exToThrow;
}
if (exToThrow != null)
{
throw new NATSConnectionException("Failed to connect", exToThrow);
}
throw new NATSNoServersException("Unable to connect to a server.");
}
}
}
}
Expand All @@ -1248,17 +1269,20 @@ internal void connect()
// only be called after the INIT protocol has been received.
private void checkForSecure(Srv s)
{
// Check to see if we need to engage TLS
// Check for mismatch in setups
if (Opts.Secure && !info.TlsRequired)
{
throw new NATSSecureConnWantedException();
}
else if (info.TlsRequired && !Opts.Secure)
if (!Opts.TlsFirst)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if tlsFirst, it will always be secure

{
// If the server asks us to be secure, give it
// a shot.
Opts.Secure = true;
// Check to see if we need to engage TLS
// Check for mismatch in setups
if (Opts.Secure && !info.TlsRequired)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opts.Secure now returns true if TlsFirst is set. This explains the 2 tests later on

{
throw new NATSSecureConnWantedException();
}
else if (info.TlsRequired && !Opts.Secure)
{
// If the server asks us to be secure, give it
// a shot.
Opts.Secure = true;
}
}

// Need to rewrap with bufio if options tell us we need
Expand All @@ -1272,10 +1296,9 @@ private void checkForSecure(Srv s)
// processExpectedInfo will look for the expected first INFO message
// sent when a connection is established. The lock should be held entering.
// Caller must lock.
private void processExpectedInfo(Srv s)
private void processExpectedInfo()
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't need the Srv parameter since that work is now done outside this function

{
Control c;

try
{
conn.SendTimeout = 2;
Expand All @@ -1298,7 +1321,6 @@ private void processExpectedInfo(Srv s)

// do not notify listeners of server changes when we process the first INFO message
processInfo(c.args, false);
checkForSecure(s);
scottf marked this conversation as resolved.
Show resolved Hide resolved
}

internal void SendUnsub(long sid, int max)
Expand Down
45 changes: 27 additions & 18 deletions src/NATS.Client/ConnectionFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,16 @@ public ConnectionFactory() { }
/// </remarks>
/// <param name="url">A string containing the URL (or URLs) to the NATS Server. See the Remarks
/// section for more information.</param>
/// <param name="reconnectOnConnect">if true, the connection will treat the initial connection as any other and attempt reconnects on failure</param>
/// <returns>An <see cref="IConnection"/> object connected to the NATS server.</returns>
/// <exception cref="NATSNoServersException">No connection to a NATS Server could be established.</exception>
/// <exception cref="NATSConnectionException"><para>A timeout occurred connecting to a NATS Server.</para>
/// <para>-or-</para>
/// <para>An exception was encountered while connecting to a NATS Server. See <see cref="Exception.InnerException"/> for more
/// details.</para></exception>
public IConnection CreateConnection(string url)
public IConnection CreateConnection(string url, bool reconnectOnConnect = false)
{
return CreateConnection(GetDefaultOptions(url));
return CreateConnection(GetDefaultOptions(url), reconnectOnConnect);
scottf marked this conversation as resolved.
Show resolved Hide resolved
}

/// <summary>
Expand All @@ -57,20 +58,21 @@ public IConnection CreateConnection(string url)
/// <param name="url">A string containing the URL (or URLs) to the NATS Server. See the Remarks
/// section for more information.</param>
/// <param name="credentialsPath">The full path to a chained credentials file.</param>
/// <param name="reconnectOnConnect">if true, the connection will treat the initial connection as any other and attempt reconnects on failure</param>
/// <returns>An <see cref="IConnection"/> object connected to the NATS server.</returns>
/// <exception cref="NATSNoServersException">No connection to a NATS Server could be established.</exception>
/// <exception cref="NATSConnectionException"><para>A timeout occurred connecting to a NATS Server.</para>
/// <para>-or-</para>
/// <para>An exception was encountered while connecting to a NATS Server. See <see cref="Exception.InnerException"/> for more
/// details.</para></exception>
public IConnection CreateConnection(string url, string credentialsPath)
public IConnection CreateConnection(string url, string credentialsPath, bool reconnectOnConnect = false)
{
if (string.IsNullOrWhiteSpace(credentialsPath))
throw new ArgumentException("Invalid credentials path", nameof(credentialsPath));

Options opts = GetDefaultOptions(url);
opts.SetUserCredentials(credentialsPath);
return CreateConnection(opts);
return CreateConnection(opts, reconnectOnConnect);
}

/// <summary>
Expand All @@ -84,13 +86,14 @@ public IConnection CreateConnection(string url, string credentialsPath)
/// section for more information.</param>
/// <param name="jwt">The path to a user's public JWT credentials.</param>
/// <param name="privateNkey">The path to a file for user user's private Nkey seed.</param>
/// <param name="reconnectOnConnect">if true, the connection will treat the initial connection as any other and attempt reconnects on failure</param>
/// <returns>An <see cref="IConnection"/> object connected to the NATS server.</returns>
/// <exception cref="NATSNoServersException">No connection to a NATS Server could be established.</exception>
/// <exception cref="NATSConnectionException"><para>A timeout occurred connecting to a NATS Server.</para>
/// <para>-or-</para>
/// <para>An exception was encountered while connecting to a NATS Server. See <see cref="Exception.InnerException"/> for more
/// details.</para></exception>
public IConnection CreateConnection(string url, string jwt, string privateNkey)
public IConnection CreateConnection(string url, string jwt, string privateNkey, bool reconnectOnConnect = false)
{
if (string.IsNullOrWhiteSpace(jwt))
throw new ArgumentException("Invalid jwt path", nameof(jwt));
Expand All @@ -99,7 +102,7 @@ public IConnection CreateConnection(string url, string jwt, string privateNkey)

Options opts = GetDefaultOptions(url);
opts.SetUserCredentials(jwt, privateNkey);
return CreateConnection(opts);
return CreateConnection(opts, reconnectOnConnect);
}

/// <summary>
Expand Down Expand Up @@ -127,50 +130,53 @@ public static Options GetDefaultOptions(string server = null)
/// </remarks>
/// <param name="url">A string containing the URL (or URLs) to the NATS Server. See the Remarks
/// section for more information.</param>
/// <param name="reconnectOnConnect">if true, the connection will treat the initial connection as any other and attempt reconnects on failure</param>
/// <returns>An <see cref="IConnection"/> object connected to the NATS server.</returns>
/// <exception cref="NATSNoServersException">No connection to a NATS Server could be established.</exception>
/// <exception cref="NATSConnectionException"><para>A timeout occurred connecting to a NATS Server.</para>
/// <para>-or-</para>
/// <para>An exception was encountered while connecting to a NATS Server. See <see cref="Exception.InnerException"/> for more
/// details.</para></exception>
public IConnection CreateSecureConnection(string url)
public IConnection CreateSecureConnection(string url, bool reconnectOnConnect = false)
{
Options opts = GetDefaultOptions(url);
opts.Secure = true;
return CreateConnection(opts);
return CreateConnection(opts, reconnectOnConnect);
}

/// <summary>
/// Create a connection to the NATs server using the default options.
/// </summary>
/// <param name="reconnectOnConnect">if true, the connection will treat the initial connection as any other and attempt reconnects on failure</param>
/// <returns>An <see cref="IConnection"/> object connected to the NATS server.</returns>
/// <exception cref="NATSNoServersException">No connection to a NATS Server could be established.</exception>
/// <exception cref="NATSConnectionException"><para>A timeout occurred connecting to a NATS Server.</para>
/// <para>-or-</para>
/// <para>An exception was encountered while connecting to a NATS Server. See <see cref="Exception.InnerException"/> for more
/// details.</para></exception>
/// <seealso cref="GetDefaultOptions"/>
public IConnection CreateConnection()
public IConnection CreateConnection(bool reconnectOnConnect = false)
{
return CreateConnection(GetDefaultOptions());
return CreateConnection(GetDefaultOptions(), reconnectOnConnect);
}

/// <summary>
/// Create a connection to a NATS Server defined by the given options.
/// </summary>
/// <param name="opts">The NATS client options to use for this connection.</param>
/// <param name="reconnectOnConnect">if true, the connection will treat the initial connection as any other and attempt reconnects on failure</param>
/// <returns>An <see cref="IConnection"/> object connected to the NATS server.</returns>
/// <exception cref="NATSNoServersException">No connection to a NATS Server could be established.</exception>
/// <exception cref="NATSConnectionException"><para>A timeout occurred connecting to a NATS Server.</para>
/// <para>-or-</para>
/// <para>An exception was encountered while connecting to a NATS Server. See <see cref="Exception.InnerException"/> for more
/// details.</para></exception>
public IConnection CreateConnection(Options opts)
public IConnection CreateConnection(Options opts, bool reconnectOnConnect = false)
{
Connection nc = new Connection(opts);
try
{
nc.connect();
nc.connect(reconnectOnConnect);
}
catch (Exception)
{
Expand All @@ -183,16 +189,17 @@ public IConnection CreateConnection(Options opts)
/// <summary>
/// Attempt to connect to the NATS server, with an encoded connection, using the default options.
/// </summary>
/// <param name="reconnectOnConnect">if true, the connection will treat the initial connection as any other and attempt reconnects on failure</param>
/// <returns>An <see cref="IEncodedConnection"/> object connected to the NATS server.</returns>
/// <seealso cref="GetDefaultOptions"/>
/// <exception cref="NATSNoServersException">No connection to a NATS Server could be established.</exception>
/// <exception cref="NATSConnectionException"><para>A timeout occurred connecting to a NATS Server.</para>
/// <para>-or-</para>
/// <para>An exception was encountered while connecting to a NATS Server. See <see cref="Exception.InnerException"/> for more
/// details.</para></exception>
public IEncodedConnection CreateEncodedConnection()
public IEncodedConnection CreateEncodedConnection(bool reconnectOnConnect = false)
{
return CreateEncodedConnection(GetDefaultOptions());
return CreateEncodedConnection(GetDefaultOptions(), reconnectOnConnect);
}

/// <summary>
Expand All @@ -201,6 +208,7 @@ public IEncodedConnection CreateEncodedConnection()
/// <remarks>
/// <para><paramref name="url"/> can contain username/password semantics.
/// Comma seperated arrays are also supported, e.g. urlA, urlB.</para>
/// <param name="reconnectOnConnect">if true, the connection will treat the initial connection as any other and attempt reconnects on failure</param>
/// </remarks>
/// <param name="url">A string containing the URL (or URLs) to the NATS Server. See the Remarks
/// section for more information.</param>
Expand All @@ -210,27 +218,28 @@ public IEncodedConnection CreateEncodedConnection()
/// <para>-or-</para>
/// <para>An exception was encountered while connecting to a NATS Server. See <see cref="Exception.InnerException"/> for more
/// details.</para></exception>
public IEncodedConnection CreateEncodedConnection(string url)
public IEncodedConnection CreateEncodedConnection(string url, bool reconnectOnConnect = false)
{
return CreateEncodedConnection(GetDefaultOptions(url));
return CreateEncodedConnection(GetDefaultOptions(url), reconnectOnConnect);
}

/// <summary>
/// Attempt to connect to the NATS server, with an encoded connection, using the given options.
/// </summary>
/// <param name="opts">The NATS client options to use for this connection.</param>
/// <returns>An <see cref="IEncodedConnection"/> object connected to the NATS server.</returns>
/// <param name="reconnectOnConnect">if true, the connection will treat the initial connection as any other and attempt reconnects on failure</param>
/// <exception cref="NATSNoServersException">No connection to a NATS Server could be established.</exception>
/// <exception cref="NATSConnectionException"><para>A timeout occurred connecting to a NATS Server.</para>
/// <para>-or-</para>
/// <para>An exception was encountered while connecting to a NATS Server. See <see cref="Exception.InnerException"/> for more
/// details.</para></exception>
public IEncodedConnection CreateEncodedConnection(Options opts)
public IEncodedConnection CreateEncodedConnection(Options opts, bool reconnectOnConnect = false)
{
EncodedConnection nc = new EncodedConnection(opts);
try
{
nc.connect();
nc.connect(reconnectOnConnect);
}
catch (Exception)
{
Expand Down
15 changes: 7 additions & 8 deletions src/NATS.Client/Exceptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,14 @@ public class NATSConnectionException : NATSException
{
public NATSConnectionException(string err) : base(err) { }
public NATSConnectionException(string err, Exception innerEx) : base(err, innerEx) { }
}

internal static class NATSConnectionExceptionExtensions
{
internal static bool IsAuthorizationViolationError(this NATSConnectionException ex)
=> ex?.Message.Equals("'authorization violation'", StringComparison.OrdinalIgnoreCase) == true;

internal static bool IsAuthenticationExpiredError(this NATSConnectionException ex)
=> ex?.Message.Equals("'authentication expired'", StringComparison.OrdinalIgnoreCase) == true;
public bool IsAuthenticationOrAuthorizationError()
{
string lowerMessage = Message.ToLower();
return lowerMessage.Contains("user authentication")
|| lowerMessage.Contains("authorization violation")
|| lowerMessage.Contains("authentication expired");
}
scottf marked this conversation as resolved.
Show resolved Hide resolved
}

/// <summary>
Expand Down
Loading
Loading