Module logstash.logback.encoder

Package net.logstash.logback.mask

Class MaskingJsonGenerator

java.lang.Object

com.fasterxml.jackson.core.JsonGenerator

com.fasterxml.jackson.core.util.JsonGeneratorDelegate

net.logstash.logback.mask.MaskingJsonGenerator

All Implemented Interfaces:

Versioned, Closeable, Flushable, AutoCloseable

public class MaskingJsonGenerator
extends JsonGeneratorDelegate

A JsonGenerator that can mask sensitive field values before delegating to a delegate JsonGenerator.

Identifying field values to mask by path

The MaskingJsonGenerator uses a collection of FieldMaskers to identify fields to mask by JSON path.

These field maskers are invoked after a new field name is written to determine if the field's value should be masked. If any masker returns a non-null value, then the returned value will be written as the field's value (instead of the original field value). Note that the masked value's type might differ from the fields original type.

Example FieldMaskers:

• FieldNameBasedFieldMasker
• PathBasedFieldMasker

Identifying field values to mask by value

The MaskingJsonGenerator uses a collection of ValueMaskers to mask field values by JSON path and field value.

These value maskers are invoked each time a new number or string scalar value is written to determine if the value should be masked. If all maskers return null, then the value is written as-is (i.e. not masked). If any masker returns non-null, then the returned value will be written as the field value.

Raw values are NOT masked.

It is much more efficient to mask field values by path, rather than by field value. Therefore, prefer using FieldMaskers instead of ValueMaskers whenever possible.

Example value maskers:

• RegexValueMasker

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonGenerator

JsonGenerator.Feature

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MASK

Fields inherited from class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

delegate, delegateCopyMethods

Fields inherited from class com.fasterxml.jackson.core.JsonGenerator

_cfgPrettyPrinter, DEFAULT_BINARY_WRITE_CAPABILITIES, DEFAULT_TEXTUAL_WRITE_CAPABILITIES, DEFAULT_WRITE_CAPABILITIES

Constructor Summary

Constructors

Constructor	Description
MaskingJsonGenerator(JsonGenerator delegate, Collection<FieldMasker> fieldMaskers, Collection<ValueMasker> valueMaskers)

Method Summary

Modifier and Type	Method	Description
void	writeArray(double[] array, int offset, int length)
void	writeArray(int[] array, int offset, int length)
void	writeArray(long[] array, int offset, int length)
void	writeBinary(byte[] data)
void	writeBinary(byte[] data, int offset, int len)
void	writeBinary(Base64Variant b64variant, byte[] data, int offset, int len)
int	writeBinary(Base64Variant b64variant, InputStream data, int dataLength)
int	writeBinary(InputStream data, int dataLength)
void	writeBoolean(boolean state)
void	writeEmbeddedObject(Object object)
void	writeEndArray()
void	writeEndObject()
void	writeFieldId(long id)
void	writeFieldName(SerializableString name)
void	writeFieldName(String name)
void	writeNull()
void	writeNumber(double v)
void	writeNumber(float v)
void	writeNumber(int v)
void	writeNumber(long v)
void	writeNumber(short v)
void	writeNumber(String encodedValue)
void	writeNumber(BigDecimal v)
void	writeNumber(BigInteger v)
void	writeObjectId(Object id)
void	writeObjectRef(Object id)
void	writeOmittedField(String fieldName)
void	writeRaw(char c)
void	writeRaw(char[] text, int offset, int len)
void	writeRaw(SerializableString raw)
void	writeRaw(String text)
void	writeRaw(String text, int offset, int len)
void	writeRawUTF8String(byte[] text, int offset, int length)
void	writeRawValue(char[] text, int offset, int len)
void	writeRawValue(String text)
void	writeRawValue(String text, int offset, int len)
void	writeStartArray()
void	writeStartArray(int size)
void	writeStartArray(Object forValue)
void	writeStartArray(Object forValue, int size)
void	writeStartObject()
void	writeStartObject(Object forValue)
void	writeStartObject(Object forValue, int size)
void	writeString(char[] text, int offset, int len)
void	writeString(SerializableString text)
void	writeString(Reader reader, int len)
void	writeString(String text)
void	writeTypeId(Object id)
void	writeUTF8String(byte[] text, int offset, int length)

Methods inherited from class com.fasterxml.jackson.core.util.JsonGeneratorDelegate

