F Moved SetOnvifAuthentication method out of the SimpleOnvifClient

Author: jimm98y

README.md

@@ -38,7 +38,7 @@ Optionally, add Onvif discovery to make your service discoverable on the network
 ```cs
 builder.Services.AddOnvifDiscovery();
 ```
-Simple DeviceImpl just extends `SharpOnvifServer.DeviceMgmt.DeviceBase` and overrides a method you want to implement - for instance `GetDeviceInformation`:
+Simple `DeviceImpl` just extends `SharpOnvifServer.DeviceMgmt.DeviceBase` and overrides a method you want to implement - for instance `GetDeviceInformation`:
 ```cs
 public class DeviceImpl : DeviceBase
 {
@@ -153,61 +153,23 @@ First add a reference to the DLL that implements the clients (e.g. `SharpOnvifCl
 ```cs
 var auth = new DigestBehavior("admin", "password");
 ```
-Create the Onvif client and set the authentication behavior before you use it:
+Create the Onvif client and set the authentication behavior using `SetOnvifAuthentication` extension method from `SharpOnvifClient.OnvifAuthenticationExtensions` before you use it:
 ```cs
- using (var deviceClient = new DeviceClient(
-     OnvifBindingFactory.CreateBinding(),
-     new System.ServiceModel.EndpointAddress("http://192.168.1.10/onvif/device_service")))
- {
-     SetAuthentication(deviceClient);
-     
-     // use the client
- }
-```
-Where the `SetAuthentication` method might look like:
-```cs
-[Flags]
-public enum AuthenticationMethod
-{
-    None = 0,
-    WsUsernameToken = 1,
-    HttpDigest = 2
-}
+using SharpOnvifClient;
 
-private readonly System.Net.NetworkCredential _credentials;
-private readonly AuthenticationMethod _authentication = AuthenticationMethod.WsUsernameToken | AuthenticationMethod.HttpDigest;
-private readonly IEndpointBehavior _legacyAuth;
+System.Net.NetworkCredential credentials = new System.Net.NetworkCredential(userName, password);
+IEndpointBehavior legacyAuth = new WsUsernameTokenBehavior(_credentials);
 
-// ctor
-...
-_credentials = new System.Net.NetworkCredential(userName, password);
-_legacyAuth = new WsUsernameTokenBehavior(_credentials);
-...
-
-private void SetAuthentication<TChannel>(ClientBase<TChannel> channel) where TChannel : class
+using (var deviceClient = new DeviceClient(
+    OnvifBindingFactory.CreateBinding(),
+    new System.ServiceModel.EndpointAddress("http://192.168.1.10/onvif/device_service")))
 {
-    if(_authentication == AuthenticationMethod.None)
-    {
-        return;
-    }
-
-    if (_authentication.HasFlag(AuthenticationMethod.HttpDigest))
-    {
-        // HTTP Digest authentication is handled by WCF
-        channel.ClientCredentials.HttpDigest.ClientCredential = _credentials;
-    }
-
-    if (_authentication.HasFlag(AuthenticationMethod.WsUsernameToken))
-    {
-        // Legacy WsUsernameToken authentication must be handled using a custom behavior
-        if (!channel.Endpoint.EndpointBehaviors.Contains(_legacyAuth))
-        {
-            channel.Endpoint.EndpointBehaviors.Add(_legacyAuth);
-        }
-    }
+    deviceClient.SetOnvifAuthentication(OnvifAuthentication.WsUsernameToken | OnvifAuthentication.HttpDigest, credentials, legacyAuth);
+    
+    // use the client
 }
 ```
-Call any method on the client like:
+Call any method on the client, e.g.:
 ```cs
 var deviceInfo = await deviceClient.GetDeviceInformationAsync(new GetDeviceInformationRequest());
 ```

src/SharpOnvifClient/OnvifAuthenticationExtensions.cs

@@ -0,0 +1,49 @@
+using System;
+using System.Diagnostics;
+using System.Net;
+using System.ServiceModel;
+
+namespace SharpOnvifClient
+{
+    [Flags]
+    public enum OnvifAuthentication
+    {
+        None = 0,
+        WsUsernameToken = 1,
+        HttpDigest = 2
+    }
+
+    public static class OnvifAuthenticationExtensions
+    {
+        public static void SetOnvifAuthentication<TChannel>(
+            this ClientBase<TChannel> channel,
+            OnvifAuthentication authentication, 
+            NetworkCredential credentials, 
+            System.ServiceModel.Description.IEndpointBehavior legacyAuth = null) where TChannel : class
+        {
+            if (authentication == OnvifAuthentication.None)
+            {
+                Debug.WriteLine("Authentication is disabled");
+                return;
+            }
+
+            if (authentication.HasFlag(OnvifAuthentication.HttpDigest))
+            {
+                // HTTP Digest authentication is handled by WCF
+                channel.ClientCredentials.HttpDigest.ClientCredential = credentials;
+            }
+
+            if (authentication.HasFlag(OnvifAuthentication.WsUsernameToken))
+            {
+                if(legacyAuth == null)
+                    throw new ArgumentNullException(nameof(legacyAuth));    
+
+                // legacy WsUsernameToken authentication must be handled using a custom behavior
+                if (!channel.Endpoint.EndpointBehaviors.Contains(legacyAuth))
+                {
+                    channel.Endpoint.EndpointBehaviors.Add(legacyAuth);
+                }
+            }
+        }
+    }
+}

src/SharpOnvifClient/SimpleOnvifClient.cs

