Package org.microproxy.extras

package org.microproxy.extras

Related Packages

Package	Description
org.microproxy

Class	Description
AccessLogFilter	Decides which finished exchanges and flows an access log writes, with the semantics of Envoy's access-log filters: AccessLogFilter.statusCode(org.microproxy.extras.AccessLogFilter.Comparison, int), AccessLogFilter.duration(org.microproxy.extras.AccessLogFilter.Comparison, long), AccessLogFilter.notHealthCheck(), AccessLogFilter.responseFlag(org.microproxy.ResponseFlag...), AccessLogFilter.header(java.lang.String), AccessLogFilter.runtime(double) sampling, and the AccessLogFilter.allOf(org.microproxy.extras.AccessLogFilter...) and AccessLogFilter.anyOf(org.microproxy.extras.AccessLogFilter...) combinators.
AccessLogFilter.Comparison	How AccessLogFilter.statusCode(org.microproxy.extras.AccessLogFilter.Comparison, int) and AccessLogFilter.duration(org.microproxy.extras.AccessLogFilter.Comparison, long) compare.
AccessLogFormat	An access-log line format, compatible with Envoy's access-log command operators: a format string such as [%START_TIME%] "%REQ(:METHOD)% %REQ(X-ENVOY-ORIGINAL-PATH?:PATH)% %PROTOCOL%" %RESPONSE_CODE% %RESPONSE_FLAGS%, or a JSON dictionary whose values are format strings.
AccessLogWriter	Where an ActivityLogger writes its lines: a file it appends to, or standard output.
ActivityLogger	An ActivityTracker that writes one access-log line per finished exchange or flow (ActivityTracker.flowEnded(org.microproxy.FlowRecord)), in an AccessLogFormat: one of the LogFormat presets, or an Envoy-compatible format string or JSON dictionary.
ActivityLogger.Builder	Builds an ActivityLogger.
AntiCache	Removes the request headers that let a server answer 304 Not Modified ( If-None-Match and If-Modified-Since), as mitmproxy's anticache, so that clients get whole responses, which other addons and recorders can then see.
BlockList	Blocks requests, as mitmproxy's block_list: the first rule whose filter matches answers the request with an empty response of its status, without contacting the server.
BlockList.Builder	Builds BlockList.
BlockList.Rule	One rule: requests the filter matches get an empty response with status, or none.
ClientReplay	Sends recorded requests again, as mitmproxy's client_replay: each goes to the proxy's own listener as an ordinary client request, so every filter, addon, script, cache and recorder of the proxy applies to it, and the proxy reaches the server (over TLS for https:// URLs).
ClientReplay.Builder	Configures a ClientReplay.
ClientReplay.Result	What a replay did.
ConcurrencyLimiter	Limits how many exchanges run at once per key: per client address by default, or per user, per target host, or anything else a key function derives from the request and its client connection.
ConcurrencyLimiter.Builder	Configures a ConcurrencyLimiter.
ConcurrencyLimiter.KeyStats	One key's state.
ConcurrencyLimiter.RejectListener	Called for every request over the limit, refused or (in shadow mode) let through.
ConcurrencyLimiter.Responder	Makes the answer to a refused request; null sends the default 429.
ConcurrencyLimiter.Snapshot	The limiter's state at one moment.
FlowFilter	A flow filter expression, in the syntax of mitmproxy's filters, which the addons (MapLocal, MapRemote, ModifyBody, ModifyHeaders, BlockList, AntiCache, StickyCookie, HarRecorder) take to choose the exchanges they act on.
FlowFilter.Flow	An exchange as filters see it: the request, the response once there is one, and the bodies when they have been buffered.
HarRecorder	Records exchanges as an HTTP Archive (HAR 1.2), as mitmproxy's hardump / save.har do, for browsers' developer tools, HAR viewers and ServerReplay.
HarRecorder.Builder	Configures a HarRecorder.
HttpLogger	Logs whole requests and responses for debugging and audits, like OkHttp's HttpLoggingInterceptor or a mitmproxy flow dump.
HttpLogger.Builder	Configures an HttpLogger.
HttpLogger.Format	How messages are written.
HttpLogger.Level	How much of each message to log.
LogFormat	Named access-log formats for ActivityLogger, each a preset of AccessLogFormat: an Envoy-compatible format string (or JSON dictionary) shown on each constant.
MapLocal	Answers requests from local files, as mitmproxy's map_local.
MapLocal.Builder	Builds MapLocal.
MapLocal.Rule	One rule: requests the filter selects whose URL contains a match of pattern are answered from path.
MapRemote	Sends requests to another URL, as mitmproxy's map_remote: each rule replaces every match of a regular expression in the request's absolute URL, and the request goes to the result.
MapRemote.Builder	Builds MapRemote.
MapRemote.Rule	One rule: requests the filter matches have every match of pattern in their URL replaced.
ModifyBody	Replaces text in request and response bodies, as mitmproxy's modify_body: every match of a regular expression in the decoded body becomes the replacement, in the messages a rule's filter selects.
ModifyBody.Builder	Builds ModifyBody.
ModifyBody.Rule	One rule: a regular expression to replace in the bodies a filter selects.
ModifyHeaders	Sets and removes headers, as mitmproxy's modify_headers.
ModifyHeaders.Rule	One rule: a header to replace on the messages a filter matches.
RecordedExchange	A recorded exchange, read from a HAR file (as HarRecorder, browsers and mitmproxy write them) or a WARC file (as WarcRecorder writes them), for ServerReplay and ClientReplay.
RewriteRules	Declarative request/response rewriting: an ordered list of RewriteRules.Rules, each matching URLs by regular expression and editing headers and textual response bodies.
RewriteRules.Builder	Builds RewriteRules.
RewriteRules.Rule	One rewrite rule: a URL pattern plus edits.
ServerReplay	Answers requests from recorded responses instead of contacting servers, as mitmproxy's server_replay.
ServerReplay.Builder	Configures a ServerReplay.
ServerReplay.Extra	What happens to requests without a recording, as mitmproxy's server_replay_extra.
ServerReplay.Replayed	A response answered from a recording, which the proxy reports as ResponseSource.REPLAY.
StickyCookie	Remembers the cookies servers set and sends them with later requests, as mitmproxy's stickycookie, so that a session started in one client carries over to others (a browser and a command-line tool, or replayed requests).
TlsFingerprints	TLS client fingerprints of a ClientHello, as access logs show them ( %TLS_JA3_FINGERPRINT%, %TLS_JA4_FINGERPRINT%): JA3, the MD5 of the hello's version, cipher suites, extensions, groups and point formats, and JA4, a readable prefix and two truncated SHA-256 hashes of the sorted cipher suites and extensions.