diff --git a/README.md b/README.md index 0e575e1..c5ffac5 100644 --- a/README.md +++ b/README.md @@ -132,3 +132,7 @@ Meta format: | fileLastModified | Long | File last modified, Unix Epoch, in millis | | compress | Boolean | Compressed or not | + +
+ +Tiny encrypt specification v1.1: [TinyEncryptSpecv1.1.md](https://github.com/OpenWebStandard/tiny-encrypt-format-spec/blob/main/TinyEncryptSpecv1.1.md) diff --git a/TinyEncryptSpecV1.1.md b/TinyEncryptSpecV1.1.md deleted file mode 100644 index 04fdade..0000000 --- a/TinyEncryptSpecV1.1.md +++ /dev/null @@ -1,44 +0,0 @@ - -File ext: `*.tinyenc` - -File format: - -```text -[TAG; 2 bytes; u16; BE; Always 1] -[LENGTH; 4 bytes; u32; BE] -[META DATA; LENGTH bytes] -[ENCRYPTED_DATA; n bytes; AES/GCM] -``` - -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 | -| 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`, `age`, `ecdh`, ... | -| kid | String | Key ID | -| desc | String | `optional` Description | -| encryptedKey | String | `base64` Encrypted Key | \ No newline at end of file