Skip to content

Commit 2333a3b

Browse files
echtishechtish
committed
Update mod_cloudflare to 1.2.0: unify source file, add autotools, update CloudFlare IP ranges to latest
1 parent 5bb5678 commit 2333a3b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+486
-2093
lines changed

‎ChangeLog

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
* Mar 20 2013 CloudFlare Inc <help@cloudflare.com> - 1.2.0
2+
- Refactor for Apache 2.4, utilize autotools for RPM/DEB builds
3+
4+
* Aug 30 2012 CloudFlare Inc <help@cloudflare.com> - 1.1.2
5+
- Bugfix for intermittent segfaults under some conditions.
6+
- Pulled from remoteip codebase.
7+
8+
* Jun 03 2012 CloudFlare Inc <help@cloudflare.com> - 1.1.1
9+
- Bugfix for DenyAll behavior when CF-Connecting-IP header not available
10+
11+
* May 20 2012 CloudFlare Inc <help@cloudflare.com> - 1.1.0
12+
- .deb and .rpm release tested on Debian 6.0, Ubuntu 8.04, Ubuntu 10.04,
13+
CentOS 5, CentOS 6, RHEL 5, RHEL 6, OpenSuSE 11.4, OpenSuSE 12.1 all on 32-bit
14+
and 64-bit architectures. These were produced on Fedora 16, Ubuntu 12.04 and
15+
OpenSuSE 12.1

