Skip to main content

Modifying the IPM

As described before, TLS-Anvil defines 4 common IPMs. Sometimes different parameters and/or parameter values should be part of the IPM. Therefore, the Anvil-Core-Framework provides several test template annotations that allow to modify a selected base IPM. Those are explained in the following.

Modifying Parameters​

IncludeParameter​

Takes a string corresponding to the enum value of TlsParameterType for the parameter that should be added to the base IPM. The values for the parameter are derived automatically from the features that the SUT ⓘ supports as well as the general constraints.

ExcludeParameter​

Takes a string corresponding to the enum value of TlsParameterType for the parameter that should be removed from the base IPM.

Modifying Parameter Values​

DynamicValueConstraints​

public @interface DynamicValueConstraints {
    Class<?> clazz() default Object.class;
    String[] affectedIdentifiers();
    String[] methods();
}

Each method of the methods array is called with the chosen parameter value of the parameter defined at the same index of the affectedIdentifiers array. When no clazz is specified, the method is called using reflection on the same class as the test template.

The method should return a boolean value. If the return value is true, the combination of parameter values is considered as valid test input. Otherwise the test input is skipped.

ValueConstraint​

public @interface ValueConstraints {
    DerivationType identifier();
    String method();
}

Some parameter values are based on TLS-Attacker enums, e.g. CipherSuiteDerivation. Those enums in TLS-Attacker already include methods that return a boolean value to check if the enum value fullfills certain parameters.

The method specified in the method field is called by using reflection on the selected enum corresponding to the identifier. If the return value is true, the combination of parameter values is considered as valid test input. Otherwise the test input is skipped.

ExplicitValues​

public @interface ExplicitValues {
    Class<?> clazz() default Object.class;
    String[] affectedIdentifiers();
    String[] methods();
}

Sometimes explicit values should be considered as parameter value, independent from the features that the SUT ⓘ supports. Those values are assigned to a parameter using this annotation.

The methods specified in the methods array are called by using reflection on clazz (test template class by default). The return value of the method should be List<DerivationParameter>.

ExplicitModelingConstraints​

public @interface ExplicitModelingConstraints {
    Class<?> clazz() default Object.class;
    String[] affectedIdentifiers();
    String[] methods();
}

This annotation replaces default constraints for a parameter with explicitly defined constraints. Each method of the methods array should return a list of ConditionalConstraint that should be applied to the given parameter at the correspondending index off the affectedIdentifiers array.