Custom DCR Validator

• Extend the DefaultRegistrationValidatorImpl class to validate RegistrationRequest according to your specification requirements. Given below is the ExtendedRegistrationValidatiorImpl class that is extended from DefaultRegistrationValidatorImpl.
• Then extend the RegistrationRequest class. For example, the ExtendedRegistrationRequest class below is extended from RegistrationRequest.
• Use the validatePost method in ExtendedRegistrationValidatiorImpl class to validate ExtendedRegistrationRequest.

For example,

public class ExtendedRegistrationValidatiorImpl extends DefaultRegistrationValidatorImpl {

  @Override
  public void validatePost(RegistrationRequest registrationRequest) throws DCRValidationException {

    /* Option 1: Using Hibernate Validator

    This method catches any constraint violation and creates relevant error messages using Hibernate Validator */

    ExtendedRegistrationRequest extendedRegistrationRequest = new ExtendedRegistrationRequest(registrationRequest); 
    ValidationUtils.validateRequest(extendedRegistrationRequest);

    /* Option 2: Using the default validation approach

    Validate the registration request and use the method below to implement the   validation logic */
    ValidationUtils.validateIssuer(registrationRequest.getIssuer());

  }

  // Add the other CRUD validations here  

}

• If you are using Hibernate Validator:

  • To add class level and attribute annotations, use the ExtendedRegistrationRequest model class.

  • To implement the extendedRegistrationRequest class, extend RegstrationRequest as follows:

  public class ExtendedRegistrationRequest extends RegistrationRequest {
  
    private RegistrationRequest registrationRequest;
  
    public ExtendedRegistrationRequest(RegistrationRequest registrationRequest) {
  
      this.registrationRequest = registrationRequest;
    }
  
    public RegistrationRequest getRegistrationRequest() {
  
      return registrationRequest;
    }
  
    // Override the required getters and setters as required
  
  }

  • Given below is a sample validation. Follow this approach to perform validations. When adding class-level annotation for model class ExtendedRegistrationRequest to validate redirect URIs in the registration request.

  @ValidateCallbackUris(registrationRequestProperty = "registrationRequest", callbackUrisProperty = "redirectUris",
    ssa = "softwareStatement", message = "Invalid callback uris:" + DCRCommonConstants.INVALID_META_DATA,
    groups = AttributeChecks.class)
  public class ExtendedRegistrationRequest extends RegistrationRequest {
  
    // Add the class implementation here
  }

• Annotation class for ValidateCallbackUris

@Target(ElementType.TYPE)
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {
  CallbackUrisValidator.class
})
public @interface ValidateCallbackUris {

  String message() default "Invalid callback uris";

  Class < ? > [] groups() default {};

  Class < ? extends Payload > [] payload() default {};

  String registrationRequestProperty() default "registrationRequestProperty";

  String callbackUrisProperty() default "callbackUrisProperty";

  String ssa() default "ssa";
}

public class CallbackUrisValidator implements ConstraintValidator < ValidateCallbackUris, Object > {

  // Override the initialize(T constrainAnnotation) method if required

  // Override isValid() with the validation logic

  // The sample isValid() method impelementatio contains the redirect URI validation logic

  @Override
  public boolean isValid(Object extendedRegistrationRequest, ConstraintValidatorContext constraintValidatorContext) {

    try {

      RegistrationRequest registrationRequest = (RegistrationRequest) new PropertyUtilsBean()
        .getProperty(extendedRegistrationRequest, registrationRequestPath);
      String softwareStatement = BeanUtils.getProperty(extendedRegistrationRequest, ssaPath);
      List < String > callbackUris = registrationRequest.getCallbackUris();
      if (callbackUris != null && !callbackUris.isEmpty()) {
        final Object ssaCallbackUris = ValidatorUtils.decodeRequestJWT(softwareStatement, "body")
          .get(ValidationConstants.SSA_REDIRECT_URIS);

        return matchRedirectURI(callbackUris, ssaCallbackUris);
      }
    } catch (IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
      log.error("Error while resolving validation fields", e);
      return false;
    } catch (ParseException e) {
      log.error("Error while parsing the softwareStatement", e);
      return false;
    }
    return true;
  }

}

