/
hashivault_identity_entity.py
195 lines (179 loc) · 7.36 KB
/
hashivault_identity_entity.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
#!/usr/bin/env python
from ansible.module_utils.hashivault import hashivault_argspec
from ansible.module_utils.hashivault import hashivault_auth_client
from ansible.module_utils.hashivault import hashivault_init
from ansible.module_utils.hashivault import hashiwrapper
ANSIBLE_METADATA = {'status': ['stableinterface'], 'supported_by': 'community', 'version': '1.1'}
DOCUMENTATION = '''
---
module: hashivault_identity_entity
version_added: "3.13.0"
short_description: Hashicorp Vault entity create module
description:
- Module to manage identity entity in Hashicorp Vault.
options:
url:
description:
- url for vault
default: to environment variable VAULT_ADDR
ca_cert:
description:
- "path to a PEM-encoded CA cert file to use to verify the Vault server TLS certificate"
default: to environment variable VAULT_CACERT
ca_path:
description:
- "path to a directory of PEM-encoded CA cert files to verify the Vault server TLS certificate : if ca_cert
is specified, its value will take precedence"
default: to environment variable VAULT_CAPATH
client_cert:
description:
- "path to a PEM-encoded client certificate for TLS authentication to the Vault server"
default: to environment variable VAULT_CLIENT_CERT
client_key:
description:
- "path to an unencrypted PEM-encoded private key matching the client certificate"
default: to environment variable VAULT_CLIENT_KEY
verify:
description:
- "if set, do not verify presented TLS certificate before communicating with Vault server : setting this
variable is not recommended except during testing"
default: to environment variable VAULT_SKIP_VERIFY
authtype:
description:
- "authentication type to use: token, userpass, github, ldap, approle"
default: token
token:
description:
- token for vault
default: to environment variable VAULT_TOKEN
username:
description:
- username to login to vault.
default: to environment variable VAULT_USER
password:
description:
- password to login to vault.
default: to environment variable VAULT_PASSWORD
name:
description:
- entity name to create or update.
id:
description:
- entity id to update.
metadata:
description:
- metadata to be associated with entity
disabled:
description:
- whether the entity is disabled
policies:
description:
- entity policies.
state:
description:
- whether create/update or delete the entity
'''
EXAMPLES = '''
---
- hosts: localhost
tasks:
- hashivault_identity_entity:
name: 'bob'
policies: 'bob'
'''
def main():
argspec = hashivault_argspec()
argspec['name'] = dict(required=False, type='str', default=None)
argspec['id'] = dict(required=False, type='str', default=None)
argspec['metadata'] = dict(required=False, type='dict', default=None)
argspec['disabled'] = dict(required=False, type='bool', default=None)
argspec['policies'] = dict(required=False, type='list', default=None)
argspec['state'] = dict(required=False, choices=['present', 'absent'], default='present')
module = hashivault_init(argspec)
result = hashivault_identity_entity(module.params)
if result.get('failed'):
module.fail_json(**result)
else:
module.exit_json(**result)
def hashivault_identity_entity_update(entity_details, client, entity_id, entity_name, entity_metadata, entity_disabled,
entity_policies):
if entity_metadata is None:
entity_metadata = entity_details['metadata']
if entity_policies is None:
entity_policies = entity_details['policies']
if entity_disabled is None:
entity_disabled = entity_details['disabled']
if entity_details['name'] != entity_name or entity_details['disabled'] != entity_disabled or \
entity_details['metadata'] != entity_metadata or set(entity_details['policies']) != set(entity_policies):
try:
client.secrets.identity.update_entity(
entity_id=entity_id,
name=entity_name,
metadata=entity_metadata,
policies=entity_policies,
disabled=entity_disabled
)
except Exception as e:
return {'failed': True, 'msg': str(e)}
return {'changed': True}
return {'changed': False}
def hashivault_identity_entity_create_or_update(params):
client = hashivault_auth_client(params)
entity_name = params.get('name')
entity_id = params.get('id')
entity_metadata = params.get('metadata')
entity_disabled = params.get('disabled')
entity_policies = params.get('policies')
if entity_id is not None:
try:
entity_details = client.secrets.identity.read_entity(entity_id=entity_id)
except Exception as e:
return {'failed': True, 'msg': str(e)}
return hashivault_identity_entity_update(entity_details['data'], client, entity_name, entity_id,
entity_metadata, entity_disabled, entity_policies)
elif entity_name is not None:
try:
entity_details = client.secrets.identity.read_entity_by_name(name=entity_name)
except Exception:
response = client.secrets.identity.create_or_update_entity_by_name(
name=entity_name,
metadata=entity_metadata,
policies=entity_policies,
disabled=entity_disabled
)
return {'changed': True, 'data': response['data']}
return hashivault_identity_entity_update(entity_details['data'], client, entity_name=entity_name,
entity_id=entity_details['data']['id'],
entity_metadata=entity_metadata,
entity_disabled=entity_disabled, entity_policies=entity_policies)
return {'failed': True, 'msg': "Either name or id must be provided"}
def hashivault_identity_entity_delete(params):
client = hashivault_auth_client(params)
entity_id = params.get('id')
entity_name = params.get('name')
if entity_id is not None:
try:
client.secrets.identity.read_entity(entity_id=entity_id)
except Exception:
return {'changed': False}
client.secrets.identity.delete_entity(entity_id=entity_id)
return {'changed': True}
elif entity_name is not None:
try:
client.secrets.identity.read_entity_by_name(name=entity_name)
except Exception:
return {'changed': False}
client.secrets.identity.delete_entity_by_name(name=entity_name)
return {'changed': True}
return {'failed': True, 'msg': "Either name or id must be provided"}
@hashiwrapper
def hashivault_identity_entity(params):
state = params.get('state')
if state == 'present':
return hashivault_identity_entity_create_or_update(params)
elif state == 'absent':
return hashivault_identity_entity_delete(params)
else:
return {'failed': True, 'msg': 'Unknown state'}
if __name__ == '__main__':
main()