aboutsummaryrefslogtreecommitdiff
path: root/protocols/service/crypto/protobuf/key_attributes.proto
blob: bae948b5ccb5d2be05c01abeb44acce79ccc1f3d (plain)
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*
 * Copyright (c) 2020-2021, Arm Limited and Contributors. All rights reserved.
 * SPDX-License-Identifier: BSD-3-Clause
 */
syntax = "proto3";

package ts_crypto;

/* Key types */
enum KeyType {
  option allow_alias = true;

  KEY_TYPE_NONE                   = 0x0000;
  KEY_TYPE_RAW_DATA               = 0x1001;
  KEY_TYPE_HMAC                   = 0x1100;
  KEY_TYPE_DERIVE                 = 0x1200;
  KEY_TYPE_AES                    = 0x2400;
  KEY_TYPE_DES                    = 0x2301;
  KEY_TYPE_CAMELLIA               = 0x2403;
  KEY_TYPE_ARC4                   = 0x2002;
  KEY_TYPE_CHACHA20               = 0x2004;
  KEY_TYPE_RSA_PUBLIC_KEY         = 0x4001;
  KEY_TYPE_RSA_KEY_PAIR           = 0x7001;
  KEY_TYPE_ECC_PUBLIC_KEY_BASE    = 0x4100;
  KEY_TYPE_ECC_KEY_PAIR_BASE      = 0x7100;
  KEY_TYPE_ECC_CURVE_MASK         = 0x00ff;
  KEY_TYPE_DH_PUBLIC_KEY_BASE     = 0x4200;
  KEY_TYPE_DH_KEY_PAIR_BASE       = 0x7200;
  KEY_TYPE_DH_GROUP_MASK          = 0x00ff;
}

/* ECC curves for use with ECC Key types */
enum EccCurve {
  ECC_CURVE_NONE                  = 0x00;
  ECC_CURVE_SECP_K1               = 0x17;
  ECC_CURVE_SECP_R1               = 0x12;
  ECC_CURVE_SECP_R2               = 0x1b;
  ECC_CURVE_SECT_K1               = 0x27;
  ECC_CURVE_SECT_R1               = 0x22;
  ECC_CURVE_SECT_R2               = 0x2b;
  ECC_CURVE_BRAINPOOL_P_R1        = 0x30;
  ECC_CURVE_MONTGOMERY            = 0x41;
}

/* Diffie-Hellman groups for use with DH key types */
enum DhGroup {
  DH_GROUP_NONE                   = 0x00;
  DH_GROUP_RFC7919                = 0x03;
}

/* Crypto algorithms */
enum Alg {
  ALG_NONE                        = 0x00000000;
  ALG_HASH_MASK                   = 0x000000ff;
  ALG_MD2                         = 0x01000001;
  ALG_MD4                         = 0x01000002;
  ALG_MD5                         = 0x01000003;
  ALG_RIPEMD160                   = 0x01000004;
  ALG_SHA_1                       = 0x01000005;
  ALG_SHA_224                     = 0x01000008;
  ALG_SHA_256                     = 0x01000009;
  ALG_SHA_384                     = 0x0100000a;
  ALG_SHA_512                     = 0x0100000b;
  ALG_SHA_512_224                 = 0x0100000c;
  ALG_SHA_512_256                 = 0x0100000d;
  ALG_SHA3_224                    = 0x01000010;
  ALG_SHA3_256                    = 0x01000011;
  ALG_SHA3_384                    = 0x01000012;
  ALG_SHA3_512                    = 0x01000013;
  ALG_CBC_MAC                     = 0x02c00001;
  ALG_CMAC                        = 0x02c00002;
  ALG_ARC4                        = 0x04800001;
  ALG_CHACHA20                    = 0x04800005;
  ALG_CTR                         = 0x04c00001;
  ALG_CFB                         = 0x04c00002;
  ALG_OFB                         = 0x04c00003;
  ALG_XTS                         = 0x044000ff;
  ALG_CBC_NO_PADDING              = 0x04600100;
  ALG_CBC_PKCS7                   = 0x04600101;
  ALG_AEAD_FROM_BLOCK_FLAG        = 0x00400000;
  ALG_CCM                         = 0x06401001;
  ALG_GCM                         = 0x06401002;
  ALG_CHACHA20_POLY1305           = 0x06001005;
  ALG_RSA_PKCS1V15_SIGN_BASE      = 0x10020000;
  ALG_RSA_PSS_BASE                = 0x10030000;
  ALG_ECDSA_BASE                  = 0x10060000;
  ALG_DETERMINISTIC_ECDSA_BASE    = 0x10070000;
  ALG_RSA_PKCS1V15_CRYPT          = 0x12020000;
  ALG_RSA_OAEP_BASE               = 0x12030000;
  ALG_HKDF_BASE                   = 0x20000100;
  ALG_TLS12_PRF_BASE              = 0x20000200;
  ALG_TLS12_PSK_TO_MS_BASE        = 0x20000300;
  ALG_KEY_DERIVATION_MASK         = 0x0803ffff;
  ALG_KEY_AGREEMENT_MASK          = 0x10fc0000;
  ALG_FFDH                        = 0x30100000;
  ALG_ECDH                        = 0x30200000;
}

/* Key lifetime */
enum KeyLifetime {
  KEY_LIFETIME_VOLATILE           = 0x00000000;
  KEY_LIFETIME_PERSISTENT         = 0x00000001;
}

/* Key usage constraints */
enum KeyUsage {
  KEY_USAGE_NONE                  = 0x00000000;
  KEY_USAGE_EXPORT                = 0x00000001;
  KEY_USAGE_COPY                  = 0x00000002;
  KEY_USAGE_ENCRYPT               = 0x00000100;
  KEY_USAGE_DECRYPT               = 0x00000200;
  KEY_USAGE_SIGN_HASH             = 0x00000400;
  KEY_USAGE_VERIFY_HASH           = 0x00000800;
  KEY_USAGE_DERIVE                = 0x00001000;
}

/* Key policy to define what key can be used for */
message KeyPolicy {
  uint32 usage = 1;
  uint32 alg = 2;
}

/* Key attributes object */
message KeyAttributes {
  uint32 type = 1;
  uint32 key_bits = 2;
  uint32 lifetime = 3;
  uint32 id = 4;
  KeyPolicy policy = 5;
}