Merge pull request #6 from telerik/niliev/flags

sessio flags FiddlerCore

.gitignore

@@ -1,4 +1,3 @@
-
 .bundle
 .dockerignore
 .DS_Store
@@ -22,7 +21,7 @@
 /fonts/
 /LICENSE
 /styles/
-_site
+/_site/
 _site_SL
 _tempconfig.yml
 bs-config.js
@@ -39,4 +38,4 @@ robots.txt
 search.html
 start-docs.sh
 start-docs-sl.sh
-watch.sh
+watch.sh

basic-usage/capture-https-traffic.md

@@ -1,9 +1,10 @@
 ---
 title: Capture HTTP/S Traffic
+description: Use FiddlerCore application events to capture and analyze HTTP and HTTPS traffic
 slug: capture-https-traffic
 tags: capture-https-traffic
 published: True
-position: 3
+position: 30
 ---
 
 # Capture HTTP/S Traffic with FiddlerCore

basic-usage/configuration.md

@@ -1,9 +1,10 @@
 ---
 title: Configuration
+description: Learn more about FiddlerCore start-up, proxy, handling, and shutdown settings
 slug: configuration
 tags: configuration
 published: True
-position: 0
+position: 10
 ---
 
 # Configuration

basic-usage/import-export-sessions.md

@@ -1,9 +1,10 @@
 ---
 title: Import and Export Sessions
+
 slug: import-export-sessions
 tags: import-export-sessions
 published: True
-position: 4
+position: 50
 ---
 
 # Import and Export Sessions with FiddlerCore

basic-usage/register-as-system-proxy.md

@@ -1,9 +1,10 @@
 ---
 title: Register as System Proxy
+description: Learn how to set FiddlerCore as the system proxy
 slug: register-as-system-proxy
 tags: register
 published: True
-position: 1
+position: 20
 ---
 
 # Register as System Proxy

basic-usage/session-flags.md

@@ -0,0 +1,71 @@
+---
+title: FiddlerCore Session flags
+description: FiddlerCore provides set of specific flags to control the processing of the Session object
+slug: fiddler-core-session-flags
+tags: fiddler-core-session-flags
+published: True
+position: 60
+---
+
+
+# Session Flags
+
+
+A field in each **Session** object contains flags that control the processing of the session. The flags can be accessed by **oSession.oFlags["flagname"]** or by using the default indexer on the **Session** object: **oSession["flagname"]**.
+
+## Using SessionFlags
+
+- Flag names are not case-sensitive.  
+- Flag values are always strings.
+- If you examine **oFlags["non-existent-flag"]**, the result will be **null**.
+- The **oFlags** collection is the "indexer" for the **Session** object, so **oSession.oFlags["flagname"]** can be written as:
+  - **oSession["flagname"]** or 
+  - **oSession["SESSION", "flagname"]**
+- You can remove a flag from the list by:
+  - Calling: **oFlags.Remove("flagname")** or 
+  - Setting **oSession["flagname"] = null**
+- The value of most flags is not important; simply adding the flag is enough.  So **oSession["ui-hide"]="no"** does the same thing as **oSession["ui-hide"] = "true"** (hides the session).
+- While you can call **oFlags.Add("flagname")**, this will throw an exception if the flag already exists.  It's better to just set the value: **oFlags["flagname"] = "value";**
+- You can create new flags that attach metadata to a given session. To avoid naming conflicts, it's recommended that you choose distinctive flagnames. For example: **addon.acme.loggingFlag**.
+
+
+
+## Host Flags
+
+- **x-overrideHost** - Provide the _Host:Port_ combination, which should be used for DNS resolution purposes. Note that this mechanism does not change the HOST header on the request and thus is not useful if there's an upstream gateway.
+- **x-hostIP** - Indicates the IP address of the server used for this request. **Read-only** flag.
+- **x-overrideGateway** - Provide the Host:Port combination of a gateway that should be used to proxy this request, or DIRECT to send the request directly to the origin server.
+
+
+## Client Flags
+
+- **x-ProcessInfo** - Information (module name and ProcessID) on source of local requests.
+- **x-clientIP** - Indicates the client IP that sent this request.  It is most useful when multiple computers on a network are pointed to a single Fiddler instance. **Read-only** flag.
+- **x-clientport** - Indicates the port on the client that sent this request. **Read-only** flag.
+- **x-ConnectResponseRemoveConnectionClose** - Use during the **FiddlerApplication.RequestHeadersAvailable** or **FiddlerApplication.BeforeRequest** event, so that when FiddlerCore responds to the client's CONNECT request with **_"200 Connection established"_**, it will not add the **_"Connection: close"_** header. This header is known to be controversial for the CONNECT response, and it causes problems with some clients.
+
+
+## Socket Reuse Flags
+
+- **x-serversocket** - String containing data about the reuse status of the server socket. **Read-only** flag.
+- **x-securepipe** - String containing data about the reuse status of a secure server socket. **Read-only** flag.
+
+
+## Decryption and Authentication Flags
+
+- **x-no-decrypt** - If set on a CONNECT tunnel, the traffic in the tunnel will not be decrypted.
+- **https-Client-Certificate** - Filename of client certificate (e.g. .CER) that should be attached to this secure request.
+- **x-OverrideCertCN** - String specifying the hostname that should appear in the CN field of this CONNECT tunnel's Fiddler-generated certificate.
+- **x-SuppressProxySupportHeader** - Prevent FiddlerCore from adding a "Proxy-Support: Session-Based-Authentication" header to HTTP/401 or HTTP/407 responses that request Negotiate or NTLM authentication.
+
+
+## Performance Flags
+
+- **request-trickle delay** - Milliseconds to delay each outbound kilobyte of request data.
+- **response-trickle-delay** - Milliseconds to delay each inbound kilobyte of response data.
+
+## Drop Sessions Flags
+
+- **log-drop-request-body** - Drop the request body from the session list after a request is sent to the server.  Helpful in reducing memory usage.
+- **log-drop-response-body** - Drop the request body from the session list after a response is sent to the client. Helpful in reducing memory usage.
+

basic-usage/use-custom-root-certificate.md

@@ -1,9 +1,10 @@
 ---
 title: Use Custom Root Certificate
+description: Create, read and trust root certificate with BouncyCastle in FiddlerCore
 slug: use-custom-root-certificate
 tags: use-custom-root-certificate
 published: True
-position: 3
+position: 40
 ---
 
 # Use Custom Root Certificate

getting-started/first-steps.md

@@ -1,5 +1,6 @@
 ---
-title: First Steps
+title: First Steps with FiddlerCore
+description: Get started with the FiddlerCore library
 slug: first-steps
 tags: first-steps
 published: True

getting-started/system-requirements.md

@@ -1,5 +1,6 @@
 ---
 title: System Requirements
+description: FiddlerCore system requirments
 slug: system-requirements
 position: 1
 ---

getting-started/telerik-nuget-server.md

@@ -1,5 +1,6 @@
 ---
 title: Telerik NuGet Server
+description: Installing the latest version of FiddlerCore via the Telerik Nuget servers
 slug: telerik-nuget-server
 position: 8
 ---

to_delete.md

@@ -0,0 +1,5 @@
+---
+layout: to_delete
+publish: False
+sitemap: false
+---