io.mosip.certify.sunbirdrc.integration.service.SunbirdRCVCIssuancePlugin Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sunbird-rc-certify-integration-impl Show documentation
Show all versions of sunbird-rc-certify-integration-impl Show documentation
Sunbird-RC plugin implementation that is used for the integration with certify
The newest version!
/*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
*/
package io.mosip.certify.sunbirdrc.integration.service;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import foundation.identity.jsonld.JsonLDObject;
import io.mosip.certify.api.dto.VCRequestDto;
import io.mosip.certify.api.dto.VCResult;
import io.mosip.certify.api.exception.VCIExchangeException;
import io.mosip.certify.api.spi.VCIssuancePlugin;
import io.mosip.certify.api.util.ErrorConstants;
import io.mosip.certify.sunbirdrc.integration.dto.RegistrySearchRequestDto;
import jakarta.annotation.PostConstruct;
import lombok.extern.slf4j.Slf4j;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.apache.velocity.runtime.RuntimeConstants;
import org.apache.velocity.runtime.resource.loader.URLResourceLoader;
import org.apache.velocity.tools.generic.DateTool;
import org.json.JSONArray;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.core.env.Environment;
import org.springframework.http.MediaType;
import org.springframework.http.RequestEntity;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.util.UriComponentsBuilder;
import java.io.IOException;
import java.io.InputStream;
import java.io.StringWriter;
import java.net.URL;
import java.net.URLConnection;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@ConditionalOnProperty(value = "mosip.certify.integration.vci-plugin", havingValue = "SunbirdRCVCIssuancePlugin")
@Component
@Slf4j
public class SunbirdRCVCIssuancePlugin implements VCIssuancePlugin {
private static final String CREDENTIAL_TYPE_PROPERTY_PREFIX ="mosip.certify.vciplugin.sunbird-rc.credential-type";
private static final String LINKED_DATA_PROOF_VC_FORMAT ="ldp_vc";
private static final String TEMPLATE_URL = "template-url";
private static final String REGISTRY_GET_URL = "registry-get-url";
private static final String REGISTRY_SEARCH_URL= "registry-search-url";
private static final String CRED_SCHEMA_ID = "cred-schema-id";
private static final String CRED_SCHEMA_VESRION = "cred-schema-version";
private static final String STATIC_VALUE_MAP_ISSUER_ID = "static-value-map.issuerId";
private static final String CREDENTIAL_OBJECT_KEY = "credential";
private final String FILTER_EQUALS_OPERATOR = "eq";
private final String PSUT_TOKEN="psut";
@Autowired
Environment env;
@Autowired
ObjectMapper mapper;
@Autowired
private RestTemplate restTemplate;
@Value("${mosip.certify.vciplugin.sunbird-rc.issue-credential-url}")
String issueCredentialUrl;
@Value("${mosip.certify.vciplugin.sunbird-rc.enable-psut-based-registry-search:false}")
private boolean enablePSUTBasedRegistrySearch;
@Value("#{'${mosip.certify.vciplugin.sunbird-rc.supported-credential-types}'.split(',')}")
List supportedCredentialTypes;
private final Map credentialTypeTemplates = new HashMap<>();
private final Map> credentialTypeConfigMap = new HashMap<>();
private VelocityEngine vEngine;
@PostConstruct
public void initialize() throws VCIExchangeException {
vEngine = new VelocityEngine();
URLResourceLoader urlResourceLoader = new URLResourceLoader() {
@Override
public InputStream getResourceStream(String name) throws ResourceNotFoundException {
try {
URL url = new URL(name);
URLConnection connection = url.openConnection();
return connection.getInputStream();
} catch (IOException e) {
throw new ResourceNotFoundException("Unable to find resource '" + name + "'");
}
}
};
vEngine.setProperty(RuntimeConstants.RESOURCE_LOADER, "url");
vEngine.setProperty("url.resource.loader.instance", urlResourceLoader);
vEngine.init();
//Validate all the supported VC
for (String credentialType : supportedCredentialTypes) {
validateAndCachePropertiesForCredentialType(credentialType.trim());
}
}
@Override
public VCResult getVerifiableCredentialWithLinkedDataProof(VCRequestDto vcRequestDto, String holderId, Map identityDetails) throws VCIExchangeException {
if (vcRequestDto == null || vcRequestDto.getType() == null) {
throw new VCIExchangeException(ErrorConstants.VCI_EXCHANGE_FAILED);
}
List types = vcRequestDto.getType();
if (types.isEmpty() || !types.get(0).equals("VerifiableCredential")) {
log.error("Invalid request: first item in type is not VerifiableCredential");
throw new VCIExchangeException(ErrorConstants.VCI_EXCHANGE_FAILED);
}
types.remove(0);
String requestedCredentialType = String.join("-", types);
//Check if the key is in the supported-credential-types
if (!supportedCredentialTypes.contains(requestedCredentialType)) {
log.error("Credential type is not supported");
throw new VCIExchangeException(ErrorConstants.VCI_EXCHANGE_FAILED);
}
//Validate context of vcrequestdto with template
List contextList=vcRequestDto.getContext();
for(String supportedType:supportedCredentialTypes){
Template template= credentialTypeTemplates.get(supportedType);
validateContextUrl(template,contextList);
}
String registrySearchField = (identityDetails.containsKey("sub")) ? (String) identityDetails.get("sub") : null;
if (registrySearchField == null) {
log.error("Invalid request: registrySearchField is null");
throw new VCIExchangeException(ErrorConstants.VCI_EXCHANGE_FAILED);
}
Map responseRegistryMap;
if(enablePSUTBasedRegistrySearch){
String registrySearchUrl=credentialTypeConfigMap.get(requestedCredentialType).get(REGISTRY_SEARCH_URL);
responseRegistryMap= fetchRegistryObjectByPSUT(registrySearchUrl,registrySearchField);
}else {
String registryUrl=credentialTypeConfigMap.get(requestedCredentialType).get(REGISTRY_GET_URL);
responseRegistryMap =fetchRegistryObject(registryUrl+ registrySearchField);
}
Map credentialRequestMap = createCredentialIssueRequest(requestedCredentialType, responseRegistryMap,vcRequestDto,holderId);
Map vcResponseMap =sendCredentialIssueRequest(credentialRequestMap);
VCResult vcResult = new VCResult();
JsonLDObject vcJsonLdObject = JsonLDObject.fromJsonObject((Map)vcResponseMap.get(CREDENTIAL_OBJECT_KEY));
vcResult.setCredential(vcJsonLdObject);
vcResult.setFormat(LINKED_DATA_PROOF_VC_FORMAT);
return vcResult;
}
@Override
public VCResult getVerifiableCredential(VCRequestDto vcRequestDto, String holderId, Map identityDetails) throws VCIExchangeException {
throw new VCIExchangeException(ErrorConstants.NOT_IMPLEMENTED);
}
private Map fetchRegistryObject(String entityUrl) throws VCIExchangeException {
RequestEntity requestEntity = RequestEntity
.get(UriComponentsBuilder.fromUriString(entityUrl).build().toUri()).build();
ResponseEntity> responseEntity = restTemplate.exchange(requestEntity,
new ParameterizedTypeReference>() {});
if (responseEntity.getStatusCode().is2xxSuccessful() && responseEntity.getBody() != null) {
return responseEntity.getBody();
}else {
log.error("Sunbird service is not running. Status Code: " ,responseEntity.getStatusCode());
throw new VCIExchangeException(ErrorConstants.VCI_EXCHANGE_FAILED);
}
}
private Map fetchRegistryObjectByPSUT(String registrySearchUrl, String psut) throws VCIExchangeException {
RegistrySearchRequestDto registrySearchRequestDto=new RegistrySearchRequestDto();
registrySearchRequestDto.setOffset(0);
registrySearchRequestDto.setLimit(2);
Map> filter=new HashMap<>();
Map psutFilter=new HashMap<>();
psutFilter.put(FILTER_EQUALS_OPERATOR ,psut);
filter.put(PSUT_TOKEN ,psutFilter);
registrySearchRequestDto.setFilters(filter);
RequestEntity requestEntity =RequestEntity.post(UriComponentsBuilder.fromUriString(registrySearchUrl).build().toUri())
.contentType(MediaType.APPLICATION_JSON_UTF8)
.body(registrySearchRequestDto);
ResponseEntity>> responseEntity = restTemplate.exchange(requestEntity,
new ParameterizedTypeReference>>() {});
if (responseEntity.getStatusCode().is2xxSuccessful() && responseEntity.getBody() != null) {
List> responseList = responseEntity.getBody();
if(responseList.size()==1){
//TODO This need to be removed since it can contain PII
log.debug("getting response {}", responseEntity);
}else{
log.debug("Registry search returns more than one match,So taking the first. Result size: " + responseList.size());
log.debug("getting response {}", responseEntity);
//Todo we should find a generic way to sort desc based on created date. The idea is we give out the most recent record as VC
}
return responseList.get(0);
}else {
log.error("Sunbird service is not running. Status Code: " ,responseEntity.getStatusCode());
throw new VCIExchangeException(ErrorConstants.VCI_EXCHANGE_FAILED);
}
}
private Map createCredentialIssueRequest(String requestedCredentialType, Map registryObjectMap, VCRequestDto vcRequestDto, String holderId) throws VCIExchangeException {
Template template=credentialTypeTemplates.get(requestedCredentialType);
Map configMap=credentialTypeConfigMap.get(requestedCredentialType);
StringWriter writer = new StringWriter();
VelocityContext context = new VelocityContext();
Map requestMap=new HashMap<>();
context.put("date", new DateTool());
context.put("issuerId", configMap.get(STATIC_VALUE_MAP_ISSUER_ID));
for (Map.Entry entry : registryObjectMap.entrySet()) {
String key = entry.getKey();
Object value = entry.getValue();
if (value instanceof List) {
JSONArray jsonArray = new JSONArray((List) value);
context.put(key, jsonArray);
} else {
context.put(key, value);
}
}
template.merge(context, writer);
try{
Map credentialObject =mapper.readValue(writer.toString(),Map.class);
((Map) credentialObject.get("credentialSubject")).put("id", holderId);
requestMap.put("credential", credentialObject);
requestMap.put("credentialSchemaId",configMap.get(CRED_SCHEMA_ID));
requestMap.put("credentialSchemaVersion",configMap.get(CRED_SCHEMA_VESRION));
requestMap.put("tags",new ArrayList<>());
}catch (JsonProcessingException e){
log.error("Error while parsing the template ",e);
throw new VCIExchangeException(ErrorConstants.VCI_EXCHANGE_FAILED);
}
//TODO This need to be removed since it can contain PII
log.info("VC requset is {}",requestMap);
return requestMap;
}
private Map sendCredentialIssueRequest(Map credentialRequestMap) throws VCIExchangeException {
try{
String requestBody=mapper.writeValueAsString(credentialRequestMap);
RequestEntity requestEntity = RequestEntity
.post(UriComponentsBuilder.fromUriString(issueCredentialUrl).build().toUri())
.contentType(MediaType.APPLICATION_JSON_UTF8)
.body(requestBody);
ResponseEntity> responseEntity = restTemplate.exchange(requestEntity,
new ParameterizedTypeReference>(){});
if (responseEntity.getStatusCode().is2xxSuccessful() && responseEntity.getBody() != null){
//TODO This need to be removed since it can contain PII
log.debug("getting response {}", responseEntity);
return responseEntity.getBody();
}else{
log.error("Sunbird service is not running. Status Code: " , responseEntity.getStatusCode());
throw new VCIExchangeException(ErrorConstants.VCI_EXCHANGE_FAILED);
}
}catch (Exception e){
log.error("Unable to parse the Registry Object :{}",credentialRequestMap);
throw new VCIExchangeException(ErrorConstants.VCI_EXCHANGE_FAILED);
}
}
private void validateAndCachePropertiesForCredentialType(String credentialType) throws VCIExchangeException {
Map configMap=new HashMap<>();
validateAndLoadProperty(CREDENTIAL_TYPE_PROPERTY_PREFIX + "." + credentialType + "." + TEMPLATE_URL,TEMPLATE_URL,configMap);
validateAndLoadProperty(CREDENTIAL_TYPE_PROPERTY_PREFIX + "." + credentialType + "." + REGISTRY_GET_URL,REGISTRY_GET_URL,configMap);
validateAndLoadProperty(CREDENTIAL_TYPE_PROPERTY_PREFIX + "." + credentialType + "." + CRED_SCHEMA_ID,CRED_SCHEMA_ID,configMap);
validateAndLoadProperty(CREDENTIAL_TYPE_PROPERTY_PREFIX + "." + credentialType + "." + CRED_SCHEMA_VESRION,CRED_SCHEMA_VESRION,configMap);
validateAndLoadProperty(CREDENTIAL_TYPE_PROPERTY_PREFIX + "." + credentialType + "." + STATIC_VALUE_MAP_ISSUER_ID,STATIC_VALUE_MAP_ISSUER_ID,configMap);
validateAndLoadProperty(CREDENTIAL_TYPE_PROPERTY_PREFIX + "." + credentialType + "." + REGISTRY_SEARCH_URL,REGISTRY_SEARCH_URL,configMap);
String templateUrl = env.getProperty(CREDENTIAL_TYPE_PROPERTY_PREFIX +"." + credentialType + "." + TEMPLATE_URL);
validateAndCacheTemplate(templateUrl,credentialType);
// cache configuration with their credential type
credentialTypeConfigMap.put(credentialType,configMap);
}
private void validateAndLoadProperty(String propertyName, String credentialProp, Map configMap) throws VCIExchangeException {
String propertyValue = env.getProperty(propertyName);
if (propertyValue == null || propertyValue.isEmpty()) {
throw new VCIExchangeException("Property " + propertyName + " is not set Properly.");
}
configMap.put(credentialProp,propertyValue);
}
private void validateAndCacheTemplate(String templateUrl, String credentialType){
Template template = vEngine.getTemplate(templateUrl);
//Todo Validate if all the templates are valid JSON-LD documents
credentialTypeTemplates.put(credentialType, template);
}
private void validateContextUrl(Template template,List vcRequestContextList) throws VCIExchangeException {
try{
StringWriter writer = new StringWriter();
template.merge(new VelocityContext(),writer);
Map templateMap = mapper.readValue(writer.toString(),Map.class);
List contextList=(List) templateMap.get("@context");
for(String contextUrl:vcRequestContextList){
if(!contextList.contains(contextUrl)){
log.error("ContextUrl is not supported");
throw new VCIExchangeException(ErrorConstants.VCI_EXCHANGE_FAILED);
}
}
}catch ( JsonProcessingException e){
log.error("Error while parsing the template ",e);
throw new VCIExchangeException(ErrorConstants.VCI_EXCHANGE_FAILED);
}
}
}