‎LICENSE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎Makefile.in

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
srcdir = @srcdir@
2+
3+
DESTDIR =
4+
LIBEXECDIR = @LIBEXECDIR@
5+
6+
CPPFLAGS = @CPPFLAGS@
7+
CFLAGS = @CFLAGS@
8+
LDFLAGS = @LDFLAGS@
9+
LDLIBS = @LDLIBS@
10+
11+
APXS = @APXS@
12+
13+
all : mod_cloudflare.la
14+
15+
mod_cloudflare.la : mod_cloudflare.c
16+
$(APXS) -c $(CPPFLAGS) $(CFLAGS) $(srcdir)/mod_cloudflare.c $(LDFLAGS) $(LDLIBS)
17+
18+
$(DESTDIR)$(LIBEXECDIR) :
19+
mkdir -p $@
20+
21+
install : all $(DESTDIR)$(LIBEXECDIR)
22+
$(APXS) -i -S LIBEXECDIR=$(DESTDIR)$(LIBEXECDIR) -n 'mod_cloudflare' $(srcdir)/mod_cloudflare.la
23+
24+
clean :
25+
-rm -f $(srcdir)/.libs/*
26+
-rm -f $(srcdir)/*.o
27+
-rm -f $(srcdir)/*.lo
28+
-rm -f $(srcdir)/*.la
29+
-rm -f $(srcdir)/*.slo
30+
-rm -rf $(srcdir)/.libs
31+
-rm -rf autom4te.cache
32+
-rm -f config.log config.status
33+
34+
distclean : clean
35+
-rm -f Makefile
36+
37+
gitclean : distclean
38+
-rm -f configure src-package.tar.gz
39+
40+
src-package:
41+
@tar cz *.c configure.ac Makefile.in LICENSE ChangeLog README > $@.tar.gz
42+
43+
$(srcdir)/configure: configure.ac
44+
cd '$(srcdir)' && autoconf && ./configure
45+
46+
Makefile: Makefile.in configure

‎README

+42-43
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,64 @@
1-
Copyright CloudFlare 2012 cloudflare.com
1+
mod_cloudflare for Apache
22

3-
======> mod_cloudflare.c
3+
Copyright CloudFlare Inc. 2013
44

5-
Based on mod_remoteip.c, this apache extension will replace the remote_ip variable in user's logs with the correct remote_ip sent from CloudFlare.
6-
This also does authentication, only performing the switch for requests originating from 204.93.173.0/24 (by default).
5+
## mod_cloudflare.c ##
76

8-
To install:
7+
Based on mod_remoteip.c, this Apache extension will replace the remote_ip
8+
variable in user's logs with the correct remote IP sent from CloudFlare. The
9+
module only performs the IP substitution for requests originating from
10+
CloudFlare IPs by default.
911

10-
# apxs2 -a -i -c mod_cloudflare.c
12+
To install, either run apxs2 directly against the .c source file:
1113

12-
No further configuration is needed. However, if you wish to override the default values, the following directives are exposed:
14+
$ apxs2 -a -i -c mod_cloudflare.c
1315

14-
* CloudFlareRemoteIPHeader
16+
An alternative way to install is to use GNU autotools, which requires that
17+
autoconf and automake already be installed:
1518

16-
This specifies the header which contains the original IP. Default:
17-
18-
CloudFlareRemoteIPHeader CF-Connecting-IP
19+
$ autoconf
20+
$ ./configure
21+
$ make
22+
$ make install
1923

20-
* CloudFlareRemoteIPTrustedProxy
24+
No further configuration is needed. However, if you wish to override the
25+
default values, the following directives are exposed:
2126

22-
This is the IP range from which we will allow the CloudFlareRemoteIPHeader to be used from. See https://www.cloudflare.com/wiki/What_are_the_CloudFlare_IP_address_ranges.
27+
### CloudFlareRemoteIPHeader ###
2328

24-
Note that on some Debian systems, you may have to add a LoadModule directive manually. This should look like:
25-
26-
LoadModule cloudflare_module /usr/lib/apache2/modules/mod_cloudflare.so
29+
This specifies the header which contains the original IP. Default:
2730

28-
Replace /usr/lib/apache2/modules/mod_cloudflare.so with the path to mod_cloudflare.so on your system.
31+
CloudFlareRemoteIPHeader CF-Connecting-IP
2932

30-
If you cannot find apxs or apxs2, on a Debian or Ubuntu distro you can install this tool with:
33+
### CloudFlareRemoteIPTrustedProxy ###
3134

32-
# apt-get install apache2-prefork-dev
35+
This is the IP range from which we will allow the CloudFlareRemoteIPHeader to
36+
be used from. See https://www.cloudflare.com/wiki/What_are_the_CloudFlare_IP_address_ranges
37+
for a complete list.
3338

34-
NOTES:
39+
Note that on some systems, you may have to add a LoadModule directive
40+
manually. This should look like:
3541

36-
*) If mod_cloudflare and mod_remoteip are enabled on the same web server, the server will crash if they both try to set the remote IP to a different value.
37-
*) Enableing mod_cloudflare will not effect the performance of Apache in any noticable maner. AB testing both over LAN and WAN show no equalilent numbers with and without mod_cloudflare.
38-
*) If you like, you may also add the directive DenyAllButCloudFlare. This will result in all requests from IPs which are not in the CloudFlareRemoteIPTrustedProxy range being denied with a status of 403.
42+
LoadModule cloudflare_module /usr/lib/apache2/modules/mod_cloudflare.so
3943

40-
Packaging
41-
The packaging directory contains a makefile to run the package process. For each class of system you wish to target, run the approriate rules:
42-
debian (& ubuntu)
43-
sudo make pkg-deb-system-prep
44-
make pkg-deb
44+
Replace /usr/lib/apache2/modules/mod_cloudflare.so with the path to
45+
mod_cloudflare.so on your system.
4546

46-
redhat (& centos)
47-
sudo make pkg-rpm-system-prep
48-
make pkg-rpm
47+
If you cannot find apxs or apxs2, install apache2-dev on Debian and Ubuntu, or
48+
httpd-devel on Red Hat and CentOS:
4949

50-
suse
51-
sudo make pkg-rpm-suse-system-prep
52-
make pkg-rpm-suse
50+
$ apt-get install apache2-dev
51+
$ yum install httpd-devel
5352

54-
Testing
55-
To test a package run the test_debian, test_rpm or test_rpm.suse scripts on the target machine:
56-
test_debian.sh libapache2-mod-cloudflare_1.1_i386.deb
57-
test_rpm.suse.sh mod_cloudflare-1.1.0-3.fc16.x86_64.rpm
58-
test_rpm.suse.sh mod_cloudflare-1.1.0-3.x86_64.suse.rpm
53+
NOTES:
5954

55+
- If mod_cloudflare and mod_remoteip are enabled on the same web server, the
56+
server will crash if they both try to set the remote IP to a different value.
6057

61-
Releases
62-
2012-08-30 1.1.2 Bugfix for intermittent segfaults under some conditions. Pulled from remoteip codebase.
63-
2012-06-03 1.1.1 Bugfix for DenyAll behavior when CF-Connecting-IP header not available.
64-
2012-05-20 1.1.0 .deb and .rpm release tested on Debian 6.0, Ubuntu 8.04, Ubuntu 10.04, CentOS 5, CentOS 6, RHEL 5, RHEL 6, OpenSuSE 11.4, OpenSuSE 12.1 all on 32-bit and 64-bit architectures. These were produced on Fedora 16, Ubuntu 12.04 and OpenSuSE 12.1
58+
- Enabling mod_cloudflare will not effect the performance of Apache in any
59+
noticeable manner. AB testing both over LAN and WAN show no equivalent numbers
60+
with and without mod_cloudflare.
6561

62+
- If you like, you may also add the directive DenyAllButCloudFlare. This will result
63+
in all requests from IPs which are not in the CloudFlareRemoteIPTrustedProxy range
64+
being denied with a status of 403.

0 commit comments

Comments
 (0)