assignCurrentValue, canOmitFields, canUseSchema, canWriteBinaryNatively, canWriteFormattedNumbers, canWriteObjectId, canWriteTypeId, close, copyCurrentEvent, copyCurrentStructure, currentValue, delegate, disable, enable, flush, getCharacterEscapes, getCodec, getCurrentValue, getDelegate, getFeatureMask, getHighestEscapedChar, getOutputBuffered, getOutputContext, getOutputTarget, getPrettyPrinter, getSchema, getWriteCapabilities, isClosed, isEnabled, overrideFormatFeatures, overrideStdFeatures, setCharacterEscapes, setCodec, setCurrentValue, setFeatureMask, setHighestNonEscapedChar, setPrettyPrinter, setRootValueSeparator, setSchema, streamWriteConstraints, useDefaultPrettyPrinter, version, writeArray, writeNumber, writeObject, writePOJO, writeTree

Methods inherited from class com.fasterxml.jackson.core.JsonGenerator

_constructWriteException, _constructWriteException, _constructWriteException, _constructWriteException, _copyCurrentContents, _copyCurrentFloatValue, _copyCurrentFloatValueExact, _copyCurrentIntValue, _copyCurrentStringValue, _reportError, _reportUnsupportedOperation, _reportUnsupportedOperation, _throwInternal, _verifyOffsets, _writeSimpleObject, configure, copyCurrentEventExact, getFormatFeatures, isEnabled, writeArrayFieldStart, writeBinaryField, writeBooleanField, writeNullField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeNumberField, writeObjectField, writeObjectFieldStart, writePOJOField, writeRawValue, writeStringField, writeTypePrefix, writeTypeSuffix

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MASK

public static final String MASK

See Also:

• Constant Field Values

Constructor Details

MaskingJsonGenerator

public MaskingJsonGenerator(JsonGenerator delegate,
 Collection<FieldMasker> fieldMaskers,
 Collection<ValueMasker> valueMaskers)

Parameters:

delegate - the generator to which to write potentially masked JSON

fieldMaskers - FieldMaskers to mask fields

valueMaskers - ValueMaskers to mask values

Method Details

writeArray

public void writeArray(int[] array,
 int offset,
 int length)
                throws IOException

Overrides:

writeArray in class JsonGeneratorDelegate

Throws:

IOException

writeArray

public void writeArray(long[] array,
 int offset,
 int length)
                throws IOException

Overrides:

writeArray in class JsonGeneratorDelegate

Throws:

IOException

writeArray

public void writeArray(double[] array,
 int offset,
 int length)
                throws IOException

Overrides:

writeArray in class JsonGeneratorDelegate

Throws:

IOException

writeFieldName

public void writeFieldName(SerializableString name)
                    throws IOException

Overrides:

writeFieldName in class JsonGeneratorDelegate

Throws:

IOException

writeFieldName

public void writeFieldName(String name)
                    throws IOException

Overrides:

writeFieldName in class JsonGeneratorDelegate

Throws:

IOException

writeFieldId

public void writeFieldId(long id)
                  throws IOException

Overrides:

writeFieldId in class JsonGeneratorDelegate

Throws:

IOException

writeBinary

public void writeBinary(Base64Variant b64variant,
 byte[] data,
 int offset,
 int len)
                 throws IOException

Overrides:

writeBinary in class JsonGeneratorDelegate

Throws:

IOException

writeBinary

public void writeBinary(byte[] data)
                 throws IOException

Overrides:

writeBinary in class JsonGenerator

Throws:

IOException

writeBinary

public void writeBinary(byte[] data,
 int offset,
 int len)
                 throws IOException

Overrides:

writeBinary in class JsonGenerator

Throws:

IOException

writeBinary

public int writeBinary(Base64Variant b64variant,
 InputStream data,
 int dataLength)
                throws IOException

Overrides:

writeBinary in class JsonGeneratorDelegate

Throws:

IOException

writeBinary

public int writeBinary(InputStream data,
 int dataLength)
                throws IOException

Overrides:

writeBinary in class JsonGenerator

Throws:

IOException

writeBoolean

public void writeBoolean(boolean state)
                  throws IOException

Overrides:

writeBoolean in class JsonGeneratorDelegate

Throws:

IOException

writeEmbeddedObject

public void writeEmbeddedObject(Object object)
                         throws IOException

Overrides:

writeEmbeddedObject in class JsonGeneratorDelegate

Throws:

IOException

writeNull

public void writeNull()
               throws IOException

Overrides:

writeNull in class JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(BigDecimal v)
                 throws IOException

Overrides:

writeNumber in class JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(BigInteger v)
                 throws IOException

Overrides:

writeNumber in class JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(double v)
                 throws IOException

Overrides:

writeNumber in class JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(float v)
                 throws IOException

Overrides:

writeNumber in class JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(int v)
                 throws IOException

Overrides:

writeNumber in class JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(short v)
                 throws IOException

Overrides:

writeNumber in class JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(long v)
                 throws IOException

Overrides:

writeNumber in class JsonGeneratorDelegate

Throws:

IOException

