• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Copyright 2022 Google LLC
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#      http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14"""Primitive Creation consistency tests."""
15
16from typing import Any
17
18from absl.testing import absltest
19from absl.testing import parameterized
20import tink
21from tink import aead
22from tink import daead
23from tink import hybrid
24from tink import jwt
25from tink import mac
26from tink import prf
27from tink import signature
28from tink import streaming_aead
29
30from tink.proto import tink_pb2
31import tink_config
32from util import test_keys
33from util import testing_servers
34from util import utilities
35
36# We register the primitives here because creation of the keysets happens
37# before "setUpModule" is called.
38aead.register()
39daead.register()
40jwt.register_jwt_mac()
41jwt.register_jwt_signature()
42mac.register()
43hybrid.register()
44prf.register()
45signature.register()
46streaming_aead.register()
47
48
49def setUpModule():
50  testing_servers.start('primitive_creation')
51
52
53def tearDownModule():
54  testing_servers.stop()
55
56
57def single_key_keysets():
58  """Produces single key keysets which can be produced from a template.
59
60  This does not produce keysets which have public keys.
61  Yields:
62    valid keysets generated from templates
63  """
64  for _, template in utilities.KEY_TEMPLATE.items():
65    yield test_keys.new_or_stored_keyset(template)
66
67
68def named_testcases():
69  case_num = 0
70  for lang in utilities.ALL_LANGUAGES:
71    for keyset in single_key_keysets():
72      for primitive in tink_config.all_primitives():
73        yield {
74            'testcase_name':
75                str(case_num) + '-' + lang + '-' + primitive.__name__ + '-' +
76                utilities.key_types_in_keyset(keyset)[0],
77            'lang':
78                lang,
79            'primitive':
80                primitive,
81            'keyset':
82                keyset,
83        }
84        case_num += 1
85
86
87class SupportedKeyTypesTest(parameterized.TestCase):
88  """Tests if creation of primitives succeeds as described in tink_config.
89
90  This test tries to see if creation of primitives is consistent with what is
91  configured in tink_config._key_types. For this, we enumerate as many triples
92  (lang, keyset, primitive) as possible, and compute, for each of them, the
93  expected result from the config, and the actual result by creating the
94  primitive.
95  """
96
97  @parameterized.named_parameters(named_testcases())
98  def test_create(self, lang: str, keyset: bytes, primitive: Any):
99    """Tests primitive creation (see top level comment).
100
101    This test should pass for every keyset, as long as the keyset can be
102    correctly parsed.
103
104    Args:
105      lang: The language to test
106      keyset: A byte string representing a keyset. The keyset needs to be valid.
107      primitive: The primitive to try and instantiate
108    """
109    keytypes = utilities.key_types_in_keyset(keyset)
110    keytype = keytypes[0]
111
112    if (lang in tink_config.supported_languages_for_key_type(keytype) and
113        primitive == tink_config.primitive_for_keytype(keytype)):
114      _ = testing_servers.remote_primitive(lang, keyset, primitive)
115    else:
116      with self.assertRaises(tink.TinkError):
117        _ = testing_servers.remote_primitive(lang, keyset, primitive)
118
119  @parameterized.named_parameters(named_testcases())
120  def test_create_with_public_keyset(self, lang: str, keyset: bytes,
121                                     primitive: Any):
122    """Tests primitive creation, after getting a public keyset.
123
124    It would be somewhat better if the test cases above produce all keysets --
125    however, this currently doesn't happen.
126
127    Args:
128      lang: the language to use
129      keyset: the serialized keyset, must be valid
130      primitive: the primitive to test
131    """
132    try:
133      public_keyset = testing_servers.public_keyset(lang, keyset)
134    except tink.TinkError:
135      self.skipTest('Cannot get the public keyset')
136
137    keytypes = utilities.key_types_in_keyset(public_keyset)
138    self.assertLen(keytypes, 1)
139    keytype = keytypes[0]
140
141    if (lang in tink_config.supported_languages_for_key_type(keytype) and
142        primitive == tink_config.primitive_for_keytype(keytype)):
143      _ = testing_servers.remote_primitive(lang, public_keyset, primitive)
144    else:
145      with self.assertRaises(tink.TinkError):
146        _ = testing_servers.remote_primitive(lang, public_keyset, primitive)
147
148  @parameterized.named_parameters(named_testcases())
149  def test_create_with_key_id_0(self, lang: str, keyset: bytes, primitive: Any):
150    """Tests primitive creation when key ID is 0.
151
152    Args:
153      lang: The language to test
154      keyset: A byte string representing a keyset. The keyset needs to be valid.
155      primitive: The primitive to try and instantiate
156    """
157    keyset_proto = tink_pb2.Keyset.FromString(keyset)
158    for key in keyset_proto.key:
159      if key.key_id == keyset_proto.primary_key_id:
160        key.key_id = 0
161    keyset_proto.primary_key_id = 0
162    modified_keyset = keyset_proto.SerializeToString()
163
164    keytypes = utilities.key_types_in_keyset(keyset)
165    keytype = keytypes[0]
166
167    if (lang in tink_config.supported_languages_for_key_type(keytype) and
168        primitive == tink_config.primitive_for_keytype(keytype)):
169      _ = testing_servers.remote_primitive(lang, modified_keyset, primitive)
170    else:
171      with self.assertRaises(tink.TinkError):
172        _ = testing_servers.remote_primitive(lang, modified_keyset, primitive)
173
174
175if __name__ == '__main__':
176  absltest.main()
177