Monday, October 08, 2012

Geolocating a users last Send location (MEC sample)

This is sample one from the where's wally section of my MEC talk and demonstrates how you can locate the geographical place where a user last sent a Message from using EWS, Extended properties and GeoIp.

This script makes use of the x-ms-exchange-organization-originalclientipaddress extended property which is a extended property that gets set on the copy of the message that is saved into the SentItems folder of a mailbox when you send a message from OWA or Outlook (Note this isn't transmitted with the actually messages itself) . eg



 
The value of this property reflects the IP Address of the sending client eg so if your using OWA from a Kiosk PC it will show the IP from the Kiosk, or if your using Outlook from home via Outlook-Anywhere it will contain your ISP's Address. Or if your traveling around the world using different hotspots then the address you will get would be from each of the hotspot's you used. Here's a sample report from a mailbox I used from different hotspot's I was using on my recent trip to MEC which included a short holiday in New York.

To resolve the IP Address to geographical location involves using GeoLocation which has an increasing number of users in IT from WebStats to GeoDNS. In this script I've used Maxmind's GeoLiteCity database and Com object. The only thing with the COM object while it only take a few lines of Powershell to use because its a 32 bit library you need to make sure you run it from 32 bit session of Powershell.

 Before running this code you need the GEOIP database and Com object and the database must be in the following location and named GeoIPCity.dat.


$geoip = New-Object -ComObject "GeoIPCOMEx.GeoIPEx"
$geoip.set_db_path('c:\mec\')

I've put a download of this script here the code itself looks like

  1. ## Get the Mailbox to Access from the 1st commandline argument  
  2.   
  3. $MailboxName = $args[0]  
  4.   
  5. ## Load Managed API dll    
  6. Add-Type -Path "C:\Program Files\Microsoft\Exchange\Web Services\1.2\Microsoft.Exchange.WebServices.dll"    
  7.     
  8. ## Set Exchange Version    
  9. $ExchangeVersion = [Microsoft.Exchange.WebServices.Data.ExchangeVersion]::Exchange2010_SP2    
  10.     
  11. ## Create Exchange Service Object    
  12. $service = New-Object Microsoft.Exchange.WebServices.Data.ExchangeService($ExchangeVersion)    
  13.     
  14. ## Set Credentials to use two options are availible Option1 to use explict credentials or Option 2 use the Default (logged On) credentials    
  15.     
  16. #Credentials Option 1 using UPN for the windows Account    
  17. $psCred = Get-Credential    
  18. $creds = New-Object System.Net.NetworkCredential($psCred.UserName.ToString(),$psCred.GetNetworkCredential().password.ToString())    
  19. $service.Credentials = $creds        
  20.     
  21. #Credentials Option 2    
  22. #service.UseDefaultCredentials = $true    
  23.     
  24. ## Choose to ignore any SSL Warning issues caused by Self Signed Certificates    
  25.     
  26. ## Code From http://poshcode.org/624  
  27. ## Create a compilation environment  
  28. $Provider=New-Object Microsoft.CSharp.CSharpCodeProvider  
  29. $Compiler=$Provider.CreateCompiler()  
  30. $Params=New-Object System.CodeDom.Compiler.CompilerParameters  
  31. $Params.GenerateExecutable=$False  
  32. $Params.GenerateInMemory=$True  
  33. $Params.IncludeDebugInformation=$False  
  34. $Params.ReferencedAssemblies.Add("System.DLL") | Out-Null  
  35.   
  36. $TASource=@' 
  37.   namespace Local.ToolkitExtensions.Net.CertificatePolicy{ 
  38.     public class TrustAll : System.Net.ICertificatePolicy { 
  39.       public TrustAll() {  
  40.       } 
  41.       public bool CheckValidationResult(System.Net.ServicePoint sp, 
  42.         System.Security.Cryptography.X509Certificates.X509Certificate cert,  
  43.         System.Net.WebRequest req, int problem) { 
  44.         return true; 
  45.       } 
  46.     } 
  47.   } 
  48. '@   
  49. $TAResults=$Provider.CompileAssemblyFromSource($Params,$TASource)  
  50. $TAAssembly=$TAResults.CompiledAssembly  
  51.   
  52. ## We now create an instance of the TrustAll and attach it to the ServicePointManager  
  53. $TrustAll=$TAAssembly.CreateInstance("Local.ToolkitExtensions.Net.CertificatePolicy.TrustAll")  
  54. [System.Net.ServicePointManager]::CertificatePolicy=$TrustAll  
  55.   
  56. ## end code from http://poshcode.org/624  
  57.     
  58. ## Set the URL of the CAS (Client Access Server) to use two options are availbe to use Autodiscover to find the CAS URL or Hardcode the CAS to use    
  59.     
  60. #CAS URL Option 1 Autodiscover    
  61. $service.AutodiscoverUrl($MailboxName,{$true})    
  62. "Using CAS Server : " + $Service.url     
  63.      
  64. #CAS URL Option 2 Hardcoded    
  65.     
  66. #$uri=[system.URI] "https://casservername/ews/exchange.asmx"    
  67. #$service.Url = $uri      
  68.     
  69. ## Optional section for Exchange Impersonation    
  70.     
  71. #$service.ImpersonatedUserId = new-object Microsoft.Exchange.WebServices.Data.ImpersonatedUserId([Microsoft.Exchange.WebServices.Data.ConnectingIdType]::SmtpAddress, $MailboxName)   
  72.   
  73. # Bind to the SentItems Folder  
  74. $folderid= new-object Microsoft.Exchange.WebServices.Data.FolderId([Microsoft.Exchange.WebServices.Data.WellKnownFolderName]::SentItems,$MailboxName)     
  75. $SentItems = [Microsoft.Exchange.WebServices.Data.Folder]::Bind($service,$folderid)  
  76. #Define ExtendedProps  
  77. $OriginalServerIP = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(  
  78. [Microsoft.Exchange.WebServices.Data.DefaultExtendedPropertySet]::InternetHeaders,"x-ms-exchange-organization-originalserveripaddress",  
  79. [Microsoft.Exchange.WebServices.Data.MapiPropertyType]::String)  
  80.   
  81. $OriginalClientIP = new-object Microsoft.Exchange.WebServices.Data.ExtendedPropertyDefinition(  
  82. [Microsoft.Exchange.WebServices.Data.DefaultExtendedPropertySet]::InternetHeaders,"x-ms-exchange-organization-originalclientipaddress",  
  83. [Microsoft.Exchange.WebServices.Data.MapiPropertyType]::String)  
  84.   
  85. $psPropset = new-object Microsoft.Exchange.WebServices.Data.PropertySet([Microsoft.Exchange.WebServices.Data.BasePropertySet]::FirstClassProperties)    
  86. $psPropset.add($OriginalServerIP)  
  87. $psPropset.add($OriginalClientIP)  
  88.   
  89. #Setup GEOIP  
  90. $geoip = New-Object -ComObject "GeoIPCOMEx.GeoIPEx"  
  91. $geoip.set_db_path('c:\mec\')  
  92.   
  93.   
  94. #Define ItemView to retrive just 1000 Items      
  95. $ivItemView =  New-Object Microsoft.Exchange.WebServices.Data.ItemView(1000)   
  96. $ivItemView.PropertySet = $psPropset  
  97. $fiItems = $null  
  98. $rptCollection = @()  
  99. do{      
  100.     $fiItems = $service.FindItems($SentItems.Id,$ivItemView)      
  101.     #[Void]$service.LoadPropertiesForItems($fiItems,$psPropset)    
  102.     foreach($Item in $fiItems.Items){   
  103.         $rptobj = "" | select DateSent,Subject,ClientIP,LocationCity,LocationCountry,Latitute,Longitute  
  104.         "Subject : " + $Item.Subject  
  105.         $rptobj.Subject = $Item.Subject  
  106.         $rptobj.DateSent = $Item.DateTimeSent  
  107.         $clientIpvalue = $null  
  108.         if($Item.TryGetProperty($OriginalClientIP,[ref]$clientIpvalue)){  
  109.             $rptobj.ClientIP = $clientIpvalue  
  110.             "ClientIP : " + $clientIpvalue  
  111.             if($geoip.find_by_addr($clientIpvalue)){  
  112.                 "Location City : " + $geoip.city  
  113.                 $rptobj.LocationCity = $geoip.city  
  114.                 "Location Country : " + $geoip.country_name  
  115.                 $rptobj.LocationCountry = $geoip.country_name  
  116.                 "Location Latitute : " + $geoip.latitude  
  117.                 $rptobj.Latitute = $geoip.latitude  
  118.                 "Location Longitute : " + $geoip.longitude  
  119.                 $rptobj.Longitute = $geoip.longitude  
  120.             }  
  121.         }  
  122.         $serverIpValue = $null  
  123.         if($Item.TryGetProperty($OriginalServerIP,[ref]$serverIpValue)){  
  124.             "ServerIP : " + $serverIpValue  
  125.         }   
  126.         $rptCollection += $rptobj  
  127.   
  128.     }      
  129.     $ivItemView.Offset += $fiItems.Items.Count      
  130. }while($fiItems.MoreAvailable -eq $true)   
  131.   
  132. $tableStyle = @" 
  133. <style> 
  134. BODY{background-color:white;} 
  135. TABLE{border-width: 1px; 
  136.   border-style: solid; 
  137.   border-color: black; 
  138.   border-collapse: collapse; 
  139. } 
  140. TH{border-width: 1px; 
  141.   padding: 10px; 
  142.   border-style: solid; 
  143.   border-color: black; 
  144.   background-color:#66CCCC 
  145. } 
  146. TD{border-width: 1px; 
  147.   padding: 2px; 
  148.   border-style: solid; 
  149.   border-color: black; 
  150.   background-color:white 
  151. } 
  152. </style> 
  153. "@  
  154.     
  155. $body = @" 
  156. <p style="font-size:25px;family:calibri;color:#ff9100">  
  157. $TableHeader  
  158. </p>  
  159. "@  
  160.   
  161. $rptCollection | ConvertTo-HTML -head $tableStyle –body $body | Out-File c:\temp\GeoIpUserSentReport.html

No comments: