/
passbolt.py
319 lines (291 loc) · 11.1 KB
/
passbolt.py
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = """
name: passbolt
author: Jean-Christophe Vassort <jean-christophe@passbolt.com>
version_added: "0.1"
short_description: retrieve resources and secrets from passbolt API
description:
- This lookup returns resources and secrets from passbolt API.
options:
per_uuid:
description: The searched term is a passbolt resource UUID
type: bool
required: False
default: False
username:
description: filter the searched term per username
type: str
require: False
default: ""
uri:
description: filter the searched term per uri
type: str
require: False
default: ""
description:
description: filter the searched term per description
type: str
require: False
default: ""
"""
EXAMPLES = """
- name: "Passbolt lookup plugin / fetch one"
debug:
var: lookup('passbolt', 'OVH')
- name: "Passbolt lookup plugin / loop with filters"
debug:
var: item
loop:
- "{{ lookup('passbolt', 'Odoo') }}"
- "{{ lookup('passbolt', 'a294b8d6-5dae-4db6-9e49-f790781cec30', per_uuid='true') }}"
- "{{ lookup('passbolt', 'OVH', username='zero-cool@ellingson.corp') }}"
- "{{ lookup('passbolt', 'OVH', username='John Dog') }}"
- name: "Passbolt lookup plugin / fetch list of items"
debug:
var: item
with_passbolt:
- "n8n"
- "Scaleway"
- "This doesn't exists"
- name: Generate AWS credentials profile
ansible.builtin.copy:
vars:
aws:
access_key: "{{ lookup('passbolt', 'AWS').password }}"
secret_key: "{{ lookup('passbolt', 'AWS').description }}"
dest: ${HOME}/.aws/credentials
owner: "{{ lookup('env', 'USER') }}"
mode: "0600"
content: |
[default]
aws_access_key_id={{ aws.access_key }}
aws_secret_access_key={{ aws.secret_key }}
"""
RETURN = """
_raw:
description:
- content of file(s)
type: list
elements: str
"""
from ansible.errors import AnsibleError, AnsibleParserError
from ansible.plugins.lookup import LookupBase
from ansible.module_utils._text import to_text
from ansible.utils.display import Display
from passbolt import PassboltAPI
from os import environ
import json
import secrets
import string
display = Display()
class LookupModule(LookupBase):
def _get_value(
self, selected_variable, variables, environment_variables, default=str()
):
variable = variables.get(selected_variable, None)
if variable is None:
return self._get_env_value(
selected_variable=selected_variable,
environment_variables=environment_variables,
default=default,
)
else:
return variable
def _get_env_value(self, selected_variable, environment_variables, default=str()):
if not environment_variables:
return environ.get(selected_variable, default)
else:
return self._templar.template(
next(
(
item.get(selected_variable)
for item in environment_variables
if item.get(selected_variable)
),
default,
)
)
def _search(self, item, kwargs):
res = 0
expected = len(kwargs)
for k in kwargs:
if kwargs[k] == item[k]:
res += 1
return expected == res
def _create_new_password(self):
characters = string.ascii_letters + string.digits
if (
str(self.dict_config.get("new_resource_password_special_chars")).lower()
== "true"
):
characters += string.punctuation
return "".join(secrets.choice(characters) for i in range(int(self.dict_config.get("new_resource_password_length"))))
def _create_new_resource(self, kwargs):
new_password = kwargs.get("password",self._create_new_password())
new_description = kwargs.get("description","Ansible Generated")
new_resource = {
"name": kwargs.get("name"),
"username": kwargs.get("username"),
"uri": kwargs.get("uri"),
"resource_type_id": self.p.resource_types["password-and-description"],
"folder_parent_id": kwargs.get("folder_parent_id"),
"secrets": [
{
"data": self.p.encrypt(
{"description": new_description, "password": new_password},
self.p.get_user_public_key(self.p.user_id),
)
}
],
}
r = self.p.create_resource(new_resource)
if r.status_code == 200:
resource = json.loads(r.text).get("body")
resource_secrets = {
"password": new_password,
"description": new_description,
}
return self._format_result(resource, resource_secrets)
else:
return self._format_result(dict(), dict())
def _format_result(self, resource, resource_secrets):
return {
"name": resource.get("name", ""),
"uri": resource.get("uri", ""),
"username": resource.get("username", ""),
"password": resource_secrets.get("password", ""),
"description": resource_secrets.get("description", ""),
"deleted": resource.get("deleted", ""),
"created": resource.get("created", ""),
"modified": resource.get("modified", ""),
"modified_by": resource.get("modified_by", ""),
"resource_type_id": resource.get("resource_type_id", ""),
"folder_parent_id": resource.get("folder_parent_id", ""),
"personal": resource.get("personal", ""),
}
def _get_config(self, variables):
return {
"base_url": self._get_value(
"PASSBOLT_BASE_URL", variables, variables.get("environment")
),
"private_key": self._get_value(
"PASSBOLT_PRIVATE_KEY", variables, variables.get("environment")
),
"passphrase": self._get_value(
"PASSBOLT_PASSPHRASE", variables, variables.get("environment")
),
"gpg_binary": self._get_value(
"PASSBOLT_GPG_BINARY", variables, variables.get("environment"), default="gpg"
),
"gpg_library": self._get_value(
"PASSBOLT_GPG_LIBRARY", variables, variables.get("environment"), default="PGPy"
),
"fingerprint": self._get_value(
"PASSBOLT_FINGERPRINT", variables, variables.get("environment")
),
"verify": self._get_value(
"PASSBOLT_VERIFY", variables, variables.get("environment"), default=True
),
"create_new_resource": self._get_value(
"PASSBOLT_CREATE_NEW_RESOURCE", variables,
variables.get("environment"),
default=False,
),
"new_resource_password_length": self._get_value(
"PASSBOLT_NEW_RESOURCE_PASSWORD_LENGTH", variables,
variables.get("environment"),
default=20,
),
"new_resource_password_special_chars": self._get_value(
"PASSBOLT_NEW_RESOURCE_PASSWORD_SPECIAL_CHARS", variables,
variables.get("environment"),
default=False,
),
}
def zdebug(self, *args, **kwargs):
with open("/tmp/debug", "w") as f:
f.write("\n")
if args:
with open("/tmp/debug", "a") as f:
f.write(repr(args))
f.write("\n")
if kwargs:
with open("/tmp/debug", "a") as f:
f.write(repr(kwargs))
f.write("\n")
# f.write(
# self._templar.template(
# next(
# item.get("PASSBOLT_PASSPHRASE")
# for item in variables.get("environment")
# if item.get("PASSBOLT_PASSPHRASE")
# )
# )
# )
# f.write("\n")
def passbolt_init(self, variables, kwargs):
self.dict_config = self._get_config(variables)
self.p = PassboltAPI(dict_config=self.dict_config)
if kwargs.get("per_uuid") != "true":
self.passbolt_resources = self.p.get_resources()
def get_resource_per_uuid(self, uuid):
resource = self.p.get_resource_per_uuid(uuid)
if not len(resource):
resource = dict()
return resource
def get_resource_per_term(self, term):
resource = next(
(item for item in self.passbolt_resources if item.get("name") == term),
dict(),
)
return resource
def get_resource_per_kwargs(self, kwargs):
resource = next(
(item for item in self.passbolt_resources if self._search(item, kwargs)),
dict(),
)
return resource
def run(self, terms, variables=None, **kwargs):
ret = []
self.set_options(var_options=variables, direct=kwargs)
self.passbolt_init(variables, kwargs)
#removing description and password for the search
description = kwargs.pop("description",None)
password = kwargs.pop("password",None)
for term in terms:
display.debug("Passbolt lookup term: %s" % term)
kwargs["name"] = uuid = term
if kwargs.get("per_uuid") == "true":
resource = self.get_resource_per_uuid(uuid)
elif kwargs.get("wantlist"): # with_passbolt case
resource = self.get_resource_per_term(term)
elif len(kwargs): # search for term plus username, uri, etc.
resource = self.get_resource_per_kwargs(kwargs)
else:
resource = self.get_resource_per_term(term)
if resource.get("id"):
# We got a resource, fetch their secrets
resource_secrets = (
self.dict_config.get("gpg_library", "PGPy") == "gnupg"
and json.loads(
self.p.decrypt(
self.p.get_resource_secret(resource.get("id"))
).data
)
or json.loads(
self.p.decrypt(self.p.get_resource_secret(resource.get("id")))
)
)
ret.append(self._format_result(resource, resource_secrets))
else:
if str(self.dict_config.get("create_new_resource")).lower() == "true":
#if r
if description:
kwargs["description"] = description
if password:
kwargs["password"] = password
ret.append(self._create_new_resource(kwargs))
else:
raise Exception("resource {} not found".format(terms[0]))
return ret