Key Manager Service (1.0)

Download OpenAPI specification:Download

License: Mosip

Rest Endpoints for operations related to key management and crypto operations

signaturecontroller

Operation related to signature

Function to validate signature Deprecated

Function to validate signature

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TimestampRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"signature": "string",
"data": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
}

Function to sign response Deprecated

Function to sign response

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (SignRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"data": "string"
}
}

Function to sign PDF

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PDFSignatureRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"applicationId": "string",
"referenceId": "string",
"timeStamp": "string",
"data": "string",
"lowerLeftX": 2147483647,
"lowerLeftY": 2147483647,
"upperRightX": 2147483647,
"upperRightY": 2147483647,
"reason": "string",
"pageNumber": 2147483647,
"password": "string"
}
}

Function to JWT Signature verification

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (JWTSignatureVerifyRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"jwtSignatureData": "string",
"actualData": "string",
"applicationId": "string",
"referenceId": "string",
"certificateData": "string",
"validateTrust": true,
"domain": "string"
}
}

TFunction to JWT sign datas

Function to JWT sign data

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (JWTSignatureRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"dataToSign": "string",
"applicationId": "string",
"referenceId": "string",
"includePayload": true,
"includeCertificate": true,
"includeCertHash": true,
"certificateUrl": "string"
}
}

Function to do JSON Web Signature(JWS) for the inputted data using inputted algorithm. Default Algorithm PS256.

Function to JWT sign data

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (JWSSignatureRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"dataToSign": "string",
"applicationId": "string",
"referenceId": "string",
"includePayload": true,
"includeCertificate": true,
"includeCertHash": true,
"certificateUrl": "string",
"validateJson": true,
"b64JWSHeaderParam": true,
"signAlgorithm": "string"
}
}

tokenidgenerator

Operation related to tokenid generator

Function to generate token id

path Parameters

uin required	string
partnercode required	string

Responses

clientcrypto

Operation related to offline Encryption and Decryption

Get signinging public key

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PublicKeyRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"serverProfile": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"publicKey": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Get encryption public key

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (PublicKeyRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"serverProfile": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"publicKey": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Encrypt data using tpm

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TpmCryptoRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"value": "string",
"publicKey": "string",
"tpm": true
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"value": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Decrypt data using tpm

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TpmCryptoRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"value": "string",
"publicKey": "string",
"tpm": true
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"value": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Verify signature

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TpmSignVerifyRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"data": "string",
"signature": "string",
"publicKey": "string",
"tpm": true
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"verified": true
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Sign data using tpm

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (TpmSignRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"data": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"data": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

cryptomanager

Operation related to Encryption and Decryption

Encrypt the data

Request Body schema: application/json

id	string
version	string
requesttime	string

Home

Key Manager Service (1.0)

signaturecontroller

Function to validate signature Deprecated

Request Body schema: application/json

Responses

Request samples

Function to sign response Deprecated

Request Body schema: application/json

Responses

Request samples

Function to sign PDF

Request Body schema: application/json

Responses

Request samples

Function to JWT Signature verification

Request Body schema: application/json

Responses

Request samples

TFunction to JWT sign datas

Request Body schema: application/json

Responses

Request samples

Function to do JSON Web Signature(JWS) for the inputted data using inputted algorithm. Default Algorithm PS256.

Request Body schema: application/json

Responses

Request samples

tokenidgenerator

Function to generate token id

path Parameters

Responses

clientcrypto

Get signinging public key

Request Body schema: application/json

Responses

Request samples

Response samples

Get encryption public key

Request Body schema: application/json

Responses

Request samples

Response samples

Encrypt data using tpm

Request Body schema: application/json

Responses

Request samples

Response samples

Decrypt data using tpm

Request Body schema: application/json

Responses

Request samples

Response samples

Verify signature

Request Body schema: application/json

Responses

Request samples

Response samples

Sign data using tpm

Request Body schema: application/json

Responses

Request samples

Response samples

cryptomanager

Encrypt the data

Request Body schema: application/json