Skip to content

Commit

Permalink
Import code into Git.
Browse files Browse the repository at this point in the history
  • Loading branch information
smarsching committed Mar 1, 2018
0 parents commit c129d92
Show file tree
Hide file tree
Showing 18 changed files with 1,229 additions and 0 deletions.
Empty file added .deps
Empty file.
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.vscode
*.slo
debian/debhelper-build-stamp
debian/files
debian/libapache2-mod-log-ipmask
debian/*.debhelper.log
debian/*.debhelper
debian/*.substvars
201 changes: 201 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
49 changes: 49 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
##
## Makefile -- Build procedure for sample log_ipmask Apache module
## Autogenerated via ``apxs -n log_ipmask -g''.
##

builddir=.
top_srcdir=/usr/share/apache2
top_builddir=/usr/share/apache2
include /usr/share/apache2/build/special.mk

CXX=c++
CXXFLAGS=-std=c++11
EXTRA_LDFLAGS=-lstdc++

# the used tools
APACHECTL=apachectl

# additional defines, includes and libraries
#DEFS=-Dmy_define=my_value
#INCLUDES=-Imy/include/dir
#LIBS=-Lmy/lib/dir -lmylib

# the default target
all: local-shared-build

# install the shared object file into Apache
install: install-modules-yes

# cleanup
clean:
-rm -f mod_log_ipmask.o mod_log_ipmask.lo mod_log_ipmask.slo mod_log_ipmask.la

# simple test
test: reload
lynx -mime_header http://localhost/log_ipmask

# install and activate shared object by reloading Apache to
# force a reload of the shared object file
reload: install restart

# the general Apache start/restart/stop
# procedures
start:
$(APACHECTL) start
restart:
$(APACHECTL) restart
stop:
$(APACHECTL) stop

14 changes: 14 additions & 0 deletions NOTICE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
mod_log_ipmask module for the Apache HTTP Server
Copyright 2018 aquenos GmbH.

This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).

Portions of this software were developed at the National Center
for Supercomputing Applications (NCSA) at the University of
Illinois at Urbana-Champaign.

This software contains code derived from the RSA Data Security
Inc. MD5 Message-Digest Algorithm, including various
modifications by Spyglass Inc., Carnegie Mellon University, and
Bell Communications Research, Inc (Bellcore).
101 changes: 101 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
mod_log_ipmask
==============

The mod_log_ipmask module is designed to work with version 2.4 of the Apache
HTTP Server. It extends the mod_log_config module by overriding the `%a` and
`%h` format strings in order to limit the number of IP address bits that are
included in log files. This is intended for applications where partial logging
of IP addresses is desired, but full IP addresses may not be logged due to
privacy concerns.


Installation
------------

On Debian-based systems, a package can be built from source by running `debuild`
in the source tree. Subsequently, the generated `.deb` package can be installed
with `dpkg`. The module has been developped for Ubuntu 16.04 LTS. When building
it on other Debian-based distributions, slight modifications to the `Makefile`
may be necessary.

On other systems, the module can be built by running `make` and installed by
running `make install`. The `Makefile` may need to be adapted if the
configuration of the target system differs from Ubuntu 16.04 LTS (e.g. different
Apache installation path, different compiler name or flags).


Configuration
-------------

When using the Debian package, the module is automatically enabled during
installation. The default configuration file can be found in
`/etc/apache2/mods-available/log_ipmask.conf`.

When installing the module using `make install` the following line needs to be
added to the Apache HTTP Server configuration file in order to load the module.

```
LoadModule log_ipmask_module /usr/lib/apache2/modules/mod_log_ipmask.so
```

Obviously, the path to the module DSO file may need to be adjusted.

The default configuration file distributed with the Debian package contains the
following configuration directives:

```
LogDefaultIPv4Mask 24
LogDefaultIPv6Mask 56
```

This limits the logging of IPv4 addresses to their first 24 bits and the logging
of IPv6 addresses to their first 56 bits. If these directives are not specified,
the module logs the full IP addresses by default.

The `LogDefaultIPv4Mask` and `LogDefaultIPv6Mask` directives may be used on the
server config or virtual host levels. Settings specified on the virtual host
level override settings specified on the server config level.

In order to not log any bits of the IP address, the mask can be set to zero.
This results in the address `0.0.0.0` being logged for IPv4 addresses and the
address `::` being logged for IPv6 addresses. In order to enable the logging of
full IP addresses, `LogDefaultIPv4Mask` can be set to `32` and
`LogDefaultIPv6Mask` can be set to `128`. These are also the default settings if
the directives are not specified at all.

The mask can also be configured on a per-log basis by adding the mask to the
parameters of the `%a` or `%h` format string.

Examples:

- `%{8|16}a` logs the first 8 bits of IPv4 addresses and the first 16 bits of
IPv6 addresses.
- `%{c|8|16}a` logs the first 8 bits of IPv4 addresses and the first 16 bits of
IPv6 addresses, but uses the peer IP address of the connection (as
described in the documentation of
[mod_log_config](http://httpd.apache.org/docs/2.4/mod/mod_log_config.html)).
- `%a` logs the address according to the settings specified by
`LogDefaultIPv4Mask` and `LogDefaultIPv6Mask`.
- `%{c}a` logs the address according to the settings specified by
`LogDefaultIPv4Mask` and `LogDefaultIPv6Mask`, but uses the peer IP address of
the connection (as described in the documentation of
[mod_log_config](http://httpd.apache.org/docs/2.4/mod/mod_log_config.html)).
- `%{8|16}h` logs the first 8 bits of IPv4 addresses and the first 16 bits of
IPv6 addresses. If the remote host name has been resolved, it is logged as is.
- `%a` logs the address according to the settings specified by
`LogDefaultIPv4Mask` and `LogDefaultIPv6Mask`. If the remote host name has
been resolved, it is logged as is.


Limitations
-----------

When using the `%h` format string, only IP addresses are masked. If the IP
address has been resolved into a hostname, the hostname is kept as-is.


Trivia
------

Despite its name, this module does not share any code with the mod_log_ipmask
module from https://github.com/webfactory/mod_log_ipmask/.
5 changes: 5 additions & 0 deletions debian/changelog
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
apache2-mod-log-ipmask (1.0.0) stable; urgency=low

* Initial release.

-- Sebastian Marsching <apache2-mod-log-ipmask-maintainer@oss.aquenos.com> Thu, 01 Mar 2018 16:20:18 +0100
1 change: 1 addition & 0 deletions debian/compat
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
9
Loading

0 comments on commit c129d92

Please sign in to comment.