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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
from unittest import TestCase
from unittest import skipIf
from parameterized import parameterized
from hvac import exceptions
from tests import utils
from tests.utils.hvac_integration_test_case import HvacIntegrationTestCase
@skipIf(
utils.vault_version_lt("0.6.2"), "AppRole endpoints standardized in version 0.6.2"
)
class TestAppRole(HvacIntegrationTestCase, TestCase):
TEST_MOUNT_POINT = "approle-test"
TEST_ROLE_NAME = "testrole"
TEST_ROLE_ID = "test_role_id"
TEST_SECRET_ID = "custom_secret"
def setUp(self):
super().setUp()
if "%s/" % self.TEST_MOUNT_POINT not in self.client.sys.list_auth_methods():
self.client.sys.enable_auth_method(
method_type="approle",
path=self.TEST_MOUNT_POINT,
)
_ = self.client.auth.approle.create_or_update_approle(
role_name=self.TEST_ROLE_NAME,
token_policies=["default"],
mount_point=self.TEST_MOUNT_POINT,
)
_ = self.client.auth.approle.update_role_id(
role_name=self.TEST_ROLE_NAME,
role_id=self.TEST_ROLE_ID,
mount_point=self.TEST_MOUNT_POINT,
)
def tearDown(self):
super().tearDown()
self.client.sys.disable_auth_method(path=self.TEST_MOUNT_POINT)
def _secret_id(self):
secret_id_response = self.client.auth.approle.generate_secret_id(
role_name=self.TEST_ROLE_NAME,
cidr_list=["127.0.0.1/32"],
mount_point=self.TEST_MOUNT_POINT,
)
return secret_id_response["data"]
@parameterized.expand(
[
("create test role", "default", None),
("bad token type", "bad_token", exceptions.ParamValidationError),
]
)
def test_create_or_update_approle(self, test_label, token_type, raises):
if raises is not None:
with self.assertRaises(raises) as cm:
self.client.auth.approle.create_or_update_approle(
role_name="testrole2",
token_policies=["default"],
token_type=token_type,
mount_point=self.TEST_MOUNT_POINT,
)
self.assertIn(member="unsupported token_type", container=str(cm.exception))
else:
response = self.client.auth.approle.create_or_update_approle(
role_name="testrole2",
token_policies=["default"],
mount_point=self.TEST_MOUNT_POINT,
)
self.assertEqual(first=bool(response), second=True)
def test_list_roles(self):
response = self.client.auth.approle.list_roles(
mount_point=self.TEST_MOUNT_POINT
)
self.assertEqual(first=len(response["data"]["keys"]), second=1)
def test_read_role(self):
response = self.client.auth.approle.read_role(
role_name=self.TEST_ROLE_NAME, mount_point=self.TEST_MOUNT_POINT
)
self.assertEqual(first=response["data"]["token_type"], second="default")
def test_delete_role(self):
response = self.client.auth.approle.delete_role(
role_name=self.TEST_ROLE_NAME, mount_point=self.TEST_MOUNT_POINT
)
self.assertEqual(first=204, second=response.status_code)
def test_read_role_id(self):
response = self.client.auth.approle.read_role_id(
role_name=self.TEST_ROLE_NAME, mount_point=self.TEST_MOUNT_POINT
)
self.assertEqual(first=self.TEST_ROLE_ID, second=response["data"]["role_id"])
@parameterized.expand(
[
("good request, no metadata", None, None, None),
("good request, good metadata", None, {"a": "val1", "B": "two"}, 300),
("good request, good metadata", None, {"a": "val1", "B": "two"}, "5m"),
("bad metadata option", exceptions.ParamValidationError, "bad", None),
]
)
def test_generate_secret_id(self, test_label, raises, metadata, wrap_ttl):
if raises is not None:
with self.assertRaises(raises) as cm:
self.client.auth.approle.generate_secret_id(
role_name=self.TEST_ROLE_NAME,
metadata=metadata,
mount_point=self.TEST_MOUNT_POINT,
wrap_ttl=wrap_ttl,
)
self.assertIn(
member="unsupported metadata argument", container=str(cm.exception)
)
else:
response = self.client.auth.approle.generate_secret_id(
role_name=self.TEST_ROLE_NAME,
cidr_list=["127.0.0.1/32"],
mount_point=self.TEST_MOUNT_POINT,
metadata=metadata,
wrap_ttl=wrap_ttl,
)
if wrap_ttl is not None:
assert "wrap_info" in response
assert isinstance(response["wrap_info"]["ttl"], int)
assert (
response["wrap_info"]["ttl"] == 300
) # NOTE: hardcoded for now because of string formats
else:
self.assertIn(
member="secret_id", container=response["data"], msg=response
)
@parameterized.expand(
[
("good request, no metadata", None, None, None),
("good request, good metadata", None, {"a": "val1", "B": "two"}, 300),
("good request, good metadata", None, {"a": "val1", "B": "two"}, "5m"),
("bad metadata option", exceptions.ParamValidationError, "bad", None),
]
)
def test_create_custom_secret_id(self, test_label, raises, metadata, wrap_ttl):
if raises is not None:
with self.assertRaises(raises) as cm:
self.client.auth.approle.create_custom_secret_id(
role_name=self.TEST_ROLE_NAME,
secret_id=self.TEST_SECRET_ID,
cidr_list=["127.0.0.1/32"],
metadata=metadata,
mount_point=self.TEST_MOUNT_POINT,
wrap_ttl=wrap_ttl,
)
self.assertIn(
member="unsupported metadata argument", container=str(cm.exception)
)
else:
response = self.client.auth.approle.create_custom_secret_id(
role_name=self.TEST_ROLE_NAME,
secret_id=self.TEST_SECRET_ID,
cidr_list=["127.0.0.1/32"],
mount_point=self.TEST_MOUNT_POINT,
metadata=metadata,
wrap_ttl=wrap_ttl,
)
if wrap_ttl is not None:
assert "wrap_info" in response
assert isinstance(response["wrap_info"]["ttl"], int)
assert (
response["wrap_info"]["ttl"] == 300
) # NOTE: hardcoded for now because of string formats
else:
self.assertEqual(
first=self.TEST_SECRET_ID, second=response["data"]["secret_id"]
)
def test_read_secret_id(self):
secret_id_response = self._secret_id()
response = self.client.auth.approle.read_secret_id(
role_name=self.TEST_ROLE_NAME,
secret_id=secret_id_response["secret_id"],
mount_point=self.TEST_MOUNT_POINT,
)
self.assertEqual(first=0, second=response["data"]["secret_id_num_uses"])
def test_destroy_secret_id(self):
secret_id_response = self._secret_id()
response = self.client.auth.approle.destroy_secret_id(
role_name=self.TEST_ROLE_NAME,
secret_id=secret_id_response["secret_id"],
mount_point=self.TEST_MOUNT_POINT,
)
self.assertEqual(first=204, second=response.status_code)
def test_list_secret_id_accessors(self):
self._secret_id()
response = self.client.auth.approle.list_secret_id_accessors(
role_name=self.TEST_ROLE_NAME, mount_point=self.TEST_MOUNT_POINT
)
self.assertEqual(first=1, second=len(response["data"]["keys"]))
def test_read_secret_id_accessor(self):
secret_id_response = self._secret_id()
response = self.client.auth.approle.read_secret_id_accessor(
role_name=self.TEST_ROLE_NAME,
secret_id_accessor=secret_id_response["secret_id_accessor"],
mount_point=self.TEST_MOUNT_POINT,
)
self.assertEqual(
first=secret_id_response["secret_id_accessor"],
second=response["data"]["secret_id_accessor"],
)
self.assertEqual(first="127.0.0.1/32", second=response["data"]["cidr_list"][0])
def test_destroy_secret_id_accessor(self):
secret_id_response = self._secret_id()
response = self.client.auth.approle.read_secret_id_accessor(
role_name=self.TEST_ROLE_NAME,
secret_id_accessor=secret_id_response["secret_id_accessor"],
mount_point=self.TEST_MOUNT_POINT,
)
self.assertEqual(
first=secret_id_response["secret_id_accessor"],
second=response["data"]["secret_id_accessor"],
)
response = self.client.auth.approle.destroy_secret_id_accessor(
role_name=self.TEST_ROLE_NAME,
secret_id_accessor=secret_id_response["secret_id_accessor"],
mount_point=self.TEST_MOUNT_POINT,
)
self.assertEqual(first=204, second=response.status_code)
def test_login(self):
secret_id_response = self._secret_id()
response = self.client.auth.approle.login(
role_id=self.TEST_ROLE_ID,
secret_id=secret_id_response["secret_id"],
mount_point=self.TEST_MOUNT_POINT,
)
self.assertIn(member="client_token", container=response["auth"])
|
