/* ======================================================================== * Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved. * * OPC Foundation MIT License 1.00 * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation * files (the "Software"), to deal in the Software without * restriction, including without limitation the rights to use, * copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following * conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. * * The complete license agreement can be found here: * http://opcfoundation.org/License/MIT/1.00/ * ======================================================================*/ using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Text; using System.Threading; using System.Threading.Tasks; using Microsoft.Extensions.Logging; using Opc.Ua; using Opc.Ua.Configuration; using Opc.Ua.Security.Certificates; using Opc.Ua.Server; namespace Quickstarts { public class UAServer where T : StandardServer { public IApplicationInstance Application { get; private set; } = null!; public ApplicationConfiguration Configuration => Application.ApplicationConfiguration!; public bool AutoAccept { get; set; } public char[]? Password { get; set; } public ExitCode ExitCode { get; private set; } public T? Server { get; private set; } /// /// Ctor of the server. /// /// The telemetry context. public UAServer(ITelemetryContext telemetry, Func factory) { m_factory = factory; m_telemetry = telemetry; m_logger = telemetry.CreateLogger>(); } /// /// Load the application configuration. /// /// public async Task LoadAsync(string applicationName, string configSectionName) { try { ExitCode = ExitCode.ErrorNotStarted; ApplicationInstance.MessageDlg = new ApplicationMessageDlg(); var passwordProvider = new CertificatePasswordProvider(Password); Application = new ApplicationInstance(m_telemetry) { ApplicationName = applicationName, ApplicationType = ApplicationType.Server, ConfigSectionName = configSectionName, CertificatePasswordProvider = passwordProvider }; // load the application configuration. await Application.LoadApplicationConfigurationAsync(false).ConfigureAwait(false); } catch (Exception ex) { throw new ErrorExitException(ex.Message, ExitCode); } } /// /// Load the application configuration. /// /// public async Task CheckCertificateAsync(bool renewCertificate) { try { ApplicationConfiguration config = Application.ApplicationConfiguration!; if (renewCertificate) { await Application.DeleteApplicationInstanceCertificateAsync().ConfigureAwait(false); } // check the application certificate. bool haveAppCertificate = await Application .CheckApplicationInstanceCertificatesAsync(false) .ConfigureAwait(false); if (!haveAppCertificate) { throw new ErrorExitException("Application instance certificate invalid!"); } if (!config.SecurityConfiguration.AutoAcceptUntrustedCertificates) { config.CertificateManager.AcceptError = AcceptCertificate; } } catch (Exception ex) { throw new ErrorExitException(ex.Message, ExitCode); } } /// /// Create server instance and add node managers. /// /// public void Create(ArrayOf nodeManagerFactories) { try { // create the server. Server = m_factory(m_telemetry); foreach (INodeManagerFactory factory in nodeManagerFactories) { Server.AddNodeManager(factory); } } catch (Exception ex) { throw new ErrorExitException(ex.Message, ExitCode); } } /// /// Start the server. /// /// public async Task StartAsync(CancellationToken ct = default) { try { // create the server. Server ??= m_factory(m_telemetry); // start the server await Application.StartAsync(Server, ct).ConfigureAwait(false); // save state ExitCode = ExitCode.ErrorRunning; // print endpoint info foreach (string? endpoint in Application.Server! .GetEndpoints() .ConvertAll(e => e.EndpointUrl) .ToList() .Distinct()) { Console.WriteLine(endpoint); } // start the status thread m_status = Task.Run(StatusThreadAsync, default); // print notification on session events Server.CurrentInstance.SessionManager.SessionActivated += EventStatus; Server.CurrentInstance.SessionManager.SessionClosing += EventStatus; Server.CurrentInstance.SessionManager.SessionCreated += EventStatus; } catch (Exception ex) { throw new ErrorExitException(ex.Message, ExitCode); } } /// /// Stops the server. /// /// public async Task StopAsync(CancellationToken ct = default) { try { if (Server != null) { using T server = Server; // Stop status thread which monitores the server property. Server = null; await m_status.ConfigureAwait(false); // Stop server and dispose await server.StopAsync(ct).ConfigureAwait(false); } ExitCode = ExitCode.Ok; } catch (Exception ex) { throw new ErrorExitException(ex.Message, ExitCode.ErrorStopping); } } /// /// Per-error accept callback used when AutoAcceptUntrustedCertificates is false. /// private bool AcceptCertificate(Certificate certificate, ServiceResult error) { if (error.StatusCode == StatusCodes.BadCertificateUntrusted && AutoAccept) { m_logger.LogInformation( "Accepted Certificate: [{Subject}] [{Thumbprint}]", certificate.Subject, certificate.Thumbprint ); return true; } m_logger.LogInformation( "Rejected Certificate: {Error} [{Subject}] [{Thumbprint}]", error, certificate.Subject, certificate.Thumbprint ); return false; } /// /// Update the session status. /// private void EventStatus(ISession session, SessionEventReason reason) { m_lastEventTime = DateTime.UtcNow; LogSessionStatusFull(session, reason.ToString()); } /// /// Output the status of a connected session. /// private void LogSessionStatusLastContact(ISession session, string reason) { lock (session.DiagnosticsLock) { m_logger.LogInformation( "{Reason,9}:{Session,20}:Last Event:{LastContactTime:HH:mm:ss}", reason, session.SessionDiagnostics.SessionName, session.SessionDiagnostics.ClientLastContactTime.ToLocalTime() ); } } /// /// Output the status of a connected session. /// private void LogSessionStatusFull(ISession session, string reason) { lock (session.DiagnosticsLock) { m_logger.LogInformation( "{Reason,9}:{Session,20}:Last Event:{LastContactTime:HH:mm:ss}:{UserIdentity,20}:{SessionId}", reason, session.SessionDiagnostics.SessionName, session.SessionDiagnostics.ClientLastContactTime.ToLocalTime(), session.Identity?.DisplayName ?? "Anonymous", session.Id ); } } /// /// Status thread, prints connection status every 10 seconds. /// private async Task StatusThreadAsync() { while (Server != null) { if (DateTime.UtcNow - m_lastEventTime > TimeSpan.FromMilliseconds(10000)) { IList sessions = Server.CurrentInstance.SessionManager.GetSessions(); for (int ii = 0; ii < sessions.Count; ii++) { ISession session = sessions[ii]; LogSessionStatusLastContact(session, "-Status-"); } m_lastEventTime = DateTime.UtcNow; } await Task.Delay(1000).ConfigureAwait(false); } } /// /// A dialog which asks for user input. /// public class ApplicationMessageDlg : IApplicationMessageDlg { private readonly TextWriter m_output; private string m_message = string.Empty; private bool m_ask; public ApplicationMessageDlg(TextWriter? output = null) { m_output = output ?? Console.Out; } public override void Message(string text, bool ask) { m_message = text; m_ask = ask; } public override async Task ShowAsync() { if (m_ask) { var message = new StringBuilder(m_message); message.Append(" (y/n, default y): "); m_output.Write(message.ToString()); try { ConsoleKeyInfo result = Console.ReadKey(); m_output.WriteLine(); return await Task.FromResult(result.KeyChar is 'y' or 'Y' or '\r') .ConfigureAwait(false); } catch { // intentionally fall through } } else { m_output.WriteLine(m_message); } return await Task.FromResult(true).ConfigureAwait(false); } } private readonly Func m_factory; private readonly ITelemetryContext m_telemetry; private readonly ILogger m_logger; private Task m_status = Task.CompletedTask; private DateTime m_lastEventTime; } }