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

Jump to bottom

fix: remove iv reference from encryptionInformation.method #23

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

fix: remove iv reference from encryptionInformation.method #23

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 2 additions & 4 deletions schema/tdf/manifest-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,21 +55,19 @@ Contains information describing the method of encryption. As well as information
|`policy`|String|The policy object which has been JSON stringified, then base64 encoded. The policy object is described in its own section: [Policy Object](PolicyObject.md)|

## encryptionInformation.method
An object which describes the information required to actually decrypt the payload once the key is retrieved. Includes the algorithm, and iv at a minimum.
An object which describes the information required to actually decrypt the payload once the key is retrieved. Includes the algorithm and isStreamable.

```javascript
"method": {
"algorithm": "AES-256-GCM",
"isStreamable": true,
"iv": "D6s7cSgFXzhVkran"
"isStreamable": true
}
```

|Parameter|Type|Description|
|---|---|---|
|`algorithm`|String|The algorithm used for encryption. Currently the two available options are `aes-256-gcm`.|
|`isStreamable`|Boolean|`isStreamable` designates whether or not a TDF payload is streamable. If it's streamable, the payload is broken into chunks, and individual hashes are generated per chunk to establish integrity of the individual chunks.|
|`iv`|String|The initialization vector for the encrypted payload.|

## encryptionInformation.integrityInformation
An object which allows an application to validate the integrity of the payload, or a chunk of a payload should it be a streamable TDF.
Expand Down