Skip to content

Commit

Permalink
refactor(java): base image for log4j
Browse files Browse the repository at this point in the history
  • Loading branch information
henrylee97 committed Nov 30, 2023
1 parent 168c862 commit d0bab39
Show file tree
Hide file tree
Showing 457 changed files with 95,779 additions and 0 deletions.
28 changes: 28 additions & 0 deletions Java-base/logging-log4j-audit/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
FROM ubuntu:22.04

RUN export DEBIAN_FRONTEND=noninteractive \
&& apt-get update \
&& apt-get install -y software-properties-common \
&& add-apt-repository ppa:deadsnakes/ppa \
&& apt-get update \
&& apt-get install -y \
build-essential \
git \
vim \
jq \
&& apt-get autoremove -y && apt-get clean -y && rm -rf /var/lib/apt/list/*

RUN apt-get -y install sudo \
openjdk-8-jdk \
maven

RUN bash -c "echo 2 | update-alternatives --config java"

COPY src /workspace
WORKDIR /workspace

RUN mvn install -V -B -Denforcer.skip=true -Dcheckstyle.skip=true -Dcobertura.skip=true -Drat.skip=true -Dlicense.skip=true -Dfindbugs.skip=true -Dgpg.skip=true -Dskip.npm=true -Dskip.gulp=true -Dskip.bower=true -Drat.numUnapprovedLicenses=100 -DskipTests=true -DskipITs=true -Dtest=None -DfailIfNoTests=false

RUN mvn test -V -B -Denforcer.skip=true -Dcheckstyle.skip=true -Dcobertura.skip=true -Drat.skip=true -Dlicense.skip=true -Dfindbugs.skip=true -Dgpg.skip=true -Dskip.npm=true -Dskip.gulp=true -Dskip.bower=true -Drat.numUnapprovedLicenses=100

ENV TZ=Asia/Seoul
202 changes: 202 additions & 0 deletions Java-base/logging-log4j-audit/src/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@

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 1999-2005 The Apache Software Foundation

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.
6 changes: 6 additions & 0 deletions Java-base/logging-log4j-audit/src/NOTICE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Apache Log4j Audit
Copyright 2017 Apache Software Foundation

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

65 changes: 65 additions & 0 deletions Java-base/logging-log4j-audit/src/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Apache Log4j Audit

Log4j-Audit provides a framework for defining audit events and then logging them using Log4j. The framework focuses on
defining the events and providing an easy mechanism for applications to log them, allowing products to provide
consistency and validity to the events that are logged. It does not focus on how the log events are written to a
data store. Log4j itself provides many options for that.

The expected process is that business analysts or product managers will be managing the catalog, defining the events
and attributes so that consumers of the events will have a consistent experience. For example, instead of one event
using an attribute with a name of "custAddr" and another using a name of "customerAddress", both would use the same
name for attributes that have the same meaning.

Once the catalog is modified in the web application it is saved as JSON to a git repository. It is expected that
a continuous integration system would notice the change and start a build of that project. The build would use the
Log4j Audit Maven Plugin to generate Java interfaces that Java developers would use to implement the audit logging
within the application. Non-Java applications would call the Audit Service by sending an appropriate Data Transfer
Object in JSON form and the Audit Service would perform the same validation that logging via the Java Interface
would.

Log4j Audit is not entirely usable by itself. Users of Log4j Audit must have a Git project that contains the JSON
catalog which will contain the Java Interfaces for the events defined in the catalog after a build is performed. They
will need to modify the Audit Service provided with Log4j Audit to include the JSON catalog (by including the
just discussed Git project as a dependency) and configuring the Audit Service as desired. The
[Log4j Audit Samples](https://github.com/apache/logging-log4j-audit-sample) is a
sample project that illustrates how to perform these tasks.

## Pull Requests on Github

By sending a pull request you grant the Apache Software Foundation sufficient rights to use and release the submitted
work under the Apache license. You grant the same rights (copyright license, patent license, etc.) to the
Apache Software Foundation as if you have signed a Contributor License Agreement. For contributions that are
judged to be non-trivial, you will be asked to actually signing a Contributor License Agreement.

## Packages

### Log4j Audit

The Log4j Audit module contains the Log4j Audit API that Java application leverage to perform audit logging, the
Log4j Audit Maven Plugin that generates Java Interfaces from the catalog, and the Audit Service that non-Java
applications interact with to perform audit logging. The Audit service will also provide access to define
dynamic catalog entries for systems that allow new custom objects and attributes to be created while the application
is executing and need to audit when actions are taken against these objects.

### Log4j Catalog

The Log4j Catalog module contains the API for working with the catalog, a module for persisting the catalog using
the Java Persistence Architecture (JPA), a module for reading and writing the JSON version of the catalog to a remote
GIT repository, and a module that provides a web application that can edit the various components of the catalog.

## Requirements

Log4j Audit requires a minimum of Java 8 and Log4j API and Core 2.9.

## Building From Source

Log4j Audit requires Apache Maven 3.x. To build from source and install to your local Maven repository, execute
the following:

```sh
mvn clean install
```

## License

Apache Log4j Audit is distributed under the [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).
44 changes: 44 additions & 0 deletions Java-base/logging-log4j-audit/src/RELEASE-NOTES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Apache Log4j 1.0.1 Release Notes

The Apache Log4j Audit team is pleased to announce the Log4j Audit 1.0.1 release!

Apache Log4j Audit is a framework for performing audit logging using a predefined catalog of audit events. It
provides a tool to create and edit audit events. It also provides a REST service to perform the logging so
that non-Java applications can use a common auditing facility.

## Release 1.0.1

Changes in this version include:


### Fixed Bugs
* [LOG4J2-2428](https://issues.apache.org/jira/browse/LOG4J2-2428):
Use the AuditExceptionHandler for validation exceptions. Thanks to Andrei Ivanov.
* [LOG4J2-2443](https://issues.apache.org/jira/browse/LOG4J2-2443):
Fix inconsistencies in validation exceptions. Thanks to Andrei Ivanov.
* [LOG4J2-2440](https://issues.apache.org/jira/browse/LOG4J2-2440):
AuditEvents should provide some basic toString(). Thanks to Andrei Ivanov.
* [LOG4J2-2429](https://issues.apache.org/jira/browse/LOG4J2-2429):
Setting the exceptionHandler on the AuditEvent sets it as a ThreadContext variable. Thanks to Andrei Ivanov.
* [LOG4J2-2421](https://issues.apache.org/jira/browse/LOG4J2-2421):
Add verbose parameter to the Log4j audit Maven plugin. Thanks to Andrei Ivanov.
* [LOG4J2-2421](https://issues.apache.org/jira/browse/LOG4J2-2421):
AbstractEventLogger.logEvent doesn't check for missing required context attributes. Thanks to Andrei Ivanov.
* [LOG4J2-2417](https://issues.apache.org/jira/browse/LOG4J2-2417):
Better handling of optional properties. Thanks to Andrei Ivanov.
* [LOG4J2-2420](https://issues.apache.org/jira/browse/LOG4J2-2420):
RequestContextFilter logging cleanup. Thanks to Andrei Ivanov.
* [LOG4J2-2442](https://issues.apache.org/jira/browse/LOG4J2-2442):
Normalize the event names logged through AbstractEventLogger.logEvent. Thanks to Andrei Ivanov.
* [LOG4J2-2431](https://issues.apache.org/jira/browse/LOG4J2-2431):
Narrow the return type of getEvent. Thanks to Andrei Ivanov.


---

Apache Log4j Audit 1.0.1 requires a minimum of Java 8 to build and run.

For complete information on Apache Log4j Audit, including instructions on how to submit bug
reports, patches, or suggestions for improvement, see the Apache Apache Log4j Audit website:

http://logging.apache.org/log4j-audit
16 changes: 16 additions & 0 deletions Java-base/logging-log4j-audit/src/checkstyle-header.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
Loading

0 comments on commit d0bab39

Please sign in to comment.