Skip to content

Commit f3c6262

Browse files
jvzvy
andauthored
Apply suggestions from code review
Co-authored-by: Volkan Yazıcı <[email protected]>
1 parent 6108781 commit f3c6262

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

src/site/asciidoc/security.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,20 +69,19 @@ For example, if a log message contains new lines, these are not escaped or encod
6969
Similarly, other encoding options are available for other formats, but pattern layouts cannot make assumptions about the entire output.
7070
As such, when using unstructured layouts, no user-controlled input should be included in logs.
7171
It is strongly recommended that a structured layout (e.g., `JsonTemplateLayout`) is used instead for these situations.
72-
Note that `StrLookup` plugins (those referenced by `${...}` templates in configuration files) that contain user-provided input should not be referenced by a pattern layout.
72+
Note that `StrLookup` plugins (those referenced by `${...}` templates in configuration files) that contain user-provided input should not be referenced by layouts.
7373
7474
=== Structured Logging
7575
7676
When using a structured layout (most layouts besides pattern layout), log messages are encoded according to various output formats.
7777
These safely encode the various fields included in a log message.
78-
For example, the JSON template layout can be configured to output log messages in various JSON structures where all log data is properly encoded into safely parseable JSON.
78+
For example, the `JsonTemplateLayout` can be configured to output log messages in various JSON structures where all log data is properly encoded into safely parseable JSON.
7979
This is the recommended mode of operation for use with log parsing and log collection tools that rely on log files or arbitrary output streams.
8080
8181
=== Code Signing
8282
8383
Log4j artifacts are all signed using PGP using a key from the Logging Services PMC https://downloads.apache.org/logging/KEYS[KEYS file].
8484
Information on how to verify releases signed with PGP is https://httpd.apache.org/dev/verification.html[documented here].
85-
Individual jar files are not signed using `jarsigner` (only PGP), and the Log4j plugin system does not rely on signed jars for validation (unlike the Java cryptography APIs for example).
8685
Thus, PGP signatures should be validated in your build process.
8786
8887
=== Java Security Manager

0 commit comments

Comments
 (0)