ironcore-documents 0.3.0-pre.0

A library for working with IronCore Labs documents and header formats.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

syntax = "proto3";

package ironcorelabs.proto;
option java_package = "com.ironcorelabs.proto";

import "dcp_edek.proto";
import "cmk_edek.proto";

message V4DocumentHeader {

  message SignatureInformation {
    enum SignatureType {
      NONE = 0;
      HS256 = 1;
    }
    bytes signature = 1;
    SignatureType signature_type = 2;
  }

  message EdekWrapper {
    message Aes256GcmEncryptedDek {
      bytes iv = 1;
      bytes ciphertext = 2;
      string id = 3;
    }

    oneof edek {
      ironcorelabs.proto.dcp.EncryptedDeks dcp_edek = 1;
      ironcorelabs.proto.cmk.EncryptedDek cmk_edek = 2;
      Aes256GcmEncryptedDek aes_256_gcm_edek = 3;
    }
  }

  // This is a message instead of inlining the algo to support the expansion
  // into streaming and chunking.
  message EncryptionInformation {
    enum EncryptionAlgorithm {
      UNKNOWN = 0;
      AES256_GCM = 1;
    }
    EncryptionAlgorithm algorithm = 1;
  }

  message SignedPayload {
    EncryptionInformation encryption_info = 1;
    repeated EdekWrapper edeks = 2;
    // A spot for users to put information they care about keeping with the dek.
    // An ICL application should not parse or look at this data.
    map<string, string> user_metadata = 3;
  }

  SignatureInformation signature_info = 1;
  SignedPayload signed_payload = 2;
}