Package com.intellij.internal.statistic.eventLog.validator

Class SensitiveDataValidator

java.lang.Object

com.intellij.internal.statistic.eventLog.validator.SensitiveDataValidator

public class SensitiveDataValidator
extends java.lang.Object

The data from all collectors is validated before it's recorded locally. It's necessary to make sure that the data is correct and it doesn't contain personal or proprietary information.
Validation is performed right before logging in guaranteeCorrectEventId(EventLogGroup, EventContext) and guaranteeCorrectEventData(EventLogGroup, EventContext).

Therefore, each collector should define data scheme and rules which will be used in validation.
Rules are stored in a separate repository, IDE loads rules from the server during runtime.
To register rules for a new group or change existing ones, create an issue.

There are 3 types of rules:

1. Enum: a list of possible values, e.g. "{enum:started|finished}" checks that the value is equal to 'started' or 'finished'.
   See: EnumWhiteListRule
2. Regexp: e.g. "{regexp#integer} checks that the value is integer.
   See: RegexpWhiteListRule
3. Custom rule: class which inherits CustomWhiteListRule and validates dynamic data like action id or file type, e.g. "{util#class_name}" checks that the value is a class name from platform, JB plugin or a plugin from JB plugin repository.
   See: ClassNameRuleValidator

There is also a list of common event data fields which doesn't require validation because they are always validated in FeatureUsageData, e.g. "plugin", "lang", etc.

Example:

• "actions" collector records invoked actions (ActionsCollectorImpl).
  It is validated by the following rules:

   {
     "event_id" : [ "{enum:action.invoked|custom.action.invoked}" ],
     "event_data" : {
       "action_id" : [ "{util#action}" ],
       "class" : [ "{util#class_name}" ],
       "context_menu" : [ "{enum#boolean}" ],
       "current_file" : [ "{util#current_file}" ],
       "input_event" : [ "{util#shortcut}" ],
       "place" : [ "{util#place}" ],
       "plugin" : [ "{util#plugin}" ],
       "plugin_type" : [ "{util#plugin_type}" ]
     }
   }
   

• "file.types" collector records information about project files (FileTypeUsagesCollector).
  It is validated by the following rules:

   {
     "event_id" : ["{enum:file.in.project}" ],
     "event_data" : {
       "file_type" : [ "{util#file_type}" ]
     }
   }
   

Field Summary

Fields

Modifier and Type	Field and Description
protected WhitelistGroupRulesStorage	myWhiteListStorage

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SensitiveDataValidator(WhitelistGroupRulesStorage storage)

Method Summary

Modifier and Type	Method and Description
static SensitiveDataValidator	getIfInitialized(java.lang.String recorderId)
static SensitiveDataValidator	getInstance(java.lang.String recorderId)
WhitelistGroupRulesStorage	getWhiteListStorage()
java.util.Map<java.lang.String,java.lang.Object>	guaranteeCorrectEventData(EventLogGroup group, EventContext context)
java.lang.String	guaranteeCorrectEventId(EventLogGroup group, EventContext context)
void	update()
ValidationResultType	validateEvent(EventLogGroup group, EventContext context)

Methods inherited from class java.lang.Object

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

Field Detail

myWhiteListStorage

protected final WhitelistGroupRulesStorage myWhiteListStorage

Constructor Detail

SensitiveDataValidator

protected SensitiveDataValidator(WhitelistGroupRulesStorage storage)

Method Detail

getInstance

public static SensitiveDataValidator getInstance(java.lang.String recorderId)

getIfInitialized

public static SensitiveDataValidator getIfInitialized(java.lang.String recorderId)

getWhiteListStorage

public WhitelistGroupRulesStorage getWhiteListStorage()

guaranteeCorrectEventId

public java.lang.String guaranteeCorrectEventId(EventLogGroup group,
                                                EventContext context)

guaranteeCorrectEventData

public java.util.Map<java.lang.String,java.lang.Object> guaranteeCorrectEventData(EventLogGroup group,
                                                                                  EventContext context)

validateEvent

public ValidationResultType validateEvent(EventLogGroup group,
                                          EventContext context)

update

public void update()