Add authentication status and new request params (#17)

* Create PIAuthenticationStatus.cs

* add client and client user agent parameters

* Update PrivacyIDEA.cs

* Update PrivacyIDEA_Client/PrivacyIDEA.cs

Co-authored-by: Copilot <[email protected]>

* Update PrivacyIDEA_Client/PrivacyIDEA.cs

Co-authored-by: Copilot <[email protected]>

* Update PrivacyIDEA.cs

* change new params to customAttributes map

* Update PrivacyIDEA.cs

---------

Co-authored-by: Copilot <[email protected]>

Author: lukasmatusiewicz

PrivacyIDEA_Client/PIAuthenticationStatus.cs

@@ -0,0 +1,11 @@
+
+namespace PrivacyIDEA_Client
+{
+    public enum PIAuthenticationStatus
+    {
+        UNDEFINED,
+        ACCEPT,
+        REJECT,
+        CHALLENGE
+    }
+}

PrivacyIDEA_Client/PrivacyIDEA.cs

@@ -74,11 +74,12 @@ public PrivacyIDEA(string url, string userAgent, bool sslVerify = true)
         /// <param name="username">username to trigger challenges for</param>
         /// <param name="domain">optional domain which can be mapped to a privacyIDEA realm</param>
         /// <param name="headers">optional headers which can be forwarded to the privacyIDEA server</param>
+        /// <param name="customParameters">optional custom parameters to include</param>
         /// <param name="cancellationToken">optional</param>
         /// <returns>PIResponse object or null on error</returns>
-        public async Task<PIResponse?> TriggerChallenges(string username, string? domain = null, List<KeyValuePair<string, string>>? headers = null, CancellationToken cancellationToken = default)
+        public async Task<PIResponse?> TriggerChallenges(string username, string? domain = null, List<KeyValuePair<string, string>>? headers = null, Dictionary<string, string>? customParameters = null, CancellationToken cancellationToken = default)
         {
-            if (await GetAuthToken(cancellationToken) is false)
+            if (await GetAuthToken(customParameters, cancellationToken) is false)
             {
                 Error("Unable to trigger challenges without an auth token!");
                 return null;
@@ -89,6 +90,7 @@ public PrivacyIDEA(string url, string userAgent, bool sslVerify = true)
             };
 
             AddRealmForDomain(domain, parameters);
+            AddCustomParameters(customParameters, parameters);
 
             string response = await SendRequest("/validate/triggerchallenge", parameters, "POST", headers, cancellationToken);
             PIResponse? ret = PIResponse.FromJSON(response, this);
@@ -100,16 +102,18 @@ public PrivacyIDEA(string url, string userAgent, bool sslVerify = true)
         /// Check if the challenge for the given transaction id has been answered yet. This is done using the /validate/polltransaction endpoint.
         /// </summary>
         /// <param name="transactionid"></param>
+        /// <param name="customParameters">optional custom parameters to include</param>
         /// <param name="cancellationToken">optional</param>
         /// <returns>true if challenge was answered. false if not or error</returns>
-        public async Task<bool> PollTransaction(string transactionid, CancellationToken cancellationToken = default)
+        public async Task<bool> PollTransaction(string transactionid, Dictionary<string, string>? customParameters = null, CancellationToken cancellationToken = default)
         {
             if (string.IsNullOrEmpty(transactionid) is false)
             {
                 var parameters = new Dictionary<string, string>
                 {
                     { "transaction_id", transactionid }
                 };
+                AddCustomParameters(customParameters, parameters);
 
                 string response = await SendRequest("/validate/polltransaction", parameters, "GET", new List<KeyValuePair<string, string>>(), cancellationToken);
 
@@ -137,11 +141,12 @@ public async Task<bool> PollTransaction(string transactionid, CancellationToken
         /// </summary>
         /// <param name="user">username</param>
         /// <param name="domain">optional domain which can be mapped to a privacyIDEA realm</param>
+        /// <param name="customParameters">optional custom parameters to include</param>
         /// <param name="cancellationToken">optional</param>
         /// <returns>true if token exists. false if not or error</returns>
-        public async Task<bool> UserHasToken(string user, string? domain = null, CancellationToken cancellationToken = default)
+        public async Task<bool> UserHasToken(string user, string? domain = null, Dictionary<string, string>? customParameters = null, CancellationToken cancellationToken = default)
         {
-            if (await GetAuthToken(cancellationToken) is false)
+            if (await GetAuthToken(customParameters, cancellationToken) is false)
             {
                 Error("Unable to lookup tokens without an auth token!");
                 return false;
@@ -151,6 +156,7 @@ public async Task<bool> UserHasToken(string user, string? domain = null, Cancell
                 { "user", user }
             };
             AddRealmForDomain(domain, parameters);
+            AddCustomParameters(customParameters, parameters);
 
             string response = await SendRequest("/token/", parameters, "GET", new List<KeyValuePair<string, string>>(), cancellationToken);
             if (string.IsNullOrEmpty(response))
@@ -174,9 +180,10 @@ public async Task<bool> UserHasToken(string user, string? domain = null, Cancell
         /// </summary>
         /// <param name="user">username</param>
         /// <param name="domain">optional domain which can be mapped to a privacyIDEA realm</param>
+        /// <param name="customParameters">optional custom parameters to include</param>
         /// <param name="cancellationToken">optional</param>
         /// <returns>PIEnrollResponse object or null on error</returns>
-        public async Task<PIEnrollResponse?> TokenInit(string user, string? domain = null, CancellationToken cancellationToken = default)
+        public async Task<PIEnrollResponse?> TokenInit(string user, string? domain = null, Dictionary<string, string>? customParameters = null, CancellationToken cancellationToken = default)
         {
             var parameters = new Dictionary<string, string>
             {
@@ -185,6 +192,7 @@ public async Task<bool> UserHasToken(string user, string? domain = null, Cancell
                 { "genkey", "1" }
             };
             AddRealmForDomain(domain, parameters);
+            AddCustomParameters(customParameters, parameters);
 
             string response = await SendRequest("/token/init", parameters, "POST", new List<KeyValuePair<string, string>>(), cancellationToken);
             return PIEnrollResponse.FromJSON(response, this);
@@ -200,9 +208,10 @@ public async Task<bool> UserHasToken(string user, string? domain = null, Cancell
         /// <param name="transactionid">optional transaction id to refer to a challenge</param>
         /// <param name="domain">optional domain which can be mapped to a privacyIDEA realm</param>
         /// <param name="headers">optional headers which can be forwarded to the privacyIDEA server</param>
+        /// <param name="customParameters">optional custom parameters to include</param>
         /// <param name="cancellationToken">optional</param>
         /// <returns>PIResponse object or null on error</returns>
-        public async Task<PIResponse?> ValidateCheck(string user, string otp, string? transactionid = null, string? domain = null, List<KeyValuePair<string, string>>? headers = null, CancellationToken cancellationToken = default)
+        public async Task<PIResponse?> ValidateCheck(string user, string otp, string? transactionid = null, string? domain = null, List<KeyValuePair<string, string>>? headers = null, Dictionary<string, string>? customParameters = null, CancellationToken cancellationToken = default)
         {
             var parameters = new Dictionary<string, string>
             {
@@ -216,6 +225,7 @@ public async Task<bool> UserHasToken(string user, string? domain = null, Cancell
             }
 
             AddRealmForDomain(domain, parameters);
+            AddCustomParameters(customParameters, parameters);
 
             string response = await SendRequest("/validate/check", parameters, "POST", headers, cancellationToken);
             return PIResponse.FromJSON(response, this);
@@ -231,9 +241,10 @@ public async Task<bool> UserHasToken(string user, string? domain = null, Cancell
         /// <param name="origin">origin also returned by the browser</param>
         /// <param name="domain">optional domain which can be mapped to a privacyIDEA realm</param>
         /// <param name="headers">optional headers which can be forwarded to the privacyIDEA server</param>
+        /// <param name="customParameters">optional custom parameters to include</param>
         /// <param name="cancellationToken">optional</param>
         /// <returns>PIResponse object or null on error</returns>
-        public async Task<PIResponse?> ValidateCheckWebAuthn(string user, string transactionID, string webAuthnSignResponse, string origin, string? domain = null, List<KeyValuePair<string, string>>? headers = null, CancellationToken cancellationToken = default)
+        public async Task<PIResponse?> ValidateCheckWebAuthn(string user, string transactionID, string webAuthnSignResponse, string origin, string? domain = null, List<KeyValuePair<string, string>>? headers = null, Dictionary<string, string>? customParameters = null, CancellationToken cancellationToken = default)
         {
             if (string.IsNullOrEmpty(user) || string.IsNullOrEmpty(transactionID) || string.IsNullOrEmpty(webAuthnSignResponse) || string.IsNullOrEmpty(origin))
             {
@@ -279,6 +290,7 @@ public async Task<bool> UserHasToken(string user, string? domain = null, Cancell
                 }
 
                 AddRealmForDomain(domain, parameters);
+                AddCustomParameters(customParameters, parameters);
 
                 // The origin has to be set in the header for WebAuthn authentication
                 headers ??= new List<KeyValuePair<string, string>>();
@@ -298,9 +310,10 @@ public async Task<bool> UserHasToken(string user, string? domain = null, Cancell
         /// Gets an auth token from the privacyIDEA server using the service account.
         /// Afterward, the token is set as the default authentication header for the HttpClient.
         /// </summary>
+        /// <param name="customParameters">optional custom parameters to include</param>
         /// <param name="cancellationToken">optional</param>
         /// <returns>true if success, false otherwise</returns>
-        private async Task<bool> GetAuthToken(CancellationToken cancellationToken = default)
+        private async Task<bool> GetAuthToken(Dictionary<string, string>? customParameters = null, CancellationToken cancellationToken = default)
         {
             if (string.IsNullOrEmpty(_serviceUser) || string.IsNullOrEmpty(_servicePass))
             {
@@ -320,6 +333,8 @@ private async Task<bool> GetAuthToken(CancellationToken cancellationToken = defa
                     parameters.Add("realm", _serviceRealm);
                 }
 
+                AddCustomParameters(customParameters, parameters);
+
                 string response = await SendRequest("/auth", parameters, "POST", null, cancellationToken);
 
                 if (string.IsNullOrEmpty(response))
@@ -351,13 +366,15 @@ private async Task<bool> GetAuthToken(CancellationToken cancellationToken = defa
             }
         }
 
-        public void SetServiceAccount(string user, string pass, string realm = "")
-        {
-            _serviceUser = user;
-            _servicePass = pass;
-            _serviceRealm = realm ?? "";
-        }
-
+        /// <summary>
+        /// Sends a request to the privacyIDEA server.
+        /// </summary>
+        /// <param name="endpoint">API endpoint</param>
+        /// <param name="parameters">POST/GET parameters</param>
+        /// <param name="method">HTTP method: POST or GET</param>
+        /// <param name="headers">optional headers to add to the request</param>
+        /// <param name="cancellationToken">optional</param>
+        /// <returns>response string</returns>
         private Task<string> SendRequest(string endpoint, Dictionary<string, string> parameters, string method,
             List<KeyValuePair<string, string>>? headers = null, CancellationToken cancellationToken = default)
         {
@@ -415,6 +432,19 @@ private Task<string> SendRequest(string endpoint, Dictionary<string, string> par
             return Task.FromResult(ret);
         }
 
+        /// <summary>
+        /// Sets the service account credentials.
+        /// </summary>
+        /// <param name="user">username</param>
+        /// <param name="pass">password</param>
+        /// <param name="realm">optional realm</param>
+        public void SetServiceAccount(string user, string pass, string realm = "")
+        {
+            _serviceUser = user;
+            _servicePass = pass;
+            _serviceRealm = realm ?? "";
+        }
+
         /// <summary>
         /// Evaluates which realm to use for a given domain and adds it to the parameter dictionary.
         /// The realm mapping takes precedence over the general realm that can be set. If no realm is found, the parameter is omitted.
@@ -458,6 +488,27 @@ private void AddRealmForDomain(string? domain, Dictionary<string, string> parame
             }
         }
 
+        /// <summary>
+        /// Adds custom parameters to request.
+        /// </summary>
+        /// <param name="customParameters">Dictionary of custom parameters to add.</param>
+        /// <param name="parameters">The dictionary to add the parameters to.</param>
+        private static void AddCustomParameters(Dictionary<string, string>? customParameters, Dictionary<string, string> parameters)
+        {
+            if (customParameters != null)
+            {
+                foreach (var attribute in customParameters)
+                {
+                    parameters.Add(attribute.Key, attribute.Value);
+                }
+            }
+        }
+
+        /// <summary>
+        /// Converts a dictionary to a StringContent with application/x-www-form-urlencoded encoding.
+        /// </summary>
+        /// <param name="dict">The dictionary to convert.</param>
+        /// <returns>A StringContent object with the encoded dictionary.</returns>
         internal static StringContent DictToEncodedStringContent(Dictionary<string, string> dict)
         {
             StringBuilder sb = new();