Fix starttime and endtime timezone issues

renisac · Jan 31, 2022 · 9a64fc3 · 9a64fc3
1 parent fa2fb36
commit 9a64fc3
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 15 deletions.
diff --git a/CIF3.psd1 b/CIF3.psd1
@@ -9,7 +9,7 @@
     RootModule        = 'CIF3.psm1'
 
     # Version number of this module.
-    ModuleVersion     = '0.9.8'
+    ModuleVersion     = '0.9.9'
 
     # Supported PSEditions
     # CompatiblePSEditions = @()
@@ -24,7 +24,7 @@
     CompanyName       = 'REN-ISAC'
 
     # Copyright statement for this module
-    Copyright         = '(c) 2020 REN-ISAC. All rights reserved.'
+    Copyright         = '(c) 2022 REN-ISAC. All rights reserved.'
 
     # Description of the functionality provided by this module
     Description       = 'PowerShell module wrapper for the Collective Intelligence Framework (CIF) v3 API'
@@ -105,7 +105,7 @@
             # IconUri = ''
 
             # ReleaseNotes of this module
-            ReleaseNotes = 'Fixes encrypt/decrypt function causing failures on non-Windows OSes.'
+            ReleaseNotes = 'Fixes potential timezone issue with StartTime and EndTime params.'
 
         } # End of PSData hashtable
 

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 REN-ISAC
+Copyright (c) 2022 REN-ISAC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/Private/ConvertTo-ReportTimeUTC.ps1 b/Private/ConvertTo-ReportTimeUTC.ps1
@@ -0,0 +1,25 @@
+function ConvertTo-ReportTimeUTC {
+    # Helper function that takes two DateTime objects (StartTime and EndTime) and
+    # standardizes to UTC before returning a comma-separated string of the values
+    param(
+        [Parameter(Mandatory = $true)]    
+        [datetime]$StartTime,
+
+        [Parameter(Mandatory = $true)]
+        [datetime]$EndTime
+    )
+
+    begin { }
+
+    process { 
+        # try to set datetime object to a string the API will like
+        $StrStart = $StartTime.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ssZ")
+        $StrEnd = $EndTime.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ssZ")
+        $ReportTime = "$StrStart,$StrEnd"
+
+        Write-Verbose "Formatting time boundaries. ReportTime set to $ReportTime"
+        Write-Output $ReportTime
+    }
+
+    end { }
+}
diff --git a/Public/Get-CIF3Feed.ps1 b/Public/Get-CIF3Feed.ps1
@@ -104,10 +104,7 @@ function Get-CIF3Feed {
         }
 
         if ($PSBoundParameters.ContainsKey('StartTime')) {
-            # try to set datetime object to a string the API will like
-            $StrStart = $StartTime.ToString("yyyy-MM-ddT00:00:00Z") # have to set start time HH:mm:ss to 00:00:00 or CIF doesn't like it
-            $StrEnd = $EndTime.ToString("yyyy-MM-ddT23:59:59Z") # have to set end time HH:mm:ss to 23:59:59 or CIF isn't happy
-            $ReportTime = "$StrStart,$StrEnd"
+            $ReportTime = ConvertTo-ReportTimeUTC -StartTime $StartTime -EndTime $EndTime
             $Body.Add('reporttime', $ReportTime) 
         }
 

diff --git a/Public/Get-CIF3Indicator.ps1 b/Public/Get-CIF3Indicator.ps1
@@ -103,10 +103,7 @@ function Get-CIF3Indicator {
         }
 
         if ($PSBoundParameters.ContainsKey('StartTime')) {
-            # try to set datetime object to a string the API will like
-            $StrStart = $StartTime.ToString("yyyy-MM-ddT00:00:00Z") # have to set start time HH:mm:ss to 00:00:00 or CIF doesn't like it
-            $StrEnd = $EndTime.ToString("yyyy-MM-ddT23:59:59Z") # have to set end time HH:mm:ss to 23:59:59 or CIF isn't happy
-            $ReportTime = "$StrStart,$StrEnd"
+            $ReportTime = ConvertTo-ReportTimeUTC -StartTime $StartTime -EndTime $EndTime
             $Body.Add('reporttime', $ReportTime) 
         }
 

diff --git a/Public/Tokens/New-CIF3Token.ps1 b/Public/Tokens/New-CIF3Token.ps1
@@ -84,7 +84,7 @@ function New-CIF3Token {
             'Acl'       { $Body.Add('acl', $Acl) }
             'Revoked'   { $Body.Add('revoked', $Revoked) }
             'Expires'   { # try to set datetime object to a string the API will like
-                            $StrExpires = $Expires.ToString("yyyy-MM-ddTHH:mm:ssZ")
+                            $StrExpires = $Expires.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ssZ")
                             $Body.Add('expires', $StrExpires)
             }
         }

diff --git a/Public/Tokens/Set-CIF3TokenGroup.ps1 b/Public/Tokens/Set-CIF3TokenGroup.ps1
@@ -74,7 +74,7 @@ function Set-CIF3TokenGroup {
             'Admin'     { $Body.Add('admin', $Admin) }
             'Revoked'   { $Body.Add('revoked', $Revoked) }
             'Expires'   { # try to set datetime object to a string the API will like
-                            $StrExpires = $Expires.ToString("yyyy-MM-ddTHH:mm:ssZ")
+                            $StrExpires = $Expires.ToUniversalTime().ToString("yyyy-MM-ddTHH:mm:ssZ")
                             $Body.Add('expires', $StrExpires)
             }
         }
@@ -83,7 +83,7 @@ function Set-CIF3TokenGroup {
 
     process {
 
-        Write-Verbose 'Token removal on CIF API'
+        Write-Verbose 'Token update on CIF API'
 
         $Params = @{
             Body    = $Body