[NEW-FEATURE] External Authorization to work with cyclic PLC data (#513)

github-actions[bot] · PTKu · web-flow · commit 6be92d8538ac · 2022-09-09T08:02:11.000+02:00
* Create draft PR for #512 * external authentication added possibility to use plc variable as a source of authentication token * added basic tests for the token providers Co-authored-by: PTKu <PTKu@users.noreply.github.com> Co-authored-by: Peter <61538034+PTKu@users.noreply.github.com>
diff --git a/src/TcOpen.Hammer/HMI/App.xaml.cs b/src/TcOpen.Hammer/HMI/App.xaml.cs
@@ -13,6 +13,7 @@
 using Serilog.Sinks;
 using TcOpen.Inxton.TcoCore.Wpf;
 using System.Windows.Media;
+using TcOpen.Inxton.Local.Security.Readers;
 
 namespace HMI
 {
@@ -71,6 +72,11 @@ public App()
             // Initialize logger
             Entry.PlcHammer.TECH_MAIN._app._logger.StartLoggingMessages(TcoCore.eMessageCategory.Info);
 
+            // Initialize external authentication
+            authenticationService.ExternalAuthorization = ExternalTokenAuthorization.CreatePlcTokenReader
+                                                            (Entry.PlcHammer.TECH_MAIN._app._station001._externalToken, 
+                                                            Entry.PlcHammer.TECH_MAIN._app._station001._externalTokenPresence);
+
             // Set up data exchange
             switch (answer)
             {
diff --git a/src/TcOpen.Hammer/HMI/PlcHammer.Hmi.csproj b/src/TcOpen.Hammer/HMI/PlcHammer.Hmi.csproj
@@ -13,6 +13,7 @@
   <ItemGroup>
     <ProjectReference Include="..\..\Serilog.Sinks.MQTT\src\Serilog.Sinks.MQTT\Serilog.Sinks.MQTT.csproj" />
     <ProjectReference Include="..\..\TcoInspectors\src\Wpf\TcOpen.Inxton.TcoInspectors.Wpf\TcOpen.Inxton.TcoInspectors.Wpf.csproj" />
+    <ProjectReference Include="..\..\TcOpen.Inxton\src\TcOpen.Inxton.Local.Security.Externals\TcOpen.Inxton.Local.Security.Readers.csproj" />
     <ProjectReference Include="..\..\_packaging\TcOpen.Group.Wpf\TcOpen.Group.Wpf.csproj" />
     <ProjectReference Include="..\PlcHammerConnector\PlcHammerConnector.csproj" />
   </ItemGroup>
diff --git a/src/TcOpen.Hammer/TcOpenHammer/TcOpenHammer/PlcHammer/POUs/Station001/Station001.TcPOU b/src/TcOpen.Hammer/TcOpenHammer/TcOpenHammer/PlcHammer/POUs/Station001/Station001.TcPOU
@@ -20,6 +20,9 @@ VAR
 	_technologicalDataManager : TechnologicalDataManager(THIS^);
 	_currentMode : enumModes := enumModes.Idle;
 	_checkers : Checkers(THIS^);
+	
+	_externalToken : STRING;
+	_externalTokenPresence : BOOL;
 END_VAR]]></Declaration>
     <Implementation>
       <ST><![CDATA[_components();
@@ -166,39 +169,5 @@ END_VAR
         </Implementation>
       </Get>
     </Property>
-    <LineIds Name="Station001">
-      <LineId Id="3" Count="22" />
-      <LineId Id="2" Count="0" />
-    </LineIds>
-    <LineIds Name="Station001.AutomatMode">
-      <LineId Id="3" Count="6" />
-      <LineId Id="2" Count="0" />
-    </LineIds>
-    <LineIds Name="Station001.Checkers.Get">
-      <LineId Id="2" Count="0" />
-    </LineIds>
-    <LineIds Name="Station001.Components.Get">
-      <LineId Id="2" Count="0" />
-    </LineIds>
-    <LineIds Name="Station001.GroundMode">
-      <LineId Id="3" Count="10" />
-      <LineId Id="2" Count="0" />
-    </LineIds>
-    <LineIds Name="Station001.ProcessRecepie.Get">
-      <LineId Id="2" Count="0" />
-    </LineIds>
-    <LineIds Name="Station001.ProcessTraceabilty.Get">
-      <LineId Id="2" Count="0" />
-    </LineIds>
-    <LineIds Name="Station001.ProductionData.Get">
-      <LineId Id="2" Count="0" />
-    </LineIds>
-    <LineIds Name="Station001.ServiceMode">
-      <LineId Id="3" Count="7" />
-      <LineId Id="2" Count="0" />
-    </LineIds>
-    <LineIds Name="Station001.TechnologicalDataManager.Get">
-      <LineId Id="2" Count="0" />
-    </LineIds>
   </POU>
 </TcPlcObject>
diff --git a/src/TcOpen.Inxton/src/Security/ExternalAuthorization.cs b/src/TcOpen.Inxton/src/Security/ExternalAuthorization.cs
@@ -23,7 +23,7 @@ private void ChangeToken(string token)
         }
         
         public IUser RequestAuthorization(string token)
-        {
+        {            
             AuthorizationErrorMessage = string.Empty;
             try
             {
diff --git a/src/TcOpen.Inxton/src/TcOpen.Inxton.Local.Security.Externals/ExternalTokenAuthorization.cs b/src/TcOpen.Inxton/src/TcOpen.Inxton.Local.Security.Externals/ExternalTokenAuthorization.cs
@@ -33,5 +33,18 @@ public static ExternalAuthorization CreateComReader(string portName, int baudRat
         {
            return new ExternalTokenAuthorization(new ComPortTokenProvider(portName, baudRate, dataBits, stopBits, parity));
         }
+
+        /// <summary>
+        /// Creates external authorization for token present in a string variable the PLC program.
+        /// </summary>
+        /// <param name="tokenValue">Onliner string containing the value of authentication token.</param>
+        /// <param name="tokenPresence">Onliner bool indicating presence of authentication token.</param>
+        /// <returns></returns>
+        public static ExternalAuthorization CreatePlcTokenReader(Vortex.Connector.ValueTypes.OnlinerString tokenValue,
+                                                                 Vortex.Connector.ValueTypes.OnlinerBool tokenPresence)
+        {
+            return new ExternalTokenAuthorization(new PlcTokenReader(tokenValue, tokenPresence));
+        }
+
     }
 }
diff --git a/src/TcOpen.Inxton/src/TcOpen.Inxton.Local.Security.Externals/PlcTokenReader/PlcTokenReader.cs b/src/TcOpen.Inxton/src/TcOpen.Inxton.Local.Security.Externals/PlcTokenReader/PlcTokenReader.cs
@@ -0,0 +1,74 @@
+﻿using System;
+using System.IO.Ports;
+using TcOpen.Inxton.Security;
+using Vortex.Connector;
+using Vortex.Connector.ValueTypes;
+
+namespace TcOpen.Inxton.Local.Security
+{
+    /// <summary>
+    ///  Provides access to authentication token data from the PLC.
+    /// </summary>
+    public class PlcTokenReader : ITokenProvider
+    {
+
+        private readonly OnlinerString _valueToken;
+        private readonly OnlinerBool _tokenPresence;
+
+        /// <summary>
+        /// Creates new instance of <see cref="PlcTokenReader"/>
+        /// </summary>
+        /// <param name="valueToken">Onliner of the variable containing value of the token</param>
+        /// <param name="tokenPresence">Onliner indicating whether the authentication token is present (inserted/active)</param>
+        public PlcTokenReader(OnlinerString valueToken, OnlinerBool tokenPresence)
+        {
+            _valueToken = valueToken;
+            _tokenPresence = tokenPresence;
+
+            _valueToken?.Subscribe(TagDataChanged);
+            _tokenPresence?.Subscribe(TagDataPresence);
+        }
+
+        public void SetTokenReceivedAction(Action<string> tokenReceivedAction)
+        {
+            IncomingTokenAction = tokenReceivedAction;
+        }
+                
+        public Action<string> IncomingTokenAction;
+      
+        
+        void TagDataChanged(IValueTag sender, ValueChangedEventArgs args)
+        {
+            try
+            {
+                if (_tokenPresence.Synchron)
+                {
+                    IncomingTokenAction?.Invoke(_valueToken.Cyclic);
+                }
+                else
+                {
+                    SecurityManager.Manager.Service.DeAuthenticateCurrentUser();
+                }
+            }
+            catch (Exception)
+            {
+                throw;
+            }
+        }
+
+        void TagDataPresence(IValueTag sender, ValueChangedEventArgs args)
+        {
+            try
+            {
+                if(_tokenPresence.Synchron == false)
+                { 
+                    SecurityManager.Manager.Service.DeAuthenticateCurrentUser();
+                }
+            }
+            catch (Exception)
+            {
+                throw;
+            }
+        }
+    }
+}
diff --git a/src/TcOpen.Inxton/tests/TcOpen.Inxton.Local.Security/TcOpen.Inxton.Local.Security.ReadersTests/UnitTest1.cs b/src/TcOpen.Inxton/tests/TcOpen.Inxton.Local.Security/TcOpen.Inxton.Local.Security.ReadersTests/UnitTest1.cs
@@ -1,4 +1,6 @@
 using NUnit.Framework;
+using System;
+using TcOpen.Inxton.Local.Security.Readers;
 
 namespace TcOpen.Inxton.Local.Security.ReadersTests
 {
@@ -10,9 +12,19 @@ public void Setup()
         }
 
         [Test]
-        public void Test1()
+        public void CreatePlcTokenReader()
         {
-            Assert.Pass();
+            var tokenValueSource = new Vortex.Connector.ValueTypes.OnlinerString();
+            var tokenPresence = new Vortex.Connector.ValueTypes.OnlinerBool();
+            var reader = ExternalTokenAuthorization.CreatePlcTokenReader(tokenValueSource, tokenPresence);            
+        }
+
+        [Test]
+        public void CreateComTokenReader()
+        {
+            var tokenValueSource = new Vortex.Connector.ValueTypes.OnlinerString();
+            var tokenPresence = new Vortex.Connector.ValueTypes.OnlinerBool();
+            Assert.Throws<System.IO.IOException>(() => ExternalTokenAuthorization.CreateComReader("COM1"));            
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ private void ChangeToken(string token)`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`public IUser RequestAuthorization(string token)`
`26`		`- {`
	`26`	`+ {`
`27`	`27`	`AuthorizationErrorMessage = string.Empty;`
`28`	`28`	`try`
`29`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -33,5 +33,18 @@ public static ExternalAuthorization CreateComReader(string portName, int baudRat`
`33`	`33`	`{`
`34`	`34`	`return new ExternalTokenAuthorization(new ComPortTokenProvider(portName, baudRate, dataBits, stopBits, parity));`
`35`	`35`	`}`
	`36`	`+`
	`37`	`+ /// <summary>`
	`38`	`+ /// Creates external authorization for token present in a string variable the PLC program.`
	`39`	`+ /// </summary>`
	`40`	`+ /// <param name="tokenValue">Onliner string containing the value of authentication token.</param>`
	`41`	`+ /// <param name="tokenPresence">Onliner bool indicating presence of authentication token.</param>`
	`42`	`+ /// <returns></returns>`
	`43`	`+ public static ExternalAuthorization CreatePlcTokenReader(Vortex.Connector.ValueTypes.OnlinerString tokenValue,`
	`44`	`+ Vortex.Connector.ValueTypes.OnlinerBool tokenPresence)`
	`45`	`+ {`
	`46`	`+ return new ExternalTokenAuthorization(new PlcTokenReader(tokenValue, tokenPresence));`
	`47`	`+ }`
	`48`	`+`
`36`	`49`	`}`
`37`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,6 @@`
`1`	`1`	`using NUnit.Framework;`
	`2`	`+using System;`
	`3`	`+using TcOpen.Inxton.Local.Security.Readers;`
`2`	`4`
`3`	`5`	`namespace TcOpen.Inxton.Local.Security.ReadersTests`
`4`	`6`	`{`
`@@ -10,9 +12,19 @@ public void Setup()`
`10`	`12`	`}`
`11`	`13`
`12`	`14`	`[Test]`
`13`		`- public void Test1()`
	`15`	`+ public void CreatePlcTokenReader()`
`14`	`16`	`{`
`15`		`- Assert.Pass();`
	`17`	`+ var tokenValueSource = new Vortex.Connector.ValueTypes.OnlinerString();`
	`18`	`+ var tokenPresence = new Vortex.Connector.ValueTypes.OnlinerBool();`
	`19`	`+ var reader = ExternalTokenAuthorization.CreatePlcTokenReader(tokenValueSource, tokenPresence);`
	`20`	`+ }`
	`21`	`+`
	`22`	`+ [Test]`
	`23`	`+ public void CreateComTokenReader()`
	`24`	`+ {`
	`25`	`+ var tokenValueSource = new Vortex.Connector.ValueTypes.OnlinerString();`
	`26`	`+ var tokenPresence = new Vortex.Connector.ValueTypes.OnlinerBool();`
	`27`	`+ Assert.Throws<System.IO.IOException>(() => ExternalTokenAuthorization.CreateComReader("COM1"));`
`16`	`28`	`}`
`17`	`29`	`}`
`18`	`30`	`}`