hatter/tiny-encrypt-java
1
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

feat: update spec

Browse Source
This commit is contained in:
Hatter Jiang
2023-09-02 00:47:50 +08:00
parent abb2480b0d
commit edeff5c265
1 changed files with 27 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
TinyEncryptSpecV1.1.md
View File

@@ -12,32 +12,33 @@ File format:
Meta format:
| Field | Type | Comment |
|------------------|-----------|----------------------------------------------|
| version | String | Constant value: `1.1` |
| created | Long | Created time, Unix Epoch |
| userAgent | String | User Agent, e.g. `TinyEncrypt v0.5.1@MacOS` |
| comment | String | `optional` Plain text comment |
| encryptedComment | String | `optional` Encrypted comment |
| encryptedMeta | String | `optional` Encrypted Meta Data |
| pgpEnvelop | String | `deprecated` PGP Publickey Encrypted DataKey |
| pgpFingerprint | String | `deprecated` Hex(Sha256(PGP Publickey)) |
| ageEnvelop | String | `deprecated` PGP Publickey Encrypted DataKey |
| ageRecipient | String | `deprecated` age1*** |
| ecdhEnvelop | String | `deprecated` KW:*** |
| ecdhPoint | String | `deprecated` 02*** |
| envelop | String | `deprecated` KMS Encrypted DataKey |
| envelops | Envelop[] | Envelop Array |
| nonce | String | `base64` GCM Nonce |
| fileLength | Long | File Length |
| fileLastModified | Long | File Last Modified, Unix Epoch |
| compress | Boolean | Compressed or Not, GZIP if `true` |
| Field | Type | Comment |
|---------------------|-----------|----------------------------------------------|
| version | String | Constant value: `1.1` |
| created | Long | Created time, Unix Epoch |
| userAgent | String | User Agent, e.g. `TinyEncrypt v0.5.1@MacOS` |
| comment | String | `optional` Plain text comment |
| encryptedComment | String | `optional` Encrypted comment |
| encryptedMeta | String | `optional` Encrypted Meta Data |
| pgpEnvelop | String | `deprecated` PGP Publickey Encrypted DataKey |
| pgpFingerprint | String | `deprecated` Hex(Sha256(PGP Publickey)) |
| ageEnvelop | String | `deprecated` PGP Publickey Encrypted DataKey |
| ageRecipient | String | `deprecated` age1*** |
| ecdhEnvelop | String | `deprecated` KW:*** |
| ecdhPoint | String | `deprecated` 02*** |
| envelop | String | `deprecated` KMS Encrypted DataKey |
| envelops | Envelop[] | Envelop Array |
| encryptionAlgorithm | String | `optional` Default `AES/GCM` |
| nonce | String | `base64` GCM Nonce |
| fileLength | Long | File Length |
| fileLastModified | Long | File Last Modified, Unix Epoch |
| compress | Boolean | Compressed or Not, GZIP if `true` |
Envelop format:
| Field | Type | Comment |
|--------------|--------|-------------------------|
| type | String | Type: `kms`, `pgp`, ... |
| kid | String | Key ID |
| desc | String | `optional` Description |
| encryptedKey | String | `base64` Encrypted Key |
| Field | Type | Comment |
|--------------|--------|----------------------------------------|
| type | String | Type: `kms`, `pgp`, `age`, `ecdh`, ... |
| kid | String | Key ID |
| desc | String | `optional` Description |
| encryptedKey | String | `base64` Encrypted Key |