writeNumber

public void writeNumber(String encodedValue)
                 throws IOException

Overrides:

writeNumber in class JsonGeneratorDelegate

Throws:

IOException

writeObjectId

public void writeObjectId(Object id)
                   throws IOException

Overrides:

writeObjectId in class JsonGeneratorDelegate

Throws:

IOException

writeObjectRef

public void writeObjectRef(Object id)
                    throws IOException

Overrides:

writeObjectRef in class JsonGeneratorDelegate

Throws:

IOException

writeOmittedField

public void writeOmittedField(String fieldName)
                       throws IOException

Overrides:

writeOmittedField in class JsonGeneratorDelegate

Throws:

IOException

writeRaw

public void writeRaw(char c)
              throws IOException

Overrides:

writeRaw in class JsonGeneratorDelegate

Throws:

IOException

writeRaw

public void writeRaw(char[] text,
 int offset,
 int len)
              throws IOException

Overrides:

writeRaw in class JsonGeneratorDelegate

Throws:

IOException

writeRaw

public void writeRaw(String text)
              throws IOException

Overrides:

writeRaw in class JsonGeneratorDelegate

Throws:

IOException

writeRaw

public void writeRaw(String text,
 int offset,
 int len)
              throws IOException

Overrides:

writeRaw in class JsonGeneratorDelegate

Throws:

IOException

writeRaw

public void writeRaw(SerializableString raw)
              throws IOException

Overrides:

writeRaw in class JsonGeneratorDelegate

Throws:

IOException

writeRawValue

public void writeRawValue(String text)
                   throws IOException

Overrides:

writeRawValue in class JsonGeneratorDelegate

Throws:

IOException

writeRawValue

public void writeRawValue(String text,
 int offset,
 int len)
                   throws IOException

Overrides:

writeRawValue in class JsonGeneratorDelegate

Throws:

IOException

writeRawValue

public void writeRawValue(char[] text,
 int offset,
 int len)
                   throws IOException

Overrides:

writeRawValue in class JsonGeneratorDelegate

Throws:

IOException

writeRawUTF8String

public void writeRawUTF8String(byte[] text,
 int offset,
 int length)
                        throws IOException

Overrides:

writeRawUTF8String in class JsonGeneratorDelegate

Throws:

IOException

writeStartArray

public void writeStartArray(int size)
                     throws IOException

Overrides:

writeStartArray in class JsonGeneratorDelegate

Throws:

IOException

writeStartArray

public void writeStartArray()
                     throws IOException

Overrides:

writeStartArray in class JsonGeneratorDelegate

Throws:

IOException

writeStartArray

public void writeStartArray(Object forValue)
                     throws IOException

Overrides:

writeStartArray in class JsonGeneratorDelegate

Throws:

IOException

writeStartArray

public void writeStartArray(Object forValue,
 int size)
                     throws IOException

Overrides:

writeStartArray in class JsonGeneratorDelegate

Throws:

IOException

writeStartObject

public void writeStartObject()
                      throws IOException

Overrides:

writeStartObject in class JsonGeneratorDelegate

Throws:

IOException

writeStartObject

public void writeStartObject(Object forValue)
                      throws IOException

Overrides:

writeStartObject in class JsonGeneratorDelegate

Throws:

IOException

writeStartObject

public void writeStartObject(Object forValue,
 int size)
                      throws IOException

Overrides:

writeStartObject in class JsonGeneratorDelegate

Throws:

IOException

writeString

public void writeString(char[] text,
 int offset,
 int len)
                 throws IOException

Overrides:

writeString in class JsonGeneratorDelegate

Throws:

IOException

writeString

public void writeString(String text)
                 throws IOException

Overrides:

writeString in class JsonGeneratorDelegate

Throws:

IOException

writeString

public void writeString(SerializableString text)
                 throws IOException

Overrides:

writeString in class JsonGeneratorDelegate

Throws:

IOException

writeString

public void writeString(Reader reader,
 int len)
                 throws IOException

Overrides:

writeString in class JsonGeneratorDelegate

Throws:

IOException

writeUTF8String

public void writeUTF8String(byte[] text,
 int offset,
 int length)
                     throws IOException

Overrides:

writeUTF8String in class JsonGeneratorDelegate

Throws:

IOException

writeTypeId

public void writeTypeId(Object id)
                 throws IOException

Overrides:

writeTypeId in class JsonGeneratorDelegate

Throws:

IOException

writeEndArray

public void writeEndArray()
                   throws IOException

Overrides:

writeEndArray in class JsonGeneratorDelegate

Throws:

IOException

writeEndObject

public void writeEndObject()
                    throws IOException

Overrides:

writeEndObject in class JsonGeneratorDelegate

Throws:

IOException