• To create a SoftwareStatementBody according to your specification, extend SoftwareStatementBody. For example, the ExtendedSoftwareStatementBody class given below is extended from SoftwareStatementBody.

• Use the setSoftwareStatementPayload method to set ExtendedSoftwareStatementBody.

For example,

public class ExtendedRegistrationValidatiorImpl extends DefaultRegistrationValidatorImpl {

  @Override
  public void setSoftwareStatementPayload(RegistrationRequest registrationRequest, String decodedSSA) {

    ExtendedSoftwareStatementBody extendedSoftwareStatementBody = new GsonBuilder().create()
      .fromJson(decodedSSA, ExtendedSoftwareStatementBody.class);
    registrationRequest.setSoftwareStatementBody(extendedSoftwareStatementBody);
  }

}

• To implement the ExtendedSoftwareStatementBody class, extend SoftwareStatementBody as follows:

public class ExtendedSoftwareStatementBody extends SoftwareStatementBody {

  private String iss;

  @SerializedName("logo_uri")
  private String logoUri;

  // Follow the above and add any field according to your specification requirements

}

• If you are using Hibernate Validator:

To add class level and attribute annotations, use the ExtendedSoftwareStatementBody model class. Given below is a sample validation. Follow this approach to perform validations.

For example, adding attribute-level annotation for model class ExtendedSoftwareStatementBody to validate the issuer in the software statement assertion (SSA).

public class ExtendedSoftwareStatementBody extends SoftwareStatementBody {

  private String iss;

  @SerializedName("logo_uri")
  private String logoUri;

  // Follow the above and add any field according to your specification requirements

  @ValidateSSAIssuer(message = "Invalid Issuer in software statement:" + DCRCommonConstants.INVALID_META_DATA,
    groups = AttributeChecks.class)
  @NotBlank(message = "Issuer Roles can not be null or empty in SSA:" + DCRCommonConstants.INVALID_META_DATA,
    groups = MandatoryChecks.class)
  public String getIss() {

    return iss;
  }

  public void setIss(String iss) {

    this.iss = iss;
  }

}

• Annotation class for ValidateSSAIssuer

@Target(ElementType.METHOD)
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy = {
  SSAIssuerValidator.class
})
public @interface ValidateSSAIssuer {

  String message() default "Invalid issuer in software statement";

  Class < ? > [] groups() default {};

  Class < ? extends Payload > [] payload() default {};
}

• SAIssuerValidator to perform the validation logic

public class SSAIssuerValidator implements ConstraintValidator < ValidateSSAIssuer, Object > {

  private static final Log log = LogFactory.getLog(SSAIssuerValidator.class);

  @Override
  public boolean isValid(Object issuer, ConstraintValidatorContext constraintValidatorContext) {

    return CDSValidationConstants.CDR_REGISTER.equals(issuer);
  }

}

• Set the registration response using the ExtendedRegistrationResponse class and its getRegistrationResponse method as shown below.

public class ExtendedRegistrationValidatiorImpl extends DefaultRegistrationValidatorImpl {

  @Override
  public String getRegistrationResponse(Map < String, Object > spMetaData) {

    Gson gson = new Gson();
    JsonElement jsonElement = gson.toJsonTree(spMetaData);
    ExtendedRegistrationResponse extendedRegistrationResponse = gson.fromJson(jsonElement, ExtendedRegistrationResponse.class);
    return gson.toJson(extendedRegistrationResponse);
  }

}

• To implement the ExtendedRegistrationResponse class, extend RegistrationResponse as follows:

public class ExtendedRegistrationResponse extends RegistrationResponse {

  @SerializedName(value = "client_name")
  private String clientName;

  @SerializedName("client_description")
  private String clientDescription;

  @SerializedName("client_uri")
  private String clientUri;

  // Add getters and setters according to your requirements

}