@@ -6,22 +6,13 @@
 using SharpOnvifCommon;
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.Linq;
 using System.ServiceModel;
 using System.ServiceModel.Description;
 using System.Threading.Tasks;
 
 namespace SharpOnvifClient
 {
-    [Flags]
-    public enum AuthenticationMethod
-    {
-        None = 0,
-        WsUsernameToken = 1,
-        HttpDigest = 2
-    }
-
     public class SimpleOnvifClient : IDisposable
     {
         private bool _disposedValue;
@@ -32,27 +23,31 @@ public class SimpleOnvifClient : IDisposable
         private object _syncRoot = new object();
         private readonly Dictionary<string, ICommunicationObject> _clients = new Dictionary<string, ICommunicationObject>();
         private readonly System.Net.NetworkCredential _credentials;
-        private readonly AuthenticationMethod _authentication;
+        private readonly OnvifAuthentication _authentication;
         private readonly IEndpointBehavior _legacyAuth;
 
-        public SimpleOnvifClient(string onvifUri) : this(onvifUri, null, null, AuthenticationMethod.None)
+        public SimpleOnvifClient(string onvifUri) : this(onvifUri, null, null, OnvifAuthentication.None)
         { }
 
-        public SimpleOnvifClient(string onvifUri, string userName, string password) : this(onvifUri, userName, password, AuthenticationMethod.WsUsernameToken | AuthenticationMethod.HttpDigest)
+        public SimpleOnvifClient(string onvifUri, string userName, string password) : this(onvifUri, userName, password, OnvifAuthentication.WsUsernameToken | OnvifAuthentication.HttpDigest)
         { }
 
-        public SimpleOnvifClient(string onvifUri, string userName, string password, AuthenticationMethod authentication)
+        public SimpleOnvifClient(string onvifUri, string userName, string password, OnvifAuthentication authentication)
         {
             if (string.IsNullOrWhiteSpace(onvifUri))
                 throw new ArgumentNullException(nameof(onvifUri));
 
-            if(authentication != AuthenticationMethod.None)
+            if(authentication != OnvifAuthentication.None)
             {
                 if (string.IsNullOrWhiteSpace(userName) || string.IsNullOrWhiteSpace(password))
                     throw new ArgumentNullException("User name or password must not be empty!");
 
                 _credentials = new System.Net.NetworkCredential(userName, password);
-                _legacyAuth = new WsUsernameTokenBehavior(_credentials);
+
+                if (authentication.HasFlag(OnvifAuthentication.WsUsernameToken))
+                {
+                    _legacyAuth = new WsUsernameTokenBehavior(_credentials);
+                }
             }
 
             _onvifUri = onvifUri;
@@ -61,45 +56,16 @@ public SimpleOnvifClient(string onvifUri, string userName, string password, Auth
 
         public void SetCameraUtcNowOffset(TimeSpan utcNowOffset)
         {
-            // used for WsUsernameToken authentication method
-            if (_authentication.HasFlag(AuthenticationMethod.WsUsernameToken))
+            if (_authentication.HasFlag(OnvifAuthentication.WsUsernameToken))
             {
-                var utcOffsetBehavior = _legacyAuth as IHasUtcOffset;
-                if (utcOffsetBehavior != null)
-                {
-                    utcOffsetBehavior.UtcNowOffset = utcNowOffset;
-                }
+                ((IHasUtcOffset)_legacyAuth).UtcNowOffset = utcNowOffset;
             }
             else
             {
                 throw new NotSupportedException("Time offset is only supported for WsUsernameToken authentication");
             }
         }
 
-        private void SetAuthentication<TChannel>(ClientBase<TChannel> channel) where TChannel : class
-        {
-            if(_authentication == AuthenticationMethod.None)
-            {
-                Debug.WriteLine("Authentication is disabled");
-                return;
-            }
-
-            if (_authentication.HasFlag(AuthenticationMethod.HttpDigest))
-            {
-                // HTTP Digest authentication is handled by WCF
-                channel.ClientCredentials.HttpDigest.ClientCredential = _credentials;
-            }
-
-            if (_authentication.HasFlag(AuthenticationMethod.WsUsernameToken))
-            {
-                // Legacy WsUsernameToken authentication must be handled using a custom behavior
-                if (!channel.Endpoint.EndpointBehaviors.Contains(_legacyAuth))
-                {
-                    channel.Endpoint.EndpointBehaviors.Add(_legacyAuth);
-                }
-            }
-        }
-
         public TClient GetOrCreateClient<TClient, TChannel>(string uri, Func<string, TClient> creator) where TClient : ClientBase<TChannel> where TChannel : class
         {
             lock (_syncRoot)
@@ -111,7 +77,7 @@ public TClient GetOrCreateClient<TClient, TChannel>(string uri, Func<string, TCl
                 else
                 {
                     var client = creator(uri);
-                    SetAuthentication(client);
+                    client.SetOnvifAuthentication(_authentication, _credentials, _legacyAuth);
                     _clients.Add(uri, client);
                     return client;
                 }
@@ -189,9 +155,6 @@ public async Task<CreatePullPointSubscriptionResponse> PullPointSubscribeAsync(i
                 {
                     InitialTerminationTime = OnvifHelpers.GetTimeoutInMinutes(initialTerminationTimeInMinutes)
                 }).ConfigureAwait(false);
-
-            Debug.WriteLine($"Pull Point subscription termination time: {subscribeResponse.TerminationTime}");
-
             return subscribeResponse;
         }
 
@@ -233,7 +196,6 @@ public async Task<SubscribeResponse1> BasicSubscribeAsync(string onvifEventListe
                     }
                 }
             }).ConfigureAwait(false);
-
             return subscriptionResult;
         }