Skip to content

Commit 700a901

Browse files
committed
Add missing FilterRule option to proxyspec documentation
1 parent dd49756 commit 700a901

File tree

3 files changed

+19
-13
lines changed

3 files changed

+19
-13
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ route injection, /etc/hosts modification and so on.
6666
#### Proxy specifications
6767

6868
SSLproxy supports three different types of proxy specifications, or proxyspecs
69-
in short, which can be in divert or split style.
69+
for short, which can be in divert or split style.
7070

7171
- Command line proxyspecs passed on the command line
7272
- One line proxyspecs in configuration files
@@ -80,17 +80,17 @@ The syntax of command line proxyspecs is as follows:
8080
[(targetaddr targetport|sni sniport|natengine)]
8181

8282
The syntax of one line proxyspecs is the same as the command line proxyspecs,
83-
except for the leading `Proxyspec` keyword:
83+
except for the leading `ProxySpec` keyword:
8484

85-
Proxyspec (tcp|ssl|http|https|pop3|pop3s|smtp|smtps|autossl)
85+
ProxySpec (tcp|ssl|http|https|pop3|pop3s|smtp|smtps|autossl)
8686
listeningaddr listeningport
8787
[up:divertport [ua:divertaddr ra:returnaddr]]
8888
[(targetaddr targetport|sni sniport|natengine)]
8989

9090
The syntax of structured proxyspecs is as follows, and they can configure
9191
connection options too:
9292

93-
Proxyspec {
93+
ProxySpec {
9494
Proto (tcp|ssl|http|https|pop3|pop3s|smtp|smtps|autossl)
9595
Addr listeningaddr # inline
9696
Port listeningport # comments
@@ -134,13 +134,15 @@ connection options too:
134134
ValidateProto (yes|no)
135135
MaxHTTPHeaderSize 8192
136136

137+
# The DivertUsers, PassUsers, and PassSite options will be deprecated
137138
DivertUsers userlist
138139
PassUsers userlist
139-
140140
PassSite rules
141141

142142
Define $macro valuelist
143-
(Divert|Split|Pass|Block|Match) filtering rules
143+
144+
(Divert|Split|Pass|Block|Match) one line filtering rules
145+
FilterRule {...} structured filtering rules
144146
}
145147

146148
For example, given the following command line proxyspec:

src/sslproxy.1

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ access point (e.g. using hostap mode), physical recabling, malicious VLAN
102102
reconfiguration or route injection, /etc/hosts modification and so on.
103103
.SH Proxy specifications
104104
SSLproxy supports three different types of proxy specifications, or proxyspecs
105-
in short, which can be in divert or split style.
105+
for short, which can be in divert or split style.
106106
.LP
107107
- Command line proxyspecs passed on the command line
108108
- One line proxyspecs in configuration files
@@ -116,17 +116,17 @@ The syntax of command line proxyspecs is as follows:
116116
[(targetaddr targetport|sni sniport|natengine)]
117117
.LP
118118
The syntax of one line proxyspecs is the same as the command line proxyspecs,
119-
except for the leading Proxyspec keyword:
119+
except for the leading ProxySpec keyword:
120120
.LP
121-
Proxyspec (tcp|ssl|http|https|pop3|pop3s|smtp|smtps|autossl)
121+
ProxySpec (tcp|ssl|http|https|pop3|pop3s|smtp|smtps|autossl)
122122
listeningaddr listeningport
123123
[up:divertport [ua:divertaddr ra:returnaddr]]
124124
[(targetaddr targetport|sni sniport|natengine)]
125125
.LP
126126
The syntax of structured proxyspecs is as follows, and they can configure
127127
connection options too:
128128
.LP
129-
Proxyspec {
129+
ProxySpec {
130130
Proto (tcp|ssl|http|https|pop3|pop3s|smtp|smtps|autossl)
131131
Addr listeningaddr # inline
132132
Port listeningport # comments
@@ -170,13 +170,15 @@ Proxyspec {
170170
ValidateProto (yes|no)
171171
MaxHTTPHeaderSize 8192
172172

173+
# The DivertUsers, PassUsers, and PassSite options will be deprecated
173174
DivertUsers userlist
174175
PassUsers userlist
175-
176176
PassSite rules
177177

178178
Define $macro valuelist
179-
(Divert|Split|Pass|Block|Match) filtering rules
179+
180+
(Divert|Split|Pass|Block|Match) one line filtering rules
181+
FilterRule {...} structured filtering rules
180182
.br
181183
}
182184
.LP

src/sslproxy.conf.5

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -569,7 +569,9 @@ PassSite
569569
.br
570570
Define
571571
.br
572-
(Divert|Split|Pass|Block|Match) filtering rules
572+
(Divert|Split|Pass|Block|Match) one line filtering rules
573+
.br
574+
FilterRule {...} structured filtering rules
573575
.br
574576
\fB}\fR
575577
.br

0 commit comments

Comments
 (0)