Skip to content

Commit e864600

Browse files
U/sgriffin/build (#76)
* fix archive dir * fix path * try adjusting path again * Clean up readme * further cleanup * more cleanup
1 parent 42716b6 commit e864600

File tree

2 files changed

+30
-23
lines changed

2 files changed

+30
-23
lines changed

README.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,63 @@
11
# Microsoft Office Inspectors for Fiddler
2-
This README document provides the instruction on installing Microsoft Office Inspectors for Fiddler.
32

4-
The MAPI Inspector evaluates the captured traffic between Outlook and Exchange; whereas the FSSHTTPandWOPI Inspector evaluates the captured traffic between client and SharePoint. These Microsoft Office Inspectors are able to display the protocol content in a user-friendly format. You may choose to install one or both inspectors.
3+
This README document provides the instruction on installing Microsoft Office Inspectors for Fiddler.
4+
5+
The MAPI Inspector evaluates the captured traffic between Outlook and Exchange; whereas the FSSHTTPandWOPI Inspector evaluates the captured traffic between client and SharePoint. These Microsoft Office Inspectors are able to display the protocol content in a user-friendly format. You may choose to install one or both inspectors.
56

67
For details on how to use the inspectors: see [*MAPI Inspector for Fiddler User Guide*](https://github.com/OfficeDev/MAPI-Inspector-for-Fiddler/wiki), see also [*FSSHTTPandWOPI Inspector for Fiddler User Guide*](https://github.com/OfficeDev/Office-Inspectors-for-Fiddler/wiki/FSSHTTPandWOPI).
78

89
## Overview
10+
911
The Messaging Application Programming Interface (MAPI) Inspector for [Fiddler](http://www.telerik.com/fiddler) decodes the MAPI message payload of an HTTP POST request and response according to [MS-OXCMAPIHTTP](https://msdn.microsoft.com/en-us/library/Dn530952(v=EXCHG.80).aspx). The MAPI Inspector is displayed under the *Inspectors* tab in Fiddler.
1012

1113
In addition to the MAPI Inspector, the File Synchronization via SOAP over HTTP Protocol (FSSHTTP) and the Web Application Open Platform Interface Protocol (WOPI)—combined as FSSHTTPandWOPI—also has a plug-in inspector for Fiddler which decodes:
14+
1215
* FSSHTTP protocol message that enables one or more clients to synchronize changes done on shared files stored on a server.
13-
* WOPI protocol message that enables a client to access and change files stored by a server.
16+
* WOPI protocol message that enables a client to access and change files stored by a server.
1417

1518
The FSSHTTPandWOPI Inspector is displayed under the *Inspectors* tab in Fiddler and decodes the message payload according to [MS-FSSHTTP](https://msdn.microsoft.com/en-us/library/dd943623%28v=office.12%29.aspx), [MS-FSSHTTPB](https://msdn.microsoft.com/en-us/library/dd965780%28v=office.12%29.aspx), [MS-FSSHTTPD](https://msdn.microsoft.com/en-us/library/ee365790%28v=office.12%29.aspx) and [MS-WOPI](https://msdn.microsoft.com/en-us/library/hh622722%28v=office.12%29.aspx).
1619

1720
This repository also includes Jscript that adds an *MS Protocol* column in the Fiddler web session panel. The *MS Protocol* column displays protocols that are relevant to MAPI, FSSHTTP, and WOPI messages, thereby allowing you to easily identify which HTTP requests and responses contain the respective message payloads.
1821

1922
## Building the Inspectors
20-
Each of the inspectors has a Visual Studio solution file in the Source folder, for example:
21-
22-
`Office-Inspectors-for-Fiddler\FSSHTTPWOPIInspector\Source\FSSHTTPandWOPIInspector.sln`
23-
`Office-Inspectors-for-Fiddler\MAPIInspector\Source\MAPIInspector.sln`
2423

25-
These will allow you to modify and build the inspector dlls.
24+
Each of the inspectors has a Visual Studio solution file in the Source folder, for example:
25+
`Office-Inspectors-for-Fiddler\MAPIInspector\Source\MAPIInspector.sln`
26+
`Office-Inspectors-for-Fiddler\FSSHTTPWOPIInspector\Source\FSSHTTPandWOPIInspector.sln`
27+
28+
These will allow you to modify and build the inspector dlls.
2629

27-
NOTE: There are dependencies on a few libraries and some of these are found in the Fiddler install folder. Specifically, the correct versions of the **HexBox** libraries can be found in your system's install folder for Fiddler. These are the libraries that you should point the Visual Studio inspector projects to for references. For example:
30+
## Installation
2831

29-
`C:\Users\<username>\AppData\Local\Programs\Fiddler\Be.Windows.Forms.HexBox.dll`
32+
First install the latest [Fiddler Classic](https://www.telerik.com/download/fiddler) tool and then run it. Note that Fiddler must be run at least once before installing any inspectors. To install the inspector of your choice (MAPI, FSSHTTPWOPI) or to install both, add the respective DLL files and the scripts.
3033

31-
## Installation
32-
First install the latest [Fiddler](http://www.telerik.com/fiddler) tool and then run it. Note that Fiddler must be run at least once before installing any inspectors. To install the inspector of your choice (MAPI, FSSHTTPWOPI) or to install both, add the respective DLL files and the scripts.
34+
### Inspector DLL
3335

34-
### Inspector DLL
35-
1. Copy the file MAPIFiddlerInspector.dll into the C:\Program Files\Fiddler2\Inspectors directory. Alternatively, you can clone this repository, build the MAPIFiddlerInspector.dll, and copy the built .dll to your C:\Program Files\Fiddler2\Inspectors directory.
36+
1. Copy the file MAPIFiddlerInspector.dll into the Fiddler directory, located here:
37+
38+
`%LocalAppData%\Programs\Fiddler\Inspectors`
39+
or here:
40+
`%ProgramFiles%\Fiddler2\Inspectors`
41+
42+
Alternatively, you can clone this repository and build the MAPIFiddlerInspector.dll, which will copy the built .dll to your fiddler Inspectors directory.
3643

3744
Follow the same process if you wish to use FSSHTTPAndWOPIFiddlerInspector.dll.
3845

3946
2. Restart Fiddler. MAPI, FSSHTTPandWOPI or both Inspectors will appear under the *Inspectors* tab for request and response. See the following screenshot.
4047

4148
![alt tag](/README-Images/InspectorsTabs.png)
4249

43-
### Script
50+
### Script
4451

4552
1. From the *Rules* menu, which is shown in the following screenshot, click *Customize Rules*.
46-
53+
4754
![alt tag](/README-Images/Figure2-mapiscript.png)
4855

4956
2. When the following message box displays, click *Yes* to install the FiddlerScript editor.
5057

5158
![alt tag](/README-Images/Figure3-mapiscript.png)
5259

53-
3. Restart Fiddler after installing the FiddlerScript editor. Fiddler displays a new tab, *FiddlerScript*, as shown in the following screenshot.
60+
3. Restart Fiddler after installing the FiddlerScript editor. Fiddler displays a new tab, *FiddlerScript*, as shown in the following screenshot.
5461

5562
![alt tag](/README-Images/Figure4-mapiscript.png)
5663

@@ -59,7 +66,7 @@ First install the latest [Fiddler](http://www.telerik.com/fiddler) tool and then
5966
But if you wish to add the code from the FSSHTTPAndWOPI.js file, then update **CalcMethodCol** function definition with the code for FSSHTTP and WOPI. Don't forget to add **GetWOPIOperationName** function definition as well.
6067

6168
**Note:** When you combine the scripts for MAPI and FSSHTTP in function **CalcMethodCol**, modify the code accordingly to ensure protocol names are displayed under the *MS Protocol* column. As shown below, the else statement is removed and the if statement for MAPI is added.
62-
69+
6370
![alt tag](/README-Images/ScriptMAPIAndFSSHTTP.png)
6471

6572
5. Restart Fiddler. The *MS Protocol* column is displayed in the session view.

scripts/Sign.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,19 +76,19 @@ stages:
7676
- task: ArchiveFiles@2
7777
inputs:
7878
rootFolderOrFile: '$(System.ArtifactsDirectory)/drop/MAPIFiddlerInspector.dll'
79-
archiveFile: '$(System.ArtifactStagingDirectory)/MAPIFiddlerInspector.dll.$(Build.BuildNumber).zip'
79+
archiveFile: '$(Build.ArtifactStagingDirectory)/MAPIFiddlerInspector.dll.$(Build.BuildNumber).zip'
8080
- task: ArchiveFiles@2
8181
inputs:
8282
rootFolderOrFile: '$(System.ArtifactsDirectory)/drop/MAPIFiddlerInspector.pdb'
83-
archiveFile: '$(System.ArtifactStagingDirectory)/MAPIFiddlerInspector.pdb.$(Build.BuildNumber).zip'
83+
archiveFile: '$(Build.ArtifactStagingDirectory)/MAPIFiddlerInspector.pdb.$(Build.BuildNumber).zip'
8484
- task: ArchiveFiles@2
8585
inputs:
8686
rootFolderOrFile: '$(System.ArtifactsDirectory)/drop/FSSHTTPandWOPIFiddlerInspector.dll'
87-
archiveFile: '$(System.ArtifactStagingDirectory)/FSSHTTPandWOPIFiddlerInspector.dll.$(Build.BuildNumber).zip'
87+
archiveFile: '$(Build.ArtifactStagingDirectory)/FSSHTTPandWOPIFiddlerInspector.dll.$(Build.BuildNumber).zip'
8888
- task: ArchiveFiles@2
8989
inputs:
9090
rootFolderOrFile: '$(System.ArtifactsDirectory)/drop/FSSHTTPandWOPIFiddlerInspector.pdb'
91-
archiveFile: '$(System.ArtifactStagingDirectory)/FSSHTTPandWOPIFiddlerInspector.pdb.$(Build.BuildNumber).zip'
91+
archiveFile: '$(Build.ArtifactStagingDirectory)/FSSHTTPandWOPIFiddlerInspector.pdb.$(Build.BuildNumber).zip'
9292

9393
- task: GitHubRelease@1
9494
inputs:
@@ -99,7 +99,7 @@ stages:
9999
tagSource: 'userSpecifiedTag'
100100
tag: '$(Build.BuildNumber)'
101101
assets: |
102-
$(System.ArtifactStagingDirectory)/drop/*.zip
102+
$(Build.ArtifactStagingDirectory)/*.zip
103103
isDraft: true
104104
isPreRelease: true
105105
changeLogCompareToRelease: 'lastFullRelease'

0 commit comments

Comments
 (0)