Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update abis-api.md #317

Open
wants to merge 1 commit into
base: 1.2.0
Choose a base branch
from
Open

Update abis-api.md #317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions docs/abis-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,9 +203,6 @@ Below is the sample API detail for reference URL.

**Sample Encrypted Response**

```
```

{% hint style="info" %}
**The structure of the encrypted data downloaded from referenceURL in MOSIP 1.2.0 or later versions**

Expand All @@ -232,8 +229,12 @@ Block 2, i.e. the encrypted actual data is again split into two parts,
* The 1st part is the random 32 bytes which will be used as _**AAD**_ in AES encryption(first 32 bytes). From this 32 bytes AAD data, the first 12 bytes is _**IV/Nonce**_.
* The 2nd part is the encrypted data which is encrypted using AES GCM PKCS5Padding.

**Note:** In Java 11, for GCM mode encryption, PKCS5Padding is alternate to NoPadding. In Java 17, PKCS5Padding as an
alternate is removed and instead **NoPadding** is used. However, the data is encrypted using PKCS5Padding in Java 11
and the data is decrypted with **NoPadding** in Java 17.

**The structure of the encrypted data downloaded from referenceURL in MOSIP 1.1.5.5 or prior versions**

{% hint style="info" %} **The structure of the encrypted data downloaded from referenceURL in MOSIP 1.1.5.5 or prior versions**

The data downloaded would be base64 encoded. Hence, after decoding the data will be in the below format. It will be divided into two Parts after splitting using #KEY\_SPLITTER#.
{% endhint %}
Expand All @@ -255,6 +256,10 @@ Block 1, i.e. the encrypted key data is again split into two parts,
Block 2, i.e. the encrypted actual data is again split into two parts,

* The 1st part is the _**Encrypted data**_, encrypted using AES GCM PKCS5Padding.

**Note:** In Java 11, for GCM mode encryption, PKCS5Padding is alternate to NoPadding. In Java 17, PKCS5Padding as an
alternate is removed and instead **NoPadding** is used. However, the data is encrypted using PKCS5Padding in Java 11
and the data is decrypted with **NoPadding** in Java 17.
* The 2nd part is _**IV/Nonce**_ i.e. the last 32 bytes appended after encrypted data.
{% endhint %}

Expand Down